Skip to content
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 4 commits into from
Mar 27, 2024

Conversation

miri64
Copy link
Member

@miri64 miri64 commented Mar 27, 2024

Contribution description

Both gnrc_lwmac and gnrc_gomach as well as their common module gnrc_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 their nettype 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.

@miri64 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 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 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
Copy link
Contributor

@Teufelchen1 Teufelchen1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@miri64 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
@miri64 miri64 enabled auto-merge March 27, 2024 10:55
@riot-ci
Copy link

riot-ci commented Mar 27, 2024

Murdock results

✔️ PASSED

0e2ab50 opendsme: fix markdown formatting of ASCII art in documentation

Success Failures Total Runtime
10031 0 10031 10m:24s

Artifacts

@miri64 miri64 added this pull request to the merge queue Mar 27, 2024
Copy link
Member

@jia200x jia200x left a 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 github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 27, 2024
@maribu maribu added this pull request to the merge queue Mar 27, 2024
Merged via the queue into RIOT-OS:master with commit 29374c6 Mar 27, 2024
32 checks passed
@miri64 miri64 deleted the gnrc_mac/cleanup/deprecate branch March 27, 2024 22:21
@MrKevinWeiss MrKevinWeiss added this to the Release 2024.04 milestone Apr 30, 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants