diff options
author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2022-06-12 16:13:22 +0200 |
---|---|---|
committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2022-06-12 18:27:40 +0200 |
commit | 9edb5f57127489dec4b7cbdc1e60920e6002abea (patch) | |
tree | 712d3aaeb2d5caa9adc80f2c6e1e4412b54efb97 | |
parent | 0ec7ce6f1e2b5b1c914897e7a58f62835cc27ce5 (diff) | |
download | extra-cmake-modules-9edb5f57127489dec4b7cbdc1e60920e6002abea.tar.gz extra-cmake-modules-9edb5f57127489dec4b7cbdc1e60920e6002abea.tar.bz2 |
API dox: use more markup for code or commandline samples
NO_CHANGELOG
30 files changed, 147 insertions, 147 deletions
diff --git a/kde-modules/KDECMakeSettings.cmake b/kde-modules/KDECMakeSettings.cmake index c991aa90..8950cfb1 100644 --- a/kde-modules/KDECMakeSettings.cmake +++ b/kde-modules/KDECMakeSettings.cmake @@ -14,7 +14,7 @@ KDECMakeSettings Changes various CMake settings to what the KDE community views as more sensible defaults. -It is recommended to include this module with the NO_POLICY_SCOPE flag, +It is recommended to include this module with the ``NO_POLICY_SCOPE`` flag, otherwise you may get spurious warnings with some versions of CMake. It is split into three parts, which can be independently disabled if desired. @@ -24,25 +24,25 @@ Runtime Paths The default runtime path (used on Unix systems to search for dynamically-linked libraries) is set to include the location that libraries -will be installed to (as set in LIB_INSTALL_DIR or, if the former is not set, -KDE_INSTALL_LIBDIR), and also the linker search path. +will be installed to (as set in ``LIB_INSTALL_DIR`` or, if the former is not set, +``KDE_INSTALL_LIBDIR``), and also the linker search path. Note that ``LIB_INSTALL_DIR`` or alternatively ``KDE_INSTALL_LIBDIR`` needs to be set before including this module. Typically, this is done by including the :kde-module:`KDEInstallDirs` module. -This section can be disabled by setting ``KDE_SKIP_RPATH_SETTINGS`` to TRUE +This section can be disabled by setting ``KDE_SKIP_RPATH_SETTINGS`` to ``TRUE`` before including this module. Testing ~~~~~~~ -Testing is enabled by default, and an option (BUILD_TESTING) is provided for +Testing is enabled by default, and an option ``BUILD_TESTING`` is provided for users to control this. See the CTest module documentation in the CMake manual for more details. -This section can be disabled by setting ``KDE_SKIP_TEST_SETTINGS`` to TRUE +This section can be disabled by setting ``KDE_SKIP_TEST_SETTINGS`` to ``TRUE`` before including this module. @@ -52,18 +52,18 @@ Build Settings Various CMake build defaults are altered, such as searching source and build directories for includes first, enabling automoc by default. -When find_package(ECM 5.38) or higher is called, this also selects +When ``find_package(ECM 5.38)`` or higher is called, this also selects a layout for the build dir that helps running executables without installing: all executables are built into a toplevel "bin" dir, making it possible to find helper binaries, and to find uninstalled plugins (provided that you use -kcoreaddons_add_plugin or set LIBRARY_OUTPUT_DIRECTORY as documented on +``kcoreaddons_add_plugin()`` or set ``LIBRARY_OUTPUT_DIRECTORY`` as documented on https://community.kde.org/Guidelines_and_HOWTOs/Making_apps_run_uninstalled). -This section can be disabled by setting ``KDE_SKIP_BUILD_SETTINGS`` to TRUE +This section can be disabled by setting ``KDE_SKIP_BUILD_SETTINGS`` to ``TRUE`` before including this module. -This section also provides an "uninstall" target that can be individually -disabled by setting ``KDE_SKIP_UNINSTALL_TARGET`` to TRUE before including +This section also provides an ``uninstall`` target that can be individually +disabled by setting ``KDE_SKIP_UNINSTALL_TARGET`` to ``TRUE`` before including this module. By default on OS X, X11 and XCB related detections are disabled. However if @@ -75,7 +75,7 @@ This message can be turned off by setting ``APPLE_SUPPRESS_X11_WARNING`` to ``ON Since pre-1.0.0. -``ENABLE_CLAZY`` option is added (OFF by default) when clang is being used. +``ENABLE_CLAZY`` option is added (``OFF`` by default) when clang is being used. Turning this option on will force clang to load the clazy plugins for richer warnings on Qt-related code. @@ -84,10 +84,10 @@ See https://commits.kde.org/clazy?path=README.md Since 5.17.0 -- Uninstall target functionality since 1.7.0. +- ``uninstall`` target functionality since 1.7.0 - ``APPLE_FORCE_X11`` option since 5.14.0 (detecting X11 was previously the default behavior) - ``APPLE_SUPPRESS_X11_WARNING`` option since 5.14.0 -- CMAKE_AUTORCC enabled by default when supported by cmake (>= 3.0) since 5.62.0 +- ``CMAKE_AUTORCC`` enabled by default when supported by CMake (>= 3.0) since 5.62.0 Translations ~~~~~~~~~~~~ @@ -97,12 +97,12 @@ for projects using l10n.kde.org. ``KDE_L10N_BRANCH`` will be responsible for choosing which l10n branch to use for the translations. -``KDE_L10N_AUTO_TRANSLATIONS`` (OFF by default) will indicate whether translations +``KDE_L10N_AUTO_TRANSLATIONS`` (``OFF`` by default) will indicate whether translations should be downloaded when building the project. Since 5.34.0 -``KDE_L10N_SYNC_TRANSLATIONS`` (OFF by default) will download the translations at configuration +``KDE_L10N_SYNC_TRANSLATIONS`` (``OFF`` by default) will download the translations at configuration time instead of build time. Since 5.50.0 diff --git a/kde-modules/KDEClangFormat.cmake b/kde-modules/KDEClangFormat.cmake index 50dfc850..fd5dcd8c 100644 --- a/kde-modules/KDEClangFormat.cmake +++ b/kde-modules/KDEClangFormat.cmake @@ -28,7 +28,7 @@ added to version control. It is recommended to add it to the ``.gitignore`` file Since 5.79: If the source folder already contains a .clang-format file it is not overwritten. Since version 5.80 this function is called by default in :kde-module:`KDEFrameworkCompilerSettings`. If directories should be excluded from -the formatting a .clang-format file with "DisableFormat: true" and "SortIncludes: false" should be created. +the formatting a .clang-format file with ``DisableFormat: true`` and ``SortIncludes: false`` should be created. Example usage: diff --git a/kde-modules/KDECompilerSettings.cmake b/kde-modules/KDECompilerSettings.cmake index e5acd59b..ceb313ac 100644 --- a/kde-modules/KDECompilerSettings.cmake +++ b/kde-modules/KDECompilerSettings.cmake @@ -16,10 +16,10 @@ Set useful compile and link flags for C++ (and C) code. Enables many more warnings than the default, and sets stricter modes for some compiler features. By default, exceptions are disabled; -kde_target_enable_exceptions() can be used to re-enable them for a +``kde_target_enable_exceptions()`` can be used to re-enable them for a specific target. -NB: it is recommended to include this module with the NO_POLICY_SCOPE +NB: it is recommended to include this module with the ``NO_POLICY_SCOPE`` flag, otherwise you may get spurious warnings with some versions of CMake. Since 5.85 newer settings are controlled by a variable @@ -141,15 +141,15 @@ Variables Inclusion of this module defines the following variables: ``ENABLE_BSYMBOLICFUNCTIONS`` - indicates whether we make use of -Bsymbolic-functions for linking. + indicates whether we make use of ``-Bsymbolic-functions`` for linking. It ensures libraries bind global function references locally rather than at runtime. This option only has an effect on ELF-based systems. The option is disabled by default except when using :kde-module:`KDEFrameworkCompilerSettings` where it's enabled. Projects can enable - it by calling set(ENABLE_BSYMBOLICFUNCTIONS ON) or passing -DENABLE - BSYMBOLICFUNCTIONS=ON when configuring the build directory. + it by calling ``set(ENABLE_BSYMBOLICFUNCTIONS ON)`` or passing + ``-DENABLE BSYMBOLICFUNCTIONS=ON`` when configuring the build directory. Since 5.85 diff --git a/kde-modules/KDEFrameworkCompilerSettings.cmake b/kde-modules/KDEFrameworkCompilerSettings.cmake index bebc33cd..73b0cff5 100644 --- a/kde-modules/KDEFrameworkCompilerSettings.cmake +++ b/kde-modules/KDEFrameworkCompilerSettings.cmake @@ -19,7 +19,7 @@ The :kde-module:`KDECompilerSettings` module is included and, in addition, vario defines that affect the Qt libraries are set to enforce certain conventions. -For example, constructions like QString("foo") are prohibited, instead +For example, constructions like ``QString("foo")`` are prohibited, instead forcing the use of QLatin1String or QStringLiteral, and some Qt-defined keywords like signals and slots will not be defined. diff --git a/kde-modules/KDEInstallDirs5.cmake b/kde-modules/KDEInstallDirs5.cmake index 20a034f3..5f67759e 100644 --- a/kde-modules/KDEInstallDirs5.cmake +++ b/kde-modules/KDEInstallDirs5.cmake @@ -152,30 +152,30 @@ deprecated variable name in square brackets): Systemd User Units (``lib/systemd/user``) [``SYSTEMD_USER_UNIT_INSTALL_DIR``]. Since 5.65 -If ``KDE_INSTALL_USE_QT_SYS_PATHS`` is set to TRUE before including this +If ``KDE_INSTALL_USE_QT_SYS_PATHS`` is set to ``TRUE`` before including this module, the default values for some variables are instead queried from Qt5's qmake (where mentioned in the parentheses above). -If not set, it will default to TRUE if Qt5's qmake is found and +If not set, it will default to ``TRUE`` if Qt5's qmake is found and it's ``QT_INSTALL_PREFIX`` is the same as ``CMAKE_INSTALL_PREFIX``, -otherwise default to FALSE. +otherwise default to ``FALSE``. This variable should NOT be set from within CMakeLists.txt files, instead is intended to be set manually when configuring a project which uses KDEInstallDirs (e.g. by packagers). -If ``KDE_INSTALL_DIRS_NO_DEPRECATED`` is set to TRUE before including this +If ``KDE_INSTALL_DIRS_NO_DEPRECATED`` is set to ``TRUE`` before including this module, the deprecated variables (listed in the square brackets above) are not defined. In addition, for each ``KDE_INSTALL_*`` variable, an equivalent ``CMAKE_INSTALL_*`` variable is defined. If -``KDE_INSTALL_DIRS_NO_DEPRECATED`` is set to TRUE, only those variables +``KDE_INSTALL_DIRS_NO_DEPRECATED`` is set to ``TRUE``, only those variables defined by the ``GNUInstallDirs`` module (shipped with CMake) are defined. -If ``KDE_INSTALL_DIRS_NO_CMAKE_VARIABLES`` is set to TRUE, no variables with +If ``KDE_INSTALL_DIRS_NO_CMAKE_VARIABLES`` is set to ``TRUE``, no variables with a ``CMAKE_`` prefix will be defined by this module (other than -CMAKE_INSTALL_DEFAULT_COMPONENT_NAME - see below). +``CMAKE_INSTALL_DEFAULT_COMPONENT_NAME`` - see below). The ``KDE_INSTALL_<dir>`` variables (or their ``CMAKE_INSTALL_<dir>`` or -deprecated counterparts) may be passed to the DESTINATION options of +deprecated counterparts) may be passed to the ``DESTINATION`` options of ``install()`` commands for the corresponding file type. They are set in the CMake cache, and so the defaults above can be overridden by users. diff --git a/kde-modules/KDEInstallDirs6.cmake b/kde-modules/KDEInstallDirs6.cmake index 603a242e..469997b8 100644 --- a/kde-modules/KDEInstallDirs6.cmake +++ b/kde-modules/KDEInstallDirs6.cmake @@ -132,12 +132,12 @@ where ``<dir>`` is one of (default values in parentheses): ``SYSTEMDUSERUNITDIR`` Systemd User Units (``lib/systemd/user``) -If ``KDE_INSTALL_USE_QT_SYS_PATHS`` is set to TRUE before including this +If ``KDE_INSTALL_USE_QT_SYS_PATHS`` is set to ``TRUE`` before including this module, the default values for some variables are instead queried from Qt6's qmake (where mentioned in the parentheses above). -If not set, it will default to TRUE if Qt6's qmake is found and +If not set, it will default to ``TRUE`` if Qt6's qmake is found and it's ``QT_INSTALL_PREFIX`` is the same as ``CMAKE_INSTALL_PREFIX``, -otherwise default to FALSE. +otherwise default to ``FALSE``. This variable should NOT be set from within CMakeLists.txt files, instead is intended to be set manually when configuring a project which uses KDEInstallDirs (e.g. by packagers). @@ -145,11 +145,11 @@ KDEInstallDirs (e.g. by packagers). In addition, for each ``KDE_INSTALL_*`` variable, an equivalent ``CMAKE_INSTALL_*`` variable is defined, if such a variable is also defined by the ``GNUInstallDirs`` module (shipped with CMake). -If ``KDE_INSTALL_DIRS_NO_CMAKE_VARIABLES`` is set to TRUE, no variables with +If ``KDE_INSTALL_DIRS_NO_CMAKE_VARIABLES`` is set to ``TRUE``, no variables with a ``CMAKE_`` prefix will be defined by this module (other than -CMAKE_INSTALL_DEFAULT_COMPONENT_NAME - see below). +``CMAKE_INSTALL_DEFAULT_COMPONENT_NAME`` - see below). -The ``KDE_INSTALL_<dir>`` variables may be passed to the DESTINATION options of +The ``KDE_INSTALL_<dir>`` variables may be passed to the ``DESTINATION`` options of ``install()`` commands for the corresponding file type. They are set in the CMake cache, and so the defaults above can be overridden by users. diff --git a/kde-modules/KDEMetaInfoPlatformCheck.cmake b/kde-modules/KDEMetaInfoPlatformCheck.cmake index 7efcdb7c..2a93b196 100644 --- a/kde-modules/KDEMetaInfoPlatformCheck.cmake +++ b/kde-modules/KDEMetaInfoPlatformCheck.cmake @@ -11,9 +11,9 @@ platforms listed in the metainfo.yaml file and the current platform that is the target of the build If the current platform that is the target of the build is not supported -a cmake FATAL_ERROR will be issued +a CMake ``FATAL_ERROR`` will be issued -The check can be ignored by setting KF_IGNORE_PLATFORM_CHECK to ON +The check can be ignored by setting ``KF_IGNORE_PLATFORM_CHECK`` to ``ON``. Since 5.93 #]=======================================================================] diff --git a/kde-modules/KDEPackageAppTemplates.cmake b/kde-modules/KDEPackageAppTemplates.cmake index 8deb1731..40261449 100644 --- a/kde-modules/KDEPackageAppTemplates.cmake +++ b/kde-modules/KDEPackageAppTemplates.cmake @@ -23,11 +23,11 @@ This module provides the following function: kde_package_app_templates(TEMPLATES <template> [<template> [...]] INSTALL_DIR <directory>) -INSTALL_DIR is the directory to install the template package to. -In most cases you will want to use the variable KDE_INSTALL_KTEMPLATESDIR +``INSTALL_DIR`` is the directory to install the template package to. +In most cases you will want to use the variable ``KDE_INSTALL_KTEMPLATESDIR`` from :kde-module:`KDEInstallDirs`. -TEMPLATES lists subdirectories containing template files; +``TEMPLATES`` lists subdirectories containing template files; each ``<template>`` directory will be packaged into a file named ``<template>.tar.bz2`` and installed to the appropriate location. @@ -36,7 +36,7 @@ an application project by itself, with names (file names or text inside) the text files replaced by the following placeholders when needed: ``%{PROJECTDIRNAME}`` - name of generated project base folder ex: %{APPNAMELC} for KAppTemplate + name of generated project base folder ex: ``%{APPNAMELC}`` for KAppTemplate ``%{APPNAME}`` project name as entered by user ex: MyKApp ``%{APPNAMELC}`` @@ -59,7 +59,7 @@ the text files replaced by the following placeholders when needed: Deprecated: ``%{dest}`` - path of generated project base folder, used in .kdevtemplate with the ShowFilesAfterGeneration entry + path of generated project base folder, used in .kdevtemplate with the ``ShowFilesAfterGeneration`` entry KDevelop >= 5.1.1 supports relative paths with that entry, making this placeholder obsolete Multiple templates can be passed at once. diff --git a/modules/ECMAddAppIcon.cmake b/modules/ECMAddAppIcon.cmake index 442fffba..4bc1226e 100644 --- a/modules/ECMAddAppIcon.cmake +++ b/modules/ECMAddAppIcon.cmake @@ -26,7 +26,7 @@ The given icons, whose names must match the pattern:: will be added as platform-specific application icons to the variable named ``<sources_var_name>`` or, if the first argument -is a target (since 5.83), to the SOURCES property of ``<target>``. +is a target (since 5.83), to the ``SOURCES`` property of ``<target>``. Any target must be created with add_executable() and not be an alias. Other icon files are ignored but on Mac SVG files can be supported and diff --git a/modules/ECMAddQch.cmake b/modules/ECMAddQch.cmake index cc7b7c49..e95003fa 100644 --- a/modules/ECMAddQch.cmake +++ b/modules/ECMAddQch.cmake @@ -46,7 +46,7 @@ generated QCH file. It is recommended to make the use of this macro optional, by depending the call to ``ecm_add_qch`` on a CMake option being set, with a name like -``BUILD_QCH`` and being TRUE by default. This will allow the developers to +``BUILD_QCH`` and being ``TRUE`` by default. This will allow the developers to saves resources on normal source development build cycles by setting this option to FALSE. diff --git a/modules/ECMAddTests.cmake b/modules/ECMAddTests.cmake index 58c78d05..6605d162 100644 --- a/modules/ECMAddTests.cmake +++ b/modules/ECMAddTests.cmake @@ -20,29 +20,29 @@ Convenience functions for adding tests. A convenience function for adding multiple tests, each consisting of a single source file. For each file in <sources>, an executable target will be created (the name of which will be the basename of the source file). This -will be linked against the libraries given with LINK_LIBRARIES. Each +will be linked against the libraries given with ``LINK_LIBRARIES``. Each executable will be added as a test with the same name. -If NAME_PREFIX is given, this prefix will be prepended to the test names, but +If ``NAME_PREFIX`` is given, this prefix will be prepended to the test names, but not the target names. As a result, it will not prevent clashes between tests with the same name in different parts of the project, but it can be used to give an indication of where to look for a failing test. -If the flag GUI is passed the test binaries will be GUI executables, otherwise +If the flag ``GUI`` is passed the test binaries will be GUI executables, otherwise the resulting binaries will be console applications (regardless of the value -of CMAKE_WIN32_EXECUTABLE or CMAKE_MACOSX_BUNDLE). Be aware that this changes +of ``CMAKE_WIN32_EXECUTABLE`` or ``CMAKE_MACOSX_BUNDLE``). Be aware that this changes the executable entry point on Windows (although some frameworks, such as Qt, abstract this difference away). -The tests will be build with -DQT_FORCE_ASSERTS to enable assertions in the +The tests will be build with ``-DQT_FORCE_ASSERTS`` to enable assertions in the test executable even for release builds. -The TARGET_NAMES_VAR and TEST_NAMES_VAR arguments, if given, should specify a +The ``TARGET_NAMES_VAR`` and ``TEST_NAMES_VAR`` arguments, if given, should specify a variable name to receive the list of generated target and test names, respectively. This makes it convenient to apply properties to them as a -whole, for example, using set_target_properties() or set_tests_properties(). +whole, for example, using ``set_target_properties()`` or ``set_tests_properties()``. -The generated target executables will have the effects of ecm_mark_as_test() +The generated target executables will have the effects of ``ecm_mark_as_test()`` (from the :module:`ECMMarkAsTest` module) applied to it. :: @@ -52,10 +52,10 @@ The generated target executables will have the effects of ecm_mark_as_test() [NAME_PREFIX <prefix>] [GUI]) -This is a single-test form of ecm_add_tests that allows multiple source files -to be used for a single test. If using multiple source files, TEST_NAME must +This is a single-test form of ``ecm_add_tests`` that allows multiple source files +to be used for a single test. If using multiple source files, ``TEST_NAME`` must be given; this will be used for both the target and test names (and, as with -ecm_add_tests(), the NAME_PREFIX argument will be prepended to the test name). +``ecm_add_tests()``, the ``NAME_PREFIX`` argument will be prepended to the test name). Since pre-1.0.0. diff --git a/modules/ECMCheckOutboundLicense.cmake b/modules/ECMCheckOutboundLicense.cmake index ac799437..204d5ec7 100644 --- a/modules/ECMCheckOutboundLicense.cmake +++ b/modules/ECMCheckOutboundLicense.cmake @@ -26,7 +26,7 @@ Preconditions for using this module: by running ``reuse spdx`` on the tested directory. When this module is included, a ``SKIP_LICENSE_TESTS`` option is added (default -OFF). Turning this option on skips the generation of license tests, which might +``OFF``). Turning this option on skips the generation of license tests, which might be convenient if licenses shall not be tested in all build configurations. :: @@ -38,7 +38,7 @@ be convenient if licenses shall not be tested in all build configurations. This method adds a custom unit test to ensure the specified outbound license to be compatible with the specified license headers. Note that a convenient way is to use -the CMake GLOB command of the FILE function. +the CMake ``GLOB`` argument of the ``FILE`` function. ``LICENSES`` : List of one or multiple outbound license regarding which the compatibility of the source code files shall be tested. Currently, the following values are supported (values are SPDX registry identifiers): diff --git a/modules/ECMConfiguredInstall.cmake b/modules/ECMConfiguredInstall.cmake index 9a6f5ce6..2b404505 100644 --- a/modules/ECMConfiguredInstall.cmake +++ b/modules/ECMConfiguredInstall.cmake @@ -6,7 +6,7 @@ ECMConfiguredInstall -------------------- -Takes a list of files, runs configure_file on each and installs the resultant configured files in the given location. +Takes a list of files, runs ``configure_file`` on each and installs the resultant configured files in the given location. Any suffix of ".in" in the passed file names will be stripped from the file name at the installed location. diff --git a/modules/ECMCoverageOption.cmake b/modules/ECMCoverageOption.cmake index 7a96280e..6109fd65 100644 --- a/modules/ECMCoverageOption.cmake +++ b/modules/ECMCoverageOption.cmake @@ -13,7 +13,7 @@ your tests. This module makes it easy to build with support for `GCov <https://gcc.gnu.org/onlinedocs/gcc/Gcov.html>`_. When this module is included, a ``BUILD_COVERAGE`` option is added (default -OFF). Turning this option on enables GCC's coverage instrumentation, and +``OFF``). Turning this option on enables GCC's coverage instrumentation, and links against ``libgcov``. Note that this will probably break the build if you are not using GCC. diff --git a/modules/ECMDeprecationSettings.cmake b/modules/ECMDeprecationSettings.cmake index fa2b9ae1..f41180e6 100644 --- a/modules/ECMDeprecationSettings.cmake +++ b/modules/ECMDeprecationSettings.cmake @@ -10,8 +10,8 @@ This module provides the ``ecm_set_disabled_deprecation_versions`` function sett deprecated API for Qt and KF projects. This method expects pairs of the identifier and deprecation version. -For the identifier "QT" this functions adds the definition "QT_DISABLE_DEPRECATED_BEFORE" with the given version in a hexadecimal format. -Otherwise the name for the definition is generated using `${IDENTIFIER}_DISABLE_DEPRECATED_BEFORE_AND_AT`, +For the identifier ``QT`` this functions adds the definition ``QT_DISABLE_DEPRECATED_BEFORE`` with the given version in a hexadecimal format. +Otherwise the name for the definition is generated using ``${IDENTIFIER}_DISABLE_DEPRECATED_BEFORE_AND_AT``, following the naming of the generated code in :module:`ECMGenerateExportHeader`. The version for the definition can be overwritten, by passing definition name and the deprecation version as a CMake definition. This allows one to exclude deprecations without having to edit the CMakeLists.txt file. diff --git a/modules/ECMFindModuleHelpers.cmake b/modules/ECMFindModuleHelpers.cmake index ce873b4b..1375ebd4 100644 --- a/modules/ECMFindModuleHelpers.cmake +++ b/modules/ECMFindModuleHelpers.cmake @@ -6,9 +6,9 @@ ECMFindModuleHelpers -------------------- -Helper macros for find modules: ecm_find_package_version_check(), -ecm_find_package_parse_components() and -ecm_find_package_handle_library_components(). +Helper macros for find modules: ``ecm_find_package_version_check()``, +``ecm_find_package_parse_components()`` and +``ecm_find_package_handle_library_components()``. :: @@ -26,14 +26,14 @@ is older than that required by extra-cmake-modules. This macro will populate <variable> with a list of components found in <name>_FIND_COMPONENTS, after checking that all those components are in the -list of KNOWN_COMPONENTS; if there are any unknown components, it will print +list of ``KNOWN_COMPONENTS``; if there are any unknown components, it will print an error or warning (depending on the value of <name>_FIND_REQUIRED) and call -return(). +``return()``. The order of components in <variable> is guaranteed to match the order they -are listed in the KNOWN_COMPONENTS argument. +are listed in the ``KNOWN_COMPONENTS`` argument. -If SKIP_DEPENDENCY_HANDLING is not set, for each component the variable +If ``SKIP_DEPENDENCY_HANDLING`` is not set, for each component the variable <name>_<component>_component_deps will be checked for dependent components. If <component> is listed in <name>_FIND_COMPONENTS, then all its (transitive) dependencies will also be added to <variable>. @@ -53,13 +53,13 @@ and <name>_<component>_header variable should contain the name of a header file associated with it (whatever relative path is normally passed to '#include'). <name>_<component>_header_subdir variable can be used to specify which subdirectory of the include path the headers will be found in. -ecm_find_package_components() will then search for the library +``ecm_find_package_components()`` will then search for the library and include directory (creating appropriate cache variables) and create an imported library target named <name>::<component>. Additional variables can be used to provide additional information: -If SKIP_PKG_CONFIG, the <name>_<component>_pkg_config variable is set, and +If ``SKIP_PKG_CONFIG``, the <name>_<component>_pkg_config variable is set, and pkg-config is found, the pkg-config module given by <name>_<component>_pkg_config will be searched for and used to help locate the library and header file. It will also be used to set @@ -69,13 +69,13 @@ Note that if version information is found via pkg-config, <name>_<component>_FIND_VERSION can be set to require a particular version for each component. -If SKIP_DEPENDENCY_HANDLING is not set, the INTERFACE_LINK_LIBRARIES property +If ``SKIP_DEPENDENCY_HANDLING`` is not set, the ``INTERFACE_LINK_LIBRARIES`` property of the imported target for <component> will be set to contain the imported targets for the components listed in <name>_<component>_component_deps. -<component>_FOUND will also be set to false if any of the components in +<component>_FOUND will also be set to ``FALSE`` if any of the components in <name>_<component>_component_deps are not found. This requires the components in <name>_<component>_component_deps to be listed before <component> in the -COMPONENTS argument. +``COMPONENTS`` argument. The following variables will be set: @@ -94,8 +94,8 @@ The following variables will be set: be altered Note that these variables are never cleared, so if -ecm_find_package_handle_library_components() is called multiple times with -different components (typically because of multiple find_package() calls) then +``ecm_find_package_handle_library_components()`` is called multiple times with +different components (typically because of multiple ``find_package()`` calls) then ``<name>_TARGETS``, for example, will contain all the targets found in any call (although no duplicates). diff --git a/modules/ECMFindQmlModule.cmake b/modules/ECMFindQmlModule.cmake index 7b436f1d..f7dbed06 100644 --- a/modules/ECMFindQmlModule.cmake +++ b/modules/ECMFindQmlModule.cmake @@ -6,7 +6,7 @@ ECMFindQmlModule ---------------- -Find QML import modules through a find_qmlmodule() call. +Find QML import modules through a ``find_qmlmodule()`` call. It uses the qmlplugindump application to find the plugins and sets them up as runtime dependencies. @@ -18,8 +18,8 @@ but fail at runtime. ecm_find_qmlmodule(<module_name> <version>...) -Any further arguments passed will be forwarded into a find_package() call. See -find_package() documentation for more information. +Any further arguments passed will be forwarded into a ``find_package()`` call. See +``find_package()`` documentation for more information. Usage example: diff --git a/modules/ECMGenerateHeaders.cmake b/modules/ECMGenerateHeaders.cmake index 4da0f379..86f35adb 100644 --- a/modules/ECMGenerateHeaders.cmake +++ b/modules/ECMGenerateHeaders.cmake @@ -22,24 +22,24 @@ Generate C/C++ CamelCase forwarding headers. [COMMON_HEADER <HeaderName>] [RELATIVE <relative_path>]) -For each CamelCase header name passed to HEADER_NAMES, a file of that name +For each CamelCase header name passed to ``HEADER_NAMES``, a file of that name will be generated that will include a version with ``.h`` or, if set, ``.<header_extension>`` appended. For example, the generated header ``ClassA`` will include ``classa.h`` (or -``ClassA.h``, see ORIGINAL). +``ClassA.h``, see ``ORIGINAL``). If a CamelCaseName consists of multiple comma-separated files, e.g. ``ClassA,ClassB,ClassC``, then multiple camelcase header files will be generated which are redirects to the first header file. The file locations of these generated headers will be stored in <camelcase_forwarding_headers_var>. -ORIGINAL specifies how the name of the original header is written: lowercased -or also camelcased. The default is LOWERCASE. Since 1.8.0. +``ORIGINAL`` specifies how the name of the original header is written: lowercased +or also camelcased. The default is "LOWERCASE". Since 1.8.0. -HEADER_EXTENSION specifies what file name extension is used for the header +``HEADER_EXTENSION`` specifies what file name extension is used for the header files. The default is "h". Since 5.48.0. -PREFIX places the generated headers in subdirectories. This should be a +``PREFIX`` places the generated headers in subdirectories. This should be a CamelCase name like ``KParts``, which will cause the CamelCase forwarding headers to be placed in the ``KParts`` directory (e.g. ``KParts/Part``). It will also, for the convenience of code in the source distribution, generate @@ -47,36 +47,36 @@ forwarding headers based on the original names (e.g. ``kparts/part.h``). This allows includes like ``"#include <kparts/part.h>"`` to be used before installation, as long as the include_directories are set appropriately. -OUTPUT_DIR specifies where the files will be generated; this should be within +``OUTPUT_DIR`` specifies where the files will be generated; this should be within the build directory. By default, ``${CMAKE_CURRENT_BINARY_DIR}`` will be used. This option can be used to avoid file conflicts. -REQUIRED_HEADERS specifies an output variable name where all the required +``REQUIRED_HEADERS`` specifies an output variable name where all the required headers will be appended so that they can be installed together with the generated ones. This is mostly intended as a convenience so that adding a new header to a project only requires specifying the CamelCase variant in the CMakeLists.txt file; the original variant will then be added to this variable. -COMMON_HEADER generates an additional convenience header which includes all +``COMMON_HEADER`` generates an additional convenience header which includes all other header files. -The RELATIVE argument indicates where the original headers can be found -relative to CMAKE_CURRENT_SOURCE_DIR. It does not affect the generated -CamelCase forwarding files, but ecm_generate_headers() uses it when checking +The ``RELATIVE`` argument indicates where the original headers can be found +relative to ``CMAKE_CURRENT_SOURCE_DIR``. It does not affect the generated +CamelCase forwarding files, but ``ecm_generate_headers()`` uses it when checking that the original header exists, and to generate originally named forwarding -headers when PREFIX is set. +headers when ``PREFIX`` is set. To allow other parts of the source distribution (eg: tests) to use the generated headers before installation, it may be desirable to set the -INCLUDE_DIRECTORIES property for the library target to output_dir. For -example, if OUTPUT_DIR is CMAKE_CURRENT_BINARY_DIR (the default), you could do +``INCLUDE_DIRECTORIES`` property for the library target to output_dir. For +example, if ``OUTPUT_DIR`` is ``CMAKE_CURRENT_BINARY_DIR`` (the default), you could do .. code-block:: cmake target_include_directories(MyLib PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>") -Example usage (without PREFIX): +Example usage (without ``PREFIX``): .. code-block:: cmake @@ -93,7 +93,7 @@ Example usage (without PREFIX): DESTINATION ${CMAKE_INSTALL_PREFIX}/include COMPONENT Devel) -Example usage (with PREFIX): +Example usage (with ``PREFIX``): .. code-block:: cmake diff --git a/modules/ECMGeneratePkgConfigFile.cmake b/modules/ECMGeneratePkgConfigFile.cmake index 8c303981..1b59da8d 100644 --- a/modules/ECMGeneratePkgConfigFile.cmake +++ b/modules/ECMGeneratePkgConfigFile.cmake @@ -47,7 +47,7 @@ also ``INSTALL``. ``INCLUDE_INSTALL_DIR`` specifies where the includes will be installed. If it's not specified, it will default to ``INSTALL_INCLUDEDIR``, ``CMAKE_INSTALL_INCLUDEDIR`` or just "include/" in case they are specified, -with the BASE_NAME postfixed. +with the ``BASE_NAME`` postfixed. ``LIB_INSTALL_DIR`` specifies where the library is being installed. If it's not specified, it will default to ``LIB_INSTALL_DIR``, @@ -66,13 +66,13 @@ package. Defaults to "https://www.kde.org/". Since 5.89.0. ``INSTALL`` will cause the module to be installed to the ``pkgconfig`` subdirectory of ``LIB_INSTALL_DIR``, unless the ``ECM_PKGCONFIG_INSTALL_DIR`` cache variable is set to something different. Note that the first call to -ecm_generate_pkgconfig_file with the ``INSTALL`` argument will cause +``ecm_generate_pkgconfig_file()`` with the ``INSTALL`` argument will cause ``ECM_PKGCONFIG_INSTALL_DIR`` to be set to the cache, and will be used in any subsequent calls. To properly use this macro a version needs to be set. To retrieve it, ``ECM_PKGCONFIG_INSTALL_DIR`` uses ``PROJECT_VERSION``. To set it, use the -project() command or the ecm_setup_version() macro +``project()`` command or the ``ecm_setup_version()`` macro Example usage: diff --git a/modules/ECMGeneratePriFile.cmake b/modules/ECMGeneratePriFile.cmake index 9fdf713a..8910cd9e 100644 --- a/modules/ECMGeneratePriFile.cmake +++ b/modules/ECMGeneratePriFile.cmake @@ -37,32 +37,32 @@ library convenient for them, in much the same way that CMake config files make things convenient for CMake-based applications. ``ecm_generate_pri_file()`` generates just such a file. -VERSION specifies the version of the library the ``.pri`` file describes. If +``VERSION`` specifies the version of the library the ``.pri`` file describes. If not set, the value is taken from the context variable ``PROJECT_VERSION``. This variable is usually set by the ``project(... VERSION ...)`` command or, -if CMake policy CMP0048 is not NEW, by :module:`ECMSetupVersion`. +if CMake policy CMP0048 is not ``NEW``, by :module:`ECMSetupVersion`. For backward-compatibility with older ECM versions the ``PROJECT_VERSION_STRING`` variable as set by :module:`ECMSetupVersion` will be preferred over ``PROJECT_VERSION`` if set, unless the minimum required version of ECM is 5.83 and newer. Since 5.83. -BASE_NAME specifies the name qmake project (.pro) files should use to refer to -the library (eg: KArchive). LIB_NAME is the name of the actual library to -link to (ie: the first argument to add_library()). DEPS is a space-separated +``BASE_NAME`` specifies the name qmake project (.pro) files should use to refer to +the library (eg: KArchive). ``LIB_NAME`` is the name of the actual library to +link to (ie: the first argument to add_library()). ``DEPS`` is a space-separated list of the base names of other libraries (for Qt libraries, use the same names you use with the ``QT`` variable in a qmake project file, such as "core" -for QtCore). FILENAME_VAR specifies the name of a variable to store the path +for QtCore). ``FILENAME_VAR`` specifies the name of a variable to store the path to the generated file in. -INCLUDE_INSTALL_DIRS are the paths (relative to ``CMAKE_INSTALL_PREFIX``) that +``INCLUDE_INSTALL_DIRS`` are the paths (relative to ``CMAKE_INSTALL_PREFIX``) that include files will be installed to. It defaults to ``${INCLUDE_INSTALL_DIR}/<baseName>`` if the ``INCLUDE_INSTALL_DIR`` variable is set. If that variable is not set, the ``CMAKE_INSTALL_INCLUDEDIR`` variable -is used instead, and if neither are set ``include`` is used. LIB_INSTALL_DIR +is used instead, and if neither are set ``include`` is used. ``LIB_INSTALL_DIR`` operates similarly for the installation location for libraries; it defaults to ``${LIB_INSTALL_DIR}``, ``${CMAKE_INSTALL_LIBDIR}`` or ``lib``, in that order. -INCLUDE_INSTALL_DIR is the old variant of INCLUDE_INSTALL_DIRS, taking only one +``INCLUDE_INSTALL_DIR`` is the old variant of ``INCLUDE_INSTALL_DIRS``, taking only one directory. Example usage: diff --git a/modules/ECMInstallIcons.cmake b/modules/ECMInstallIcons.cmake index 49cfc2da..cad970e9 100644 --- a/modules/ECMInstallIcons.cmake +++ b/modules/ECMInstallIcons.cmake @@ -23,9 +23,9 @@ The given icons, whose names must match the pattern:: <size>-<group>-<name>.<ext> -will be installed to the appropriate subdirectory of DESTINATION according to +will be installed to the appropriate subdirectory of ``DESTINATION`` according to the FreeDesktop.org icon naming scheme. By default, they are installed to the -"hicolor" theme, but this can be changed using the THEME argument. If the +"hicolor" theme, but this can be changed using the ``THEME`` argument. If the icons are localized, the LANG argument can be used to install them in a locale-specific directory. diff --git a/modules/ECMMarkAsTest.cmake b/modules/ECMMarkAsTest.cmake index 8ac5e8ba..6a5373d5 100644 --- a/modules/ECMMarkAsTest.cmake +++ b/modules/ECMMarkAsTest.cmake @@ -14,9 +14,9 @@ Marks a target as only being required for tests. ecm_mark_as_test(<target1> [<target2> [...]]) This will cause the specified targets to not be built unless either -BUILD_TESTING is set to ON or the user invokes the ``buildtests`` target. +``BUILD_TESTING`` is set to ``ON`` or the user invokes the ``buildtests`` target. -BUILD_TESTING is created as a cache variable by the CTest module and by the +``BUILD_TESTING`` is created as a cache variable by the CTest module and by the :kde-module:`KDECMakeSettings` module. Since pre-1.0.0. diff --git a/modules/ECMOptionalAddSubdirectory.cmake b/modules/ECMOptionalAddSubdirectory.cmake index 0eeb1d41..68142086 100644 --- a/modules/ECMOptionalAddSubdirectory.cmake +++ b/modules/ECMOptionalAddSubdirectory.cmake @@ -12,7 +12,7 @@ Make subdirectories optional. ecm_optional_add_subdirectory(<dir>) -This behaves like add_subdirectory(), except that it does not complain if the +This behaves like ``add_subdirectory()``, except that it does not complain if the directory does not exist. Additionally, if the directory does exist, it creates an option to allow the user to skip it. The option will be named BUILD_<dir>. @@ -20,7 +20,7 @@ BUILD_<dir>. This is useful for "meta-projects" that combine several mostly-independent sub-projects. -If the CMake variable DISABLE_ALL_OPTIONAL_SUBDIRECTORIES is set to TRUE for +If the CMake variable ``DISABLE_ALL_OPTIONAL_SUBDIRECTORIES`` is set to ``TRUE`` for the first CMake run on the project, all optional subdirectories will be disabled by default (but can of course be enabled via the respective options). For example, the following will disable all optional subdirectories except the diff --git a/modules/ECMPackageConfigHelpers.cmake b/modules/ECMPackageConfigHelpers.cmake index f320ebc2..c635122e 100644 --- a/modules/ECMPackageConfigHelpers.cmake +++ b/modules/ECMPackageConfigHelpers.cmake @@ -24,19 +24,19 @@ more information. [NO_CHECK_REQUIRED_COMPONENTS_MACRO]) -This behaves in the same way as configure_package_config_file() from CMake -2.8.12, except that it adds an extra helper macro: find_dependency(). It is +This behaves in the same way as ``configure_package_config_file()`` from CMake +2.8.12, except that it adds an extra helper macro: ``find_dependency()``. It is highly recommended that you read the `documentation for CMakePackageConfigHelpers <https://www.cmake.org/cmake/help/v2.8.12/cmake.html#module:CMakePackageConfigHelpers>`_ -for more information, particularly with regard to the PATH_VARS argument. +for more information, particularly with regard to the ``PATH_VARS`` argument. -Note that there is no argument that will disable the find_dependency() macro; +Note that there is no argument that will disable the ``find_dependency()`` macro; if you do not require this macro, you should use ``configure_package_config_file`` from the CMakePackageConfigHelpers module. CMake 3.0 includes a CMakeFindDependencyMacro module that provides the -find_dependency() macro (which you can ``include()`` in your package config +``find_dependency()`` macro (which you can ``include()`` in your package config file), so this file is only useful for projects wishing to provide config files that will work with CMake 2.8.12. @@ -47,9 +47,9 @@ Additional Config File Macros find_dependency(<dep> [<version> [EXACT]]) -find_dependency() should be used instead of find_package() to find package -dependencies. It forwards the correct parameters for EXACT, QUIET and -REQUIRED which were passed to the original find_package() call. It also sets +``find_dependency()`` should be used instead of ``find_package()`` to find package +dependencies. It forwards the correct parameters for ``EXACT``, ``QUIET`` and +``REQUIRED`` which were passed to the original ``find_package()`` call. It also sets an informative diagnostic message if the dependency could not be found. Since pre-1.0.0. diff --git a/modules/ECMPoQmTools.cmake b/modules/ECMPoQmTools.cmake index 3b288064..517d9e3a 100644 --- a/modules/ECMPoQmTools.cmake +++ b/modules/ECMPoQmTools.cmake @@ -22,12 +22,12 @@ or library. Compile .po files into .qm files for the given language. -If INSTALL_DESTINATION is given, the .qm files are installed in +If ``INSTALL_DESTINATION`` is given, the .qm files are installed in ``<install_destination>/<lang>/LC_MESSAGES``. Typically, ``<install_destination>`` is set to ``share/locale``. ``ecm_process_po_files_as_qm`` creates a "translations" target. This target -builds all .po files into .qm files. If ALL is specified, these rules are +builds all .po files into .qm files. If ``ALL`` is specified, these rules are added to the "all" target (and so the .qm files will be built by default). :: @@ -37,8 +37,8 @@ added to the "all" target (and so the .qm files will be built by default). Generates C++ code which ensures translations are automatically loaded at startup. The generated files are appended to the variable named ``<sources_var_name>`` or, if the first argument is a target (since 5.83), to -the SOURCES property of ``<target>``. Any target must be created with -add_executable() or add_library() and not be an alias. +the ``SOURCES`` property of ``<target>``. Any target must be created with +``add_executable()`` or ``add_library()`` and not be an alias. It assumes that the .qm file for the language code ``<lang>`` is installed as ``<sharedir>/locale/<lang>/LC_MESSAGES/<catalog_name>.qm``, where diff --git a/modules/ECMQmlModule.cmake b/modules/ECMQmlModule.cmake index f3d215b9..9dca966b 100644 --- a/modules/ECMQmlModule.cmake +++ b/modules/ECMQmlModule.cmake @@ -35,7 +35,7 @@ Example usage: ecm_add_qml_module(<target name> URI <module uri> [VERSION <module version>] [NO_PLUGIN] [CLASSNAME <class name>]) This will declare a new CMake target called ``<target name>``. The ``URI`` -argument is required and should be a proper QML module URI. The URI is used, +argument is required and should be a proper QML module URI. The ``URI`` is used, among others, to generate a subdirectory where the module will be installed to. If the ``VERSION`` argument is specified, it is used to initialize the default diff --git a/modules/ECMSetupVersion.cmake b/modules/ECMSetupVersion.cmake index 73b71ed1..330f7365 100644 --- a/modules/ECMSetupVersion.cmake +++ b/modules/ECMSetupVersion.cmake @@ -36,7 +36,7 @@ version of ECM is < 5.83):: <prefix>_VERSION_STRING - <version> (use <prefix>_VERSION instead) -If CMake policy CMP0048 is not NEW, the following CMake variables will also +If CMake policy CMP0048 is not ``NEW``, the following CMake variables will also be set:: PROJECT_VERSION_MAJOR - <major> @@ -44,14 +44,14 @@ be set:: PROJECT_VERSION_PATCH - <patch> PROJECT_VERSION - <version> -For backward-compatibility, if CMake policy CMP0048 is not NEW, also this variable is set +For backward-compatibility, if CMake policy CMP0048 is not ``NEW``, also this variable is set (only if the minimum required version of ECM is < 5.83):: PROJECT_VERSION_STRING - <version> (use PROJECT_VERSION instead) -If the VERSION_HEADER option is used, a simple C header is generated with the +If the ``VERSION_HEADER`` option is used, a simple C header is generated with the given filename. If filename is a relative path, it is interpreted as relative -to CMAKE_CURRENT_BINARY_DIR. The generated header contains the following +to ``CMAKE_CURRENT_BINARY_DIR``. The generated header contains the following macros:: <prefix>_VERSION_MAJOR - <major> as an integer @@ -64,15 +64,15 @@ macros:: next 8 bits and ``<major>`` in the remaining bits. Note that ``<patch>`` and ``<minor>`` must be less than 256. -If the PACKAGE_VERSION_FILE option is used, a simple CMake package version -file is created using the write_basic_package_version_file() macro provided by +If the ``PACKAGE_VERSION_FILE`` option is used, a simple CMake package version +file is created using the ``write_basic_package_version_file()`` macro provided by CMake. It should be installed in the same location as the Config.cmake file of -the library so that it can be found by find_package(). If the filename is a -relative path, it is interpreted as relative to CMAKE_CURRENT_BINARY_DIR. The -optional COMPATIBILITY option is forwarded to -write_basic_package_version_file(), and defaults to AnyNewerVersion. +the library so that it can be found by ``find_package()``. If the filename is a +relative path, it is interpreted as relative to ``CMAKE_CURRENT_BINARY_DIR``. The +optional ``COMPATIBILITY`` option is forwarded to +``write_basic_package_version_file()``, and defaults to ``AnyNewerVersion``. -If CMake policy CMP0048 is NEW, an alternative form of the command is +If CMake policy CMP0048 is ``NEW``, an alternative form of the command is available:: ecm_setup_version(PROJECT @@ -81,14 +81,14 @@ available:: [VERSION_HEADER <filename>] [PACKAGE_VERSION_FILE <filename>] ) -This will use the version information set by the project() command. -VARIABLE_PREFIX defaults to the project name. Note that PROJECT must be the +This will use the version information set by the ``project()`` command. +``VARIABLE_PREFIX`` defaults to the project name. Note that ``PROJECT`` must be the first argument. In all other respects, it behaves like the other form of the command. Since pre-1.0.0. -COMPATIBILITY option available since 1.6.0. +``COMPATIBILITY`` option available since 1.6.0. #]=======================================================================] include(CMakePackageConfigHelpers) diff --git a/modules/ECMSourceVersionControl.cmake b/modules/ECMSourceVersionControl.cmake index b61c7069..36bc78c7 100644 --- a/modules/ECMSourceVersionControl.cmake +++ b/modules/ECMSourceVersionControl.cmake @@ -10,7 +10,7 @@ Tries to determine whether the source is under version control (git clone, svn checkout, etc). ``ECM_SOURCE_UNDER_VERSION_CONTROL`` is set when indication is found that -CMAKE_SOURCE_DIR is under version control. +``CMAKE_SOURCE_DIR`` is under version control. Since 5.63 #]=======================================================================] diff --git a/modules/ECMUseFindModules.cmake b/modules/ECMUseFindModules.cmake index d8bcf7b4..c00d6716 100644 --- a/modules/ECMUseFindModules.cmake +++ b/modules/ECMUseFindModules.cmake @@ -20,12 +20,12 @@ found, so it is not necessary to ``include(ECMUseFindModules)`` explicitly. This allows selective use of the find modules provided by ECM, including deferring to CMake's versions of those modules if it has them. Rather than adding ``${ECM_FIND_MODULE_DIR}`` to ``CMAKE_MODULE_PATH``, you use -ecm_use_find_modules() to copy the modules you want to a local (build) +``ecm_use_find_modules()`` to copy the modules you want to a local (build) directory, and add that to ``CMAKE_MODULE_PATH``. -The find modules given to MODULES will be copied to the directory given by DIR +The find modules given to ``MODULES`` will be copied to the directory given by ``DIR`` (which should be located in ``${CMAKE_BINARY_DIR}`` and added to -``CMAKE_MODULE_PATH``). If NO_OVERRIDE is given, only modules not also +``CMAKE_MODULE_PATH``). If ``NO_OVERRIDE`` is given, only modules not also provided by CMake will be copied. Example: diff --git a/modules/ECMWinResolveSymlinks.cmake b/modules/ECMWinResolveSymlinks.cmake index 25ab6c90..392ed93e 100644 --- a/modules/ECMWinResolveSymlinks.cmake +++ b/modules/ECMWinResolveSymlinks.cmake @@ -17,7 +17,7 @@ it creates a text file for each symlink, containing a relative path to the real file. This function would recursively walk over specified directory and replace pseudo-symlinks with corresponding real file's contents. It would then run -git update-index --assume-unchanged on them to trick git. +``git update-index --assume-unchanged`` on them to trick git. This is useful for projects like "breeze-icons" that contain many identical icons implemented as symlinks. |