@@ -23,13 +23,13 @@ at the time of writing, they are likely to not be recent enough.
23
23
rustc
24
24
*****
25
25
26
- A recent * nightly * Rust toolchain (with, at least, `` rustc ``) is required,
27
- e.g. `` nightly-2021-05-29 ``. Our goal is to use a stable toolchain as soon
28
- as possible, but for the moment we depend on a handful of nightly features.
26
+ A particular version (` 1.54.0-beta.1 `) of the Rust compiler is required.
27
+ Newer versions may or may not work because, for the moment, we depend on
28
+ some unstable Rust features.
29
29
30
30
If you are using ``rustup ``, run::
31
31
32
- rustup default nightly -2021-05-29
32
+ rustup default beta -2021-06-23
33
33
34
34
Otherwise, fetch a standalone installer or install ``rustup `` from:
35
35
@@ -125,16 +125,30 @@ the component manually::
125
125
The standalone installers also come with ``clippy ``.
126
126
127
127
128
+ cargo
129
+ *****
130
+
131
+ ``cargo `` is the Rust native build system. It is currently required to run
132
+ the tests (``rusttest `` target) since we use it to build a custom standard
133
+ library that contains the facilities provided by our custom ``alloc ``.
134
+
135
+ If you are using ``rustup ``, all the profiles already install the tool,
136
+ so you should be good to go. The standalone installers also include ``cargo ``.
137
+
138
+
128
139
rustdoc
129
140
*******
130
141
131
- If you install the ``rustdoc `` tool, then you will be able to generate pretty
132
- HTML documentation for Rust code, including for the libraries (crates) inside
133
- ``rust/ `` that are used by the rest of the kernel (for details, please see
134
- :ref: `Documentation/rust/docs.rst <rust_docs >`).
142
+ ``rustdoc `` is the documentation tool for Rust. It generates pretty HTML
143
+ documentation for Rust code (for details, please see
144
+ :ref: `Documentation/rust/docs.rst <rust_docs >`.
145
+
146
+ ``rustdoc `` is also able to test the examples provided in documented Rust code
147
+ (called doctests or documentation tests). We use this feature, thus ``rustdoc ``
148
+ is required to run the tests (``rusttest `` target).
135
149
136
150
If you are using ``rustup ``, all the profiles already install the tool,
137
- so you should be good to go. The standalone installers also come with ``rustdoc ``.
151
+ so you should be good to go. The standalone installers also include ``rustdoc ``.
138
152
139
153
140
154
rust-analyzer
0 commit comments