diff options
Diffstat (limited to 'kde-modules/KDEClangFormat.cmake')
| -rw-r--r-- | kde-modules/KDEClangFormat.cmake | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/kde-modules/KDEClangFormat.cmake b/kde-modules/KDEClangFormat.cmake index 995f03ad..b662b275 100644 --- a/kde-modules/KDEClangFormat.cmake +++ b/kde-modules/KDEClangFormat.cmake @@ -14,15 +14,31 @@ # # Using this function will create a clang-format target that will format all # ``<files>`` passed to the function with the predefined KDE clang-format style. +# To format the files you have to invoke the target with ``make clang-format`` or ``ninja clang-format``. +# Once the project is formatted it is recommended to enforce the formatting using a pre-commit hook, +# this can be done using :kde-module:`KDEGitCommitHooks`. +# +# The ``.clang-format`` file from ECM will be copied to the source directory. This file should not be +# added to version control. It is recommended to add it to the ``.gitignore`` file: ``/.clang-format``. +# +# Since 5.79: If the source folder already contains a .clang-format file it is not overwritten. # # Example usage: # # .. code-block:: cmake # # include(KDEClangFormat) -# file(GLOB_RECURSE ALL_CLANG_FORMAT_SOURCE_FILES src/*.cpp src/*.h) +# file(GLOB_RECURSE ALL_CLANG_FORMAT_SOURCE_FILES *.cpp *.h) # kde_clang_format(${ALL_CLANG_FORMAT_SOURCE_FILES}) # +# To exclude directories from the formatting add a ``.clang-format`` +# file in the directory with the following contents: +# +# .. code-block:: yaml +# +# DisableFormat: true +# SortIncludes: false +# # Since 5.64 #============================================================================= |