linux-kernel - [PATCH] docs: rust: add "The Rust experiment" section

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20231018160922.1018962-1-ojeda@kernel.org>
Date:   Wed, 18 Oct 2023 18:09:22 +0200
From:   Miguel Ojeda <ojeda@...nel.org>
To:     Jonathan Corbet <corbet@....net>, Miguel Ojeda <ojeda@...nel.org>,
        Wedson Almeida Filho <wedsonaf@...il.com>,
        Alex Gaynor <alex.gaynor@...il.com>
Cc:     Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>,
        Björn Roy Baron <bjorn3_gh@...tonmail.com>,
        Benno Lossin <benno.lossin@...ton.me>,
        Andreas Hindborg <a.hindborg@...sung.com>,
        Alice Ryhl <aliceryhl@...gle.com>,
        Andrew Lunn <andrew@...n.ch>, linux-doc@...r.kernel.org,
        rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org,
        patches@...ts.linux.dev
Subject: [PATCH] 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.

Signed-off-by: Miguel Ojeda <ojeda@...nel.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