summaryrefslogtreecommitdiffstats
path: root/Source/kwsys/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-05-25 13:40:59 (GMT)
committerBrad King <brad.king@kitware.com>2017-05-25 13:40:59 (GMT)
commit867b17428a02b3cfb337624988206ed9500aa646 (patch)
tree1fb929664f9e7dcb7531f9b0db9ea7727f4a9a9e /Source/kwsys/CONTRIBUTING.rst
parentbc2cfd7c98d6a238710504172f78321d099d0eaa (diff)
parent402c6c121c924e68c17ce04de8dc5d28dac6fa6e (diff)
downloadCMake-867b17428a02b3cfb337624988206ed9500aa646.zip
CMake-867b17428a02b3cfb337624988206ed9500aa646.tar.gz
CMake-867b17428a02b3cfb337624988206ed9500aa646.tar.bz2
Merge branch 'upstream-KWSys' into update-kwsys
* upstream-KWSys: KWSys 2017-05-25 (160bed45)
Diffstat (limited to 'Source/kwsys/CONTRIBUTING.rst')
-rw-r--r--Source/kwsys/CONTRIBUTING.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/Source/kwsys/CONTRIBUTING.rst b/Source/kwsys/CONTRIBUTING.rst
index d71832a..70a313e 100644
--- a/Source/kwsys/CONTRIBUTING.rst
+++ b/Source/kwsys/CONTRIBUTING.rst
@@ -27,10 +27,12 @@ copies of KWSys within dependent projects can be updated to get the changes.
Code Style
==========
-We use `clang-format`_ to define our style for C++ code in the KWSys source
-tree. See the `.clang-format`_ configuration file for our style settings.
-Use ``clang-format`` version 3.8 or higher to format source files.
-See also the `clang-format.bash`_ script.
+We use `clang-format`_ version **3.8** to define our style for C++ code in
+the KWSys source tree. See the `.clang-format`_ configuration file for
+our style settings. Use the `clang-format.bash`_ script to format source
+code. It automatically runs ``clang-format`` on the set of source files
+for which we enforce style. The script also has options to format only
+a subset of files, such as those that are locally modified.
.. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html
.. _`.clang-format`: .clang-format