| From: |
| Miguel Ojeda <ojeda-AT-kernel.org> |
| To: |
| Jonathan Corbet <corbet-AT-lwn.net>, Miguel Ojeda <ojeda-AT-kernel.org>, Wedson Almeida Filho <wedsonaf-AT-gmail.com>, Alex Gaynor <alex.gaynor-AT-gmail.com> |
| Subject: |
| [PATCH] docs: rust: add "The Rust experiment" section |
| Date: |
| Wed, 18 Oct 2023 18:09:22 +0200 |
| Message-ID: |
| <20231018160922.1018962-1-ojeda@kernel.org> |
| Cc: |
| Boqun Feng <boqun.feng-AT-gmail.com>, Gary Guo <gary-AT-garyguo.net>, Björn Roy Baron <bjorn3_gh-AT-protonmail.com>, Benno Lossin <benno.lossin-AT-proton.me>, Andreas Hindborg <a.hindborg-AT-samsung.com>, Alice Ryhl <aliceryhl-AT-google.com>, Andrew Lunn <andrew-AT-lunn.ch>, linux-doc-AT-vger.kernel.org, rust-for-linux-AT-vger.kernel.org, linux-kernel-AT-vger.kernel.org, patches-AT-lists.linux.dev |
| Archive-link: |
| Article |
Clarify that the Rust experiment is still going on to avoid
confusion for both kernel maintainers and end users.
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
Andrew: I did not add a `Suggested-by` just in case, but please let me know
if you want it, of course.
Documentation/rust/index.rst | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/Documentation/rust/index.rst b/Documentation/rust/index.rst
index e599be2cec9b..aaed36af15ce 100644
--- a/Documentation/rust/index.rst
+++ b/Documentation/rust/index.rst
@@ -6,6 +6,23 @@ 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.
+
+In particular, if you are an end user, please note that there are no in-tree
+drivers/modules suitable or intended for production use yet.
+
+
.. only:: rustdoc and html
You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.
base-commit: 94f6f0550c625fab1f373bb86a6669b45e9748b3
--
2.42.0
