Skip to content

Commit

Permalink
fixup! doc: Update for Rust libraries
Browse files Browse the repository at this point in the history
  • Loading branch information
chrysn committed Jul 9, 2022
1 parent b9ee0d4 commit e4279bd
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/doxygen/src/using-rust.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,15 +89,15 @@ They always depend on the `rust_riotmodules` module / crate,
which collects all enabled modules into a single crate by means of optional features.

If the application is not written in Rust,
it further depends on `rust_riotmodules_standalone`,
that then depends on `rust_riotmodules_standalone`,
which adds a panic handler and serves as a root crate.

If the application is written in Rust,
`rust_riotmodules` needs to be added as a dependency of the application.
(This helps deduplicate between application and library code,
and also avoids symbol name clashes).
This is done by adding a dependency on the local `rust_riotmodules_standalone` crate (which is a no-op when no such modules are enabled),
and placing an `extern crate rust_riotmodules_standalone;` statement in the code.
This is done by adding a dependency on the local `rust_riotmodules` crate (which is a no-op when no such modules are enabled),
and placing an `extern crate rust_riotmodules;` statement in the code.
(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).

Expand Down

0 comments on commit e4279bd

Please sign in to comment.