Guides: Introduce Rust Guide by AnnsAnns · Pull Request #21435 · RIOT-OS/RIOT

AnnsAnns · 2025-04-24T14:55:55Z

Contribution description

This PR introduces a basic Rust tutorial for RIOT. The idea is to give a very brief and simple overview into the great support RIOT has while still having a focus on the more advanced C tutorials.

Testing procedure

Currently Rust support is not integrated within the tutorial code check. However, this is based on the existing rust example and quite basic for the most part. I am still unsure how to proceed with a long term testing solution for this.

Issues/PRs references

This depends on #21434 which depends on #21436 which depends on #21404

doc/guides/rust_tutorials/create_project.mdx

AnnsAnns · 2025-06-24T07:29:54Z

Waiting for #21434 getting merged until I fix the merge conflicts 👍

crasbe · 2025-06-26T14:22:08Z

This can now be rebased, as #21434 is merged :)

AnnsAnns · 2025-06-26T15:18:49Z

The Rust guide is now rebased and (at least if I am not mistaken) ready for review with the modernized instructions 🫡

riot-ci · 2025-06-26T15:19:38Z

Murdock results

✔️ PASSED

47dec48 doc/guides: Introduce Rust Tutorial

Success	Failures	Total	Runtime
1	0	1	02m:10s

Artifacts

Documentation preview

crasbe

Disclaimer: I know next to nothing about Rust (well, not the programming language that is. I have some experience with metalworking :) ).

doc/guides/rust_tutorials/rust_in_riot.md

crasbe · 2025-06-26T15:25:33Z

doc/guides/rust_tutorials/rust_in_riot.md

+------------
+
+The easy part of the story is that Rust code gets compiled into a static library
+which is then linked together with the rest of the RIOT code;


I probably wouldn't use the semicolon here, also relevant for other sections.

just fyi, rust_in_riot is not my text, its a direct port of the doxygen text

https://github.com/AnnsAnns/RIOT/blob/31c45477e8839ffab882fd1b366a8778931c8fb8/doc/doxygen/src/using-rust.md

doc/guides/rust_tutorials/create_project.mdx

crasbe · 2025-06-26T15:44:33Z

doc/guides/rust_tutorials/rust_in_riot.md

+and tested for in applications using the Makefile line
+`FEATURES_REQUIRED += rust_target`.


As per @chrysn s review comment, this is not required anymore.

Same for this.

AnnsAnns · 2025-07-01T10:32:31Z

I applied the deprecation warning as per #21568 (comment) and updated the guide that was here to the latest version, this is now 1:1 the guide that is currently on doxygen.

crasbe · 2025-07-03T08:41:59Z

doc/doxygen/src/using-rust.md

-[inline_cast]: https://github.com/RIOT-OS/rust-riot-wrappers/blob/db9d163e3eddcb7154edcf25db7207e4123964ee/src/lib.rs#L68
-[C2Rust's support for atomics has improved]: https://github.com/immunant/c2rust/issues/436
-[atomics workarounds]: https://github.com/RIOT-OS/rust-riot-sys/blob/525b2384a3541d4879a5f3845ee6241243c29a78/riot-c2rust.h#L79
+@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/). This page will be removed in the future.


Should this also get a definitive date?

Also: long line.

doc/guides/rust_tutorials/rust_in_riot.md

crasbe · 2025-07-03T08:49:08Z

doc/guides/rust_tutorials/rust_in_riot.md

+and tested for in applications using the Makefile line
+`FEATURES_REQUIRED += rust_target`.


Same for this.

AnnsAnns · 2025-07-10T09:42:54Z

Sorry for vanishing for a few weeks, I'm currently approaching my exams 😅

This should cover what you said in the reviews, I also did some minor spelling/formatting fixes for the rust_in_riot guide as you asked for.

crasbe

I'll still have to look at the generated documentation in Starlight.

crasbe · 2025-07-10T10:19:46Z

doc/doxygen/src/using-rust.md

-[inline_cast]: https://github.com/RIOT-OS/rust-riot-wrappers/blob/db9d163e3eddcb7154edcf25db7207e4123964ee/src/lib.rs#L68
-[C2Rust's support for atomics has improved]: https://github.com/immunant/c2rust/issues/436
-[atomics workarounds]: https://github.com/RIOT-OS/rust-riot-sys/blob/525b2384a3541d4879a5f3845ee6241243c29a78/riot-c2rust.h#L79
+@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/). This page will be removed after release 2025.11.


short lined 👍

crasbe · 2025-07-10T10:21:14Z

doc/guides/rust_tutorials/rust_in_riot.md

Should this file have an .mdx extension instead of .md?

Nah, the tip section is """standard""" markdown syntax. MDX would only be interesting if we imported things or did JSX-related tomfoolery.

AnnsAnns · 2025-07-21T11:58:11Z

Is anything still blocking?

crasbe

Apparently I started a review and did not publish it 👀

crasbe · 2025-07-15T11:42:14Z

doc/guides/rust_tutorials/rust_in_riot.md

+(The latter is needed even after most `extern crate` was abolished in 2018,
+because crates depended on but not used otherwise are usually not linked in).
+
+## Toolchain {#toolchain}


Fixed sorry for not noticing 😅

crasbe · 2025-07-15T11:43:34Z

