-
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
doc: remove documentation on deprecated RIOT_FILE_* macros #21320
Conversation
That change is good, because with the current CFLAGS in vs. Lines 98 to 99 in 04a1698
|
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.
Small nitpick: There is an excess whitespace in one of your commits in front of the "doc".
2a424b4
to
bffa112
Compare
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.
If we can use standard macros without spilling the absolute path 👍 from my side.
But wait... should we maybe go through the official deprecation cycle first. So deprecate them for removal after the 2025.10 release? |
Well, since they've never been documented (and not used throughout the codebase in the last years), I'd argue this is not part of the public API and therefore doesn't qualify for the deprecation process. In particular, the documentation from #21170 hasn't made it into any release yet. |
Only because something is not documented, doesn't mean it is not used. It was a feature that has been there for years and though hidden, people might still rely on it. Is there any hurry to get it out? If no, let's go the official path. If yes, the reasons should be clearly stated in OP.
Our documentation is not tagged to releases, so I find this sentence a somewhat strange claim. |
Alright, closing in favor of #21345 |
Contribution description
#21170 added documentation about
RIOT_FILE_RELATIVE
andRIOT_FILE_NOPATH
which were already considered obsolete in #18936. Instead of going through the deprecation hoops I'd propose to just revert these commits before the next release.Issues/PRs references
Reverts #21170.