Linux Documentation
 help / color / mirror / Atom feed
From: Carlos Bilbao <carlos.bilbao@amd.com>
To: Miguel Ojeda <ojeda@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
	Wedson Almeida Filho <wedsonaf@gmail.com>,
	Alex Gaynor <alex.gaynor@gmail.com>
Cc: "Boqun Feng" <boqun.feng@gmail.com>,
	"Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <benno.lossin@proton.me>,
	"Andreas Hindborg" <a.hindborg@samsung.com>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Andrew Lunn" <andrew@lunn.ch>,
	linux-doc@vger.kernel.org, rust-for-linux@vger.kernel.org,
	linux-kernel@vger.kernel.org, patches@lists.linux.dev,
	andrew@lunn.ch
Subject: Re: [PATCH] docs: rust: add "The Rust experiment" section
Date: Mon, 23 Oct 2023 09:34:02 -0500	[thread overview]
Message-ID: <dcb9d0bb-67a3-2f50-9d17-251baa24b066@amd.com> (raw)
In-Reply-To: <20231018160922.1018962-1-ojeda@kernel.org>

On 10/18/23 11:09, Miguel Ojeda wrote:
> 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.
> +

Personally, I would rephrase this to:

"Please note that, as an end user, there are currently no in-tree drivers
or modules suitable or intended for production use."

Also, I believe this should go here and not in Quick Start. The average end
user, to whom this sentence seems to refer, typically begins his/her
learning journey from the index page of our website.

I think this will be helpful.

Reviewed-by: Carlos Bilbao <carlos.bilbao@amd.com>

> +
>   .. only:: rustdoc and html
> 
>   	You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.
> 
> base-commit: 94f6f0550c625fab1f373bb86a6669b45e9748b3
> --
> 2.42.0
> 

Thanks,
Carlos

  parent reply	other threads:[~2023-10-23 14:34 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-18 16:09 [PATCH] docs: rust: add "The Rust experiment" section Miguel Ojeda
2023-10-18 16:27 ` Andrew Lunn
2023-10-18 16:41   ` Miguel Ojeda
2023-10-18 21:05     ` Miguel Ojeda
2023-10-20 15:00     ` Andrew Lunn
2023-10-23 14:40       ` Carlos Bilbao
2023-10-24  8:55       ` Miguel Ojeda
2023-10-23 14:34 ` Carlos Bilbao [this message]
2023-10-24  9:16   ` Miguel Ojeda
2023-10-24 18:15     ` Carlos Bilbao
2023-10-25 10:12 ` Miguel Ojeda

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=dcb9d0bb-67a3-2f50-9d17-251baa24b066@amd.com \
    --to=carlos.bilbao@amd.com \
    --cc=a.hindborg@samsung.com \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=andrew@lunn.ch \
    --cc=benno.lossin@proton.me \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=corbet@lwn.net \
    --cc=gary@garyguo.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=ojeda@kernel.org \
    --cc=patches@lists.linux.dev \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=wedsonaf@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox