summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorKWSys Upstream <kwrobot@kitware.com>2017-05-25 13:40:27 (GMT)
committerBrad King <brad.king@kitware.com>2017-05-25 13:40:58 (GMT)
commit402c6c121c924e68c17ce04de8dc5d28dac6fa6e (patch)
treebcabf00ea8ce999c13bbb8fb925fbde75722365c /CONTRIBUTING.rst
parent47a8ff3491cf4892eb2b28048b5f987a4ec1187a (diff)
downloadCMake-402c6c121c924e68c17ce04de8dc5d28dac6fa6e.zip
CMake-402c6c121c924e68c17ce04de8dc5d28dac6fa6e.tar.gz
CMake-402c6c121c924e68c17ce04de8dc5d28dac6fa6e.tar.bz2
KWSys 2017-05-25 (160bed45)
Code extracted from: https://gitlab.kitware.com/utils/kwsys.git at commit 160bed451833380e9f6ddc60e709ab6800bf2129 (master). Upstream Shortlog ----------------- Brad King (1): 51859eab CONTRIBUTING: Specify clang-format version used for code style Florian Maushart (2): 684bcda6 SystemInformation: Expose CPU feature flags publicly 70b8332f SystemInformation: Add CPU_FEATURE_FPU flag
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index d71832a..70a313e 100644
--- a/CONTRIBUTING.rst
+++ b/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