Skip to content

Commit 7583ce6

Browse files
committed
docs: rust: remove CC=clang mentions
Nowadays all architectures except s390 recommend using `LLVM=1` instead of `CC=clang`, and since commit a3c6bfb ("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. 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]. Link: https://lore.kernel.org/rust-for-linux/6df6e8e5-8d5b-4d3d-91b5-bc0e90c424ea@nvidia.com/ [1] Reviewed-by: Ariel Miculas <amiculas@cisco.com> Reviewed-by: Nathan Chancellor <nathan@kernel.org> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Reviewed-by: Benno Lossin <benno.lossin@proton.me> Reviewed-by: Justin Stitt <justinstitt@google.com> Reviewed-by: John Hubbard <jhubbard@nvidia.com> Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com> Link: https://lore.kernel.org/r/20231215124751.175191-1-ojeda@kernel.org Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
1 parent bc2e7d5 commit 7583ce6

File tree

1 file changed

+1
-5
lines changed

1 file changed

+1
-5
lines changed

Documentation/rust/quick-start.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ libclang
7676

7777
``libclang`` (part of LLVM) is used by ``bindgen`` to understand the C code
7878
in the kernel, which means LLVM needs to be installed; like when the kernel
79-
is compiled with ``CC=clang`` or ``LLVM=1``.
79+
is compiled with ``LLVM=1``.
8080

8181
Linux distributions are likely to have a suitable one available, so it is
8282
best to check that first.
@@ -229,10 +229,6 @@ at the moment. That is::
229229

230230
make LLVM=1
231231

232-
For architectures that do not support a full LLVM toolchain, use::
233-
234-
make CC=clang
235-
236232
Using GCC also works for some configurations, but it is very experimental at
237233
the moment.
238234

0 commit comments

Comments
 (0)