summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorKWSys Upstream <kwrobot@kitware.com>2016-11-09 14:12:29 (GMT)
committerBrad King <brad.king@kitware.com>2016-11-09 14:22:56 (GMT)
commit773b36e5d4af3ac040625e0ea16bcfd30fcdeb6d (patch)
treebd409d3f09f6714981a444e896e1bc08e22ee184 /CONTRIBUTING.rst
parent53862f04a0002894c0ef5aeb23d52495e5abe60d (diff)
downloadCMake-773b36e5d4af3ac040625e0ea16bcfd30fcdeb6d.zip
CMake-773b36e5d4af3ac040625e0ea16bcfd30fcdeb6d.tar.gz
CMake-773b36e5d4af3ac040625e0ea16bcfd30fcdeb6d.tar.bz2
KWSys 2016-11-09 (18c65411)
Code extracted from: http://public.kitware.com/KWSys.git at commit 18c654114de3aa65429542f95308720bc68f9231 (master). Upstream Shortlog ----------------- Brad King (14): 37306a1c FStream: Quiet unused argument warning 15e90a3c Sort includes to stabilize include order w.r.t. clang-format 26509227 Copyright.txt: Add notice of copyright by contributors fc42d3f2 Add temporary script to filter license notices c41c1bc4 Simplify KWSys per-source license notices 1d4c0b4a Remove temporary script that filtered license notices a4f5ef79 SystemInformation: Remove stray comment 8649a886 kwsysPrivate: Protect KWSYS_HEADER macro from clang-format 89b98af5 Configure clang-format for KWSys source tree 547dacad Add a script to run clang-format on the entire source tree aa94be0c CONTRIBUTING: Add a section on coding style 6604c4b6 Empty commit at end of history preceding clang-format style transition 2b3e2b1c Tell Git to not export 'clang-format' infrastructure 18c65411 FStream: Include Configure.hxx before other headers Kitware Robot (1): 6c973b46 Revise C++ coding style using clang-format
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 960eea4..47dffee 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -24,6 +24,19 @@ KWSys has no independent issue tracker. After encountering an issue
Otherwise please report the issue to the tracker for the project that
hosts the copy of KWSys in which the problem was found.
+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.
+
+.. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html
+.. _`.clang-format`: .clang-format
+.. _`clang-format.bash`: clang-format.bash
+
+
License
=======