Update clang-tools page with instructions for obtaining clang-format-8

SmingHub · Oct 31, 2024 · 6281fc6 · 6281fc6
1 parent 0447ab4
commit 6281fc6
Showing 1 changed file with 28 additions and 12 deletions.
diff --git a/docs/source/information/develop/clang-tools.rst b/docs/source/information/develop/clang-tools.rst
@@ -15,16 +15,25 @@ Note that *clang-format* is part of the main **Clang** project, whilst *clang-ti
 found in **clang-tools-extra**.
 
 
-Installation
+clang-format
 ------------
 
-In Ubuntu you should be able to install them using the following command::
+Installation
+~~~~~~~~~~~~
 
-   sudo apt-get install clang-format clang-tidy
+Sming requires version 8 which is generally no longer available in the standard repositories for recent GNU/Linux distributions.
+You can find standalone builds at https://github.com/muttleyxd/clang-tools-static-binaries/releases.
+
+For example:
+
+```
+export CLANG_FORMAT=/opt/clang-format-8
+wget https://github.com/muttleyxd/clang-tools-static-binaries/releases/download/master-32d3ac78/clang-format-8_linux-amd64 -O /opt/clang-format-8
+chmod +x $CLANG_FORMAT
+```
+
+You should persist the definition for :envvar:`CLANG_FORMAT` as Sming uses this when running the ``make cs`` commands (see below).
 
-See the the `download <http://releases.llvm.org/download.html>`__ page
-of the Clang project for installation instructions for other operating
-systems.
 
 .. important::
 
@@ -37,10 +46,6 @@ systems.
    You should install the same version on your development computer.
 
 
-
-clang-format
-------------
-
 Rules
 ~~~~~
 
@@ -114,12 +119,23 @@ C, C++ or header file or a selection in it and run the ``Format`` command
 clang-tidy
 ----------
 
-Configuration
-~~~~~~~~~~~~~
+Installation
+~~~~~~~~~~~~
 
 No specific version is required but generally you should aim to use the most recent version
 available in your distribution. Version 17.0.6 was used at time of writing these notes.
 
+In Ubuntu you should be able install using the following command::
+
+   sudo apt-get install clang-tidy
+
+See the the `download <http://releases.llvm.org/download.html>`__ page
+of the Clang project for installation instructions for other operating
+systems.
+
+Configuration
+~~~~~~~~~~~~~
+
 The default tool configuration is defined in the
 `.clang-tidy <https://github.com/SmingHub/Sming/blob/develop/.clang-tidy>`__
 file, located in the root directory of the framework.