From: ejjordan Date: Tue, 26 Oct 2021 14:38:47 +0000 (+0200) Subject: Document clang11 in developer docs X-Git-Url: http://biod.pnpi.spb.ru/gitweb/?a=commitdiff_plain;h=20c16d2e1c1a989f9ece724a2bed0f037dd0ee56;p=alexxy%2Fgromacs.git Document clang11 in developer docs Instead of the no longer used clang7. Fixes #4173 --- diff --git a/docs/dev-manual/code-formatting.rst b/docs/dev-manual/code-formatting.rst index 7c93dbe2c9..e9718541d1 100644 --- a/docs/dev-manual/code-formatting.rst +++ b/docs/dev-manual/code-formatting.rst @@ -22,15 +22,15 @@ the code stays invariant under such formatting. Setting up clang-format ----------------------- -|Gromacs| formatting is enforced with clang-format 7.0.1. +|Gromacs| formatting is enforced with clang-format 11.0.1. :command:`clang-format` is one of the core *clang* tools. It may be included in a *clang* or *llvm* package from your favorite packaging system or you may find a standalone *clang-format* package, -but you should confirm that the provided command is version 7.0.1 or -7.1.0. Example:: +but you should confirm that the provided command is version 11.0.0 or 11.0.1. +Example:: $ clang-format --version - clang-format version 7.1.0 (tags/RELEASE_710/final) + clang-format version 11.0.0 If you use a different version of clang-format, you will likely get different formatting results than @@ -39,12 +39,12 @@ and the commits that you push will fail the automated tests. .. note:: - Refer to `LLVM `__ for + Refer to `LLVM `__ for source and binary downloads. If downloading sources, note that you will need to download both the *LLVM source code* and the *Clang source code*. As per the clang - `INSTALL.txt `__, + `INSTALL.txt `__, place the expanded clang source into a :file:`tools/clang` subdirectory within the expanded llvm archive, then run CMake against the llvm source directory. @@ -70,7 +70,7 @@ clang-format discovers which formatting rules to apply from the which will be automatically updated (if necessary) when you :command:`git pull` from the |Gromacs| repository. For more about the tool and the :file:`.clang-format` configuration file, -visit https://releases.llvm.org/7.0.1/tools/clang/docs/ClangFormat.html +visit https://releases.llvm.org/11.0.1/tools/clang/docs/ClangFormat.html What is automatically formatted? --------------------------------