Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.32 as permitted sender) client-ip=23.128.96.32;
Message-ID: <dcb9d0bb-67a3-2f50-9d17-251baa24b066@amd.com>
Date:   Mon, 23 Oct 2023 09:34:02 -0500
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.15.1
Subject: Re: [PATCH] docs: rust: add "The Rust experiment" section
Content-Language: en-US
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>,
        =?UTF-8?Q?Bj=c3=b6rn_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
References: <20231018160922.1018962-1-ojeda@kernel.org>
From:   Carlos Bilbao <carlos.bilbao@amd.com>
In-Reply-To: <20231018160922.1018962-1-ojeda@kernel.org>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?dHByNzhEQ25JNWtnZFJSTG8vUFp5TXJBakhnNzRqemptWHNXRDhIWXBUTVdk?=
 =?utf-8?B?dDhlOUFYZy8wMHM5bDhPLzRhUSs5citvUlF4T3hidTRVaVh3UThqKzB5UUM4?=
 =?utf-8?B?S3ptVGZibGg5alAxRjNLekI0NG5oMFhpTnl2NzVPTnh5L0JHWHJldHFOTFc2?=
 =?utf-8?B?Y2JESXNPQWd1R0JKdmxGUFQ0S3BFQU5LNTBzVVFqRTU1UXNUZWQvc1FTK0po?=
 =?utf-8?B?VlN3QzgwNFMxUE1LZ0I2Y0kwTko0Y0J5M1JNdlU1bjlMVTBWK1ZLMXRiUjhx?=
 =?utf-8?B?Z2F1eXM5SDV1S1JneUtsQjU4NHFFQ2oyL2xySkNJT0U2N1pYTVlJVUtadEg1?=
 =?utf-8?B?eWFyUzA5RDNIc2hNZHgrVHBHMHNOWll1bmlacmREMWRldk1vb3puN0hXYjNp?=
 =?utf-8?B?b1l2YjZRS3k1SjJEM3F0ekZqRk85UTRWU00yRGVFdnZWSzFCaUthZFNIcHpr?=
 =?utf-8?B?NGtYT2lrblV4dXdRY2VDQkw3b1dmbFRGL3FlM0dLS2dNZkNRUWJ1SHh1Kytp?=
 =?utf-8?B?Tzd4cjY4YXhlL3dkYVFSRWFXbHBQN2tyRlNUcFJ2bVVNcCtWY3dJZGIzNkp1?=
 =?utf-8?B?aXg4U1o1ZkJscXlMT0lQcnk0MUdDdzl5VElvRUJlajRHb3hnMUZBRlplUG5z?=
 =?utf-8?B?ZjZ1SE8yZGM1bU1pVXJ2cUl4d3Z1S3BWQ3J6ZmFiSVJMN21VSTRwcEkyUCtK?=
 =?utf-8?B?ZFlTMkpHVUZkd1crcTZaelZBekFTc1ZxVFdVOTNNTGROc2M4dXRrVS84UDVj?=
 =?utf-8?B?emNpS2tvbW1uOTlZWXl0akpKOGtMQnY0MGcwV3BQSGxNUDBPYnc0YTRzYWZ4?=
 =?utf-8?B?VG1wYXI4bFYrYVhQMXZLa2NkT0FyRGs0YTB5aEdRaWJDSUtOWVdZVi9JNlph?=
 =?utf-8?B?NGZ0Yjg2Y2xTZzl5amxqWVM5aDYyNjN6VVEySm02VjZLMlF5VUNydFFNQ2lr?=
 =?utf-8?B?Y0Q2MFd2Y2dwQjBZZisxa096b2lCRzVmNjA4NVVyOHFHdnhORzU4VVJwekVP?=
 =?utf-8?B?RXQ0aDJhRkQ5bFhyeUNKeWxyNm5JQktUeDNqOXdCTktSelJPZTZwbmt3cnll?=
 =?utf-8?B?NkVuNzd6Sy9XcUo4Y0FXdTRUOGsveXJQM0NhZVg5ME9EY2djdTJGeVJqSWlX?=
 =?utf-8?B?dndSOTh1RzdaZHRBOE1UWUt3MTF6dWVYNWhpNGNFaDhBbzcrM1VPNTM5dnlU?=
 =?utf-8?B?TTJkRGtsQjlIVVdKTXFUSE9OQnBTV0pVaWQrVCtzN256RUo3VUJZZXRuMDA1?=
 =?utf-8?B?d0loc0tOQ1RjUzFYVjgzb0lRYVZEMGN1aU1BaG1jbkRpWlp3bnpHRjI3a3I5?=
 =?utf-8?B?MjAzMlRsMndWNHhjZmF2NTdONlVKR2MrcjZlY2M2K2lzcDRwK1U1c2FtZDM3?=
 =?utf-8?B?cmhwdWtpR3pSSzVxcUlnSUFVSCs2cUhFYndKK0E5UE0wdjA3VVRoWmRxbjlN?=
 =?utf-8?B?UENRZ1ZRVU1GMDdUV29TRS8zZVJoTXRHMThKQTJrblVvbUplaGZCWldaYkFR?=
 =?utf-8?B?eFlOUVdJZUxnVFFSaXlyS2J5WTZNbFlLbFRGdlJTWXpsSzFmRE0za3JnYjgr?=
 =?utf-8?B?SUs3cGtwbi95dmVWOS9jQU1GQUJsMk1lYXc1ZDZOSE9GTnJ3WmM1SEh3bVZB?=
 =?utf-8?B?V3ZFdFVPYlF3c08yak5TZ2dWYTBiOTYxTW9zUTNhUVlGTFlmYm5FT28zREV4?=
 =?utf-8?B?ckRVZ0d5TTMyQTlGK2MrOVNmc2RjUmgvQlVJb1c4WVZ1clZYeG90RE42MWJC?=
 =?utf-8?B?U2tPSVdTQmIwOTdzTGhiT0VvU1FiRFlrQUtLL2NqSldlZ2czYWF6V2VBQ0VS?=
 =?utf-8?B?ZklvYjZ4b3FPSUJRWnNETFlSZU8rcUllalJkYkZhR0dPVEV2aHpnL21Sdi90?=
 =?utf-8?B?YTNpMnQvbFFhWTdzZ25zNEF2SWhDSS9EcEdLRWZoUG5PRDFORHZJVGNobHdW?=
 =?utf-8?B?UmlwUHExUThzSU1xUHNPNWlvL3EzK1B3TlRxSXlMazc2SHJ5MHFrbDl2UEY4?=
 =?utf-8?B?MWtHeXBMdk9YbTRHWXozU1k1cy95cXROMmtiOXRJR0ZUeWF0Ym5GM0R3d0ZK?=
 =?utf-8?B?eEozejRyQ0xOdFpRRUJVUURlM2xvdmpyRnJtalJhMmNYR2E0cEFMbHRDQkZq?=
 =?utf-8?Q?TwX4NTqEfv6nHyD2bzj+eH5UA?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 5fe2b0a7-c255-42e5-7adc-08dbd3d51b9b
X-MS-Exchange-CrossTenant-AuthSource: BL1PR12MB5874.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Oct 2023 14:34:04.9261
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 8BAdX0XR1BV4XQxL1UaYUDmf7XzBH1Dn9AmUPQ3GCrfLkmI8CkjXR49/gPCZTfUYKDjCpIO0kk+FMrNlSx1Fkg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR12MB4240
X-Spam-Status: No, score=-4.2 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS
	autolearn=unavailable autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on agentk.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (agentk.vger.email [0.0.0.0]); Mon, 23 Oct 2023 07:34:20 -0700 (PDT)

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