Received-SPF: pass (google.com: domain of linux-kernel+bounces-1467-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Message-ID: <43a1013b-9b88-4af2-a39d-a7f29894e4a9@nvidia.com>
Date: Fri, 15 Dec 2023 09:48:25 -0800
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH] docs: rust: remove `CC=clang` mentions
To: Miguel Ojeda <ojeda@kernel.org>, 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>, rust-for-linux@vger.kernel.org,
 linux-kernel@vger.kernel.org, patches@lists.linux.dev,
 Jonathan Corbet <corbet@lwn.net>, Nathan Chancellor <nathan@kernel.org>,
 Nick Desaulniers <ndesaulniers@google.com>, Bill Wendling
 <morbo@google.com>, Justin Stitt <justinstitt@google.com>,
 linux-doc@vger.kernel.org, llvm@lists.linux.dev
References: <20231215124751.175191-1-ojeda@kernel.org>
Content-Language: en-US
From: John Hubbard <jhubbard@nvidia.com>
In-Reply-To: <20231215124751.175191-1-ojeda@kernel.org>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?WGRBN1orZU9OTUtlRmd6bFRNWW51b2FnUzFDNlhwbVZYRmZKdXFDRzB2cUt5?=
 =?utf-8?B?Tnd4R2lSaVZRMTFUYisrYkZzUnhWRVIzcjN1L0pOeTd4NE00QS9FR21ZQVlE?=
 =?utf-8?B?ZzNYdjJYUy8ydXlXMDd4QUhNY25XY0pGZFpkVE9lMk52aVcxOEtUTEVHaWJQ?=
 =?utf-8?B?SmYwUGw3cEpRcnEwYzRYWjd2NUgyTkxHR2dVSEZFb0ZFblJqZWw4SEttZGRl?=
 =?utf-8?B?bmNQNmVqb1BCejJtbDBUVEtmR2Jlc2FvTXd1VDAzcjBqMzlOVGZpRHl2OVBL?=
 =?utf-8?B?NVB1elppWlhKUFlmS1RPZGkrT05MeGtwVmNTYUhGTi9lS1FqeHdsQkNyRjhR?=
 =?utf-8?B?UEw0M0xHVThCSW52WWdiRDNPdHAxRncrL2txZk90TlZLdDExcmphM09kd1d6?=
 =?utf-8?B?TU5CSXNTRVh3dWd4UGoyeXlMSzdiZy9NejFMeUhXN1oyYkZITFlkNTZPUnJ5?=
 =?utf-8?B?Zzh0cEpVK3E1Ukp4bVZrQk40djRpWXJYeWV1WkJMWVF6NGE0aWI1UXdOKzNQ?=
 =?utf-8?B?RVdreEtXSjBIenZsVFJ3R3RIQi9BdDNScnNqVDZHSEhXVXFJTGQvSSthT2xp?=
 =?utf-8?B?d3hOeEFLQXF6bkkwblQweldBb1BqNitzQkdtLzBobzczSmc1Uzk1R1hkamdJ?=
 =?utf-8?B?L3RuR2Jma2MvNGhZN0ZrT0tCUmxqUDVlUU5oYVY2eVB3b3hka083WS9xeUZP?=
 =?utf-8?B?RmFrdndHOXQxdFFUaEJUNzllbW0raEhrQkhWQ0dXV3EvdDU2Z0E5ZDh2QTB1?=
 =?utf-8?B?amlVVUNuaFFKMUdoendzUnIyZklKMWFIT2dwQVZMSUdkK3NWT2VaSnVTdXND?=
 =?utf-8?B?cjBxRk93NnFWaTNDL1VHWGtkUmdGam5Dcmc3NE4rL2tpTFJmNjF5K3I2Nm5H?=
 =?utf-8?B?UEJ5NWhqNTFsMkFtYWdSMldTVVpFOGFUc3AzZUNuYnNLZno4Qi95TEtoT2hC?=
 =?utf-8?B?aVY5VktJQk1HY1V6YVY2T3Z3ZzUrVWpXYi9seVkzQjZXS205MjZVMkdZUUUr?=
 =?utf-8?B?K2JMQ3NldkNMS0xsM3htL3JyUGFyeGdPcnE0aC9ZOWJieGQ3dTNaNERYM1BW?=
 =?utf-8?B?NWQ3T1hVSWtaekpKbW15bkYyOGozUEw3a0thRTMyUU1JKzFtdjZQKzhUUG5W?=
 =?utf-8?B?VWUzTnUrRGV4c2FoYm82VC8rZk9NUXFBb1REV0M0a3NNSDR5bmd5cU94U3kv?=
 =?utf-8?B?M0NNcDh4SjROekcxcFVOMm5Vd3p4eEZYNGJUQzJZeG5YNS9kMDdzdWI3Y3BP?=
 =?utf-8?B?YTMvUUhMRmlWREdYY1Y0d1N6dDduRG1yNm1IYjI1QTBibjV4NFF0blJsUlRx?=
 =?utf-8?B?c2dQY2ZxUjhBSTg2M3FjcFM5SFR3QmRIVnliSy9ZTVZQeWNTUDFJZzRHQlVt?=
 =?utf-8?B?RDV5ajRkWkI5UWROVWh3QWxZWHQvYkJRM1UzbVlzbXU3UUlUaGlKdlBPOUl2?=
 =?utf-8?B?YWdYcTVoMGV5dFJMZ2RyTHl5RE5uWTRrZnVwZ1drNjd3d2dybElsL1pncE9W?=
 =?utf-8?B?Z3ZhTktMb3hlWFJWbzgyU1laQ0ZMSkRoKy9BOW5xaWt3ZlZtRU16SXhtRnM0?=
 =?utf-8?B?aFlhV2x6aGFzSjR6SkhaVWVNVTVOSTJpRkJNd2hPVVFETnFpSGNEcHdBcy9h?=
 =?utf-8?B?R2NCOU1tODJTYlFWS1dmcFBHV2F1L3Q2TzhZVEFWNUg5SFpKNTZDakVVKzlq?=
 =?utf-8?B?OU5GOEVTYUQ3MXN6dGgvRnlzYVEySnhSYzFpUk5DQnNzTzJsZVc2R25JeCtB?=
 =?utf-8?B?VVljMW1KVFYvNkljaVkyZDNLUXZFTisvZ1QxbzdvV0tONnFRampjblNSdkd4?=
 =?utf-8?B?WVBwY0ZzRktPQlJZTnVhV2lYUk1YWjM0T1dhOFlEOFdXbmJBSktNVVRlMjFE?=
 =?utf-8?B?eDg3OGEyK3hmQ1FBendRWnJPa3NPSE1mOGxYUnhVeFNRbTgyM2grek1RZUo0?=
 =?utf-8?B?dFV0ZTFDLzJqdnkvd3RualVVVDhMUVp2SFlJYmVQdEV5a3lVdzF1WVBVVEc0?=
 =?utf-8?B?eXdrbTRNamhuWmVKZk5rY25acFZCRU85VXZuNHllQmp5c0lXVTF1YmpxYm1G?=
 =?utf-8?B?U0dCSHMxNXRDcTlWMThGcXNpVDJTRDRvVXhNLzVvT2IvYWRITmVYR05GVU1s?=
 =?utf-8?B?dkNBcU84WVpaMmZ6TXBJUzVCUlBoWkljYld5VSsvdnlyM29ZdGFtcER4aTUr?=
 =?utf-8?B?enc9PQ==?=
