Commit 3519c4d6 authored by Nick Desaulniers's avatar Nick Desaulniers Committed by Jonathan Corbet
Browse files

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: default avatarNick Desaulniers <ndesaulniers@google.com>
Tested-by: default avatarGustavo A. R. Silva <gustavoars@kernel.org>
Tested-by: default avatarNathan Chancellor <natechancellor@gmail.com>
Reviewed-by: default avatarKees Cook <keescook@chromium.org>
Reviewed-by: default avatarNathan Chancellor <natechancellor@gmail.com>
Reviewed-by: default avatarMasahiro Yamada <masahiroy@kernel.org>
Acked-by: default avatarWill Deacon <will@kernel.org>
Link: https://lore.kernel.org/r/20200826191555.3350406-1-ndesaulniers@google.com


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent eb45fb2f

Documentation/kbuild/llvm.rst

+4 −0
Original line number Diff line number Diff line 
.. _kbuild_llvm:



==============================

Building Linux with Clang/LLVM

==============================
@@ -73,6 +75,8 @@ Getting Help 
- `Wiki <https://github.com/ClangBuiltLinux/linux/wiki>`_

- `Beginner Bugs <https://github.com/ClangBuiltLinux/linux/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`_



.. _getting_llvm:



Getting LLVM

-------------

Documentation/process/changes.rst

+15 −0
Original line number Diff line number Diff line
@@ -30,6 +30,7 @@ you probably needn't concern yourself with pcmciautils. 
        Program        Minimal version       Command to check the version

====================== ===============  ========================================

GNU C                  4.9              gcc --version

Clang/LLVM (optional)  10.0.1           clang --version

GNU make               3.81             make --version

binutils               2.23             ld -v

flex                   2.5.35           flex --version
@@ -68,6 +69,15 @@ GCC 
The gcc version requirements may vary depending on the type of CPU in your

computer.



Clang/LLVM (optional)

---------------------



The latest formal release of clang and LLVM utils (according to

`releases.llvm.org <https://releases.llvm.org>`_) are supported for building

kernels. Older releases aren't guaranteed to work, and we may drop workarounds

from the kernel that were used to support older versions. Please see additional

docs on :ref:`Building Linux with Clang/LLVM <kbuild_llvm>`.



Make

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


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



Clang/LLVM

----------



- :ref:`Getting LLVM <getting_llvm>`.



Make

----