diff options
author | Miguel Ojeda <ojeda@kernel.org> | 2023-10-18 18:09:22 +0200 |
---|---|---|
committer | Miguel Ojeda <ojeda@kernel.org> | 2023-10-25 03:14:00 +0200 |
commit | 3857af38e57a80b15b994e19d1f4301cac796481 (patch) | |
tree | b0787009561458f49b2f8cbee442f5fef4ff8026 | |
parent | 6a5c032c4b7e4262488703086ab280406dc51298 (diff) |
docs: rust: add "The Rust experiment" sectionrust-6.7
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>
-rw-r--r-- | Documentation/rust/index.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/Documentation/rust/index.rst b/Documentation/rust/index.rst index e599be2cec9b..965f2db529e0 100644 --- a/Documentation/rust/index.rst +++ b/Documentation/rust/index.rst @@ -6,6 +6,25 @@ Rust Documentation related to Rust within the kernel. To start using Rust in the kernel, please read the quick-start.rst guide. + +The Rust experiment +------------------- + +The Rust support was merged in v6.1 into mainline in order to help in +determining whether Rust as a language was suitable for the kernel, i.e. worth +the tradeoffs. + +Currently, the Rust support is primarily intended for kernel developers and +maintainers interested in the Rust support, so that they can start working on +abstractions and drivers, as well as helping the development of infrastructure +and tools. + +If you are an end user, please note that there are currently no in-tree +drivers/modules suitable or intended for production use, and that the Rust +support is still in development/experimental, especially for certain kernel +configurations. + + .. only:: rustdoc and html You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_. |