diff options
Diffstat (limited to 'kde-modules')
-rw-r--r-- | kde-modules/KDECMakeSettings.cmake | 32 | ||||
-rw-r--r-- | kde-modules/KDEClangFormat.cmake | 2 | ||||
-rw-r--r-- | kde-modules/KDECompilerSettings.cmake | 10 | ||||
-rw-r--r-- | kde-modules/KDEFrameworkCompilerSettings.cmake | 2 | ||||
-rw-r--r-- | kde-modules/KDEInstallDirs5.cmake | 16 | ||||
-rw-r--r-- | kde-modules/KDEInstallDirs6.cmake | 12 | ||||
-rw-r--r-- | kde-modules/KDEMetaInfoPlatformCheck.cmake | 4 | ||||
-rw-r--r-- | kde-modules/KDEPackageAppTemplates.cmake | 10 |
8 files changed, 44 insertions, 44 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. |