diff options
Diffstat (limited to 'Help')
766 files changed, 2230 insertions, 175 deletions
diff --git a/Help/command/add_compile_definitions.rst b/Help/command/add_compile_definitions.rst index e10aba0..48e33be 100644 --- a/Help/command/add_compile_definitions.rst +++ b/Help/command/add_compile_definitions.rst @@ -1,6 +1,8 @@ add_compile_definitions ----------------------- +.. versionadded:: 3.12 + Add preprocessor definitions to the compilation of source files. .. code-block:: cmake diff --git a/Help/command/add_library.rst b/Help/command/add_library.rst index 01c415a..f3df631 100644 --- a/Help/command/add_library.rst +++ b/Help/command/add_library.rst @@ -64,42 +64,6 @@ See also :prop_sf:`HEADER_FILE_ONLY` on what to do if some sources are pre-processed, and you want to have the original sources reachable from within IDE. -Imported Libraries -^^^^^^^^^^^^^^^^^^ - -.. code-block:: cmake - - add_library(<name> <SHARED|STATIC|MODULE|OBJECT|UNKNOWN> IMPORTED - [GLOBAL]) - -An :ref:`IMPORTED library target <Imported Targets>` references a library -file located outside the project. No rules are generated to build it, and -the :prop_tgt:`IMPORTED` target property is ``True``. The target name has -scope in the directory in which it is created and below, but the ``GLOBAL`` -option extends visibility. It may be referenced like any target built -within the project. ``IMPORTED`` libraries are useful for convenient -reference from commands like :command:`target_link_libraries`. Details -about the imported library are specified by setting properties whose names -begin in ``IMPORTED_`` and ``INTERFACE_``. - -The most important properties are: - -* :prop_tgt:`IMPORTED_LOCATION` (and its per-configuration - variant :prop_tgt:`IMPORTED_LOCATION_<CONFIG>`) which specifies the - location of the main library file on disk. -* :prop_tgt:`IMPORTED_OBJECTS` (and :prop_tgt:`IMPORTED_OBJECTS_<CONFIG>`) - for object libraries, specifies the locations of object files on disk. -* :prop_tgt:`PUBLIC_HEADER` files to be installed during :command:`install` invocation - -See documentation of the ``IMPORTED_*`` and ``INTERFACE_*`` properties -for more information. - -An ``UNKNOWN`` library type is typically only used in the implementation of -:ref:`Find Modules`. It allows the path to an imported library (often found -using the :command:`find_library` command) to be used without having to know -what type of library it is. This is especially useful on Windows where a -static library and a DLL's import library both have the same file extension. - Object Libraries ^^^^^^^^^^^^^^^^ @@ -129,6 +93,112 @@ systems (such as Xcode) may not like targets that have only object files, so consider adding at least one real source file to any target that references ``$<TARGET_OBJECTS:objlib>``. +Interface Libraries +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: cmake + + add_library(<name> INTERFACE) + +Creates an :ref:`Interface Library <Interface Libraries>`. +An ``INTERFACE`` library target does not compile sources and does +not produce a library artifact on disk. However, it may have +properties set on it and it may be installed and exported. +Typically, ``INTERFACE_*`` properties are populated on an interface +target using the commands: + +* :command:`set_property`, +* :command:`target_link_libraries(INTERFACE)`, +* :command:`target_link_options(INTERFACE)`, +* :command:`target_include_directories(INTERFACE)`, +* :command:`target_compile_options(INTERFACE)`, +* :command:`target_compile_definitions(INTERFACE)`, and +* :command:`target_sources(INTERFACE)`, + +and then it is used as an argument to :command:`target_link_libraries` +like any other target. + +An interface library created with the above signature has no source files +itself and is not included as a target in the generated buildsystem. + +Since CMake 3.19, an interface library target may be created with +source files: + +.. code-block:: cmake + + add_library(<name> INTERFACE [<source>...] [EXCLUDE_FROM_ALL]) + +Source files may be listed directly in the ``add_library`` call or added +later by calls to :command:`target_sources` with the ``PRIVATE`` or +``PUBLIC`` keywords. + +If an interface library has source files (i.e. the :prop_tgt:`SOURCES` +target property is set), it will appear in the generated buildsystem +as a build target much like a target defined by the +:command:`add_custom_target` command. It does not compile any sources, +but does contain build rules for custom commands created by the +:command:`add_custom_command` command. + +.. note:: + In most command signatures where the ``INTERFACE`` keyword appears, + the items listed after it only become part of that target's usage + requirements and are not part of the target's own settings. However, + in this signature of ``add_library``, the ``INTERFACE`` keyword refers + to the library type only. Sources listed after it in the ``add_library`` + call are ``PRIVATE`` to the interface library and do not appear in its + :prop_tgt:`INTERFACE_SOURCES` target property. + +Imported Libraries +^^^^^^^^^^^^^^^^^^ + +.. code-block:: cmake + + add_library(<name> <type> IMPORTED [GLOBAL]) + +Creates an :ref:`IMPORTED library target <Imported Targets>` called ``<name>``. +No rules are generated to build it, and the :prop_tgt:`IMPORTED` target +property is ``True``. The target name has scope in the directory in which +it is created and below, but the ``GLOBAL`` option extends visibility. +It may be referenced like any target built within the project. +``IMPORTED`` libraries are useful for convenient reference from commands +like :command:`target_link_libraries`. Details about the imported library +are specified by setting properties whose names begin in ``IMPORTED_`` and +``INTERFACE_``. + +The ``<type>`` must be one of: + +``STATIC``, ``SHARED``, ``MODULE``, ``UNKNOWN`` + References a library file located outside the project. The + :prop_tgt:`IMPORTED_LOCATION` target property (or its per-configuration + variant :prop_tgt:`IMPORTED_LOCATION_<CONFIG>`) specifies the + location of the main library file on disk. In the case of a ``SHARED`` + library on Windows, the :prop_tgt:`IMPORTED_IMPLIB` target property + (or its per-configuration variant :prop_tgt:`IMPORTED_IMPLIB_<CONFIG>`) + specifies the location of the DLL import library file (``.lib`` or + ``.dll.a``) on disk, and the ``IMPORTED_LOCATION`` is the location of + the ``.dll`` runtime library (and is optional). + Additional usage requirements may be specified in ``INTERFACE_*`` properties. + + An ``UNKNOWN`` library type is typically only used in the implementation of + :ref:`Find Modules`. It allows the path to an imported library (often found + using the :command:`find_library` command) to be used without having to know + what type of library it is. This is especially useful on Windows where a + static library and a DLL's import library both have the same file extension. + +``OBJECT`` + References a set of object files located outside the project. + The :prop_tgt:`IMPORTED_OBJECTS` target property (or its per-configuration + variant :prop_tgt:`IMPORTED_OBJECTS_<CONFIG>`) specifies the locations of + object files on disk. + Additional usage requirements may be specified in ``INTERFACE_*`` properties. + +``INTERFACE`` + Does not reference any library or object files on disk, but may + specify usage requirements in ``INTERFACE_*`` properties. + +See documentation of the ``IMPORTED_*`` and ``INTERFACE_*`` properties +for more information. + Alias Libraries ^^^^^^^^^^^^^^^ @@ -153,35 +223,3 @@ to modify properties of ``<target>``, that is, it may not be used as the operand of :command:`set_property`, :command:`set_target_properties`, :command:`target_link_libraries` etc. An ``ALIAS`` target may not be installed or exported. - -Interface Libraries -^^^^^^^^^^^^^^^^^^^ - -.. code-block:: cmake - - add_library(<name> INTERFACE [IMPORTED [GLOBAL]]) - -Creates an :ref:`Interface Library <Interface Libraries>`. An ``INTERFACE`` -library target does not directly create build output, though it may -have properties set on it and it may be installed, exported and -imported. Typically the ``INTERFACE_*`` properties are populated on -the interface target using the commands: - -* :command:`set_property`, -* :command:`target_link_libraries(INTERFACE)`, -* :command:`target_link_options(INTERFACE)`, -* :command:`target_include_directories(INTERFACE)`, -* :command:`target_compile_options(INTERFACE)`, -* :command:`target_compile_definitions(INTERFACE)`, and -* :command:`target_sources(INTERFACE)`, - -and then it is used as an argument to :command:`target_link_libraries` -like any other target. - -An ``INTERFACE`` :ref:`Imported Target <Imported Targets>` may also be -created with this signature. An ``IMPORTED`` library target references a -library defined outside the project. The target name has scope in the -directory in which it is created and below, but the ``GLOBAL`` option -extends visibility. It may be referenced like any target built within -the project. ``IMPORTED`` libraries are useful for convenient reference -from commands like :command:`target_link_libraries`. diff --git a/Help/command/add_link_options.rst b/Help/command/add_link_options.rst index faa4afb..f03e7c0 100644 --- a/Help/command/add_link_options.rst +++ b/Help/command/add_link_options.rst @@ -1,6 +1,8 @@ add_link_options ---------------- +.. versionadded:: 3.13 + Add options to the link step for executable, shared library or module library targets in the current directory and below that are added after this command is invoked. diff --git a/Help/command/add_test.rst b/Help/command/add_test.rst index a77ba37..2b4d082 100644 --- a/Help/command/add_test.rst +++ b/Help/command/add_test.rst @@ -10,8 +10,9 @@ Add a test to the project to be run by :manual:`ctest(1)`. [WORKING_DIRECTORY <dir>] [COMMAND_EXPAND_LISTS]) -Adds a test called ``<name>``. The test name may not contain spaces, -quotes, or other characters special in CMake syntax. The options are: +Adds a test called ``<name>``. The test name may contain arbitrary +characters, expressed as a :ref:`Quoted Argument` or :ref:`Bracket Argument` +if necessary. See policy :policy:`CMP0110`. The options are: ``COMMAND`` Specify the test command-line. If ``<command>`` specifies an diff --git a/Help/command/cmake_language.rst b/Help/command/cmake_language.rst index 0988097..9e98d79 100644 --- a/Help/command/cmake_language.rst +++ b/Help/command/cmake_language.rst @@ -1,6 +1,8 @@ cmake_language -------------- +.. versionadded:: 3.18 + Call meta-operations on CMake commands. Synopsis diff --git a/Help/command/cmake_parse_arguments.rst b/Help/command/cmake_parse_arguments.rst index fcd36d0..8803ec8 100644 --- a/Help/command/cmake_parse_arguments.rst +++ b/Help/command/cmake_parse_arguments.rst @@ -1,6 +1,8 @@ cmake_parse_arguments --------------------- +.. versionadded:: 3.5 + Parse function or macro arguments. .. code-block:: cmake diff --git a/Help/command/configure_file.rst b/Help/command/configure_file.rst index 29e85bd..46d1a05 100644 --- a/Help/command/configure_file.rst +++ b/Help/command/configure_file.rst @@ -7,6 +7,7 @@ Copy a file to another location and modify its contents. configure_file(<input> <output> [COPYONLY] [ESCAPE_QUOTES] [@ONLY] + [NO_SOURCE_PERMISSIONS] [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]) Copies an ``<input>`` file to an ``<output>`` file and substitutes @@ -82,6 +83,11 @@ The arguments are: Restrict variable replacement to references of the form ``@VAR@``. This is useful for configuring scripts that use ``${VAR}`` syntax. + ``NO_SOURCE_PERMISSIONS`` + Does not transfer the file permissions of the original file to the copy. + The copied file permissions default to the standard 644 value + (-rw-r--r--). + ``NEWLINE_STYLE <style>`` Specify the newline style for the output file. Specify ``UNIX`` or ``LF`` for ``\n`` newlines, or specify diff --git a/Help/command/continue.rst b/Help/command/continue.rst index 31c7089..f62802e 100644 --- a/Help/command/continue.rst +++ b/Help/command/continue.rst @@ -1,6 +1,8 @@ continue -------- +.. versionadded:: 3.2 + Continue to the top of enclosing foreach or while loop. .. code-block:: cmake diff --git a/Help/command/file.rst b/Help/command/file.rst index 693c059..2cf938b 100644 --- a/Help/command/file.rst +++ b/Help/command/file.rst @@ -776,11 +776,14 @@ Transfer .. code-block:: cmake - file(DOWNLOAD <url> <file> [<options>...]) + file(DOWNLOAD <url> [<file>] [<options>...]) file(UPLOAD <file> <url> [<options>...]) -The ``DOWNLOAD`` mode downloads the given ``<url>`` to a local ``<file>``. -The ``UPLOAD`` mode uploads a local ``<file>`` to a given ``<url>``. +The ``DOWNLOAD`` mode downloads the given ``<url>`` to a local ``<file>``. If +``<file>`` is not specified for ``file(DOWNLOAD)``, the file is not saved. This +can be useful if you want to know if a file can be downloaded (for example, to +check that it exists) without actually saving it anywhere. The ``UPLOAD`` mode +uploads a local ``<file>`` to a given ``<url>``. Options to both ``DOWNLOAD`` and ``UPLOAD`` are: @@ -853,10 +856,12 @@ Additional options to ``DOWNLOAD`` are: Verify that the downloaded content hash matches the expected value, where ``ALGO`` is one of the algorithms supported by ``file(<HASH>)``. - If it does not match, the operation fails with an error. + If it does not match, the operation fails with an error. It is an error to + specify this if ``DOWNLOAD`` is not given a ``<file>``. ``EXPECTED_MD5 <value>`` - Historical short-hand for ``EXPECTED_HASH MD5=<value>``. + Historical short-hand for ``EXPECTED_HASH MD5=<value>``. It is an error to + specify this if ``DOWNLOAD`` is not given a ``<file>``. Locking ^^^^^^^ diff --git a/Help/command/include_guard.rst b/Help/command/include_guard.rst index 877aa86..dca3b6f 100644 --- a/Help/command/include_guard.rst +++ b/Help/command/include_guard.rst @@ -1,6 +1,8 @@ include_guard ------------- +.. versionadded:: 3.10 + Provides an include guard for the file currently being processed by CMake. .. code-block:: cmake diff --git a/Help/command/install.rst b/Help/command/install.rst index c8df7d9..c11eaf4 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -45,6 +45,9 @@ signatures that specify them. The common options are: As absolute paths are not supported by :manual:`cpack <cpack(1)>` installer generators, it is preferable to use relative paths throughout. + In particular, there is no need to make paths absolute by prepending + :variable:`CMAKE_INSTALL_PREFIX`; this prefix is used by default if + the DESTINATION is a relative path. ``PERMISSIONS`` Specify permissions for installed files. Valid permissions are diff --git a/Help/command/target_compile_features.rst b/Help/command/target_compile_features.rst index c5401e6..b50be34 100644 --- a/Help/command/target_compile_features.rst +++ b/Help/command/target_compile_features.rst @@ -1,6 +1,8 @@ target_compile_features ----------------------- +.. versionadded:: 3.1 + Add expected compiler features to a target. .. code-block:: cmake diff --git a/Help/command/target_link_directories.rst b/Help/command/target_link_directories.rst index 76da94d..bb75a3d 100644 --- a/Help/command/target_link_directories.rst +++ b/Help/command/target_link_directories.rst @@ -1,6 +1,8 @@ target_link_directories ----------------------- +.. versionadded:: 3.13 + Add link directories to a target. .. code-block:: cmake diff --git a/Help/command/target_link_options.rst b/Help/command/target_link_options.rst index 89038e3..e59e0e1 100644 --- a/Help/command/target_link_options.rst +++ b/Help/command/target_link_options.rst @@ -1,6 +1,8 @@ target_link_options ------------------- +.. versionadded:: 3.13 + Add options to the link step for an executable, shared library or module library target. diff --git a/Help/command/target_precompile_headers.rst b/Help/command/target_precompile_headers.rst index d4280b1..7005180 100644 --- a/Help/command/target_precompile_headers.rst +++ b/Help/command/target_precompile_headers.rst @@ -1,6 +1,8 @@ target_precompile_headers ------------------------- +.. versionadded:: 3.16 + Add a list of header files to precompile. Precompiling header files can speed up compilation by creating a partially diff --git a/Help/command/target_sources.rst b/Help/command/target_sources.rst index 27e737b..653b8d7 100644 --- a/Help/command/target_sources.rst +++ b/Help/command/target_sources.rst @@ -1,6 +1,8 @@ target_sources -------------- +.. versionadded:: 3.1 + Add sources to a target. .. code-block:: cmake @@ -9,19 +11,21 @@ Add sources to a target. <INTERFACE|PUBLIC|PRIVATE> [items1...] [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]) -Specifies sources to use when compiling a given target. Relative -source file paths are interpreted as being relative to the current +Specifies sources to use when building a target and/or its dependents. +Relative source file paths are interpreted as being relative to the current source directory (i.e. :variable:`CMAKE_CURRENT_SOURCE_DIR`). The named ``<target>`` must have been created by a command such as :command:`add_executable` or :command:`add_library` and must not be an :ref:`ALIAS target <Alias Targets>`. The ``INTERFACE``, ``PUBLIC`` and ``PRIVATE`` keywords are required to -specify the scope of the following arguments. ``PRIVATE`` and ``PUBLIC`` +specify the scope of the items following them. ``PRIVATE`` and ``PUBLIC`` items will populate the :prop_tgt:`SOURCES` property of -``<target>``. ``PUBLIC`` and ``INTERFACE`` items will populate the -:prop_tgt:`INTERFACE_SOURCES` property of ``<target>``. -(:ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items.) +``<target>``, which are used when building the target itself. +``PUBLIC`` and ``INTERFACE`` items will populate the +:prop_tgt:`INTERFACE_SOURCES` property of ``<target>``, which are used +when building dependents. (:ref:`IMPORTED targets <Imported Targets>` +only support ``INTERFACE`` items because they are not build targets.) The following arguments specify sources. Repeated calls for the same ``<target>`` append items in the order called. diff --git a/Help/command/variable_watch.rst b/Help/command/variable_watch.rst index ce69bcf..8293f5a 100644 --- a/Help/command/variable_watch.rst +++ b/Help/command/variable_watch.rst @@ -7,9 +7,42 @@ Watch the CMake variable for change. variable_watch(<variable> [<command>]) -If the specified ``<variable>`` changes, a message will be printed -to inform about the change. +If the specified ``<variable>`` changes and no ``<command>`` is given, +a message will be printed to inform about the change. -Additionally, if ``<command>`` is given, this command will be executed. +If ``<command>`` is given, this command will be executed instead. The command will receive the following arguments: ``COMMAND(<variable> <access> <value> <current_list_file> <stack>)`` + +``<variable>`` + Name of the variable being accessed. + +``<access>`` + One of ``READ_ACCESS``, ``UNKNOWN_READ_ACCESS``, ``MODIFIED_ACCESS``, + ``UNKNOWN_MODIFIED_ACCESS``, or ``REMOVED_ACCESS``. The ``UNKNOWN_`` + values are only used when the variable has never been set. Once set, + they are never used again during the same CMake run, even if the + variable is later unset. + +``<value>`` + The value of the variable. On a modification, this is the new + (modified) value of the variable. On removal, the value is empty. + +``<current_list_file>`` + Full path to the file doing the access. + +``<stack>`` + List of absolute paths of all files currently on the stack of file + inclusion, with the bottom-most file first and the currently + processed file (that is, ``current_list_file``) last. + +Note that for some accesses such as :command:`list(APPEND)`, the watcher +is executed twice, first with a read access and then with a write one. +Also note that an :command:`if(DEFINED)` query on the variable does not +register as an access and the watcher is not executed. + +Only non-cache variables can be watched using this command. Access to +cache variables is never watched. However, the existence of a cache +variable ``var`` causes accesses to the non-cache variable ``var`` to +not use the ``UNKNOWN_`` prefix, even if a non-cache variable ``var`` +has never existed. diff --git a/Help/cpack_gen/external.rst b/Help/cpack_gen/external.rst index 406f6be..7ef1071 100644 --- a/Help/cpack_gen/external.rst +++ b/Help/cpack_gen/external.rst @@ -281,3 +281,10 @@ Variables specific to CPack External generator It is invoked after (optional) staging took place and may run an external packaging tool. The script has access to the variables defined by the CPack config file. + +.. variable:: CPACK_EXTERNAL_BUILT_PACKAGES + + The ``CPACK_EXTERNAL_PACKAGE_SCRIPT`` script may set this list variable to the + full paths of generated package files. CPack copy these files from the stage + directory back to the top build directory and possibly produce checksum files + if the :variable:`CPACK_PACKAGE_CHECKSUM` is set. diff --git a/Help/cpack_gen/packagemaker.rst b/Help/cpack_gen/packagemaker.rst index c2a450e..357eb73 100644 --- a/Help/cpack_gen/packagemaker.rst +++ b/Help/cpack_gen/packagemaker.rst @@ -29,7 +29,7 @@ macOS using PackageMaker: .. variable:: CPACK_PACKAGEMAKER_BACKGROUND - Adds a background to Distribtion XML if specified. The value contains the + Adds a background to Distribution XML if specified. The value contains the path to image in ``Resources`` directory. .. variable:: CPACK_PACKAGEMAKER_BACKGROUND_ALIGNMENT diff --git a/Help/cpack_gen/productbuild.rst b/Help/cpack_gen/productbuild.rst index 82b79ae..fd99e5a 100644 --- a/Help/cpack_gen/productbuild.rst +++ b/Help/cpack_gen/productbuild.rst @@ -68,7 +68,7 @@ macOS using ProductBuild: .. variable:: CPACK_PRODUCTBUILD_BACKGROUND - Adds a background to Distribtion XML if specified. The value contains the + Adds a background to Distribution XML if specified. The value contains the path to image in ``Resources`` directory. .. variable:: CPACK_PRODUCTBUILD_BACKGROUND_ALIGNMENT diff --git a/Help/cpack_gen/wix.rst b/Help/cpack_gen/wix.rst index 7fb5a12..5b880ba 100644 --- a/Help/cpack_gen/wix.rst +++ b/Help/cpack_gen/wix.rst @@ -286,3 +286,11 @@ Windows using WiX. When unspecified CPack will try to locate a WiX Toolset installation via the ``WIX`` environment variable instead. + +.. variable:: CPACK_WIX_CUSTOM_XMLNS + + This variable provides a list of custom namespace declarations that are necessary + for using WiX extensions. Each declaration should be in the form name=url, where + name is the plain namespace without the usual xmlns: prefix and url is an unquoted + namespace url. A list of commonly known WiX schemata can be found here: + https://wixtoolset.org/documentation/manual/v3/xsd/ diff --git a/Help/dev/maint.rst b/Help/dev/maint.rst index a1c1a6f..4c2c89f 100644 --- a/Help/dev/maint.rst +++ b/Help/dev/maint.rst @@ -200,6 +200,23 @@ the notes, and revise wording. Then commit with a message such as:: Add section headers similar to the $prev release notes and move each individual bullet into an appropriate section. Revise a few bullets. +Update Sphinx ``versionadded`` directives in documents added since +the previous release by running the `update_versions.py`_ script: + +.. code-block:: shell + + Utilities/Sphinx/update_versions.py --since v$prev.0 --overwrite + +.. _`update_versions.py`: ../../Utilities/Sphinx/update_versions.py + +Commit the changes with a message such as:: + + Help: Update Sphinx versionadded directives for $ver release + + Run the script: + + Utilities/Sphinx/update_versions.py --since v$prev.0 --overwrite + Open a merge request with the ``doc-$ver-relnotes`` branch for review and integration. Further steps may proceed after this has been merged to ``master``. @@ -299,3 +316,28 @@ announcing that post-release development is open:: before staging or merging. .. _`CMake Discourse Forum Development Category`: https://discourse.cmake.org/c/development + +Initial Post-Release Development +-------------------------------- + +Deprecate policies more than 8 release series old by updating the +policy range check in ``cmMakefile::SetPolicy``. +Commit with a message such as:: + + Add deprecation warnings for policies CMP#### and below + + The OLD behaviors of all policies are deprecated, but only by + documentation. Add an explicit deprecation diagnostic for policies + introduced in CMake $OLDVER and below to encourage projects to port + away from setting policies to OLD. + +Update the ``cmake_policy`` version range generated by ``install(EXPORT)`` +in ``cmExportFileGenerator::GeneratePolicyHeaderCode`` to end at the +previous release. We use one release back since we now know all the +policies added for that version. Commit with a message such as:: + + export: Increase maximum policy version in exported files to $prev + + The files generatd by `install(EXPORT)` and `export()` commands + are known to work with policies as of CMake $prev, so enable them + in sufficiently new CMake versions. diff --git a/Help/dev/review.rst b/Help/dev/review.rst index 6c7e92c..f2a91c0 100644 --- a/Help/dev/review.rst +++ b/Help/dev/review.rst @@ -260,7 +260,7 @@ This may be generated with If the commit is a fix for the mentioned commit, consider using a ``Fixes:`` trailer in the commit message with the specified format. This trailer should not be word-wrapped. Note that if there is also an issue for what is being -fixed, it is preferrable to link to the issue instead. +fixed, it is preferable to link to the issue instead. If relevant, add the first release tag of CMake containing the commit after the ``<date>``, i.e., ``commit <shorthash> (<subject>, <date>, <tag>)``. diff --git a/Help/dev/source.rst b/Help/dev/source.rst index 0ccb8f4..d93e55c 100644 --- a/Help/dev/source.rst +++ b/Help/dev/source.rst @@ -35,6 +35,9 @@ Available features are: * From ``C++14``: + * ``<cm/iomanip>``: + ``cm::quoted`` + * ``<cm/iterator>``: ``cm::make_reverse_iterator``, ``cm::cbegin``, ``cm::cend``, ``cm::rbegin``, ``cm::rend``, ``cm::crbegin``, ``cm::crend`` @@ -53,6 +56,9 @@ Available features are: * ``<cm/algorithm>``: ``cm::clamp`` + * ``cm/filesystem>``: + ``cm::filesystem::path`` + * ``<cm/iterator>``: ``cm::size``, ``cm::empty``, ``cm::data`` diff --git a/Help/envvar/ASM_DIALECT.rst b/Help/envvar/ASM_DIALECT.rst index a06e3cb..a606280 100644 --- a/Help/envvar/ASM_DIALECT.rst +++ b/Help/envvar/ASM_DIALECT.rst @@ -1,6 +1,8 @@ ASM<DIALECT> ------------ +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Preferred executable for compiling a specific dialect of assembly language @@ -12,3 +14,11 @@ in the cache as :variable:`CMAKE_ASM<DIALECT>_COMPILER <CMAKE_<LANG>_COMPILER>`. For subsequent configuration runs, the environment variable will be ignored in favor of :variable:`CMAKE_ASM<DIALECT>_COMPILER <CMAKE_<LANG>_COMPILER>`. + +.. note:: + Options that are required to make the compiler work correctly can be included; + they can not be changed. + +.. code-block:: console + + $ export ASM="custom-compiler --arg1 --arg2" diff --git a/Help/envvar/ASM_DIALECTFLAGS.rst b/Help/envvar/ASM_DIALECTFLAGS.rst index 2e1c6d2..66a75e2 100644 --- a/Help/envvar/ASM_DIALECTFLAGS.rst +++ b/Help/envvar/ASM_DIALECTFLAGS.rst @@ -1,6 +1,8 @@ ASM<DIALECT>FLAGS ----------------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Default compilation flags to be used when compiling a specific dialect of an diff --git a/Help/envvar/CC.rst b/Help/envvar/CC.rst index ef12059..4c970b4 100644 --- a/Help/envvar/CC.rst +++ b/Help/envvar/CC.rst @@ -1,6 +1,8 @@ CC -- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Preferred executable for compiling ``C`` language files. Will only be used by @@ -9,3 +11,11 @@ value for ``CC`` is stored in the cache as :variable:`CMAKE_C_COMPILER <CMAKE_<LANG>_COMPILER>`. For any configuration run (including the first), the environment variable will be ignored if the :variable:`CMAKE_C_COMPILER <CMAKE_<LANG>_COMPILER>` variable is defined. + +.. note:: + Options that are required to make the compiler work correctly can be included; + they can not be changed. + +.. code-block:: console + + $ export CC="custom-compiler --arg1 --arg2" diff --git a/Help/envvar/CCMAKE_COLORS.rst b/Help/envvar/CCMAKE_COLORS.rst index d4750c3..4e76bf8 100644 --- a/Help/envvar/CCMAKE_COLORS.rst +++ b/Help/envvar/CCMAKE_COLORS.rst @@ -1,6 +1,8 @@ CCMAKE_COLORS ------------- +.. versionadded:: 3.18 + Determines what colors are used by the CMake curses interface, when run on a terminal that supports colors. The syntax follows the same conventions as ``LS_COLORS``; diff --git a/Help/envvar/CFLAGS.rst b/Help/envvar/CFLAGS.rst index 190b4f4..31db6a6 100644 --- a/Help/envvar/CFLAGS.rst +++ b/Help/envvar/CFLAGS.rst @@ -1,6 +1,8 @@ CFLAGS ------ +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Default compilation flags to be used when compiling ``C`` files. Will only be diff --git a/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst b/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst index 199ca3e..dbc589a 100644 --- a/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst +++ b/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst @@ -1,6 +1,8 @@ CMAKE_BUILD_PARALLEL_LEVEL -------------------------- +.. versionadded:: 3.12 + .. include:: ENV_VAR.txt Specifies the maximum number of concurrent processes to use when building diff --git a/Help/envvar/CMAKE_CONFIG_TYPE.rst b/Help/envvar/CMAKE_CONFIG_TYPE.rst index 168593d..c207a48 100644 --- a/Help/envvar/CMAKE_CONFIG_TYPE.rst +++ b/Help/envvar/CMAKE_CONFIG_TYPE.rst @@ -1,6 +1,8 @@ CMAKE_CONFIG_TYPE ----------------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt The default build configuration for :ref:`Build Tool Mode` and diff --git a/Help/envvar/CMAKE_EXPORT_COMPILE_COMMANDS.rst b/Help/envvar/CMAKE_EXPORT_COMPILE_COMMANDS.rst index e9e0810..9e678be 100644 --- a/Help/envvar/CMAKE_EXPORT_COMPILE_COMMANDS.rst +++ b/Help/envvar/CMAKE_EXPORT_COMPILE_COMMANDS.rst @@ -1,6 +1,8 @@ CMAKE_EXPORT_COMPILE_COMMANDS ----------------------------- +.. versionadded:: 3.17 + .. include:: ENV_VAR.txt The default value for :variable:`CMAKE_EXPORT_COMPILE_COMMANDS` when there diff --git a/Help/envvar/CMAKE_GENERATOR.rst b/Help/envvar/CMAKE_GENERATOR.rst index f2d055f..3488b04 100644 --- a/Help/envvar/CMAKE_GENERATOR.rst +++ b/Help/envvar/CMAKE_GENERATOR.rst @@ -1,6 +1,8 @@ CMAKE_GENERATOR --------------- +.. versionadded:: 3.15 + .. include:: ENV_VAR.txt Specifies the CMake default generator to use when no generator is supplied diff --git a/Help/envvar/CMAKE_GENERATOR_INSTANCE.rst b/Help/envvar/CMAKE_GENERATOR_INSTANCE.rst index 1654fa1..8ca7d80 100644 --- a/Help/envvar/CMAKE_GENERATOR_INSTANCE.rst +++ b/Help/envvar/CMAKE_GENERATOR_INSTANCE.rst @@ -1,6 +1,8 @@ CMAKE_GENERATOR_INSTANCE ------------------------ +.. versionadded:: 3.15 + .. include:: ENV_VAR.txt Default value for :variable:`CMAKE_GENERATOR_INSTANCE` if no Cache entry is diff --git a/Help/envvar/CMAKE_GENERATOR_PLATFORM.rst b/Help/envvar/CMAKE_GENERATOR_PLATFORM.rst index 917b30b..b039845 100644 --- a/Help/envvar/CMAKE_GENERATOR_PLATFORM.rst +++ b/Help/envvar/CMAKE_GENERATOR_PLATFORM.rst @@ -1,6 +1,8 @@ CMAKE_GENERATOR_PLATFORM ------------------------ +.. versionadded:: 3.15 + .. include:: ENV_VAR.txt Default value for :variable:`CMAKE_GENERATOR_PLATFORM` if no Cache entry diff --git a/Help/envvar/CMAKE_GENERATOR_TOOLSET.rst b/Help/envvar/CMAKE_GENERATOR_TOOLSET.rst index 7ac3856..394dd88 100644 --- a/Help/envvar/CMAKE_GENERATOR_TOOLSET.rst +++ b/Help/envvar/CMAKE_GENERATOR_TOOLSET.rst @@ -1,6 +1,8 @@ CMAKE_GENERATOR_TOOLSET ----------------------- +.. versionadded:: 3.15 + .. include:: ENV_VAR.txt Default value for :variable:`CMAKE_GENERATOR_TOOLSET` if no Cache entry diff --git a/Help/envvar/CMAKE_LANG_COMPILER_LAUNCHER.rst b/Help/envvar/CMAKE_LANG_COMPILER_LAUNCHER.rst index 4f91e9a..c384fa1 100644 --- a/Help/envvar/CMAKE_LANG_COMPILER_LAUNCHER.rst +++ b/Help/envvar/CMAKE_LANG_COMPILER_LAUNCHER.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_COMPILER_LAUNCHER ------------------------------ +.. versionadded:: 3.17 + .. include:: ENV_VAR.txt Default compiler launcher to use for the specified language. Will only be used diff --git a/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst b/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst index 77ead4d..5babbe5 100644 --- a/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst +++ b/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst @@ -1,6 +1,8 @@ CMAKE_MSVCIDE_RUN_PATH ---------------------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Extra PATH locations for custom commands when using diff --git a/Help/envvar/CMAKE_NO_VERBOSE.rst b/Help/envvar/CMAKE_NO_VERBOSE.rst index 149efbd..fe733f8 100644 --- a/Help/envvar/CMAKE_NO_VERBOSE.rst +++ b/Help/envvar/CMAKE_NO_VERBOSE.rst @@ -1,6 +1,8 @@ CMAKE_NO_VERBOSE ---------------- +.. versionadded:: 3.14 + Disables verbose output from CMake when :envvar:`VERBOSE` environment variable is set. diff --git a/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst b/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst index ef7d547..4bfa36a 100644 --- a/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst +++ b/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst @@ -1,6 +1,8 @@ CMAKE_OSX_ARCHITECTURES ----------------------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Target specific architectures for macOS. diff --git a/Help/envvar/CMAKE_PREFIX_PATH.rst b/Help/envvar/CMAKE_PREFIX_PATH.rst index 276fdd6..e5d6aa1 100644 --- a/Help/envvar/CMAKE_PREFIX_PATH.rst +++ b/Help/envvar/CMAKE_PREFIX_PATH.rst @@ -1,6 +1,8 @@ CMAKE_PREFIX_PATH ----------------- +.. versionadded:: 3.18 + .. include:: ENV_VAR.txt The ``CMAKE_PREFIX_PATH`` environment variable may be set to a list of diff --git a/Help/envvar/CSFLAGS.rst b/Help/envvar/CSFLAGS.rst index 8762982..d875209 100644 --- a/Help/envvar/CSFLAGS.rst +++ b/Help/envvar/CSFLAGS.rst @@ -1,9 +1,11 @@ CSFLAGS ------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt -Preferred executable for compiling ``CSharp`` language files. Will only be +Default compilation flags to be used when compiling ``CSharp`` files. Will only be used by CMake on the first configuration to determine ``CSharp`` default compilation flags, after which the value for ``CSFLAGS`` is stored in the cache as :variable:`CMAKE_CSharp_FLAGS <CMAKE_<LANG>_FLAGS>`. For any configuration diff --git a/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst b/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst index e1991b2..b27bc09 100644 --- a/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst +++ b/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst @@ -1,6 +1,8 @@ CTEST_INTERACTIVE_DEBUG_MODE ---------------------------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Environment variable that will exist and be set to ``1`` when a test executed diff --git a/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst b/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst index d8b4262..9c6bd03 100644 --- a/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst +++ b/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst @@ -1,6 +1,8 @@ CTEST_OUTPUT_ON_FAILURE ----------------------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Boolean environment variable that controls if the output should be logged for diff --git a/Help/envvar/CTEST_PARALLEL_LEVEL.rst b/Help/envvar/CTEST_PARALLEL_LEVEL.rst index fd4936e..a21c783 100644 --- a/Help/envvar/CTEST_PARALLEL_LEVEL.rst +++ b/Help/envvar/CTEST_PARALLEL_LEVEL.rst @@ -1,6 +1,8 @@ CTEST_PARALLEL_LEVEL -------------------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Specify the number of tests for CTest to run in parallel. See :manual:`ctest(1)` diff --git a/Help/envvar/CTEST_PROGRESS_OUTPUT.rst b/Help/envvar/CTEST_PROGRESS_OUTPUT.rst index b36a6b8..8c29d7d 100644 --- a/Help/envvar/CTEST_PROGRESS_OUTPUT.rst +++ b/Help/envvar/CTEST_PROGRESS_OUTPUT.rst @@ -1,6 +1,8 @@ CTEST_PROGRESS_OUTPUT --------------------- +.. versionadded:: 3.13 + .. include:: ENV_VAR.txt Boolean environment variable that affects how :manual:`ctest <ctest(1)>` diff --git a/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst b/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst index 79dbb79..dffd63d 100644 --- a/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst +++ b/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst @@ -1,6 +1,8 @@ CTEST_USE_LAUNCHERS_DEFAULT --------------------------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Initializes the :variable:`CTEST_USE_LAUNCHERS` variable if not already defined. diff --git a/Help/envvar/CUDACXX.rst b/Help/envvar/CUDACXX.rst index 10c0f9d..69471b0 100644 --- a/Help/envvar/CUDACXX.rst +++ b/Help/envvar/CUDACXX.rst @@ -1,6 +1,8 @@ CUDACXX ------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Preferred executable for compiling ``CUDA`` language files. Will only be used by @@ -9,3 +11,11 @@ value for ``CUDA`` is stored in the cache as :variable:`CMAKE_CUDA_COMPILER <CMAKE_<LANG>_COMPILER>`. For any configuration run (including the first), the environment variable will be ignored if the :variable:`CMAKE_CUDA_COMPILER <CMAKE_<LANG>_COMPILER>` variable is defined. + +.. note:: + Options that are required to make the compiler work correctly can be included; + they can not be changed. + +.. code-block:: console + + $ export CUDACXX="custom-compiler --arg1 --arg2" diff --git a/Help/envvar/CUDAFLAGS.rst b/Help/envvar/CUDAFLAGS.rst index 14c5d84..1f1bde5 100644 --- a/Help/envvar/CUDAFLAGS.rst +++ b/Help/envvar/CUDAFLAGS.rst @@ -1,6 +1,8 @@ CUDAFLAGS --------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Default compilation flags to be used when compiling ``CUDA`` files. Will only be diff --git a/Help/envvar/CUDAHOSTCXX.rst b/Help/envvar/CUDAHOSTCXX.rst index b9f65bd..81c1228 100644 --- a/Help/envvar/CUDAHOSTCXX.rst +++ b/Help/envvar/CUDAHOSTCXX.rst @@ -1,6 +1,8 @@ CUDAHOSTCXX ----------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Preferred executable for compiling host code when compiling ``CUDA`` diff --git a/Help/envvar/CXX.rst b/Help/envvar/CXX.rst index d655350..908a521 100644 --- a/Help/envvar/CXX.rst +++ b/Help/envvar/CXX.rst @@ -1,6 +1,8 @@ CXX --- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Preferred executable for compiling ``CXX`` language files. Will only be used by @@ -9,3 +11,11 @@ value for ``CXX`` is stored in the cache as :variable:`CMAKE_CXX_COMPILER <CMAKE_<LANG>_COMPILER>`. For any configuration run (including the first), the environment variable will be ignored if the :variable:`CMAKE_CXX_COMPILER <CMAKE_<LANG>_COMPILER>` variable is defined. + +.. note:: + Options that are required to make the compiler work correctly can be included; + they can not be changed. + +.. code-block:: console + + $ export CXX="custom-compiler --arg1 --arg2" diff --git a/Help/envvar/CXXFLAGS.rst b/Help/envvar/CXXFLAGS.rst index 460a347..a3cef77 100644 --- a/Help/envvar/CXXFLAGS.rst +++ b/Help/envvar/CXXFLAGS.rst @@ -1,6 +1,8 @@ CXXFLAGS -------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Default compilation flags to be used when compiling ``CXX`` (C++) files. Will diff --git a/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst b/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst index 6a52d64..7635342 100644 --- a/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst +++ b/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst @@ -1,6 +1,8 @@ DASHBOARD_TEST_FROM_CTEST ------------------------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Environment variable that will exist when a test executed by :manual:`ctest(1)` diff --git a/Help/envvar/DESTDIR.rst b/Help/envvar/DESTDIR.rst index d2144ae..ee290f2 100644 --- a/Help/envvar/DESTDIR.rst +++ b/Help/envvar/DESTDIR.rst @@ -1,6 +1,8 @@ DESTDIR ------- +.. versionadded:: 3.12 + .. include:: ENV_VAR.txt On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the diff --git a/Help/envvar/FC.rst b/Help/envvar/FC.rst index d6cabbc..dcee02d 100644 --- a/Help/envvar/FC.rst +++ b/Help/envvar/FC.rst @@ -1,6 +1,8 @@ FC -- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Preferred executable for compiling ``Fortran`` language files. Will only be used @@ -10,3 +12,11 @@ which the value for ``Fortran`` is stored in the cache as configuration run (including the first), the environment variable will be ignored if the :variable:`CMAKE_Fortran_COMPILER <CMAKE_<LANG>_COMPILER>` variable is defined. + +.. note:: + Options that are required to make the compiler work correctly can be included; + they can not be changed. + +.. code-block:: console + + $ export FC="custom-compiler --arg1 --arg2" diff --git a/Help/envvar/FFLAGS.rst b/Help/envvar/FFLAGS.rst index 53bffb6..4c1f3d2 100644 --- a/Help/envvar/FFLAGS.rst +++ b/Help/envvar/FFLAGS.rst @@ -1,6 +1,8 @@ FFLAGS ------ +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Default compilation flags to be used when compiling ``Fortran`` files. Will only diff --git a/Help/envvar/LDFLAGS.rst b/Help/envvar/LDFLAGS.rst index 816d6ef..78b34f4 100644 --- a/Help/envvar/LDFLAGS.rst +++ b/Help/envvar/LDFLAGS.rst @@ -1,6 +1,8 @@ LDFLAGS ------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Will only be used by CMake on the first configuration to determine the default diff --git a/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst b/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst index 662bd03..1558704 100644 --- a/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst +++ b/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst @@ -1,6 +1,8 @@ MACOSX_DEPLOYMENT_TARGET ------------------------ +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Specify the minimum version of macOS on which the target binaries are diff --git a/Help/envvar/OBJC.rst b/Help/envvar/OBJC.rst index 30c0d13..2d95806 100644 --- a/Help/envvar/OBJC.rst +++ b/Help/envvar/OBJC.rst @@ -1,6 +1,8 @@ OBJC ---- +.. versionadded:: 3.16.7 + .. include:: ENV_VAR.txt Preferred executable for compiling ``OBJC`` language files. Will only be used diff --git a/Help/envvar/OBJCXX.rst b/Help/envvar/OBJCXX.rst index a72f7e7..71286d9 100644 --- a/Help/envvar/OBJCXX.rst +++ b/Help/envvar/OBJCXX.rst @@ -1,6 +1,8 @@ OBJCXX ------ +.. versionadded:: 3.16.7 + .. include:: ENV_VAR.txt Preferred executable for compiling ``OBJCXX`` language files. Will only be used diff --git a/Help/envvar/PackageName_ROOT.rst b/Help/envvar/PackageName_ROOT.rst index 82b0a06..fc2a1d5 100644 --- a/Help/envvar/PackageName_ROOT.rst +++ b/Help/envvar/PackageName_ROOT.rst @@ -1,6 +1,8 @@ <PackageName>_ROOT ------------------ +.. versionadded:: 3.12.1 + .. include:: ENV_VAR.txt Calls to :command:`find_package(<PackageName>)` will search in prefixes diff --git a/Help/envvar/RC.rst b/Help/envvar/RC.rst index 557520e..adfaecc 100644 --- a/Help/envvar/RC.rst +++ b/Help/envvar/RC.rst @@ -1,6 +1,8 @@ RC -- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Preferred executable for compiling ``resource`` files. Will only be used by CMake @@ -9,3 +11,11 @@ value for ``RC`` is stored in the cache as :variable:`CMAKE_RC_COMPILER <CMAKE_<LANG>_COMPILER>`. For any configuration run (including the first), the environment variable will be ignored if the :variable:`CMAKE_RC_COMPILER <CMAKE_<LANG>_COMPILER>` variable is defined. + +.. note:: + Options that are required to make the compiler work correctly can be included; + they can not be changed. + +.. code-block:: console + + $ export RC="custom-compiler --arg1 --arg2" diff --git a/Help/envvar/RCFLAGS.rst b/Help/envvar/RCFLAGS.rst index bc43cb2..f33a9a8 100644 --- a/Help/envvar/RCFLAGS.rst +++ b/Help/envvar/RCFLAGS.rst @@ -1,6 +1,8 @@ RCFLAGS ------- +.. versionadded:: 3.10 + .. include:: ENV_VAR.txt Default compilation flags to be used when compiling ``resource`` files. Will diff --git a/Help/envvar/SWIFTC.rst b/Help/envvar/SWIFTC.rst index b12e51d..896e156 100644 --- a/Help/envvar/SWIFTC.rst +++ b/Help/envvar/SWIFTC.rst @@ -1,6 +1,8 @@ SWIFTC ------ +.. versionadded:: 3.15 + .. include:: ENV_VAR.txt Preferred executable for compiling ``Swift`` language files. Will only be used by @@ -9,3 +11,11 @@ value for ``SWIFTC`` is stored in the cache as :variable:`CMAKE_Swift_COMPILER <CMAKE_<LANG>_COMPILER>`. For any configuration run (including the first), the environment variable will be ignored if the :variable:`CMAKE_Swift_COMPILER <CMAKE_<LANG>_COMPILER>` variable is defined. + +.. note:: + Options that are required to make the compiler work correctly can be included; + they can not be changed. + +.. code-block:: console + + $ export SWIFTC="custom-compiler --arg1 --arg2" diff --git a/Help/envvar/VERBOSE.rst b/Help/envvar/VERBOSE.rst index 2d775a5..5911951 100644 --- a/Help/envvar/VERBOSE.rst +++ b/Help/envvar/VERBOSE.rst @@ -1,6 +1,8 @@ VERBOSE ------- +.. versionadded:: 3.14 + Activates verbose output from CMake and your build tools of choice when you start to actually build your project. diff --git a/Help/generator/Green Hills MULTI.rst b/Help/generator/Green Hills MULTI.rst index dffc679..2246699 100644 --- a/Help/generator/Green Hills MULTI.rst +++ b/Help/generator/Green Hills MULTI.rst @@ -1,6 +1,8 @@ Green Hills MULTI ----------------- +.. versionadded:: 3.3 + Generates Green Hills MULTI project files (experimental, work-in-progress). The buildsystem has predetermined build-configuration settings that can be controlled diff --git a/Help/generator/Ninja Multi-Config.rst b/Help/generator/Ninja Multi-Config.rst index f480eb8..e6c7a1c 100644 --- a/Help/generator/Ninja Multi-Config.rst +++ b/Help/generator/Ninja Multi-Config.rst @@ -1,6 +1,8 @@ Ninja Multi-Config ------------------ +.. versionadded:: 3.17 + Generates multiple ``build-<Config>.ninja`` files. This generator is very much like the :generator:`Ninja` generator, but with diff --git a/Help/generator/Visual Studio 14 2015.rst b/Help/generator/Visual Studio 14 2015.rst index 7383f7a..401845d 100644 --- a/Help/generator/Visual Studio 14 2015.rst +++ b/Help/generator/Visual Studio 14 2015.rst @@ -1,6 +1,8 @@ Visual Studio 14 2015 --------------------- +.. versionadded:: 3.1 + Generates Visual Studio 14 (VS 2015) project files. Project Types diff --git a/Help/generator/Visual Studio 15 2017.rst b/Help/generator/Visual Studio 15 2017.rst index 7e6f0fb..e7baaad 100644 --- a/Help/generator/Visual Studio 15 2017.rst +++ b/Help/generator/Visual Studio 15 2017.rst @@ -1,6 +1,8 @@ Visual Studio 15 2017 --------------------- +.. versionadded:: 3.7.1 + Generates Visual Studio 15 (VS 2017) project files. Project Types diff --git a/Help/generator/Visual Studio 16 2019.rst b/Help/generator/Visual Studio 16 2019.rst index 4aec7f7..3da8091 100644 --- a/Help/generator/Visual Studio 16 2019.rst +++ b/Help/generator/Visual Studio 16 2019.rst @@ -1,6 +1,8 @@ Visual Studio 16 2019 --------------------- +.. versionadded:: 3.14 + Generates Visual Studio 16 (VS 2019) project files. Project Types diff --git a/Help/guide/tutorial/Complete/MathFunctions/CMakeLists.txt b/Help/guide/tutorial/Complete/MathFunctions/CMakeLists.txt index c911625..a47d5e0 100644 --- a/Help/guide/tutorial/Complete/MathFunctions/CMakeLists.txt +++ b/Help/guide/tutorial/Complete/MathFunctions/CMakeLists.txt @@ -57,7 +57,11 @@ set_property(TARGET MathFunctions PROPERTY VERSION "1.0.0") set_property(TARGET MathFunctions PROPERTY SOVERSION "1") # install rules -install(TARGETS MathFunctions tutorial_compiler_flags +set(installable_libs MathFunctions tutorial_compiler_flags) +if(TARGET SqrtLibrary) + list(APPEND installable_libs SqrtLibrary) +endif() +install(TARGETS ${installable_libs} DESTINATION lib EXPORT MathFunctionsTargets) install(FILES MathFunctions.h DESTINATION include) diff --git a/Help/guide/tutorial/Step10/MathFunctions/CMakeLists.txt b/Help/guide/tutorial/Step10/MathFunctions/CMakeLists.txt index e0c0621..0bfe20c 100644 --- a/Help/guide/tutorial/Step10/MathFunctions/CMakeLists.txt +++ b/Help/guide/tutorial/Step10/MathFunctions/CMakeLists.txt @@ -47,5 +47,9 @@ endif() target_compile_definitions(MathFunctions PRIVATE "EXPORTING_MYMATH") # install rules -install(TARGETS MathFunctions DESTINATION lib) +set(installable_libs MathFunctions) +if(TARGET SqrtLibrary) + list(APPEND installable_libs SqrtLibrary) +endif() +install(TARGETS ${installable_libs} DESTINATION lib) install(FILES MathFunctions.h DESTINATION include) diff --git a/Help/guide/tutorial/Step11/MathFunctions/CMakeLists.txt b/Help/guide/tutorial/Step11/MathFunctions/CMakeLists.txt index 32f5e08..0d287ca 100644 --- a/Help/guide/tutorial/Step11/MathFunctions/CMakeLists.txt +++ b/Help/guide/tutorial/Step11/MathFunctions/CMakeLists.txt @@ -51,5 +51,9 @@ target_link_libraries(MathFunctions PUBLIC tutorial_compiler_flags) target_compile_definitions(MathFunctions PRIVATE "EXPORTING_MYMATH") # install rules -install(TARGETS MathFunctions DESTINATION lib) +set(installable_libs MathFunctions tutorial_compiler_flags) +if(TARGET SqrtLibrary) + list(APPEND installable_libs SqrtLibrary) +endif() +install(TARGETS ${installable_libs} DESTINATION lib) install(FILES MathFunctions.h DESTINATION include) diff --git a/Help/guide/tutorial/Step12/MathFunctions/CMakeLists.txt b/Help/guide/tutorial/Step12/MathFunctions/CMakeLists.txt index 720ee64..ea3861c 100644 --- a/Help/guide/tutorial/Step12/MathFunctions/CMakeLists.txt +++ b/Help/guide/tutorial/Step12/MathFunctions/CMakeLists.txt @@ -53,7 +53,11 @@ target_link_libraries(MathFunctions PUBLIC tutorial_compiler_flags) target_compile_definitions(MathFunctions PRIVATE "EXPORTING_MYMATH") # install rules -install(TARGETS MathFunctions tutorial_compiler_flags +set(installable_libs MathFunctions tutorial_compiler_flags) +if(TARGET SqrtLibrary) + list(APPEND installable_libs SqrtLibrary) +endif() +install(TARGETS ${installable_libs} DESTINATION lib EXPORT MathFunctionsTargets) install(FILES MathFunctions.h DESTINATION include) diff --git a/Help/guide/tutorial/index.rst b/Help/guide/tutorial/index.rst index 6e26de9..665d123 100644 --- a/Help/guide/tutorial/index.rst +++ b/Help/guide/tutorial/index.rst @@ -81,8 +81,8 @@ replaced. Next modify ``tutorial.cxx`` to include the configured header file, ``TutorialConfig.h``. -Finally, let's print out the version number by updating ``tutorial.cxx`` as -follows: +Finally, let's print out the executable name and version number by updating +``tutorial.cxx`` as follows: .. literalinclude:: Step2/tutorial.cxx :language: c++ @@ -106,7 +106,8 @@ correct flags. The easiest way to enable support for a specific C++ standard in CMake is by using the :variable:`CMAKE_CXX_STANDARD` variable. For this tutorial, set the :variable:`CMAKE_CXX_STANDARD` variable in the ``CMakeLists.txt`` file to 11 and :variable:`CMAKE_CXX_STANDARD_REQUIRED` to -True: +True. Make sure to add the ``CMAKE_CXX_STANDARD`` declarations above the call +to ``add_executable``. .. literalinclude:: Step2/CMakeLists.txt :language: cmake @@ -120,18 +121,28 @@ Run the :manual:`cmake <cmake(1)>` executable or the with your chosen build tool. For example, from the command line we could navigate to the -``Help/guide/tutorial`` directory of the CMake source code tree and run the -following commands: +``Help/guide/tutorial`` directory of the CMake source code tree and create a +build directory: .. code-block:: console mkdir Step1_build + +Next, navigate to the build directory and run CMake to configure the project +and generate a native build system: + +.. code-block:: console + cd Step1_build cmake ../Step1 + +Then call that build system to actually compile/link the project: + +.. code-block:: console + cmake --build . -Navigate to the directory where Tutorial was built (likely the make directory -or a Debug or Release build configuration subdirectory) and run these commands: +Finally, try to use the newly built ``Tutorial`` with these commands: .. code-block:: console @@ -212,8 +223,9 @@ libraries to later be linked into the executable. The variable classic approach when dealing with many optional components, we will cover the modern approach in the next step. -The corresponding changes to the source code are fairly straightforward. First, -in ``tutorial.cxx``, include the ``MathFunctions.h`` header if we need it: +The corresponding changes to the source code are fairly straightforward. +First, in ``tutorial.cxx``, include the ``MathFunctions.h`` header if we +need it: .. literalinclude:: Step3/tutorial.cxx :language: c++ @@ -242,8 +254,17 @@ Run the :manual:`cmake <cmake(1)>` executable or the :manual:`cmake-gui <cmake-gui(1)>` to configure the project and then build it with your chosen build tool. Then run the built Tutorial executable. -Use the :manual:`ccmake <ccmake(1)>` executable or the :manual:`cmake-gui <cmake-gui(1)>` -to update the value of ``USE_MYMATH``. Rebuild and run the tutorial again. +Now let's update the value of ``USE_MYMATH``. The easiest way is to use the +:manual:`cmake-gui <cmake-gui(1)>` or :manual:`ccmake <ccmake(1)>` if you're +in the terminal. Or, alternatively, if you want to change the option from the +command-line, try: + +.. code-block:: console + + cmake ../Step2 -DUSE_MYMATH=OFF + +Rebuild and run the tutorial again. + Which function gives better results, sqrt or mysqrt? Adding Usage Requirements for Library (Step 3) @@ -320,21 +341,32 @@ And to the end of the top-level ``CMakeLists.txt`` we add: That is all that is needed to create a basic local install of the tutorial. -Run the :manual:`cmake <cmake(1)>` executable or the +Now run the :manual:`cmake <cmake(1)>` executable or the :manual:`cmake-gui <cmake-gui(1)>` to configure the project and then build it -with your chosen build tool. Run the install step by using the ``install`` -option of the :manual:`cmake <cmake(1)>` command (introduced in 3.15, older -versions of CMake must use ``make install``) from the command line, or build -the ``INSTALL`` target from an IDE. This will install the appropriate header -files, libraries, and executables. +with your chosen build tool. + +Then run the install step by using the ``install`` option of the +:manual:`cmake <cmake(1)>` command (introduced in 3.15, older versions of +CMake must use ``make install``) from the command line. For +multi-configuration tools, don't forget to use the ``--config`` argument to +specify the configuration. If using an IDE, simply build the ``INSTALL`` +target. This step will install the appropriate header files, libraries, and +executables. For example: + +.. code-block:: console + + cmake --install . The CMake variable :variable:`CMAKE_INSTALL_PREFIX` is used to determine the -root of where the files will be installed. If using ``cmake --install`` a -custom installation directory can be given via the ``--prefix`` argument. For -multi-configuration tools, use the ``--config`` argument to specify the -configuration. +root of where the files will be installed. If using the ``cmake --install`` +command, the installation prefix can be overridden via the ``--prefix`` +argument. For example: + +.. code-block:: console + + cmake --install . --prefix "/home/myuser/installdir" -Verify that the installed Tutorial runs. +Navigate to the install directory and verify that the installed Tutorial runs. Testing Support --------------- @@ -520,6 +552,7 @@ We also have to add the current binary directory to the list of include directories so that ``Table.h`` can be found and included by ``mysqrt.cxx``. .. literalinclude:: Step7/MathFunctions/CMakeLists.txt + :language: cmake :start-after: # state that we depend on our bin :end-before: # install rules @@ -675,9 +708,9 @@ The first step is to update the starting section of the top-level Now that we have made MathFunctions always be used, we will need to update the logic of that library. So, in ``MathFunctions/CMakeLists.txt`` we need to -create a SqrtLibrary that will conditionally be built when ``USE_MYMATH`` is -enabled. Now, since this is a tutorial, we are going to explicitly require -that SqrtLibrary is built statically. +create a SqrtLibrary that will conditionally be built and installed when +``USE_MYMATH`` is enabled. Now, since this is a tutorial, we are going to +explicitly require that SqrtLibrary is built statically. The end result is that ``MathFunctions/CMakeLists.txt`` should look like: @@ -703,7 +736,7 @@ Finally, update ``MathFunctions/MathFunctions.h`` to use dll export defines: .. literalinclude:: Step10/MathFunctions/MathFunctions.h :language: c++ -At this point, if you build everything, you will notice that linking fails +At this point, if you build everything, you may notice that linking fails as we are combining a static library without position independent code with a library that has position independent code. The solution to this is to explicitly set the :prop_tgt:`POSITION_INDEPENDENT_CODE` target property of @@ -750,7 +783,7 @@ A common usage of :manual:`generator expressions <cmake-generator-expressions(7)>` is to conditionally add compiler flags, such as those for language levels or warnings. A nice pattern is to associate this information to an ``INTERFACE`` -target allowing this information to propagate. Lets start by constructing an +target allowing this information to propagate. Let's start by constructing an ``INTERFACE`` target and specifying the required C++ standard level of ``11`` instead of using :variable:`CMAKE_CXX_STANDARD`. diff --git a/Help/manual/cmake-buildsystem.7.rst b/Help/manual/cmake-buildsystem.7.rst index d8142a2..7008383 100644 --- a/Help/manual/cmake-buildsystem.7.rst +++ b/Help/manual/cmake-buildsystem.7.rst @@ -96,6 +96,9 @@ Apple Frameworks A ``SHARED`` library may be marked with the :prop_tgt:`FRAMEWORK` target property to create an macOS or iOS Framework Bundle. +A library with the ``FRAMEWORK`` target property should also set the +:prop_tgt:`FRAMEWORK_VERSION` target property. This property is typically +set to the value of "A" by macOS conventions. The ``MACOSX_FRAMEWORK_IDENTIFIER`` sets ``CFBundleIdentifier`` key and it uniquely identifies the bundle. @@ -104,7 +107,7 @@ and it uniquely identifies the bundle. add_library(MyFramework SHARED MyFramework.cpp) set_target_properties(MyFramework PROPERTIES FRAMEWORK TRUE - FRAMEWORK_VERSION A + FRAMEWORK_VERSION A # Version "A" is macOS convention MACOSX_FRAMEWORK_IDENTIFIER org.cmake.MyFramework ) @@ -115,7 +118,10 @@ Object Libraries The ``OBJECT`` library type defines a non-archival collection of object files resulting from compiling the given source files. The object files collection -may be used as source inputs to other targets: +may be used as source inputs to other targets by using the syntax +``$<TARGET_OBJECTS:name>``. This is a +:manual:`generator expression <cmake-generator-expressions(7)>` that can be +used to supply the ``OBJECT`` library content to other targets: .. code-block:: cmake @@ -373,8 +379,12 @@ position-independent-code, so a diagnostic is issued. The ``lib1`` and ``lib2`` requirements are not "compatible". One of them requires that consumers are built as position-independent-code, while the other requires that consumers are not built as position-independent-code. -Because ``exe2`` links to both and they are in conflict, a diagnostic is -issued. +Because ``exe2`` links to both and they are in conflict, a CMake error message +is issued:: + + CMake Error: The INTERFACE_POSITION_INDEPENDENT_CODE property of "lib2" does + not agree with the value of POSITION_INDEPENDENT_CODE already determined + for "exe2". To be "compatible", the :prop_tgt:`POSITION_INDEPENDENT_CODE` property, if set must be either the same, in a boolean sense, as the @@ -732,7 +742,7 @@ As the value of the :prop_tgt:`POSITION_INDEPENDENT_CODE` property of the ``exe1`` target is dependent on the linked libraries (``lib3``), and the edge of linking ``exe1`` is determined by the same :prop_tgt:`POSITION_INDEPENDENT_CODE` property, the dependency graph above -contains a cycle. :manual:`cmake(1)` issues a diagnostic in this case. +contains a cycle. :manual:`cmake(1)` issues an error message. .. _`Output Artifacts`: @@ -922,8 +932,8 @@ property from it: Interface Libraries ------------------- -An ``INTERFACE`` target has no :prop_tgt:`LOCATION` and is mutable, but is -otherwise similar to an :prop_tgt:`IMPORTED` target. +An ``INTERFACE`` library target does not compile sources and does not +produce a library artifact on disk, so it has no :prop_tgt:`LOCATION`. It may specify usage requirements such as :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES`, @@ -937,11 +947,22 @@ Only the ``INTERFACE`` modes of the :command:`target_include_directories`, :command:`target_sources`, and :command:`target_link_libraries` commands may be used with ``INTERFACE`` libraries. +Since CMake 3.19, an ``INTERFACE`` library target may optionally contain +source files. An interface library that contains source files will be +included as a build target in the generated buildsystem. It does not +compile sources, but may contain custom commands to generate other sources. +Additionally, IDEs will show the source files as part of the target for +interactive reading and editing. + A primary use-case for ``INTERFACE`` libraries is header-only libraries. .. code-block:: cmake - add_library(Eigen INTERFACE) + add_library(Eigen INTERFACE + src/eigen.h + src/vector.h + src/matrix.h + ) target_include_directories(Eigen INTERFACE $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src> $<INSTALL_INTERFACE:include/Eigen> @@ -975,25 +996,17 @@ This way, the build specification of ``exe1`` is expressed entirely as linked targets, and the complexity of compiler-specific flags is encapsulated in an ``INTERFACE`` library target. -The properties permitted to be set on or read from an ``INTERFACE`` library -are: - -* Properties matching ``INTERFACE_*`` -* Built-in properties matching ``COMPATIBLE_INTERFACE_*`` -* ``EXPORT_NAME`` -* ``EXPORT_PROPERTIES`` -* ``IMPORTED`` -* ``MANUALLY_ADDED_DEPENDENCIES`` -* ``NAME`` -* Properties matching ``IMPORTED_LIBNAME_*`` -* Properties matching ``MAP_IMPORTED_CONFIG_*`` - ``INTERFACE`` libraries may be installed and exported. Any content they refer to must be installed separately: .. code-block:: cmake - add_library(Eigen INTERFACE) + set(Eigen_headers + src/eigen.h + src/vector.h + src/matrix.h + ) + add_library(Eigen INTERFACE ${Eigen_headers}) target_include_directories(Eigen INTERFACE $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src> $<INSTALL_INTERFACE:include/Eigen> @@ -1003,9 +1016,6 @@ to must be installed separately: install(EXPORT eigenExport NAMESPACE Upstream:: DESTINATION lib/cmake/Eigen ) - install(FILES - ${CMAKE_CURRENT_SOURCE_DIR}/src/eigen.h - ${CMAKE_CURRENT_SOURCE_DIR}/src/vector.h - ${CMAKE_CURRENT_SOURCE_DIR}/src/matrix.h + install(FILES ${Eigen_headers} DESTINATION include/Eigen ) diff --git a/Help/manual/cmake-file-api.7.rst b/Help/manual/cmake-file-api.7.rst index cc50952..6876e1c 100644 --- a/Help/manual/cmake-file-api.7.rst +++ b/Help/manual/cmake-file-api.7.rst @@ -425,7 +425,7 @@ Version 1 does not exist to avoid confusion with that from { "kind": "codemodel", - "version": { "major": 2, "minor": 1 }, + "version": { "major": 2, "minor": 2 }, "paths": { "source": "/path/to/top-level-source-dir", "build": "/path/to/top-level-build-dir" @@ -650,7 +650,8 @@ with members: ``type`` A string specifying the type of the target. The value is one of ``EXECUTABLE``, ``STATIC_LIBRARY``, ``SHARED_LIBRARY``, - ``MODULE_LIBRARY``, ``OBJECT_LIBRARY``, or ``UTILITY``. + ``MODULE_LIBRARY``, ``OBJECT_LIBRARY``, ``INTERFACE_LIBRARY``, + or ``UTILITY``. ``backtrace`` Optional member that is present when a CMake language backtrace to @@ -869,6 +870,26 @@ with members: A string specifying the language (e.g. ``C``, ``CXX``, ``Fortran``) of the toolchain is used to compile the source file. + ``languageStandard`` + Optional member that is present when the language standard is set + explicitly (e.g. via :prop_tgt:`CXX_STANDARD`) or implicitly by + compile features. Each entry is a JSON object with two members: + + ``backtraces`` + Optional member that is present when a CMake language backtrace to + the ``<LANG>_STANDARD`` setting is available. If the language + standard was set implicitly by compile features those are used as + the backtrace(s). It's possible for multiple compile features to + require the same language standard so there could be multiple + backtraces. The value is a JSON array with each entry being an + unsigned integer 0-based index into the ``backtraceGraph`` + member's ``nodes`` array. + + ``standard`` + String representing the language standard. + + This field was added in codemodel version 2.2. + ``compileCommandFragments`` Optional member that is present when fragments of the compiler command line invocation are available. The value is a JSON array of entries diff --git a/Help/manual/cmake-generator-expressions.7.rst b/Help/manual/cmake-generator-expressions.7.rst index 124da44..c7f6b27 100644 --- a/Help/manual/cmake-generator-expressions.7.rst +++ b/Help/manual/cmake-generator-expressions.7.rst @@ -105,10 +105,11 @@ Variable Queries ``$<TARGET_EXISTS:target>`` ``1`` if ``target`` exists, else ``0``. -``$<CONFIG:cfg>`` - ``1`` if config is ``cfg``, else ``0``. This is a case-insensitive comparison. - The mapping in :prop_tgt:`MAP_IMPORTED_CONFIG_<CONFIG>` is also considered by - this expression when it is evaluated on a property on an :prop_tgt:`IMPORTED` +``$<CONFIG:cfgs>`` + ``1`` if config is any one of the entries in ``cfgs``, else ``0``. This is a + case-insensitive comparison. The mapping in + :prop_tgt:`MAP_IMPORTED_CONFIG_<CONFIG>` is also considered by this + expression when it is evaluated on a property on an :prop_tgt:`IMPORTED` target. ``$<PLATFORM_ID:platform_ids>`` where ``platform_ids`` is a comma-separated list. diff --git a/Help/manual/cmake-policies.7.rst b/Help/manual/cmake-policies.7.rst index e98038a..2627e0c 100644 --- a/Help/manual/cmake-policies.7.rst +++ b/Help/manual/cmake-policies.7.rst @@ -51,6 +51,15 @@ The :variable:`CMAKE_MINIMUM_REQUIRED_VERSION` variable may also be used to determine whether to report an error on use of deprecated macros or functions. +Policies Introduced by CMake 3.19 +================================= + +.. toctree:: + :maxdepth: 1 + + CMP0110: add_test() supports arbitrary characters in test names. </policy/CMP0110> + CMP0109: find_program() requires permission to execute but not to read. </policy/CMP0109> + Policies Introduced by CMake 3.18 ================================= diff --git a/Help/manual/cmake-properties.7.rst b/Help/manual/cmake-properties.7.rst index 30b2a05..afdf78c 100644 --- a/Help/manual/cmake-properties.7.rst +++ b/Help/manual/cmake-properties.7.rst @@ -307,6 +307,7 @@ Properties on Targets /prop_tgt/OBJCXX_EXTENSIONS /prop_tgt/OBJCXX_STANDARD /prop_tgt/OBJCXX_STANDARD_REQUIRED + /prop_tgt/OPTIMIZE_DEPENDENCIES /prop_tgt/OSX_ARCHITECTURES_CONFIG /prop_tgt/OSX_ARCHITECTURES /prop_tgt/OUTPUT_NAME_CONFIG diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index 4ce8365..4b40917 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -158,6 +158,7 @@ Variables that Change Behavior /variable/CMAKE_AUTOMOC_RELAXED_MODE /variable/CMAKE_BACKWARDS_COMPATIBILITY /variable/CMAKE_BUILD_TYPE + /variable/CMAKE_CLANG_VFS_OVERLAY /variable/CMAKE_CODEBLOCKS_COMPILER_ID /variable/CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES /variable/CMAKE_CODELITE_USE_TARGETS @@ -436,6 +437,7 @@ Variables that Control the Build /variable/CMAKE_NINJA_OUTPUT_PATH_PREFIX /variable/CMAKE_NO_BUILTIN_CHRPATH /variable/CMAKE_NO_SYSTEM_FROM_IMPORTED + /variable/CMAKE_OPTIMIZE_DEPENDENCIES /variable/CMAKE_OSX_ARCHITECTURES /variable/CMAKE_OSX_DEPLOYMENT_TARGET /variable/CMAKE_OSX_SYSROOT diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 9becfc6..c5e0aae 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -341,9 +341,9 @@ Options Print a warning when an uninitialized variable is used. ``--warn-unused-vars`` - Warn about unused variables. - - Find variables that are declared or set, but not used. + Does nothing. In CMake versions 3.2 and below this enabled warnings about + unused variables. In CMake versions 3.3 through 3.18 the option was broken. + In CMake 3.19 and above the option has been removed. ``--no-warn-unused-cli`` Don't warn about command line options. @@ -359,7 +359,7 @@ Options This flag tells CMake to warn about other files as well. ``--profiling-output=<path>`` - Used in conjuction with ``--profiling-format`` to output to a given path. + Used in conjunction with ``--profiling-format`` to output to a given path. ``--profiling-format=<file>`` Enable the output of profiling data of CMake script in the given format. @@ -450,6 +450,9 @@ The options are: ``--component <comp>`` Component-based install. Only install component ``<comp>``. +``--default-directory-permissions <permissions>`` + Default directory install permissions. Permissions in format ``<u=rwx,g=rx,o=rx>``. + ``--prefix <prefix>`` Override the installation prefix, :variable:`CMAKE_INSTALL_PREFIX`. @@ -566,7 +569,8 @@ Available commands are: ``compare_files [--ignore-eol] <file1> <file2>`` Check if ``<file1>`` is same as ``<file2>``. If files are the same, - then returns ``0``, if not it returns ``1``. The ``--ignore-eol`` option + then returns ``0``, if not it returns ``1``. In case of invalid + arguments, it returns 2. The ``--ignore-eol`` option implies line-wise comparison and ignores LF/CRLF differences. ``copy <file>... <destination>`` @@ -594,6 +598,13 @@ Available commands are: .. note:: Path to where ``<new>`` symbolic link will be created has to exist beforehand. +``create_hardlink <old> <new>`` + Create a hard link ``<new>`` naming ``<old>``. + + .. note:: + Path to where ``<new>`` hard link will be created has to exist beforehand. + ``<old>`` has to exist beforehand. + ``echo [<string>...]`` Displays arguments as text. diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index d3ab75a..b5bb1c1 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -1333,7 +1333,7 @@ Resource Allocation =================== CTest provides a mechanism for tests to specify the resources that they need -in a fine-grained way, and for users to specify the resources availiable on +in a fine-grained way, and for users to specify the resources available on the running machine. This allows CTest to internally keep track of which resources are in use and which are free, scheduling tests in a way that prevents them from trying to claim resources that are not available. diff --git a/Help/module/CPackArchive.rst b/Help/module/CPackArchive.rst index 8616098..f5d6da4 100644 --- a/Help/module/CPackArchive.rst +++ b/Help/module/CPackArchive.rst @@ -1,4 +1,6 @@ CPackArchive ------------ +.. versionadded:: 3.9 + The documentation for the CPack Archive generator has moved here: :cpack_gen:`CPack Archive Generator` diff --git a/Help/module/CPackFreeBSD.rst b/Help/module/CPackFreeBSD.rst index 69701b8..7ae6164 100644 --- a/Help/module/CPackFreeBSD.rst +++ b/Help/module/CPackFreeBSD.rst @@ -1,4 +1,6 @@ CPackFreeBSD ------------ +.. versionadded:: 3.10 + The documentation for the CPack FreeBSD generator has moved here: :cpack_gen:`CPack FreeBSD Generator` diff --git a/Help/module/CPackNuGet.rst b/Help/module/CPackNuGet.rst index 4f39b3a..bbed7f9 100644 --- a/Help/module/CPackNuGet.rst +++ b/Help/module/CPackNuGet.rst @@ -1,4 +1,6 @@ CPackNuGet ---------- +.. versionadded:: 3.12 + The documentation for the CPack NuGet generator has moved here: :cpack_gen:`CPack NuGet Generator` diff --git a/Help/module/CPackProductBuild.rst b/Help/module/CPackProductBuild.rst index 8cd9198..e12cd32 100644 --- a/Help/module/CPackProductBuild.rst +++ b/Help/module/CPackProductBuild.rst @@ -1,4 +1,6 @@ CPackProductBuild ----------------- +.. versionadded:: 3.7 + The documentation for the CPack productbuild generator has moved here: :cpack_gen:`CPack productbuild Generator` diff --git a/Help/policy/CMP0051.rst b/Help/policy/CMP0051.rst index 6b679e5..053bc97 100644 --- a/Help/policy/CMP0051.rst +++ b/Help/policy/CMP0051.rst @@ -1,6 +1,8 @@ CMP0051 ------- +.. versionadded:: 3.1 + List TARGET_OBJECTS in SOURCES target property. CMake 3.0 and lower did not include the ``TARGET_OBJECTS`` diff --git a/Help/policy/CMP0052.rst b/Help/policy/CMP0052.rst index ee2e6e8..c75f9ab 100644 --- a/Help/policy/CMP0052.rst +++ b/Help/policy/CMP0052.rst @@ -1,6 +1,8 @@ CMP0052 ------- +.. versionadded:: 3.1 + Reject source and build dirs in installed :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES`. diff --git a/Help/policy/CMP0053.rst b/Help/policy/CMP0053.rst index 032b3e5..9b18b2d 100644 --- a/Help/policy/CMP0053.rst +++ b/Help/policy/CMP0053.rst @@ -1,6 +1,8 @@ CMP0053 ------- +.. versionadded:: 3.1 + Simplify variable reference and escape sequence evaluation. CMake 3.1 introduced a much faster implementation of evaluation of the diff --git a/Help/policy/CMP0054.rst b/Help/policy/CMP0054.rst index 1e000a6..c7ae019 100644 --- a/Help/policy/CMP0054.rst +++ b/Help/policy/CMP0054.rst @@ -1,6 +1,8 @@ CMP0054 ------- +.. versionadded:: 3.1 + Only interpret :command:`if` arguments as variables or keywords when unquoted. CMake 3.1 and above no longer implicitly dereference variables or diff --git a/Help/policy/CMP0055.rst b/Help/policy/CMP0055.rst index bc5ad08..47cac8e 100644 --- a/Help/policy/CMP0055.rst +++ b/Help/policy/CMP0055.rst @@ -1,6 +1,8 @@ CMP0055 ------- +.. versionadded:: 3.2 + Strict checking for the :command:`break` command. CMake 3.1 and lower allowed calls to the :command:`break` command diff --git a/Help/policy/CMP0056.rst b/Help/policy/CMP0056.rst index 834da84..628a6a1 100644 --- a/Help/policy/CMP0056.rst +++ b/Help/policy/CMP0056.rst @@ -1,6 +1,8 @@ CMP0056 ------- +.. versionadded:: 3.2 + Honor link flags in :command:`try_compile` source-file signature. The :command:`try_compile` command source-file signature generates a diff --git a/Help/policy/CMP0057.rst b/Help/policy/CMP0057.rst index 83db186..76aebfb 100644 --- a/Help/policy/CMP0057.rst +++ b/Help/policy/CMP0057.rst @@ -1,6 +1,8 @@ CMP0057 ------- +.. versionadded:: 3.3 + Support new :command:`if` IN_LIST operator. CMake 3.3 adds support for the new IN_LIST operator. diff --git a/Help/policy/CMP0058.rst b/Help/policy/CMP0058.rst index 05efd48..06cc74b 100644 --- a/Help/policy/CMP0058.rst +++ b/Help/policy/CMP0058.rst @@ -1,6 +1,8 @@ CMP0058 ------- +.. versionadded:: 3.3 + Ninja requires custom command byproducts to be explicit. When an intermediate file generated during the build is consumed diff --git a/Help/policy/CMP0059.rst b/Help/policy/CMP0059.rst index bce982e..6317d05 100644 --- a/Help/policy/CMP0059.rst +++ b/Help/policy/CMP0059.rst @@ -1,6 +1,8 @@ CMP0059 ------- +.. versionadded:: 3.3 + Do not treat ``DEFINITIONS`` as a built-in directory property. CMake 3.3 and above no longer make a list of definitions available through diff --git a/Help/policy/CMP0060.rst b/Help/policy/CMP0060.rst index 98ac2cf..09257d1 100644 --- a/Help/policy/CMP0060.rst +++ b/Help/policy/CMP0060.rst @@ -1,6 +1,8 @@ CMP0060 ------- +.. versionadded:: 3.3 + Link libraries by full path even in implicit directories. Policy :policy:`CMP0003` was introduced with the intention of always diff --git a/Help/policy/CMP0061.rst b/Help/policy/CMP0061.rst index 57e4161..aca551d 100644 --- a/Help/policy/CMP0061.rst +++ b/Help/policy/CMP0061.rst @@ -1,6 +1,8 @@ CMP0061 ------- +.. versionadded:: 3.3 + CTest does not by default tell ``make`` to ignore errors (``-i``). The :command:`ctest_build` and :command:`build_command` commands no diff --git a/Help/policy/CMP0062.rst b/Help/policy/CMP0062.rst index 0db7aaf..01e93f0 100644 --- a/Help/policy/CMP0062.rst +++ b/Help/policy/CMP0062.rst @@ -1,6 +1,8 @@ CMP0062 ------- +.. versionadded:: 3.3 + Disallow :command:`install` of :command:`export` result. The :command:`export()` command generates a file containing diff --git a/Help/policy/CMP0063.rst b/Help/policy/CMP0063.rst index d736d06..fec3ad8 100644 --- a/Help/policy/CMP0063.rst +++ b/Help/policy/CMP0063.rst @@ -1,6 +1,8 @@ CMP0063 ------- +.. versionadded:: 3.3 + Honor visibility properties for all target types. The :prop_tgt:`<LANG>_VISIBILITY_PRESET` and diff --git a/Help/policy/CMP0064.rst b/Help/policy/CMP0064.rst index e9a061b..0c20c13 100644 --- a/Help/policy/CMP0064.rst +++ b/Help/policy/CMP0064.rst @@ -1,6 +1,8 @@ CMP0064 ------- +.. versionadded:: 3.4 + Recognize ``TEST`` as a operator for the :command:`if` command. The ``TEST`` operator was added to the :command:`if` command to determine if a diff --git a/Help/policy/CMP0065.rst b/Help/policy/CMP0065.rst index b820aad..8968b91 100644 --- a/Help/policy/CMP0065.rst +++ b/Help/policy/CMP0065.rst @@ -1,6 +1,8 @@ CMP0065 ------- +.. versionadded:: 3.4 + Do not add flags to export symbols from executables without the :prop_tgt:`ENABLE_EXPORTS` target property. diff --git a/Help/policy/CMP0066.rst b/Help/policy/CMP0066.rst index e110ae1..b08430f 100644 --- a/Help/policy/CMP0066.rst +++ b/Help/policy/CMP0066.rst @@ -1,6 +1,8 @@ CMP0066 ------- +.. versionadded:: 3.7 + Honor per-config flags in :command:`try_compile` source-file signature. The source file signature of the :command:`try_compile` command uses the value diff --git a/Help/policy/CMP0067.rst b/Help/policy/CMP0067.rst index f802787..8358bb2 100644 --- a/Help/policy/CMP0067.rst +++ b/Help/policy/CMP0067.rst @@ -1,6 +1,8 @@ CMP0067 ------- +.. versionadded:: 3.8 + Honor language standard in :command:`try_compile` source-file signature. The :command:`try_compile` source file signature is intended to allow diff --git a/Help/policy/CMP0068.rst b/Help/policy/CMP0068.rst index 978a6e3..5d2a4b1 100644 --- a/Help/policy/CMP0068.rst +++ b/Help/policy/CMP0068.rst @@ -1,6 +1,8 @@ CMP0068 ------- +.. versionadded:: 3.9 + ``RPATH`` settings on macOS do not affect ``install_name``. CMake 3.9 and newer remove any effect the following settings may have on the diff --git a/Help/policy/CMP0069.rst b/Help/policy/CMP0069.rst index 0d5ddfd..eafac45 100644 --- a/Help/policy/CMP0069.rst +++ b/Help/policy/CMP0069.rst @@ -1,6 +1,8 @@ CMP0069 ------- +.. versionadded:: 3.9 + :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` is enforced when enabled. CMake 3.9 and newer prefer to add IPO flags whenever the diff --git a/Help/policy/CMP0070.rst b/Help/policy/CMP0070.rst index 0fb3617..c880d1f 100644 --- a/Help/policy/CMP0070.rst +++ b/Help/policy/CMP0070.rst @@ -1,6 +1,8 @@ CMP0070 ------- +.. versionadded:: 3.10 + Define :command:`file(GENERATE)` behavior for relative paths. CMake 3.10 and newer define that relative paths given to ``INPUT`` and diff --git a/Help/policy/CMP0071.rst b/Help/policy/CMP0071.rst index 855ecf0..700d3b0 100644 --- a/Help/policy/CMP0071.rst +++ b/Help/policy/CMP0071.rst @@ -1,6 +1,8 @@ CMP0071 ------- +.. versionadded:: 3.10 + Let :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC` process :prop_sf:`GENERATED` files. diff --git a/Help/policy/CMP0072.rst b/Help/policy/CMP0072.rst index 3abbad7..1dcdfef 100644 --- a/Help/policy/CMP0072.rst +++ b/Help/policy/CMP0072.rst @@ -1,6 +1,8 @@ CMP0072 ------- +.. versionadded:: 3.11 + :module:`FindOpenGL` prefers GLVND by default when available. The :module:`FindOpenGL` module provides an ``OpenGL::GL`` target and an diff --git a/Help/policy/CMP0073.rst b/Help/policy/CMP0073.rst index 9bfa0e9..8f0345c 100644 --- a/Help/policy/CMP0073.rst +++ b/Help/policy/CMP0073.rst @@ -1,6 +1,8 @@ CMP0073 ------- +.. versionadded:: 3.12 + Do not produce legacy ``_LIB_DEPENDS`` cache entries. Ancient CMake versions once used ``<tgt>_LIB_DEPENDS`` cache entries to diff --git a/Help/policy/CMP0074.rst b/Help/policy/CMP0074.rst index 63ebf7b..863bbb2 100644 --- a/Help/policy/CMP0074.rst +++ b/Help/policy/CMP0074.rst @@ -1,6 +1,8 @@ CMP0074 ------- +.. versionadded:: 3.12 + :command:`find_package` uses ``<PackageName>_ROOT`` variables. In CMake 3.12 and above the :command:`find_package(<PackageName>)` command now diff --git a/Help/policy/CMP0075.rst b/Help/policy/CMP0075.rst index aa5c3f7..4213782 100644 --- a/Help/policy/CMP0075.rst +++ b/Help/policy/CMP0075.rst @@ -1,6 +1,8 @@ CMP0075 ------- +.. versionadded:: 3.12 + Include file check macros honor ``CMAKE_REQUIRED_LIBRARIES``. In CMake 3.12 and above, the diff --git a/Help/policy/CMP0076.rst b/Help/policy/CMP0076.rst index dd25f80..edca742 100644 --- a/Help/policy/CMP0076.rst +++ b/Help/policy/CMP0076.rst @@ -1,6 +1,8 @@ CMP0076 ------- +.. versionadded:: 3.13 + The :command:`target_sources` command converts relative paths to absolute. In CMake 3.13 and above, the :command:`target_sources` command now converts diff --git a/Help/policy/CMP0077.rst b/Help/policy/CMP0077.rst index 44797b6..174cde9 100644 --- a/Help/policy/CMP0077.rst +++ b/Help/policy/CMP0077.rst @@ -1,6 +1,8 @@ CMP0077 ------- +.. versionadded:: 3.13 + :command:`option` honors normal variables. The :command:`option` command is typically used to create a cache entry diff --git a/Help/policy/CMP0078.rst b/Help/policy/CMP0078.rst index 2e97934..89fdb0b 100644 --- a/Help/policy/CMP0078.rst +++ b/Help/policy/CMP0078.rst @@ -1,6 +1,8 @@ CMP0078 ------- +.. versionadded:: 3.13 + :module:`UseSWIG` generates standard target names. Starting with CMake 3.13, :module:`UseSWIG` generates now standard target diff --git a/Help/policy/CMP0079.rst b/Help/policy/CMP0079.rst index 0244d6c..01aa08d 100644 --- a/Help/policy/CMP0079.rst +++ b/Help/policy/CMP0079.rst @@ -1,6 +1,8 @@ CMP0079 ------- +.. versionadded:: 3.13 + :command:`target_link_libraries` allows use with targets in other directories. Prior to CMake 3.13 the :command:`target_link_libraries` command did not diff --git a/Help/policy/CMP0080.rst b/Help/policy/CMP0080.rst index 5ce9591..789efea 100644 --- a/Help/policy/CMP0080.rst +++ b/Help/policy/CMP0080.rst @@ -1,6 +1,8 @@ CMP0080 ------- +.. versionadded:: 3.13 + :module:`BundleUtilities` cannot be included at configure time. The macros provided by :module:`BundleUtilities` are intended to be invoked diff --git a/Help/policy/CMP0081.rst b/Help/policy/CMP0081.rst index d3b2872..d1573dd 100644 --- a/Help/policy/CMP0081.rst +++ b/Help/policy/CMP0081.rst @@ -1,6 +1,8 @@ CMP0081 ------- +.. versionadded:: 3.13 + Relative paths not allowed in :prop_tgt:`LINK_DIRECTORIES` target property. CMake 3.12 and lower allowed the :prop_dir:`LINK_DIRECTORIES` directory diff --git a/Help/policy/CMP0082.rst b/Help/policy/CMP0082.rst index d887616..25c9580 100644 --- a/Help/policy/CMP0082.rst +++ b/Help/policy/CMP0082.rst @@ -1,6 +1,8 @@ CMP0082 ------- +.. versionadded:: 3.14 + Install rules from :command:`add_subdirectory` calls are interleaved with those in caller. diff --git a/Help/policy/CMP0083.rst b/Help/policy/CMP0083.rst index e0b09cf..7518ee3 100644 --- a/Help/policy/CMP0083.rst +++ b/Help/policy/CMP0083.rst @@ -1,6 +1,8 @@ CMP0083 ------- +.. versionadded:: 3.14 + To control generation of Position Independent Executable (``PIE``) or not, some flags are required at link time. diff --git a/Help/policy/CMP0084.rst b/Help/policy/CMP0084.rst index 713d295..9547701 100644 --- a/Help/policy/CMP0084.rst +++ b/Help/policy/CMP0084.rst @@ -1,6 +1,8 @@ CMP0084 ------- +.. versionadded:: 3.14 + The :module:`FindQt` module does not exist for :command:`find_package`. The existence of :module:`FindQt` means that for Qt upstream to provide diff --git a/Help/policy/CMP0085.rst b/Help/policy/CMP0085.rst index d9ec9a2..d90c72f 100644 --- a/Help/policy/CMP0085.rst +++ b/Help/policy/CMP0085.rst @@ -1,6 +1,8 @@ CMP0085 ------- +.. versionadded:: 3.14 + ``$<IN_LIST:...>`` handles empty list items. In CMake 3.13 and lower, the ``$<IN_LIST:...>`` generator expression always diff --git a/Help/policy/CMP0086.rst b/Help/policy/CMP0086.rst index 4a9e8b8..725b502 100644 --- a/Help/policy/CMP0086.rst +++ b/Help/policy/CMP0086.rst @@ -1,6 +1,8 @@ CMP0086 ------- +.. versionadded:: 3.14 + :module:`UseSWIG` honors ``SWIG_MODULE_NAME`` via ``-module`` flag. Starting with CMake 3.14, :module:`UseSWIG` passes option diff --git a/Help/policy/CMP0087.rst b/Help/policy/CMP0087.rst index 4c45b99..4a65506 100644 --- a/Help/policy/CMP0087.rst +++ b/Help/policy/CMP0087.rst @@ -1,6 +1,8 @@ CMP0087 ------- +.. versionadded:: 3.14 + :command:`install(CODE)` and :command:`install(SCRIPT)` support generator expressions. diff --git a/Help/policy/CMP0088.rst b/Help/policy/CMP0088.rst index 82c04ef..1840a58 100644 --- a/Help/policy/CMP0088.rst +++ b/Help/policy/CMP0088.rst @@ -1,6 +1,8 @@ CMP0088 ------- +.. versionadded:: 3.14 + :module:`FindBISON` runs bison in :variable:`CMAKE_CURRENT_BINARY_DIR` when executing. diff --git a/Help/policy/CMP0089.rst b/Help/policy/CMP0089.rst index 029de55..e3fc77a 100644 --- a/Help/policy/CMP0089.rst +++ b/Help/policy/CMP0089.rst @@ -1,6 +1,8 @@ CMP0089 ------- +.. versionadded:: 3.15 + Compiler id for IBM Clang-based XL compilers is now ``XLClang``. CMake 3.15 and above recognize that IBM's Clang-based XL compilers diff --git a/Help/policy/CMP0090.rst b/Help/policy/CMP0090.rst index 720c17c..58dd999 100644 --- a/Help/policy/CMP0090.rst +++ b/Help/policy/CMP0090.rst @@ -1,6 +1,8 @@ CMP0090 ------- +.. versionadded:: 3.15 + :command:`export(PACKAGE)` does not populate package registry by default. In CMake 3.14 and below the :command:`export(PACKAGE)` command populated the diff --git a/Help/policy/CMP0091.rst b/Help/policy/CMP0091.rst index 1a5878a..ffc0ade 100644 --- a/Help/policy/CMP0091.rst +++ b/Help/policy/CMP0091.rst @@ -1,6 +1,8 @@ CMP0091 ------- +.. versionadded:: 3.15 + MSVC runtime library flags are selected by an abstraction. Compilers targeting the MSVC ABI have flags to select the MSVC runtime library. diff --git a/Help/policy/CMP0092.rst b/Help/policy/CMP0092.rst index 8d3a288..2f39830 100644 --- a/Help/policy/CMP0092.rst +++ b/Help/policy/CMP0092.rst @@ -1,6 +1,8 @@ CMP0092 ------- +.. versionadded:: 3.15 + MSVC warning flags are not in :variable:`CMAKE_<LANG>_FLAGS` by default. When using MSVC-like compilers in CMake 3.14 and below, warning flags @@ -16,7 +18,7 @@ CMake 3.15 and above prefer to leave out warning flags from the value of This policy provides compatibility with projects that have not been updated to expect the lack of warning flags. The policy setting takes effect as of the first :command:`project` or :command:`enable_language` command that -initializes :variable:`CMAKE_<LANG>_FLAGS` for a given lanuage ``<LANG>``. +initializes :variable:`CMAKE_<LANG>_FLAGS` for a given language ``<LANG>``. .. note:: diff --git a/Help/policy/CMP0093.rst b/Help/policy/CMP0093.rst index 0ffc493..4a9955f 100644 --- a/Help/policy/CMP0093.rst +++ b/Help/policy/CMP0093.rst @@ -1,6 +1,8 @@ CMP0093 ------- +.. versionadded:: 3.15 + :module:`FindBoost` reports ``Boost_VERSION`` in ``x.y.z`` format. In CMake 3.14 and below the module would report the Boost version diff --git a/Help/policy/CMP0094.rst b/Help/policy/CMP0094.rst index 836f30f..1b57658 100644 --- a/Help/policy/CMP0094.rst +++ b/Help/policy/CMP0094.rst @@ -1,6 +1,8 @@ CMP0094 ------- +.. versionadded:: 3.15 + Modules :module:`FindPython3`, :module:`FindPython2` and :module:`FindPython` use ``LOCATION`` for lookup strategy. diff --git a/Help/policy/CMP0095.rst b/Help/policy/CMP0095.rst index 4c56a05..ebdbab6 100644 --- a/Help/policy/CMP0095.rst +++ b/Help/policy/CMP0095.rst @@ -1,6 +1,8 @@ CMP0095 ------- +.. versionadded:: 3.16 + ``RPATH`` entries are properly escaped in the intermediary CMake install script. In CMake 3.15 and earlier, ``RPATH`` entries set via diff --git a/Help/policy/CMP0096.rst b/Help/policy/CMP0096.rst index 8eaf0f9..8fd6f72 100644 --- a/Help/policy/CMP0096.rst +++ b/Help/policy/CMP0096.rst @@ -1,6 +1,8 @@ CMP0096 ------- +.. versionadded:: 3.16 + The :command:`project` command preserves leading zeros in version components. When a ``VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]`` argument is given diff --git a/Help/policy/CMP0097.rst b/Help/policy/CMP0097.rst index 4840aa6..2240874 100644 --- a/Help/policy/CMP0097.rst +++ b/Help/policy/CMP0097.rst @@ -1,6 +1,8 @@ CMP0097 ------- +.. versionadded:: 3.16 + :command:`ExternalProject_Add` with ``GIT_SUBMODULES ""`` initializes no submodules. diff --git a/Help/policy/CMP0098.rst b/Help/policy/CMP0098.rst index 6d1443b..e793380 100644 --- a/Help/policy/CMP0098.rst +++ b/Help/policy/CMP0098.rst @@ -1,6 +1,8 @@ CMP0098 ------- +.. versionadded:: 3.17 + :module:`FindFLEX` runs ``flex`` in directory :variable:`CMAKE_CURRENT_BINARY_DIR` when executing. diff --git a/Help/policy/CMP0099.rst b/Help/policy/CMP0099.rst index c897e7b..0c64949 100644 --- a/Help/policy/CMP0099.rst +++ b/Help/policy/CMP0099.rst @@ -1,6 +1,8 @@ CMP0099 ------- +.. versionadded:: 3.17 + Target link properties :prop_tgt:`INTERFACE_LINK_OPTIONS`, :prop_tgt:`INTERFACE_LINK_DIRECTORIES` and :prop_tgt:`INTERFACE_LINK_DEPENDS` are now transitive over private dependencies of static libraries. diff --git a/Help/policy/CMP0100.rst b/Help/policy/CMP0100.rst index b24d013..730fa82 100644 --- a/Help/policy/CMP0100.rst +++ b/Help/policy/CMP0100.rst @@ -1,6 +1,8 @@ CMP0100 ------- +.. versionadded:: 3.17 + Let :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC` process header files that end with a ``.hh`` extension. diff --git a/Help/policy/CMP0101.rst b/Help/policy/CMP0101.rst index 9941acf..f02bccc 100644 --- a/Help/policy/CMP0101.rst +++ b/Help/policy/CMP0101.rst @@ -1,6 +1,8 @@ CMP0101 ------- +.. versionadded:: 3.17 + :command:`target_compile_options` now honors ``BEFORE`` keyword in all scopes. In CMake 3.16 and below the :command:`target_compile_options` ignores the diff --git a/Help/policy/CMP0102.rst b/Help/policy/CMP0102.rst index 9859006..78b5584 100644 --- a/Help/policy/CMP0102.rst +++ b/Help/policy/CMP0102.rst @@ -1,6 +1,8 @@ CMP0102 ------- +.. versionadded:: 3.17 + The :command:`mark_as_advanced` command no longer creates a cache entry if one does not already exist. diff --git a/Help/policy/CMP0103.rst b/Help/policy/CMP0103.rst index 223e0cb..b5f44d1 100644 --- a/Help/policy/CMP0103.rst +++ b/Help/policy/CMP0103.rst @@ -1,6 +1,8 @@ CMP0103 ------- +.. versionadded:: 3.18 + Multiple calls to :command:`export` command with same ``FILE`` without ``APPEND`` is no longer allowed. diff --git a/Help/policy/CMP0104.rst b/Help/policy/CMP0104.rst index 8516716..7c7a16e 100644 --- a/Help/policy/CMP0104.rst +++ b/Help/policy/CMP0104.rst @@ -1,6 +1,8 @@ CMP0104 ------- +.. versionadded:: 3.18 + Initialize :variable:`CMAKE_CUDA_ARCHITECTURES` when :variable:`CMAKE_CUDA_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` is ``NVIDIA``. Raise an error if :prop_tgt:`CUDA_ARCHITECTURES` is empty. diff --git a/Help/policy/CMP0105.rst b/Help/policy/CMP0105.rst index 19a1edb..097a59a 100644 --- a/Help/policy/CMP0105.rst +++ b/Help/policy/CMP0105.rst @@ -1,6 +1,8 @@ CMP0105 ------- +.. versionadded:: 3.18 + :prop_tgt:`LINK_OPTIONS` and :prop_tgt:`INTERFACE_LINK_OPTIONS` target properties are now used for the device link step. diff --git a/Help/policy/CMP0106.rst b/Help/policy/CMP0106.rst index e34d15a..18a6635 100644 --- a/Help/policy/CMP0106.rst +++ b/Help/policy/CMP0106.rst @@ -1,6 +1,8 @@ CMP0106 ------- +.. versionadded:: 3.18 + The :module:`Documentation` module is removed. The :module:`Documentation` was added as a support mechanism for the VTK diff --git a/Help/policy/CMP0107.rst b/Help/policy/CMP0107.rst index 111bef7..da5ae06 100644 --- a/Help/policy/CMP0107.rst +++ b/Help/policy/CMP0107.rst @@ -1,6 +1,8 @@ CMP0107 ------- +.. versionadded:: 3.18 + It is not allowed to create an ``ALIAS`` target with the same name as an another target. diff --git a/Help/policy/CMP0108.rst b/Help/policy/CMP0108.rst index 0d54cfa..4d1091d 100644 --- a/Help/policy/CMP0108.rst +++ b/Help/policy/CMP0108.rst @@ -1,6 +1,8 @@ CMP0108 ------- +.. versionadded:: 3.18 + A target is not allowed to link to itself even through an ``ALIAS`` target. In CMake 3.17 and below, a target can link to a target aliased to itself. diff --git a/Help/policy/CMP0109.rst b/Help/policy/CMP0109.rst new file mode 100644 index 0000000..f86287f --- /dev/null +++ b/Help/policy/CMP0109.rst @@ -0,0 +1,24 @@ +CMP0109 +------- + +.. versionadded:: 3.19 + +:command:`find_program` requires permission to execute but not to read. + +In CMake 3.18 and below, the :command:`find_program` command on UNIX +would find files that are readable without requiring execute permission, +and would not find files that are executable without read permission. +In CMake 3.19 and above, ``find_program`` now prefers to require execute +permission but not read permission. This policy provides compatibility +with projects that have not been updated to expect the new behavior. + +The ``OLD`` behavior for this policy is for ``find_program`` to require +read permission but not execute permission. +The ``NEW`` behavior for this policy is for ``find_program`` to require +execute permission but not read permission. + +This policy was introduced in CMake version 3.19. CMake version |release| +warns when the policy is not set and uses ``OLD`` behavior. Use the +:command:`cmake_policy` command to set it to ``OLD`` or ``NEW`` explicitly. + +.. include:: DEPRECATED.txt diff --git a/Help/policy/CMP0110.rst b/Help/policy/CMP0110.rst new file mode 100644 index 0000000..bc198aa --- /dev/null +++ b/Help/policy/CMP0110.rst @@ -0,0 +1,24 @@ +CMP0110 +------- + +:command:`add_test` supports arbitrary characters in test names. + +:command:`add_test` can now (officially) create tests with whitespace and +other special characters in its name. Before CMake version 3.19 that was not +allowed, however, it was possible to work around this limitation by explicitly +putting escaped quotes arount the test's name in the ``add_test`` command. + +Although never officially supported several projects in the wild found and +implemented this workaround. However, the new change which officially allows +the ``add_test`` command to support whitespace and other special characters in +test names now breaks that workaround. In order for these projects to work +smoothly with newer CMake versions, this policy was introduced. + +The ``OLD`` behavior of this policy is to still prevent ``add_test`` from +handling whitespace and special characters properly (if not using the +mentioned workaround). The ``NEW`` behavior on the other hand allows names +with whitespace and special characters for tests created by ``add_test``. + +This policy was introduced in CMake version 3.19. CMake version |release| +warns when the policy is not set and uses ``OLD`` behavior. Use the +:command:`cmake_policy` command to set it to ``OLD`` or ``NEW`` explicitly. diff --git a/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst b/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst index 051d22a..6097d14 100644 --- a/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst +++ b/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst @@ -1,6 +1,8 @@ ADDITIONAL_CLEAN_FILES ---------------------- +.. versionadded:: 3.15 + A :ref:`;-list <CMake Language Lists>` of files or directories that will be removed as a part of the global ``clean`` target. It is useful for specifying generated files or directories that are used by multiple targets diff --git a/Help/prop_dir/BINARY_DIR.rst b/Help/prop_dir/BINARY_DIR.rst index 597c79a..fcf9d17 100644 --- a/Help/prop_dir/BINARY_DIR.rst +++ b/Help/prop_dir/BINARY_DIR.rst @@ -1,5 +1,7 @@ BINARY_DIR ---------- +.. versionadded:: 3.7 + This read-only directory property reports absolute path to the binary directory corresponding to the source on which it is read. diff --git a/Help/prop_dir/BUILDSYSTEM_TARGETS.rst b/Help/prop_dir/BUILDSYSTEM_TARGETS.rst index 04bb56e..5c5893d 100644 --- a/Help/prop_dir/BUILDSYSTEM_TARGETS.rst +++ b/Help/prop_dir/BUILDSYSTEM_TARGETS.rst @@ -1,6 +1,8 @@ BUILDSYSTEM_TARGETS ------------------- +.. versionadded:: 3.7 + This read-only directory property contains a :ref:`semicolon-separated list <CMake Language Lists>` of buildsystem targets added in the directory by calls to the :command:`add_library`, :command:`add_executable`, diff --git a/Help/prop_dir/LABELS.rst b/Help/prop_dir/LABELS.rst index de27d90..bf14368 100644 --- a/Help/prop_dir/LABELS.rst +++ b/Help/prop_dir/LABELS.rst @@ -1,6 +1,8 @@ LABELS ------ +.. versionadded:: 3.10 + Specify a list of text labels associated with a directory and all of its subdirectories. This is equivalent to setting the :prop_tgt:`LABELS` target property and the :prop_test:`LABELS` test property on all targets and tests in diff --git a/Help/prop_dir/LINK_OPTIONS.rst b/Help/prop_dir/LINK_OPTIONS.rst index f229ba6..3a5c72f 100644 --- a/Help/prop_dir/LINK_OPTIONS.rst +++ b/Help/prop_dir/LINK_OPTIONS.rst @@ -1,6 +1,8 @@ LINK_OPTIONS ------------ +.. versionadded:: 3.13 + List of options to use for the link step of shared library, module and executable targets as well as the device link step. diff --git a/Help/prop_dir/SOURCE_DIR.rst b/Help/prop_dir/SOURCE_DIR.rst index ac98c3b..d73707d 100644 --- a/Help/prop_dir/SOURCE_DIR.rst +++ b/Help/prop_dir/SOURCE_DIR.rst @@ -1,5 +1,7 @@ SOURCE_DIR ---------- +.. versionadded:: 3.7 + This read-only directory property reports absolute path to the source directory on which it is read. diff --git a/Help/prop_dir/SUBDIRECTORIES.rst b/Help/prop_dir/SUBDIRECTORIES.rst index 6a0ac80..71ea496 100644 --- a/Help/prop_dir/SUBDIRECTORIES.rst +++ b/Help/prop_dir/SUBDIRECTORIES.rst @@ -1,6 +1,8 @@ SUBDIRECTORIES -------------- +.. versionadded:: 3.7 + This read-only directory property contains a :ref:`semicolon-separated list <CMake Language Lists>` of subdirectories processed so far by the :command:`add_subdirectory` or :command:`subdirs` commands. Each entry is diff --git a/Help/prop_dir/TESTS.rst b/Help/prop_dir/TESTS.rst index 1c9f6e5..294be17 100644 --- a/Help/prop_dir/TESTS.rst +++ b/Help/prop_dir/TESTS.rst @@ -1,6 +1,8 @@ TESTS ----- +.. versionadded:: 3.12 + List of tests. This read-only property holds a diff --git a/Help/prop_dir/TEST_INCLUDE_FILES.rst b/Help/prop_dir/TEST_INCLUDE_FILES.rst index c3e4602..f9a66f4 100644 --- a/Help/prop_dir/TEST_INCLUDE_FILES.rst +++ b/Help/prop_dir/TEST_INCLUDE_FILES.rst @@ -1,6 +1,8 @@ TEST_INCLUDE_FILES ------------------ +.. versionadded:: 3.10 + A list of cmake files that will be included when ctest is run. If you specify ``TEST_INCLUDE_FILES``, those files will be included and diff --git a/Help/prop_dir/VS_STARTUP_PROJECT.rst b/Help/prop_dir/VS_STARTUP_PROJECT.rst index 2680dfa..8a0c3c8 100644 --- a/Help/prop_dir/VS_STARTUP_PROJECT.rst +++ b/Help/prop_dir/VS_STARTUP_PROJECT.rst @@ -1,6 +1,8 @@ VS_STARTUP_PROJECT ------------------ +.. versionadded:: 3.6 + Specify the default startup project in a Visual Studio solution. The :ref:`Visual Studio Generators` create a ``.sln`` file for each directory diff --git a/Help/prop_gbl/AUTOGEN_SOURCE_GROUP.rst b/Help/prop_gbl/AUTOGEN_SOURCE_GROUP.rst index d294eb1..2e32320 100644 --- a/Help/prop_gbl/AUTOGEN_SOURCE_GROUP.rst +++ b/Help/prop_gbl/AUTOGEN_SOURCE_GROUP.rst @@ -1,6 +1,8 @@ AUTOGEN_SOURCE_GROUP -------------------- +.. versionadded:: 3.9 + Name of the :command:`source_group` for :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTORCC` generated files. diff --git a/Help/prop_gbl/AUTOMOC_SOURCE_GROUP.rst b/Help/prop_gbl/AUTOMOC_SOURCE_GROUP.rst index 2455dc7..a266fde 100644 --- a/Help/prop_gbl/AUTOMOC_SOURCE_GROUP.rst +++ b/Help/prop_gbl/AUTOMOC_SOURCE_GROUP.rst @@ -1,6 +1,8 @@ AUTOMOC_SOURCE_GROUP -------------------- +.. versionadded:: 3.9 + Name of the :command:`source_group` for :prop_tgt:`AUTOMOC` generated files. When set this is used instead of :prop_gbl:`AUTOGEN_SOURCE_GROUP` for diff --git a/Help/prop_gbl/AUTORCC_SOURCE_GROUP.rst b/Help/prop_gbl/AUTORCC_SOURCE_GROUP.rst index 65ea95b..54ebabb 100644 --- a/Help/prop_gbl/AUTORCC_SOURCE_GROUP.rst +++ b/Help/prop_gbl/AUTORCC_SOURCE_GROUP.rst @@ -1,6 +1,8 @@ AUTORCC_SOURCE_GROUP -------------------- +.. versionadded:: 3.9 + Name of the :command:`source_group` for :prop_tgt:`AUTORCC` generated files. When set this is used instead of :prop_gbl:`AUTOGEN_SOURCE_GROUP` for diff --git a/Help/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst b/Help/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst index 44e37fe..e8e3148 100644 --- a/Help/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst +++ b/Help/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst @@ -1,6 +1,8 @@ CMAKE_CUDA_KNOWN_FEATURES ------------------------- +.. versionadded:: 3.17 + List of CUDA features known to this version of CMake. The features listed in this global property may be known to be available to the diff --git a/Help/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst b/Help/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst index b921c6b..9b53282 100644 --- a/Help/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst +++ b/Help/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst @@ -1,6 +1,8 @@ CMAKE_CXX_KNOWN_FEATURES ------------------------ +.. versionadded:: 3.1 + List of C++ features known to this version of CMake. The features listed in this global property may be known to be available to the diff --git a/Help/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst b/Help/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst index e5f896e..7166381 100644 --- a/Help/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst +++ b/Help/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst @@ -1,6 +1,8 @@ CMAKE_C_KNOWN_FEATURES ---------------------- +.. versionadded:: 3.1 + List of C features known to this version of CMake. The features listed in this global property may be known to be available to the diff --git a/Help/prop_gbl/CMAKE_ROLE.rst b/Help/prop_gbl/CMAKE_ROLE.rst index 27512fa..3f4492f 100644 --- a/Help/prop_gbl/CMAKE_ROLE.rst +++ b/Help/prop_gbl/CMAKE_ROLE.rst @@ -1,6 +1,8 @@ CMAKE_ROLE ---------- +.. versionadded:: 3.14 + Tells what mode the current running script is in. Could be one of several values: diff --git a/Help/prop_gbl/ECLIPSE_EXTRA_CPROJECT_CONTENTS.rst b/Help/prop_gbl/ECLIPSE_EXTRA_CPROJECT_CONTENTS.rst index 50c41a9..2f110a7 100644 --- a/Help/prop_gbl/ECLIPSE_EXTRA_CPROJECT_CONTENTS.rst +++ b/Help/prop_gbl/ECLIPSE_EXTRA_CPROJECT_CONTENTS.rst @@ -1,6 +1,8 @@ ECLIPSE_EXTRA_CPROJECT_CONTENTS ------------------------------- +.. versionadded:: 3.12 + Additional contents to be inserted into the generated Eclipse cproject file. The cproject file defines the CDT specific information. Some third party IDE's diff --git a/Help/prop_gbl/FIND_LIBRARY_USE_LIB32_PATHS.rst b/Help/prop_gbl/FIND_LIBRARY_USE_LIB32_PATHS.rst index 8396026..f6cad66 100644 --- a/Help/prop_gbl/FIND_LIBRARY_USE_LIB32_PATHS.rst +++ b/Help/prop_gbl/FIND_LIBRARY_USE_LIB32_PATHS.rst @@ -1,6 +1,8 @@ FIND_LIBRARY_USE_LIB32_PATHS ---------------------------- +.. versionadded:: 3.7 + Whether the :command:`find_library` command should automatically search ``lib32`` directories. diff --git a/Help/prop_gbl/FIND_LIBRARY_USE_LIBX32_PATHS.rst b/Help/prop_gbl/FIND_LIBRARY_USE_LIBX32_PATHS.rst index b87b09b..851f859 100644 --- a/Help/prop_gbl/FIND_LIBRARY_USE_LIBX32_PATHS.rst +++ b/Help/prop_gbl/FIND_LIBRARY_USE_LIBX32_PATHS.rst @@ -1,6 +1,8 @@ FIND_LIBRARY_USE_LIBX32_PATHS ----------------------------- +.. versionadded:: 3.9 + Whether the :command:`find_library` command should automatically search ``libx32`` directories. diff --git a/Help/prop_gbl/GENERATOR_IS_MULTI_CONFIG.rst b/Help/prop_gbl/GENERATOR_IS_MULTI_CONFIG.rst index b8ec8a6..6f1a9e1 100644 --- a/Help/prop_gbl/GENERATOR_IS_MULTI_CONFIG.rst +++ b/Help/prop_gbl/GENERATOR_IS_MULTI_CONFIG.rst @@ -1,6 +1,8 @@ GENERATOR_IS_MULTI_CONFIG ------------------------- +.. versionadded:: 3.9 + Read-only property that is true on multi-configuration generators. True when using a multi-configuration generator diff --git a/Help/prop_gbl/TARGET_MESSAGES.rst b/Help/prop_gbl/TARGET_MESSAGES.rst index 275b074..bb91772 100644 --- a/Help/prop_gbl/TARGET_MESSAGES.rst +++ b/Help/prop_gbl/TARGET_MESSAGES.rst @@ -1,6 +1,8 @@ TARGET_MESSAGES --------------- +.. versionadded:: 3.4 + Specify whether to report the completion of each target. This property specifies whether :ref:`Makefile Generators` should diff --git a/Help/prop_gbl/XCODE_EMIT_EFFECTIVE_PLATFORM_NAME.rst b/Help/prop_gbl/XCODE_EMIT_EFFECTIVE_PLATFORM_NAME.rst index 9500443..392b704 100644 --- a/Help/prop_gbl/XCODE_EMIT_EFFECTIVE_PLATFORM_NAME.rst +++ b/Help/prop_gbl/XCODE_EMIT_EFFECTIVE_PLATFORM_NAME.rst @@ -1,6 +1,8 @@ XCODE_EMIT_EFFECTIVE_PLATFORM_NAME ---------------------------------- +.. versionadded:: 3.8 + Control emission of ``EFFECTIVE_PLATFORM_NAME`` by the :generator:`Xcode` generator. diff --git a/Help/prop_inst/CPACK_DESKTOP_SHORTCUTS.rst b/Help/prop_inst/CPACK_DESKTOP_SHORTCUTS.rst index 729ab60..55e9a20 100644 --- a/Help/prop_inst/CPACK_DESKTOP_SHORTCUTS.rst +++ b/Help/prop_inst/CPACK_DESKTOP_SHORTCUTS.rst @@ -1,6 +1,8 @@ CPACK_DESKTOP_SHORTCUTS ----------------------- +.. versionadded:: 3.3 + Species a list of shortcut names that should be created on the `Desktop` for this file. diff --git a/Help/prop_inst/CPACK_NEVER_OVERWRITE.rst b/Help/prop_inst/CPACK_NEVER_OVERWRITE.rst index 4789e25..12eef9e 100644 --- a/Help/prop_inst/CPACK_NEVER_OVERWRITE.rst +++ b/Help/prop_inst/CPACK_NEVER_OVERWRITE.rst @@ -1,6 +1,8 @@ CPACK_NEVER_OVERWRITE --------------------- +.. versionadded:: 3.1 + Request that this file not be overwritten on install or reinstall. The property is currently only supported by the :cpack_gen:`CPack WIX Generator`. diff --git a/Help/prop_inst/CPACK_PERMANENT.rst b/Help/prop_inst/CPACK_PERMANENT.rst index 985de0d..e89c552 100644 --- a/Help/prop_inst/CPACK_PERMANENT.rst +++ b/Help/prop_inst/CPACK_PERMANENT.rst @@ -1,6 +1,8 @@ CPACK_PERMANENT --------------- +.. versionadded:: 3.1 + Request that this file not be removed on uninstall. The property is currently only supported by the :cpack_gen:`CPack WIX Generator`. diff --git a/Help/prop_inst/CPACK_STARTUP_SHORTCUTS.rst b/Help/prop_inst/CPACK_STARTUP_SHORTCUTS.rst index d9208b9..e896acd 100644 --- a/Help/prop_inst/CPACK_STARTUP_SHORTCUTS.rst +++ b/Help/prop_inst/CPACK_STARTUP_SHORTCUTS.rst @@ -1,6 +1,8 @@ CPACK_STARTUP_SHORTCUTS ----------------------- +.. versionadded:: 3.3 + Species a list of shortcut names that should be created in the `Startup` folder for this file. diff --git a/Help/prop_inst/CPACK_START_MENU_SHORTCUTS.rst b/Help/prop_inst/CPACK_START_MENU_SHORTCUTS.rst index 092334a..fb8807f 100644 --- a/Help/prop_inst/CPACK_START_MENU_SHORTCUTS.rst +++ b/Help/prop_inst/CPACK_START_MENU_SHORTCUTS.rst @@ -1,6 +1,8 @@ CPACK_START_MENU_SHORTCUTS -------------------------- +.. versionadded:: 3.3 + Species a list of shortcut names that should be created in the `Start Menu` for this file. diff --git a/Help/prop_inst/CPACK_WIX_ACL.rst b/Help/prop_inst/CPACK_WIX_ACL.rst index c88f426..8b4fb5c 100644 --- a/Help/prop_inst/CPACK_WIX_ACL.rst +++ b/Help/prop_inst/CPACK_WIX_ACL.rst @@ -1,6 +1,8 @@ CPACK_WIX_ACL ------------- +.. versionadded:: 3.1 + Specifies access permissions for files or directories installed by a WiX installer. diff --git a/Help/prop_sf/COMPILE_OPTIONS.rst b/Help/prop_sf/COMPILE_OPTIONS.rst index 537dcec..a694c3e 100644 --- a/Help/prop_sf/COMPILE_OPTIONS.rst +++ b/Help/prop_sf/COMPILE_OPTIONS.rst @@ -1,6 +1,8 @@ COMPILE_OPTIONS --------------- +.. versionadded:: 3.11 + List of additional options to pass to the compiler. This property holds a :ref:`semicolon-separated list <CMake Language Lists>` of options diff --git a/Help/prop_sf/Fortran_PREPROCESS.rst b/Help/prop_sf/Fortran_PREPROCESS.rst index 25ea827..548a97b 100644 --- a/Help/prop_sf/Fortran_PREPROCESS.rst +++ b/Help/prop_sf/Fortran_PREPROCESS.rst @@ -1,6 +1,8 @@ Fortran_PREPROCESS ------------------ +.. versionadded:: 3.18 + Control whether the Fortran source file should be unconditionally preprocessed. If unset or empty, rely on the compiler to determine whether the file diff --git a/Help/prop_sf/INCLUDE_DIRECTORIES.rst b/Help/prop_sf/INCLUDE_DIRECTORIES.rst index 23de70e..89ffd15 100644 --- a/Help/prop_sf/INCLUDE_DIRECTORIES.rst +++ b/Help/prop_sf/INCLUDE_DIRECTORIES.rst @@ -1,6 +1,8 @@ INCLUDE_DIRECTORIES ------------------- +.. versionadded:: 3.11 + List of preprocessor include file search directories. This property holds a :ref:`semicolon-separated list <CMake Language Lists>` of paths diff --git a/Help/prop_sf/SKIP_AUTOGEN.rst b/Help/prop_sf/SKIP_AUTOGEN.rst index f31185a..2173f59 100644 --- a/Help/prop_sf/SKIP_AUTOGEN.rst +++ b/Help/prop_sf/SKIP_AUTOGEN.rst @@ -1,6 +1,8 @@ SKIP_AUTOGEN ------------ +.. versionadded:: 3.8 + Exclude the source file from :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` processing (for Qt projects). diff --git a/Help/prop_sf/SKIP_AUTOMOC.rst b/Help/prop_sf/SKIP_AUTOMOC.rst index a929448..e92cfe0 100644 --- a/Help/prop_sf/SKIP_AUTOMOC.rst +++ b/Help/prop_sf/SKIP_AUTOMOC.rst @@ -1,6 +1,8 @@ SKIP_AUTOMOC ------------ +.. versionadded:: 3.8 + Exclude the source file from :prop_tgt:`AUTOMOC` processing (for Qt projects). For broader exclusion control see :prop_sf:`SKIP_AUTOGEN`. diff --git a/Help/prop_sf/SKIP_AUTORCC.rst b/Help/prop_sf/SKIP_AUTORCC.rst index bccccfc..2829c25 100644 --- a/Help/prop_sf/SKIP_AUTORCC.rst +++ b/Help/prop_sf/SKIP_AUTORCC.rst @@ -1,6 +1,8 @@ SKIP_AUTORCC ------------ +.. versionadded:: 3.8 + Exclude the source file from :prop_tgt:`AUTORCC` processing (for Qt projects). For broader exclusion control see :prop_sf:`SKIP_AUTOGEN`. diff --git a/Help/prop_sf/SKIP_AUTOUIC.rst b/Help/prop_sf/SKIP_AUTOUIC.rst index 8c962db..ae9725a 100644 --- a/Help/prop_sf/SKIP_AUTOUIC.rst +++ b/Help/prop_sf/SKIP_AUTOUIC.rst @@ -1,6 +1,8 @@ SKIP_AUTOUIC ------------ +.. versionadded:: 3.8 + 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 diff --git a/Help/prop_sf/SKIP_PRECOMPILE_HEADERS.rst b/Help/prop_sf/SKIP_PRECOMPILE_HEADERS.rst index 0031da3..660de3f 100644 --- a/Help/prop_sf/SKIP_PRECOMPILE_HEADERS.rst +++ b/Help/prop_sf/SKIP_PRECOMPILE_HEADERS.rst @@ -1,6 +1,8 @@ SKIP_PRECOMPILE_HEADERS ----------------------- +.. versionadded:: 3.16 + Is this source file skipped by :prop_tgt:`PRECOMPILE_HEADERS` feature. This property helps with build problems that one would run into diff --git a/Help/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst b/Help/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst index 6d1e60d..ae526ac 100644 --- a/Help/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst +++ b/Help/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst @@ -1,6 +1,8 @@ SKIP_UNITY_BUILD_INCLUSION -------------------------- +.. versionadded:: 3.16 + Setting this property to true ensures the source file will be skipped by unity builds when its associated target has its :prop_tgt:`UNITY_BUILD` property set to true. The source file will instead be compiled on its own diff --git a/Help/prop_sf/Swift_DEPENDENCIES_FILE.rst b/Help/prop_sf/Swift_DEPENDENCIES_FILE.rst index faac2df..a90c7eb 100644 --- a/Help/prop_sf/Swift_DEPENDENCIES_FILE.rst +++ b/Help/prop_sf/Swift_DEPENDENCIES_FILE.rst @@ -1,5 +1,7 @@ Swift_DEPENDENCIES_FILE ----------------------- +.. versionadded:: 3.15 + This property sets the path for the Swift dependency file (swiftdeps) for the source. If one is not specified, it will default to ``<OBJECT>.swiftdeps``. diff --git a/Help/prop_sf/Swift_DIAGNOSTICS_FILE.rst b/Help/prop_sf/Swift_DIAGNOSTICS_FILE.rst index 5bf5d59..47d5ac3 100644 --- a/Help/prop_sf/Swift_DIAGNOSTICS_FILE.rst +++ b/Help/prop_sf/Swift_DIAGNOSTICS_FILE.rst @@ -1,4 +1,6 @@ Swift_DIAGNOSTICS_FILE ---------------------- +.. versionadded:: 3.15 + This property controls where the Swift diagnostics are serialized. diff --git a/Help/prop_sf/UNITY_GROUP.rst b/Help/prop_sf/UNITY_GROUP.rst index ec6b0f6..9c18b70 100644 --- a/Help/prop_sf/UNITY_GROUP.rst +++ b/Help/prop_sf/UNITY_GROUP.rst @@ -1,5 +1,7 @@ UNITY_GROUP ----------- +.. versionadded:: 3.18 + This property controls which *bucket* the source will be part of when the :prop_tgt:`UNITY_BUILD_MODE` is set to ``GROUP``. diff --git a/Help/prop_sf/VS_COPY_TO_OUT_DIR.rst b/Help/prop_sf/VS_COPY_TO_OUT_DIR.rst index 16c8d83..ebc3061 100644 --- a/Help/prop_sf/VS_COPY_TO_OUT_DIR.rst +++ b/Help/prop_sf/VS_COPY_TO_OUT_DIR.rst @@ -1,6 +1,8 @@ VS_COPY_TO_OUT_DIR ------------------ +.. versionadded:: 3.8 + Sets the ``<CopyToOutputDirectory>`` tag for a source file in a Visual Studio project file. Valid values are ``Never``, ``Always`` and ``PreserveNewest``. diff --git a/Help/prop_sf/VS_CSHARP_tagname.rst b/Help/prop_sf/VS_CSHARP_tagname.rst index 91c4a06..75720f8 100644 --- a/Help/prop_sf/VS_CSHARP_tagname.rst +++ b/Help/prop_sf/VS_CSHARP_tagname.rst @@ -1,6 +1,8 @@ VS_CSHARP_<tagname> ------------------- +.. versionadded:: 3.8 + Visual Studio and CSharp source-file-specific configuration. Tell the :manual:`Visual Studio generators <cmake-generators(7)>` diff --git a/Help/prop_sf/VS_DEPLOYMENT_CONTENT.rst b/Help/prop_sf/VS_DEPLOYMENT_CONTENT.rst index 6a38478..ee49b27 100644 --- a/Help/prop_sf/VS_DEPLOYMENT_CONTENT.rst +++ b/Help/prop_sf/VS_DEPLOYMENT_CONTENT.rst @@ -1,6 +1,8 @@ VS_DEPLOYMENT_CONTENT --------------------- +.. versionadded:: 3.1 + Mark a source file as content for deployment with a Windows Phone or Windows Store application when built with a :manual:`Visual Studio generators <cmake-generators(7)>`. diff --git a/Help/prop_sf/VS_DEPLOYMENT_LOCATION.rst b/Help/prop_sf/VS_DEPLOYMENT_LOCATION.rst index 2ce22fc..b170544 100644 --- a/Help/prop_sf/VS_DEPLOYMENT_LOCATION.rst +++ b/Help/prop_sf/VS_DEPLOYMENT_LOCATION.rst @@ -1,6 +1,8 @@ VS_DEPLOYMENT_LOCATION ---------------------- +.. versionadded:: 3.1 + Specifies the deployment location for a content source file with a Windows Phone or Windows Store application when built with a :manual:`Visual Studio generators <cmake-generators(7)>`. diff --git a/Help/prop_sf/VS_INCLUDE_IN_VSIX.rst b/Help/prop_sf/VS_INCLUDE_IN_VSIX.rst index db470ef..16c56bf 100644 --- a/Help/prop_sf/VS_INCLUDE_IN_VSIX.rst +++ b/Help/prop_sf/VS_INCLUDE_IN_VSIX.rst @@ -1,6 +1,8 @@ VS_INCLUDE_IN_VSIX ------------------ +.. versionadded:: 3.8 + Boolean property to specify if the file should be included within a VSIX (Visual Studio Integration Extension) extension package. This is needed for development of Visual Studio extensions. diff --git a/Help/prop_sf/VS_RESOURCE_GENERATOR.rst b/Help/prop_sf/VS_RESOURCE_GENERATOR.rst index 97e5aac..c5bb4f6 100644 --- a/Help/prop_sf/VS_RESOURCE_GENERATOR.rst +++ b/Help/prop_sf/VS_RESOURCE_GENERATOR.rst @@ -1,6 +1,8 @@ VS_RESOURCE_GENERATOR --------------------- +.. versionadded:: 3.8 + This property allows to specify the resource generator to be used on this file. It defaults to ``PublicResXFileCodeGenerator`` if not set. diff --git a/Help/prop_sf/VS_SETTINGS.rst b/Help/prop_sf/VS_SETTINGS.rst index 50034fb..322f5a6 100644 --- a/Help/prop_sf/VS_SETTINGS.rst +++ b/Help/prop_sf/VS_SETTINGS.rst @@ -1,6 +1,8 @@ VS_SETTINGS ----------- +.. versionadded:: 3.18 + Set any item metadata on a non-built file. Takes a list of ``Key=Value`` pairs. Tells the Visual Studio generator to set diff --git a/Help/prop_sf/VS_SHADER_DISABLE_OPTIMIZATIONS.rst b/Help/prop_sf/VS_SHADER_DISABLE_OPTIMIZATIONS.rst index 446dd26..6fb6778 100644 --- a/Help/prop_sf/VS_SHADER_DISABLE_OPTIMIZATIONS.rst +++ b/Help/prop_sf/VS_SHADER_DISABLE_OPTIMIZATIONS.rst @@ -1,6 +1,8 @@ VS_SHADER_DISABLE_OPTIMIZATIONS ------------------------------- +.. versionadded:: 3.11 + Disable compiler optimizations for an ``.hlsl`` source file. This adds the ``-Od`` flag to the command line for the FxCompiler tool. Specify the value ``true`` for this property to disable compiler optimizations. diff --git a/Help/prop_sf/VS_SHADER_ENABLE_DEBUG.rst b/Help/prop_sf/VS_SHADER_ENABLE_DEBUG.rst index c0e60a3..9c8f9d7 100644 --- a/Help/prop_sf/VS_SHADER_ENABLE_DEBUG.rst +++ b/Help/prop_sf/VS_SHADER_ENABLE_DEBUG.rst @@ -1,6 +1,8 @@ VS_SHADER_ENABLE_DEBUG ---------------------- +.. versionadded:: 3.11 + Enable debugging information for an ``.hlsl`` source file. This adds the ``-Zi`` flag to the command line for the FxCompiler tool. Specify the value ``true`` to generate debugging information for the compiled shader. diff --git a/Help/prop_sf/VS_SHADER_ENTRYPOINT.rst b/Help/prop_sf/VS_SHADER_ENTRYPOINT.rst index fe3471f..4b311ba 100644 --- a/Help/prop_sf/VS_SHADER_ENTRYPOINT.rst +++ b/Help/prop_sf/VS_SHADER_ENTRYPOINT.rst @@ -1,5 +1,7 @@ VS_SHADER_ENTRYPOINT -------------------- +.. versionadded:: 3.1 + Specifies the name of the entry point for the shader of a ``.hlsl`` source file. diff --git a/Help/prop_sf/VS_SHADER_FLAGS.rst b/Help/prop_sf/VS_SHADER_FLAGS.rst index 0a53afd..07f8497 100644 --- a/Help/prop_sf/VS_SHADER_FLAGS.rst +++ b/Help/prop_sf/VS_SHADER_FLAGS.rst @@ -1,4 +1,6 @@ VS_SHADER_FLAGS --------------- +.. versionadded:: 3.2 + Set additional Visual Studio shader flags of a ``.hlsl`` source file. diff --git a/Help/prop_sf/VS_SHADER_MODEL.rst b/Help/prop_sf/VS_SHADER_MODEL.rst index b1cf0df..072df89 100644 --- a/Help/prop_sf/VS_SHADER_MODEL.rst +++ b/Help/prop_sf/VS_SHADER_MODEL.rst @@ -1,5 +1,7 @@ VS_SHADER_MODEL --------------- +.. versionadded:: 3.1 + Specifies the shader model of a ``.hlsl`` source file. Some shader types can only be used with recent shader models diff --git a/Help/prop_sf/VS_SHADER_OBJECT_FILE_NAME.rst b/Help/prop_sf/VS_SHADER_OBJECT_FILE_NAME.rst index 093bcc6..3647a5e 100644 --- a/Help/prop_sf/VS_SHADER_OBJECT_FILE_NAME.rst +++ b/Help/prop_sf/VS_SHADER_OBJECT_FILE_NAME.rst @@ -1,6 +1,8 @@ VS_SHADER_OBJECT_FILE_NAME -------------------------- +.. versionadded:: 3.12 + Specifies a file name for the compiled shader object file for an ``.hlsl`` source file. This adds the ``-Fo`` flag to the command line for the FxCompiler tool. diff --git a/Help/prop_sf/VS_SHADER_OUTPUT_HEADER_FILE.rst b/Help/prop_sf/VS_SHADER_OUTPUT_HEADER_FILE.rst index e6763d3..4113a16 100644 --- a/Help/prop_sf/VS_SHADER_OUTPUT_HEADER_FILE.rst +++ b/Help/prop_sf/VS_SHADER_OUTPUT_HEADER_FILE.rst @@ -1,5 +1,7 @@ VS_SHADER_OUTPUT_HEADER_FILE ---------------------------- +.. versionadded:: 3.10 + Set filename for output header file containing object code of a ``.hlsl`` source file. diff --git a/Help/prop_sf/VS_SHADER_TYPE.rst b/Help/prop_sf/VS_SHADER_TYPE.rst index f104837..3fb7e60 100644 --- a/Help/prop_sf/VS_SHADER_TYPE.rst +++ b/Help/prop_sf/VS_SHADER_TYPE.rst @@ -1,4 +1,6 @@ VS_SHADER_TYPE -------------- +.. versionadded:: 3.1 + Set the Visual Studio shader type of a ``.hlsl`` source file. diff --git a/Help/prop_sf/VS_SHADER_VARIABLE_NAME.rst b/Help/prop_sf/VS_SHADER_VARIABLE_NAME.rst index 1a5e369..3361b40 100644 --- a/Help/prop_sf/VS_SHADER_VARIABLE_NAME.rst +++ b/Help/prop_sf/VS_SHADER_VARIABLE_NAME.rst @@ -1,5 +1,7 @@ VS_SHADER_VARIABLE_NAME ----------------------- +.. versionadded:: 3.10 + Set name of variable in header file containing object code of a ``.hlsl`` source file. diff --git a/Help/prop_sf/VS_TOOL_OVERRIDE.rst b/Help/prop_sf/VS_TOOL_OVERRIDE.rst index 8bdc5ca..b2f4112 100644 --- a/Help/prop_sf/VS_TOOL_OVERRIDE.rst +++ b/Help/prop_sf/VS_TOOL_OVERRIDE.rst @@ -1,5 +1,7 @@ VS_TOOL_OVERRIDE ---------------- +.. versionadded:: 3.7 + Override the default Visual Studio tool that will be applied to the source file with a new tool not based on the extension of the file. diff --git a/Help/prop_sf/VS_XAML_TYPE.rst b/Help/prop_sf/VS_XAML_TYPE.rst index 1a274ba..612b07b 100644 --- a/Help/prop_sf/VS_XAML_TYPE.rst +++ b/Help/prop_sf/VS_XAML_TYPE.rst @@ -1,6 +1,8 @@ VS_XAML_TYPE ------------ +.. versionadded:: 3.3 + Mark a Extensible Application Markup Language (XAML) source file as a different type than the default ``Page``. The most common usage would be to set the default ``App.xaml`` file as diff --git a/Help/prop_sf/XCODE_EXPLICIT_FILE_TYPE.rst b/Help/prop_sf/XCODE_EXPLICIT_FILE_TYPE.rst index b8cf946..5a50d7d 100644 --- a/Help/prop_sf/XCODE_EXPLICIT_FILE_TYPE.rst +++ b/Help/prop_sf/XCODE_EXPLICIT_FILE_TYPE.rst @@ -1,6 +1,8 @@ XCODE_EXPLICIT_FILE_TYPE ------------------------ +.. versionadded:: 3.1 + Set the :generator:`Xcode` ``explicitFileType`` attribute on its reference to a source file. CMake computes a default based on file extension but can be told explicitly with this property. diff --git a/Help/prop_sf/XCODE_FILE_ATTRIBUTES.rst b/Help/prop_sf/XCODE_FILE_ATTRIBUTES.rst index 4c93f44..ba51e00 100644 --- a/Help/prop_sf/XCODE_FILE_ATTRIBUTES.rst +++ b/Help/prop_sf/XCODE_FILE_ATTRIBUTES.rst @@ -1,6 +1,8 @@ XCODE_FILE_ATTRIBUTES --------------------- +.. versionadded:: 3.7 + Add values to the :generator:`Xcode` ``ATTRIBUTES`` setting on its reference to a source file. Among other things, this can be used to set the role on a ``.mig`` file:: diff --git a/Help/prop_sf/XCODE_LAST_KNOWN_FILE_TYPE.rst b/Help/prop_sf/XCODE_LAST_KNOWN_FILE_TYPE.rst index b21891f..0b84e31 100644 --- a/Help/prop_sf/XCODE_LAST_KNOWN_FILE_TYPE.rst +++ b/Help/prop_sf/XCODE_LAST_KNOWN_FILE_TYPE.rst @@ -1,6 +1,8 @@ XCODE_LAST_KNOWN_FILE_TYPE -------------------------- +.. versionadded:: 3.1 + Set the :generator:`Xcode` ``lastKnownFileType`` attribute on its reference to a source file. CMake computes a default based on file extension but can be told explicitly with this property. diff --git a/Help/prop_test/DISABLED.rst b/Help/prop_test/DISABLED.rst index 1d469e8..cbf07a5 100644 --- a/Help/prop_test/DISABLED.rst +++ b/Help/prop_test/DISABLED.rst @@ -1,6 +1,8 @@ DISABLED -------- +.. versionadded:: 3.9 + If set to ``True``, the test will be skipped and its status will be 'Not Run'. A ``DISABLED`` test will not be counted in the total number of tests and its completion status will be reported to CDash as ``Disabled``. diff --git a/Help/prop_test/FIXTURES_CLEANUP.rst b/Help/prop_test/FIXTURES_CLEANUP.rst index 3075b4d..aa043da 100644 --- a/Help/prop_test/FIXTURES_CLEANUP.rst +++ b/Help/prop_test/FIXTURES_CLEANUP.rst @@ -1,6 +1,8 @@ FIXTURES_CLEANUP ---------------- +.. versionadded:: 3.7 + Specifies a list of fixtures for which the test is to be treated as a cleanup test. These fixture names are distinct from test case names and are not required to have any similarity to the names of tests associated with them. diff --git a/Help/prop_test/FIXTURES_REQUIRED.rst b/Help/prop_test/FIXTURES_REQUIRED.rst index e3f60c4..d92808a 100644 --- a/Help/prop_test/FIXTURES_REQUIRED.rst +++ b/Help/prop_test/FIXTURES_REQUIRED.rst @@ -1,6 +1,8 @@ FIXTURES_REQUIRED ----------------- +.. versionadded:: 3.7 + Specifies a list of fixtures the test requires. Fixture names are case sensitive and they are not required to have any similarity to test names. diff --git a/Help/prop_test/FIXTURES_SETUP.rst b/Help/prop_test/FIXTURES_SETUP.rst index fdb21cc..04a09d8 100644 --- a/Help/prop_test/FIXTURES_SETUP.rst +++ b/Help/prop_test/FIXTURES_SETUP.rst @@ -1,6 +1,8 @@ FIXTURES_SETUP -------------- +.. versionadded:: 3.7 + Specifies a list of fixtures for which the test is to be treated as a setup test. These fixture names are distinct from test case names and are not required to have any similarity to the names of tests associated with them. diff --git a/Help/prop_test/PROCESSOR_AFFINITY.rst b/Help/prop_test/PROCESSOR_AFFINITY.rst index 38ec179..f48a69c 100644 --- a/Help/prop_test/PROCESSOR_AFFINITY.rst +++ b/Help/prop_test/PROCESSOR_AFFINITY.rst @@ -1,6 +1,8 @@ PROCESSOR_AFFINITY ------------------ +.. versionadded:: 3.12 + Set to a true value to ask CTest to launch the test process with CPU affinity for a fixed set of processors. If enabled and supported for the current platform, CTest will choose a set of processors to place in the CPU affinity diff --git a/Help/prop_test/RESOURCE_GROUPS.rst b/Help/prop_test/RESOURCE_GROUPS.rst index 63c56ce..26c8fa2 100644 --- a/Help/prop_test/RESOURCE_GROUPS.rst +++ b/Help/prop_test/RESOURCE_GROUPS.rst @@ -1,6 +1,8 @@ RESOURCE_GROUPS --------------- +.. versionadded:: 3.16 + Specify resources required by a test, grouped in a way that is meaningful to the test. See :ref:`resource allocation <ctest-resource-allocation>` for more information on how this property integrates into the CTest resource diff --git a/Help/prop_test/SKIP_REGULAR_EXPRESSION.rst b/Help/prop_test/SKIP_REGULAR_EXPRESSION.rst index 2c6d980..46c4363 100644 --- a/Help/prop_test/SKIP_REGULAR_EXPRESSION.rst +++ b/Help/prop_test/SKIP_REGULAR_EXPRESSION.rst @@ -1,6 +1,8 @@ SKIP_REGULAR_EXPRESSION ----------------------- +.. versionadded:: 3.16 + If the output matches this regular expression the test will be marked as skipped. If set, if the output matches one of specified regular expressions, diff --git a/Help/prop_test/TIMEOUT_AFTER_MATCH.rst b/Help/prop_test/TIMEOUT_AFTER_MATCH.rst index d607992..726dcab 100644 --- a/Help/prop_test/TIMEOUT_AFTER_MATCH.rst +++ b/Help/prop_test/TIMEOUT_AFTER_MATCH.rst @@ -1,6 +1,8 @@ TIMEOUT_AFTER_MATCH ------------------- +.. versionadded:: 3.6 + Change a test's timeout duration after a matching line is encountered in its output. diff --git a/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst b/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst index 3b9d965..dc87d23 100644 --- a/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst +++ b/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst @@ -1,6 +1,8 @@ ADDITIONAL_CLEAN_FILES ---------------------- +.. versionadded:: 3.15 + A :ref:`;-list <CMake Language Lists>` of files or directories that will be removed as a part of the global ``clean`` target. It can be used to specify files and directories that are generated as part of building the target or diff --git a/Help/prop_tgt/AIX_EXPORT_ALL_SYMBOLS.rst b/Help/prop_tgt/AIX_EXPORT_ALL_SYMBOLS.rst index 15ddc0b..de98fdf 100644 --- a/Help/prop_tgt/AIX_EXPORT_ALL_SYMBOLS.rst +++ b/Help/prop_tgt/AIX_EXPORT_ALL_SYMBOLS.rst @@ -1,6 +1,8 @@ AIX_EXPORT_ALL_SYMBOLS ---------------------- +.. versionadded:: 3.17 + On AIX, CMake automatically exports all symbols from shared libraries, and from executables with the :prop_tgt:`ENABLE_EXPORTS` target property set. Explicitly disable this boolean property to suppress the behavior and diff --git a/Help/prop_tgt/ALIAS_GLOBAL.rst b/Help/prop_tgt/ALIAS_GLOBAL.rst index 8854f57..a8859c6 100644 --- a/Help/prop_tgt/ALIAS_GLOBAL.rst +++ b/Help/prop_tgt/ALIAS_GLOBAL.rst @@ -1,6 +1,8 @@ ALIAS_GLOBAL ------------ +.. versionadded:: 3.18 + Read-only property indicating of whether an :ref:`ALIAS target <Alias Targets>` is globally visible. diff --git a/Help/prop_tgt/ANDROID_ANT_ADDITIONAL_OPTIONS.rst b/Help/prop_tgt/ANDROID_ANT_ADDITIONAL_OPTIONS.rst index af6b405..eceb17d 100644 --- a/Help/prop_tgt/ANDROID_ANT_ADDITIONAL_OPTIONS.rst +++ b/Help/prop_tgt/ANDROID_ANT_ADDITIONAL_OPTIONS.rst @@ -1,6 +1,8 @@ ANDROID_ANT_ADDITIONAL_OPTIONS ------------------------------ +.. versionadded:: 3.4 + Set the additional options for Android Ant build system. This is a string value containing all command line options for the Ant build. This property is initialized by the value of the diff --git a/Help/prop_tgt/ANDROID_API.rst b/Help/prop_tgt/ANDROID_API.rst index 63464d7..7664f18 100644 --- a/Help/prop_tgt/ANDROID_API.rst +++ b/Help/prop_tgt/ANDROID_API.rst @@ -1,6 +1,8 @@ ANDROID_API ----------- +.. versionadded:: 3.1 + When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition`, this property sets the Android target API version (e.g. ``15``). The version number must be a positive decimal integer. This property is diff --git a/Help/prop_tgt/ANDROID_API_MIN.rst b/Help/prop_tgt/ANDROID_API_MIN.rst index 773ab3f..7ca2455 100644 --- a/Help/prop_tgt/ANDROID_API_MIN.rst +++ b/Help/prop_tgt/ANDROID_API_MIN.rst @@ -1,6 +1,8 @@ ANDROID_API_MIN --------------- +.. versionadded:: 3.2 + Set the Android MIN API version (e.g. ``9``). The version number must be a positive decimal integer. This property is initialized by the value of the :variable:`CMAKE_ANDROID_API_MIN` variable if it is set diff --git a/Help/prop_tgt/ANDROID_ARCH.rst b/Help/prop_tgt/ANDROID_ARCH.rst index 3e07e5a..94b76dd 100644 --- a/Help/prop_tgt/ANDROID_ARCH.rst +++ b/Help/prop_tgt/ANDROID_ARCH.rst @@ -1,6 +1,8 @@ ANDROID_ARCH ------------ +.. versionadded:: 3.4 + When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition`, this property sets the Android target architecture. diff --git a/Help/prop_tgt/ANDROID_ASSETS_DIRECTORIES.rst b/Help/prop_tgt/ANDROID_ASSETS_DIRECTORIES.rst index 764a582..b09a8b7 100644 --- a/Help/prop_tgt/ANDROID_ASSETS_DIRECTORIES.rst +++ b/Help/prop_tgt/ANDROID_ASSETS_DIRECTORIES.rst @@ -1,6 +1,8 @@ ANDROID_ASSETS_DIRECTORIES -------------------------- +.. versionadded:: 3.4 + Set the Android assets directories to copy into the main assets folder before build. This a string property that contains the directory paths separated by semicolon. diff --git a/Help/prop_tgt/ANDROID_GUI.rst b/Help/prop_tgt/ANDROID_GUI.rst index 92e2041..cc022db 100644 --- a/Help/prop_tgt/ANDROID_GUI.rst +++ b/Help/prop_tgt/ANDROID_GUI.rst @@ -1,6 +1,8 @@ ANDROID_GUI ----------- +.. versionadded:: 3.1 + When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition`, this property specifies whether to build an executable as an application package on Android. diff --git a/Help/prop_tgt/ANDROID_JAR_DEPENDENCIES.rst b/Help/prop_tgt/ANDROID_JAR_DEPENDENCIES.rst index 42937c1..9880daf 100644 --- a/Help/prop_tgt/ANDROID_JAR_DEPENDENCIES.rst +++ b/Help/prop_tgt/ANDROID_JAR_DEPENDENCIES.rst @@ -1,6 +1,8 @@ ANDROID_JAR_DEPENDENCIES ------------------------ +.. versionadded:: 3.4 + Set the Android property that specifies JAR dependencies. This is a string value property. This property is initialized by the value of the :variable:`CMAKE_ANDROID_JAR_DEPENDENCIES` diff --git a/Help/prop_tgt/ANDROID_JAR_DIRECTORIES.rst b/Help/prop_tgt/ANDROID_JAR_DIRECTORIES.rst index 54f0a8f..6fef50b 100644 --- a/Help/prop_tgt/ANDROID_JAR_DIRECTORIES.rst +++ b/Help/prop_tgt/ANDROID_JAR_DIRECTORIES.rst @@ -1,6 +1,8 @@ ANDROID_JAR_DIRECTORIES ----------------------- +.. versionadded:: 3.4 + Set the Android property that specifies directories to search for the JAR libraries. diff --git a/Help/prop_tgt/ANDROID_JAVA_SOURCE_DIR.rst b/Help/prop_tgt/ANDROID_JAVA_SOURCE_DIR.rst index 90ef1ce..9ea9884 100644 --- a/Help/prop_tgt/ANDROID_JAVA_SOURCE_DIR.rst +++ b/Help/prop_tgt/ANDROID_JAVA_SOURCE_DIR.rst @@ -1,6 +1,8 @@ ANDROID_JAVA_SOURCE_DIR ----------------------- +.. versionadded:: 3.4 + Set the Android property that defines the Java source code root directories. This a string property that contains the directory paths separated by semicolon. This property is initialized by the value of the diff --git a/Help/prop_tgt/ANDROID_NATIVE_LIB_DEPENDENCIES.rst b/Help/prop_tgt/ANDROID_NATIVE_LIB_DEPENDENCIES.rst index 759a37b..3aa741f 100644 --- a/Help/prop_tgt/ANDROID_NATIVE_LIB_DEPENDENCIES.rst +++ b/Help/prop_tgt/ANDROID_NATIVE_LIB_DEPENDENCIES.rst @@ -1,6 +1,8 @@ ANDROID_NATIVE_LIB_DEPENDENCIES ------------------------------- +.. versionadded:: 3.4 + Set the Android property that specifies the .so dependencies. This is a string property. diff --git a/Help/prop_tgt/ANDROID_NATIVE_LIB_DIRECTORIES.rst b/Help/prop_tgt/ANDROID_NATIVE_LIB_DIRECTORIES.rst index d0cd29d..98200d9 100644 --- a/Help/prop_tgt/ANDROID_NATIVE_LIB_DIRECTORIES.rst +++ b/Help/prop_tgt/ANDROID_NATIVE_LIB_DIRECTORIES.rst @@ -1,6 +1,8 @@ ANDROID_NATIVE_LIB_DIRECTORIES ------------------------------ +.. versionadded:: 3.4 + Set the Android property that specifies directories to search for the ``.so`` libraries. diff --git a/Help/prop_tgt/ANDROID_PROCESS_MAX.rst b/Help/prop_tgt/ANDROID_PROCESS_MAX.rst index 847acae..0b6aba7 100644 --- a/Help/prop_tgt/ANDROID_PROCESS_MAX.rst +++ b/Help/prop_tgt/ANDROID_PROCESS_MAX.rst @@ -1,6 +1,8 @@ ANDROID_PROCESS_MAX ------------------- +.. versionadded:: 3.4 + Set the Android property that defines the maximum number of a parallel Android NDK compiler processes (e.g. ``4``). This property is initialized by the value of the diff --git a/Help/prop_tgt/ANDROID_PROGUARD.rst b/Help/prop_tgt/ANDROID_PROGUARD.rst index dafc51e..b5ce166 100644 --- a/Help/prop_tgt/ANDROID_PROGUARD.rst +++ b/Help/prop_tgt/ANDROID_PROGUARD.rst @@ -1,6 +1,8 @@ ANDROID_PROGUARD ---------------- +.. versionadded:: 3.4 + When this property is set to true that enables the ProGuard tool to shrink, optimize, and obfuscate the code by removing unused code and renaming classes, fields, and methods with semantically obscure names. diff --git a/Help/prop_tgt/ANDROID_PROGUARD_CONFIG_PATH.rst b/Help/prop_tgt/ANDROID_PROGUARD_CONFIG_PATH.rst index 0e929d1..6ac59d8 100644 --- a/Help/prop_tgt/ANDROID_PROGUARD_CONFIG_PATH.rst +++ b/Help/prop_tgt/ANDROID_PROGUARD_CONFIG_PATH.rst @@ -1,6 +1,8 @@ ANDROID_PROGUARD_CONFIG_PATH ---------------------------- +.. versionadded:: 3.4 + Set the Android property that specifies the location of the ProGuard config file. Leave empty to use the default one. This a string property that contains the path to ProGuard config file. diff --git a/Help/prop_tgt/ANDROID_SECURE_PROPS_PATH.rst b/Help/prop_tgt/ANDROID_SECURE_PROPS_PATH.rst index 9533f1a..f2ffa2e 100644 --- a/Help/prop_tgt/ANDROID_SECURE_PROPS_PATH.rst +++ b/Help/prop_tgt/ANDROID_SECURE_PROPS_PATH.rst @@ -1,6 +1,8 @@ ANDROID_SECURE_PROPS_PATH ------------------------- +.. versionadded:: 3.4 + Set the Android property that states the location of the secure properties file. This is a string property that contains the file path. This property is initialized by the value of the diff --git a/Help/prop_tgt/ANDROID_SKIP_ANT_STEP.rst b/Help/prop_tgt/ANDROID_SKIP_ANT_STEP.rst index 6361896..1a54bce 100644 --- a/Help/prop_tgt/ANDROID_SKIP_ANT_STEP.rst +++ b/Help/prop_tgt/ANDROID_SKIP_ANT_STEP.rst @@ -1,6 +1,8 @@ ANDROID_SKIP_ANT_STEP --------------------- +.. versionadded:: 3.4 + Set the Android property that defines whether or not to skip the Ant build step. This is a boolean property initialized by the value of the :variable:`CMAKE_ANDROID_SKIP_ANT_STEP` variable if it is set when a target is created. diff --git a/Help/prop_tgt/ANDROID_STL_TYPE.rst b/Help/prop_tgt/ANDROID_STL_TYPE.rst index 386e96e..c83712b 100644 --- a/Help/prop_tgt/ANDROID_STL_TYPE.rst +++ b/Help/prop_tgt/ANDROID_STL_TYPE.rst @@ -1,6 +1,8 @@ ANDROID_STL_TYPE ---------------- +.. versionadded:: 3.4 + When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition`, this property specifies the type of STL support for the project. This is a string property that could set to the one of the following values: diff --git a/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst b/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst index 909b14c..ff42ae8 100644 --- a/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst +++ b/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst @@ -1,6 +1,8 @@ AUTOGEN_BUILD_DIR ----------------- +.. versionadded:: 3.9 + Directory where :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` generate files for the target. diff --git a/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst b/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst index 022bab5..563190a 100644 --- a/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst +++ b/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst @@ -1,6 +1,8 @@ AUTOGEN_ORIGIN_DEPENDS ---------------------- +.. versionadded:: 3.14 + Switch for forwarding origin target dependencies to the corresponding ``_autogen`` target. diff --git a/Help/prop_tgt/AUTOGEN_PARALLEL.rst b/Help/prop_tgt/AUTOGEN_PARALLEL.rst index 968b619..663b54e 100644 --- a/Help/prop_tgt/AUTOGEN_PARALLEL.rst +++ b/Help/prop_tgt/AUTOGEN_PARALLEL.rst @@ -1,6 +1,8 @@ AUTOGEN_PARALLEL ---------------- +.. versionadded:: 3.11 + Number of parallel ``moc`` or ``uic`` processes to start when using :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`. diff --git a/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst b/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst index 57a647f..8998284 100644 --- a/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst +++ b/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst @@ -1,6 +1,8 @@ AUTOMOC_COMPILER_PREDEFINES --------------------------- +.. versionadded:: 3.10 + Boolean value used by :prop_tgt:`AUTOMOC` to determine if the compiler pre definitions file ``moc_predefs.h`` should be generated. diff --git a/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst b/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst index 6eda26c..1f31700 100644 --- a/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst +++ b/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst @@ -1,6 +1,8 @@ AUTOMOC_DEPEND_FILTERS ---------------------- +.. versionadded:: 3.9 + Filter definitions used by :prop_tgt:`AUTOMOC` to extract file names from a source file that are registered as additional dependencies for the ``moc`` file of the source file. diff --git a/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst b/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst index 6b66ce8..f4b8396 100644 --- a/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst +++ b/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst @@ -1,6 +1,8 @@ AUTOMOC_EXECUTABLE ------------------ +.. versionadded:: 3.14 + :prop_tgt:`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 diff --git a/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst b/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst index 5329bba..a53810d 100644 --- a/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst +++ b/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst @@ -1,6 +1,8 @@ AUTOMOC_MACRO_NAMES ------------------- +.. versionadded:: 3.10 + A :ref:`semicolon-separated list <CMake Language Lists>` list of macro names used by :prop_tgt:`AUTOMOC` to determine if a C++ file needs to be processed by ``moc``. diff --git a/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst b/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst index 5ed504f..836d953 100644 --- a/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst +++ b/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst @@ -1,6 +1,8 @@ AUTOMOC_PATH_PREFIX ------------------- +.. versionadded:: 3.16 + When this property is ``ON``, CMake will generate the ``-p`` path prefix option for ``moc`` on :prop_tgt:`AUTOMOC` enabled Qt targets. diff --git a/Help/prop_tgt/AUTORCC_EXECUTABLE.rst b/Help/prop_tgt/AUTORCC_EXECUTABLE.rst index ca0fbd7..4f85fba 100644 --- a/Help/prop_tgt/AUTORCC_EXECUTABLE.rst +++ b/Help/prop_tgt/AUTORCC_EXECUTABLE.rst @@ -1,6 +1,8 @@ AUTORCC_EXECUTABLE ------------------ +.. versionadded:: 3.14 + :prop_tgt:`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 diff --git a/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst b/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst index 03bd554..5966326 100644 --- a/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst +++ b/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst @@ -1,6 +1,8 @@ AUTOUIC_EXECUTABLE ------------------ +.. versionadded:: 3.14 + :prop_tgt:`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 diff --git a/Help/prop_tgt/AUTOUIC_SEARCH_PATHS.rst b/Help/prop_tgt/AUTOUIC_SEARCH_PATHS.rst index 96d9f89..87fea48 100644 --- a/Help/prop_tgt/AUTOUIC_SEARCH_PATHS.rst +++ b/Help/prop_tgt/AUTOUIC_SEARCH_PATHS.rst @@ -1,6 +1,8 @@ AUTOUIC_SEARCH_PATHS -------------------- +.. versionadded:: 3.9 + Search path list used by :prop_tgt:`AUTOUIC` to find included ``.ui`` files. diff --git a/Help/prop_tgt/BINARY_DIR.rst b/Help/prop_tgt/BINARY_DIR.rst index 246f7e6..beab12c 100644 --- a/Help/prop_tgt/BINARY_DIR.rst +++ b/Help/prop_tgt/BINARY_DIR.rst @@ -1,6 +1,8 @@ BINARY_DIR ---------- +.. versionadded:: 3.4 + This read-only property reports the value of the :variable:`CMAKE_CURRENT_BINARY_DIR` variable in the directory in which the target was defined. diff --git a/Help/prop_tgt/BUILD_RPATH.rst b/Help/prop_tgt/BUILD_RPATH.rst index d978b94..1f917a5 100644 --- a/Help/prop_tgt/BUILD_RPATH.rst +++ b/Help/prop_tgt/BUILD_RPATH.rst @@ -1,6 +1,8 @@ BUILD_RPATH ----------- +.. versionadded:: 3.8 + A :ref:`semicolon-separated list <CMake Language Lists>` specifying runtime path (``RPATH``) entries to add to binaries linked in the build tree (for platforms that support it). The entries will *not* be used for binaries in the install diff --git a/Help/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst b/Help/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst index 3378797..2cdfa0d 100644 --- a/Help/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst +++ b/Help/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst @@ -1,6 +1,8 @@ BUILD_RPATH_USE_ORIGIN ---------------------- +.. versionadded:: 3.14 + Whether to use relative paths for the build ``RPATH``. This property is initialized by the value of the variable diff --git a/Help/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst b/Help/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst index bbb9a24..073dce5 100644 --- a/Help/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst +++ b/Help/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst @@ -1,6 +1,8 @@ BUILD_WITH_INSTALL_NAME_DIR --------------------------- +.. versionadded:: 3.9 + ``BUILD_WITH_INSTALL_NAME_DIR`` is a boolean specifying whether the macOS ``install_name`` of a target in the build tree uses the directory given by :prop_tgt:`INSTALL_NAME_DIR`. This setting only applies to targets on macOS. diff --git a/Help/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst b/Help/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst index 052ac6d..adfa6f7 100644 --- a/Help/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst +++ b/Help/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst @@ -1,6 +1,8 @@ COMMON_LANGUAGE_RUNTIME ----------------------- +.. versionadded:: 3.12 + By setting this target property, the target is configured to build with ``C++/CLI`` support. diff --git a/Help/prop_tgt/COMPILE_FEATURES.rst b/Help/prop_tgt/COMPILE_FEATURES.rst index 46aec4f..9b937ed 100644 --- a/Help/prop_tgt/COMPILE_FEATURES.rst +++ b/Help/prop_tgt/COMPILE_FEATURES.rst @@ -1,6 +1,8 @@ COMPILE_FEATURES ---------------- +.. versionadded:: 3.1 + Compiler features enabled for this target. The list of features in this property are a subset of the features listed diff --git a/Help/prop_tgt/COMPILE_PDB_NAME.rst b/Help/prop_tgt/COMPILE_PDB_NAME.rst index 24a9f62..b76afeb 100644 --- a/Help/prop_tgt/COMPILE_PDB_NAME.rst +++ b/Help/prop_tgt/COMPILE_PDB_NAME.rst @@ -1,6 +1,8 @@ COMPILE_PDB_NAME ---------------- +.. versionadded:: 3.1 + Output name for the MS debug symbol ``.pdb`` file generated by the compiler while building source files. diff --git a/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst b/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst index e4077f5..4c9825d 100644 --- a/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst +++ b/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst @@ -1,6 +1,8 @@ COMPILE_PDB_NAME_<CONFIG> ------------------------- +.. versionadded:: 3.1 + Per-configuration output name for the MS debug symbol ``.pdb`` file generated by the compiler while building source files. diff --git a/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst index 34f49be..3f3df66 100644 --- a/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst +++ b/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst @@ -1,6 +1,8 @@ COMPILE_PDB_OUTPUT_DIRECTORY ---------------------------- +.. versionadded:: 3.1 + Output directory for the MS debug symbol ``.pdb`` file generated by the compiler while building source files. diff --git a/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst index f261756..c25c2fc 100644 --- a/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst +++ b/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -1,6 +1,8 @@ COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG> ------------------------------------- +.. versionadded:: 3.1 + Per-configuration output directory for the MS debug symbol ``.pdb`` file generated by the compiler while building source files. diff --git a/Help/prop_tgt/CROSSCOMPILING_EMULATOR.rst b/Help/prop_tgt/CROSSCOMPILING_EMULATOR.rst index 87c5978..d7fb9b1 100644 --- a/Help/prop_tgt/CROSSCOMPILING_EMULATOR.rst +++ b/Help/prop_tgt/CROSSCOMPILING_EMULATOR.rst @@ -1,6 +1,8 @@ CROSSCOMPILING_EMULATOR ----------------------- +.. versionadded:: 3.3 + Use the given emulator to run executables created when crosscompiling. This command will be added as a prefix to :command:`add_test`, :command:`add_custom_command`, and :command:`add_custom_target` commands diff --git a/Help/prop_tgt/CUDA_ARCHITECTURES.rst b/Help/prop_tgt/CUDA_ARCHITECTURES.rst index bae3c6f..d56b769 100644 --- a/Help/prop_tgt/CUDA_ARCHITECTURES.rst +++ b/Help/prop_tgt/CUDA_ARCHITECTURES.rst @@ -1,6 +1,8 @@ CUDA_ARCHITECTURES ------------------ +.. versionadded:: 3.18 + List of architectures to generate device code for. An architecture can be suffixed by either ``-real`` or ``-virtual`` to specify diff --git a/Help/prop_tgt/CUDA_EXTENSIONS.rst b/Help/prop_tgt/CUDA_EXTENSIONS.rst index 098ca3c..2ddba0b 100644 --- a/Help/prop_tgt/CUDA_EXTENSIONS.rst +++ b/Help/prop_tgt/CUDA_EXTENSIONS.rst @@ -1,6 +1,8 @@ CUDA_EXTENSIONS --------------- +.. versionadded:: 3.8 + Boolean specifying whether compiler specific extensions are requested. This property specifies whether compiler specific extensions should be diff --git a/Help/prop_tgt/CUDA_PTX_COMPILATION.rst b/Help/prop_tgt/CUDA_PTX_COMPILATION.rst index 0ee372b..4e90afe 100644 --- a/Help/prop_tgt/CUDA_PTX_COMPILATION.rst +++ b/Help/prop_tgt/CUDA_PTX_COMPILATION.rst @@ -1,6 +1,8 @@ CUDA_PTX_COMPILATION -------------------- +.. versionadded:: 3.9 + Compile CUDA sources to ``.ptx`` files instead of ``.obj`` files within :ref:`Object Libraries`. diff --git a/Help/prop_tgt/CUDA_RESOLVE_DEVICE_SYMBOLS.rst b/Help/prop_tgt/CUDA_RESOLVE_DEVICE_SYMBOLS.rst index dae960f..819ce3e 100644 --- a/Help/prop_tgt/CUDA_RESOLVE_DEVICE_SYMBOLS.rst +++ b/Help/prop_tgt/CUDA_RESOLVE_DEVICE_SYMBOLS.rst @@ -1,6 +1,8 @@ CUDA_RESOLVE_DEVICE_SYMBOLS --------------------------- +.. versionadded:: 3.9 + CUDA only: Enables device linking for the specific library target where required. diff --git a/Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst b/Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst index 11b344c..e937fc6 100644 --- a/Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst +++ b/Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst @@ -1,6 +1,8 @@ CUDA_RUNTIME_LIBRARY -------------------- +.. versionadded:: 3.17 + Select the CUDA runtime library for use by compilers targeting the CUDA language. The allowed case insensitive values are: diff --git a/Help/prop_tgt/CUDA_SEPARABLE_COMPILATION.rst b/Help/prop_tgt/CUDA_SEPARABLE_COMPILATION.rst index d306d7f..32222f9 100644 --- a/Help/prop_tgt/CUDA_SEPARABLE_COMPILATION.rst +++ b/Help/prop_tgt/CUDA_SEPARABLE_COMPILATION.rst @@ -1,6 +1,8 @@ CUDA_SEPARABLE_COMPILATION -------------------------- +.. versionadded:: 3.8 + CUDA only: Enables separate compilation of device code If set this will enable separable compilation for all CUDA files for diff --git a/Help/prop_tgt/CUDA_STANDARD.rst b/Help/prop_tgt/CUDA_STANDARD.rst index 6d6774e..fcc4725 100644 --- a/Help/prop_tgt/CUDA_STANDARD.rst +++ b/Help/prop_tgt/CUDA_STANDARD.rst @@ -1,6 +1,8 @@ CUDA_STANDARD ------------- +.. versionadded:: 3.8 + The CUDA/C++ standard whose features are requested to build this target. This property specifies the CUDA/C++ standard whose features are requested diff --git a/Help/prop_tgt/CUDA_STANDARD_REQUIRED.rst b/Help/prop_tgt/CUDA_STANDARD_REQUIRED.rst index b2d5b28..c9301b5 100644 --- a/Help/prop_tgt/CUDA_STANDARD_REQUIRED.rst +++ b/Help/prop_tgt/CUDA_STANDARD_REQUIRED.rst @@ -1,6 +1,8 @@ CUDA_STANDARD_REQUIRED ---------------------- +.. versionadded:: 3.8 + Boolean describing whether the value of :prop_tgt:`CUDA_STANDARD` is a requirement. If this property is set to ``ON``, then the value of the @@ -8,7 +10,7 @@ If this property is set to ``ON``, then the value of the property is ``OFF`` or unset, the :prop_tgt:`CUDA_STANDARD` target property is treated as optional and may "decay" to a previous standard if the requested is not available. For compilers that have no notion of a standard level, such as -MSVC, this has no effect. +MSVC 1800 (Visual Studio 2013) and lower, this has no effect. 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/CXX_EXTENSIONS.rst b/Help/prop_tgt/CXX_EXTENSIONS.rst index 280bb3a..bda531e 100644 --- a/Help/prop_tgt/CXX_EXTENSIONS.rst +++ b/Help/prop_tgt/CXX_EXTENSIONS.rst @@ -1,6 +1,8 @@ CXX_EXTENSIONS -------------- +.. versionadded:: 3.1 + Boolean specifying whether compiler specific extensions are requested. This property specifies whether compiler specific extensions should be diff --git a/Help/prop_tgt/CXX_STANDARD.rst b/Help/prop_tgt/CXX_STANDARD.rst index ccc0147..f322ffe 100644 --- a/Help/prop_tgt/CXX_STANDARD.rst +++ b/Help/prop_tgt/CXX_STANDARD.rst @@ -1,6 +1,8 @@ CXX_STANDARD ------------ +.. versionadded:: 3.1 + The C++ standard whose features are requested to build this target. This property specifies the C++ standard whose features are requested diff --git a/Help/prop_tgt/CXX_STANDARD_REQUIRED.rst b/Help/prop_tgt/CXX_STANDARD_REQUIRED.rst index 697d7f6..8b17490 100644 --- a/Help/prop_tgt/CXX_STANDARD_REQUIRED.rst +++ b/Help/prop_tgt/CXX_STANDARD_REQUIRED.rst @@ -1,6 +1,8 @@ CXX_STANDARD_REQUIRED --------------------- +.. versionadded:: 3.1 + Boolean describing whether the value of :prop_tgt:`CXX_STANDARD` is a requirement. If this property is set to ``ON``, then the value of the @@ -8,7 +10,7 @@ If this property is set to ``ON``, then the value of the property is ``OFF`` or unset, the :prop_tgt:`CXX_STANDARD` target property is treated as optional and may "decay" to a previous standard if the requested is not available. For compilers that have no notion of a standard level, such as -MSVC, this has no effect. +MSVC 1800 (Visual Studio 2013) and lower, this has no effect. 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/C_EXTENSIONS.rst b/Help/prop_tgt/C_EXTENSIONS.rst index 05b14ce..b2abb46 100644 --- a/Help/prop_tgt/C_EXTENSIONS.rst +++ b/Help/prop_tgt/C_EXTENSIONS.rst @@ -1,6 +1,8 @@ C_EXTENSIONS ------------ +.. versionadded:: 3.1 + Boolean specifying whether compiler specific extensions are requested. This property specifies whether compiler specific extensions should be diff --git a/Help/prop_tgt/C_STANDARD.rst b/Help/prop_tgt/C_STANDARD.rst index 6a05139..999a9e7 100644 --- a/Help/prop_tgt/C_STANDARD.rst +++ b/Help/prop_tgt/C_STANDARD.rst @@ -1,6 +1,8 @@ C_STANDARD ---------- +.. versionadded:: 3.1 + The C standard whose features are requested to build this target. This property specifies the C standard whose features are requested diff --git a/Help/prop_tgt/C_STANDARD_REQUIRED.rst b/Help/prop_tgt/C_STANDARD_REQUIRED.rst index acfad98..55bff04 100644 --- a/Help/prop_tgt/C_STANDARD_REQUIRED.rst +++ b/Help/prop_tgt/C_STANDARD_REQUIRED.rst @@ -1,6 +1,8 @@ C_STANDARD_REQUIRED ------------------- +.. versionadded:: 3.1 + Boolean describing whether the value of :prop_tgt:`C_STANDARD` is a requirement. If this property is set to ``ON``, then the value of the @@ -8,7 +10,7 @@ If this property is set to ``ON``, then the value of the property is ``OFF`` or unset, the :prop_tgt:`C_STANDARD` target property is treated as optional and may "decay" to a previous standard if the requested is not available. For compilers that have no notion of a standard level, such as -MSVC, this has no effect. +MSVC 1800 (Visual Studio 2013) and lower, this has no effect. 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/DEBUG_POSTFIX.rst b/Help/prop_tgt/DEBUG_POSTFIX.rst index 04e312e..eca7cb0 100644 --- a/Help/prop_tgt/DEBUG_POSTFIX.rst +++ b/Help/prop_tgt/DEBUG_POSTFIX.rst @@ -1,7 +1,7 @@ DEBUG_POSTFIX ------------- -See target property ``<CONFIG>_POSTFIX``. +See target property :prop_tgt:`<CONFIG>_POSTFIX`. -This property is a special case of the more-general ``<CONFIG>_POSTFIX`` +This property is a special case of the more-general :prop_tgt:`<CONFIG>_POSTFIX` property for the ``DEBUG`` configuration. diff --git a/Help/prop_tgt/DEPLOYMENT_ADDITIONAL_FILES.rst b/Help/prop_tgt/DEPLOYMENT_ADDITIONAL_FILES.rst index 5e9c191..f11fe7c 100644 --- a/Help/prop_tgt/DEPLOYMENT_ADDITIONAL_FILES.rst +++ b/Help/prop_tgt/DEPLOYMENT_ADDITIONAL_FILES.rst @@ -1,6 +1,8 @@ DEPLOYMENT_ADDITIONAL_FILES --------------------------- +.. versionadded:: 3.13 + Set the WinCE project ``AdditionalFiles`` in ``DeploymentTool`` in ``.vcproj`` files generated by the :generator:`Visual Studio 9 2008` generator. This is useful when you want to debug on remote WinCE device. diff --git a/Help/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst b/Help/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst index 368768a..0680238 100644 --- a/Help/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst +++ b/Help/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst @@ -1,6 +1,8 @@ DEPLOYMENT_REMOTE_DIRECTORY --------------------------- +.. versionadded:: 3.6 + Set the WinCE project ``RemoteDirectory`` in ``DeploymentTool`` and ``RemoteExecutable`` in ``DebuggerTool`` in ``.vcproj`` files generated by the :generator:`Visual Studio 9 2008` generator. diff --git a/Help/prop_tgt/DEPRECATION.rst b/Help/prop_tgt/DEPRECATION.rst index fef2e2e..45ca848 100644 --- a/Help/prop_tgt/DEPRECATION.rst +++ b/Help/prop_tgt/DEPRECATION.rst @@ -1,6 +1,8 @@ DEPRECATION ----------- +.. versionadded:: 3.17 + Deprecation message from imported target's developer. ``DEPRECATION`` is the message regarding a deprecation status to be displayed diff --git a/Help/prop_tgt/DISABLE_PRECOMPILE_HEADERS.rst b/Help/prop_tgt/DISABLE_PRECOMPILE_HEADERS.rst index 4cef023..7b3826b 100644 --- a/Help/prop_tgt/DISABLE_PRECOMPILE_HEADERS.rst +++ b/Help/prop_tgt/DISABLE_PRECOMPILE_HEADERS.rst @@ -1,6 +1,8 @@ DISABLE_PRECOMPILE_HEADERS -------------------------- +.. versionadded:: 3.16 + Disables the precompilation of header files specified by :prop_tgt:`PRECOMPILE_HEADERS` property. diff --git a/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK.rst b/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK.rst index 8698eb6..3ba4e25 100644 --- a/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK.rst +++ b/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK.rst @@ -1,6 +1,8 @@ DOTNET_TARGET_FRAMEWORK ----------------------- +.. versionadded:: 3.17 + Specify the .NET target framework. Used to specify the .NET target framework for C++/CLI and C#. For diff --git a/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK_VERSION.rst b/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK_VERSION.rst index b33f4fb..fbd1aab 100644 --- a/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK_VERSION.rst +++ b/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK_VERSION.rst @@ -1,6 +1,8 @@ DOTNET_TARGET_FRAMEWORK_VERSION ------------------------------- +.. versionadded:: 3.12 + Specify the .NET target framework version. Used to specify the .NET target framework version for C++/CLI and C#. diff --git a/Help/prop_tgt/EXCLUDE_FROM_ALL.rst b/Help/prop_tgt/EXCLUDE_FROM_ALL.rst index c9ece22..f0200f3 100644 --- a/Help/prop_tgt/EXCLUDE_FROM_ALL.rst +++ b/Help/prop_tgt/EXCLUDE_FROM_ALL.rst @@ -19,3 +19,10 @@ If a target has ``EXCLUDE_FROM_ALL`` set to true, it may still be listed in an :command:`install(TARGETS)` command, but the user is responsible for ensuring that the target's build artifacts are not missing or outdated when an install is performed. + +This property may use "generator expressions" with the syntax ``$<...>``. See +the :manual:`cmake-generator-expressions(7)` manual for available expressions. + +Only the "Ninja Multi-Config" generator supports a property value that varies by +configuration. For all other generators the value of this property must be the +same for all configurations. diff --git a/Help/prop_tgt/EXPORT_PROPERTIES.rst b/Help/prop_tgt/EXPORT_PROPERTIES.rst index bcf47a6..2d54f8b 100644 --- a/Help/prop_tgt/EXPORT_PROPERTIES.rst +++ b/Help/prop_tgt/EXPORT_PROPERTIES.rst @@ -1,6 +1,8 @@ EXPORT_PROPERTIES ----------------- +.. versionadded:: 3.12 + List additional properties to export for a target. This property contains a list of property names that should be exported by @@ -12,3 +14,11 @@ Properties starting with ``INTERFACE_`` or ``IMPORTED_`` are not allowed as they are reserved for internal CMake use. Properties containing generator expressions are also not allowed. + +.. note:: + + Since CMake 3.19, :ref:`Interface Libraries` may have arbitrary + target properties. If a project exports an interface library + with custom properties, the resulting package may not work with + dependents configured by older versions of CMake that reject the + custom properties. diff --git a/Help/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst b/Help/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst index 243c0cd..84d0c1e 100644 --- a/Help/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst +++ b/Help/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst @@ -1,6 +1,8 @@ FRAMEWORK_MULTI_CONFIG_POSTFIX_<CONFIG> --------------------------------------- +.. versionadded:: 3.18 + Postfix to append to the framework file name for configuration ``<CONFIG>``, when using a multi-config generator (like Xcode and Ninja Multi-Config). diff --git a/Help/prop_tgt/FRAMEWORK_VERSION.rst b/Help/prop_tgt/FRAMEWORK_VERSION.rst index c2ae7b9..38b8137 100644 --- a/Help/prop_tgt/FRAMEWORK_VERSION.rst +++ b/Help/prop_tgt/FRAMEWORK_VERSION.rst @@ -1,6 +1,8 @@ FRAMEWORK_VERSION ----------------- +.. versionadded:: 3.4 + Version of a framework created using the :prop_tgt:`FRAMEWORK` target property (e.g. ``A``). diff --git a/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst b/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst index e061863..84029e4 100644 --- a/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst +++ b/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst @@ -11,6 +11,14 @@ corresponding to the target's source directory. If the variable :variable:`CMAKE_Fortran_MODULE_DIRECTORY` is set when a target is created its value is used to initialize this property. +When using one of the :ref:`Visual Studio Generators` with the Intel Fortran +plugin installed in Visual Studio, a subdirectory named after the +configuration will be appended to the path where modules are created. +For example, if ``Fortran_MODULE_DIRECTORY`` is set to ``C:/some/path``, +modules will end up in ``C:/some/path/Debug`` (or +``C:/some/path/Release`` etc.) when an Intel Fortran ``.vfproj`` file is +generated, and in ``C:/some/path`` when any other generator is used. + Note that some compilers will automatically search the module output directory for modules USEd during compilation but others will not. If your sources USE modules their location must be specified by diff --git a/Help/prop_tgt/Fortran_PREPROCESS.rst b/Help/prop_tgt/Fortran_PREPROCESS.rst index 47a15c0..e7e2fba 100644 --- a/Help/prop_tgt/Fortran_PREPROCESS.rst +++ b/Help/prop_tgt/Fortran_PREPROCESS.rst @@ -1,6 +1,8 @@ Fortran_PREPROCESS ------------------ +.. versionadded:: 3.18 + Control whether the Fortran source file should be unconditionally preprocessed. diff --git a/Help/prop_tgt/GHS_INTEGRITY_APP.rst b/Help/prop_tgt/GHS_INTEGRITY_APP.rst index b669781..cccd087 100644 --- a/Help/prop_tgt/GHS_INTEGRITY_APP.rst +++ b/Help/prop_tgt/GHS_INTEGRITY_APP.rst @@ -1,6 +1,8 @@ GHS_INTEGRITY_APP ----------------- +.. versionadded:: 3.14 + ``ON`` / ``OFF`` boolean to determine if an executable target should be treated as an `Integrity Application`. diff --git a/Help/prop_tgt/GHS_NO_SOURCE_GROUP_FILE.rst b/Help/prop_tgt/GHS_NO_SOURCE_GROUP_FILE.rst index 11ce0b22..fe6b8e6 100644 --- a/Help/prop_tgt/GHS_NO_SOURCE_GROUP_FILE.rst +++ b/Help/prop_tgt/GHS_NO_SOURCE_GROUP_FILE.rst @@ -1,6 +1,8 @@ GHS_NO_SOURCE_GROUP_FILE ------------------------ +.. versionadded:: 3.14 + ``ON`` / ``OFF`` boolean to control if the project file for a target should be one single file or multiple files. diff --git a/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst b/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst index dc73807..f7e366a 100644 --- a/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst +++ b/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst @@ -1,15 +1,15 @@ IMPLICIT_DEPENDS_INCLUDE_TRANSFORM ---------------------------------- -Specify #include line transforms for dependencies in a target. +Specify ``#include`` line transforms for dependencies in a target. -This property specifies rules to transform macro-like #include lines +This property specifies rules to transform macro-like ``#include`` lines during implicit dependency scanning of C and C++ source files. The list of rules must be semicolon-separated with each entry of the form -"A_MACRO(%)=value-with-%" (the % must be literal). During dependency -scanning occurrences of A_MACRO(...) on #include lines will be +``A_MACRO(%)=value-with-%`` (the ``%`` must be literal). During dependency +scanning occurrences of ``A_MACRO(...)`` on ``#include`` lines will be replaced by the value given with the macro argument substituted for -'%'. For example, the entry +``%``. For example, the entry :: diff --git a/Help/prop_tgt/IMPORTED_COMMON_LANGUAGE_RUNTIME.rst b/Help/prop_tgt/IMPORTED_COMMON_LANGUAGE_RUNTIME.rst index 99e3bc4..8c20e07 100644 --- a/Help/prop_tgt/IMPORTED_COMMON_LANGUAGE_RUNTIME.rst +++ b/Help/prop_tgt/IMPORTED_COMMON_LANGUAGE_RUNTIME.rst @@ -1,6 +1,8 @@ IMPORTED_COMMON_LANGUAGE_RUNTIME -------------------------------- +.. versionadded:: 3.12 + Property to define if the target uses ``C++/CLI``. Ignored for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_GLOBAL.rst b/Help/prop_tgt/IMPORTED_GLOBAL.rst index 1a9129f..176127f 100644 --- a/Help/prop_tgt/IMPORTED_GLOBAL.rst +++ b/Help/prop_tgt/IMPORTED_GLOBAL.rst @@ -1,6 +1,8 @@ IMPORTED_GLOBAL --------------- +.. versionadded:: 3.11 + Indication of whether an :ref:`IMPORTED target <Imported Targets>` is globally visible. diff --git a/Help/prop_tgt/IMPORTED_LIBNAME.rst b/Help/prop_tgt/IMPORTED_LIBNAME.rst index 1943dba..7a83906 100644 --- a/Help/prop_tgt/IMPORTED_LIBNAME.rst +++ b/Help/prop_tgt/IMPORTED_LIBNAME.rst @@ -1,6 +1,8 @@ IMPORTED_LIBNAME ---------------- +.. versionadded:: 3.8 + Specify the link library name for an :ref:`imported <Imported Targets>` :ref:`Interface Library <Interface Libraries>`. diff --git a/Help/prop_tgt/IMPORTED_LIBNAME_CONFIG.rst b/Help/prop_tgt/IMPORTED_LIBNAME_CONFIG.rst index a28b838..df64769 100644 --- a/Help/prop_tgt/IMPORTED_LIBNAME_CONFIG.rst +++ b/Help/prop_tgt/IMPORTED_LIBNAME_CONFIG.rst @@ -1,6 +1,8 @@ IMPORTED_LIBNAME_<CONFIG> ------------------------- +.. versionadded:: 3.8 + <CONFIG>-specific version of :prop_tgt:`IMPORTED_LIBNAME` property. Configuration names correspond to those provided by the project from diff --git a/Help/prop_tgt/IMPORTED_OBJECTS.rst b/Help/prop_tgt/IMPORTED_OBJECTS.rst index 50a329f..bbbcd86 100644 --- a/Help/prop_tgt/IMPORTED_OBJECTS.rst +++ b/Help/prop_tgt/IMPORTED_OBJECTS.rst @@ -1,6 +1,8 @@ IMPORTED_OBJECTS ---------------- +.. versionadded:: 3.9 + A :ref:`semicolon-separated list <CMake Language Lists>` of absolute paths to the object files on disk for an :ref:`imported <Imported targets>` :ref:`object library <object libraries>`. diff --git a/Help/prop_tgt/IMPORTED_OBJECTS_CONFIG.rst b/Help/prop_tgt/IMPORTED_OBJECTS_CONFIG.rst index 4419ed1..b12ca38 100644 --- a/Help/prop_tgt/IMPORTED_OBJECTS_CONFIG.rst +++ b/Help/prop_tgt/IMPORTED_OBJECTS_CONFIG.rst @@ -1,6 +1,8 @@ IMPORTED_OBJECTS_<CONFIG> ------------------------- +.. versionadded:: 3.9 + <CONFIG>-specific version of :prop_tgt:`IMPORTED_OBJECTS` property. Configuration names correspond to those provided by the project from diff --git a/Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst b/Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst index 72dcaa0..f41e41c 100644 --- a/Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst +++ b/Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst @@ -1,6 +1,8 @@ INSTALL_REMOVE_ENVIRONMENT_RPATH -------------------------------- +.. versionadded:: 3.16 + Controls whether toolchain-defined rpaths should be removed during installation. When a target is being installed, CMake may need to rewrite its rpath diff --git a/Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst b/Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst index 31b594f..0db3b0c 100644 --- a/Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst +++ b/Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst @@ -1,6 +1,8 @@ INTERFACE_COMPILE_FEATURES -------------------------- +.. versionadded:: 3.1 + .. |property_name| replace:: compile features .. |command_name| replace:: :command:`target_compile_features` .. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_COMPILE_FEATURES`` diff --git a/Help/prop_tgt/INTERFACE_LINK_DEPENDS.rst b/Help/prop_tgt/INTERFACE_LINK_DEPENDS.rst index 790554d..9c8275d 100644 --- a/Help/prop_tgt/INTERFACE_LINK_DEPENDS.rst +++ b/Help/prop_tgt/INTERFACE_LINK_DEPENDS.rst @@ -1,6 +1,8 @@ INTERFACE_LINK_DEPENDS ---------------------- +.. versionadded:: 3.13 + Additional public interface files on which a target binary depends for linking. This property is supported only by :generator:`Ninja` and diff --git a/Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst index 56a4ec0..de1dabb 100644 --- a/Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst +++ b/Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst @@ -1,6 +1,8 @@ INTERFACE_LINK_DIRECTORIES -------------------------- +.. versionadded:: 3.13 + .. |property_name| replace:: link directories .. |command_name| replace:: :command:`target_link_directories` .. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_LINK_DIRECTORIES`` diff --git a/Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst b/Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst index c293b98..4245fe9 100644 --- a/Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst +++ b/Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst @@ -1,6 +1,8 @@ INTERFACE_LINK_OPTIONS ---------------------- +.. versionadded:: 3.13 + .. |property_name| replace:: link options .. |command_name| replace:: :command:`target_link_options` .. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_LINK_OPTIONS`` diff --git a/Help/prop_tgt/INTERFACE_PRECOMPILE_HEADERS.rst b/Help/prop_tgt/INTERFACE_PRECOMPILE_HEADERS.rst index e285407..2299264 100644 --- a/Help/prop_tgt/INTERFACE_PRECOMPILE_HEADERS.rst +++ b/Help/prop_tgt/INTERFACE_PRECOMPILE_HEADERS.rst @@ -1,6 +1,8 @@ INTERFACE_PRECOMPILE_HEADERS ---------------------------- +.. versionadded:: 3.16 + List of interface header files to precompile into consuming targets. Targets may populate this property to publish the header files diff --git a/Help/prop_tgt/INTERFACE_SOURCES.rst b/Help/prop_tgt/INTERFACE_SOURCES.rst index a224b68..759c482 100644 --- a/Help/prop_tgt/INTERFACE_SOURCES.rst +++ b/Help/prop_tgt/INTERFACE_SOURCES.rst @@ -1,6 +1,8 @@ INTERFACE_SOURCES ----------------- +.. versionadded:: 3.1 + List of interface sources to compile into consuming targets. Targets may populate this property to publish the sources diff --git a/Help/prop_tgt/IOS_INSTALL_COMBINED.rst b/Help/prop_tgt/IOS_INSTALL_COMBINED.rst index 59f67a7..92d60dc 100644 --- a/Help/prop_tgt/IOS_INSTALL_COMBINED.rst +++ b/Help/prop_tgt/IOS_INSTALL_COMBINED.rst @@ -1,6 +1,8 @@ IOS_INSTALL_COMBINED -------------------- +.. versionadded:: 3.5 + Build a combined (device and simulator) target when installing. When this property is set to set to false (which is the default) then it will @@ -8,4 +10,10 @@ either be built with the device SDK or the simulator SDK depending on the SDK set. But if this property is set to true then the target will at install time also be built for the corresponding SDK and combined into one library. +.. note:: + + If a selected architecture is available for both: device SDK and simulator + SDK it will be built for the SDK selected by :variable:`CMAKE_OSX_SYSROOT` + and removed from the corresponding SDK. + This feature requires at least Xcode version 6. diff --git a/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst b/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst index ece28a4..42cace0 100644 --- a/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst +++ b/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst @@ -1,6 +1,8 @@ JOB_POOL_PRECOMPILE_HEADER -------------------------- +.. versionadded:: 3.17 + Ninja only: Pool used for generating pre-compiled headers. The number of parallel compile processes could be limited by defining diff --git a/Help/prop_tgt/LANG_CLANG_TIDY.rst b/Help/prop_tgt/LANG_CLANG_TIDY.rst index 2bfef66..7fc2372 100644 --- a/Help/prop_tgt/LANG_CLANG_TIDY.rst +++ b/Help/prop_tgt/LANG_CLANG_TIDY.rst @@ -1,6 +1,8 @@ <LANG>_CLANG_TIDY ----------------- +.. versionadded:: 3.6 + This property is implemented only when ``<LANG>`` is ``C`` or ``CXX``. Specify a :ref:`semicolon-separated list <CMake Language Lists>` containing a command diff --git a/Help/prop_tgt/LANG_COMPILER_LAUNCHER.rst b/Help/prop_tgt/LANG_COMPILER_LAUNCHER.rst index a6f2b24..77ae1f6 100644 --- a/Help/prop_tgt/LANG_COMPILER_LAUNCHER.rst +++ b/Help/prop_tgt/LANG_COMPILER_LAUNCHER.rst @@ -1,6 +1,8 @@ <LANG>_COMPILER_LAUNCHER ------------------------ +.. versionadded:: 3.4 + This property is implemented only when ``<LANG>`` is ``C``, ``CXX``, ``Fortran``, ``OBJC``, ``OBJCXX``, or ``CUDA``. diff --git a/Help/prop_tgt/LANG_CPPCHECK.rst b/Help/prop_tgt/LANG_CPPCHECK.rst index 60785d0..80acbc0 100644 --- a/Help/prop_tgt/LANG_CPPCHECK.rst +++ b/Help/prop_tgt/LANG_CPPCHECK.rst @@ -1,6 +1,8 @@ <LANG>_CPPCHECK --------------- +.. versionadded:: 3.10 + This property is supported only when ``<LANG>`` is ``C`` or ``CXX``. Specify a :ref:`semicolon-separated list <CMake Language Lists>` containing a command line diff --git a/Help/prop_tgt/LANG_CPPLINT.rst b/Help/prop_tgt/LANG_CPPLINT.rst index 9944c88..be6db46 100644 --- a/Help/prop_tgt/LANG_CPPLINT.rst +++ b/Help/prop_tgt/LANG_CPPLINT.rst @@ -1,6 +1,8 @@ <LANG>_CPPLINT -------------- +.. versionadded:: 3.8 + This property is supported only when ``<LANG>`` is ``C`` or ``CXX``. Specify a :ref:`semicolon-separated list <CMake Language Lists>` containing a command line diff --git a/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst b/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst index 35220e4..eebef56 100644 --- a/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst +++ b/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst @@ -1,6 +1,8 @@ <LANG>_INCLUDE_WHAT_YOU_USE --------------------------- +.. versionadded:: 3.3 + This property is implemented only when ``<LANG>`` is ``C`` or ``CXX``. Specify a :ref:`semicolon-separated list <CMake Language Lists>` containing a command diff --git a/Help/prop_tgt/LINK_DIRECTORIES.rst b/Help/prop_tgt/LINK_DIRECTORIES.rst index c2905b3..67be494 100644 --- a/Help/prop_tgt/LINK_DIRECTORIES.rst +++ b/Help/prop_tgt/LINK_DIRECTORIES.rst @@ -1,6 +1,8 @@ LINK_DIRECTORIES ---------------- +.. versionadded:: 3.13 + List of directories to use for the link step of shared library, module and executable targets. diff --git a/Help/prop_tgt/LINK_OPTIONS.rst b/Help/prop_tgt/LINK_OPTIONS.rst index ff3ee87..8c0dfc4 100644 --- a/Help/prop_tgt/LINK_OPTIONS.rst +++ b/Help/prop_tgt/LINK_OPTIONS.rst @@ -1,6 +1,8 @@ LINK_OPTIONS ------------ +.. versionadded:: 3.13 + List of options to use for the link step of shared library, module and executable targets as well as the device link step. Targets that are static libraries need to use the :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property. diff --git a/Help/prop_tgt/LINK_WHAT_YOU_USE.rst b/Help/prop_tgt/LINK_WHAT_YOU_USE.rst index 32d6edb..2ed93ad 100644 --- a/Help/prop_tgt/LINK_WHAT_YOU_USE.rst +++ b/Help/prop_tgt/LINK_WHAT_YOU_USE.rst @@ -1,6 +1,8 @@ LINK_WHAT_YOU_USE --------------------------- +.. versionadded:: 3.7 + This is a boolean option that when set to ``TRUE`` will automatically run ``ldd -r -u`` on the target after it is linked. In addition, the linker flag ``-Wl,--no-as-needed`` will be passed to the target with the link command so diff --git a/Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst b/Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst index 26d5cc8..a24b255 100644 --- a/Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst +++ b/Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst @@ -1,6 +1,8 @@ MACHO_COMPATIBILITY_VERSION --------------------------- +.. versionadded:: 3.17 + What compatibility version number is this target for Mach-O binaries. For shared libraries on Mach-O systems (e.g. macOS, iOS) diff --git a/Help/prop_tgt/MACHO_CURRENT_VERSION.rst b/Help/prop_tgt/MACHO_CURRENT_VERSION.rst index 9afb356..530f79b 100644 --- a/Help/prop_tgt/MACHO_CURRENT_VERSION.rst +++ b/Help/prop_tgt/MACHO_CURRENT_VERSION.rst @@ -1,6 +1,8 @@ MACHO_CURRENT_VERSION --------------------- +.. versionadded:: 3.17 + What current version number is this target for Mach-O binaries. For shared libraries on Mach-O systems (e.g. macOS, iOS) diff --git a/Help/prop_tgt/MANUALLY_ADDED_DEPENDENCIES.rst b/Help/prop_tgt/MANUALLY_ADDED_DEPENDENCIES.rst index c12ea14..72871b3 100644 --- a/Help/prop_tgt/MANUALLY_ADDED_DEPENDENCIES.rst +++ b/Help/prop_tgt/MANUALLY_ADDED_DEPENDENCIES.rst @@ -1,6 +1,8 @@ MANUALLY_ADDED_DEPENDENCIES --------------------------- +.. versionadded:: 3.8 + Get manually added dependencies to other top-level targets. This read-only property can be used to query all dependencies that diff --git a/Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst b/Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst index 73792de..9b978b2 100644 --- a/Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst +++ b/Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst @@ -1,6 +1,8 @@ MSVC_RUNTIME_LIBRARY -------------------- +.. versionadded:: 3.15 + Select the MSVC runtime library for use by compilers targeting the MSVC ABI. The allowed values are: diff --git a/Help/prop_tgt/OBJCXX_EXTENSIONS.rst b/Help/prop_tgt/OBJCXX_EXTENSIONS.rst index 9f9d804..8a254f2 100644 --- a/Help/prop_tgt/OBJCXX_EXTENSIONS.rst +++ b/Help/prop_tgt/OBJCXX_EXTENSIONS.rst @@ -1,6 +1,8 @@ OBJCXX_EXTENSIONS ----------------- +.. versionadded:: 3.16 + Boolean specifying whether compiler specific extensions are requested. This property specifies whether compiler specific extensions should be diff --git a/Help/prop_tgt/OBJCXX_STANDARD.rst b/Help/prop_tgt/OBJCXX_STANDARD.rst index 3c925dc..1067153 100644 --- a/Help/prop_tgt/OBJCXX_STANDARD.rst +++ b/Help/prop_tgt/OBJCXX_STANDARD.rst @@ -1,6 +1,8 @@ OBJCXX_STANDARD --------------- +.. versionadded:: 3.16 + The ObjC++ standard whose features are requested to build this target. This property specifies the ObjC++ standard whose features are requested diff --git a/Help/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst b/Help/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst index c330abf..3cee740 100644 --- a/Help/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst +++ b/Help/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst @@ -1,6 +1,8 @@ OBJCXX_STANDARD_REQUIRED ------------------------ +.. versionadded:: 3.16 + Boolean describing whether the value of :prop_tgt:`OBJCXX_STANDARD` is a requirement. If this property is set to ``ON``, then the value of the diff --git a/Help/prop_tgt/OBJC_EXTENSIONS.rst b/Help/prop_tgt/OBJC_EXTENSIONS.rst index 2de9e48..ef1c754 100644 --- a/Help/prop_tgt/OBJC_EXTENSIONS.rst +++ b/Help/prop_tgt/OBJC_EXTENSIONS.rst @@ -1,6 +1,8 @@ OBJC_EXTENSIONS --------------- +.. versionadded:: 3.16 + Boolean specifying whether compiler specific extensions are requested. This property specifies whether compiler specific extensions should be diff --git a/Help/prop_tgt/OBJC_STANDARD.rst b/Help/prop_tgt/OBJC_STANDARD.rst index d1e1b24..2143ff9 100644 --- a/Help/prop_tgt/OBJC_STANDARD.rst +++ b/Help/prop_tgt/OBJC_STANDARD.rst @@ -1,6 +1,8 @@ OBJC_STANDARD ------------- +.. versionadded:: 3.16 + The OBJC standard whose features are requested to build this target. This property specifies the OBJC standard whose features are requested diff --git a/Help/prop_tgt/OBJC_STANDARD_REQUIRED.rst b/Help/prop_tgt/OBJC_STANDARD_REQUIRED.rst index 8cf377c..11547c8 100644 --- a/Help/prop_tgt/OBJC_STANDARD_REQUIRED.rst +++ b/Help/prop_tgt/OBJC_STANDARD_REQUIRED.rst @@ -1,6 +1,8 @@ OBJC_STANDARD_REQUIRED ---------------------- +.. versionadded:: 3.16 + Boolean describing whether the value of :prop_tgt:`OBJC_STANDARD` is a requirement. If this property is set to ``ON``, then the value of the diff --git a/Help/prop_tgt/OPTIMIZE_DEPENDENCIES.rst b/Help/prop_tgt/OPTIMIZE_DEPENDENCIES.rst new file mode 100644 index 0000000..533cf6a --- /dev/null +++ b/Help/prop_tgt/OPTIMIZE_DEPENDENCIES.rst @@ -0,0 +1,38 @@ +OPTIMIZE_DEPENDENCIES +--------------------- + +Activates dependency optimization of static and object libraries. + +When this property is set to true, some dependencies for a static or object +library may be removed at generation time if they are not necessary to build +the library, since static and object libraries don't actually link against +anything. + +If a static or object library has dependency optimization enabled, it first +discards all dependencies. Then, it looks through all of the direct and +indirect dependencies that it initially had, and adds them back if they meet +any of the following criteria: + +* The dependency was added to the library by :command:`add_dependencies`. +* The dependency was added to the library through a source file in the library + generated by a custom command that uses the dependency. +* The dependency has any ``PRE_BUILD``, ``PRE_LINK``, or ``POST_BUILD`` custom + commands associated with it. +* The dependency contains any source files that were generated by a custom + command. +* The dependency contains any languages which produce side effects that are + relevant to the library. Currently, all languages except C, C++, Objective-C, + Objective-C++, assembly, and CUDA are assumed to produce side effects. + However, side effects from one language are assumed not to be relevant to + another (for example, a Fortran library is assumed to not have any side + effects that are relevant for a Swift library.) + +As an example, assume you have a static Fortran library which depends on a +static C library, which in turn depends on a static Fortran library. The +top-level Fortran library has optimization enabled, but the middle C library +does not. If you build the top Fortran library, the bottom Fortran library will +also build, but not the middle C library, since the C library does not have any +side effects that are relevant for the Fortran library. However, if you build +the middle C library, the bottom Fortran library will also build, even though +it does not have any side effects that are relevant to the C library, since the +C library does not have optimization enabled. diff --git a/Help/prop_tgt/PCH_WARN_INVALID.rst b/Help/prop_tgt/PCH_WARN_INVALID.rst index 96e1abd..2d5ec55 100644 --- a/Help/prop_tgt/PCH_WARN_INVALID.rst +++ b/Help/prop_tgt/PCH_WARN_INVALID.rst @@ -1,6 +1,8 @@ PCH_WARN_INVALID ---------------- +.. versionadded:: 3.18 + When this property is set to true, the precompile header compiler options will contain a compiler flag which should warn about invalid precompiled headers e.g. ``-Winvalid-pch`` for GNU compiler. diff --git a/Help/prop_tgt/PRECOMPILE_HEADERS.rst b/Help/prop_tgt/PRECOMPILE_HEADERS.rst index 9e70b65..af27947 100644 --- a/Help/prop_tgt/PRECOMPILE_HEADERS.rst +++ b/Help/prop_tgt/PRECOMPILE_HEADERS.rst @@ -1,6 +1,8 @@ PRECOMPILE_HEADERS ------------------ +.. versionadded:: 3.16 + List of header files to precompile. This property holds a :ref:`semicolon-separated list <CMake Language Lists>` diff --git a/Help/prop_tgt/PRECOMPILE_HEADERS_REUSE_FROM.rst b/Help/prop_tgt/PRECOMPILE_HEADERS_REUSE_FROM.rst index 9c3e7ea..6f5635b 100644 --- a/Help/prop_tgt/PRECOMPILE_HEADERS_REUSE_FROM.rst +++ b/Help/prop_tgt/PRECOMPILE_HEADERS_REUSE_FROM.rst @@ -1,6 +1,8 @@ PRECOMPILE_HEADERS_REUSE_FROM ----------------------------- +.. versionadded:: 3.16 + Target from which to reuse the precompiled headers build artifact. See the second signature of :command:`target_precompile_headers` command diff --git a/Help/prop_tgt/SOURCE_DIR.rst b/Help/prop_tgt/SOURCE_DIR.rst index b25813b..78ce220 100644 --- a/Help/prop_tgt/SOURCE_DIR.rst +++ b/Help/prop_tgt/SOURCE_DIR.rst @@ -1,6 +1,8 @@ SOURCE_DIR ---------- +.. versionadded:: 3.4 + This read-only property reports the value of the :variable:`CMAKE_CURRENT_SOURCE_DIR` variable in the directory in which the target was defined. diff --git a/Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst b/Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst index d05fda4..2f4a3ba 100644 --- a/Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst +++ b/Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst @@ -1,6 +1,8 @@ STATIC_LIBRARY_OPTIONS ---------------------- +.. versionadded:: 3.13 + Archiver (or MSVC librarian) flags for a static library target. Targets that are shared libraries, modules, or executables need to use the :prop_tgt:`LINK_OPTIONS` target property. diff --git a/Help/prop_tgt/Swift_DEPENDENCIES_FILE.rst b/Help/prop_tgt/Swift_DEPENDENCIES_FILE.rst index 46c9a1d..0f944b6 100644 --- a/Help/prop_tgt/Swift_DEPENDENCIES_FILE.rst +++ b/Help/prop_tgt/Swift_DEPENDENCIES_FILE.rst @@ -1,5 +1,7 @@ Swift_DEPENDENCIES_FILE ----------------------- +.. versionadded:: 3.15 + This property sets the path for the Swift dependency file (swiftdep) for the target. If one is not specified, it will default to ``<TARGET>.swiftdeps``. diff --git a/Help/prop_tgt/Swift_LANGUAGE_VERSION.rst b/Help/prop_tgt/Swift_LANGUAGE_VERSION.rst index 7579447..afc6b31 100644 --- a/Help/prop_tgt/Swift_LANGUAGE_VERSION.rst +++ b/Help/prop_tgt/Swift_LANGUAGE_VERSION.rst @@ -1,6 +1,8 @@ Swift_LANGUAGE_VERSION ---------------------- +.. versionadded:: 3.16 + This property sets the language version for the Swift sources in the target. If one is not specified, it will default to ``<CMAKE_Swift_LANGUAGE_VERSION>`` if specified, otherwise it is the latest version supported by the compiler. diff --git a/Help/prop_tgt/Swift_MODULE_DIRECTORY.rst b/Help/prop_tgt/Swift_MODULE_DIRECTORY.rst index d404251..a6484f2 100644 --- a/Help/prop_tgt/Swift_MODULE_DIRECTORY.rst +++ b/Help/prop_tgt/Swift_MODULE_DIRECTORY.rst @@ -1,6 +1,8 @@ Swift_MODULE_DIRECTORY ---------------------- +.. versionadded:: 3.15 + Specify output directory for Swift modules provided by the target. If the target contains Swift source files, this specifies the directory in which diff --git a/Help/prop_tgt/Swift_MODULE_NAME.rst b/Help/prop_tgt/Swift_MODULE_NAME.rst index 2866020..d941b54 100644 --- a/Help/prop_tgt/Swift_MODULE_NAME.rst +++ b/Help/prop_tgt/Swift_MODULE_NAME.rst @@ -1,5 +1,7 @@ Swift_MODULE_NAME ----------------- +.. versionadded:: 3.15 + This property specifies the name of the Swift module. It is defaulted to the name of the target. diff --git a/Help/prop_tgt/UNITY_BUILD.rst b/Help/prop_tgt/UNITY_BUILD.rst index e140952..04cede6 100644 --- a/Help/prop_tgt/UNITY_BUILD.rst +++ b/Help/prop_tgt/UNITY_BUILD.rst @@ -1,6 +1,8 @@ UNITY_BUILD ----------- +.. versionadded:: 3.16 + When this property is set to true, the target source files will be combined into batches for faster compilation. This is done by creating a (set of) unity sources which ``#include`` the original sources, then compiling these diff --git a/Help/prop_tgt/UNITY_BUILD_BATCH_SIZE.rst b/Help/prop_tgt/UNITY_BUILD_BATCH_SIZE.rst index 44ffe27..3886ec9 100644 --- a/Help/prop_tgt/UNITY_BUILD_BATCH_SIZE.rst +++ b/Help/prop_tgt/UNITY_BUILD_BATCH_SIZE.rst @@ -1,6 +1,8 @@ UNITY_BUILD_BATCH_SIZE ---------------------- +.. versionadded:: 3.16 + Specifies the maximum number of source files that can be combined into any one unity source file when unity builds are enabled by the :prop_tgt:`UNITY_BUILD` target property. The original source files will be distributed across as many diff --git a/Help/prop_tgt/UNITY_BUILD_CODE_AFTER_INCLUDE.rst b/Help/prop_tgt/UNITY_BUILD_CODE_AFTER_INCLUDE.rst index 7231b61..ac2b19c 100644 --- a/Help/prop_tgt/UNITY_BUILD_CODE_AFTER_INCLUDE.rst +++ b/Help/prop_tgt/UNITY_BUILD_CODE_AFTER_INCLUDE.rst @@ -1,6 +1,8 @@ UNITY_BUILD_CODE_AFTER_INCLUDE ------------------------------ +.. versionadded:: 3.16 + Code snippet which is included verbatim by the :prop_tgt:`UNITY_BUILD` feature just after every ``#include`` statement in the generated unity source files. For example: diff --git a/Help/prop_tgt/UNITY_BUILD_CODE_BEFORE_INCLUDE.rst b/Help/prop_tgt/UNITY_BUILD_CODE_BEFORE_INCLUDE.rst index 7ed6fa1..6f0d56b 100644 --- a/Help/prop_tgt/UNITY_BUILD_CODE_BEFORE_INCLUDE.rst +++ b/Help/prop_tgt/UNITY_BUILD_CODE_BEFORE_INCLUDE.rst @@ -1,6 +1,8 @@ UNITY_BUILD_CODE_BEFORE_INCLUDE ------------------------------- +.. versionadded:: 3.16 + Code snippet which is included verbatim by the :prop_tgt:`UNITY_BUILD` feature just before every ``#include`` statement in the generated unity source files. For example: diff --git a/Help/prop_tgt/UNITY_BUILD_MODE.rst b/Help/prop_tgt/UNITY_BUILD_MODE.rst index 1ebab23..003451e 100644 --- a/Help/prop_tgt/UNITY_BUILD_MODE.rst +++ b/Help/prop_tgt/UNITY_BUILD_MODE.rst @@ -1,6 +1,8 @@ UNITY_BUILD_MODE ---------------- +.. versionadded:: 3.18 + CMake provides different algorithms for selecting which sources are grouped together into a *bucket*. Selection is decided by this property, which has the following acceptable values: diff --git a/Help/prop_tgt/VS_CONFIGURATION_TYPE.rst b/Help/prop_tgt/VS_CONFIGURATION_TYPE.rst index 640bed5..4adffd4 100644 --- a/Help/prop_tgt/VS_CONFIGURATION_TYPE.rst +++ b/Help/prop_tgt/VS_CONFIGURATION_TYPE.rst @@ -1,6 +1,8 @@ VS_CONFIGURATION_TYPE --------------------- +.. versionadded:: 3.6 + Visual Studio project configuration type. Sets the ``ConfigurationType`` attribute for a generated Visual Studio project. diff --git a/Help/prop_tgt/VS_DEBUGGER_COMMAND.rst b/Help/prop_tgt/VS_DEBUGGER_COMMAND.rst index ba5fd0a..58476d6 100644 --- a/Help/prop_tgt/VS_DEBUGGER_COMMAND.rst +++ b/Help/prop_tgt/VS_DEBUGGER_COMMAND.rst @@ -1,6 +1,8 @@ VS_DEBUGGER_COMMAND ------------------- +.. versionadded:: 3.12 + Sets the local debugger command for Visual Studio C++ targets. The property value may use :manual:`generator expressions <cmake-generator-expressions(7)>`. diff --git a/Help/prop_tgt/VS_DEBUGGER_COMMAND_ARGUMENTS.rst b/Help/prop_tgt/VS_DEBUGGER_COMMAND_ARGUMENTS.rst index 06ef5d5..6c26601 100644 --- a/Help/prop_tgt/VS_DEBUGGER_COMMAND_ARGUMENTS.rst +++ b/Help/prop_tgt/VS_DEBUGGER_COMMAND_ARGUMENTS.rst @@ -1,6 +1,8 @@ VS_DEBUGGER_COMMAND_ARGUMENTS ----------------------------- +.. versionadded:: 3.13 + Sets the local debugger command line arguments for Visual Studio C++ targets. The property value may use :manual:`generator expressions <cmake-generator-expressions(7)>`. diff --git a/Help/prop_tgt/VS_DEBUGGER_ENVIRONMENT.rst b/Help/prop_tgt/VS_DEBUGGER_ENVIRONMENT.rst index f55ac7b..2f59a82 100644 --- a/Help/prop_tgt/VS_DEBUGGER_ENVIRONMENT.rst +++ b/Help/prop_tgt/VS_DEBUGGER_ENVIRONMENT.rst @@ -1,6 +1,8 @@ VS_DEBUGGER_ENVIRONMENT ----------------------- +.. versionadded:: 3.13 + Sets the local debugger environment for Visual Studio C++ targets. The property value may use :manual:`generator expressions <cmake-generator-expressions(7)>`. diff --git a/Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst b/Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst index 008bbf6..c163abf 100644 --- a/Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst +++ b/Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst @@ -1,6 +1,8 @@ VS_DEBUGGER_WORKING_DIRECTORY ----------------------------- +.. versionadded:: 3.8 + Sets the local debugger working directory for Visual Studio C++ targets. The property value may use :manual:`generator expressions <cmake-generator-expressions(7)>`. diff --git a/Help/prop_tgt/VS_DESKTOP_EXTENSIONS_VERSION.rst b/Help/prop_tgt/VS_DESKTOP_EXTENSIONS_VERSION.rst index 19d1620..5fd23e1 100644 --- a/Help/prop_tgt/VS_DESKTOP_EXTENSIONS_VERSION.rst +++ b/Help/prop_tgt/VS_DESKTOP_EXTENSIONS_VERSION.rst @@ -1,6 +1,8 @@ VS_DESKTOP_EXTENSIONS_VERSION ----------------------------- +.. versionadded:: 3.4 + Visual Studio Windows 10 Desktop Extensions Version Specifies the version of the Desktop Extensions that should be included in the diff --git a/Help/prop_tgt/VS_DOTNET_DOCUMENTATION_FILE.rst b/Help/prop_tgt/VS_DOTNET_DOCUMENTATION_FILE.rst index 1bc361c..a388256 100644 --- a/Help/prop_tgt/VS_DOTNET_DOCUMENTATION_FILE.rst +++ b/Help/prop_tgt/VS_DOTNET_DOCUMENTATION_FILE.rst @@ -1,6 +1,8 @@ VS_DOTNET_DOCUMENTATION_FILE ---------------------------- +.. versionadded:: 3.17 + Visual Studio managed project .NET documentation output Sets the target XML documentation file output. diff --git a/Help/prop_tgt/VS_DOTNET_REFERENCEPROP_refname_TAG_tagname.rst b/Help/prop_tgt/VS_DOTNET_REFERENCEPROP_refname_TAG_tagname.rst index ab311ea..5b9caee 100644 --- a/Help/prop_tgt/VS_DOTNET_REFERENCEPROP_refname_TAG_tagname.rst +++ b/Help/prop_tgt/VS_DOTNET_REFERENCEPROP_refname_TAG_tagname.rst @@ -1,6 +1,8 @@ VS_DOTNET_REFERENCEPROP_<refname>_TAG_<tagname> ----------------------------------------------- +.. versionadded:: 3.10 + Defines an XML property ``<tagname>`` for a .NET reference ``<refname>``. diff --git a/Help/prop_tgt/VS_DOTNET_REFERENCES_COPY_LOCAL.rst b/Help/prop_tgt/VS_DOTNET_REFERENCES_COPY_LOCAL.rst index 7641ba5..556fa8a 100644 --- a/Help/prop_tgt/VS_DOTNET_REFERENCES_COPY_LOCAL.rst +++ b/Help/prop_tgt/VS_DOTNET_REFERENCES_COPY_LOCAL.rst @@ -1,6 +1,8 @@ VS_DOTNET_REFERENCES_COPY_LOCAL ------------------------------- +.. versionadded:: 3.8 + Sets the **Copy Local** property for all .NET hint references in the target Boolean property to enable/disable copying of .NET hint references to diff --git a/Help/prop_tgt/VS_DOTNET_REFERENCE_refname.rst b/Help/prop_tgt/VS_DOTNET_REFERENCE_refname.rst index 5814005..9c4d34a 100644 --- a/Help/prop_tgt/VS_DOTNET_REFERENCE_refname.rst +++ b/Help/prop_tgt/VS_DOTNET_REFERENCE_refname.rst @@ -1,6 +1,8 @@ VS_DOTNET_REFERENCE_<refname> ----------------------------- +.. versionadded:: 3.8 + Visual Studio managed project .NET reference with name ``<refname>`` and hint path. diff --git a/Help/prop_tgt/VS_DPI_AWARE.rst b/Help/prop_tgt/VS_DPI_AWARE.rst index 82640cc..47ce1ce 100644 --- a/Help/prop_tgt/VS_DPI_AWARE.rst +++ b/Help/prop_tgt/VS_DPI_AWARE.rst @@ -1,6 +1,8 @@ VS_DPI_AWARE ------------ +.. versionadded:: 3.16 + Set the Manifest Tool -> Input and Output -> DPI Awareness in the Visual Studio target project properties. diff --git a/Help/prop_tgt/VS_IOT_EXTENSIONS_VERSION.rst b/Help/prop_tgt/VS_IOT_EXTENSIONS_VERSION.rst index 27c8a3d..ca6a3ca 100644 --- a/Help/prop_tgt/VS_IOT_EXTENSIONS_VERSION.rst +++ b/Help/prop_tgt/VS_IOT_EXTENSIONS_VERSION.rst @@ -1,6 +1,8 @@ VS_IOT_EXTENSIONS_VERSION ------------------------- +.. versionadded:: 3.4 + Visual Studio Windows 10 IoT Extensions Version Specifies the version of the IoT Extensions that should be included in the diff --git a/Help/prop_tgt/VS_IOT_STARTUP_TASK.rst b/Help/prop_tgt/VS_IOT_STARTUP_TASK.rst index add50cb..259055d 100644 --- a/Help/prop_tgt/VS_IOT_STARTUP_TASK.rst +++ b/Help/prop_tgt/VS_IOT_STARTUP_TASK.rst @@ -1,6 +1,8 @@ VS_IOT_STARTUP_TASK ------------------- +.. versionadded:: 3.4 + Visual Studio Windows 10 IoT Continuous Background Task Specifies that the target should be compiled as a Continuous Background Task library. diff --git a/Help/prop_tgt/VS_JUST_MY_CODE_DEBUGGING.rst b/Help/prop_tgt/VS_JUST_MY_CODE_DEBUGGING.rst index 42fb8ad..724bd2f 100644 --- a/Help/prop_tgt/VS_JUST_MY_CODE_DEBUGGING.rst +++ b/Help/prop_tgt/VS_JUST_MY_CODE_DEBUGGING.rst @@ -1,6 +1,8 @@ VS_JUST_MY_CODE_DEBUGGING ------------------------- +.. versionadded:: 3.15 + Enable Just My Code with Visual Studio debugger. Supported on :ref:`Visual Studio Generators` for VS 2010 and higher, diff --git a/Help/prop_tgt/VS_MOBILE_EXTENSIONS_VERSION.rst b/Help/prop_tgt/VS_MOBILE_EXTENSIONS_VERSION.rst index be3c9a0..b307e84 100644 --- a/Help/prop_tgt/VS_MOBILE_EXTENSIONS_VERSION.rst +++ b/Help/prop_tgt/VS_MOBILE_EXTENSIONS_VERSION.rst @@ -1,6 +1,8 @@ VS_MOBILE_EXTENSIONS_VERSION ---------------------------- +.. versionadded:: 3.4 + Visual Studio Windows 10 Mobile Extensions Version Specifies the version of the Mobile Extensions that should be included in the diff --git a/Help/prop_tgt/VS_NO_SOLUTION_DEPLOY.rst b/Help/prop_tgt/VS_NO_SOLUTION_DEPLOY.rst index ffcbde5..bf6ac10 100644 --- a/Help/prop_tgt/VS_NO_SOLUTION_DEPLOY.rst +++ b/Help/prop_tgt/VS_NO_SOLUTION_DEPLOY.rst @@ -1,6 +1,8 @@ VS_NO_SOLUTION_DEPLOY --------------------- +.. versionadded:: 3.15 + Specify that the target should not be marked for deployment to a Windows CE or Windows Phone device in the generated Visual Studio solution. diff --git a/Help/prop_tgt/VS_PACKAGE_REFERENCES.rst b/Help/prop_tgt/VS_PACKAGE_REFERENCES.rst index 5a0465b..ec17567 100644 --- a/Help/prop_tgt/VS_PACKAGE_REFERENCES.rst +++ b/Help/prop_tgt/VS_PACKAGE_REFERENCES.rst @@ -1,6 +1,8 @@ VS_PACKAGE_REFERENCES --------------------- +.. versionadded:: 3.15 + Visual Studio package references for nuget. Adds one or more semicolon-delimited package references to a generated diff --git a/Help/prop_tgt/VS_PLATFORM_TOOLSET.rst b/Help/prop_tgt/VS_PLATFORM_TOOLSET.rst index f8f2e8e..27a92d6 100644 --- a/Help/prop_tgt/VS_PLATFORM_TOOLSET.rst +++ b/Help/prop_tgt/VS_PLATFORM_TOOLSET.rst @@ -1,6 +1,8 @@ VS_PLATFORM_TOOLSET ------------------- +.. versionadded:: 3.18 + Overrides the platform toolset used to build a target. Only supported when the compiler used by the given toolset is the diff --git a/Help/prop_tgt/VS_PROJECT_IMPORT.rst b/Help/prop_tgt/VS_PROJECT_IMPORT.rst index 569c8ea..f5e9698 100644 --- a/Help/prop_tgt/VS_PROJECT_IMPORT.rst +++ b/Help/prop_tgt/VS_PROJECT_IMPORT.rst @@ -1,6 +1,8 @@ VS_PROJECT_IMPORT ----------------- +.. versionadded:: 3.15 + Visual Studio managed project imports Adds to a generated Visual Studio project one or more semicolon-delimited paths diff --git a/Help/prop_tgt/VS_SDK_REFERENCES.rst b/Help/prop_tgt/VS_SDK_REFERENCES.rst index 99987f5..9a082e7 100644 --- a/Help/prop_tgt/VS_SDK_REFERENCES.rst +++ b/Help/prop_tgt/VS_SDK_REFERENCES.rst @@ -1,6 +1,8 @@ VS_SDK_REFERENCES ----------------- +.. versionadded:: 3.7 + Visual Studio project SDK references. Specify a :ref:`semicolon-separated list <CMake Language Lists>` of SDK references to be added to a generated Visual Studio project, e.g. diff --git a/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst b/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst index eef848f..e56f411 100644 --- a/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst +++ b/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst @@ -1,6 +1,8 @@ VS_SOLUTION_DEPLOY ------------------ +.. versionadded:: 3.18 + Specify that the target should be marked for deployment when not targeting Windows CE, Windows Phone or a Windows Store application. diff --git a/Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst b/Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst index 738a912..b5a76fc 100644 --- a/Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst +++ b/Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst @@ -1,6 +1,8 @@ VS_SOURCE_SETTINGS_<tool> ------------------------- +.. versionadded:: 3.18 + Set any item metadata on all non-built files that use <tool>. Takes a list of ``Key=Value`` pairs. Tells the Visual Studio generator diff --git a/Help/prop_tgt/VS_USER_PROPS.rst b/Help/prop_tgt/VS_USER_PROPS.rst index 1be222b..8f2a105 100644 --- a/Help/prop_tgt/VS_USER_PROPS.rst +++ b/Help/prop_tgt/VS_USER_PROPS.rst @@ -1,6 +1,8 @@ VS_USER_PROPS ------------- +.. versionadded:: 3.8 + Sets the user props file to be included in the visual studio C++ project file. The standard path is ``$(UserRootDir)\\Microsoft.Cpp.$(Platform).user.props``, which is diff --git a/Help/prop_tgt/VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION.rst b/Help/prop_tgt/VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION.rst index 1ad7a71..50cf203 100644 --- a/Help/prop_tgt/VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION.rst +++ b/Help/prop_tgt/VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION.rst @@ -1,6 +1,8 @@ VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION -------------------------------------- +.. versionadded:: 3.4 + Visual Studio Windows Target Platform Minimum Version For Windows 10. Specifies the minimum version of the OS that is being diff --git a/Help/prop_tgt/VS_WINRT_COMPONENT.rst b/Help/prop_tgt/VS_WINRT_COMPONENT.rst index e160bd6..8b4aaf7 100644 --- a/Help/prop_tgt/VS_WINRT_COMPONENT.rst +++ b/Help/prop_tgt/VS_WINRT_COMPONENT.rst @@ -1,6 +1,8 @@ VS_WINRT_COMPONENT ------------------ +.. versionadded:: 3.1 + Mark a target as a Windows Runtime component for the Visual Studio generator. Compile the target with ``C++/CX`` language extensions for Windows Runtime. For ``SHARED`` and ``MODULE`` libraries, this also defines the diff --git a/Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst b/Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst index 86711bf..00f32f6 100644 --- a/Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst +++ b/Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst @@ -1,6 +1,8 @@ WINDOWS_EXPORT_ALL_SYMBOLS -------------------------- +.. versionadded:: 3.4 + This property is implemented only for MS-compatible tools on Windows. Enable this boolean property to automatically create a module definition diff --git a/Help/prop_tgt/XCODE_EXPLICIT_FILE_TYPE.rst b/Help/prop_tgt/XCODE_EXPLICIT_FILE_TYPE.rst index dc92902..e01a034 100644 --- a/Help/prop_tgt/XCODE_EXPLICIT_FILE_TYPE.rst +++ b/Help/prop_tgt/XCODE_EXPLICIT_FILE_TYPE.rst @@ -1,6 +1,8 @@ XCODE_EXPLICIT_FILE_TYPE ------------------------ +.. versionadded:: 3.8 + Set the Xcode ``explicitFileType`` attribute on its reference to a target. CMake computes a default based on target type but can be told explicitly with this property. diff --git a/Help/prop_tgt/XCODE_GENERATE_SCHEME.rst b/Help/prop_tgt/XCODE_GENERATE_SCHEME.rst index c32b4de..06a3cf9 100644 --- a/Help/prop_tgt/XCODE_GENERATE_SCHEME.rst +++ b/Help/prop_tgt/XCODE_GENERATE_SCHEME.rst @@ -1,6 +1,8 @@ XCODE_GENERATE_SCHEME --------------------- +.. versionadded:: 3.15 + If enabled, the :generator:`Xcode` generator will generate schema files. These are useful to invoke analyze, archive, build-for-testing and test actions from the command line. diff --git a/Help/prop_tgt/XCODE_PRODUCT_TYPE.rst b/Help/prop_tgt/XCODE_PRODUCT_TYPE.rst index f4ef5c0..17a9c3f 100644 --- a/Help/prop_tgt/XCODE_PRODUCT_TYPE.rst +++ b/Help/prop_tgt/XCODE_PRODUCT_TYPE.rst @@ -1,6 +1,8 @@ XCODE_PRODUCT_TYPE ------------------ +.. versionadded:: 3.8 + Set the Xcode ``productType`` attribute on its reference to a target. CMake computes a default based on target type but can be told explicitly with this property. diff --git a/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER.rst b/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER.rst index cc9bac2..c72ec06 100644 --- a/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER.rst +++ b/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_ADDRESS_SANITIZER ------------------------------ +.. versionadded:: 3.13 + Whether to enable ``Address Sanitizer`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst b/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst index 37a043a..293b5d4 100644 --- a/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst +++ b/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN ----------------------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Detect use of stack after return`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_ARGUMENTS.rst b/Help/prop_tgt/XCODE_SCHEME_ARGUMENTS.rst index 1f228e3..2bfcb41 100644 --- a/Help/prop_tgt/XCODE_SCHEME_ARGUMENTS.rst +++ b/Help/prop_tgt/XCODE_SCHEME_ARGUMENTS.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_ARGUMENTS ---------------------- +.. versionadded:: 3.13 + Specify command line arguments that should be added to the Arguments section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_DEBUG_AS_ROOT.rst b/Help/prop_tgt/XCODE_SCHEME_DEBUG_AS_ROOT.rst index 5407e80..2523deb 100644 --- a/Help/prop_tgt/XCODE_SCHEME_DEBUG_AS_ROOT.rst +++ b/Help/prop_tgt/XCODE_SCHEME_DEBUG_AS_ROOT.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_DEBUG_AS_ROOT -------------------------- +.. versionadded:: 3.15 + Whether to debug the target as 'root'. Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property diff --git a/Help/prop_tgt/XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst b/Help/prop_tgt/XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst index 9afeedd..bbcae35 100644 --- a/Help/prop_tgt/XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst +++ b/Help/prop_tgt/XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING -------------------------------------- +.. versionadded:: 3.16 + Whether to enable ``Allow debugging when using document Versions Browser`` in the Options section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst b/Help/prop_tgt/XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst index 1a6fcfd..3d315a2 100644 --- a/Help/prop_tgt/XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst +++ b/Help/prop_tgt/XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER ---------------------------------------- +.. versionadded:: 3.13 + Whether to disable the ``Main Thread Checker`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst b/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst index 9224022..2ca20f7 100644 --- a/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst +++ b/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS ---------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Dynamic Library Loads`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst b/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst index 203c803..278c9ef 100644 --- a/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst +++ b/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE ------------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Dynamic Linker API usage`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_ENVIRONMENT.rst b/Help/prop_tgt/XCODE_SCHEME_ENVIRONMENT.rst index c6d875e..16542f8 100644 --- a/Help/prop_tgt/XCODE_SCHEME_ENVIRONMENT.rst +++ b/Help/prop_tgt/XCODE_SCHEME_ENVIRONMENT.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_ENVIRONMENT ------------------------ +.. versionadded:: 3.13 + Specify environment variables that should be added to the Arguments section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_EXECUTABLE.rst b/Help/prop_tgt/XCODE_SCHEME_EXECUTABLE.rst index 104841b..b453f10 100644 --- a/Help/prop_tgt/XCODE_SCHEME_EXECUTABLE.rst +++ b/Help/prop_tgt/XCODE_SCHEME_EXECUTABLE.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_EXECUTABLE ----------------------- +.. versionadded:: 3.13 + Specify path to executable in the Info section of the generated Xcode scheme. If not set the schema generator will select the current target if it is actually executable. diff --git a/Help/prop_tgt/XCODE_SCHEME_GUARD_MALLOC.rst b/Help/prop_tgt/XCODE_SCHEME_GUARD_MALLOC.rst index c4e83da..4b242a2 100644 --- a/Help/prop_tgt/XCODE_SCHEME_GUARD_MALLOC.rst +++ b/Help/prop_tgt/XCODE_SCHEME_GUARD_MALLOC.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_GUARD_MALLOC ------------------------------ +.. versionadded:: 3.13 + Whether to enable ``Guard Malloc`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst b/Help/prop_tgt/XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst index 73992c3..2a813aa 100644 --- a/Help/prop_tgt/XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst +++ b/Help/prop_tgt/XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP ------------------------------------- +.. versionadded:: 3.13 + Whether to enable the ``Main Thread Checker`` option ``Pause on issues`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_MALLOC_GUARD_EDGES.rst b/Help/prop_tgt/XCODE_SCHEME_MALLOC_GUARD_EDGES.rst index ca761c0..750da74 100644 --- a/Help/prop_tgt/XCODE_SCHEME_MALLOC_GUARD_EDGES.rst +++ b/Help/prop_tgt/XCODE_SCHEME_MALLOC_GUARD_EDGES.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_MALLOC_GUARD_EDGES ------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Malloc Guard Edges`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_MALLOC_SCRIBBLE.rst b/Help/prop_tgt/XCODE_SCHEME_MALLOC_SCRIBBLE.rst index c5ddb95..4ebd21b 100644 --- a/Help/prop_tgt/XCODE_SCHEME_MALLOC_SCRIBBLE.rst +++ b/Help/prop_tgt/XCODE_SCHEME_MALLOC_SCRIBBLE.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_MALLOC_SCRIBBLE ------------------------------ +.. versionadded:: 3.13 + Whether to enable ``Malloc Scribble`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_MALLOC_STACK.rst b/Help/prop_tgt/XCODE_SCHEME_MALLOC_STACK.rst index 170f33d..5afe34e 100644 --- a/Help/prop_tgt/XCODE_SCHEME_MALLOC_STACK.rst +++ b/Help/prop_tgt/XCODE_SCHEME_MALLOC_STACK.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_MALLOC_STACK ------------------------- +.. versionadded:: 3.13 + Whether to enable ``Malloc Stack`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER.rst b/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER.rst index bb70141..cc774c4 100644 --- a/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER.rst +++ b/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_THREAD_SANITIZER ----------------------------- +.. versionadded:: 3.13 + Whether to enable ``Thread Sanitizer`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER_STOP.rst b/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER_STOP.rst index 5deadb1..3bb2596 100644 --- a/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER_STOP.rst +++ b/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER_STOP.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_THREAD_SANITIZER_STOP ---------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Thread Sanitizer - Pause on issues`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst b/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst index 0cd823d..1146130 100644 --- a/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst +++ b/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER ------------------------------------------ +.. versionadded:: 3.13 + Whether to enable ``Undefined Behavior Sanitizer`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst b/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst index d1a9bca..358f298 100644 --- a/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst +++ b/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP ----------------------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Undefined Behavior Sanitizer`` option ``Pause on issues`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCODE_SCHEME_WORKING_DIRECTORY.rst b/Help/prop_tgt/XCODE_SCHEME_WORKING_DIRECTORY.rst index f538f1d..d8d56fc 100644 --- a/Help/prop_tgt/XCODE_SCHEME_WORKING_DIRECTORY.rst +++ b/Help/prop_tgt/XCODE_SCHEME_WORKING_DIRECTORY.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_WORKING_DIRECTORY ------------------------------ +.. versionadded:: 3.17 + Specify the ``Working Directory`` of the *Run* and *Profile* actions in the generated Xcode scheme. In case the value contains generator expressions those are evaluated. diff --git a/Help/prop_tgt/XCODE_SCHEME_ZOMBIE_OBJECTS.rst b/Help/prop_tgt/XCODE_SCHEME_ZOMBIE_OBJECTS.rst index 6e70e8b..6030109 100644 --- a/Help/prop_tgt/XCODE_SCHEME_ZOMBIE_OBJECTS.rst +++ b/Help/prop_tgt/XCODE_SCHEME_ZOMBIE_OBJECTS.rst @@ -1,6 +1,8 @@ XCODE_SCHEME_ZOMBIE_OBJECTS ------------------------------ +.. versionadded:: 3.13 + Whether to enable ``Zombie Objects`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/prop_tgt/XCTEST.rst b/Help/prop_tgt/XCTEST.rst index eb47e60..67e9a70 100644 --- a/Help/prop_tgt/XCTEST.rst +++ b/Help/prop_tgt/XCTEST.rst @@ -1,6 +1,8 @@ XCTEST ------ +.. versionadded:: 3.3 + This target is a XCTest CFBundle on the Mac. This property will usually get set via the :command:`xctest_add_bundle` diff --git a/Help/release/3.1.rst b/Help/release/3.1.rst index 8bea28f..3f4712b 100644 --- a/Help/release/3.1.rst +++ b/Help/release/3.1.rst @@ -83,7 +83,7 @@ Commands :manual:`generator expression <cmake-generator-expressions(7)>`. * The :command:`string` command learned a new ``UUID`` subcommand - to generate a univerally unique identifier. + to generate a universally unique identifier. * New :command:`target_compile_features` command allows populating the :prop_tgt:`COMPILE_FEATURES` target property, just like any other diff --git a/Help/release/3.3.rst b/Help/release/3.3.rst index 6657e8d..44f4e19 100644 --- a/Help/release/3.3.rst +++ b/Help/release/3.3.rst @@ -196,7 +196,7 @@ CPack :prop_inst:`CPACK_START_MENU_SHORTCUTS`, :prop_inst:`CPACK_DESKTOP_SHORTCUTS` and :prop_inst:`CPACK_STARTUP_SHORTCUTS` installed file properties which can - be used to install shorcuts in the Start Menu, on the Desktop and + be used to install shortcuts in the Start Menu, on the Desktop and in the Startup Folder respectively. Other diff --git a/Help/release/dev/0-sample-topic.rst b/Help/release/dev/0-sample-topic.rst new file mode 100644 index 0000000..e4cc01e --- /dev/null +++ b/Help/release/dev/0-sample-topic.rst @@ -0,0 +1,7 @@ +0-sample-topic +-------------- + +* This is a sample release note for the change in a topic. + Developers should add similar notes for each topic branch + making a noteworthy change. Each document should be named + and titled to match the topic name to avoid merge conflicts. diff --git a/Help/release/dev/CPACK_EXTERNAL_BUILT_PACKAGES.rst b/Help/release/dev/CPACK_EXTERNAL_BUILT_PACKAGES.rst new file mode 100644 index 0000000..af446d2 --- /dev/null +++ b/Help/release/dev/CPACK_EXTERNAL_BUILT_PACKAGES.rst @@ -0,0 +1,4 @@ +CPACK_EXTERNAL_BUILT_PACKAGES +----------------------------- + +* :cpack_gen:`CPack External Generator` learned the :variable:`CPACK_EXTERNAL_BUILT_PACKAGES` variable. diff --git a/Help/release/dev/EXCLUDE_FROM_ALL-genex.rst b/Help/release/dev/EXCLUDE_FROM_ALL-genex.rst new file mode 100644 index 0000000..4d5a83c --- /dev/null +++ b/Help/release/dev/EXCLUDE_FROM_ALL-genex.rst @@ -0,0 +1,5 @@ +EXCLUDE_FROM_ALL-genex +---------------------- + +* The :prop_tgt:`EXCLUDE_FROM_ALL` target property gained support for + :manual:`generator expressions <cmake-generator-expressions(7)>`. diff --git a/Help/release/dev/FindCUDAToolkit-no-nvcc.rst b/Help/release/dev/FindCUDAToolkit-no-nvcc.rst new file mode 100644 index 0000000..e815876 --- /dev/null +++ b/Help/release/dev/FindCUDAToolkit-no-nvcc.rst @@ -0,0 +1,5 @@ +FindCUDAToolkit-no-nvcc +----------------------- + +* The :module:`FindCUDAToolkit` module gained support for finding CUDA toolkits + that do not contain ``nvcc``. diff --git a/Help/release/dev/FindSDL-update.rst b/Help/release/dev/FindSDL-update.rst new file mode 100644 index 0000000..a85d2b9 --- /dev/null +++ b/Help/release/dev/FindSDL-update.rst @@ -0,0 +1,11 @@ +FindSDL-update +-------------- + +* The :module:`FindSDL` module now provides: + + * imported target ``SDL::SDL``, + + * result variables ``SDL_LIBRARIES`` and ``SDL_INCLUDE_DIRS``, + + * version variables ``SDL_VERSION``, ``SDL_VERSION_MAJOR`` + ``SDL_VERSION_MINOR``, and ``SDL_VERSION_PATCH``. diff --git a/Help/release/dev/FindTIFF-tiffxx.rst b/Help/release/dev/FindTIFF-tiffxx.rst new file mode 100644 index 0000000..656d38f --- /dev/null +++ b/Help/release/dev/FindTIFF-tiffxx.rst @@ -0,0 +1,5 @@ +FindTIFF-tiffxx +--------------- + +* The :module:`FindTIFF` module gained a ``CXX`` component to + find the ``tiffxx`` library containing C++ bindings. diff --git a/Help/release/dev/FindVulkan-glslc.rst b/Help/release/dev/FindVulkan-glslc.rst new file mode 100644 index 0000000..246bc8f --- /dev/null +++ b/Help/release/dev/FindVulkan-glslc.rst @@ -0,0 +1,10 @@ +FindVulkan-glslc +---------------- + +* The :module:`FindVulkan` module gained a new output variable + ``Vulkan_GLSLC_EXECUTABLE`` which contains the path to the + GLSL SPIR-V compiler. + +* The :module:`FindVulkan` module gained a new target + ``Vulkan::glslc`` which contains the path to the + GLSL SPIR-V compiler. diff --git a/Help/release/dev/add_test-special-chars-in-name.rst b/Help/release/dev/add_test-special-chars-in-name.rst new file mode 100644 index 0000000..5bb9a23 --- /dev/null +++ b/Help/release/dev/add_test-special-chars-in-name.rst @@ -0,0 +1,6 @@ +add_test-special-chars-in-name +------------------------------ + +* The :command:`add_test` command now (officially) supports whitespace and + other special characters in the name for the test it creates. + See policy :policy:`CMP0110`. diff --git a/Help/release/dev/build-interface-targets.rst b/Help/release/dev/build-interface-targets.rst new file mode 100644 index 0000000..37bded4 --- /dev/null +++ b/Help/release/dev/build-interface-targets.rst @@ -0,0 +1,6 @@ +build-interface-targets +----------------------- + +* :ref:`Interface Libraries` may now have source files added via + :command:`add_library` or :command:`target_sources`. Those + with sources will be generated as part of the build system. diff --git a/Help/release/dev/clang-cl-vfs.rst b/Help/release/dev/clang-cl-vfs.rst new file mode 100644 index 0000000..40b19ef --- /dev/null +++ b/Help/release/dev/clang-cl-vfs.rst @@ -0,0 +1,6 @@ +clang-cl-vfs +------------ + +* A :variable:`CMAKE_CLANG_VFS_OVERLAY` variable was added to tell + Clang to use a VFS overlay to support the Windows SDK when + cross-compiling from hosts with case-sensitive filesystems. diff --git a/Help/release/dev/cmake-E-create_hardlink.rst b/Help/release/dev/cmake-E-create_hardlink.rst new file mode 100644 index 0000000..66cdc87 --- /dev/null +++ b/Help/release/dev/cmake-E-create_hardlink.rst @@ -0,0 +1,5 @@ +cmake-E-create_hardlink +----------------------- + +* The :manual:`cmake(1)` gained a ``-E create_hardlink`` command-line tool + that can be used to create hardlinks between files. diff --git a/Help/release/dev/compiler_flags.rst b/Help/release/dev/compiler_flags.rst new file mode 100644 index 0000000..7138e80 --- /dev/null +++ b/Help/release/dev/compiler_flags.rst @@ -0,0 +1,9 @@ +compiler_flags +----------------- + +* The :variable:`CMAKE_<LANG>_COMPILER` variable may now be used to + store "mandatory" compiler flags like the :envvar:`CC` and other environment variables. + +* The :variable:`CMAKE_<LANG>_FLAGS_INIT` variable will now be considered during + the compiler indentification check if other sources like :variable:`CMAKE_<LANG>_FLAGS` + or :envvar:`CFLAGS` are not set. diff --git a/Help/release/dev/configure_file-permission-control.rst b/Help/release/dev/configure_file-permission-control.rst new file mode 100644 index 0000000..54b52b7 --- /dev/null +++ b/Help/release/dev/configure_file-permission-control.rst @@ -0,0 +1,5 @@ +configure_file-permission-control +--------------------------------- + +* The :command:`configure_file` command gained a ``NO_SOURCE_PERMISSIONS`` + option to suppress copying the input file's permissions to the output file. diff --git a/Help/release/dev/cpack-pre-and-post-build-scripts.rst b/Help/release/dev/cpack-pre-and-post-build-scripts.rst new file mode 100644 index 0000000..bf7958b --- /dev/null +++ b/Help/release/dev/cpack-pre-and-post-build-scripts.rst @@ -0,0 +1,5 @@ +cpack-pre-and-post-build-scripts +-------------------------------- + +* CPack learned the :variable:`CPACK_PRE_BUILD_SCRIPTS`, :variable:`CPACK_POST_BUILD_SCRIPTS`, + and :variable:`CPACK_PACKAGE_FILES` variables. diff --git a/Help/release/dev/cpack-wix-custom-xmlns.rst b/Help/release/dev/cpack-wix-custom-xmlns.rst new file mode 100644 index 0000000..84934cb --- /dev/null +++ b/Help/release/dev/cpack-wix-custom-xmlns.rst @@ -0,0 +1,5 @@ +cpack-wix-custom-xmlns +---------------------- + +* The :cpack_gen:`CPack WIX Generator` gained a + :variable:`CPACK_WIX_CUSTOM_XMLNS` option to specify custom XML namespaces. diff --git a/Help/release/dev/ctest-cuda-memcheck.rst b/Help/release/dev/ctest-cuda-memcheck.rst new file mode 100644 index 0000000..f8f861a --- /dev/null +++ b/Help/release/dev/ctest-cuda-memcheck.rst @@ -0,0 +1,8 @@ +CTest +----- + +* :manual:`ctest(1)` gained support for cuda-memcheck as ``CTEST_MEMORYCHECK_COMMAND``. + The different tools (memcheck, racecheck, synccheck, initcheck) supplied by + cuda-memcheck can be selected by setting the appropriate flags using the + ``CTEST_MEMORYCHECK_COMMAND_OPTIONS`` variable. + The default flags are `--tool memcheck --leak-check full`. diff --git a/Help/release/dev/deprecate-policy-old.rst b/Help/release/dev/deprecate-policy-old.rst new file mode 100644 index 0000000..1dc01cc --- /dev/null +++ b/Help/release/dev/deprecate-policy-old.rst @@ -0,0 +1,13 @@ +deprecate-policy-old +-------------------- + +* An explicit deprecation diagnostic was added for policy ``CMP0071`` + (``CMP0071`` and below were already deprecated). + The :manual:`cmake-policies(7)` manual explains that the OLD behaviors + of all policies are deprecated and that projects should port to the + NEW behaviors. + +* Compatibility with versions of CMake older than 2.8.12 is now deprecated + and will be removed from a future version. Calls to + :command:`cmake_minimum_required` or :command:`cmake_policy` that set + the policy version to an older value now issue a deprecation diagnostic. diff --git a/Help/release/dev/file-download-optional-file.rst b/Help/release/dev/file-download-optional-file.rst new file mode 100644 index 0000000..f3dc24c --- /dev/null +++ b/Help/release/dev/file-download-optional-file.rst @@ -0,0 +1,5 @@ +file-download-optional-file +--------------------------- + +* The ``<file>`` argument is now optional for :command:`file(DOWNLOAD)`. If it + is not specified, the file is not saved. diff --git a/Help/release/dev/fileapi-codemodel-2.2.rst b/Help/release/dev/fileapi-codemodel-2.2.rst new file mode 100644 index 0000000..5954df6 --- /dev/null +++ b/Help/release/dev/fileapi-codemodel-2.2.rst @@ -0,0 +1,7 @@ +fileapi-codemodel-2.2 +--------------------- + +* The :manual:`cmake-file-api(7)` "codemodel" version 2 ``version`` field has + been updated to 2.2. +* The :manual:`cmake-file-api(7)` "codemodel" version 2 "target" object gained + a new ``languageStandard`` field in the ``compileGroups`` objects. diff --git a/Help/release/dev/find_program-exe-no-read.rst b/Help/release/dev/find_program-exe-no-read.rst new file mode 100644 index 0000000..161b5db --- /dev/null +++ b/Help/release/dev/find_program-exe-no-read.rst @@ -0,0 +1,5 @@ +find_program-exe-no-read +------------------------ + +* The :command:`find_program` command now requires permission to execute + but not to read the file found. See policy :policy:`CMP0109`. diff --git a/Help/release/dev/install-default-directory-permissions.rst b/Help/release/dev/install-default-directory-permissions.rst new file mode 100644 index 0000000..27cffee --- /dev/null +++ b/Help/release/dev/install-default-directory-permissions.rst @@ -0,0 +1,5 @@ +install-default-directory-permissions +------------------------------------- + +* The ``--install`` argument of the :manual:`cmake(1)` command line tool gained a + ``--default-directory-permissions`` argument. diff --git a/Help/release/dev/macOS-sdk-latest.rst b/Help/release/dev/macOS-sdk-latest.rst new file mode 100644 index 0000000..c5ac3a6 --- /dev/null +++ b/Help/release/dev/macOS-sdk-latest.rst @@ -0,0 +1,10 @@ +macOS-sdk-latest +---------------- + +* Building for macOS will now use the latest SDK available on the system, + unless the user has explicitly chosen a SDK using :variable:`CMAKE_OSX_SYSROOT`. + + The deployment target or system macOS version will not affect + the choice of SDK. + +* macOS SDKs older than 10.5 are no longer supported. diff --git a/Help/release/dev/optimize-link-dependencies.rst b/Help/release/dev/optimize-link-dependencies.rst new file mode 100644 index 0000000..cfda826 --- /dev/null +++ b/Help/release/dev/optimize-link-dependencies.rst @@ -0,0 +1,7 @@ +optimize-link-dependencies +-------------------------- + +* A new target property, :prop_tgt:`OPTIMIZE_DEPENDENCIES`, was added to + avoid unnecessarily building dependencies for a static library. +* A new variable, :variable:`CMAKE_OPTIMIZE_DEPENDENCIES`, was added to + initialize the :prop_tgt:`OPTIMIZE_DEPENDENCIES` target property. diff --git a/Help/release/dev/remove-cmake-gui-qt4.rst b/Help/release/dev/remove-cmake-gui-qt4.rst new file mode 100644 index 0000000..2b29b75 --- /dev/null +++ b/Help/release/dev/remove-cmake-gui-qt4.rst @@ -0,0 +1,5 @@ +remove-cmake-gui-qt4 +-------------------- + +* :manual:`cmake-gui(1)` now requires Qt5. Support for compiling with Qt4 has + been removed. diff --git a/Help/release/dev/remove-warn-unused-vars.rst b/Help/release/dev/remove-warn-unused-vars.rst new file mode 100644 index 0000000..7a06e91 --- /dev/null +++ b/Help/release/dev/remove-warn-unused-vars.rst @@ -0,0 +1,6 @@ +remove-warn-unused-vars +----------------------- + +* The :manual:`cmake(1)` command-line option ``--warn-unused-vars`` has + been removed and is now silently ignored. The option has not worked + correctly since CMake 3.3. diff --git a/Help/release/dev/visual-studio-android.rst b/Help/release/dev/visual-studio-android.rst new file mode 100644 index 0000000..4e1a110 --- /dev/null +++ b/Help/release/dev/visual-studio-android.rst @@ -0,0 +1,7 @@ +visual-studio-android +--------------------- + +* The :ref:`Visual Studio Generators` for Visual Studio 2015 and above gained + support for the Visual Studio Tools for Android. This allows you to set + :variable:`CMAKE_SYSTEM_NAME` to `Android` to generate `.vcxproj` files for + the Android tools. diff --git a/Help/release/index.rst b/Help/release/index.rst index 4578b3a..cdc3e8b 100644 --- a/Help/release/index.rst +++ b/Help/release/index.rst @@ -7,6 +7,8 @@ CMake Release Notes This file should include the adjacent "dev.txt" file in development versions but not in release versions. +.. include:: dev.txt + Releases ======== diff --git a/Help/variable/ANDROID.rst b/Help/variable/ANDROID.rst index fede4ca..68dccf2 100644 --- a/Help/variable/ANDROID.rst +++ b/Help/variable/ANDROID.rst @@ -1,5 +1,7 @@ ANDROID ------- +.. versionadded:: 3.7 + Set to ``1`` when the target system (:variable:`CMAKE_SYSTEM_NAME`) is ``Android``. diff --git a/Help/variable/CACHE.rst b/Help/variable/CACHE.rst index 2cef27e..d5489c8 100644 --- a/Help/variable/CACHE.rst +++ b/Help/variable/CACHE.rst @@ -1,6 +1,8 @@ CACHE ----- +.. versionadded:: 3.13 + Operator to read cache variables. Use the syntax ``$CACHE{VAR}`` to read cache entry ``VAR``. diff --git a/Help/variable/CMAKE_AIX_EXPORT_ALL_SYMBOLS.rst b/Help/variable/CMAKE_AIX_EXPORT_ALL_SYMBOLS.rst index c64dd48..699fe0f 100644 --- a/Help/variable/CMAKE_AIX_EXPORT_ALL_SYMBOLS.rst +++ b/Help/variable/CMAKE_AIX_EXPORT_ALL_SYMBOLS.rst @@ -1,6 +1,8 @@ CMAKE_AIX_EXPORT_ALL_SYMBOLS ---------------------------- +.. versionadded:: 3.17 + Default value for :prop_tgt:`AIX_EXPORT_ALL_SYMBOLS` target property. This variable is used to initialize the property on each target as it is created. diff --git a/Help/variable/CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS.rst b/Help/variable/CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS.rst index 8862ba9..2d6b4b9 100644 --- a/Help/variable/CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS.rst +++ b/Help/variable/CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS ------------------------------------ +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_ANT_ADDITIONAL_OPTIONS` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_API.rst b/Help/variable/CMAKE_ANDROID_API.rst index c07a05a..4388bf2 100644 --- a/Help/variable/CMAKE_ANDROID_API.rst +++ b/Help/variable/CMAKE_ANDROID_API.rst @@ -1,6 +1,8 @@ CMAKE_ANDROID_API ----------------- +.. versionadded:: 3.1 + When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition`, this variable may be set to specify the default value for the :prop_tgt:`ANDROID_API` target property. See that target property for diff --git a/Help/variable/CMAKE_ANDROID_API_MIN.rst b/Help/variable/CMAKE_ANDROID_API_MIN.rst index 0246c75..a0d2ab4 100644 --- a/Help/variable/CMAKE_ANDROID_API_MIN.rst +++ b/Help/variable/CMAKE_ANDROID_API_MIN.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_API_MIN --------------------- +.. versionadded:: 3.2 + Default value for the :prop_tgt:`ANDROID_API_MIN` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_ARCH.rst b/Help/variable/CMAKE_ANDROID_ARCH.rst index b91ca57..9f12742 100644 --- a/Help/variable/CMAKE_ANDROID_ARCH.rst +++ b/Help/variable/CMAKE_ANDROID_ARCH.rst @@ -1,6 +1,8 @@ CMAKE_ANDROID_ARCH ------------------ +.. versionadded:: 3.4 + When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition`, this variable may be set to specify the default value for the :prop_tgt:`ANDROID_ARCH` target property. See that target property for diff --git a/Help/variable/CMAKE_ANDROID_ARCH_ABI.rst b/Help/variable/CMAKE_ANDROID_ARCH_ABI.rst index 0a3ed3c..5a2e3ec 100644 --- a/Help/variable/CMAKE_ANDROID_ARCH_ABI.rst +++ b/Help/variable/CMAKE_ANDROID_ARCH_ABI.rst @@ -1,6 +1,8 @@ CMAKE_ANDROID_ARCH_ABI ---------------------- +.. versionadded:: 3.7 + When :ref:`Cross Compiling for Android`, this variable specifies the target architecture and ABI to be used. Valid values are: diff --git a/Help/variable/CMAKE_ANDROID_ARM_MODE.rst b/Help/variable/CMAKE_ANDROID_ARM_MODE.rst index ad3c37c..973ff7e 100644 --- a/Help/variable/CMAKE_ANDROID_ARM_MODE.rst +++ b/Help/variable/CMAKE_ANDROID_ARM_MODE.rst @@ -1,6 +1,8 @@ CMAKE_ANDROID_ARM_MODE ---------------------- +.. versionadded:: 3.7 + When :ref:`Cross Compiling for Android` and :variable:`CMAKE_ANDROID_ARCH_ABI` is set to one of the ``armeabi`` architectures, set ``CMAKE_ANDROID_ARM_MODE`` to ``ON`` to target 32-bit ARM processors (``-marm``). Otherwise, the diff --git a/Help/variable/CMAKE_ANDROID_ARM_NEON.rst b/Help/variable/CMAKE_ANDROID_ARM_NEON.rst index 4b7ae03..6b9cf08 100644 --- a/Help/variable/CMAKE_ANDROID_ARM_NEON.rst +++ b/Help/variable/CMAKE_ANDROID_ARM_NEON.rst @@ -1,6 +1,8 @@ CMAKE_ANDROID_ARM_NEON ---------------------- +.. versionadded:: 3.7 + When :ref:`Cross Compiling for Android` and :variable:`CMAKE_ANDROID_ARCH_ABI` is set to ``armeabi-v7a`` set ``CMAKE_ANDROID_ARM_NEON`` to ``ON`` to target ARM NEON devices. diff --git a/Help/variable/CMAKE_ANDROID_ASSETS_DIRECTORIES.rst b/Help/variable/CMAKE_ANDROID_ASSETS_DIRECTORIES.rst index c372fe4..3de2be4 100644 --- a/Help/variable/CMAKE_ANDROID_ASSETS_DIRECTORIES.rst +++ b/Help/variable/CMAKE_ANDROID_ASSETS_DIRECTORIES.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_ASSETS_DIRECTORIES -------------------------------- +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_ASSETS_DIRECTORIES` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_GUI.rst b/Help/variable/CMAKE_ANDROID_GUI.rst index 1755375..821bbee 100644 --- a/Help/variable/CMAKE_ANDROID_GUI.rst +++ b/Help/variable/CMAKE_ANDROID_GUI.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_GUI ----------------- +.. versionadded:: 3.1 + Default value for the :prop_tgt:`ANDROID_GUI` target property of executables. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_JAR_DEPENDENCIES.rst b/Help/variable/CMAKE_ANDROID_JAR_DEPENDENCIES.rst index 451a929..80ab842 100644 --- a/Help/variable/CMAKE_ANDROID_JAR_DEPENDENCIES.rst +++ b/Help/variable/CMAKE_ANDROID_JAR_DEPENDENCIES.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_JAR_DEPENDENCIES ------------------------------ +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_JAR_DEPENDENCIES` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_JAR_DIRECTORIES.rst b/Help/variable/CMAKE_ANDROID_JAR_DIRECTORIES.rst index af83e34..4d148d8 100644 --- a/Help/variable/CMAKE_ANDROID_JAR_DIRECTORIES.rst +++ b/Help/variable/CMAKE_ANDROID_JAR_DIRECTORIES.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_JAR_DIRECTORIES ----------------------------- +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_JAR_DIRECTORIES` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_JAVA_SOURCE_DIR.rst b/Help/variable/CMAKE_ANDROID_JAVA_SOURCE_DIR.rst index 3dc05e0..021baa0 100644 --- a/Help/variable/CMAKE_ANDROID_JAVA_SOURCE_DIR.rst +++ b/Help/variable/CMAKE_ANDROID_JAVA_SOURCE_DIR.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_JAVA_SOURCE_DIR ----------------------------- +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_JAVA_SOURCE_DIR` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES.rst b/Help/variable/CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES.rst index 4191907..41d4cc3 100644 --- a/Help/variable/CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES.rst +++ b/Help/variable/CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES ------------------------------------- +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_NATIVE_LIB_DEPENDENCIES` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES.rst b/Help/variable/CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES.rst index 7cb9527..e87547d 100644 --- a/Help/variable/CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES.rst +++ b/Help/variable/CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES ------------------------------------ +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_NATIVE_LIB_DIRECTORIES` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_NDK.rst b/Help/variable/CMAKE_ANDROID_NDK.rst index d241dd0..72ac99e 100644 --- a/Help/variable/CMAKE_ANDROID_NDK.rst +++ b/Help/variable/CMAKE_ANDROID_NDK.rst @@ -1,6 +1,8 @@ CMAKE_ANDROID_NDK ----------------- +.. versionadded:: 3.7 + When :ref:`Cross Compiling for Android with the NDK`, this variable holds the absolute path to the root directory of the NDK. The directory must contain a ``platforms`` subdirectory holding the ``android-<api>`` diff --git a/Help/variable/CMAKE_ANDROID_NDK_DEPRECATED_HEADERS.rst b/Help/variable/CMAKE_ANDROID_NDK_DEPRECATED_HEADERS.rst index 8ea1257..40a5c1a 100644 --- a/Help/variable/CMAKE_ANDROID_NDK_DEPRECATED_HEADERS.rst +++ b/Help/variable/CMAKE_ANDROID_NDK_DEPRECATED_HEADERS.rst @@ -1,6 +1,8 @@ CMAKE_ANDROID_NDK_DEPRECATED_HEADERS ------------------------------------ +.. versionadded:: 3.9 + When :ref:`Cross Compiling for Android with the NDK`, this variable may be set to specify whether to use the deprecated per-api-level headers instead of the unified headers. diff --git a/Help/variable/CMAKE_ANDROID_NDK_TOOLCHAIN_HOST_TAG.rst b/Help/variable/CMAKE_ANDROID_NDK_TOOLCHAIN_HOST_TAG.rst index 207019a..9d61fa4 100644 --- a/Help/variable/CMAKE_ANDROID_NDK_TOOLCHAIN_HOST_TAG.rst +++ b/Help/variable/CMAKE_ANDROID_NDK_TOOLCHAIN_HOST_TAG.rst @@ -1,6 +1,8 @@ CMAKE_ANDROID_NDK_TOOLCHAIN_HOST_TAG ------------------------------------ +.. versionadded:: 3.7.1 + When :ref:`Cross Compiling for Android with the NDK`, this variable provides the NDK's "host tag" used to construct the path to prebuilt toolchains that run on the host. diff --git a/Help/variable/CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION.rst b/Help/variable/CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION.rst index 22808e3..15fe18f 100644 --- a/Help/variable/CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION.rst +++ b/Help/variable/CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION.rst @@ -1,6 +1,8 @@ CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION ----------------------------------- +.. versionadded:: 3.7 + When :ref:`Cross Compiling for Android with the NDK`, this variable may be set to specify the version of the toolchain to be used as the compiler. diff --git a/Help/variable/CMAKE_ANDROID_PROCESS_MAX.rst b/Help/variable/CMAKE_ANDROID_PROCESS_MAX.rst index 19fb527..be241c2 100644 --- a/Help/variable/CMAKE_ANDROID_PROCESS_MAX.rst +++ b/Help/variable/CMAKE_ANDROID_PROCESS_MAX.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_PROCESS_MAX ------------------------- +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_PROCESS_MAX` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_PROGUARD.rst b/Help/variable/CMAKE_ANDROID_PROGUARD.rst index b8fdd46..bb001d3 100644 --- a/Help/variable/CMAKE_ANDROID_PROGUARD.rst +++ b/Help/variable/CMAKE_ANDROID_PROGUARD.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_PROGUARD ---------------------- +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_PROGUARD` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_PROGUARD_CONFIG_PATH.rst b/Help/variable/CMAKE_ANDROID_PROGUARD_CONFIG_PATH.rst index 8dea009..6fd4067 100644 --- a/Help/variable/CMAKE_ANDROID_PROGUARD_CONFIG_PATH.rst +++ b/Help/variable/CMAKE_ANDROID_PROGUARD_CONFIG_PATH.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_PROGUARD_CONFIG_PATH ---------------------------------- +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_PROGUARD_CONFIG_PATH` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_SECURE_PROPS_PATH.rst b/Help/variable/CMAKE_ANDROID_SECURE_PROPS_PATH.rst index 69a4d0b..9f5743e 100644 --- a/Help/variable/CMAKE_ANDROID_SECURE_PROPS_PATH.rst +++ b/Help/variable/CMAKE_ANDROID_SECURE_PROPS_PATH.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_SECURE_PROPS_PATH ------------------------------- +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_SECURE_PROPS_PATH` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_SKIP_ANT_STEP.rst b/Help/variable/CMAKE_ANDROID_SKIP_ANT_STEP.rst index 0a96df9..588769b 100644 --- a/Help/variable/CMAKE_ANDROID_SKIP_ANT_STEP.rst +++ b/Help/variable/CMAKE_ANDROID_SKIP_ANT_STEP.rst @@ -1,5 +1,7 @@ CMAKE_ANDROID_SKIP_ANT_STEP --------------------------- +.. versionadded:: 3.4 + Default value for the :prop_tgt:`ANDROID_SKIP_ANT_STEP` target property. See that target property for additional information. diff --git a/Help/variable/CMAKE_ANDROID_STANDALONE_TOOLCHAIN.rst b/Help/variable/CMAKE_ANDROID_STANDALONE_TOOLCHAIN.rst index ea62cab..3ca89f5 100644 --- a/Help/variable/CMAKE_ANDROID_STANDALONE_TOOLCHAIN.rst +++ b/Help/variable/CMAKE_ANDROID_STANDALONE_TOOLCHAIN.rst @@ -1,6 +1,8 @@ CMAKE_ANDROID_STANDALONE_TOOLCHAIN ---------------------------------- +.. versionadded:: 3.7 + When :ref:`Cross Compiling for Android with a Standalone Toolchain`, this variable holds the absolute path to the root directory of the toolchain. The specified directory must contain a ``sysroot`` subdirectory. diff --git a/Help/variable/CMAKE_ANDROID_STL_TYPE.rst b/Help/variable/CMAKE_ANDROID_STL_TYPE.rst index d174575..3778181 100644 --- a/Help/variable/CMAKE_ANDROID_STL_TYPE.rst +++ b/Help/variable/CMAKE_ANDROID_STL_TYPE.rst @@ -1,6 +1,8 @@ CMAKE_ANDROID_STL_TYPE ---------------------- +.. versionadded:: 3.4 + When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition`, this variable may be set to specify the default value for the :prop_tgt:`ANDROID_STL_TYPE` target property. See that target property diff --git a/Help/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst b/Help/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst index 94c2b6e..d8bd82c 100644 --- a/Help/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst +++ b/Help/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst @@ -1,6 +1,8 @@ CMAKE_ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> --------------------------------------- +.. versionadded:: 3.3 + Where to put all the :ref:`ARCHIVE <Archive Output Artifacts>` target files when built for a specific configuration. diff --git a/Help/variable/CMAKE_AUTOGEN_ORIGIN_DEPENDS.rst b/Help/variable/CMAKE_AUTOGEN_ORIGIN_DEPENDS.rst index 1398e78..c24e462 100644 --- a/Help/variable/CMAKE_AUTOGEN_ORIGIN_DEPENDS.rst +++ b/Help/variable/CMAKE_AUTOGEN_ORIGIN_DEPENDS.rst @@ -1,6 +1,8 @@ CMAKE_AUTOGEN_ORIGIN_DEPENDS ---------------------------- +.. versionadded:: 3.14 + Switch for forwarding origin target dependencies to the corresponding ``_autogen`` targets. diff --git a/Help/variable/CMAKE_AUTOGEN_PARALLEL.rst b/Help/variable/CMAKE_AUTOGEN_PARALLEL.rst index dd9499a..2ada012 100644 --- a/Help/variable/CMAKE_AUTOGEN_PARALLEL.rst +++ b/Help/variable/CMAKE_AUTOGEN_PARALLEL.rst @@ -1,6 +1,8 @@ CMAKE_AUTOGEN_PARALLEL ---------------------- +.. versionadded:: 3.11 + Number of parallel ``moc`` or ``uic`` processes to start when using :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`. diff --git a/Help/variable/CMAKE_AUTOGEN_VERBOSE.rst b/Help/variable/CMAKE_AUTOGEN_VERBOSE.rst index bad9cf2..f77ed6a 100644 --- a/Help/variable/CMAKE_AUTOGEN_VERBOSE.rst +++ b/Help/variable/CMAKE_AUTOGEN_VERBOSE.rst @@ -1,6 +1,8 @@ CMAKE_AUTOGEN_VERBOSE --------------------- +.. versionadded:: 3.13 + 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. diff --git a/Help/variable/CMAKE_AUTOMOC_COMPILER_PREDEFINES.rst b/Help/variable/CMAKE_AUTOMOC_COMPILER_PREDEFINES.rst index 7e1c53d..f1b03a0 100644 --- a/Help/variable/CMAKE_AUTOMOC_COMPILER_PREDEFINES.rst +++ b/Help/variable/CMAKE_AUTOMOC_COMPILER_PREDEFINES.rst @@ -1,6 +1,8 @@ CMAKE_AUTOMOC_COMPILER_PREDEFINES --------------------------------- +.. versionadded:: 3.10 + This variable is used to initialize the :prop_tgt:`AUTOMOC_COMPILER_PREDEFINES` property on all the targets. See that target property for additional information. diff --git a/Help/variable/CMAKE_AUTOMOC_DEPEND_FILTERS.rst b/Help/variable/CMAKE_AUTOMOC_DEPEND_FILTERS.rst index 5c3662d..2c1551a 100644 --- a/Help/variable/CMAKE_AUTOMOC_DEPEND_FILTERS.rst +++ b/Help/variable/CMAKE_AUTOMOC_DEPEND_FILTERS.rst @@ -1,6 +1,8 @@ CMAKE_AUTOMOC_DEPEND_FILTERS ---------------------------- +.. versionadded:: 3.9 + Filter definitions used by :variable:`CMAKE_AUTOMOC` to extract file names from source code as additional dependencies for the ``moc`` file. diff --git a/Help/variable/CMAKE_AUTOMOC_MACRO_NAMES.rst b/Help/variable/CMAKE_AUTOMOC_MACRO_NAMES.rst index ba1b9d2..8e34df2 100644 --- a/Help/variable/CMAKE_AUTOMOC_MACRO_NAMES.rst +++ b/Help/variable/CMAKE_AUTOMOC_MACRO_NAMES.rst @@ -1,6 +1,8 @@ CMAKE_AUTOMOC_MACRO_NAMES ---------------------------- +.. versionadded:: 3.10 + :ref:`Semicolon-separated list <CMake Language Lists>` list of macro names used by :variable:`CMAKE_AUTOMOC` to determine if a C++ file needs to be processed by ``moc``. diff --git a/Help/variable/CMAKE_AUTOMOC_PATH_PREFIX.rst b/Help/variable/CMAKE_AUTOMOC_PATH_PREFIX.rst index 1e9790f..42f48b4 100644 --- a/Help/variable/CMAKE_AUTOMOC_PATH_PREFIX.rst +++ b/Help/variable/CMAKE_AUTOMOC_PATH_PREFIX.rst @@ -1,6 +1,8 @@ CMAKE_AUTOMOC_PATH_PREFIX ------------------------- +.. versionadded:: 3.16 + Whether to generate the ``-p`` path prefix option for ``moc`` on :prop_tgt:`AUTOMOC` enabled Qt targets. diff --git a/Help/variable/CMAKE_AUTOUIC_SEARCH_PATHS.rst b/Help/variable/CMAKE_AUTOUIC_SEARCH_PATHS.rst index aa132bf..0262368 100644 --- a/Help/variable/CMAKE_AUTOUIC_SEARCH_PATHS.rst +++ b/Help/variable/CMAKE_AUTOUIC_SEARCH_PATHS.rst @@ -1,6 +1,8 @@ CMAKE_AUTOUIC_SEARCH_PATHS -------------------------- +.. versionadded:: 3.9 + Search path list used by :variable:`CMAKE_AUTOUIC` to find included ``.ui`` files. diff --git a/Help/variable/CMAKE_BUILD_RPATH.rst b/Help/variable/CMAKE_BUILD_RPATH.rst index f5d53b8..7a8ace7 100644 --- a/Help/variable/CMAKE_BUILD_RPATH.rst +++ b/Help/variable/CMAKE_BUILD_RPATH.rst @@ -1,6 +1,8 @@ CMAKE_BUILD_RPATH ----------------- +.. versionadded:: 3.8 + :ref:`Semicolon-separated list <CMake Language Lists>` specifying runtime path (``RPATH``) entries to add to binaries linked in the build tree (for platforms that support it). The entries will *not* be used for binaries in the install diff --git a/Help/variable/CMAKE_BUILD_RPATH_USE_ORIGIN.rst b/Help/variable/CMAKE_BUILD_RPATH_USE_ORIGIN.rst index e34ede6..ecd9278 100644 --- a/Help/variable/CMAKE_BUILD_RPATH_USE_ORIGIN.rst +++ b/Help/variable/CMAKE_BUILD_RPATH_USE_ORIGIN.rst @@ -1,6 +1,8 @@ CMAKE_BUILD_RPATH_USE_ORIGIN ---------------------------- +.. versionadded:: 3.14 + Whether to use relative paths for the build ``RPATH``. This is used to initialize the :prop_tgt:`BUILD_RPATH_USE_ORIGIN` target diff --git a/Help/variable/CMAKE_BUILD_WITH_INSTALL_NAME_DIR.rst b/Help/variable/CMAKE_BUILD_WITH_INSTALL_NAME_DIR.rst index 30d5d3b..5ba775c 100644 --- a/Help/variable/CMAKE_BUILD_WITH_INSTALL_NAME_DIR.rst +++ b/Help/variable/CMAKE_BUILD_WITH_INSTALL_NAME_DIR.rst @@ -1,6 +1,8 @@ CMAKE_BUILD_WITH_INSTALL_NAME_DIR --------------------------------- +.. versionadded:: 3.9 + Whether to use :prop_tgt:`INSTALL_NAME_DIR` on targets in the build tree. This variable is used to initialize the :prop_tgt:`BUILD_WITH_INSTALL_NAME_DIR` diff --git a/Help/variable/CMAKE_CLANG_VFS_OVERLAY.rst b/Help/variable/CMAKE_CLANG_VFS_OVERLAY.rst new file mode 100644 index 0000000..56ac328 --- /dev/null +++ b/Help/variable/CMAKE_CLANG_VFS_OVERLAY.rst @@ -0,0 +1,9 @@ +CMAKE_CLANG_VFS_OVERLAY +----------------------- + +.. versionadded:: 3.19 + +When cross compiling for windows with clang-cl, this variable can be an +absolute path pointing to a clang virtual file system yaml file, which +will enable clang-cl to resolve windows header names on a case sensitive +file system. diff --git a/Help/variable/CMAKE_CODEBLOCKS_COMPILER_ID.rst b/Help/variable/CMAKE_CODEBLOCKS_COMPILER_ID.rst index ad2709d..0b2b0a0 100644 --- a/Help/variable/CMAKE_CODEBLOCKS_COMPILER_ID.rst +++ b/Help/variable/CMAKE_CODEBLOCKS_COMPILER_ID.rst @@ -1,6 +1,8 @@ CMAKE_CODEBLOCKS_COMPILER_ID ---------------------------- +.. versionadded:: 3.11 + Change the compiler id in the generated CodeBlocks project files. CodeBlocks uses its own compiler id string which differs from diff --git a/Help/variable/CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES.rst b/Help/variable/CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES.rst index 80ffce3..dbb8606 100644 --- a/Help/variable/CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES.rst +++ b/Help/variable/CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES.rst @@ -1,6 +1,8 @@ CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES --------------------------------------- +.. versionadded:: 3.10 + Change the way the CodeBlocks generator creates project files. If this variable evaluates to ``ON`` the generator excludes from diff --git a/Help/variable/CMAKE_CODELITE_USE_TARGETS.rst b/Help/variable/CMAKE_CODELITE_USE_TARGETS.rst index 33cdf6c..21af5f7 100644 --- a/Help/variable/CMAKE_CODELITE_USE_TARGETS.rst +++ b/Help/variable/CMAKE_CODELITE_USE_TARGETS.rst @@ -1,6 +1,8 @@ CMAKE_CODELITE_USE_TARGETS -------------------------- +.. versionadded:: 3.7 + Change the way the CodeLite generator creates projectfiles. If this variable evaluates to ``ON`` at the end of the top-level diff --git a/Help/variable/CMAKE_COMPILER_IS_GNUCC.rst b/Help/variable/CMAKE_COMPILER_IS_GNUCC.rst index a40667e..91cf848 100644 --- a/Help/variable/CMAKE_COMPILER_IS_GNUCC.rst +++ b/Help/variable/CMAKE_COMPILER_IS_GNUCC.rst @@ -1,5 +1,7 @@ CMAKE_COMPILER_IS_GNUCC ----------------------- +.. versionadded:: 3.7 + True if the ``C`` compiler is GNU. Use :variable:`CMAKE_C_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` instead. diff --git a/Help/variable/CMAKE_COMPILER_IS_GNUCXX.rst b/Help/variable/CMAKE_COMPILER_IS_GNUCXX.rst index f1f5cf7..e67718a 100644 --- a/Help/variable/CMAKE_COMPILER_IS_GNUCXX.rst +++ b/Help/variable/CMAKE_COMPILER_IS_GNUCXX.rst @@ -1,5 +1,7 @@ CMAKE_COMPILER_IS_GNUCXX ------------------------ +.. versionadded:: 3.7 + True if the C++ (``CXX``) compiler is GNU. Use :variable:`CMAKE_CXX_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` instead. diff --git a/Help/variable/CMAKE_COMPILER_IS_GNUG77.rst b/Help/variable/CMAKE_COMPILER_IS_GNUG77.rst index 3d6dab4..f69c01a 100644 --- a/Help/variable/CMAKE_COMPILER_IS_GNUG77.rst +++ b/Help/variable/CMAKE_COMPILER_IS_GNUG77.rst @@ -1,5 +1,7 @@ CMAKE_COMPILER_IS_GNUG77 ------------------------ +.. versionadded:: 3.7 + True if the ``Fortran`` compiler is GNU. Use :variable:`CMAKE_Fortran_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` instead. diff --git a/Help/variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY.rst b/Help/variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY.rst index ea33c7d..11f52c7 100644 --- a/Help/variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY.rst +++ b/Help/variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY.rst @@ -1,6 +1,8 @@ CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY ---------------------------------- +.. versionadded:: 3.1 + Output directory for MS debug symbol ``.pdb`` files generated by the compiler while building source files. diff --git a/Help/variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst b/Help/variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst index fdeb9ab..99d0bdc 100644 --- a/Help/variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst +++ b/Help/variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -1,6 +1,8 @@ CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG> ------------------------------------------- +.. versionadded:: 3.1 + Per-configuration output directory for MS debug symbol ``.pdb`` files generated by the compiler while building source files. diff --git a/Help/variable/CMAKE_CPACK_COMMAND.rst b/Help/variable/CMAKE_CPACK_COMMAND.rst index 559108a..3a81d68 100644 --- a/Help/variable/CMAKE_CPACK_COMMAND.rst +++ b/Help/variable/CMAKE_CPACK_COMMAND.rst @@ -1,6 +1,8 @@ CMAKE_CPACK_COMMAND ------------------- +.. versionadded:: 3.13 + Full path to :manual:`cpack(1)` command installed with CMake. This is the full path to the CPack executable :manual:`cpack(1)` which is diff --git a/Help/variable/CMAKE_CROSSCOMPILING_EMULATOR.rst b/Help/variable/CMAKE_CROSSCOMPILING_EMULATOR.rst index 1d013b7..815da00 100644 --- a/Help/variable/CMAKE_CROSSCOMPILING_EMULATOR.rst +++ b/Help/variable/CMAKE_CROSSCOMPILING_EMULATOR.rst @@ -1,6 +1,8 @@ CMAKE_CROSSCOMPILING_EMULATOR ----------------------------- +.. versionadded:: 3.3 + This variable is only used when :variable:`CMAKE_CROSSCOMPILING` is on. It should point to a command on the host system that can run executable built for the target system. diff --git a/Help/variable/CMAKE_CROSS_CONFIGS.rst b/Help/variable/CMAKE_CROSS_CONFIGS.rst index 94157f3..be921d6 100644 --- a/Help/variable/CMAKE_CROSS_CONFIGS.rst +++ b/Help/variable/CMAKE_CROSS_CONFIGS.rst @@ -1,6 +1,8 @@ CMAKE_CROSS_CONFIGS ------------------- +.. versionadded:: 3.17 + Specifies a :ref:`semicolon-separated list <CMake Language Lists>` of configurations available from all ``build-<Config>.ninja`` files in the :generator:`Ninja Multi-Config` generator. This variable activates diff --git a/Help/variable/CMAKE_CTEST_ARGUMENTS.rst b/Help/variable/CMAKE_CTEST_ARGUMENTS.rst index 0940b46..4dfc8fe 100644 --- a/Help/variable/CMAKE_CTEST_ARGUMENTS.rst +++ b/Help/variable/CMAKE_CTEST_ARGUMENTS.rst @@ -1,6 +1,8 @@ CMAKE_CTEST_ARGUMENTS --------------------- +.. versionadded:: 3.17 + Set this to a :ref:`semicolon-separated list <CMake Language Lists>` of command-line arguments to pass to :manual:`ctest(1)` when running tests through the ``test`` (or ``RUN_TESTS``) target of the generated build system. diff --git a/Help/variable/CMAKE_CUDA_ARCHITECTURES.rst b/Help/variable/CMAKE_CUDA_ARCHITECTURES.rst index 149bffa..985040d 100644 --- a/Help/variable/CMAKE_CUDA_ARCHITECTURES.rst +++ b/Help/variable/CMAKE_CUDA_ARCHITECTURES.rst @@ -1,6 +1,8 @@ CMAKE_CUDA_ARCHITECTURES ------------------------ +.. versionadded:: 3.18 + Default value for :prop_tgt:`CUDA_ARCHITECTURES` property of targets. This is initialized as follows depending on :variable:`CMAKE_CUDA_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>`: diff --git a/Help/variable/CMAKE_CUDA_COMPILE_FEATURES.rst b/Help/variable/CMAKE_CUDA_COMPILE_FEATURES.rst index 2cd2650..c1c270c 100644 --- a/Help/variable/CMAKE_CUDA_COMPILE_FEATURES.rst +++ b/Help/variable/CMAKE_CUDA_COMPILE_FEATURES.rst @@ -1,6 +1,8 @@ CMAKE_CUDA_COMPILE_FEATURES --------------------------- +.. versionadded:: 3.17 + List of features known to the CUDA compiler These features are known to be available for use with the CUDA compiler. This diff --git a/Help/variable/CMAKE_CUDA_EXTENSIONS.rst b/Help/variable/CMAKE_CUDA_EXTENSIONS.rst index 4fe758e..b86c0ea 100644 --- a/Help/variable/CMAKE_CUDA_EXTENSIONS.rst +++ b/Help/variable/CMAKE_CUDA_EXTENSIONS.rst @@ -1,6 +1,8 @@ CMAKE_CUDA_EXTENSIONS --------------------- +.. versionadded:: 3.8 + Default value for :prop_tgt:`CUDA_EXTENSIONS` property of targets. This variable is used to initialize the :prop_tgt:`CUDA_EXTENSIONS` diff --git a/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst b/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst index 6d34c5c..07342b5 100644 --- a/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst +++ b/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst @@ -1,8 +1,25 @@ CMAKE_CUDA_HOST_COMPILER ------------------------ -Executable to use when compiling host code when compiling ``CUDA`` language -files. Maps to the ``nvcc -ccbin`` option. Will only be used by CMake on the first -configuration to determine a valid host compiler for ``CUDA``. After a valid -host compiler has been found, this value is read-only. This variable takes -priority over the :envvar:`CUDAHOSTCXX` environment variable. +.. versionadded:: 3.10 + +When :variable:`CMAKE_CUDA_COMPILER <CMAKE_<LANG>_COMPILER>` is set to +NVIDIA ``nvcc``, ``CMAKE_CUDA_HOST_COMPILER`` selects the compiler +executable to use when compiling host code for ``CUDA`` language files. +This maps to the ``nvcc -ccbin`` option. + +The ``CMAKE_CUDA_HOST_COMPILER`` variable may be set explicitly before CUDA is +first enabled by a :command:`project` or :command:`enable_language` command. +This can be done via ``-DCMAKE_CUDA_HOST_COMPILER=...`` on the command line +or in a :ref:`toolchain file <Cross Compiling Toolchain>`. Or, one may set +the :envvar:`CUDAHOSTCXX` environment variable to provide a default value. + +Once the CUDA language is enabled, the ``CMAKE_CUDA_HOST_COMPILER`` variable +is read-only and changes to it are undefined behavior. + +.. note:: + + Since ``CMAKE_CUDA_HOST_COMPILER`` is meaningful only when the + ``CMAKE_CUDA_COMPILER`` is ``nvcc``, it does not make sense to + set ``CMAKE_CUDA_HOST_COMPILER`` explicitly without also setting + ``CMAKE_CUDA_COMPILER`` explicitly to be sure it is ``nvcc``. diff --git a/Help/variable/CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS.rst b/Help/variable/CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS.rst index fc835cd..474baee 100644 --- a/Help/variable/CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS.rst +++ b/Help/variable/CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS.rst @@ -1,6 +1,8 @@ CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS --------------------------------- +.. versionadded:: 3.16 + Default value for :prop_tgt:`CUDA_RESOLVE_DEVICE_SYMBOLS` target property. This variable is used to initialize the property on each target as it is created. diff --git a/Help/variable/CMAKE_CUDA_RUNTIME_LIBRARY.rst b/Help/variable/CMAKE_CUDA_RUNTIME_LIBRARY.rst index e3205d3..69b9d93 100644 --- a/Help/variable/CMAKE_CUDA_RUNTIME_LIBRARY.rst +++ b/Help/variable/CMAKE_CUDA_RUNTIME_LIBRARY.rst @@ -1,6 +1,8 @@ CMAKE_CUDA_RUNTIME_LIBRARY -------------------------- +.. versionadded:: 3.17 + Select the CUDA runtime library for use when compiling and linking CUDA. This variable is used to initialize the :prop_tgt:`CUDA_RUNTIME_LIBRARY` property on all targets as they are created. diff --git a/Help/variable/CMAKE_CUDA_SEPARABLE_COMPILATION.rst b/Help/variable/CMAKE_CUDA_SEPARABLE_COMPILATION.rst index eef92fb..3dbaef9 100644 --- a/Help/variable/CMAKE_CUDA_SEPARABLE_COMPILATION.rst +++ b/Help/variable/CMAKE_CUDA_SEPARABLE_COMPILATION.rst @@ -1,6 +1,8 @@ CMAKE_CUDA_SEPARABLE_COMPILATION -------------------------------- +.. versionadded:: 3.11 + Default value for :prop_tgt:`CUDA_SEPARABLE_COMPILATION` target property. This variable is used to initialize the property on each target as it is created. diff --git a/Help/variable/CMAKE_CUDA_STANDARD.rst b/Help/variable/CMAKE_CUDA_STANDARD.rst index 6c23031..798ab1e 100644 --- a/Help/variable/CMAKE_CUDA_STANDARD.rst +++ b/Help/variable/CMAKE_CUDA_STANDARD.rst @@ -1,6 +1,8 @@ CMAKE_CUDA_STANDARD ------------------- +.. versionadded:: 3.8 + Default value for :prop_tgt:`CUDA_STANDARD` property of targets. This variable is used to initialize the :prop_tgt:`CUDA_STANDARD` diff --git a/Help/variable/CMAKE_CUDA_STANDARD_REQUIRED.rst b/Help/variable/CMAKE_CUDA_STANDARD_REQUIRED.rst index 935d605..ae2f52f 100644 --- a/Help/variable/CMAKE_CUDA_STANDARD_REQUIRED.rst +++ b/Help/variable/CMAKE_CUDA_STANDARD_REQUIRED.rst @@ -1,6 +1,8 @@ CMAKE_CUDA_STANDARD_REQUIRED ---------------------------- +.. versionadded:: 3.8 + Default value for :prop_tgt:`CUDA_STANDARD_REQUIRED` property of targets. This variable is used to initialize the :prop_tgt:`CUDA_STANDARD_REQUIRED` diff --git a/Help/variable/CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES.rst b/Help/variable/CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES.rst index 7de50a5..e586dab 100644 --- a/Help/variable/CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES.rst +++ b/Help/variable/CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES.rst @@ -1,6 +1,8 @@ CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES -------------------------------------- +.. versionadded:: 3.8 + When the ``CUDA`` language has been enabled, this provides a :ref:`semicolon-separated list <CMake Language Lists>` of include directories provided by the CUDA Toolkit. The value may be useful for C++ source files diff --git a/Help/variable/CMAKE_CURRENT_FUNCTION.rst b/Help/variable/CMAKE_CURRENT_FUNCTION.rst index fb7f610..5d1a4e9 100644 --- a/Help/variable/CMAKE_CURRENT_FUNCTION.rst +++ b/Help/variable/CMAKE_CURRENT_FUNCTION.rst @@ -1,6 +1,8 @@ CMAKE_CURRENT_FUNCTION ---------------------- +.. versionadded:: 3.17 + When executing code inside a :command:`function`, this variable contains the name of the current function. It can be useful for diagnostic or debug messages. diff --git a/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_DIR.rst b/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_DIR.rst index 44ae1e5..f8f553d 100644 --- a/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_DIR.rst +++ b/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_DIR.rst @@ -1,6 +1,8 @@ CMAKE_CURRENT_FUNCTION_LIST_DIR ------------------------------- +.. versionadded:: 3.17 + When executing code inside a :command:`function`, this variable contains the full directory of the listfile that defined the current function. diff --git a/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_FILE.rst b/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_FILE.rst index c737af9..437dfec 100644 --- a/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_FILE.rst +++ b/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_FILE.rst @@ -1,6 +1,8 @@ CMAKE_CURRENT_FUNCTION_LIST_FILE -------------------------------- +.. versionadded:: 3.17 + When executing code inside a :command:`function`, this variable contains the full path to the listfile that defined the current function. diff --git a/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_LINE.rst b/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_LINE.rst index ad6282e..2fc7012 100644 --- a/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_LINE.rst +++ b/Help/variable/CMAKE_CURRENT_FUNCTION_LIST_LINE.rst @@ -1,6 +1,8 @@ CMAKE_CURRENT_FUNCTION_LIST_LINE -------------------------------- +.. versionadded:: 3.17 + When executing code inside a :command:`function`, this variable contains the line number in the listfile where the current function was defined. diff --git a/Help/variable/CMAKE_CXX_COMPILE_FEATURES.rst b/Help/variable/CMAKE_CXX_COMPILE_FEATURES.rst index 5c59f95..8fcfbae 100644 --- a/Help/variable/CMAKE_CXX_COMPILE_FEATURES.rst +++ b/Help/variable/CMAKE_CXX_COMPILE_FEATURES.rst @@ -1,6 +1,8 @@ CMAKE_CXX_COMPILE_FEATURES -------------------------- +.. versionadded:: 3.1 + List of features known to the C++ compiler These features are known to be available for use with the C++ compiler. This diff --git a/Help/variable/CMAKE_CXX_EXTENSIONS.rst b/Help/variable/CMAKE_CXX_EXTENSIONS.rst index 4a92425..ea8c4be 100644 --- a/Help/variable/CMAKE_CXX_EXTENSIONS.rst +++ b/Help/variable/CMAKE_CXX_EXTENSIONS.rst @@ -1,6 +1,8 @@ CMAKE_CXX_EXTENSIONS -------------------- +.. versionadded:: 3.1 + Default value for :prop_tgt:`CXX_EXTENSIONS` property of targets. This variable is used to initialize the :prop_tgt:`CXX_EXTENSIONS` diff --git a/Help/variable/CMAKE_CXX_STANDARD.rst b/Help/variable/CMAKE_CXX_STANDARD.rst index 8a8bdff..8ef8c80 100644 --- a/Help/variable/CMAKE_CXX_STANDARD.rst +++ b/Help/variable/CMAKE_CXX_STANDARD.rst @@ -1,6 +1,8 @@ CMAKE_CXX_STANDARD ------------------ +.. versionadded:: 3.1 + Default value for :prop_tgt:`CXX_STANDARD` property of targets. This variable is used to initialize the :prop_tgt:`CXX_STANDARD` diff --git a/Help/variable/CMAKE_CXX_STANDARD_REQUIRED.rst b/Help/variable/CMAKE_CXX_STANDARD_REQUIRED.rst index 4c71058..f7b2ae9 100644 --- a/Help/variable/CMAKE_CXX_STANDARD_REQUIRED.rst +++ b/Help/variable/CMAKE_CXX_STANDARD_REQUIRED.rst @@ -1,6 +1,8 @@ CMAKE_CXX_STANDARD_REQUIRED --------------------------- +.. versionadded:: 3.1 + Default value for :prop_tgt:`CXX_STANDARD_REQUIRED` property of targets. This variable is used to initialize the :prop_tgt:`CXX_STANDARD_REQUIRED` diff --git a/Help/variable/CMAKE_C_COMPILE_FEATURES.rst b/Help/variable/CMAKE_C_COMPILE_FEATURES.rst index 8d1eca0..2b306a3 100644 --- a/Help/variable/CMAKE_C_COMPILE_FEATURES.rst +++ b/Help/variable/CMAKE_C_COMPILE_FEATURES.rst @@ -1,6 +1,8 @@ CMAKE_C_COMPILE_FEATURES ------------------------ +.. versionadded:: 3.1 + List of features known to the C compiler These features are known to be available for use with the C compiler. This diff --git a/Help/variable/CMAKE_C_EXTENSIONS.rst b/Help/variable/CMAKE_C_EXTENSIONS.rst index fa510d4..fce8fc7 100644 --- a/Help/variable/CMAKE_C_EXTENSIONS.rst +++ b/Help/variable/CMAKE_C_EXTENSIONS.rst @@ -1,6 +1,8 @@ CMAKE_C_EXTENSIONS ------------------ +.. versionadded:: 3.1 + Default value for :prop_tgt:`C_EXTENSIONS` property of targets. This variable is used to initialize the :prop_tgt:`C_EXTENSIONS` diff --git a/Help/variable/CMAKE_C_STANDARD.rst b/Help/variable/CMAKE_C_STANDARD.rst index b55e00c..64ef8ce 100644 --- a/Help/variable/CMAKE_C_STANDARD.rst +++ b/Help/variable/CMAKE_C_STANDARD.rst @@ -1,6 +1,8 @@ CMAKE_C_STANDARD ---------------- +.. versionadded:: 3.1 + Default value for :prop_tgt:`C_STANDARD` property of targets. This variable is used to initialize the :prop_tgt:`C_STANDARD` diff --git a/Help/variable/CMAKE_C_STANDARD_REQUIRED.rst b/Help/variable/CMAKE_C_STANDARD_REQUIRED.rst index 7f70f6e..e70b6bd 100644 --- a/Help/variable/CMAKE_C_STANDARD_REQUIRED.rst +++ b/Help/variable/CMAKE_C_STANDARD_REQUIRED.rst @@ -1,6 +1,8 @@ CMAKE_C_STANDARD_REQUIRED ------------------------- +.. versionadded:: 3.1 + Default value for :prop_tgt:`C_STANDARD_REQUIRED` property of targets. This variable is used to initialize the :prop_tgt:`C_STANDARD_REQUIRED` diff --git a/Help/variable/CMAKE_DEFAULT_BUILD_TYPE.rst b/Help/variable/CMAKE_DEFAULT_BUILD_TYPE.rst index aa4f82d..cadbf3a 100644 --- a/Help/variable/CMAKE_DEFAULT_BUILD_TYPE.rst +++ b/Help/variable/CMAKE_DEFAULT_BUILD_TYPE.rst @@ -1,6 +1,8 @@ CMAKE_DEFAULT_BUILD_TYPE ------------------------ +.. versionadded:: 3.17 + Specifies the configuration to use by default in a ``build.ninja`` file in the :generator:`Ninja Multi-Config` generator. If this variable is specified, ``build.ninja`` uses build rules from ``build-<Config>.ninja`` by default. All diff --git a/Help/variable/CMAKE_DEFAULT_CONFIGS.rst b/Help/variable/CMAKE_DEFAULT_CONFIGS.rst index 84c642a..65a5f0d 100644 --- a/Help/variable/CMAKE_DEFAULT_CONFIGS.rst +++ b/Help/variable/CMAKE_DEFAULT_CONFIGS.rst @@ -1,6 +1,8 @@ CMAKE_DEFAULT_CONFIGS --------------------- +.. versionadded:: 3.17 + Specifies a :ref:`semicolon-separated list <CMake Language Lists>` of configurations to build for a target in ``build.ninja`` if no ``:<Config>`` suffix is specified in the :generator:`Ninja Multi-Config` generator. If it is set to ``all``, all diff --git a/Help/variable/CMAKE_DEPENDS_IN_PROJECT_ONLY.rst b/Help/variable/CMAKE_DEPENDS_IN_PROJECT_ONLY.rst index 7179071..bfe9402 100644 --- a/Help/variable/CMAKE_DEPENDS_IN_PROJECT_ONLY.rst +++ b/Help/variable/CMAKE_DEPENDS_IN_PROJECT_ONLY.rst @@ -1,6 +1,8 @@ CMAKE_DEPENDS_IN_PROJECT_ONLY ----------------------------- +.. versionadded:: 3.6 + When set to ``TRUE`` in a directory, the build system produced by the :ref:`Makefile Generators` is set up to only consider dependencies on source files that appear either in the source or in the binary directories. Changes diff --git a/Help/variable/CMAKE_DIRECTORY_LABELS.rst b/Help/variable/CMAKE_DIRECTORY_LABELS.rst index 2a6c410..81d6dd1 100644 --- a/Help/variable/CMAKE_DIRECTORY_LABELS.rst +++ b/Help/variable/CMAKE_DIRECTORY_LABELS.rst @@ -1,6 +1,8 @@ CMAKE_DIRECTORY_LABELS ----------------------- +.. versionadded:: 3.10 + Specify labels for the current directory. This is used to initialize the :prop_dir:`LABELS` directory property. diff --git a/Help/variable/CMAKE_DISABLE_PRECOMPILE_HEADERS.rst b/Help/variable/CMAKE_DISABLE_PRECOMPILE_HEADERS.rst index 7c30ede..cf52776 100644 --- a/Help/variable/CMAKE_DISABLE_PRECOMPILE_HEADERS.rst +++ b/Help/variable/CMAKE_DISABLE_PRECOMPILE_HEADERS.rst @@ -1,6 +1,8 @@ CMAKE_DISABLE_PRECOMPILE_HEADERS -------------------------------- +.. versionadded:: 3.16 + Default value for :prop_tgt:`DISABLE_PRECOMPILE_HEADERS` of targets. By default ``CMAKE_DISABLE_PRECOMPILE_HEADERS`` is ``OFF``. diff --git a/Help/variable/CMAKE_DOTNET_TARGET_FRAMEWORK.rst b/Help/variable/CMAKE_DOTNET_TARGET_FRAMEWORK.rst index 8edcd1e..29249d6 100644 --- a/Help/variable/CMAKE_DOTNET_TARGET_FRAMEWORK.rst +++ b/Help/variable/CMAKE_DOTNET_TARGET_FRAMEWORK.rst @@ -1,6 +1,8 @@ CMAKE_DOTNET_TARGET_FRAMEWORK ----------------------------- +.. versionadded:: 3.17 + Default value for :prop_tgt:`DOTNET_TARGET_FRAMEWORK` property of targets. diff --git a/Help/variable/CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION.rst b/Help/variable/CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION.rst index c2eef9e..fc3c360 100644 --- a/Help/variable/CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION.rst +++ b/Help/variable/CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION.rst @@ -1,6 +1,8 @@ CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION ------------------------------------- +.. versionadded:: 3.12 + Default value for :prop_tgt:`DOTNET_TARGET_FRAMEWORK_VERSION` property of targets. diff --git a/Help/variable/CMAKE_ECLIPSE_GENERATE_LINKED_RESOURCES.rst b/Help/variable/CMAKE_ECLIPSE_GENERATE_LINKED_RESOURCES.rst index 331aae8..548c563 100644 --- a/Help/variable/CMAKE_ECLIPSE_GENERATE_LINKED_RESOURCES.rst +++ b/Help/variable/CMAKE_ECLIPSE_GENERATE_LINKED_RESOURCES.rst @@ -1,6 +1,8 @@ CMAKE_ECLIPSE_GENERATE_LINKED_RESOURCES --------------------------------------- +.. versionadded:: 3.6 + This cache variable is used by the Eclipse project generator. See :manual:`cmake-generators(7)`. diff --git a/Help/variable/CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT.rst b/Help/variable/CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT.rst index 7b4367d..fc28ebb 100644 --- a/Help/variable/CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT.rst +++ b/Help/variable/CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT.rst @@ -1,6 +1,8 @@ CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT ------------------------------------- +.. versionadded:: 3.6 + This cache variable is used by the Eclipse project generator. See :manual:`cmake-generators(7)`. diff --git a/Help/variable/CMAKE_ECLIPSE_MAKE_ARGUMENTS.rst b/Help/variable/CMAKE_ECLIPSE_MAKE_ARGUMENTS.rst index 6e8a408..90e36f5 100644 --- a/Help/variable/CMAKE_ECLIPSE_MAKE_ARGUMENTS.rst +++ b/Help/variable/CMAKE_ECLIPSE_MAKE_ARGUMENTS.rst @@ -1,6 +1,8 @@ CMAKE_ECLIPSE_MAKE_ARGUMENTS ---------------------------- +.. versionadded:: 3.6 + This cache variable is used by the Eclipse project generator. See :manual:`cmake-generators(7)`. diff --git a/Help/variable/CMAKE_ECLIPSE_RESOURCE_ENCODING.rst b/Help/variable/CMAKE_ECLIPSE_RESOURCE_ENCODING.rst index 314efe5..492acd8 100644 --- a/Help/variable/CMAKE_ECLIPSE_RESOURCE_ENCODING.rst +++ b/Help/variable/CMAKE_ECLIPSE_RESOURCE_ENCODING.rst @@ -1,6 +1,8 @@ CMAKE_ECLIPSE_RESOURCE_ENCODING ------------------------------- +.. versionadded:: 3.16 + This cache variable tells the :generator:`Eclipse CDT4` project generator to set the resource encoding to the given value in generated project files. If no value is given, no encoding will be set. diff --git a/Help/variable/CMAKE_ECLIPSE_VERSION.rst b/Help/variable/CMAKE_ECLIPSE_VERSION.rst index 8cc7882..db65d89 100644 --- a/Help/variable/CMAKE_ECLIPSE_VERSION.rst +++ b/Help/variable/CMAKE_ECLIPSE_VERSION.rst @@ -1,6 +1,8 @@ CMAKE_ECLIPSE_VERSION --------------------- +.. versionadded:: 3.6 + This cache variable is used by the Eclipse project generator. See :manual:`cmake-generators(7)`. diff --git a/Help/variable/CMAKE_ENABLE_EXPORTS.rst b/Help/variable/CMAKE_ENABLE_EXPORTS.rst index 8848da1..9f43de3 100644 --- a/Help/variable/CMAKE_ENABLE_EXPORTS.rst +++ b/Help/variable/CMAKE_ENABLE_EXPORTS.rst @@ -1,6 +1,8 @@ CMAKE_ENABLE_EXPORTS -------------------- +.. versionadded:: 3.4 + Specify whether executables export symbols for loadable modules. This variable is used to initialize the :prop_tgt:`ENABLE_EXPORTS` target diff --git a/Help/variable/CMAKE_EXECUTE_PROCESS_COMMAND_ECHO.rst b/Help/variable/CMAKE_EXECUTE_PROCESS_COMMAND_ECHO.rst index 76561d8..90a16c3 100644 --- a/Help/variable/CMAKE_EXECUTE_PROCESS_COMMAND_ECHO.rst +++ b/Help/variable/CMAKE_EXECUTE_PROCESS_COMMAND_ECHO.rst @@ -1,6 +1,8 @@ CMAKE_EXECUTE_PROCESS_COMMAND_ECHO ---------------------------------- +.. versionadded:: 3.15 + If this variable is set to ``STDERR``, ``STDOUT`` or ``NONE`` then commands in :command:`execute_process` calls will be printed to either stderr or stdout or not at all. diff --git a/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG_INIT.rst b/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG_INIT.rst index 592a369..4d2718a 100644 --- a/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG_INIT.rst +++ b/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG_INIT.rst @@ -1,6 +1,8 @@ CMAKE_EXE_LINKER_FLAGS_<CONFIG>_INIT ------------------------------------ +.. versionadded:: 3.7 + Value used to initialize the :variable:`CMAKE_EXE_LINKER_FLAGS_<CONFIG>` cache entry the first time a build tree is configured. This variable is meant to be set by a :variable:`toolchain file diff --git a/Help/variable/CMAKE_EXE_LINKER_FLAGS_INIT.rst b/Help/variable/CMAKE_EXE_LINKER_FLAGS_INIT.rst index 0b8afe4..6e3927c 100644 --- a/Help/variable/CMAKE_EXE_LINKER_FLAGS_INIT.rst +++ b/Help/variable/CMAKE_EXE_LINKER_FLAGS_INIT.rst @@ -1,6 +1,8 @@ CMAKE_EXE_LINKER_FLAGS_INIT --------------------------- +.. versionadded:: 3.7 + Value used to initialize the :variable:`CMAKE_EXE_LINKER_FLAGS` cache entry the first time a build tree is configured. This variable is meant to be set by a :variable:`toolchain file diff --git a/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst b/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst index 6d2450b..724f309 100644 --- a/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst +++ b/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst @@ -1,6 +1,8 @@ CMAKE_EXPORT_COMPILE_COMMANDS ----------------------------- +.. versionadded:: 3.5 + Enable/Disable output of compile commands during generation. If enabled, generates a ``compile_commands.json`` file containing the exact diff --git a/Help/variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY.rst b/Help/variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY.rst index 768ed64..5772490 100644 --- a/Help/variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY.rst +++ b/Help/variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY.rst @@ -1,6 +1,8 @@ CMAKE_EXPORT_NO_PACKAGE_REGISTRY -------------------------------- +.. versionadded:: 3.1 + Disable the :command:`export(PACKAGE)` command when :policy:`CMP0090` is not set to ``NEW``. diff --git a/Help/variable/CMAKE_EXPORT_PACKAGE_REGISTRY.rst b/Help/variable/CMAKE_EXPORT_PACKAGE_REGISTRY.rst index 3476a19..663639b 100644 --- a/Help/variable/CMAKE_EXPORT_PACKAGE_REGISTRY.rst +++ b/Help/variable/CMAKE_EXPORT_PACKAGE_REGISTRY.rst @@ -1,6 +1,8 @@ CMAKE_EXPORT_PACKAGE_REGISTRY ----------------------------- +.. versionadded:: 3.15 + Enables the :command:`export(PACKAGE)` command when :policy:`CMP0090` is set to ``NEW``. diff --git a/Help/variable/CMAKE_FIND_APPBUNDLE.rst b/Help/variable/CMAKE_FIND_APPBUNDLE.rst index 7a05fac..17563f3 100644 --- a/Help/variable/CMAKE_FIND_APPBUNDLE.rst +++ b/Help/variable/CMAKE_FIND_APPBUNDLE.rst @@ -1,6 +1,8 @@ CMAKE_FIND_APPBUNDLE -------------------- +.. versionadded:: 3.4 + This variable affects how ``find_*`` commands choose between macOS Application Bundles and unix-style package components. diff --git a/Help/variable/CMAKE_FIND_DEBUG_MODE.rst b/Help/variable/CMAKE_FIND_DEBUG_MODE.rst index f5fd8ce..8f2a82f 100644 --- a/Help/variable/CMAKE_FIND_DEBUG_MODE.rst +++ b/Help/variable/CMAKE_FIND_DEBUG_MODE.rst @@ -1,6 +1,8 @@ CMAKE_FIND_DEBUG_MODE --------------------- +.. versionadded:: 3.17 + Print extra find call information for the following commands to standard error: diff --git a/Help/variable/CMAKE_FIND_FRAMEWORK.rst b/Help/variable/CMAKE_FIND_FRAMEWORK.rst index 4d5078f..3b62cda 100644 --- a/Help/variable/CMAKE_FIND_FRAMEWORK.rst +++ b/Help/variable/CMAKE_FIND_FRAMEWORK.rst @@ -1,6 +1,8 @@ CMAKE_FIND_FRAMEWORK -------------------- +.. versionadded:: 3.4 + This variable affects how ``find_*`` commands choose between macOS Frameworks and unix-style package components. diff --git a/Help/variable/CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX.rst b/Help/variable/CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX.rst index ada8955..ca2ad7f 100644 --- a/Help/variable/CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX.rst +++ b/Help/variable/CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX.rst @@ -1,6 +1,8 @@ CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX ------------------------------------ +.. versionadded:: 3.9 + Specify a ``<suffix>`` to tell the :command:`find_library` command to search in a ``lib<suffix>`` directory before each ``lib`` directory that would normally be searched. diff --git a/Help/variable/CMAKE_FIND_PACKAGE_NAME.rst b/Help/variable/CMAKE_FIND_PACKAGE_NAME.rst index bd1a30f..fc1fd43 100644 --- a/Help/variable/CMAKE_FIND_PACKAGE_NAME.rst +++ b/Help/variable/CMAKE_FIND_PACKAGE_NAME.rst @@ -1,6 +1,8 @@ CMAKE_FIND_PACKAGE_NAME ----------------------- +.. versionadded:: 3.1.1 + Defined by the :command:`find_package` command while loading a find module to record the caller-specified package name. See command documentation for details. diff --git a/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst b/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst index 4ee9d8b..8d86a94 100644 --- a/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst +++ b/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst @@ -1,6 +1,8 @@ CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY -------------------------------------- +.. versionadded:: 3.1 + .. deprecated:: 3.16 Use the :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` variable instead. 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 107c183..cc67f08 100644 --- a/Help/variable/CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY.rst +++ b/Help/variable/CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY.rst @@ -1,6 +1,8 @@ CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY --------------------------------------------- +.. versionadded:: 3.1 + .. deprecated:: 3.16 Use the :variable:`CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY` variable instead. diff --git a/Help/variable/CMAKE_FIND_PACKAGE_PREFER_CONFIG.rst b/Help/variable/CMAKE_FIND_PACKAGE_PREFER_CONFIG.rst index db658a1..ba81529 100644 --- a/Help/variable/CMAKE_FIND_PACKAGE_PREFER_CONFIG.rst +++ b/Help/variable/CMAKE_FIND_PACKAGE_PREFER_CONFIG.rst @@ -1,6 +1,8 @@ CMAKE_FIND_PACKAGE_PREFER_CONFIG --------------------------------- +.. versionadded:: 3.15 + Tell :command:`find_package` to try "Config" mode before "Module" mode if no mode was specified. diff --git a/Help/variable/CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS.rst b/Help/variable/CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS.rst index dfbde20..86d75e7 100644 --- a/Help/variable/CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS.rst +++ b/Help/variable/CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS.rst @@ -1,6 +1,8 @@ CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS ----------------------------------- +.. versionadded:: 3.14 + Set to ``TRUE`` to tell :command:`find_package` calls to resolve symbolic links in the value of ``<PackageName>_DIR``. diff --git a/Help/variable/CMAKE_FIND_PACKAGE_SORT_DIRECTION.rst b/Help/variable/CMAKE_FIND_PACKAGE_SORT_DIRECTION.rst index 99e4ec1..98c2a8f 100644 --- a/Help/variable/CMAKE_FIND_PACKAGE_SORT_DIRECTION.rst +++ b/Help/variable/CMAKE_FIND_PACKAGE_SORT_DIRECTION.rst @@ -1,6 +1,8 @@ CMAKE_FIND_PACKAGE_SORT_DIRECTION --------------------------------- +.. versionadded:: 3.7 + The sorting direction used by :variable:`CMAKE_FIND_PACKAGE_SORT_ORDER`. It can assume one of the following values: diff --git a/Help/variable/CMAKE_FIND_PACKAGE_SORT_ORDER.rst b/Help/variable/CMAKE_FIND_PACKAGE_SORT_ORDER.rst index ba5f3a8..1725ba1 100644 --- a/Help/variable/CMAKE_FIND_PACKAGE_SORT_ORDER.rst +++ b/Help/variable/CMAKE_FIND_PACKAGE_SORT_ORDER.rst @@ -1,6 +1,8 @@ CMAKE_FIND_PACKAGE_SORT_ORDER ----------------------------- +.. versionadded:: 3.7 + The default order for sorting packages found using :command:`find_package`. It can assume one of the following values: diff --git a/Help/variable/CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH.rst b/Help/variable/CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH.rst index 957e956..de1bad7 100644 --- a/Help/variable/CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH.rst +++ b/Help/variable/CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH.rst @@ -1,6 +1,8 @@ CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH ------------------------------------- +.. versionadded:: 3.16 + Controls the default behavior of the following commands for whether or not to search paths provided by cmake-specific environment variables: diff --git a/Help/variable/CMAKE_FIND_USE_CMAKE_PATH.rst b/Help/variable/CMAKE_FIND_USE_CMAKE_PATH.rst index d2bdb09..47ce3a3 100644 --- a/Help/variable/CMAKE_FIND_USE_CMAKE_PATH.rst +++ b/Help/variable/CMAKE_FIND_USE_CMAKE_PATH.rst @@ -1,6 +1,8 @@ CMAKE_FIND_USE_CMAKE_PATH ------------------------- +.. versionadded:: 3.16 + Controls the default behavior of the following commands for whether or not to search paths provided by cmake-specific cache variables: diff --git a/Help/variable/CMAKE_FIND_USE_CMAKE_SYSTEM_PATH.rst b/Help/variable/CMAKE_FIND_USE_CMAKE_SYSTEM_PATH.rst index b99081d..2fd00df 100644 --- a/Help/variable/CMAKE_FIND_USE_CMAKE_SYSTEM_PATH.rst +++ b/Help/variable/CMAKE_FIND_USE_CMAKE_SYSTEM_PATH.rst @@ -1,6 +1,8 @@ CMAKE_FIND_USE_CMAKE_SYSTEM_PATH -------------------------------- +.. versionadded:: 3.16 + Controls the default behavior of the following commands for whether or not to search paths provided by platform-specific cmake variables: diff --git a/Help/variable/CMAKE_FIND_USE_PACKAGE_REGISTRY.rst b/Help/variable/CMAKE_FIND_USE_PACKAGE_REGISTRY.rst index 7c7ca36..3127206 100644 --- a/Help/variable/CMAKE_FIND_USE_PACKAGE_REGISTRY.rst +++ b/Help/variable/CMAKE_FIND_USE_PACKAGE_REGISTRY.rst @@ -1,6 +1,8 @@ CMAKE_FIND_USE_PACKAGE_REGISTRY ------------------------------- +.. versionadded:: 3.16 + Controls the default behavior of the :command:`find_package` command for whether or not to search paths provided by the :ref:`User Package Registry`. diff --git a/Help/variable/CMAKE_FIND_USE_PACKAGE_ROOT_PATH.rst b/Help/variable/CMAKE_FIND_USE_PACKAGE_ROOT_PATH.rst index e7f5b0f..64e5c6d 100644 --- a/Help/variable/CMAKE_FIND_USE_PACKAGE_ROOT_PATH.rst +++ b/Help/variable/CMAKE_FIND_USE_PACKAGE_ROOT_PATH.rst @@ -1,6 +1,8 @@ CMAKE_FIND_USE_PACKAGE_ROOT_PATH -------------------------------- +.. versionadded:: 3.16 + Controls the default behavior of the following commands for whether or not to search paths provided by :variable:`<PackageName>_ROOT` variables: diff --git a/Help/variable/CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH.rst b/Help/variable/CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH.rst index fbaba5a..a0a86e4 100644 --- a/Help/variable/CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH.rst +++ b/Help/variable/CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH.rst @@ -1,6 +1,8 @@ CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH -------------------------------------- +.. versionadded:: 3.16 + Controls the default behavior of the following commands for whether or not to search paths provided by standard system environment variables: diff --git a/Help/variable/CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY.rst b/Help/variable/CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY.rst index cb4eec5..504b7e8 100644 --- a/Help/variable/CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY.rst +++ b/Help/variable/CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY.rst @@ -1,6 +1,8 @@ CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY -------------------------------------- +.. versionadded:: 3.16 + Controls searching the :ref:`System Package Registry` by the :command:`find_package` command. diff --git a/Help/variable/CMAKE_FOLDER.rst b/Help/variable/CMAKE_FOLDER.rst index 50a2b88..37f137c 100644 --- a/Help/variable/CMAKE_FOLDER.rst +++ b/Help/variable/CMAKE_FOLDER.rst @@ -1,6 +1,8 @@ CMAKE_FOLDER ------------ +.. versionadded:: 3.12 + Set the folder name. Use to organize targets in an IDE. This variable is used to initialize the :prop_tgt:`FOLDER` property on all the diff --git a/Help/variable/CMAKE_FRAMEWORK.rst b/Help/variable/CMAKE_FRAMEWORK.rst index 591041c..37385bf 100644 --- a/Help/variable/CMAKE_FRAMEWORK.rst +++ b/Help/variable/CMAKE_FRAMEWORK.rst @@ -1,6 +1,8 @@ CMAKE_FRAMEWORK --------------- +.. versionadded:: 3.15 + Default value for :prop_tgt:`FRAMEWORK` of targets. This variable is used to initialize the :prop_tgt:`FRAMEWORK` property on diff --git a/Help/variable/CMAKE_FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst b/Help/variable/CMAKE_FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst index 5c7cd23..47fb66e 100644 --- a/Help/variable/CMAKE_FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst +++ b/Help/variable/CMAKE_FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst @@ -1,6 +1,8 @@ CMAKE_FRAMEWORK_MULTI_CONFIG_POSTFIX_<CONFIG> --------------------------------------------- +.. versionadded:: 3.18 + Default framework filename postfix under configuration ``<CONFIG>`` when using a multi-config generator. diff --git a/Help/variable/CMAKE_Fortran_PREPROCESS.rst b/Help/variable/CMAKE_Fortran_PREPROCESS.rst index 74b2d8b..7d405f3 100644 --- a/Help/variable/CMAKE_Fortran_PREPROCESS.rst +++ b/Help/variable/CMAKE_Fortran_PREPROCESS.rst @@ -1,6 +1,8 @@ CMAKE_Fortran_PREPROCESS ------------------------ +.. versionadded:: 3.18 + Default value for :prop_tgt:`Fortran_PREPROCESS` of targets. This variable is used to initialize the :prop_tgt:`Fortran_PREPROCESS` diff --git a/Help/variable/CMAKE_GENERATOR_INSTANCE.rst b/Help/variable/CMAKE_GENERATOR_INSTANCE.rst index 3657ed4..5858d7a 100644 --- a/Help/variable/CMAKE_GENERATOR_INSTANCE.rst +++ b/Help/variable/CMAKE_GENERATOR_INSTANCE.rst @@ -1,6 +1,8 @@ CMAKE_GENERATOR_INSTANCE ------------------------ +.. versionadded:: 3.11 + Generator-specific instance specification provided by user. Some CMake generators support selection of an instance of the native build diff --git a/Help/variable/CMAKE_GENERATOR_PLATFORM.rst b/Help/variable/CMAKE_GENERATOR_PLATFORM.rst index 2c115a3..b17d83a 100644 --- a/Help/variable/CMAKE_GENERATOR_PLATFORM.rst +++ b/Help/variable/CMAKE_GENERATOR_PLATFORM.rst @@ -1,6 +1,8 @@ CMAKE_GENERATOR_PLATFORM ------------------------ +.. versionadded:: 3.1 + Generator-specific target platform specification provided by user. Some CMake generators support a target platform name to be given diff --git a/Help/variable/CMAKE_GHS_NO_SOURCE_GROUP_FILE.rst b/Help/variable/CMAKE_GHS_NO_SOURCE_GROUP_FILE.rst index b6768a1..0e8ae5e 100644 --- a/Help/variable/CMAKE_GHS_NO_SOURCE_GROUP_FILE.rst +++ b/Help/variable/CMAKE_GHS_NO_SOURCE_GROUP_FILE.rst @@ -1,6 +1,8 @@ CMAKE_GHS_NO_SOURCE_GROUP_FILE ------------------------------ +.. versionadded:: 3.14 + ``ON`` / ``OFF`` boolean to control if the project file for a target should be one single file or multiple files. Refer to :prop_tgt:`GHS_NO_SOURCE_GROUP_FILE` for further details. diff --git a/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET.rst b/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET.rst index 8587742..96e9907 100644 --- a/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET.rst +++ b/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET.rst @@ -1,6 +1,8 @@ CMAKE_GLOBAL_AUTOGEN_TARGET --------------------------- +.. versionadded:: 3.14 + Switch to enable generation of a global ``autogen`` target. When :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET` is enabled, a custom target diff --git a/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET_NAME.rst b/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET_NAME.rst index c86a5d0..4af4bc3 100644 --- a/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET_NAME.rst +++ b/Help/variable/CMAKE_GLOBAL_AUTOGEN_TARGET_NAME.rst @@ -1,6 +1,8 @@ CMAKE_GLOBAL_AUTOGEN_TARGET_NAME -------------------------------- +.. versionadded:: 3.14 + Change the name of the global ``autogen`` target. When :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET` is enabled, a global custom target diff --git a/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET.rst b/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET.rst index f92128c..efea5be 100644 --- a/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET.rst +++ b/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET.rst @@ -1,6 +1,8 @@ CMAKE_GLOBAL_AUTORCC_TARGET --------------------------- +.. versionadded:: 3.14 + Switch to enable generation of a global ``autorcc`` target. When :variable:`CMAKE_GLOBAL_AUTORCC_TARGET` is enabled, a custom target diff --git a/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET_NAME.rst b/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET_NAME.rst index c6e05de..4d2e313 100644 --- a/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET_NAME.rst +++ b/Help/variable/CMAKE_GLOBAL_AUTORCC_TARGET_NAME.rst @@ -1,6 +1,8 @@ CMAKE_GLOBAL_AUTORCC_TARGET_NAME -------------------------------- +.. versionadded:: 3.14 + Change the name of the global ``autorcc`` target. When :variable:`CMAKE_GLOBAL_AUTORCC_TARGET` is enabled, a global custom target diff --git a/Help/variable/CMAKE_HOST_SOLARIS.rst b/Help/variable/CMAKE_HOST_SOLARIS.rst index 82b5d69..7054acd 100644 --- a/Help/variable/CMAKE_HOST_SOLARIS.rst +++ b/Help/variable/CMAKE_HOST_SOLARIS.rst @@ -1,6 +1,8 @@ CMAKE_HOST_SOLARIS ------------------ +.. versionadded:: 3.6 + ``True`` for Oracle Solaris operating systems. Set to ``true`` when the host system is Oracle Solaris. diff --git a/Help/variable/CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst b/Help/variable/CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst index f994fbe..aad99e4 100644 --- a/Help/variable/CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst +++ b/Help/variable/CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst @@ -1,6 +1,8 @@ CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS ------------------------------------------- +.. versionadded:: 3.11 + Default permissions for directories created implicitly during installation of files by :command:`install` and :command:`file(INSTALL)`. diff --git a/Help/variable/CMAKE_INSTALL_MESSAGE.rst b/Help/variable/CMAKE_INSTALL_MESSAGE.rst index 304df26..4f39cfe 100644 --- a/Help/variable/CMAKE_INSTALL_MESSAGE.rst +++ b/Help/variable/CMAKE_INSTALL_MESSAGE.rst @@ -1,6 +1,8 @@ CMAKE_INSTALL_MESSAGE --------------------- +.. versionadded:: 3.1 + Specify verbosity of installation script code generated by the :command:`install` command (using the :command:`file(INSTALL)` command). For paths that are newly installed or updated, installation diff --git a/Help/variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT.rst b/Help/variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT.rst index 2a5842d..93cc319 100644 --- a/Help/variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT.rst +++ b/Help/variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT.rst @@ -1,6 +1,8 @@ CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT ------------------------------------------- +.. versionadded:: 3.7.1 + CMake sets this variable to a ``TRUE`` value when the :variable:`CMAKE_INSTALL_PREFIX` has just been initialized to its default value, typically on the first run of CMake within diff --git a/Help/variable/CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH.rst b/Help/variable/CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH.rst index 76ca3da..c86e433 100644 --- a/Help/variable/CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH.rst +++ b/Help/variable/CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH.rst @@ -1,6 +1,8 @@ CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH -------------------------------------- +.. versionadded:: 3.16 + Sets the default for whether toolchain-defined rpaths should be removed during installation. diff --git a/Help/variable/CMAKE_INTERPROCEDURAL_OPTIMIZATION.rst b/Help/variable/CMAKE_INTERPROCEDURAL_OPTIMIZATION.rst index b0cbb62..cf7da76 100644 --- a/Help/variable/CMAKE_INTERPROCEDURAL_OPTIMIZATION.rst +++ b/Help/variable/CMAKE_INTERPROCEDURAL_OPTIMIZATION.rst @@ -1,6 +1,8 @@ CMAKE_INTERPROCEDURAL_OPTIMIZATION ---------------------------------- +.. versionadded:: 3.9 + Default value for :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` of targets. This variable is used to initialize the :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` diff --git a/Help/variable/CMAKE_INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst b/Help/variable/CMAKE_INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst index b291102..5b3ee77 100644 --- a/Help/variable/CMAKE_INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst +++ b/Help/variable/CMAKE_INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst @@ -1,6 +1,8 @@ CMAKE_INTERPROCEDURAL_OPTIMIZATION_<CONFIG> ------------------------------------------- +.. versionadded:: 3.9 + Default value for :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION_<CONFIG>` of targets. This variable is used to initialize the :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION_<CONFIG>` diff --git a/Help/variable/CMAKE_IOS_INSTALL_COMBINED.rst b/Help/variable/CMAKE_IOS_INSTALL_COMBINED.rst index c5cb9b6..cd7fd8d 100644 --- a/Help/variable/CMAKE_IOS_INSTALL_COMBINED.rst +++ b/Help/variable/CMAKE_IOS_INSTALL_COMBINED.rst @@ -1,6 +1,8 @@ CMAKE_IOS_INSTALL_COMBINED -------------------------- +.. versionadded:: 3.5 + Default value for :prop_tgt:`IOS_INSTALL_COMBINED` of targets. This variable is used to initialize the :prop_tgt:`IOS_INSTALL_COMBINED` diff --git a/Help/variable/CMAKE_JOB_POOLS.rst b/Help/variable/CMAKE_JOB_POOLS.rst index 72b50b4..43d3c84 100644 --- a/Help/variable/CMAKE_JOB_POOLS.rst +++ b/Help/variable/CMAKE_JOB_POOLS.rst @@ -1,6 +1,8 @@ CMAKE_JOB_POOLS --------------- +.. versionadded:: 3.11 + If the :prop_gbl:`JOB_POOLS` global property is not set, the value of this variable is used in its place. See :prop_gbl:`JOB_POOLS` for additional information. diff --git a/Help/variable/CMAKE_JOB_POOL_PRECOMPILE_HEADER.rst b/Help/variable/CMAKE_JOB_POOL_PRECOMPILE_HEADER.rst index f9467b3..1a6f66a 100644 --- a/Help/variable/CMAKE_JOB_POOL_PRECOMPILE_HEADER.rst +++ b/Help/variable/CMAKE_JOB_POOL_PRECOMPILE_HEADER.rst @@ -1,6 +1,8 @@ CMAKE_JOB_POOL_PRECOMPILE_HEADER -------------------------------- +.. versionadded:: 3.17 + This variable is used to initialize the :prop_tgt:`JOB_POOL_PRECOMPILE_HEADER` property on all the targets. See :prop_tgt:`JOB_POOL_PRECOMPILE_HEADER` for additional information. diff --git a/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_MACHINE.rst b/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_MACHINE.rst index d336364..f539277 100644 --- a/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_MACHINE.rst +++ b/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_MACHINE.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_ANDROID_TOOLCHAIN_MACHINE -------------------------------------- +.. versionadded:: 3.7.1 + When :ref:`Cross Compiling for Android` this variable contains the toolchain binutils machine name (e.g. ``gcc -dumpmachine``). The binutils typically have a ``<machine>-`` prefix on their name. diff --git a/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_PREFIX.rst b/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_PREFIX.rst index db04af3..ff072ca 100644 --- a/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_PREFIX.rst +++ b/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_PREFIX.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_ANDROID_TOOLCHAIN_PREFIX ------------------------------------- +.. versionadded:: 3.7 + When :ref:`Cross Compiling for Android` this variable contains the absolute path prefixing the toolchain GNU compiler and its binutils. diff --git a/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_SUFFIX.rst b/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_SUFFIX.rst index 159eb22..d595280 100644 --- a/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_SUFFIX.rst +++ b/Help/variable/CMAKE_LANG_ANDROID_TOOLCHAIN_SUFFIX.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_ANDROID_TOOLCHAIN_SUFFIX ------------------------------------- +.. versionadded:: 3.7 + When :ref:`Cross Compiling for Android` this variable contains the host platform suffix of the toolchain GNU compiler and its binutils. diff --git a/Help/variable/CMAKE_LANG_CLANG_TIDY.rst b/Help/variable/CMAKE_LANG_CLANG_TIDY.rst index bd49de3..78f0f6a 100644 --- a/Help/variable/CMAKE_LANG_CLANG_TIDY.rst +++ b/Help/variable/CMAKE_LANG_CLANG_TIDY.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_CLANG_TIDY ----------------------- +.. versionadded:: 3.6 + Default value for :prop_tgt:`<LANG>_CLANG_TIDY` target property when ``<LANG>`` is ``C`` or ``CXX``. diff --git a/Help/variable/CMAKE_LANG_COMPILER.rst b/Help/variable/CMAKE_LANG_COMPILER.rst index 89df495..e694b33 100644 --- a/Help/variable/CMAKE_LANG_COMPILER.rst +++ b/Help/variable/CMAKE_LANG_COMPILER.rst @@ -5,3 +5,28 @@ The full path to the compiler for ``LANG``. This is the command that will be used as the ``<LANG>`` compiler. Once set, you can not change this variable. + +Usage +^^^^^ + +This variable can be set by the user during the first time a build tree is configured. + +If a non-full path value is supplied then CMake will resolve the full path of +the compiler. + +The variable could be set in a user supplied toolchain file or via `-D` on the command line. + +.. note:: + Options that are required to make the compiler work correctly can be included + as items in a list; they can not be changed. + +.. code-block:: cmake + + #set within user supplied toolchain file + set(CMAKE_C_COMPILER /full/path/to/qcc --arg1 --arg2) + +or + +.. code-block:: console + + $ cmake ... -DCMAKE_C_COMPILER='qcc;--arg1;--arg2' diff --git a/Help/variable/CMAKE_LANG_COMPILER_AR.rst b/Help/variable/CMAKE_LANG_COMPILER_AR.rst index b83a1d4..74f2758 100644 --- a/Help/variable/CMAKE_LANG_COMPILER_AR.rst +++ b/Help/variable/CMAKE_LANG_COMPILER_AR.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_COMPILER_AR ------------------------ +.. versionadded:: 3.9 + A wrapper around ``ar`` adding the appropriate ``--plugin`` option for the compiler. diff --git a/Help/variable/CMAKE_LANG_COMPILER_ARCHITECTURE_ID.rst b/Help/variable/CMAKE_LANG_COMPILER_ARCHITECTURE_ID.rst index 054c648..8057566 100644 --- a/Help/variable/CMAKE_LANG_COMPILER_ARCHITECTURE_ID.rst +++ b/Help/variable/CMAKE_LANG_COMPILER_ARCHITECTURE_ID.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID ------------------------------------- +.. versionadded:: 3.10 + An internal variable subject to change. This is used to identify the variant of a compiler based on its target diff --git a/Help/variable/CMAKE_LANG_COMPILER_LAUNCHER.rst b/Help/variable/CMAKE_LANG_COMPILER_LAUNCHER.rst index c76e2d0..98634c2 100644 --- a/Help/variable/CMAKE_LANG_COMPILER_LAUNCHER.rst +++ b/Help/variable/CMAKE_LANG_COMPILER_LAUNCHER.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_COMPILER_LAUNCHER ------------------------------ +.. versionadded:: 3.4 + Default value for :prop_tgt:`<LANG>_COMPILER_LAUNCHER` target property. This variable is used to initialize the property on each target as it is created. This is done only when ``<LANG>`` is ``C``, ``CXX``, ``Fortran``, diff --git a/Help/variable/CMAKE_LANG_COMPILER_PREDEFINES_COMMAND.rst b/Help/variable/CMAKE_LANG_COMPILER_PREDEFINES_COMMAND.rst index e050f43..935329a 100644 --- a/Help/variable/CMAKE_LANG_COMPILER_PREDEFINES_COMMAND.rst +++ b/Help/variable/CMAKE_LANG_COMPILER_PREDEFINES_COMMAND.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_COMPILER_PREDEFINES_COMMAND ---------------------------------------- +.. versionadded:: 3.10 + Command that outputs the compiler pre definitions. See :prop_tgt:`AUTOMOC` which uses diff --git a/Help/variable/CMAKE_LANG_COMPILER_RANLIB.rst b/Help/variable/CMAKE_LANG_COMPILER_RANLIB.rst index 945160b..1d10b55 100644 --- a/Help/variable/CMAKE_LANG_COMPILER_RANLIB.rst +++ b/Help/variable/CMAKE_LANG_COMPILER_RANLIB.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_COMPILER_RANLIB ---------------------------- +.. versionadded:: 3.9 + A wrapper around ``ranlib`` adding the appropriate ``--plugin`` option for the compiler. diff --git a/Help/variable/CMAKE_LANG_COMPILER_VERSION_INTERNAL.rst b/Help/variable/CMAKE_LANG_COMPILER_VERSION_INTERNAL.rst index c3cd980..596a989 100644 --- a/Help/variable/CMAKE_LANG_COMPILER_VERSION_INTERNAL.rst +++ b/Help/variable/CMAKE_LANG_COMPILER_VERSION_INTERNAL.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_COMPILER_VERSION_INTERNAL -------------------------------------- +.. versionadded:: 3.10 + An internal variable subject to change. This is used to identify the variant of a compiler based on an internal diff --git a/Help/variable/CMAKE_LANG_CPPCHECK.rst b/Help/variable/CMAKE_LANG_CPPCHECK.rst index 50b478f..5ae5faf 100644 --- a/Help/variable/CMAKE_LANG_CPPCHECK.rst +++ b/Help/variable/CMAKE_LANG_CPPCHECK.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_CPPCHECK --------------------- +.. versionadded:: 3.10 + Default value for :prop_tgt:`<LANG>_CPPCHECK` target property. This variable is used to initialize the property on each target as it is created. This is done only when ``<LANG>`` is ``C`` or ``CXX``. diff --git a/Help/variable/CMAKE_LANG_CPPLINT.rst b/Help/variable/CMAKE_LANG_CPPLINT.rst index 3b6f452..ab7b0fc 100644 --- a/Help/variable/CMAKE_LANG_CPPLINT.rst +++ b/Help/variable/CMAKE_LANG_CPPLINT.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_CPPLINT -------------------- +.. versionadded:: 3.8 + Default value for :prop_tgt:`<LANG>_CPPLINT` target property. This variable is used to initialize the property on each target as it is created. This is done only when ``<LANG>`` is ``C`` or ``CXX``. diff --git a/Help/variable/CMAKE_LANG_FLAGS_CONFIG.rst b/Help/variable/CMAKE_LANG_FLAGS_CONFIG.rst index 1dbd036..628b62b 100644 --- a/Help/variable/CMAKE_LANG_FLAGS_CONFIG.rst +++ b/Help/variable/CMAKE_LANG_FLAGS_CONFIG.rst @@ -1,4 +1,6 @@ CMAKE_<LANG>_FLAGS_<CONFIG> --------------------------- +.. versionadded:: 3.11 + Flags for language ``<LANG>`` when building for the ``<CONFIG>`` configuration. diff --git a/Help/variable/CMAKE_LANG_FLAGS_CONFIG_INIT.rst b/Help/variable/CMAKE_LANG_FLAGS_CONFIG_INIT.rst index 1eb5b3f..17669a2 100644 --- a/Help/variable/CMAKE_LANG_FLAGS_CONFIG_INIT.rst +++ b/Help/variable/CMAKE_LANG_FLAGS_CONFIG_INIT.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_FLAGS_<CONFIG>_INIT -------------------------------- +.. versionadded:: 3.11 + Value used to initialize the :variable:`CMAKE_<LANG>_FLAGS_<CONFIG>` cache entry the first time a build tree is configured for language ``<LANG>``. This variable is meant to be set by a :variable:`toolchain file diff --git a/Help/variable/CMAKE_LANG_FLAGS_DEBUG_INIT.rst b/Help/variable/CMAKE_LANG_FLAGS_DEBUG_INIT.rst index de7fcfc..49c9e99 100644 --- a/Help/variable/CMAKE_LANG_FLAGS_DEBUG_INIT.rst +++ b/Help/variable/CMAKE_LANG_FLAGS_DEBUG_INIT.rst @@ -1,5 +1,7 @@ CMAKE_<LANG>_FLAGS_DEBUG_INIT ----------------------------- +.. versionadded:: 3.7 + This variable is the ``Debug`` variant of the :variable:`CMAKE_<LANG>_FLAGS_<CONFIG>_INIT` variable. diff --git a/Help/variable/CMAKE_LANG_FLAGS_INIT.rst b/Help/variable/CMAKE_LANG_FLAGS_INIT.rst index 4a034e8..67ff2cb 100644 --- a/Help/variable/CMAKE_LANG_FLAGS_INIT.rst +++ b/Help/variable/CMAKE_LANG_FLAGS_INIT.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_FLAGS_INIT ----------------------- +.. versionadded:: 3.7 + Value used to initialize the :variable:`CMAKE_<LANG>_FLAGS` cache entry the first time a build tree is configured for language ``<LANG>``. This variable is meant to be set by a :variable:`toolchain file diff --git a/Help/variable/CMAKE_LANG_FLAGS_MINSIZEREL_INIT.rst b/Help/variable/CMAKE_LANG_FLAGS_MINSIZEREL_INIT.rst index 1e7003c..3600909 100644 --- a/Help/variable/CMAKE_LANG_FLAGS_MINSIZEREL_INIT.rst +++ b/Help/variable/CMAKE_LANG_FLAGS_MINSIZEREL_INIT.rst @@ -1,5 +1,7 @@ CMAKE_<LANG>_FLAGS_MINSIZEREL_INIT ---------------------------------- +.. versionadded:: 3.7 + This variable is the ``MinSizeRel`` variant of the :variable:`CMAKE_<LANG>_FLAGS_<CONFIG>_INIT` variable. diff --git a/Help/variable/CMAKE_LANG_FLAGS_RELEASE_INIT.rst b/Help/variable/CMAKE_LANG_FLAGS_RELEASE_INIT.rst index e7c73fe..e889852 100644 --- a/Help/variable/CMAKE_LANG_FLAGS_RELEASE_INIT.rst +++ b/Help/variable/CMAKE_LANG_FLAGS_RELEASE_INIT.rst @@ -1,5 +1,7 @@ CMAKE_<LANG>_FLAGS_RELEASE_INIT ------------------------------- +.. versionadded:: 3.7 + This variable is the ``Release`` variant of the :variable:`CMAKE_<LANG>_FLAGS_<CONFIG>_INIT` variable. diff --git a/Help/variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO_INIT.rst b/Help/variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO_INIT.rst index 3ab3975..b42caee 100644 --- a/Help/variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO_INIT.rst +++ b/Help/variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO_INIT.rst @@ -1,5 +1,7 @@ CMAKE_<LANG>_FLAGS_RELWITHDEBINFO_INIT -------------------------------------- +.. versionadded:: 3.7 + This variable is the ``RelWithDebInfo`` variant of the :variable:`CMAKE_<LANG>_FLAGS_<CONFIG>_INIT` variable. diff --git a/Help/variable/CMAKE_LANG_INCLUDE_WHAT_YOU_USE.rst b/Help/variable/CMAKE_LANG_INCLUDE_WHAT_YOU_USE.rst index 2c8028a..be6c210 100644 --- a/Help/variable/CMAKE_LANG_INCLUDE_WHAT_YOU_USE.rst +++ b/Help/variable/CMAKE_LANG_INCLUDE_WHAT_YOU_USE.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_INCLUDE_WHAT_YOU_USE --------------------------------- +.. versionadded:: 3.3 + Default value for :prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE` target property. This variable is used to initialize the property on each target as it is created. This is done only when ``<LANG>`` is ``C`` or ``CXX``. diff --git a/Help/variable/CMAKE_LANG_LINKER_WRAPPER_FLAG.rst b/Help/variable/CMAKE_LANG_LINKER_WRAPPER_FLAG.rst index df51407..471c351 100644 --- a/Help/variable/CMAKE_LANG_LINKER_WRAPPER_FLAG.rst +++ b/Help/variable/CMAKE_LANG_LINKER_WRAPPER_FLAG.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_LINKER_WRAPPER_FLAG -------------------------------- +.. versionadded:: 3.13 + Defines the syntax of compiler driver option to pass options to the linker tool. It will be used to translate the ``LINKER:`` prefix in the link options (see :command:`add_link_options` and :command:`target_link_options`). diff --git a/Help/variable/CMAKE_LANG_LINKER_WRAPPER_FLAG_SEP.rst b/Help/variable/CMAKE_LANG_LINKER_WRAPPER_FLAG_SEP.rst index faf1481..a3895af 100644 --- a/Help/variable/CMAKE_LANG_LINKER_WRAPPER_FLAG_SEP.rst +++ b/Help/variable/CMAKE_LANG_LINKER_WRAPPER_FLAG_SEP.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_LINKER_WRAPPER_FLAG_SEP ------------------------------------ +.. versionadded:: 3.13 + This variable is used with :variable:`CMAKE_<LANG>_LINKER_WRAPPER_FLAG` variable to format ``LINKER:`` prefix in the link options (see :command:`add_link_options` and :command:`target_link_options`). diff --git a/Help/variable/CMAKE_LANG_LINK_LIBRARY_FILE_FLAG.rst b/Help/variable/CMAKE_LANG_LINK_LIBRARY_FILE_FLAG.rst index d54f080..23ece88 100644 --- a/Help/variable/CMAKE_LANG_LINK_LIBRARY_FILE_FLAG.rst +++ b/Help/variable/CMAKE_LANG_LINK_LIBRARY_FILE_FLAG.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_LINK_LIBRARY_FILE_FLAG ----------------------------------- +.. versionadded:: 3.16 + Language-specific flag to be used to link a library specified by a path to its file. diff --git a/Help/variable/CMAKE_LANG_LINK_LIBRARY_FLAG.rst b/Help/variable/CMAKE_LANG_LINK_LIBRARY_FLAG.rst index d7bb0d8..0f528db 100644 --- a/Help/variable/CMAKE_LANG_LINK_LIBRARY_FLAG.rst +++ b/Help/variable/CMAKE_LANG_LINK_LIBRARY_FLAG.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_LINK_LIBRARY_FLAG ------------------------------ +.. versionadded:: 3.16 + Flag to be used to link a library into a shared library or executable. This flag will be used to specify a library to link to a shared library or an diff --git a/Help/variable/CMAKE_LANG_LINK_LIBRARY_SUFFIX.rst b/Help/variable/CMAKE_LANG_LINK_LIBRARY_SUFFIX.rst index a378657..359e29f 100644 --- a/Help/variable/CMAKE_LANG_LINK_LIBRARY_SUFFIX.rst +++ b/Help/variable/CMAKE_LANG_LINK_LIBRARY_SUFFIX.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_LINK_LIBRARY_SUFFIX -------------------------------- +.. versionadded:: 3.16 + Language-specific suffix for libraries that you link to. The suffix to use for the end of a library filename, ``.lib`` on Windows. diff --git a/Help/variable/CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES.rst b/Help/variable/CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES.rst index c8e3d57..24aca8b 100644 --- a/Help/variable/CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES.rst +++ b/Help/variable/CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_STANDARD_INCLUDE_DIRECTORIES ----------------------------------------- +.. versionadded:: 3.6 + Include directories to be used for every source file compiled with the ``<LANG>`` compiler. This is meant for specification of system include directories needed by the language for the current platform. diff --git a/Help/variable/CMAKE_LANG_STANDARD_LIBRARIES.rst b/Help/variable/CMAKE_LANG_STANDARD_LIBRARIES.rst index ba6df93..d5f3351 100644 --- a/Help/variable/CMAKE_LANG_STANDARD_LIBRARIES.rst +++ b/Help/variable/CMAKE_LANG_STANDARD_LIBRARIES.rst @@ -1,6 +1,8 @@ CMAKE_<LANG>_STANDARD_LIBRARIES ------------------------------- +.. versionadded:: 3.6 + Libraries linked into every executable and shared library linked for language ``<LANG>``. This is meant for specification of system libraries needed by the language for the current platform. diff --git a/Help/variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst b/Help/variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst index e069cdd..08f95c4 100644 --- a/Help/variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst +++ b/Help/variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst @@ -1,6 +1,8 @@ CMAKE_LIBRARY_OUTPUT_DIRECTORY_<CONFIG> --------------------------------------- +.. versionadded:: 3.3 + Where to put all the :ref:`LIBRARY <Library Output Artifacts>` target files when built for a specific configuration. diff --git a/Help/variable/CMAKE_LINK_DIRECTORIES_BEFORE.rst b/Help/variable/CMAKE_LINK_DIRECTORIES_BEFORE.rst index 026ca35..f120866 100644 --- a/Help/variable/CMAKE_LINK_DIRECTORIES_BEFORE.rst +++ b/Help/variable/CMAKE_LINK_DIRECTORIES_BEFORE.rst @@ -1,6 +1,8 @@ CMAKE_LINK_DIRECTORIES_BEFORE ----------------------------- +.. versionadded:: 3.13 + Whether to append or prepend directories by default in :command:`link_directories`. diff --git a/Help/variable/CMAKE_LINK_SEARCH_END_STATIC.rst b/Help/variable/CMAKE_LINK_SEARCH_END_STATIC.rst index 54cdaaa..f4ccc04 100644 --- a/Help/variable/CMAKE_LINK_SEARCH_END_STATIC.rst +++ b/Help/variable/CMAKE_LINK_SEARCH_END_STATIC.rst @@ -1,6 +1,8 @@ CMAKE_LINK_SEARCH_END_STATIC ---------------------------- +.. versionadded:: 3.4 + End a link line such that static system libraries are used. Some linkers support switches such as ``-Bstatic`` and ``-Bdynamic`` to diff --git a/Help/variable/CMAKE_LINK_SEARCH_START_STATIC.rst b/Help/variable/CMAKE_LINK_SEARCH_START_STATIC.rst index 0d52a31..2025c72 100644 --- a/Help/variable/CMAKE_LINK_SEARCH_START_STATIC.rst +++ b/Help/variable/CMAKE_LINK_SEARCH_START_STATIC.rst @@ -1,6 +1,8 @@ CMAKE_LINK_SEARCH_START_STATIC ------------------------------ +.. versionadded:: 3.4 + Assume the linker looks for static libraries by default. Some linkers support switches such as ``-Bstatic`` and ``-Bdynamic`` to diff --git a/Help/variable/CMAKE_LINK_WHAT_YOU_USE.rst b/Help/variable/CMAKE_LINK_WHAT_YOU_USE.rst index 90c4d3f..06b3aa8 100644 --- a/Help/variable/CMAKE_LINK_WHAT_YOU_USE.rst +++ b/Help/variable/CMAKE_LINK_WHAT_YOU_USE.rst @@ -1,6 +1,8 @@ CMAKE_LINK_WHAT_YOU_USE --------------------------------- +.. versionadded:: 3.7 + Default value for :prop_tgt:`LINK_WHAT_YOU_USE` target property. This variable is used to initialize the property on each target as it is created. diff --git a/Help/variable/CMAKE_MATCH_COUNT.rst b/Help/variable/CMAKE_MATCH_COUNT.rst index 355e834..deeec8b 100644 --- a/Help/variable/CMAKE_MATCH_COUNT.rst +++ b/Help/variable/CMAKE_MATCH_COUNT.rst @@ -1,6 +1,8 @@ CMAKE_MATCH_COUNT ----------------- +.. versionadded:: 3.2 + The number of matches with the last regular expression. When a regular expression match is used, CMake fills in diff --git a/Help/variable/CMAKE_MATCH_n.rst b/Help/variable/CMAKE_MATCH_n.rst index c7dd623..a92788e 100644 --- a/Help/variable/CMAKE_MATCH_n.rst +++ b/Help/variable/CMAKE_MATCH_n.rst @@ -1,6 +1,8 @@ CMAKE_MATCH_<n> --------------- +.. versionadded:: 3.9 + Capture group ``<n>`` matched by the last regular expression, for groups 0 through 9. Group 0 is the entire match. Groups 1 through 9 are the subexpressions captured by ``()`` syntax. diff --git a/Help/variable/CMAKE_MAXIMUM_RECURSION_DEPTH.rst b/Help/variable/CMAKE_MAXIMUM_RECURSION_DEPTH.rst index 7110b16..59c60d3 100644 --- a/Help/variable/CMAKE_MAXIMUM_RECURSION_DEPTH.rst +++ b/Help/variable/CMAKE_MAXIMUM_RECURSION_DEPTH.rst @@ -1,6 +1,8 @@ CMAKE_MAXIMUM_RECURSION_DEPTH ----------------------------- +.. versionadded:: 3.14 + Maximum recursion depth for CMake scripts. It is intended to be set on the command line with ``-DCMAKE_MAXIMUM_RECURSION_DEPTH=<x>``, or within ``CMakeLists.txt`` by projects that require a large recursion depth. Projects diff --git a/Help/variable/CMAKE_MESSAGE_CONTEXT.rst b/Help/variable/CMAKE_MESSAGE_CONTEXT.rst index 6b4ca40..41ace43 100644 --- a/Help/variable/CMAKE_MESSAGE_CONTEXT.rst +++ b/Help/variable/CMAKE_MESSAGE_CONTEXT.rst @@ -1,6 +1,8 @@ CMAKE_MESSAGE_CONTEXT --------------------- +.. versionadded:: 3.17 + When enabled by the :manual:`cmake <cmake(1)>` ``--log-context`` command line option or the :variable:`CMAKE_MESSAGE_CONTEXT_SHOW` variable, the :command:`message` command converts the ``CMAKE_MESSAGE_CONTEXT`` list into a diff --git a/Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst b/Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst index 7ec218e..382e9ff 100644 --- a/Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst +++ b/Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst @@ -1,6 +1,8 @@ CMAKE_MESSAGE_CONTEXT_SHOW -------------------------- +.. versionadded:: 3.17 + Setting this variable to true enables showing a context with each line logged by the :command:`message` command (see :variable:`CMAKE_MESSAGE_CONTEXT` for how the context itself is specified). diff --git a/Help/variable/CMAKE_MESSAGE_INDENT.rst b/Help/variable/CMAKE_MESSAGE_INDENT.rst index 7e44a4c..c6263d2 100644 --- a/Help/variable/CMAKE_MESSAGE_INDENT.rst +++ b/Help/variable/CMAKE_MESSAGE_INDENT.rst @@ -1,6 +1,8 @@ CMAKE_MESSAGE_INDENT -------------------- +.. versionadded:: 3.16 + The :command:`message` command joins the strings from this list and for log levels of ``NOTICE`` and below, it prepends the resultant string to each line of the message. diff --git a/Help/variable/CMAKE_MESSAGE_LOG_LEVEL.rst b/Help/variable/CMAKE_MESSAGE_LOG_LEVEL.rst index 1d4cfe6..3b45d1d 100644 --- a/Help/variable/CMAKE_MESSAGE_LOG_LEVEL.rst +++ b/Help/variable/CMAKE_MESSAGE_LOG_LEVEL.rst @@ -1,6 +1,8 @@ CMAKE_MESSAGE_LOG_LEVEL ----------------------- +.. versionadded:: 3.17 + When set, this variable specifies the logging level used by the :command:`message` command. Valid values are the same as those for the ``--log-level`` command line option of the :manual:`cmake(1)` program. diff --git a/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG_INIT.rst b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG_INIT.rst index 3279014..e8a6401 100644 --- a/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG_INIT.rst +++ b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG_INIT.rst @@ -1,6 +1,8 @@ CMAKE_MODULE_LINKER_FLAGS_<CONFIG>_INIT --------------------------------------- +.. versionadded:: 3.7 + Value used to initialize the :variable:`CMAKE_MODULE_LINKER_FLAGS_<CONFIG>` cache entry the first time a build tree is configured. This variable is meant to be set by a :variable:`toolchain file diff --git a/Help/variable/CMAKE_MODULE_LINKER_FLAGS_INIT.rst b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_INIT.rst index 91b39f6..d59e9bf 100644 --- a/Help/variable/CMAKE_MODULE_LINKER_FLAGS_INIT.rst +++ b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_INIT.rst @@ -1,6 +1,8 @@ CMAKE_MODULE_LINKER_FLAGS_INIT ------------------------------ +.. versionadded:: 3.7 + Value used to initialize the :variable:`CMAKE_MODULE_LINKER_FLAGS` cache entry the first time a build tree is configured. This variable is meant to be set by a :variable:`toolchain file diff --git a/Help/variable/CMAKE_MSVCIDE_RUN_PATH.rst b/Help/variable/CMAKE_MSVCIDE_RUN_PATH.rst index 22e727f..721ceaa 100644 --- a/Help/variable/CMAKE_MSVCIDE_RUN_PATH.rst +++ b/Help/variable/CMAKE_MSVCIDE_RUN_PATH.rst @@ -1,6 +1,8 @@ CMAKE_MSVCIDE_RUN_PATH ---------------------- +.. versionadded:: 3.10 + Extra PATH locations that should be used when executing :command:`add_custom_command` or :command:`add_custom_target` when using the :generator:`Visual Studio 9 2008` (or above) generator. This allows diff --git a/Help/variable/CMAKE_MSVC_RUNTIME_LIBRARY.rst b/Help/variable/CMAKE_MSVC_RUNTIME_LIBRARY.rst index 8b54e7e..14806e6 100644 --- a/Help/variable/CMAKE_MSVC_RUNTIME_LIBRARY.rst +++ b/Help/variable/CMAKE_MSVC_RUNTIME_LIBRARY.rst @@ -1,6 +1,8 @@ CMAKE_MSVC_RUNTIME_LIBRARY -------------------------- +.. versionadded:: 3.15 + Select the MSVC runtime library for use by compilers targeting the MSVC ABI. This variable is used to initialize the :prop_tgt:`MSVC_RUNTIME_LIBRARY` property on all targets as they are created. It is also propagated by diff --git a/Help/variable/CMAKE_NETRC.rst b/Help/variable/CMAKE_NETRC.rst index 903ec31..2c64a81 100644 --- a/Help/variable/CMAKE_NETRC.rst +++ b/Help/variable/CMAKE_NETRC.rst @@ -1,6 +1,8 @@ CMAKE_NETRC ----------- +.. versionadded:: 3.11 + This variable is used to initialize the ``NETRC`` option for :command:`file(DOWNLOAD)` and :command:`file(UPLOAD)` commands and the module :module:`ExternalProject`. See those commands for additional diff --git a/Help/variable/CMAKE_NETRC_FILE.rst b/Help/variable/CMAKE_NETRC_FILE.rst index 0f09afe..97a645e 100644 --- a/Help/variable/CMAKE_NETRC_FILE.rst +++ b/Help/variable/CMAKE_NETRC_FILE.rst @@ -1,6 +1,8 @@ CMAKE_NETRC_FILE ---------------- +.. versionadded:: 3.11 + This variable is used to initialize the ``NETRC_FILE`` option for :command:`file(DOWNLOAD)` and :command:`file(UPLOAD)` commands and the module :module:`ExternalProject`. See those commands for additional diff --git a/Help/variable/CMAKE_NINJA_OUTPUT_PATH_PREFIX.rst b/Help/variable/CMAKE_NINJA_OUTPUT_PATH_PREFIX.rst index 64091aa..a8c4035 100644 --- a/Help/variable/CMAKE_NINJA_OUTPUT_PATH_PREFIX.rst +++ b/Help/variable/CMAKE_NINJA_OUTPUT_PATH_PREFIX.rst @@ -1,6 +1,8 @@ CMAKE_NINJA_OUTPUT_PATH_PREFIX ------------------------------ +.. versionadded:: 3.6 + Set output files path prefix for the :generator:`Ninja` generator. Every output files listed in the generated ``build.ninja`` will be diff --git a/Help/variable/CMAKE_OBJCXX_EXTENSIONS.rst b/Help/variable/CMAKE_OBJCXX_EXTENSIONS.rst index 8afa6f2..b5225ea 100644 --- a/Help/variable/CMAKE_OBJCXX_EXTENSIONS.rst +++ b/Help/variable/CMAKE_OBJCXX_EXTENSIONS.rst @@ -1,6 +1,8 @@ CMAKE_OBJCXX_EXTENSIONS ----------------------- +.. versionadded:: 3.16 + Default value for :prop_tgt:`OBJCXX_EXTENSIONS` property of targets. This variable is used to initialize the :prop_tgt:`OBJCXX_EXTENSIONS` diff --git a/Help/variable/CMAKE_OBJCXX_STANDARD.rst b/Help/variable/CMAKE_OBJCXX_STANDARD.rst index 4e5016a..98e4624 100644 --- a/Help/variable/CMAKE_OBJCXX_STANDARD.rst +++ b/Help/variable/CMAKE_OBJCXX_STANDARD.rst @@ -1,6 +1,8 @@ CMAKE_OBJCXX_STANDARD --------------------- +.. versionadded:: 3.16 + Default value for :prop_tgt:`OBJCXX_STANDARD` property of targets. This variable is used to initialize the :prop_tgt:`OBJCXX_STANDARD` diff --git a/Help/variable/CMAKE_OBJCXX_STANDARD_REQUIRED.rst b/Help/variable/CMAKE_OBJCXX_STANDARD_REQUIRED.rst index 3a0602a..4b5e77c 100644 --- a/Help/variable/CMAKE_OBJCXX_STANDARD_REQUIRED.rst +++ b/Help/variable/CMAKE_OBJCXX_STANDARD_REQUIRED.rst @@ -1,6 +1,8 @@ CMAKE_OBJCXX_STANDARD_REQUIRED ------------------------------ +.. versionadded:: 3.16 + Default value for :prop_tgt:`OBJCXX_STANDARD_REQUIRED` property of targets. This variable is used to initialize the :prop_tgt:`OBJCXX_STANDARD_REQUIRED` diff --git a/Help/variable/CMAKE_OBJC_EXTENSIONS.rst b/Help/variable/CMAKE_OBJC_EXTENSIONS.rst index d9619d8..d6e3c7d 100644 --- a/Help/variable/CMAKE_OBJC_EXTENSIONS.rst +++ b/Help/variable/CMAKE_OBJC_EXTENSIONS.rst @@ -1,6 +1,8 @@ CMAKE_OBJC_EXTENSIONS --------------------- +.. versionadded:: 3.16 + Default value for :prop_tgt:`OBJC_EXTENSIONS` property of targets. This variable is used to initialize the :prop_tgt:`OBJC_EXTENSIONS` diff --git a/Help/variable/CMAKE_OBJC_STANDARD.rst b/Help/variable/CMAKE_OBJC_STANDARD.rst index 976c441..fde367d 100644 --- a/Help/variable/CMAKE_OBJC_STANDARD.rst +++ b/Help/variable/CMAKE_OBJC_STANDARD.rst @@ -1,6 +1,8 @@ CMAKE_OBJC_STANDARD ------------------- +.. versionadded:: 3.16 + Default value for :prop_tgt:`OBJC_STANDARD` property of targets. This variable is used to initialize the :prop_tgt:`OBJC_STANDARD` diff --git a/Help/variable/CMAKE_OBJC_STANDARD_REQUIRED.rst b/Help/variable/CMAKE_OBJC_STANDARD_REQUIRED.rst index 5c02096..8d26d95 100644 --- a/Help/variable/CMAKE_OBJC_STANDARD_REQUIRED.rst +++ b/Help/variable/CMAKE_OBJC_STANDARD_REQUIRED.rst @@ -1,6 +1,8 @@ CMAKE_OBJC_STANDARD_REQUIRED ---------------------------- +.. versionadded:: 3.16 + Default value for :prop_tgt:`OBJC_STANDARD_REQUIRED` property of targets. This variable is used to initialize the :prop_tgt:`OBJC_STANDARD_REQUIRED` diff --git a/Help/variable/CMAKE_OPTIMIZE_DEPENDENCIES.rst b/Help/variable/CMAKE_OPTIMIZE_DEPENDENCIES.rst new file mode 100644 index 0000000..eed352a --- /dev/null +++ b/Help/variable/CMAKE_OPTIMIZE_DEPENDENCIES.rst @@ -0,0 +1,4 @@ +CMAKE_OPTIMIZE_DEPENDENCIES +--------------------------- + +Initializes the :prop_tgt:`OPTIMIZE_DEPENDENCIES` target property. diff --git a/Help/variable/CMAKE_PCH_WARN_INVALID.rst b/Help/variable/CMAKE_PCH_WARN_INVALID.rst index e152abd..457a428 100644 --- a/Help/variable/CMAKE_PCH_WARN_INVALID.rst +++ b/Help/variable/CMAKE_PCH_WARN_INVALID.rst @@ -1,5 +1,7 @@ CMAKE_PCH_WARN_INVALID ---------------------- +.. versionadded:: 3.18 + This variable is used to initialize the :prop_tgt:`PCH_WARN_INVALID` property of targets when they are created. diff --git a/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst b/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst index 51b0592..95cbe40 100644 --- a/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst +++ b/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst @@ -1,6 +1,8 @@ CMAKE_PROJECT_DESCRIPTION ------------------------- +.. versionadded:: 3.9 + The description of the top level project. This variable holds the description of the project as specified in the top diff --git a/Help/variable/CMAKE_PROJECT_HOMEPAGE_URL.rst b/Help/variable/CMAKE_PROJECT_HOMEPAGE_URL.rst index ee0bf7c..4c5debe 100644 --- a/Help/variable/CMAKE_PROJECT_HOMEPAGE_URL.rst +++ b/Help/variable/CMAKE_PROJECT_HOMEPAGE_URL.rst @@ -1,6 +1,8 @@ CMAKE_PROJECT_HOMEPAGE_URL -------------------------- +.. versionadded:: 3.12 + The homepage URL of the top level project. This variable holds the homepage URL of the project as specified in the top diff --git a/Help/variable/CMAKE_PROJECT_INCLUDE.rst b/Help/variable/CMAKE_PROJECT_INCLUDE.rst index 5835264..41d9e5d 100644 --- a/Help/variable/CMAKE_PROJECT_INCLUDE.rst +++ b/Help/variable/CMAKE_PROJECT_INCLUDE.rst @@ -1,6 +1,8 @@ CMAKE_PROJECT_INCLUDE --------------------- +.. versionadded:: 3.15 + A CMake language file or module to be included as the last step of all :command:`project` command calls. This is intended for injecting custom code into project builds without modifying their source. diff --git a/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst b/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst index 280c14a..c2fd0f8 100644 --- a/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst +++ b/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst @@ -1,6 +1,8 @@ CMAKE_PROJECT_INCLUDE_BEFORE ---------------------------- +.. versionadded:: 3.15 + A CMake language file or module to be included as the first step of all :command:`project` command calls. This is intended for injecting custom code into project builds without modifying their source. diff --git a/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE_BEFORE.rst b/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE_BEFORE.rst index db1432d..39abb12 100644 --- a/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE_BEFORE.rst +++ b/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE_BEFORE.rst @@ -1,6 +1,8 @@ CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE ------------------------------------------- +.. versionadded:: 3.17 + A CMake language file or module to be included as the first step of any :command:`project` command calls that specify ``<PROJECT-NAME>`` as the project name. This is intended for injecting custom code into project builds without diff --git a/Help/variable/CMAKE_PROJECT_VERSION.rst b/Help/variable/CMAKE_PROJECT_VERSION.rst index 4f8f556..450c136 100644 --- a/Help/variable/CMAKE_PROJECT_VERSION.rst +++ b/Help/variable/CMAKE_PROJECT_VERSION.rst @@ -1,6 +1,8 @@ CMAKE_PROJECT_VERSION --------------------- +.. versionadded:: 3.12 + The version of the top level project. This variable holds the version of the project as specified in the top diff --git a/Help/variable/CMAKE_PROJECT_VERSION_MAJOR.rst b/Help/variable/CMAKE_PROJECT_VERSION_MAJOR.rst index f1001ac..c7511e7 100644 --- a/Help/variable/CMAKE_PROJECT_VERSION_MAJOR.rst +++ b/Help/variable/CMAKE_PROJECT_VERSION_MAJOR.rst @@ -1,6 +1,8 @@ CMAKE_PROJECT_VERSION_MAJOR --------------------------- +.. versionadded:: 3.12 + The major version of the top level project. This variable holds the major version of the project as specified in the top diff --git a/Help/variable/CMAKE_PROJECT_VERSION_MINOR.rst b/Help/variable/CMAKE_PROJECT_VERSION_MINOR.rst index 13202be..dd91dcf 100644 --- a/Help/variable/CMAKE_PROJECT_VERSION_MINOR.rst +++ b/Help/variable/CMAKE_PROJECT_VERSION_MINOR.rst @@ -1,6 +1,8 @@ CMAKE_PROJECT_VERSION_MINOR --------------------------- +.. versionadded:: 3.12 + The minor version of the top level project. This variable holds the minor version of the project as specified in the top diff --git a/Help/variable/CMAKE_PROJECT_VERSION_PATCH.rst b/Help/variable/CMAKE_PROJECT_VERSION_PATCH.rst index b8570d9..61fd1f3 100644 --- a/Help/variable/CMAKE_PROJECT_VERSION_PATCH.rst +++ b/Help/variable/CMAKE_PROJECT_VERSION_PATCH.rst @@ -1,6 +1,8 @@ CMAKE_PROJECT_VERSION_PATCH --------------------------- +.. versionadded:: 3.12 + The patch version of the top level project. This variable holds the patch version of the project as specified in the top diff --git a/Help/variable/CMAKE_PROJECT_VERSION_TWEAK.rst b/Help/variable/CMAKE_PROJECT_VERSION_TWEAK.rst index e1ad4be..0deae8b 100644 --- a/Help/variable/CMAKE_PROJECT_VERSION_TWEAK.rst +++ b/Help/variable/CMAKE_PROJECT_VERSION_TWEAK.rst @@ -1,6 +1,8 @@ CMAKE_PROJECT_VERSION_TWEAK --------------------------- +.. versionadded:: 3.12 + The tweak version of the top level project. This variable holds the tweak version of the project as specified in the top diff --git a/Help/variable/CMAKE_RULE_MESSAGES.rst b/Help/variable/CMAKE_RULE_MESSAGES.rst index 7460a81..39be2e9 100644 --- a/Help/variable/CMAKE_RULE_MESSAGES.rst +++ b/Help/variable/CMAKE_RULE_MESSAGES.rst @@ -1,6 +1,8 @@ CMAKE_RULE_MESSAGES ------------------- +.. versionadded:: 3.13 + Specify whether to report a message for each make rule. If set in the cache it is used to initialize the value of the :prop_gbl:`RULE_MESSAGES` property. diff --git a/Help/variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst b/Help/variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst index 080dea6..c9c55c5 100644 --- a/Help/variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst +++ b/Help/variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst @@ -1,6 +1,8 @@ CMAKE_RUNTIME_OUTPUT_DIRECTORY_<CONFIG> --------------------------------------- +.. versionadded:: 3.3 + Where to put all the :ref:`RUNTIME <Runtime Output Artifacts>` target files when built for a specific configuration. diff --git a/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG_INIT.rst b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG_INIT.rst index 185df38..7f3dec7 100644 --- a/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG_INIT.rst +++ b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG_INIT.rst @@ -1,6 +1,8 @@ CMAKE_SHARED_LINKER_FLAGS_<CONFIG>_INIT --------------------------------------- +.. versionadded:: 3.7 + Value used to initialize the :variable:`CMAKE_SHARED_LINKER_FLAGS_<CONFIG>` cache entry the first time a build tree is configured. This variable is meant to be set by a :variable:`toolchain file diff --git a/Help/variable/CMAKE_SHARED_LINKER_FLAGS_INIT.rst b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_INIT.rst index cb819a7..6d51afe 100644 --- a/Help/variable/CMAKE_SHARED_LINKER_FLAGS_INIT.rst +++ b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_INIT.rst @@ -1,6 +1,8 @@ CMAKE_SHARED_LINKER_FLAGS_INIT ------------------------------ +.. versionadded:: 3.7 + Value used to initialize the :variable:`CMAKE_SHARED_LINKER_FLAGS` cache entry the first time a build tree is configured. This variable is meant to be set by a :variable:`toolchain file diff --git a/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG_INIT.rst b/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG_INIT.rst index a49d1cb..5e65ef2 100644 --- a/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG_INIT.rst +++ b/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG_INIT.rst @@ -1,6 +1,8 @@ CMAKE_STATIC_LINKER_FLAGS_<CONFIG>_INIT --------------------------------------- +.. versionadded:: 3.7 + Value used to initialize the :variable:`CMAKE_STATIC_LINKER_FLAGS_<CONFIG>` cache entry the first time a build tree is configured. This variable is meant to be set by a :variable:`toolchain file diff --git a/Help/variable/CMAKE_STATIC_LINKER_FLAGS_INIT.rst b/Help/variable/CMAKE_STATIC_LINKER_FLAGS_INIT.rst index 113ca71..cbf681c 100644 --- a/Help/variable/CMAKE_STATIC_LINKER_FLAGS_INIT.rst +++ b/Help/variable/CMAKE_STATIC_LINKER_FLAGS_INIT.rst @@ -1,6 +1,8 @@ CMAKE_STATIC_LINKER_FLAGS_INIT ------------------------------ +.. versionadded:: 3.7 + Value used to initialize the :variable:`CMAKE_STATIC_LINKER_FLAGS` cache entry the first time a build tree is configured. This variable is meant to be set by a :variable:`toolchain file diff --git a/Help/variable/CMAKE_SUBLIME_TEXT_2_ENV_SETTINGS.rst b/Help/variable/CMAKE_SUBLIME_TEXT_2_ENV_SETTINGS.rst index 02c8663..5c1c8d1 100644 --- a/Help/variable/CMAKE_SUBLIME_TEXT_2_ENV_SETTINGS.rst +++ b/Help/variable/CMAKE_SUBLIME_TEXT_2_ENV_SETTINGS.rst @@ -1,6 +1,8 @@ CMAKE_SUBLIME_TEXT_2_ENV_SETTINGS --------------------------------- +.. versionadded:: 3.8 + This variable contains a list of env vars as a list of tokens with the syntax ``var=value``. diff --git a/Help/variable/CMAKE_SUBLIME_TEXT_2_EXCLUDE_BUILD_TREE.rst b/Help/variable/CMAKE_SUBLIME_TEXT_2_EXCLUDE_BUILD_TREE.rst index d654425..28b0dbd 100644 --- a/Help/variable/CMAKE_SUBLIME_TEXT_2_EXCLUDE_BUILD_TREE.rst +++ b/Help/variable/CMAKE_SUBLIME_TEXT_2_EXCLUDE_BUILD_TREE.rst @@ -1,6 +1,8 @@ CMAKE_SUBLIME_TEXT_2_EXCLUDE_BUILD_TREE --------------------------------------- +.. versionadded:: 3.8 + If this variable evaluates to ``ON`` at the end of the top-level ``CMakeLists.txt`` file, the :generator:`Sublime Text 2` extra generator excludes the build tree from the ``.sublime-project`` if it is inside the diff --git a/Help/variable/CMAKE_SUPPRESS_REGENERATION.rst b/Help/variable/CMAKE_SUPPRESS_REGENERATION.rst index 96184dd..48490ff 100644 --- a/Help/variable/CMAKE_SUPPRESS_REGENERATION.rst +++ b/Help/variable/CMAKE_SUPPRESS_REGENERATION.rst @@ -1,6 +1,8 @@ CMAKE_SUPPRESS_REGENERATION --------------------------- +.. versionadded:: 3.12 + If ``CMAKE_SUPPRESS_REGENERATION`` is ``OFF``, which is default, then CMake adds a special target on which all other targets depend that checks the build system and optionally re-runs CMake to regenerate the build system when diff --git a/Help/variable/CMAKE_SYSROOT_COMPILE.rst b/Help/variable/CMAKE_SYSROOT_COMPILE.rst index e96c62b..4aea48e 100644 --- a/Help/variable/CMAKE_SYSROOT_COMPILE.rst +++ b/Help/variable/CMAKE_SYSROOT_COMPILE.rst @@ -1,6 +1,8 @@ CMAKE_SYSROOT_COMPILE --------------------- +.. versionadded:: 3.9 + Path to pass to the compiler in the ``--sysroot`` flag when compiling source files. This is the same as :variable:`CMAKE_SYSROOT` but is used only for compiling sources and not linking. diff --git a/Help/variable/CMAKE_SYSROOT_LINK.rst b/Help/variable/CMAKE_SYSROOT_LINK.rst index 88b48ef..9749b7b 100644 --- a/Help/variable/CMAKE_SYSROOT_LINK.rst +++ b/Help/variable/CMAKE_SYSROOT_LINK.rst @@ -1,6 +1,8 @@ CMAKE_SYSROOT_LINK ------------------ +.. versionadded:: 3.9 + Path to pass to the compiler in the ``--sysroot`` flag when linking. This is the same as :variable:`CMAKE_SYSROOT` but is used only for linking and not compiling sources. diff --git a/Help/variable/CMAKE_SYSTEM_APPBUNDLE_PATH.rst b/Help/variable/CMAKE_SYSTEM_APPBUNDLE_PATH.rst index 666af46..06a99a8 100644 --- a/Help/variable/CMAKE_SYSTEM_APPBUNDLE_PATH.rst +++ b/Help/variable/CMAKE_SYSTEM_APPBUNDLE_PATH.rst @@ -1,6 +1,8 @@ CMAKE_SYSTEM_APPBUNDLE_PATH --------------------------- +.. versionadded:: 3.4 + Search path for macOS application bundles used by the :command:`find_program`, and :command:`find_package` commands. By default it contains the standard directories for the current system. It is *not* intended to be modified by diff --git a/Help/variable/CMAKE_SYSTEM_FRAMEWORK_PATH.rst b/Help/variable/CMAKE_SYSTEM_FRAMEWORK_PATH.rst index 14ba18e..1a402c1 100644 --- a/Help/variable/CMAKE_SYSTEM_FRAMEWORK_PATH.rst +++ b/Help/variable/CMAKE_SYSTEM_FRAMEWORK_PATH.rst @@ -1,6 +1,8 @@ CMAKE_SYSTEM_FRAMEWORK_PATH --------------------------- +.. versionadded:: 3.4 + Search path for macOS frameworks used by the :command:`find_library`, :command:`find_package`, :command:`find_path`, and :command:`find_file` commands. By default it contains the standard directories for the diff --git a/Help/variable/CMAKE_Swift_LANGUAGE_VERSION.rst b/Help/variable/CMAKE_Swift_LANGUAGE_VERSION.rst index b4a74eb..fce6fa7 100644 --- a/Help/variable/CMAKE_Swift_LANGUAGE_VERSION.rst +++ b/Help/variable/CMAKE_Swift_LANGUAGE_VERSION.rst @@ -1,6 +1,8 @@ CMAKE_Swift_LANGUAGE_VERSION ---------------------------- +.. versionadded:: 3.7 + Set to the Swift language version number. If not set, the oldest legacy version known to be available in the host Xcode version is assumed: diff --git a/Help/variable/CMAKE_Swift_MODULE_DIRECTORY.rst b/Help/variable/CMAKE_Swift_MODULE_DIRECTORY.rst index b11253b..3694973 100644 --- a/Help/variable/CMAKE_Swift_MODULE_DIRECTORY.rst +++ b/Help/variable/CMAKE_Swift_MODULE_DIRECTORY.rst @@ -1,6 +1,8 @@ CMAKE_Swift_MODULE_DIRECTORY ---------------------------- +.. versionadded:: 3.15 + Swift module output directory. This variable is used to initialise the :prop_tgt:`Swift_MODULE_DIRECTORY` diff --git a/Help/variable/CMAKE_Swift_NUM_THREADS.rst b/Help/variable/CMAKE_Swift_NUM_THREADS.rst index cb33678..e1dafb0 100644 --- a/Help/variable/CMAKE_Swift_NUM_THREADS.rst +++ b/Help/variable/CMAKE_Swift_NUM_THREADS.rst @@ -1,6 +1,8 @@ CMAKE_Swift_NUM_THREADS ----------------------- +.. versionadded:: 3.15.1 + Number of threads for parallel compilation for Swift targets. This variable controls the number of parallel jobs that the swift driver creates diff --git a/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst b/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst index 0f96787..d178513 100644 --- a/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst +++ b/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst @@ -1,6 +1,8 @@ CMAKE_TRY_COMPILE_PLATFORM_VARIABLES ------------------------------------ +.. versionadded:: 3.6 + List of variables that the :command:`try_compile` command source file signature must propagate into the test project in order to target the same platform as the host project. diff --git a/Help/variable/CMAKE_TRY_COMPILE_TARGET_TYPE.rst b/Help/variable/CMAKE_TRY_COMPILE_TARGET_TYPE.rst index 5fa8dfc..b60539f 100644 --- a/Help/variable/CMAKE_TRY_COMPILE_TARGET_TYPE.rst +++ b/Help/variable/CMAKE_TRY_COMPILE_TARGET_TYPE.rst @@ -1,6 +1,8 @@ CMAKE_TRY_COMPILE_TARGET_TYPE ----------------------------- +.. versionadded:: 3.6 + Type of target generated for :command:`try_compile` calls using the source file signature. Valid values are: diff --git a/Help/variable/CMAKE_UNITY_BUILD.rst b/Help/variable/CMAKE_UNITY_BUILD.rst index a86cd67..54a781a 100644 --- a/Help/variable/CMAKE_UNITY_BUILD.rst +++ b/Help/variable/CMAKE_UNITY_BUILD.rst @@ -1,6 +1,8 @@ CMAKE_UNITY_BUILD ----------------- +.. versionadded:: 3.16 + This variable is used to initialize the :prop_tgt:`UNITY_BUILD` property of targets when they are created. Setting it to true enables batch compilation of multiple sources within each target. diff --git a/Help/variable/CMAKE_UNITY_BUILD_BATCH_SIZE.rst b/Help/variable/CMAKE_UNITY_BUILD_BATCH_SIZE.rst index 7988d4b..7733fe8 100644 --- a/Help/variable/CMAKE_UNITY_BUILD_BATCH_SIZE.rst +++ b/Help/variable/CMAKE_UNITY_BUILD_BATCH_SIZE.rst @@ -1,6 +1,8 @@ CMAKE_UNITY_BUILD_BATCH_SIZE ---------------------------- +.. versionadded:: 3.16 + This variable is used to initialize the :prop_tgt:`UNITY_BUILD_BATCH_SIZE` property of targets when they are created. It specifies the default upper limit on the number of source files that may be combined in any one unity diff --git a/Help/variable/CMAKE_VS_GLOBALS.rst b/Help/variable/CMAKE_VS_GLOBALS.rst index 83777b6..d4514fe 100644 --- a/Help/variable/CMAKE_VS_GLOBALS.rst +++ b/Help/variable/CMAKE_VS_GLOBALS.rst @@ -1,6 +1,8 @@ CMAKE_VS_GLOBALS ---------------- +.. versionadded:: 3.13 + List of ``Key=Value`` records to be set per target as target properties :prop_tgt:`VS_GLOBAL_<variable>` with ``variable=Key`` and value ``Value``. diff --git a/Help/variable/CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD.rst b/Help/variable/CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD.rst index f54472a..ace94e4 100644 --- a/Help/variable/CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD.rst +++ b/Help/variable/CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD.rst @@ -1,6 +1,8 @@ CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD ----------------------------------------- +.. versionadded:: 3.3 + Include ``INSTALL`` target to default build. In Visual Studio solution, by default the ``INSTALL`` target will not be part diff --git a/Help/variable/CMAKE_VS_INCLUDE_PACKAGE_TO_DEFAULT_BUILD.rst b/Help/variable/CMAKE_VS_INCLUDE_PACKAGE_TO_DEFAULT_BUILD.rst index 693ba45..ab4d0fa 100644 --- a/Help/variable/CMAKE_VS_INCLUDE_PACKAGE_TO_DEFAULT_BUILD.rst +++ b/Help/variable/CMAKE_VS_INCLUDE_PACKAGE_TO_DEFAULT_BUILD.rst @@ -1,6 +1,8 @@ CMAKE_VS_INCLUDE_PACKAGE_TO_DEFAULT_BUILD ----------------------------------------- +.. versionadded:: 3.8 + Include ``PACKAGE`` target to default build. In Visual Studio solution, by default the ``PACKAGE`` target will not be part diff --git a/Help/variable/CMAKE_VS_JUST_MY_CODE_DEBUGGING.rst b/Help/variable/CMAKE_VS_JUST_MY_CODE_DEBUGGING.rst index 546cdf4..0a02a32 100644 --- a/Help/variable/CMAKE_VS_JUST_MY_CODE_DEBUGGING.rst +++ b/Help/variable/CMAKE_VS_JUST_MY_CODE_DEBUGGING.rst @@ -1,6 +1,8 @@ CMAKE_VS_JUST_MY_CODE_DEBUGGING ------------------------------- +.. versionadded:: 3.15 + Enable Just My Code with Visual Studio debugger. This variable is used to initialize the :prop_tgt:`VS_JUST_MY_CODE_DEBUGGING` diff --git a/Help/variable/CMAKE_VS_NsightTegra_VERSION.rst b/Help/variable/CMAKE_VS_NsightTegra_VERSION.rst index 386c3a9..2982b39 100644 --- a/Help/variable/CMAKE_VS_NsightTegra_VERSION.rst +++ b/Help/variable/CMAKE_VS_NsightTegra_VERSION.rst @@ -1,6 +1,8 @@ CMAKE_VS_NsightTegra_VERSION ---------------------------- +.. versionadded:: 3.1 + When using a Visual Studio generator with the :variable:`CMAKE_SYSTEM_NAME` variable set to ``Android``, this variable contains the version number of the diff --git a/Help/variable/CMAKE_VS_PLATFORM_NAME.rst b/Help/variable/CMAKE_VS_PLATFORM_NAME.rst index 7a4642a..7d08add 100644 --- a/Help/variable/CMAKE_VS_PLATFORM_NAME.rst +++ b/Help/variable/CMAKE_VS_PLATFORM_NAME.rst @@ -1,6 +1,8 @@ CMAKE_VS_PLATFORM_NAME ---------------------- +.. versionadded:: 3.1 + Visual Studio target platform name used by the current generator. VS 8 and above allow project files to specify a target platform. diff --git a/Help/variable/CMAKE_VS_PLATFORM_NAME_DEFAULT.rst b/Help/variable/CMAKE_VS_PLATFORM_NAME_DEFAULT.rst index c18e6fd..6440174 100644 --- a/Help/variable/CMAKE_VS_PLATFORM_NAME_DEFAULT.rst +++ b/Help/variable/CMAKE_VS_PLATFORM_NAME_DEFAULT.rst @@ -1,6 +1,8 @@ CMAKE_VS_PLATFORM_NAME_DEFAULT ------------------------------ +.. versionadded:: 3.14.3 + Default for the Visual Studio target platform name for the current generator without considering the value of the :variable:`CMAKE_GENERATOR_PLATFORM` variable. For :ref:`Visual Studio Generators` for VS 2017 and below this is diff --git a/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_CUDA.rst b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_CUDA.rst index 67b7f74..e66378d 100644 --- a/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_CUDA.rst +++ b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_CUDA.rst @@ -1,6 +1,8 @@ CMAKE_VS_PLATFORM_TOOLSET_CUDA ------------------------------ +.. versionadded:: 3.9 + NVIDIA CUDA Toolkit version whose Visual Studio toolset to use. The :ref:`Visual Studio Generators` for VS 2010 and above support using diff --git a/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_CUDA_CUSTOM_DIR.rst b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_CUDA_CUSTOM_DIR.rst index 060648a..74db6b1 100644 --- a/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_CUDA_CUSTOM_DIR.rst +++ b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_CUDA_CUSTOM_DIR.rst @@ -1,6 +1,8 @@ CMAKE_VS_PLATFORM_TOOLSET_CUDA_CUSTOM_DIR ----------------------------------------- +.. versionadded:: 3.16 + Path to standalone NVIDIA CUDA Toolkit (eg. extracted from installer). The :ref:`Visual Studio Generators` for VS 2010 and above support using diff --git a/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_HOST_ARCHITECTURE.rst b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_HOST_ARCHITECTURE.rst index 99ac90d..84d7212 100644 --- a/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_HOST_ARCHITECTURE.rst +++ b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_HOST_ARCHITECTURE.rst @@ -1,6 +1,8 @@ CMAKE_VS_PLATFORM_TOOLSET_HOST_ARCHITECTURE ------------------------------------------- +.. versionadded:: 3.8 + Visual Studio preferred tool architecture. The :ref:`Visual Studio Generators` for VS 2013 and above support using diff --git a/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_VERSION.rst b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_VERSION.rst index 4d9b978..64f2e39 100644 --- a/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_VERSION.rst +++ b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET_VERSION.rst @@ -1,6 +1,8 @@ CMAKE_VS_PLATFORM_TOOLSET_VERSION --------------------------------- +.. versionadded:: 3.12 + Visual Studio Platform Toolset version. The :ref:`Visual Studio Generators` for VS 2017 and above allow to diff --git a/Help/variable/CMAKE_VS_SDK_EXCLUDE_DIRECTORIES.rst b/Help/variable/CMAKE_VS_SDK_EXCLUDE_DIRECTORIES.rst index 36c4dcc..969f328 100644 --- a/Help/variable/CMAKE_VS_SDK_EXCLUDE_DIRECTORIES.rst +++ b/Help/variable/CMAKE_VS_SDK_EXCLUDE_DIRECTORIES.rst @@ -1,4 +1,6 @@ CMAKE_VS_SDK_EXCLUDE_DIRECTORIES -------------------------------- +.. versionadded:: 3.12 + This variable allows to override Visual Studio default Exclude Directories. diff --git a/Help/variable/CMAKE_VS_SDK_EXECUTABLE_DIRECTORIES.rst b/Help/variable/CMAKE_VS_SDK_EXECUTABLE_DIRECTORIES.rst index 3ec755b..7455e10 100644 --- a/Help/variable/CMAKE_VS_SDK_EXECUTABLE_DIRECTORIES.rst +++ b/Help/variable/CMAKE_VS_SDK_EXECUTABLE_DIRECTORIES.rst @@ -1,4 +1,6 @@ CMAKE_VS_SDK_EXECUTABLE_DIRECTORIES ----------------------------------- +.. versionadded:: 3.12 + This variable allows to override Visual Studio default Executable Directories. diff --git a/Help/variable/CMAKE_VS_SDK_INCLUDE_DIRECTORIES.rst b/Help/variable/CMAKE_VS_SDK_INCLUDE_DIRECTORIES.rst index da10bde..3f27aea 100644 --- a/Help/variable/CMAKE_VS_SDK_INCLUDE_DIRECTORIES.rst +++ b/Help/variable/CMAKE_VS_SDK_INCLUDE_DIRECTORIES.rst @@ -1,4 +1,6 @@ CMAKE_VS_SDK_INCLUDE_DIRECTORIES -------------------------------- +.. versionadded:: 3.12 + This variable allows to override Visual Studio default Include Directories. diff --git a/Help/variable/CMAKE_VS_SDK_LIBRARY_DIRECTORIES.rst b/Help/variable/CMAKE_VS_SDK_LIBRARY_DIRECTORIES.rst index b33754a..35e45a3 100644 --- a/Help/variable/CMAKE_VS_SDK_LIBRARY_DIRECTORIES.rst +++ b/Help/variable/CMAKE_VS_SDK_LIBRARY_DIRECTORIES.rst @@ -1,4 +1,6 @@ CMAKE_VS_SDK_LIBRARY_DIRECTORIES -------------------------------- +.. versionadded:: 3.12 + This variable allows to override Visual Studio default Library Directories. diff --git a/Help/variable/CMAKE_VS_SDK_LIBRARY_WINRT_DIRECTORIES.rst b/Help/variable/CMAKE_VS_SDK_LIBRARY_WINRT_DIRECTORIES.rst index b022215..24b90b6 100644 --- a/Help/variable/CMAKE_VS_SDK_LIBRARY_WINRT_DIRECTORIES.rst +++ b/Help/variable/CMAKE_VS_SDK_LIBRARY_WINRT_DIRECTORIES.rst @@ -1,5 +1,7 @@ CMAKE_VS_SDK_LIBRARY_WINRT_DIRECTORIES -------------------------------------- +.. versionadded:: 3.12 + This variable allows to override Visual Studio default Library WinRT Directories. diff --git a/Help/variable/CMAKE_VS_SDK_REFERENCE_DIRECTORIES.rst b/Help/variable/CMAKE_VS_SDK_REFERENCE_DIRECTORIES.rst index c03f0ae..00382fe 100644 --- a/Help/variable/CMAKE_VS_SDK_REFERENCE_DIRECTORIES.rst +++ b/Help/variable/CMAKE_VS_SDK_REFERENCE_DIRECTORIES.rst @@ -1,4 +1,6 @@ CMAKE_VS_SDK_REFERENCE_DIRECTORIES ---------------------------------- +.. versionadded:: 3.12 + This variable allows to override Visual Studio default Reference Directories. diff --git a/Help/variable/CMAKE_VS_SDK_SOURCE_DIRECTORIES.rst b/Help/variable/CMAKE_VS_SDK_SOURCE_DIRECTORIES.rst index 0c73f06..b98c999 100644 --- a/Help/variable/CMAKE_VS_SDK_SOURCE_DIRECTORIES.rst +++ b/Help/variable/CMAKE_VS_SDK_SOURCE_DIRECTORIES.rst @@ -1,4 +1,6 @@ CMAKE_VS_SDK_SOURCE_DIRECTORIES ------------------------------- +.. versionadded:: 3.12 + This variable allows to override Visual Studio default Source Directories. diff --git a/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION.rst b/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION.rst index 83b9bc1..cb55bc2 100644 --- a/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION.rst +++ b/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION.rst @@ -1,6 +1,8 @@ CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION ---------------------------------------- +.. versionadded:: 3.4 + Visual Studio Windows Target Platform Version. When targeting Windows 10 and above Visual Studio 2015 and above support diff --git a/Help/variable/CMAKE_VS_WINRT_BY_DEFAULT.rst b/Help/variable/CMAKE_VS_WINRT_BY_DEFAULT.rst index 2eea424..9ded85f 100644 --- a/Help/variable/CMAKE_VS_WINRT_BY_DEFAULT.rst +++ b/Help/variable/CMAKE_VS_WINRT_BY_DEFAULT.rst @@ -1,6 +1,8 @@ CMAKE_VS_WINRT_BY_DEFAULT ------------------------- +.. versionadded:: 3.13 + Inform :ref:`Visual Studio Generators` for VS 2010 and above that the target platform enables WinRT compilation by default and it needs to be explicitly disabled if ``/ZW`` or :prop_tgt:`VS_WINRT_COMPONENT` is diff --git a/Help/variable/CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS.rst b/Help/variable/CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS.rst index 1636842..7b01185 100644 --- a/Help/variable/CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS.rst +++ b/Help/variable/CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS.rst @@ -1,6 +1,8 @@ CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS -------------------------------- +.. versionadded:: 3.4 + Default value for :prop_tgt:`WINDOWS_EXPORT_ALL_SYMBOLS` target property. This variable is used to initialize the property on each target as it is created. diff --git a/Help/variable/CMAKE_XCODE_ATTRIBUTE_an-attribute.rst b/Help/variable/CMAKE_XCODE_ATTRIBUTE_an-attribute.rst index be683d6..90e4c0e 100644 --- a/Help/variable/CMAKE_XCODE_ATTRIBUTE_an-attribute.rst +++ b/Help/variable/CMAKE_XCODE_ATTRIBUTE_an-attribute.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_ATTRIBUTE_<an-attribute> ------------------------------------ +.. versionadded:: 3.1 + Set Xcode target attributes directly. Tell the :generator:`Xcode` generator to set '<an-attribute>' to a given value diff --git a/Help/variable/CMAKE_XCODE_GENERATE_SCHEME.rst b/Help/variable/CMAKE_XCODE_GENERATE_SCHEME.rst index 5b1a003..40070e1 100644 --- a/Help/variable/CMAKE_XCODE_GENERATE_SCHEME.rst +++ b/Help/variable/CMAKE_XCODE_GENERATE_SCHEME.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_GENERATE_SCHEME --------------------------- +.. versionadded:: 3.9 + If enabled, the :generator:`Xcode` generator will generate schema files. These are useful to invoke analyze, archive, build-for-testing and test actions from the command line. diff --git a/Help/variable/CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT_ONLY.rst b/Help/variable/CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT_ONLY.rst index ea3e240..38d043c 100644 --- a/Help/variable/CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT_ONLY.rst +++ b/Help/variable/CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT_ONLY.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT_ONLY ------------------------------------------- +.. versionadded:: 3.11 + If enabled, the :generator:`Xcode` generator will generate only a single Xcode project file for the topmost :command:`project()` command instead of generating one for every ``project()`` command. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER.rst b/Help/variable/CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER.rst index b972ba5..b3fa93b 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER ------------------------------------ +.. versionadded:: 3.13 + Whether to enable ``Address Sanitizer`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst b/Help/variable/CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst index 59eb32d..1a0a17a 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN ----------------------------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Detect use of stack after return`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst b/Help/variable/CMAKE_XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst index a264d36..917fc7f 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING -------------------------------------------- +.. versionadded:: 3.16 + Whether to enable ``Allow debugging when using document Versions Browser`` in the Options section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst b/Help/variable/CMAKE_XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst index 71bcf42..b604598 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER ---------------------------------------------- +.. versionadded:: 3.13 + Whether to disable the ``Main Thread Checker`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst b/Help/variable/CMAKE_XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst index 53f55e6..070ddfc 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS ---------------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Dynamic Library Loads`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst b/Help/variable/CMAKE_XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst index 784ceb6..4291816 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE ------------------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Dynamic Linker API usage`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_ENVIRONMENT.rst b/Help/variable/CMAKE_XCODE_SCHEME_ENVIRONMENT.rst index 4832659..62b698d 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_ENVIRONMENT.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_ENVIRONMENT.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_ENVIRONMENT ------------------------------ +.. versionadded:: 3.17 + Specify environment variables that should be added to the Arguments section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_GUARD_MALLOC.rst b/Help/variable/CMAKE_XCODE_SCHEME_GUARD_MALLOC.rst index 9350244..48b481e 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_GUARD_MALLOC.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_GUARD_MALLOC.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_GUARD_MALLOC ------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Guard Malloc`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst b/Help/variable/CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst index 45a2dad..ef8ed9b 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP ------------------------------------------- +.. versionadded:: 3.13 + Whether to enable the ``Main Thread Checker`` option ``Pause on issues`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES.rst b/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES.rst index 94d1c61..d4ae9eb 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES ------------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Malloc Guard Edges`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE.rst b/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE.rst index 9bf0eb4..e28f6a1 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE ---------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Malloc Scribble`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_STACK.rst b/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_STACK.rst index 4cc21ee..59fcfd3 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_STACK.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_MALLOC_STACK.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_MALLOC_STACK ------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Malloc Stack`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER.rst b/Help/variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER.rst index 6d1b56e..511eb04 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_THREAD_SANITIZER ----------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Thread Sanitizer`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP.rst b/Help/variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP.rst index de40478..6f3b8ce 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP ---------------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Thread Sanitizer - Pause on issues`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst b/Help/variable/CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst index ec5df66..46d3ccf 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER ------------------------------------------------ +.. versionadded:: 3.13 + Whether to enable ``Undefined Behavior Sanitizer`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst b/Help/variable/CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst index dcec9b0..8fa5ece 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP ----------------------------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Undefined Behavior Sanitizer`` option ``Pause on issues`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_WORKING_DIRECTORY.rst b/Help/variable/CMAKE_XCODE_SCHEME_WORKING_DIRECTORY.rst index 5bb7907..4221e48 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_WORKING_DIRECTORY.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_WORKING_DIRECTORY.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_WORKING_DIRECTORY ------------------------------------ +.. versionadded:: 3.17 + Specify the ``Working Directory`` of the *Run* and *Profile* actions in the generated Xcode scheme. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_ZOMBIE_OBJECTS.rst b/Help/variable/CMAKE_XCODE_SCHEME_ZOMBIE_OBJECTS.rst index 82e9d76..fd9488e 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_ZOMBIE_OBJECTS.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_ZOMBIE_OBJECTS.rst @@ -1,6 +1,8 @@ CMAKE_XCODE_SCHEME_ZOMBIE_OBJECTS --------------------------------- +.. versionadded:: 3.13 + Whether to enable ``Zombie Objects`` in the Diagnostics section of the generated Xcode scheme. diff --git a/Help/variable/CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst b/Help/variable/CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst index 83d5ce7..01fb189 100644 --- a/Help/variable/CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst +++ b/Help/variable/CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.rst @@ -1,6 +1,8 @@ CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS ------------------------------------------- +.. versionadded:: 3.11 + Default permissions for implicitly created directories during packaging. This variable serves the same purpose during packaging as the diff --git a/Help/variable/CTEST_BINARY_DIRECTORY.rst b/Help/variable/CTEST_BINARY_DIRECTORY.rst index fd8461f..8413e37 100644 --- a/Help/variable/CTEST_BINARY_DIRECTORY.rst +++ b/Help/variable/CTEST_BINARY_DIRECTORY.rst @@ -1,5 +1,7 @@ CTEST_BINARY_DIRECTORY ---------------------- +.. versionadded:: 3.1 + Specify the CTest ``BuildDirectory`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_BUILD_COMMAND.rst b/Help/variable/CTEST_BUILD_COMMAND.rst index 7b13ba0..31c44e2 100644 --- a/Help/variable/CTEST_BUILD_COMMAND.rst +++ b/Help/variable/CTEST_BUILD_COMMAND.rst @@ -1,5 +1,7 @@ CTEST_BUILD_COMMAND ------------------- +.. versionadded:: 3.1 + Specify the CTest ``MakeCommand`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_BUILD_NAME.rst b/Help/variable/CTEST_BUILD_NAME.rst index d25d84c..3d08397 100644 --- a/Help/variable/CTEST_BUILD_NAME.rst +++ b/Help/variable/CTEST_BUILD_NAME.rst @@ -1,5 +1,7 @@ CTEST_BUILD_NAME ---------------- +.. versionadded:: 3.1 + Specify the CTest ``BuildName`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_BZR_COMMAND.rst b/Help/variable/CTEST_BZR_COMMAND.rst index 474d621..0c05d1a 100644 --- a/Help/variable/CTEST_BZR_COMMAND.rst +++ b/Help/variable/CTEST_BZR_COMMAND.rst @@ -1,5 +1,7 @@ CTEST_BZR_COMMAND ----------------- +.. versionadded:: 3.1 + Specify the CTest ``BZRCommand`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_BZR_UPDATE_OPTIONS.rst b/Help/variable/CTEST_BZR_UPDATE_OPTIONS.rst index d0f9579..4dd5e5b 100644 --- a/Help/variable/CTEST_BZR_UPDATE_OPTIONS.rst +++ b/Help/variable/CTEST_BZR_UPDATE_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_BZR_UPDATE_OPTIONS ------------------------ +.. versionadded:: 3.1 + Specify the CTest ``BZRUpdateOptions`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_CHANGE_ID.rst b/Help/variable/CTEST_CHANGE_ID.rst index a423f49..a6d15f7 100644 --- a/Help/variable/CTEST_CHANGE_ID.rst +++ b/Help/variable/CTEST_CHANGE_ID.rst @@ -1,6 +1,8 @@ CTEST_CHANGE_ID --------------- +.. versionadded:: 3.4 + Specify the CTest ``ChangeId`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_CHECKOUT_COMMAND.rst b/Help/variable/CTEST_CHECKOUT_COMMAND.rst index da256f2..852c28e 100644 --- a/Help/variable/CTEST_CHECKOUT_COMMAND.rst +++ b/Help/variable/CTEST_CHECKOUT_COMMAND.rst @@ -1,5 +1,7 @@ CTEST_CHECKOUT_COMMAND ---------------------- +.. versionadded:: 3.1 + Tell the :command:`ctest_start` command how to checkout or initialize the source directory in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_CONFIGURATION_TYPE.rst b/Help/variable/CTEST_CONFIGURATION_TYPE.rst index 9e277fa..392845e 100644 --- a/Help/variable/CTEST_CONFIGURATION_TYPE.rst +++ b/Help/variable/CTEST_CONFIGURATION_TYPE.rst @@ -1,6 +1,8 @@ CTEST_CONFIGURATION_TYPE ------------------------ +.. versionadded:: 3.1 + Specify the CTest ``DefaultCTestConfigurationType`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_CONFIGURE_COMMAND.rst b/Help/variable/CTEST_CONFIGURE_COMMAND.rst index 5561b6d..992ef47 100644 --- a/Help/variable/CTEST_CONFIGURE_COMMAND.rst +++ b/Help/variable/CTEST_CONFIGURE_COMMAND.rst @@ -1,5 +1,7 @@ CTEST_CONFIGURE_COMMAND ----------------------- +.. versionadded:: 3.1 + Specify the CTest ``ConfigureCommand`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_COVERAGE_COMMAND.rst b/Help/variable/CTEST_COVERAGE_COMMAND.rst index a78792e..f5425cb 100644 --- a/Help/variable/CTEST_COVERAGE_COMMAND.rst +++ b/Help/variable/CTEST_COVERAGE_COMMAND.rst @@ -1,6 +1,8 @@ CTEST_COVERAGE_COMMAND ---------------------- +.. versionadded:: 3.1 + Specify the CTest ``CoverageCommand`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_COVERAGE_EXTRA_FLAGS.rst b/Help/variable/CTEST_COVERAGE_EXTRA_FLAGS.rst index 2981955..39d9b5d 100644 --- a/Help/variable/CTEST_COVERAGE_EXTRA_FLAGS.rst +++ b/Help/variable/CTEST_COVERAGE_EXTRA_FLAGS.rst @@ -1,5 +1,7 @@ CTEST_COVERAGE_EXTRA_FLAGS -------------------------- +.. versionadded:: 3.1 + Specify the CTest ``CoverageExtraFlags`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_CURL_OPTIONS.rst b/Help/variable/CTEST_CURL_OPTIONS.rst index fc5dfc4..14af4e4 100644 --- a/Help/variable/CTEST_CURL_OPTIONS.rst +++ b/Help/variable/CTEST_CURL_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_CURL_OPTIONS ------------------ +.. versionadded:: 3.1 + Specify the CTest ``CurlOptions`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_CUSTOM_COVERAGE_EXCLUDE.rst b/Help/variable/CTEST_CUSTOM_COVERAGE_EXCLUDE.rst index d5893c9..84ba12d 100644 --- a/Help/variable/CTEST_CUSTOM_COVERAGE_EXCLUDE.rst +++ b/Help/variable/CTEST_CUSTOM_COVERAGE_EXCLUDE.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_COVERAGE_EXCLUDE ----------------------------- +.. versionadded:: 3.4 + A list of regular expressions which will be used to exclude files by their path from coverage output by the :command:`ctest_coverage` command. diff --git a/Help/variable/CTEST_CUSTOM_ERROR_EXCEPTION.rst b/Help/variable/CTEST_CUSTOM_ERROR_EXCEPTION.rst index cd65ae3..7191ce4 100644 --- a/Help/variable/CTEST_CUSTOM_ERROR_EXCEPTION.rst +++ b/Help/variable/CTEST_CUSTOM_ERROR_EXCEPTION.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_ERROR_EXCEPTION ---------------------------- +.. versionadded:: 3.4 + A list of regular expressions which will be used to exclude when detecting error messages in build outputs by the :command:`ctest_test` command. diff --git a/Help/variable/CTEST_CUSTOM_ERROR_MATCH.rst b/Help/variable/CTEST_CUSTOM_ERROR_MATCH.rst index 558f5e5..5d213f2 100644 --- a/Help/variable/CTEST_CUSTOM_ERROR_MATCH.rst +++ b/Help/variable/CTEST_CUSTOM_ERROR_MATCH.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_ERROR_MATCH ------------------------ +.. versionadded:: 3.4 + A list of regular expressions which will be used to detect error messages in build outputs by the :command:`ctest_test` command. diff --git a/Help/variable/CTEST_CUSTOM_ERROR_POST_CONTEXT.rst b/Help/variable/CTEST_CUSTOM_ERROR_POST_CONTEXT.rst index 614859b..452d060 100644 --- a/Help/variable/CTEST_CUSTOM_ERROR_POST_CONTEXT.rst +++ b/Help/variable/CTEST_CUSTOM_ERROR_POST_CONTEXT.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_ERROR_POST_CONTEXT ------------------------------- +.. versionadded:: 3.4 + The number of lines to include as context which follow an error message by the :command:`ctest_test` command. The default is 10. diff --git a/Help/variable/CTEST_CUSTOM_ERROR_PRE_CONTEXT.rst b/Help/variable/CTEST_CUSTOM_ERROR_PRE_CONTEXT.rst index 74dc47a..b7717dd 100644 --- a/Help/variable/CTEST_CUSTOM_ERROR_PRE_CONTEXT.rst +++ b/Help/variable/CTEST_CUSTOM_ERROR_PRE_CONTEXT.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_ERROR_PRE_CONTEXT ------------------------------ +.. versionadded:: 3.4 + The number of lines to include as context which precede an error message by the :command:`ctest_test` command. The default is 10. diff --git a/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst b/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst index 5aeae88..31ba099 100644 --- a/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst +++ b/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE -------------------------------------------- +.. versionadded:: 3.4 + When saving a failing test's output, this is the maximum size, in bytes, that will be collected by the :command:`ctest_test` command. Defaults to 307200 (300 KiB). diff --git a/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS.rst b/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS.rst index 920cb04..e5be1ad 100644 --- a/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS.rst +++ b/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS ------------------------------------- +.. versionadded:: 3.4 + The maximum number of errors in a single build step which will be detected. After this, the :command:`ctest_test` command will truncate the output. Defaults to 50. diff --git a/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS.rst b/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS.rst index a1f1cc1..b513a5c 100644 --- a/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS.rst +++ b/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS --------------------------------------- +.. versionadded:: 3.4 + The maximum number of warnings in a single build step which will be detected. After this, the :command:`ctest_test` command will truncate the output. Defaults to 50. diff --git a/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst b/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst index 1fbb8c5..08762d8 100644 --- a/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst +++ b/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE -------------------------------------------- +.. versionadded:: 3.4 + When saving a passing test's output, this is the maximum size, in bytes, that will be collected by the :command:`ctest_test` command. Defaults to 1024 (1 KiB). diff --git a/Help/variable/CTEST_CUSTOM_MEMCHECK_IGNORE.rst b/Help/variable/CTEST_CUSTOM_MEMCHECK_IGNORE.rst index 578576c..405fc33 100644 --- a/Help/variable/CTEST_CUSTOM_MEMCHECK_IGNORE.rst +++ b/Help/variable/CTEST_CUSTOM_MEMCHECK_IGNORE.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_MEMCHECK_IGNORE ---------------------------- +.. versionadded:: 3.4 + A list of regular expressions to use to exclude tests during the :command:`ctest_memcheck` command. diff --git a/Help/variable/CTEST_CUSTOM_POST_MEMCHECK.rst b/Help/variable/CTEST_CUSTOM_POST_MEMCHECK.rst index 40291fe..5e488a7 100644 --- a/Help/variable/CTEST_CUSTOM_POST_MEMCHECK.rst +++ b/Help/variable/CTEST_CUSTOM_POST_MEMCHECK.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_POST_MEMCHECK -------------------------- +.. versionadded:: 3.4 + A list of commands to run at the end of the :command:`ctest_memcheck` command. .. include:: CTEST_CUSTOM_XXX.txt diff --git a/Help/variable/CTEST_CUSTOM_POST_TEST.rst b/Help/variable/CTEST_CUSTOM_POST_TEST.rst index 791292c..7ec42f7 100644 --- a/Help/variable/CTEST_CUSTOM_POST_TEST.rst +++ b/Help/variable/CTEST_CUSTOM_POST_TEST.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_POST_TEST ---------------------- +.. versionadded:: 3.4 + A list of commands to run at the end of the :command:`ctest_test` command. .. include:: CTEST_CUSTOM_XXX.txt diff --git a/Help/variable/CTEST_CUSTOM_PRE_MEMCHECK.rst b/Help/variable/CTEST_CUSTOM_PRE_MEMCHECK.rst index 00de8aa..99e47bd 100644 --- a/Help/variable/CTEST_CUSTOM_PRE_MEMCHECK.rst +++ b/Help/variable/CTEST_CUSTOM_PRE_MEMCHECK.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_PRE_MEMCHECK ------------------------- +.. versionadded:: 3.4 + A list of commands to run at the start of the :command:`ctest_memcheck` command. diff --git a/Help/variable/CTEST_CUSTOM_PRE_TEST.rst b/Help/variable/CTEST_CUSTOM_PRE_TEST.rst index 6af7152..95c6314 100644 --- a/Help/variable/CTEST_CUSTOM_PRE_TEST.rst +++ b/Help/variable/CTEST_CUSTOM_PRE_TEST.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_PRE_TEST ---------------------- +.. versionadded:: 3.4 + A list of commands to run at the start of the :command:`ctest_test` command. .. include:: CTEST_CUSTOM_XXX.txt diff --git a/Help/variable/CTEST_CUSTOM_TESTS_IGNORE.rst b/Help/variable/CTEST_CUSTOM_TESTS_IGNORE.rst index 57222ca..27a75d9 100644 --- a/Help/variable/CTEST_CUSTOM_TESTS_IGNORE.rst +++ b/Help/variable/CTEST_CUSTOM_TESTS_IGNORE.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_TESTS_IGNORE ------------------------- +.. versionadded:: 3.14 + A list of regular expressions to use to exclude tests during the :command:`ctest_test` command. diff --git a/Help/variable/CTEST_CUSTOM_WARNING_EXCEPTION.rst b/Help/variable/CTEST_CUSTOM_WARNING_EXCEPTION.rst index a03d473..539760b 100644 --- a/Help/variable/CTEST_CUSTOM_WARNING_EXCEPTION.rst +++ b/Help/variable/CTEST_CUSTOM_WARNING_EXCEPTION.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_WARNING_EXCEPTION ------------------------------ +.. versionadded:: 3.4 + A list of regular expressions which will be used to exclude when detecting warning messages in build outputs by the :command:`ctest_build` command. diff --git a/Help/variable/CTEST_CUSTOM_WARNING_MATCH.rst b/Help/variable/CTEST_CUSTOM_WARNING_MATCH.rst index 18aa6b3..53e7707 100644 --- a/Help/variable/CTEST_CUSTOM_WARNING_MATCH.rst +++ b/Help/variable/CTEST_CUSTOM_WARNING_MATCH.rst @@ -1,6 +1,8 @@ CTEST_CUSTOM_WARNING_MATCH -------------------------- +.. versionadded:: 3.4 + A list of regular expressions which will be used to detect warning messages in build outputs by the :command:`ctest_build` command. diff --git a/Help/variable/CTEST_CVS_CHECKOUT.rst b/Help/variable/CTEST_CVS_CHECKOUT.rst index 6431c02..32cf9eb 100644 --- a/Help/variable/CTEST_CVS_CHECKOUT.rst +++ b/Help/variable/CTEST_CVS_CHECKOUT.rst @@ -1,4 +1,6 @@ CTEST_CVS_CHECKOUT ------------------ +.. versionadded:: 3.1 + Deprecated. Use :variable:`CTEST_CHECKOUT_COMMAND` instead. diff --git a/Help/variable/CTEST_CVS_COMMAND.rst b/Help/variable/CTEST_CVS_COMMAND.rst index 049700b..7932070 100644 --- a/Help/variable/CTEST_CVS_COMMAND.rst +++ b/Help/variable/CTEST_CVS_COMMAND.rst @@ -1,5 +1,7 @@ CTEST_CVS_COMMAND ----------------- +.. versionadded:: 3.1 + Specify the CTest ``CVSCommand`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_CVS_UPDATE_OPTIONS.rst b/Help/variable/CTEST_CVS_UPDATE_OPTIONS.rst index d7f2f7c..359e708 100644 --- a/Help/variable/CTEST_CVS_UPDATE_OPTIONS.rst +++ b/Help/variable/CTEST_CVS_UPDATE_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_CVS_UPDATE_OPTIONS ------------------------ +.. versionadded:: 3.1 + Specify the CTest ``CVSUpdateOptions`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_DROP_LOCATION.rst b/Help/variable/CTEST_DROP_LOCATION.rst index c0f2215..f66793b 100644 --- a/Help/variable/CTEST_DROP_LOCATION.rst +++ b/Help/variable/CTEST_DROP_LOCATION.rst @@ -1,5 +1,7 @@ CTEST_DROP_LOCATION ------------------- +.. versionadded:: 3.1 + Specify the CTest ``DropLocation`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_DROP_METHOD.rst b/Help/variable/CTEST_DROP_METHOD.rst index 50fbd4d..3a84658 100644 --- a/Help/variable/CTEST_DROP_METHOD.rst +++ b/Help/variable/CTEST_DROP_METHOD.rst @@ -1,5 +1,7 @@ CTEST_DROP_METHOD ----------------- +.. versionadded:: 3.1 + Specify the CTest ``DropMethod`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_DROP_SITE.rst b/Help/variable/CTEST_DROP_SITE.rst index d15d99b..9c871e3 100644 --- a/Help/variable/CTEST_DROP_SITE.rst +++ b/Help/variable/CTEST_DROP_SITE.rst @@ -1,5 +1,7 @@ CTEST_DROP_SITE --------------- +.. versionadded:: 3.1 + Specify the CTest ``DropSite`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_DROP_SITE_CDASH.rst b/Help/variable/CTEST_DROP_SITE_CDASH.rst index 22b9776..dcdb286 100644 --- a/Help/variable/CTEST_DROP_SITE_CDASH.rst +++ b/Help/variable/CTEST_DROP_SITE_CDASH.rst @@ -1,5 +1,7 @@ CTEST_DROP_SITE_CDASH --------------------- +.. versionadded:: 3.1 + Specify the CTest ``IsCDash`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_DROP_SITE_PASSWORD.rst b/Help/variable/CTEST_DROP_SITE_PASSWORD.rst index 904d2c8..8259651 100644 --- a/Help/variable/CTEST_DROP_SITE_PASSWORD.rst +++ b/Help/variable/CTEST_DROP_SITE_PASSWORD.rst @@ -1,5 +1,7 @@ CTEST_DROP_SITE_PASSWORD ------------------------ +.. versionadded:: 3.1 + Specify the CTest ``DropSitePassword`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_DROP_SITE_USER.rst b/Help/variable/CTEST_DROP_SITE_USER.rst index a860a03..8d2e3a3 100644 --- a/Help/variable/CTEST_DROP_SITE_USER.rst +++ b/Help/variable/CTEST_DROP_SITE_USER.rst @@ -1,5 +1,7 @@ CTEST_DROP_SITE_USER -------------------- +.. versionadded:: 3.1 + Specify the CTest ``DropSiteUser`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_EXTRA_COVERAGE_GLOB.rst b/Help/variable/CTEST_EXTRA_COVERAGE_GLOB.rst index 286f7df..1d7e8d4 100644 --- a/Help/variable/CTEST_EXTRA_COVERAGE_GLOB.rst +++ b/Help/variable/CTEST_EXTRA_COVERAGE_GLOB.rst @@ -1,6 +1,8 @@ CTEST_EXTRA_COVERAGE_GLOB ------------------------- +.. versionadded:: 3.4 + A list of regular expressions which will be used to find files which should be covered by the :command:`ctest_coverage` command. diff --git a/Help/variable/CTEST_GIT_COMMAND.rst b/Help/variable/CTEST_GIT_COMMAND.rst index eb83792..eb9b440 100644 --- a/Help/variable/CTEST_GIT_COMMAND.rst +++ b/Help/variable/CTEST_GIT_COMMAND.rst @@ -1,5 +1,7 @@ CTEST_GIT_COMMAND ----------------- +.. versionadded:: 3.1 + Specify the CTest ``GITCommand`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_GIT_INIT_SUBMODULES.rst b/Help/variable/CTEST_GIT_INIT_SUBMODULES.rst index fd27003..529bfc7 100644 --- a/Help/variable/CTEST_GIT_INIT_SUBMODULES.rst +++ b/Help/variable/CTEST_GIT_INIT_SUBMODULES.rst @@ -1,5 +1,7 @@ CTEST_GIT_INIT_SUBMODULES ------------------------- +.. versionadded:: 3.6 + Specify the CTest ``GITInitSubmodules`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_GIT_UPDATE_CUSTOM.rst b/Help/variable/CTEST_GIT_UPDATE_CUSTOM.rst index 0c479e6..82a8a6a 100644 --- a/Help/variable/CTEST_GIT_UPDATE_CUSTOM.rst +++ b/Help/variable/CTEST_GIT_UPDATE_CUSTOM.rst @@ -1,5 +1,7 @@ CTEST_GIT_UPDATE_CUSTOM ----------------------- +.. versionadded:: 3.1 + Specify the CTest ``GITUpdateCustom`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_GIT_UPDATE_OPTIONS.rst b/Help/variable/CTEST_GIT_UPDATE_OPTIONS.rst index 4590a78..1568239 100644 --- a/Help/variable/CTEST_GIT_UPDATE_OPTIONS.rst +++ b/Help/variable/CTEST_GIT_UPDATE_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_GIT_UPDATE_OPTIONS ------------------------ +.. versionadded:: 3.1 + Specify the CTest ``GITUpdateOptions`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_HG_COMMAND.rst b/Help/variable/CTEST_HG_COMMAND.rst index 3854950..3372fe4 100644 --- a/Help/variable/CTEST_HG_COMMAND.rst +++ b/Help/variable/CTEST_HG_COMMAND.rst @@ -1,5 +1,7 @@ CTEST_HG_COMMAND ---------------- +.. versionadded:: 3.1 + Specify the CTest ``HGCommand`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_HG_UPDATE_OPTIONS.rst b/Help/variable/CTEST_HG_UPDATE_OPTIONS.rst index 9049c1f..85c6b03 100644 --- a/Help/variable/CTEST_HG_UPDATE_OPTIONS.rst +++ b/Help/variable/CTEST_HG_UPDATE_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_HG_UPDATE_OPTIONS ----------------------- +.. versionadded:: 3.1 + Specify the CTest ``HGUpdateOptions`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_LABELS_FOR_SUBPROJECTS.rst b/Help/variable/CTEST_LABELS_FOR_SUBPROJECTS.rst index 959596b..dd6d125 100644 --- a/Help/variable/CTEST_LABELS_FOR_SUBPROJECTS.rst +++ b/Help/variable/CTEST_LABELS_FOR_SUBPROJECTS.rst @@ -1,5 +1,7 @@ CTEST_LABELS_FOR_SUBPROJECTS ---------------------------- +.. versionadded:: 3.10 + Specify the CTest ``LabelsForSubprojects`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_MEMORYCHECK_COMMAND.rst b/Help/variable/CTEST_MEMORYCHECK_COMMAND.rst index 8c199ba..25f1bd9 100644 --- a/Help/variable/CTEST_MEMORYCHECK_COMMAND.rst +++ b/Help/variable/CTEST_MEMORYCHECK_COMMAND.rst @@ -1,5 +1,7 @@ CTEST_MEMORYCHECK_COMMAND ------------------------- +.. versionadded:: 3.1 + Specify the CTest ``MemoryCheckCommand`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_MEMORYCHECK_COMMAND_OPTIONS.rst b/Help/variable/CTEST_MEMORYCHECK_COMMAND_OPTIONS.rst index 3e26ab5..51830d5 100644 --- a/Help/variable/CTEST_MEMORYCHECK_COMMAND_OPTIONS.rst +++ b/Help/variable/CTEST_MEMORYCHECK_COMMAND_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_MEMORYCHECK_COMMAND_OPTIONS --------------------------------- +.. versionadded:: 3.1 + Specify the CTest ``MemoryCheckCommandOptions`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS.rst b/Help/variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS.rst index 2de5fb6..6cd51fa 100644 --- a/Help/variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS.rst +++ b/Help/variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_MEMORYCHECK_SANITIZER_OPTIONS ----------------------------------- +.. versionadded:: 3.1 + Specify the CTest ``MemoryCheckSanitizerOptions`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_MEMORYCHECK_SUPPRESSIONS_FILE.rst b/Help/variable/CTEST_MEMORYCHECK_SUPPRESSIONS_FILE.rst index 1147ee8..a61a3ef 100644 --- a/Help/variable/CTEST_MEMORYCHECK_SUPPRESSIONS_FILE.rst +++ b/Help/variable/CTEST_MEMORYCHECK_SUPPRESSIONS_FILE.rst @@ -1,5 +1,7 @@ CTEST_MEMORYCHECK_SUPPRESSIONS_FILE ----------------------------------- +.. versionadded:: 3.1 + Specify the CTest ``MemoryCheckSuppressionFile`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_MEMORYCHECK_TYPE.rst b/Help/variable/CTEST_MEMORYCHECK_TYPE.rst index 4e7d5c0..2452228 100644 --- a/Help/variable/CTEST_MEMORYCHECK_TYPE.rst +++ b/Help/variable/CTEST_MEMORYCHECK_TYPE.rst @@ -1,6 +1,8 @@ CTEST_MEMORYCHECK_TYPE ---------------------- +.. versionadded:: 3.1 + Specify the CTest ``MemoryCheckType`` setting in a :manual:`ctest(1)` dashboard client script. Valid values are ``Valgrind``, ``Purify``, ``BoundsChecker``, ``DrMemory`` and diff --git a/Help/variable/CTEST_NIGHTLY_START_TIME.rst b/Help/variable/CTEST_NIGHTLY_START_TIME.rst index 90841f9..2d707d5 100644 --- a/Help/variable/CTEST_NIGHTLY_START_TIME.rst +++ b/Help/variable/CTEST_NIGHTLY_START_TIME.rst @@ -1,6 +1,8 @@ CTEST_NIGHTLY_START_TIME ------------------------ +.. versionadded:: 3.1 + Specify the CTest ``NightlyStartTime`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_P4_CLIENT.rst b/Help/variable/CTEST_P4_CLIENT.rst index 347ea54..0778c5b 100644 --- a/Help/variable/CTEST_P4_CLIENT.rst +++ b/Help/variable/CTEST_P4_CLIENT.rst @@ -1,5 +1,7 @@ CTEST_P4_CLIENT --------------- +.. versionadded:: 3.1 + Specify the CTest ``P4Client`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_P4_COMMAND.rst b/Help/variable/CTEST_P4_COMMAND.rst index defab12..5cc2a81 100644 --- a/Help/variable/CTEST_P4_COMMAND.rst +++ b/Help/variable/CTEST_P4_COMMAND.rst @@ -1,5 +1,7 @@ CTEST_P4_COMMAND ---------------- +.. versionadded:: 3.1 + Specify the CTest ``P4Command`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_P4_OPTIONS.rst b/Help/variable/CTEST_P4_OPTIONS.rst index fee4ce2..01b6534 100644 --- a/Help/variable/CTEST_P4_OPTIONS.rst +++ b/Help/variable/CTEST_P4_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_P4_OPTIONS ---------------- +.. versionadded:: 3.1 + Specify the CTest ``P4Options`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_P4_UPDATE_OPTIONS.rst b/Help/variable/CTEST_P4_UPDATE_OPTIONS.rst index 0e2790f..365aa3f 100644 --- a/Help/variable/CTEST_P4_UPDATE_OPTIONS.rst +++ b/Help/variable/CTEST_P4_UPDATE_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_P4_UPDATE_OPTIONS ----------------------- +.. versionadded:: 3.1 + Specify the CTest ``P4UpdateOptions`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_RESOURCE_SPEC_FILE.rst b/Help/variable/CTEST_RESOURCE_SPEC_FILE.rst index a6fdbc9..8e9bf01 100644 --- a/Help/variable/CTEST_RESOURCE_SPEC_FILE.rst +++ b/Help/variable/CTEST_RESOURCE_SPEC_FILE.rst @@ -1,6 +1,8 @@ CTEST_RESOURCE_SPEC_FILE ------------------------ +.. versionadded:: 3.18 + Specify the CTest ``ResourceSpecFile`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_RUN_CURRENT_SCRIPT.rst b/Help/variable/CTEST_RUN_CURRENT_SCRIPT.rst index abc123c..32c85ad 100644 --- a/Help/variable/CTEST_RUN_CURRENT_SCRIPT.rst +++ b/Help/variable/CTEST_RUN_CURRENT_SCRIPT.rst @@ -1,5 +1,7 @@ CTEST_RUN_CURRENT_SCRIPT ------------------------ +.. versionadded:: 3.11 + Setting this to 0 prevents :manual:`ctest(1)` from being run again when it reaches the end of a script run by calling ``ctest -S``. diff --git a/Help/variable/CTEST_SCP_COMMAND.rst b/Help/variable/CTEST_SCP_COMMAND.rst index 19ea8b3..155b058 100644 --- a/Help/variable/CTEST_SCP_COMMAND.rst +++ b/Help/variable/CTEST_SCP_COMMAND.rst @@ -1,4 +1,6 @@ CTEST_SCP_COMMAND ----------------- +.. versionadded:: 3.1 + Legacy option. Not used. diff --git a/Help/variable/CTEST_SITE.rst b/Help/variable/CTEST_SITE.rst index 8a5ec25..526e6ed 100644 --- a/Help/variable/CTEST_SITE.rst +++ b/Help/variable/CTEST_SITE.rst @@ -1,5 +1,7 @@ CTEST_SITE ---------- +.. versionadded:: 3.1 + Specify the CTest ``Site`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_SOURCE_DIRECTORY.rst b/Help/variable/CTEST_SOURCE_DIRECTORY.rst index b6837d1..4c6ac54 100644 --- a/Help/variable/CTEST_SOURCE_DIRECTORY.rst +++ b/Help/variable/CTEST_SOURCE_DIRECTORY.rst @@ -1,5 +1,7 @@ CTEST_SOURCE_DIRECTORY ---------------------- +.. versionadded:: 3.1 + Specify the CTest ``SourceDirectory`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_SUBMIT_URL.rst b/Help/variable/CTEST_SUBMIT_URL.rst index 7d84da4..b6e7f68 100644 --- a/Help/variable/CTEST_SUBMIT_URL.rst +++ b/Help/variable/CTEST_SUBMIT_URL.rst @@ -1,5 +1,7 @@ CTEST_SUBMIT_URL ---------------- +.. versionadded:: 3.14 + Specify the CTest ``SubmitURL`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_SVN_COMMAND.rst b/Help/variable/CTEST_SVN_COMMAND.rst index af90143..e97acd0 100644 --- a/Help/variable/CTEST_SVN_COMMAND.rst +++ b/Help/variable/CTEST_SVN_COMMAND.rst @@ -1,5 +1,7 @@ CTEST_SVN_COMMAND ----------------- +.. versionadded:: 3.1 + Specify the CTest ``SVNCommand`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_SVN_OPTIONS.rst b/Help/variable/CTEST_SVN_OPTIONS.rst index 76551dc..5326e20 100644 --- a/Help/variable/CTEST_SVN_OPTIONS.rst +++ b/Help/variable/CTEST_SVN_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_SVN_OPTIONS ----------------- +.. versionadded:: 3.1 + Specify the CTest ``SVNOptions`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_SVN_UPDATE_OPTIONS.rst b/Help/variable/CTEST_SVN_UPDATE_OPTIONS.rst index 5f01a19..24e0bbf 100644 --- a/Help/variable/CTEST_SVN_UPDATE_OPTIONS.rst +++ b/Help/variable/CTEST_SVN_UPDATE_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_SVN_UPDATE_OPTIONS ------------------------ +.. versionadded:: 3.1 + Specify the CTest ``SVNUpdateOptions`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_TEST_LOAD.rst b/Help/variable/CTEST_TEST_LOAD.rst index 80823fe..b6a9d62 100644 --- a/Help/variable/CTEST_TEST_LOAD.rst +++ b/Help/variable/CTEST_TEST_LOAD.rst @@ -1,6 +1,8 @@ CTEST_TEST_LOAD --------------- +.. versionadded:: 3.4 + Specify the ``TestLoad`` setting in the :ref:`CTest Test Step` of a :manual:`ctest(1)` dashboard client script. This sets the default value for the ``TEST_LOAD`` option of the :command:`ctest_test` diff --git a/Help/variable/CTEST_TEST_TIMEOUT.rst b/Help/variable/CTEST_TEST_TIMEOUT.rst index c031437..61d9191 100644 --- a/Help/variable/CTEST_TEST_TIMEOUT.rst +++ b/Help/variable/CTEST_TEST_TIMEOUT.rst @@ -1,5 +1,7 @@ CTEST_TEST_TIMEOUT ------------------ +.. versionadded:: 3.1 + Specify the CTest ``TimeOut`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_TRIGGER_SITE.rst b/Help/variable/CTEST_TRIGGER_SITE.rst index a50e405..6abb852 100644 --- a/Help/variable/CTEST_TRIGGER_SITE.rst +++ b/Help/variable/CTEST_TRIGGER_SITE.rst @@ -1,4 +1,6 @@ CTEST_TRIGGER_SITE ------------------ +.. versionadded:: 3.1 + Legacy option. Not used. diff --git a/Help/variable/CTEST_UPDATE_COMMAND.rst b/Help/variable/CTEST_UPDATE_COMMAND.rst index 90155d0..c4ed645 100644 --- a/Help/variable/CTEST_UPDATE_COMMAND.rst +++ b/Help/variable/CTEST_UPDATE_COMMAND.rst @@ -1,5 +1,7 @@ CTEST_UPDATE_COMMAND -------------------- +.. versionadded:: 3.1 + Specify the CTest ``UpdateCommand`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_UPDATE_OPTIONS.rst b/Help/variable/CTEST_UPDATE_OPTIONS.rst index e43d61d..96c4b6c 100644 --- a/Help/variable/CTEST_UPDATE_OPTIONS.rst +++ b/Help/variable/CTEST_UPDATE_OPTIONS.rst @@ -1,5 +1,7 @@ CTEST_UPDATE_OPTIONS -------------------- +.. versionadded:: 3.1 + Specify the CTest ``UpdateOptions`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_UPDATE_VERSION_ONLY.rst b/Help/variable/CTEST_UPDATE_VERSION_ONLY.rst index a862baa..f7c863c 100644 --- a/Help/variable/CTEST_UPDATE_VERSION_ONLY.rst +++ b/Help/variable/CTEST_UPDATE_VERSION_ONLY.rst @@ -1,5 +1,7 @@ CTEST_UPDATE_VERSION_ONLY ------------------------- +.. versionadded:: 3.1 + Specify the CTest :ref:`UpdateVersionOnly <UpdateVersionOnly>` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_UPDATE_VERSION_OVERRIDE.rst b/Help/variable/CTEST_UPDATE_VERSION_OVERRIDE.rst index 39fbaba..87918cb 100644 --- a/Help/variable/CTEST_UPDATE_VERSION_OVERRIDE.rst +++ b/Help/variable/CTEST_UPDATE_VERSION_OVERRIDE.rst @@ -1,5 +1,7 @@ CTEST_UPDATE_VERSION_OVERRIDE ----------------------------- +.. versionadded:: 3.15 + Specify the CTest :ref:`UpdateVersionOverride <UpdateVersionOverride>` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_USE_LAUNCHERS.rst b/Help/variable/CTEST_USE_LAUNCHERS.rst index 9f48a2e..728cdc5 100644 --- a/Help/variable/CTEST_USE_LAUNCHERS.rst +++ b/Help/variable/CTEST_USE_LAUNCHERS.rst @@ -1,5 +1,7 @@ CTEST_USE_LAUNCHERS ------------------- +.. versionadded:: 3.1 + Specify the CTest ``UseLaunchers`` setting in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/GHS-MULTI.rst b/Help/variable/GHS-MULTI.rst index fe3b17e..bb139af 100644 --- a/Help/variable/GHS-MULTI.rst +++ b/Help/variable/GHS-MULTI.rst @@ -1,4 +1,6 @@ GHS-MULTI --------- +.. versionadded:: 3.3 + ``True`` when using :generator:`Green Hills MULTI` generator. diff --git a/Help/variable/IOS.rst b/Help/variable/IOS.rst index e5cc3f6..b27be55 100644 --- a/Help/variable/IOS.rst +++ b/Help/variable/IOS.rst @@ -1,4 +1,6 @@ IOS --- +.. versionadded:: 3.14 + Set to ``1`` when the target system (:variable:`CMAKE_SYSTEM_NAME`) is ``iOS``. diff --git a/Help/variable/MINGW.rst b/Help/variable/MINGW.rst index 6d29be4..27c56ea 100644 --- a/Help/variable/MINGW.rst +++ b/Help/variable/MINGW.rst @@ -1,6 +1,8 @@ MINGW ----- +.. versionadded:: 3.2 + ``True`` when using MinGW Set to ``true`` when the compiler is some version of MinGW. diff --git a/Help/variable/MSVC14.rst b/Help/variable/MSVC14.rst index 79e0c10..1eb5183 100644 --- a/Help/variable/MSVC14.rst +++ b/Help/variable/MSVC14.rst @@ -1,6 +1,8 @@ MSVC14 ------ +.. versionadded:: 3.1 + Discouraged. Use the :variable:`MSVC_VERSION` variable instead. ``True`` when using the Microsoft Visual Studio ``v140`` or ``v141`` diff --git a/Help/variable/MSVC_TOOLSET_VERSION.rst b/Help/variable/MSVC_TOOLSET_VERSION.rst index f4a33e2..c642a9f 100644 --- a/Help/variable/MSVC_TOOLSET_VERSION.rst +++ b/Help/variable/MSVC_TOOLSET_VERSION.rst @@ -1,6 +1,8 @@ MSVC_TOOLSET_VERSION -------------------- +.. versionadded:: 3.12 + The toolset version of Microsoft Visual C/C++ being used if any. If MSVC-like is being used, this variable is set based on the version of the compiler as given by the :variable:`MSVC_VERSION` variable. diff --git a/Help/variable/MSYS.rst b/Help/variable/MSYS.rst index 25ddc7f..6be7681 100644 --- a/Help/variable/MSYS.rst +++ b/Help/variable/MSYS.rst @@ -1,4 +1,6 @@ MSYS ---- +.. versionadded:: 3.14 + ``True`` when using the :generator:`MSYS Makefiles` generator. diff --git a/Help/variable/PROJECT-NAME_DESCRIPTION.rst b/Help/variable/PROJECT-NAME_DESCRIPTION.rst index 2b88b1a..f372f5c 100644 --- a/Help/variable/PROJECT-NAME_DESCRIPTION.rst +++ b/Help/variable/PROJECT-NAME_DESCRIPTION.rst @@ -1,5 +1,7 @@ <PROJECT-NAME>_DESCRIPTION -------------------------- +.. versionadded:: 3.12 + Value given to the ``DESCRIPTION`` option of the most recent call to the :command:`project` command with project name ``<PROJECT-NAME>``, if any. diff --git a/Help/variable/PROJECT-NAME_HOMEPAGE_URL.rst b/Help/variable/PROJECT-NAME_HOMEPAGE_URL.rst index 22cc304..4800b13 100644 --- a/Help/variable/PROJECT-NAME_HOMEPAGE_URL.rst +++ b/Help/variable/PROJECT-NAME_HOMEPAGE_URL.rst @@ -1,5 +1,7 @@ <PROJECT-NAME>_HOMEPAGE_URL --------------------------- +.. versionadded:: 3.12 + Value given to the ``HOMEPAGE_URL`` option of the most recent call to the :command:`project` command with project name ``<PROJECT-NAME>``, if any. diff --git a/Help/variable/PROJECT_DESCRIPTION.rst b/Help/variable/PROJECT_DESCRIPTION.rst index 2833e11..1fefcdc 100644 --- a/Help/variable/PROJECT_DESCRIPTION.rst +++ b/Help/variable/PROJECT_DESCRIPTION.rst @@ -1,6 +1,8 @@ PROJECT_DESCRIPTION ------------------- +.. versionadded:: 3.9 + Short project description given to the project command. This is the description given to the most recently called :command:`project` diff --git a/Help/variable/PROJECT_HOMEPAGE_URL.rst b/Help/variable/PROJECT_HOMEPAGE_URL.rst index 754c9e8..0d2c937 100644 --- a/Help/variable/PROJECT_HOMEPAGE_URL.rst +++ b/Help/variable/PROJECT_HOMEPAGE_URL.rst @@ -1,6 +1,8 @@ PROJECT_HOMEPAGE_URL -------------------- +.. versionadded:: 3.12 + The homepage URL of the project. This is the homepage URL given to the most recently called :command:`project` diff --git a/Help/variable/PackageName_ROOT.rst b/Help/variable/PackageName_ROOT.rst index 1c2fd34..3f7ee4c 100644 --- a/Help/variable/PackageName_ROOT.rst +++ b/Help/variable/PackageName_ROOT.rst @@ -1,6 +1,8 @@ <PackageName>_ROOT ------------------ +.. versionadded:: 3.12.1 + Calls to :command:`find_package(<PackageName>)` will search in prefixes specified by the ``<PackageName>_ROOT`` CMake variable, where ``<PackageName>`` is the name given to the :command:`find_package` call diff --git a/Help/variable/WINCE.rst b/Help/variable/WINCE.rst index 54ff7de..4dca297 100644 --- a/Help/variable/WINCE.rst +++ b/Help/variable/WINCE.rst @@ -1,5 +1,7 @@ WINCE ----- +.. versionadded:: 3.1 + True when the :variable:`CMAKE_SYSTEM_NAME` variable is set to ``WindowsCE``. diff --git a/Help/variable/WINDOWS_PHONE.rst b/Help/variable/WINDOWS_PHONE.rst index 61d91b0..bf7099d 100644 --- a/Help/variable/WINDOWS_PHONE.rst +++ b/Help/variable/WINDOWS_PHONE.rst @@ -1,5 +1,7 @@ WINDOWS_PHONE ------------- +.. versionadded:: 3.1 + True when the :variable:`CMAKE_SYSTEM_NAME` variable is set to ``WindowsPhone``. diff --git a/Help/variable/WINDOWS_STORE.rst b/Help/variable/WINDOWS_STORE.rst index dae3b53..13831c2 100644 --- a/Help/variable/WINDOWS_STORE.rst +++ b/Help/variable/WINDOWS_STORE.rst @@ -1,5 +1,7 @@ WINDOWS_STORE ------------- +.. versionadded:: 3.1 + True when the :variable:`CMAKE_SYSTEM_NAME` variable is set to ``WindowsStore``. diff --git a/Help/variable/XCODE.rst b/Help/variable/XCODE.rst index 99f20fb..167ca86 100644 --- a/Help/variable/XCODE.rst +++ b/Help/variable/XCODE.rst @@ -1,4 +1,6 @@ XCODE ----- +.. versionadded:: 3.7 + ``True`` when using :generator:`Xcode` generator. |