Clarify that the Rust experiment is still going on to avoid
confusion for both kernel maintainers and end users.
Signed-off-by: Miguel Ojeda <[email protected]>
---
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
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 <[email protected]>
> ---
> 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 <[email protected]>
> +
> .. only:: rustdoc and html
>
> You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.
>
> base-commit: 94f6f0550c625fab1f373bb86a6669b45e9748b3
> --
> 2.42.0
>
Thanks,
Carlos
On Mon, Oct 23, 2023 at 4:34 PM Carlos Bilbao <[email protected]> wrote:
>
> 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."
Yeah, I think the "yet" -> "currently" change helps, so I took it. I
haven't changed the "if" to "as" because some readers are not really
end users but kernel developers/maintainers, so I think it could be a
bit confusing.
> I think this will be helpful.
>
> Reviewed-by: Carlos Bilbao <[email protected]>
Thanks! I have changed the paragraph to this, can I still use your
`Reviewed-by`?
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.
Cheers,
Miguel
On 10/24/23 04:16, Miguel Ojeda wrote:
> On Mon, Oct 23, 2023 at 4:34 PM Carlos Bilbao <[email protected]> wrote:
>>
>> 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."
>
> Yeah, I think the "yet" -> "currently" change helps, so I took it. I
> haven't changed the "if" to "as" because some readers are not really
> end users but kernel developers/maintainers, so I think it could be a
> bit confusing.
>
>> I think this will be helpful.
>>
>> Reviewed-by: Carlos Bilbao <[email protected]>
>
> Thanks! I have changed the paragraph to this, can I still use your
> `Reviewed-by`?
Yes, that's perfect.
>
> 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.
>
> Cheers,
> Miguel
Thanks,
Carlos
On Wed, Oct 18, 2023 at 6:09 PM Miguel Ojeda <[email protected]> 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 <[email protected]>
Applied to `rust-next`, with the new paragraph -- thanks everyone!
Cheers,
Miguel