clang-format: add configuration file

[thirdparty/linux.git] / Documentation / process / coding-style.rst

diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index d98deb62c4002c9341589a8416a78d81b304ae60..4e7c0a1c427a9ae8d4bee3b0796c0ec5363c293e 100644 (file)
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -631,6 +631,14 @@ options ``-kr -i8`` (stands for ``K&R, 8 character indents``), or use
 re-formatting you may want to take a look at the man page.  But
 remember: ``indent`` is not a fix for bad programming.
 
+Note that you can also use the ``clang-format`` tool to help you with
+these rules, to quickly re-format parts of your code automatically,
+and to review full files in order to spot coding style mistakes,
+typos and possible improvements. It is also handy for sorting ``#includes``,
+for aligning variables/macros, for reflowing text and other similar tasks.
+See the file :ref:`Documentation/process/clang-format.rst <clangformat>`
+for more details.
+
 
 10) Kconfig configuration files
 -------------------------------