Skip to content

doc/guides/rust_tutorials: mention BUILD_IN_DOCKER more verbosely#21735

Merged
crasbe merged 1 commit intoRIOT-OS:masterfrom
AnnsAnns:rust_builddocker
Sep 22, 2025
Merged

doc/guides/rust_tutorials: mention BUILD_IN_DOCKER more verbosely#21735
crasbe merged 1 commit intoRIOT-OS:masterfrom
AnnsAnns:rust_builddocker

Conversation

@AnnsAnns
Copy link
Member

Contribution description

This should reduce potential errors as happened in #21733 and make it easier to understand when/how to build stuff within our docker container.

Testing procedure

make doc-starlight

Issues/PRs references

This closes #21733

@github-actions github-actions bot added the Area: doc Area: Documentation label Sep 22, 2025
@crasbe crasbe added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / 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 Sep 22, 2025
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 think this should include a link to the "Building in Docker" guide, possibly it could be shorter in total to reduce the redundancy.

Comment on lines 170 to 171
Do note that building in Docker will take quite a bit longer on the first run,
as it needs to download a fairly large Docker image.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a bit of an understatement, the Docker container is more than 20GB big.

@riot-ci
Copy link

riot-ci commented Sep 22, 2025

Murdock results

✔️ PASSED

90072fb doc/guides/rust_tutorials: mention BUILD_IN_DOCKER more verbosely

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

Artifacts

@AnnsAnns
Copy link
Member Author

Fixed and changed 🐸 👉 👉

@crasbe
Copy link
Contributor

crasbe commented Sep 22, 2025

Please squash :)

@AnnsAnns
Copy link
Member Author

🎾 Squash

@crasbe crasbe enabled auto-merge September 22, 2025 10:06
@crasbe crasbe added this pull request to the merge queue Sep 22, 2025
Merged via the queue into RIOT-OS:master with commit 30a2b27 Sep 22, 2025
25 checks passed
@benpicco benpicco added this to the Release 2025.10 milestone Dec 3, 2025
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 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

Development

Successfully merging this pull request may close these issues.

Tutorial for hello_world incomplete/buggy

4 participants