Skip to content

Commit 3519c4d

Browse files
nickdesaulniersJonathan Corbet
authored and
Jonathan Corbet
committed
Documentation: add minimum clang/llvm version
Based on a vote at the LLVM BoF at Plumbers 2020, we decided to start small, supporting just one formal upstream release of LLVM for now. We can probably widen the support window of supported versions over time. Also, note that LLVM's release process is different than GCC's. GCC tends to have 1 major release per year while releasing minor updates to the past 3 major versions. LLVM tends to support one major release and one minor release every six months. Signed-off-by: Nick Desaulniers <ndesaulniers@google.com> Tested-by: Gustavo A. R. Silva <gustavoars@kernel.org> Tested-by: Nathan Chancellor <natechancellor@gmail.com> Reviewed-by: Kees Cook <keescook@chromium.org> Reviewed-by: Nathan Chancellor <natechancellor@gmail.com> Reviewed-by: Masahiro Yamada <masahiroy@kernel.org> Acked-by: Will Deacon <will@kernel.org> Link: https://lore.kernel.org/r/20200826191555.3350406-1-ndesaulniers@google.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
1 parent eb45fb2 commit 3519c4d

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

Documentation/kbuild/llvm.rst

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _kbuild_llvm:
2+
13
==============================
24
Building Linux with Clang/LLVM
35
==============================
@@ -73,6 +75,8 @@ Getting Help
7375
- `Wiki <https://github.com/ClangBuiltLinux/linux/wiki>`_
7476
- `Beginner Bugs <https://github.com/ClangBuiltLinux/linux/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`_
7577

78+
.. _getting_llvm:
79+
7680
Getting LLVM
7781
-------------
7882

Documentation/process/changes.rst

+15
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ you probably needn't concern yourself with pcmciautils.
3030
Program Minimal version Command to check the version
3131
====================== =============== ========================================
3232
GNU C 4.9 gcc --version
33+
Clang/LLVM (optional) 10.0.1 clang --version
3334
GNU make 3.81 make --version
3435
binutils 2.23 ld -v
3536
flex 2.5.35 flex --version
@@ -68,6 +69,15 @@ GCC
6869
The gcc version requirements may vary depending on the type of CPU in your
6970
computer.
7071

72+
Clang/LLVM (optional)
73+
---------------------
74+
75+
The latest formal release of clang and LLVM utils (according to
76+
`releases.llvm.org <https://releases.llvm.org>`_) are supported for building
77+
kernels. Older releases aren't guaranteed to work, and we may drop workarounds
78+
from the kernel that were used to support older versions. Please see additional
79+
docs on :ref:`Building Linux with Clang/LLVM <kbuild_llvm>`.
80+
7181
Make
7282
----
7383

@@ -331,6 +341,11 @@ gcc
331341

332342
- <ftp://ftp.gnu.org/gnu/gcc/>
333343

344+
Clang/LLVM
345+
----------
346+
347+
- :ref:`Getting LLVM <getting_llvm>`.
348+
334349
Make
335350
----
336351

0 commit comments

Comments
 (0)