diff options
55 files changed, 92 insertions, 92 deletions
diff --git a/Help/command/add_library.rst b/Help/command/add_library.rst index 43cefca..07c8bab 100644 --- a/Help/command/add_library.rst +++ b/Help/command/add_library.rst @@ -83,7 +83,7 @@ Object Libraries Creates an :ref:`Object Library <Object Libraries>`. An object library compiles source files but does not archive or link their object files into a -library. Instead other targets created by :command:`add_library` or +library. Instead other targets created by ``add_library`` or :command:`add_executable` may reference the objects using an expression of the form :genex:`$\<TARGET_OBJECTS:objlib\> <TARGET_OBJECTS>` as a source, where ``objlib`` is the object library name. For example: diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst index d4ba465..5cfeeab 100644 --- a/Help/command/execute_process.rst +++ b/Help/command/execute_process.rst @@ -52,7 +52,7 @@ Options: redirect stdin, stdout, and stderr.) If a sequential execution of multiple commands is required, use multiple - :command:`execute_process` calls with a single ``COMMAND`` argument. + ``execute_process`` calls with a single ``COMMAND`` argument. ``WORKING_DIRECTORY`` The named directory will be set as the current working directory of diff --git a/Help/command/include_guard.rst b/Help/command/include_guard.rst index dca3b6f..e8cafac 100644 --- a/Help/command/include_guard.rst +++ b/Help/command/include_guard.rst @@ -13,7 +13,7 @@ Sets up an include guard for the current CMake file (see the :variable:`CMAKE_CURRENT_LIST_FILE` variable documentation). CMake will end its processing of the current file at the location of the -:command:`include_guard` command if the current file has already been +``include_guard`` command if the current file has already been processed for the applicable scope (see below). This provides functionality similar to the include guards commonly used in source headers or to the ``#pragma once`` directive. If the current file has been processed previously diff --git a/Help/command/install.rst b/Help/command/install.rst index d036a20..126888a 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -32,7 +32,7 @@ are executed in order during installation. .. versionchanged:: 3.22 The environment variable :envvar:`CMAKE_INSTALL_MODE` can override the - default copying behavior of :command:`install()`. + default copying behavior of ``install()``. There are multiple signatures for this command. Some of them define installation options for files and targets. Options common to diff --git a/Help/command/return.rst b/Help/command/return.rst index 795dbeb..bb6d87d 100644 --- a/Help/command/return.rst +++ b/Help/command/return.rst @@ -30,7 +30,7 @@ command. All arguments are ignored unless that policy is set to ``NEW``. with the :command:`block` command, as described below. The ``PROPAGATE`` option can be very useful in conjunction with the - :command:`block` command. A :command:`return` will propagate the + :command:`block` command. A ``return`` will propagate the specified variables through any enclosing block scopes created by the :command:`block` commands. Inside a function, this ensures the variables are propagated to the function's caller, regardless of any blocks within diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst index 6ae245f..52c0ae8 100644 --- a/Help/command/try_compile.rst +++ b/Help/command/try_compile.rst @@ -271,7 +271,7 @@ Other Behavior Settings If :policy:`CMP0083` is set to ``NEW``, then in order to obtain correct behavior at link time, the ``check_pie_supported()`` command from the :module:`CheckPIESupported` module must be called before using the - :command:`try_compile` command. + ``try_compile`` command. The current settings of :policy:`CMP0065` and :policy:`CMP0083` are propagated through to the generated test project. diff --git a/Help/generator/Xcode.rst b/Help/generator/Xcode.rst index 9dd5015..ab369d5 100644 --- a/Help/generator/Xcode.rst +++ b/Help/generator/Xcode.rst @@ -41,7 +41,7 @@ Swift Support .. versionadded:: 3.4 -When using the :generator:`Xcode` generator with Xcode 6.1 or higher, +When using the ``Xcode`` generator with Xcode 6.1 or higher, one may enable the ``Swift`` language with the :command:`enable_language` command or the :command:`project`. diff --git a/Help/policy/CMP0053.rst b/Help/policy/CMP0053.rst index 9b18b2d..58500d6 100644 --- a/Help/policy/CMP0053.rst +++ b/Help/policy/CMP0053.rst @@ -20,7 +20,7 @@ cleaned up to simplify the behavior. Specifically: the characters ``_``, ``.``, ``/``, ``-``, and ``+``. Note that ``$`` is technically allowed in the ``NEW`` behavior, but is invalid for ``OLD`` behavior. This is due to an oversight during the - implementation of :policy:`CMP0053` and its use as a literal variable + implementation of ``CMP0053`` and its use as a literal variable reference is discouraged for this reason. Variables with other characters in their name may still be referenced indirectly, e.g. diff --git a/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst b/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst index b6f6160..a19cc4e 100644 --- a/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst +++ b/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst @@ -10,7 +10,7 @@ Additional files to remove during the clean stage. A :ref:`;-list <CMake Language Lists>` of files that will be removed as a part of the ``make clean`` target. -Arguments to :prop_dir:`ADDITIONAL_MAKE_CLEAN_FILES` may use +Arguments to ``ADDITIONAL_MAKE_CLEAN_FILES`` may use :manual:`generator expressions <cmake-generator-expressions(7)>`. This property only works for the Makefile generators. diff --git a/Help/prop_gbl/AUTOGEN_SOURCE_GROUP.rst b/Help/prop_gbl/AUTOGEN_SOURCE_GROUP.rst index 07c732b..600a64a 100644 --- a/Help/prop_gbl/AUTOGEN_SOURCE_GROUP.rst +++ b/Help/prop_gbl/AUTOGEN_SOURCE_GROUP.rst @@ -9,7 +9,7 @@ Name of the :command:`source_group` for :prop_tgt:`AUTOMOC`, Files generated by :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTORCC` and :prop_tgt:`AUTOUIC` are not always known at configure time and therefore can't be passed to :command:`source_group`. -:prop_gbl:`AUTOGEN_SOURCE_GROUP` can be used instead to generate or select +``AUTOGEN_SOURCE_GROUP`` can be used instead to generate or select a source group for :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTORCC` and :prop_tgt:`AUTOUIC` generated files. diff --git a/Help/prop_gbl/JOB_POOLS.rst b/Help/prop_gbl/JOB_POOLS.rst index 10c8243..5dfe6de 100644 --- a/Help/prop_gbl/JOB_POOLS.rst +++ b/Help/prop_gbl/JOB_POOLS.rst @@ -5,7 +5,7 @@ Ninja only: List of available pools. A pool is a named integer property and defines the maximum number of concurrent jobs which can be started by a rule assigned to the pool. -The :prop_gbl:`JOB_POOLS` property is a semicolon-separated list of +The ``JOB_POOLS`` property is a semicolon-separated list of pairs using the syntax ``NAME=integer`` (without a space after the equality sign). For instance: @@ -21,7 +21,7 @@ or per target by setting the target properties :command:`Custom commands <add_custom_command>` and :command:`custom targets <add_custom_target>` can specify pools using the option ``JOB_POOL``. -Using a pool that is not defined by :prop_gbl:`JOB_POOLS` causes +Using a pool that is not defined by ``JOB_POOLS`` causes an error by ninja at build time. If not set, this property uses the value of the :variable:`CMAKE_JOB_POOLS` diff --git a/Help/prop_sf/SKIP_AUTOUIC.rst b/Help/prop_sf/SKIP_AUTOUIC.rst index ae9725a..45ed3f8 100644 --- a/Help/prop_sf/SKIP_AUTOUIC.rst +++ b/Help/prop_sf/SKIP_AUTOUIC.rst @@ -5,7 +5,7 @@ SKIP_AUTOUIC Exclude the source file from :prop_tgt:`AUTOUIC` processing (for Qt projects). -:prop_sf:`SKIP_AUTOUIC` can be set on C++ header and source files and on +``SKIP_AUTOUIC`` can be set on C++ header and source files and on ``.ui`` files. For broader exclusion control see :prop_sf:`SKIP_AUTOGEN`. diff --git a/Help/prop_test/TIMEOUT_AFTER_MATCH.rst b/Help/prop_test/TIMEOUT_AFTER_MATCH.rst index 726dcab..aa17590 100644 --- a/Help/prop_test/TIMEOUT_AFTER_MATCH.rst +++ b/Help/prop_test/TIMEOUT_AFTER_MATCH.rst @@ -28,14 +28,14 @@ variable if either of these are set. Because the test's start time is reset, its execution time will not include any time that was spent waiting for the matching output. -:prop_test:`TIMEOUT_AFTER_MATCH` is useful for avoiding spurious +``TIMEOUT_AFTER_MATCH`` is useful for avoiding spurious timeouts when your test must wait for some system resource to become available before it can execute. Set :prop_test:`TIMEOUT` to a longer duration that accounts for resource acquisition and use -:prop_test:`TIMEOUT_AFTER_MATCH` to control how long the actual test +``TIMEOUT_AFTER_MATCH`` to control how long the actual test is allowed to run. If the required resource can be controlled by CTest you should use -:prop_test:`RESOURCE_LOCK` instead of :prop_test:`TIMEOUT_AFTER_MATCH`. +:prop_test:`RESOURCE_LOCK` instead of ``TIMEOUT_AFTER_MATCH``. This property should be used when only the test itself can determine when its required resources are available. diff --git a/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst b/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst index ff42ae8..1ca0969 100644 --- a/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst +++ b/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst @@ -13,7 +13,7 @@ When unset or empty the directory ``<dir>/<target-name>_autogen`` is used where ``<dir>`` is :variable:`CMAKE_CURRENT_BINARY_DIR` and ``<target-name>`` is :prop_tgt:`NAME`. -By default :prop_tgt:`AUTOGEN_BUILD_DIR` is unset. +By default ``AUTOGEN_BUILD_DIR`` is unset. See the :manual:`cmake-qt(7)` manual for more information on using CMake with Qt. diff --git a/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst b/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst index 563190a..9350a4f 100644 --- a/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst +++ b/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst @@ -11,16 +11,16 @@ Targets which have their :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` property ``moc`` and ``uic`` files. As this ``_autogen`` target is created at generate-time, it is not possible to define dependencies of it using e.g. :command:`add_dependencies`. Instead the -:prop_tgt:`AUTOGEN_ORIGIN_DEPENDS` target property decides whether the origin +``AUTOGEN_ORIGIN_DEPENDS`` target property decides whether the origin target dependencies should be forwarded to the ``_autogen`` target or not. -By default :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS` is initialized from +By default ``AUTOGEN_ORIGIN_DEPENDS`` is initialized from :variable:`CMAKE_AUTOGEN_ORIGIN_DEPENDS` which is ``ON`` by default. In total the dependencies of the ``_autogen`` target are composed from - forwarded origin target dependencies - (enabled by default via :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS`) + (enabled by default via ``AUTOGEN_ORIGIN_DEPENDS``) - additional user defined dependencies from :prop_tgt:`AUTOGEN_TARGET_DEPENDS` See the :manual:`cmake-qt(7)` manual for more information on using CMake @@ -29,12 +29,12 @@ with Qt. Note ^^^^ -Disabling :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS` is useful to avoid building of +Disabling ``AUTOGEN_ORIGIN_DEPENDS`` is useful to avoid building of origin target dependencies when building the ``_autogen`` target only. This is especially interesting when a :variable:`global autogen target <CMAKE_GLOBAL_AUTOGEN_TARGET>` is enabled. When the ``_autogen`` target doesn't require all the origin target's -dependencies, and :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS` is disabled, it might be +dependencies, and ``AUTOGEN_ORIGIN_DEPENDS`` is disabled, it might be necessary to extend :prop_tgt:`AUTOGEN_TARGET_DEPENDS` to add missing dependencies. diff --git a/Help/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst b/Help/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst index 92b52a3..5286d2d 100644 --- a/Help/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst +++ b/Help/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst @@ -8,7 +8,7 @@ Targets which have their :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` property ``moc`` and ``uic`` files. As this ``_autogen`` target is created at generate-time, it is not possible to define dependencies of it using e.g. :command:`add_dependencies`. Instead the -:prop_tgt:`AUTOGEN_TARGET_DEPENDS` target property can be set to a +``AUTOGEN_TARGET_DEPENDS`` target property can be set to a :ref:`;-list <CMake Language Lists>` of additional dependencies for the ``_autogen`` target. Dependencies can be target names or file names. @@ -16,7 +16,7 @@ In total the dependencies of the ``_autogen`` target are composed from - forwarded origin target dependencies (enabled by default via :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS`) -- additional user defined dependencies from :prop_tgt:`AUTOGEN_TARGET_DEPENDS` +- additional user defined dependencies from ``AUTOGEN_TARGET_DEPENDS`` See the :manual:`cmake-qt(7)` manual for more information on using CMake with Qt. @@ -33,4 +33,4 @@ If :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` depends on a file that is either :prop_sf:`SKIP_AUTOUIC`, :prop_sf:`SKIP_AUTOGEN` or :policy:`CMP0071` or - a file that isn't in the origin target's sources -it must be added to :prop_tgt:`AUTOGEN_TARGET_DEPENDS`. +it must be added to ``AUTOGEN_TARGET_DEPENDS``. diff --git a/Help/prop_tgt/AUTOMOC.rst b/Help/prop_tgt/AUTOMOC.rst index ed8b262..0feb2e8 100644 --- a/Help/prop_tgt/AUTOMOC.rst +++ b/Help/prop_tgt/AUTOMOC.rst @@ -3,7 +3,7 @@ AUTOMOC Should the target be processed with auto-moc (for Qt projects). -:prop_tgt:`AUTOMOC` is a boolean specifying whether CMake will handle the Qt +``AUTOMOC`` is a boolean specifying whether CMake will handle the Qt ``moc`` preprocessor automatically, i.e. without having to use commands like :module:`QT4_WRAP_CPP() <FindQt4>`, ``QT5_WRAP_CPP()``, etc. Currently, Qt versions 4 to 6 are supported. @@ -19,7 +19,7 @@ Header file processing ^^^^^^^^^^^^^^^^^^^^^^ At configuration time, a list of header files that should be scanned by -:prop_tgt:`AUTOMOC` is computed from the target's sources. +``AUTOMOC`` is computed from the target's sources. - All header files in the target's sources are added to the scan list. - For all C++ source files ``<source_base>.<source_extension>`` in the @@ -146,7 +146,7 @@ which is added to the target's sources. Qt version detection ^^^^^^^^^^^^^^^^^^^^ -:prop_tgt:`AUTOMOC` enabled targets need to know the Qt major and minor +``AUTOMOC`` enabled targets need to know the Qt major and minor version they're working with. The major version usually is provided by the ``INTERFACE_QT_MAJOR_VERSION`` property of the ``Qt[456]Core`` library, that the target links to. To find the minor version, CMake builds a list of @@ -173,7 +173,7 @@ entry in the list is taken. A ``find_package(Qt[456]...)`` call sets the ``QT/Qt[56]Core_VERSION_MAJOR/MINOR`` variables. If the call is in a different context than the :command:`add_executable` or :command:`add_library` call, e.g. in a function, -then the version variables might not be available to the :prop_tgt:`AUTOMOC` +then the version variables might not be available to the ``AUTOMOC`` enabled target. In that case the version variables can be forwarded from the ``find_package(Qt[456]...)`` calling context to the :command:`add_executable` @@ -221,25 +221,25 @@ Compiler pre definitions for ``moc`` are written to the ``moc_predefs.h`` file. The generation of this file can be enabled or disabled in this target property. :prop_sf:`SKIP_AUTOMOC`: -Sources and headers can be excluded from :prop_tgt:`AUTOMOC` processing by +Sources and headers can be excluded from ``AUTOMOC`` processing by setting this source file property. :prop_sf:`SKIP_AUTOGEN`: -Source files can be excluded from :prop_tgt:`AUTOMOC`, +Source files can be excluded from ``AUTOMOC``, :prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` processing by setting this source file property. :prop_gbl:`AUTOGEN_SOURCE_GROUP`: This global property can be used to group files generated by -:prop_tgt:`AUTOMOC` or :prop_tgt:`AUTORCC` together in an IDE, e.g. in MSVS. +``AUTOMOC`` or :prop_tgt:`AUTORCC` together in an IDE, e.g. in MSVS. :prop_gbl:`AUTOGEN_TARGETS_FOLDER`: -This global property can be used to group :prop_tgt:`AUTOMOC`, +This global property can be used to group ``AUTOMOC``, :prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` targets together in an IDE, e.g. in MSVS. :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET`: -A global ``autogen`` target, that depends on all :prop_tgt:`AUTOMOC` or +A global ``autogen`` target, that depends on all ``AUTOMOC`` or :prop_tgt:`AUTOUIC` generated ``<ORIGIN>_autogen`` targets in the project, will be generated when this variable is ``ON``. diff --git a/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst b/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst index 8998284..82aa61e 100644 --- a/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst +++ b/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst @@ -12,14 +12,14 @@ from the output of the command defined in when - :prop_tgt:`AUTOMOC` is enabled, -- :prop_tgt:`AUTOMOC_COMPILER_PREDEFINES` is enabled, +- ``AUTOMOC_COMPILER_PREDEFINES`` is enabled, - :variable:`CMAKE_CXX_COMPILER_PREDEFINES_COMMAND <CMAKE_<LANG>_COMPILER_PREDEFINES_COMMAND>` isn't empty and - the Qt version is greater or equal 5.8. The ``moc_predefs.h`` file, which is generated in :prop_tgt:`AUTOGEN_BUILD_DIR`, is passed to ``moc`` as the argument to the ``--include`` option. -By default :prop_tgt:`AUTOMOC_COMPILER_PREDEFINES` is initialized from +By default ``AUTOMOC_COMPILER_PREDEFINES`` is initialized from :variable:`CMAKE_AUTOMOC_COMPILER_PREDEFINES`, which is ON by default. See the :manual:`cmake-qt(7)` manual for more information on using CMake diff --git a/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst b/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst index 1f31700..c4277d7 100644 --- a/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst +++ b/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst @@ -25,7 +25,7 @@ target's sources, then it might be necessary to add it to the ``_autogen`` target dependencies. See :prop_tgt:`AUTOGEN_TARGET_DEPENDS` for reference. -By default :prop_tgt:`AUTOMOC_DEPEND_FILTERS` is initialized from +By default ``AUTOMOC_DEPEND_FILTERS`` is initialized from :variable:`CMAKE_AUTOMOC_DEPEND_FILTERS`, which is empty by default. From Qt 5.15.0 on this variable is ignored as moc is able to output the correct diff --git a/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst b/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst index f4b8396..a6d5aa0 100644 --- a/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst +++ b/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst @@ -3,7 +3,7 @@ AUTOMOC_EXECUTABLE .. versionadded:: 3.14 -:prop_tgt:`AUTOMOC_EXECUTABLE` is file path pointing to the ``moc`` +``AUTOMOC_EXECUTABLE`` is file path pointing to the ``moc`` executable to use for :prop_tgt:`AUTOMOC` enabled files. Setting this property will make CMake skip the automatic detection of the ``moc`` binary as well as the sanity-tests normally run to ensure diff --git a/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst b/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst index a53810d..072e7f7 100644 --- a/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst +++ b/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst @@ -10,7 +10,7 @@ This property is only used if the :prop_tgt:`AUTOMOC` property is ``ON`` for this target. When running :prop_tgt:`AUTOMOC`, CMake searches for the strings listed in -:prop_tgt:`AUTOMOC_MACRO_NAMES` in C++ source and header files. +``AUTOMOC_MACRO_NAMES`` in C++ source and header files. If any of the strings is found - as the first non space string on a new line or @@ -18,7 +18,7 @@ If any of the strings is found then the file will be processed by ``moc``. -By default :prop_tgt:`AUTOMOC_MACRO_NAMES` is initialized from +By default ``AUTOMOC_MACRO_NAMES`` is initialized from :variable:`CMAKE_AUTOMOC_MACRO_NAMES`. See the :manual:`cmake-qt(7)` manual for more information on using CMake diff --git a/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst b/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst index 836d953..dcddcae 100644 --- a/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst +++ b/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst @@ -14,7 +14,7 @@ compute the relative path accordingly. If the header is not in the the ``-p`` path prefix option. ``moc`` usually generates a relative include path in that case. -:prop_tgt:`AUTOMOC_PATH_PREFIX` is initialized from the variable +``AUTOMOC_PATH_PREFIX`` is initialized from the variable :variable:`CMAKE_AUTOMOC_PATH_PREFIX`, which is ``OFF`` by default. See the :manual:`cmake-qt(7)` manual for more information on using CMake @@ -26,7 +26,7 @@ Reproducible builds For reproducible builds it is recommended to keep headers that are ``moc`` compiled in one of the target :command:`include directories <target_include_directories>` and set -:prop_tgt:`AUTOMOC_PATH_PREFIX` to ``ON``. This ensures that: +``AUTOMOC_PATH_PREFIX`` to ``ON``. This ensures that: - ``moc`` output files are identical on different build setups, - ``moc`` output files will compile correctly when the source and/or diff --git a/Help/prop_tgt/AUTORCC.rst b/Help/prop_tgt/AUTORCC.rst index 0a0c2a1..33de352 100644 --- a/Help/prop_tgt/AUTORCC.rst +++ b/Help/prop_tgt/AUTORCC.rst @@ -3,7 +3,7 @@ AUTORCC Should the target be processed with auto-rcc (for Qt projects). -:prop_tgt:`AUTORCC` is a boolean specifying whether CMake will handle +``AUTORCC`` is a boolean specifying whether CMake will handle the Qt ``rcc`` code generator automatically, i.e. without having to use commands like :module:`QT4_ADD_RESOURCES() <FindQt4>`, ``QT5_ADD_RESOURCES()``, etc. Currently, Qt versions 4 to 6 are supported. @@ -13,7 +13,7 @@ as target sources at build time and invoke ``rcc`` accordingly. This property is initialized by the value of the :variable:`CMAKE_AUTORCC` variable if it is set when a target is created. -By default :prop_tgt:`AUTORCC` is processed by a +By default ``AUTORCC`` is processed by a :command:`custom command <add_custom_command>`. If the ``.qrc`` file is :prop_sf:`GENERATED`, a :command:`custom target <add_custom_target>` is used instead. @@ -37,25 +37,25 @@ property. The corresponding :prop_sf:`AUTORCC_OPTIONS` source file property can be used to specify options to be applied only to a specific ``.qrc`` file. :prop_sf:`SKIP_AUTORCC`: -``.qrc`` files can be excluded from :prop_tgt:`AUTORCC` processing by +``.qrc`` files can be excluded from ``AUTORCC`` processing by setting this source file property. :prop_sf:`SKIP_AUTOGEN`: Source files can be excluded from :prop_tgt:`AUTOMOC`, -:prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` processing by +:prop_tgt:`AUTOUIC` and ``AUTORCC`` processing by setting this source file property. :prop_gbl:`AUTOGEN_SOURCE_GROUP`: This global property can be used to group files generated by -:prop_tgt:`AUTOMOC` or :prop_tgt:`AUTORCC` together in an IDE, e.g. in MSVS. +:prop_tgt:`AUTOMOC` or ``AUTORCC`` together in an IDE, e.g. in MSVS. :prop_gbl:`AUTOGEN_TARGETS_FOLDER`: This global property can be used to group :prop_tgt:`AUTOMOC`, -:prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` targets together in an IDE, +:prop_tgt:`AUTOUIC` and ``AUTORCC`` targets together in an IDE, e.g. in MSVS. :variable:`CMAKE_GLOBAL_AUTORCC_TARGET`: -A global ``autorcc`` target that depends on all :prop_tgt:`AUTORCC` targets +A global ``autorcc`` target that depends on all ``AUTORCC`` targets in the project will be generated when this variable is ``ON``. See the :manual:`cmake-qt(7)` manual for more information on using CMake diff --git a/Help/prop_tgt/AUTORCC_EXECUTABLE.rst b/Help/prop_tgt/AUTORCC_EXECUTABLE.rst index 4f85fba..68942e6 100644 --- a/Help/prop_tgt/AUTORCC_EXECUTABLE.rst +++ b/Help/prop_tgt/AUTORCC_EXECUTABLE.rst @@ -3,7 +3,7 @@ AUTORCC_EXECUTABLE .. versionadded:: 3.14 -:prop_tgt:`AUTORCC_EXECUTABLE` is file path pointing to the ``rcc`` +``AUTORCC_EXECUTABLE`` is file path pointing to the ``rcc`` executable to use for :prop_tgt:`AUTORCC` enabled files. Setting this property will make CMake skip the automatic detection of the ``rcc`` binary as well as the sanity-tests normally run to ensure diff --git a/Help/prop_tgt/AUTOUIC.rst b/Help/prop_tgt/AUTOUIC.rst index e0cea97..dc854b2 100644 --- a/Help/prop_tgt/AUTOUIC.rst +++ b/Help/prop_tgt/AUTOUIC.rst @@ -3,7 +3,7 @@ AUTOUIC Should the target be processed with auto-uic (for Qt projects). -:prop_tgt:`AUTOUIC` is a boolean specifying whether CMake will handle +``AUTOUIC`` is a boolean specifying whether CMake will handle the Qt ``uic`` code generator automatically, i.e. without having to use commands like :module:`QT4_WRAP_UI() <FindQt4>`, ``QT5_WRAP_UI()``, etc. Currently, Qt versions 4 to 6 are supported. @@ -59,22 +59,22 @@ can be used to specify options to be applied only to a specific ``<base_name>.ui`` file. :prop_sf:`SKIP_AUTOUIC`: -Source files can be excluded from :prop_tgt:`AUTOUIC` processing by setting +Source files can be excluded from ``AUTOUIC`` processing by setting this source file property. :prop_sf:`SKIP_AUTOGEN`: Source files can be excluded from :prop_tgt:`AUTOMOC`, -:prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` processing by +``AUTOUIC`` and :prop_tgt:`AUTORCC` processing by setting this source file property. :prop_gbl:`AUTOGEN_TARGETS_FOLDER`: This global property can be used to group :prop_tgt:`AUTOMOC`, -:prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` targets together in an IDE, +``AUTOUIC`` and :prop_tgt:`AUTORCC` targets together in an IDE, e.g. in MSVS. :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET`: A global ``autogen`` target, that depends on all :prop_tgt:`AUTOMOC` or -:prop_tgt:`AUTOUIC` generated ``<ORIGIN>_autogen`` targets in the project, +``AUTOUIC`` generated ``<ORIGIN>_autogen`` targets in the project, will be generated when this variable is ``ON``. :prop_tgt:`AUTOGEN_PARALLEL`: diff --git a/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst b/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst index 5966326..be79290 100644 --- a/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst +++ b/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst @@ -3,7 +3,7 @@ AUTOUIC_EXECUTABLE .. versionadded:: 3.14 -:prop_tgt:`AUTOUIC_EXECUTABLE` is file path pointing to the ``uic`` +``AUTOUIC_EXECUTABLE`` is file path pointing to the ``uic`` executable to use for :prop_tgt:`AUTOUIC` enabled files. Setting this property will make CMake skip the automatic detection of the ``uic`` binary as well as the sanity-tests normally run to ensure diff --git a/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst b/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst index 42cace0..fab142c 100644 --- a/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst +++ b/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst @@ -18,6 +18,6 @@ For instance: This property is initialized by the value of :variable:`CMAKE_JOB_POOL_PRECOMPILE_HEADER`. -If neither :prop_tgt:`JOB_POOL_PRECOMPILE_HEADER` nor +If neither ``JOB_POOL_PRECOMPILE_HEADER`` nor :variable:`CMAKE_JOB_POOL_PRECOMPILE_HEADER` are set then :prop_tgt:`JOB_POOL_COMPILE` will be used for this task. diff --git a/Help/prop_tgt/OBJCXX_EXTENSIONS.rst b/Help/prop_tgt/OBJCXX_EXTENSIONS.rst index 2a15dec..9a629fd 100644 --- a/Help/prop_tgt/OBJCXX_EXTENSIONS.rst +++ b/Help/prop_tgt/OBJCXX_EXTENSIONS.rst @@ -15,7 +15,7 @@ See the :manual:`cmake-compile-features(7)` manual for information on compile features and a list of supported compilers. If the property is not set, and the project has set the :prop_tgt:`CXX_EXTENSIONS`, -the value of :prop_tgt:`CXX_EXTENSIONS` is set for :prop_tgt:`OBJCXX_EXTENSIONS`. +the value of :prop_tgt:`CXX_EXTENSIONS` is set for ``OBJCXX_EXTENSIONS``. This property is initialized by the value of the :variable:`CMAKE_OBJCXX_EXTENSIONS` variable if set when a target is diff --git a/Help/prop_tgt/OBJCXX_STANDARD.rst b/Help/prop_tgt/OBJCXX_STANDARD.rst index 6ac8216..03108e1 100644 --- a/Help/prop_tgt/OBJCXX_STANDARD.rst +++ b/Help/prop_tgt/OBJCXX_STANDARD.rst @@ -53,7 +53,7 @@ Additionally, the :prop_tgt:`OBJCXX_EXTENSIONS` target property may be used to control whether compiler-specific extensions are enabled on a per-target basis. If the property is not set, and the project has set the :prop_tgt:`CXX_STANDARD`, -the value of :prop_tgt:`CXX_STANDARD` is set for :prop_tgt:`OBJCXX_STANDARD`. +the value of :prop_tgt:`CXX_STANDARD` is set for ``OBJCXX_STANDARD``. See the :manual:`cmake-compile-features(7)` manual for information on compile features and a list of supported compilers. diff --git a/Help/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst b/Help/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst index 3cee740..2c3c77c 100644 --- a/Help/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst +++ b/Help/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst @@ -12,7 +12,7 @@ treated as optional and may "decay" to a previous standard if the requested is not available. If the property is not set, and the project has set the :prop_tgt:`CXX_STANDARD_REQUIRED`, -the value of :prop_tgt:`CXX_STANDARD_REQUIRED` is set for :prop_tgt:`OBJCXX_STANDARD_REQUIRED`. +the value of :prop_tgt:`CXX_STANDARD_REQUIRED` is set for ``OBJCXX_STANDARD_REQUIRED``. See the :manual:`cmake-compile-features(7)` manual for information on compile features and a list of supported compilers. diff --git a/Help/prop_tgt/OBJC_EXTENSIONS.rst b/Help/prop_tgt/OBJC_EXTENSIONS.rst index cd72e5f..2914045 100644 --- a/Help/prop_tgt/OBJC_EXTENSIONS.rst +++ b/Help/prop_tgt/OBJC_EXTENSIONS.rst @@ -12,7 +12,7 @@ property is ``ON`` by default. The basic OBJC standard level is controlled by the :prop_tgt:`OBJC_STANDARD` target property. If the property is not set, and the project has set the :prop_tgt:`C_EXTENSIONS`, -the value of :prop_tgt:`C_EXTENSIONS` is set for :prop_tgt:`OBJC_EXTENSIONS`. +the value of :prop_tgt:`C_EXTENSIONS` is set for ``OBJC_EXTENSIONS``. See the :manual:`cmake-compile-features(7)` manual for information on compile features and a list of supported compilers. diff --git a/Help/prop_tgt/OBJC_STANDARD.rst b/Help/prop_tgt/OBJC_STANDARD.rst index 2d27bcf..0609239 100644 --- a/Help/prop_tgt/OBJC_STANDARD.rst +++ b/Help/prop_tgt/OBJC_STANDARD.rst @@ -36,7 +36,7 @@ Additionally, the :prop_tgt:`OBJC_EXTENSIONS` target property may be used to control whether compiler-specific extensions are enabled on a per-target basis. If the property is not set, and the project has set the :prop_tgt:`C_STANDARD`, -the value of :prop_tgt:`C_STANDARD` is set for :prop_tgt:`OBJC_STANDARD`. +the value of :prop_tgt:`C_STANDARD` is set for ``OBJC_STANDARD``. See the :manual:`cmake-compile-features(7)` manual for information on compile features and a list of supported compilers. diff --git a/Help/prop_tgt/OBJC_STANDARD_REQUIRED.rst b/Help/prop_tgt/OBJC_STANDARD_REQUIRED.rst index 11547c8..8b0a928 100644 --- a/Help/prop_tgt/OBJC_STANDARD_REQUIRED.rst +++ b/Help/prop_tgt/OBJC_STANDARD_REQUIRED.rst @@ -12,7 +12,7 @@ treated as optional and may "decay" to a previous standard if the requested is not available. If the property is not set, and the project has set the :prop_tgt:`C_STANDARD_REQUIRED`, -the value of :prop_tgt:`C_STANDARD_REQUIRED` is set for :prop_tgt:`OBJC_STANDARD_REQUIRED`. +the value of :prop_tgt:`C_STANDARD_REQUIRED` is set for ``OBJC_STANDARD_REQUIRED``. See the :manual:`cmake-compile-features(7)` manual for information on compile features and a list of supported compilers. diff --git a/Help/prop_tgt/UNITY_BUILD_MODE.rst b/Help/prop_tgt/UNITY_BUILD_MODE.rst index 003451e..d3d1fcc 100644 --- a/Help/prop_tgt/UNITY_BUILD_MODE.rst +++ b/Help/prop_tgt/UNITY_BUILD_MODE.rst @@ -56,5 +56,5 @@ which has the following acceptable values: PROPERTIES UNITY_GROUP "bucket2" ) -If no explicit :prop_tgt:`UNITY_BUILD_MODE` has been specified, CMake will +If no explicit ``UNITY_BUILD_MODE`` has been specified, CMake will default to ``BATCH``. diff --git a/Help/variable/CMAKE_AUTOGEN_ORIGIN_DEPENDS.rst b/Help/variable/CMAKE_AUTOGEN_ORIGIN_DEPENDS.rst index c24e462..f490974 100644 --- a/Help/variable/CMAKE_AUTOGEN_ORIGIN_DEPENDS.rst +++ b/Help/variable/CMAKE_AUTOGEN_ORIGIN_DEPENDS.rst @@ -10,4 +10,4 @@ This variable is used to initialize the :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS` property on all the targets. See that target property for additional information. -By default :variable:`CMAKE_AUTOGEN_ORIGIN_DEPENDS` is ``ON``. +By default ``CMAKE_AUTOGEN_ORIGIN_DEPENDS`` is ``ON``. diff --git a/Help/variable/CMAKE_AUTOGEN_PARALLEL.rst b/Help/variable/CMAKE_AUTOGEN_PARALLEL.rst index 2ada012..8e68579 100644 --- a/Help/variable/CMAKE_AUTOGEN_PARALLEL.rst +++ b/Help/variable/CMAKE_AUTOGEN_PARALLEL.rst @@ -9,4 +9,4 @@ Number of parallel ``moc`` or ``uic`` processes to start when using This variable is used to initialize the :prop_tgt:`AUTOGEN_PARALLEL` property on all the targets. See that target property for additional information. -By default :variable:`CMAKE_AUTOGEN_PARALLEL` is unset. +By default ``CMAKE_AUTOGEN_PARALLEL`` is unset. diff --git a/Help/variable/CMAKE_AUTOGEN_VERBOSE.rst b/Help/variable/CMAKE_AUTOGEN_VERBOSE.rst index f77ed6a..246bd37 100644 --- a/Help/variable/CMAKE_AUTOGEN_VERBOSE.rst +++ b/Help/variable/CMAKE_AUTOGEN_VERBOSE.rst @@ -7,9 +7,9 @@ Sets the verbosity of :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC`. A positive integer value or a true boolean value lets the ``AUTO*`` generators output additional processing information. -Setting :variable:`CMAKE_AUTOGEN_VERBOSE` has the same effect +Setting ``CMAKE_AUTOGEN_VERBOSE`` has the same effect as setting the ``VERBOSE`` environment variable during generation (e.g. by calling ``make VERBOSE=1``). The extra verbosity is limited to the ``AUTO*`` generators though. -By default :variable:`CMAKE_AUTOGEN_VERBOSE` is unset. +By default ``CMAKE_AUTOGEN_VERBOSE`` is unset. diff --git a/Help/variable/CMAKE_BINARY_DIR.rst b/Help/variable/CMAKE_BINARY_DIR.rst index e601eb8..96c6319 100644 --- a/Help/variable/CMAKE_BINARY_DIR.rst +++ b/Help/variable/CMAKE_BINARY_DIR.rst @@ -8,6 +8,6 @@ tree. For an in-source build, this would be the same as :variable:`CMAKE_SOURCE_DIR`. When run in :option:`cmake -P` script mode, CMake sets the variables -:variable:`CMAKE_BINARY_DIR`, :variable:`CMAKE_SOURCE_DIR`, +``CMAKE_BINARY_DIR``, :variable:`CMAKE_SOURCE_DIR`, :variable:`CMAKE_CURRENT_BINARY_DIR` and :variable:`CMAKE_CURRENT_SOURCE_DIR` to the current working directory. diff --git a/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst b/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst index 15f81d2..1d7a111 100644 --- a/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst +++ b/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst @@ -11,5 +11,5 @@ current source directory being processed. When run in :option:`cmake -P` script mode, CMake sets the variables :variable:`CMAKE_BINARY_DIR`, :variable:`CMAKE_SOURCE_DIR`, -:variable:`CMAKE_CURRENT_BINARY_DIR` and +``CMAKE_CURRENT_BINARY_DIR`` and :variable:`CMAKE_CURRENT_SOURCE_DIR` to the current working directory. diff --git a/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst b/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst index 5b86026..4205efb 100644 --- a/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst +++ b/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst @@ -9,4 +9,4 @@ processed by cmake. When run in :option:`cmake -P` script mode, CMake sets the variables :variable:`CMAKE_BINARY_DIR`, :variable:`CMAKE_SOURCE_DIR`, :variable:`CMAKE_CURRENT_BINARY_DIR` and -:variable:`CMAKE_CURRENT_SOURCE_DIR` to the current working directory. +``CMAKE_CURRENT_SOURCE_DIR`` to the current working directory. diff --git a/Help/variable/CMAKE_DEFAULT_CONFIGS.rst b/Help/variable/CMAKE_DEFAULT_CONFIGS.rst index 65a5f0d..2f42b23 100644 --- a/Help/variable/CMAKE_DEFAULT_CONFIGS.rst +++ b/Help/variable/CMAKE_DEFAULT_CONFIGS.rst @@ -10,7 +10,7 @@ configurations from :variable:`CMAKE_CROSS_CONFIGS` are used. If it is not specified, it defaults to :variable:`CMAKE_DEFAULT_BUILD_TYPE`. For example, if you set :variable:`CMAKE_DEFAULT_BUILD_TYPE` to ``Release``, -but set :variable:`CMAKE_DEFAULT_CONFIGS` to ``Debug`` or ``all``, all +but set ``CMAKE_DEFAULT_CONFIGS`` to ``Debug`` or ``all``, all ``<target>`` aliases in ``build.ninja`` will resolve to ``<target>:Debug`` or ``<target>:all``, but custom commands will still use the ``Release`` configuration. diff --git a/Help/variable/CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT.rst b/Help/variable/CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT.rst index 721014a..612ab8a 100644 --- a/Help/variable/CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT.rst +++ b/Help/variable/CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT.rst @@ -9,5 +9,5 @@ This cache variable is used by the Eclipse project generator. See If this variable is set to TRUE, the Eclipse project generator will generate an Eclipse project in :variable:`CMAKE_SOURCE_DIR` . This project can then be used in Eclipse e.g. for the version control functionality. -:variable:`CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT` defaults to ``FALSE``; so +``CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT`` defaults to ``FALSE``; so nothing is written into the source directory. diff --git a/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst b/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst index 8d86a94..5392ad1 100644 --- a/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst +++ b/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst @@ -18,7 +18,7 @@ unless the ``NO_CMAKE_PACKAGE_REGISTRY`` option is provided. In some cases, for example to locate only system wide installations, it is not desirable to use the :ref:`User Package Registry` when searching -for packages. If the :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` +for packages. If the ``CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY`` variable is ``TRUE``, all the :command:`find_package` commands will skip the :ref:`User Package Registry` as if they were called with the ``NO_CMAKE_PACKAGE_REGISTRY`` argument. diff --git a/Help/variable/CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY.rst b/Help/variable/CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY.rst index cc67f08..21b0230 100644 --- a/Help/variable/CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY.rst +++ b/Help/variable/CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY.rst @@ -18,7 +18,7 @@ unless the ``NO_CMAKE_SYSTEM_PACKAGE_REGISTRY`` option is provided. In some cases, it is not desirable to use the :ref:`System Package Registry` when searching for packages. If the -:variable:`CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY` variable is +``CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY`` variable is ``TRUE``, all the :command:`find_package` commands will skip the :ref:`System Package Registry` as if they were called with the ``NO_CMAKE_SYSTEM_PACKAGE_REGISTRY`` argument. diff --git a/Help/variable/CMAKE_FIND_USE_PACKAGE_REGISTRY.rst b/Help/variable/CMAKE_FIND_USE_PACKAGE_REGISTRY.rst index a5eec7a..b058ba0 100644 --- a/Help/variable/CMAKE_FIND_USE_PACKAGE_REGISTRY.rst +++ b/Help/variable/CMAKE_FIND_USE_PACKAGE_REGISTRY.rst @@ -18,7 +18,7 @@ This variable takes precedence over In some cases, for example to locate only system wide installations, it is not desirable to use the :ref:`User Package Registry` when searching -for packages. If the :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` +for packages. If the ``CMAKE_FIND_USE_PACKAGE_REGISTRY`` variable is ``FALSE``, all the :command:`find_package` commands will skip the :ref:`User Package Registry` as if they were called with the ``NO_CMAKE_PACKAGE_REGISTRY`` argument. diff --git a/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET.rst b/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET.rst index 96e9907..7d3f9c3 100644 --- a/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET.rst +++ b/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET.rst @@ -5,7 +5,7 @@ CMAKE_GLOBAL_AUTOGEN_TARGET Switch to enable generation of a global ``autogen`` target. -When :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET` is enabled, a custom target +When ``CMAKE_GLOBAL_AUTOGEN_TARGET`` is enabled, a custom target ``autogen`` is generated. This target depends on all :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC` generated ``<ORIGIN>_autogen`` targets in the project. By building the global ``autogen`` target, all :prop_tgt:`AUTOMOC` and @@ -14,7 +14,7 @@ By building the global ``autogen`` target, all :prop_tgt:`AUTOMOC` and The name of the global ``autogen`` target can be changed by setting :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET_NAME`. -By default :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET` is unset. +By default ``CMAKE_GLOBAL_AUTOGEN_TARGET`` is unset. See the :manual:`cmake-qt(7)` manual for more information on using CMake with Qt. diff --git a/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET_NAME.rst b/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET_NAME.rst index 4af4bc3..d970d56 100644 --- a/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET_NAME.rst +++ b/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET_NAME.rst @@ -6,10 +6,10 @@ CMAKE_GLOBAL_AUTOGEN_TARGET_NAME Change the name of the global ``autogen`` target. When :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET` is enabled, a global custom target -named ``autogen`` is created. :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET_NAME` +named ``autogen`` is created. ``CMAKE_GLOBAL_AUTOGEN_TARGET_NAME`` allows to set a different name for that target. -By default :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET_NAME` is unset. +By default ``CMAKE_GLOBAL_AUTOGEN_TARGET_NAME`` is unset. See the :manual:`cmake-qt(7)` manual for more information on using CMake with Qt. diff --git a/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET.rst b/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET.rst index efea5be..0b8c309 100644 --- a/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET.rst +++ b/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET.rst @@ -5,7 +5,7 @@ CMAKE_GLOBAL_AUTORCC_TARGET Switch to enable generation of a global ``autorcc`` target. -When :variable:`CMAKE_GLOBAL_AUTORCC_TARGET` is enabled, a custom target +When ``CMAKE_GLOBAL_AUTORCC_TARGET`` is enabled, a custom target ``autorcc`` is generated. This target depends on all :prop_tgt:`AUTORCC` generated ``<ORIGIN>_arcc_<QRC>`` targets in the project. By building the global ``autorcc`` target, all :prop_tgt:`AUTORCC` @@ -14,7 +14,7 @@ files in the project will be generated. The name of the global ``autorcc`` target can be changed by setting :variable:`CMAKE_GLOBAL_AUTORCC_TARGET_NAME`. -By default :variable:`CMAKE_GLOBAL_AUTORCC_TARGET` is unset. +By default ``CMAKE_GLOBAL_AUTORCC_TARGET`` is unset. See the :manual:`cmake-qt(7)` manual for more information on using CMake with Qt. diff --git a/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET_NAME.rst b/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET_NAME.rst index b7db892..742425f 100644 --- a/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET_NAME.rst +++ b/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET_NAME.rst @@ -6,10 +6,10 @@ CMAKE_GLOBAL_AUTORCC_TARGET_NAME Change the name of the global ``autorcc`` target. When :variable:`CMAKE_GLOBAL_AUTORCC_TARGET` is enabled, a global custom target -named ``autorcc`` is created. :variable:`CMAKE_GLOBAL_AUTORCC_TARGET_NAME` +named ``autorcc`` is created. ``CMAKE_GLOBAL_AUTORCC_TARGET_NAME`` allows to set a different name for that target. -By default :variable:`CMAKE_GLOBAL_AUTORCC_TARGET_NAME` is unset. +By default ``CMAKE_GLOBAL_AUTORCC_TARGET_NAME`` is unset. See the :manual:`cmake-qt(7)` manual for more information on using CMake with Qt. diff --git a/Help/variable/CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst b/Help/variable/CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst index aad99e4..f864c20 100644 --- a/Help/variable/CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst +++ b/Help/variable/CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst @@ -7,7 +7,7 @@ Default permissions for directories created implicitly during installation of files by :command:`install` and :command:`file(INSTALL)`. If ``make install`` is invoked and directories are implicitly created they -get permissions set by :variable:`CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS` +get permissions set by ``CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS`` variable or platform specific default permissions if the variable is not set. Implicitly created directories are created if they are not explicitly installed @@ -15,7 +15,7 @@ by :command:`install` command but are needed to install a file on a certain path. Example of such locations are directories created due to the setting of :variable:`CMAKE_INSTALL_PREFIX`. -Expected content of the :variable:`CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS` +Expected content of the ``CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS`` variable is a list of permissions that can be used by :command:`install` command `PERMISSIONS` section. diff --git a/Help/variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY.rst b/Help/variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY.rst index 80a68c9..e88db36 100644 --- a/Help/variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY.rst +++ b/Help/variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY.rst @@ -6,6 +6,6 @@ Don't make the ``install`` target depend on the ``all`` target. By default, the ``install`` target depends on the ``all`` target. This has the effect, that when ``make install`` is invoked or ``INSTALL`` is built, first the ``all`` target is built, then the installation starts. -If :variable:`CMAKE_SKIP_INSTALL_ALL_DEPENDENCY` is set to ``TRUE``, this +If ``CMAKE_SKIP_INSTALL_ALL_DEPENDENCY`` is set to ``TRUE``, this dependency is not created, so the installation process will start immediately, independent from whether the project has been completely built or not. diff --git a/Help/variable/CMAKE_SOURCE_DIR.rst b/Help/variable/CMAKE_SOURCE_DIR.rst index 7210f75..f1d1bee 100644 --- a/Help/variable/CMAKE_SOURCE_DIR.rst +++ b/Help/variable/CMAKE_SOURCE_DIR.rst @@ -8,6 +8,6 @@ tree. For an in-source build, this would be the same as :variable:`CMAKE_BINARY_DIR`. When run in :option:`cmake -P` script mode, CMake sets the variables -:variable:`CMAKE_BINARY_DIR`, :variable:`CMAKE_SOURCE_DIR`, +:variable:`CMAKE_BINARY_DIR`, ``CMAKE_SOURCE_DIR``, :variable:`CMAKE_CURRENT_BINARY_DIR` and :variable:`CMAKE_CURRENT_SOURCE_DIR` to the current working directory. diff --git a/Help/variable/CMAKE_STAGING_PREFIX.rst b/Help/variable/CMAKE_STAGING_PREFIX.rst index bdb97fa..7b1048b 100644 --- a/Help/variable/CMAKE_STAGING_PREFIX.rst +++ b/Help/variable/CMAKE_STAGING_PREFIX.rst @@ -5,10 +5,10 @@ This variable may be set to a path to install to when cross-compiling. This can be useful if the path in :variable:`CMAKE_SYSROOT` is read-only, or otherwise should remain pristine. -The :variable:`CMAKE_STAGING_PREFIX` location is also used as a search prefix +The ``CMAKE_STAGING_PREFIX`` location is also used as a search prefix by the ``find_*`` commands. This can be controlled by setting the :variable:`CMAKE_FIND_NO_INSTALL_PREFIX` variable. If any ``RPATH``/``RUNPATH`` entries passed to the linker contain the -:variable:`CMAKE_STAGING_PREFIX`, the matching path fragments are replaced +``CMAKE_STAGING_PREFIX``, the matching path fragments are replaced with the :variable:`CMAKE_INSTALL_PREFIX`. diff --git a/Help/variable/CMAKE_TASKING_TOOLSET.rst b/Help/variable/CMAKE_TASKING_TOOLSET.rst index 6bd1479..53b2c09 100644 --- a/Help/variable/CMAKE_TASKING_TOOLSET.rst +++ b/Help/variable/CMAKE_TASKING_TOOLSET.rst @@ -14,7 +14,7 @@ the compiler features correctly. If no toolset is specified, Due to the different versioning schemes, the compiler version (:variable:`CMAKE_<LANG>_COMPILER_VERSION`) depends on the toolset and architecture in use. If projects can be built with multiple toolsets or -architectures, the specified :variable:`CMAKE_TASKING_TOOLSET` and the +architectures, the specified ``CMAKE_TASKING_TOOLSET`` and the automatically determined :variable:`CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID` must be taken into account when comparing against the :variable:`CMAKE_<LANG>_COMPILER_VERSION`. diff --git a/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM.rst b/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM.rst index d9f136c..f1a1977 100644 --- a/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM.rst +++ b/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM.rst @@ -5,7 +5,7 @@ CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM Override the :ref:`Windows 10 SDK Maximum Version for VS 2015` and beyond. -The :variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM` variable may +The ``CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM`` variable may be set to a false value (e.g. ``OFF``, ``FALSE``, or ``0``) or the SDK version to use as the maximum (e.g. ``10.0.14393.0``). If unset, the default depends on which version of Visual Studio is targeted by the current generator. |