diff options
Diffstat (limited to 'kde-modules/KDEGitCommitHooks.cmake')
| -rw-r--r-- | kde-modules/KDEGitCommitHooks.cmake | 74 |
1 files changed, 37 insertions, 37 deletions
diff --git a/kde-modules/KDEGitCommitHooks.cmake b/kde-modules/KDEGitCommitHooks.cmake index 7bbd024c..761175f1 100644 --- a/kde-modules/KDEGitCommitHooks.cmake +++ b/kde-modules/KDEGitCommitHooks.cmake @@ -1,44 +1,44 @@ -#.rst: -# KDEGitCommitHooks -# -------------------- -# -# This module provides a functionality to enforce formatting -# or in the future other QS checks. -# -# This module provides the following function: -# -# :: -# -# kde_configure_pre_commit_hook( -# CHECKS <check1> [<check2> [...]] -# ) -# -# This function will create a pre-commit hook which contains all the given checks. -# -# 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 -# -# include(KDEGitCommitHooks) -# kde_configure_git_pre_commit_hook(CHECKS CLANG_FORMAT) -# -# Since 5.79 - -#============================================================================= # SPDX-FileCopyrightText: 2020 Alexander Lohnau <alexander.lohnau@gmx.de> # # SPDX-License-Identifier: BSD-3-Clause +#[=======================================================================[.rst: +KDEGitCommitHooks +-------------------- + +This module provides a functionality to enforce formatting +or in the future other QS checks. + +This module provides the following function: + +:: + + kde_configure_pre_commit_hook( + CHECKS <check1> [<check2> [...]] + ) + +This function will create a pre-commit hook which contains all the given checks. + +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 + + include(KDEGitCommitHooks) + kde_configure_git_pre_commit_hook(CHECKS CLANG_FORMAT) + +Since 5.79 +#]=======================================================================] + # try to find clang-format in path find_program(KDE_CLANG_FORMAT_EXECUTABLE clang-format) include(CMakeParseArguments) |