diff options
| -rw-r--r-- | CONTRIBUTING.rst | 14 | ||||
| -rw-r--r-- | Help/dev/source.rst | 14 |
2 files changed, 16 insertions, 12 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 434f0f4..e219763 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -25,6 +25,7 @@ To contribute patches: #. Fork the upstream `CMake Repository`_ into a personal account. #. Run `Utilities/SetupForDevelopment.sh`_ for local configuration. +#. See the `CMake Source Code Guide`_ for coding guidelines. #. Base all new work on the upstream ``master`` branch. #. Create commits making incremental, distinct, logically complete changes. #. Push a topic branch to a personal repository fork on GitLab. @@ -35,20 +36,9 @@ The merge request will enter the `CMake Review Process`_ for consideration. .. _`Kitware's GitLab Instance`: https://gitlab.kitware.com .. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake .. _`Utilities/SetupForDevelopment.sh`: Utilities/SetupForDevelopment.sh +.. _`CMake Source Code Guide`: Help/dev/source.rst .. _`CMake Review Process`: Help/dev/review.rst -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. -See also the `Utilities/Scripts/clang-format.bash`_ script. - -.. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html -.. _`.clang-format`: .clang-format -.. _`Utilities/Scripts/clang-format.bash`: Utilities/Scripts/clang-format.bash - License ======= diff --git a/Help/dev/source.rst b/Help/dev/source.rst index dfde290..f70e477 100644 --- a/Help/dev/source.rst +++ b/Help/dev/source.rst @@ -5,3 +5,17 @@ The following is a guide to the CMake source code for developers. See documentation on `CMake Development`_ for more information. .. _`CMake Development`: README.rst + +C++ Code Style +============== + +We use `clang-format`_ version **3.8** to define our style for C++ code in +the CMake source tree. See the `.clang-format`_ configuration file for our +style settings. Use the `Utilities/Scripts/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 +.. _`Utilities/Scripts/clang-format.bash`: ../../Utilities/Scripts/clang-format.bash |