mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-03-11 20:11:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help/dev: Adopt clang-format instructions in coding guide

Browse Source 
Simplify the `CONTRIBUTING.rst` document by moving the code style
section over to our dedicated coding guide and linking to it instead.
This commit is contained in:
Brad King
2017-04-19 16:19:55 -04:00
parent 540b4cdc2b
commit 0fd255adf5
2 changed files with 16 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.rst
View File

@@ -25,6 +25,7 @@ To contribute patches:
#. Fork the upstream `CMake Repository`_ into a personal account. #. Fork the upstream `CMake Repository`_ into a personal account.
#. Run `Utilities/SetupForDevelopment.sh`_ for local configuration. #. 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. #. Base all new work on the upstream ``master`` branch.
#. Create commits making incremental, distinct, logically complete changes. #. Create commits making incremental, distinct, logically complete changes.
#. Push a topic branch to a personal repository fork on GitLab. #. 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 .. _`Kitware's GitLab Instance`: https://gitlab.kitware.com
.. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake .. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake
.. _`Utilities/SetupForDevelopment.sh`: Utilities/SetupForDevelopment.sh .. _`Utilities/SetupForDevelopment.sh`: Utilities/SetupForDevelopment.sh
.. _`CMake Source Code Guide`: Help/dev/source.rst
.. _`CMake Review Process`: Help/dev/review.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 License
======= =======

14
Help/dev/source.rst
View File

@@ -5,3 +5,17 @@ The following is a guide to the CMake source code for developers.
See documentation on `CMake Development`_ for more information. See documentation on `CMake Development`_ for more information.
.. _`CMake Development`: README.rst .. _`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