Skip to content

Commit d8a3faf

Browse files
committed
fix: apply suggested changes
1 parent 17762c7 commit d8a3faf

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

doc/guides/rust_tutorials/rust_in_riot.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ and placing an `extern crate rust_riotmodules,` statement in the code.
118118
(The latter is needed even after most `extern crate` was abolished in 2018,
119119
because crates depended on but not used otherwise are usually not linked in).
120120

121-
## Toolchain {#toolchain}
121+
## Toolchain
122122

123123
Using Rust on RIOT needs the latest stable version of Rust. Please note that
124124
many popular Linux distributions provide very old versions in their
@@ -128,8 +128,8 @@ on its project website].
128128

129129
Make sure you have the core library for the CPU (**target**) of your choice available:
130130

131-
```
132-
$ rustup target add thumbv7m-none-eabi
131+
```shell
132+
rustup target add thumbv7m-none-eabi
133133
```
134134

135135
Substitute `thumbv7m-none-eabi` with the value of `RUST_TARGET`
@@ -145,8 +145,8 @@ To avoid playing the whack-a-mole of installing components whenever an install s
145145
consider installing this list of packages on Debian
146146
(or an equivalent list on the distribution of your choice):
147147

148-
```
149-
# apt install libclang-dev llvm llvm-dev cmake libssl-dev pkg-config
148+
```shell
149+
apt install libclang-dev llvm llvm-dev cmake libssl-dev pkg-config
150150
```
151151

152152
This encompasses both components needed for riot-sys and for the later installation of C2Rust.
@@ -157,14 +157,14 @@ as this is using some recent fixes, it is best installed as:
157157
<!-- 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. -->
158158

159159
```shell
160-
$ cargo install c2rust --git https://github.com/immunant/c2rust --tag v0.19.0 --locked
160+
cargo install c2rust --git https://github.com/immunant/c2rust --tag v0.19.0 --locked
161161
```
162162

163163
If multiple versions of LLVM are installed locally,
164164
it may be necessary to prefix it with the selected LLVM version:
165165

166-
```
167-
$ LLVM_CONFIG_PATH=/usr/bin/llvm-config-16 cargo install …
166+
```shell
167+
LLVM_CONFIG_PATH=/usr/bin/llvm-config-16 cargo install …
168168
```
169169

170170
[cargo]: https://doc.rust-lang.org/cargo/
@@ -192,8 +192,8 @@ The typical workflow of (C-nonbreaking, Rust-breaking) API changes is as follows
192192

193193
Consequently, builds of Rust examples break.
194194

195+
<!-- commit reference rather than PR as that was still on GitLab back then -->
195196
- A PR is opened on riot-wrappers to smooth over the change, like [aab605f4]
196-
<!-- commit reference rather than PR as that was still on GitLab back then -->.
197197

198198
The PR is tested against current master in its CI (albeit not for the full set of boards).
199199
To test whether it also works for the changed API,

0 commit comments

Comments
 (0)