diff options
| author | Alexander Lohnau <alexander.lohnau@gmx.de> | 2021-01-20 12:57:22 +0000 |
|---|---|---|
| committer | Alexander Lohnau <alexander.lohnau@gmx.de> | 2021-01-20 12:57:22 +0000 |
| commit | e071de97b256a504c7b9d6e9655d1218bbd2c0a8 (patch) | |
| tree | 84d524882493063f5a9910bef4b45cc8a92979b2 | |
| parent | 8e4aebd8c10f0bed761f41ea56015893ab363fde (diff) | |
| download | extra-cmake-modules-e071de97b256a504c7b9d6e9655d1218bbd2c0a8.tar.gz extra-cmake-modules-e071de97b256a504c7b9d6e9655d1218bbd2c0a8.tar.bz2 | |
Add detailed explanation for KDEGitCommitHooks checks
| -rw-r--r-- | kde-modules/KDEGitCommitHooks.cmake | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/kde-modules/KDEGitCommitHooks.cmake b/kde-modules/KDEGitCommitHooks.cmake index b0b1a188..1ad93470 100644 --- a/kde-modules/KDEGitCommitHooks.cmake +++ b/kde-modules/KDEGitCommitHooks.cmake @@ -18,6 +18,16 @@ # In case the source dir does not contain the .git folder, the GIT_DIR # parameter can be passed in. # +# Checks: +# +# - ``CLANG_FORMAT`` With this check enabled the ``git clang-format`` tool will be used to make sure that +# the changed parts are properly formatted. In case the changes are not properly formatted an error +# message with the command to preview the formatting changes and to format the files in place +# will be displayed. This tool will reuse the exsting ``.clang-format`` file, in case you +# want to use the one provided by ECM you can include ``include(KDEClangFormat)`` which will copy +# the file to the source dir. It is also recommended to reformat the entire project before enforcing +# the formatting using this commit hook. +# # Example usage: # # .. code-block:: cmake |