Skip to content

doc: add documentation on RIOT_FILE_RELATIVE#21170

Merged
mguetschow merged 2 commits intoRIOT-OS:masterfrom
miri64:doc/enh/RIOT_FILE_RELATIVE
Jan 28, 2025
Merged

doc: add documentation on RIOT_FILE_RELATIVE#21170
mguetschow merged 2 commits intoRIOT-OS:masterfrom
miri64:doc/enh/RIOT_FILE_RELATIVE

Conversation

@miri64
Copy link
Copy Markdown
Member

@miri64 miri64 commented Jan 28, 2025

Contribution description

@mguetschow pointed out, and rightly so, that RIOT_FILE_RELATIVE is not documented. This fixes that.

Testing procedure

RIOT_FILE_RELATIVE should show up in the rendered doc now.

Issues/PRs references

@miri64 miri64 added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Jan 28, 2025
@miri64 miri64 force-pushed the doc/enh/RIOT_FILE_RELATIVE branch from 893bdde to 9e14379 Compare January 28, 2025 19:42
@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Jan 28, 2025

Now that he looked at the definition in Makefile.base, he also asked me to add doc for RIOT_FILE_NOPATH

@miri64 miri64 force-pushed the doc/enh/RIOT_FILE_RELATIVE branch from 81bdbc9 to e2f4368 Compare January 28, 2025 19:58
mguetschow
mguetschow approved these changes Jan 28, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

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

Perfect, thank you!

@mguetschow mguetschow enabled auto-merge January 28, 2025 20:11
@riot-ci
Copy link
Copy Markdown

riot-ci commented Jan 28, 2025

Murdock results

✔️ PASSED

e2f4368 doc: add documentation on RIOT_FILE_NOPATH

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

Artifacts

@mguetschow mguetschow added this pull request to the merge queue Jan 28, 2025
Merged via the queue into RIOT-OS:master with commit 5ebef09 Jan 28, 2025
@mguetschow
Copy link
Copy Markdown
Contributor

mguetschow commented Feb 25, 2025

@miri64 I think #18936 is the reason this was not documented before. Should we revert?

This was referenced Mar 25, 2025
Open
Closed
@mguetschow mguetschow mentioned this pull request Apr 2, 2025
Merged
@mguetschow mguetschow added this to the Release 2025.04 milestone Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mguetschow mguetschow mguetschow approved these changes

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees

No one assigned

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 CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Milestone

Release 2025.04

Development

Successfully merging this pull request may close these issues.

3 participants

@miri64 @riot-ci @mguetschow