summaryrefslogtreecommitdiffstats
path: root/Source/kwsys/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-05-26 15:12:57 (GMT)
committerKitware Robot <kwrobot@kitware.com>2017-05-26 15:13:45 (GMT)
commit256481499d56589e98659bd069d7f8a2fd653546 (patch)
tree33eb56b12a45868b48bcdd2b6193bff95d171a37 /Source/kwsys/CONTRIBUTING.rst
parent83e4a8e63713c3e99f81aac2973763c6252846bc (diff)
parent867b17428a02b3cfb337624988206ed9500aa646 (diff)
downloadCMake-256481499d56589e98659bd069d7f8a2fd653546.zip
CMake-256481499d56589e98659bd069d7f8a2fd653546.tar.gz
CMake-256481499d56589e98659bd069d7f8a2fd653546.tar.bz2
Merge topic 'update-kwsys'
867b1742 Merge branch 'upstream-KWSys' into update-kwsys 402c6c12 KWSys 2017-05-25 (160bed45) Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !890
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