X-OriginatorOrg: Nvidia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 1b2974b7-cdba-4aab-611f-08dbfd961b90
X-MS-Exchange-CrossTenant-AuthSource: BY5PR12MB4130.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Dec 2023 17:48:55.3854
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: W4woBavSoFM3SNI+BUFsZoRmcLWEY3fzOG/KZNlvpmtwlUitHG49nMjNY32y6qFBY+Qm9EbDOYDHkU9HfCIKMA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS7PR12MB5911

On 12/15/23 04:47, Miguel Ojeda wrote:
> Nowadays all architectures except s390 recommend using `LLVM=1` instead of
> `CC=clang`, and since commit a3c6bfba4429 ("Documentation/llvm: refresh
> docs") the Kbuild LLVM documentation makes `LLVM=1` the way to go:
> 
>      We want to encourage the use of ``LLVM=1`` rather than just
>      ``CC=clang``. Make that suggestion "above the fold" and "front and
>      center" in our docs.
> 
> In particular, that commit removes the examples with `CC=clang`.
> 
> Thus do the same in the Rust Quick Start guide, i.e. remove the `CC=clang`
> mentions, especially since the architectures that have had their Rust
> support upstreamed (or soon to be upstreamed) are all `LLVM=1` ones
> anyway. And perhaps by the time Rust is supported for s390 (or new
> architectures), it may have moved to `LLVM=1` anyway. Otherwise,
> this can be added back if needed (or perhaps an extra link to
> Documentation/kbuild/llvm.rst).
> 
> This should also help avoiding potential confusion around `CC=clang` [1].

Yes it should. :)

Reviewed-by: John Hubbard <jhubbard@nvidia.com>


thanks,
-- 
John Hubbard
NVIDIA

> 
> Link: https://lore.kernel.org/rust-for-linux/6df6e8e5-8d5b-4d3d-91b5-bc0e90c424ea@nvidia.com/ [1]
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---
>   Documentation/rust/quick-start.rst | 6 +-----
>   1 file changed, 1 insertion(+), 5 deletions(-)
> 
> diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst
> index f382914f4191..75faa987079a 100644
> --- a/Documentation/rust/quick-start.rst
> +++ b/Documentation/rust/quick-start.rst
> @@ -76,7 +76,7 @@ libclang
>   
>   ``libclang`` (part of LLVM) is used by ``bindgen`` to understand the C code
>   in the kernel, which means LLVM needs to be installed; like when the kernel
> -is compiled with ``CC=clang`` or ``LLVM=1``.
> +is compiled with ``LLVM=1``.
>   
>   Linux distributions are likely to have a suitable one available, so it is
>   best to check that first.
> @@ -229,10 +229,6 @@ at the moment. That is::
>   
>   	make LLVM=1
>   
> -For architectures that do not support a full LLVM toolchain, use::
> -
> -	make CC=clang
> -
>   Using GCC also works for some configurations, but it is very experimental at
>   the moment.
>   
> 
> base-commit: a39b6ac3781d46ba18193c9dbb2110f31e9bffe9