Skip to content

Commit 246b7b0

Browse files
committed
doc: changes: add Rust and bindgen entries
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
1 parent 986b07e commit 246b7b0

1 file changed

Lines changed: 32 additions & 6 deletions

File tree

Documentation/process/changes.rst

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,12 @@ running a Linux kernel. Also, not all tools are necessary on all
2626
systems; obviously, if you don't have any PC Card hardware, for example,
2727
you probably needn't concern yourself with pcmciautils.
2828

29-
Furthermore, note that newer versions of the Rust toolchain may or may not work
30-
because, for the moment, we depend on some unstable features. Thus, unless you
31-
know what you are doing, use the exact version listed here. Please see
32-
:ref:`Documentation/rust/quick-start.rst <rust_quick_start>` for details.
33-
3429
====================== =============== ========================================
3530
Program Minimal version Command to check the version
3631
====================== =============== ========================================
3732
GNU C 5.1 gcc --version
3833
Clang/LLVM (optional) 10.0.1 clang --version
39-
rustc (optional) 1.58.0 rustc --version
34+
Rust (optional) 1.58.0 rustc --version
4035
bindgen (optional) 0.56.0 bindgen --version
4136
GNU make 3.81 make --version
4237
binutils 2.23 ld -v
@@ -85,6 +80,27 @@ kernels. Older releases aren't guaranteed to work, and we may drop workarounds
8580
from the kernel that were used to support older versions. Please see additional
8681
docs on :ref:`Building Linux with Clang/LLVM <kbuild_llvm>`.
8782

83+
Rust (optional)
84+
---------------
85+
86+
A particular version of the Rust toolchain is required. Newer versions may or
87+
may not work because the kernel depends on some unstable Rust features, for
88+
the moment.
89+
90+
Each Rust toolchain comes with several "components", some of which are required
91+
(like ``rustc``) and some that are optional. The ``rust-src`` component (which
92+
is optional) needs to be installed to build the kernel. Other components are
93+
useful for developing.
94+
95+
Please see :ref:`Documentation/rust/quick-start.rst <rust_quick_start>` for
96+
more information.
97+
98+
bindgen (optional)
99+
------------------
100+
101+
``bindgen`` is used to generate the Rust bindings to the C side of the kernel.
102+
It depends on ``libclang``.
103+
88104
Make
89105
----
90106

@@ -369,6 +385,16 @@ Clang/LLVM
369385

370386
- :ref:`Getting LLVM <getting_llvm>`.
371387

388+
Rust
389+
----
390+
391+
- :ref:`Documentation/rust/quick-start.rst <rust_quick_start>`.
392+
393+
bindgen
394+
-------
395+
396+
- :ref:`Documentation/rust/quick-start.rst <rust_quick_start>`.
397+
372398
Make
373399
----
374400

0 commit comments

Comments
 (0)