Skip to content

doc: deprecate RIOT_FILE_* macros#21345

Merged
miri64 merged 1 commit intoRIOT-OS:masterfrom
mguetschow:doc-file-macros-deprecate
Apr 2, 2025
Merged

doc: deprecate RIOT_FILE_* macros#21345
miri64 merged 1 commit intoRIOT-OS:masterfrom
mguetschow:doc-file-macros-deprecate

Conversation

@mguetschow
Copy link
Copy Markdown
Contributor

Contribution description

Alternative to #21320. Quoting from there:

#21170 added documentation about RIOT_FILE_RELATIVE and RIOT_FILE_NOPATH which were already considered obsolete in #18936.

@miri64 insisted on going through the normal deprecation process even for such previously non-publicly documented macros, so lets do that instead.

There are replacements for both macros as compiler built-ins from gcc 8/12 and clang 10/9.

Testing procedure

Read the CI generated docs. Also check list of deprecated features.

Issues/PRs references

#4053, #21320, #21170, #18936

@github-actions github-actions bot added the Area: doc Area: Documentation label Apr 2, 2025
@crasbe crasbe added Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Apr 2, 2025
@riot-ci
Copy link
Copy Markdown

riot-ci commented Apr 2, 2025

Murdock results

✔️ PASSED

3c12ee0 doc: deprecate RIOT_FILE_* macros

Success Failures Total Runtime
1 0 1 01m:19s

Artifacts

@mguetschow mguetschow force-pushed the doc-file-macros-deprecate branch 3 times, most recently from d6e6648 to 24396e1 Compare April 2, 2025 11:02
@mguetschow mguetschow force-pushed the doc-file-macros-deprecate branch from 24396e1 to 3c12ee0 Compare April 2, 2025 11:05
@miri64 miri64 enabled auto-merge April 2, 2025 11:06
@miri64 miri64 added this pull request to the merge queue Apr 2, 2025
Merged via the queue into RIOT-OS:master with commit c69ef85 Apr 2, 2025
26 checks passed
@mguetschow mguetschow deleted the doc-file-macros-deprecate branch April 2, 2025 12:50
@mguetschow
Copy link
Copy Markdown
Contributor Author

Thanks everyone!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants