diff options
Diffstat (limited to 'Help/command')
61 files changed, 2051 insertions, 475 deletions
diff --git a/Help/command/DEVICE_LINK_OPTIONS.txt b/Help/command/DEVICE_LINK_OPTIONS.txt index 3f0226fdcd..1297cd0547 100644 --- a/Help/command/DEVICE_LINK_OPTIONS.txt +++ b/Help/command/DEVICE_LINK_OPTIONS.txt @@ -1,11 +1,12 @@ -When a device link step is involved, which is controlled by -:prop_tgt:`CUDA_SEPARABLE_COMPILATION` and -:prop_tgt:`CUDA_RESOLVE_DEVICE_SYMBOLS` properties and policy :policy:`CMP0105`, -the raw options will be delivered to the host and device link steps (wrapped in -``-Xcompiler`` or equivalent for device link). Options wrapped with -``$<DEVICE_LINK:...>`` -:manual:`generator expression <cmake-generator-expressions(7)>` will be used -only for the device link step. Options wrapped with ``$<HOST_LINK:...>`` -:manual:`generator expression <cmake-generator-expressions(7)>` will be used -only for the host link step. +.. versionadded:: 3.18 + When a device link step is involved, which is controlled by + :prop_tgt:`CUDA_SEPARABLE_COMPILATION` and + :prop_tgt:`CUDA_RESOLVE_DEVICE_SYMBOLS` properties and policy :policy:`CMP0105`, + the raw options will be delivered to the host and device link steps (wrapped in + ``-Xcompiler`` or equivalent for device link). Options wrapped with + ``$<DEVICE_LINK:...>`` + :manual:`generator expression <cmake-generator-expressions(7)>` will be used + only for the device link step. Options wrapped with ``$<HOST_LINK:...>`` + :manual:`generator expression <cmake-generator-expressions(7)>` will be used + only for the host link step. diff --git a/Help/command/FIND_XXX.txt b/Help/command/FIND_XXX.txt index 4a62c5b5ba..97eecfca36 100644 --- a/Help/command/FIND_XXX.txt +++ b/Help/command/FIND_XXX.txt @@ -33,9 +33,6 @@ of this command. If the |SEARCH_XXX| is found the result is stored in the variable and the search will not be repeated unless the variable is cleared. If nothing is found, the result will be ``<VAR>-NOTFOUND``. -The ``REQUIRED`` option stops processing with an error message if nothing -is found, otherwise the search will be attempted again the -next time |FIND_XXX| is invoked with the same variable. Options include: @@ -60,7 +57,11 @@ Options include: Specify the documentation string for the ``<VAR>`` cache entry. ``REQUIRED`` - Stop processing with an error message if nothing is found. + .. versionadded:: 3.18 + + Stop processing with an error message if nothing is found, otherwise + the search will be attempted again the next time |FIND_XXX| is invoked + with the same variable. If ``NO_DEFAULT_PATH`` is specified, then no additional paths are added to the search. @@ -84,20 +85,21 @@ If ``NO_DEFAULT_PATH`` is not specified, the search process is as follows: |prefix_XXX_SUBDIR| for each ``<prefix>`` in :variable:`CMAKE_SYSTEM_PREFIX_PATH` -1. If called from within a find module or any other script loaded by a call to - :command:`find_package(<PackageName>)`, search prefixes unique to the - current package being found. Specifically, look in the - :variable:`<PackageName>_ROOT` CMake variable and the - :envvar:`<PackageName>_ROOT` environment variable. - The package root variables are maintained as a stack, so if called from - nested find modules or config packages, root paths from the parent's find - module or config package will be searched after paths from the current - module or package. In other words, the search order would be - ``<CurrentPackage>_ROOT``, ``ENV{<CurrentPackage>_ROOT}``, - ``<ParentPackage>_ROOT``, ``ENV{<ParentPackage>_ROOT}``, etc. - This can be skipped if ``NO_PACKAGE_ROOT_PATH`` is passed or by setting - the :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` to ``FALSE``. - See policy :policy:`CMP0074`. +1. .. versionadded:: 3.12 + If called from within a find module or any other script loaded by a call to + :command:`find_package(<PackageName>)`, search prefixes unique to the + current package being found. Specifically, look in the + :variable:`<PackageName>_ROOT` CMake variable and the + :envvar:`<PackageName>_ROOT` environment variable. + The package root variables are maintained as a stack, so if called from + nested find modules or config packages, root paths from the parent's find + module or config package will be searched after paths from the current + module or package. In other words, the search order would be + ``<CurrentPackage>_ROOT``, ``ENV{<CurrentPackage>_ROOT}``, + ``<ParentPackage>_ROOT``, ``ENV{<ParentPackage>_ROOT}``, etc. + This can be skipped if ``NO_PACKAGE_ROOT_PATH`` is passed or by setting + the :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` to ``FALSE``. + See policy :policy:`CMP0074`. * |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX| @@ -151,6 +153,10 @@ If ``NO_DEFAULT_PATH`` is not specified, the search process is as follows: or in the short-hand version of the command. These are typically hard-coded guesses. +.. versionadded:: 3.16 + Added ``CMAKE_FIND_USE_<CATEGORY>_PATH`` variables to globally disable + various search locations. + .. |FIND_ARGS_XXX| replace:: <VAR> NAMES name On macOS the :variable:`CMAKE_FIND_FRAMEWORK` and diff --git a/Help/command/OPTIONS_SHELL.txt b/Help/command/OPTIONS_SHELL.txt index 0f8ec323cd..4051ffe16e 100644 --- a/Help/command/OPTIONS_SHELL.txt +++ b/Help/command/OPTIONS_SHELL.txt @@ -1,9 +1,11 @@ The final set of compile or link options used for a target is constructed by accumulating options from the current target and the usage requirements of its dependencies. The set of options is de-duplicated to avoid repetition. -While beneficial for individual options, the de-duplication step can break -up option groups. For example, ``-D A -D B`` becomes ``-D A B``. One may -specify a group of options using shell-like quoting along with a ``SHELL:`` -prefix. The ``SHELL:`` prefix is dropped, and the rest of the option string -is parsed using the :command:`separate_arguments` ``UNIX_COMMAND`` mode. -For example, ``"SHELL:-D A" "SHELL:-D B"`` becomes ``-D A -D B``. + +.. versionadded:: 3.12 + While beneficial for individual options, the de-duplication step can break + up option groups. For example, ``-D A -D B`` becomes ``-D A B``. One may + specify a group of options using shell-like quoting along with a ``SHELL:`` + prefix. The ``SHELL:`` prefix is dropped, and the rest of the option string + is parsed using the :command:`separate_arguments` ``UNIX_COMMAND`` mode. + For example, ``"SHELL:-D A" "SHELL:-D B"`` becomes ``-D A -D B``. diff --git a/Help/command/add_custom_command.rst b/Help/command/add_custom_command.rst index 231f9dad41..183bb72fcd 100644 --- a/Help/command/add_custom_command.rst +++ b/Help/command/add_custom_command.rst @@ -46,11 +46,19 @@ The options are: Append the ``COMMAND`` and ``DEPENDS`` option values to the custom command for the first output specified. There must have already been a previous call to this command with the same output. + + If the previous call specified the output via a generator expression, + the output specified by the current call must match in at least one + configuration after evaluating generator expressions. In this case, + the appended commands and dependencies apply to all configurations. + The ``COMMENT``, ``MAIN_DEPENDENCY``, and ``WORKING_DIRECTORY`` options are currently ignored when APPEND is given, but may be used in the future. ``BYPRODUCTS`` + .. versionadded:: 3.2 + Specify the files the command is expected to produce but whose modification time may or may not be newer than the dependencies. If a byproduct name is a relative path it will be interpreted @@ -71,6 +79,10 @@ The options are: The :ref:`Makefile Generators` will remove ``BYPRODUCTS`` and other :prop_sf:`GENERATED` files during ``make clean``. + .. versionadded:: 3.20 + Arguments to ``BYPRODUCTS`` may use + :manual:`generator expressions <cmake-generator-expressions(7)>`. + ``COMMAND`` Specify the command-line(s) to execute at build time. If more than one ``COMMAND`` is specified they will be executed in order, @@ -88,18 +100,19 @@ The options are: * The target is not being cross-compiled (i.e. the :variable:`CMAKE_CROSSCOMPILING` variable is not set to true). - * The target is being cross-compiled and an emulator is provided (i.e. - its :prop_tgt:`CROSSCOMPILING_EMULATOR` target property is set). - In this case, the contents of :prop_tgt:`CROSSCOMPILING_EMULATOR` will be - prepended to the command before the location of the target executable. + * .. versionadded:: 3.6 + The target is being cross-compiled and an emulator is provided (i.e. + its :prop_tgt:`CROSSCOMPILING_EMULATOR` target property is set). + In this case, the contents of :prop_tgt:`CROSSCOMPILING_EMULATOR` will be + prepended to the command before the location of the target executable. If neither of the above conditions are met, it is assumed that the command name is a program to be found on the ``PATH`` at build time. Arguments to ``COMMAND`` may use :manual:`generator expressions <cmake-generator-expressions(7)>`. - Use the ``TARGET_FILE`` generator expression to refer to the location of - a target later in the command line (i.e. as a command argument rather + Use the :genex:`TARGET_FILE` generator expression to refer to the location + of a target later in the command line (i.e. as a command argument rather than as the command to execute). Whenever one of the following target based generator expressions are used as @@ -153,18 +166,23 @@ The options are: If any dependency is an ``OUTPUT`` of another custom command in the same directory (``CMakeLists.txt`` file), CMake automatically brings the other custom command into the target in which this command is built. - A target-level dependency is added if any dependency is listed as - ``BYPRODUCTS`` of a target or any of its build events in the same - directory to ensure the byproducts will be available. + + .. versionadded:: 3.16 + A target-level dependency is added if any dependency is listed as + ``BYPRODUCTS`` of a target or any of its build events in the same + directory to ensure the byproducts will be available. If ``DEPENDS`` is not specified, the command will run whenever the ``OUTPUT`` is missing; if the command does not actually create the ``OUTPUT``, the rule will always run. - Arguments to ``DEPENDS`` may use - :manual:`generator expressions <cmake-generator-expressions(7)>`. + .. versionadded:: 3.1 + Arguments to ``DEPENDS`` may use + :manual:`generator expressions <cmake-generator-expressions(7)>`. ``COMMAND_EXPAND_LISTS`` + .. versionadded:: 3.8 + Lists in ``COMMAND`` arguments will be expanded, including those created with :manual:`generator expressions <cmake-generator-expressions(7)>`, @@ -183,7 +201,13 @@ The options are: Note that the ``IMPLICIT_DEPENDS`` option is currently supported only for Makefile generators and will be ignored by other generators. + .. note:: + + This option cannot be specified at the same time as ``DEPFILE`` option. + ``JOB_POOL`` + .. versionadded:: 3.15 + Specify a :prop_gbl:`pool <JOB_POOLS>` for the :generator:`Ninja` generator. Incompatible with ``USES_TERMINAL``, which implies the ``console`` pool. @@ -210,7 +234,13 @@ The options are: as a file on disk it should be marked with the :prop_sf:`SYMBOLIC` source file property. + .. versionadded:: 3.20 + Arguments to ``OUTPUT`` may use + :manual:`generator expressions <cmake-generator-expressions(7)>`. + ``USES_TERMINAL`` + .. versionadded:: 3.2 + The command will be given direct access to the terminal if possible. With the :generator:`Ninja` generator, this places the command in the ``console`` :prop_gbl:`pool <JOB_POOLS>`. @@ -230,14 +260,72 @@ The options are: If it is a relative path it will be interpreted relative to the build tree directory corresponding to the current source directory. - Arguments to ``WORKING_DIRECTORY`` may use - :manual:`generator expressions <cmake-generator-expressions(7)>`. + .. versionadded:: 3.13 + Arguments to ``WORKING_DIRECTORY`` may use + :manual:`generator expressions <cmake-generator-expressions(7)>`. ``DEPFILE`` - Specify a ``.d`` depfile for the :generator:`Ninja` generator. + .. versionadded:: 3.7 + + Specify a ``.d`` depfile for the :generator:`Ninja` generator and + :ref:`Makefile Generators`. A ``.d`` file holds dependencies usually emitted by the custom command itself. - Using ``DEPFILE`` with other generators than Ninja is an error. + Using ``DEPFILE`` with other generators than :generator:`Ninja` or + :ref:`Makefile Generators` is an error. + + .. versionadded:: 3.20 + Added the support of :ref:`Makefile Generators`. + + If the ``DEPFILE`` argument is relative, it should be relative to + :variable:`CMAKE_CURRENT_BINARY_DIR`, and any relative paths inside the + ``DEPFILE`` should also be relative to :variable:`CMAKE_CURRENT_BINARY_DIR` + (see policy :policy:`CMP0116`. This policy is always ``NEW`` for + :ref:`Makefile Generators`). + + .. note:: + + For :ref:`Makefile Generators`, this option cannot be specified at the + same time as ``IMPLICIT_DEPENDS`` option. + +Examples: Generating Files +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Custom commands may be used to generate source files. +For example, the code: + +.. code-block:: cmake + + add_custom_command( + OUTPUT out.c + COMMAND someTool -i ${CMAKE_CURRENT_SOURCE_DIR}/in.txt + -o out.c + DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/in.txt + VERBATIM) + add_library(myLib out.c) + +adds a custom command to run ``someTool`` to generate ``out.c`` and then +compile the generated source as part of a library. The generation rule +will re-run whenever ``in.txt`` changes. + +.. versionadded:: 3.20 + One may use generator expressions to specify per-configuration outputs. + For example, the code: + + .. code-block:: cmake + + add_custom_command( + OUTPUT "out-$<CONFIG>.c" + COMMAND someTool -i ${CMAKE_CURRENT_SOURCE_DIR}/in.txt + -o "out-$<CONFIG>.c" + -c "$<CONFIG>" + DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/in.txt + VERBATIM) + add_library(myLib "out-$<CONFIG>.c") + + adds a custom command to run ``someTool`` to generate ``out-<config>.c``, + where ``<config>`` is the build configuration, and then compile the generated + source as part of a library. Build Events ^^^^^^^^^^^^ @@ -288,3 +376,49 @@ of the following is specified: configuration and no "empty-string-command" will be added. This allows to add individual build events for every configuration. + +Examples: Build Events +^^^^^^^^^^^^^^^^^^^^^^ + +A ``POST_BUILD`` event may be used to post-process a binary after linking. +For example, the code: + +.. code-block:: cmake + + add_executable(myExe myExe.c) + add_custom_command( + TARGET myExe POST_BUILD + COMMAND someHasher -i "$<TARGET_FILE:myExe>" + -o "$<TARGET_FILE:myExe>.hash" + VERBATIM) + +will run ``someHasher`` to produce a ``.hash`` file next to the executable +after linking. + +.. versionadded:: 3.20 + One may use generator expressions to specify per-configuration byproducts. + For example, the code: + + .. code-block:: cmake + + add_library(myPlugin MODULE myPlugin.c) + add_custom_command( + TARGET myPlugin POST_BUILD + COMMAND someHasher -i "$<TARGET_FILE:myPlugin>" + --as-code "myPlugin-hash-$<CONFIG>.c" + BYPRODUCTS "myPlugin-hash-$<CONFIG>.c" + VERBATIM) + add_executable(myExe myExe.c "myPlugin-hash-$<CONFIG>.c") + + will run ``someHasher`` after linking ``myPlugin``, e.g. to produce a ``.c`` + file containing code to check the hash of ``myPlugin`` that the ``myExe`` + executable can use to verify it before loading. + +Ninja Multi-Config +^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 3.20 + + ``add_custom_command`` supports the :generator:`Ninja Multi-Config` + generator's cross-config capabilities. See the generator documentation + for more information. diff --git a/Help/command/add_custom_target.rst b/Help/command/add_custom_target.rst index 2eb0c88649..22d3f294d7 100644 --- a/Help/command/add_custom_target.rst +++ b/Help/command/add_custom_target.rst @@ -32,6 +32,8 @@ The options are: called ``ALL``). ``BYPRODUCTS`` + .. versionadded:: 3.2 + Specify the files the command is expected to produce but whose modification time may or may not be updated on subsequent builds. If a byproduct name is a relative path it will be interpreted @@ -52,6 +54,10 @@ The options are: The :ref:`Makefile Generators` will remove ``BYPRODUCTS`` and other :prop_sf:`GENERATED` files during ``make clean``. + .. versionadded:: 3.20 + Arguments to ``BYPRODUCTS`` may use + :manual:`generator expressions <cmake-generator-expressions(7)>`. + ``COMMAND`` Specify the command-line(s) to execute at build time. If more than one ``COMMAND`` is specified they will be executed in order, @@ -67,18 +73,19 @@ The options are: * The target is not being cross-compiled (i.e. the :variable:`CMAKE_CROSSCOMPILING` variable is not set to true). - * The target is being cross-compiled and an emulator is provided (i.e. - its :prop_tgt:`CROSSCOMPILING_EMULATOR` target property is set). - In this case, the contents of :prop_tgt:`CROSSCOMPILING_EMULATOR` will be - prepended to the command before the location of the target executable. + * .. versionadded:: 3.6 + The target is being cross-compiled and an emulator is provided (i.e. + its :prop_tgt:`CROSSCOMPILING_EMULATOR` target property is set). + In this case, the contents of :prop_tgt:`CROSSCOMPILING_EMULATOR` will be + prepended to the command before the location of the target executable. If neither of the above conditions are met, it is assumed that the command name is a program to be found on the ``PATH`` at build time. Arguments to ``COMMAND`` may use :manual:`generator expressions <cmake-generator-expressions(7)>`. - Use the ``TARGET_FILE`` generator expression to refer to the location of - a target later in the command line (i.e. as a command argument rather + Use the :genex:`TARGET_FILE` generator expression to refer to the location + of a target later in the command line (i.e. as a command argument rather than as the command to execute). Whenever one of the following target based generator expressions are used as @@ -103,14 +110,18 @@ The options are: :command:`add_custom_command` command calls in the same directory (``CMakeLists.txt`` file). They will be brought up to date when the target is built. - A target-level dependency is added if any dependency is a byproduct - of a target or any of its build events in the same directory to ensure - the byproducts will be available before this target is built. + + .. versionchanged:: 3.16 + A target-level dependency is added if any dependency is a byproduct + of a target or any of its build events in the same directory to ensure + the byproducts will be available before this target is built. Use the :command:`add_dependencies` command to add dependencies on other targets. ``COMMAND_EXPAND_LISTS`` + .. versionadded:: 3.8 + Lists in ``COMMAND`` arguments will be expanded, including those created with :manual:`generator expressions <cmake-generator-expressions(7)>`, @@ -119,6 +130,8 @@ The options are: to be properly expanded. ``JOB_POOL`` + .. versionadded:: 3.15 + Specify a :prop_gbl:`pool <JOB_POOLS>` for the :generator:`Ninja` generator. Incompatible with ``USES_TERMINAL``, which implies the ``console`` pool. @@ -141,6 +154,8 @@ The options are: tool-specific special characters. ``USES_TERMINAL`` + .. versionadded:: 3.2 + The command will be given direct access to the terminal if possible. With the :generator:`Ninja` generator, this places the command in the ``console`` :prop_gbl:`pool <JOB_POOLS>`. @@ -150,5 +165,15 @@ The options are: If it is a relative path it will be interpreted relative to the build tree directory corresponding to the current source directory. - Arguments to ``WORKING_DIRECTORY`` may use - :manual:`generator expressions <cmake-generator-expressions(7)>`. + .. versionadded:: 3.13 + Arguments to ``WORKING_DIRECTORY`` may use + :manual:`generator expressions <cmake-generator-expressions(7)>`. + +Ninja Multi-Config +^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 3.20 + + ``add_custom_target`` supports the :generator:`Ninja Multi-Config` + generator's cross-config capabilities. See the generator documentation + for more information. diff --git a/Help/command/add_dependencies.rst b/Help/command/add_dependencies.rst index de219a5087..14c0183031 100644 --- a/Help/command/add_dependencies.rst +++ b/Help/command/add_dependencies.rst @@ -17,6 +17,9 @@ Dependencies added to an :ref:`imported target <Imported Targets>` or an :ref:`interface library <Interface Libraries>` are followed transitively in its place since the target itself does not build. +.. versionadded:: 3.3 + Allow adding dependencies to interface libraries. + See the ``DEPENDS`` option of :command:`add_custom_target` and :command:`add_custom_command` commands for adding file-level dependencies in custom rules. See the :prop_sf:`OBJECT_DEPENDS` diff --git a/Help/command/add_executable.rst b/Help/command/add_executable.rst index e073228de6..dde94293e9 100644 --- a/Help/command/add_executable.rst +++ b/Help/command/add_executable.rst @@ -17,13 +17,21 @@ Normal Executables [source1] [source2 ...]) Adds an executable target called ``<name>`` to be built from the source -files listed in the command invocation. (The source files can be omitted -here if they are added later using :command:`target_sources`.) The +files listed in the command invocation. The ``<name>`` corresponds to the logical target name and must be globally unique within a project. The actual file name of the executable built is constructed based on conventions of the native platform (such as ``<name>.exe`` or just ``<name>``). +.. versionadded:: 3.1 + Source arguments to ``add_executable`` may use "generator expressions" with + the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` + manual for available expressions. + +.. versionadded:: 3.11 + The source files can be omitted if they are added later using + :command:`target_sources`. + By default the executable file will be created in the build tree directory corresponding to the source tree directory in which the command was invoked. See documentation of the @@ -43,10 +51,8 @@ If ``EXCLUDE_FROM_ALL`` is given the corresponding property will be set on the created target. See documentation of the :prop_tgt:`EXCLUDE_FROM_ALL` target property for details. -Source arguments to ``add_executable`` may use "generator expressions" with -the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` -manual for available expressions. See the :manual:`cmake-buildsystem(7)` -manual for more on defining buildsystem properties. +See the :manual:`cmake-buildsystem(7)` manual for more on defining +buildsystem properties. 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 @@ -85,10 +91,14 @@ be used to refer to ``<target>`` in subsequent commands. The ``<name>`` does not appear in the generated buildsystem as a make target. The ``<target>`` may not be an ``ALIAS``. -An ``ALIAS`` to a non-``GLOBAL`` :ref:`Imported Target <Imported Targets>` -has scope in the directory in which the alias is created and below. -The :prop_tgt:`ALIAS_GLOBAL` target property can be used to check if the -alias is global or not. +.. versionadded:: 3.11 + An ``ALIAS`` can target a ``GLOBAL`` :ref:`Imported Target <Imported Targets>` + +.. versionadded:: 3.18 + An ``ALIAS`` can target a non-``GLOBAL`` Imported Target. Such alias is + scoped to the directory in which it is created and subdirectories. + The :prop_tgt:`ALIAS_GLOBAL` target property can be used to check if the + alias is global or not. ``ALIAS`` targets can be used as targets to read properties from, executables for custom commands and custom targets. They can also be diff --git a/Help/command/add_library.rst b/Help/command/add_library.rst index b7dfabc8e5..d3fbdcf199 100644 --- a/Help/command/add_library.rst +++ b/Help/command/add_library.rst @@ -17,13 +17,21 @@ Normal Libraries [<source>...]) Adds a library target called ``<name>`` to be built from the source files -listed in the command invocation. (The source files can be omitted here -if they are added later using :command:`target_sources`.) The ``<name>`` +listed in the command invocation. The ``<name>`` corresponds to the logical target name and must be globally unique within a project. The actual file name of the library built is constructed based on conventions of the native platform (such as ``lib<name>.a`` or ``<name>.lib``). +.. versionadded:: 3.1 + Source arguments to ``add_library`` may use "generator expressions" with + the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` + manual for available expressions. + +.. versionadded:: 3.11 + The source files can be omitted if they are added later using + :command:`target_sources`. + ``STATIC``, ``SHARED``, or ``MODULE`` may be given to specify the type of library to be created. ``STATIC`` libraries are archives of object files for use when linking other targets. ``SHARED`` libraries are linked @@ -34,9 +42,13 @@ type is ``STATIC`` or ``SHARED`` based on whether the current value of the variable :variable:`BUILD_SHARED_LIBS` is ``ON``. For ``SHARED`` and ``MODULE`` libraries the :prop_tgt:`POSITION_INDEPENDENT_CODE` target property is set to ``ON`` automatically. -A ``SHARED`` or ``STATIC`` library may be marked with the :prop_tgt:`FRAMEWORK` +A ``SHARED`` library may be marked with the :prop_tgt:`FRAMEWORK` target property to create an macOS Framework. +.. versionadded:: 3.8 + A ``STATIC`` library may be marked with the :prop_tgt:`FRAMEWORK` + target property to create a static Framework. + If a library does not export any symbols, it must not be declared as a ``SHARED`` library. For example, a Windows resource DLL or a managed C++/CLI DLL that exports no unmanaged symbols would need to be a ``MODULE`` library. @@ -55,10 +67,8 @@ If ``EXCLUDE_FROM_ALL`` is given the corresponding property will be set on the created target. See documentation of the :prop_tgt:`EXCLUDE_FROM_ALL` target property for details. -Source arguments to ``add_library`` may use "generator expressions" with -the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` -manual for available expressions. See the :manual:`cmake-buildsystem(7)` -manual for more on defining buildsystem properties. +See the :manual:`cmake-buildsystem(7)` manual for more on defining +buildsystem properties. 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 @@ -93,6 +103,9 @@ 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>``. +.. versionadded:: 3.12 + Object libraries can be linked to with :command:`target_link_libraries`. + Interface Libraries ^^^^^^^^^^^^^^^^^^^ @@ -121,23 +134,28 @@ 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: +.. versionadded:: 3.15 + An interface library can have :prop_tgt:`PUBLIC_HEADER` and + :prop_tgt:`PRIVATE_HEADER` properties. The headers specified by those + properties can be installed using the :command:`install(TARGETS)` command. -.. code-block:: cmake +.. versionadded:: 3.19 + An interface library target may be created with source files: + + .. code-block:: cmake - add_library(<name> INTERFACE [<source>...] [EXCLUDE_FROM_ALL]) + 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. + 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. + 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, @@ -211,10 +229,14 @@ used to refer to ``<target>`` in subsequent commands. The ``<name>`` does not appear in the generated buildsystem as a make target. The ``<target>`` may not be an ``ALIAS``. -An ``ALIAS`` to a non-``GLOBAL`` :ref:`Imported Target <Imported Targets>` -has scope in the directory in which the alias is created and below. -The :prop_tgt:`ALIAS_GLOBAL` target property can be used to check if the -alias is global or not. +.. versionadded:: 3.11 + An ``ALIAS`` can target a ``GLOBAL`` :ref:`Imported Target <Imported Targets>` + +.. versionadded:: 3.18 + An ``ALIAS`` can target a non-``GLOBAL`` Imported Target. Such alias is + scoped to the directory in which it is created and below. + The :prop_tgt:`ALIAS_GLOBAL` target property can be used to check if the + alias is global or not. ``ALIAS`` targets can be used as linkable targets and as targets to read properties from. They can also be tested for existence with the diff --git a/Help/command/add_test.rst b/Help/command/add_test.rst index 2b4d082d1a..95cd0374ec 100644 --- a/Help/command/add_test.rst +++ b/Help/command/add_test.rst @@ -31,6 +31,8 @@ if necessary. See policy :policy:`CMP0110`. The options are: current source directory. ``COMMAND_EXPAND_LISTS`` + .. versionadded:: 3.16 + Lists in ``COMMAND`` arguments will be expanded, including those created with :manual:`generator expressions <cmake-generator-expressions(7)>`. @@ -43,6 +45,9 @@ unless the :prop_test:`PASS_REGULAR_EXPRESSION`, :prop_test:`FAIL_REGULAR_EXPRESSION` or :prop_test:`SKIP_REGULAR_EXPRESSION` test property is used. +.. versionadded:: 3.16 + Added :prop_test:`SKIP_REGULAR_EXPRESSION` property. + The ``COMMAND`` and ``WORKING_DIRECTORY`` options may use "generator expressions" with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. @@ -52,7 +57,7 @@ Example usage: .. code-block:: cmake add_test(NAME mytest - COMMAND testDriver --config $<CONFIGURATION> + COMMAND testDriver --config $<CONFIG> --exe $<TARGET_FILE:myexe>) This creates a test ``mytest`` whose command runs a ``testDriver`` tool diff --git a/Help/command/cmake_host_system_information.rst b/Help/command/cmake_host_system_information.rst index 2e9563aab3..2b902a9159 100644 --- a/Help/command/cmake_host_system_information.rst +++ b/Help/command/cmake_host_system_information.rst @@ -24,6 +24,14 @@ Key Description ``AVAILABLE_VIRTUAL_MEMORY`` Available virtual memory in MiB [#mebibytes]_ ``TOTAL_PHYSICAL_MEMORY`` Total physical memory in MiB [#mebibytes]_ ``AVAILABLE_PHYSICAL_MEMORY`` Available physical memory in MiB [#mebibytes]_ +============================= ================================================ + +.. versionadded:: 3.10 + Additional ``<key>`` values are available: + +============================= ================================================ +Key Description +============================= ================================================ ``IS_64BIT`` One if processor is 64Bit ``HAS_FPU`` One if processor has floating point unit ``HAS_MMX`` One if processor supports MMX instructions diff --git a/Help/command/cmake_minimum_required.rst b/Help/command/cmake_minimum_required.rst index f3326b8323..c3b3e7370c 100644 --- a/Help/command/cmake_minimum_required.rst +++ b/Help/command/cmake_minimum_required.rst @@ -7,6 +7,9 @@ Require a minimum version of cmake. cmake_minimum_required(VERSION <min>[...<max>] [FATAL_ERROR]) +.. versionadded:: 3.12 + The optional ``<max>`` version. + Sets the minimum required version of cmake for a project. Also updates the policy settings as explained below. diff --git a/Help/command/cmake_parse_arguments.rst b/Help/command/cmake_parse_arguments.rst index 8803ec8bd0..7c85da6103 100644 --- a/Help/command/cmake_parse_arguments.rst +++ b/Help/command/cmake_parse_arguments.rst @@ -1,8 +1,6 @@ cmake_parse_arguments --------------------- -.. versionadded:: 3.5 - Parse function or macro arguments. .. code-block:: cmake @@ -13,6 +11,10 @@ Parse function or macro arguments. cmake_parse_arguments(PARSE_ARGV <N> <prefix> <options> <one_value_keywords> <multi_value_keywords>) +.. versionadded:: 3.5 + This command is implemented natively. Previously, it has been defined in the + module :module:`CMakeParseArguments`. + This command is for use in macros or functions. It processes the arguments given to that macro or function, and defines a set of variables which hold the values of the @@ -21,11 +23,12 @@ respective options. The first signature reads processes arguments passed in the ``<args>...``. This may be used in either a :command:`macro` or a :command:`function`. -The ``PARSE_ARGV`` signature is only for use in a :command:`function` -body. In this case the arguments that are parsed come from the -``ARGV#`` variables of the calling function. The parsing starts with -the ``<N>``-th argument, where ``<N>`` is an unsigned integer. This allows for -the values to have special characters like ``;`` in them. +.. versionadded:: 3.7 + The ``PARSE_ARGV`` signature is only for use in a :command:`function` + body. In this case the arguments that are parsed come from the + ``ARGV#`` variables of the calling function. The parsing starts with + the ``<N>``-th argument, where ``<N>`` is an unsigned integer. + This allows for the values to have special characters like ``;`` in them. The ``<options>`` argument contains all options for the respective macro, i.e. keywords which can be used when calling the macro without any value @@ -40,12 +43,11 @@ The ``<multi_value_keywords>`` argument contains all keywords for this macro which can be followed by more than one value, like e.g. the ``TARGETS`` or ``FILES`` keywords of the :command:`install` command. -.. note:: - - All keywords shall be unique. I.e. every keyword shall only be specified - once in either ``<options>``, ``<one_value_keywords>`` or - ``<multi_value_keywords>``. A warning will be emitted if uniqueness is - violated. +.. versionchanged:: 3.5 + All keywords shall be unique. I.e. every keyword shall only be specified + once in either ``<options>``, ``<one_value_keywords>`` or + ``<multi_value_keywords>``. A warning will be emitted if uniqueness is + violated. When done, ``cmake_parse_arguments`` will consider for each of the keywords listed in ``<options>``, ``<one_value_keywords>`` and @@ -61,10 +63,12 @@ All remaining arguments are collected in a variable were recognized. This can be checked afterwards to see whether your macro was called with unrecognized parameters. -``<one_value_keywords>`` and ``<multi_value_keywords>`` that were given no -values at all are collected in a variable ``<prefix>_KEYWORDS_MISSING_VALUES`` -that will be undefined if all keywords received values. This can be checked -to see if there were keywords without any values given. +.. versionadded:: 3.15 + ``<one_value_keywords>`` and ``<multi_value_keywords>`` that were given no + values at all are collected in a variable + ``<prefix>_KEYWORDS_MISSING_VALUES`` that will be undefined if all keywords + received values. This can be checked to see if there were keywords without + any values given. Consider the following example macro, ``my_install()``, which takes similar arguments to the real :command:`install` command: diff --git a/Help/command/cmake_path.rst b/Help/command/cmake_path.rst new file mode 100644 index 0000000000..a8999f35b1 --- /dev/null +++ b/Help/command/cmake_path.rst @@ -0,0 +1,784 @@ +cmake_path +---------- + +.. versionadded:: 3.20 + +This command is for the manipulation of paths. Only syntactic aspects of +paths are handled, there is no interaction of any kind with any underlying +file system. The path may represent a non-existing path or even one that +is not allowed to exist on the current file system or platform. +For operations that do interact with the filesystem, see the :command:`file` +command. + +.. note:: + + The ``cmake_path`` command handles paths in the format of the build system + (i.e. the host platform), not the target system. When cross-compiling, + if the path contains elements that are not representable on the host + platform (e.g. a drive letter when the host is not Windows), the results + will be unpredictable. + +Synopsis +^^^^^^^^ + +.. parsed-literal:: + + `Conventions`_ + + `Path Structure And Terminology`_ + + `Normalization`_ + + `Decomposition`_ + cmake_path(`GET`_ <path-var> :ref:`ROOT_NAME <GET_ROOT_NAME>` <out-var>) + cmake_path(`GET`_ <path-var> :ref:`ROOT_DIRECTORY <GET_ROOT_DIRECTORY>` <out-var>) + cmake_path(`GET`_ <path-var> :ref:`ROOT_PATH <GET_ROOT_PATH>` <out-var>) + cmake_path(`GET`_ <path-var> :ref:`FILENAME <GET_FILENAME>` <out-var>) + cmake_path(`GET`_ <path-var> :ref:`EXTENSION <GET_EXTENSION>` [LAST_ONLY] <out-var>) + cmake_path(`GET`_ <path-var> :ref:`STEM <GET_STEM>` [LAST_ONLY] <out-var>) + cmake_path(`GET`_ <path-var> :ref:`RELATIVE_PART <GET_RELATIVE_PART>` <out-var>) + cmake_path(`GET`_ <path-var> :ref:`PARENT_PATH <GET_PARENT_PATH>` <out-var>) + + `Query`_ + cmake_path(`HAS_ROOT_NAME`_ <path-var> <out-var>) + cmake_path(`HAS_ROOT_DIRECTORY`_ <path-var> <out-var>) + cmake_path(`HAS_ROOT_PATH`_ <path-var> <out-var>) + cmake_path(`HAS_FILENAME`_ <path-var> <out-var>) + cmake_path(`HAS_EXTENSION`_ <path-var> <out-var>) + cmake_path(`HAS_STEM`_ <path-var> <out-var>) + cmake_path(`HAS_RELATIVE_PART`_ <path-var> <out-var>) + cmake_path(`HAS_PARENT_PATH`_ <path-var> <out-var>) + cmake_path(`IS_ABSOLUTE`_ <path-var> <out-var>) + cmake_path(`IS_RELATIVE`_ <path-var> <out-var>) + cmake_path(`IS_PREFIX`_ <path-var> <input> [NORMALIZE] <out-var>) + cmake_path(`COMPARE`_ <input1> <OP> <input2> <out-var>) + + `Modification`_ + cmake_path(:ref:`SET <cmake_path-SET>` <path-var> [NORMALIZE] <input>) + cmake_path(`APPEND`_ <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>]) + cmake_path(`APPEND_STRING`_ <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>]) + cmake_path(`REMOVE_FILENAME`_ <path-var> [OUTPUT_VARIABLE <out-var>]) + cmake_path(`REPLACE_FILENAME`_ <path-var> <input> [OUTPUT_VARIABLE <out-var>]) + cmake_path(`REMOVE_EXTENSION`_ <path-var> [LAST_ONLY] [OUTPUT_VARIABLE <out-var>]) + cmake_path(`REPLACE_EXTENSION`_ <path-var> [LAST_ONLY] <input> [OUTPUT_VARIABLE <out-var>]) + + `Generation`_ + cmake_path(`NORMAL_PATH`_ <path-var> [OUTPUT_VARIABLE <out-var>]) + cmake_path(`RELATIVE_PATH`_ <path-var> [BASE_DIRECTORY <input>] [OUTPUT_VARIABLE <out-var>]) + cmake_path(`ABSOLUTE_PATH`_ <path-var> [BASE_DIRECTORY <input>] [NORMALIZE] [OUTPUT_VARIABLE <out-var>]) + + `Native Conversion`_ + cmake_path(`NATIVE_PATH`_ <path-var> [NORMALIZE] <out-var>) + cmake_path(`CONVERT`_ <input> `TO_CMAKE_PATH_LIST`_ <out-var>) + cmake_path(`CONVERT`_ <input> `TO_NATIVE_PATH_LIST`_ <out-var>) + + `Hashing`_ + cmake_path(`HASH`_ <path-var> <out-var>) + +Conventions +^^^^^^^^^^^ + +The following conventions are used in this command's documentation: + +``<path-var>`` + Always the name of a variable. For commands that expect a ``<path-var>`` + as input, the variable must exist and it is expected to hold a single path. + +``<input>`` + A string literal which may contain a path, path fragment, or multiple paths + with a special separator depending on the command. See the description of + each command to see how this is interpreted. + +``<input>...`` + Zero or more string literal arguments. + +``<out-var>`` + The name of a variable into which the result of a command will be written. + + +Path Structure And Terminology +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A path has the following structure (all components are optional, with some +constraints): + +:: + + root-name root-directory-separator (item-name directory-separator)* filename + +``root-name`` + Identifies the root on a filesystem with multiple roots (such as ``"C:"`` + or ``"//myserver"``). It is optional. + +``root-directory-separator`` + A directory separator that, if present, indicates that this path is + absolute. If it is missing and the first element other than the + ``root-name`` is an ``item-name``, then the path is relative. + +``item-name`` + A sequence of characters that aren't directory separators. This name may + identify a file, a hard link, a symbolic link, or a directory. Two special + cases are recognized: + + * The item name consisting of a single dot character ``.`` is a + directory name that refers to the current directory. + + * The item name consisting of two dot characters ``..`` is a + directory name that refers to the parent directory. + + The ``(...)*`` pattern shown above is to indicate that there can be zero + or more item names, with multiple items separated by a + ``directory-separator``. The ``()*`` characters are not part of the path. + +``directory-separator`` + The only recognized directory separator is a forward slash character ``/``. + If this character is repeated, it is treated as a single directory + separator. In other words, ``/usr///////lib`` is the same as ``/usr/lib``. + +.. _FILENAME_DEF: +.. _EXTENSION_DEF: +.. _STEM_DEF: + +``filename`` + A path has a ``filename`` if it does not end with a ``directory-separator``. + The ``filename`` is effectively the last ``item-name`` of the path, so it + can also be a hard link, symbolic link or a directory. + + A ``filename`` can have an *extension*. By default, the extension is + defined as the sub-string beginning at the left-most period (including + the period) and until the end of the ``filename``. In commands that + accept a ``LAST_ONLY`` keyword, ``LAST_ONLY`` changes the interpretation + to the sub-string beginning at the right-most period. + + The following exceptions apply to the above interpretation: + + * If the first character in the ``filename`` is a period, that period is + ignored (i.e. a ``filename`` like ``".profile"`` is treated as having + no extension). + + * If the ``filename`` is either ``.`` or ``..``, it has no extension. + + The *stem* is the part of the ``filename`` before the extension. + +Some commands refer to a ``root-path``. This is the concatenation of +``root-name`` and ``root-directory-separator``, either or both of which can +be empty. A ``relative-part`` refers to the full path with any ``root-path`` +removed. + + +Creating A Path Variable +^^^^^^^^^^^^^^^^^^^^^^^^ + +While a path can be created with care using an ordinary :command:`set` +command, it is recommended to use :ref:`cmake_path(SET) <cmake_path-SET>` +instead, as it automatically converts the path to the required form where +required. The :ref:`cmake_path(APPEND) <APPEND>` subcommand may +be another suitable alternative where a path needs to be constructed by +joining fragments. The following example compares the three methods for +constructing the same path: + +.. code-block:: cmake + + set(path1 "${CMAKE_CURRENT_SOURCE_DIR}/data") + + cmake_path(SET path2 "${CMAKE_CURRENT_SOURCE_DIR}/data") + + cmake_path(APPEND path3 "${CMAKE_CURRENT_SOURCE_DIR}" "data") + +`Modification`_ and `Generation`_ sub-commands can either store the result +in-place, or in a separate variable named after an ``OUTPUT_VARIABLE`` +keyword. All other sub-commands store the result in a mandatory ``<out-var>`` +variable. + +.. _Normalization: + +Normalization +^^^^^^^^^^^^^ + +Some sub-commands support *normalizing* a path. The algorithm used to +normalize a path is as follows: + +1. If the path is empty, stop (the normalized form of an empty path is + also an empty path). +2. Replace each ``directory-separator``, which may consist of multiple + separators, with a single ``/`` (``/a///b --> /a/b``). +3. Remove each solitary period (``.``) and any immediately following + ``directory-separator`` (``/a/./b/. --> /a/b``). +4. Remove each ``item-name`` (other than ``..``) that is immediately + followed by a ``directory-separator`` and a ``..``, along with any + immediately following ``directory-separator`` (``/a/b/../c --> a/c``). +5. If there is a ``root-directory``, remove any ``..`` and any + ``directory-separators`` immediately following them. The parent of the + root directory is treated as still the root directory (``/../a --> /a``). +6. If the last ``item-name`` is ``..``, remove any trailing + ``directory-separator`` (``../ --> ..``). +7. If the path is empty by this stage, add a ``dot`` (normal form of ``./`` + is ``.``). + + +Decomposition +^^^^^^^^^^^^^ + +.. _GET: +.. _GET_ROOT_NAME: +.. _GET_ROOT_DIRECTORY: +.. _GET_ROOT_PATH: +.. _GET_FILENAME: +.. _GET_EXTENSION: +.. _GET_STEM: +.. _GET_RELATIVE_PART: +.. _GET_PARENT_PATH: + +The following forms of the ``GET`` subcommand each retrieve a different +component or group of components from a path. See +`Path Structure And Terminology`_ for the meaning of each path component. + +:: + + cmake_path(GET <path-var> ROOT_NAME <out-var>) + cmake_path(GET <path-var> ROOT_DIRECTORY <out-var>) + cmake_path(GET <path-var> ROOT_PATH <out-var>) + cmake_path(GET <path-var> FILENAME <out-var>) + cmake_path(GET <path-var> EXTENSION [LAST_ONLY] <out-var>) + cmake_path(GET <path-var> STEM [LAST_ONLY] <out-var>) + cmake_path(GET <path-var> RELATIVE_PART <out-var>) + cmake_path(GET <path-var> PARENT_PATH <out-var>) + +If a requested component is not present in the path, an empty string will be +stored in ``<out-var>``. For example, only Windows systems have the concept +of a ``root-name``, so when the host machine is non-Windows, the ``ROOT_NAME`` +subcommand will always return an empty string. + +For ``PARENT_PATH``, if the `HAS_RELATIVE_PART`_ subcommand returns false, +the result is a copy of ``<path-var>``. Note that this implies that a root +directory is considered to have a parent, with that parent being itself. +Where `HAS_RELATIVE_PART`_ returns true, the result will essentially be +``<path-var>`` with one less element. + +Root examples +""""""""""""" + +.. code-block:: cmake + + set(path "c:/a") + + cmake_path(GET path ROOT_NAME rootName) + cmake_path(GET path ROOT_DIRECTORY rootDir) + cmake_path(GET path ROOT_PATH rootPath) + + message("Root name is \"${rootName}\"") + message("Root directory is \"${rootDir}\"") + message("Root path is \"${rootPath}\"") + +:: + + Root name is "c:" + Root directory is "/" + Root path is "c:/" + +Filename examples +""""""""""""""""" + +.. code-block:: cmake + + set(path "/a/b") + cmake_path(GET path FILENAME filename) + message("First filename is \"${filename}\"") + + # Trailing slash means filename is empty + set(path "/a/b/") + cmake_path(GET path FILENAME filename) + message("Second filename is \"${filename}\"") + +:: + + First filename is "b" + Second filename is "" + +Extension and stem examples +""""""""""""""""""""""""""" + +.. code-block:: cmake + + set(path "name.ext1.ext2") + + cmake_path(GET path EXTENSION fullExt) + cmake_path(GET path STEM fullStem) + message("Full extension is \"${fullExt}\"") + message("Full stem is \"${fullStem}\"") + + # Effect of LAST_ONLY + cmake_path(GET path EXTENSION LAST_ONLY lastExt) + cmake_path(GET path STEM LAST_ONLY lastStem) + message("Last extension is \"${lastExt}\"") + message("Last stem is \"${lastStem}\"") + + # Special cases + set(dotPath "/a/.") + set(dotDotPath "/a/..") + set(someMorePath "/a/.some.more") + cmake_path(GET dotPath EXTENSION dotExt) + cmake_path(GET dotPath STEM dotStem) + cmake_path(GET dotDotPath EXTENSION dotDotExt) + cmake_path(GET dotDotPath STEM dotDotStem) + cmake_path(GET dotMorePath EXTENSION someMoreExt) + cmake_path(GET dotMorePath STEM someMoreStem) + message("Dot extension is \"${dotExt}\"") + message("Dot stem is \"${dotStem}\"") + message("Dot-dot extension is \"${dotDotExt}\"") + message("Dot-dot stem is \"${dotDotStem}\"") + message(".some.more extension is \"${someMoreExt}\"") + message(".some.more stem is \"${someMoreStem}\"") + +:: + + Full extension is ".ext1.ext2" + Full stem is "name" + Last extension is ".ext2" + Last stem is "name.ext1" + Dot extension is "" + Dot stem is "." + Dot-dot extension is "" + Dot-dot stem is ".." + .some.more extension is ".more" + .some.more stem is ".some" + +Relative part examples +"""""""""""""""""""""" + +.. code-block:: cmake + + set(path "c:/a/b") + cmake_path(GET path RELATIVE_PART result) + message("Relative part is \"${result}\"") + + set(path "c/d") + cmake_path(GET path RELATIVE_PART result) + message("Relative part is \"${result}\"") + + set(path "/") + cmake_path(GET path RELATIVE_PART result) + message("Relative part is \"${result}\"") + +:: + + Relative part is "a/b" + Relative part is "c/d" + Relative part is "" + +Path traversal examples +""""""""""""""""""""""" + +.. code-block:: cmake + + set(path "c:/a/b") + cmake_path(GET path PARENT_PATH result) + message("Parent path is \"${result}\"") + + set(path "c:/") + cmake_path(GET path PARENT_PATH result) + message("Parent path is \"${result}\"") + +:: + + Parent path is "c:/a" + Parent path is "c:/" + + +Query +^^^^^ + +Each of the ``GET`` subcommands has a corresponding ``HAS_...`` +subcommand which can be used to discover whether a particular path +component is present. See `Path Structure And Terminology`_ for the +meaning of each path component. + +.. _HAS_ROOT_NAME: +.. _HAS_ROOT_DIRECTORY: +.. _HAS_ROOT_PATH: +.. _HAS_FILENAME: +.. _HAS_EXTENSION: +.. _HAS_STEM: +.. _HAS_RELATIVE_PART: +.. _HAS_PARENT_PATH: + +:: + + cmake_path(HAS_ROOT_NAME <path-var> <out-var>) + cmake_path(HAS_ROOT_DIRECTORY <path-var> <out-var>) + cmake_path(HAS_ROOT_PATH <path-var> <out-var>) + cmake_path(HAS_FILENAME <path-var> <out-var>) + cmake_path(HAS_EXTENSION <path-var> <out-var>) + cmake_path(HAS_STEM <path-var> <out-var>) + cmake_path(HAS_RELATIVE_PART <path-var> <out-var>) + cmake_path(HAS_PARENT_PATH <path-var> <out-var>) + +Each of the above follows the predictable pattern of setting ``<out-var>`` +to true if the path has the associated component, or false otherwise. +Note the following special cases: + +* For ``HAS_ROOT_PATH``, a true result will only be returned if at least one + of ``root-name`` or ``root-directory`` is non-empty. + +* For ``HAS_PARENT_PATH``, the root directory is also considered to have a + parent, which will be itself. The result is true except if the path + consists of just a :ref:`filename <FILENAME_DEF>`. + +.. _IS_ABSOLUTE: + +:: + + cmake_path(IS_ABSOLUTE <path-var> <out-var>) + +Sets ``<out-var>`` to true if ``<path-var>`` is absolute. An absolute path +is a path that unambiguously identifies the location of a file without +reference to an additional starting location. On Windows, this means the +path must have both a ``root-name`` and a ``root-directory-separator`` to be +considered absolute. On other platforms, just a ``root-directory-separator`` +is sufficient. Note that this means on Windows, ``IS_ABSOLUTE`` can be +false while ``HAS_ROOT_DIRECTORY`` can be true. + +.. _IS_RELATIVE: + +:: + + cmake_path(IS_RELATIVE <path-var> <out-var>) + +This will store the opposite of ``IS_ABSOLUTE`` in ``<out-var>``. + +.. _IS_PREFIX: + +:: + + cmake_path(IS_PREFIX <path-var> <input> [NORMALIZE] <out-var>) + +Checks if ``<path-var>`` is the prefix of ``<input>``. + +When the ``NORMALIZE`` option is specified, ``<path-var>`` and ``<input>`` +are :ref:`normalized <Normalization>` before the check. + +.. code-block:: cmake + + set(path "/a/b/c/d") + cmake_path(IS_PREFIX path "/a/b" result) # result = true + cmake_path(IS_PREFIX path "/x/y/z" result) # result = false + + set(path "/a/b") + cmake_path(IS_PREFIX path "/a/c/../b" NORMALIZE result) # result = true + +.. _COMPARE: + +:: + + cmake_path(COMPARE <input1> EQUAL <input2> <out-var>) + cmake_path(COMPARE <input1> NOT_EQUAL <input2> <out-var>) + +Compares the lexical representations of two paths provided as string literals. +No normalization is performed on either path. Equality is determined +according to the following pseudo-code logic: + +:: + + if(NOT <input1>.root_name() STREQUAL <input2>.root_name()) + return FALSE + + if(<input1>.has_root_directory() XOR <input2>.has_root_directory()) + return FALSE + + Return FALSE if a relative portion of <input1> is not lexicographically + equal to the relative portion of <input2>. This comparison is performed path + component-wise. If all of the components compare equal, then return TRUE. + +.. note:: + Unlike most other ``cmake_path()`` subcommands, the ``COMPARE`` subcommand + takes literal strings as input, not the names of variables. + + +Modification +^^^^^^^^^^^^ + +.. _cmake_path-SET: + +:: + + cmake_path(SET <path-var> [NORMALIZE] <input>) + +Assign the ``<input>`` path to ``<path-var>``. If ``<input>`` is a native +path, it is converted into a cmake-style path with forward-slashes +(``/``). On Windows, the long filename marker is taken into account. + +When the ``NORMALIZE`` option is specified, the path is :ref:`normalized +<Normalization>` before the conversion. + +For example: + +.. code-block:: cmake + + set(native_path "c:\\a\\b/..\\c") + cmake_path(SET path "${native_path}") + message("CMake path is \"${path}\"") + + cmake_path(SET path NORMALIZE "${native_path}") + message("Normalized CMake path is \"${path}\"") + +Output:: + + CMake path is "c:/a/b/../c" + Normalized CMake path is "c:/a/c" + +.. _APPEND: + +:: + + cmake_path(APPEND <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>]) + +Append all the ``<input>`` arguments to the ``<path-var>`` using ``/`` as +the ``directory-separator``. Depending on the ``<input>``, the previous +contents of ``<path-var>`` may be discarded. For each ``<input>`` argument, +the following algorithm (pseudo-code) applies: + +:: + + # <path> is the contents of <path-var> + + if(<input>.is_absolute() OR + (<input>.has_root_name() AND + NOT <input>.root_name() STREQUAL <path>.root_name())) + replace <path> with <input> + return() + endif() + + if(<input>.has_root_directory()) + remove any root-directory and the entire relative path from <path> + elseif(<path>.has_filename() OR + (NOT <path-var>.has_root_directory() OR <path>.is_absolute())) + append directory-separator to <path> + endif() + + append <input> omitting any root-name to <path> + +.. _APPEND_STRING: + +:: + + cmake_path(APPEND_STRING <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>]) + +Append all the ``<input>`` arguments to the ``<path-var>`` without adding any +``directory-separator``. + +.. _REMOVE_FILENAME: + +:: + + cmake_path(REMOVE_FILENAME <path-var> [OUTPUT_VARIABLE <out-var>]) + +Removes the :ref:`filename <FILENAME_DEF>` component (as returned by +:ref:`GET ... FILENAME <GET_FILENAME>`) from ``<path-var>``. After removal, +any trailing ``directory-separator`` is left alone, if present. + +If ``OUTPUT_VARIABLE`` is not given, then after this function returns, +`HAS_FILENAME`_ returns false for ``<path-var>``. + +For example: + +.. code-block:: cmake + + set(path "/a/b") + cmake_path(REMOVE_FILENAME path) + message("First path is \"${path}\"") + + # filename is now already empty, the following removes nothing + cmake_path(REMOVE_FILENAME path) + message("Second path is \"${result}\"") + +Output:: + + First path is "/a/" + Second path is "/a/" + +.. _REPLACE_FILENAME: + +:: + + cmake_path(REPLACE_FILENAME <path-var> <input> [OUTPUT_VARIABLE <out-var>]) + +Replaces the :ref:`filename <FILENAME_DEF>` component from ``<path-var>`` +with ``<input>``. If ``<path-var>`` has no filename component (i.e. +`HAS_FILENAME`_ returns false), the path is unchanged. The operation is +equivalent to the following: + +.. code-block:: cmake + + cmake_path(HAS_FILENAME path has_filename) + if(has_filename) + cmake_path(REMOVE_FILENAME path) + cmake_path(APPEND path input); + endif() + +.. _REMOVE_EXTENSION: + +:: + + cmake_path(REMOVE_EXTENSION <path-var> [LAST_ONLY] + [OUTPUT_VARIABLE <out-var>]) + +Removes the :ref:`extension <EXTENSION_DEF>`, if any, from ``<path-var>``. + +.. _REPLACE_EXTENSION: + +:: + + cmake_path(REPLACE_EXTENSION <path-var> [LAST_ONLY] <input> + [OUTPUT_VARIABLE <out-var>]) + +Replaces the :ref:`extension <EXTENSION_DEF>` with ``<input>``. Its effect +is equivalent to the following: + +.. code-block:: cmake + + cmake_path(REMOVE_EXTENSION path) + if(NOT "input" MATCHES "^\\.") + cmake_path(APPEND_STRING path ".") + endif() + cmake_path(APPEND_STRING path "input") + + +Generation +^^^^^^^^^^ + +.. _NORMAL_PATH: + +:: + + cmake_path(NORMAL_PATH <path-var> [OUTPUT_VARIABLE <out-var>]) + +Normalize ``<path-var>`` according the steps described in :ref:`Normalization`. + +.. _cmake_path-RELATIVE_PATH: +.. _RELATIVE_PATH: + +:: + + cmake_path(RELATIVE_PATH <path-var> [BASE_DIRECTORY <input>] + [OUTPUT_VARIABLE <out-var>]) + +Modifies ``<path-var>`` to make it relative to the ``BASE_DIRECTORY`` argument. +If ``BASE_DIRECTORY`` is not specified, the default base directory will be +:variable:`CMAKE_CURRENT_SOURCE_DIR`. + +For reference, the algorithm used to compute the relative path is the same +as that used by C++ +`std::filesystem::path::lexically_relative +<https://en.cppreference.com/w/cpp/filesystem/path/lexically_normal>`_. + +.. _ABSOLUTE_PATH: + +:: + + cmake_path(ABSOLUTE_PATH <path-var> [BASE_DIRECTORY <input>] [NORMALIZE] + [OUTPUT_VARIABLE <out-var>]) + +If ``<path-var>`` is a relative path (`IS_RELATIVE`_ is true), it is evaluated +relative to the given base directory specified by ``BASE_DIRECTORY`` option. +If ``BASE_DIRECTORY`` is not specified, the default base directory will be +:variable:`CMAKE_CURRENT_SOURCE_DIR`. + +When the ``NORMALIZE`` option is specified, the path is :ref:`normalized +<Normalization>` after the path computation. + +Because ``cmake_path()`` does not access the filesystem, symbolic links are +not resolved. To compute a real path with symbolic links resolved, use the +:command:`file(REAL_PATH)` command instead. + +Native Conversion +^^^^^^^^^^^^^^^^^ + +For commands in this section, *native* refers to the host platform, not the +target platform when cross-compiling. + +.. _cmake_path-NATIVE_PATH: +.. _NATIVE_PATH: + +:: + + cmake_path(NATIVE_PATH <path-var> [NORMALIZE] <out-var>) + +Converts a cmake-style ``<path-var>`` into a native path with +platform-specific slashes (``\`` on Windows hosts and ``/`` elsewhere). + +When the ``NORMALIZE`` option is specified, the path is :ref:`normalized +<Normalization>` before the conversion. + +.. _CONVERT: +.. _cmake_path-TO_CMAKE_PATH_LIST: +.. _TO_CMAKE_PATH_LIST: + +:: + + cmake_path(CONVERT <input> TO_CMAKE_PATH_LIST <out-var> [NORMALIZE]) + +Converts a native ``<input>`` path into a cmake-style path with forward +slashes (``/``). On Windows hosts, the long filename marker is taken into +account. The input can be a single path or a system search path like +``$ENV{PATH}``. A search path will be converted to a cmake-style list +separated by ``;`` characters (on non-Windows platforms, this essentially +means ``:`` separators are replaced with ``;``). The result of the +conversion is stored in the ``<out-var>`` variable. + +When the ``NORMALIZE`` option is specified, the path is :ref:`normalized +<Normalization>` before the conversion. + +.. note:: + Unlike most other ``cmake_path()`` subcommands, the ``CONVERT`` subcommand + takes a literal string as input, not the name of a variable. + +.. _cmake_path-TO_NATIVE_PATH_LIST: +.. _TO_NATIVE_PATH_LIST: + +:: + + cmake_path(CONVERT <input> TO_NATIVE_PATH_LIST <out-var> [NORMALIZE]) + +Converts a cmake-style ``<input>`` path into a native path with +platform-specific slashes (``\`` on Windows hosts and ``/`` elsewhere). +The input can be a single path or a cmake-style list. A list will be +converted into a native search path (``;``-separated on Windows, +``:``-separated on other platforms). The result of the conversion is +stored in the ``<out-var>`` variable. + +When the ``NORMALIZE`` option is specified, the path is :ref:`normalized +<Normalization>` before the conversion. + +.. note:: + Unlike most other ``cmake_path()`` subcommands, the ``CONVERT`` subcommand + takes a literal string as input, not the name of a variable. + +For example: + +.. code-block:: cmake + + set(paths "/a/b/c" "/x/y/z") + cmake_path(CONVERT "${paths}" TO_NATIVE_PATH_LIST native_paths) + message("Native path list is \"${native_paths}\"") + +Output on Windows:: + + Native path list is "\a\b\c;\x\y\z" + +Output on all other platforms:: + + Native path list is "/a/b/c:/x/y/z" + +Hashing +^^^^^^^ + +.. _HASH: + +:: + + cmake_path(HASH <path-var> <out-var>) + +Compute a hash value of ``<path-var>`` such that for two paths ``p1`` and +``p2`` that compare equal (:ref:`COMPARE ... EQUAL <COMPARE>`), the hash +value of ``p1`` is equal to the hash value of ``p2``. The path is always +:ref:`normalized <Normalization>` before the hash is computed. diff --git a/Help/command/cmake_policy.rst b/Help/command/cmake_policy.rst index 4bc7807bb1..94060d9b82 100644 --- a/Help/command/cmake_policy.rst +++ b/Help/command/cmake_policy.rst @@ -28,6 +28,9 @@ encourage projects to set policies based on CMake versions: cmake_policy(VERSION <min>[...<max>]) +.. versionadded:: 3.12 + The optional ``<max>`` version. + ``<min>`` and the optional ``<max>`` are each CMake versions of the form ``major.minor[.patch[.tweak]]``, and the ``...`` is literal. The ``<min>`` version must be at least ``2.4`` and at most the running version of CMake. diff --git a/Help/command/configure_file.rst b/Help/command/configure_file.rst index c59995ae2a..63ea84d1b3 100644 --- a/Help/command/configure_file.rst +++ b/Help/command/configure_file.rst @@ -6,8 +6,9 @@ Copy a file to another location and modify its contents. .. code-block:: cmake configure_file(<input> <output> + [FILE_PERMISSIONS <permissions>...] [COPYONLY] [ESCAPE_QUOTES] [@ONLY] - [NO_SOURCE_PERMISSIONS] + [NO_SOURCE_PERMISSIONS] [USE_SOURCE_PERMISSIONS] [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]) Copies an ``<input>`` file to an ``<output>`` file and substitutes @@ -37,22 +38,24 @@ a false constant by the :command:`if` command. The "..." content on the line after the variable name, if any, is processed as above. Input file lines of the form ``#cmakedefine01 VAR`` will be replaced with either ``#define VAR 1`` or ``#define VAR 0`` similarly. -The result lines (with the exception of the ``#undef`` comments) can be -indented using spaces and/or tabs between the ``#`` character -and the ``cmakedefine`` or ``cmakedefine01`` words. This whitespace -indentation will be preserved in the output lines: -.. code-block:: c +.. versionadded:: 3.10 + The result lines (with the exception of the ``#undef`` comments) can be + indented using spaces and/or tabs between the ``#`` character + and the ``cmakedefine`` or ``cmakedefine01`` words. This whitespace + indentation will be preserved in the output lines: - # cmakedefine VAR - # cmakedefine01 VAR + .. code-block:: c -will be replaced, if ``VAR`` is defined, with + # cmakedefine VAR + # cmakedefine01 VAR -.. code-block:: c + will be replaced, if ``VAR`` is defined, with - # define VAR - # define VAR 1 + .. code-block:: c + + # define VAR + # define VAR 1 If the input file is modified the build system will re-run CMake to re-configure the file and generate the build system again. @@ -72,6 +75,9 @@ The arguments are: If the path names an existing directory the output file is placed in that directory with the same file name as the input file. +``FILE_PERMISSIONS <permissions>...`` + Use user provided permissions for the output file. + ``COPYONLY`` Copy the file without replacing any variable references or other content. This option may not be used with ``NEWLINE_STYLE``. @@ -84,10 +90,17 @@ The arguments are: This is useful for configuring scripts that use ``${VAR}`` syntax. ``NO_SOURCE_PERMISSIONS`` + .. versionadded:: 3.19 + 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--). +``USE_SOURCE_PERMISSIONS`` + .. versionadded:: 3.20 + + Transfer the file permissions of the original file to the output file. + ``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/ctest_build.rst b/Help/command/ctest_build.rst index 66e1844e9c..4d6dc5a43a 100644 --- a/Help/command/ctest_build.rst +++ b/Help/command/ctest_build.rst @@ -50,7 +50,10 @@ The options are: for an example. ``PROJECT_NAME <project-name>`` - Ignored. This was once used but is no longer needed. + Ignored since CMake 3.0. + + .. versionchanged:: 3.14 + This value is no longer required. ``TARGET <target-name>`` Specify the name of a target to build. If not specified the @@ -68,10 +71,14 @@ The options are: Store the return value of the native build tool in the given variable. ``CAPTURE_CMAKE_ERROR <result-var>`` + .. versionadded:: 3.7 + Store in the ``<result-var>`` variable -1 if there are any errors running the command and prevent ctest from returning non-zero if an error occurs. ``QUIET`` + .. versionadded:: 3.3 + Suppress any CTest-specific non-error output that would have been printed to the console otherwise. The summary of warnings / errors, as well as the output from the native build tool is unaffected by diff --git a/Help/command/ctest_configure.rst b/Help/command/ctest_configure.rst index 2dea07b16f..95712aac06 100644 --- a/Help/command/ctest_configure.rst +++ b/Help/command/ctest_configure.rst @@ -37,10 +37,14 @@ The options are: configuration tool. ``CAPTURE_CMAKE_ERROR <result-var>`` + .. versionadded:: 3.7 + Store in the ``<result-var>`` variable -1 if there are any errors running the command and prevent ctest from returning non-zero if an error occurs. ``QUIET`` + .. versionadded:: 3.3 + Suppress any CTest-specific non-error messages that would have otherwise been printed to the console. Output from the underlying configure command is not affected. diff --git a/Help/command/ctest_coverage.rst b/Help/command/ctest_coverage.rst index d50f63498c..a6c643bbc5 100644 --- a/Help/command/ctest_coverage.rst +++ b/Help/command/ctest_coverage.rst @@ -37,10 +37,14 @@ The options are: ran without error and non-zero otherwise. ``CAPTURE_CMAKE_ERROR <result-var>`` + .. versionadded:: 3.7 + Store in the ``<result-var>`` variable -1 if there are any errors running the command and prevent ctest from returning non-zero if an error occurs. ``QUIET`` + .. versionadded:: 3.3 + Suppress any CTest-specific non-error output that would have been printed to the console otherwise. The summary indicating how many lines of code were covered is unaffected by this option. diff --git a/Help/command/ctest_memcheck.rst b/Help/command/ctest_memcheck.rst index 288b65a259..f655c2eb2e 100644 --- a/Help/command/ctest_memcheck.rst +++ b/Help/command/ctest_memcheck.rst @@ -35,4 +35,6 @@ Most options are the same as those for the :command:`ctest_test` command. The options unique to this command are: ``DEFECT_COUNT <defect-count-var>`` + .. versionadded:: 3.8 + Store in the ``<defect-count-var>`` the number of defects found. diff --git a/Help/command/ctest_start.rst b/Help/command/ctest_start.rst index f0704aca54..c0f3c6d3cd 100644 --- a/Help/command/ctest_start.rst +++ b/Help/command/ctest_start.rst @@ -29,8 +29,11 @@ The parameters are as follows: ``GROUP <group>`` If ``GROUP`` is used, the submissions will go to the specified group on the CDash server. If no ``GROUP`` is specified, the name of the model is used by - default. This replaces the deprecated option ``TRACK``. Despite the name - change its behavior is unchanged. + default. + + .. versionchanged:: 3.16 + This replaces the deprecated option ``TRACK``. Despite the name + change its behavior is unchanged. ``APPEND`` If ``APPEND`` is used, the existing ``TAG`` is used rather than creating a new @@ -56,6 +59,8 @@ The parameters are as follows: new model and group will be used. ``QUIET`` + .. versionadded:: 3.3 + If ``QUIET`` is used, CTest will suppress any non-error messages that it otherwise would have printed to the console. diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst index 983fc20ced..e6d277f59d 100644 --- a/Help/command/ctest_submit.rst +++ b/Help/command/ctest_submit.rst @@ -42,14 +42,20 @@ The options are: Each individual file must exist at the time of the call. ``SUBMIT_URL <url>`` + .. versionadded:: 3.14 + The ``http`` or ``https`` URL of the dashboard server to send the submission to. If not given, the :variable:`CTEST_SUBMIT_URL` variable is used. ``BUILD_ID <result-var>`` + .. versionadded:: 3.15 + Store in the ``<result-var>`` variable the ID assigned to this build by CDash. ``HTTPHEADER <HTTP-header>`` + .. versionadded:: 3.9 + Specify HTTP header to be included in the request to CDash during submission. For example, CDash can be configured to only accept submissions from authenticated clients. In this case, you should provide a bearer token in your @@ -73,20 +79,27 @@ The options are: non-zero on failure. ``CAPTURE_CMAKE_ERROR <result-var>`` + .. versionadded:: 3.13 + Store in the ``<result-var>`` variable -1 if there are any errors running the command and prevent ctest from returning non-zero if an error occurs. ``QUIET`` + .. versionadded:: 3.3 + Suppress all non-error messages that would have otherwise been printed to the console. Submit to CDash Upload API ^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. versionadded:: 3.2 + :: ctest_submit(CDASH_UPLOAD <file> [CDASH_UPLOAD_TYPE <type>] [SUBMIT_URL <url>] + [BUILD_ID <result-var>] [HTTPHEADER <header>] [RETRY_COUNT <count>] [RETRY_DELAY <delay>] @@ -99,6 +112,19 @@ with a content hash of the file. If CDash does not already have the file, then it is uploaded. Along with the file, a CDash type string is specified to tell CDash which handler to use to process the data. -This signature accepts the ``SUBMIT_URL``, ``BUILD_ID``, ``HTTPHEADER``, -``RETRY_COUNT``, ``RETRY_DELAY``, ``RETURN_VALUE`` and ``QUIET`` options -as described above. +This signature interprets options in the same way as the first one. + +.. versionadded:: 3.8 + Added the ``RETRY_COUNT``, ``RETRY_DELAY``, ``QUIET`` options. + +.. versionadded:: 3.9 + Added the ``HTTPHEADER`` option. + +.. versionadded:: 3.13 + Added the ``RETURN_VALUE`` option. + +.. versionadded:: 3.14 + Added the ``SUBMIT_URL`` option. + +.. versionadded:: 3.15 + Added the ``BUILD_ID`` option. diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst index 3589296ad5..b4493a03dd 100644 --- a/Help/command/ctest_test.rst +++ b/Help/command/ctest_test.rst @@ -68,6 +68,8 @@ The options are: Tests not matching this expression are excluded. ``EXCLUDE_FIXTURE <regex>`` + .. versionadded:: 3.7 + If a test in the set of tests to be executed requires a particular fixture, that fixture's setup and cleanup tests would normally be added to the test set automatically. This option prevents adding setup or cleanup tests for @@ -76,9 +78,13 @@ The options are: setup tests that fail. ``EXCLUDE_FIXTURE_SETUP <regex>`` + .. versionadded:: 3.7 + Same as ``EXCLUDE_FIXTURE`` except only matching setup tests are excluded. ``EXCLUDE_FIXTURE_CLEANUP <regex>`` + .. versionadded:: 3.7 + Same as ``EXCLUDE_FIXTURE`` except only matching cleanup tests are excluded. ``PARALLEL_LEVEL <level>`` @@ -86,11 +92,15 @@ The options are: be run in parallel. ``RESOURCE_SPEC_FILE <file>`` + .. versionadded:: 3.16 + Specify a :ref:`resource specification file <ctest-resource-specification-file>`. See :ref:`ctest-resource-allocation` for more information. ``TEST_LOAD <threshold>`` + .. versionadded:: 3.4 + While running tests in parallel, try not to start tests when they may cause the CPU load to pass above a given threshold. If not specified the :variable:`CTEST_TEST_LOAD` variable will be checked, @@ -98,6 +108,8 @@ The options are: See also the ``TestLoad`` setting in the :ref:`CTest Test Step`. ``REPEAT <mode>:<n>`` + .. versionadded:: 3.17 + Run tests repeatedly based on the given ``<mode>`` up to ``<n>`` times. The modes are: @@ -121,6 +133,8 @@ The options are: implicit test dependencies. ``STOP_ON_FAILURE`` + .. versionadded:: 3.18 + Stop the execution of the tests once one has failed. ``STOP_TIME <time-of-day>`` @@ -131,10 +145,14 @@ The options are: Store non-zero if anything went wrong. ``CAPTURE_CMAKE_ERROR <result-var>`` + .. versionadded:: 3.7 + Store in the ``<result-var>`` variable -1 if there are any errors running the command and prevent ctest from returning non-zero if an error occurs. ``QUIET`` + .. versionadded:: 3.3 + Suppress any CTest-specific non-error messages that would have otherwise been printed to the console. Output from the underlying test command is not affected. Summary info detailing the percentage of passing tests is also diff --git a/Help/command/ctest_update.rst b/Help/command/ctest_update.rst index 96a11c9136..63f991b5e0 100644 --- a/Help/command/ctest_update.rst +++ b/Help/command/ctest_update.rst @@ -24,10 +24,14 @@ The options are: updated or ``-1`` on error. ``CAPTURE_CMAKE_ERROR <result-var>`` + .. versionadded:: 3.13 + Store in the ``<result-var>`` variable -1 if there are any errors running the command and prevent ctest from returning non-zero if an error occurs. ``QUIET`` + .. versionadded:: 3.3 + Tell CTest to suppress most non-error messages that it would have otherwise printed to the console. CTest will still report the new revision of the repository and any conflicting files diff --git a/Help/command/ctest_upload.rst b/Help/command/ctest_upload.rst index 39d9de1a35..ffddd0a43a 100644 --- a/Help/command/ctest_upload.rst +++ b/Help/command/ctest_upload.rst @@ -14,9 +14,13 @@ The options are: dashboard server. ``QUIET`` + .. versionadded:: 3.3 + Suppress any CTest-specific non-error output that would have been printed to the console otherwise. ``CAPTURE_CMAKE_ERROR <result-var>`` + .. versionadded:: 3.7 + Store in the ``<result-var>`` variable -1 if there are any errors running the command and prevent ctest from returning non-zero if an error occurs. diff --git a/Help/command/enable_language.rst b/Help/command/enable_language.rst index e8640eadc6..ce765de684 100644 --- a/Help/command/enable_language.rst +++ b/Help/command/enable_language.rst @@ -12,6 +12,15 @@ variables that are created by the project command. Example languages are ``CXX``, ``C``, ``CUDA``, ``OBJC``, ``OBJCXX``, ``Fortran``, ``ISPC``, and ``ASM``. +.. versionadded:: 3.8 + Added ``CUDA`` support. + +.. versionadded:: 3.16 + Added ``OBJC`` and ``OBJCXX`` support. + +.. versionadded:: 3.18 + Added ``ISPC`` support. + If enabling ``ASM``, enable it last so that CMake can check whether compilers for other languages like ``C`` work for assembly too. diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst index 268c3075bf..82fcd46a51 100644 --- a/Help/command/execute_process.rst +++ b/Help/command/execute_process.rst @@ -62,6 +62,8 @@ Options: describing an error condition. ``RESULTS_VARIABLE <variable>`` + .. versionadded:: 3.10 + The variable will be set to contain the result of all processes as a :ref:`semicolon-separated list <CMake Language Lists>`, in order of the given ``COMMAND`` arguments. Each entry will be an integer return code @@ -75,19 +77,26 @@ Options: ``INPUT_FILE, OUTPUT_FILE``, ``ERROR_FILE`` The file named will be attached to the standard input of the first process, standard output of the last process, or standard error of - all processes, respectively. If the same file is named for both - output and error then it will be used for both. + all processes, respectively. + + .. versionadded:: 3.3 + If the same file is named for both output and error then it will be used + for both. ``OUTPUT_QUIET``, ``ERROR_QUIET`` The standard output or standard error results will be quietly ignored. ``COMMAND_ECHO <where>`` + .. versionadded:: 3.15 + The command being run will be echo'ed to ``<where>`` with ``<where>`` being set to one of ``STDERR``, ``STDOUT`` or ``NONE``. See the :variable:`CMAKE_EXECUTE_PROCESS_COMMAND_ECHO` variable for a way to control the default behavior when this option is not present. ``ENCODING <name>`` + .. versionadded:: 3.8 + On Windows, the encoding that is used to decode output from the process. Ignored on other platforms. Valid encoding names are: @@ -104,11 +113,15 @@ Options: ``OEM`` Use the original equipment manufacturer (OEM) code page. ``UTF8`` or ``UTF-8`` - Use the UTF-8 codepage. Prior to CMake 3.11.0, only ``UTF8`` was accepted - for this encoding. In CMake 3.11.0, ``UTF-8`` was added for consistency with - the `UTF-8 RFC <https://www.ietf.org/rfc/rfc3629>`_ naming convention. + Use the UTF-8 codepage. + + .. versionadded:: 3.11 + Accept ``UTF-8`` spelling for consistency with the + `UTF-8 RFC <https://www.ietf.org/rfc/rfc3629>`_ naming convention. ``ECHO_OUTPUT_VARIABLE``, ``ECHO_ERROR_VARIABLE`` + .. versionadded:: 3.18 + The standard output or standard error will not be exclusively redirected to the configured variables. @@ -118,6 +131,8 @@ Options: This is analogous to the ``tee`` Unix command. ``COMMAND_ERROR_IS_FATAL <ANY|LAST>`` + .. versionadded:: 3.19 + The option following ``COMMAND_ERROR_IS_FATAL`` determines the behavior when an error is encountered: diff --git a/Help/command/export.rst b/Help/command/export.rst index 2ca7056164..e8a1fa70e4 100644 --- a/Help/command/export.rst +++ b/Help/command/export.rst @@ -64,16 +64,23 @@ build tree. In some cases, for example for packaging and for system wide installations, it is not desirable to write the user package registry. -By default the ``export(PACKAGE)`` command does nothing (see policy -:policy:`CMP0090`) because populating the user package registry has effects -outside the source and build trees. Set the -:variable:`CMAKE_EXPORT_PACKAGE_REGISTRY` variable to add build directories to -the CMake user package registry. +.. versionchanged:: 3.1 + If the :variable:`CMAKE_EXPORT_NO_PACKAGE_REGISTRY` variable + is enabled, the ``export(PACKAGE)`` command will do nothing. + +.. versionchanged:: 3.15 + By default the ``export(PACKAGE)`` command does nothing (see policy + :policy:`CMP0090`) because populating the user package registry has effects + outside the source and build trees. Set the + :variable:`CMAKE_EXPORT_PACKAGE_REGISTRY` variable to add build directories + to the CMake user package registry. .. code-block:: cmake export(TARGETS [target1 [target2 [...]]] [ANDROID_MK <filename>]) +.. versionadded:: 3.7 + This signature exports cmake built targets to the android ndk build system by creating an Android.mk file that references the prebuilt targets. The Android NDK supports the use of prebuilt libraries, both static and shared. diff --git a/Help/command/file.rst b/Help/command/file.rst index e963be0fb6..3db605d6a8 100644 --- a/Help/command/file.rst +++ b/Help/command/file.rst @@ -3,6 +3,21 @@ file File manipulation command. +This command is dedicated to file and path manipulation requiring access to the +filesystem. + +For other path manipulation, handling only syntactic aspects, have a look at +:command:`cmake_path` command. + +.. note:: + + The sub-commands `RELATIVE_PATH`_, `TO_CMAKE_PATH`_ and `TO_NATIVE_PATH`_ has + been superseded, respectively, by sub-commands + :ref:`RELATIVE_PATH <cmake_path-RELATIVE_PATH>`, + :ref:`CONVERT ... TO_CMAKE_PATH_LIST <cmake_path-TO_CMAKE_PATH_LIST>` and + :ref:`CONVERT ... TO_NATIVE_PATH_LIST <cmake_path-TO_NATIVE_PATH_LIST>` of + :command:`cmake_path` command. + Synopsis ^^^^^^^^ @@ -103,10 +118,15 @@ Parse a list of ASCII strings from ``<filename>`` and store it in Consider only strings that match the given regular expression. ``ENCODING <encoding-type>`` + .. versionadded:: 3.1 + Consider strings of a given encoding. Currently supported encodings are: - UTF-8, UTF-16LE, UTF-16BE, UTF-32LE, UTF-32BE. If the ENCODING option - is not provided and the file has a Byte Order Mark, the ENCODING option - will be defaulted to respect the Byte Order Mark. + ``UTF-8``, ``UTF-16LE``, ``UTF-16BE``, ``UTF-32LE``, ``UTF-32BE``. + If the ``ENCODING`` option is not provided and the file has a Byte Order Mark, + the ``ENCODING`` option will be defaulted to respect the Byte Order Mark. + + .. versionadded:: 3.2 + Added the ``UTF-16LE``, ``UTF-16BE``, ``UTF-32LE``, ``UTF-32BE`` encodings. For example, the code @@ -160,6 +180,8 @@ the ``<format>`` and ``UTC`` options. [POST_EXCLUDE_REGEXES [<regexes>...]] ) +.. versionadded:: 3.16 + Recursively get the list of libraries depended on by the given files. Please note that this sub-command is not intended to be used in project mode. @@ -408,6 +430,9 @@ dependency resolution: If this variable is not specified, it is determined by the value of ``CMAKE_OBJDUMP`` if set, else by system introspection. + .. versionadded:: 3.18 + Use ``CMAKE_OBJDUMP`` if set. + Writing ^^^^^^^ @@ -436,6 +461,8 @@ to update the file only when its content changes. file(TOUCH [<files>...]) file(TOUCH_NOCREATE [<files>...]) +.. versionadded:: 3.12 + Create a file with no content if it does not yet exist. If the file already exists, its access and/or modification will be updated to the time when the function call is executed. @@ -452,7 +479,10 @@ modified. file(GENERATE OUTPUT output-file <INPUT input-file|CONTENT content> - [CONDITION expression] [TARGET target]) + [CONDITION expression] [TARGET target] + [FILE_PERMISSIONS <permissions>...] + [NO_SOURCE_PERMISSIONS] [USE_SOURCE_PERMISSIONS] + [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]) Generate an output file for each build configuration supported by the current :manual:`CMake Generator <cmake-generators(7)>`. Evaluate @@ -469,8 +499,10 @@ from the input content to produce the output content. The options are: ``INPUT <input-file>`` Use the content from a given file as input. - A relative path is treated with respect to the value of - :variable:`CMAKE_CURRENT_SOURCE_DIR`. See policy :policy:`CMP0070`. + + .. versionchanged:: 3.10 + A relative path is treated with respect to the value of + :variable:`CMAKE_CURRENT_SOURCE_DIR`. See policy :policy:`CMP0070`. ``OUTPUT <output-file>`` Specify the output file name to generate. Use generator expressions @@ -478,15 +510,37 @@ from the input content to produce the output content. The options are: name. Multiple configurations may generate the same output file only if the generated content is identical. Otherwise, the ``<output-file>`` must evaluate to an unique name for each configuration. - A relative path (after evaluating generator expressions) is treated - with respect to the value of :variable:`CMAKE_CURRENT_BINARY_DIR`. - See policy :policy:`CMP0070`. + + .. versionchanged:: 3.10 + A relative path (after evaluating generator expressions) is treated + with respect to the value of :variable:`CMAKE_CURRENT_BINARY_DIR`. + See policy :policy:`CMP0070`. ``TARGET <target>`` + .. versionadded:: 3.19 + Specify which target to use when evaluating generator expressions that require a target for evaluation (e.g. ``$<COMPILE_FEATURES:...>``, ``$<TARGET_PROPERTY:prop>``). +``FILE_PERMISSIONS <permissions>...`` + Use user provided permissions for the generated file. + +``NO_SOURCE_PERMISSIONS`` + The generated file permissions default to the standard 644 value + (-rw-r--r--). + +``USE_SOURCE_PERMISSIONS`` + Transfer the file permissions of the original file to the generated file. + This option expects INPUT option. + +``NEWLINE_STYLE <style>`` + .. versionadded:: 3.20 + + Specify the newline style for the generated file. Specify + ``UNIX`` or ``LF`` for ``\n`` newlines, or specify + ``DOS``, ``WIN32``, or ``CRLF`` for ``\r\n`` newlines. + Exactly one ``CONTENT`` or ``INPUT`` option must be given. A specific ``OUTPUT`` file may be named by at most one invocation of ``file(GENERATE)``. Generated files are modified and their timestamp updated on subsequent cmake @@ -506,6 +560,8 @@ of a project's ``CMakeLists.txt`` files. [ESCAPE_QUOTES] [@ONLY] [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]) +.. versionadded:: 3.18 + Generate an output file using the input given by ``CONTENT`` and substitute variable values referenced as ``@VAR@`` or ``${VAR}`` contained therein. The substitution rules behave the same as the :command:`configure_file` command. @@ -554,20 +610,25 @@ Generate a list of files that match the ``<globbing-expressions>`` and store it into the ``<variable>``. Globbing expressions are similar to regular expressions, but much simpler. If ``RELATIVE`` flag is specified, the results will be returned as relative paths to the given -path. The results will be ordered lexicographically. +path. + +.. versionchanged:: 3.6 + The results will be ordered lexicographically. On Windows and macOS, globbing is case-insensitive even if the underlying filesystem is case-sensitive (both filenames and globbing expressions are converted to lowercase before matching). On other platforms, globbing is case-sensitive. -If the ``CONFIGURE_DEPENDS`` flag is specified, CMake will add logic -to the main build system check target to rerun the flagged ``GLOB`` commands -at build time. If any of the outputs change, CMake will regenerate the build -system. +.. versionadded:: 3.3 + By default ``GLOB`` lists directories - directories are omitted in result if + ``LIST_DIRECTORIES`` is set to false. -By default ``GLOB`` lists directories - directories are omitted in result if -``LIST_DIRECTORIES`` is set to false. +.. versionadded:: 3.12 + If the ``CONFIGURE_DEPENDS`` flag is specified, CMake will add logic + to the main build system check target to rerun the flagged ``GLOB`` commands + at build time. If any of the outputs change, CMake will regenerate the build + system. .. note:: We do not recommend using GLOB to collect a list of source files from @@ -590,10 +651,11 @@ matched directory and match the files. Subdirectories that are symlinks are only traversed if ``FOLLOW_SYMLINKS`` is given or policy :policy:`CMP0009` is not set to ``NEW``. -By default ``GLOB_RECURSE`` omits directories from result list - setting -``LIST_DIRECTORIES`` to true adds directories to result list. -If ``FOLLOW_SYMLINKS`` is given or policy :policy:`CMP0009` is not set to -``NEW`` then ``LIST_DIRECTORIES`` treats symlinks as directories. +.. versionadded:: 3.3 + By default ``GLOB_RECURSE`` omits directories from result list - setting + ``LIST_DIRECTORIES`` to true adds directories to result list. + If ``FOLLOW_SYMLINKS`` is given or policy :policy:`CMP0009` is not set to + ``NEW`` then ``LIST_DIRECTORIES`` treats symlinks as directories. Examples of recursive globbing include:: @@ -619,7 +681,12 @@ Move a file or directory within a filesystem from ``<oldname>`` to Remove the given files. The ``REMOVE_RECURSE`` mode will remove the given files and directories, also non-empty directories. No error is emitted if a given file does not exist. Relative input paths are evaluated with respect -to the current source directory. Empty input paths are ignored with a warning. +to the current source directory. + +.. versionchanged:: 3.15 + Empty input paths are ignored with a warning. Previous versions of CMake + interpreted empty string as a relative path with respect to the current + directory and removed its contents. .. _MAKE_DIRECTORY: @@ -652,17 +719,18 @@ at the destination with the same timestamp. Copying preserves input permissions unless explicit permissions or ``NO_SOURCE_PERMISSIONS`` are given (default is ``USE_SOURCE_PERMISSIONS``). -If ``FOLLOW_SYMLINK_CHAIN`` is specified, ``COPY`` will recursively resolve -the symlinks at the paths given until a real file is found, and install -a corresponding symlink in the destination for each symlink encountered. For -each symlink that is installed, the resolution is stripped of the directory, -leaving only the filename, meaning that the new symlink points to a file in -the same directory as the symlink. This feature is useful on some Unix systems, -where libraries are installed as a chain of symlinks with version numbers, with -less specific versions pointing to more specific versions. -``FOLLOW_SYMLINK_CHAIN`` will install all of these symlinks and the library -itself into the destination directory. For example, if you have the following -directory structure: +.. versionadded:: 3.15 + If ``FOLLOW_SYMLINK_CHAIN`` is specified, ``COPY`` will recursively resolve + the symlinks at the paths given until a real file is found, and install + a corresponding symlink in the destination for each symlink encountered. For + each symlink that is installed, the resolution is stripped of the directory, + leaving only the filename, meaning that the new symlink points to a file in + the same directory as the symlink. This feature is useful on some Unix systems, + where libraries are installed as a chain of symlinks with version numbers, with + less specific versions pointing to more specific versions. + ``FOLLOW_SYMLINK_CHAIN`` will install all of these symlinks and the library + itself into the destination directory. For example, if you have the following + directory structure: * ``/opt/foo/lib/libfoo.so.1.2.3`` * ``/opt/foo/lib/libfoo.so.1.2 -> libfoo.so.1.2.3`` @@ -696,6 +764,8 @@ use this signature (with some undocumented options for internal use). file(SIZE <filename> <variable>) +.. versionadded:: 3.14 + Determine the file size of the ``<filename>`` and put the result in ``<variable>`` variable. Requires that ``<filename>`` is a valid path pointing to a file and is readable. @@ -706,6 +776,8 @@ pointing to a file and is readable. file(READ_SYMLINK <linkname> <variable>) +.. versionadded:: 3.14 + This subcommand queries the symlink ``<linkname>`` and stores the path it points to in the result ``<variable>``. If ``<linkname>`` does not exist or is not a symlink, CMake issues a fatal error. @@ -730,6 +802,8 @@ absolute path is obtained: file(CREATE_LINK <original> <linkname> [RESULT <result>] [COPY_ON_ERROR] [SYMBOLIC]) +.. versionadded:: 3.14 + Create a link ``<linkname>`` that points to ``<original>``. It will be a hard link by default, but providing the ``SYMBOLIC`` option results in a symbolic link instead. Hard links require that ``original`` @@ -754,10 +828,12 @@ which would make them unable to support a hard link. [FILE_PERMISSIONS <permissions>...] [DIRECTORY_PERMISSIONS <permissions>...]) +.. versionadded:: 3.19 + Set the permissions for the ``<files>...`` and ``<directories>...`` specified. Valid permissions are ``OWNER_READ``, ``OWNER_WRITE``, ``OWNER_EXECUTE``, ``GROUP_READ``, ``GROUP_WRITE``, ``GROUP_EXECUTE``, ``WORLD_READ``, -``WORLD_WRITE``, ``WORLD_EXECUTE``. +``WORLD_WRITE``, ``WORLD_EXECUTE``, ``SETUID``, ``SETGID``. Valid combination of keywords are: @@ -790,6 +866,8 @@ Valid combination of keywords are: [FILE_PERMISSIONS <permissions>...] [DIRECTORY_PERMISSIONS <permissions>...]) +.. versionadded:: 3.19 + Same as `CHMOD`_, but change the permissions of files and directories present in the ``<directories>...`` recursively. @@ -802,6 +880,8 @@ Path Conversion file(REAL_PATH <path> <out-var> [BASE_DIRECTORY <dir>]) +.. versionadded:: 3.19 + Compute the absolute path to an existing file or directory with symlinks resolved. @@ -849,10 +929,12 @@ Transfer file(UPLOAD <file> <url> [<options>...]) The ``DOWNLOAD`` subcommand 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>``. +The ``UPLOAD`` mode uploads a local ``<file>`` to a given ``<url>``. + +.. versionadded:: 3.19 + 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. Options to both ``DOWNLOAD`` and ``UPLOAD`` are: @@ -877,12 +959,18 @@ Options to both ``DOWNLOAD`` and ``UPLOAD`` are: Terminate the operation after a given total time has elapsed. ``USERPWD <username>:<password>`` + .. versionadded:: 3.7 + Set username and password for operation. ``HTTPHEADER <HTTP-header>`` + .. versionadded:: 3.7 + HTTP header for operation. Suboption can be repeated several times. ``NETRC <level>`` + .. versionadded:: 3.11 + Specify whether the .netrc file is to be used for operation. If this option is not specified, the value of the ``CMAKE_NETRC`` variable will be used instead. @@ -899,6 +987,8 @@ Options to both ``DOWNLOAD`` and ``UPLOAD`` are: The .netrc file is required, and information in the URL is ignored. ``NETRC_FILE <file>`` + .. versionadded:: 3.11 + Specify an alternative .netrc file to the one in your home directory, if the ``NETRC`` level is ``OPTIONAL`` or ``REQUIRED``. If this option is not specified, the value of the ``CMAKE_NETRC_FILE`` variable will @@ -911,9 +1001,15 @@ If neither ``NETRC`` option is given CMake will check variables Specify whether to verify the server certificate for ``https://`` URLs. The default is to *not* verify. + .. versionadded:: 3.18 + Added support to ``file(UPLOAD)``. + ``TLS_CAINFO <file>`` Specify a custom Certificate Authority file for ``https://`` URLs. + .. versionadded:: 3.18 + Added support to ``file(UPLOAD)``. + For ``https://`` URLs CMake must be built with OpenSSL support. ``TLS/SSL`` certificates are not checked by default. Set ``TLS_VERIFY`` to ``ON`` to check certificates. If neither ``TLS`` option is given CMake will check @@ -944,6 +1040,8 @@ Locking [RESULT_VARIABLE <variable>] [TIMEOUT <seconds>]) +.. versionadded:: 3.2 + Lock a file specified by ``<path>`` if no ``DIRECTORY`` option present and file ``<path>/cmake.lock`` otherwise. File will be locked for scope defined by ``GUARD`` option (default value is ``PROCESS``). ``RELEASE`` option can be used @@ -979,6 +1077,8 @@ Archiving [MTIME <mtime>] [VERBOSE]) +.. versionadded:: 3.18 + Creates the specified ``<archive>`` file with the files and directories listed in ``<paths>``. Note that ``<paths>`` must list actual files or directories, wildcards are not supported. @@ -993,9 +1093,10 @@ compression. The other formats use no compression by default, but can be directed to do so with the ``COMPRESSION`` option. Valid values for ``<compression>`` are ``None``, ``BZip2``, ``GZip``, ``XZ``, and ``Zstd``. -The compression level can be specified with the ``COMPRESSION_LEVEL`` option. -The ``<compression-level>`` should be between 0-9, with the default being 0. -The ``COMPRESSION`` option must be present when ``COMPRESSION_LEVEL`` is given. +.. versionadded:: 3.19 + The compression level can be specified with the ``COMPRESSION_LEVEL`` option. + The ``<compression-level>`` should be between 0-9, with the default being 0. + The ``COMPRESSION`` option must be present when ``COMPRESSION_LEVEL`` is given. .. note:: With ``FORMAT`` set to ``raw`` only one file will be compressed with the @@ -1016,6 +1117,8 @@ the ``MTIME`` option. [LIST_ONLY] [VERBOSE]) +.. versionadded:: 3.18 + Extracts or lists the content of the specified ``<archive>``. The directory where the content of the archive will be extracted to can diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 1be2e09eef..3dfd62fc32 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -351,15 +351,16 @@ The set of installation prefixes is constructed using the following steps. If ``NO_DEFAULT_PATH`` is specified all ``NO_*`` options are enabled. -1. Search paths specified in the :variable:`<PackageName>_ROOT` CMake - variable and the :envvar:`<PackageName>_ROOT` environment variable, - where ``<PackageName>`` is the package to be found. - The package root variables are maintained as a stack so if - called from within a find module, root paths from the parent's find - module will also be searched after paths for the current package. - This can be skipped if ``NO_PACKAGE_ROOT_PATH`` is passed or by setting - the :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` to ``FALSE``. - See policy :policy:`CMP0074`. +1. .. versionadded:: 3.12 + Search paths specified in the :variable:`<PackageName>_ROOT` CMake + variable and the :envvar:`<PackageName>_ROOT` environment variable, + where ``<PackageName>`` is the package to be found. + The package root variables are maintained as a stack so if + called from within a find module, root paths from the parent's find + module will also be searched after paths for the current package. + This can be skipped if ``NO_PACKAGE_ROOT_PATH`` is passed or by setting + the :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` to ``FALSE``. + See policy :policy:`CMP0074`. 2. Search paths specified in cmake-specific cache variables. These are intended to be used on the command line with a ``-DVAR=value``. @@ -430,6 +431,10 @@ enabled. 9. Search paths specified by the ``PATHS`` option. These are typically hard-coded guesses. +.. versionadded:: 3.16 + Added the ``CMAKE_FIND_USE_<CATEGORY>_PATH`` variables to globally disable + various search locations. + .. |FIND_XXX| replace:: find_package .. |FIND_ARGS_XXX| replace:: <PackageName> .. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace:: diff --git a/Help/command/foreach.rst b/Help/command/foreach.rst index a01a1042c9..8de6debae4 100644 --- a/Help/command/foreach.rst +++ b/Help/command/foreach.rst @@ -88,6 +88,8 @@ yields foreach(<loop_var>... IN ZIP_LISTS <lists>) +.. versionadded:: 3.17 + In this variant, ``<lists>`` is a whitespace or semicolon separated list of list-valued variables. The ``foreach`` command iterates over each list simultaneously setting the diff --git a/Help/command/function.rst b/Help/command/function.rst index 7a9b907542..3d25aa45f0 100644 --- a/Help/command/function.rst +++ b/Help/command/function.rst @@ -50,8 +50,9 @@ and so on. However, it is strongly recommended to stay with the case chosen in the function definition. Typically functions use all-lowercase names. -The :command:`cmake_language(CALL ...)` command can also be used to -invoke the function. +.. versionadded:: 3.18 + The :command:`cmake_language(CALL ...)` command can also be used to + invoke the function. Arguments ^^^^^^^^^ diff --git a/Help/command/get_directory_property.rst b/Help/command/get_directory_property.rst index 39015cc24e..0ccbfb0272 100644 --- a/Help/command/get_directory_property.rst +++ b/Help/command/get_directory_property.rst @@ -11,12 +11,14 @@ Stores a property of directory scope in the named ``<variable>``. The ``DIRECTORY`` argument specifies another directory from which to retrieve the property value instead of the current directory. -It may reference either a source directory, or since CMake 3.19, -a binary directory. Relative paths are treated as relative to the +Relative paths are treated as relative to the current source directory. CMake must already know about the directory, either by having added it through a call to :command:`add_subdirectory` or being the top level directory. +.. versionadded:: 3.19 + ``<dir>`` may reference a binary directory. + If the property is not defined for the nominated directory scope, an empty string is returned. In the case of ``INHERITED`` properties, if the property is not found for the nominated directory scope, diff --git a/Help/command/get_filename_component.rst b/Help/command/get_filename_component.rst index ea2dedb64c..be9d00af30 100644 --- a/Help/command/get_filename_component.rst +++ b/Help/command/get_filename_component.rst @@ -3,6 +3,11 @@ get_filename_component Get a specific component of a full filename. +.. versionchanged:: 3.19 + This command been superseded by :command:`cmake_path` command, except + ``REALPATH`` now offered by :ref:`file(REAL_PATH) <REAL_PATH>` command and + ``PROGRAM`` now available in :command:`separate_arguments(PROGRAM)` command. + .. code-block:: cmake get_filename_component(<var> <FileName> <mode> [CACHE]) @@ -19,6 +24,9 @@ Sets ``<var>`` to a component of ``<FileName>``, where ``<mode>`` is one of: NAME_WLE = File name with neither the directory nor the last extension PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11) +.. versionadded:: 3.14 + Added the ``LAST_EXT`` and ``NAME_WLE`` modes. + Paths are returned with forward slashes and have no trailing slashes. If the optional ``CACHE`` argument is specified, the result variable is added to the cache. @@ -27,6 +35,8 @@ added to the cache. get_filename_component(<var> <FileName> <mode> [BASE_DIR <dir>] [CACHE]) +.. versionadded:: 3.4 + Sets ``<var>`` to the absolute path of ``<FileName>``, where ``<mode>`` is one of: @@ -53,9 +63,3 @@ left as a full path. If ``PROGRAM_ARGS`` is present with ``PROGRAM``, then any command-line arguments present in the ``<FileName>`` string are split from the program name and stored in ``<arg_var>``. This is used to separate a program name from its arguments in a command line string. - -.. note:: - - The ``REALPATH`` and ``PROGRAM`` subcommands had been superseded, - respectively, by :ref:`file(REAL_PATH) <REAL_PATH>` and - :command:`separate_arguments(PROGRAM)` commands. diff --git a/Help/command/get_property.rst b/Help/command/get_property.rst index 870c934e3d..f77d8af785 100644 --- a/Help/command/get_property.rst +++ b/Help/command/get_property.rst @@ -30,35 +30,43 @@ It must be one of the following: ``DIRECTORY`` Scope defaults to the current directory but another directory (already processed by CMake) may be named by the - full or relative path ``<dir>``. The ``<dir>`` may reference either a - source directory, or since CMake 3.19, a binary directory. + full or relative path ``<dir>``. Relative paths are treated as relative to the current source directory. See also the :command:`get_directory_property` command. + .. versionadded:: 3.19 + ``<dir>`` may reference a binary directory. + ``TARGET`` Scope must name one existing target. See also the :command:`get_target_property` command. ``SOURCE`` Scope must name one source file. By default, the source file's property - will be read from the current source directory's scope, but this can be - overridden with one of the following sub-options: + will be read from the current source directory's scope. + + .. versionadded:: 3.18 + Directory scope can be overridden with one of the following sub-options: + + ``DIRECTORY <dir>`` + The source file property will be read from the ``<dir>`` directory's + scope. CMake must already know about + the directory, either by having added it through a call + to :command:`add_subdirectory` or ``<dir>`` being the top level directory. + Relative paths are treated as relative to the current source directory. - ``DIRECTORY <dir>`` - The source file property will be read from the ``<dir>`` directory's - scope. The ``<dir>`` may reference either a source directory, or - since CMake 3.19, a binary directory. CMake must already know about - the directory, either by having added it through a call - to :command:`add_subdirectory` or ``<dir>`` being the top level directory. - Relative paths are treated as relative to the current source directory. + .. versionadded:: 3.19 + ``<dir>`` may reference a binary directory. - ``TARGET_DIRECTORY <target>`` - The source file property will be read from the directory scope in which - ``<target>`` was created (``<target>`` must therefore already exist). + ``TARGET_DIRECTORY <target>`` + The source file property will be read from the directory scope in which + ``<target>`` was created (``<target>`` must therefore already exist). See also the :command:`get_source_file_property` command. ``INSTALL`` + .. versionadded:: 3.1 + Scope must name one installed file path. ``TEST`` @@ -86,3 +94,8 @@ If ``BRIEF_DOCS`` or ``FULL_DOCS`` is given then the variable is set to a string containing documentation for the requested property. If documentation is requested for a property that has not been defined ``NOTFOUND`` is returned. + +.. note:: + + The :prop_sf:`GENERATED` source file property may be globally visible. + See its documentation for details. diff --git a/Help/command/get_source_file_property.rst b/Help/command/get_source_file_property.rst index 76ed776c03..ae41565985 100644 --- a/Help/command/get_source_file_property.rst +++ b/Help/command/get_source_file_property.rst @@ -19,22 +19,29 @@ command and if still unable to find the property, ``variable`` will be set to an empty string. By default, the source file's property will be read from the current source -directory's scope, but this can be overridden with one of the following -sub-options: +directory's scope. -``DIRECTORY <dir>`` - The source file property will be read from the ``<dir>`` directory's - scope. CMake must already know about that source directory, either by - having added it through a call to :command:`add_subdirectory` or ``<dir>`` - being the top level source directory. Relative paths are treated as - relative to the current source directory. +.. versionadded:: 3.18 + Directory scope can be overridden with one of the following sub-options: -``TARGET_DIRECTORY <target>`` - The source file property will be read from the directory scope in which - ``<target>`` was created (``<target>`` must therefore already exist). + ``DIRECTORY <dir>`` + The source file property will be read from the ``<dir>`` directory's + scope. CMake must already know about that source directory, either by + having added it through a call to :command:`add_subdirectory` or ``<dir>`` + being the top level source directory. Relative paths are treated as + relative to the current source directory. + + ``TARGET_DIRECTORY <target>`` + The source file property will be read from the directory scope in which + ``<target>`` was created (``<target>`` must therefore already exist). Use :command:`set_source_files_properties` to set property values. Source file properties usually control how the file is built. One property that is always there is :prop_sf:`LOCATION`. See also the more general :command:`get_property` command. + +.. note:: + + The :prop_sf:`GENERATED` source file property may be globally visible. + See its documentation for details. diff --git a/Help/command/if.rst b/Help/command/if.rst index be992df157..f327ca9434 100644 --- a/Help/command/if.rst +++ b/Help/command/if.rst @@ -39,15 +39,16 @@ the ``if``, ``elseif`` and :command:`while` clauses. Compound conditions are evaluated in the following order of precedence: Innermost parentheses are evaluated first. Next come unary tests such -as ``EXISTS``, ``COMMAND``, and ``DEFINED``. Then binary tests such as -``EQUAL``, ``LESS``, ``LESS_EQUAL``, ``GREATER``, ``GREATER_EQUAL``, -``STREQUAL``, ``STRLESS``, ``STRLESS_EQUAL``, ``STRGREATER``, -``STRGREATER_EQUAL``, ``VERSION_EQUAL``, ``VERSION_LESS``, -``VERSION_LESS_EQUAL``, ``VERSION_GREATER``, ``VERSION_GREATER_EQUAL``, -and ``MATCHES``. Then the boolean operators in the order ``NOT``, ``AND``, -and finally ``OR``. +as `EXISTS`_, `COMMAND`_, and `DEFINED`_. Then binary tests such as +`EQUAL`_, `LESS`_, `LESS_EQUAL`_, `GREATER`_, `GREATER_EQUAL`_, +`STREQUAL`_, `STRLESS`_, `STRLESS_EQUAL`_, `STRGREATER`_, +`STRGREATER_EQUAL`_, `VERSION_EQUAL`_, `VERSION_LESS`_, +`VERSION_LESS_EQUAL`_, `VERSION_GREATER`_, `VERSION_GREATER_EQUAL`_, +and `MATCHES`_. Then the boolean operators in the order `NOT`_, `AND`_, +and finally `OR`_. -Possible conditions are: +Basic Expressions +""""""""""""""""" ``if(<constant>)`` True if the constant is ``1``, ``ON``, ``YES``, ``TRUE``, ``Y``, @@ -62,15 +63,35 @@ Possible conditions are: True if given a variable that is defined to a value that is not a false constant. False otherwise. (Note macro arguments are not variables.) +Logic Operators +""""""""""""""" + +.. _NOT: + ``if(NOT <condition>)`` True if the condition is not true. +.. _AND: + ``if(<cond1> AND <cond2>)`` True if both conditions would be considered true individually. +.. _OR: + ``if(<cond1> OR <cond2>)`` True if either condition would be considered true individually. +``if((condition) AND (condition OR (condition)))`` + The conditions inside the parenthesis are evaluated first and then + the remaining condition is evaluated as in the other examples. + Where there are nested parenthesis the innermost are evaluated as part + of evaluating the condition that contains them. + +Existence Checks +"""""""""""""""" + +.. _COMMAND: + ``if(COMMAND command-name)`` True if the given name is a command, macro or function that can be invoked. @@ -85,14 +106,35 @@ Possible conditions are: (in any directory). ``if(TEST test-name)`` - True if the given name is an existing test name created by the - :command:`add_test` command. + .. versionadded:: 3.3 + True if the given name is an existing test name created by the + :command:`add_test` command. + +.. _DEFINED: + +``if(DEFINED <name>|CACHE{<name>}|ENV{<name>})`` + True if a variable, cache variable or environment variable + with given ``<name>`` is defined. The value of the variable + does not matter. Note that macro arguments are not variables. + + .. versionadded:: 3.14 + Added support for ``CACHE{<name>}`` variables. + +``if(<variable|string> IN_LIST <variable>)`` + .. versionadded:: 3.3 + True if the given element is contained in the named list variable. + +File Operations +""""""""""""""" + +.. _EXISTS: ``if(EXISTS path-to-file-or-directory)`` True if the named file or directory exists. Behavior is well-defined - only for full paths. Resolves symbolic links, i.e. if the named file or - directory is a symbolic link, returns true if the target of the - symbolic link exists. + only for explicit full paths (a leading ``~/`` is not expanded as + a home directory and is considered a relative path). + Resolves symbolic links, i.e. if the named file or directory is a + symbolic link, returns true if the target of the symbolic link exists. ``if(file1 IS_NEWER_THAN file2)`` True if ``file1`` is newer than ``file2`` or if one of the two files doesn't @@ -113,50 +155,86 @@ Possible conditions are: ``if(IS_ABSOLUTE path)`` True if the given path is an absolute path. +Comparisons +""""""""""" + +.. _MATCHES: + ``if(<variable|string> MATCHES regex)`` True if the given string or variable's value matches the given regular condition. See :ref:`Regex Specification` for regex format. - ``()`` groups are captured in :variable:`CMAKE_MATCH_<n>` variables. + + .. versionadded:: 3.9 + ``()`` groups are captured in :variable:`CMAKE_MATCH_<n>` variables. + +.. _LESS: ``if(<variable|string> LESS <variable|string>)`` True if the given string or variable's value is a valid number and less than that on the right. +.. _GREATER: + ``if(<variable|string> GREATER <variable|string>)`` True if the given string or variable's value is a valid number and greater than that on the right. +.. _EQUAL: + ``if(<variable|string> EQUAL <variable|string>)`` True if the given string or variable's value is a valid number and equal to that on the right. +.. _LESS_EQUAL: + ``if(<variable|string> LESS_EQUAL <variable|string>)`` - True if the given string or variable's value is a valid number and less - than or equal to that on the right. + .. versionadded:: 3.7 + True if the given string or variable's value is a valid number and less + than or equal to that on the right. + +.. _GREATER_EQUAL: ``if(<variable|string> GREATER_EQUAL <variable|string>)`` - True if the given string or variable's value is a valid number and greater - than or equal to that on the right. + .. versionadded:: 3.7 + True if the given string or variable's value is a valid number and greater + than or equal to that on the right. + +.. _STRLESS: ``if(<variable|string> STRLESS <variable|string>)`` True if the given string or variable's value is lexicographically less than the string or variable on the right. +.. _STRGREATER: + ``if(<variable|string> STRGREATER <variable|string>)`` True if the given string or variable's value is lexicographically greater than the string or variable on the right. +.. _STREQUAL: + ``if(<variable|string> STREQUAL <variable|string>)`` True if the given string or variable's value is lexicographically equal to the string or variable on the right. +.. _STRLESS_EQUAL: + ``if(<variable|string> STRLESS_EQUAL <variable|string>)`` - True if the given string or variable's value is lexicographically less - than or equal to the string or variable on the right. + .. versionadded:: 3.7 + True if the given string or variable's value is lexicographically less + than or equal to the string or variable on the right. + +.. _STRGREATER_EQUAL: ``if(<variable|string> STRGREATER_EQUAL <variable|string>)`` - True if the given string or variable's value is lexicographically greater - than or equal to the string or variable on the right. + .. versionadded:: 3.7 + True if the given string or variable's value is lexicographically greater + than or equal to the string or variable on the right. + +Version Comparisons +""""""""""""""""""" + +.. _VERSION_LESS: ``if(<variable|string> VERSION_LESS <variable|string>)`` Component-wise integer version number comparison (version format is @@ -164,43 +242,39 @@ Possible conditions are: Any non-integer version component or non-integer trailing part of a version component effectively truncates the string at that point. +.. _VERSION_GREATER: + ``if(<variable|string> VERSION_GREATER <variable|string>)`` Component-wise integer version number comparison (version format is ``major[.minor[.patch[.tweak]]]``, omitted components are treated as zero). Any non-integer version component or non-integer trailing part of a version component effectively truncates the string at that point. -``if(<variable|string> VERSION_EQUAL <variable|string>)`` - Component-wise integer version number comparison (version format is - ``major[.minor[.patch[.tweak]]]``, omitted components are treated as zero). - Any non-integer version component or non-integer trailing part of a version - component effectively truncates the string at that point. +.. _VERSION_EQUAL: -``if(<variable|string> VERSION_LESS_EQUAL <variable|string>)`` +``if(<variable|string> VERSION_EQUAL <variable|string>)`` Component-wise integer version number comparison (version format is ``major[.minor[.patch[.tweak]]]``, omitted components are treated as zero). Any non-integer version component or non-integer trailing part of a version component effectively truncates the string at that point. -``if(<variable|string> VERSION_GREATER_EQUAL <variable|string>)`` - Component-wise integer version number comparison (version format is - ``major[.minor[.patch[.tweak]]]``, omitted components are treated as zero). - Any non-integer version component or non-integer trailing part of a version - component effectively truncates the string at that point. +.. _VERSION_LESS_EQUAL: -``if(<variable|string> IN_LIST <variable>)`` - True if the given element is contained in the named list variable. +``if(<variable|string> VERSION_LESS_EQUAL <variable|string>)`` + .. versionadded:: 3.7 + Component-wise integer version number comparison (version format is + ``major[.minor[.patch[.tweak]]]``, omitted components are treated as zero). + Any non-integer version component or non-integer trailing part of a version + component effectively truncates the string at that point. -``if(DEFINED <name>|CACHE{<name>}|ENV{<name>})`` - True if a variable, cache variable or environment variable - with given ``<name>`` is defined. The value of the variable - does not matter. Note that macro arguments are not variables. +.. _VERSION_GREATER_EQUAL: -``if((condition) AND (condition OR (condition)))`` - The conditions inside the parenthesis are evaluated first and then - the remaining condition is evaluated as in the previous examples. - Where there are nested parenthesis the innermost are evaluated as part - of evaluating the condition that contains them. +``if(<variable|string> VERSION_GREATER_EQUAL <variable|string>)`` + .. versionadded:: 3.7 + Component-wise integer version number comparison (version format is + ``major[.minor[.patch[.tweak]]]``, omitted components are treated as zero). + Any non-integer version component or non-integer trailing part of a version + component effectively truncates the string at that point. Variable Expansion ^^^^^^^^^^^^^^^^^^ @@ -268,11 +342,12 @@ above-documented condition syntax accepts ``<variable|string>``: tested to see if they are boolean constants, if so they are used as such, otherwise they are assumed to be variables and are dereferenced. -To prevent ambiguity, potential variable or keyword names can be -specified in a :ref:`Quoted Argument` or a :ref:`Bracket Argument`. -A quoted or bracketed variable or keyword will be interpreted as a -string and not dereferenced or interpreted. -See policy :policy:`CMP0054`. +.. versionchanged:: 3.1 + To prevent ambiguity, potential variable or keyword names can be + specified in a :ref:`Quoted Argument` or a :ref:`Bracket Argument`. + A quoted or bracketed variable or keyword will be interpreted as a + string and not dereferenced or interpreted. + See policy :policy:`CMP0054`. There is no automatic evaluation for environment or cache :ref:`Variable References`. Their values must be referenced as diff --git a/Help/command/include_external_msproject.rst b/Help/command/include_external_msproject.rst index 540a13af83..435465462b 100644 --- a/Help/command/include_external_msproject.rst +++ b/Help/command/include_external_msproject.rst @@ -21,6 +21,7 @@ specify the type of project, id (``GUID``) of the project and the name of the target platform. This is useful for projects requiring values other than the default (e.g. WIX projects). -If the imported project has different configuration names than the -current project, set the :prop_tgt:`MAP_IMPORTED_CONFIG_<CONFIG>` -target property to specify the mapping. +.. versionadded:: 3.9 + If the imported project has different configuration names than the + current project, set the :prop_tgt:`MAP_IMPORTED_CONFIG_<CONFIG>` + target property to specify the mapping. diff --git a/Help/command/install.rst b/Help/command/install.rst index c11eaf4293..35207f4c47 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -20,10 +20,13 @@ Introduction This command generates installation rules for a project. Install rules specified by calls to the ``install()`` command within a source directory -are executed in order during installation. Install rules in subdirectories -added by calls to the :command:`add_subdirectory` command are interleaved -with those in the parent directory to run in the order declared (see -policy :policy:`CMP0082`). +are executed in order during installation. + +.. versionchanged:: 3.14 + Install rules in subdirectories + added by calls to the :command:`add_subdirectory` command are interleaved + with those in the parent directory to run in the order declared (see + policy :policy:`CMP0082`). There are multiple signatures for this command. Some of them define installation options for files and targets. Options common to @@ -85,6 +88,8 @@ signatures that specify them. The common options are: :variable:`CMAKE_INSTALL_DEFAULT_COMPONENT_NAME` variable. ``EXCLUDE_FROM_ALL`` + .. versionadded:: 3.6 + Specify that the file is excluded from a full installation and only installed as part of a component-specific installation @@ -97,16 +102,18 @@ signatures that specify them. The common options are: Specify that it is not an error if the file to be installed does not exist. -Command signatures that install files may print messages during -installation. Use the :variable:`CMAKE_INSTALL_MESSAGE` variable -to control which messages are printed. +.. versionadded:: 3.1 + Command signatures that install files may print messages during + installation. Use the :variable:`CMAKE_INSTALL_MESSAGE` variable + to control which messages are printed. -Many of the ``install()`` variants implicitly create the directories -containing the installed files. If -:variable:`CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS` is set, these -directories will be created with the permissions specified. Otherwise, -they will be created according to the uname rules on Unix-like platforms. -Windows platforms are unaffected. +.. versionadded:: 3.11 + Many of the ``install()`` variants implicitly create the directories + containing the installed files. If + :variable:`CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS` is set, these + directories will be created with the permissions specified. Otherwise, + they will be created according to the uname rules on Unix-like platforms. + Windows platforms are unaffected. Installing Targets ^^^^^^^^^^^^^^^^^^ @@ -162,6 +169,8 @@ that may be installed: accompanying import libraries are of kind ``ARCHIVE``). ``OBJECTS`` + .. versionadded:: 3.9 + Object files associated with *object libraries*. ``FRAMEWORK`` @@ -246,6 +255,8 @@ In addition to the common options listed above, each target can accept the following additional arguments: ``NAMELINK_COMPONENT`` + .. versionadded:: 3.12 + On some platforms a versioned shared library has a symbolic link such as:: @@ -357,17 +368,19 @@ targets that link to the object libraries in their implementation. Installing a target with the :prop_tgt:`EXCLUDE_FROM_ALL` target property set to ``TRUE`` has undefined behavior. -`install(TARGETS)`_ can install targets that were created in -other directories. When using such cross-directory install rules, running -``make install`` (or similar) from a subdirectory will not guarantee that -targets from other directories are up-to-date. You can use -:command:`target_link_libraries` or :command:`add_dependencies` -to ensure that such out-of-directory targets are built before the -subdirectory-specific install rules are run. +.. versionadded:: 3.3 + An install destination given as a ``DESTINATION`` argument may + use "generator expressions" with the syntax ``$<...>``. See the + :manual:`cmake-generator-expressions(7)` manual for available expressions. -An install destination given as a ``DESTINATION`` argument may -use "generator expressions" with the syntax ``$<...>``. See the -:manual:`cmake-generator-expressions(7)` manual for available expressions. +.. versionadded:: 3.13 + `install(TARGETS)`_ can install targets that were created in + other directories. When using such cross-directory install rules, running + ``make install`` (or similar) from a subdirectory will not guarantee that + targets from other directories are up-to-date. You can use + :command:`target_link_libraries` or :command:`add_dependencies` + to ensure that such out-of-directory targets are built before the + subdirectory-specific install rules are run. Installing Files ^^^^^^^^^^^^^^^^ @@ -455,9 +468,15 @@ this advice while installing headers to a project-specific subdirectory: DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/myproj ) -An install destination given as a ``DESTINATION`` argument may -use "generator expressions" with the syntax ``$<...>``. See the -:manual:`cmake-generator-expressions(7)` manual for available expressions. +.. versionadded:: 3.4 + An install destination given as a ``DESTINATION`` argument may + use "generator expressions" with the syntax ``$<...>``. See the + :manual:`cmake-generator-expressions(7)` manual for available expressions. + +.. versionadded:: 3.20 + An install rename given as a ``RENAME`` argument may + use "generator expressions" with the syntax ``$<...>``. See the + :manual:`cmake-generator-expressions(7)` manual for available expressions. Installing Directories ^^^^^^^^^^^^^^^^^^^^^^ @@ -495,7 +514,8 @@ permissions specified in the ``FILES`` form of the command, and the directories will be given the default permissions specified in the ``PROGRAMS`` form of the command. -The ``MESSAGE_NEVER`` option disables file installation status output. +.. versionadded:: 3.1 + The ``MESSAGE_NEVER`` option disables file installation status output. Installation of directories may be controlled with fine granularity using the ``PATTERN`` or ``REGEX`` options. These "match" options specify a @@ -579,10 +599,14 @@ path that begins with the appropriate :module:`GNUInstallDirs` variable. This allows package maintainers to control the install destination by setting the appropriate cache variables. -The list of ``dirs...`` given to ``DIRECTORY`` and an install destination -given as a ``DESTINATION`` argument may use "generator expressions" -with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` -manual for available expressions. +.. versionadded:: 3.4 + An install destination given as a ``DESTINATION`` argument may + use "generator expressions" with the syntax ``$<...>``. See the + :manual:`cmake-generator-expressions(7)` manual for available expressions. + +.. versionadded:: 3.5 + The list of ``dirs...`` given to ``DIRECTORY`` may use + "generator expressions" too. Custom Installation Logic ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -610,10 +634,11 @@ example, the code will print a message during installation. -``<file>`` or ``<code>`` may use "generator expressions" with the syntax -``$<...>`` (in the case of ``<file>``, this refers to their use in the file -name, not the file's contents). See the -:manual:`cmake-generator-expressions(7)` manual for available expressions. +.. versionadded:: 3.14 + ``<file>`` or ``<code>`` may use "generator expressions" with the syntax + ``$<...>`` (in the case of ``<file>``, this refers to their use in the file + name, not the file's contents). See the + :manual:`cmake-generator-expressions(7)` manual for available expressions. Installing Exports ^^^^^^^^^^^^^^^^^^ @@ -673,13 +698,14 @@ RPM, typically handle this by listing the ``Runtime`` component as a dependency of the ``Development`` component in the package metadata, ensuring that the library is always installed if the headers and CMake export file are present. -In addition to cmake language files, the ``EXPORT_ANDROID_MK`` mode maybe -used to specify an export to the android ndk build system. This mode -accepts the same options as the normal export mode. The Android -NDK supports the use of prebuilt libraries, both static and shared. This -allows cmake to build the libraries of a project and make them available -to an ndk build system complete with transitive dependencies, include flags -and defines required to use the libraries. +.. versionadded:: 3.7 + In addition to cmake language files, the ``EXPORT_ANDROID_MK`` mode maybe + used to specify an export to the android ndk build system. This mode + accepts the same options as the normal export mode. The Android + NDK supports the use of prebuilt libraries, both static and shared. This + allows cmake to build the libraries of a project and make them available + to an ndk build system complete with transitive dependencies, include flags + and defines required to use the libraries. The ``EXPORT`` form is useful to help outside projects use targets built and installed by the current project. For example, the code diff --git a/Help/command/link_directories.rst b/Help/command/link_directories.rst index 9cb8faa741..6732402347 100644 --- a/Help/command/link_directories.rst +++ b/Help/command/link_directories.rst @@ -11,21 +11,25 @@ Adds the paths in which the linker should search for libraries. Relative paths given to this command are interpreted as relative to the current source directory, see :policy:`CMP0015`. -The directories are added to the :prop_dir:`LINK_DIRECTORIES` directory -property for the current ``CMakeLists.txt`` file, converting relative -paths to absolute as needed. The command will apply only to targets created after it is called. -By default the directories specified are appended onto the current list of -directories. This default behavior can be changed by setting -:variable:`CMAKE_LINK_DIRECTORIES_BEFORE` to ``ON``. By using -``AFTER`` or ``BEFORE`` explicitly, you can select between appending and -prepending, independent of the default. - -Arguments to ``link_directories`` may use "generator expressions" with -the syntax "$<...>". See the :manual:`cmake-generator-expressions(7)` -manual for available expressions. See the :manual:`cmake-buildsystem(7)` -manual for more on defining buildsystem properties. +.. versionadded:: 3.13 + The directories are added to the :prop_dir:`LINK_DIRECTORIES` directory + property for the current ``CMakeLists.txt`` file, converting relative + paths to absolute as needed. See the :manual:`cmake-buildsystem(7)` + manual for more on defining buildsystem properties. + +.. versionadded:: 3.13 + By default the directories specified are appended onto the current list of + directories. This default behavior can be changed by setting + :variable:`CMAKE_LINK_DIRECTORIES_BEFORE` to ``ON``. By using + ``AFTER`` or ``BEFORE`` explicitly, you can select between appending and + prepending, independent of the default. + +.. versionadded:: 3.13 + Arguments to ``link_directories`` may use "generator expressions" with + the syntax "$<...>". See the :manual:`cmake-generator-expressions(7)` + manual for available expressions. .. note:: diff --git a/Help/command/list.rst b/Help/command/list.rst index 4d339a03c2..7accc5a39e 100644 --- a/Help/command/list.rst +++ b/Help/command/list.rst @@ -88,6 +88,8 @@ Returns the list of elements specified by indices from the list. list(JOIN <list> <glue> <output variable>) +.. versionadded:: 3.12 + Returns a string joining all list's elements using the glue string. To join multiple strings, which are not part of a list, use ``JOIN`` operator from :command:`string` command. @@ -98,6 +100,8 @@ from :command:`string` command. list(SUBLIST <list> <begin> <length> <output variable>) +.. versionadded:: 3.12 + Returns a sublist of the given list. If ``<length>`` is 0, an empty list will be returned. If ``<length>`` is -1 or the list is smaller than ``<begin>+<length>`` then @@ -132,6 +136,8 @@ Appends elements to the list. list(FILTER <list> <INCLUDE|EXCLUDE> REGEX <regular_expression>) +.. versionadded:: 3.6 + Includes or removes items from the list that match the mode's pattern. In ``REGEX`` mode, items will be matched against the given regular expression. @@ -152,6 +158,8 @@ Inserts elements to the list to the specified location. list(POP_BACK <list> [<out-var>...]) +.. versionadded:: 3.15 + If no variable name is given, removes exactly one element. Otherwise, assign the last element's value to the given variable and removes it, up to the last variable name given. @@ -162,6 +170,8 @@ up to the last variable name given. list(POP_FRONT <list> [<out-var>...]) +.. versionadded:: 3.15 + If no variable name is given, removes exactly one element. Otherwise, assign the first element's value to the given variable and removes it, up to the last variable name given. @@ -172,6 +182,8 @@ up to the last variable name given. list(PREPEND <list> [<element> ...]) +.. versionadded:: 3.15 + Insert elements to the 0th position in the list. .. _REMOVE_ITEM: @@ -206,6 +218,8 @@ but if duplicates are encountered, only the first instance is preserved. list(TRANSFORM <list> <ACTION> [<SELECTOR>] [OUTPUT_VARIABLE <output variable>]) +.. versionadded:: 3.12 + Transforms the list by applying an action to all or, by specifying a ``<SELECTOR>``, to the selected elements of the list, storing the result in-place or in the specified output variable. @@ -302,6 +316,13 @@ Reverses the contents of the list in-place. list(SORT <list> [COMPARE <compare>] [CASE <case>] [ORDER <order>]) Sorts the list in-place alphabetically. + +.. versionadded:: 3.13 + Added the ``COMPARE``, ``CASE``, and ``ORDER`` options. + +.. versionadded:: 3.18 + Added the ``COMPARE NATURAL`` option. + Use the ``COMPARE`` keyword to select the comparison method for sorting. The ``<compare>`` option should be one of: diff --git a/Help/command/macro.rst b/Help/command/macro.rst index 797a90d8f4..5fe4c00efa 100644 --- a/Help/command/macro.rst +++ b/Help/command/macro.rst @@ -48,8 +48,9 @@ and so on. However, it is strongly recommended to stay with the case chosen in the macro definition. Typically macros use all-lowercase names. -The :command:`cmake_language(CALL ...)` command can also be used to -invoke the macro. +.. versionadded:: 3.18 + The :command:`cmake_language(CALL ...)` command can also be used to + invoke the macro. Arguments ^^^^^^^^^ diff --git a/Help/command/mark_as_advanced.rst b/Help/command/mark_as_advanced.rst index e52e623a7f..201363fadd 100644 --- a/Help/command/mark_as_advanced.rst +++ b/Help/command/mark_as_advanced.rst @@ -23,8 +23,6 @@ new values will be marked as advanced, but if a variable already has an advanced/non-advanced state, it will not be changed. -.. note:: - - Policy :policy:`CMP0102` affects the behavior of the ``mark_as_advanced`` - call. When set to ``NEW``, variables passed to this command which are not - already in the cache are ignored. See policy :policy:`CMP0102`. +.. versionchanged:: 3.17 + Variables passed to this command which are not already in the cache + are ignored. See policy :policy:`CMP0102`. diff --git a/Help/command/math.rst b/Help/command/math.rst index ddb1ec63cf..8386aabc6f 100644 --- a/Help/command/math.rst +++ b/Help/command/math.rst @@ -17,17 +17,18 @@ Supported operators are ``+``, ``-``, ``*``, ``/``, ``%``, ``|``, ``&``, ``^``, ``~``, ``<<``, ``>>``, and ``(...)``; they have the same meaning as in C code. -Hexadecimal numbers are recognized when prefixed with ``0x``, as in C code. - -The result is formatted according to the option ``OUTPUT_FORMAT``, -where ``<format>`` is one of - -``HEXADECIMAL`` - Hexadecimal notation as in C code, i. e. starting with "0x". -``DECIMAL`` - Decimal notation. Which is also used if no ``OUTPUT_FORMAT`` option - is specified. - +.. versionadded:: 3.13 + Hexadecimal numbers are recognized when prefixed with ``0x``, as in C code. + +.. versionadded:: 3.13 + The result is formatted according to the option ``OUTPUT_FORMAT``, + where ``<format>`` is one of + + ``HEXADECIMAL`` + Hexadecimal notation as in C code, i. e. starting with "0x". + ``DECIMAL`` + Decimal notation. Which is also used if no ``OUTPUT_FORMAT`` option + is specified. For example diff --git a/Help/command/message.rst b/Help/command/message.rst index 6bc0e4cfc6..e44803e858 100644 --- a/Help/command/message.rst +++ b/Help/command/message.rst @@ -71,6 +71,9 @@ influences the way the message is handled: using this log level would normally only be temporary and would expect to be removed before releasing the project, packaging up the files, etc. +.. versionadded:: 3.15 + Added the ``NOTICE``, ``VERBOSE``, ``DEBUG``, and ``TRACE`` levels. + The CMake command-line tool displays ``STATUS`` to ``TRACE`` messages on stdout with the message preceded by two hyphens and a space. All other message types are sent to stderr and are not prefixed with hyphens. The @@ -79,25 +82,29 @@ The :manual:`curses interface <ccmake(1)>` shows ``STATUS`` to ``TRACE`` messages one at a time on a status line and other messages in an interactive pop-up box. The ``--log-level`` command-line option to each of these tools can be used to control which messages will be shown. -To make a log level persist between CMake runs, the -:variable:`CMAKE_MESSAGE_LOG_LEVEL` variable can be set instead. -Note that the command line option takes precedence over the cache variable. - -Messages of log levels ``NOTICE`` and below will have each line preceded -by the content of the :variable:`CMAKE_MESSAGE_INDENT` variable (converted to -a single string by concatenating its list items). For ``STATUS`` to ``TRACE`` -messages, this indenting content will be inserted after the hyphens. - -Messages of log levels ``NOTICE`` and below can also have each line preceded -with context of the form ``[some.context.example]``. The content between the -square brackets is obtained by converting the :variable:`CMAKE_MESSAGE_CONTEXT` -list variable to a dot-separated string. The message context will always -appear before any indenting content but after any automatically added leading -hyphens. By default, message context is not shown, it has to be explicitly -enabled by giving the :manual:`cmake <cmake(1)>` ``--log-context`` -command-line option or by setting the :variable:`CMAKE_MESSAGE_CONTEXT_SHOW` -variable to true. See the :variable:`CMAKE_MESSAGE_CONTEXT` documentation for -usage examples. + +.. versionadded:: 3.17 + To make a log level persist between CMake runs, the + :variable:`CMAKE_MESSAGE_LOG_LEVEL` variable can be set instead. + Note that the command line option takes precedence over the cache variable. + +.. versionadded:: 3.16 + Messages of log levels ``NOTICE`` and below will have each line preceded + by the content of the :variable:`CMAKE_MESSAGE_INDENT` variable (converted to + a single string by concatenating its list items). For ``STATUS`` to ``TRACE`` + messages, this indenting content will be inserted after the hyphens. + +.. versionadded:: 3.17 + Messages of log levels ``NOTICE`` and below can also have each line preceded + with context of the form ``[some.context.example]``. The content between the + square brackets is obtained by converting the :variable:`CMAKE_MESSAGE_CONTEXT` + list variable to a dot-separated string. The message context will always + appear before any indenting content but after any automatically added leading + hyphens. By default, message context is not shown, it has to be explicitly + enabled by giving the :manual:`cmake <cmake(1)>` ``--log-context`` + command-line option or by setting the :variable:`CMAKE_MESSAGE_CONTEXT_SHOW` + variable to true. See the :variable:`CMAKE_MESSAGE_CONTEXT` documentation for + usage examples. CMake Warning and Error message text displays using a simple markup language. Non-indented text is formatted in line-wrapped paragraphs @@ -107,6 +114,8 @@ delimited by newlines. Indented text is considered pre-formatted. Reporting checks ^^^^^^^^^^^^^^^^ +.. versionadded:: 3.17 + A common pattern in CMake output is a message indicating the start of some sort of check, followed by another message reporting the result of that check. For example: diff --git a/Help/command/project.rst b/Help/command/project.rst index c325050f98..6c931b692a 100644 --- a/Help/command/project.rst +++ b/Help/command/project.rst @@ -55,10 +55,14 @@ The options are: * :variable:`PROJECT_VERSION_TWEAK`, :variable:`<PROJECT-NAME>_VERSION_TWEAK`. - When the ``project()`` command is called from the top-level ``CMakeLists.txt``, - then the version is also stored in the variable :variable:`CMAKE_PROJECT_VERSION`. + .. versionadded:: 3.12 + When the ``project()`` command is called from the top-level + ``CMakeLists.txt``, then the version is also stored in the variable + :variable:`CMAKE_PROJECT_VERSION`. ``DESCRIPTION <project-description-string>`` + .. versionadded:: 3.9 + Optional. Sets the variables @@ -71,7 +75,12 @@ The options are: When the ``project()`` command is called from the top-level ``CMakeLists.txt``, then the description is also stored in the variable :variable:`CMAKE_PROJECT_DESCRIPTION`. + .. versionadded:: 3.12 + Added the ``<PROJECT-NAME>_DESCRIPTION`` variable. + ``HOMEPAGE_URL <url-string>`` + .. versionadded:: 3.12 + Optional. Sets the variables @@ -93,6 +102,15 @@ The options are: Specify language ``NONE``, or use the ``LANGUAGES`` keyword and list no languages, to skip enabling any languages. + .. versionadded:: 3.8 + Added ``CUDA`` support. + + .. versionadded:: 3.16 + Added ``OBJC`` and ``OBJCXX`` support. + + .. versionadded:: 3.18 + Added ``ISPC`` support. + If enabling ``ASM``, list it last so that CMake can check whether compilers for other languages like ``C`` work for assembly too. @@ -115,6 +133,13 @@ they point to will be included as the last step of the ``project()`` command. If both are set, then :variable:`CMAKE_PROJECT_INCLUDE` will be included before :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`. +.. versionadded:: 3.15 + Added the ``CMAKE_PROJECT_INCLUDE`` and ``CMAKE_PROJECT_INCLUDE_BEFORE`` + variables. + +.. versionadded:: 3.17 + Added the ``CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE`` variable. + Usage ^^^^^ diff --git a/Help/command/separate_arguments.rst b/Help/command/separate_arguments.rst index 69fb726723..f66af35a57 100644 --- a/Help/command/separate_arguments.rst +++ b/Help/command/separate_arguments.rst @@ -32,10 +32,14 @@ be one of the following keywords: MSDN article `Parsing C Command-Line Arguments`_ for details. ``NATIVE_COMMAND`` + .. versionadded:: 3.9 + Proceeds as in ``WINDOWS_COMMAND`` mode if the host system is Windows. Otherwise proceeds as in ``UNIX_COMMAND`` mode. ``PROGRAM`` + .. versionadded:: 3.19 + The first item in ``<args>`` is assumed to be an executable and will be searched in the system search path or left as a full path. If not found, ``<variable>`` will be empty. Otherwise, ``<variable>`` is a list of 2 diff --git a/Help/command/set_property.rst b/Help/command/set_property.rst index b5c1613e3c..bf437b4347 100644 --- a/Help/command/set_property.rst +++ b/Help/command/set_property.rst @@ -28,11 +28,12 @@ It must be one of the following: ``DIRECTORY`` Scope defaults to the current directory but other directories (already processed by CMake) may be named by full or relative path. - Each path may reference either a source directory, or since CMake 3.19, - a binary directory. Relative paths are treated as relative to the current source directory. See also the :command:`set_directory_properties` command. + .. versionadded:: 3.19 + ``<dir>`` may reference a binary directory. + ``TARGET`` Scope may name zero or more existing targets. See also the :command:`set_target_properties` command. @@ -40,25 +41,31 @@ It must be one of the following: ``SOURCE`` Scope may name zero or more source files. By default, source file properties are only visible to targets added in the same directory (``CMakeLists.txt``). - Visibility can be set in other directory scopes using one or both of the - following sub-options: - - ``DIRECTORY <dirs>...`` - The source file property will be set in each of the ``<dirs>`` - directories' scopes. Each path may reference either a source directory, - or since CMake 3.19, a binary directory. CMake must already know about - each of these directories, either by having added them through a call to - :command:`add_subdirectory` or it being the top level source directory. - Relative paths are treated as relative to the current source directory. - - ``TARGET_DIRECTORY <targets>...`` - The source file property will be set in each of the directory scopes - where any of the specified ``<targets>`` were created (the ``<targets>`` - must therefore already exist). + + .. versionadded:: 3.18 + Visibility can be set in other directory scopes using one or both of the + following sub-options: + + ``DIRECTORY <dirs>...`` + The source file property will be set in each of the ``<dirs>`` + directories' scopes. CMake must already know about + each of these directories, either by having added them through a call to + :command:`add_subdirectory` or it being the top level source directory. + Relative paths are treated as relative to the current source directory. + + .. versionadded:: 3.19 + ``<dirs>`` may reference a binary directory. + + ``TARGET_DIRECTORY <targets>...`` + The source file property will be set in each of the directory scopes + where any of the specified ``<targets>`` were created (the ``<targets>`` + must therefore already exist). See also the :command:`set_source_files_properties` command. ``INSTALL`` + .. versionadded:: 3.1 + Scope may name zero or more installed file paths. These are made available to CPack to influence deployment. @@ -98,3 +105,8 @@ directly set in the nominated scope, the command will behave as though See the :manual:`cmake-properties(7)` manual for a list of properties in each scope. + +.. note:: + + The :prop_sf:`GENERATED` source file property may be globally visible. + See its documentation for details. diff --git a/Help/command/set_source_files_properties.rst b/Help/command/set_source_files_properties.rst index 9558b4036b..61c69a2e9a 100644 --- a/Help/command/set_source_files_properties.rst +++ b/Help/command/set_source_files_properties.rst @@ -14,9 +14,10 @@ Source files can have properties that affect how they are built. Sets properties associated with source files using a key/value paired list. -By default, source file properties are only visible to targets added in the -same directory (``CMakeLists.txt``). Visibility can be set in other directory -scopes using one or both of the following options: +.. versionadded:: 3.18 + By default, source file properties are only visible to targets added in the + same directory (``CMakeLists.txt``). Visibility can be set in other directory + scopes using one or both of the following options: ``DIRECTORY <dirs>...`` The source file properties will be set in each of the ``<dirs>`` @@ -35,3 +36,8 @@ See also the :command:`set_property(SOURCE)` command. See :ref:`Source File Properties` for the list of properties known to CMake. + +.. note:: + + The :prop_sf:`GENERATED` source file property may be globally visible. + See its documentation for details. diff --git a/Help/command/site_name.rst b/Help/command/site_name.rst index 1bcaeada04..09b5a9fbd6 100644 --- a/Help/command/site_name.rst +++ b/Help/command/site_name.rst @@ -6,3 +6,7 @@ Set the given variable to the name of the computer. .. code-block:: cmake site_name(variable) + +On UNIX-like platforms, if the variable ``HOSTNAME`` is set, its value +will be executed as a command expected to print out the host name, +much like the ``hostname`` command-line tool. diff --git a/Help/command/source_group.rst b/Help/command/source_group.rst index 5ae9e51444..5db1ec8c54 100644 --- a/Help/command/source_group.rst +++ b/Help/command/source_group.rst @@ -14,12 +14,16 @@ This is intended to set up file tabs in Visual Studio. The options are: ``TREE`` + .. versionadded:: 3.8 + CMake will automatically detect, from ``<src>`` files paths, source groups it needs to create, to keep structure of source groups analogically to the actual files and directories structure in the project. Paths of ``<src>`` files will be cut to be relative to ``<root>``. ``PREFIX`` + .. versionadded:: 3.8 + Source group and files located directly in ``<root>`` path, will be placed in ``<prefix>`` source groups. @@ -47,6 +51,9 @@ appropriately: source_group(outer\\inner ...) source_group(TREE <root> PREFIX sources\\inc ...) +.. versionadded:: 3.18 + Allow using forward slashes (``/``) to specify subgroups. + For backwards compatibility, the short-hand signature .. code-block:: cmake diff --git a/Help/command/string.rst b/Help/command/string.rst index 51f8d821ab..8ad0089afd 100644 --- a/Help/command/string.rst +++ b/Help/command/string.rst @@ -170,10 +170,12 @@ The following characters have special meaning in regular expressions: Matches a pattern on either side of the ``|`` ``()`` Saves a matched subexpression, which can be referenced - in the ``REGEX REPLACE`` operation. Additionally it is saved - by all regular expression-related commands, including - e.g. :command:`if(MATCHES)`, in the variables - :variable:`CMAKE_MATCH_<n>` for ``<n>`` 0..9. + in the ``REGEX REPLACE`` operation. + + .. versionadded:: 3.9 + All regular expression-related commands, including e.g. + :command:`if(MATCHES)`, save subgroup matches in the variables + :variable:`CMAKE_MATCH_<n>` for ``<n>`` 0..9. ``*``, ``+`` and ``?`` have higher precedence than concatenation. ``|`` has lower precedence than concatenation. This means that the regular @@ -205,6 +207,8 @@ Manipulation string(APPEND <string_variable> [<input>...]) +.. versionadded:: 3.4 + Append all the ``<input>`` arguments to the string. .. _PREPEND: @@ -213,6 +217,8 @@ Append all the ``<input>`` arguments to the string. string(PREPEND <string_variable> [<input>...]) +.. versionadded:: 3.10 + Prepend all the ``<input>`` arguments to the string. .. _CONCAT: @@ -230,6 +236,8 @@ the result in the named ``<output_variable>``. string(JOIN <glue> <output_variable> [<input>...]) +.. versionadded:: 3.12 + Join all the ``<input>`` arguments together using the ``<glue>`` string and store the result in the named ``<output_variable>``. @@ -271,16 +279,15 @@ result stored in ``<output_variable>`` will *not* be the number of characters. Store in an ``<output_variable>`` a substring of a given ``<string>``. If ``<length>`` is ``-1`` the remainder of the string starting at ``<begin>`` -will be returned. If ``<string>`` is shorter than ``<length>`` then the -end of the string is used instead. +will be returned. + +.. versionchanged:: 3.2 + If ``<string>`` is shorter than ``<length>`` then the end of the string + is used instead. Previous versions of CMake reported an error in this case. Both ``<begin>`` and ``<length>`` are counted in bytes, so care must be exercised if ``<string>`` could contain multi-byte characters. -.. note:: - CMake 3.1 and below reported an error if ``<length>`` pointed past - the end of ``<string>``. - .. _STRIP: .. code-block:: cmake @@ -296,6 +303,8 @@ leading and trailing spaces removed. string(GENEX_STRIP <string> <output_variable>) +.. versionadded:: 3.1 + Strip any :manual:`generator expressions <cmake-generator-expressions(7)>` from the input ``<string>`` and store the result in the ``<output_variable>``. @@ -305,6 +314,8 @@ from the input ``<string>`` and store the result in the ``<output_variable>``. string(REPEAT <string> <count> <output_variable>) +.. versionadded:: 3.15 + Produce the output string as the input ``<string>`` repeated ``<count>`` times. Comparison @@ -323,6 +334,9 @@ Comparison Compare the strings and store true or false in the ``<output_variable>``. +.. versionadded:: 3.7 + Added the ``LESS_EQUAL`` and ``GREATER_EQUAL`` options. + .. _`Supported Hash Algorithms`: Hashing @@ -358,6 +372,9 @@ The supported ``<HASH>`` algorithm names are: ``SHA3_512`` Keccak SHA-3. +.. versionadded:: 3.8 + Added the ``SHA3_*`` hash algorithms. + Generation ^^^^^^^^^^ @@ -375,6 +392,8 @@ Convert all numbers into corresponding ASCII characters. string(HEX <string> <output_variable>) +.. versionadded:: 3.18 + Convert each byte in the input ``<string>`` to its hexadecimal representation and store the concatenated hex digits in the ``<output_variable>``. Letters in the output (``a`` through ``f``) are in lowercase. @@ -451,6 +470,18 @@ specifiers: %y The last two digits of the current year (00-99) %Y The current year. +.. versionadded:: 3.6 + ``%s`` format specifier (UNIX time). + +.. versionadded:: 3.7 + ``%a`` and ``%b`` format specifiers (abbreviated month and weekday names). + +.. versionadded:: 3.8 + ``%%`` specifier (literal ``%``). + +.. versionadded:: 3.7 + ``%A`` and ``%B`` format specifiers (full month and weekday names). + Unknown format specifiers will be ignored and copied to the output as-is. @@ -461,8 +492,7 @@ If no explicit ``<format_string>`` is given, it will default to: %Y-%m-%dT%H:%M:%S for local time. %Y-%m-%dT%H:%M:%SZ for UTC. -.. note:: - +.. versionadded:: 3.8 If the ``SOURCE_DATE_EPOCH`` environment variable is set, its value will be used instead of the current time. See https://reproducible-builds.org/specs/source-date-epoch/ for details. @@ -474,6 +504,8 @@ If no explicit ``<format_string>`` is given, it will default to: string(UUID <output_variable> NAMESPACE <namespace> NAME <name> TYPE <MD5|SHA1> [UPPER]) +.. versionadded:: 3.1 + Create a universally unique identifier (aka GUID) as per RFC4122 based on the hash of the combined values of ``<namespace>`` (which itself has to be a valid UUID) and ``<name>``. @@ -489,6 +521,8 @@ with the optional ``UPPER`` flag. JSON ^^^^ +.. versionadded:: 3.19 + Functionality for querying a JSON string. .. note:: diff --git a/Help/command/target_compile_definitions.rst b/Help/command/target_compile_definitions.rst index 9e9c69093b..3fb113a924 100644 --- a/Help/command/target_compile_definitions.rst +++ b/Help/command/target_compile_definitions.rst @@ -19,10 +19,12 @@ specify the scope of the following arguments. ``PRIVATE`` and ``PUBLIC`` items will populate the :prop_tgt:`COMPILE_DEFINITIONS` property of ``<target>``. ``PUBLIC`` and ``INTERFACE`` items will populate the :prop_tgt:`INTERFACE_COMPILE_DEFINITIONS` property of ``<target>``. -(:ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items.) The following arguments specify compile definitions. Repeated calls for the same ``<target>`` append items in the order called. +.. versionadded:: 3.11 + Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets <Imported Targets>`. + Arguments to ``target_compile_definitions`` may use "generator expressions" with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. See the :manual:`cmake-buildsystem(7)` @@ -37,3 +39,12 @@ For example, the following are all equivalent: target_compile_definitions(foo PUBLIC -DFOO) # -D removed target_compile_definitions(foo PUBLIC "" FOO) # "" ignored target_compile_definitions(foo PUBLIC -D FOO) # -D becomes "", then ignored + +Definitions may optionally have values: + +.. code-block:: cmake + + target_compile_definitions(foo PUBLIC FOO=1) + +Note that many compilers treat ``-DFOO`` as equivalent to ``-DFOO=1``, but +other tools may not recognize this in all circumstances (e.g. IntelliSense). diff --git a/Help/command/target_compile_features.rst b/Help/command/target_compile_features.rst index b50be34a6b..58502bfc2d 100644 --- a/Help/command/target_compile_features.rst +++ b/Help/command/target_compile_features.rst @@ -21,9 +21,11 @@ specify the scope of the features. ``PRIVATE`` and ``PUBLIC`` items will populate the :prop_tgt:`COMPILE_FEATURES` property of ``<target>``. ``PUBLIC`` and ``INTERFACE`` items will populate the :prop_tgt:`INTERFACE_COMPILE_FEATURES` property of ``<target>``. -(:ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items.) Repeated calls for the same ``<target>`` append items. +.. versionadded:: 3.11 + Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets <Imported Targets>`. + 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>`. diff --git a/Help/command/target_compile_options.rst b/Help/command/target_compile_options.rst index 3c733c5d72..e45b209adf 100644 --- a/Help/command/target_compile_options.rst +++ b/Help/command/target_compile_options.rst @@ -26,10 +26,12 @@ specify the scope of the following arguments. ``PRIVATE`` and ``PUBLIC`` items will populate the :prop_tgt:`COMPILE_OPTIONS` property of ``<target>``. ``PUBLIC`` and ``INTERFACE`` items will populate the :prop_tgt:`INTERFACE_COMPILE_OPTIONS` property of ``<target>``. -(:ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items.) The following arguments specify compile options. Repeated calls for the same ``<target>`` append items in the order called. +.. versionadded:: 3.11 + Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets <Imported Targets>`. + Arguments to ``target_compile_options`` may use "generator expressions" with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. See the :manual:`cmake-buildsystem(7)` diff --git a/Help/command/target_include_directories.rst b/Help/command/target_include_directories.rst index 660e15c9bf..3e53b2e4a1 100644 --- a/Help/command/target_include_directories.rst +++ b/Help/command/target_include_directories.rst @@ -5,7 +5,7 @@ Add include directories to a target. .. code-block:: cmake - target_include_directories(<target> [SYSTEM] [BEFORE] + target_include_directories(<target> [SYSTEM] [AFTER|BEFORE] <INTERFACE|PUBLIC|PRIVATE> [items1...] [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]) @@ -14,17 +14,19 @@ 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>`. -If ``BEFORE`` is specified, the content will be prepended to the property -instead of being appended. +By using ``AFTER`` or ``BEFORE`` explicitly, you can select between appending +and prepending, independent of the default. The ``INTERFACE``, ``PUBLIC`` and ``PRIVATE`` keywords are required to specify the scope of the following arguments. ``PRIVATE`` and ``PUBLIC`` items will populate the :prop_tgt:`INCLUDE_DIRECTORIES` property of ``<target>``. ``PUBLIC`` and ``INTERFACE`` items will populate the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` property of ``<target>``. -(:ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items.) The following arguments specify include directories. +.. versionadded:: 3.11 + Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets <Imported Targets>`. + Specified include directories may be absolute paths or relative paths. Repeated calls for the same <target> append items in the order called. If ``SYSTEM`` is specified, the compiler will be told the diff --git a/Help/command/target_link_libraries.rst b/Help/command/target_link_libraries.rst index c2e7e8ac9e..872e264e99 100644 --- a/Help/command/target_link_libraries.rst +++ b/Help/command/target_link_libraries.rst @@ -27,6 +27,10 @@ set to ``NEW`` then the target must have been created in the current directory. Repeated calls for the same ``<target>`` append items in the order called. +.. versionadded:: 3.13 + The ``<target>`` doesn't have to be defined in the same directory as the + ``target_link_libraries`` call. + Each ``<item>`` may be: * **A library target name**: The generated link line will have the @@ -62,10 +66,11 @@ Each ``<item>`` may be: :ref:`usage requirement <Target Usage Requirements>`. This has the same effect as passing the framework directory as an include directory. - On :ref:`Visual Studio Generators` for VS 2010 and above, library files - ending in ``.targets`` will be treated as MSBuild targets files and - imported into generated project files. This is not supported by other - generators. + .. versionadded:: 3.8 + On :ref:`Visual Studio Generators` for VS 2010 and above, library files + ending in ``.targets`` will be treated as MSBuild targets files and + imported into generated project files. This is not supported by other + generators. The full path to the library file will be quoted/escaped for the shell automatically. @@ -89,6 +94,11 @@ Each ``<item>`` may be: flags explicitly. The flags will then be placed at the toolchain-defined flag position in the link command. + .. versionadded:: 3.13 + :prop_tgt:`LINK_OPTIONS` target property and :command:`target_link_options` + command. For earlier versions of CMake, use :prop_tgt:`LINK_FLAGS` + property instead. + The link flag is treated as a command-line string fragment and will be used with no extra quoting or escaping. @@ -216,6 +226,8 @@ is not ``NEW``, they are also appended to the Linking Object Libraries ^^^^^^^^^^^^^^^^^^^^^^^^ +.. versionadded:: 3.12 + :ref:`Object Libraries` may be used as the ``<target>`` (first) argument of ``target_link_libraries`` to specify dependencies of their sources on other libraries. For example, the code diff --git a/Help/command/target_link_options.rst b/Help/command/target_link_options.rst index e59e0e1c68..87dff39ae6 100644 --- a/Help/command/target_link_options.rst +++ b/Help/command/target_link_options.rst @@ -36,10 +36,12 @@ specify the scope of the following arguments. ``PRIVATE`` and ``PUBLIC`` items will populate the :prop_tgt:`LINK_OPTIONS` property of ``<target>``. ``PUBLIC`` and ``INTERFACE`` items will populate the :prop_tgt:`INTERFACE_LINK_OPTIONS` property of ``<target>``. -(:ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items.) The following arguments specify link options. Repeated calls for the same ``<target>`` append items in the order called. +.. note:: + :ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items. + Arguments to ``target_link_options`` may use "generator expressions" with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. See the :manual:`cmake-buildsystem(7)` diff --git a/Help/command/target_precompile_headers.rst b/Help/command/target_precompile_headers.rst index 7005180630..9f7dabbd41 100644 --- a/Help/command/target_precompile_headers.rst +++ b/Help/command/target_precompile_headers.rst @@ -34,7 +34,7 @@ Repeated calls for the same ``<target>`` will append items in the order called. Projects should generally avoid using ``PUBLIC`` or ``INTERFACE`` for targets that will be :ref:`exported <install(EXPORT)>`, or they should at least use -the ``$<BUILD_INTERFACE:...>`` generator expression to prevent precompile +the :genex:`$<BUILD_INTERFACE:...>` generator expression to prevent precompile headers from appearing in an installed exported target. Consumers of a target should typically be in control of what precompile headers they use, not have precompile headers forced on them by the targets being consumed (since @@ -74,7 +74,7 @@ Arguments to ``target_precompile_headers()`` may use "generator expressions" with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. -The ``$<COMPILE_LANGUAGE:...>`` generator expression is particularly +The :genex:`$<COMPILE_LANGUAGE:...>` generator expression is particularly useful for specifying a language-specific header to precompile for only one language (e.g. ``CXX`` and not ``C``). In this case, header file names that are not explicitly in double quotes or angle brackets diff --git a/Help/command/target_sources.rst b/Help/command/target_sources.rst index 653b8d7c53..520614a17b 100644 --- a/Help/command/target_sources.rst +++ b/Help/command/target_sources.rst @@ -12,27 +12,37 @@ Add sources to a target. [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]) 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 +The named ``<target>`` must have been created by a command such as +:command:`add_executable` or :command:`add_library` or +:command:`add_custom_target` and must not be an :ref:`ALIAS target <Alias Targets>`. +.. versionchanged:: 3.13 + Relative source file paths are interpreted as being relative to the current + source directory (i.e. :variable:`CMAKE_CURRENT_SOURCE_DIR`). + See policy :policy:`CMP0076`. + +.. versionadded:: 3.20 + ``<target>`` can be a custom target. + The ``INTERFACE``, ``PUBLIC`` and ``PRIVATE`` keywords are required to specify the scope of the items following them. ``PRIVATE`` and ``PUBLIC`` items will populate the :prop_tgt:`SOURCES` property of ``<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.) +when building dependents. The following arguments specify sources. Repeated calls for the same -``<target>`` append items in the order called. +``<target>`` append items in the order called. The targets created by +:command:`add_custom_target` can only have ``PRIVATE`` scope. + +.. versionadded:: 3.3 + Allow exporting targets with :prop_tgt:`INTERFACE_SOURCES`. + +.. versionadded:: 3.11 + Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets <Imported Targets>`. Arguments to ``target_sources`` may use "generator expressions" with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. See the :manual:`cmake-buildsystem(7)` manual for more on defining buildsystem properties. - -See also the :policy:`CMP0076` policy for older behavior related to the -handling of relative source file paths. diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst index 323077af1d..06da910ddf 100644 --- a/Help/command/try_compile.rst +++ b/Help/command/try_compile.rst @@ -19,6 +19,10 @@ Try Compiling Whole Projects Try building a project. The success or failure of the ``try_compile``, i.e. ``TRUE`` or ``FALSE`` respectively, is returned in ``<resultVar>``. +.. versionadded:: 3.14 + The name of the ``<resultVar>`` is defined by the user. Previously, it had + a fixed name ``RESULT_VAR``. + In this form, ``<srcdir>`` should contain a complete CMake project with a ``CMakeLists.txt`` file and all sources. The ``<bindir>`` and ``<srcdir>`` will not be deleted after this command is run. Specify ``<targetName>`` to @@ -47,6 +51,10 @@ Try building an executable or static library from one or more source files variable). The success or failure of the ``try_compile``, i.e. ``TRUE`` or ``FALSE`` respectively, is returned in ``<resultVar>``. +.. versionadded:: 3.14 + The name of the ``<resultVar>`` is defined by the user. Previously, it had + a fixed name ``RESULT_VAR``. + In this form, one or more source files must be provided. If :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` is unset or is set to ``EXECUTABLE``, the sources must include a definition for ``main`` and CMake will create a @@ -94,6 +102,8 @@ The options are: given to the ``CMAKE_FLAGS`` option will be ignored. ``LINK_OPTIONS <options>...`` + .. versionadded:: 3.14 + Specify link step options to pass to :command:`target_link_options` or to set the :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property in the generated project, depending on the :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` variable. @@ -102,17 +112,23 @@ The options are: Store the output from the build process in the given variable. ``<LANG>_STANDARD <std>`` + .. versionadded:: 3.8 + Specify the :prop_tgt:`C_STANDARD`, :prop_tgt:`CXX_STANDARD`, :prop_tgt:`OBJC_STANDARD`, :prop_tgt:`OBJCXX_STANDARD`, or :prop_tgt:`CUDA_STANDARD` target property of the generated project. ``<LANG>_STANDARD_REQUIRED <bool>`` + .. versionadded:: 3.8 + Specify the :prop_tgt:`C_STANDARD_REQUIRED`, :prop_tgt:`CXX_STANDARD_REQUIRED`, :prop_tgt:`OBJC_STANDARD_REQUIRED`, :prop_tgt:`OBJCXX_STANDARD_REQUIRED`,or :prop_tgt:`CUDA_STANDARD_REQUIRED` target property of the generated project. ``<LANG>_EXTENSIONS <bool>`` + .. versionadded:: 3.8 + Specify the :prop_tgt:`C_EXTENSIONS`, :prop_tgt:`CXX_EXTENSIONS`, :prop_tgt:`OBJC_EXTENSIONS`, :prop_tgt:`OBJCXX_EXTENSIONS`, or :prop_tgt:`CUDA_EXTENSIONS` target property of the generated project. @@ -131,24 +147,26 @@ the try_compile call of interest, and then re-run cmake again with Other Behavior Settings ^^^^^^^^^^^^^^^^^^^^^^^ -If set, the following variables are passed in to the generated -try_compile CMakeLists.txt to initialize compile target properties with -default values: +.. versionadded:: 3.4 + If set, the following variables are passed in to the generated + try_compile CMakeLists.txt to initialize compile target properties with + default values: -* :variable:`CMAKE_CUDA_RUNTIME_LIBRARY` -* :variable:`CMAKE_ENABLE_EXPORTS` -* :variable:`CMAKE_LINK_SEARCH_START_STATIC` -* :variable:`CMAKE_LINK_SEARCH_END_STATIC` -* :variable:`CMAKE_MSVC_RUNTIME_LIBRARY` -* :variable:`CMAKE_POSITION_INDEPENDENT_CODE` + * :variable:`CMAKE_CUDA_RUNTIME_LIBRARY` + * :variable:`CMAKE_ENABLE_EXPORTS` + * :variable:`CMAKE_LINK_SEARCH_START_STATIC` + * :variable:`CMAKE_LINK_SEARCH_END_STATIC` + * :variable:`CMAKE_MSVC_RUNTIME_LIBRARY` + * :variable:`CMAKE_POSITION_INDEPENDENT_CODE` -If :policy:`CMP0056` is set to ``NEW``, then -:variable:`CMAKE_EXE_LINKER_FLAGS` is passed in as well. + If :policy:`CMP0056` is set to ``NEW``, then + :variable:`CMAKE_EXE_LINKER_FLAGS` is passed in as well. -If :policy:`CMP0083` is set to ``NEW``, then in order to obtain correct -behavior at link time, the ``check_pie_supported()`` command from the -:module:`CheckPIESupported` module must be called before using the -:command:`try_compile` command. +.. versionchanged:: 3.14 + If :policy:`CMP0083` is set to ``NEW``, then in order to obtain correct + behavior at link time, the ``check_pie_supported()`` command from the + :module:`CheckPIESupported` module must be called before using the + :command:`try_compile` command. The current settings of :policy:`CMP0065` and :policy:`CMP0083` are propagated through to the generated test project. @@ -156,37 +174,41 @@ through to the generated test project. Set the :variable:`CMAKE_TRY_COMPILE_CONFIGURATION` variable to choose a build configuration. -Set the :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` variable to specify -the type of target used for the source file signature. - -Set the :variable:`CMAKE_TRY_COMPILE_PLATFORM_VARIABLES` variable to specify -variables that must be propagated into the test project. This variable is -meant for use only in toolchain files and is only honored by the -``try_compile()`` command for the source files form, not when given a whole -project. - -If :policy:`CMP0067` is set to ``NEW``, or any of the ``<LANG>_STANDARD``, -``<LANG>_STANDARD_REQUIRED``, or ``<LANG>_EXTENSIONS`` options are used, -then the language standard variables are honored: - -* :variable:`CMAKE_C_STANDARD` -* :variable:`CMAKE_C_STANDARD_REQUIRED` -* :variable:`CMAKE_C_EXTENSIONS` -* :variable:`CMAKE_CXX_STANDARD` -* :variable:`CMAKE_CXX_STANDARD_REQUIRED` -* :variable:`CMAKE_CXX_EXTENSIONS` -* :variable:`CMAKE_OBJC_STANDARD` -* :variable:`CMAKE_OBJC_STANDARD_REQUIRED` -* :variable:`CMAKE_OBJC_EXTENSIONS` -* :variable:`CMAKE_OBJCXX_STANDARD` -* :variable:`CMAKE_OBJCXX_STANDARD_REQUIRED` -* :variable:`CMAKE_OBJCXX_EXTENSIONS` -* :variable:`CMAKE_CUDA_STANDARD` -* :variable:`CMAKE_CUDA_STANDARD_REQUIRED` -* :variable:`CMAKE_CUDA_EXTENSIONS` - -Their values are used to set the corresponding target properties in -the generated project (unless overridden by an explicit option). - -For the :generator:`Green Hills MULTI` generator the GHS toolset and target -system customization cache variables are also propagated into the test project. +.. versionadded:: 3.6 + Set the :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` variable to specify + the type of target used for the source file signature. + +.. versionadded:: 3.6 + Set the :variable:`CMAKE_TRY_COMPILE_PLATFORM_VARIABLES` variable to specify + variables that must be propagated into the test project. This variable is + meant for use only in toolchain files and is only honored by the + ``try_compile()`` command for the source files form, not when given a whole + project. + +.. versionchanged:: 3.8 + If :policy:`CMP0067` is set to ``NEW``, or any of the ``<LANG>_STANDARD``, + ``<LANG>_STANDARD_REQUIRED``, or ``<LANG>_EXTENSIONS`` options are used, + then the language standard variables are honored: + + * :variable:`CMAKE_C_STANDARD` + * :variable:`CMAKE_C_STANDARD_REQUIRED` + * :variable:`CMAKE_C_EXTENSIONS` + * :variable:`CMAKE_CXX_STANDARD` + * :variable:`CMAKE_CXX_STANDARD_REQUIRED` + * :variable:`CMAKE_CXX_EXTENSIONS` + * :variable:`CMAKE_OBJC_STANDARD` + * :variable:`CMAKE_OBJC_STANDARD_REQUIRED` + * :variable:`CMAKE_OBJC_EXTENSIONS` + * :variable:`CMAKE_OBJCXX_STANDARD` + * :variable:`CMAKE_OBJCXX_STANDARD_REQUIRED` + * :variable:`CMAKE_OBJCXX_EXTENSIONS` + * :variable:`CMAKE_CUDA_STANDARD` + * :variable:`CMAKE_CUDA_STANDARD_REQUIRED` + * :variable:`CMAKE_CUDA_EXTENSIONS` + + Their values are used to set the corresponding target properties in + the generated project (unless overridden by an explicit option). + +.. versionchanged:: 3.14 + For the :generator:`Green Hills MULTI` generator the GHS toolset and target + system customization cache variables are also propagated into the test project. diff --git a/Help/command/try_run.rst b/Help/command/try_run.rst index d401ebe929..404de985de 100644 --- a/Help/command/try_run.rst +++ b/Help/command/try_run.rst @@ -20,6 +20,7 @@ Try Compiling and Running Source Files [COMPILE_OUTPUT_VARIABLE <var>] [RUN_OUTPUT_VARIABLE <var>] [OUTPUT_VARIABLE <var>] + [WORKING_DIRECTORY <var>] [ARGS <args>...]) Try compiling a ``<srcfile>``. Returns ``TRUE`` or ``FALSE`` for success @@ -29,6 +30,11 @@ executable was built, but failed to run, then ``<runResultVar>`` will be set to ``FAILED_TO_RUN``. See the :command:`try_compile` command for information on how the test project is constructed to build the source file. +.. versionadded:: 3.14 + The names of the result variables ``<runResultVar>`` and + ``<compileResultVar>`` are defined by the user. Previously, they had + fixed names ``RUN_RESULT_VAR`` and ``COMPILE_RESULT_VAR``. + The options are: ``CMAKE_FLAGS <flags>...`` @@ -46,6 +52,8 @@ The options are: Report the compile step build output in a given variable. ``LINK_LIBRARIES <libs>...`` + .. versionadded:: 3.2 + Specify libraries to be linked in the generated project. The list of libraries may refer to system libraries and to :ref:`Imported Targets <Imported Targets>` from the calling project. @@ -54,6 +62,8 @@ The options are: given to the ``CMAKE_FLAGS`` option will be ignored. ``LINK_OPTIONS <options>...`` + .. versionadded:: 3.14 + Specify link step options to pass to :command:`target_link_options` in the generated project. @@ -65,6 +75,12 @@ The options are: ``RUN_OUTPUT_VARIABLE <var>`` Report the output from running the executable in a given variable. +``WORKING_DIRECTORY <var>`` + .. versionadded:: 3.20 + + Run the executable in the given directory. If no ``WORKING_DIRECTORY`` is + specified, the executable will run in ``<bindir>``. + Other Behavior Settings ^^^^^^^^^^^^^^^^^^^^^^^ @@ -74,6 +90,10 @@ a build configuration. Behavior when Cross Compiling ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. versionadded:: 3.3 + Use ``CMAKE_CROSSCOMPILING_EMULATOR`` when running cross-compiled + binaries. + When cross compiling, the executable compiled in the first step usually cannot be run on the build host. The ``try_run`` command checks the :variable:`CMAKE_CROSSCOMPILING` variable to detect whether CMake is in |