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 /kde-modules/KDEInstallDirs6.cmake | |
| 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
Diffstat (limited to 'kde-modules/KDEInstallDirs6.cmake')
| -rw-r--r-- | kde-modules/KDEInstallDirs6.cmake | 12 |
1 files changed, 6 insertions, 6 deletions
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. |