summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2016-05-17 13:33:02 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2016-05-17 13:33:02 (GMT)
commit7d2a0aa76c25d92f1e2a03778f5666bdd7e56b92 (patch)
tree2bdcf15abfef8e197173b5a135fe6b8391e43316 /CONTRIBUTING.rst
parent930ac45cbafca79eec9ae68e07c547b5c81b8c2c (diff)
parentd9fd2f5402eeaa345691313658e02b51038f570b (diff)
downloadCMake-7d2a0aa76c25d92f1e2a03778f5666bdd7e56b92.zip
CMake-7d2a0aa76c25d92f1e2a03778f5666bdd7e56b92.tar.gz
CMake-7d2a0aa76c25d92f1e2a03778f5666bdd7e56b92.tar.bz2
Merge topic 'clang-format-source'
d9fd2f54 Revise C++ coding style using clang-format 82df6dea Empty commit at end of history preceding clang-format style transition 6a13f43f CONTRIBUTING: Add a section on coding style bf451d9f Add a script to run clang-format on the entire source tree 1e90d78f Configure clang-format for CMake source tree da60adc3 Tell Git to use a distinct conflict marker size in `.rst` files
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 0e5c7e1..ddf8407 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -23,6 +23,16 @@ Please base all new work on the ``master`` branch. Then use
``git format-patch`` to produce patches suitable to post to
the mailing list.
+Code Style
+==========
+
+We use `clang-format`_ to define our style for C++ code in the CMake source
+tree. See the `.clang-format`_ configuration file for our style settings.
+Use ``clang-format`` version 3.8 or higher to format source files.
+
+.. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html
+.. _`.clang-format`: .clang-format
+
License
=======