Skip to content

sys/stdio: better document configuration #21459

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 1, 2025
Merged

sys/stdio: better document configuration #21459

merged 1 commit into from
May 1, 2025

Conversation

@maribu
Copy link
Member

@maribu maribu commented Apr 30, 2025

Contribution description

This changes the documentation of how to configure stdio, especially with regard on how to configure the stdio frontends with printf_float, printf_long_long, and stdin.

Testing procedure

The CI will provide a doc preview.

Issues/PRs references

None

@maribu maribu 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 labels Apr 30, 2025
@maribu maribu requested a review from crasbe April 30, 2025 19:32
@maribu maribu requested a review from jia200x as a code owner April 30, 2025 19:32
@github-actions github-actions bot added Area: build system Area: Build system Area: sys Area: System labels Apr 30, 2025
@riot-ci
Copy link

riot-ci commented Apr 30, 2025 •
edited
Loading

Murdock results

✔️ PASSED

3d5fad5 sys/stdio: better document configuration

Success Failures Total Runtime
10320 0 10320 11m:17s

Artifacts

crasbe
crasbe reviewed May 1, 2025
View reviewed changes
Copy link
Contributor

@crasbe crasbe left a comment

Choose a reason for hiding this comment

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

I like this change a lot, it makes the STDIO abstraction a lot more approachable.

Some small remarks to make it a bit easier to understand, but this is also open to discussion.

crasbe
crasbe approved these changes May 1, 2025
View reviewed changes
Copy link
Contributor

@crasbe crasbe left a comment

Choose a reason for hiding this comment

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

Please squash :)

Thanks for addressing this :)

@maribu @crasbe
sys/stdio: better document configuration
3d5fad5 
This changes the documentation of how to configure stdio, especially
with regard on how to configure the stdio frontends with
`printf_float`, `printf_long_long`, and `stdin`.

Co-authored-by: crasbe <crasbe@gmail.com>
@maribu maribu added this pull request to the merge queue May 1, 2025
Merged via the queue into RIOT-OS:master with commit bf8c734 May 1, 2025
25 checks passed
@maribu
Copy link
Member Author

maribu commented May 1, 2025

Thx a lot :-)

@maribu maribu deleted the sys/stdio/doc branch May 1, 2025 12:52
@Teufelchen1 Teufelchen1 added this to the Release 2025.07 milestone Jul 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@crasbe crasbe crasbe approved these changes

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

Assignees

No one assigned

Labels

Area: build system Area: Build system Area: doc Area: Documentation Area: sys Area: System CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Milestone

Release 2025.07

Development

Successfully merging this pull request may close these issues.

4 participants

@maribu @riot-ci @crasbe @Teufelchen1