-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
gnrc_mac / gnrc_lwmac / gnrc_gomach: Deprecate modules #20512
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
miri64
added
Type: cleanup
The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation
Process: deprecation
Integration Process: The PR is deprecating a feature or API
labels
Mar 27, 2024
github-actions
bot
added
Area: network
Area: Networking
Area: build system
Area: Build system
Area: pkg
Area: External package ports
Area: sys
Area: System
labels
Mar 27, 2024
miri64
added
Type: enhancement
The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Area: doc
Area: Documentation
labels
Mar 27, 2024
Teufelchen1
approved these changes
Mar 27, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
miri64
added
the
CI: ready for build
If set, CI server will compile all applications for all available boards for the labeled PR
label
Mar 27, 2024
jia200x
approved these changes
Mar 27, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Mar 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Area: build system
Area: Build system
Area: doc
Area: Documentation
Area: network
Area: Networking
Area: pkg
Area: External package ports
Area: sys
Area: System
CI: ready for build
If set, CI server will compile all applications for all available boards for the labeled PR
Process: deprecation
Integration Process: The PR is deprecating a feature or API
Type: cleanup
The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation
Type: enhancement
The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution description
Both
gnrc_lwmac
andgnrc_gomach
as well as their common modulegnrc_mac
are effectively unmaintained (the last commit to these modules that wasn't a cleanup or adoption for API change was in 2017). So let's deprecate them and later on remove them. People requiring a MAC protocols can use OpenDSME as an alternative.Since I also had a look at the OpenDSME doc, I found a rendering issue there for which I piggybacked a fix.
Testing procedure
make doc
should generate a documentation with those modules (and theirnettype
on the deprecated list. Building any application that uses those modules (e.g.examples/gnrc_networking_mac
) should show a warning that deprecated modules are used.Issues/PRs references
As discussed in #16502.