doc/guides/rust_tutorials/rust_in_riot.md

+
+<!-- The locked works around <https://github.com/dtolnay/proc-macro2/issues/475> as closed in <https://github.com/immunant/c2rust/pull/1197>, there is no newer release that could be tested. -->
+
+```shell


Suggested change

```shell

This is currently the only line here that has syntax highlighting enabled, and it doesn't really gain much:

The "Create Project" page mostly uses the syntax highlighting, maybe you can make that consistent.

Everything now uses syntax highlighting

crasbe · 2025-07-15T11:44:19Z

doc/guides/rust_tutorials/rust_in_riot.md

+    The PR is tested against current master in its CI (albeit not for the full set of boards).
+    To test whether it also works for the changed API,
+    a commit titled "REMOVEME Test with updated riot-wrappes" can be added to the original PR,
+    it alters `.cargo/config.toml` to point to the changed branch,
+    and removes any Cargo.lock files in the RIOT tree.
+
+    That PR is then merged.


Something is wrong here. Perhaps a - missing?

There was a html comment within the list which the markdown parser did not like at all

AnnsAnns · 2025-07-21T20:31:00Z

As with the #21573 feel free to reach out if anything is missing and I will try to rebase (hah, you didnt expect me to change the pun 😛) it into my schedule

crasbe

Looks good, please squash.

fix: update rust in riot to modern port, deprecate old guide fix: update deprecation notice to specify removal date

AnnsAnns · 2025-07-21T20:34:56Z

Looks good, please squash.

No matter the hour, crasbe is here with approval power 📖 ✍️

crasbe · 2025-07-21T20:44:40Z

Good luck with your exams :)

github-actions bot added Area: doc Area: Documentation Area: CI Area: Continuous Integration of RIOT components Area: tools Area: Supplementary tools Area: examples Area: Example Applications labels Apr 24, 2025

crasbe added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation State: waiting for other PR State: The PR requires another PR to be merged first labels Apr 24, 2025

AnnsAnns mentioned this pull request Apr 24, 2025

doc/guides: Add Getting Started guide #21436

Merged

chrysn reviewed Apr 24, 2025

View reviewed changes

doc/guides/rust_tutorials/create_project.mdx Outdated Show resolved Hide resolved

chrysn mentioned this pull request May 21, 2025

Updated readme and makefile so its easier for newbies to get ipv6 adresses #21500

Closed

crasbe removed the State: waiting for other PR State: The PR requires another PR to be merged first label Jun 26, 2025

AnnsAnns force-pushed the tutorials/rust branch from 1c73f78 to d416e84 Compare June 26, 2025 15:17

github-actions bot removed Area: CI Area: Continuous Integration of RIOT components Area: tools Area: Supplementary tools Area: examples Area: Example Applications labels Jun 26, 2025

AnnsAnns force-pushed the tutorials/rust branch from d416e84 to 3e68dd8 Compare June 26, 2025 15:17

crasbe added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jun 26, 2025

crasbe marked this pull request as ready for review June 26, 2025 15:19

crasbe requested review from aabadie and jia200x as code owners June 26, 2025 15:19

AnnsAnns requested a review from chrysn June 26, 2025 15:20

crasbe reviewed Jun 26, 2025

View reviewed changes

AnnsAnns mentioned this pull request Jul 1, 2025

Guide Site Migration: Tracker #21575

Closed

23 tasks

crasbe reviewed Jul 3, 2025

View reviewed changes

crasbe reviewed Jul 10, 2025

View reviewed changes

crasbe reviewed Jul 21, 2025

View reviewed changes

crasbe approved these changes Jul 21, 2025

View reviewed changes

doc/guides: Introduce Rust Tutorial

47dec48

fix: update rust in riot to modern port, deprecate old guide fix: update deprecation notice to specify removal date

AnnsAnns force-pushed the tutorials/rust branch from d8a3faf to 47dec48 Compare July 21, 2025 20:33

crasbe enabled auto-merge July 21, 2025 20:36

crasbe added this pull request to the merge queue Jul 21, 2025

Merged via the queue into RIOT-OS:master with commit 6e77a81 Jul 21, 2025
25 checks passed

		and tested for in applications using the Makefile line
		`FEATURES_REQUIRED += rust_target`.


		<!-- The locked works around <https://github.com/dtolnay/proc-macro2/issues/475> as closed in <https://github.com/immunant/c2rust/pull/1197>, there is no newer release that could be tested. -->

		```shell

Conversation

AnnsAnns commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Contribution description

Testing procedure

Issues/PRs references

Uh oh!

Uh oh!

AnnsAnns commented Jun 24, 2025

Uh oh!

crasbe commented Jun 26, 2025

Uh oh!

AnnsAnns commented Jun 26, 2025

Uh oh!

riot-ci commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Murdock results

Artifacts

Uh oh!

crasbe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AnnsAnns commented Jul 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AnnsAnns commented Jul 10, 2025

Uh oh!

crasbe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AnnsAnns commented Jul 21, 2025

Uh oh!

crasbe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

crasbe Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

AnnsAnns commented Apr 24, 2025 •

edited

Loading

riot-ci commented Jun 26, 2025 •

edited

Loading

crasbe Jul 15, 2025 •

edited

Loading