diff options
author | Brad King <brad.king@kitware.com> | 2017-04-19 16:19:55 -0400 |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2017-04-19 16:33:06 -0400 |
commit | 0fd255adf52592e6443c15a68c09cfa7fc26e85b (patch) | |
tree | 8ed099d562f6b87ee224d1a4c74abd15c6bebd44 /CONTRIBUTING.rst | |
parent | 540b4cdc2bd7cb824c6cf7403857844b4fce4d6e (diff) | |
download | cmake-0fd255adf52592e6443c15a68c09cfa7fc26e85b.tar.gz |
Help/dev: Adopt clang-format instructions in coding guide
Simplify the `CONTRIBUTING.rst` document by moving the code style
section over to our dedicated coding guide and linking to it instead.
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 14 |
1 files changed, 2 insertions, 12 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 434f0f448a..e2197632a5 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 ======= |