Skip to content

Commit 3857af3

Browse files
committed
docs: rust: add "The Rust experiment" section
Clarify that the Rust experiment is still going on to avoid confusion for both kernel maintainers and end users. Reviewed-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20231018160922.1018962-1-ojeda@kernel.org [ Changed last paragraph as discussed in the mailing list. ] Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
1 parent 6a5c032 commit 3857af3

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

Documentation/rust/index.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,25 @@ Rust
66
Documentation related to Rust within the kernel. To start using Rust
77
in the kernel, please read the quick-start.rst guide.
88

9+
10+
The Rust experiment
11+
-------------------
12+
13+
The Rust support was merged in v6.1 into mainline in order to help in
14+
determining whether Rust as a language was suitable for the kernel, i.e. worth
15+
the tradeoffs.
16+
17+
Currently, the Rust support is primarily intended for kernel developers and
18+
maintainers interested in the Rust support, so that they can start working on
19+
abstractions and drivers, as well as helping the development of infrastructure
20+
and tools.
21+
22+
If you are an end user, please note that there are currently no in-tree
23+
drivers/modules suitable or intended for production use, and that the Rust
24+
support is still in development/experimental, especially for certain kernel
25+
configurations.
26+
27+
928
.. only:: rustdoc and html
1029

1130
You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.

0 commit comments

Comments
 (0)