diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0144.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0144.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..81e622af1157ff82a0a655a4d004f6615aabbf88 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0144.rst.txt @@ -0,0 +1,25 @@ +CMP0144 +------- + +.. versionadded:: 3.27 + +:command:`find_package` uses upper-case ``_ROOT`` variables. + +In CMake 3.27 and above the :command:`find_package()` command now +searches prefixes specified by the upper-case :variable:`_ROOT` +CMake variable and the :envvar:`_ROOT` environment variable +in addition to the case-preserved :variable:`_ROOT` and +:envvar:`_ROOT` variables used since policy :policy:`CMP0074`. +This policy provides compatibility with projects that have not been +updated to avoid using ``_ROOT`` variables for other purposes. + +The ``OLD`` behavior for this policy is to ignore ``_ROOT`` +variables if the original ```` has lower-case characters. +The ``NEW`` behavior for this policy is to use ``_ROOT`` +variables. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0145.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0145.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9b0d43f22bee550fe7724b0d2fb42d75decf3324 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0145.rst.txt @@ -0,0 +1,29 @@ +CMP0145 +------- + +.. versionadded:: 3.27 + +The :module:`Dart` and :module:`FindDart` modules are removed. + +These modules were added very early in CMake's development to support +driving tests with a "DART" tool, but DART has not been distributed or +maintained for many years. Projects would ``include(Dart)`` to use it, +and the ``Dart`` module would run ``find_package(Dart)`` internally. +Since :manual:`ctest(1)` was created, the ``Dart`` module has just been +a compatibility shim that finds ``Dart`` to support some legacy +functionality and then forwards to the :module:`CTest` module. + +CMake 3.27 and above prefer to not provide the :module:`Dart` or +:module:`FindDart` modules. This policy provides compatibility for +projects that have not been ported away from them. Projects using the +``Dart`` module should be updated to use the :module:`CTest` module directly. + +The ``OLD`` behavior of this policy is for ``include(Dart)`` and +``find_package(Dart)`` to load the deprecated modules. The ``NEW`` +behavior is for uses of the modules to fail as if they do not exist. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0146.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0146.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7d6ba191e839cfe016b777d24e96f07b5a99810c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0146.rst.txt @@ -0,0 +1,28 @@ +CMP0146 +------- + +.. versionadded:: 3.27 + +The :module:`FindCUDA` module is removed. + +The :module:`FindCUDA` module has been deprecated since CMake 3.10. +CMake 3.27 and above prefer to not provide the module. +This policy provides compatibility for projects that have not been +ported away from it. + +Projects using the :module:`FindCUDA` module should be updated to use +CMake's first-class ``CUDA`` language support. List ``CUDA`` among the +languages named in the top-level call to the :command:`project` command, +or call the :command:`enable_language` command with ``CUDA``. +Then one can add CUDA (``.cu``) sources directly to targets, +similar to other languages. + +The ``OLD`` behavior of this policy is for ``find_package(CUDA)`` to +load the deprecated module. The ``NEW`` behavior is for uses of the +module to fail as if it does not exist. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0147.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0147.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fd5dc5f9982157e3b67f1945ece876a0f60fc663 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0147.rst.txt @@ -0,0 +1,23 @@ +CMP0147 +------- + +.. versionadded:: 3.27 + +:ref:`Visual Studio Generators` build custom commands in parallel. + +Visual Studio 15.8 (2017) and newer support building custom commands in +parallel. CMake 3.27 and above prefer to enable this behavior by adding +a ``BuildInParallel`` setting to custom commands in ``.vcxproj`` files. +This policy provides compatibility for projects that have not been updated +to expect this, e.g., because their custom commands were accidentally +relying on serial execution by MSBuild. + +The ``OLD`` behavior for this policy is to not add ``BuildInParallel``. +The ``NEW`` behavior for this policy is to add ``BuildInParallel`` for +VS 15.8 and newer. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0148.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0148.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c522c6ab87523559de747653a0d568550e4384cb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0148.rst.txt @@ -0,0 +1,28 @@ +CMP0148 +------- + +.. versionadded:: 3.27 + +The :module:`FindPythonInterp` and :module:`FindPythonLibs` modules are removed. + +These modules have been deprecated since CMake 3.12. +CMake 3.27 and above prefer to not provide the modules. +This policy provides compatibility for projects that have not been +ported away from them. + +Projects using the :module:`FindPythonInterp` and/or :module:`FindPythonLibs` +modules should be updated to use one of their replacements: + +* :module:`FindPython3` +* :module:`FindPython2` +* :module:`FindPython` + +The ``OLD`` behavior of this policy is for ``find_package(PythonInterp)`` +and ``find_package(PythonLibs)`` to load the deprecated modules. The ``NEW`` +behavior is for uses of the modules to fail as if they do not exist. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0149.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0149.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..11e935d04c5e97d6788cc8aed7da4c0bd9727275 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0149.rst.txt @@ -0,0 +1,53 @@ +CMP0149 +------- + +.. versionadded:: 3.27 + +:ref:`Visual Studio Generators` select latest Windows SDK by default. + +Visual Studio Generators select a Windows SDK version to put in the +``WindowsTargetPlatformVersion`` setting in ``.vcxproj`` files. +CMake sets the :variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION` +variable to the selected SDK version. + +Prior to CMake 3.27, the SDK version was always selected by the value of +the :variable:`CMAKE_SYSTEM_VERSION` variable. Users or toolchain files +could set that variable to one of the exact Windows SDK versions available +on the host system. Since :variable:`CMAKE_SYSTEM_VERSION` defaults to +:variable:`CMAKE_HOST_SYSTEM_VERSION`, and it is not guaranteed that a +matching Windows SDK version is available, CMake had to fall back to +using the latest Windows SDK version if no exact match was available. +This approach was problematic: + +* The latest Windows SDK might or might not be selected based on whether + the host version of Windows happens to match an available SDK version. + +* An old Windows SDK version might be selected that has not been updated + for newer language standards such as C11. + +CMake 3.27 and higher prefer to ignore the exact value of +:variable:`CMAKE_SYSTEM_VERSION` and by default select the latest SDK +version available. An exact SDK version may be specified explicitly +using a ``version=`` field in the :variable:`CMAKE_GENERATOR_PLATFORM` +variable. See :ref:`Visual Studio Platform Selection`. + +This policy provides compatibility for projects, toolchain files, and +build scripts that have not been ported away from using +:variable:`CMAKE_SYSTEM_VERSION` to specify an exact SDK version. + +.. note:: + + This policy must be set before the first :command:`project` or + :command:`enable_language` command invocation at the top of the + project. That is when :ref:`Visual Studio Generators` select a + Windows SDK. + +The ``OLD`` behavior for this policy is to use the exact value of +:variable:`CMAKE_SYSTEM_VERSION` if possible. The ``NEW`` behavior +for this policy is to ignore it. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0150.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0150.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e8c58ef3c1ec36515a7b47fa5f0951005f8784ed --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0150.rst.txt @@ -0,0 +1,39 @@ +CMP0150 +------- + +.. versionadded:: 3.27 + +:command:`ExternalProject_Add` and :command:`FetchContent_Declare` commands +treat relative ``GIT_REPOSITORY`` paths as being relative to the parent +project's remote. + +Earlier versions of these commands always treated relative paths in +``GIT_REPOSITORY`` as local paths, but the base directory it was treated +as relative to was both undocumented and unintuitive. The ``OLD`` behavior +for this policy is to interpret relative paths used for ``GIT_REPOSITORY`` +as local paths relative to the following: + +* The parent directory of ``SOURCE_DIR`` for :command:`ExternalProject_Add`. +* ``FETCHCONTENT_BASE_DIR`` for :command:`FetchContent_Declare`. + +The ``NEW`` behavior is to determine the remote from the parent project and +interpret the path relative to that remote. The value of +:variable:`CMAKE_CURRENT_SOURCE_DIR` when :command:`ExternalProject_Add` or +:command:`FetchContent_Declare` is called determines the parent project. +The remote is selected according to the following (the first match is used): + +* If the parent project is checked out on a branch with an upstream remote + defined, use that remote. +* If only one remote is defined, use that remote. +* If multiple remotes are defined and one of them is named ``origin``, use + ``origin``'s remote but also issue a warning. + +If an appropriate remote cannot be determined from the above, a fatal error +will be raised. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 +.. |WARNS_OR_DOES_NOT_WARN| replace:: + warns when a relative path is encountered +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0151.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0151.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..49b081132b25d0fc2e0c862b7ba7776da8cdab7f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0151.rst.txt @@ -0,0 +1,27 @@ +CMP0151 +------- + +.. versionadded:: 3.27 + +AUTOMOC include directory is a system include directory by default. + +Headers generated for :ref:`Qt AUTOMOC` are placed in target-specific include +directories. CMake 3.26 and older added these as normal include directories. +CMake 3.27 and newer prefer to add them as system include directories. +This policy provides compatibility for projects that have not been updated +to expect this. + +If the :prop_tgt:`AUTOGEN_USE_SYSTEM_INCLUDE` target property is set, +perhaps via the :variable:`CMAKE_AUTOGEN_USE_SYSTEM_INCLUDE` variable, +then its value is used regardless of the setting of this policy. + +The ``OLD`` behavior for this policy is to add autogen include directory to +the target's include directories. +The ``NEW`` behavior for this policy is to add autogen include directory to +the target's system include directories. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0152.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0152.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..94109e349488de1e36297168cdaef06c5bb0219a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0152.rst.txt @@ -0,0 +1,21 @@ +CMP0152 +------- + +.. versionadded:: 3.28 + +:command:`file(REAL_PATH)` resolves symlinks before collapsing ../ components. + +In CMake 3.27 and below, :command:`file(REAL_PATH)` collapsed any ``../`` +components in a path before resolving symlinks. This produced incorrect +results when the ``../`` collapsed away a symlink. + +The ``OLD`` behavior for this policy is to collapse ``../`` components before +resolving symlinks. +The ``NEW`` behavior for this policy is to resolve all symlinks before +collapsing ``../`` components. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.28 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0153.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0153.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..838f0824404ebb6fbb89277625ba0f418fe593d6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0153.rst.txt @@ -0,0 +1,14 @@ +CMP0153 +------- + +.. versionadded:: 3.28 + +The :command:`exec_program` command should not be called. + +This command has long been superseded by the :command:`execute_process` +command and has been deprecated since CMake 3.0. + +.. |disallowed_version| replace:: 3.28 +.. include:: DISALLOWED_COMMAND.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0154.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0154.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..89a4f67fb15f6eb8b2f8362f37ffb54c905bb06c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0154.rst.txt @@ -0,0 +1,58 @@ +CMP0154 +------- + +.. versionadded:: 3.28 + +Generated files are private by default in targets using :ref:`file sets`. + +CMake 3.27 and below assume that any file generated as an output or byproduct +of :command:`add_custom_command` or :command:`add_custom_target` may be a +public header file meant for inclusion by dependents' source files. This +requires :ref:`Ninja Generators` to add conservative order-only dependencies +that prevent a target's source files from compiling before custom commands +from the target's dependencies are finished, even if those custom commands +only produce sources private to their own target. + +:ref:`File Sets`, introduced by CMake 3.23, provide a way to express the +visibility of generated header files. CMake 3.28 and above prefer to +assume that, in targets using file sets, generated files are private to +their own target by default. Generated public headers must be specified +as members of a ``PUBLIC`` (or ``INTERFACE``) ``FILE_SET``, typically of +type ``HEADERS``. With this information, :ref:`Ninja Generators` may omit +the above-mentioned conservative dependencies and produce more efficient +build graphs. + +Additionally, if the custom command's output is a member of a file set of type +``CXX_MODULES``, it will additionally not be required to exist before +compiling other sources in the same target. Since these files should not be +included at compile time directly, they may not be implicitly required to +exist for other compilation rules. + +This policy provides compatibility for projects using file sets in targets +with generated header files that have not been updated. Such projects +should be updated to express generated public headers in a file set. +For example: + +.. code-block:: cmake + + add_custom_command( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/foo.h + ... + ) + target_sources(foo + PUBLIC FILE_SET HEADERS + BASE_DIRS ${CMAKE_CURRENT_BINARY_DIR} + FILES ${CMAKE_CURRENT_BINARY_DIR}/foo.h + ) + +The ``OLD`` behavior for this policy is to assume generated files are +public, even in targets using file sets, and for :ref:`Ninja Generators` +to produce conservative build graphs. The ``NEW`` behavior for this +policy is to assume generated files are private in targets using file sets, +and for :ref:`Ninja Generators` to produce more efficient build graphs. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.28 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0155.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0155.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5397c0d6e088eec2b78b25236cab90e0472c2f99 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0155.rst.txt @@ -0,0 +1,27 @@ +CMP0155 +------- + +.. versionadded:: 3.28 + +C++ sources in targets with at least C++20 are scanned for imports +when supported. + +CMake 3.27 and below assume that C++ sources do not ``import`` modules. +CMake 3.28 and above prefer to assume that C++ sources in targets using C++20 +or higher might ``import`` modules, and must be scanned before compiling, +unless explicitly disabled. This policy provides compatibility for projects +that use C++20 or higher, without modules, that have not been updated to turn +off scanning, e.g., via the :variable:`CMAKE_CXX_SCAN_FOR_MODULES` variable. +See the :manual:`cmake-cxxmodules(7)` manual for more details on C++ module +support. + +The ``OLD`` behavior for this policy is to assume that C++ 20 and newer +sources do not import modules. The ``NEW`` behavior for this policy is to +assume that C++ 20 and newer files may import modules if the compiler +understands how to scan for their dependencies, and need to be scanned. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.28 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0156.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0156.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7956742ae45a7ed2f79dc2d6a57e78e85212a1ce --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0156.rst.txt @@ -0,0 +1,51 @@ +CMP0156 +------- + +.. versionadded:: 3.29 + +De-duplicate libraries on link lines based on linker capabilities. + +Traditional linkers maintain a set of undefined symbols during linking. The +linker processes each file in the order in which it appears on the command +line, until the set of undefined symbols becomes empty. An object file is +linked into the output object when it is encountered, with its undefined +symbols added to the set. Upon encountering an archive file a traditional +linker searches the objects contained therein, and processes those that satisfy +symbols in the unresolved set. + +Handling mutually dependent archives may be awkward when using a traditional +linker. Archive files may have to be specified multiple times. + +Some linkers (for instance Apple or Windows linkers, as well as ``LLVM LLD``) +record all symbols found in objects and archives as they iterate over command +line arguments. When one of these linkers encounters an undefined symbol that +can be resolved by an object file contained in a previously processed archive +file, it immediately extracts and links it into the output object. + +CMake 3.28 and below may generate link lines that repeat static libraries as +a traditional linker would need, even when using a linker that does not need it. +They may also de-duplicate shared libraries by keeping their last occurrence, +which on Windows platforms can change DLL load order. + +CMake 3.29 and above prefer to apply different strategies based on linker +capabilities. So, when targeting Apple and Windows platforms, all +libraries are de-duplicated. Moreover, on Windows platforms, libraries +are de-duplicated by keeping their first occurrence, thus respecting the +project-specified order. This policy provides compatibility with projects +that have not been updated to expect the latter behavior. + +.. note:: + + When this policy is set to ``NEW``, the policy :policy:`CMP0179` controls + which occurrence of the static libraries is kept when they are de-duplicated. + +The ``OLD`` behavior for this policy is to always repeat static libraries +as if using a traditional linker, and always de-duplicate shared libraries +by keeping the last occurrence of each. The ``NEW`` behavior for this policy +is to apply different strategies based on linker capabilities. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0157.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0157.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c607203993174a96869761c09bd47657294f51c0 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0157.rst.txt @@ -0,0 +1,47 @@ +CMP0157 +------- + +.. versionadded:: 3.29 + +Swift compilation mode is selected by an abstraction. + +The Swift compiler can compile modules in different modes. The desired build +mode depends whether the developer is iterating and wants to incrementally make +changes, or if they are building a release for distribution and want more +optimizations applied to the resulting binary. + +CMake versions 3.26 through 3.28 build Swift binaries with whole-module +optimizations enabled when configured in a non-debug build type. +For CMake versions earlier than 3.26, the developer needs to specify +the necessary flag manually for the :ref:`Ninja Generators`, and cannot +not specify whole-module optimizations to the :generator:`Xcode` generator. + +CMake versions 3.29 and above prefer to set the compilation mode using +the :prop_tgt:`Swift_COMPILATION_MODE` target property, which can be +initialized by the :variable:`CMAKE_Swift_COMPILATION_MODE` variable. + +This policy provides compatibility for projects that have not been updated. +The policy setting takes effect as of the first :command:`project` or +:command:`enable_language` command that enables the ``Swift`` language. + +.. note:: + + Once the policy has taken effect at the top of a project, that choice + must be used throughout the tree. In projects that have nested projects + in subdirectories, be sure to convert everything together. + +The ``OLD`` behavior for this policy builds all Swift targets in +``wholemodule`` mode for non-debug configurations. :ref:`Ninja Generators` +prepend the ``-wmo`` flag to the default set of Swift flags. +The :generator:`Xcode` generator sets the ``SWIFT_COMPILATION_MODE`` +attribute to ``wholemodule`` in the generated Xcode project file. + +The ``NEW`` behavior for this policy is to apply the compilation mode specified +in the :prop_tgt:`Swift_COMPILATION_MODE` target property, initialized as each +target is created by the :variable:`CMAKE_Swift_COMPILATION_MODE` variable. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0158.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0158.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..66e5a6294477b16c03493d327a0cb589c523da98 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0158.rst.txt @@ -0,0 +1,28 @@ +CMP0158 +------- + +.. versionadded:: 3.29 + +:command:`add_test` honors :variable:`CMAKE_CROSSCOMPILING_EMULATOR` only +when :variable:`cross-compiling `. + +In CMake 3.28 and below, :command:`add_test` unconditionally used the +:prop_tgt:`CROSSCOMPILING_EMULATOR` target property (initialized by the +:variable:`CMAKE_CROSSCOMPILING_EMULATOR` variable) to run test commands +naming executable targets. CMake 3.29 and above prefer to use the emulator +only when the :variable:`CMAKE_CROSSCOMPILING` variable is enabled. The +:variable:`CMAKE_TEST_LAUNCHER` variable may be used instead when not +cross-compiling. This policy provides compatibility for projects that +have not been updated. + +The ``OLD`` behavior for this policy is for :command:`add_test` to use +the :prop_tgt:`CROSSCOMPILING_EMULATOR` target property unconditionally. +The ``NEW`` behavior for this policy is for :command:`add_test` to use +the :prop_tgt:`CROSSCOMPILING_EMULATOR` target property only when +:variable:`cross-compiling `. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0159.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0159.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..908ef0f414c4f73d253ce6e39da7231a160a1002 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0159.rst.txt @@ -0,0 +1,23 @@ +CMP0159 +------- + +.. versionadded:: 3.29 + +:command:`file(STRINGS)` with ``REGEX`` updates :variable:`CMAKE_MATCH_`. + +In CMake 3.28 and below the :command:`file(STRINGS)` command's ``REGEX`` +option does not affect :variable:`CMAKE_MATCH_` variables. CMake 3.29 +and above prefer to update the :variable:`CMAKE_MATCH_` variables using +captures from the last match in the file, similar to the +:command:`string(REGEX MATCHALL)` command. This policy provides +compatibility for projects that have not been updated to expect the behavior. + +The ``OLD`` behavior for this policy is for :command:`file(STRINGS)` with +``REGEX`` to not store capture groups in :variable:`CMAKE_MATCH_` +variables. The ``NEW`` behavior is to store the capture groups. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0160.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0160.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..46318aba96c63cb9d3d0154cf4a06345da5ad493 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0160.rst.txt @@ -0,0 +1,39 @@ +CMP0160 +------- + +.. versionadded:: 3.29 + +More read-only target properties now error when trying to set them. + +The :command:`set_target_properties` and :command:`set_property` commands +are intended to error out on all read-only properties. However, CMake 3.28 and +below only did this for the following properties: + +* :prop_tgt:`HEADER_SETS` +* :prop_tgt:`INTERFACE_HEADER_SETS` +* :prop_tgt:`IMPORTED_GLOBAL` +* :prop_tgt:`MANUALLY_ADDED_DEPENDENCIES` +* :prop_tgt:`NAME` +* :prop_tgt:`TYPE` + +This policy enforces the read-only nature of the following target properties: + +* :prop_tgt:`ALIAS_GLOBAL` +* :prop_tgt:`BINARY_DIR` +* :prop_tgt:`CXX_MODULE_SETS` +* :prop_tgt:`IMPORTED` +* :prop_tgt:`INTERFACE_CXX_MODULE_SETS` +* :prop_tgt:`LOCATION` +* :prop_tgt:`LOCATION_` +* :prop_tgt:`SOURCE_DIR` + +The ``OLD`` behavior for this policy is to only error out for the properties +:prop_tgt:`MANUALLY_ADDED_DEPENDENCIES`, :prop_tgt:`NAME`, and :prop_tgt:`TYPE`. +The ``NEW`` behavior for this policy is to error out on all target properties +that are documented as read-only. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0161.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0161.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..34bb64c5351e9d5b8edea987e88625fa46972143 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0161.rst.txt @@ -0,0 +1,36 @@ +CMP0161 +------- + +.. versionadded:: 3.29 + +The :variable:`CPACK_PRODUCTBUILD_DOMAINS` variable defaults to true. + +Before CMake 3.29, the :variable:`CPACK_PRODUCTBUILD_DOMAINS` variable is +unset by default. When using the :cpack_gen:`CPack productbuild Generator`, +this disables the use of the ``domains`` attribute in the productbuild +Distribution XML, and falls back to the ``auth`` attribute instead. +These attributes control where a productbuild package is allowed to be +installed. But the ``auth`` attribute has been deprecated by Apple, +so projects should migrate to using ``domains`` instead. + +CMake 3.29 and above prefer to use a default value of true for +:variable:`CPACK_PRODUCTBUILD_DOMAINS`, which means ``domains`` will be used +by default unless the project explicitly sets +:variable:`CPACK_PRODUCTBUILD_DOMAINS` to false. +This policy provides compatibility with projects that enabled the +:cpack_gen:`CPack productbuild Generator`, but did not explicitly set +:variable:`CPACK_PRODUCTBUILD_DOMAINS`. + +The ``OLD`` behavior for this policy is to leave +:variable:`CPACK_PRODUCTBUILD_DOMAINS` unset if it hasn't been set. +The ``NEW`` behavior for this policy is to use a default value of true for +:variable:`CPACK_PRODUCTBUILD_DOMAINS`. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt +Note that a warning will only be emitted if the +:variable:`CPACK_BINARY_PRODUCTBUILD >` variable is +set to true and the project is being built for an Apple platform. + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0162.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0162.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..df46d968e8a8e94aef82c20063a791ae7dfb626a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0162.rst.txt @@ -0,0 +1,47 @@ +CMP0162 +------- + +.. versionadded:: 3.30 + +:ref:`Visual Studio Generators` add ``UseDebugLibraries`` indicators by default. + +The "Use Debug Libraries" setting in Visual Studio projects indicates what +configurations are considered debug configurations. In standalone projects, +this may affect MSBuild's default selection of MSVC runtime library, +optimization flags, runtime checks, and similar settings. CMake typically +generates all those settings explicitly based on the project's specification, +so CMake 3.29 and below do not write any ``UseDebugLibraries`` indicators to +``.vcxproj`` files. + +CMake 3.30 and above prefer to write ``UseDebugLibraries`` indicators because +they are useful for reference by both humans and tools, and may also affect +the behavior of platform-specific SDKs. The indicator for each configuration +of a target is determined as follows: + +* If the target compiles sources for a known MSVC runtime library + (such as that specified by :prop_tgt:`MSVC_RUNTIME_LIBRARY`), + then ``UseDebugLibraries`` is ``true`` for configurations that + compile for a "Debug" runtime library, and ``false`` for others. + +* Otherwise, such as in targets created by :command:`add_custom_target`, + ``UseDebugLibraries`` is ``true`` for the ``Debug`` configuration, + and ``false`` for others. + +This policy provides compatibility for projects that have not been updated to +expect the indicators. The policy setting is recorded by each target as it is +created and used to determine the default behavior for that target's +``.vcxproj`` file. + +The ``OLD`` behavior for this policy is to not generate ``UseDebugLibraries`` +indicators by default. The ``NEW`` behavior for this policy is to generate +``UseDebugLibraries`` indicators by default. + +If the :variable:`CMAKE_VS_USE_DEBUG_LIBRARIES` variable and/or +:prop_tgt:`VS_USE_DEBUG_LIBRARIES` target property is set, it explicitly +controls ``UseDebugLibraries`` generation regardless of this policy. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0163.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0163.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..40b353508568f0ef94e1c27978ec26749f036bf5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0163.rst.txt @@ -0,0 +1,37 @@ +CMP0163 +------- + +.. versionadded:: 3.30 + +The :prop_sf:`GENERATED` source file property is now visible in all directories. + +In CMake 3.29 and below, the :prop_sf:`GENERATED` source file property, +like other source file properties, was scoped in every directory separately. +Although policy :policy:`CMP0118` allowed sources marked ``GENERATED`` in one +directory to be used in other directories without manually marking them as +``GENERATED`` again, the ``GENERATED`` property was still not visible to +:command:`get_property` and :command:`get_source_file_property` calls. + +Whether or not a source file is generated is an all-or-nothing global +property of the source: a source is either generated or it is not. +CMake 3.30 and above prefer to treat the :prop_sf:`GENERATED` source file +property as globally scoped. Once it is set in one directory, it is +immediately visible to :command:`get_property` and +:command:`get_source_file_property` calls in other directories. +This policy provides compatibility for projects that have not been +updated for this behavior. + +The ``OLD`` behavior of this policy is for the ``GENERATED`` source file +property to be visible only in the directories in which it is set. The +``NEW`` behavior of this policy is to allow the ``GENERATED`` source file +property to be visible in all directories once set in any directory. +Furthermore, the ``NEW`` behavior of this policy implies the ``NEW`` +behavior of policy :policy:`CMP0118`: the ``GENERATED`` property may +be set only to boolean values, and may not be turned off once turned on. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 +.. |WARNS_OR_DOES_NOT_WARN| replace:: + does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0164.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0164.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9702cc24c34b3df46fda7c763298a13d704b5305 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0164.rst.txt @@ -0,0 +1,31 @@ +CMP0164 +------- + +.. versionadded:: 3.30 + +:command:`add_library` rejects ``SHARED`` libraries when not supported by +the platform. + +In CMake 3.29 and below, on platforms that do not support shared libraries +(:prop_gbl:`TARGET_SUPPORTS_SHARED_LIBS` is false), the +:command:`add_library` command automatically converts ``SHARED`` libraries to +``STATIC`` libraries to help users build projects on such platforms. However, +the semantics of shared and static libraries are different enough that such +automatic conversion cannot work in general. Projects using shared libraries +need to be ported to such platforms on a case-by-case basis. + +In CMake 3.30 and above, :command:`add_library` prefers to reject creation +of shared libraries on platforms that do not support them, and fail with a +fatal error message. This policy provides compatibility for projects that +happened to work with the automatic conversion to static libraries and have +not been updated with an explicit port. + +The ``OLD`` behavior for this policy is to implicitly create a static +library with a developer warning. The ``NEW`` behavior for this policy is +to fail. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn about the behavior change +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0165.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0165.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7a79c44ea9fd9dd505e95ac36d236b006f5b1e52 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0165.rst.txt @@ -0,0 +1,26 @@ +CMP0165 +------- + +.. versionadded:: 3.30 + +:command:`enable_language` must not be called before :command:`project`. + +In CMake 3.29 and below, if a project called :command:`enable_language` +before the first call to :command:`project`, the language would be enabled +but possibly using unset details that were expected to be set. +In CMake 3.30 and above, :command:`enable_language` prefers to reject this +case and stop with a fatal error instead if it detects that :command:`project` +has not yet been called. This policy provides compatibility for projects that +happened to work when :command:`enable_language` was called before +:command:`project` and have not been updated to call these commands in the +required order. + +The ``OLD`` behavior for this policy is to allow :command:`enable_language` +to be called before :command:`project`. The ``NEW`` behavior for this policy +is to fail with a fatal error in such cases. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0166.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0166.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..053455943006f11e3d84dad69696a26e37981b1e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0166.rst.txt @@ -0,0 +1,40 @@ +CMP0166 +------- + +.. versionadded:: 3.30 + +:genex:`TARGET_PROPERTY` evaluates link properties transitively over private +dependencies of static libraries. + +In CMake 3.29 and below, the :genex:`TARGET_PROPERTY` generator expression +evaluates properties :prop_tgt:`INTERFACE_LINK_OPTIONS`, +:prop_tgt:`INTERFACE_LINK_DIRECTORIES`, and :prop_tgt:`INTERFACE_LINK_DEPENDS` +as if they were :ref:`Transitive Compile Properties` rather than +:ref:`Transitive Link Properties`, even when policy :policy:`CMP0099` is +set to ``NEW``. Private dependencies of static libraries, which appear in +their :prop_tgt:`INTERFACE_LINK_LIBRARIES` guarded by :genex:`LINK_ONLY` +generator expressions, are not followed. This is inconsistent with +evaluation of the same target properties during buildsystem generation. + +CMake 3.30 and above prefer that :genex:`TARGET_PROPERTY` evaluates +properties :prop_tgt:`INTERFACE_LINK_OPTIONS`, +:prop_tgt:`INTERFACE_LINK_DIRECTORIES`, and :prop_tgt:`INTERFACE_LINK_DEPENDS` +as :ref:`Transitive Link Properties` such that private dependencies of static +libraries, which appear in their :prop_tgt:`INTERFACE_LINK_LIBRARIES` guarded +by :genex:`LINK_ONLY` generator expressions, are followed. +This policy provides compatibility for projects that have not been updated +to expect the new behavior. + +The ``OLD`` behavior for this policy is for :genex:`TARGET_PROPERTY` to +evaluate properties :prop_tgt:`INTERFACE_LINK_OPTIONS`, +:prop_tgt:`INTERFACE_LINK_DIRECTORIES`, and :prop_tgt:`INTERFACE_LINK_DEPENDS` +as if they were :ref:`Transitive Compile Properties` by not following private +dependencies of static libraries. The ``NEW`` behavior for this policy is +to evaluate them as :ref:`Transitive Link Properties` by following private +dependencies of static libraries. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0167.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0167.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..763ef6909e7a4f23d0de9c5c6bd69317b214ae2d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0167.rst.txt @@ -0,0 +1,28 @@ +CMP0167 +------- + +.. versionadded:: 3.30 + +The :module:`FindBoost` module is removed. + +CMake 3.29 and below provide a ``FindBoost`` module, but it needs constant +updates to keep up with upstream Boost releases. Upstream Boost 1.70 +and above provide a ``BoostConfig.cmake`` package configuration file. +``find_package(Boost CONFIG)`` finds the upstream package directly, +without the find module. + +CMake 3.30 and above prefer to not provide the ``FindBoost`` module +so that ``find_package(Boost)`` calls, without the ``CONFIG`` or +``NO_MODULE`` options, find the upstream ``BoostConfig.cmake`` directly. +This policy provides compatibility for projects that have not been ported +to use the upstream Boost package. + +The ``OLD`` behavior of this policy is for ``find_package(Boost)`` to +load CMake's :module:`FindBoost` module. The ``NEW`` behavior is for +``find_package(Boost)`` to search for the upstream ``BoostConfig.cmake``. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0168.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0168.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..cab40b9d85a1f040ba9db07ae6f62eb4e063b040 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0168.rst.txt @@ -0,0 +1,72 @@ +CMP0168 +------- + +.. versionadded:: 3.30 + +The :module:`FetchContent` module implements steps directly instead of through +a sub-build. + +CMake 3.29 and below implement FetchContent as a separate sub-build. +This required configuring that separate project and using a build tool. +This approach can be very slow with some generators and operating systems. +CMake 3.30 and above prefer to implement the download, update, and patch +steps directly as part of the main project. + +The ``NEW`` behavior has the following characteristics: + +* No sub-build is used. All operations are implemented directly from the + main project's CMake configure step. When running in CMake script mode, + no build tool needs to be available. +* Generator expressions and GNU Make variables of the form ``$(SOMEVAR)`` are + not supported. They should not be used in any argument to + :command:`FetchContent_Declare` or :command:`FetchContent_Populate`. +* All ``LOG_...`` and ``USES_TERMINAL_...`` options, the ``QUIET`` option, and + the :variable:`FETCHCONTENT_QUIET` variable are ignored. + :module:`FetchContent` output is always part of the main project's configure + output. This also means it now respects the message logging level (see + :variable:`CMAKE_MESSAGE_LOG_LEVEL` and + :option:`--log-level `). The default message log level + should be comparable to using ``QUIET`` with the ``OLD`` policy setting, + except that warnings will now be shown. +* The ``PREFIX``, ``TMP_DIR``, ``STAMP_DIR``, ``LOG_DIR``, and ``DOWNLOAD_DIR`` + options and their associated directory properties are ignored. The + :module:`FetchContent` module controls those locations internally. +* :option:`cmake --fresh` will remove the stamp and script files used for + tracking and populating the dependency. This will force the dependency's + download, update, and patch steps to be re-executed. The directory used for + downloads is not affected by :option:`cmake --fresh`, so any previously + downloaded files for the ``URL`` download method can still be re-used. + +The ``OLD`` behavior has the following characteristics: + +* A sub-build is always used to implement the download, update, and patch + steps. A build tool must be available, even when using + :command:`FetchContent_Populate` in CMake script mode. +* Generator expressions and GNU Make variables of the form ``$(SOMEVAR)`` can + be used, although such use is almost always inappropriate. They are evaluated + in the sub-build, so they do not see any information from the main build. +* All logging, terminal control, and directory options related to the download, + update, or patch steps are supported. +* If the ``QUIET`` option is used, or the :variable:`FETCHCONTENT_QUIET` + variable is set to true, warnings will not be shown in the output. +* :option:`cmake --fresh` has no effect on the dependency's stamp or script + files. Previously executed steps will only re-run if details about the + dependency have changed. + +There's a reasonably good chance that users can set the +:variable:`CMAKE_POLICY_DEFAULT_CMP0168 >` +variable to ``NEW`` to globally switch to the ``NEW`` behavior while waiting +for the project and its dependencies to be updated use the ``NEW`` policy +setting by default. Projects don't typically make use of the features that the +``NEW`` behavior no longer supports, and even those projects that do will often +still work fine when those options are ignored. Before setting this behavior +globally, check whether any :command:`FetchContent_Declare` or +:command:`FetchContent_Populate` calls use the ignored options in a way that +would change observable behavior, other than putting temporary or +internally-generated files in different locations. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0169.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0169.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..38b8dcbb4d167c9f21c9897e6b026943d2776dc9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0169.rst.txt @@ -0,0 +1,49 @@ +CMP0169 +------- + +.. versionadded:: 3.30 + +Calling :command:`FetchContent_Populate` with a single argument (the name of +a declared dependency) is deprecated. + +Prior to the introduction of :command:`FetchContent_MakeAvailable`, projects +populated previously declared content (with :command:`FetchContent_Declare`) +using the following pattern: + +.. code-block:: cmake + + FetchContent_GetProperties(depname) + if(NOT depname_POPULATED) + FetchContent_Populate(depname) + add_subdirectory(${depname_SOURCE_DIR} ${depname_BINARY_DIR}) + endif() + +The above pattern does not support a number of features that have been added +to :module:`FetchContent` over time. It ignores options like ``SYSTEM`` and +``EXCLUDE_FROM_ALL`` which may be given to :command:`FetchContent_Declare`, +but can't be made known to the above project code. It also does not support +:ref:`dependency providers `. +Projects should call :command:`FetchContent_MakeAvailable` instead of using +the above pattern. + +CMake 3.30 and above prefers to reject calls to +:command:`FetchContent_Populate` with the name of a declared dependency. +This policy provides compatibility for projects that have not been updated +to call :command:`FetchContent_MakeAvailable` instead. + +The ``OLD`` behavior of this policy allows :command:`FetchContent_Populate` +to be called with the name of a declared dependency. +The ``NEW`` behavior halts with a fatal error in such cases. + +.. note:: + Calling :command:`FetchContent_Populate` with the full population details + as command arguments rather than just a dependency name remains fully + supported. Only the form calling :command:`FetchContent_Populate` with a + single argument (the name of a previously declared dependency) is deprecated + with this policy. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0170.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0170.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9d7860a72b51986c400b2337e5db86cb6ac65db2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0170.rst.txt @@ -0,0 +1,30 @@ +CMP0170 +------- + +.. versionadded:: 3.30 + +When ``FETCHCONTENT_FULLY_DISCONNECTED`` is set to true, +:command:`FetchContent_MakeAvailable` and :command:`FetchContent_Populate` +enforce the constraint that their source directory must already be populated. +The requirement has always been documented, but it was not checked or enforced +with CMake 3.29 or older. This sometimes led to hard-to-trace errors when a +project expected a dependency to have been populated, but its population was +silently skipped. + +CMake 3.30 and above prefers to check and enforce the constraint. +This policy provides compatibility for situations where the user cannot easily +prevent ``FETCHCONTENT_FULLY_DISCONNECTED`` from being inappropriately set +to true. + +The ``OLD`` behavior of this policy allows ``FETCHCONTENT_FULLY_DISCONNECTED`` +to be set to true even if a dependency's source directory has not been +populated. +The ``NEW`` behavior halts with a fatal error if +``FETCHCONTENT_FULLY_DISCONNECTED`` is set to true and a dependency population +would be skipped, but that dependency's source directory doesn't exist. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0171.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0171.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c364bf4a79940783947394dcc0c6f1e237bb44ad --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0171.rst.txt @@ -0,0 +1,26 @@ +CMP0171 +------- + +.. versionadded:: 3.31 + +``codegen`` is a reserved target name. + +CMake 3.30 and earlier did not reserve ``codegen`` as a builtin target name, +leaving projects free to create their own target with that name. +CMake 3.31 and later prefer to reserve ``codegen`` as a builtin target name +to drive custom commands created with the ``CODEGEN`` option to +:command:`add_custom_command`. In order to support building the ``codegen`` +target in scripted environments, e.g., ``cmake --build . --target codegen``, +the ``codegen`` target needs to be generated even if no custom commands +use the ``CODEGEN`` option. This policy provides compatibility for projects +that have not been updated to avoid creating a target named ``codegen``. + +The ``OLD`` behavior of this policy allows projects to create a target +with the name ``codegen``. The ``NEW`` behavior halts with a fatal error +if a target with the name ``codegen`` is created. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0172.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0172.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c316975792d14def9bac174468d8c27540d68476 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0172.rst.txt @@ -0,0 +1,39 @@ +CMP0172 +------- + +.. versionadded:: 3.31 + +The :module:`CPack` module enables per-machine installation by default +in the :cpack_gen:`CPack WIX Generator`. + +The :cpack_gen:`CPack WIX Generator`'s :variable:`CPACK_WIX_INSTALL_SCOPE` +option controls the scope of the generated Windows Installer package. +When :variable:`CPACK_WIX_VERSION` is set to 4 or higher, the default scope +is ``perMachine``. However, when using WIX 3 the default scope is ``NONE``, +and CPack does not set any ``InstallScope`` in the package specification. +The resulting installer requires administrative privileges and installs +into the system-wide ``ProgramFiles`` directory, but the start menu entry +and uninstaller registration are created only for the current user. + +The :module:`CPack` module in CMake 3.30 and older does not specify any +:variable:`CPACK_WIX_INSTALL_SCOPE` value by default, so CPack uses no +installation scope by default with WIX 3. CMake 3.31 and newer instead +prefer to set :variable:`CPACK_WIX_INSTALL_SCOPE` to ``perMachine`` by +default to make the behavior consistent across all WIX versions. This +policy provides compatibility for projects that have not been updated +to expect ``perMachine`` behavior. + +The ``OLD`` behavior for this policy is to not set +:variable:`CPACK_WIX_INSTALL_SCOPE` by default. The ``NEW`` behavior for +this policy is to set :variable:`CPACK_WIX_INSTALL_SCOPE` to ``perMachine`` +by default. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default +.. include:: STANDARD_ADVICE.txt + +See documentation of the +:variable:`CMAKE_POLICY_WARNING_CMP0172 >` +variable to control the warning. + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0173.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0173.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..30de19f5895cd472ca314a2c9327325921157e0f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0173.rst.txt @@ -0,0 +1,22 @@ +CMP0173 +------- + +.. versionadded:: 3.31 + +The :module:`CMakeFindFrameworks` module is removed. + +CMake's framework handling has evolved well beyond what the +``CMakeFindFrameworks`` module supports. The module lacks any handling of +XCFrameworks, it never documented the one command it provides, and +:command:`find_library` provides superior capabilities in all respects. + +The ``OLD`` behavior of this policy is for :module:`CMakeFindFrameworks` to +continue to provide the undocumented ``cmake_find_frameworks()`` command. +The ``NEW`` behavior halts with a fatal error if anything tries to include +the module. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0174.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0174.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..748fdba9da393b052c96e8d11ba54216f4faa242 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0174.rst.txt @@ -0,0 +1,37 @@ +CMP0174 +------- + +.. versionadded:: 3.31 + +:command:`cmake_parse_arguments(PARSE_ARGV)` defines a variable for an empty +string after a single-value keyword. + +One of the main reasons for using the ``PARSE_ARGV`` form of the +:command:`cmake_parse_arguments` command is to more robustly handle corner +cases related to empty values. The non-``PARSE_ARGV`` form doesn't preserve +empty arguments, but the ``PARSE_ARGV`` form does. For each single-value +keyword given, a variable should be defined if the keyword is present, even +if it is followed by an empty string. + +Prior to CMake 3.31, no variable would be defined if the value given after a +single-value keyword was an empty string. This meant the code could not detect +the difference between the keyword not being given, and it being given but with +an empty value, except by iterating over all the arguments and checking if the +keyword is present. + +For the ``OLD`` behavior of this policy, +:command:`cmake_parse_arguments(PARSE_ARGV)` does not define a variable for a +single-value keyword followed by an empty string, or followed by no value at +all. + +For the ``NEW`` behavior, :command:`cmake_parse_arguments(PARSE_ARGV)` always +defines a variable for each keyword given in the arguments, even a single-value +keyword with an empty string as its value or no value at all. With the +``NEW`` behavior, the code can robustly check if a single-value keyword was +given using just ``if(DEFINED _)``. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0175.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0175.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a71aadfcce1f0208046b22e547b979ce85a00bd2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0175.rst.txt @@ -0,0 +1,40 @@ +CMP0175 +------- + +.. versionadded:: 3.31 + +:command:`add_custom_command` rejects invalid arguments. + +CMake 3.30 and earlier silently ignored unsupported keywords and missing or +invalid arguments for the different forms of the :command:`add_custom_command` +command. CMake 3.31 implements more rigorous argument checking and will flag +invalid or missing arguments as errors. + +The ``OLD`` behavior of this policy will accept the same invalid keywords or +arguments as CMake 3.30 and earlier. The ``NEW`` behavior will flag the +following as errors that previously went unreported: + +* The ``OUTPUT`` form does not accept ``PRE_BUILD``, ``PRE_LINK``, or + ``POST_BUILD`` keywords. +* When the ``APPEND`` keyword is given, the ``OUTPUT`` form also does not + accept ``BYPRODUCTS``, ``COMMAND_EXPAND_LISTS``, ``DEPENDS_EXPLICIT_ONLY``, + ``DEPFILE``, ``JOB_POOL``, ``JOB_SERVER_AWARE``, ``USES_TERMINAL``, or + ``VERBATIM`` keywords. +* The ``TARGET`` form requires exactly one of ``PRE_BUILD``, ``PRE_LINK``, or + ``POST_BUILD`` to be given. Previously, if none were given, ``POST_BUILD`` + was assumed, or if multiple keywords were given, the last one was used. +* The ``TARGET`` form does not accept ``DEPENDS``, ``DEPENDS_EXPLICIT_ONLY``, + ``DEPFILE``, ``IMPLICIT_DEPENDS``, ``MAIN_DEPENDENCY``, ``JOB_POOL``, or + ``JOB_SERVER_AWARE`` keywords. +* The ``TARGET`` form now requires at least one ``COMMAND`` to be given. +* If a keyword expects a value to be given after it, but no value is provided, + that was previously treated as though the keyword was not given at all. +* The ``COMMENT`` keyword expects exactly one value after it. If multiple + values are given, or if the ``COMMENT`` keyword is given more than once, + this is an error. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0176.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0176.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..46831748a9080827c0e1bcec09261f4f9c4c6df7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0176.rst.txt @@ -0,0 +1,27 @@ +CMP0176 +------- + +.. versionadded:: 3.31 + +:command:`execute_process` ``ENCODING`` is ``UTF-8`` by default. + +The ``ENCODING`` option is meaningful only on Windows. It specifies the +character encoding expected in the process's output on stdout and stderr. +In CMake 3.14 and below the default encoding was ``NONE``, which corresponds +to CMake's internal UTF-8 encoding. In CMake 3.15 through CMake 3.30 the +default encoding was accidentally changed to ``AUTO``, but the change went +unnoticed and was not documented. + +CMake 3.31 and above prefer the ``ENCODING`` default to be ``UTF-8``. +This policy provides compatibility with projects that may have been +relying on the default being ``AUTO``. + +The ``OLD`` behavior of this policy is for :command:`execute_process` +to use ``AUTO`` by default if no ``ENCODING`` is specified. The ``NEW`` +behavior for this policy is to use ``UTF-8`` as the default ``ENCODING``. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0177.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0177.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3eca9f3b3124f294bc104a80b7bbc604a7429895 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0177.rst.txt @@ -0,0 +1,38 @@ +CMP0177 +------- + +.. versionadded:: 3.31 + +:command:`install` ``DESTINATION`` paths are normalized. + +The :command:`install` command has a number of different forms, and most of +them take a ``DESTINATION`` keyword, some in more than one place. +CMake 3.30 and earlier used the value given after the ``DESTINATION`` keyword +as provided with no transformations. The :command:`install(EXPORT)` form +assumes the path contains no ``..`` or ``.`` path components when computing +a path relative to the ``DESTINATION``, and if the project provided a path +that violated that assumption, the computed path would be incorrect. + +CMake 3.31 normalizes all ``DESTINATION`` values given in any form of the +:command:`install` command, except for the ``INCLUDES DESTINATION`` of the +:command:`install(TARGETS)` form. The normalization performed is the same +as for the :command:`cmake_path` command (see :ref:`Normalization`). + +The ``OLD`` behavior of this policy performs no translation on the +``DESTINATION`` values of any :command:`install` command. They are used +exactly as provided. If a destination path contains ``..`` or ``.`` path +components, :command:`install(EXPORT)` will use the same wrong paths as +CMake 3.30 and earlier. + +The ``NEW`` behavior will normalize all ``DESTINATION`` values except for +``INCLUDES DESTINATION``. If a destination path contains a generator +expression, it will be wrapped in a ``$`` +generator expression. + +This policy was introduced in CMake version 3.31. +It may be set by :command:`cmake_policy` or :command:`cmake_minimum_required`. +If it is not set, CMake will warn if it detects a path that would be different +if normalized, and uses ``OLD`` behavior. If a destination path contains a +generator expression, no such warning will be issued regardless of the value. + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0178.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0178.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f6152ebd67a60931eab83d90bd7c1be2aafcc21c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0178.rst.txt @@ -0,0 +1,37 @@ +CMP0178 +------- + +.. versionadded:: 3.31 + +Test command lines preserve empty arguments. + +Empty values in the :prop_tgt:`TEST_LAUNCHER` and +:prop_tgt:`CROSSCOMPILING_EMULATOR` target properties are now preserved +for tests added by the following: + +* The :command:`add_test` command. +* The :command:`ExternalData_Add_Test` command from the :module:`ExternalData` + module. +* The :command:`gtest_add_tests` or :command:`gtest_discover_tests` commands + from the :module:`GoogleTest` module. + +For the :command:`gtest_add_tests` and :command:`gtest_discover_tests` +commands, empty elements in the values passed after the ``EXTRA_ARGS`` +keyword are also now preserved. + +The ``OLD`` behavior of this policy silently discards empty list items +from the :prop_tgt:`TEST_LAUNCHER` and :prop_tgt:`CROSSCOMPILING_EMULATOR` +target properties in the above-mentioned cases. It also silently discards +empty items from the values given after ``EXTRA_ARGS`` for the +:command:`gtest_add_tests` and :command:`gtest_discover_tests` commands. + +The ``NEW`` behavior of this policy preserves empty list items in the +:prop_tgt:`TEST_LAUNCHER` and :prop_tgt:`CROSSCOMPILING_EMULATOR` target +properties, and in values given after ``EXTRA_ARGS`` for +:command:`gtest_add_tests` and :command:`gtest_discover_tests`. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0179.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0179.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7c9498f119acab6543172ac4126693274ed7c68b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0179.rst.txt @@ -0,0 +1,28 @@ +CMP0179 +------- + +.. versionadded:: 3.31 + +De-duplication of static libraries on link lines keeps first occurrence. +This policy is only relevant when policy :policy:`CMP0156` is set to ``NEW``. + +Based on the linker capabilities, the static libraries can +be de-duplicated. See policy :policy:`CMP0156` for more information. + +CMake 3.30 and below may choose to keep, on some platforms, the last occurrence +of the static libraries rather than the fist occurrence when they are +de-duplicated. + +CMake 3.31 and above prefer to keep, on all platforms, the first occurrence of +the static libraries when they are de-duplicated. + +The ``OLD`` behavior for this policy is to keep, on some platforms, the last +occurrence of the static libraries when they are de-duplicated. The ``NEW`` +behavior for this policy is to keep the first occurrence of the static +libraries when they are de-duplicated, regardless of the platform. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/policy/CMP0180.rst.txt b/cmake/doc/cmake/html/_sources/policy/CMP0180.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f69c0bcc486267b20d84df9833ab1a8a0d6b4819 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/policy/CMP0180.rst.txt @@ -0,0 +1,36 @@ +CMP0180 +------- + +.. versionadded:: 3.31 + +:command:`project` always sets ``_*`` as normal variables. + +In CMake 3.29 and below, the :command:`project` command set +:variable:`_SOURCE_DIR`, :variable:`_BINARY_DIR`, +and :variable:`_IS_TOP_LEVEL` as cache entries, but not as +normal variables. CMake 3.30 started setting them as normal variables, +but only if they are already set as normal variables. This was needed to +preserve support for some :module:`FetchContent` use cases under policy +:policy:`CMP0169`'s NEW behavior, while also preserving behavior of nested +directories that call :command:`project` with the same project name. +See release notes for 3.30.3, 3.30.4, and 3.30.5 for details. + +CMake 3.31 and later prefer to always set ``_SOURCE_DIR``, +``_BINARY_DIR``, and ``_IS_TOP_LEVEL``, as both +cache entries and normal variables, regardless of what cache or normal +variables already exist. This policy provides compatibility for projects +that have not been updated to expect this behavior. + +The ``OLD`` behavior for this policy will only set normal variables for +``_SOURCE_DIR``, ``_BINARY_DIR``, and +``_IS_TOP_LEVEL`` if there is already a normal variable by that +name when :command:`project` is called. +The ``NEW`` behavior for this policy will always set normal variables for +``_SOURCE_DIR``, ``_BINARY_DIR``, and +``_IS_TOP_LEVEL`` when :command:`project` is called. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 +.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/cmake/doc/cmake/html/_sources/prop_cache/ADVANCED.rst.txt b/cmake/doc/cmake/html/_sources/prop_cache/ADVANCED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ec4de9d8552b70f087881cd1cd7592d78142430b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_cache/ADVANCED.rst.txt @@ -0,0 +1,8 @@ +ADVANCED +-------- + +True if entry should be hidden by default in GUIs. + +This is a boolean value indicating whether the entry is considered +interesting only for advanced configuration. The :command:`mark_as_advanced` +command modifies this property. diff --git a/cmake/doc/cmake/html/_sources/prop_cache/HELPSTRING.rst.txt b/cmake/doc/cmake/html/_sources/prop_cache/HELPSTRING.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..71a86d0551d021a096dd0b673fa85e19fc9c07a1 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_cache/HELPSTRING.rst.txt @@ -0,0 +1,7 @@ +HELPSTRING +---------- + +Help associated with entry in GUIs. + +This string summarizes the purpose of an entry to help users set it +through a CMake GUI. diff --git a/cmake/doc/cmake/html/_sources/prop_cache/MODIFIED.rst.txt b/cmake/doc/cmake/html/_sources/prop_cache/MODIFIED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3ad70354daf8b359809788722f3c7e22e92e6082 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_cache/MODIFIED.rst.txt @@ -0,0 +1,7 @@ +MODIFIED +-------- + +Internal management property. Do not set or get. + +This is an internal cache entry property managed by CMake to track +interactive user modification of entries. Ignore it. diff --git a/cmake/doc/cmake/html/_sources/prop_cache/STRINGS.rst.txt b/cmake/doc/cmake/html/_sources/prop_cache/STRINGS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0e3c326d2c68ee59b91c3504664d36addbb3dce2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_cache/STRINGS.rst.txt @@ -0,0 +1,9 @@ +STRINGS +------- + +Enumerate possible ``STRING`` entry values for GUI selection. + +For cache entries with type ``STRING``, this enumerates a set of values. +CMake GUIs may use this to provide a selection widget instead of a +generic string entry field. This is for convenience only. CMake does +not enforce that the value matches one of those listed. diff --git a/cmake/doc/cmake/html/_sources/prop_cache/TYPE.rst.txt b/cmake/doc/cmake/html/_sources/prop_cache/TYPE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7ca859f68b6d7671f21c3a0621fd18bbb41e7c2e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_cache/TYPE.rst.txt @@ -0,0 +1,21 @@ +TYPE +---- + +Widget type for entry in GUIs. + +Cache entry values are always strings, but CMake GUIs present widgets +to help users set values. The GUIs use this property as a hint to +determine the widget type. Valid ``TYPE`` values are: + +:: + + BOOL = Boolean ON/OFF value. + PATH = Path to a directory. + FILEPATH = Path to a file. + STRING = Generic string value. + INTERNAL = Do not present in GUI at all. + STATIC = Value managed by CMake, do not change. + UNINITIALIZED = Type not yet specified. + +Generally the ``TYPE`` of a cache entry should be set by the command which +creates it ( :command:`set`, :command:`option`, :command:`find_library`, etc.). diff --git a/cmake/doc/cmake/html/_sources/prop_cache/VALUE.rst.txt b/cmake/doc/cmake/html/_sources/prop_cache/VALUE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..59aabd431aa009aa925fcc697bf4f4d6771c3001 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_cache/VALUE.rst.txt @@ -0,0 +1,7 @@ +VALUE +----- + +Value of a cache entry. + +This property maps to the actual value of a cache entry. Setting this +property always sets the value without checking, so use with care. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/ADDITIONAL_CLEAN_FILES.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/ADDITIONAL_CLEAN_FILES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6097d14d3242fb29ae7107c9c4f7236a1e2e5752 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/ADDITIONAL_CLEAN_FILES.rst.txt @@ -0,0 +1,23 @@ +ADDITIONAL_CLEAN_FILES +---------------------- + +.. versionadded:: 3.15 + +A :ref:`;-list ` of files or directories that will be +removed as a part of the global ``clean`` target. It is useful for +specifying generated files or directories that are used by multiple targets +or by CMake itself, or that are generated in ways which cannot be captured as +outputs or byproducts of custom commands. + +If an additional clean file is specific to a single target only, then the +:prop_tgt:`ADDITIONAL_CLEAN_FILES` target property would usually be a better +choice than this directory property. + +Relative paths are allowed and are interpreted relative to the +current binary directory. + +Contents of ``ADDITIONAL_CLEAN_FILES`` may use +:manual:`generator expressions `. + +This property only works for the :generator:`Ninja` and the Makefile +generators. It is ignored by other generators. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a19cc4ee283cfd436afa6cbf3c90f7fcb87e50de --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst.txt @@ -0,0 +1,17 @@ +ADDITIONAL_MAKE_CLEAN_FILES +--------------------------- + +.. deprecated:: 3.15 + + Use :prop_dir:`ADDITIONAL_CLEAN_FILES` instead. + +Additional files to remove during the clean stage. + +A :ref:`;-list ` of files that will be removed as a +part of the ``make clean`` target. + +Arguments to ``ADDITIONAL_MAKE_CLEAN_FILES`` may use +:manual:`generator expressions `. + +This property only works for the Makefile generators. +It is ignored on other generators. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/BINARY_DIR.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/BINARY_DIR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fcf9d17d7b9a4c0e721b95f13361a5408e726108 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/BINARY_DIR.rst.txt @@ -0,0 +1,7 @@ +BINARY_DIR +---------- + +.. versionadded:: 3.7 + +This read-only directory property reports absolute path to the binary +directory corresponding to the source on which it is read. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/BUILDSYSTEM_TARGETS.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/BUILDSYSTEM_TARGETS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c998488b4af4dc380a6c1b48804352bbe37191f9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/BUILDSYSTEM_TARGETS.rst.txt @@ -0,0 +1,15 @@ +BUILDSYSTEM_TARGETS +------------------- + +.. versionadded:: 3.7 + +This read-only directory property contains a +:ref:`semicolon-separated list ` of buildsystem targets added in the +directory by calls to the :command:`add_library`, :command:`add_executable`, +and :command:`add_custom_target` commands. The list does not include any +:ref:`Imported Targets` or :ref:`Alias Targets`, but does include +:ref:`Interface Libraries`. Each entry in the list is the logical name +of a target, suitable to pass to the :command:`get_property` command +``TARGET`` option. + +See also the :prop_dir:`IMPORTED_TARGETS` directory property. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/CACHE_VARIABLES.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/CACHE_VARIABLES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2c66f939e5778ed49cfb1ef2775952e5deb6a834 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/CACHE_VARIABLES.rst.txt @@ -0,0 +1,7 @@ +CACHE_VARIABLES +--------------- + +List of cache variables available in the current directory. + +This read-only property specifies the list of CMake cache variables +currently defined. It is intended for debugging purposes. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/CLEAN_NO_CUSTOM.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/CLEAN_NO_CUSTOM.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5ae78bf7527a3eaa8b8e322704914b312864e0d3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/CLEAN_NO_CUSTOM.rst.txt @@ -0,0 +1,6 @@ +CLEAN_NO_CUSTOM +--------------- + +Set to true to tell :ref:`Makefile Generators` not to remove the outputs of +custom commands for this directory during the ``make clean`` operation. +This is ignored on other generators because it is not possible to implement. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/CMAKE_CONFIGURE_DEPENDS.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/CMAKE_CONFIGURE_DEPENDS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b1aef1966c4d30ece43ba4021d955fffec28d67f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/CMAKE_CONFIGURE_DEPENDS.rst.txt @@ -0,0 +1,9 @@ +CMAKE_CONFIGURE_DEPENDS +----------------------- + +Tell CMake about additional input files to the configuration process. +If any named file is modified the build system will re-run CMake to +re-configure the file and generate the build system again. + +Specify files as a semicolon-separated list of paths. Relative paths +are interpreted as relative to the current source directory. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/COMPILE_DEFINITIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/COMPILE_DEFINITIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5a12c1eaa08418d42f09168ce52c7d4688720cb4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/COMPILE_DEFINITIONS.rst.txt @@ -0,0 +1,34 @@ +COMPILE_DEFINITIONS +------------------- + +Preprocessor definitions for compiling a directory's sources. + +This property specifies the list of options given so far to the +:command:`add_compile_definitions` (or :command:`add_definitions`) command. + +The ``COMPILE_DEFINITIONS`` property may be set to a semicolon-separated +list of preprocessor definitions using the syntax ``VAR`` or ``VAR=value``. +Function-style definitions are not supported. CMake will +automatically escape the value correctly for the native build system +(note that CMake language syntax may require escapes to specify some +values). + +This property will be initialized in each directory by its value in the +directory's parent. + +CMake will automatically drop some definitions that are not supported +by the native build tool. + +.. versionadded:: 3.26 + Any leading ``-D`` on an item will be removed. + +.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt + +Contents of ``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)` +manual for more on defining buildsystem properties. + +The corresponding :prop_dir:`COMPILE_DEFINITIONS_` property may +be set to specify per-configuration definitions. Generator expressions +should be preferred instead of setting the alternative property. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/COMPILE_DEFINITIONS_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/COMPILE_DEFINITIONS_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a6af45f35bdafd8dc5b2f83d2079d1d8ae734e35 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/COMPILE_DEFINITIONS_CONFIG.rst.txt @@ -0,0 +1,19 @@ +COMPILE_DEFINITIONS_ +---------------------------- + +Ignored. See CMake Policy :policy:`CMP0043`. + +Per-configuration preprocessor definitions in a directory. + +This is the configuration-specific version of :prop_dir:`COMPILE_DEFINITIONS` +where ```` is an upper-case name (ex. ``COMPILE_DEFINITIONS_DEBUG``). + +This property will be initialized in each directory by its value in +the directory's parent. + +Contents of ``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)` +manual for more on defining buildsystem properties. + +Generator expressions should be preferred instead of setting this property. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/COMPILE_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/COMPILE_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..48e8b9b8d604efe9bfd0d29f4d1b4f654f481090 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/COMPILE_OPTIONS.rst.txt @@ -0,0 +1,16 @@ +COMPILE_OPTIONS +--------------- + +List of options to pass to the compiler. + +This property holds a :ref:`semicolon-separated list ` of options +given so far to the :command:`add_compile_options` command. + +This property is used to initialize the :prop_tgt:`COMPILE_OPTIONS` target +property when a target is created, which is used by the generators to set +the options for the compiler. + +Contents of ``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)` manual +for more on defining buildsystem properties. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/DEFINITIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/DEFINITIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..79ac3f3462b23c72ef6d553eb85548b1a6561067 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/DEFINITIONS.rst.txt @@ -0,0 +1,13 @@ +DEFINITIONS +----------- + +For CMake 2.4 compatibility only. Use :prop_dir:`COMPILE_DEFINITIONS` +instead. + +This read-only property specifies the list of flags given so far to +the :command:`add_definitions` command. It is intended for debugging +purposes. Use the :prop_dir:`COMPILE_DEFINITIONS` directory property +instead. + +This built-in read-only property does not exist if policy +:policy:`CMP0059` is set to ``NEW``. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/EXCLUDE_FROM_ALL.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/EXCLUDE_FROM_ALL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..1adb50e147f97427839bbba548e3dbbeabb7347b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/EXCLUDE_FROM_ALL.rst.txt @@ -0,0 +1,34 @@ +EXCLUDE_FROM_ALL +---------------- + +Set this directory property to a true value on a subdirectory to exclude +its targets from the "all" target of its ancestors. If excluded, running +e.g. ``make`` in the parent directory will not build targets the +subdirectory by default. This does not affect the "all" target of the +subdirectory itself. Running e.g. ``make`` inside the subdirectory will +still build its targets. + +``EXCLUDE_FROM_ALL`` is meant for when the subdirectory contains +a separate part of the project that is useful, but not necessary, +such as a set of examples, or e.g. an integrated 3rd party library. +Typically the subdirectory should contain its own :command:`project` +command invocation so that a full build system will be generated in the +subdirectory (such as a Visual Studio IDE solution file). Note that +inter-target dependencies supersede this exclusion. If a target built by +the parent project depends on a target in the subdirectory, the dependee +target will be included in the parent project build system to satisfy +the dependency. + +If the ``EXCLUDE_FROM_ALL`` argument is provided, it has the following effects: + +* Targets defined in the subdirectory or below will not be + included in the ``ALL`` target of the parent directory. + Those targets must be built explicitly by the user, + or be a dependency of another target that will be built. +* Targets defined in the subdirectory or below will be + excluded from IDE project files. +* Any install rules defined in the subdirectory or below will + be ignored when installing the parent directory. + +Note that these effects are not the same as those for the +:prop_tgt:`EXCLUDE_FROM_ALL` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f5349763a0fa28a6482412c4517237443f99cf20 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst.txt @@ -0,0 +1,34 @@ +IMPLICIT_DEPENDS_INCLUDE_TRANSFORM +---------------------------------- + +Specify ``#include`` line transforms for dependencies in a directory. + +This property specifies rules to transform macro-like ``#include`` lines +during implicit dependency scanning of C and C++ source files. The +list of rules must be semicolon-separated with each entry of the form +``A_MACRO(%)=value-with-%`` (the ``%`` must be literal). During dependency +scanning occurrences of ``A_MACRO(...)`` on ``#include`` lines will be +replaced by the value given with the macro argument substituted for +``%``. For example, the entry + +:: + + MYDIR(%)= + +will convert lines of the form + +:: + + #include MYDIR(myheader.h) + +to + +:: + + #include + +allowing the dependency to be followed. + +This property applies to sources in all targets within a directory. +The property value is initialized in each directory by its value in +the directory's parent. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/IMPORTED_TARGETS.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/IMPORTED_TARGETS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fea8a93d49cae6ee4f3c819be12cf15cae5b828c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/IMPORTED_TARGETS.rst.txt @@ -0,0 +1,14 @@ +IMPORTED_TARGETS +---------------- + +.. versionadded:: 3.21 + +This read-only directory property contains a +:ref:`semicolon-separated list ` of +:ref:`Imported Targets` added in the directory by calls to the +:command:`add_library` and :command:`add_executable` commands. +Each entry in the list is the logical name of a target, suitable +to pass to the :command:`get_property` command ``TARGET`` option +when called in the same directory. + +See also the :prop_dir:`BUILDSYSTEM_TARGETS` directory property. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/INCLUDE_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/INCLUDE_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5d856b80a83d66588f0390189ea248e29ab0df7c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/INCLUDE_DIRECTORIES.rst.txt @@ -0,0 +1,32 @@ +INCLUDE_DIRECTORIES +------------------- + +List of preprocessor include file search directories. + +This property specifies the list of directories given so far to the +:command:`include_directories` command. + +This property is used to populate the :prop_tgt:`INCLUDE_DIRECTORIES` +target property, which is used by the generators to set the include +directories for the compiler. + +In addition to accepting values from that command, values may be set +directly on any directory using the :command:`set_property` command, and can be +set on the current directory using the :command:`set_directory_properties` +command. A directory gets its initial value from its parent directory if it has +one. The initial value of the :prop_tgt:`INCLUDE_DIRECTORIES` target property +comes from the value of this property. Both directory and target property +values are adjusted by calls to the :command:`include_directories` command. +Calls to :command:`set_property` or :command:`set_directory_properties`, +however, will update the directory property value without updating target +property values. Therefore direct property updates must be made before +calls to :command:`add_executable` or :command:`add_library` for targets +they are meant to affect. + +The target property values are used by the generators to set the +include paths for the compiler. + +Contents of ``INCLUDE_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. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/INCLUDE_REGULAR_EXPRESSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/INCLUDE_REGULAR_EXPRESSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..bb90c61a7386efb4bb4c50bbcbd426be6025145b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/INCLUDE_REGULAR_EXPRESSION.rst.txt @@ -0,0 +1,9 @@ +INCLUDE_REGULAR_EXPRESSION +-------------------------- + +Include file scanning regular expression. + +This property specifies the regular expression used during +dependency scanning to match include files that should be followed. +See the :command:`include_regular_expression` command for a high-level +interface to set this property. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/INTERPROCEDURAL_OPTIMIZATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/INTERPROCEDURAL_OPTIMIZATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6693a43cc719a5562d2f99e1913bf5126d5c3dcc --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/INTERPROCEDURAL_OPTIMIZATION.rst.txt @@ -0,0 +1,6 @@ +INTERPROCEDURAL_OPTIMIZATION +---------------------------- + +This directory property does not exist anymore. + +See the target property :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` instead. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7ef1bb4490966cdf5e82d9af610b1bad58d5f2db --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst.txt @@ -0,0 +1,6 @@ +INTERPROCEDURAL_OPTIMIZATION_ +------------------------------------- + +This directory property does not exist anymore. + +See the target property :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION_` instead. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/LABELS.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/LABELS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..bf14368e23d0843f7d287df40ac34701da6dc891 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/LABELS.rst.txt @@ -0,0 +1,15 @@ +LABELS +------ + +.. versionadded:: 3.10 + +Specify a list of text labels associated with a directory and all of its +subdirectories. This is equivalent to setting the :prop_tgt:`LABELS` target +property and the :prop_test:`LABELS` test property on all targets and tests in +the current directory and subdirectories. Note: Launchers must enabled to +propagate labels to targets. + +The :variable:`CMAKE_DIRECTORY_LABELS` variable can be used to initialize this +property. + +The list is reported in dashboard submissions. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/LINK_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/LINK_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..44dc2304e9e6f2e8524a03acb41ec61f1a4ec10f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/LINK_DIRECTORIES.rst.txt @@ -0,0 +1,17 @@ +LINK_DIRECTORIES +---------------- + +List of linker search directories. + +This property holds a :ref:`semicolon-separated list ` of directories +and is typically populated using the :command:`link_directories` command. +It gets its initial value from its parent directory, if it has one. + +The directory property is used to initialize the :prop_tgt:`LINK_DIRECTORIES` +target property when a target is created. That target property is used +by the generators to set the library search directories for the linker. + +Contents of ``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. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/LINK_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/LINK_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3a5c72ff09dcd71142e2125dd471a61c40fe8ced --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/LINK_OPTIONS.rst.txt @@ -0,0 +1,19 @@ +LINK_OPTIONS +------------ + +.. versionadded:: 3.13 + +List of options to use for the link step of shared library, module +and executable targets as well as the device link step. + +This property holds a :ref:`semicolon-separated list ` of options +given so far to the :command:`add_link_options` command. + +This property is used to initialize the :prop_tgt:`LINK_OPTIONS` target +property when a target is created, which is used by the generators to set +the options for the compiler. + +Contents of ``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)` manual +for more on defining buildsystem properties. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/LISTFILE_STACK.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/LISTFILE_STACK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..22ec4b68ae7314df71cc02763667a5b7fefbaf9c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/LISTFILE_STACK.rst.txt @@ -0,0 +1,10 @@ +LISTFILE_STACK +-------------- + +The current stack of listfiles being processed. + +This property is mainly useful when trying to debug errors in your +CMake scripts. It returns a list of what list files are currently +being processed, in order. So if one listfile does an +:command:`include` command then that is effectively pushing the +included listfile onto the stack. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/MACROS.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/MACROS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..245cc1b91ebb16c87eb85b5d8072ea55029ff253 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/MACROS.rst.txt @@ -0,0 +1,8 @@ +MACROS +------ + +List of macro commands available in the current directory. + +This read-only property specifies the list of CMake macros currently +defined. It is intended for debugging purposes. See the :command:`macro` +command. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/PARENT_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/PARENT_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3bc5824c94d43a181f6bc8931cf342adcbebb665 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/PARENT_DIRECTORY.rst.txt @@ -0,0 +1,8 @@ +PARENT_DIRECTORY +---------------- + +Source directory that added current subdirectory. + +This read-only property specifies the source directory that added the +current source directory as a subdirectory of the build. In the +top-level directory the value is the empty-string. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/RULE_LAUNCH_COMPILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/RULE_LAUNCH_COMPILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d9b550e242a27241f86cb094d293928d67debedb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/RULE_LAUNCH_COMPILE.rst.txt @@ -0,0 +1,13 @@ +RULE_LAUNCH_COMPILE +------------------- + +Specify a launcher for compile rules. + +.. note:: + This property is intended for internal use by :manual:`ctest(1)`. Projects + and developers should use the :prop_tgt:`_COMPILER_LAUNCHER` target + properties or the associated :variable:`CMAKE__COMPILER_LAUNCHER` + variables instead. + +See the :prop_gbl:`global property ` of the same name +for details. This overrides the global property for a directory. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/RULE_LAUNCH_CUSTOM.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/RULE_LAUNCH_CUSTOM.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..93d1e0111ed57e7909067ca5764221a8e6778f16 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/RULE_LAUNCH_CUSTOM.rst.txt @@ -0,0 +1,7 @@ +RULE_LAUNCH_CUSTOM +------------------ + +Specify a launcher for custom rules. + +See the global property of the same name for details. This overrides +the global property for a directory. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/RULE_LAUNCH_LINK.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/RULE_LAUNCH_LINK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..922c8d5b23b7ef2e07394d69cf43d91e7ac015ed --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/RULE_LAUNCH_LINK.rst.txt @@ -0,0 +1,13 @@ +RULE_LAUNCH_LINK +---------------- + +Specify a launcher for link rules. + +.. note:: + This property is intended for internal use by :manual:`ctest(1)`. Projects + and developers should use the :prop_tgt:`_LINKER_LAUNCHER` target + properties or the associated :variable:`CMAKE__LINKER_LAUNCHER` + variables instead. + +See the :prop_gbl:`global property ` of the same name for +details. This overrides the global property for a directory. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/SOURCE_DIR.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/SOURCE_DIR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d73707dacbb91992e40467de74668ea68271dfb3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/SOURCE_DIR.rst.txt @@ -0,0 +1,7 @@ +SOURCE_DIR +---------- + +.. versionadded:: 3.7 + +This read-only directory property reports absolute path to the source +directory on which it is read. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/SUBDIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/SUBDIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..71ea496fe41d630106292890f3952aaa6d8b748c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/SUBDIRECTORIES.rst.txt @@ -0,0 +1,17 @@ +SUBDIRECTORIES +-------------- + +.. versionadded:: 3.7 + +This read-only directory property contains a +:ref:`semicolon-separated list ` of subdirectories processed so far by +the :command:`add_subdirectory` or :command:`subdirs` commands. Each entry is +the absolute path to the source directory (containing the ``CMakeLists.txt`` +file). This is suitable to pass to the :command:`get_property` command +``DIRECTORY`` option. + +.. note:: + + The :command:`subdirs` command does not process its arguments until + after the calling directory is fully processed. Therefore looking + up this property in the current directory will not see them. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/SYSTEM.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/SYSTEM.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ad4ace17929ac2f7e2ed613ea9e174a564b32f50 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/SYSTEM.rst.txt @@ -0,0 +1,10 @@ +SYSTEM +------ + +.. versionadded:: 3.25 + +This directory property is used to initialize the :prop_tgt:`SYSTEM` +target property for non-imported targets created in that directory. +It is set to true by :command:`add_subdirectory` and +:command:`FetchContent_Declare` when the ``SYSTEM`` option is given +as an argument to those commands. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/TESTS.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/TESTS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..294be178d4aa416aa1d4e3eb0e4eee97035ab2b9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/TESTS.rst.txt @@ -0,0 +1,10 @@ +TESTS +----- + +.. versionadded:: 3.12 + +List of tests. + +This read-only property holds a +:ref:`semicolon-separated list ` of tests +defined so far, in the current directory, by the :command:`add_test` command. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/TEST_INCLUDE_FILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/TEST_INCLUDE_FILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..31b23829d45136de361262b19c43712530432df8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/TEST_INCLUDE_FILE.rst.txt @@ -0,0 +1,9 @@ +TEST_INCLUDE_FILE +----------------- + +Deprecated. Use :prop_dir:`TEST_INCLUDE_FILES` instead. + +A cmake file that will be included when ctest is run. + +If you specify ``TEST_INCLUDE_FILE``, that file will be included and +processed when ctest is run on the directory. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/TEST_INCLUDE_FILES.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/TEST_INCLUDE_FILES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f9a66f42c0e7180e47e4e30dd31ae97d3b0cc611 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/TEST_INCLUDE_FILES.rst.txt @@ -0,0 +1,9 @@ +TEST_INCLUDE_FILES +------------------ + +.. versionadded:: 3.10 + +A list of cmake files that will be included when ctest is run. + +If you specify ``TEST_INCLUDE_FILES``, those files will be included and +processed when ctest is run on the directory. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/VARIABLES.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/VARIABLES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0328295c3fe08b2834eab6ff0e5ad0059dcbbfe2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/VARIABLES.rst.txt @@ -0,0 +1,7 @@ +VARIABLES +--------- + +List of variables defined in the current directory. + +This read-only property specifies the list of CMake variables +currently defined. It is intended for debugging purposes. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/VS_GLOBAL_SECTION_POST_section.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/VS_GLOBAL_SECTION_POST_section.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5b326734fdb7ce1020f24d83a3556ea7bd6c7cc0 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/VS_GLOBAL_SECTION_POST_section.rst.txt @@ -0,0 +1,31 @@ +VS_GLOBAL_SECTION_POST_
+-------------------------------- + +Specify a postSolution global section in Visual Studio. + +Setting a property like this generates an entry of the following form +in the solution file: + +:: + + GlobalSection(
) = postSolution + + EndGlobalSection + +The property must be set to a semicolon-separated list of ``key=value`` +pairs. Each such pair will be transformed into an entry in the +solution global section. Whitespace around key and value is ignored. +List elements which do not contain an equal sign are skipped. + +This property only works for :ref:`Visual Studio Generators`; it is ignored +on other generators. The property only applies when set on a +directory whose ``CMakeLists.txt`` contains a :command:`project` command. + +Note that CMake generates postSolution sections ``ExtensibilityGlobals`` +and ``ExtensibilityAddIns`` by default. If you set the corresponding +property, it will override the default section. For example, setting +``VS_GLOBAL_SECTION_POST_ExtensibilityGlobals`` will override the default +contents of the ``ExtensibilityGlobals`` section, while keeping +ExtensibilityAddIns on its default. However, CMake will always +add a ``SolutionGuid`` to the ``ExtensibilityGlobals`` section +if it is not specified explicitly. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/VS_GLOBAL_SECTION_PRE_section.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/VS_GLOBAL_SECTION_PRE_section.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..179f1bbfeef29a285efa6af93fee4d55303a49a6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/VS_GLOBAL_SECTION_PRE_section.rst.txt @@ -0,0 +1,22 @@ +VS_GLOBAL_SECTION_PRE_
+------------------------------- + +Specify a preSolution global section in Visual Studio. + +Setting a property like this generates an entry of the following form +in the solution file: + +:: + + GlobalSection(
) = preSolution + + EndGlobalSection + +The property must be set to a semicolon-separated list of ``key=value`` +pairs. Each such pair will be transformed into an entry in the +solution global section. Whitespace around key and value is ignored. +List elements which do not contain an equal sign are skipped. + +This property only works for :ref:`Visual Studio Generators`; it is ignored +on other generators. The property only applies when set on a +directory whose ``CMakeLists.txt`` contains a :command:`project` command. diff --git a/cmake/doc/cmake/html/_sources/prop_dir/VS_STARTUP_PROJECT.rst.txt b/cmake/doc/cmake/html/_sources/prop_dir/VS_STARTUP_PROJECT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8a0c3c8437dee6d3b7d2addd32ffeaf1fdcefcea --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_dir/VS_STARTUP_PROJECT.rst.txt @@ -0,0 +1,20 @@ +VS_STARTUP_PROJECT +------------------ + +.. versionadded:: 3.6 + +Specify the default startup project in a Visual Studio solution. + +The :ref:`Visual Studio Generators` create a ``.sln`` file for each directory +whose ``CMakeLists.txt`` file calls the :command:`project` command. Set this +property in the same directory as a :command:`project` command call (e.g. in +the top-level ``CMakeLists.txt`` file) to specify the default startup project +for the corresponding solution file. + +The property must be set to the name of an existing target. This +will cause that project to be listed first in the generated solution +file causing Visual Studio to make it the startup project if the +solution has never been opened before. + +If this property is not specified, then the ``ALL_BUILD`` project +will be the default. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..19775ff2dc6c4138a08d31fee09a496afc914949 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS.rst.txt @@ -0,0 +1,21 @@ +ALLOW_DUPLICATE_CUSTOM_TARGETS +------------------------------ + +Allow duplicate custom targets to be created. + +Normally CMake requires that all targets built in a project have +globally unique logical names (see policy :policy:`CMP0002`). +This is necessary to generate meaningful project file names in +:generator:`Xcode` and :ref:`Visual Studio Generators` IDE +generators. It also allows the target names to be referenced +unambiguously. + +Makefile generators are capable of supporting duplicate :command:`add_custom_target` +names. For projects that care only about :ref:`Makefile Generators` and do +not wish to support :generator:`Xcode` or :ref:`Visual Studio Generators` IDE +generators, one may set this property to ``True`` +to allow duplicate custom targets. The property +allows multiple :command:`add_custom_target` command calls in different +directories to specify the same target name. However, setting this +property will cause non-Makefile generators to produce an error and +refuse to generate the project. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/AUTOGEN_SOURCE_GROUP.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/AUTOGEN_SOURCE_GROUP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..600a64a400c23897c91332c21f0ca015a53c4dd4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/AUTOGEN_SOURCE_GROUP.rst.txt @@ -0,0 +1,18 @@ +AUTOGEN_SOURCE_GROUP +-------------------- + +.. versionadded:: 3.9 + +Name of the :command:`source_group` for :prop_tgt:`AUTOMOC`, +:prop_tgt:`AUTORCC` and :prop_tgt:`AUTOUIC` generated files. + +Files generated by :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTORCC` and +:prop_tgt:`AUTOUIC` are not always known at configure time and therefore can't +be passed to :command:`source_group`. +``AUTOGEN_SOURCE_GROUP`` can be used instead to generate or select +a source group for :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTORCC` and +:prop_tgt:`AUTOUIC` generated files. + +For :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTORCC` and :prop_tgt:`AUTOUIC` specific +overrides see :prop_gbl:`AUTOMOC_SOURCE_GROUP`, :prop_gbl:`AUTORCC_SOURCE_GROUP` +and :prop_gbl:`AUTOUIC_SOURCE_GROUP` respectively. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/AUTOGEN_TARGETS_FOLDER.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/AUTOGEN_TARGETS_FOLDER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0b747b207405783ec7527a6ae164a334e90635bd --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/AUTOGEN_TARGETS_FOLDER.rst.txt @@ -0,0 +1,9 @@ +AUTOGEN_TARGETS_FOLDER +---------------------- + +Name of :prop_tgt:`FOLDER` for ``*_autogen`` targets that are added +automatically by CMake for targets for which :prop_tgt:`AUTOMOC` is enabled. + +If not set, CMake uses the :prop_tgt:`FOLDER` property of the parent target as a +default value for this property. See also the documentation for the +:prop_tgt:`FOLDER` target property and the :prop_tgt:`AUTOMOC` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/AUTOMOC_SOURCE_GROUP.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/AUTOMOC_SOURCE_GROUP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a266fdebf4c3c3ab4cd814857f02e25876532540 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/AUTOMOC_SOURCE_GROUP.rst.txt @@ -0,0 +1,9 @@ +AUTOMOC_SOURCE_GROUP +-------------------- + +.. versionadded:: 3.9 + +Name of the :command:`source_group` for :prop_tgt:`AUTOMOC` generated files. + +When set this is used instead of :prop_gbl:`AUTOGEN_SOURCE_GROUP` for +files generated by :prop_tgt:`AUTOMOC`. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..17666e45a1665dd4b79e821aa942f043ef5b1777 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst.txt @@ -0,0 +1,11 @@ +AUTOMOC_TARGETS_FOLDER +---------------------- + +Name of :prop_tgt:`FOLDER` for ``*_autogen`` targets that are added automatically by +CMake for targets for which :prop_tgt:`AUTOMOC` is enabled. + +This property is obsolete. Use :prop_gbl:`AUTOGEN_TARGETS_FOLDER` instead. + +If not set, CMake uses the :prop_tgt:`FOLDER` property of the parent target as a +default value for this property. See also the documentation for the +:prop_tgt:`FOLDER` target property and the :prop_tgt:`AUTOMOC` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/AUTORCC_SOURCE_GROUP.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/AUTORCC_SOURCE_GROUP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..54ebabb0d8fe62b66b9549dc2115fc6a82cbec76 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/AUTORCC_SOURCE_GROUP.rst.txt @@ -0,0 +1,9 @@ +AUTORCC_SOURCE_GROUP +-------------------- + +.. versionadded:: 3.9 + +Name of the :command:`source_group` for :prop_tgt:`AUTORCC` generated files. + +When set this is used instead of :prop_gbl:`AUTOGEN_SOURCE_GROUP` for +files generated by :prop_tgt:`AUTORCC`. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/AUTOUIC_SOURCE_GROUP.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/AUTOUIC_SOURCE_GROUP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..79ebfe0eccce8750e2592f13161546a52460486b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/AUTOUIC_SOURCE_GROUP.rst.txt @@ -0,0 +1,9 @@ +AUTOUIC_SOURCE_GROUP +-------------------- + +.. versionadded:: 3.21 + +Name of the :command:`source_group` for :prop_tgt:`AUTOUIC` generated files. + +When set this is used instead of :prop_gbl:`AUTOGEN_SOURCE_GROUP` for +files generated by :prop_tgt:`AUTOUIC`. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fd2f9413fd0e3e41a7db549590fd220b166aeed6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst.txt @@ -0,0 +1,44 @@ +CMAKE_CUDA_KNOWN_FEATURES +------------------------- + +.. versionadded:: 3.17 + +List of CUDA features known to this version of CMake. + +The features listed in this global property may be known to be available to the +CUDA compiler. If the feature is available with the C++ compiler, it will +be listed in the :variable:`CMAKE_CUDA_COMPILE_FEATURES` variable. + +The features listed here may be used with the :command:`target_compile_features` +command. See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + + +The features known to this version of CMake are: + +``cuda_std_03`` + Compiler mode is at least CUDA/C++ 03. + +``cuda_std_11`` + Compiler mode is at least CUDA/C++ 11. + +``cuda_std_14`` + Compiler mode is at least CUDA/C++ 14. + +``cuda_std_17`` + Compiler mode is at least CUDA/C++ 17. + +``cuda_std_20`` + Compiler mode is at least CUDA/C++ 20. + +``cuda_std_23`` + .. versionadded:: 3.20 + + Compiler mode is at least CUDA/C++ 23. + +``cuda_std_26`` + .. versionadded:: 3.30 + + Compiler mode is at least CUDA/C++ 26. + +.. include:: CMAKE_LANG_STD_FLAGS.txt diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..177659afc3bd3d056689f3d51e84d3cc6a733186 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst.txt @@ -0,0 +1,367 @@ +CMAKE_CXX_KNOWN_FEATURES +------------------------ + +.. versionadded:: 3.1 + +List of C++ features known to this version of CMake. + +The features listed in this global property may be known to be available to the +C++ compiler. If the feature is available with the C++ compiler, it will +be listed in the :variable:`CMAKE_CXX_COMPILE_FEATURES` variable. + +The features listed here may be used with the :command:`target_compile_features` +command. See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +The features known to this version of CMake are listed below. + +High level meta features indicating C++ standard support +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 3.8 + +The following meta features indicate general support for the associated +language standard. It reflects the language support claimed by the compiler, +but it does not necessarily imply complete conformance to that standard. + +``cxx_std_98`` + Compiler mode is at least C++ 98. + +``cxx_std_11`` + Compiler mode is at least C++ 11. + +``cxx_std_14`` + Compiler mode is at least C++ 14. + +``cxx_std_17`` + Compiler mode is at least C++ 17. + +``cxx_std_20`` + .. versionadded:: 3.12 + + Compiler mode is at least C++ 20. + +``cxx_std_23`` + .. versionadded:: 3.20 + + Compiler mode is at least C++ 23. + +``cxx_std_26`` + .. versionadded:: 3.30 + + Compiler mode is at least C++ 26. + +.. include:: CMAKE_LANG_STD_FLAGS.txt + +Low level individual compile features +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +For C++ 11 and C++ 14, compilers were sometimes slow to implement certain +language features. CMake provided some individual compile features to help +projects determine whether specific features were available. These individual +features are now less relevant and projects should generally prefer to use the +high level meta features instead. Individual compile features are not provided +for C++ 17 or later. + +See the :manual:`cmake-compile-features(7)` manual for further discussion of +the use of individual compile features. + +Individual features from C++ 98 +""""""""""""""""""""""""""""""" + +``cxx_template_template_parameters`` + Template template parameters, as defined in ``ISO/IEC 14882:1998``. + + +Individual features from C++ 11 +""""""""""""""""""""""""""""""" + +``cxx_alias_templates`` + Template aliases, as defined in N2258_. + + .. _N2258: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2258.pdf + +``cxx_alignas`` + Alignment control ``alignas``, as defined in N2341_. + + .. _N2341: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2341.pdf + +``cxx_alignof`` + Alignment control ``alignof``, as defined in N2341_. + + .. _N2341: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2341.pdf + +``cxx_attributes`` + Generic attributes, as defined in N2761_. + + .. _N2761: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2761.pdf + +``cxx_auto_type`` + Automatic type deduction, as defined in N1984_. + + .. _N1984: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n1984.pdf + +``cxx_constexpr`` + Constant expressions, as defined in N2235_. + + .. _N2235: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2235.pdf + + +``cxx_decltype_incomplete_return_types`` + Decltype on incomplete return types, as defined in N3276_. + + .. _N3276 : https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2011/n3276.pdf + +``cxx_decltype`` + Decltype, as defined in N2343_. + + .. _N2343: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2343.pdf + +``cxx_default_function_template_args`` + Default template arguments for function templates, as defined in DR226_ + + .. _DR226: https://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#226 + +``cxx_defaulted_functions`` + Defaulted functions, as defined in N2346_. + + .. _N2346: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2346.htm + +``cxx_defaulted_move_initializers`` + Defaulted move initializers, as defined in N3053_. + + .. _N3053: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3053.html + +``cxx_delegating_constructors`` + Delegating constructors, as defined in N1986_. + + .. _N1986: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n1986.pdf + +``cxx_deleted_functions`` + Deleted functions, as defined in N2346_. + + .. _N2346: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2346.htm + +``cxx_enum_forward_declarations`` + Enum forward declarations, as defined in N2764_. + + .. _N2764: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2764.pdf + +``cxx_explicit_conversions`` + Explicit conversion operators, as defined in N2437_. + + .. _N2437: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2437.pdf + +``cxx_extended_friend_declarations`` + Extended friend declarations, as defined in N1791_. + + .. _N1791: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1791.pdf + +``cxx_extern_templates`` + Extern templates, as defined in N1987_. + + .. _N1987: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n1987.htm + +``cxx_final`` + Override control ``final`` keyword, as defined in N2928_, N3206_ and N3272_. + + .. _N2928: https://www.open-std.org/JTC1/SC22/WG21/docs/papers/2009/n2928.htm + .. _N3206: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3206.htm + .. _N3272: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2011/n3272.htm + +``cxx_func_identifier`` + Predefined ``__func__`` identifier, as defined in N2340_. + + .. _N2340: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2340.htm + +``cxx_generalized_initializers`` + Initializer lists, as defined in N2672_. + + .. _N2672: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2672.htm + +``cxx_inheriting_constructors`` + Inheriting constructors, as defined in N2540_. + + .. _N2540: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2540.htm + +``cxx_inline_namespaces`` + Inline namespaces, as defined in N2535_. + + .. _N2535: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2535.htm + +``cxx_lambdas`` + Lambda functions, as defined in N2927_. + + .. _N2927: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2009/n2927.pdf + +``cxx_local_type_template_args`` + Local and unnamed types as template arguments, as defined in N2657_. + + .. _N2657: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm + +``cxx_long_long_type`` + ``long long`` type, as defined in N1811_. + + .. _N1811: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1811.pdf + +``cxx_noexcept`` + Exception specifications, as defined in N3050_. + + .. _N3050: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3050.html + +``cxx_nonstatic_member_init`` + Non-static data member initialization, as defined in N2756_. + + .. _N2756: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2756.htm + +``cxx_nullptr`` + Null pointer, as defined in N2431_. + + .. _N2431: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2431.pdf + +``cxx_override`` + Override control ``override`` keyword, as defined in N2928_, N3206_ + and N3272_. + + .. _N2928: https://www.open-std.org/JTC1/SC22/WG21/docs/papers/2009/n2928.htm + .. _N3206: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3206.htm + .. _N3272: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2011/n3272.htm + +``cxx_range_for`` + Range-based for, as defined in N2930_. + + .. _N2930: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2009/n2930.html + +``cxx_raw_string_literals`` + Raw string literals, as defined in N2442_. + + .. _N2442: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2442.htm + +``cxx_reference_qualified_functions`` + Reference qualified functions, as defined in N2439_. + + .. _N2439: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2439.htm + +``cxx_right_angle_brackets`` + Right angle bracket parsing, as defined in N1757_. + + .. _N1757: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1757.html + +``cxx_rvalue_references`` + R-value references, as defined in N2118_. + + .. _N2118: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2118.html + +``cxx_sizeof_member`` + Size of non-static data members, as defined in N2253_. + + .. _N2253: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2253.html + +``cxx_static_assert`` + Static assert, as defined in N1720_. + + .. _N1720: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2004/n1720.html + +``cxx_strong_enums`` + Strongly typed enums, as defined in N2347_. + + .. _N2347: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2347.pdf + +``cxx_thread_local`` + Thread-local variables, as defined in N2659_. + + .. _N2659: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2659.htm + +``cxx_trailing_return_types`` + Automatic function return type, as defined in N2541_. + + .. _N2541: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2541.htm + +``cxx_unicode_literals`` + Unicode string literals, as defined in N2442_. + + .. _N2442: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2442.htm + +``cxx_uniform_initialization`` + Uniform initialization, as defined in N2640_. + + .. _N2640: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2640.pdf + +``cxx_unrestricted_unions`` + Unrestricted unions, as defined in N2544_. + + .. _N2544: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2544.pdf + +``cxx_user_literals`` + User-defined literals, as defined in N2765_. + + .. _N2765: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2765.pdf + +``cxx_variadic_macros`` + Variadic macros, as defined in N1653_. + + .. _N1653: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2004/n1653.htm + +``cxx_variadic_templates`` + Variadic templates, as defined in N2242_. + + .. _N2242: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2242.pdf + + +Individual features from C++ 14 +""""""""""""""""""""""""""""""" + +``cxx_aggregate_default_initializers`` + Aggregate default initializers, as defined in N3605_. + + .. _N3605: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3605.html + +``cxx_attribute_deprecated`` + ``[[deprecated]]`` attribute, as defined in N3760_. + + .. _N3760: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3760.html + +``cxx_binary_literals`` + Binary literals, as defined in N3472_. + + .. _N3472: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2012/n3472.pdf + +``cxx_contextual_conversions`` + Contextual conversions, as defined in N3323_. + + .. _N3323: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2012/n3323.pdf + +``cxx_decltype_auto`` + ``decltype(auto)`` semantics, as defined in N3638_. + + .. _N3638: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3638.html + +``cxx_digit_separators`` + Digit separators, as defined in N3781_. + + .. _N3781: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3781.pdf + +``cxx_generic_lambdas`` + Generic lambdas, as defined in N3649_. + + .. _N3649: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3649.html + +``cxx_lambda_init_captures`` + Initialized lambda captures, as defined in N3648_. + + .. _N3648: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3648.html + +``cxx_relaxed_constexpr`` + Relaxed constexpr, as defined in N3652_. + + .. _N3652: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3652.html + +``cxx_return_type_deduction`` + Return type deduction on normal functions, as defined in N3386_. + + .. _N3386: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2012/n3386.html + +``cxx_variable_templates`` + Variable templates, as defined in N3651_. + + .. _N3651: https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3651.pdf diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7aca9e8342ae7380f9479dee717240f8e79e3317 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst.txt @@ -0,0 +1,57 @@ +CMAKE_C_KNOWN_FEATURES +---------------------- + +.. versionadded:: 3.1 + +List of C features known to this version of CMake. + +The features listed in this global property may be known to be available to the +C compiler. If the feature is available with the C compiler, it will +be listed in the :variable:`CMAKE_C_COMPILE_FEATURES` variable. + +The features listed here may be used with the :command:`target_compile_features` +command. See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +The features known to this version of CMake are listed below. + +High level meta features indicating C standard support +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 3.8 + +``c_std_90`` + Compiler mode is at least C 90. + +``c_std_99`` + Compiler mode is at least C 99. + +``c_std_11`` + Compiler mode is at least C 11. + +``c_std_17`` + .. versionadded:: 3.21 + + Compiler mode is at least C 17. + +``c_std_23`` + .. versionadded:: 3.21 + + Compiler mode is at least C 23. + +.. include:: CMAKE_LANG_STD_FLAGS.txt + +Low level individual compile features +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +``c_function_prototypes`` + Function prototypes, as defined in ``ISO/IEC 9899:1990``. + +``c_restrict`` + ``restrict`` keyword, as defined in ``ISO/IEC 9899:1999``. + +``c_static_assert`` + Static assert, as defined in ``ISO/IEC 9899:2011``. + +``c_variadic_macros`` + Variadic macros, as defined in ``ISO/IEC 9899:1999``. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_HIP_KNOWN_FEATURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_HIP_KNOWN_FEATURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9d13c81dde141a4e3bd101afcf9aac99ad33c448 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_HIP_KNOWN_FEATURES.rst.txt @@ -0,0 +1,42 @@ +CMAKE_HIP_KNOWN_FEATURES +------------------------ + +.. versionadded:: 3.30 + +List of HIP features known to this version of CMake. + +The features listed in this global property may be known to be available to the +HIP compiler. If the feature is available with the HIP compiler, it will +be listed in the :variable:`CMAKE_HIP_COMPILE_FEATURES` variable. + +The features listed here may be used with the :command:`target_compile_features` +command. See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + + +The features known to this version of CMake are: + +``hip_std_98`` + Compiler mode is at least HIP/C++ 98. + +``hip_std_11`` + Compiler mode is at least HIP/C++ 11. + +``hip_std_14`` + Compiler mode is at least HIP/C++ 14. + +``hip_std_17`` + Compiler mode is at least HIP/C++ 17. + +``hip_std_20`` + Compiler mode is at least HIP/C++ 20. + +``hip_std_23`` + Compiler mode is at least HIP/C++ 23. + +``hip_std_26`` + .. versionadded:: 3.30 + + Compiler mode is at least HIP/C++ 26. + +.. include:: CMAKE_LANG_STD_FLAGS.txt diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_ROLE.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_ROLE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3f4492f0c80453545532a4513d0c2cd269f7a795 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/CMAKE_ROLE.rst.txt @@ -0,0 +1,22 @@ +CMAKE_ROLE +---------- + +.. versionadded:: 3.14 + +Tells what mode the current running script is in. Could be one of several +values: + +``PROJECT`` + Running in project mode (processing a ``CMakeLists.txt`` file). + +``SCRIPT`` + Running in ``-P`` script mode. + +``FIND_PACKAGE`` + Running in ``--find-package`` mode. + +``CTEST`` + Running in CTest script mode. + +``CPACK`` + Running in CPack. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/DEBUG_CONFIGURATIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/DEBUG_CONFIGURATIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fec6fdac86a6f269d7048bcaba2c6eb27d4826ba --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/DEBUG_CONFIGURATIONS.rst.txt @@ -0,0 +1,13 @@ +DEBUG_CONFIGURATIONS +-------------------- + +Specify which configurations are for debugging. + +The value must be a semi-colon separated list of configuration names. +Currently this property is used only by the :command:`target_link_libraries` +command. Additional uses may be defined in the future. + +This property must be set at the top level of the project and before +the first :command:`target_link_libraries` command invocation. If any entry in +the list does not match a valid configuration for the project the +behavior is undefined. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/DISABLED_FEATURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/DISABLED_FEATURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..882bbfacde2c5744903fce0c94088dd00c8367e9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/DISABLED_FEATURES.rst.txt @@ -0,0 +1,11 @@ +DISABLED_FEATURES +----------------- + +List of features which are disabled during the CMake run. + +List of features which are disabled during the CMake run. By default +it contains the names of all packages which were not found. This is +determined using the ``_FOUND`` variables. Packages which are +searched ``QUIET`` are not listed. A project can add its own features to +this list. This property is used by the macros in +``FeatureSummary.cmake``. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/ECLIPSE_EXTRA_CPROJECT_CONTENTS.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/ECLIPSE_EXTRA_CPROJECT_CONTENTS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2f110a74e2f075a50cfad502824ab5bc26639aa6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/ECLIPSE_EXTRA_CPROJECT_CONTENTS.rst.txt @@ -0,0 +1,14 @@ +ECLIPSE_EXTRA_CPROJECT_CONTENTS +------------------------------- + +.. versionadded:: 3.12 + +Additional contents to be inserted into the generated Eclipse cproject file. + +The cproject file defines the CDT specific information. Some third party IDE's +are based on Eclipse with the addition of other information specific to that IDE. +Through this property, it is possible to add this additional contents to +the generated project. +It is expected to contain valid XML. + +Also see the :prop_gbl:`ECLIPSE_EXTRA_NATURES` property. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/ECLIPSE_EXTRA_NATURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/ECLIPSE_EXTRA_NATURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a46575ffaa9cc7b5348807af146429b619cfdf0e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/ECLIPSE_EXTRA_NATURES.rst.txt @@ -0,0 +1,10 @@ +ECLIPSE_EXTRA_NATURES +--------------------- + +List of natures to add to the generated Eclipse project file. + +Eclipse projects specify language plugins by using natures. This property +should be set to the unique identifier for a nature (which looks like a Java +package name). + +Also see the :prop_gbl:`ECLIPSE_EXTRA_CPROJECT_CONTENTS` property. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/ENABLED_FEATURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/ENABLED_FEATURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..acbb3d0189bcaee74e39f3a9c8780947ec902332 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/ENABLED_FEATURES.rst.txt @@ -0,0 +1,11 @@ +ENABLED_FEATURES +---------------- + +List of features which are enabled during the CMake run. + +List of features which are enabled during the CMake run. By default +it contains the names of all packages which were found. This is +determined using the ``_FOUND`` variables. Packages which are +searched ``QUIET`` are not listed. A project can add its own features to +this list. This property is used by the macros in +``FeatureSummary.cmake``. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/ENABLED_LANGUAGES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/ENABLED_LANGUAGES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..43e3c09f7f9b1f689f67e2bd39c185cc79c64621 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/ENABLED_LANGUAGES.rst.txt @@ -0,0 +1,6 @@ +ENABLED_LANGUAGES +----------------- + +Read-only property that contains the list of currently enabled languages + +Set to list of currently enabled languages. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_LIB32_PATHS.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_LIB32_PATHS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f6cad66b8195d38d792ce641793d396b11c0c206 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_LIB32_PATHS.rst.txt @@ -0,0 +1,14 @@ +FIND_LIBRARY_USE_LIB32_PATHS +---------------------------- + +.. versionadded:: 3.7 + +Whether the :command:`find_library` command should automatically search +``lib32`` directories. + +``FIND_LIBRARY_USE_LIB32_PATHS`` is a boolean specifying whether the +:command:`find_library` command should automatically search the ``lib32`` +variant of directories called ``lib`` in the search path when building 32-bit +binaries. + +See also the :variable:`CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX` variable. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ed343ba41bd3a347942753ac49af5029e059688c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst.txt @@ -0,0 +1,12 @@ +FIND_LIBRARY_USE_LIB64_PATHS +---------------------------- + +Whether :command:`find_library` should automatically search lib64 +directories. + +FIND_LIBRARY_USE_LIB64_PATHS is a boolean specifying whether the +:command:`find_library` command should automatically search the lib64 +variant of directories called lib in the search path when building +64-bit binaries. + +See also the :variable:`CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX` variable. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_LIBX32_PATHS.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_LIBX32_PATHS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..851f8590258b58c3059db0c5627c1116bda5d21e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_LIBX32_PATHS.rst.txt @@ -0,0 +1,14 @@ +FIND_LIBRARY_USE_LIBX32_PATHS +----------------------------- + +.. versionadded:: 3.9 + +Whether the :command:`find_library` command should automatically search +``libx32`` directories. + +``FIND_LIBRARY_USE_LIBX32_PATHS`` is a boolean specifying whether the +:command:`find_library` command should automatically search the ``libx32`` +variant of directories called ``lib`` in the search path when building +x32-abi binaries. + +See also the :variable:`CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX` variable. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..beb94ac4142ff42b472414a6a7852e76b75efbe7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst.txt @@ -0,0 +1,10 @@ +FIND_LIBRARY_USE_OPENBSD_VERSIONING +----------------------------------- + +Whether :command:`find_library` should find OpenBSD-style shared +libraries. + +This property is a boolean specifying whether the +:command:`find_library` command should find shared libraries with +OpenBSD-style versioned extension: ".so..". The +property is set to true on OpenBSD and false on other platforms. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/GENERATOR_IS_MULTI_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/GENERATOR_IS_MULTI_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..761a1dd2a2d5c12cca778d05a0e719b182414a56 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/GENERATOR_IS_MULTI_CONFIG.rst.txt @@ -0,0 +1,15 @@ +GENERATOR_IS_MULTI_CONFIG +------------------------- + +.. versionadded:: 3.9 + +Read-only property that is true on multi-configuration generators. + +True when using a multi-configuration generator such as: + +* :generator:`Ninja Multi-Config` +* :ref:`Visual Studio Generators` +* :generator:`Xcode` + +Multi-config generators use :variable:`CMAKE_CONFIGURATION_TYPES` +as the set of configurations and ignore :variable:`CMAKE_BUILD_TYPE`. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..832503b5129ea649df6a5413452bd23a0fa2147f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE.rst.txt @@ -0,0 +1,8 @@ +GLOBAL_DEPENDS_DEBUG_MODE +------------------------- + +Enable global target dependency graph debug mode. + +CMake automatically analyzes the global inter-target dependency graph +at the beginning of native build system generation. This property +causes it to display details of its analysis to stderr. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/GLOBAL_DEPENDS_NO_CYCLES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/GLOBAL_DEPENDS_NO_CYCLES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d10661e6295280bb1a2b47d1e1750f1f562deea0 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/GLOBAL_DEPENDS_NO_CYCLES.rst.txt @@ -0,0 +1,10 @@ +GLOBAL_DEPENDS_NO_CYCLES +------------------------ + +Disallow global target dependency graph cycles. + +CMake automatically analyzes the global inter-target dependency graph +at the beginning of native build system generation. It reports an +error if the dependency graph contains a cycle that does not consist +of all STATIC library targets. This property tells CMake to disallow +all cycles completely, even among static libraries. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/INSTALL_PARALLEL.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/INSTALL_PARALLEL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c30d6c9b817b787c7b284f9f4a17dfb6f3e4ba96 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/INSTALL_PARALLEL.rst.txt @@ -0,0 +1,27 @@ +INSTALL_PARALLEL +---------------- + +.. versionadded:: 3.30 + +Enables parallel installation option for a project. The install code for each +subdirectory added with ``add_subdirectory`` can run independently. + +When using the Ninja generator, setting this property to ``ON``, causes +``install/local`` targets have the console pool disabled, allowing them to run +concurrently. + +This property also provides the target ``install/parallel``, which has an +explicit dependency on the ``install/local`` target for each subdirectory. + + .. versionadded:: 3.31 + + When this property is ``ON``, ``cmake --install`` can be given the ``-j `` + or ``--parallel `` option to specify a maximum number of jobs. + The :envvar:`CMAKE_INSTALL_PARALLEL_LEVEL` environment variable specifies a + default parallel level if this option is not provided. + +Calls to :command:`install(CODE)` or :command:`install(SCRIPT)` might depend +on actions performed by an earlier :command:`install` command in a different +directory such as files installed or variable settings. If the project has +such order-dependent installation logic, parallel installation should be +not be enabled, in order to prevent possible race conditions. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/IN_TRY_COMPILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/IN_TRY_COMPILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fd2d2e196843a0a024fa993a8387dff1c0ba1f54 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/IN_TRY_COMPILE.rst.txt @@ -0,0 +1,7 @@ +IN_TRY_COMPILE +-------------- + +Read-only property that is true during a try-compile configuration. + +True when building a project inside a :command:`try_compile` or +:command:`try_run` command. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/JOB_POOLS.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/JOB_POOLS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5dfe6de33df3eddb61c7aaf229a4ec21ca95b844 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/JOB_POOLS.rst.txt @@ -0,0 +1,31 @@ +JOB_POOLS +--------- + +Ninja only: List of available pools. + +A pool is a named integer property and defines the maximum number +of concurrent jobs which can be started by a rule assigned to the pool. +The ``JOB_POOLS`` property is a semicolon-separated list of +pairs using the syntax ``NAME=integer`` (without a space after the equality sign). + +For instance: + +.. code-block:: cmake + + set_property(GLOBAL PROPERTY JOB_POOLS two_jobs=2 ten_jobs=10) + +Defined pools could be used globally by setting +:variable:`CMAKE_JOB_POOL_COMPILE` and :variable:`CMAKE_JOB_POOL_LINK` +or per target by setting the target properties +:prop_tgt:`JOB_POOL_COMPILE` and :prop_tgt:`JOB_POOL_LINK`. +:command:`Custom commands ` and +:command:`custom targets ` can specify pools using the +option ``JOB_POOL``. +Using a pool that is not defined by ``JOB_POOLS`` causes +an error by ninja at build time. + +If not set, this property uses the value of the :variable:`CMAKE_JOB_POOLS` +variable. + +Build targets provided by CMake that are meant for individual interactive +use, such as ``install``, are placed in the ``console`` pool automatically. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/PACKAGES_FOUND.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/PACKAGES_FOUND.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..61cce1fd8d3002d8b9cd54a16cb2ed9f3185718b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/PACKAGES_FOUND.rst.txt @@ -0,0 +1,7 @@ +PACKAGES_FOUND +-------------- + +List of packages which were found during the CMake run. + +List of packages which were found during the CMake run. Whether a +package has been found is determined using the _FOUND variables. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/PACKAGES_NOT_FOUND.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/PACKAGES_NOT_FOUND.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ca3c5bac6f14819dbf81dc32b73a7ad0bed784c3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/PACKAGES_NOT_FOUND.rst.txt @@ -0,0 +1,7 @@ +PACKAGES_NOT_FOUND +------------------ + +List of packages which were not found during the CMake run. + +List of packages which were not found during the CMake run. Whether a +package has been found is determined using the _FOUND variables. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..bf8c9a354fc3a70e56f1ee5b60428558545e34ed --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst.txt @@ -0,0 +1,9 @@ +PREDEFINED_TARGETS_FOLDER +------------------------- + +Name of FOLDER for targets that are added automatically by CMake. + +If not set, CMake uses "CMakePredefinedTargets" as a default value for +this property. Targets such as INSTALL, PACKAGE and RUN_TESTS will be +organized into this FOLDER. See also the documentation for the +:prop_tgt:`FOLDER` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/PROPAGATE_TOP_LEVEL_INCLUDES_TO_TRY_COMPILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/PROPAGATE_TOP_LEVEL_INCLUDES_TO_TRY_COMPILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..edfee175e9664dd35ff584643b88c5c46b047c8e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/PROPAGATE_TOP_LEVEL_INCLUDES_TO_TRY_COMPILE.rst.txt @@ -0,0 +1,19 @@ +PROPAGATE_TOP_LEVEL_INCLUDES_TO_TRY_COMPILE +------------------------------------------- + +.. versionadded:: 3.30 + +When this global property is set to true, the +:variable:`CMAKE_PROJECT_TOP_LEVEL_INCLUDES` variable is propagated into +:command:`try_compile` calls that use the +:ref:`whole-project signature `. +Calls to the :ref:`source file signature ` are not +affected by this property. +``PROPAGATE_TOP_LEVEL_INCLUDES_TO_TRY_COMPILE`` is unset by default. + +For :ref:`dependency providers ` that want to +be enabled in whole-project :command:`try_compile` calls, set this global +property to true just before or after registering the provider. +Note that all files listed in :variable:`CMAKE_PROJECT_TOP_LEVEL_INCLUDES` +will need to be able to handle being included in such :command:`try_compile` +calls, and it is the user's responsibility to ensure this. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/REPORT_UNDEFINED_PROPERTIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/REPORT_UNDEFINED_PROPERTIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..29ba36557f04c55be07bf9236cf5da73b5b881b1 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/REPORT_UNDEFINED_PROPERTIES.rst.txt @@ -0,0 +1,8 @@ +REPORT_UNDEFINED_PROPERTIES +--------------------------- + +If set, report any undefined properties to this file. + +If this property is set to a filename then when CMake runs it will +report any properties or variables that were accessed but not defined +into the filename specified in this property. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/RULE_LAUNCH_COMPILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/RULE_LAUNCH_COMPILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a43e9e554b26657118508f91773931bc14d391a5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/RULE_LAUNCH_COMPILE.rst.txt @@ -0,0 +1,17 @@ +RULE_LAUNCH_COMPILE +------------------- + +Specify a launcher for compile rules. + +.. note:: + This property is intended for internal use by :manual:`ctest(1)`. Projects + and developers should use the :prop_tgt:`_COMPILER_LAUNCHER` target + properties or the associated :variable:`CMAKE__COMPILER_LAUNCHER` + variables instead. + +:ref:`Makefile Generators` and the :generator:`Ninja` generator prefix +compiler commands with the given launcher command line. +This is intended to allow launchers to intercept build problems +with high granularity. Other generators ignore this property +because their underlying build systems provide no hook to wrap +individual commands with a launcher. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/RULE_LAUNCH_CUSTOM.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/RULE_LAUNCH_CUSTOM.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b20c59bcc4234c1b550fc6bf0c3cbf250f5d920a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/RULE_LAUNCH_CUSTOM.rst.txt @@ -0,0 +1,11 @@ +RULE_LAUNCH_CUSTOM +------------------ + +Specify a launcher for custom rules. + +:ref:`Makefile Generators` and the :generator:`Ninja` generator prefix +custom commands with the given launcher command line. +This is intended to allow launchers to intercept build problems +with high granularity. Other generators ignore this property +because their underlying build systems provide no hook to wrap +individual commands with a launcher. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/RULE_LAUNCH_LINK.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/RULE_LAUNCH_LINK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..da376fe5faccb7268170914ba478e34927fd6a73 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/RULE_LAUNCH_LINK.rst.txt @@ -0,0 +1,17 @@ +RULE_LAUNCH_LINK +---------------- + +Specify a launcher for link rules. + +.. note:: + This property is intended for internal use by :manual:`ctest(1)`. Projects + and developers should use the :prop_tgt:`_LINKER_LAUNCHER` target + properties or the associated :variable:`CMAKE__LINKER_LAUNCHER` + variables instead. + +:ref:`Makefile Generators` and the :generator:`Ninja` generator prefix +link and archive commands with the given launcher command line. +This is intended to allow launchers to intercept build problems +with high granularity. Other generators ignore this property +because their underlying build systems provide no hook to wrap +individual commands with a launcher. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/RULE_MESSAGES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/RULE_MESSAGES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a9734a73028ca1f6e67dbad64598265876cf6967 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/RULE_MESSAGES.rst.txt @@ -0,0 +1,13 @@ +RULE_MESSAGES +------------- + +Specify whether to report a message for each make rule. + +This property specifies whether Makefile generators should add a +progress message describing what each build rule does. If the +property is not set the default is ON. Set the property to OFF to +disable granular messages and report only as each target completes. +This is intended to allow scripted builds to avoid the build time cost +of detailed reports. If a :variable:`CMAKE_RULE_MESSAGES` cache entry exists +its value initializes the value of this property. Non-Makefile +generators currently ignore this property. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..930febae718aba2a7c6252dea46380a0164afb8e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS.rst.txt @@ -0,0 +1,7 @@ +TARGET_ARCHIVES_MAY_BE_SHARED_LIBS +---------------------------------- + +Set if shared libraries may be named like archives. + +On AIX shared libraries may be named "lib.a". This property is +set to true on such platforms. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/TARGET_MESSAGES.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/TARGET_MESSAGES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..bb917723e33ea37940e959fa0ec2145cb1ce12f0 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/TARGET_MESSAGES.rst.txt @@ -0,0 +1,22 @@ +TARGET_MESSAGES +--------------- + +.. versionadded:: 3.4 + +Specify whether to report the completion of each target. + +This property specifies whether :ref:`Makefile Generators` should +add a progress message describing that each target has been completed. +If the property is not set the default is ``ON``. Set the property +to ``OFF`` to disable target completion messages. + +This option is intended to reduce build output when little or no +work needs to be done to bring the build tree up to date. + +If a ``CMAKE_TARGET_MESSAGES`` cache entry exists its value +initializes the value of this property. + +Non-Makefile generators currently ignore this property. + +See the counterpart property :prop_gbl:`RULE_MESSAGES` to disable +everything except for target completion messages. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/TARGET_SUPPORTS_SHARED_LIBS.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/TARGET_SUPPORTS_SHARED_LIBS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6846b631db534c64ccf9257b5ac615317510d3e5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/TARGET_SUPPORTS_SHARED_LIBS.rst.txt @@ -0,0 +1,9 @@ +TARGET_SUPPORTS_SHARED_LIBS +--------------------------- + +Does the target platform support shared libraries. + +``TARGET_SUPPORTS_SHARED_LIBS`` is a boolean specifying whether the target +platform supports shared libraries. Basically all current general +purpose OS do so, the exceptions are usually embedded systems +with no or special OSs. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/USE_FOLDERS.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/USE_FOLDERS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6f5a083fbcaeb73324209438958d69dacae42a56 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/USE_FOLDERS.rst.txt @@ -0,0 +1,17 @@ +USE_FOLDERS +----------- + +Controls whether to use the :prop_tgt:`FOLDER` target property to organize +targets into folders. The value of ``USE_FOLDERS`` at the end of the top level +``CMakeLists.txt`` file is what determines the behavior. + +.. versionchanged:: 3.26 + + CMake treats this property as ``ON`` by default. + See policy :policy:`CMP0143`. + +Not all CMake generators support recording folder details for targets. +The :generator:`Xcode` and :ref:`Visual Studio ` +generators are examples of generators that do. Similarly, not all IDEs +support presenting targets using folder hierarchies, even if the CMake +generator used provides the necessary information. diff --git a/cmake/doc/cmake/html/_sources/prop_gbl/XCODE_EMIT_EFFECTIVE_PLATFORM_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_gbl/XCODE_EMIT_EFFECTIVE_PLATFORM_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6794a264e79f28eb78ae93e435638835ee34fe0b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_gbl/XCODE_EMIT_EFFECTIVE_PLATFORM_NAME.rst.txt @@ -0,0 +1,27 @@ +XCODE_EMIT_EFFECTIVE_PLATFORM_NAME +---------------------------------- + +.. versionadded:: 3.8 + +Control emission of ``EFFECTIVE_PLATFORM_NAME`` by the :generator:`Xcode` +generator. + +It is required for building the same target with multiple SDKs. A +common use case is the parallel use of ``iphoneos`` and +``iphonesimulator`` SDKs. + +Three different states possible that control when the :generator:`Xcode` +generator emits the ``EFFECTIVE_PLATFORM_NAME`` variable: + +- If set to ``ON`` it will always be emitted +- If set to ``OFF`` it will never be emitted +- If unset (the default) it will only be emitted when the project was + configured for an embedded Xcode SDK like iOS, tvOS, visionOS, watchOS + or any of the simulators. + +.. note:: + + When this behavior is enable for generated Xcode projects, the + ``EFFECTIVE_PLATFORM_NAME`` variable will leak into + :manual:`Generator expressions ` + like ``TARGET_FILE`` and will render those mostly unusable. diff --git a/cmake/doc/cmake/html/_sources/prop_inst/CPACK_DESKTOP_SHORTCUTS.rst.txt b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_DESKTOP_SHORTCUTS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..55e9a20ff4153ad5b715e78c1335febcd7dda351 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_DESKTOP_SHORTCUTS.rst.txt @@ -0,0 +1,9 @@ +CPACK_DESKTOP_SHORTCUTS +----------------------- + +.. versionadded:: 3.3 + +Species a list of shortcut names that should be created on the `Desktop` +for this file. + +The property is currently only supported by the :cpack_gen:`CPack WIX Generator`. diff --git a/cmake/doc/cmake/html/_sources/prop_inst/CPACK_NEVER_OVERWRITE.rst.txt b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_NEVER_OVERWRITE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..12eef9ec26f0325e121aec268e9e6b9ebd9652fa --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_NEVER_OVERWRITE.rst.txt @@ -0,0 +1,8 @@ +CPACK_NEVER_OVERWRITE +--------------------- + +.. versionadded:: 3.1 + +Request that this file not be overwritten on install or reinstall. + +The property is currently only supported by the :cpack_gen:`CPack WIX Generator`. diff --git a/cmake/doc/cmake/html/_sources/prop_inst/CPACK_PERMANENT.rst.txt b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_PERMANENT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e89c55200db1e582d716b6a3ee7c80a1f4249dce --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_PERMANENT.rst.txt @@ -0,0 +1,8 @@ +CPACK_PERMANENT +--------------- + +.. versionadded:: 3.1 + +Request that this file not be removed on uninstall. + +The property is currently only supported by the :cpack_gen:`CPack WIX Generator`. diff --git a/cmake/doc/cmake/html/_sources/prop_inst/CPACK_STARTUP_SHORTCUTS.rst.txt b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_STARTUP_SHORTCUTS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e896acdd4d861ae87e25fd5c6741440fb7eb49d9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_STARTUP_SHORTCUTS.rst.txt @@ -0,0 +1,9 @@ +CPACK_STARTUP_SHORTCUTS +----------------------- + +.. versionadded:: 3.3 + +Species a list of shortcut names that should be created in the `Startup` folder +for this file. + +The property is currently only supported by the :cpack_gen:`CPack WIX Generator`. diff --git a/cmake/doc/cmake/html/_sources/prop_inst/CPACK_START_MENU_SHORTCUTS.rst.txt b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_START_MENU_SHORTCUTS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e70eeb4d71682c7ae2e4a5a51032e241cbac58be --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_START_MENU_SHORTCUTS.rst.txt @@ -0,0 +1,9 @@ +CPACK_START_MENU_SHORTCUTS +-------------------------- + +.. versionadded:: 3.3 + +Species a list of shortcut names that should be created in the ``Start Menu`` +for this file. + +The property is currently only supported by the :cpack_gen:`CPack WIX Generator`. diff --git a/cmake/doc/cmake/html/_sources/prop_inst/CPACK_WIX_ACL.rst.txt b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_WIX_ACL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a82191ae40d72c8860f15011a82d9e52f689f0a0 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_inst/CPACK_WIX_ACL.rst.txt @@ -0,0 +1,23 @@ +CPACK_WIX_ACL +------------- + +.. versionadded:: 3.1 + +Specifies access permissions for files or directories +installed by a WiX installer. + +The property can contain multiple list entries, +each of which has to match the following format. + +:: + + [@]=[,] + +```` and ```` specify the windows user and domain for which the +```` element should be generated. + +```` is any of the YesNoType attributes listed here:: + + https://wixtoolset.org/documentation/manual/v3/xsd/wix/permission.html + +The property is currently only supported by the :cpack_gen:`CPack WIX Generator`. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/ABSTRACT.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/ABSTRACT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..339d11528752e38b7d721296b2c168542b323a67 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/ABSTRACT.rst.txt @@ -0,0 +1,9 @@ +ABSTRACT +-------- + +Is this source file an abstract class. + +A property on a source file that indicates if the source file +represents a class that is abstract. This only makes sense for +languages that have a notion of an abstract class and it is only used +by some tools that wrap classes into other languages. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/AUTORCC_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/AUTORCC_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2bec033e4657eb70200e526c8c1af149c6fc413b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/AUTORCC_OPTIONS.rst.txt @@ -0,0 +1,22 @@ +AUTORCC_OPTIONS +--------------- + +Additional options for ``rcc`` when using :prop_tgt:`AUTORCC` + +This property holds additional command line options which will be used when +``rcc`` is executed during the build via :prop_tgt:`AUTORCC`, i.e. it is equivalent to the +optional ``OPTIONS`` argument of the :module:`qt4_add_resources() ` macro. + +By default it is empty. + +The options set on the ``.qrc`` source file may override +:prop_tgt:`AUTORCC_OPTIONS` set on the target. + +EXAMPLE +^^^^^^^ + +.. code-block:: cmake + + # ... + set_property(SOURCE resources.qrc PROPERTY AUTORCC_OPTIONS "--compress;9") + # ... diff --git a/cmake/doc/cmake/html/_sources/prop_sf/AUTOUIC_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/AUTOUIC_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e2f47ecd291191a1076989bc104674e921a3495c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/AUTOUIC_OPTIONS.rst.txt @@ -0,0 +1,23 @@ +AUTOUIC_OPTIONS +--------------- + +Additional options for ``uic`` when using :prop_tgt:`AUTOUIC` + +This property holds additional command line options +which will be used when ``uic`` is executed during the build via +:prop_tgt:`AUTOUIC`, i.e. it is equivalent to the optional ``OPTIONS`` +argument of the :module:`qt4_wrap_ui() ` macro. + +By default it is empty. + +The options set on the ``.ui`` source file may override +:prop_tgt:`AUTOUIC_OPTIONS` set on the target. + +EXAMPLE +^^^^^^^ + +.. code-block:: cmake + + # ... + set_property(SOURCE widget.ui PROPERTY AUTOUIC_OPTIONS "--no-protection") + # ... diff --git a/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_DEFINITIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_DEFINITIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2af896ebf4b885502b57761443c256dee973afb4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_DEFINITIONS.rst.txt @@ -0,0 +1,32 @@ +COMPILE_DEFINITIONS +------------------- + +Preprocessor definitions for compiling a source file. + +The ``COMPILE_DEFINITIONS`` property may be set to a semicolon-separated +list of preprocessor definitions using the syntax ``VAR`` or ``VAR=value``. +Function-style definitions are not supported. CMake will +automatically escape the value correctly for the native build system +(note that CMake language syntax may require escapes to specify some +values). This property may be set on a per-configuration basis using +the name ``COMPILE_DEFINITIONS_`` where ```` is an upper-case +name (ex. ``COMPILE_DEFINITIONS_DEBUG``). + +CMake will automatically drop some definitions that are not supported +by the native build tool. Xcode does not support per-configuration +definitions on source files. + +.. versionadded:: 3.26 + Any leading ``-D`` on an item will be removed. + +.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt + +Contents of ``COMPILE_DEFINITIONS`` may use :manual:`cmake-generator-expressions(7)` +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. However, :generator:`Xcode` +does not support per-config per-source settings, so expressions +that depend on the build configuration are not allowed with that +generator. + +Generator expressions should be preferred instead of setting the alternative per-configuration +property. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_DEFINITIONS_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_DEFINITIONS_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ec867b65d900d4719ba681c7c683ad890108cdab --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_DEFINITIONS_CONFIG.rst.txt @@ -0,0 +1,10 @@ +COMPILE_DEFINITIONS_ +---------------------------- + +Ignored. See CMake Policy :policy:`CMP0043`. + +Per-configuration preprocessor definitions on a source file. + +This is the configuration-specific version of :prop_tgt:`COMPILE_DEFINITIONS`. +Note that :generator:`Xcode` does not support per-configuration source +file flags so this property will be ignored by the :generator:`Xcode` generator. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_FLAGS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_FLAGS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..1d3def47b475b53702938cc4913c4de2023e05f8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_FLAGS.rst.txt @@ -0,0 +1,21 @@ +COMPILE_FLAGS +------------- + +Additional flags to be added when compiling this source file. + +The ``COMPILE_FLAGS`` property, managed as a string, sets additional compiler +flags used that will be added to the list of compile flags when this source +file builds. The flags will be added after target-wide flags. + +Use :prop_sf:`COMPILE_DEFINITIONS` to pass additional preprocessor definitions. + +Contents of ``COMPILE_FLAGS`` may use "generator expressions" +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. However, :generator:`Xcode` +does not support per-config per-source settings, so expressions +that depend on the build configuration are not allowed with that +generator. + +.. note:: + + This property has been superseded by the :prop_sf:`COMPILE_OPTIONS` property. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9b00e0ebb9f08fbfb7e3f08a21b87fded060e55e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/COMPILE_OPTIONS.rst.txt @@ -0,0 +1,34 @@ +COMPILE_OPTIONS +--------------- + +.. versionadded:: 3.11 + +List of additional options to pass to the compiler. + +This property holds a :ref:`semicolon-separated list ` +of options and will be added to the list of compile flags when this source +file builds. The options will be added after target-wide options. + +Contents of ``COMPILE_OPTIONS`` may use "generator expressions" with the +syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual +for available expressions. However, :generator:`Xcode` +does not support per-config per-source settings, so expressions +that depend on the build configuration are not allowed with that +generator. + +Usage example: + +.. code-block:: cmake + + set_source_files_properties(foo.cpp PROPERTIES COMPILE_OPTIONS "-Wno-unused-parameter;-Wno-missing-field-initializer") + +Related properties: + +* Prefer this property over :prop_sf:`COMPILE_FLAGS`. +* Use :prop_sf:`COMPILE_DEFINITIONS` to pass additional preprocessor definitions. +* Use :prop_sf:`INCLUDE_DIRECTORIES` to pass additional include directories. + +Related commands: + +* :command:`add_compile_options` for directory-wide settings +* :command:`target_compile_options` for target-specific settings diff --git a/cmake/doc/cmake/html/_sources/prop_sf/CXX_SCAN_FOR_MODULES.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/CXX_SCAN_FOR_MODULES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d10969a043182dd26b271c0b2527fe0f54c56e45 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/CXX_SCAN_FOR_MODULES.rst.txt @@ -0,0 +1,18 @@ +CXX_SCAN_FOR_MODULES +-------------------- + +.. versionadded:: 3.28 + +``CXX_SCAN_FOR_MODULES`` is a boolean specifying whether CMake will scan the +source for C++ module dependencies. See also the +:prop_tgt:`CXX_SCAN_FOR_MODULES` for target-wide settings. + +When this property is set ``ON``, CMake will scan the source at build time and +add module dependency information to the compile line as necessary. When this +property is set ``OFF``, CMake will not scan the source at build time. When +this property is unset, the :prop_tgt:`CXX_SCAN_FOR_MODULES` property is +consulted. + +Note that scanning is only performed if C++20 or higher is enabled for the +target and the source uses the ``CXX`` language. Scanning for modules in +sources belonging to file sets of type ``CXX_MODULES`` is always performed. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/EXTERNAL_OBJECT.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/EXTERNAL_OBJECT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..351c04d515a61606fce2503dba536f108cc3ff4a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/EXTERNAL_OBJECT.rst.txt @@ -0,0 +1,8 @@ +EXTERNAL_OBJECT +--------------- + +If set to true then this is an object file. + +If this property is set to ``True`` then the source file is really an +object file and should not be compiled. It will still be linked into +the target though. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/Fortran_FORMAT.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/Fortran_FORMAT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ef33926190dbda93cce142241db13afb29a38106 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/Fortran_FORMAT.rst.txt @@ -0,0 +1,12 @@ +Fortran_FORMAT +-------------- + +Set to ``FIXED`` or ``FREE`` to indicate the Fortran source layout. + +This property tells CMake whether a given Fortran source file uses +fixed-format or free-format. CMake will pass the corresponding format flag +to the compiler. Consider using the target-wide :prop_tgt:`Fortran_FORMAT` +property if all source files in a target share the same format. + +.. note:: For some compilers, ``NAG``, ``PGI`` and ``Solaris Studio``, + setting this to ``OFF`` will have no effect. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/Fortran_PREPROCESS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/Fortran_PREPROCESS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..548a97b147da35c8f281d558a95b68af72e820db --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/Fortran_PREPROCESS.rst.txt @@ -0,0 +1,19 @@ +Fortran_PREPROCESS +------------------ + +.. versionadded:: 3.18 + +Control whether the Fortran source file should be unconditionally preprocessed. + +If unset or empty, rely on the compiler to determine whether the file +should be preprocessed. If explicitly set to ``OFF`` then the file +does not need to be preprocessed. If explicitly set to ``ON``, then +the file does need to be preprocessed as part of the compilation step. + +When using the :generator:`Ninja` generator, all source files are +first preprocessed in order to generate module dependency +information. Setting this property to ``OFF`` will make ``Ninja`` +skip this step. + +Consider using the target-wide :prop_tgt:`Fortran_PREPROCESS` property +if all source files in a target need to be preprocessed. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/GENERATED.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/GENERATED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..566b58a0a49b0c27cab9c82f6fc0fbb9de237ccb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/GENERATED.rst.txt @@ -0,0 +1,49 @@ +GENERATED +--------- + +Is this source file generated as part of the build or CMake process. + +.. versionchanged:: 3.20 + Turning on the ``GENERATED`` source file property in one directory allows + the associated source file to be used across directories without the need + to manually setting that property for other directory scopes, too. + Additionally, it may now be set only to boolean values, and may not be + turned off once turned on. See policy :policy:`CMP0118`. + +.. versionchanged:: 3.30 + Whether or not a source file is generated is an all-or-nothing global + property of the source. Consequently, the ``GENERATED`` source file + property is now visible in all directories. See policy :policy:`CMP0163`. + +Tells the internal CMake engine that a source file is generated by an outside +process such as another build step, or the execution of CMake itself. +This information is then used to exempt the file from any existence or +validity checks. + +Any file that is + +- created by the execution of commands such as + :command:`add_custom_command` which run during the build +- listed as one of the ``BYPRODUCTS`` of an :command:`add_custom_command` + or :command:`add_custom_target` command, or +- created by a CMake ``AUTOGEN`` operation such as :prop_tgt:`AUTOMOC`, + :prop_tgt:`AUTORCC`, or :prop_tgt:`AUTOUIC` + +will be marked with the ``GENERATED`` property. + +When a generated file created as the ``OUTPUT`` of an +:command:`add_custom_command` command is explicitly listed as a source file +for any target in the same directory scope (which usually means the same +``CMakeLists.txt`` file), CMake will automatically create a dependency to +make sure the file is generated before building that target. + +The :ref:`Makefile Generators` will remove ``GENERATED`` files during +``make clean``. + +Generated sources may be hidden in some IDE tools, while in others they might +be shown. For the special case of sources generated by CMake's :prop_tgt:`AUTOMOC`, +:prop_tgt:`AUTORCC` or :prop_tgt:`AUTOUIC` functionality, the +:prop_gbl:`AUTOGEN_SOURCE_GROUP`, :prop_gbl:`AUTOMOC_SOURCE_GROUP`, +:prop_gbl:`AUTORCC_SOURCE_GROUP` and :prop_gbl:`AUTOUIC_SOURCE_GROUP` target +properties may influence where the generated sources are grouped in the project's +file lists. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/HEADER_FILE_ONLY.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/HEADER_FILE_ONLY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..71d62ae800f86162a1311c7ed8d3747a3fc7abb4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/HEADER_FILE_ONLY.rst.txt @@ -0,0 +1,24 @@ +HEADER_FILE_ONLY +---------------- + +Is this source file only a header file. + +A property on a source file that indicates if the source file is a +header file with no associated implementation. This is set +automatically based on the file extension and is used by CMake to +determine if certain dependency information should be computed. + +By setting this property to ``ON``, you can disable compilation of +the given source file, even if it should be compiled because it is +part of the library's/executable's sources. + +This is useful if you have some source files which you somehow +pre-process, and then add these pre-processed sources via +:command:`add_library` or :command:`add_executable`. Normally, in IDE, +there would be no reference of the original sources, only of these +pre-processed sources. So by setting this property for all the original +source files to ``ON``, and then either calling :command:`add_library` +or :command:`add_executable` while passing both the pre-processed +sources and the original sources, or by using :command:`target_sources` +to add original source files will do exactly what would one expect, i.e. +the original source files would be visible in IDE, and will not be built. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/INCLUDE_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/INCLUDE_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..89ffd15605b072c508f6ce0b97d3588e8bab841b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/INCLUDE_DIRECTORIES.rst.txt @@ -0,0 +1,20 @@ +INCLUDE_DIRECTORIES +------------------- + +.. versionadded:: 3.11 + +List of preprocessor include file search directories. + +This property holds a :ref:`semicolon-separated list ` of paths +and will be added to the list of include directories when this +source file builds. These directories will take precedence over directories +defined at target level except for :generator:`Xcode` generator due to technical +limitations. + +Relative paths should not be added to this property directly. + +Contents of ``INCLUDE_DIRECTORIES`` may use "generator expressions" with +the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual +for available expressions. However, :generator:`Xcode` does not support +per-config per-source settings, so expressions that depend on the build +configuration are not allowed with that generator. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/KEEP_EXTENSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/KEEP_EXTENSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a32f96834d12d65b54b3a26ebe89323fab934833 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/KEEP_EXTENSION.rst.txt @@ -0,0 +1,9 @@ +KEEP_EXTENSION +-------------- + +Make the output file have the same extension as the source file. + +If this property is set then the file extension of the output file +will be the same as that of the source file. Normally the output file +extension is computed based on the language of the source file, for +example ``.cxx`` will go to a ``.o`` extension. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/LABELS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/LABELS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d0d2a0a926e8d8713d1e060df3157f47e6ab8934 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/LABELS.rst.txt @@ -0,0 +1,8 @@ +LABELS +------ + +Specify a list of text labels associated with a source file. + +This property has meaning only when the source file is listed in a +target whose ``LABELS`` property is also set. No other semantics are +currently specified. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/LANGUAGE.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/LANGUAGE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..92bd227e0f172e790a3c5b4d384f35bbd8d8ca76 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/LANGUAGE.rst.txt @@ -0,0 +1,17 @@ +LANGUAGE +-------- + +Specify the programming language in which a source file is written. + +A property that can be set to indicate what programming language the +source file is. If it is not set the language is determined based on +the file extension. Typical values are ``CXX`` (i.e. C++), ``C``, +``CSharp``, ``CUDA``, ``Fortran``, ``HIP``, ``ISPC``, and ``ASM``. Setting +this property for a file means this file will be compiled, unless +:prop_sf:`HEADER_FILE_ONLY` is set. + +.. versionchanged:: 3.20 + Setting this property causes the source file to be compiled as the + specified language, using explicit flags if possible. Previously it + only caused the specified language's compiler to be used. + See policy :policy:`CMP0119`. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/LOCATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/LOCATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..252d6802404f8f4ebfca37193b76f39fcc8a183f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/LOCATION.rst.txt @@ -0,0 +1,7 @@ +LOCATION +-------- + +The full path to a source file. + +A read only property on a SOURCE FILE that contains the full path to +the source file. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/MACOSX_PACKAGE_LOCATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/MACOSX_PACKAGE_LOCATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d185d91978bf83d73f1cb79e34faf9dfd186768a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/MACOSX_PACKAGE_LOCATION.rst.txt @@ -0,0 +1,30 @@ +MACOSX_PACKAGE_LOCATION +----------------------- + +Place a source file inside a Application Bundle +(:prop_tgt:`MACOSX_BUNDLE`), Core Foundation Bundle (:prop_tgt:`BUNDLE`), +or Framework Bundle (:prop_tgt:`FRAMEWORK`). It is applicable for macOS +and iOS. + +Executable targets with the :prop_tgt:`MACOSX_BUNDLE` property set are +built as macOS or iOS application bundles on Apple platforms. Shared +library targets with the :prop_tgt:`FRAMEWORK` property set are built as +macOS or iOS frameworks on Apple platforms. Module library targets with +the :prop_tgt:`BUNDLE` property set are built as macOS ``CFBundle`` bundles +on Apple platforms. Source files listed in the target with this property +set will be copied to a directory inside the bundle or framework content +folder specified by the property value. For macOS Application Bundles the +content folder is ``.app/Contents``. For macOS Frameworks the +content folder is ``.framework/Versions/``. For macOS +CFBundles the content folder is ``.bundle/Contents`` (unless the +extension is changed). See the :prop_tgt:`PUBLIC_HEADER`, +:prop_tgt:`PRIVATE_HEADER`, and :prop_tgt:`RESOURCE` target properties for +specifying files meant for ``Headers``, ``PrivateHeaders``, or +``Resources`` directories. + +If the specified location is equal to ``Resources``, the resulting location +will be the same as if the :prop_tgt:`RESOURCE` property had been used. If +the specified location is a sub-folder of ``Resources``, it will be placed +into the respective sub-folder. Note: For iOS Apple uses a flat bundle layout +where no ``Resources`` folder exist. Therefore CMake strips the ``Resources`` +folder name from the specified location. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/OBJECT_DEPENDS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/OBJECT_DEPENDS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..aaff95659d1e8d7f362683f575a0e78f396a8d7e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/OBJECT_DEPENDS.rst.txt @@ -0,0 +1,21 @@ +OBJECT_DEPENDS +-------------- + +Additional files on which a compiled object file depends. + +Specifies a :ref:`semicolon-separated list ` of full-paths to +files on which any object files compiled from this source file depend. +On :ref:`Makefile Generators` and the :generator:`Ninja` generator an +object file will be recompiled if any of the named files is newer than it. +:ref:`Visual Studio Generators` and the :generator:`Xcode` generator +cannot implement such compilation dependencies. + +This property need not be used to specify the dependency of a source +file on a generated header file that it includes. Although the +property was originally introduced for this purpose, it is no longer +necessary. If the generated header file is created by a custom +command in the same target as the source file, the automatic +dependency scanning process will recognize the dependency. If the +generated header file is created by another target, an inter-target +dependency should be created with the :command:`add_dependencies` +command (if one does not already exist due to linking relationships). diff --git a/cmake/doc/cmake/html/_sources/prop_sf/OBJECT_OUTPUTS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/OBJECT_OUTPUTS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3e799ed88647f1b15991e8ce6176fff69df334b3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/OBJECT_OUTPUTS.rst.txt @@ -0,0 +1,12 @@ +OBJECT_OUTPUTS +-------------- + +Additional outputs for a :generator:`Ninja` or :ref:`Makefile Generators` rule. + +Additional outputs created by compilation of this source file. If any +of these outputs is missing the object will be recompiled. This is +supported only on the :generator:`Ninja` and :ref:`Makefile Generators` +and will be ignored on other generators. + +This property supports +:manual:`generator expressions `. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTOGEN.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTOGEN.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2173f59964f385596dc209280a3d83f0f2f4e096 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTOGEN.rst.txt @@ -0,0 +1,19 @@ +SKIP_AUTOGEN +------------ + +.. versionadded:: 3.8 + +Exclude the source file from :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTOUIC` and +:prop_tgt:`AUTORCC` processing (for Qt projects). + +For finer exclusion control see :prop_sf:`SKIP_AUTOMOC`, +:prop_sf:`SKIP_AUTOUIC` and :prop_sf:`SKIP_AUTORCC`. + +EXAMPLE +^^^^^^^ + +.. code-block:: cmake + + # ... + set_property(SOURCE file.h PROPERTY SKIP_AUTOGEN ON) + # ... diff --git a/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTOMOC.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTOMOC.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e92cfe0d70a5e4df93ba42369985b30a230f0a51 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTOMOC.rst.txt @@ -0,0 +1,17 @@ +SKIP_AUTOMOC +------------ + +.. versionadded:: 3.8 + +Exclude the source file from :prop_tgt:`AUTOMOC` processing (for Qt projects). + +For broader exclusion control see :prop_sf:`SKIP_AUTOGEN`. + +EXAMPLE +^^^^^^^ + +.. code-block:: cmake + + # ... + set_property(SOURCE file.h PROPERTY SKIP_AUTOMOC ON) + # ... diff --git a/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTORCC.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTORCC.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2829c259dfbc8cf44e88dacb2085a4fa470b42e3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTORCC.rst.txt @@ -0,0 +1,17 @@ +SKIP_AUTORCC +------------ + +.. versionadded:: 3.8 + +Exclude the source file from :prop_tgt:`AUTORCC` processing (for Qt projects). + +For broader exclusion control see :prop_sf:`SKIP_AUTOGEN`. + +EXAMPLE +^^^^^^^ + +.. code-block:: cmake + + # ... + set_property(SOURCE file.qrc PROPERTY SKIP_AUTORCC ON) + # ... diff --git a/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTOUIC.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTOUIC.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..45ed3f8a52902321d43352a9d98f49b68be361ee --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_AUTOUIC.rst.txt @@ -0,0 +1,22 @@ +SKIP_AUTOUIC +------------ + +.. versionadded:: 3.8 + +Exclude the source file from :prop_tgt:`AUTOUIC` processing (for Qt projects). + +``SKIP_AUTOUIC`` can be set on C++ header and source files and on +``.ui`` files. + +For broader exclusion control see :prop_sf:`SKIP_AUTOGEN`. + +EXAMPLE +^^^^^^^ + +.. code-block:: cmake + + # ... + set_property(SOURCE file.h PROPERTY SKIP_AUTOUIC ON) + set_property(SOURCE file.cpp PROPERTY SKIP_AUTOUIC ON) + set_property(SOURCE widget.ui PROPERTY SKIP_AUTOUIC ON) + # ... diff --git a/cmake/doc/cmake/html/_sources/prop_sf/SKIP_LINTING.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_LINTING.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0e0a616f5efb8d2a981978da422356fbc98f4fbf --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_LINTING.rst.txt @@ -0,0 +1,42 @@ +SKIP_LINTING +------------ + +.. versionadded:: 3.27 + +This property allows you to exclude a specific source file +from the linting process. The linting process involves running +tools such as :prop_tgt:`_CPPLINT`, :prop_tgt:`_CLANG_TIDY`, +:prop_tgt:`_CPPCHECK`, and :prop_tgt:`_INCLUDE_WHAT_YOU_USE` +on the source files, as well as compiling header files as part of +:prop_tgt:`VERIFY_INTERFACE_HEADER_SETS`. By setting ``SKIP_LINTING`` on a +source file, the mentioned linting tools will not be executed for that +particular file. + +Example +^^^^^^^ + +Consider a C++ project that includes multiple source files, +such as ``main.cpp``, ``things.cpp``, and ``generatedBindings.cpp``. +In this example, you want to exclude the ``generatedBindings.cpp`` +file from the linting process. To achieve this, you can utilize +the ``SKIP_LINTING`` property with the :command:`set_source_files_properties` +command as shown below: + +.. code-block:: cmake + + add_executable(MyApp main.cpp things.cpp generatedBindings.cpp) + + set_source_files_properties(generatedBindings.cpp PROPERTIES + SKIP_LINTING ON + ) + +In the provided code snippet, the ``SKIP_LINTING`` property is set to true +for the ``generatedBindings.cpp`` source file. As a result, when the linting +tools specified by :prop_tgt:`_CPPLINT`, :prop_tgt:`_CLANG_TIDY`, +:prop_tgt:`_CPPCHECK`, or :prop_tgt:`_INCLUDE_WHAT_YOU_USE` +are executed, they will skip analyzing the ``generatedBindings.cpp`` file. + +By using the ``SKIP_LINTING`` property, you can selectively exclude specific +source files from the linting process. This allows you to focus the +linting tools on the relevant parts of your project, enhancing the efficiency +and effectiveness of the linting workflow. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/SKIP_PRECOMPILE_HEADERS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_PRECOMPILE_HEADERS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..660de3fe404929da84e4942cc8747971623a4a2b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_PRECOMPILE_HEADERS.rst.txt @@ -0,0 +1,15 @@ +SKIP_PRECOMPILE_HEADERS +----------------------- + +.. versionadded:: 3.16 + +Is this source file skipped by :prop_tgt:`PRECOMPILE_HEADERS` feature. + +This property helps with build problems that one would run into +when using the :prop_tgt:`PRECOMPILE_HEADERS` feature. + +One example would be the usage of Objective-C (``*.m``) files, and +Objective-C++ (``*.mm``) files, which lead to compilation failure +because they are treated (in case of Ninja / Makefile generator) +as C, and CXX respectively. The precompile headers are not +compatible between languages. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..38a0a7800d4a8260d614aa0be4551deb7c4fe1dd --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst.txt @@ -0,0 +1,17 @@ +SKIP_UNITY_BUILD_INCLUSION +-------------------------- + +.. versionadded:: 3.16 + +Setting this property to true ensures the source file will be skipped by +unity builds when its associated target has its :prop_tgt:`UNITY_BUILD` +property set to true. The source file will instead be compiled on its own +in the same way as it would with unity builds disabled. + +This property helps with "ODR (One definition rule)" problems where combining +a particular source file with others might lead to build errors or other +unintended side effects. + +Note that sources which are scanned for C++ modules (see +:manual:`cmake-cxxmodules(7)`) are not eligible for unity build inclusion and +will automatically be excluded. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/SYMBOLIC.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/SYMBOLIC.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8bebe30bb424a4b65408dcd030e7dc5186ca770b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/SYMBOLIC.rst.txt @@ -0,0 +1,8 @@ +SYMBOLIC +-------- + +Is this just a name for a rule. + +If ``SYMBOLIC`` (boolean) is set to ``True`` the build system will be informed +that the source file is not actually created on disk but instead used +as a symbolic name for a build rule. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/Swift_DEPENDENCIES_FILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/Swift_DEPENDENCIES_FILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a90c7ebcb6b11607092cf08c8cf4332e61872cf0 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/Swift_DEPENDENCIES_FILE.rst.txt @@ -0,0 +1,7 @@ +Swift_DEPENDENCIES_FILE +----------------------- + +.. versionadded:: 3.15 + +This property sets the path for the Swift dependency file (swiftdeps) for the +source. If one is not specified, it will default to ``.swiftdeps``. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/Swift_DIAGNOSTICS_FILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/Swift_DIAGNOSTICS_FILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..47d5ac378485401d39fe7b1c072db0d9ae85351f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/Swift_DIAGNOSTICS_FILE.rst.txt @@ -0,0 +1,6 @@ +Swift_DIAGNOSTICS_FILE +---------------------- + +.. versionadded:: 3.15 + +This property controls where the Swift diagnostics are serialized. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/UNITY_GROUP.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/UNITY_GROUP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9c18b70587b380e9d3f9f7f1b5c674b8355b40e8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/UNITY_GROUP.rst.txt @@ -0,0 +1,7 @@ +UNITY_GROUP +----------- + +.. versionadded:: 3.18 + +This property controls which *bucket* the source will be part of when +the :prop_tgt:`UNITY_BUILD_MODE` is set to ``GROUP``. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_COPY_TO_OUT_DIR.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_COPY_TO_OUT_DIR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ebc306113e6d56910408cc914e2e12630dad4cbc --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_COPY_TO_OUT_DIR.rst.txt @@ -0,0 +1,8 @@ +VS_COPY_TO_OUT_DIR +------------------ + +.. versionadded:: 3.8 + +Sets the ```` tag for a source file in a +Visual Studio project file. Valid values are ``Never``, ``Always`` +and ``PreserveNewest``. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_CSHARP_tagname.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_CSHARP_tagname.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..77b1e16e8bc1160a32488d3689919642108a32b0 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_CSHARP_tagname.rst.txt @@ -0,0 +1,22 @@ +VS_CSHARP_ +------------------- + +.. versionadded:: 3.8 + +Visual Studio and CSharp source-file-specific configuration. + +Tell the :manual:`Visual Studio generators ` +to set the source file tag ```` +to a given value in the generated Visual Studio CSharp +project. Ignored on other generators and languages. This property +can be used to define dependencies between source files or set any +other Visual Studio specific parameters. + +Example usage: + +.. code-block:: cmake + + set_source_files_properties( + PROPERTIES + VS_CSHARP_DependentUpon + VS_CSHARP_SubType "Form") diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_DEPLOYMENT_CONTENT.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_DEPLOYMENT_CONTENT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ee49b2736c9630b63992c840acc09ce1e56ead93 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_DEPLOYMENT_CONTENT.rst.txt @@ -0,0 +1,14 @@ +VS_DEPLOYMENT_CONTENT +--------------------- + +.. versionadded:: 3.1 + +Mark a source file as content for deployment with a Windows Phone or +Windows Store application when built with a +:manual:`Visual Studio generators `. +The value must evaluate to either ``1`` or ``0`` and may use +:manual:`generator expressions ` +to make the choice based on the build configuration. +The ``.vcxproj`` file entry for the source file will be +marked either ``DeploymentContent`` or ``ExcludedFromBuild`` +for values ``1`` and ``0``, respectively. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_DEPLOYMENT_LOCATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_DEPLOYMENT_LOCATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b17054488ab041fddb135ce7426dd0909399d6c6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_DEPLOYMENT_LOCATION.rst.txt @@ -0,0 +1,11 @@ +VS_DEPLOYMENT_LOCATION +---------------------- + +.. versionadded:: 3.1 + +Specifies the deployment location for a content source file with a Windows +Phone or Windows Store application when built +with a :manual:`Visual Studio generators `. +This property is only applicable when using :prop_sf:`VS_DEPLOYMENT_CONTENT`. +The value represent the path relative to the app package and applies to all +configurations. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_INCLUDE_IN_VSIX.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_INCLUDE_IN_VSIX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..16c56bfaad4c496576f0d723f1b39f9be46a1241 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_INCLUDE_IN_VSIX.rst.txt @@ -0,0 +1,8 @@ +VS_INCLUDE_IN_VSIX +------------------ + +.. versionadded:: 3.8 + +Boolean property to specify if the file should be included within a +VSIX (Visual Studio Integration Extension) extension package. +This is needed for development of Visual Studio extensions. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_RESOURCE_GENERATOR.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_RESOURCE_GENERATOR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c5bb4f60babf8b901b5fc42e4adf2fc4a8a2983e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_RESOURCE_GENERATOR.rst.txt @@ -0,0 +1,10 @@ +VS_RESOURCE_GENERATOR +--------------------- + +.. versionadded:: 3.8 + +This property allows to specify the resource generator to be used +on this file. It defaults to ``PublicResXFileCodeGenerator`` if +not set. + +This property only applies to C# projects. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_SETTINGS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_SETTINGS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..871e36e855d7bb69494571504111c2359d2f7bc5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_SETTINGS.rst.txt @@ -0,0 +1,25 @@ +VS_SETTINGS +----------- + +.. versionadded:: 3.18 + +Set any item metadata on a file. + +.. versionadded:: 3.22 + + This property is honored for all source file types. + Previously it worked only for non-built files. + +Takes a list of ``Key=Value`` pairs. Tells the Visual Studio generator to set +``Key`` to ``Value`` as item metadata on the file. + +For example: + +.. code-block:: cmake + + set_property(SOURCE file.hlsl PROPERTY VS_SETTINGS "Key=Value" "Key2=Value2") + +will set ``Key`` to ``Value`` and ``Key2`` to ``Value2`` on the +``file.hlsl`` item as metadata. + +:manual:`Generator expressions ` are supported. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_DISABLE_OPTIMIZATIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_DISABLE_OPTIMIZATIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6fb677833cd3750266a7c3e39b1b84cfb506aee6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_DISABLE_OPTIMIZATIONS.rst.txt @@ -0,0 +1,8 @@ +VS_SHADER_DISABLE_OPTIMIZATIONS +------------------------------- + +.. versionadded:: 3.11 + +Disable compiler optimizations for an ``.hlsl`` source file. This adds the +``-Od`` flag to the command line for the FxCompiler tool. Specify the value +``true`` for this property to disable compiler optimizations. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_ENABLE_DEBUG.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_ENABLE_DEBUG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9c8f9d7e8dc2d807d51fb9f8d48d9822cc2fc731 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_ENABLE_DEBUG.rst.txt @@ -0,0 +1,8 @@ +VS_SHADER_ENABLE_DEBUG +---------------------- + +.. versionadded:: 3.11 + +Enable debugging information for an ``.hlsl`` source file. This adds the +``-Zi`` flag to the command line for the FxCompiler tool. Specify the value +``true`` to generate debugging information for the compiled shader. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_ENTRYPOINT.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_ENTRYPOINT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4b311ba99d6ddc2f0887308ecce7e0c155973970 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_ENTRYPOINT.rst.txt @@ -0,0 +1,7 @@ +VS_SHADER_ENTRYPOINT +-------------------- + +.. versionadded:: 3.1 + +Specifies the name of the entry point for the shader of a ``.hlsl`` source +file. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_FLAGS.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_FLAGS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..07f8497e88e571427f403f717824848c49331f53 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_FLAGS.rst.txt @@ -0,0 +1,6 @@ +VS_SHADER_FLAGS +--------------- + +.. versionadded:: 3.2 + +Set additional Visual Studio shader flags of a ``.hlsl`` source file. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_MODEL.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_MODEL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..072df89aaf070f4d563790faa8a15134d89c17e1 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_MODEL.rst.txt @@ -0,0 +1,7 @@ +VS_SHADER_MODEL +--------------- + +.. versionadded:: 3.1 + +Specifies the shader model of a ``.hlsl`` source file. Some shader types can +only be used with recent shader models diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_OBJECT_FILE_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_OBJECT_FILE_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3647a5ed3abfa29caa249a5054112d134ee1ec46 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_OBJECT_FILE_NAME.rst.txt @@ -0,0 +1,8 @@ +VS_SHADER_OBJECT_FILE_NAME +-------------------------- + +.. versionadded:: 3.12 + +Specifies a file name for the compiled shader object file for an ``.hlsl`` +source file. This adds the ``-Fo`` flag to the command line for the FxCompiler +tool. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_OUTPUT_HEADER_FILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_OUTPUT_HEADER_FILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4113a165d7fc047dcf7c1c561adc5c963c6c46e6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_OUTPUT_HEADER_FILE.rst.txt @@ -0,0 +1,7 @@ +VS_SHADER_OUTPUT_HEADER_FILE +---------------------------- + +.. versionadded:: 3.10 + +Set filename for output header file containing object code of a ``.hlsl`` +source file. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_TYPE.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_TYPE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3fb7e60265a9192629be6d476938ae9cb5692b10 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_TYPE.rst.txt @@ -0,0 +1,6 @@ +VS_SHADER_TYPE +-------------- + +.. versionadded:: 3.1 + +Set the Visual Studio shader type of a ``.hlsl`` source file. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_VARIABLE_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_VARIABLE_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3361b400163f00f0d8fbcfe7d6d2cda485540037 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_SHADER_VARIABLE_NAME.rst.txt @@ -0,0 +1,7 @@ +VS_SHADER_VARIABLE_NAME +----------------------- + +.. versionadded:: 3.10 + +Set name of variable in header file containing object code of a ``.hlsl`` +source file. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_TOOL_OVERRIDE.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_TOOL_OVERRIDE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b2f41120fd9166130933fa80453a52e5a72f2e55 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_TOOL_OVERRIDE.rst.txt @@ -0,0 +1,7 @@ +VS_TOOL_OVERRIDE +---------------- + +.. versionadded:: 3.7 + +Override the default Visual Studio tool that will be applied to the source file +with a new tool not based on the extension of the file. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/VS_XAML_TYPE.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/VS_XAML_TYPE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..612b07ba2211b0f28a5753c6080f6e588d13cc88 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/VS_XAML_TYPE.rst.txt @@ -0,0 +1,9 @@ +VS_XAML_TYPE +------------ + +.. versionadded:: 3.3 + +Mark a Extensible Application Markup Language (XAML) source file +as a different type than the default ``Page``. +The most common usage would be to set the default ``App.xaml`` file as +``ApplicationDefinition``. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/WRAP_EXCLUDE.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/WRAP_EXCLUDE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..638ff0398accc8c171e1e75c1e0df124746780db --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/WRAP_EXCLUDE.rst.txt @@ -0,0 +1,11 @@ +WRAP_EXCLUDE +------------ + +Exclude this source file from any code wrapping techniques. + +Some packages can wrap source files into alternate languages to +provide additional functionality. + +For example, C++ code can be wrapped into Java or Python, using SWIG. +If ``WRAP_EXCLUDE`` is set to ``True``, that indicates that this +source file should not be wrapped. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/XCODE_EXPLICIT_FILE_TYPE.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/XCODE_EXPLICIT_FILE_TYPE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5a50d7dcf40daa423f685f4497f1b5a9e08f2a49 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/XCODE_EXPLICIT_FILE_TYPE.rst.txt @@ -0,0 +1,10 @@ +XCODE_EXPLICIT_FILE_TYPE +------------------------ + +.. versionadded:: 3.1 + +Set the :generator:`Xcode` ``explicitFileType`` attribute on its reference to a +source file. CMake computes a default based on file extension but +can be told explicitly with this property. + +See also :prop_sf:`XCODE_LAST_KNOWN_FILE_TYPE`. diff --git a/cmake/doc/cmake/html/_sources/prop_sf/XCODE_FILE_ATTRIBUTES.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/XCODE_FILE_ATTRIBUTES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ba51e00ef59a5db37865a2a43decf9b45321b35c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/XCODE_FILE_ATTRIBUTES.rst.txt @@ -0,0 +1,13 @@ +XCODE_FILE_ATTRIBUTES +--------------------- + +.. versionadded:: 3.7 + +Add values to the :generator:`Xcode` ``ATTRIBUTES`` setting on its reference to a +source file. Among other things, this can be used to set the role on +a ``.mig`` file:: + + set_source_files_properties(defs.mig + PROPERTIES + XCODE_FILE_ATTRIBUTES "Client;Server" + ) diff --git a/cmake/doc/cmake/html/_sources/prop_sf/XCODE_LAST_KNOWN_FILE_TYPE.rst.txt b/cmake/doc/cmake/html/_sources/prop_sf/XCODE_LAST_KNOWN_FILE_TYPE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0b84e314c3fd70c9c61b4460f3655c09b4129c21 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_sf/XCODE_LAST_KNOWN_FILE_TYPE.rst.txt @@ -0,0 +1,11 @@ +XCODE_LAST_KNOWN_FILE_TYPE +-------------------------- + +.. versionadded:: 3.1 + +Set the :generator:`Xcode` ``lastKnownFileType`` attribute on its reference to +a source file. CMake computes a default based on file extension but +can be told explicitly with this property. + +See also :prop_sf:`XCODE_EXPLICIT_FILE_TYPE`, which is preferred +over this property if set. diff --git a/cmake/doc/cmake/html/_sources/prop_test/ATTACHED_FILES.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/ATTACHED_FILES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..496d800710cada9ef6d25ce306d60f8a74bda980 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/ATTACHED_FILES.rst.txt @@ -0,0 +1,7 @@ +ATTACHED_FILES +-------------- + +Attach a list of files to a dashboard submission. + +Set this property to a list of files that will be encoded and +submitted to the dashboard as an addition to the test result. diff --git a/cmake/doc/cmake/html/_sources/prop_test/ATTACHED_FILES_ON_FAIL.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/ATTACHED_FILES_ON_FAIL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..add54b2b1dacb12d56229b607446faaf00e31a05 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/ATTACHED_FILES_ON_FAIL.rst.txt @@ -0,0 +1,7 @@ +ATTACHED_FILES_ON_FAIL +---------------------- + +Attach a list of files to a dashboard submission if the test fails. + +Same as :prop_test:`ATTACHED_FILES`, but these files will only be +included if the test does not pass. diff --git a/cmake/doc/cmake/html/_sources/prop_test/COST.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/COST.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9300d7b2730ad3ceef14b8ed8a629cdb014c25bd --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/COST.rst.txt @@ -0,0 +1,14 @@ +COST +---- + +This property describes the cost of a test. When parallel testing is +enabled, tests in the test set will be run in descending order of cost. +Projects can explicitly define the cost of a test by setting this property +to a floating point value. + +When the cost of a test is not defined by the project, +:manual:`ctest ` will initially use a default cost of ``0``. +It computes a weighted average of the cost each time a test is run and +uses that as an improved estimate of the cost for the next run. The more +a test is re-run in the same build directory, the more representative the +cost should become. diff --git a/cmake/doc/cmake/html/_sources/prop_test/DEPENDS.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/DEPENDS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5aa36b446e4cfaa3a7fd6219cf604bbfe0d6ae7d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/DEPENDS.rst.txt @@ -0,0 +1,22 @@ +DEPENDS +------- + +Specifies that this test should only be run after the specified list of tests. + +Set this to a list of tests that must finish before this test is run. The +results of those tests are not considered, the dependency relationship is +purely for order of execution (i.e. it is really just a *run after* +relationship). Consider using test fixtures with setup tests if a dependency +with successful completion is required (see :prop_test:`FIXTURES_REQUIRED`). + +Examples +~~~~~~~~ + +.. code-block:: cmake + + add_test(NAME baseTest1 ...) + add_test(NAME baseTest2 ...) + add_test(NAME dependsTest12 ...) + + set_tests_properties(dependsTest12 PROPERTIES DEPENDS "baseTest1;baseTest2") + # dependsTest12 runs after baseTest1 and baseTest2, even if they fail diff --git a/cmake/doc/cmake/html/_sources/prop_test/DISABLED.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/DISABLED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..cbf07a58d6bf71688adad280e795de434d046b3d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/DISABLED.rst.txt @@ -0,0 +1,17 @@ +DISABLED +-------- + +.. versionadded:: 3.9 + +If set to ``True``, the test will be skipped and its status will be 'Not Run'. A +``DISABLED`` test will not be counted in the total number of tests and its +completion status will be reported to CDash as ``Disabled``. + +A ``DISABLED`` test does not participate in test fixture dependency resolution. +If a ``DISABLED`` test has fixture requirements defined in its +:prop_test:`FIXTURES_REQUIRED` property, it will not cause setup or cleanup +tests for those fixtures to be added to the test set. + +If a test with the :prop_test:`FIXTURES_SETUP` property set is ``DISABLED``, +the fixture behavior will be as though that setup test was passing and any test +case requiring that fixture will still run. diff --git a/cmake/doc/cmake/html/_sources/prop_test/ENVIRONMENT.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/ENVIRONMENT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..07b96bb63d11682f5c7be05eb19d9d43be86dd95 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/ENVIRONMENT.rst.txt @@ -0,0 +1,9 @@ +ENVIRONMENT +----------- + +Specify environment variables that should be defined for running a test. + +Set to a :ref:`semicolon-separated list ` list +of environment variables and values of the form ``MYVAR=value``. +Those environment variables will be defined while running the test. +The environment changes from this property do not affect other tests. diff --git a/cmake/doc/cmake/html/_sources/prop_test/ENVIRONMENT_MODIFICATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/ENVIRONMENT_MODIFICATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ad3e190377116389def56c0ec3f204b0e85e18b9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/ENVIRONMENT_MODIFICATION.rst.txt @@ -0,0 +1,41 @@ +ENVIRONMENT_MODIFICATION +------------------------ + +.. versionadded:: 3.22 + +Specify environment variables that should be modified for running a test. Note +that the operations performed by this property are performed after the +:prop_test:`ENVIRONMENT` property is already applied. + +Set to a :ref:`semicolon-separated list ` of +environment variables and values of the form ``MYVAR=OP:VALUE``, +where ``MYVAR`` is the case-sensitive name of an environment variable +to be modified. Entries are considered in the order specified in the +property's value. The ``OP`` may be one of: + + - ``reset``: Reset to the unmodified value, ignoring all modifications to + ``MYVAR`` prior to this entry. Note that this will reset the variable to + the value set by :prop_test:`ENVIRONMENT`, if it was set, and otherwise + to its state from the rest of the CTest execution. + - ``set``: Replaces the current value of ``MYVAR`` with ``VALUE``. + - ``unset``: Unsets the current value of ``MYVAR``. + - ``string_append``: Appends singular ``VALUE`` to the current value of + ``MYVAR``. + - ``string_prepend``: Prepends singular ``VALUE`` to the current value of + ``MYVAR``. + - ``path_list_append``: Appends singular ``VALUE`` to the current value of + ``MYVAR`` using the host platform's path list separator (``;`` on Windows + and ``:`` elsewhere). + - ``path_list_prepend``: Prepends singular ``VALUE`` to the current value of + ``MYVAR`` using the host platform's path list separator (``;`` on Windows + and ``:`` elsewhere). + - ``cmake_list_append``: Appends singular ``VALUE`` to the current value of + ``MYVAR`` using ``;`` as the separator. + - ``cmake_list_prepend``: Prepends singular ``VALUE`` to the current value of + ``MYVAR`` using ``;`` as the separator. + +Unrecognized ``OP`` values will result in the test failing before it is +executed. This is so that future operations may be added without changing +valid behavior of existing tests. + +The environment changes from this property do not affect other tests. diff --git a/cmake/doc/cmake/html/_sources/prop_test/FAIL_REGULAR_EXPRESSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/FAIL_REGULAR_EXPRESSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e94856d21759200c7b485d19a9df6e32e249861b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/FAIL_REGULAR_EXPRESSION.rst.txt @@ -0,0 +1,26 @@ +FAIL_REGULAR_EXPRESSION +----------------------- + +If the test output (stdout or stderr) matches this regular expression the test +will fail, regardless of the process exit code. Tests that exceed the timeout +specified by :prop_test:`TIMEOUT` fail regardless of +``FAIL_REGULAR_EXPRESSION``. Any non-zero return code or system-level test +failures including segmentation faults, signal abort, or heap errors fail the +test even if the regular expression does not match. + +If set, if the output matches one of specified regular expressions, the test +will fail. Example: + +.. code-block:: cmake + + # test would pass, except for FAIL_REGULAR_EXPRESSION + add_test(NAME mytest COMMAND ${CMAKE_COMMAND} -E echo "Failed") + + set_property(TEST mytest PROPERTY + FAIL_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed" + ) + +``FAIL_REGULAR_EXPRESSION`` expects a list of regular expressions. + +See also the :prop_test:`PASS_REGULAR_EXPRESSION` and +:prop_test:`SKIP_REGULAR_EXPRESSION` test properties. diff --git a/cmake/doc/cmake/html/_sources/prop_test/FIXTURES_CLEANUP.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/FIXTURES_CLEANUP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..aa043da4673e6daaec8224909585d508ffd595f7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/FIXTURES_CLEANUP.rst.txt @@ -0,0 +1,49 @@ +FIXTURES_CLEANUP +---------------- + +.. versionadded:: 3.7 + +Specifies a list of fixtures for which the test is to be treated as a cleanup +test. These fixture names are distinct from test case names and are not +required to have any similarity to the names of tests associated with them. + +Fixture cleanup tests are ordinary tests with all of the usual test +functionality. Setting the ``FIXTURES_CLEANUP`` property for a test has two +primary effects: + +- CTest will ensure the test executes after all other tests which list any of + the fixtures in its :prop_test:`FIXTURES_REQUIRED` property. + +- If CTest is asked to run only a subset of tests (e.g. using regular + expressions or the ``--rerun-failed`` option) and the cleanup test is not in + the set of tests to run, it will automatically be added if any tests in the + set require any fixture listed in ``FIXTURES_CLEANUP``. + +A cleanup test can have multiple fixtures listed in its ``FIXTURES_CLEANUP`` +property. It will execute only once for the whole CTest run, not once for each +fixture. A fixture can also have more than one cleanup test defined. If there +are multiple cleanup tests for a fixture, projects can control their order with +the usual :prop_test:`DEPENDS` test property if necessary. + +A cleanup test is allowed to require other fixtures, but not any fixture listed +in its ``FIXTURES_CLEANUP`` property. For example: + +.. code-block:: cmake + + # Ok: Dependent fixture is different to cleanup + set_tests_properties(cleanupFoo PROPERTIES + FIXTURES_CLEANUP Foo + FIXTURES_REQUIRED Bar + ) + + # Error: cannot require same fixture as cleanup + set_tests_properties(cleanupFoo PROPERTIES + FIXTURES_CLEANUP Foo + FIXTURES_REQUIRED Foo + ) + +Cleanup tests will execute even if setup or regular tests for that fixture fail +or are skipped. + +See :prop_test:`FIXTURES_REQUIRED` for a more complete discussion of how to use +test fixtures. diff --git a/cmake/doc/cmake/html/_sources/prop_test/FIXTURES_REQUIRED.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/FIXTURES_REQUIRED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7a056012b7ae3a350f4e309981870cfaaa6bc313 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/FIXTURES_REQUIRED.rst.txt @@ -0,0 +1,99 @@ +FIXTURES_REQUIRED +----------------- + +.. versionadded:: 3.7 + +Specifies a list of fixtures the test requires. Fixture names are case +sensitive and they are not required to have any similarity to test names. + +Fixtures are a way to attach setup and cleanup tasks to a set of tests. If a +test requires a given fixture, then all tests marked as setup tasks for that +fixture will be executed first (once for the whole set of tests, not once per +test requiring the fixture). After all tests requiring a particular fixture +have completed, CTest will ensure all tests marked as cleanup tasks for that +fixture are then executed. Tests are marked as setup tasks with the +:prop_test:`FIXTURES_SETUP` property and as cleanup tasks with the +:prop_test:`FIXTURES_CLEANUP` property. If any of a fixture's setup tests fail, +all tests listing that fixture in their ``FIXTURES_REQUIRED`` property will not +be executed. The cleanup tests for the fixture will always be executed, even if +some setup tests fail. + +When CTest is asked to execute only a subset of tests (e.g. by the use of +regular expressions or when run with the :option:`--rerun-failed ` +command line option), it will automatically add any setup or cleanup tests for +fixtures required by any of the tests that are in the execution set. This +behavior can be overridden with the :option:`-FS `, +:option:`-FC ` and :option:`-FA ` command line options to +:manual:`ctest(1)` if desired. + +Since setup and cleanup tasks are also tests, they can have an ordering +specified by the :prop_test:`DEPENDS` test property just like any other tests. +This can be exploited to implement setup or cleanup using multiple tests for a +single fixture to modularise setup or cleanup logic. + +The concept of a fixture is different to that of a resource specified by +:prop_test:`RESOURCE_LOCK`, but they may be used together. A fixture defines a +set of tests which share setup and cleanup requirements, whereas a resource +lock has the effect of ensuring a particular set of tests do not run in +parallel. Some situations may need both, such as setting up a database, +serializing test access to that database and deleting the database again at the +end. For such cases, tests would populate both ``FIXTURES_REQUIRED`` and +:prop_test:`RESOURCE_LOCK` to combine the two behaviors. Names used for +:prop_test:`RESOURCE_LOCK` have no relationship with names of fixtures, so note +that a resource lock does not imply a fixture and vice versa. + +Consider the following example which represents a database test scenario +similar to that mentioned above: + +.. code-block:: cmake + + add_test(NAME testsDone COMMAND emailResults) + add_test(NAME fooOnly COMMAND testFoo) + add_test(NAME dbOnly COMMAND testDb) + add_test(NAME dbWithFoo COMMAND testDbWithFoo) + add_test(NAME createDB COMMAND initDB) + add_test(NAME setupUsers COMMAND userCreation) + add_test(NAME cleanupDB COMMAND deleteDB) + add_test(NAME cleanupFoo COMMAND removeFoos) + + set_tests_properties(setupUsers PROPERTIES DEPENDS createDB) + + set_tests_properties(createDB PROPERTIES FIXTURES_SETUP DB) + set_tests_properties(setupUsers PROPERTIES FIXTURES_SETUP DB) + set_tests_properties(cleanupDB PROPERTIES FIXTURES_CLEANUP DB) + set_tests_properties(cleanupFoo PROPERTIES FIXTURES_CLEANUP Foo) + set_tests_properties(testsDone PROPERTIES FIXTURES_CLEANUP "DB;Foo") + + set_tests_properties(fooOnly PROPERTIES FIXTURES_REQUIRED Foo) + set_tests_properties(dbOnly PROPERTIES FIXTURES_REQUIRED DB) + set_tests_properties(dbWithFoo PROPERTIES FIXTURES_REQUIRED "DB;Foo") + + set_tests_properties(dbOnly dbWithFoo createDB setupUsers cleanupDB + PROPERTIES RESOURCE_LOCK DbAccess) + +Key points from this example: + +- Two fixtures are defined: ``DB`` and ``Foo``. Tests can require a single + fixture as ``fooOnly`` and ``dbOnly`` do, or they can depend on multiple + fixtures like ``dbWithFoo`` does. + +- A ``DEPENDS`` relationship is set up to ensure ``setupUsers`` happens after + ``createDB``, both of which are setup tests for the ``DB`` fixture and will + therefore be executed before the ``dbOnly`` and ``dbWithFoo`` tests + automatically. + +- No explicit ``DEPENDS`` relationships were needed to make the setup tests run + before or the cleanup tests run after the regular tests. + +- The ``Foo`` fixture has no setup tests defined, only a single cleanup test. + +- ``testsDone`` is a cleanup test for both the ``DB`` and ``Foo`` fixtures. + Therefore, it will only execute once regular tests for both fixtures have + finished (i.e. after ``fooOnly``, ``dbOnly`` and ``dbWithFoo``). No + ``DEPENDS`` relationship was specified for ``testsDone``, so it is free to + run before, after or concurrently with other cleanup tests for either + fixture. + +- The setup and cleanup tests never list the fixtures they are for in their own + ``FIXTURES_REQUIRED`` property, as that would result in a dependency on + themselves and be considered an error. diff --git a/cmake/doc/cmake/html/_sources/prop_test/FIXTURES_SETUP.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/FIXTURES_SETUP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..04a09d86cc5ba880ef01d33b6ed4039cbc4a8692 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/FIXTURES_SETUP.rst.txt @@ -0,0 +1,50 @@ +FIXTURES_SETUP +-------------- + +.. versionadded:: 3.7 + +Specifies a list of fixtures for which the test is to be treated as a setup +test. These fixture names are distinct from test case names and are not +required to have any similarity to the names of tests associated with them. + +Fixture setup tests are ordinary tests with all of the usual test +functionality. Setting the ``FIXTURES_SETUP`` property for a test has two +primary effects: + +- CTest will ensure the test executes before any other test which lists the + fixture name(s) in its :prop_test:`FIXTURES_REQUIRED` property. + +- If CTest is asked to run only a subset of tests (e.g. using regular + expressions or the ``--rerun-failed`` option) and the setup test is not in + the set of tests to run, it will automatically be added if any tests in the + set require any fixture listed in ``FIXTURES_SETUP``. + +A setup test can have multiple fixtures listed in its ``FIXTURES_SETUP`` +property. It will execute only once for the whole CTest run, not once for each +fixture. A fixture can also have more than one setup test defined. If there are +multiple setup tests for a fixture, projects can control their order with the +usual :prop_test:`DEPENDS` test property if necessary. + +A setup test is allowed to require other fixtures, but not any fixture listed +in its ``FIXTURES_SETUP`` property. For example: + +.. code-block:: cmake + + # Ok: dependent fixture is different to setup + set_tests_properties(setupFoo PROPERTIES + FIXTURES_SETUP Foo + FIXTURES_REQUIRED Bar + ) + + # Error: cannot require same fixture as setup + set_tests_properties(setupFoo PROPERTIES + FIXTURES_SETUP Foo + FIXTURES_REQUIRED Foo + ) + +If any of a fixture's setup tests fail, none of the tests listing that fixture +in its :prop_test:`FIXTURES_REQUIRED` property will be run. Cleanup tests will, +however, still be executed. + +See :prop_test:`FIXTURES_REQUIRED` for a more complete discussion of how to use +test fixtures. diff --git a/cmake/doc/cmake/html/_sources/prop_test/GENERATED_RESOURCE_SPEC_FILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/GENERATED_RESOURCE_SPEC_FILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..89596acb6f6dbdd94e87b850bb46a421fd218bd4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/GENERATED_RESOURCE_SPEC_FILE.rst.txt @@ -0,0 +1,7 @@ +GENERATED_RESOURCE_SPEC_FILE +---------------------------- + +.. versionadded:: 3.28 + +Path to the :ref:`dynamically-generated resource spec file +` generated by this test. diff --git a/cmake/doc/cmake/html/_sources/prop_test/LABELS.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/LABELS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..02e2fae8600a93826108836642ce9f4a6aeb2dfe --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/LABELS.rst.txt @@ -0,0 +1,10 @@ +LABELS +------ + +Specify a list of text labels associated with a test. The labels are +reported in both the :program:`ctest` output summary and in dashboard submissions. +They can also be used to filter the set of tests to be executed (see the +:option:`ctest -L` and :option:`ctest -LE` options). + +See :ref:`Additional Labels` for adding labels to a test dynamically during +test execution. diff --git a/cmake/doc/cmake/html/_sources/prop_test/MEASUREMENT.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/MEASUREMENT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..de459ed4e8fddaa8a58f3a2f4c8f530612d5a443 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/MEASUREMENT.rst.txt @@ -0,0 +1,8 @@ +MEASUREMENT +----------- + +Specify a ``CDASH`` measurement and value to be reported for a test. + +If set to a name then that name will be reported to ``CDASH`` as a named +measurement with a value of ``1``. You may also specify a value by +setting ``MEASUREMENT`` to ``measurement=value``. diff --git a/cmake/doc/cmake/html/_sources/prop_test/PASS_REGULAR_EXPRESSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/PASS_REGULAR_EXPRESSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b19e637fb6b552842a132fb234997c1d2c73f7da --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/PASS_REGULAR_EXPRESSION.rst.txt @@ -0,0 +1,50 @@ +PASS_REGULAR_EXPRESSION +----------------------- + +The test output (stdout or stderr) must match this regular expression +for the test to pass. The process exit code is ignored. Tests that exceed +the timeout specified by :prop_test:`TIMEOUT` still fail regardless of +``PASS_REGULAR_EXPRESSION``. System-level test failures including +segmentation faults, signal abort, or heap errors may fail the test even +if ``PASS_REGULAR_EXPRESSION`` is matched. + +Example: + +.. code-block:: cmake + + add_test(NAME mytest COMMAND ${CMAKE_COMMAND} -E echo "Passed this test") + + set_property(TEST mytest PROPERTY + PASS_REGULAR_EXPRESSION "pass;Passed" + ) + +``PASS_REGULAR_EXPRESSION`` expects a list of regular expressions. + +To run a test that may have a system-level failure, but still pass if +``PASS_REGULAR_EXPRESSION`` matches, use a CMake command to wrap the +executable run. Note that this will prevent automatic handling of the +:prop_tgt:`CROSSCOMPILING_EMULATOR` and :prop_tgt:`TEST_LAUNCHER` +target property. + +.. code-block:: cmake + + add_executable(main main.c) + + add_test(NAME sigabrt COMMAND ${CMAKE_COMMAND} -E env $) + + set_property(TEST sigabrt PROPERTY PROPERTY_REGULAR_EXPRESSION "pass;Passed") + +.. code-block:: c + + #include + #include + + int main(void){ + fprintf(stdout, "Passed\n"); + fflush(stdout); /* ensure the output buffer is seen */ + raise(SIGABRT); + return 0; + } + +See also the :prop_test:`FAIL_REGULAR_EXPRESSION` and +:prop_test:`SKIP_REGULAR_EXPRESSION` test properties. diff --git a/cmake/doc/cmake/html/_sources/prop_test/PROCESSORS.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/PROCESSORS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a927c10782c4acd5832a4dd8f1c9799df4e1eb5c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/PROCESSORS.rst.txt @@ -0,0 +1,16 @@ +PROCESSORS +---------- + +Set to specify how many process slots this test requires. +If not set, the default is ``1`` processor. + +Denotes the number of processors that this test will require. This is +typically used for MPI tests, and should be used in conjunction with +the :command:`ctest_test` ``PARALLEL_LEVEL`` option. + +This will also be used to display a weighted test timing result in label and +subproject summaries in the command line output of :manual:`ctest(1)`. The wall +clock time for the test run will be multiplied by this property to give a +better idea of how much cpu resource CTest allocated for the test. + +See also the :prop_test:`PROCESSOR_AFFINITY` test property. diff --git a/cmake/doc/cmake/html/_sources/prop_test/PROCESSOR_AFFINITY.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/PROCESSOR_AFFINITY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f48a69cb0786b683372812910f981419c6f53497 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/PROCESSOR_AFFINITY.rst.txt @@ -0,0 +1,13 @@ +PROCESSOR_AFFINITY +------------------ + +.. versionadded:: 3.12 + +Set to a true value to ask CTest to launch the test process with CPU affinity +for a fixed set of processors. If enabled and supported for the current +platform, CTest will choose a set of processors to place in the CPU affinity +mask when launching the test process. The number of processors in the set is +determined by the :prop_test:`PROCESSORS` test property or the number of +processors available to CTest, whichever is smaller. The set of processors +chosen will be disjoint from the processors assigned to other concurrently +running tests that also have the ``PROCESSOR_AFFINITY`` property enabled. diff --git a/cmake/doc/cmake/html/_sources/prop_test/REQUIRED_FILES.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/REQUIRED_FILES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..baf209cfb0c8728f0ea13c4d479be34a285d6e34 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/REQUIRED_FILES.rst.txt @@ -0,0 +1,38 @@ +REQUIRED_FILES +-------------- + +List of files required to run the test. The filenames are relative to the +test :prop_test:`WORKING_DIRECTORY` unless an absolute path is specified. + +If set to a list of files, the test will not be run unless all of the +files exist. + +Examples +~~~~~~~~ + +Suppose that ``test.txt`` is created by test ``baseTest`` and ``none.txt`` +does not exist: + +.. code-block:: cmake + + add_test(NAME baseTest ...) # Assumed to create test.txt + add_test(NAME fileTest ...) + + # The following ensures that if baseTest is successful, test.txt will + # have been created before fileTest is run + set_tests_properties(fileTest PROPERTIES + DEPENDS baseTest + REQUIRED_FILES test.txt + ) + + add_test(NAME notRunTest ...) + + # The following makes notRunTest depend on two files. Nothing creates + # the none.txt file, so notRunTest will fail with status "Not Run". + set_tests_properties(notRunTest PROPERTIES + REQUIRED_FILES "test.txt;none.txt" + ) + +The above example demonstrates how ``REQUIRED_FILES`` works, but it is not the +most robust way to implement test ordering with failure detection. For that, +test fixtures are a better alternative (see :prop_test:`FIXTURES_REQUIRED`). diff --git a/cmake/doc/cmake/html/_sources/prop_test/RESOURCE_GROUPS.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/RESOURCE_GROUPS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..26c8fa26b01bde688dc42868417822fc257cda2f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/RESOURCE_GROUPS.rst.txt @@ -0,0 +1,72 @@ +RESOURCE_GROUPS +--------------- + +.. versionadded:: 3.16 + +Specify resources required by a test, grouped in a way that is meaningful to +the test. See :ref:`resource allocation ` +for more information on how this property integrates into the CTest resource +allocation feature. + +The ``RESOURCE_GROUPS`` property is a :ref:`semicolon-separated list ` of group descriptions. Each entry consists of an optional +number of groups using the description followed by a series of resource +requirements for those groups. These requirements (and the number of groups) +are separated by commas. The resource requirements consist of the name of a +resource type, followed by a colon, followed by an unsigned integer +specifying the number of slots required on one resource of the given type. + +The ``RESOURCE_GROUPS`` property tells CTest what resources a test expects +to use grouped in a way meaningful to the test. The test itself must read +the :ref:`environment variables ` to +determine which resources have been allocated to each group. For example, +each group may correspond to a process the test will spawn when executed. + +Consider the following example: + +.. code-block:: cmake + + add_test(NAME MyTest COMMAND MyExe) + set_property(TEST MyTest PROPERTY RESOURCE_GROUPS + "2,gpus:2" + "gpus:4,crypto_chips:2") + +In this example, there are two group descriptions (implicitly separated by a +semicolon.) The content of the first description is ``2,gpus:2``. This +description specifies 2 groups, each of which requires 2 slots from a single +GPU. The content of the second description is ``gpus:4,crypto_chips:2``. This +description does not specify a group count, so a default of 1 is assumed. +This single group requires 4 slots from a single GPU and 2 slots from a +single cryptography chip. In total, 3 resource groups are specified for this +test, each with its own unique requirements. + +Note that the number of slots following the resource type specifies slots from +a *single* instance of the resource. If the resource group can tolerate +receiving slots from different instances of the same resource, it can indicate +this by splitting the specification into multiple requirements of one slot. For +example: + +.. code-block:: cmake + + add_test(NAME MyTest COMMAND MyExe) + set_property(TEST MyTest PROPERTY RESOURCE_GROUPS + "gpus:1,gpus:1,gpus:1,gpus:1") + +In this case, the single resource group indicates that it needs four GPU slots, +all of which may come from separate GPUs (though they don't have to; CTest may +still assign slots from the same GPU.) + +When CTest sets the :ref:`environment variables +` for a test, it assigns a group number +based on the group description, starting at 0 on the left and the number of +groups minus 1 on the right. For example, in the example above, the two +groups in the first description would have IDs of 0 and 1, and the single +group in the second description would have an ID of 2. + +Both the ``RESOURCE_GROUPS`` and :prop_test:`RESOURCE_LOCK` properties serve +similar purposes, but they are distinct and orthogonal. Resources specified by +``RESOURCE_GROUPS`` do not affect :prop_test:`RESOURCE_LOCK`, and vice versa. +Whereas :prop_test:`RESOURCE_LOCK` is a simpler property that is used for +locking one global resource, ``RESOURCE_GROUPS`` is a more advanced property +that allows multiple tests to simultaneously use multiple resources of the +same type, specifying their requirements in a fine-grained manner. diff --git a/cmake/doc/cmake/html/_sources/prop_test/RESOURCE_LOCK.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/RESOURCE_LOCK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8b13a01d41d1b826d41a3480639794b5a9bed416 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/RESOURCE_LOCK.rst.txt @@ -0,0 +1,18 @@ +RESOURCE_LOCK +------------- + +Specify a list of resources that are locked by this test. + +If multiple tests specify the same resource lock, they are guaranteed +not to run concurrently. + +See also :prop_test:`FIXTURES_REQUIRED` if the resource requires any setup or +cleanup steps. + +Both the :prop_test:`RESOURCE_GROUPS` and ``RESOURCE_LOCK`` properties serve +similar purposes, but they are distinct and orthogonal. Resources specified by +:prop_test:`RESOURCE_GROUPS` do not affect ``RESOURCE_LOCK``, and vice versa. +Whereas ``RESOURCE_LOCK`` is a simpler property that is used for locking one +global resource, :prop_test:`RESOURCE_GROUPS` is a more advanced property +that allows multiple tests to simultaneously use multiple resources of the +same type, specifying their requirements in a fine-grained manner. diff --git a/cmake/doc/cmake/html/_sources/prop_test/RUN_SERIAL.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/RUN_SERIAL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ab4c542336df85651f04d5ca54052014cb404183 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/RUN_SERIAL.rst.txt @@ -0,0 +1,8 @@ +RUN_SERIAL +---------- + +Do not run this test in parallel with any other test. + +Use this option in conjunction with the ctest_test ``PARALLEL_LEVEL`` +option to specify that this test should not be run in parallel with +any other tests. diff --git a/cmake/doc/cmake/html/_sources/prop_test/SKIP_REGULAR_EXPRESSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/SKIP_REGULAR_EXPRESSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8717a0a4028d1a6ce0965946935e065e1d9efbe5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/SKIP_REGULAR_EXPRESSION.rst.txt @@ -0,0 +1,47 @@ +SKIP_REGULAR_EXPRESSION +----------------------- + +.. versionadded:: 3.16 + +If the test output (stderr or stdout) matches this regular expression the test +will be marked as skipped, regardless of the process exit code. Tests that +exceed the timeout specified by :prop_test:`TIMEOUT` still fail regardless of +``SKIP_REGULAR_EXPRESSION``. System-level test failures including segmentation +faults, signal abort, or heap errors may fail the test even if the regular +expression matches. + +Example: + +.. code-block:: cmake + + add_test(NAME mytest COMMAND ${CMAKE_COMMAND} -E echo "Skipped this test") + + set_property(TEST mytest PROPERTY + SKIP_REGULAR_EXPRESSION "[^a-z]Skip" "SKIP" "Skipped" + ) + +``SKIP_REGULAR_EXPRESSION`` expects a list of regular expressions. + +To run a test that may have a system-level failure, but still skip if +``SKIP_REGULAR_EXPRESSION`` matches, use a CMake command to wrap the +executable run. Note that this will prevent automatic handling of the +:prop_tgt:`CROSSCOMPILING_EMULATOR` and :prop_tgt:`TEST_LAUNCHER` +target property. + +.. code-block:: cmake + + add_executable(main main.c) + + add_test(NAME sigabrt COMMAND ${CMAKE_COMMAND} -E env $) + + set_property(TEST sigabrt PROPERTY SKIP_REGULAR_EXPRESSION "SIGABRT;[aA]bort") + +.. code-block:: c + + #include + + int main(void){ raise(SIGABRT); return 0; } + +See also the :prop_test:`SKIP_RETURN_CODE`, +:prop_test:`PASS_REGULAR_EXPRESSION`, and :prop_test:`FAIL_REGULAR_EXPRESSION` +test properties. diff --git a/cmake/doc/cmake/html/_sources/prop_test/SKIP_RETURN_CODE.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/SKIP_RETURN_CODE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..57fc031e6659b4183ecfb13c03bd735bb3436d2c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/SKIP_RETURN_CODE.rst.txt @@ -0,0 +1,48 @@ +SKIP_RETURN_CODE +---------------- + +Return code to mark a test as skipped. + +Sometimes only a test itself can determine if all requirements for the +test are met. If such a situation should not be considered a hard failure +a return code of the process can be specified that will mark the test as +``Not Run`` if it is encountered. Valid values are in the range of +0 to 255, inclusive. + +Tests that exceed the timeout specified by :prop_test:`TIMEOUT` still fail +regardless of ``SKIP_RETURN_CODE``. +System-level test failures including segmentation faults, +signal abort, or heap errors may fail the test even if the return code matches. + +.. code-block:: cmake + + # cmake (1) defines this to return code 1 + add_test(NAME r1 COMMAND ${CMAKE_COMMAND} -E false) + + set_tests_properties(r1 PROPERTIES SKIP_RETURN_CODE 1) + + +To run a test that may have a system-level failure, but still skip if +``SKIP_RETURN_CODE`` matches, use a CMake command to wrap the executable run. +Note that this will prevent automatic handling of the +:prop_tgt:`CROSSCOMPILING_EMULATOR` and :prop_tgt:`TEST_LAUNCHER` target +property. + +.. code-block:: cmake + + add_executable(main main.c) + + # cmake -E env returns 1 if the command fails in any way + add_test(NAME sigabrt COMMAND ${CMAKE_COMMAND} -E env $) + + set_property(TEST sigabrt PROPERTY SKIP_RETURN_CODE 1) + +.. code-block:: c + + #include + + int main(void){ raise(SIGABRT); return 0; } + + +To handle multiple types of cases that may need to be skipped, consider the +:prop_test:`SKIP_REGULAR_EXPRESSION` property. diff --git a/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..175c0fb460e9e5777b0e3791df1983da97d466b2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT.rst.txt @@ -0,0 +1,15 @@ +TIMEOUT +------- + +How many seconds to allow for this test. + +This property if set will limit a test to not take more than the +specified number of seconds to run. If it exceeds that the test +process will be killed and ctest will move to the next test. This +setting takes precedence over :variable:`CTEST_TEST_TIMEOUT`. + +An explicit ``0`` value means the test has no timeout, except as +necessary to honor :option:`ctest --stop-time`. + +See also :prop_test:`TIMEOUT_AFTER_MATCH` and +:prop_test:`TIMEOUT_SIGNAL_NAME`. diff --git a/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT_AFTER_MATCH.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT_AFTER_MATCH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..edee2ef8d08f9fbf4ca0d556408507c89067e963 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT_AFTER_MATCH.rst.txt @@ -0,0 +1,43 @@ +TIMEOUT_AFTER_MATCH +------------------- + +.. versionadded:: 3.6 + +Change a test's timeout duration after a matching line is encountered +in its output. + +Usage +^^^^^ + +.. code-block:: cmake + + add_test(mytest ...) + set_property(TEST mytest PROPERTY TIMEOUT_AFTER_MATCH "${seconds}" "${regex}") + +Description +^^^^^^^^^^^ + +Allow a test ``seconds`` to complete after ``regex`` is encountered in +its output. + +When the test outputs a line that matches ``regex`` its start time is +reset to the current time and its timeout duration is changed to +``seconds``. Prior to this, the timeout duration is determined by the +:prop_test:`TIMEOUT` property or the :variable:`CTEST_TEST_TIMEOUT` +variable if either of these are set. Because the test's start time is +reset, its execution time will not include any time that was spent +waiting for the matching output. + +``TIMEOUT_AFTER_MATCH`` is useful for avoiding spurious +timeouts when your test must wait for some system resource to become +available before it can execute. Set :prop_test:`TIMEOUT` to a longer +duration that accounts for resource acquisition and use +``TIMEOUT_AFTER_MATCH`` to control how long the actual test +is allowed to run. + +If the required resource can be controlled by CTest you should use +:prop_test:`RESOURCE_LOCK` instead of ``TIMEOUT_AFTER_MATCH``. +This property should be used when only the test itself can determine +when its required resources are available. + +See also :prop_test:`TIMEOUT_SIGNAL_NAME`. diff --git a/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT_SIGNAL_GRACE_PERIOD.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT_SIGNAL_GRACE_PERIOD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..858be5dd54a4a8d21bbeefb3b0f86a28ba28ac7b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT_SIGNAL_GRACE_PERIOD.rst.txt @@ -0,0 +1,14 @@ +TIMEOUT_SIGNAL_GRACE_PERIOD +--------------------------- + +.. versionadded:: 3.27 + +If the :prop_test:`TIMEOUT_SIGNAL_NAME` test property is set, this property +specifies the number of seconds to wait for a test process to terminate after +sending the custom signal. Otherwise, this property has no meaning. + +The grace period may be any real value greater than ``0.0``, but not greater +than ``60.0``. If this property is not set, the default is ``1.0`` second. + +This is available only on platforms supporting POSIX signals. +It is not available on Windows. diff --git a/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT_SIGNAL_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT_SIGNAL_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6294d275531971f5d429b5a51017e53a1336c76c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/TIMEOUT_SIGNAL_NAME.rst.txt @@ -0,0 +1,41 @@ +TIMEOUT_SIGNAL_NAME +------------------- + +.. versionadded:: 3.27 + +Specify a custom signal to send to a test process when its timeout is reached. +This is available only on platforms supporting POSIX signals. +It is not available on Windows. + +The name must be one of the following: + + ``SIGINT`` + Interrupt. + + ``SIGQUIT`` + Quit. + + ``SIGTERM`` + Terminate. + + ``SIGUSR1`` + User defined signal 1. + + ``SIGUSR2`` + User defined signal 2. + +The custom signal is sent to the test process to give it a chance +to exit gracefully during a grace period: + +* If the test process created any children, it is responsible for + terminating them too. + +* The grace period length is determined by the + :prop_test:`TIMEOUT_SIGNAL_GRACE_PERIOD` test property. + +* If the test process does not terminate before the grace period ends, + :manual:`ctest(1)` will force termination of its entire process tree + via ``SIGSTOP`` and ``SIGKILL``. + +See also :variable:`CTEST_TEST_TIMEOUT`, +:prop_test:`TIMEOUT`, and :prop_test:`TIMEOUT_AFTER_MATCH`. diff --git a/cmake/doc/cmake/html/_sources/prop_test/WILL_FAIL.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/WILL_FAIL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9d61ab7c68cac75bc50ad3c36e3c9779d7674b27 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/WILL_FAIL.rst.txt @@ -0,0 +1,37 @@ +WILL_FAIL +--------- + +If ``true``, inverts the pass / fail test criteria. Tests for which +``WILL_FAIL`` is ``true`` fail with return code 0 and pass with non-zero +return code. Tests that exceed the timeout specified by :prop_test:`TIMEOUT` +still fail regardless of ``WILL_FAIL``. +System-level test failures including segmentation faults, +signal abort, or heap errors may fail the test even if ``WILL_FAIL`` is true. + +Example of a test that would ordinarily pass, but fails because ``WILL_FAIL`` +is ``true``: + +.. code-block:: cmake + + add_test(NAME failed COMMAND ${CMAKE_COMMAND} -E true) + set_property(TEST failed PROPERTY WILL_FAIL true) + +To run a test that may have a system-level failure, but still pass if +``WILL_FAIL`` is set, use a CMake command to wrap the executable run. +Note that this will prevent automatic handling of the +:prop_tgt:`CROSSCOMPILING_EMULATOR` and :prop_tgt:`TEST_LAUNCHER` +target property. + +.. code-block:: cmake + + add_executable(main main.c) + + add_test(NAME sigabrt COMMAND ${CMAKE_COMMAND} -E env $) + + set_property(TEST sigabrt PROPERTY WILL_FAIL TRUE) + +.. code-block:: c + + #include + + int main(void){ raise(SIGABRT); return 0; } diff --git a/cmake/doc/cmake/html/_sources/prop_test/WORKING_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_test/WORKING_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..92a040967eb991551fdb6d8c0ab675a10dc61322 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_test/WORKING_DIRECTORY.rst.txt @@ -0,0 +1,9 @@ +WORKING_DIRECTORY +----------------- + +The directory from which the test executable will be called. + +If this is not set, the test will be run with the working directory set to the +binary directory associated with where the test was created (i.e. the +:variable:`CMAKE_CURRENT_BINARY_DIR` for where :command:`add_test` was +called). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ADDITIONAL_CLEAN_FILES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ADDITIONAL_CLEAN_FILES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..dc87d23ef606abfcded8a608c29b90b8d3b01fe7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ADDITIONAL_CLEAN_FILES.rst.txt @@ -0,0 +1,25 @@ +ADDITIONAL_CLEAN_FILES +---------------------- + +.. versionadded:: 3.15 + +A :ref:`;-list ` of files or directories that will be +removed as a part of the global ``clean`` target. It can be used to specify +files and directories that are generated as part of building the target or +that are directly associated with the target in some way (e.g. created as a +result of running the target). + +For custom targets, if such files can be captured as outputs or byproducts +instead, then that should be preferred over adding them to this property. +If an additional clean file is used by multiple targets or isn't +target-specific, then the :prop_dir:`ADDITIONAL_CLEAN_FILES` directory +property may be the more appropriate property to use. + +Relative paths are allowed and are interpreted relative to the +current binary directory. + +Contents of ``ADDITIONAL_CLEAN_FILES`` may use +:manual:`generator expressions `. + +This property only works for the :generator:`Ninja` and the Makefile +generators. It is ignored by other generators. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AIX_EXPORT_ALL_SYMBOLS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AIX_EXPORT_ALL_SYMBOLS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..de98fdf6ed422196ec0ca11665b913cd348fbd94 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AIX_EXPORT_ALL_SYMBOLS.rst.txt @@ -0,0 +1,14 @@ +AIX_EXPORT_ALL_SYMBOLS +---------------------- + +.. versionadded:: 3.17 + +On AIX, CMake automatically exports all symbols from shared libraries, and +from executables with the :prop_tgt:`ENABLE_EXPORTS` target property set. +Explicitly disable this boolean property to suppress the behavior and +export no symbols by default. In this case it is expected that the project +will use other means to export some symbols. + +This property is initialized by the value of +the :variable:`CMAKE_AIX_EXPORT_ALL_SYMBOLS` variable if it is set +when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AIX_SHARED_LIBRARY_ARCHIVE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AIX_SHARED_LIBRARY_ARCHIVE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9e81594fd197bff664ae8c46cca0aa2f9c5de185 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AIX_SHARED_LIBRARY_ARCHIVE.rst.txt @@ -0,0 +1,22 @@ +AIX_SHARED_LIBRARY_ARCHIVE +-------------------------- + +.. versionadded:: 3.31 + +On AIX, enable creation of a shared library archive. This places +the shared object ``.so`` file inside an archive ``.a`` file. + +By default, CMake creates shared libraries on AIX as plain +shared object ``.so`` files for consistency with other UNIX platforms. +Alternatively, set this property to a true value to create a shared +library archive instead, as is AIX convention. + +The shared object name in the archive encodes version information from +the :prop_tgt:`SOVERSION` target property, if set, and otherwise from +the :prop_tgt:`VERSION` target property, if set. + +This property defaults to :variable:`CMAKE_AIX_SHARED_LIBRARY_ARCHIVE` +if that variable is set when a non-imported ``SHARED`` library target +is created by :command:`add_library`. Imported targets must explicitly +enable :prop_tgt:`!AIX_SHARED_LIBRARY_ARCHIVE` if they import an AIX +shared library archive. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ALIASED_TARGET.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ALIASED_TARGET.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f9e60348db595433ef7c8fd4f4f066075f94567b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ALIASED_TARGET.rst.txt @@ -0,0 +1,7 @@ +ALIASED_TARGET +-------------- + +Name of target aliased by this target. + +If this is an :ref:`Alias Target `, this property contains +the name of the target aliased. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ALIAS_GLOBAL.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ALIAS_GLOBAL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a8859c6b9ac4647ffba088a162b80eedd36e0313 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ALIAS_GLOBAL.rst.txt @@ -0,0 +1,19 @@ +ALIAS_GLOBAL +------------ + +.. versionadded:: 3.18 + +Read-only property indicating of whether an :ref:`ALIAS target ` +is globally visible. + +The boolean value of this property is ``TRUE`` for aliases to +:ref:`IMPORTED targets ` created +with the ``GLOBAL`` options to :command:`add_executable()` or +:command:`add_library()`, ``FALSE`` otherwise. It is undefined for +targets built within the project. + +.. note:: + + Promoting an :ref:`IMPORTED target ` from ``LOCAL`` + to ``GLOBAL`` scope by changing the value or :prop_tgt:`IMPORTED_GLOBAL` + target property do not change the scope of local aliases. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_ANT_ADDITIONAL_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_ANT_ADDITIONAL_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..eceb17de4d21b38ff1c6a0970f7a15506de98685 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_ANT_ADDITIONAL_OPTIONS.rst.txt @@ -0,0 +1,10 @@ +ANDROID_ANT_ADDITIONAL_OPTIONS +------------------------------ + +.. versionadded:: 3.4 + +Set the additional options for Android Ant build system. This is +a string value containing all command line options for the Ant build. +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS` variable if it is +set when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_API.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_API.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7664f1833f2c4b877e418144298644c8680dfa33 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_API.rst.txt @@ -0,0 +1,10 @@ +ANDROID_API +----------- + +.. versionadded:: 3.1 + +When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio +Edition`, this property sets the Android target API version (e.g. ``15``). +The version number must be a positive decimal integer. This property is +initialized by the value of the :variable:`CMAKE_ANDROID_API` variable if +it is set when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_API_MIN.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_API_MIN.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7ca2455ec2c11b31e82ef52f45fac0cbd5c893b3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_API_MIN.rst.txt @@ -0,0 +1,9 @@ +ANDROID_API_MIN +--------------- + +.. versionadded:: 3.2 + +Set the Android MIN API version (e.g. ``9``). The version number +must be a positive decimal integer. This property is initialized by +the value of the :variable:`CMAKE_ANDROID_API_MIN` variable if it is set +when a target is created. Native code builds using this API version. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_ARCH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_ARCH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..94b76dd453ead402d4152620ddf678a8b5844dd8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_ARCH.rst.txt @@ -0,0 +1,20 @@ +ANDROID_ARCH +------------ + +.. versionadded:: 3.4 + +When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio +Edition`, this property sets the Android target architecture. + +This is a string property that could be set to the one of +the following values: + +* ``armv7-a``: "ARMv7-A (armv7-a)" +* ``armv7-a-hard``: "ARMv7-A, hard-float ABI (armv7-a)" +* ``arm64-v8a``: "ARMv8-A, 64bit (arm64-v8a)" +* ``x86``: "x86 (x86)" +* ``x86_64``: "x86_64 (x86_64)" + +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_ARCH` variable if it is set +when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_ASSETS_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_ASSETS_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b09a8b7c71d01b9f61222ea4f402b108f9b2c235 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_ASSETS_DIRECTORIES.rst.txt @@ -0,0 +1,11 @@ +ANDROID_ASSETS_DIRECTORIES +-------------------------- + +.. versionadded:: 3.4 + +Set the Android assets directories to copy into the main assets +folder before build. This a string property that contains the +directory paths separated by semicolon. +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_ASSETS_DIRECTORIES` variable if it is set when +a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_GUI.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_GUI.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..cc022dbf6557945315c271579d60647a160d83a8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_GUI.rst.txt @@ -0,0 +1,17 @@ +ANDROID_GUI +----------- + +.. versionadded:: 3.1 + +When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio +Edition`, this property specifies whether to build an executable as an +application package on Android. + +When this property is set to true the executable when built for Android +will be created as an application package. This property is initialized +by the value of the :variable:`CMAKE_ANDROID_GUI` variable if it is set +when a target is created. + +Add the ``AndroidManifest.xml`` source file explicitly to the +target :command:`add_executable` command invocation to specify the +root directory of the application package source. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_JAR_DEPENDENCIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_JAR_DEPENDENCIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9880dafcc0925d5e5671aedfae81428e275c5d12 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_JAR_DEPENDENCIES.rst.txt @@ -0,0 +1,9 @@ +ANDROID_JAR_DEPENDENCIES +------------------------ + +.. versionadded:: 3.4 + +Set the Android property that specifies JAR dependencies. +This is a string value property. This property is initialized +by the value of the :variable:`CMAKE_ANDROID_JAR_DEPENDENCIES` +variable if it is set when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_JAR_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_JAR_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6fef50b2d6511c28dff46326fbc5aac5ea77b246 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_JAR_DIRECTORIES.rst.txt @@ -0,0 +1,16 @@ +ANDROID_JAR_DIRECTORIES +----------------------- + +.. versionadded:: 3.4 + +Set the Android property that specifies directories to search for +the JAR libraries. + +This a string property that contains the directory paths separated by +semicolons. This property is initialized by the value of the +:variable:`CMAKE_ANDROID_JAR_DIRECTORIES` variable if it is set when +a target is created. + +Contents of ``ANDROID_JAR_DIRECTORIES`` may use "generator expressions" +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_JAVA_SOURCE_DIR.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_JAVA_SOURCE_DIR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9ea988444d413d0e1a268215aa4ccfb3887c6a38 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_JAVA_SOURCE_DIR.rst.txt @@ -0,0 +1,10 @@ +ANDROID_JAVA_SOURCE_DIR +----------------------- + +.. versionadded:: 3.4 + +Set the Android property that defines the Java source code root directories. +This a string property that contains the directory paths separated by semicolon. +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_JAVA_SOURCE_DIR` variable if it is set +when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_NATIVE_LIB_DEPENDENCIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_NATIVE_LIB_DEPENDENCIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3aa741f90ed3fce2d1ac7aa94f5f2c947099dc21 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_NATIVE_LIB_DEPENDENCIES.rst.txt @@ -0,0 +1,16 @@ +ANDROID_NATIVE_LIB_DEPENDENCIES +------------------------------- + +.. versionadded:: 3.4 + +Set the Android property that specifies the .so dependencies. +This is a string property. + +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES` variable if it is set +when a target is created. + +Contents of ``ANDROID_NATIVE_LIB_DEPENDENCIES`` may use +"generator expressions" with the syntax ``$<...>``. See the +:manual:`cmake-generator-expressions(7)` manual for +available expressions. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_NATIVE_LIB_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_NATIVE_LIB_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..98200d9cea52f55945c7c64647b7031ef85f8e23 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_NATIVE_LIB_DIRECTORIES.rst.txt @@ -0,0 +1,18 @@ +ANDROID_NATIVE_LIB_DIRECTORIES +------------------------------ + +.. versionadded:: 3.4 + +Set the Android property that specifies directories to search for the ``.so`` +libraries. + +This a string property that contains the directory paths separated +by semicolons. + +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES` variable if it is set when a +target is created. + +Contents of ``ANDROID_NATIVE_LIB_DIRECTORIES`` may use "generator expressions" +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_PROCESS_MAX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_PROCESS_MAX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0b6aba7aa1d13a603169070bdbb6969606095e86 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_PROCESS_MAX.rst.txt @@ -0,0 +1,10 @@ +ANDROID_PROCESS_MAX +------------------- + +.. versionadded:: 3.4 + +Set the Android property that defines the maximum number of a +parallel Android NDK compiler processes (e.g. ``4``). +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_PROCESS_MAX` variable if it is set +when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_PROGUARD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_PROGUARD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b5ce166a8841f63a40df02bb5c4d799f6537827f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_PROGUARD.rst.txt @@ -0,0 +1,11 @@ +ANDROID_PROGUARD +---------------- + +.. versionadded:: 3.4 + +When this property is set to true that enables the ProGuard tool to shrink, +optimize, and obfuscate the code by removing unused code and renaming +classes, fields, and methods with semantically obscure names. +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_PROGUARD` variable if it is set +when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_PROGUARD_CONFIG_PATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_PROGUARD_CONFIG_PATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6ac59d8eb77df5f4eb3890c10109027c555b337e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_PROGUARD_CONFIG_PATH.rst.txt @@ -0,0 +1,11 @@ +ANDROID_PROGUARD_CONFIG_PATH +---------------------------- + +.. versionadded:: 3.4 + +Set the Android property that specifies the location of the ProGuard +config file. Leave empty to use the default one. +This a string property that contains the path to ProGuard config file. +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_PROGUARD_CONFIG_PATH` variable if it is set +when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_SECURE_PROPS_PATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_SECURE_PROPS_PATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f2ffa2e354939c79defc3cf7300b769dad152f8c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_SECURE_PROPS_PATH.rst.txt @@ -0,0 +1,10 @@ +ANDROID_SECURE_PROPS_PATH +------------------------- + +.. versionadded:: 3.4 + +Set the Android property that states the location of the secure properties file. +This is a string property that contains the file path. +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_SECURE_PROPS_PATH` variable +if it is set when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_SKIP_ANT_STEP.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_SKIP_ANT_STEP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..1a54bce91825935cfcac65487c67c61019d1c7b2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_SKIP_ANT_STEP.rst.txt @@ -0,0 +1,8 @@ +ANDROID_SKIP_ANT_STEP +--------------------- + +.. versionadded:: 3.4 + +Set the Android property that defines whether or not to skip the Ant build step. +This is a boolean property initialized by the value of the +:variable:`CMAKE_ANDROID_SKIP_ANT_STEP` variable if it is set when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_STL_TYPE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_STL_TYPE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c83712b25fc2037fea9be398302916e7f259311a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ANDROID_STL_TYPE.rst.txt @@ -0,0 +1,29 @@ +ANDROID_STL_TYPE +---------------- + +.. versionadded:: 3.4 + +When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio +Edition`, this property specifies the type of STL support for the project. +This is a string property that could set to the one of the following values: + +``none`` + No C++ Support +``system`` + Minimal C++ without STL +``gabi++_static`` + GAbi++ Static +``gabi++_shared`` + GAbi++ Shared +``gnustl_static`` + GNU libstdc++ Static +``gnustl_shared`` + GNU libstdc++ Shared +``stlport_static`` + STLport Static +``stlport_shared`` + STLport Shared + +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_STL_TYPE` variable if it is set when a target is +created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..abb627cdad7e94ac2b7041202a354bbcbcc0609e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst.txt @@ -0,0 +1,12 @@ +ARCHIVE_OUTPUT_DIRECTORY +------------------------ + +.. |XXX| replace:: :ref:`ARCHIVE ` +.. |xxx| replace:: archive +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_ARCHIVE_OUTPUT_DIRECTORY` +.. include:: XXX_OUTPUT_DIRECTORY.txt + +.. |IDEM| replace:: in the same directory +.. include:: MACOS_IMPORT_FILES.txt + +See also the :prop_tgt:`ARCHIVE_OUTPUT_DIRECTORY_` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..12f8bb7ef1aace563795b5842688f55827f18bea --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst.txt @@ -0,0 +1,16 @@ +ARCHIVE_OUTPUT_DIRECTORY_ +--------------------------------- + +Per-configuration output directory for +:ref:`ARCHIVE ` target files. + +This is a per-configuration version of the +:prop_tgt:`ARCHIVE_OUTPUT_DIRECTORY` target property, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the +:variable:`CMAKE_ARCHIVE_OUTPUT_DIRECTORY_` variable if +it is set when a target is created. + +Contents of ``ARCHIVE_OUTPUT_DIRECTORY_`` may use +:manual:`generator expressions `. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..1f1c4671f1b1a1bd5d15f78898bc8506df7ecb1f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_NAME.rst.txt @@ -0,0 +1,11 @@ +ARCHIVE_OUTPUT_NAME +------------------- + +.. |XXX| replace:: :ref:`ARCHIVE ` +.. |xxx| replace:: archive +.. include:: XXX_OUTPUT_NAME.txt + +.. |IDEM| replace:: with the same name +.. include:: MACOS_IMPORT_FILES.txt + +See also the :prop_tgt:`ARCHIVE_OUTPUT_NAME_` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4f62eb995350dbb778e5690f7344d32ffe55d290 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst.txt @@ -0,0 +1,8 @@ +ARCHIVE_OUTPUT_NAME_ +---------------------------- + +Per-configuration output name for +:ref:`ARCHIVE ` target files. + +This is the configuration-specific version of the +:prop_tgt:`ARCHIVE_OUTPUT_NAME` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_BETTER_GRAPH_MULTI_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_BETTER_GRAPH_MULTI_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..edeb15c00d6c8d23a378af5203df6dc1becec351 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_BETTER_GRAPH_MULTI_CONFIG.rst.txt @@ -0,0 +1,22 @@ +AUTOGEN_BETTER_GRAPH_MULTI_CONFIG +--------------------------------- + +.. versionadded:: 3.29 + +``AUTOGEN_BETTER_GRAPH_MULTI_CONFIG`` is a boolean property that can be set +on a target to have better dependency graph for multi-configuration generators. +When this property is enabled, ``CMake`` will generate more per-config targets. +Thus, the dependency graph will be more accurate for multi-configuration +generators and some recompilations will be avoided. + +If the Qt version is 6.8 or newer, this property is enabled by default. +If the Qt version is older than 6.8, this property is disabled by default. +Consult the Qt documentation to check if the property can be enabled for older +Qt versions. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +This property is initialized by the +:variable:`CMAKE_AUTOGEN_BETTER_GRAPH_MULTI_CONFIG` variable if it is set when +a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_BUILD_DIR.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_BUILD_DIR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..1ca0969b699f288677bba3f1e3f6f5bec2a17705 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_BUILD_DIR.rst.txt @@ -0,0 +1,19 @@ +AUTOGEN_BUILD_DIR +----------------- + +.. versionadded:: 3.9 + +Directory where :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` +generate files for the target. + +The directory is created on demand and automatically added to the +:prop_tgt:`ADDITIONAL_CLEAN_FILES` target property. + +When unset or empty the directory ``/_autogen`` is used where +```` is :variable:`CMAKE_CURRENT_BINARY_DIR` and ```` +is :prop_tgt:`NAME`. + +By default ``AUTOGEN_BUILD_DIR`` is unset. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_COMMAND_LINE_LENGTH_MAX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_COMMAND_LINE_LENGTH_MAX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f1e51a7cc8d46b7648cba9074d7625e209367191 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_COMMAND_LINE_LENGTH_MAX.rst.txt @@ -0,0 +1,18 @@ +AUTOGEN_COMMAND_LINE_LENGTH_MAX +------------------------------- + +.. versionadded:: 3.29 + +Command line length limit for autogen targets, i.e. ``moc`` or ``uic``, +that triggers the use of response files on Windows instead of passing all +arguments to the command line. + +- An empty (or unset) value sets the limit to 32000 +- A positive non zero integer value sets the exact command line length + limit. + +By default ``AUTOGEN_COMMAND_LINE_LENGTH_MAX`` is initialized from +:variable:`CMAKE_AUTOGEN_COMMAND_LINE_LENGTH_MAX`. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..33db8a752d669bc94b8804d4a4b4991cf9a033d5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst.txt @@ -0,0 +1,48 @@ +AUTOGEN_ORIGIN_DEPENDS +---------------------- + +.. versionadded:: 3.14 + +Switch for forwarding origin target dependencies to the corresponding +:ref:`_autogen` target. + + .. note:: + + If Qt 5.15 or later is used and the generator is either :generator:`Ninja` + or :ref:`Makefile Generators`, origin target dependencies are forwarded to + the :ref:`_autogen_timestamp_deps` target instead of + :ref:`_autogen` + + +Targets which have their :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` property +``ON`` have a corresponding :ref:`_autogen` target which generates +``moc`` and ``uic`` files. As this :ref:`_autogen` target is created at +generate-time, it is not possible to define dependencies of it using +e.g. :command:`add_dependencies`. Instead the ``AUTOGEN_ORIGIN_DEPENDS`` +target property decides whether the origin target dependencies should be +forwarded to the :ref:`_autogen` target or not. + +By default ``AUTOGEN_ORIGIN_DEPENDS`` is initialized from +:variable:`CMAKE_AUTOGEN_ORIGIN_DEPENDS` which is ``ON`` by default. + +In total the dependencies of the :ref:`_autogen` target are composed +from + +- forwarded origin target dependencies + (enabled by default via ``AUTOGEN_ORIGIN_DEPENDS``) +- additional user defined dependencies from :prop_tgt:`AUTOGEN_TARGET_DEPENDS` + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +.. note:: + + Disabling ``AUTOGEN_ORIGIN_DEPENDS`` is useful to avoid building of + origin target dependencies when building the :ref:`_autogen` target + only. This is especially interesting when a + :variable:`global autogen target ` is enabled. + + When the :ref:`_autogen` target doesn't require all the origin target's + dependencies, and ``AUTOGEN_ORIGIN_DEPENDS`` is disabled, it might be + necessary to extend :prop_tgt:`AUTOGEN_TARGET_DEPENDS` to add missing + dependencies. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_PARALLEL.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_PARALLEL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9d34355e527e04711c414dd19c04e2479f294a1c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_PARALLEL.rst.txt @@ -0,0 +1,23 @@ +AUTOGEN_PARALLEL +---------------- + +.. versionadded:: 3.11 + +Number of parallel ``moc`` or ``uic`` processes to start when using +:prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`. + +The custom :ref:`_autogen` target starts a number of threads of which +each one parses a source file and on demand starts a ``moc`` or ``uic`` +process. ``AUTOGEN_PARALLEL`` controls how many parallel threads +(and therefore ``moc`` or ``uic`` processes) are started. + +- An empty (or unset) value or the string ``AUTO`` sets the number of + threads/processes to the number of physical CPUs on the host system. +- A positive non zero integer value sets the exact thread/process count. +- Otherwise a single thread/process is started. + +By default ``AUTOGEN_PARALLEL`` is initialized from +:variable:`CMAKE_AUTOGEN_PARALLEL`. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..13e2ef7c0c3fcac5718ae3a6cee265a37347b78f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst.txt @@ -0,0 +1,46 @@ +AUTOGEN_TARGET_DEPENDS +---------------------- + +Additional target dependencies of the corresponding :ref:`_autogen` +target. + + .. note:: + + If Qt 5.15 or later is used and the generator is either :generator:`Ninja` + or :ref:`Makefile Generators`, additional target dependencies are added to + the :ref:`_autogen_timestamp_deps` target instead of the + :ref:`_autogen` target. + + +Targets which have their :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` property +``ON`` have a corresponding :ref:`_autogen` target which generates +``moc`` and ``uic`` files. As this :ref:`_autogen` target is created +at generate-time, it is not possible to define dependencies of it using e.g. +:command:`add_dependencies`. Instead the ``AUTOGEN_TARGET_DEPENDS`` target +property can be set to a :ref:`;-list ` of additional +dependencies for the :ref:`_autogen` target. Dependencies can be target +names or file names. + +In total the dependencies of the :ref:`_autogen` target are composed +from + +- forwarded origin target dependencies + (enabled by default via :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS`) +- additional user defined dependencies from ``AUTOGEN_TARGET_DEPENDS`` + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +Use cases +^^^^^^^^^ + +If :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` depends on a file that is either + +- a :prop_sf:`GENERATED` non C++ file (e.g. a :prop_sf:`GENERATED` ``.json`` + or ``.ui`` file) or +- a :prop_sf:`GENERATED` C++ file that isn't recognized by :prop_tgt:`AUTOMOC` + and :prop_tgt:`AUTOUIC` because it's skipped by :prop_sf:`SKIP_AUTOMOC`, + :prop_sf:`SKIP_AUTOUIC`, :prop_sf:`SKIP_AUTOGEN` or :policy:`CMP0071` or +- a file that isn't in the origin target's sources + +it must be added to ``AUTOGEN_TARGET_DEPENDS``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_USE_SYSTEM_INCLUDE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_USE_SYSTEM_INCLUDE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..37d6276db4ff0619871d860d08383ce32f1b1487 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOGEN_USE_SYSTEM_INCLUDE.rst.txt @@ -0,0 +1,19 @@ +AUTOGEN_USE_SYSTEM_INCLUDE +-------------------------- + +.. versionadded:: 3.27 + +``AUTOGEN_USE_SYSTEM_INCLUDE`` is a boolean property that can be set +on a target to indicate that the autogen target include directory should +be added as a system include directory or normal include directory to the +target. + +If this property is not set, the autogen target include directory is added +as a system include directory by default. See policy :policy:`CMP0151`. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +This property is initialized by the +:variable:`CMAKE_AUTOGEN_USE_SYSTEM_INCLUDE` variable if it is set when +a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d4f2b25f425630527c08f75b67b5432bab099046 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC.rst.txt @@ -0,0 +1,257 @@ +AUTOMOC +------- + +Should the target be processed with auto-moc (for Qt projects). + +``AUTOMOC`` is a boolean specifying whether CMake will handle the Qt ``moc`` +preprocessor automatically, i.e. without having to use commands like +:module:`QT4_WRAP_CPP() `, `qt5_wrap_cpp()`_, etc. +Currently, Qt versions 4 to 6 are supported. + +.. _qt5_wrap_cpp(): https://doc.qt.io/qt-5/qtcore-cmake-qt5-wrap-cpp.html + +This property is initialized by the value of the :variable:`CMAKE_AUTOMOC` +variable if it is set when a target is created. + +When this property is set ``ON``, CMake will scan the header and +source files at build time and invoke ``moc`` accordingly. + + +Header file processing +^^^^^^^^^^^^^^^^^^^^^^ + +At configuration time, a list of header files that should be scanned by +``AUTOMOC`` is computed from the target's sources. + +- All header files in the target's sources are added to the scan list. +- For all C++ source files ``.`` in the + target's sources, CMake searches for + + - a regular header with the same base name + (``.``) and + - a private header with the same base name and a ``_p`` suffix + (``_p.``) + + and adds these to the scan list. + +At build time, CMake scans each unknown or modified header file from the +list and searches for + +- a Qt macro from :prop_tgt:`AUTOMOC_MACRO_NAMES`, +- additional file dependencies from the ``FILE`` argument of a + ``Q_PLUGIN_METADATA`` macro and +- additional file dependencies detected by filters defined in + :prop_tgt:`AUTOMOC_DEPEND_FILTERS`. + +If a Qt macro is found, then the header will be compiled by the ``moc`` to the +output file ``moc_.cpp``. The complete output file path is +described in the section `Output file location`_. + +The header will be ``moc`` compiled again if a file from the additional file +dependencies changes. + +Header ``moc`` output files ``moc_.cpp`` can be included in source +files. In the section `Including header moc files in sources`_ there is more +information on that topic. + + +Source file processing +^^^^^^^^^^^^^^^^^^^^^^ + +At build time, CMake scans each unknown or modified C++ source file from the +target's sources for + +- a Qt macro from :prop_tgt:`AUTOMOC_MACRO_NAMES`, +- includes of header ``moc`` files + (see `Including header moc files in sources`_), +- additional file dependencies from the ``FILE`` argument of a + ``Q_PLUGIN_METADATA`` macro and +- additional file dependencies detected by filters defined in + :prop_tgt:`AUTOMOC_DEPEND_FILTERS`. + +If a Qt macro is found, then the C++ source file +``.`` is expected to as well contain an include +statement + +.. code-block:: c++ + + #include <.moc> // or + #include ".moc" + +The source file then will be compiled by the ``moc`` to the output file +``.moc``. A description of the complete output file path is in section +`Output file location`_. + +The source will be ``moc`` compiled again if a file from the additional file +dependencies changes. + +Including header moc files in sources +""""""""""""""""""""""""""""""""""""" + +A source file can include the ``moc`` output file of a header +``.`` by using an include statement of +the form + +.. code-block:: c++ + + #include .cpp> // or + #include "moc_.cpp" + +If the ``moc`` output file of a header is included by a source, it will +be generated in a different location than if it was not included. This is +described in the section `Output file location`_. + + +Output file location +^^^^^^^^^^^^^^^^^^^^ + +Included moc output files +""""""""""""""""""""""""" + +``moc`` output files that are included by a source file will be generated in + +- ``/include`` + for single configuration generators or in +- ``/include_`` + for :prop_gbl:`multi configuration ` generators. + +Where ```` is the value of the target property +:prop_tgt:`AUTOGEN_BUILD_DIR`. + +The include directory is automatically added to the target's +:prop_tgt:`INCLUDE_DIRECTORIES`. + +Not included moc output files +""""""""""""""""""""""""""""" + +``moc`` output files that are not included in a source file will be generated +in + +- ``/`` + for single configuration generators or in, +- ``/include_/`` + for :prop_gbl:`multi configuration ` generators. + +Where ```` is a checksum computed from the relative +parent directory path of the ``moc`` input file. This scheme allows to have +``moc`` input files with the same name in different directories. + +All not included ``moc`` output files will be included automatically by the +CMake generated file + +- ``/mocs_compilation.cpp``, or +- ``/mocs_compilation_$.cpp``, + +which is added to the target's sources. + + +Qt version detection +^^^^^^^^^^^^^^^^^^^^ + +``AUTOMOC`` enabled targets need to know the Qt major and minor +version they're working with. The major version usually is provided by the +``INTERFACE_QT_MAJOR_VERSION`` property of the ``Qt[456]Core`` library, +that the target links to. To find the minor version, CMake builds a list of +available Qt versions from + +- ``Qt6Core_VERSION_MAJOR`` and ``Qt6Core_VERSION_MINOR`` variables + (usually set by ``find_package(Qt6...)``) +- ``Qt6Core_VERSION_MAJOR`` and ``Qt6Core_VERSION_MINOR`` directory properties +- ``Qt5Core_VERSION_MAJOR`` and ``Qt5Core_VERSION_MINOR`` variables + (usually set by ``find_package(Qt5...)``) +- ``Qt5Core_VERSION_MAJOR`` and ``Qt5Core_VERSION_MINOR`` directory properties +- ``QT_VERSION_MAJOR`` and ``QT_VERSION_MINOR`` variables + (usually set by ``find_package(Qt4...)``) +- ``QT_VERSION_MAJOR`` and ``QT_VERSION_MINOR`` directory properties + +in the context of the :command:`add_executable` or :command:`add_library` call. + +Assumed ``INTERFACE_QT_MAJOR_VERSION`` is a valid number, the first +entry in the list with a matching major version is taken. If no matching major +version was found, an error is generated. +If ``INTERFACE_QT_MAJOR_VERSION`` is not a valid number, the first +entry in the list is taken. + +A ``find_package(Qt[456]...)`` call sets the ``QT/Qt[56]Core_VERSION_MAJOR/MINOR`` +variables. If the call is in a different context than the +:command:`add_executable` or :command:`add_library` call, e.g. in a function, +then the version variables might not be available to the ``AUTOMOC`` +enabled target. +In that case the version variables can be forwarded from the +``find_package(Qt[456]...)`` calling context to the :command:`add_executable` +or :command:`add_library` calling context as directory properties. +The following Qt5 example demonstrates the procedure. + +.. code-block:: cmake + + function (add_qt5_client) + find_package(Qt5 REQUIRED QUIET COMPONENTS Core Widgets) + ... + set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" + PROPERTY Qt5Core_VERSION_MAJOR "${Qt5Core_VERSION_MAJOR}") + set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" + PROPERTY Qt5Core_VERSION_MINOR "${Qt5Core_VERSION_MAJOR}") + ... + endfunction () + ... + add_qt5_client() + add_executable(myTarget main.cpp) + target_link_libraries(myTarget Qt5::QtWidgets) + set_property(TARGET myTarget PROPERTY AUTOMOC ON) + + +Modifiers +^^^^^^^^^ + +:prop_tgt:`AUTOMOC_EXECUTABLE`: +The ``moc`` executable will be detected automatically, but can be forced to +a certain binary using this target property. + +:prop_tgt:`AUTOMOC_MOC_OPTIONS`: +Additional command line options for ``moc`` can be set in this target property. + +:prop_tgt:`AUTOMOC_MACRO_NAMES`: +This list of Qt macro names can be extended to search for additional macros in +headers and sources. + +:prop_tgt:`AUTOMOC_DEPEND_FILTERS`: +``moc`` dependency file names can be extracted from headers or sources by +defining file name filters in this target property. + +:prop_tgt:`AUTOMOC_COMPILER_PREDEFINES`: +Compiler pre definitions for ``moc`` are written to the ``moc_predefs.h`` file. +The generation of this file can be enabled or disabled in this target property. + +:prop_sf:`SKIP_AUTOMOC`: +Sources and headers can be excluded from ``AUTOMOC`` processing by +setting this source file property. + +:prop_sf:`SKIP_AUTOGEN`: +Source files can be excluded from ``AUTOMOC``, +:prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` processing by +setting this source file property. + +:prop_gbl:`AUTOGEN_SOURCE_GROUP`: +This global property can be used to group files generated by +``AUTOMOC`` or :prop_tgt:`AUTORCC` together in an IDE, e.g. in MSVS. + +:prop_gbl:`AUTOGEN_TARGETS_FOLDER`: +This global property can be used to group ``AUTOMOC``, +:prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` targets together in an IDE, +e.g. in MSVS. + +:variable:`CMAKE_GLOBAL_AUTOGEN_TARGET`: +A global ``autogen`` target, that depends on all ``AUTOMOC`` or +:prop_tgt:`AUTOUIC` generated :ref:`_autogen` targets in the project, +will be generated when this variable is ``ON``. + +:prop_tgt:`AUTOGEN_PARALLEL`: +This target property controls the number of ``moc`` or ``uic`` processes to +start in parallel during builds. + +:prop_tgt:`AUTOGEN_COMMAND_LINE_LENGTH_MAX`: +This target property controls the limit when to use response files for +``moc`` or ``uic`` processes on Windows. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..82aa61e8b3dd6843cdf5959321942f573d21b11c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst.txt @@ -0,0 +1,26 @@ +AUTOMOC_COMPILER_PREDEFINES +--------------------------- + +.. versionadded:: 3.10 + +Boolean value used by :prop_tgt:`AUTOMOC` to determine if the +compiler pre definitions file ``moc_predefs.h`` should be generated. + +CMake generates a ``moc_predefs.h`` file with compiler pre definitions +from the output of the command defined in +:variable:`CMAKE_CXX_COMPILER_PREDEFINES_COMMAND _COMPILER_PREDEFINES_COMMAND>` +when + +- :prop_tgt:`AUTOMOC` is enabled, +- ``AUTOMOC_COMPILER_PREDEFINES`` is enabled, +- :variable:`CMAKE_CXX_COMPILER_PREDEFINES_COMMAND _COMPILER_PREDEFINES_COMMAND>` isn't empty and +- the Qt version is greater or equal 5.8. + +The ``moc_predefs.h`` file, which is generated in :prop_tgt:`AUTOGEN_BUILD_DIR`, +is passed to ``moc`` as the argument to the ``--include`` option. + +By default ``AUTOMOC_COMPILER_PREDEFINES`` is initialized from +:variable:`CMAKE_AUTOMOC_COMPILER_PREDEFINES`, which is ON by default. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d571f53afb72a83676def59982ba897cadcb68c7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst.txt @@ -0,0 +1,109 @@ +AUTOMOC_DEPEND_FILTERS +---------------------- + +.. versionadded:: 3.9 + +Filter definitions used by :prop_tgt:`AUTOMOC` to extract file names from a +source file that are registered as additional dependencies for the +``moc`` file of the source file. + +Filters are defined as ``KEYWORD;REGULAR_EXPRESSION`` pairs. First the file +content is searched for ``KEYWORD``. If it is found at least once, then file +names are extracted by successively searching for ``REGULAR_EXPRESSION`` and +taking the first match group. + +The file name found in the first match group is searched for + +- first in the vicinity of the source file +- and afterwards in the target's :prop_tgt:`INCLUDE_DIRECTORIES`. + +If any of the extracted files changes, then the ``moc`` file for the source +file gets rebuilt even when the source file itself doesn't change. + +If any of the extracted files is :prop_sf:`GENERATED` or if it is not in the +target's sources, then it might be necessary to add it to the +:ref:`_autogen` target dependencies. +See :prop_tgt:`AUTOGEN_TARGET_DEPENDS` for reference. + +By default ``AUTOMOC_DEPEND_FILTERS`` is initialized from +:variable:`CMAKE_AUTOMOC_DEPEND_FILTERS`, which is empty by default. + +From Qt 5.15.0 on this variable is ignored as ``moc`` is able to output the +correct dependencies. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + + +Example 1 +^^^^^^^^^ + +A header file ``my_class.hpp`` uses a custom macro ``JSON_FILE_MACRO`` which +is defined in an other header ``macros.hpp``. +We want the ``moc`` file of ``my_class.hpp`` to depend on the file name +argument of ``JSON_FILE_MACRO``:: + + // my_class.hpp + class My_Class : public QObject + { + Q_OBJECT + JSON_FILE_MACRO ( "info.json" ) + ... + }; + +In ``CMakeLists.txt`` we add a filter to +:variable:`CMAKE_AUTOMOC_DEPEND_FILTERS` like this:: + + list( APPEND CMAKE_AUTOMOC_DEPEND_FILTERS + "JSON_FILE_MACRO" + "[\n][ \t]*JSON_FILE_MACRO[ \t]*\\([ \t]*\"([^\"]+)\"" + ) + +We assume ``info.json`` is a plain (not :prop_sf:`GENERATED`) file that is +listed in the target's source. Therefore we do not need to add it to +:prop_tgt:`AUTOGEN_TARGET_DEPENDS`. + +Example 2 +^^^^^^^^^ + +In the target ``my_target`` a header file ``complex_class.hpp`` uses a +custom macro ``JSON_BASED_CLASS`` which is defined in an other header +``macros.hpp``:: + + // macros.hpp + ... + #define JSON_BASED_CLASS(name, json) \ + class name : public QObject \ + { \ + Q_OBJECT \ + Q_PLUGIN_METADATA(IID "demo" FILE json) \ + name() {} \ + }; + ... + +:: + + // complex_class.hpp + #pragma once + JSON_BASED_CLASS(Complex_Class, "meta.json") + // end of file + +Since ``complex_class.hpp`` doesn't contain a ``Q_OBJECT`` macro it would be +ignored by :prop_tgt:`AUTOMOC`. We change this by adding ``JSON_BASED_CLASS`` +to :variable:`CMAKE_AUTOMOC_MACRO_NAMES`:: + + list(APPEND CMAKE_AUTOMOC_MACRO_NAMES "JSON_BASED_CLASS") + +We want the ``moc`` file of ``complex_class.hpp`` to depend on +``meta.json``. So we add a filter to +:variable:`CMAKE_AUTOMOC_DEPEND_FILTERS`:: + + list(APPEND CMAKE_AUTOMOC_DEPEND_FILTERS + "JSON_BASED_CLASS" + "[\n^][ \t]*JSON_BASED_CLASS[ \t]*\\([^,]*,[ \t]*\"([^\"]+)\"" + ) + +Additionally we assume ``meta.json`` is :prop_sf:`GENERATED` which is +why we have to add it to :prop_tgt:`AUTOGEN_TARGET_DEPENDS`:: + + set_property(TARGET my_target APPEND PROPERTY AUTOGEN_TARGET_DEPENDS "meta.json") diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_EXECUTABLE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_EXECUTABLE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a6d5aa03e6731d527f1cd77b0e09983a174c03c1 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_EXECUTABLE.rst.txt @@ -0,0 +1,17 @@ +AUTOMOC_EXECUTABLE +------------------ + +.. versionadded:: 3.14 + +``AUTOMOC_EXECUTABLE`` is file path pointing to the ``moc`` +executable to use for :prop_tgt:`AUTOMOC` enabled files. Setting +this property will make CMake skip the automatic detection of the +``moc`` binary as well as the sanity-tests normally run to ensure +that the binary is available and working as expected. + +Usually this property does not need to be set. Only consider this +property if auto-detection of ``moc`` can not work -- e.g. because +you are building the ``moc`` binary as part of your project. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_MACRO_NAMES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_MACRO_NAMES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a4a9ba230338bd12838deaccfbb25ab4c1126629 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_MACRO_NAMES.rst.txt @@ -0,0 +1,38 @@ +AUTOMOC_MACRO_NAMES +------------------- + +.. versionadded:: 3.10 + +A :ref:`semicolon-separated list ` of macro names used by +:prop_tgt:`AUTOMOC` to determine if a C++ file needs to be processed by ``moc``. + +This property is only used if the :prop_tgt:`AUTOMOC` property is ``ON`` +for this target. + +When running :prop_tgt:`AUTOMOC`, CMake searches for the strings listed in +``AUTOMOC_MACRO_NAMES`` in C++ source and header files. +If any of the strings is found + +- as the first non space string on a new line or +- as the first non space string after a ``{`` on a new line, + +then the file will be processed by ``moc``. + +By default ``AUTOMOC_MACRO_NAMES`` is initialized from +:variable:`CMAKE_AUTOMOC_MACRO_NAMES`. + +See also the :prop_tgt:`INTERFACE_AUTOMOC_MACRO_NAMES` target property. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +Example +^^^^^^^ + +In this case the ``Q_OBJECT`` macro is hidden inside another macro +called ``CUSTOM_MACRO``. To let CMake know that source files that contain +``CUSTOM_MACRO`` need to be ``moc`` processed, we call: + +.. code-block:: cmake + + set_property(TARGET tgt APPEND PROPERTY AUTOMOC_MACRO_NAMES "CUSTOM_MACRO") diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_MOC_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_MOC_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..11ab147c09ed0515f798d2e25e14d8f5fa42c1ba --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_MOC_OPTIONS.rst.txt @@ -0,0 +1,53 @@ +AUTOMOC_MOC_OPTIONS +------------------- + +Additional options for ``moc`` when using :prop_tgt:`AUTOMOC` + +This property is only used if the :prop_tgt:`AUTOMOC` property is ``ON`` +for this target. In this case, it holds additional command line +options which will be used when ``moc`` is executed during the build, i.e. +it is equivalent to the optional ``OPTIONS`` argument of the +:module:`qt4_wrap_cpp() ` macro. + +This property is initialized by the value of the +:variable:`CMAKE_AUTOMOC_MOC_OPTIONS` variable if it is set when a target +is created, or an empty string otherwise. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +EXAMPLE +^^^^^^^ + +In this example, the ``moc`` tool is invoked with the ``-D_EXTRA_DEFINE`` +option when generating the moc file for ``object.cpp``. + +``CMakeLists.txt`` + .. code-block:: cmake + + add_executable(mocOptions object.cpp main.cpp) + set_property(TARGET mocOptions PROPERTY AUTOMOC ON) + target_compile_options(mocOptions PRIVATE "-D_EXTRA_DEFINE") + set_property(TARGET mocOptions PROPERTY AUTOMOC_MOC_OPTIONS "-D_EXTRA_DEFINE") + target_link_libraries(mocOptions Qt6::Core) + +``object.hpp`` + .. code-block:: c++ + + #ifndef Object_HPP + #define Object_HPP + + #include + + #ifdef _EXTRA_DEFINE + class Object : public QObject + { + Q_OBJECT + public: + + Object(); + + }; + #endif + + #endif diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_PATH_PREFIX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_PATH_PREFIX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..dcddcaebb4c08bf21719a81d1e2b1bd08833bcd7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOMOC_PATH_PREFIX.rst.txt @@ -0,0 +1,33 @@ +AUTOMOC_PATH_PREFIX +------------------- + +.. versionadded:: 3.16 + +When this property is ``ON``, CMake will generate the ``-p`` path prefix +option for ``moc`` on :prop_tgt:`AUTOMOC` enabled Qt targets. + +To generate the path prefix, CMake tests if the header compiled by ``moc`` +is in any of the target +:command:`include directories `. If so, CMake will +compute the relative path accordingly. If the header is not in the +:command:`include directories `, CMake will omit +the ``-p`` path prefix option. ``moc`` usually generates a +relative include path in that case. + +``AUTOMOC_PATH_PREFIX`` is initialized from the variable +:variable:`CMAKE_AUTOMOC_PATH_PREFIX`, which is ``OFF`` by default. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +Reproducible builds +^^^^^^^^^^^^^^^^^^^ + +For reproducible builds it is recommended to keep headers that are ``moc`` +compiled in one of the target +:command:`include directories ` and set +``AUTOMOC_PATH_PREFIX`` to ``ON``. This ensures that: + +- ``moc`` output files are identical on different build setups, +- ``moc`` output files will compile correctly when the source and/or + build directory is a symbolic link. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTORCC.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTORCC.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fea906ca497f1dbac4a66f2f4314ba62b21fa7fe --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTORCC.rst.txt @@ -0,0 +1,64 @@ +AUTORCC +------- + +Should the target be processed with auto-rcc (for Qt projects). + +``AUTORCC`` is a boolean specifying whether CMake will handle +the Qt ``rcc`` code generator automatically, i.e. without having to use +commands like :module:`QT4_ADD_RESOURCES() `, `qt5_add_resources()`_, +etc. Currently, Qt versions 4 to 6 are supported. + +.. _`qt5_add_resources()`: https://doc.qt.io/qt-5/qtcore-cmake-qt5-add-resources.html + +When this property is ``ON``, CMake will handle ``.qrc`` files added +as target sources at build time and invoke ``rcc`` accordingly. +This property is initialized by the value of the :variable:`CMAKE_AUTORCC` +variable if it is set when a target is created. + +By default ``AUTORCC`` is processed by a +:command:`custom command `. +If the ``.qrc`` file is :prop_sf:`GENERATED`, a +:command:`custom target ` is used instead. + +When there are multiple ``.qrc`` files with the same name, CMake will +generate unspecified unique output file names for ``rcc``. Therefore, if +``Q_INIT_RESOURCE()`` or ``Q_CLEANUP_RESOURCE()`` need to be used, the +``.qrc`` file name must be unique. + + +Modifiers +^^^^^^^^^ + +:prop_tgt:`AUTORCC_EXECUTABLE`: +The ``rcc`` executable will be detected automatically, but can be forced to +a certain binary by setting this target property. + +:prop_tgt:`AUTORCC_OPTIONS`: +Additional command line options for ``rcc`` can be set via this target +property. The corresponding :prop_sf:`AUTORCC_OPTIONS` source file property +can be used to specify options to be applied only to a specific ``.qrc`` file. + +:prop_sf:`SKIP_AUTORCC`: +``.qrc`` files can be excluded from ``AUTORCC`` processing by +setting this source file property. + +:prop_sf:`SKIP_AUTOGEN`: +Source files can be excluded from :prop_tgt:`AUTOMOC`, +:prop_tgt:`AUTOUIC` and ``AUTORCC`` processing by +setting this source file property. + +:prop_gbl:`AUTOGEN_SOURCE_GROUP`: +This global property can be used to group files generated by +:prop_tgt:`AUTOMOC` or ``AUTORCC`` together in an IDE, e.g. in MSVS. + +:prop_gbl:`AUTOGEN_TARGETS_FOLDER`: +This global property can be used to group :prop_tgt:`AUTOMOC`, +:prop_tgt:`AUTOUIC` and ``AUTORCC`` targets together in an IDE, +e.g. in MSVS. + +:variable:`CMAKE_GLOBAL_AUTORCC_TARGET`: +A global ``autorcc`` target that depends on all ``AUTORCC`` targets +in the project will be generated when this variable is ``ON``. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTORCC_EXECUTABLE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTORCC_EXECUTABLE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..68942e67e91604bc7c766c56c7e3fa03a89e4a11 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTORCC_EXECUTABLE.rst.txt @@ -0,0 +1,17 @@ +AUTORCC_EXECUTABLE +------------------ + +.. versionadded:: 3.14 + +``AUTORCC_EXECUTABLE`` is file path pointing to the ``rcc`` +executable to use for :prop_tgt:`AUTORCC` enabled files. Setting +this property will make CMake skip the automatic detection of the +``rcc`` binary as well as the sanity-tests normally run to ensure +that the binary is available and working as expected. + +Usually this property does not need to be set. Only consider this +property if auto-detection of ``rcc`` can not work -- e.g. because +you are building the ``rcc`` binary as part of your project. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTORCC_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTORCC_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5261aff230c712d921067fe81ffe25118cdc3bdf --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTORCC_OPTIONS.rst.txt @@ -0,0 +1,28 @@ +AUTORCC_OPTIONS +--------------- + +Additional options for ``rcc`` when using :prop_tgt:`AUTORCC` + +This property holds additional command line options which will be used +when ``rcc`` is executed during the build via :prop_tgt:`AUTORCC`, +i.e. it is equivalent to the optional ``OPTIONS`` argument of the +:module:`qt4_add_resources() ` macro. + +This property is initialized by the value of the +:variable:`CMAKE_AUTORCC_OPTIONS` variable if it is set when a target is +created, or an empty string otherwise. + +The options set on the target may be overridden by :prop_sf:`AUTORCC_OPTIONS` +set on the ``.qrc`` source file. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +EXAMPLE +^^^^^^^ + +.. code-block:: cmake + + # ... + set_property(TARGET tgt PROPERTY AUTORCC_OPTIONS "--compress;9") + # ... diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5010220d4ba569c5a008c914db2a509d8b0dc586 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC.rst.txt @@ -0,0 +1,91 @@ +AUTOUIC +------- + +Should the target be processed with auto-uic (for Qt projects). + +``AUTOUIC`` is a boolean specifying whether CMake will handle +the Qt ``uic`` code generator automatically, i.e. without having to use +commands like :module:`QT4_WRAP_UI() `, `qt5_wrap_ui()`_, etc. +Currently, Qt versions 4 to 6 are supported. + +.. _`qt5_wrap_ui()`: https://doc.qt.io/qt-5/qtwidgets-cmake-qt5-wrap-ui.html + +This property is initialized by the value of the :variable:`CMAKE_AUTOUIC` +variable if it is set when a target is created. + +When this property is ``ON``, CMake will scan the header and source files at +build time and invoke ``uic`` accordingly. + + +Header and source file processing +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +At build time, CMake scans each header and source file from the +target's sources for include statements of the form + +.. code-block:: c++ + + #include "ui_.h" + +Once such an include statement is found in a file, CMake searches for the +``uic`` input file ``.ui`` + +- in the vicinity of the file and +- in the :prop_tgt:`AUTOUIC_SEARCH_PATHS` of the target. + +If the ``.ui`` file was found, ``uic`` is called on it to generate +``ui_.h`` in the directory + +- ``/include`` for single configuration generators or in +- ``/include_`` for + :prop_gbl:`multi configuration ` generators. + +Where ```` is the value of the target property +:prop_tgt:`AUTOGEN_BUILD_DIR`. + +The include directory is automatically added to the target's +:prop_tgt:`INCLUDE_DIRECTORIES`. + + +Modifiers +^^^^^^^^^ + +:prop_tgt:`AUTOUIC_EXECUTABLE`: +The ``uic`` executable will be detected automatically, but can be forced to +a certain binary using this target property. + +:prop_tgt:`AUTOUIC_OPTIONS`: +Additional command line options for ``uic`` can be set via this target +property. The corresponding :prop_sf:`AUTOUIC_OPTIONS` source file property +can be used to specify options to be applied only to a specific +``.ui`` file. + +:prop_sf:`SKIP_AUTOUIC`: +Source files can be excluded from ``AUTOUIC`` processing by setting +this source file property. + +:prop_sf:`SKIP_AUTOGEN`: +Source files can be excluded from :prop_tgt:`AUTOMOC`, +``AUTOUIC`` and :prop_tgt:`AUTORCC` processing by +setting this source file property. + +:prop_gbl:`AUTOGEN_TARGETS_FOLDER`: +This global property can be used to group :prop_tgt:`AUTOMOC`, +``AUTOUIC`` and :prop_tgt:`AUTORCC` targets together in an IDE, +e.g. in MSVS. + +:variable:`CMAKE_GLOBAL_AUTOGEN_TARGET`: +A global ``autogen`` target, that depends on all :prop_tgt:`AUTOMOC` or +``AUTOUIC`` generated :ref:`_autogen` targets in the project, +will be generated when this variable is ``ON``. + +:prop_tgt:`AUTOGEN_PARALLEL`: +This target property controls the number of ``moc`` or ``uic`` processes to +start in parallel during builds. + +:prop_tgt:`AUTOGEN_COMMAND_LINE_LENGTH_MAX`: +This target property controls the limit when to use response files for +``moc`` or ``uic`` processes on Windows. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC_EXECUTABLE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC_EXECUTABLE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..be7929094567958b9e96e00955c242c9a0f31a58 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC_EXECUTABLE.rst.txt @@ -0,0 +1,17 @@ +AUTOUIC_EXECUTABLE +------------------ + +.. versionadded:: 3.14 + +``AUTOUIC_EXECUTABLE`` is file path pointing to the ``uic`` +executable to use for :prop_tgt:`AUTOUIC` enabled files. Setting +this property will make CMake skip the automatic detection of the +``uic`` binary as well as the sanity-tests normally run to ensure +that the binary is available and working as expected. + +Usually this property does not need to be set. Only consider this +property if auto-detection of ``uic`` can not work -- e.g. because +you are building the ``uic`` binary as part of your project. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d601740602983a309d033e070e898a6cfa7c49ad --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC_OPTIONS.rst.txt @@ -0,0 +1,34 @@ +AUTOUIC_OPTIONS +--------------- + +.. versionadded:: 3.0 + +Additional options for ``uic`` when using :prop_tgt:`AUTOUIC` + +This property holds additional command line options which will be used when +``uic`` is executed during the build via :prop_tgt:`AUTOUIC`, i.e. it is +equivalent to the optional ``OPTIONS`` argument of the +:module:`qt4_wrap_ui() ` macro. + +This property is initialized by the value of the +:variable:`CMAKE_AUTOUIC_OPTIONS` variable if it is set when a target is +created, or an empty string otherwise. + +The options set on the target may be overridden by :prop_sf:`AUTOUIC_OPTIONS` +set on the ``.ui`` source file. + +This property may use "generator expressions" with the syntax ``$<...>``. +See the :manual:`cmake-generator-expressions(7)` manual for available +expressions. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +EXAMPLE +^^^^^^^ + +.. code-block:: cmake + + # ... + set_property(TARGET tgt PROPERTY AUTOUIC_OPTIONS "--no-protection") + # ... diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC_SEARCH_PATHS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC_SEARCH_PATHS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..87fea48b299d977c3335a6285936a70e7476cd77 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/AUTOUIC_SEARCH_PATHS.rst.txt @@ -0,0 +1,14 @@ +AUTOUIC_SEARCH_PATHS +-------------------- + +.. versionadded:: 3.9 + +Search path list used by :prop_tgt:`AUTOUIC` to find included +``.ui`` files. + +This property is initialized by the value of the +:variable:`CMAKE_AUTOUIC_SEARCH_PATHS` variable if it is set +when a target is created. Otherwise it is empty. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/BINARY_DIR.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/BINARY_DIR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..beab12c8acfbcb322c4dfbc22d215c2d76648890 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/BINARY_DIR.rst.txt @@ -0,0 +1,8 @@ +BINARY_DIR +---------- + +.. versionadded:: 3.4 + +This read-only property reports the value of the +:variable:`CMAKE_CURRENT_BINARY_DIR` variable in the directory in which +the target was defined. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_RPATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_RPATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..902e2f7af1d6aac301fc0a3947c4f5af211a38a9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_RPATH.rst.txt @@ -0,0 +1,36 @@ +BUILD_RPATH +----------- + +.. versionadded:: 3.8 + +A :ref:`semicolon-separated list ` specifying +runtime path (``RPATH``) entries to add to binaries linked in the +build tree (for platforms that support it). By default, CMake sets +the runtime path of binaries in the build tree to contain search +paths it knows are needed to find the shared libraries they link. +Projects may set ``BUILD_RPATH`` to specify additional search paths. + +The build-tree runtime path will *not* be used for binaries in the +install tree. It will be replaced with the install-tree runtime path +during the installation step. See also the :prop_tgt:`INSTALL_RPATH` +target property. + +This property is initialized by the value of the variable +:variable:`CMAKE_BUILD_RPATH` if it is set when a target is created. + +This property supports +:manual:`generator expressions `. + +Other settings that affect the build-tree runtime path include: + +* The :variable:`CMAKE_SKIP_RPATH` variable completely disables runtime + paths in both the build tree and install tree. + +* The :prop_tgt:`SKIP_BUILD_RPATH` target property disables setting any + runtime path in the build tree. + +* The :prop_tgt:`BUILD_RPATH_USE_ORIGIN` target property causes the + automatically-generated runtime path to use entries relative to ``$ORIGIN``. + +* The :prop_tgt:`BUILD_WITH_INSTALL_RPATH` target property causes binaries + in the build tree to be built with the install-tree runtime path. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2cdfa0d9c156ca41be94965f8d1129489262de39 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst.txt @@ -0,0 +1,26 @@ +BUILD_RPATH_USE_ORIGIN +---------------------- + +.. versionadded:: 3.14 + +Whether to use relative paths for the build ``RPATH``. + +This property is initialized by the value of the variable +:variable:`CMAKE_BUILD_RPATH_USE_ORIGIN`. + +On platforms that support runtime paths (``RPATH``) with the +``$ORIGIN`` token, setting this property to ``TRUE`` enables relative +paths in the build ``RPATH`` for executables and shared libraries that +point to shared libraries in the same build tree. + +Normally the build ``RPATH`` of a binary contains absolute paths +to the directory of each shared library it links to. The ``RPATH`` +entries for directories contained within the build tree can be made +relative to enable relocatable builds and to help achieve reproducible +builds by omitting the build directory from the build environment. + +This property has no effect on platforms that do not support the +``$ORIGIN`` token in ``RPATH``, or when the :variable:`CMAKE_SKIP_RPATH` +variable is set. The runtime path set through the +:prop_tgt:`BUILD_RPATH` target property is also unaffected by this +property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..073dce5cb62003b77e40fb9a3c01101e3c7129f6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst.txt @@ -0,0 +1,15 @@ +BUILD_WITH_INSTALL_NAME_DIR +--------------------------- + +.. versionadded:: 3.9 + +``BUILD_WITH_INSTALL_NAME_DIR`` is a boolean specifying whether the macOS +``install_name`` of a target in the build tree uses the directory given by +:prop_tgt:`INSTALL_NAME_DIR`. This setting only applies to targets on macOS. + +This property is initialized by the value of the variable +:variable:`CMAKE_BUILD_WITH_INSTALL_NAME_DIR` if it is set when a target is +created. + +If this property is not set and policy :policy:`CMP0068` is not ``NEW``, the +value of :prop_tgt:`BUILD_WITH_INSTALL_RPATH` is used in its place. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0244351044a1e8f2112f22be5b94b0bd2b1bdfd4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst.txt @@ -0,0 +1,15 @@ +BUILD_WITH_INSTALL_RPATH +------------------------ + +``BUILD_WITH_INSTALL_RPATH`` is a boolean specifying whether to link the target +in the build tree with the :prop_tgt:`INSTALL_RPATH`. This takes precedence +over :prop_tgt:`SKIP_BUILD_RPATH` and avoids the need for relinking before +installation. + +This property is initialized by the value of the +:variable:`CMAKE_BUILD_WITH_INSTALL_RPATH` variable if it is set when a target +is created. + +If policy :policy:`CMP0068` is not ``NEW``, this property also controls use of +:prop_tgt:`INSTALL_NAME_DIR` in the build tree on macOS. Either way, the +:prop_tgt:`BUILD_WITH_INSTALL_NAME_DIR` target property takes precedence. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/BUNDLE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/BUNDLE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c556ac32cf5d6c8391b7aa682f7f507416800a27 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/BUNDLE.rst.txt @@ -0,0 +1,9 @@ +BUNDLE +------ + +This target is a ``CFBundle`` on the macOS. + +If a module library target has this property set to true it will be +built as a ``CFBundle`` when built on the mac. It will have the directory +structure required for a ``CFBundle`` and will be suitable to be used for +creating Browser Plugins or other application resources. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/BUNDLE_EXTENSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/BUNDLE_EXTENSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..70de11c403c790484c1174d99dd431ef6cd36f39 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/BUNDLE_EXTENSION.rst.txt @@ -0,0 +1,8 @@ +BUNDLE_EXTENSION +---------------- + +The file extension used to name a :prop_tgt:`BUNDLE`, a :prop_tgt:`FRAMEWORK`, +or a :prop_tgt:`MACOSX_BUNDLE` target on the macOS and iOS. + +The default value is ``bundle``, ``framework``, or ``app`` for the respective +target types. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7ce0023c81383d927b7d57c920a9068e1402aec2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst.txt @@ -0,0 +1,41 @@ +COMMON_LANGUAGE_RUNTIME +----------------------- + +.. versionadded:: 3.12 + +By setting this target property, the target is configured to build with +``C++/CLI`` support. + +The Visual Studio generator defines the ``clr`` parameter depending on +the value of the ``COMMON_LANGUAGE_RUNTIME`` target property: + +Not Set (default) + + Native C++. + +``""`` (set but empty) + + Mixed unmanaged/managed C++ using .NET Framework. + +``netcore`` + .. versionadded:: 3.26 + + Mixed unmanaged/managed C++ using .NET Core. + + This required VS 2019's v142 toolset or higher. + +``pure`` + + Managed C++. + +``safe`` + + Managed C++. + +This property is only evaluated :ref:`Visual Studio Generators` for +VS 2010 and above. + +To be able to build managed C++ targets with VS 2017 and above the component +``C++/CLI support`` must be installed, which may not be done by default. + +See also :prop_tgt:`IMPORTED_COMMON_LANGUAGE_RUNTIME` diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6910367e4e8759833db5f57f874445d66d1d9f4f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst.txt @@ -0,0 +1,20 @@ +COMPATIBLE_INTERFACE_BOOL +------------------------- + +Properties which must be compatible with their link interface + +The ``COMPATIBLE_INTERFACE_BOOL`` property may contain a list of +properties for this target which must be consistent when evaluated as a +boolean with the ``INTERFACE`` variant of the property in all linked +dependees. For example, if a property ``FOO`` appears in the list, then +for each dependee, the ``INTERFACE_FOO`` property content in all of its +dependencies must be consistent with each other, and with the ``FOO`` +property in the depender. + +Consistency in this sense has the meaning that if the property is set, +then it must have the same boolean value as all others, and if the +property is not set, then it is ignored. + +Note that for each dependee, the set of properties specified in this +property must not intersect with the set specified in any of the other +:ref:`Compatible Interface Properties`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MAX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MAX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..298acf1ba374c824e276bc40343b5f3ee33e3463 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MAX.rst.txt @@ -0,0 +1,18 @@ +COMPATIBLE_INTERFACE_NUMBER_MAX +------------------------------- + +Properties whose maximum value from the link interface will be used. + +The ``COMPATIBLE_INTERFACE_NUMBER_MAX`` property may contain a list of +properties for this target whose maximum value may be read at generate +time when evaluated in the ``INTERFACE`` variant of the property in all +linked dependees. For example, if a property ``FOO`` appears in the list, +then for each dependee, the ``INTERFACE_FOO`` property content in all of +its dependencies will be compared with each other and with the ``FOO`` +property in the depender. When reading the ``FOO`` property at generate +time, the maximum value will be returned. If the property is not set, +then it is ignored. + +Note that for each dependee, the set of properties specified in this +property must not intersect with the set specified in any of the other +:ref:`Compatible Interface Properties`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MIN.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MIN.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9255d8eb61ac4ae12a2596436550fa7713fb11f0 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MIN.rst.txt @@ -0,0 +1,18 @@ +COMPATIBLE_INTERFACE_NUMBER_MIN +------------------------------- + +Properties whose minimum value from the link interface will be used. + +The ``COMPATIBLE_INTERFACE_NUMBER_MIN`` property may contain a list of +properties for this target whose minimum value may be read at generate +time when evaluated in the ``INTERFACE`` variant of the property of all +linked dependees. For example, if a +property ``FOO`` appears in the list, then for each dependee, the +``INTERFACE_FOO`` property content in all of its dependencies will be +compared with each other and with the ``FOO`` property in the depender. +When reading the ``FOO`` property at generate time, the minimum value +will be returned. If the property is not set, then it is ignored. + +Note that for each dependee, the set of properties specified in this +property must not intersect with the set specified in any of the other +:ref:`Compatible Interface Properties`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a0050b94187b820dd2a5fab2351b48bb53cc177e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst.txt @@ -0,0 +1,16 @@ +COMPATIBLE_INTERFACE_STRING +--------------------------- + +Properties which must be string-compatible with their link interface + +The ``COMPATIBLE_INTERFACE_STRING`` property may contain a list of +properties for this target which must be the same when evaluated as a +string in the ``INTERFACE`` variant of the property all linked dependees. +For example, if a property ``FOO`` appears in the list, then for each +dependee, the ``INTERFACE_FOO`` property content in all of its +dependencies must be equal with each other, and with the ``FOO`` property +in the depender. If the property is not set, then it is ignored. + +Note that for each dependee, the set of properties specified in this +property must not intersect with the set specified in any of the other +:ref:`Compatible Interface Properties`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_DEFINITIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_DEFINITIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c128a9be0fc8e5ae82e30444535d5343213e1862 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_DEFINITIONS.rst.txt @@ -0,0 +1,28 @@ +COMPILE_DEFINITIONS +------------------- + +Preprocessor definitions for compiling a target's sources. + +The ``COMPILE_DEFINITIONS`` property may be set to a semicolon-separated +list of preprocessor definitions using the syntax ``VAR`` or ``VAR=value``. +Function-style definitions are not supported. CMake will +automatically escape the value correctly for the native build system +(note that CMake language syntax may require escapes to specify some +values). + +CMake will automatically drop some definitions that are not supported +by the native build tool. + +.. versionadded:: 3.26 + Any leading ``-D`` on an item will be removed. + +.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt + +Contents of ``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)` manual +for more on defining buildsystem properties. + +The corresponding :prop_tgt:`COMPILE_DEFINITIONS_` property may +be set to specify per-configuration definitions. Generator expressions +should be preferred instead of setting the alternative property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..84bd5e48316b22038895f0313ba8e875d294b83c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst.txt @@ -0,0 +1,16 @@ +COMPILE_DEFINITIONS_ +---------------------------- + +Ignored. See CMake Policy :policy:`CMP0043`. + +Per-configuration preprocessor definitions on a target. + +This is the configuration-specific version of :prop_tgt:`COMPILE_DEFINITIONS` +where ```` is an upper-case name (ex. ``COMPILE_DEFINITIONS_DEBUG``). + +Contents of ``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)` +manual for more on defining buildsystem properties. + +Generator expressions should be preferred instead of setting this property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_FEATURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_FEATURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9b937ed973e54490dd87a988d5018a1ef63cb604 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_FEATURES.rst.txt @@ -0,0 +1,15 @@ +COMPILE_FEATURES +---------------- + +.. versionadded:: 3.1 + +Compiler features enabled for this target. + +The list of features in this property are a subset of the features listed +in the :variable:`CMAKE_C_COMPILE_FEATURES`, :variable:`CMAKE_CUDA_COMPILE_FEATURES`, and +:variable:`CMAKE_CXX_COMPILE_FEATURES` variables. + +Contents of ``COMPILE_FEATURES`` may use "generator expressions" with the +syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. See the :manual:`cmake-compile-features(7)` manual +for information on compile features and a list of supported compilers. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_FLAGS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_FLAGS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5229d467d1ef30740de012e92c6e4c7ae9e2dbfe --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_FLAGS.rst.txt @@ -0,0 +1,14 @@ +COMPILE_FLAGS +------------- + +Additional flags to use when compiling this target's sources. + +The ``COMPILE_FLAGS`` property sets additional compiler flags used to +build sources within the target. Use :prop_tgt:`COMPILE_DEFINITIONS` +to pass additional preprocessor definitions. + +.. note:: + + This property has been superseded by the :prop_tgt:`COMPILE_OPTIONS` property. + Alternatively, you can also use the :command:`target_compile_options` command + instead. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8b032adeeeff18f266077bef816aab0789f955d3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_OPTIONS.rst.txt @@ -0,0 +1,27 @@ +COMPILE_OPTIONS +--------------- + +List of options to pass to the compiler. + +This property holds a :ref:`semicolon-separated list ` +of options specified so far for its target. Use the +:command:`target_compile_options` command to append more options. +The options will be added after flags in the +:variable:`CMAKE__FLAGS` and :variable:`CMAKE__FLAGS_` +variables, but before those propagated from dependencies by the +:prop_tgt:`INTERFACE_COMPILE_OPTIONS` property. + +This property adds compile options for all languages in a target. +Use the :genex:`COMPILE_LANGUAGE` generator expression to specify +per-language compile options. + +This property is initialized by the :prop_dir:`COMPILE_OPTIONS` directory +property when a target is created, and is used by the generators to set +the options for the compiler. + +Contents of ``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)` manual +for more on defining buildsystem properties. + +.. include:: ../command/OPTIONS_SHELL.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b76afeb0896c05f1c3a2a23687212a0c46b9617b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_NAME.rst.txt @@ -0,0 +1,13 @@ +COMPILE_PDB_NAME +---------------- + +.. versionadded:: 3.1 + +Output name for the MS debug symbol ``.pdb`` file generated by the +compiler while building source files. + +This property specifies the base name for the debug symbols file. +If not set, the default is unspecified. + +.. |PDB_XXX| replace:: :prop_tgt:`PDB_NAME` +.. include:: COMPILE_PDB_NOTE.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4c9825db248310d2303bea8ed62419c6785807c9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst.txt @@ -0,0 +1,12 @@ +COMPILE_PDB_NAME_ +------------------------- + +.. versionadded:: 3.1 + +Per-configuration output name for the MS debug symbol ``.pdb`` file +generated by the compiler while building source files. + +This is the configuration-specific version of :prop_tgt:`COMPILE_PDB_NAME`. + +.. |PDB_XXX| replace:: :prop_tgt:`PDB_NAME_` +.. include:: COMPILE_PDB_NOTE.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3f3df660d89ee383b2026055f9f44aeebf32f886 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst.txt @@ -0,0 +1,15 @@ +COMPILE_PDB_OUTPUT_DIRECTORY +---------------------------- + +.. versionadded:: 3.1 + +Output directory for the MS debug symbol ``.pdb`` file +generated by the compiler while building source files. + +This property specifies the directory into which the MS debug symbols +will be placed by the compiler. This property is initialized by the +value of the :variable:`CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY` variable +if it is set when a target is created. + +.. |PDB_XXX| replace:: :prop_tgt:`PDB_OUTPUT_DIRECTORY` +.. include:: COMPILE_PDB_NOTE.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c25c2fc4e5b85a77a2dbff1d5c9fe58e61223345 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst.txt @@ -0,0 +1,18 @@ +COMPILE_PDB_OUTPUT_DIRECTORY_ +------------------------------------- + +.. versionadded:: 3.1 + +Per-configuration output directory for the MS debug symbol ``.pdb`` file +generated by the compiler while building source files. + +This is a per-configuration version of +:prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY`, +but multi-configuration generators (Visual Studio, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the +:variable:`CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_` variable +if it is set when a target is created. + +.. |PDB_XXX| replace:: :prop_tgt:`PDB_OUTPUT_DIRECTORY_` +.. include:: COMPILE_PDB_NOTE.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_WARNING_AS_ERROR.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_WARNING_AS_ERROR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0d2b29596374c67040584954580ff14683201bcb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/COMPILE_WARNING_AS_ERROR.rst.txt @@ -0,0 +1,37 @@ +COMPILE_WARNING_AS_ERROR +------------------------ + +.. versionadded:: 3.24 + +Specify whether to treat warnings on compile as errors. +If enabled, adds a flag to treat warnings on compile as errors. +If the :option:`cmake --compile-no-warning-as-error` option is given +on the :manual:`cmake(1)` command line, this property is ignored. + +This property is not implemented for all compilers. It is silently ignored +if there is no implementation for the compiler being used. The currently +implemented :variable:`compiler IDs _COMPILER_ID>` are: + +* ``GNU`` +* ``Clang`` +* ``AppleClang`` +* ``Fujitsu`` +* ``FujitsuClang`` +* ``IBMClang`` +* ``Intel`` +* ``IntelLLVM`` +* ``LCC`` +* ``MSVC`` +* ``NVHPC`` +* ``NVIDIA`` (CUDA) +* ``QCC`` +* ``SunPro`` +* ``Tasking`` +* ``TI`` +* ``VisualAge`` +* ``XL`` +* ``XLClang`` + +This property is initialized by the value of the variable +:variable:`CMAKE_COMPILE_WARNING_AS_ERROR` if it is set when a target is +created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CONFIG_OUTPUT_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CONFIG_OUTPUT_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a61c70295906ac2c3b16285d9cd6302407e4bcaf --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CONFIG_OUTPUT_NAME.rst.txt @@ -0,0 +1,8 @@ +_OUTPUT_NAME +-------------------- + +Old per-configuration target file base name. +Use :prop_tgt:`OUTPUT_NAME_` instead. + +This is a configuration-specific version of the :prop_tgt:`OUTPUT_NAME` +target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CONFIG_POSTFIX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CONFIG_POSTFIX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..69caa39d55f2e91b489de7e5f92471635ecdd6ed --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CONFIG_POSTFIX.rst.txt @@ -0,0 +1,13 @@ +_POSTFIX +---------------- + +Postfix to append to the target file name for configuration ````. + +When building with configuration ```` the value of this property +is appended to the target file name built on disk. For non-executable +targets, this property is initialized by the value of the +:variable:`CMAKE__POSTFIX` variable if it is set when a target is +created. This property is ignored on macOS for Frameworks and App Bundles. + +For macOS see also the :prop_tgt:`FRAMEWORK_MULTI_CONFIG_POSTFIX_` +target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CROSSCOMPILING_EMULATOR.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CROSSCOMPILING_EMULATOR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d09ff1929e3eb129e81f5b93a51d63def2631ba6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CROSSCOMPILING_EMULATOR.rst.txt @@ -0,0 +1,22 @@ +CROSSCOMPILING_EMULATOR +----------------------- + +.. versionadded:: 3.3 + +Use the given emulator to run executables created when crosscompiling. +This command will be added as a prefix to :command:`add_test`, +:command:`add_custom_command`, and :command:`add_custom_target` commands +for built target system executables. + +.. versionadded:: 3.15 + If this property contains a :ref:`semicolon-separated list `, then the first value is the command and remaining values are its + arguments. + +.. versionadded:: 3.29 + Contents of ``CROSSCOMPILING_EMULATOR`` may use + :manual:`generator expressions `. + +This property is initialized by the value of the +:variable:`CMAKE_CROSSCOMPILING_EMULATOR` variable if it is set when a target +is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_ARCHITECTURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_ARCHITECTURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..05c25999bbdcd6cbb7fa14e25996e85fe50704aa --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_ARCHITECTURES.rst.txt @@ -0,0 +1,61 @@ +CUDA_ARCHITECTURES +------------------ + +.. versionadded:: 3.18 + +List of architectures to generate device code for. + +An architecture can be suffixed by either ``-real`` or ``-virtual`` to specify +the kind of architecture to generate code for. +If no suffix is given then code is generated for both real and virtual +architectures. + +A non-empty false value (e.g. ``OFF``) disables adding architectures. +This is intended to support packagers and rare cases where full control +over the passed flags is required. + +This property is initialized by the value of the :variable:`CMAKE_CUDA_ARCHITECTURES` +variable if it is set when a target is created. + +The ``CUDA_ARCHITECTURES`` target property must be set to a non-empty value on targets +that compile CUDA sources, or it is an error. See policy :policy:`CMP0104`. + +The ``CUDA_ARCHITECTURES`` may be set to one of the following special values: + +``all`` + .. versionadded:: 3.23 + + Compile for all supported major and minor real architectures, + and the highest major virtual architecture. + +``all-major`` + .. versionadded:: 3.23 + + Compile for all supported major real architectures, and the highest + major virtual architecture. + +``native`` + .. versionadded:: 3.24 + + Compile for the architecture(s) of the host's GPU(s). + +Examples +^^^^^^^^ + +.. code-block:: cmake + + set_target_properties(tgt PROPERTIES CUDA_ARCHITECTURES "35;50;72") + +Generates code for real and virtual architectures ``30``, ``50`` and ``72``. + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY CUDA_ARCHITECTURES 70-real 72-virtual) + +Generates code for real architecture ``70`` and virtual architecture ``72``. + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY CUDA_ARCHITECTURES OFF) + +CMake will not pass any architecture flags to the compiler. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_CUBIN_COMPILATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_CUBIN_COMPILATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f8860aeda3df2da13f65b4103de96ab2749ca93a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_CUBIN_COMPILATION.rst.txt @@ -0,0 +1,14 @@ +CUDA_CUBIN_COMPILATION +---------------------- + +.. versionadded:: 3.27 + +Compile CUDA sources to ``.cubin`` files instead of ``.obj`` files +within :ref:`Object Libraries`. + +For example: + +.. code-block:: cmake + + add_library(mycubin OBJECT a.cu b.cu) + set_property(TARGET mycubin PROPERTY CUDA_CUBIN_COMPILATION ON) diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_EXTENSIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_EXTENSIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ab467ac408c1c0332eb01056b54f5a0c8c9f7991 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_EXTENSIONS.rst.txt @@ -0,0 +1,21 @@ +CUDA_EXTENSIONS +--------------- + +.. versionadded:: 3.8 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu++11`` instead of ``-std=c++11`` to the compile line. This +property is ``ON`` by default. The basic CUDA/C++ standard level is +controlled by the :prop_tgt:`CUDA_STANDARD` target property. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CUDA_EXTENSIONS` variable if set when a target is created +and otherwise by the value of +:variable:`CMAKE_CUDA_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` +(see :policy:`CMP0128`). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_FATBIN_COMPILATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_FATBIN_COMPILATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3d3c715339009adce8735380ca8ec8691bc0960c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_FATBIN_COMPILATION.rst.txt @@ -0,0 +1,14 @@ +CUDA_FATBIN_COMPILATION +----------------------- + +.. versionadded:: 3.27 + +Compile CUDA sources to ``.fatbin`` files instead of ``.obj`` files +within :ref:`Object Libraries`. + +For example: + +.. code-block:: cmake + + add_library(myfbins OBJECT a.cu b.cu) + set_property(TARGET myfbins PROPERTY CUDA_FATBIN_COMPILATION ON) diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_OPTIX_COMPILATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_OPTIX_COMPILATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c2a06a88b7158c428e8051a9f70bd9843deaa336 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_OPTIX_COMPILATION.rst.txt @@ -0,0 +1,14 @@ +CUDA_OPTIX_COMPILATION +---------------------- + +.. versionadded:: 3.27 + +Compile CUDA sources to ``.optixir`` files instead of ``.obj`` files +within :ref:`Object Libraries`. + +For example: + +.. code-block:: cmake + + add_library(myoptix OBJECT a.cu b.cu) + set_property(TARGET myoptix PROPERTY CUDA_OPTIX_COMPILATION ON) diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_PTX_COMPILATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_PTX_COMPILATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4e90afee98b4f9edef7c4b7e8920f25a0c7f8065 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_PTX_COMPILATION.rst.txt @@ -0,0 +1,14 @@ +CUDA_PTX_COMPILATION +-------------------- + +.. versionadded:: 3.9 + +Compile CUDA sources to ``.ptx`` files instead of ``.obj`` files +within :ref:`Object Libraries`. + +For example: + +.. code-block:: cmake + + add_library(myptx OBJECT a.cu b.cu) + set_property(TARGET myptx PROPERTY CUDA_PTX_COMPILATION ON) diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_RESOLVE_DEVICE_SYMBOLS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_RESOLVE_DEVICE_SYMBOLS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..58072e1f0aa07d204dcfb620e2bdb955aa72d83a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_RESOLVE_DEVICE_SYMBOLS.rst.txt @@ -0,0 +1,32 @@ +CUDA_RESOLVE_DEVICE_SYMBOLS +--------------------------- + +.. versionadded:: 3.9 + +CUDA only: Enables device linking for the specific library target where +required. + +If set, this will tell the required compilers to enable device linking +on the library target. Device linking is an additional link step +required by some CUDA compilers when :prop_tgt:`CUDA_SEPARABLE_COMPILATION` is +enabled. Normally device linking is deferred until a shared library or +executable is generated, allowing for multiple static libraries to resolve +device symbols at the same time when they are used by a shared library or +executable. + +If this property or :variable:`CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS` is unset, +static libraries are treated as if it is disabled while shared, module, +and executable targets behave as if it is on. + +If :variable:`CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS` has been defined, +this property is initialized to the value the variable and overriding +the default behavior. + +Note that device linking is not supported for :ref:`Object Libraries`. + + +For instance: + +.. code-block:: cmake + + set_property(TARGET mystaticlib PROPERTY CUDA_RESOLVE_DEVICE_SYMBOLS ON) diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_RUNTIME_LIBRARY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_RUNTIME_LIBRARY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e937fc68ac1a6f7714b9c62b5ceeb1473fb2d4b4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_RUNTIME_LIBRARY.rst.txt @@ -0,0 +1,23 @@ +CUDA_RUNTIME_LIBRARY +-------------------- + +.. versionadded:: 3.17 + +Select the CUDA runtime library for use by compilers targeting the CUDA language. + +The allowed case insensitive values are: + +.. include:: CUDA_RUNTIME_LIBRARY-VALUES.txt + +Contents of ``CUDA_RUNTIME_LIBRARY`` may use +:manual:`generator expressions `. + +If that property is not set then CMake uses an appropriate default +value based on the compiler to select the CUDA runtime library. + +.. note:: + + This property has effect only when the ``CUDA`` language is enabled. To + control the CUDA runtime linking when only using the CUDA SDK with the + ``C`` or ``C++`` language we recommend using the :module:`FindCUDAToolkit` + module. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_SEPARABLE_COMPILATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_SEPARABLE_COMPILATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..32222f91ba0273a564f7180ea1cf6ebee96608fb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_SEPARABLE_COMPILATION.rst.txt @@ -0,0 +1,19 @@ +CUDA_SEPARABLE_COMPILATION +-------------------------- + +.. versionadded:: 3.8 + +CUDA only: Enables separate compilation of device code + +If set this will enable separable compilation for all CUDA files for +the given target. + +For instance: + +.. code-block:: cmake + + set_property(TARGET myexe PROPERTY CUDA_SEPARABLE_COMPILATION ON) + +This property is initialized by the value of the +:variable:`CMAKE_CUDA_SEPARABLE_COMPILATION` variable if it is set when a +target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_STANDARD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_STANDARD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ada69b93f88f493d66e7d33acff25d1c7235857a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_STANDARD.rst.txt @@ -0,0 +1,68 @@ +CUDA_STANDARD +------------- + +.. versionadded:: 3.8 + +The CUDA/C++ standard whose features are requested to build this target. + +This property specifies the CUDA/C++ standard whose features are requested +to build this target. For some compilers, this results in adding a +flag such as ``-std=gnu++11`` to the compile line. + +Supported values are: + +``98`` + CUDA C++98. Note that this maps to the same as ``03`` internally. + +``03`` + CUDA C++03 + +``11`` + CUDA C++11 + +``14`` + CUDA C++14. While CMake 3.8 and later *recognize* ``14`` as a valid value, + CMake 3.9 was the first version to include support for any compiler. + +``17`` + CUDA C++17. While CMake 3.8 and later *recognize* ``17`` as a valid value, + CMake 3.18 was the first version to include support for any compiler. + +``20`` + .. versionadded:: 3.12 + + CUDA C++20. While CMake 3.12 and later *recognize* ``20`` as a valid value, + CMake 3.18 was the first version to include support for any compiler. + +``23`` + .. versionadded:: 3.20 + + CUDA C++23 + +``26`` + .. versionadded:: 3.25 + + CUDA C++26. CMake 3.25 and later *recognize* ``26`` as a valid value, + no version has support for any compiler. + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY CUDA_STANDARD 11) + +with a compiler which does not support ``-std=gnu++11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu++03`` flag if supported. This "decay" behavior may be controlled +with the :prop_tgt:`CUDA_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`CUDA_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CUDA_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_STANDARD_REQUIRED.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_STANDARD_REQUIRED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c9301b53d14304c5f6456604887b3683a13d5529 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CUDA_STANDARD_REQUIRED.rst.txt @@ -0,0 +1,20 @@ +CUDA_STANDARD_REQUIRED +---------------------- + +.. versionadded:: 3.8 + +Boolean describing whether the value of :prop_tgt:`CUDA_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`CUDA_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`CUDA_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. For compilers that have no notion of a standard level, such as +MSVC 1800 (Visual Studio 2013) and lower, this has no effect. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CUDA_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CXX_EXTENSIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_EXTENSIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9b52504efc8a229210aeedfede22fabfb4ffd0ae --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_EXTENSIONS.rst.txt @@ -0,0 +1,21 @@ +CXX_EXTENSIONS +-------------- + +.. versionadded:: 3.1 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu++11`` instead of ``-std=c++11`` to the compile line. This +property is ``ON`` by default. The basic C++ standard level is +controlled by the :prop_tgt:`CXX_STANDARD` target property. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CXX_EXTENSIONS` variable if set when a target is created +and otherwise by the value of +:variable:`CMAKE_CXX_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` (see +:policy:`CMP0128`). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_DIRS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_DIRS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6c5dd3a49869bf185085d303d8c7940d65782e50 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_DIRS.rst.txt @@ -0,0 +1,15 @@ +CXX_MODULE_DIRS +--------------- + +.. versionadded:: 3.28 + +Semicolon-separated list of base directories of the target's default +C++ module set (i.e. the file set with name and type ``CXX_MODULES``). The +property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`CXX_MODULE_DIRS_` for the list of base directories in +other C++ module sets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_DIRS_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_DIRS_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8b6e4dd20e3977a663fd754c17c26436fc63fc5c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_DIRS_NAME.rst.txt @@ -0,0 +1,15 @@ +CXX_MODULE_DIRS_ +---------------------- + +.. versionadded:: 3.28 + +Semicolon-separated list of base directories of the target's ```` C++ +module set, which has the set type ``CXX_MODULES``. The property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`CXX_MODULE_DIRS` for the list of base directories in the +default C++ module set. See :prop_tgt:`CXX_MODULE_SETS` for the file set names +of all C++ module sets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_SET.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_SET.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..851de86ebeef7420d5a785e26ff2258140ba0a09 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_SET.rst.txt @@ -0,0 +1,16 @@ +CXX_MODULE_SET +-------------- + +.. versionadded:: 3.28 + +Semicolon-separated list of files in the target's default C++ module set, +(i.e. the file set with name and type ``CXX_MODULES``). If any of the paths +are relative, they are computed relative to the target's source directory. The +property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`CXX_MODULE_SET_` for the list of files in other C++ +module sets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_SETS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_SETS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..216502718642500584a3d90bab715814da5096b6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_SETS.rst.txt @@ -0,0 +1,14 @@ +CXX_MODULE_SETS +--------------- + +.. versionadded:: 3.28 + +Read-only list of the target's ``PRIVATE`` and ``PUBLIC`` C++ module sets (i.e. +all file sets with the type ``CXX_MODULES``). Files listed in these file sets +are treated as source files for the purpose of IDE integration. + +C++ module sets may be defined using the :command:`target_sources` command +``FILE_SET`` option with type ``CXX_MODULES``. + +See also :prop_tgt:`CXX_MODULE_SET_`, :prop_tgt:`CXX_MODULE_SET` and +:prop_tgt:`INTERFACE_CXX_MODULE_SETS`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_SET_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_SET_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e73e28ae98aab7c974fd3879748e6d7ab5808d99 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_SET_NAME.rst.txt @@ -0,0 +1,16 @@ +CXX_MODULE_SET_ +--------------------- + +.. versionadded:: 3.28 + +Semicolon-separated list of files in the target's ```` C++ module set, +which has the set type ``CXX_MODULES``. If any of the paths are relative, they +are computed relative to the target's source directory. The property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`CXX_MODULE_SET` for the list of files in the default C++ module +set. See :prop_tgt:`CXX_MODULE_SETS` for the file set names of all C++ module +sets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_STD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_STD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d42699db3ac8e0ecd77ab7bcb9d22e96220f5017 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_MODULE_STD.rst.txt @@ -0,0 +1,41 @@ +CXX_MODULE_STD +-------------- + +.. versionadded:: 3.30 + +``CXX_MODULE_STD`` is a boolean specifying whether the target may use +``import std;`` its C++ sources or not. + +.. note :: + + This setting is meaningful only when experimental support for ``import + std;`` has been enabled by the ``CMAKE_EXPERIMENTAL_CXX_IMPORT_STD`` gate. + +When this property is explicitly set to ``ON``, CMake will add a dependency to +a target which provides the C++ standard library's modules for the C++ +standard applied to the target. This target is only applicable within the +current build and will not appear in the exported interfaces of the targets. +When consumed, these targets will be reapplied as necessary. + +.. note: + + Similar to the introduction of :prop:`CXX_SCAN_FOR_MODULES`, this property + defaults to _not_ adding ``import std`` support to targets using + ``cxx_std_23`` without an explicit request in order to preserve existing + behavior for projects using C++23 without ``import std``. A future policy + to change the default behavior is expected once the feature sees wider + usage. + +This property's value is not relevant for targets which disable scanning (see +:prop_tgt:`CXX_SCAN_FOR_MODULES`). Additionally, this property only applies to +targets utilizing C++23 (``cxx_std_23``) or newer. + +The property supports +:manual:`generator expressions `, however +expressions that depend upon the configuration, the consuming target, or the +linker language are not allowed. Whether a target uses ``import std`` should +not depend upon such things as it is a static property of the target's source +code. + +Targets which are exported with C++ module sources will have this property's +resolved value exported. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CXX_SCAN_FOR_MODULES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_SCAN_FOR_MODULES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..791914e316b2df4ebe4a37c0087846e0ed172579 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_SCAN_FOR_MODULES.rst.txt @@ -0,0 +1,22 @@ +CXX_SCAN_FOR_MODULES +-------------------- + +.. versionadded:: 3.28 + +``CXX_SCAN_FOR_MODULES`` is a boolean specifying whether CMake will scan C++ +sources in the target for module dependencies. See also the +:prop_sf:`CXX_SCAN_FOR_MODULES` for per-source settings which, if set, +overrides the target-wide settings. + +This property is initialized by the value of the +:variable:`CMAKE_CXX_SCAN_FOR_MODULES` variable if it is set when a target is +created. + +When this property is set ``ON`` or unset, CMake will scan the target's +``CXX`` sources at build time and add module dependency information to the +compile line as necessary. When this property is set ``OFF``, CMake will not +scan the target's ``CXX`` sources at build time. + +Note that scanning is only performed if C++20 or higher is enabled for the +target. Scanning for modules in the target's sources belonging to file sets +of type ``CXX_MODULES`` is always performed. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CXX_STANDARD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_STANDARD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9b381e4217462c2a96be394d6caf52c42a618eab --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_STANDARD.rst.txt @@ -0,0 +1,66 @@ +CXX_STANDARD +------------ + +.. versionadded:: 3.1 + +The C++ standard whose features are requested to build this target. + +This property specifies the C++ standard whose features are requested +to build this target. For some compilers, this results in adding a +flag such as ``-std=gnu++11`` to the compile line. For compilers that +have no notion of a standard level, such as Microsoft Visual C++ before +2015 Update 3, this has no effect. + +Supported values are: + +``98`` + C++98 + +``11`` + C++11 + +``14`` + C++14 + +``17`` + .. versionadded:: 3.8 + + C++17 + +``20`` + .. versionadded:: 3.12 + + C++20 + +``23`` + .. versionadded:: 3.20 + + C++23 + +``26`` + .. versionadded:: 3.25 + + C++26. CMake 3.25 and later *recognize* ``26`` as a valid value, + no version has support for any compiler. + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY CXX_STANDARD 11) + +with a compiler which does not support ``-std=gnu++11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu++98`` flag if supported. This "decay" behavior may be controlled +with the :prop_tgt:`CXX_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`CXX_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CXX_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/CXX_STANDARD_REQUIRED.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_STANDARD_REQUIRED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8b17490ab4a7dd80f8dd7b3d96fdeb76a8ddfdef --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/CXX_STANDARD_REQUIRED.rst.txt @@ -0,0 +1,20 @@ +CXX_STANDARD_REQUIRED +--------------------- + +.. versionadded:: 3.1 + +Boolean describing whether the value of :prop_tgt:`CXX_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`CXX_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`CXX_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. For compilers that have no notion of a standard level, such as +MSVC 1800 (Visual Studio 2013) and lower, this has no effect. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CXX_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/C_EXTENSIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/C_EXTENSIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a53090c57fd1c5fb9e9585f99b06b711f91bf407 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/C_EXTENSIONS.rst.txt @@ -0,0 +1,21 @@ +C_EXTENSIONS +------------ + +.. versionadded:: 3.1 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu11`` instead of ``-std=c11`` to the compile line. This +property is ``ON`` by default. The basic C standard level is +controlled by the :prop_tgt:`C_STANDARD` target property. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_C_EXTENSIONS` variable if set when a target is created and +otherwise by the value of +:variable:`CMAKE_C_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` (see +:policy:`CMP0128`). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/C_STANDARD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/C_STANDARD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ecba2a8f1f1609311608d3b4f3b467b41315238b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/C_STANDARD.rst.txt @@ -0,0 +1,55 @@ +C_STANDARD +---------- + +.. versionadded:: 3.1 + +The C standard whose features are requested to build this target. + +This property specifies the C standard whose features are requested +to build this target. For some compilers, this results in adding a +flag such as ``-std=gnu11`` to the compile line. For compilers that +have no notion of a C standard level, such as Microsoft Visual C++ before +VS 16.7, this property has no effect. + +Supported values are: + +``90`` + C89/C90 + +``99`` + C99 + +``11`` + C11 + +``17`` + .. versionadded:: 3.21 + + C17 + +``23`` + .. versionadded:: 3.21 + + C23 + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY C_STANDARD 11) + +with a compiler which does not support ``-std=gnu11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu99`` or ``-std=gnu90`` flag if supported. This "decay" behavior may +be controlled with the :prop_tgt:`C_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`C_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_C_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/C_STANDARD_REQUIRED.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/C_STANDARD_REQUIRED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8059e3a669dd676add2863f8f637a34197024ea4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/C_STANDARD_REQUIRED.rst.txt @@ -0,0 +1,20 @@ +C_STANDARD_REQUIRED +------------------- + +.. versionadded:: 3.1 + +Boolean describing whether the value of :prop_tgt:`C_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`C_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`C_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. For compilers that have no notion of a C standard level, such +as Microsoft Visual C++ before VS 16.7, this property has no effect. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_C_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/DEBUG_POSTFIX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/DEBUG_POSTFIX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..eca7cb0966e35b93e1b2ca36ec4d4d261cbea915 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/DEBUG_POSTFIX.rst.txt @@ -0,0 +1,7 @@ +DEBUG_POSTFIX +------------- + +See target property :prop_tgt:`_POSTFIX`. + +This property is a special case of the more-general :prop_tgt:`_POSTFIX` +property for the ``DEBUG`` configuration. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/DEFINE_SYMBOL.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/DEFINE_SYMBOL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..775cf898cbdd84abaa79b10a971807bc7bb0b903 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/DEFINE_SYMBOL.rst.txt @@ -0,0 +1,17 @@ +DEFINE_SYMBOL +------------- + +Define a symbol when compiling this target's sources. + +``DEFINE_SYMBOL`` sets the name of the preprocessor symbol defined when +compiling sources in a shared library. If not set here then it is set +to ``target_EXPORTS`` by default (with some substitutions if the target is +not a valid C identifier). This is useful for headers to know whether +they are being included from inside their library or outside to +properly setup dllexport/dllimport decorations on Windows. + +On POSIX platforms, this can optionally be used to control the visibility +of symbols. + +CMake provides support for such decorations with the :module:`GenerateExportHeader` +module. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/DEPLOYMENT_ADDITIONAL_FILES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/DEPLOYMENT_ADDITIONAL_FILES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..afbee831a325a105069598a538af90cd9e6ac49c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/DEPLOYMENT_ADDITIONAL_FILES.rst.txt @@ -0,0 +1,20 @@ +DEPLOYMENT_ADDITIONAL_FILES +--------------------------- + +.. versionadded:: 3.13 + +Set the WinCE project ``AdditionalFiles`` in ``DeploymentTool`` in ``.vcproj`` +files generated by the :ref:`Visual Studio Generators`. +This is useful when you want to debug on remote WinCE device. +Specify additional files that will be copied to the device. +For example: + +.. code-block:: cmake + + set_property(TARGET ${TARGET} PROPERTY + DEPLOYMENT_ADDITIONAL_FILES "english.lng|local_folder|remote_folder|0" + "german.lng|local_folder|remote_folder|0") + +produces:: + + diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3f691b1815242c3d9e26903f5d8aa0e15f408af8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst.txt @@ -0,0 +1,20 @@ +DEPLOYMENT_REMOTE_DIRECTORY +--------------------------- + +.. versionadded:: 3.6 + +Set the WinCE project ``RemoteDirectory`` in ``DeploymentTool`` and +``RemoteExecutable`` in ``DebuggerTool`` in ``.vcproj`` files generated +by the :ref:`Visual Studio Generators`. +This is useful when you want to debug on remote WinCE device. +For example: + +.. code-block:: cmake + + set_property(TARGET ${TARGET} PROPERTY + DEPLOYMENT_REMOTE_DIRECTORY "\\FlashStorage") + +produces:: + + + diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/DEPRECATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/DEPRECATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2945c98817fb250e47880ae7abf10e8054edbae2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/DEPRECATION.rst.txt @@ -0,0 +1,14 @@ +DEPRECATION +----------- + +.. versionadded:: 3.17 + +Deprecation message from imported target's developer. + +``DEPRECATION`` is the message regarding a deprecation status to be displayed +to downstream users of a target. + +The message is formatted as follows: + +* Lines that do not start in whitespace are wrapped as paragraph text. +* Lines that start in whitespace are preserved as preformatted text. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/DISABLE_PRECOMPILE_HEADERS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/DISABLE_PRECOMPILE_HEADERS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7b3826b4ff27f21b0083c1cea5f9d6e9ef685080 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/DISABLE_PRECOMPILE_HEADERS.rst.txt @@ -0,0 +1,10 @@ +DISABLE_PRECOMPILE_HEADERS +-------------------------- + +.. versionadded:: 3.16 + +Disables the precompilation of header files specified by +:prop_tgt:`PRECOMPILE_HEADERS` property. + +If the property is not set, CMake will use the value provided +by :variable:`CMAKE_DISABLE_PRECOMPILE_HEADERS`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/DLL_NAME_WITH_SOVERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/DLL_NAME_WITH_SOVERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c86b218eb0e08bea405ef36f21529a6568f153af --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/DLL_NAME_WITH_SOVERSION.rst.txt @@ -0,0 +1,17 @@ +DLL_NAME_WITH_SOVERSION +----------------------- + +.. versionadded:: 3.27 + +This property controls whether the :prop_tgt:`SOVERSION` target +property is added to the filename of generated DLL filenames +for the Windows platform, which is selected when the +:variable:`WIN32` variable is set. + +The value of the listed property is appended to the +basename of the runtime component of the shared library +target as ``-``. + +Please note that setting this property has no effect +if versioned filenames are globally disabled with the +:variable:`CMAKE_PLATFORM_NO_VERSIONED_SONAME` variable. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/DOTNET_SDK.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/DOTNET_SDK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ca1dcaca9ab6de976f63e80c24c6fb7825a86a42 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/DOTNET_SDK.rst.txt @@ -0,0 +1,25 @@ +DOTNET_SDK +---------- + +.. versionadded:: 3.23 + +Specify the .NET SDK for C# projects. For example: ``Microsoft.NET.Sdk``. + +This property tells :ref:`Visual Studio Generators` for VS 2019 and +above to generate a .NET SDK-style project using the specified SDK. +The property is meaningful only to these generators, and only in C# +targets. It is ignored for C++ projects, even if they are managed +(e.g. using :prop_tgt:`COMMON_LANGUAGE_RUNTIME`). + +This property must be a non-empty string to generate .NET SDK-style projects. +CMake does not perform any validations for the value of the property. + +This property may be initialized for all targets using the +:variable:`CMAKE_DOTNET_SDK` variable. + +.. note:: + + The :ref:`Visual Studio Generators` in this version of CMake have not + yet learned to support :command:`add_custom_command` in .NET SDK-style + projects. It is currently an error to attach a custom command to a + target with the ``DOTNET_SDK`` property set. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/DOTNET_TARGET_FRAMEWORK.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/DOTNET_TARGET_FRAMEWORK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3ba4e25021152452ce025fa161191ff36665e02c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/DOTNET_TARGET_FRAMEWORK.rst.txt @@ -0,0 +1,15 @@ +DOTNET_TARGET_FRAMEWORK +----------------------- + +.. versionadded:: 3.17 + +Specify the .NET target framework. + +Used to specify the .NET target framework for C++/CLI and C#. For +example: ``netcoreapp2.1``. + +This property is only evaluated for :ref:`Visual Studio Generators` +VS 2010 and above. + +Can be initialized for all targets using the variable +:variable:`CMAKE_DOTNET_TARGET_FRAMEWORK`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/DOTNET_TARGET_FRAMEWORK_VERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/DOTNET_TARGET_FRAMEWORK_VERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fbd1aab47134bc21ff5136e5341f604fae940d5c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/DOTNET_TARGET_FRAMEWORK_VERSION.rst.txt @@ -0,0 +1,17 @@ +DOTNET_TARGET_FRAMEWORK_VERSION +------------------------------- + +.. versionadded:: 3.12 + +Specify the .NET target framework version. + +Used to specify the .NET target framework version for C++/CLI and C#. +For example: ``v4.5``. + +This property is only evaluated for :ref:`Visual Studio Generators` +VS 2010 and above. + +To initialize this variable for all targets set +:variable:`CMAKE_DOTNET_TARGET_FRAMEWORK` or +:variable:`CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION`. If both are set, +the latter is ignored. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ENABLE_EXPORTS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ENABLE_EXPORTS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..1902d9480ef2bbe2cd57ef8c20de1b33c8402368 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ENABLE_EXPORTS.rst.txt @@ -0,0 +1,59 @@ +ENABLE_EXPORTS +-------------- + +Specify whether an executable or a shared library exports symbols. + +Normally an executable does not export any symbols because it is the +final program. It is possible for an executable to export symbols to +be used by loadable modules. When this property is set to true CMake +will allow other targets to "link" to the executable with the +:command:`target_link_libraries` command. On all platforms a target-level +dependency on the executable is created for targets that link to it. +Handling of the executable on the link lines of the loadable modules +varies by platform: + +* On Windows-based systems (including Cygwin) an "import library" is + created along with the executable to list the exported symbols. + Loadable modules link to the import library to get the symbols. + +* On macOS, loadable modules link to the executable itself using the + ``-bundle_loader`` flag. + +* On AIX, a linker "import file" is created along with the executable + to list the exported symbols for import when linking other targets. + Loadable modules link to the import file to get the symbols. + +* On other platforms, loadable modules are simply linked without + referencing the executable since the dynamic loader will + automatically bind symbols when the module is loaded. + +This property is initialized by the value of the +:variable:`CMAKE_EXECUTABLE_ENABLE_EXPORTS` variable, if it is set when an +executable target is created. If :variable:`CMAKE_EXECUTABLE_ENABLE_EXPORTS` +is not set, the :variable:`CMAKE_ENABLE_EXPORTS` variable is used to initialize +the property instead for backward compatibility reasons. +See below for alternative initialization behavior for shared library targets. + +.. versionadded:: 3.27 + To link with a shared library on macOS, or to a shared framework on any Apple + platform, a linker import file can be used instead of the actual shared + library. These linker import files are also known as text-based stubs, and + they have a ``.tbd`` file extension. + + The generation of these linker import files, as well as their consumption, is + controlled by this property. When this property is set to true on a shared + library target, CMake will generate a ``.tbd`` file for the library. + Other targets that link to the shared library target will then use this + ``.tbd`` file when linking rather than linking to the shared library binary. + + .. note:: + + For backward compatibility reasons, this property will be ignored if the + :prop_tgt:`XCODE_ATTRIBUTE_GENERATE_TEXT_BASED_STUBS >` + target property or the + :variable:`CMAKE_XCODE_ATTRIBUTE_GENERATE_TEXT_BASED_STUBS >` + variable is set to false. + + For shared library targets, this property is initialized by the value of the + :variable:`CMAKE_SHARED_LIBRARY_ENABLE_EXPORTS` variable, if it is set when + the target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/EXCLUDE_FROM_ALL.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/EXCLUDE_FROM_ALL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f0200f38bc1db86958ad3f6b51b4597fbe31378a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/EXCLUDE_FROM_ALL.rst.txt @@ -0,0 +1,28 @@ +EXCLUDE_FROM_ALL +---------------- + +Set this target property to a true (or false) value to exclude (or include) +the target from the "all" target of the containing directory and its +ancestors. If excluded, running e.g. ``make`` in the containing directory +or its ancestors will not build the target by default. + +If this target property is not set then the target will be included in +the "all" target of the containing directory. Furthermore, it will be +included in the "all" target of its ancestor directories unless the +:prop_dir:`EXCLUDE_FROM_ALL` directory property is set. + +With ``EXCLUDE_FROM_ALL`` set to false or not set at all, the target +will be brought up to date as part of doing a ``make install`` or its +equivalent for the CMake generator being used. + +If a target has ``EXCLUDE_FROM_ALL`` set to true, it may still be listed +in an :command:`install(TARGETS)` command, but the user is responsible for +ensuring that the target's build artifacts are not missing or outdated when +an install is performed. + +This property may use "generator expressions" with the syntax ``$<...>``. See +the :manual:`cmake-generator-expressions(7)` manual for available expressions. + +Only the "Ninja Multi-Config" generator supports a property value that varies by +configuration. For all other generators the value of this property must be the +same for all configurations. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..664704bfa773129455817ef2f932fdcd1b08e6a9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst.txt @@ -0,0 +1,8 @@ +EXCLUDE_FROM_DEFAULT_BUILD +-------------------------- + +Exclude target from ``Build Solution``. + +This property is only used by Visual Studio generators. +When set to ``TRUE``, the target will not be built when you press +``Build Solution``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ad1021aa45acb0342bddd35ecabfd03cc012896c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst.txt @@ -0,0 +1,10 @@ +EXCLUDE_FROM_DEFAULT_BUILD_ +----------------------------------- + +Per-configuration version of target exclusion from ``Build Solution``. + +This is the configuration-specific version of +:prop_tgt:`EXCLUDE_FROM_DEFAULT_BUILD`. If the generic +:prop_tgt:`EXCLUDE_FROM_DEFAULT_BUILD` is also set on a target, +``EXCLUDE_FROM_DEFAULT_BUILD_`` takes +precedence in configurations for which it has a value. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_BUILD_DATABASE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_BUILD_DATABASE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6f68b47d0b10966b88880c6f850ba943fd135a34 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_BUILD_DATABASE.rst.txt @@ -0,0 +1,15 @@ +EXPORT_BUILD_DATABASE +--------------------- + +.. versionadded:: 3.31 + +Enable/Disable output of a build database for a target. + +This property is initialized by the value of the variable +:variable:`CMAKE_EXPORT_BUILD_DATABASE` if it is set when a target is created. + +.. note :: + + This property is meaningful only when experimental support for build + databases has been enabled by the + ``CMAKE_EXPERIMENTAL_EXPORT_BUILD_DATABASE`` gate. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_COMPILE_COMMANDS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_COMPILE_COMMANDS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0b1145c4e8990c34cf61b2d5f68b82b568220024 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_COMPILE_COMMANDS.rst.txt @@ -0,0 +1,9 @@ +EXPORT_COMPILE_COMMANDS +----------------------- + +.. versionadded:: 3.20 + +Enable/Disable output of compile commands during generation for a target. + +This property is initialized by the value of the variable +:variable:`CMAKE_EXPORT_COMPILE_COMMANDS` if it is set when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_FIND_PACKAGE_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_FIND_PACKAGE_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b7405d6b72f636ef74ea10cc1b0613cad989b3d3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_FIND_PACKAGE_NAME.rst.txt @@ -0,0 +1,14 @@ +EXPORT_FIND_PACKAGE_NAME +------------------------ + +.. note:: + + Experimental. Gated by ``CMAKE_EXPERIMENTAL_EXPORT_PACKAGE_DEPENDENCIES``. + +Control the package name associated with a dependency target when exporting a +:command:`find_dependency` call in :command:`install(EXPORT)` or +:command:`export(EXPORT)`. This can be used to assign a package name to a +package that is built by CMake and exported, or to override the package in the +:command:`find_package` call that created the target. + +This property is initialized by :variable:`CMAKE_EXPORT_FIND_PACKAGE_NAME`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0e021d0db53e38af5e98cc3cdfa23e7b35759a26 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_NAME.rst.txt @@ -0,0 +1,8 @@ +EXPORT_NAME +----------- + +Exported name for target files. + +This sets the name for the ``IMPORTED`` target generated by the +:command:`install(EXPORT)` and :command:`export` commands. +If not set, the logical target name is used by default. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_NO_SYSTEM.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_NO_SYSTEM.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f86abd3c648321a1a72fca1415b99a46b210cbdf --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_NO_SYSTEM.rst.txt @@ -0,0 +1,13 @@ +EXPORT_NO_SYSTEM +---------------- + +.. versionadded:: 3.25 + +This property affects the behavior of the :command:`install(EXPORT)` and +:command:`export` commands when they install or export the target respectively. +When ``EXPORT_NO_SYSTEM`` is set to true, those commands generate an imported +target with :prop_tgt:`SYSTEM` property set to false. + +See the :prop_tgt:`NO_SYSTEM_FROM_IMPORTED` target property to set this +behavior on the target *consuming* the include directories rather than the +one *providing* them. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_PROPERTIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_PROPERTIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2d54f8bf84284d1e3be459509bf7538abdc3c1f7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/EXPORT_PROPERTIES.rst.txt @@ -0,0 +1,24 @@ +EXPORT_PROPERTIES +----------------- + +.. versionadded:: 3.12 + +List additional properties to export for a target. + +This property contains a list of property names that should be exported by +the :command:`install(EXPORT)` and :command:`export` commands. By default +only a limited number of properties are exported. This property can be used +to additionally export other properties as well. + +Properties starting with ``INTERFACE_`` or ``IMPORTED_`` are not allowed as +they are reserved for internal CMake use. + +Properties containing generator expressions are also not allowed. + +.. note:: + + Since CMake 3.19, :ref:`Interface Libraries` may have arbitrary + target properties. If a project exports an interface library + with custom properties, the resulting package may not work with + dependents configured by older versions of CMake that reject the + custom properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/EchoString.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/EchoString.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..352d06258953d8ed03480f10be2550c9ec392e9e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/EchoString.rst.txt @@ -0,0 +1,7 @@ +EchoString +---------- + +A message to be displayed when the target is built. + +A message to display on some generators (such as :ref:`Makefile Generators`) +when the target is built. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/FOLDER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/FOLDER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..616b96253d7fe079e0d337bc51f6c0f112f4497d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/FOLDER.rst.txt @@ -0,0 +1,20 @@ +FOLDER +------ + +For IDEs that present targets using a folder hierarchy, this property +specifies the name of the folder to place the target under. +To nest folders, use ``FOLDER`` values such as ``GUI/Dialogs`` with ``/`` +characters separating folder levels. Targets with no ``FOLDER`` property +will appear as top level entities. Targets with the same ``FOLDER`` +property value will appear in the same folder as siblings. + +Only some CMake generators honor the ``FOLDER`` property +(e.g. :generator:`Xcode` or any of the +:ref:`Visual Studio ` generators). +Those generators that don't will simply ignore it. + +This property is initialized by the value of the variable +:variable:`CMAKE_FOLDER` if it is set when a target is created. + +The global property :prop_gbl:`USE_FOLDERS` must be set to true, otherwise +the ``FOLDER`` property is ignored. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/FRAMEWORK.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/FRAMEWORK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3dff1be3c8fa55aa8d741fe8b69b14f3bc7f0548 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/FRAMEWORK.rst.txt @@ -0,0 +1,37 @@ +FRAMEWORK +--------- + +Build ``SHARED`` or ``STATIC`` library as Framework Bundle on the macOS and iOS. + +If such a library target has this property set to ``TRUE`` it will be +built as a framework when built on the macOS and iOS. It will have the +directory structure required for a framework and will be suitable to +be used with the ``-framework`` option. This property is initialized by the +value of the :variable:`CMAKE_FRAMEWORK` variable if it is set when a target is +created. + +To customize ``Info.plist`` file in the framework, use +:prop_tgt:`MACOSX_FRAMEWORK_INFO_PLIST` target property. + +For macOS see also the :prop_tgt:`FRAMEWORK_VERSION` target property. + +Example of creation ``dynamicFramework``: + +.. code-block:: cmake + + add_library(dynamicFramework SHARED + dynamicFramework.c + dynamicFramework.h + ) + set_target_properties(dynamicFramework PROPERTIES + FRAMEWORK TRUE + FRAMEWORK_VERSION C + MACOSX_FRAMEWORK_IDENTIFIER com.cmake.dynamicFramework + MACOSX_FRAMEWORK_INFO_PLIST Info.plist + # "current version" in semantic format in Mach-O binary file + VERSION 16.4.0 + # "compatibility version" in semantic format in Mach-O binary file + SOVERSION 1.0.0 + PUBLIC_HEADER dynamicFramework.h + XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY "iPhone Developer" + ) diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..84d0c1e257edcffcfe30856adcf5d1073aee5de7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst.txt @@ -0,0 +1,28 @@ +FRAMEWORK_MULTI_CONFIG_POSTFIX_ +--------------------------------------- + +.. versionadded:: 3.18 + +Postfix to append to the framework file name for configuration ````, +when using a multi-config generator (like Xcode and Ninja Multi-Config). + +When building with configuration ```` the value of this property +is appended to the framework file name built on disk. + +For example, given a framework called ``my_fw``, a value of ``_debug`` +for the ``FRAMEWORK_MULTI_CONFIG_POSTFIX_DEBUG`` property, and +``Debug;Release`` in :variable:`CMAKE_CONFIGURATION_TYPES`, the following +relevant files would be created for the ``Debug`` and ``Release`` +configurations: + +- ``Release/my_fw.framework/my_fw`` +- ``Release/my_fw.framework/Versions/A/my_fw`` +- ``Debug/my_fw.framework/my_fw_debug`` +- ``Debug/my_fw.framework/Versions/A/my_fw_debug`` + +For framework targets, this property is initialized by the value of the +:variable:`CMAKE_FRAMEWORK_MULTI_CONFIG_POSTFIX_` variable if it +is set when a target is created. + +This property is ignored for non-framework targets, and when using single +config generators. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/FRAMEWORK_VERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/FRAMEWORK_VERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..38b81373e27a6ffe02f368cabe1df379d0b51070 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/FRAMEWORK_VERSION.rst.txt @@ -0,0 +1,10 @@ +FRAMEWORK_VERSION +----------------- + +.. versionadded:: 3.4 + +Version of a framework created using the :prop_tgt:`FRAMEWORK` target +property (e.g. ``A``). + +This property only affects macOS, as iOS doesn't have versioned +directory structure. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_BUILDING_INSTRINSIC_MODULES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_BUILDING_INSTRINSIC_MODULES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3533ef9c8f1b0309c4f7451106fa05d2636a04fc --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_BUILDING_INSTRINSIC_MODULES.rst.txt @@ -0,0 +1,16 @@ +Fortran_BUILDING_INSTRINSIC_MODULES +----------------------------------- + +.. versionadded:: 3.22 + +Instructs the CMake Fortran preprocessor that the target is building +Fortran intrinsics for building a Fortran compiler. + +This property is off by default and should be turned only on projects +that build a Fortran compiler. It should not be turned on for projects +that use a Fortran compiler. + +Turning this property on will correctly add dependencies for building +Fortran intrinsic modules whereas turning the property off will ignore +Fortran intrinsic modules in the dependency graph as they are supplied +by the compiler itself. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_FORMAT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_FORMAT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8704e5f42329d1683c3ca8fc06c76dc70a9bd393 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_FORMAT.rst.txt @@ -0,0 +1,11 @@ +Fortran_FORMAT +-------------- + +Set to ``FIXED`` or ``FREE`` to indicate the Fortran source layout. + +This property tells CMake whether the Fortran source files in a target +use fixed-format or free-format. CMake will pass the corresponding +format flag to the compiler. Use the source-specific ``Fortran_FORMAT`` +property to change the format of a specific source file. If the +variable :variable:`CMAKE_Fortran_FORMAT` is set when a target is created its +value is used to initialize this property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_MODULE_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_MODULE_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..84029e4290678e4cd23ee6653e8040ce5f448271 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_MODULE_DIRECTORY.rst.txt @@ -0,0 +1,25 @@ +Fortran_MODULE_DIRECTORY +------------------------ + +Specify output directory for Fortran modules provided by the target. + +If the target contains Fortran source files that provide modules and +the compiler supports a module output directory this specifies the +directory in which the modules will be placed. When this property is +not set the modules will be placed in the build directory +corresponding to the target's source directory. If the variable +:variable:`CMAKE_Fortran_MODULE_DIRECTORY` is set when a target is created its +value is used to initialize this property. + +When using one of the :ref:`Visual Studio Generators` with the Intel Fortran +plugin installed in Visual Studio, a subdirectory named after the +configuration will be appended to the path where modules are created. +For example, if ``Fortran_MODULE_DIRECTORY`` is set to ``C:/some/path``, +modules will end up in ``C:/some/path/Debug`` (or +``C:/some/path/Release`` etc.) when an Intel Fortran ``.vfproj`` file is +generated, and in ``C:/some/path`` when any other generator is used. + +Note that some compilers will automatically search the module output +directory for modules USEd during compilation but others will not. If +your sources USE modules their location must be specified by +:prop_tgt:`INCLUDE_DIRECTORIES` regardless of this property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_PREPROCESS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_PREPROCESS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e7e2fbaf8506c354c907884425379c0eabe0b527 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/Fortran_PREPROCESS.rst.txt @@ -0,0 +1,25 @@ +Fortran_PREPROCESS +------------------ + +.. versionadded:: 3.18 + +Control whether the Fortran source file should be unconditionally +preprocessed. + +If unset or empty, rely on the compiler to determine whether the file +should be preprocessed. If explicitly set to ``OFF`` then the file does not +need to be preprocessed. If explicitly set to ``ON``, then the file does +need to be preprocessed as part of the compilation step. + +When using the :generator:`Ninja` generator, all source files are +first preprocessed in order to generate module dependency +information. Setting this property to ``OFF`` will make ``Ninja`` +skip this step. + +Use the source-specific :prop_sf:`Fortran_PREPROCESS` property if a single +file needs to be preprocessed. If the variable +:variable:`CMAKE_Fortran_PREPROCESS` is set when a target is created its +value is used to initialize this property. + +.. note:: For some compilers, ``NAG``, ``PGI`` and ``Solaris Studio``, + setting this to ``OFF`` will have no effect. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/GENERATOR_FILE_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/GENERATOR_FILE_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a48610550487d8219c2ce0d6b7783213b93ac9d3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/GENERATOR_FILE_NAME.rst.txt @@ -0,0 +1,9 @@ +GENERATOR_FILE_NAME +------------------- + +Generator's file for this target. + +An internal property used by some generators to record the name of the +project or dsp file associated with this target. Note that at +configure time, this property is only set for targets created by +:command:`include_external_msproject`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/GHS_INTEGRITY_APP.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/GHS_INTEGRITY_APP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..cccd087b824c62c07588c1221fa84484968618c3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/GHS_INTEGRITY_APP.rst.txt @@ -0,0 +1,12 @@ +GHS_INTEGRITY_APP +----------------- + +.. versionadded:: 3.14 + +``ON`` / ``OFF`` boolean to determine if an executable target should +be treated as an `Integrity Application`. + +If no value is set and if a ``.int`` file is added as a source file to the +executable target it will be treated as an `Integrity Application`. + +Supported on :generator:`Green Hills MULTI`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/GHS_NO_SOURCE_GROUP_FILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/GHS_NO_SOURCE_GROUP_FILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fe6b8e68ae7f136223b93e3527b9bcba11225565 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/GHS_NO_SOURCE_GROUP_FILE.rst.txt @@ -0,0 +1,15 @@ +GHS_NO_SOURCE_GROUP_FILE +------------------------ + +.. versionadded:: 3.14 + +``ON`` / ``OFF`` boolean to control if the project file for a target should +be one single file or multiple files. + +The default behavior or when the property is ``OFF`` is to generate a project +file for the target and then a sub-project file for each source group. + +When this property is ``ON`` or if :variable:`CMAKE_GHS_NO_SOURCE_GROUP_FILE` +is ``ON`` then only a single project file is generated for the target. + +Supported on :generator:`Green Hills MULTI`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/GNUtoMS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/GNUtoMS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a09ebbfae35889c44f91701961920621c7d5c7d6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/GNUtoMS.rst.txt @@ -0,0 +1,17 @@ +GNUtoMS +------- + +Convert GNU import library (``.dll.a``) to MS format (``.lib``). + +When linking a shared library or executable that exports symbols using +GNU tools on Windows (MinGW/MSYS) with Visual Studio installed convert +the import library (``.dll.a``) from GNU to MS format (``.lib``). Both import +libraries will be installed by :command:`install(TARGETS)` and exported by +:command:`install(EXPORT)` and :command:`export` to be linked +by applications with either GNU- or MS-compatible tools. + +If the variable ``CMAKE_GNUtoMS`` is set when a target is created its +value is used to initialize this property. The variable must be set +prior to the first command that enables a language such as :command:`project` +or :command:`enable_language`. CMake provides the variable as an option to the +user automatically when configuring on Windows with GNU tools. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/HAS_CXX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/HAS_CXX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..15199b15b1d00f6ead73a254f36a839258b8a01f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/HAS_CXX.rst.txt @@ -0,0 +1,7 @@ +HAS_CXX +------- + +Link the target using the C++ linker tool (obsolete). + +This is equivalent to setting the :prop_tgt:`LINKER_LANGUAGE` +property to ``CXX``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_DIRS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_DIRS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d095345ce0312169fb712eec94c7e331ccbf0d79 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_DIRS.rst.txt @@ -0,0 +1,14 @@ +HEADER_DIRS +----------- + +.. versionadded:: 3.23 + +Semicolon-separated list of base directories of the target's default +header set (i.e. the file set with name and type ``HEADERS``). The property +supports :manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`HEADER_DIRS_` for the list of base directories in +other header sets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_DIRS_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_DIRS_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..dc73df74d88c474dbd39668f566ba5a5ca88e5a9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_DIRS_NAME.rst.txt @@ -0,0 +1,15 @@ +HEADER_DIRS_ +------------------ + +.. versionadded:: 3.23 + +Semicolon-separated list of base directories of the target's ```` +header set, which has the set type ``HEADERS``. The property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`HEADER_DIRS` for the list of base directories in the +default header set. See :prop_tgt:`HEADER_SETS` for the file set names of all +header sets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_SET.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_SET.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a703fc155a3a8e2bf1846cf1b2aff817819648f2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_SET.rst.txt @@ -0,0 +1,15 @@ +HEADER_SET +---------- + +.. versionadded:: 3.23 + +Semicolon-separated list of files in the target's default header set, +(i.e. the file set with name and type ``HEADERS``). If any of the paths +are relative, they are computed relative to the target's source directory. +The property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`HEADER_SET_` for the list of files in other header sets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_SETS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_SETS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ceb1df50620f12544245d237d4c6867f05e30a55 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_SETS.rst.txt @@ -0,0 +1,15 @@ +HEADER_SETS +----------- + +.. versionadded:: 3.23 + +Read-only list of the target's ``PRIVATE`` and ``PUBLIC`` header sets (i.e. +all file sets with the type ``HEADERS``). Files listed in these file sets are +treated as source files for the purpose of IDE integration. The files also +have their :prop_sf:`HEADER_FILE_ONLY` property set to ``TRUE``. + +Header sets may be defined using the :command:`target_sources` command +``FILE_SET`` option with type ``HEADERS``. + +See also :prop_tgt:`HEADER_SET_`, :prop_tgt:`HEADER_SET` and +:prop_tgt:`INTERFACE_HEADER_SETS`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_SET_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_SET_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e537f5a47b7a4951bdb76fb5eb7f3e0466ecdb2f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/HEADER_SET_NAME.rst.txt @@ -0,0 +1,15 @@ +HEADER_SET_ +----------------- + +.. versionadded:: 3.23 + +Semicolon-separated list of files in the target's ```` header set, +which has the set type ``HEADERS``. If any of the paths are relative, +they are computed relative to the target's source directory. The property +supports :manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`HEADER_SET` for the list of files in the default header set. +See :prop_tgt:`HEADER_SETS` for the file set names of all header sets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/HIP_ARCHITECTURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/HIP_ARCHITECTURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..58a813d52f1987bcb5ee9ab9335e2e3fc8eb5217 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/HIP_ARCHITECTURES.rst.txt @@ -0,0 +1,28 @@ +HIP_ARCHITECTURES +----------------- + +.. versionadded:: 3.21 + +List of GPU architectures to for which to generate device code. +Architecture names are interpreted based on :variable:`CMAKE_HIP_PLATFORM`. + +A non-empty false value (e.g. ``OFF``) disables adding architectures. +This is intended to support packagers and rare cases where full control +over the passed flags is required. + +This property is initialized by the value of the :variable:`CMAKE_HIP_ARCHITECTURES` +variable if it is set when a target is created. + +The HIP compilation model has two modes: whole and separable. Whole compilation +generates device code at compile time. Separable compilation generates device +code at link time. Therefore the ``HIP_ARCHITECTURES`` target property should +be set on targets that compile or link with any HIP sources. + +Examples +^^^^^^^^ + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY HIP_ARCHITECTURES gfx801 gfx900) + +Generates code for both ``gfx801`` and ``gfx900``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/HIP_EXTENSIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/HIP_EXTENSIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d1475c96420110b3dc09865a31c2b226499aea08 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/HIP_EXTENSIONS.rst.txt @@ -0,0 +1,21 @@ +HIP_EXTENSIONS +-------------- + +.. versionadded:: 3.21 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu++11`` instead of ``-std=c++11`` to the compile line. This +property is ``ON`` by default. The basic HIP/C++ standard level is +controlled by the :prop_tgt:`HIP_STANDARD` target property. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_HIP_EXTENSIONS` variable if set when a target is created +and otherwise by the value of +:variable:`CMAKE_HIP_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` (see +:policy:`CMP0128`). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/HIP_STANDARD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/HIP_STANDARD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9de873038126d427eabfa3b1229aaf8ad826ec5e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/HIP_STANDARD.rst.txt @@ -0,0 +1,54 @@ +HIP_STANDARD +------------ + +.. versionadded:: 3.21 + +The HIP/C++ standard requested to build this target. + +Supported values are: + +``98`` + HIP C++98 + +``11`` + HIP C++11 + +``14`` + HIP C++14 + +``17`` + HIP C++17 + +``20`` + HIP C++20 + +``23`` + HIP C++23 + +``26`` + .. versionadded:: 3.25 + + HIP C++26. CMake 3.25 and later *recognize* ``26`` as a valid value, + no version has support for any compiler. + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY HIP_STANDARD 11) + +with a compiler which does not support ``-std=gnu++11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu++98`` flag if supported. This "decay" behavior may be controlled +with the :prop_tgt:`HIP_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`HIP_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_HIP_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/HIP_STANDARD_REQUIRED.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/HIP_STANDARD_REQUIRED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e56209a3cbce4020a257992a4a1f0ef587d291e1 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/HIP_STANDARD_REQUIRED.rst.txt @@ -0,0 +1,19 @@ +HIP_STANDARD_REQUIRED +--------------------- + +.. versionadded:: 3.21 + +Boolean describing whether the value of :prop_tgt:`HIP_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`HIP_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`HIP_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_HIP_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f7e366a772060e4a12ad8a198015ee670634cc9d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst.txt @@ -0,0 +1,32 @@ +IMPLICIT_DEPENDS_INCLUDE_TRANSFORM +---------------------------------- + +Specify ``#include`` line transforms for dependencies in a target. + +This property specifies rules to transform macro-like ``#include`` lines +during implicit dependency scanning of C and C++ source files. The +list of rules must be semicolon-separated with each entry of the form +``A_MACRO(%)=value-with-%`` (the ``%`` must be literal). During dependency +scanning occurrences of ``A_MACRO(...)`` on ``#include`` lines will be +replaced by the value given with the macro argument substituted for +``%``. For example, the entry + +:: + + MYDIR(%)= + +will convert lines of the form + +:: + + #include MYDIR(myheader.h) + +to + +:: + + #include + +allowing the dependency to be followed. + +This property applies to sources in the target on which it is set. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..22d28aaf756b24c727ce076b4f1c020c51fdec72 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED.rst.txt @@ -0,0 +1,8 @@ +IMPORTED +-------- + +Read-only indication of whether a target is ``IMPORTED``. + +The boolean value of this property is ``True`` for targets created with +the ``IMPORTED`` option to :command:`add_executable` or :command:`add_library`. +It is ``False`` for targets built within the project. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_COMMON_LANGUAGE_RUNTIME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_COMMON_LANGUAGE_RUNTIME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8c20e07e2b4d8b31608e02b6c9668c27f01710e9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_COMMON_LANGUAGE_RUNTIME.rst.txt @@ -0,0 +1,10 @@ +IMPORTED_COMMON_LANGUAGE_RUNTIME +-------------------------------- + +.. versionadded:: 3.12 + +Property to define if the target uses ``C++/CLI``. + +Ignored for non-imported targets. + +See also the :prop_tgt:`COMMON_LANGUAGE_RUNTIME` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CONFIGURATIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CONFIGURATIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a4746d3d163a140f8b4255942920e0f884b2d210 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CONFIGURATIONS.rst.txt @@ -0,0 +1,22 @@ +IMPORTED_CONFIGURATIONS +----------------------- + +Configurations provided for an :ref:`imported target `. + +Set this to the list of configuration names available for an imported +target. For each configuration named, the imported target's artifacts +must be specified in other target properties: + +* :prop_tgt:`IMPORTED_LOCATION_`, or +* :prop_tgt:`IMPORTED_IMPLIB_` (on DLL platforms, on AIX for + :ref:`Executables ` or on Apple for + :ref:`Shared Libraries `), or +* :prop_tgt:`IMPORTED_OBJECTS_` (for :ref:`Object Libraries`), or +* :prop_tgt:`IMPORTED_LIBNAME_` (for :ref:`Interface Libraries`). + +The configuration names correspond to those defined in the project from +which the target is imported. If the importing project uses a different +set of configurations, the names may be mapped using the +:prop_tgt:`MAP_IMPORTED_CONFIG_` target property. + +The ``IMPORTED_CONFIGURATIONS`` property is ignored for non-imported targets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_DEFINITIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_DEFINITIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b0681914d418632745279fe1c9183de5e42c2d5b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_DEFINITIONS.rst.txt @@ -0,0 +1,10 @@ +IMPORTED_CXX_MODULES_COMPILE_DEFINITIONS +---------------------------------------- + +.. versionadded:: 3.28 + +Preprocessor definitions for compiling an ``IMPORTED`` target's C++ module +sources. + +CMake will automatically drop some definitions that are not supported +by the native build tool. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_FEATURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_FEATURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..cea359f5b09342e3b7f86e40dfcad0d708cf19a8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_FEATURES.rst.txt @@ -0,0 +1,9 @@ +IMPORTED_CXX_MODULES_COMPILE_FEATURES +------------------------------------- + +.. versionadded:: 3.28 + +Compiler features enabled for this ``IMPORTED`` target's C++ modules. + +The value of this property is used by the generators to set the include +paths for the compiler. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..cf7bc5b238cd6dcb1308b8d9e760507cfd85d379 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_OPTIONS.rst.txt @@ -0,0 +1,9 @@ +IMPORTED_CXX_MODULES_COMPILE_OPTIONS +------------------------------------ + +.. versionadded:: 3.28 + +List of options to pass to the compiler for this ``IMPORTED`` target's C++ +modules. + +.. include:: ../command/OPTIONS_SHELL.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_INCLUDE_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_INCLUDE_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..46d74ea27fc212518245e33712fd89623b30d669 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_INCLUDE_DIRECTORIES.rst.txt @@ -0,0 +1,10 @@ +IMPORTED_CXX_MODULES_INCLUDE_DIRECTORIES +---------------------------------------- + +.. versionadded:: 3.28 + +List of preprocessor include file search directories when compiling C++ +modules for ``IMPORTED`` targets. + +The value of this property is used by the generators to set the include +paths for the compiler. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_LINK_LIBRARIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_LINK_LIBRARIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ff5cec87364e990ee6d9bdb9472829c42d036953 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_CXX_MODULES_LINK_LIBRARIES.rst.txt @@ -0,0 +1,7 @@ +IMPORTED_CXX_MODULES_LINK_LIBRARIES +----------------------------------- + +.. versionadded:: 3.28 + +List of direct dependencies to use for usage requirements for C++ modules in +the target's C++ modules. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_GLOBAL.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_GLOBAL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..176127f43c23dcd9eb40e859dfe63cd4dbf52739 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_GLOBAL.rst.txt @@ -0,0 +1,32 @@ +IMPORTED_GLOBAL +--------------- + +.. versionadded:: 3.11 + +Indication of whether an :ref:`IMPORTED target ` is +globally visible. + +The boolean value of this property is True for targets created with the +``IMPORTED`` ``GLOBAL`` options to :command:`add_executable()` or +:command:`add_library()`. It is always False for targets built within the +project. + +For targets created with the ``IMPORTED`` option to +:command:`add_executable()` or :command:`add_library()` but without the +additional option ``GLOBAL`` this is False, too. However, setting this +property for such a locally ``IMPORTED`` target to True promotes that +target to global scope. This promotion can only be done in the same +directory where that ``IMPORTED`` target was created in the first place. + +.. note:: + + Once an imported target has been made global, it cannot be changed back to + non-global. Therefore, if a project sets this property, it may only + provide a value of True. CMake will issue an error if the project tries to + set the property to a non-True value, even if the value was already False. + +.. note:: + + Local :ref:`ALIAS targets ` created before promoting an + :ref:`IMPORTED target ` from ``LOCAL`` to ``GLOBAL``, keep + their initial scope (see :prop_tgt:`ALIAS_GLOBAL` target property). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_IMPLIB.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_IMPLIB.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..135c31c30e1e71b1bc46542c68be7bb7a552e57b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_IMPLIB.rst.txt @@ -0,0 +1,39 @@ +IMPORTED_IMPLIB +--------------- + +Full path to the import library for an ``IMPORTED`` target. + +This property may be set: + +* On DLL platforms, to the location of the ``.lib`` part of the DLL. +* .. versionadded:: 3.16 + On AIX, to an import file (e.g. ``.imp``) created for executables that + export symbols (see the :prop_tgt:`ENABLE_EXPORTS` target property). +* .. versionadded:: 3.27 + On Apple platforms, to an import file (e.g. ``.tbd``) created for shared + libraries or frameworks (see the :prop_tgt:`ENABLE_EXPORTS` target + property). For frameworks, this is the location of the ``.tbd`` file + symlink just inside the framework folder. +* .. versionadded:: 3.28 + On non-DLL platforms, to the location of a shared library. + When set without also specifying an :prop_tgt:`IMPORTED_LOCATION`, + the library is considered to be a stub, and its location will not + be added as a runtime search path to dependents that link it. + +.. versionchanged:: 3.28 + If an imported target is an Apple framework or XCFramework, the preferred + arrangement is to set :prop_tgt:`IMPORTED_LOCATION` to the ``.framework`` + or ``.xcframework`` directory. CMake will then find the relevant ``.tbd`` + file inside that framework or XCFramework automatically without requiring + ``IMPORTED_IMPLIB`` to be set. + +The ``IMPORTED_IMPLIB`` target property may be overridden for a +given configuration ```` by the configuration-specific +:prop_tgt:`IMPORTED_IMPLIB_` target property. Furthermore, +the :prop_tgt:`MAP_IMPORTED_CONFIG_` target property may be +used to map between a project's configurations and those of an imported +target. If none of these is set then the name of any other configuration +listed in the :prop_tgt:`IMPORTED_CONFIGURATIONS` target property may be +selected and its :prop_tgt:`IMPORTED_IMPLIB_` value used. + +This property is ignored for non-imported targets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5debabc954e532c3d0ddc1dc431a3c1ffa69806f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst.txt @@ -0,0 +1,7 @@ +IMPORTED_IMPLIB_ +------------------------ + +-specific version of :prop_tgt:`IMPORTED_IMPLIB` property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LIBNAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LIBNAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7a83906e1c01fa1b7681affba1450734acbda128 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LIBNAME.rst.txt @@ -0,0 +1,25 @@ +IMPORTED_LIBNAME +---------------- + +.. versionadded:: 3.8 + +Specify the link library name for an :ref:`imported ` +:ref:`Interface Library `. + +An interface library builds no library file itself but does specify +usage requirements for its consumers. The ``IMPORTED_LIBNAME`` +property may be set to specify a single library name to be placed +on the link line in place of the interface library target name as +a requirement for using the interface. + +This property is intended for use in naming libraries provided by +a platform SDK for which the full path to a library file may not +be known. The value may be a plain library name such as ``foo`` +but may *not* be a path (e.g. ``/usr/lib/libfoo.so``) or a flag +(e.g. ``-Wl,...``). The name is never treated as a library target +name even if it happens to name one. + +The ``IMPORTED_LIBNAME`` property is allowed only on +:ref:`imported ` :ref:`Interface Libraries` +and is rejected on targets of other types (for which +the :prop_tgt:`IMPORTED_LOCATION` target property may be used). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LIBNAME_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LIBNAME_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..df64769fec37b2960d11c3440af1d39544461f71 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LIBNAME_CONFIG.rst.txt @@ -0,0 +1,9 @@ +IMPORTED_LIBNAME_ +------------------------- + +.. versionadded:: 3.8 + +-specific version of :prop_tgt:`IMPORTED_LIBNAME` property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f7e21658107bea89d0792de40325f95681a0fdeb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst.txt @@ -0,0 +1,14 @@ +IMPORTED_LINK_DEPENDENT_LIBRARIES +--------------------------------- + +Dependent shared libraries of an imported shared library. + +Shared libraries may be linked to other shared libraries as part of +their implementation. On some platforms the linker searches for the +dependent libraries of shared libraries they are including in the +link. Set this property to the list of dependent shared libraries of +an imported library. The list should be disjoint from the list of +interface libraries in the :prop_tgt:`INTERFACE_LINK_LIBRARIES` property. On +platforms requiring dependent shared libraries to be found at link +time CMake uses this list to add appropriate files or paths to the +link command line. Ignored for non-imported targets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5b9c51308e0a5e218c9a044835ee94b96b86beb7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst.txt @@ -0,0 +1,8 @@ +IMPORTED_LINK_DEPENDENT_LIBRARIES_ +------------------------------------------ + +-specific version of :prop_tgt:`IMPORTED_LINK_DEPENDENT_LIBRARIES`. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4ed4281f3897e04cdac17080f62650ad3bbf9c19 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst.txt @@ -0,0 +1,14 @@ +IMPORTED_LINK_INTERFACE_LANGUAGES +--------------------------------- + +Languages compiled into an ``IMPORTED`` static library. + +Set this to the list of languages of source files compiled to produce +a ``STATIC IMPORTED`` library (such as ``C`` or ``CXX``). CMake accounts for +these languages when computing how to link a target to the imported +library. For example, when a C executable links to an imported C++ +static library CMake chooses the C++ linker to satisfy language +runtime dependencies of the static library. + +This property is ignored for targets that are not ``STATIC`` libraries. +This property is ignored for non-imported targets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..40fcf7fcf353c259abfb60b8f5a1af98d9622755 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst.txt @@ -0,0 +1,8 @@ +IMPORTED_LINK_INTERFACE_LANGUAGES_ +------------------------------------------ + +-specific version of :prop_tgt:`IMPORTED_LINK_INTERFACE_LANGUAGES`. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..527cf2ebead01b4ae8999a6c87fdaaf62c40131f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst.txt @@ -0,0 +1,16 @@ +IMPORTED_LINK_INTERFACE_LIBRARIES +--------------------------------- + +Transitive link interface of an ``IMPORTED`` target. + +Set this to the list of libraries whose interface is included when an +``IMPORTED`` library target is linked to another target. The libraries +will be included on the link line for the target. Unlike the +:prop_tgt:`LINK_INTERFACE_LIBRARIES` property, this property applies to all +imported target types, including ``STATIC`` libraries. This property is +ignored for non-imported targets. + +This property is ignored if the target also has a non-empty +:prop_tgt:`INTERFACE_LINK_LIBRARIES` property. + +This property is deprecated. Use :prop_tgt:`INTERFACE_LINK_LIBRARIES` instead. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..050fb1dff0a751e4f81deb61446bee33352faa17 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst.txt @@ -0,0 +1,13 @@ +IMPORTED_LINK_INTERFACE_LIBRARIES_ +------------------------------------------ + +-specific version of :prop_tgt:`IMPORTED_LINK_INTERFACE_LIBRARIES`. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. + +This property is ignored if the target also has a non-empty +:prop_tgt:`INTERFACE_LINK_LIBRARIES` property. + +This property is deprecated. Use :prop_tgt:`INTERFACE_LINK_LIBRARIES` instead. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7a92d96b647198c0900496f27988411fa5ef146e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst.txt @@ -0,0 +1,6 @@ +IMPORTED_LINK_INTERFACE_MULTIPLICITY +------------------------------------ + +Repetition count for cycles of ``IMPORTED`` static libraries. + +This is :prop_tgt:`LINK_INTERFACE_MULTIPLICITY` for ``IMPORTED`` targets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..758237bf1da49130fb081a490b92fd7f74331d84 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst.txt @@ -0,0 +1,7 @@ +IMPORTED_LINK_INTERFACE_MULTIPLICITY_ +--------------------------------------------- + +-specific version of :prop_tgt:`IMPORTED_LINK_INTERFACE_MULTIPLICITY`. + +If set, this property completely overrides the generic property for +the named configuration. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LOCATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LOCATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b162253b0129ab72ee00fde3eb9822b2c1a8e6b7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LOCATION.rst.txt @@ -0,0 +1,38 @@ +IMPORTED_LOCATION +----------------- + +Full path to the main file on disk for an ``IMPORTED`` target. + +Set this to the location of an ``IMPORTED`` target file on disk. For +executables this is the location of the executable file. For ``STATIC`` +libraries and modules this is the location of the library or module. +For ``SHARED`` libraries on non-DLL platforms this is the location of the +shared library. For application bundles on macOS this is the location of +the executable file inside ``Contents/MacOS`` within the bundle folder. +For frameworks on macOS this is the location of the +library file symlink just inside the framework folder. For DLLs this +is the location of the ``.dll`` part of the library. For ``UNKNOWN`` +libraries this is the location of the file to be linked. Ignored for +non-imported targets. + +.. versionadded:: 3.28 + + For ordinary frameworks on Apple platforms, this may be the location of the + ``.framework`` folder itself. For XCFrameworks, it may be the location of + the ``.xcframework`` folder, in which case any target that links against it + will get the selected library's ``Headers`` directory as a usage requirement. + +The ``IMPORTED_LOCATION`` target property may be overridden for a +given configuration ```` by the configuration-specific +:prop_tgt:`IMPORTED_LOCATION_` target property. Furthermore, +the :prop_tgt:`MAP_IMPORTED_CONFIG_` target property may be +used to map between a project's configurations and those of an imported +target. If none of these is set then the name of any other configuration +listed in the :prop_tgt:`IMPORTED_CONFIGURATIONS` target property may be +selected and its :prop_tgt:`IMPORTED_LOCATION_` value used. + +To get the location of an imported target read one of the :prop_tgt:`LOCATION` +or :prop_tgt:`LOCATION_` properties. + +For platforms with import libraries (e.g. Windows, AIX or Apple) see also +:prop_tgt:`IMPORTED_IMPLIB`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LOCATION_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LOCATION_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c5f5f048ce61a6c13b1e7762aad86f47d8a23107 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_LOCATION_CONFIG.rst.txt @@ -0,0 +1,7 @@ +IMPORTED_LOCATION_ +-------------------------- + +-specific version of :prop_tgt:`IMPORTED_LOCATION` property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_NO_SONAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_NO_SONAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..cbb764226399975f87331b2496257b9f06f40865 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_NO_SONAME.rst.txt @@ -0,0 +1,9 @@ +IMPORTED_NO_SONAME +------------------ + +Specifies that an ``IMPORTED`` shared library target has no ``soname``. + +Set this property to true for an imported shared library file that has +no ``soname`` field. CMake may adjust generated link commands for some +platforms to prevent the linker from using the path to the library in +place of its missing ``soname``. Ignored for non-imported targets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..76fe471f40dfe692541798fed8631b21e6472888 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst.txt @@ -0,0 +1,7 @@ +IMPORTED_NO_SONAME_ +--------------------------- + +-specific version of :prop_tgt:`IMPORTED_NO_SONAME` property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_NO_SYSTEM.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_NO_SYSTEM.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e1fea37d8cf0e8d0d4b5b376f50800eed904588f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_NO_SYSTEM.rst.txt @@ -0,0 +1,37 @@ +IMPORTED_NO_SYSTEM +------------------ + +.. versionadded:: 3.23 + +.. deprecated:: 3.25 + + ``IMPORTED_NO_SYSTEM`` is deprecated. Please use the following alternatives + instead: + + * Set :prop_tgt:`SYSTEM` to false if you don't want a target's include + directories to be treated as system directories when compiling consumers. + * Set :prop_tgt:`EXPORT_NO_SYSTEM` to true if you don't want the include + directories of the imported target generated by :command:`install(EXPORT)` + and :command:`export` commands to be treated as system directories when + compiling consumers. + +Setting ``IMPORTED_NO_SYSTEM`` to true on an +:ref:`imported target ` specifies that it is not a +system target. This has the following effects: + +* Entries of :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` are not treated + as system include directories when compiling consumers (regardless of + the value of the consumed target's :prop_tgt:`SYSTEM` property), as they + would be by default. Entries of + :prop_tgt:`INTERFACE_SYSTEM_INCLUDE_DIRECTORIES` are not affected, + and will always be treated as system include directories. +* On Apple platforms, when the target is a framework, it will not be treated as + system. + +This property can also be enabled on a non-imported target. Doing so does +not affect the build system, but does tell the :command:`install(EXPORT)` and +:command:`export` commands to enable it on the imported targets they generate. + +See the :prop_tgt:`NO_SYSTEM_FROM_IMPORTED` target property to set this +behavior on the target *consuming* the include directories rather than +the one *providing* them. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_OBJECTS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_OBJECTS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9aacea7454be3fda6f9a3b72c84b7ccbd151ce2c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_OBJECTS.rst.txt @@ -0,0 +1,91 @@ +IMPORTED_OBJECTS +---------------- + +.. versionadded:: 3.9 + +A :ref:`semicolon-separated list ` of absolute paths +to the object files on disk for an :ref:`imported ` +:ref:`object library `. + +Ignored for non-imported targets. + +Projects may skip ``IMPORTED_OBJECTS`` if the configuration-specific +property :prop_tgt:`IMPORTED_OBJECTS_` is set instead, except in +situations as noted in the section below. + + +Xcode Generator Considerations +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 3.20 + +For Apple platforms, a project may be built for more than one architecture. +This is controlled by the :variable:`CMAKE_OSX_ARCHITECTURES` variable. +For all but the :generator:`Xcode` generator, CMake invokes compilers once +per source file and passes multiple ``-arch`` flags, leading to a single +object file which will be a universal binary. Such object files work well +when listed in the ``IMPORTED_OBJECTS`` of a separate CMake build, even for +the :generator:`Xcode` generator. But producing such object files with the +:generator:`Xcode` generator is more difficult, since it invokes the compiler +once per architecture for each source file. Unlike the other generators, +it does not generate universal object file binaries. + +A further complication with the :generator:`Xcode` generator is that when +targeting device platforms (iOS, tvOS, visionOS or watchOS), the :generator:`Xcode` +generator has the ability to use either the device or simulator SDK without +needing CMake to be re-run. The SDK can be selected at build time. +But since some architectures can be supported by both the device and the +simulator SDKs (e.g. ``arm64`` with Xcode 12 or later), not all combinations +can be represented in a single universal binary. The only solution in this +case is to have multiple object files. + +``IMPORTED_OBJECTS`` doesn't support generator expressions, so every file +it lists needs to be valid for every architecture and SDK. If incorporating +object files that are not universal binaries, the path and/or file name of +each object file has to somehow encapsulate the different architectures and +SDKs. With the :generator:`Xcode` generator, Xcode variables of the form +``$(...)`` can be used to represent these aspects and Xcode will substitute +the appropriate values at build time. CMake doesn't interpret these +variables and embeds them unchanged in the Xcode project file. +``$(CURRENT_ARCH)`` can be used to represent the architecture, while +``$(EFFECTIVE_PLATFORM_NAME)`` can be used to differentiate between SDKs. + +The following shows one example of how these two variables can be used to +refer to an object file whose location depends on both the SDK and the +architecture: + +.. code-block:: cmake + + add_library(someObjs OBJECT IMPORTED) + + set_property(TARGET someObjs PROPERTY IMPORTED_OBJECTS + # Quotes are required because of the () + "/path/to/somewhere/objects$(EFFECTIVE_PLATFORM_NAME)/$(CURRENT_ARCH)/func.o" + ) + + # Example paths: + # /path/to/somewhere/objects-iphoneos/arm64/func.o + # /path/to/somewhere/objects-iphonesimulator/x86_64/func.o + +In some cases, you may want to have configuration-specific object files +as well. The ``$(CONFIGURATION)`` Xcode variable is often used for this and +can be used in conjunction with the others mentioned above: + +.. code-block:: cmake + + add_library(someObjs OBJECT IMPORTED) + set_property(TARGET someObjs PROPERTY IMPORTED_OBJECTS + "/path/to/somewhere/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)/$(CURRENT_ARCH)/func.o" + ) + + # Example paths: + # /path/to/somewhere/Release-iphoneos/arm64/func.o + # /path/to/somewhere/Debug-iphonesimulator/x86_64/func.o + +When any Xcode variable is used, CMake is not able to fully evaluate the +path(s) at configure time. One consequence of this is that the +configuration-specific :prop_tgt:`IMPORTED_OBJECTS_` properties cannot +be used, since CMake cannot determine whether an object file exists at a +particular ```` location. The ``IMPORTED_OBJECTS`` property must be +used for these situations and the configuration-specific aspects of the path +should be handled by the ``$(CONFIGURATION)`` Xcode variable. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_OBJECTS_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_OBJECTS_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..238395a23c617d8d229e2c06a339e5a354e783c4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_OBJECTS_CONFIG.rst.txt @@ -0,0 +1,20 @@ +IMPORTED_OBJECTS_ +------------------------- + +.. versionadded:: 3.9 + +````-specific version of :prop_tgt:`IMPORTED_OBJECTS` property. + +Configuration names correspond to those provided by the project from +which the target is imported. + + +Xcode Generator Considerations +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Do not use this ````-specific property if you need to use Xcode +variables like ``$(CURRENT_ARCH)`` or ``$(EFFECTIVE_PLATFORM_NAME)`` in +the value. The ````-specific properties will be ignored in such +cases because CMake cannot determine whether a file exists at the +configuration-specific path at configuration time. For such cases, use +:prop_tgt:`IMPORTED_OBJECTS` instead. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_SONAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_SONAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..bf0c3cbc15a8a51fb8b15ffa6e407cba78562ec7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_SONAME.rst.txt @@ -0,0 +1,8 @@ +IMPORTED_SONAME +--------------- + +The ``soname`` of an ``IMPORTED`` target of shared library type. + +Set this to the ``soname`` embedded in an imported shared library. This +is meaningful only on platforms supporting the feature. Ignored for +non-imported targets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_SONAME_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_SONAME_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..59a9d1a45494a18f7b5213f74be75d75fdd2810b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORTED_SONAME_CONFIG.rst.txt @@ -0,0 +1,7 @@ +IMPORTED_SONAME_ +------------------------ + +-specific version of :prop_tgt:`IMPORTED_SONAME` property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORT_PREFIX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORT_PREFIX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..17e381be47f155946b1102ed0e4e709bd99466b6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORT_PREFIX.rst.txt @@ -0,0 +1,9 @@ +IMPORT_PREFIX +------------- + +What comes before the import library name. + +Similar to the target property :prop_tgt:`PREFIX`, but used for import libraries +(typically corresponding to a ``DLL``) instead of regular libraries. A +target property that can be set to override the prefix (such as ``lib``) +on an import library name. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IMPORT_SUFFIX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORT_SUFFIX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9307115b431e63e0b65165d35550d5696256b851 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IMPORT_SUFFIX.rst.txt @@ -0,0 +1,9 @@ +IMPORT_SUFFIX +------------- + +What comes after the import library name. + +Similar to the target property :prop_tgt:`SUFFIX`, but used +for import libraries (typically corresponding to a ``DLL``) instead of +regular libraries. A target property that can be set to override +the suffix (such as ``.lib``) on an import library name. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INCLUDE_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INCLUDE_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b381d1dbdf5a16cd25983dbffd9e461e81728cf7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INCLUDE_DIRECTORIES.rst.txt @@ -0,0 +1,24 @@ +INCLUDE_DIRECTORIES +------------------- + +List of preprocessor include file search directories. + +This property specifies the list of directories given so far to the +:command:`target_include_directories` command. In addition to accepting +values from that command, values may be set directly on any +target using the :command:`set_property` command. A target gets its +initial value for this property from the value of the +:prop_dir:`INCLUDE_DIRECTORIES` directory property. Both directory and +target property values are adjusted by calls to the +:command:`include_directories` command. + +The value of this property is used by the generators to set the include +paths for the compiler. + +Relative paths should not be added to this property directly. Use one of +the commands above instead to handle relative paths. + +Contents of ``INCLUDE_DIRECTORIES`` may use :manual:`cmake-generator-expressions(7)` 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. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_NAME_DIR.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_NAME_DIR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..84310b9a93746f4fb86e9d45463ca63982cc5613 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_NAME_DIR.rst.txt @@ -0,0 +1,23 @@ +INSTALL_NAME_DIR +---------------- + +Directory name for installed targets on Apple platforms. + +``INSTALL_NAME_DIR`` is a string specifying the directory portion of the +"install_name" field of shared libraries on Apple platforms for +installed targets. When not set, the default directory used is determined +by :prop_tgt:`MACOSX_RPATH`. If the :prop_tgt:`BUILD_WITH_INSTALL_NAME_DIR` +property is set, this will be used already in the build tree. +Policies :policy:`CMP0068` and :policy:`CMP0042` are also relevant. + +This property is initialized by the value of the variable +:variable:`CMAKE_INSTALL_NAME_DIR` if it is set when a target is +created. + +This property supports :manual:`generator expressions `. +In particular, the :genex:`$` generator expression can be +used to set the directory relative to the install-time prefix. + +On platforms that support runtime paths (``RPATH``), refer to the +:prop_tgt:`INSTALL_RPATH` target property. +Under Windows, the :genex:`TARGET_RUNTIME_DLLS` generator expression is related. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f41e41c66ae91ee829930bdcba968875fb36925b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst.txt @@ -0,0 +1,18 @@ +INSTALL_REMOVE_ENVIRONMENT_RPATH +-------------------------------- + +.. versionadded:: 3.16 + +Controls whether toolchain-defined rpaths should be removed during installation. + +When a target is being installed, CMake may need to rewrite its rpath +information. This occurs when the install rpath (as specified by the +:prop_tgt:`INSTALL_RPATH` target property) has different contents to the rpath +that the target was built with. Some toolchains insert their own rpath +contents into the binary as part of the build. By default, CMake will +preserve those extra inserted contents in the install rpath. For those +scenarios where such toolchain-inserted entries need to be discarded during +install, set the ``INSTALL_REMOVE_ENVIRONMENT_RPATH`` target property to true. + +This property is initialized by the value of +:variable:`CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH` when the target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_RPATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_RPATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e5110b89379b5447f357a5c2591331babf1cd805 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_RPATH.rst.txt @@ -0,0 +1,36 @@ +INSTALL_RPATH +------------- + +The rpath to use for installed targets. + +By default, the install rpath is empty. It can be set using this property, +which is a semicolon-separated list specifying the rpath to use in installed +targets (for platforms that support it). This property is initialized +by the value of the variable :variable:`CMAKE_INSTALL_RPATH` if it is set +when a target is created. +Beside setting the install rpath manually, using the +:prop_tgt:`INSTALL_RPATH_USE_LINK_PATH` target property it can also be +generated automatically by CMake. + +Normally CMake uses the build tree for the RPATH when building executables +etc on systems that use RPATH, see the :prop_tgt:`BUILD_RPATH` target +property. When the software is installed +the targets are edited (or relinked) by CMake (see +:variable:`CMAKE_NO_BUILTIN_CHRPATH`) to have the install RPATH. +This editing during installation can be avoided via +the :prop_tgt:`BUILD_WITH_INSTALL_RPATH` target property. + +For handling toolchain-dependent RPATH entries the +:prop_tgt:`INSTALL_REMOVE_ENVIRONMENT_RPATH` can be used. +Runtime paths can be disabled completely via the :variable:`CMAKE_SKIP_RPATH` +variable. + +Because the rpath may contain ``${ORIGIN}``, which coincides with CMake syntax, +the contents of ``INSTALL_RPATH`` are properly escaped in the +``cmake_install.cmake`` script (see policy :policy:`CMP0095`.) + +This property supports +:manual:`generator expressions `. + +On Apple platforms, refer to the :prop_tgt:`INSTALL_NAME_DIR` target property. +Under Windows, the :genex:`TARGET_RUNTIME_DLLS` generator expression is related. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ef859cf2d2e46f2fa89abd6204f66fd62fe0b150 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst.txt @@ -0,0 +1,14 @@ +INSTALL_RPATH_USE_LINK_PATH +--------------------------- + +Add paths to linker search and installed rpath. + +``INSTALL_RPATH_USE_LINK_PATH`` is a boolean that if set to ``TRUE`` +will append to the runtime search path (rpath) of installed binaries +any directories outside the project that are in the linker search path or +contain linked library files. The directories are appended after the +value of the :prop_tgt:`INSTALL_RPATH` target property. + +This property is initialized by the value of the variable +:variable:`CMAKE_INSTALL_RPATH_USE_LINK_PATH` if it is set when a target is +created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_AUTOMOC_MACRO_NAMES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_AUTOMOC_MACRO_NAMES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..502775c8e3b4816168b71fc9c800a41c4f8cd241 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_AUTOMOC_MACRO_NAMES.rst.txt @@ -0,0 +1,89 @@ +INTERFACE_AUTOMOC_MACRO_NAMES +----------------------------- + +.. versionadded:: 3.27 + +A :ref:`semicolon-separated list ` of macro names for +:prop_tgt:`AUTOMOC` to be propagated to consumers. + +When a target with :prop_tgt:`AUTOMOC` enabled links to a library that sets +``INTERFACE_AUTOMOC_MACRO_NAMES``, the target inherits the listed macro names +and merges them with those specified in its own :prop_tgt:`AUTOMOC_MACRO_NAMES` +property. The target will then automatically generate MOC files for source +files that contain the inherited macro names too, not just the macro names +specified in its own :prop_tgt:`AUTOMOC_MACRO_NAMES` property. + +By default ``INTERFACE_AUTOMOC_MACRO_NAMES`` is empty. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +Example 1 +^^^^^^^^^ + +In this example, ``myapp`` inherits the macro names ``STATIC_LIB_1`` and +``STATIC_LIB_2`` from ``static_lib``. The ``moc`` tool will then automatically +be run on any of the ``myapp`` sources which contain ``STATIC_LIB_1`` or +``STATIC_LIB_2``. + +.. code-block:: cmake + + set(AUTOMOC ON) + add_executable(myapp main.cpp) + target_link_libraries(myapp PRIVATE static_lib) + + add_library(static_lib STATIC static.cpp) + set_property(TARGET static_lib PROPERTY + INTERFACE_AUTOMOC_MACRO_NAMES "STATIC_LIB_1;STATIC_LIB_2" + ) + +Example 2 +^^^^^^^^^ + +In this example, the ``INTERFACE_AUTOMOC_MACRO_NAMES`` target property of the +various ``*_deep_lib`` libraries will propagate to ``shared_lib``, +``static_lib`` and ``interface_lib``. Because the linking relationships are +specified as ``PUBLIC`` and ``INTERFACE``, those macro names will also further +propagate transitively up to ``app``. + +.. code-block:: cmake + + set(AUTOMOC ON) + + add_library(shared_deep_lib SHARED deep_lib.cpp) + add_library(static_deep_lib STATIC deep_lib.cpp) + add_library(interface_deep_lib INTERFACE) + + set_property(TARGET shared_deep_lib PROPERTY + INTERFACE_AUTOMOC_MACRO_NAMES "SHARED_LINK_LIB" + ) + set_property(TARGET static_deep_lib PROPERTY + INTERFACE_AUTOMOC_MACRO_NAMES "STATIC_LINK_LIB" + ) + set_property(TARGET interface_deep_lib PROPERTY + INTERFACE_AUTOMOC_MACRO_NAMES "INTERFACE_LINK_LIB" + ) + + add_library(shared_lib SHARED lib.cpp) + add_library(static_lib STATIC lib.cpp) + add_library(interface_lib INTERFACE) + + # PUBLIC and INTERFACE here ensure the macro names propagate to any + # consumers of shared_lib, static_lib or interface_lib too + target_link_libraries(shared_lib PUBLIC shared_deep_lib) + target_link_libraries(static_lib PUBLIC static_deep_lib) + target_link_libraries(interface_lib INTERFACE interface_deep_lib) + + # This consumer will receive all three of the above custom macro names as + # transitive usage requirements + add_executable(app main.cpp) + target_link_libraries(app PRIVATE shared_lib static_lib interface_lib) + +In the above: + +* ``shared_lib`` sources will be processed by ``moc`` if they contain + ``SHARED_LINK_LIB``. +* ``static_lib`` sources will be processed by ``moc`` if they contain + ``STATIC_LINK_LIB``. +* ``app`` sources will be processed by ``moc`` if they contain + ``SHARED_LINK_LIB``, ``STATIC_LINK_LIB`` or ``INTERFACE_LINK_LIB``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_AUTOUIC_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_AUTOUIC_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2fe011aa03bf5631ca349133a689ec87ccf15aab --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_AUTOUIC_OPTIONS.rst.txt @@ -0,0 +1,16 @@ +INTERFACE_AUTOUIC_OPTIONS +------------------------- + +.. versionadded:: 3.0 + +List of interface options to pass to uic. + +Targets may populate this property to publish the options +required to use when invoking ``uic``. Consuming targets can add entries to their +own :prop_tgt:`AUTOUIC_OPTIONS` property such as +``$`` to use the uic options +specified in the interface of ``foo``. This is done automatically by +the :command:`target_link_libraries` command. + +This property supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9cc12a1e90c81533131139cb5adad069a0d2e200 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst.txt @@ -0,0 +1,8 @@ +INTERFACE_COMPILE_DEFINITIONS +----------------------------- + +.. |property_name| replace:: compile definitions +.. |command_name| replace:: :command:`target_compile_definitions` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_COMPILE_DEFINITIONS`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`COMPILE_DEFINITIONS` +.. include:: INTERFACE_BUILD_PROPERTY.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_COMPILE_FEATURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_COMPILE_FEATURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..50d6161a3acb4544a8d72b8fffedbc44a99b7ea6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_COMPILE_FEATURES.rst.txt @@ -0,0 +1,13 @@ +INTERFACE_COMPILE_FEATURES +-------------------------- + +.. versionadded:: 3.1 + +.. |property_name| replace:: compile features +.. |command_name| replace:: :command:`target_compile_features` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_COMPILE_FEATURES`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`COMPILE_FEATURES` +.. include:: INTERFACE_BUILD_PROPERTY.txt + +See the :manual:`cmake-compile-features(7)` manual for information on compile +features and a list of supported compilers. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2af7a9911ce2f353adaf7554b298b6462950875c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst.txt @@ -0,0 +1,8 @@ +INTERFACE_COMPILE_OPTIONS +------------------------- + +.. |property_name| replace:: compile options +.. |command_name| replace:: :command:`target_compile_options` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_COMPILE_OPTIONS`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`COMPILE_OPTIONS` +.. include:: INTERFACE_BUILD_PROPERTY.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_CXX_MODULE_SETS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_CXX_MODULE_SETS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fd6e34bb043f4eb790702c44ab67bc3cda902965 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_CXX_MODULE_SETS.rst.txt @@ -0,0 +1,14 @@ +INTERFACE_CXX_MODULE_SETS +------------------------- + +.. versionadded:: 3.28 + +Read-only list of the target's ``PUBLIC`` C++ module sets (i.e. all file sets +with the type ``CXX_MODULES``). Files listed in these C++ module sets can be +installed with :command:`install(TARGETS)` and exported with +:command:`install(EXPORT)` and :command:`export`. + +C++ module sets may be defined using the :command:`target_sources` command +``FILE_SET`` option with type ``CXX_MODULES``. + +See also :prop_tgt:`CXX_MODULE_SETS`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_HEADER_SETS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_HEADER_SETS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2d3bdacfcf08836f77ff52afb546ecd97236346d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_HEADER_SETS.rst.txt @@ -0,0 +1,14 @@ +INTERFACE_HEADER_SETS +--------------------- + +.. versionadded:: 3.23 + +Read-only list of the target's ``INTERFACE`` and ``PUBLIC`` header sets (i.e. +all file sets with the type ``HEADERS``). Files listed in these header sets +can be installed with :command:`install(TARGETS)` and exported with +:command:`install(EXPORT)` and :command:`export`. + +Header sets may be defined using the :command:`target_sources` command +``FILE_SET`` option with type ``HEADERS``. + +See also :prop_tgt:`HEADER_SETS`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_HEADER_SETS_TO_VERIFY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_HEADER_SETS_TO_VERIFY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b0d63f3cd66d6488e83116528c466eccc87a455e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_HEADER_SETS_TO_VERIFY.rst.txt @@ -0,0 +1,13 @@ +INTERFACE_HEADER_SETS_TO_VERIFY +------------------------------- + +.. versionadded:: 3.24 + +Used to specify which ``PUBLIC`` and ``INTERFACE`` header sets of a target +should be verified. + +This property contains a semicolon-separated list of header sets which +should be verified if :prop_tgt:`VERIFY_INTERFACE_HEADER_SETS` is set to +``TRUE``. If the list is empty, all ``PUBLIC`` and ``INTERFACE`` header sets +are verified. (If the project does not want to verify any header sets on the +target, simply set :prop_tgt:`VERIFY_INTERFACE_HEADER_SETS` to ``FALSE``.) diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8795c80ab6cc41e88e678242b21dd7a6b0a9d37c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst.txt @@ -0,0 +1,28 @@ +INTERFACE_INCLUDE_DIRECTORIES +----------------------------- + +.. |property_name| replace:: include directories +.. |command_name| replace:: :command:`target_include_directories` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_INCLUDE_DIRECTORIES`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`INCLUDE_DIRECTORIES` +.. include:: INTERFACE_BUILD_PROPERTY.txt + +Include directories usage requirements commonly differ between the build-tree +and the install-tree. The ``BUILD_INTERFACE`` and ``INSTALL_INTERFACE`` +generator expressions can be used to describe separate usage requirements +based on the usage location. Relative paths are allowed within the +``INSTALL_INTERFACE`` expression and are interpreted relative to the +installation prefix. For example: + +.. code-block:: cmake + + target_include_directories(mylib INTERFACE + $ + $ # /include/mylib + ) + +Creating Relocatable Packages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. |INTERFACE_PROPERTY_LINK| replace:: ``INTERFACE_INCLUDE_DIRECTORIES`` +.. include:: /include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_DEPENDS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_DEPENDS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9c8275d5f2497fde53a7f0c05cfd2078b47b7881 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_DEPENDS.rst.txt @@ -0,0 +1,34 @@ +INTERFACE_LINK_DEPENDS +---------------------- + +.. versionadded:: 3.13 + +Additional public interface files on which a target binary depends for linking. + +This property is supported only by :generator:`Ninja` and +:ref:`Makefile Generators`. +It is intended to specify dependencies on "linker scripts" for +custom Makefile link rules. + +When target dependencies are specified using :command:`target_link_libraries`, +CMake will read this property from all target dependencies to determine the +build properties of the consumer. + +Contents of ``INTERFACE_LINK_DEPENDS`` 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. + +Link dependency files usage requirements commonly differ between the build-tree +and the install-tree. The ``BUILD_INTERFACE`` and ``INSTALL_INTERFACE`` +generator expressions can be used to describe separate usage requirements +based on the usage location. Relative paths are allowed within the +``INSTALL_INTERFACE`` expression and are interpreted relative to the +installation prefix. For example: + +.. code-block:: cmake + + set_property(TARGET mylib PROPERTY INTERFACE_LINK_DEPENDS + $ + $ # /mylinkscript + ) diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..45b3225cff3aebba312560cabe935125b2eef948 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst.txt @@ -0,0 +1,10 @@ +INTERFACE_LINK_DIRECTORIES +-------------------------- + +.. versionadded:: 3.13 + +.. |property_name| replace:: link directories +.. |command_name| replace:: :command:`target_link_directories` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_LINK_DIRECTORIES`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`LINK_DIRECTORIES` +.. include:: INTERFACE_BUILD_PROPERTY.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_LIBRARIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_LIBRARIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..53f5838f7ab031e75de361692c4f42bb90056630 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_LIBRARIES.rst.txt @@ -0,0 +1,39 @@ +INTERFACE_LINK_LIBRARIES +------------------------ + +List public interface libraries for a library. + +This property contains the list of transitive link dependencies. When +the target is linked into another target using the +:command:`target_link_libraries` command, the libraries listed (and +recursively their link interface libraries) will be provided to the +other target also. This property is overridden by the +:prop_tgt:`LINK_INTERFACE_LIBRARIES` or +:prop_tgt:`LINK_INTERFACE_LIBRARIES_` property if policy +:policy:`CMP0022` is ``OLD`` or unset. + +The value of this property is used by the generators when constructing +the link rule for a dependent target. A dependent target's direct +link dependencies, specified by its :prop_tgt:`LINK_LIBRARIES` target +property, are linked first, followed by indirect dependencies from the +transitive closure of the direct dependencies' +``INTERFACE_LINK_LIBRARIES`` properties. See policy :policy:`CMP0022`. + +Contents of ``INTERFACE_LINK_LIBRARIES`` 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. + +.. include:: LINK_LIBRARIES_INDIRECTION.txt + +``INTERFACE_LINK_LIBRARIES`` adds transitive link dependencies for a +target's dependents. In advanced use cases, one may update the +direct link dependencies of a target's dependents by using the +:prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` and +:prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` target properties. + +Creating Relocatable Packages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. |INTERFACE_PROPERTY_LINK| replace:: ``INTERFACE_LINK_LIBRARIES`` +.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6243bb1481f5a96d490d362bb13380df4028c7bf --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.rst.txt @@ -0,0 +1,236 @@ +INTERFACE_LINK_LIBRARIES_DIRECT +------------------------------- + +.. versionadded:: 3.24 + +List of libraries that consumers of this library should treat +as direct link dependencies. + +This target property may be set to *include* items in a dependent +target's final set of direct link dependencies. See the +:prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` target property +to exclude items. + +The initial set of a dependent target's direct link dependencies is +specified by its :prop_tgt:`LINK_LIBRARIES` target property. Indirect +link dependencies are specified by the transitive closure of the direct +link dependencies' :prop_tgt:`INTERFACE_LINK_LIBRARIES` properties. +Any link dependency may specify additional direct link dependencies +using the ``INTERFACE_LINK_LIBRARIES_DIRECT`` target property. +The set of direct link dependencies is then filtered to exclude items named +by any dependency's :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` +target property. + +.. |INTERFACE_PROPERTY_LINK_DIRECT| replace:: ``INTERFACE_LINK_LIBRARIES_DIRECT`` +.. include:: INTERFACE_LINK_LIBRARIES_DIRECT.txt + +Direct Link Dependencies as Usage Requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The ``INTERFACE_LINK_LIBRARIES_DIRECT`` and +``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` target properties +are :ref:`usage requirements `. +Their effects propagate to dependent targets transitively, and can +therefore affect the direct link dependencies of every target in a +chain of dependent libraries. Whenever some library target ``X`` links +to another library target ``Y`` whose direct or transitive usage +requirements contain ``INTERFACE_LINK_LIBRARIES_DIRECT`` or +``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE``, the properties may affect +``X``'s list of direct link dependencies: + +* If ``X`` is a shared library or executable, its dependencies are linked. + They also affect the usage requirements with which ``X``'s sources are + compiled. + +* If ``X`` is a static library or object library, it does not actually + link, so its dependencies at most affect the usage requirements with + which ``X``'s sources are compiled. + +The properties may also affect the list of direct link dependencies +on ``X``'s dependents: + +* If ``X`` links ``Y`` publicly: + + .. code-block:: cmake + + target_link_libraries(X PUBLIC Y) + + then ``Y`` is placed in ``X``'s :prop_tgt:`INTERFACE_LINK_LIBRARIES`, + so ``Y``'s usage requirements, including ``INTERFACE_LINK_LIBRARIES_DIRECT``, + ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE``, and the usage requirements + declared by the direct link dependencies they add, are propagated to + ``X``'s dependents. + +* If ``X`` is a static library or object library, and links ``Y`` privately: + + .. code-block:: cmake + + target_link_libraries(X PRIVATE Y) + + then ``$`` is placed in ``X``'s + :prop_tgt:`INTERFACE_LINK_LIBRARIES`. ``Y``'s linking requirements, + including ``INTERFACE_LINK_LIBRARIES_DIRECT``, + ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE``, and the transitive link + dependencies declared by the direct link dependencies they add, are + propagated to ``X``'s dependents. However, ``Y``'s non-linking + usage requirements are blocked by the :genex:`LINK_ONLY` generator + expression, and are not propagated to ``X``'s dependents. + +* If ``X`` is a shared library or executable, and links ``Y`` privately: + + .. code-block:: cmake + + target_link_libraries(X PRIVATE Y) + + then ``Y`` is not placed in ``X``'s :prop_tgt:`INTERFACE_LINK_LIBRARIES`, + so ``Y``'s usage requirements, even ``INTERFACE_LINK_LIBRARIES_DIRECT`` + and ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE``, are not propagated to + ``X``'s dependents. + +* In all cases, the content of ``X``'s :prop_tgt:`INTERFACE_LINK_LIBRARIES` + is not affected by ``Y``'s ``INTERFACE_LINK_LIBRARIES_DIRECT`` or + ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE``. + +One may limit the effects of ``INTERFACE_LINK_LIBRARIES_DIRECT`` and +``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` to a subset of dependent +targets by using the :genex:`TARGET_PROPERTY` generator expression. +For example, to limit the effects to executable targets, use an +entry of the form:: + + "$<$,EXECUTABLE>:...>" + +Similarly, to limit the effects to specific targets, use an entry +of the form:: + + "$<$>:...>" + +This entry will only affect targets that set their ``USE_IT`` +target property to a true value. + +Direct Link Dependency Ordering +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The list of direct link dependencies for a target is computed from an +initial ordered list in its :prop_tgt:`LINK_LIBRARIES` target property. +For each item, additional direct link dependencies are discovered from +its direct and transitive ``INTERFACE_LINK_LIBRARIES_DIRECT`` usage +requirements. Each discovered item is injected before the item that +specified it. However, a discovered item is added at most once, +and only if it did not appear anywhere in the initial list. +This gives :prop_tgt:`LINK_LIBRARIES` control over ordering of +those direct link dependencies that it explicitly specifies. + +Once all direct link dependencies have been collected, items named by +all of their :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` +usage requirements are removed from the final list. This does not +affect the order of the items that remain. + +Example: Static Plugins +^^^^^^^^^^^^^^^^^^^^^^^ + +Consider a static library ``Foo`` that provides a static plugin +``FooPlugin`` to consuming application executables, where the +implementation of the plugin depends on ``Foo`` and other things. +In this case, the application should link to ``FooPlugin`` directly, +before ``Foo``. However, the application author only knows about ``Foo``. +We can express this as follows: + +.. code-block:: cmake + + # Core library used by other components. + add_library(Core STATIC core.cpp) + + # Foo is a static library for use by applications. + # Implementation of Foo depends on Core. + add_library(Foo STATIC foo.cpp foo_plugin_helper.cpp) + target_link_libraries(Foo PRIVATE Core) + + # Extra parts of Foo for use by its static plugins. + # Implementation of Foo's extra parts depends on both Core and Foo. + add_library(FooExtras STATIC foo_extras.cpp) + target_link_libraries(FooExtras PRIVATE Core Foo) + + # The Foo library has an associated static plugin + # that should be linked into the final executable. + # Implementation of the plugin depends on Core, Foo, and FooExtras. + add_library(FooPlugin STATIC foo_plugin.cpp) + target_link_libraries(FooPlugin PRIVATE Core Foo FooExtras) + + # An app that links Foo should link Foo's plugin directly. + set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT FooPlugin) + + # An app does not need to link Foo directly because the plugin links it. + set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE Foo) + +An application ``app`` only needs to specify that it links to ``Foo``: + +.. code-block:: cmake + + add_executable(app main.cpp) + target_link_libraries(app PRIVATE Foo) + +The ``INTERFACE_LINK_LIBRARIES_DIRECT`` target property on ``Foo`` tells +CMake to pretend that ``app`` also links directly to ``FooPlugin``. +The ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` target property on ``Foo`` +tells CMake to pretend that ``app`` did *not* link directly to ``Foo``. +Instead, ``Foo`` will be linked as a dependency of ``FooPlugin``. The +final link line for ``app`` will link the libraries in the following +order: + +* ``FooPlugin`` as a direct link dependency of ``app`` + (via ``Foo``'s usage requirements). +* ``FooExtras`` as a dependency of ``FooPlugin``. +* ``Foo`` as a dependency of ``FooPlugin`` and ``FooExtras``. +* ``Core`` as a dependency of ``FooPlugin``, ``FooExtras``, and ``Foo``. + +Note that without the ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` target +property, ``Foo`` would be linked twice: once as a direct dependency +of ``app``, and once as a dependency of ``FooPlugin``. + +Example: Opt-In Static Plugins +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In the above `Example: Static Plugins`_, the ``app`` executable specifies +that it links directly to ``Foo``. In a real application, there might +be an intermediate library: + +.. code-block:: cmake + + add_library(app_impl STATIC app_impl.cpp) + target_link_libraries(app_impl PRIVATE Foo) + + add_executable(app main.cpp) + target_link_libraries(app PRIVATE app_impl) + +In this case we do not want ``Foo``'s ``INTERFACE_LINK_LIBRARIES_DIRECT`` +and ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` target properties to affect +the direct dependencies of ``app_impl``. To avoid this, we can revise +the property values to make their effects opt-in: + +.. code-block:: cmake + + # An app that links Foo should link Foo's plugin directly. + set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT + "$<$>:FooPlugin>" + ) + + # An app does not need to link Foo directly because the plugin links it. + set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE + "$<$>:Foo>" + ) + +Now, the ``app`` executable can opt-in to get ``Foo``'s plugin(s): + +.. code-block:: cmake + + set_property(TARGET app PROPERTY FOO_STATIC_PLUGINS 1) + +The final link line for ``app`` will now link the libraries in the following +order: + +* ``FooPlugin`` as a direct link dependency of ``app`` + (via ``Foo``'s usage requirements). +* ``app_impl`` as a direct link dependency of ``app``. +* ``FooExtras`` as a dependency of ``FooPlugin``. +* ``Foo`` as a dependency of ``app_impl``, ``FooPlugin``, and ``FooExtras``. +* ``Core`` as a dependency of ``FooPlugin``, ``FooExtras``, and ``Foo``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2f8f87fa64962e7d2cd19733c4b8edc154e808fe --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE.rst.txt @@ -0,0 +1,34 @@ +INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE +--------------------------------------- + +.. versionadded:: 3.24 + +List of libraries that consumers of this library should *not* treat +as direct link dependencies. + +This target property may be set to *exclude* items from a dependent +target's final set of direct link dependencies. This property is +processed after the :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` +target property of all other dependencies of the dependent target, so +exclusion from direct link dependence takes priority over inclusion. + +The initial set of a dependent target's direct link dependencies is +specified by its :prop_tgt:`LINK_LIBRARIES` target property. Indirect +link dependencies are specified by the transitive closure of the direct +link dependencies' :prop_tgt:`INTERFACE_LINK_LIBRARIES` properties. +Any link dependency may specify additional direct link dependencies +using the :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` target property. +The set of direct link dependencies is then filtered to exclude items named +by any dependency's ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` target +property. + +Excluding an item from a dependent target's direct link dependencies +does not mean the dependent target won't link the item. The item +may still be linked as an indirect link dependency via the +:prop_tgt:`INTERFACE_LINK_LIBRARIES` property on other dependencies. + +.. |INTERFACE_PROPERTY_LINK_DIRECT| replace:: ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` +.. include:: INTERFACE_LINK_LIBRARIES_DIRECT.txt + +See the :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` target property +documentation for more details and examples. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..785b17cfa58717a205c8d779e16e6ad4d9432fe5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_LINK_OPTIONS.rst.txt @@ -0,0 +1,10 @@ +INTERFACE_LINK_OPTIONS +---------------------- + +.. versionadded:: 3.13 + +.. |property_name| replace:: link options +.. |command_name| replace:: :command:`target_link_options` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_LINK_OPTIONS`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`LINK_OPTIONS` +.. include:: INTERFACE_BUILD_PROPERTY.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4336d71825a7ac37ef7f28227e7122d15f2a5802 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst.txt @@ -0,0 +1,22 @@ +INTERFACE_POSITION_INDEPENDENT_CODE +----------------------------------- + +Whether consumers need to create a position-independent target + +The ``INTERFACE_POSITION_INDEPENDENT_CODE`` property informs consumers of +this target whether they must set their +:prop_tgt:`POSITION_INDEPENDENT_CODE` property to ``ON``. If this +property is set to ``ON``, then the :prop_tgt:`POSITION_INDEPENDENT_CODE` +property on all consumers will be set to ``ON``. Similarly, if this +property is set to ``OFF``, then the :prop_tgt:`POSITION_INDEPENDENT_CODE` +property on all consumers will be set to ``OFF``. If this property is +undefined, then consumers will determine their +:prop_tgt:`POSITION_INDEPENDENT_CODE` property by other means. Consumers +must ensure that the targets that they link to have a consistent +requirement for their ``INTERFACE_POSITION_INDEPENDENT_CODE`` property. + +Contents of ``INTERFACE_POSITION_INDEPENDENT_CODE`` 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. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_PRECOMPILE_HEADERS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_PRECOMPILE_HEADERS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2299264535e18cc7066073b4596aee5b6142ab22 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_PRECOMPILE_HEADERS.rst.txt @@ -0,0 +1,18 @@ +INTERFACE_PRECOMPILE_HEADERS +---------------------------- + +.. versionadded:: 3.16 + +List of interface header files to precompile into consuming targets. + +Targets may populate this property to publish the header files +for consuming targets to precompile. The :command:`target_precompile_headers` +command populates this property with values given to the ``PUBLIC`` and +``INTERFACE`` keywords. Projects may also get and set the property directly. +See the discussion in :command:`target_precompile_headers` for guidance on +appropriate use of this property for installed or exported targets. + +Contents of ``INTERFACE_PRECOMPILE_HEADERS`` 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. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_SOURCES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_SOURCES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..759c482110038abbd2e8f4db911891296e0e98b9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_SOURCES.rst.txt @@ -0,0 +1,20 @@ +INTERFACE_SOURCES +----------------- + +.. versionadded:: 3.1 + +List of interface sources to compile into consuming targets. + +Targets may populate this property to publish the sources +for consuming targets to compile. The :command:`target_sources` command +populates this property with values given to the ``PUBLIC`` and +``INTERFACE`` keywords. Projects may also get and set the property directly. + +When target dependencies are specified using :command:`target_link_libraries`, +CMake will read this property from all target dependencies to determine the +sources of the consumer. + +Contents of ``INTERFACE_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. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2ded46f156d427a29d004db87da19de257092ad2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst.txt @@ -0,0 +1,31 @@ +INTERFACE_SYSTEM_INCLUDE_DIRECTORIES +------------------------------------ + +List of public system include directories for a library. + +Targets may populate this property to publish the include directories +which contain system headers, and therefore should not result in +compiler warnings. Additionally, system include directories are searched +after normal include directories regardless of the order specified. + +When the :command:`target_include_directories` command is given the +``SYSTEM`` keyword, it populates this property with values provided after the +``PUBLIC`` and ``INTERFACE`` keywords. + +Projects may also get and set the property directly, but must be aware that +adding directories to this property does not make those directories used +during compilation. Adding directories to this property marks directories +as system directories which otherwise would be used in a non-system manner. +This can appear similar to duplication, so prefer the high-level +:command:`target_include_directories` command with the ``SYSTEM`` keyword +and avoid setting the property directly. + +When target dependencies are specified using :command:`target_link_libraries`, +CMake will read this property from all target dependencies to mark the +same include directories as containing system headers. + +Contents of ``INTERFACE_SYSTEM_INCLUDE_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. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0a4ac9aa5f4a8a81b2d80280d3e5484ac35bd33b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst.txt @@ -0,0 +1,17 @@ +INTERPROCEDURAL_OPTIMIZATION +---------------------------- + +Enable interprocedural optimization for a target. + +If set to true, enables interprocedural optimizations if they are +known :module:`to be supported ` by the compiler. Depending +on value of policy :policy:`CMP0069`, the error will be reported or ignored, +if interprocedural optimization is enabled but not supported. + +This property is initialized by the +:variable:`CMAKE_INTERPROCEDURAL_OPTIMIZATION` variable if it is set when a +target is created. + +There is also the per-configuration :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION_` +target property, which overrides :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` +if it is set. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..79d46048b103f0c4fadfe1b46b76b279fa845ee5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst.txt @@ -0,0 +1,12 @@ +INTERPROCEDURAL_OPTIMIZATION_ +------------------------------------- + +Per-configuration interprocedural optimization for a target. + +This is a per-configuration version of :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION`. +If set, this property overrides the generic property for the named +configuration. + +This property is initialized by the +:variable:`CMAKE_INTERPROCEDURAL_OPTIMIZATION_` variable if it is set +when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/IOS_INSTALL_COMBINED.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/IOS_INSTALL_COMBINED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c296691e0b1d05283bb4691d85064a4ca25a1410 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/IOS_INSTALL_COMBINED.rst.txt @@ -0,0 +1,28 @@ +IOS_INSTALL_COMBINED +-------------------- + +.. versionadded:: 3.5 +.. deprecated:: 3.28 + + :prop_tgt:`IOS_INSTALL_COMBINED` was designed to make universal binaries + containing iOS/arm* device code paired with iOS Simulator/x86_64 code + (or similar for other Apple embedded platforms). Universal binaries can only + differentiate code based on CPU type, so this only made sense before the + days of arm64 macOS machines (i.e. iOS Simulator/arm64). Apple now + recommends xcframeworks, which contain multiple binaries for different + platforms, for this use case. + +Build a combined (device and simulator) target when installing. + +When this property is set to false, which is the default, then it will +either be built with the device SDK or the simulator SDK depending on the SDK +set. But if this property is set to true then the target will at install time +also be built for the other SDK and combined into one library. + +.. note:: + + If a selected architecture is available for both device SDK and simulator + SDK it will be built for the SDK selected by :variable:`CMAKE_OSX_SYSROOT` + and removed from the other SDK. + +This feature requires at least Xcode version 6. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ISPC_HEADER_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ISPC_HEADER_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2a3a8bcb2e8a33e626edea2051e9e0950ccdebb2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ISPC_HEADER_DIRECTORY.rst.txt @@ -0,0 +1,13 @@ +ISPC_HEADER_DIRECTORY +--------------------- + +.. versionadded:: 3.19 + +Specify relative output directory for ISPC headers provided by the target. + +If the target contains ISPC source files, this specifies the directory in which +the generated headers will be placed. Relative paths are treated with respect to +the value of :variable:`CMAKE_CURRENT_BINARY_DIR`. When this property is not set, the +headers will be placed a generator defined build directory. If the variable +:variable:`CMAKE_ISPC_HEADER_DIRECTORY` is set when a target is created +its value is used to initialize this property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ISPC_HEADER_SUFFIX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ISPC_HEADER_SUFFIX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6397e554f6677aeed47432c961a37a4d2c1136da --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ISPC_HEADER_SUFFIX.rst.txt @@ -0,0 +1,14 @@ +ISPC_HEADER_SUFFIX +------------------ + +.. versionadded:: 3.19.2 + +Specify output suffix to be used for ISPC generated headers provided by the target. + +This property is initialized by the value of the :variable:`CMAKE_ISPC_HEADER_SUFFIX` +variable if it is set when a target is created. + +If the target contains ISPC source files, this specifies the header suffix to +be used for the generated headers. + +The default value is ``_ispc.h``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/ISPC_INSTRUCTION_SETS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/ISPC_INSTRUCTION_SETS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..cad116f8f700c427e7b7d761548c1b23c2fe51d3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/ISPC_INSTRUCTION_SETS.rst.txt @@ -0,0 +1,21 @@ +ISPC_INSTRUCTION_SETS +--------------------- + +.. versionadded:: 3.19 + +List of instruction set architectures to generate code for. + +This property is initialized by the value of the :variable:`CMAKE_ISPC_INSTRUCTION_SETS` +variable if it is set when a target is created. + +The ``ISPC_INSTRUCTION_SETS`` target property must be used when generating for multiple +instruction sets so that CMake can track what object files will be generated. + +Examples +^^^^^^^^ + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY ISPC_INSTRUCTION_SETS avx2-i32x4 avx512skx-i32x835) + +Generates code for avx2 and avx512skx target architectures. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/JOB_POOL_COMPILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/JOB_POOL_COMPILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5d8e9403873efc9758133c7aa1cb2e7e4b9ecc93 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/JOB_POOL_COMPILE.rst.txt @@ -0,0 +1,17 @@ +JOB_POOL_COMPILE +---------------- + +Ninja only: Pool used for compiling. + +The number of parallel compile processes could be limited by defining +pools with the global :prop_gbl:`JOB_POOLS` +property and then specifying here the pool name. + +For instance: + +.. code-block:: cmake + + set_property(TARGET myexe PROPERTY JOB_POOL_COMPILE ten_jobs) + +This property is initialized by the value of +:variable:`CMAKE_JOB_POOL_COMPILE`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/JOB_POOL_LINK.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/JOB_POOL_LINK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..653533371cad02ed9a5d58827dd4fc1d4984ee53 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/JOB_POOL_LINK.rst.txt @@ -0,0 +1,16 @@ +JOB_POOL_LINK +------------- + +Ninja only: Pool used for linking. + +The number of parallel link processes could be limited by defining +pools with the global :prop_gbl:`JOB_POOLS` +property and then specifying here the pool name. + +For instance: + +.. code-block:: cmake + + set_property(TARGET myexe PROPERTY JOB_POOL_LINK two_jobs) + +This property is initialized by the value of :variable:`CMAKE_JOB_POOL_LINK`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fab142c7abab6471a4d83a17533f55e71f56c14f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst.txt @@ -0,0 +1,23 @@ +JOB_POOL_PRECOMPILE_HEADER +-------------------------- + +.. versionadded:: 3.17 + +Ninja only: Pool used for generating pre-compiled headers. + +The number of parallel compile processes could be limited by defining +pools with the global :prop_gbl:`JOB_POOLS` +property and then specifying here the pool name. + +For instance: + +.. code-block:: cmake + + set_property(TARGET myexe PROPERTY JOB_POOL_PRECOMPILE_HEADER two_jobs) + +This property is initialized by the value of +:variable:`CMAKE_JOB_POOL_PRECOMPILE_HEADER`. + +If neither ``JOB_POOL_PRECOMPILE_HEADER`` nor +:variable:`CMAKE_JOB_POOL_PRECOMPILE_HEADER` are set then +:prop_tgt:`JOB_POOL_COMPILE` will be used for this task. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LABELS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LABELS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5e464696dce835b4782593d65064ecdcca0b12a5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LABELS.rst.txt @@ -0,0 +1,6 @@ +LABELS +------ + +Specify a list of text labels associated with a target. + +Target label semantics are currently unspecified. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CLANG_TIDY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CLANG_TIDY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9ecdc57b6583ebf1fc7b92125f1588f770fe2746 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CLANG_TIDY.rst.txt @@ -0,0 +1,41 @@ +_CLANG_TIDY +----------------- + +.. versionadded:: 3.6 + +This property is implemented only when ```` is ``C``, ``CXX``, ``OBJC`` +or ``OBJCXX``. + +Specify a :ref:`semicolon-separated list ` containing +a command line for the ``clang-tidy`` tool. The :ref:`Makefile Generators` +and the :generator:`Ninja` generator will run this tool along with the +compiler and report a warning if the tool reports any problems. + +The specified ``clang-tidy`` command line will be invoked with additional +arguments specifying the source file and, after ``--``, the full compiler +command line. + +.. versionchanged:: 3.25 + + If the specified ``clang-tidy`` command line includes the ``-p`` option, + it will be invoked without ``--`` and the full compiler command line. + ``clang-tidy`` will look up the source file in the specified compiler + commands database. + +This property is initialized by the value of +the :variable:`CMAKE__CLANG_TIDY` variable if it is set +when a target is created. + +.. versionadded:: 3.27 + + This property supports + :manual:`generator expressions `. + +.. versionadded:: 3.27 + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting tools defined by :prop_tgt:`_CPPLINT`, + ``_CLANG_TIDY``, :prop_tgt:`_CPPCHECK`, and + :prop_tgt:`_INCLUDE_WHAT_YOU_USE`. When :prop_sf:`SKIP_LINTING` is + set to true on a source file, those tools will not be run on that specific + file. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fc88f0f3021d769ce614fc01498ae0451bfb0b04 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst.txt @@ -0,0 +1,29 @@ +_CLANG_TIDY_EXPORT_FIXES_DIR +---------------------------------- + +.. versionadded:: 3.26 + +This property is implemented only when ```` is ``C``, ``CXX``, ``OBJC`` +or ``OBJCXX``, and only has an effect when :prop_tgt:`_CLANG_TIDY` is +set. + +Specify a directory for the ``clang-tidy`` tool to put ``.yaml`` files +containing its suggested changes in. This can be used for automated mass +refactoring by ``clang-tidy``. Each object file that gets compiled will have a +corresponding ``.yaml`` file in this directory. After the build is completed, +you can run ``clang-apply-replacements`` on this directory to simultaneously +apply all suggested changes to the code base. If this property is not an +absolute directory, it is assumed to be relative to the target's binary +directory. This property should be preferred over adding an ``--export-fixes`` +or ``--fix`` argument directly to the :prop_tgt:`_CLANG_TIDY` property. + +When this property is set, CMake takes ownership of the specified directory, +and may create, modify, or delete files and directories within the directory +at any time during configure or build time. Users should use a dedicated +directory for exporting clang-tidy fixes to avoid having files deleted or +overwritten by CMake. Users should not create, modify, or delete files in this +directory. + +This property is initialized by the value of +the :variable:`CMAKE__CLANG_TIDY_EXPORT_FIXES_DIR` variable if it is set +when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LANG_COMPILER_LAUNCHER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_COMPILER_LAUNCHER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2e039bd3a104d1483c19a8c75602d8fd7dd4e525 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_COMPILER_LAUNCHER.rst.txt @@ -0,0 +1,21 @@ +_COMPILER_LAUNCHER +------------------------ + +.. versionadded:: 3.4 + +This property is implemented only when ```` is ``C``, ``CXX``, +``Fortran``, ``HIP``, ``ISPC``, ``OBJC``, ``OBJCXX``, or ``CUDA``. + +Specify a :ref:`semicolon-separated list ` containing a command line +for a compiler launching tool. The :ref:`Makefile Generators` and the +:generator:`Ninja` generator will run this tool and pass the compiler and +its arguments to the tool. Some example tools are distcc and ccache. + +This property is initialized by the value of +the :variable:`CMAKE__COMPILER_LAUNCHER` variable if it is set +when a target is created. + +.. versionadded:: 3.25 + + The property value may use + :manual:`generator expressions `. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CPPCHECK.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CPPCHECK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0628061539bff141f152c16bddf7827a97b20838 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CPPCHECK.rst.txt @@ -0,0 +1,31 @@ +_CPPCHECK +--------------- + +.. versionadded:: 3.10 + +This property is supported only when ```` is ``C`` or ``CXX``. + +Specify a :ref:`semicolon-separated list ` containing a command line +for the ``cppcheck`` static analysis tool. The :ref:`Makefile Generators` +and the :generator:`Ninja` generator will run ``cppcheck`` along with the +compiler and report any problems. If the command-line specifies the +exit code options to ``cppcheck`` then the build will fail if the +tool returns non-zero. + +This property is initialized by the value of the +:variable:`CMAKE__CPPCHECK` variable if it is set when a target is +created. + +.. versionadded:: 3.27 + + This property supports + :manual:`generator expressions `. + +.. versionadded:: 3.27 + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting tools defined by :prop_tgt:`_CPPLINT`, + :prop_tgt:`_CLANG_TIDY`, ``_CPPCHECK``, and + :prop_tgt:`_INCLUDE_WHAT_YOU_USE`. When :prop_sf:`SKIP_LINTING` is + set to true on a source file, those tools will not be run on that specific + file. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CPPLINT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CPPLINT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..02610daa3246233a5078aef63bff828cfa068723 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_CPPLINT.rst.txt @@ -0,0 +1,29 @@ +_CPPLINT +-------------- + +.. versionadded:: 3.8 + +This property is supported only when ```` is ``C`` or ``CXX``. + +Specify a :ref:`semicolon-separated list ` containing a command line +for the ``cpplint`` style checker. The :ref:`Makefile Generators` and the +:generator:`Ninja` generator will run ``cpplint`` along with the compiler +and report any problems. + +This property is initialized by the value of the +:variable:`CMAKE__CPPLINT` variable if it is set when a target is +created. + +.. versionadded:: 3.27 + + This property supports + :manual:`generator expressions `. + +.. versionadded:: 3.27 + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting tools defined by ``_CPPLINT``, + :prop_tgt:`_CLANG_TIDY`, :prop_tgt:`_CPPCHECK`, and + :prop_tgt:`_INCLUDE_WHAT_YOU_USE`. When :prop_sf:`SKIP_LINTING` is + set to true on a source file, those tools will not be run on that specific + file. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LANG_EXTENSIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_EXTENSIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..afc2ad367ec65c4b454d40341c71654a24b33871 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_EXTENSIONS.rst.txt @@ -0,0 +1,24 @@ +_EXTENSIONS +----------------- + +The variations are: + +* :prop_tgt:`C_EXTENSIONS` +* :prop_tgt:`CXX_EXTENSIONS` +* :prop_tgt:`CUDA_EXTENSIONS` +* :prop_tgt:`HIP_EXTENSIONS` +* :prop_tgt:`OBJC_EXTENSIONS` +* :prop_tgt:`OBJCXX_EXTENSIONS` + +These properties specify whether compiler-specific extensions are requested. + +These properties are initialized by the value of the +:variable:`CMAKE__EXTENSIONS` variable if it is set when a target is +created and otherwise by the value of +:variable:`CMAKE__EXTENSIONS_DEFAULT` (see :policy:`CMP0128`). + +For supported CMake versions see the respective pages. +To control language standard versions see :prop_tgt:`_STANDARD`. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2f51c8f23bc88011168e6c711b5301b75037b260 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst.txt @@ -0,0 +1,29 @@ +_INCLUDE_WHAT_YOU_USE +--------------------------- + +.. versionadded:: 3.3 + +This property is implemented only when ```` is ``C`` or ``CXX``. + +Specify a :ref:`semicolon-separated list ` containing a command +line for the ``include-what-you-use`` tool. The :ref:`Makefile Generators` +and the :generator:`Ninja` generator will run this tool along with the +compiler and report a warning if the tool reports any problems. + +This property is initialized by the value of +the :variable:`CMAKE__INCLUDE_WHAT_YOU_USE` variable if it is set +when a target is created. + +.. versionadded:: 3.27 + + This property supports + :manual:`generator expressions `. + +.. versionadded:: 3.27 + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting tools defined by :prop_tgt:`_CPPLINT`, + :prop_tgt:`_CLANG_TIDY`, :prop_tgt:`_CPPCHECK`, and + ``_INCLUDE_WHAT_YOU_USE``. When :prop_sf:`SKIP_LINTING` is + set to true on a source file, those tools will not be run on that specific + file. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LANG_LINKER_LAUNCHER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_LINKER_LAUNCHER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d39ec203aae7e8fc20e1cc1a3559322995342d2f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_LINKER_LAUNCHER.rst.txt @@ -0,0 +1,21 @@ +_LINKER_LAUNCHER +---------------------- + +.. versionadded:: 3.21 + +This property is implemented only when ```` is ``C``, ``CXX``, +``OBJC``, or ``OBJCXX`` + +Specify a :ref:`semicolon-separated list ` containing a +command line for a linker launching tool. The :ref:`Makefile Generators` and the +:generator:`Ninja` generator will run this tool and pass the linker and its +arguments to the tool. This is useful for tools such as static analyzers. + +This property is initialized by the value of the +:variable:`CMAKE__LINKER_LAUNCHER` variable if it is set when a target is +created. + +.. versionadded:: 3.27 + + The property value may use + :manual:`generator expressions `. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LANG_STANDARD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_STANDARD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4b59af70e257d42212d402892ad09134179361e1 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_STANDARD.rst.txt @@ -0,0 +1,33 @@ +_STANDARD +--------------- + +The variations are: + +* :prop_tgt:`C_STANDARD` +* :prop_tgt:`CXX_STANDARD` +* :prop_tgt:`CUDA_STANDARD` +* :prop_tgt:`HIP_STANDARD` +* :prop_tgt:`OBJC_STANDARD` +* :prop_tgt:`OBJCXX_STANDARD` + +These properties specify language standard versions which are requested. When a +newer standard is specified than is supported by the compiler, then it will +fallback to the latest supported standard. This "decay" behavior may be +controlled with the :prop_tgt:`_STANDARD_REQUIRED` target property. + +Note that the actual language standard used may be higher than that specified +by ``_STANDARD``, regardless of the value of +:prop_tgt:`_STANDARD_REQUIRED`. In particular, +:ref:`usage requirements ` or the use of +:manual:`compile features ` can raise the required +language standard above what ``_STANDARD`` specifies. + +These properties are initialized by the value of the +:variable:`CMAKE__STANDARD` variable if it is set when a target is +created. + +For supported values and CMake versions see the respective pages. +To control compiler-specific extensions see :prop_tgt:`_EXTENSIONS`. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LANG_STANDARD_REQUIRED.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_STANDARD_REQUIRED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..532057b98f90abc6d35f811f6491f5571aad6d01 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_STANDARD_REQUIRED.rst.txt @@ -0,0 +1,32 @@ +_STANDARD_REQUIRED +------------------------ + +The variations are: + +* :prop_tgt:`C_STANDARD_REQUIRED` +* :prop_tgt:`CXX_STANDARD_REQUIRED` +* :prop_tgt:`CUDA_STANDARD_REQUIRED` +* :prop_tgt:`HIP_STANDARD_REQUIRED` +* :prop_tgt:`OBJC_STANDARD_REQUIRED` +* :prop_tgt:`OBJCXX_STANDARD_REQUIRED` + +These properties specify whether the value of :prop_tgt:`_STANDARD` is a +requirement. When false or unset, the :prop_tgt:`_STANDARD` target +property is treated as optional and may "decay" to a previous standard if the +requested standard is not available. When ``_STANDARD_REQUIRED`` is set +to true, :prop_tgt:`_STANDARD` becomes a hard requirement and a fatal +error will be issued if that requirement cannot be met. + +Note that the actual language standard used may be higher than that specified +by :prop_tgt:`_STANDARD`, regardless of the value of +``_STANDARD_REQUIRED``. In particular, +:ref:`usage requirements ` or the use of +:manual:`compile features ` can raise the required +language standard above what :prop_tgt:`_STANDARD` specifies. + +These properties are initialized by the value of the +:variable:`CMAKE__STANDARD_REQUIRED` variable if it is set when a target +is created. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LANG_VISIBILITY_PRESET.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_VISIBILITY_PRESET.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5d34e207efb2e687a55ef07481120a83db5a847f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LANG_VISIBILITY_PRESET.rst.txt @@ -0,0 +1,13 @@ +_VISIBILITY_PRESET +------------------------ + +Value for symbol visibility compile flags + +The ``_VISIBILITY_PRESET`` property determines the value passed in a +visibility related compile option, such as ``-fvisibility=`` for ````. +This property affects compilation in sources of all types of targets +(subject to policy :policy:`CMP0063`). + +This property is initialized by the value of the +:variable:`CMAKE__VISIBILITY_PRESET` variable if it is set when a +target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9fbe9040838d349e812228b2abaa374401e64580 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst.txt @@ -0,0 +1,9 @@ +LIBRARY_OUTPUT_DIRECTORY +------------------------ + +.. |XXX| replace:: :ref:`LIBRARY ` +.. |xxx| replace:: library +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_LIBRARY_OUTPUT_DIRECTORY` +.. include:: XXX_OUTPUT_DIRECTORY.txt + +See also the :prop_tgt:`LIBRARY_OUTPUT_DIRECTORY_` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5cefc38bb8bfd681b7a38d237274a8770e897e5b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst.txt @@ -0,0 +1,17 @@ +LIBRARY_OUTPUT_DIRECTORY_ +--------------------------------- + +Per-configuration output directory for +:ref:`LIBRARY ` target files. + +This is a per-configuration version of the +:prop_tgt:`LIBRARY_OUTPUT_DIRECTORY` target property, but +multi-configuration generators (:ref:`Visual Studio Generators`, +:generator:`Xcode`) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the +:variable:`CMAKE_LIBRARY_OUTPUT_DIRECTORY_` variable if +it is set when a target is created. + +Contents of ``LIBRARY_OUTPUT_DIRECTORY_`` may use +:manual:`generator expressions `. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6027f7f73e732d7df7025d7b08749a6eea2dbf69 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_NAME.rst.txt @@ -0,0 +1,8 @@ +LIBRARY_OUTPUT_NAME +------------------- + +.. |XXX| replace:: :ref:`LIBRARY ` +.. |xxx| replace:: library +.. include:: XXX_OUTPUT_NAME.txt + +See also the :prop_tgt:`LIBRARY_OUTPUT_NAME_` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..1994c7b1653880d66a1e8e2f2c66329c0f253de4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst.txt @@ -0,0 +1,8 @@ +LIBRARY_OUTPUT_NAME_ +---------------------------- + +Per-configuration output name for +:ref:`LIBRARY ` target files. + +This is the configuration-specific version of the +:prop_tgt:`LIBRARY_OUTPUT_NAME` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINKER_LANGUAGE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINKER_LANGUAGE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f47b488a9974e06417277da2cdc17fa85faf6578 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINKER_LANGUAGE.rst.txt @@ -0,0 +1,16 @@ +LINKER_LANGUAGE +--------------- + +Specifies language whose compiler will invoke the linker. + +For executables, shared libraries, and modules, this sets the language +whose compiler is used to link the target (such as "C" or "CXX"). A +typical value for an executable is the language of the source file +providing the program entry point (main). If not set, the language +with the highest linker preference value is the default. Details of +the linker preferences are considered internal, but some limited +discussion can be found under the internal +:variable:`CMAKE__LINKER_PREFERENCE` variables. + +If this property is not set by the user, it will be calculated at +generate-time by CMake. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINKER_TYPE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINKER_TYPE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..23e1e4cf308a2868f4ae670a12ed7831044cdad2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINKER_TYPE.rst.txt @@ -0,0 +1,27 @@ +LINKER_TYPE +----------- + +.. versionadded:: 3.29 + +Specify which linker will be used for the link step. The property value may use +:manual:`generator expressions `. + +.. include:: ../variable/LINKER_PREDEFINED_TYPES.txt + +This property is not supported on :generator:`Green Hills MULTI` generator. + +The implementation details for the selected linker will be provided by the +:variable:`CMAKE__USING_LINKER_` variable. For example: + +.. code-block:: cmake + + add_library(lib1 SHARED ...) + set_property(TARGET lib1 PROPERTY LINKER_TYPE LLD) + +This specifies that ``lib1`` should use linker type ``LLD`` for the link step. +The command line options that will be passed to the toolchain will be provided +by the ``CMAKE__USING_LINKER_LLD`` variable. + +Note that the linker would typically be set using :variable:`CMAKE_LINKER_TYPE` +for the whole build rather than setting the ``LINKER_TYPE`` property on +individual targets. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_DEPENDS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_DEPENDS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e59d4c014e0e5be01054c31bf8ddf535bd253a94 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_DEPENDS.rst.txt @@ -0,0 +1,18 @@ +LINK_DEPENDS +------------ + +Additional files on which a target binary depends for linking. + +Specifies a semicolon-separated list of full-paths to files on which +the link rule for this target depends. The target binary will be +linked if any of the named files is newer than it. + +This property is supported only by :generator:`Ninja` and +:ref:`Makefile Generators`. It is +intended to specify dependencies on "linker scripts" for custom Makefile link +rules. + +Contents of ``LINK_DEPENDS`` 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. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_DEPENDS_NO_SHARED.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_DEPENDS_NO_SHARED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..dc2dc9e320ea73c232048316e71345ebae82069a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_DEPENDS_NO_SHARED.rst.txt @@ -0,0 +1,15 @@ +LINK_DEPENDS_NO_SHARED +---------------------- + +Do not depend on linked shared library files. + +Set this property to true to tell CMake generators not to add +file-level dependencies on the shared library files linked by this +target. Modification to the shared libraries will not be sufficient +to re-link this target. Logical target-level dependencies will not be +affected so the linked shared libraries will still be brought up to +date before this target is built. + +This property is initialized by the value of the +:variable:`CMAKE_LINK_DEPENDS_NO_SHARED` variable if it is set when a +target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_DIRECTORIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_DIRECTORIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..67be494ce97cbeb3577e19b77022bf108669661c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_DIRECTORIES.rst.txt @@ -0,0 +1,20 @@ +LINK_DIRECTORIES +---------------- + +.. versionadded:: 3.13 + +List of directories to use for the link step of shared library, module +and executable targets. + +This property holds a :ref:`semicolon-separated list ` of directories +specified so far for its target. Use the :command:`target_link_directories` +command to append more search directories. + +This property is initialized by the :prop_dir:`LINK_DIRECTORIES` directory +property when a target is created, and is used by the generators to set +the search directories for the linker. + +Contents of ``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. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_FLAGS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_FLAGS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..92cd3c0a5bbc28de056ee535ed650e30df97a68f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_FLAGS.rst.txt @@ -0,0 +1,16 @@ +LINK_FLAGS +---------- + +Additional flags to use when linking this target if it is a shared library, +module library, or an executable. Static libraries need to use +:prop_tgt:`STATIC_LIBRARY_OPTIONS` or :prop_tgt:`STATIC_LIBRARY_FLAGS` +properties. + +The ``LINK_FLAGS`` property, managed as a string, can be used to add extra +flags to the link step of a target. :prop_tgt:`LINK_FLAGS_` will add +to the configuration ````, for example, ``DEBUG``, ``RELEASE``, +``MINSIZEREL``, ``RELWITHDEBINFO``, ... + +.. note:: + + This property has been superseded by :prop_tgt:`LINK_OPTIONS` property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_FLAGS_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_FLAGS_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..68c31293206fba9138ece924a28482dde43f8f65 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_FLAGS_CONFIG.rst.txt @@ -0,0 +1,11 @@ +LINK_FLAGS_ +------------------- + +Per-configuration linker flags for a ``SHARED`` library, ``MODULE`` or +``EXECUTABLE`` target. + +This is the configuration-specific version of :prop_tgt:`LINK_FLAGS`. + +.. note:: + + This property has been superseded by :prop_tgt:`LINK_OPTIONS` property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_LIBRARIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_LIBRARIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2dcf45cbd4f605136650e7d505a73e2a2baa304a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_LIBRARIES.rst.txt @@ -0,0 +1,31 @@ +LINK_INTERFACE_LIBRARIES +------------------------ + +List public interface libraries for a shared library or executable. + +By default linking to a shared library target transitively links to +targets with which the library itself was linked. For an executable +with exports (see the :prop_tgt:`ENABLE_EXPORTS` target property) no +default transitive link dependencies are used. This property replaces the default +transitive link dependencies with an explicit list. When the target +is linked into another target using the :command:`target_link_libraries` +command, the libraries listed (and recursively +their link interface libraries) will be provided to the other target +also. If the list is empty then no transitive link dependencies will +be incorporated when this target is linked into another target even if +the default set is non-empty. This property is initialized by the +value of the :variable:`CMAKE_LINK_INTERFACE_LIBRARIES` variable if it is +set when a target is created. This property is ignored for ``STATIC`` +libraries. + +This property is overridden by the :prop_tgt:`INTERFACE_LINK_LIBRARIES` +property if policy :policy:`CMP0022` is ``NEW``. + +This property is deprecated. Use :prop_tgt:`INTERFACE_LINK_LIBRARIES` +instead. + +Creating Relocatable Packages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. |INTERFACE_PROPERTY_LINK| replace:: ``LINK_INTERFACE_LIBRARIES`` +.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..22ee5a68b270c1d0e88f10a7ac827347e83b529d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst.txt @@ -0,0 +1,20 @@ +LINK_INTERFACE_LIBRARIES_ +--------------------------------- + +Per-configuration list of public interface libraries for a target. + +This is the configuration-specific version of +:prop_tgt:`LINK_INTERFACE_LIBRARIES`. If set, this property completely +overrides the generic property for the named configuration. + +This property is overridden by the :prop_tgt:`INTERFACE_LINK_LIBRARIES` +property if policy :policy:`CMP0022` is ``NEW``. + +This property is deprecated. Use :prop_tgt:`INTERFACE_LINK_LIBRARIES` +instead. + +Creating Relocatable Packages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. |INTERFACE_PROPERTY_LINK| replace:: ``LINK_INTERFACE_LIBRARIES_`` +.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b798af954be0d55f84385ebdda6fa691306da082 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst.txt @@ -0,0 +1,12 @@ +LINK_INTERFACE_MULTIPLICITY +--------------------------- + +Repetition count for ``STATIC`` libraries with cyclic dependencies. + +When linking to a ``STATIC`` library target with cyclic dependencies the +linker may need to scan more than once through the archives in the +strongly connected component of the dependency graph. CMake by +default constructs the link line so that the linker will scan through +the component at least twice. This property specifies the minimum +number of scans if it is larger than the default. CMake uses the +largest value specified by any target in a component. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7c9461fde8b2b537ced7e7d1f37bc2f68a165bd2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst.txt @@ -0,0 +1,8 @@ +LINK_INTERFACE_MULTIPLICITY_ +------------------------------------ + +Per-configuration repetition count for cycles of ``STATIC`` libraries. + +This is the configuration-specific version of +:prop_tgt:`LINK_INTERFACE_MULTIPLICITY`. If set, this property completely +overrides the generic property for the named configuration. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b449aa151b9b3d28f0f6262a6d9cea9cbbf7ccc1 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARIES.rst.txt @@ -0,0 +1,35 @@ +LINK_LIBRARIES +-------------- + +List of direct link dependencies. + +This property specifies the list of libraries or targets which will be +used for linking. In addition to accepting values from the +:command:`target_link_libraries` command, values may be set directly on +any target using the :command:`set_property` command. + +The value of this property is used by the generators to construct the +link rule for the target. The direct link dependencies are linked first, +followed by indirect dependencies from the transitive closure of the +direct dependencies' :prop_tgt:`INTERFACE_LINK_LIBRARIES` properties. +See policy :policy:`CMP0022`. + +Contents of ``LINK_LIBRARIES`` may use +:manual:`generator expressions ` with the +syntax ``$<...>``. Policy :policy:`CMP0131` affects the behavior of the +:genex:`LINK_ONLY` generator expression for this property. + +See the :manual:`cmake-buildsystem(7)` manual for more on defining +buildsystem properties. + +.. include:: LINK_LIBRARIES_INDIRECTION.txt + +In advanced use cases, the list of direct link dependencies specified +by this property may be updated by usage requirements from dependencies. +See the :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` and +:prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` target properties. + +See the :variable:`CMAKE_LINK_LIBRARIES_STRATEGY` variable and +corresponding :prop_tgt:`LINK_LIBRARIES_STRATEGY` target property +for details on how CMake orders direct link dependencies on linker +command lines. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0749c6fb18153440fa1019c771790348b0422139 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst.txt @@ -0,0 +1,56 @@ +LINK_LIBRARIES_ONLY_TARGETS +--------------------------- + +.. versionadded:: 3.23 + +Enforce that link items that can be target names are actually existing targets. + +Set this property to a true value to enable additional checks on the contents +of the :prop_tgt:`LINK_LIBRARIES` and :prop_tgt:`INTERFACE_LINK_LIBRARIES` +target properties, typically populated by :command:`target_link_libraries`. +Checks are also applied to libraries added to a target through the +:prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` properties of its dependencies. +CMake will verify that link items that might be target names actually name +existing targets. An item is considered a possible target name if: + +* it does not contain a ``/`` or ``\``, and +* it does not start in ``-``, and +* (for historical reasons) it does not start in ``$`` or `````. + +This property is initialized by the value of the +:variable:`CMAKE_LINK_LIBRARIES_ONLY_TARGETS` variable when a non-imported +target is created. The property may be explicitly enabled on an imported +target to check its link interface. + +In the following example, CMake will halt with an error at configure time +because ``miLib`` is not a target: + +.. code-block:: cmake + + set(CMAKE_LINK_LIBRARIES_ONLY_TARGETS ON) + add_library(myLib STATIC myLib.c) + add_executable(myExe myExe.c) + target_link_libraries(myExe PRIVATE miLib) # typo for myLib + +In order to link toolchain-provided libraries by name while still +enforcing ``LINK_LIBRARIES_ONLY_TARGETS``, use an +:ref:`imported ` +:ref:`Interface Library ` with the +:prop_tgt:`IMPORTED_LIBNAME` target property: + +.. code-block:: cmake + + add_library(toolchain::m INTERFACE IMPORTED) + set_property(TARGET toolchain::m PROPERTY IMPORTED_LIBNAME "m") + target_link_libraries(myExe PRIVATE toolchain::m) + +See also policy :policy:`CMP0028`. + +.. note:: + + If :prop_tgt:`INTERFACE_LINK_LIBRARIES` contains generator expressions, + its actual list of link items may depend on the type and properties of + the consuming target. In such cases CMake may not always detect names + of missing targets that only appear for specific consumers. + A future version of CMake with improved heuristics may start triggering + errors on projects accepted by previous versions of CMake. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARIES_STRATEGY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARIES_STRATEGY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f8db750152c42cbcf0f13153031b68266cfbd4cc --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARIES_STRATEGY.rst.txt @@ -0,0 +1,87 @@ +LINK_LIBRARIES_STRATEGY +----------------------- + +.. versionadded:: 3.31 + +Specify a strategy for ordering a target's direct link dependencies +on linker command lines. This property is initialized by the value of the +:variable:`CMAKE_LINK_LIBRARIES_STRATEGY` variable if it is set when a +target is created. + +CMake generates a target's link line using its :ref:`Target Link Properties`. +In particular, the :prop_tgt:`LINK_LIBRARIES` target property records the +target's direct link dependencies, typically populated by calls to +:command:`target_link_libraries`. Indirect link dependencies are +propagated from those entries of :prop_tgt:`LINK_LIBRARIES` that name +library targets by following the transitive closure of their +:prop_tgt:`INTERFACE_LINK_LIBRARIES` properties. CMake supports multiple +strategies for nominally ordering direct and indirect link dependencies, +which are then filtered for `Toolchain-Specific Behavior`_. + +Consider this example for the strategies below: + +.. code-block:: cmake + + add_library(A STATIC ...) + add_library(B STATIC ...) + add_library(C STATIC ...) + add_executable(main ...) + target_link_libraries(B PRIVATE A) + target_link_libraries(C PRIVATE A) + target_link_libraries(main PRIVATE A B C) + +The supported strategies are: + +``REORDER_MINIMALLY`` + Entries of :prop_tgt:`LINK_LIBRARIES` always appear first and in their + original order. Indirect link dependencies not satisfied by the + original entries may be reordered and de-duplicated with respect to + one another, but are always appended after the original entries. + This may result in less efficient link lines, but gives projects + control of ordering among independent entries. Such control may be + important when intermixing link flags with libraries, or when multiple + libraries provide a given symbol. + + This is the default. + + In the above example, this strategy computes a link line for ``main`` + by starting with its original entries ``A B C``, and then appends + another ``A`` to satisfy the dependencies of ``B`` and ``C`` on ``A``. + The nominal order produced by this strategy is ``A B C A``. + + Note that additional filtering for `Toolchain-Specific Behavior`_ + may de-duplicate ``A`` on the actual linker invocation in the + generated build system, resulting in either ``A B C`` or ``B C A``. + +``REORDER_FREELY`` + Entries of :prop_tgt:`LINK_LIBRARIES` may be reordered, de-duplicated, + and intermixed with indirect link dependencies. This may result in + more efficient link lines, but does not give projects any control of + ordering among independent entries. + + In the above example, this strategy computes a link line for ``main`` + by re-ordering its original entries ``A B C`` to satisfy the + dependencies of ``B`` and ``C`` on ``A``. + The nominal order produced by this strategy is ``B C A``. + +Toolchain-Specific Behavior +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +After one of the above strategies produces a nominal order among +direct and indirect link dependencies, the actual linker invocation +in the generated build system may de-duplicate entries based on +platform-specific requirements and linker capabilities. +See policy :policy:`CMP0156`. + +For example, if the ``REORDER_MINIMALLY`` strategy produces ``A B C A``, +the actual link line may de-duplicate ``A`` as follows: + +* If ``A`` is a static library and the linker re-scans automatically, + the first occurrence is kept, resulting in ``A B C``. + See policy :policy:`CMP0179` + +* If ``A`` is a shared library on Windows, the first + occurrence is kept, resulting in ``A B C``. + +* If ``A`` is a shared library on macOS or UNIX platforms, the last + occurrence is kept, resulting in ``B C A``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARY_OVERRIDE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARY_OVERRIDE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..916a7c66d5fb0bcb6874f55efdc34c9aae062881 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARY_OVERRIDE.rst.txt @@ -0,0 +1,65 @@ +LINK_LIBRARY_OVERRIDE +--------------------- + +.. versionadded:: 3.24 + +Override the library features associated with libraries from +:genex:`LINK_LIBRARY` generator expressions. This can be used to resolve +incompatible library features that result from specifying different features +for the same library in different :genex:`LINK_LIBRARY` generator expressions. + +This property supports overriding multiple libraries and features. It expects +a :ref:`semicolon-separated list `, where each list item +has the following form:: + + feature[,link-item]* + +For each comma-separated ``link-item``, any existing library feature associated +with it will be ignored for the target this property is set on. The item +will instead be associated with the specified ``feature``. Each ``link-item`` +can be anything that would be accepted as part of a ``library-list`` in a +:genex:`LINK_LIBRARY` generator expression. + +.. code-block:: cmake + + add_library(lib1 ...) + add_library(lib2 ...) + add_library(lib3 ...) + + target_link_libraries(lib1 PUBLIC "$") + target_link_libraries(lib2 PUBLIC "$") + target_link_libraries(lib3 PRIVATE lib1 lib2) + + # lib1 is associated with both feature2 and no feature. Without any override, + # this would result in a fatal error at generation time for lib3. + # Define an override to resolve the incompatible feature associations. + set_property(TARGET lib3 PROPERTY LINK_LIBRARY_OVERRIDE "feature2,lib1,external") + + # lib1 and external will now be associated with feature2 instead when linking lib3 + +It is also possible to override any feature with the pre-defined ``DEFAULT`` +library feature. This effectively discards any feature for that link item, +for that target only (``lib3`` in this example): + +.. code-block:: cmake + + # When linking lib3, discard any library feature for lib1, and use feature2 for external + set_property(TARGET lib3 PROPERTY LINK_LIBRARY_OVERRIDE + "DEFAULT,lib1" + "feature2,external" + ) + +The above example also demonstrates how to specify different feature overrides +for different link items. See the :prop_tgt:`LINK_LIBRARY_OVERRIDE_` +target property for an alternative way of overriding library features for +individual libraries, which may be simpler in some cases. If both properties +are defined and specify an override for the same link item, +:prop_tgt:`LINK_LIBRARY_OVERRIDE_` takes precedence over +``LINK_LIBRARY_OVERRIDE``. + +Contents of ``LINK_LIBRARY_OVERRIDE`` may use +:manual:`generator expressions `. + +For more information about library features, see the +:variable:`CMAKE__LINK_LIBRARY_USING_` and +:variable:`CMAKE_LINK_LIBRARY_USING_` variables. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARY_OVERRIDE_LIBRARY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARY_OVERRIDE_LIBRARY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4d3dd4f64a4181aaec6fe5032414a1b0fb50f1ea --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_LIBRARY_OVERRIDE_LIBRARY.rst.txt @@ -0,0 +1,51 @@ +LINK_LIBRARY_OVERRIDE_ +------------------------------- + +.. versionadded:: 3.24 + +Override the library feature associated with ```` from +:genex:`LINK_LIBRARY` generator expressions. This can be used to resolve +incompatible library features that result from specifying different features +for ```` in different :genex:`LINK_LIBRARY` generator expressions. + +When set on a target, this property holds a single library feature name, which +will be applied to ```` when linking that target. + +.. code-block:: cmake + + add_library(lib1 ...) + add_library(lib2 ...) + add_library(lib3 ...) + + target_link_libraries(lib1 PUBLIC "$") + target_link_libraries(lib2 PUBLIC "$") + target_link_libraries(lib3 PRIVATE lib1 lib2) + + # lib1 is associated with both feature2 and no feature. Without any override, + # this would result in a fatal error at generation time for lib3. + # Define an override to resolve the incompatible feature associations. + set_property(TARGET lib3 PROPERTY LINK_LIBRARY_OVERRIDE_lib1 feature2) + + # lib1 will now be associated with feature2 instead when linking lib3 + +It is also possible to override any feature with the pre-defined ``DEFAULT`` +library feature. This effectively discards any feature for that link item, +for that target only (``lib3`` in this example): + +.. code-block:: cmake + + # When linking lib3, discard any library feature for lib1 + set_property(TARGET lib3 PROPERTY LINK_LIBRARY_OVERRIDE_lib1 DEFAULT) + +See the :prop_tgt:`LINK_LIBRARY_OVERRIDE` target property for an alternative +way of overriding library features for multiple libraries at once. If both +properties are defined and specify an override for the same link item, +``LINK_LIBRARY_OVERRIDE_`` takes precedence over +:prop_tgt:`LINK_LIBRARY_OVERRIDE`. + +Contents of ``LINK_LIBRARY_OVERRIDE_`` may use +:manual:`generator expressions `. + +For more information about library features, see the +:variable:`CMAKE__LINK_LIBRARY_USING_` and +:variable:`CMAKE_LINK_LIBRARY_USING_` variables. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fcdac59039b48777364d761428a7071f16fd53da --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_OPTIONS.rst.txt @@ -0,0 +1,36 @@ +LINK_OPTIONS +------------ + +.. versionadded:: 3.13 + +List of options to use for the link step of shared library, module +and executable targets as well as the device link step. Targets that are static +libraries need to use the :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property. + +These options are used for both normal linking and device linking +(see policy :policy:`CMP0105`). To control link options for normal and device +link steps, :genex:`$` and :genex:`$` generator +expressions can be used. + +This property holds a :ref:`semicolon-separated list ` of +options specified so far for its target. Use the :command:`target_link_options` +command to append more options. + +This property is initialized by the :prop_dir:`LINK_OPTIONS` directory +property when a target is created, and is used by the generators to set +the options for the compiler. + +Contents of ``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)` manual +for more on defining buildsystem properties. + +.. note:: + + This property must be used in preference to :prop_tgt:`LINK_FLAGS` property. + +.. include:: ../command/DEVICE_LINK_OPTIONS.txt + +.. include:: ../command/OPTIONS_SHELL.txt + +.. include:: ../command/LINK_OPTIONS_LINKER.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_SEARCH_END_STATIC.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_SEARCH_END_STATIC.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fecbb148049e3543dd15b5de8fb609dec247d655 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_SEARCH_END_STATIC.rst.txt @@ -0,0 +1,19 @@ +LINK_SEARCH_END_STATIC +---------------------- + +End a link line such that static system libraries are used. + +Some linkers support switches such as ``-Bstatic`` and ``-Bdynamic`` to +determine whether to use static or shared libraries for ``-lXXX`` options. +CMake uses these options to set the link type for libraries whose full +paths are not known or (in some cases) are in implicit link +directories for the platform. By default CMake adds an option at the +end of the library list (if necessary) to set the linker search type +back to its starting type. This property switches the final linker +search type to ``-Bstatic`` regardless of how it started. + +This property is initialized by the value of the variable +:variable:`CMAKE_LINK_SEARCH_END_STATIC` if it is set +when a target is created. + +See also :prop_tgt:`LINK_SEARCH_START_STATIC`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_SEARCH_START_STATIC.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_SEARCH_START_STATIC.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..83cf231c5fa49703fc72b06c822776eb39451ba2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_SEARCH_START_STATIC.rst.txt @@ -0,0 +1,20 @@ +LINK_SEARCH_START_STATIC +------------------------ + +Assume the linker looks for static libraries by default. + +Some linkers support switches such as ``-Bstatic`` and ``-Bdynamic`` to +determine whether to use static or shared libraries for ``-lXXX`` options. +CMake uses these options to set the link type for libraries whose full +paths are not known or (in some cases) are in implicit link +directories for the platform. By default the linker search type is +assumed to be ``-Bdynamic`` at the beginning of the library list. This +property switches the assumption to ``-Bstatic``. It is intended for use +when linking an executable statically (e.g. with the GNU ``-static`` +option). + +This property is initialized by the value of the variable + :variable:`CMAKE_LINK_SEARCH_START_STATIC` if it is set + when a target is created. + +See also :prop_tgt:`LINK_SEARCH_END_STATIC`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LINK_WHAT_YOU_USE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_WHAT_YOU_USE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d6de0d49c7577ebb902dcc8a513d547cd456c191 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LINK_WHAT_YOU_USE.rst.txt @@ -0,0 +1,23 @@ +LINK_WHAT_YOU_USE +----------------- + +.. versionadded:: 3.7 + +This is a boolean option that, when set to ``TRUE``, will automatically run +contents of variable :variable:`CMAKE_LINK_WHAT_YOU_USE_CHECK` on the target +after it is linked. In addition, the linker flag specified by variable +:variable:`CMAKE__LINK_WHAT_YOU_USE_FLAG` will be passed to the target +with the link command so that all libraries specified on the command line will +be linked into the target. This will result in the link producing a list of +libraries that provide no symbols used by this target but are being linked to +it. + +.. note:: + + For now, it is only supported for ``ELF`` platforms and is only applicable to + executable and shared or module library targets. This property will be + ignored for any other targets and configurations. + +This property is initialized by the value of +the :variable:`CMAKE_LINK_WHAT_YOU_USE` variable if it is set +when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LOCATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LOCATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d058064d6bccce8adbc9dc579676d4e83e022dcf --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LOCATION.rst.txt @@ -0,0 +1,28 @@ +LOCATION +-------- + +Read-only location of a target on disk. + +For an imported target, this read-only property returns the value of +the ``LOCATION_`` property for an unspecified configuration +```` provided by the target. + +For a non-imported target, this property is provided for compatibility +with CMake 2.4 and below. It was meant to get the location of an +executable target's output file for use in :command:`add_custom_command`. The +path may contain a build-system-specific portion that is replaced at +build time with the configuration getting built (such as +``$(ConfigurationName)`` in VS). In CMake 2.6 and above +:command:`add_custom_command` automatically recognizes a target name in its +``COMMAND`` and ``DEPENDS`` options and computes the target location. In +CMake 2.8.4 and above :command:`add_custom_command` recognizes +:manual:`generator expressions ` +to refer to target locations anywhere in the command. +Therefore this property is not needed for creating custom commands. + +Do not set properties that affect the location of a target after +reading this property. These include properties whose names match +``(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_)?``, +``(IMPLIB_)?(PREFIX|SUFFIX)``, or "LINKER_LANGUAGE". Failure to follow +this rule is not diagnosed and leaves the location of the target +undefined. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/LOCATION_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/LOCATION_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..67de8ed21c574164e96741031ef8abf5c7fe1ad2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/LOCATION_CONFIG.rst.txt @@ -0,0 +1,20 @@ +LOCATION_ +----------------- + +Read-only property providing a target location on disk. + +A read-only property that indicates where a target's main file is +located on disk for the configuration ````. The property is +defined only for library and executable targets. An imported target +may provide a set of configurations different from that of the +importing project. By default CMake looks for an exact-match but +otherwise uses an arbitrary available configuration. Use the +:prop_tgt:`MAP_IMPORTED_CONFIG_` property to map imported +configurations explicitly. + +Do not set properties that affect the location of a target after +reading this property. These include properties whose names match +``(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_)?``, +``(IMPLIB_)?(PREFIX|SUFFIX)``, or :prop_tgt:`LINKER_LANGUAGE`. +Failure to follow this rule is not diagnosed and leaves +the location of the target undefined. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a24b25519feb644ccedb6873626da7337f3bb6a4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst.txt @@ -0,0 +1,27 @@ +MACHO_COMPATIBILITY_VERSION +--------------------------- + +.. versionadded:: 3.17 + +What compatibility version number is this target for Mach-O binaries. + +For shared libraries on Mach-O systems (e.g. macOS, iOS) +the ``MACHO_COMPATIBILITY_VERSION`` property corresponds to the +*compatibility version* and :prop_tgt:`MACHO_CURRENT_VERSION` corresponds to +the *current version*. These are both embedded in the shared library binary +and can be checked with the ``otool -L `` command. + +It should be noted that the :prop_tgt:`MACHO_CURRENT_VERSION` and +``MACHO_COMPATIBILITY_VERSION`` properties do not affect the file +names or version-related symlinks that CMake generates for the library. +The :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` target properties still +control the file and symlink names. The ``install_name`` is also still +controlled by :prop_tgt:`SOVERSION`. + +When :prop_tgt:`MACHO_CURRENT_VERSION` and ``MACHO_COMPATIBILITY_VERSION`` +are not given, :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` are used for +the version details to be embedded in the binaries respectively. +The :prop_tgt:`MACHO_CURRENT_VERSION` and ``MACHO_COMPATIBILITY_VERSION`` +properties only need to be given if the project needs to decouple the file +and symlink naming from the version details embedded in the binaries +(e.g. to match libtool conventions). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/MACHO_CURRENT_VERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/MACHO_CURRENT_VERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..530f79b1ad06f5dbeae6e5ef7a3cda99956e6ab9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/MACHO_CURRENT_VERSION.rst.txt @@ -0,0 +1,27 @@ +MACHO_CURRENT_VERSION +--------------------- + +.. versionadded:: 3.17 + +What current version number is this target for Mach-O binaries. + +For shared libraries on Mach-O systems (e.g. macOS, iOS) +the :prop_tgt:`MACHO_COMPATIBILITY_VERSION` property corresponds to the +*compatibility version* and ``MACHO_CURRENT_VERSION`` corresponds to the +*current version*. These are both embedded in the shared library binary +and can be checked with the ``otool -L `` command. + +It should be noted that the ``MACHO_CURRENT_VERSION`` and +:prop_tgt:`MACHO_COMPATIBILITY_VERSION` properties do not affect the file +names or version-related symlinks that CMake generates for the library. +The :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` target properties still +control the file and symlink names. The ``install_name`` is also still +controlled by :prop_tgt:`SOVERSION`. + +When ``MACHO_CURRENT_VERSION`` and :prop_tgt:`MACHO_COMPATIBILITY_VERSION` +are not given, :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` are used for +the version details to be embedded in the binaries respectively. +The ``MACHO_CURRENT_VERSION`` and :prop_tgt:`MACHO_COMPATIBILITY_VERSION` +properties only need to be given if the project needs to decouple the file +and symlink naming from the version details embedded in the binaries +(e.g. to match libtool conventions). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_BUNDLE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_BUNDLE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..92bce53eee6a04b7c3e42f51da647ea8843b3f08 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_BUNDLE.rst.txt @@ -0,0 +1,12 @@ +MACOSX_BUNDLE +------------- + +Build an executable as an Application Bundle on macOS or iOS. + +When this property is set to ``TRUE`` the executable when built on macOS +or iOS will be created as an application bundle. This makes it +a GUI executable that can be launched from the Finder. See the +:prop_tgt:`MACOSX_BUNDLE_INFO_PLIST` target property for information about +creation of the ``Info.plist`` file for the application bundle. +This property is initialized by the value of the variable +:variable:`CMAKE_MACOSX_BUNDLE` if it is set when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..443a645e4484f04a0574878a3e5809a767f96865 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst.txt @@ -0,0 +1,35 @@ +MACOSX_BUNDLE_INFO_PLIST +------------------------ + +Specify a custom ``Info.plist`` template for a macOS and iOS Application Bundle. + +An executable target with :prop_tgt:`MACOSX_BUNDLE` enabled will be built as an +application bundle on macOS. By default its ``Info.plist`` file is created +by configuring a template called ``MacOSXBundleInfo.plist.in`` located in the +:variable:`CMAKE_MODULE_PATH`. This property specifies an alternative template +file name which may be a full path. + +The following target properties may be set to specify content to be +configured into the file: + +``MACOSX_BUNDLE_BUNDLE_NAME`` + Sets ``CFBundleName``. +``MACOSX_BUNDLE_BUNDLE_VERSION`` + Sets ``CFBundleVersion``. +``MACOSX_BUNDLE_COPYRIGHT`` + Sets ``NSHumanReadableCopyright``. +``MACOSX_BUNDLE_GUI_IDENTIFIER`` + Sets ``CFBundleIdentifier``. +``MACOSX_BUNDLE_ICON_FILE`` + Sets ``CFBundleIconFile``. +``MACOSX_BUNDLE_INFO_STRING`` + Sets ``CFBundleGetInfoString``. +``MACOSX_BUNDLE_LONG_VERSION_STRING`` + Sets ``CFBundleLongVersionString``. +``MACOSX_BUNDLE_SHORT_VERSION_STRING`` + Sets ``CFBundleShortVersionString``. + +CMake variables of the same name may be set to affect all targets in a +directory that do not have each specific property set. If a custom +``Info.plist`` is specified by this property it may of course hard-code +all the settings instead of using the target properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a1f7c66607212efee8029cbda4b1186ac4059a3d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst.txt @@ -0,0 +1,35 @@ +MACOSX_FRAMEWORK_INFO_PLIST +--------------------------- + +Specify a custom ``Info.plist`` template for a macOS and iOS Framework. + +A library target with :prop_tgt:`FRAMEWORK` enabled will be built as a +framework on macOS. By default its ``Info.plist`` file is created by +configuring a template called ``MacOSXFrameworkInfo.plist.in`` located in the +:variable:`CMAKE_MODULE_PATH`. This property specifies an alternative template +file name which may be a full path. + +The following target properties may be set to specify content to be +configured into the file: + +``MACOSX_FRAMEWORK_BUNDLE_NAME`` + .. versionadded:: 3.31 + + Sets ``CFBundleName``. + +``MACOSX_FRAMEWORK_BUNDLE_VERSION`` + Sets ``CFBundleVersion``. + +``MACOSX_FRAMEWORK_ICON_FILE`` + Sets ``CFBundleIconFile``. + +``MACOSX_FRAMEWORK_IDENTIFIER`` + Sets ``CFBundleIdentifier``. + +``MACOSX_FRAMEWORK_SHORT_VERSION_STRING`` + Sets ``CFBundleShortVersionString``. + +CMake variables of the same name may be set to affect all targets in a +directory that do not have each specific property set. If a custom +``Info.plist`` is specified by this property it may of course hard-code +all the settings instead of using the target properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_RPATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_RPATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..acd5a7aa48b59cf6bcbade9f3040da0f162b9ae1 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/MACOSX_RPATH.rst.txt @@ -0,0 +1,23 @@ +MACOSX_RPATH +------------ + +Whether this target on macOS or iOS is located at runtime using rpaths. + +When this property is set to ``TRUE``, the directory portion of +the ``install_name`` field of this shared library will be ``@rpath`` +unless overridden by :prop_tgt:`INSTALL_NAME_DIR`. This indicates +the shared library is to be found at runtime using runtime +paths (rpaths). + +This property is initialized by the value of the variable +:variable:`CMAKE_MACOSX_RPATH` if it is set when a target is +created. + +Runtime paths will also be embedded in binaries using this target and +can be controlled by the :prop_tgt:`INSTALL_RPATH` target property on +the target linking to this target. + +Policy :policy:`CMP0042` was introduced to change the default value of +``MACOSX_RPATH`` to ``TRUE``. This is because use of ``@rpath`` is a +more flexible and powerful alternative to ``@executable_path`` and +``@loader_path``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/MANUALLY_ADDED_DEPENDENCIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/MANUALLY_ADDED_DEPENDENCIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..72871b3e6a39d3897a72922d156827a88f0d11cc --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/MANUALLY_ADDED_DEPENDENCIES.rst.txt @@ -0,0 +1,10 @@ +MANUALLY_ADDED_DEPENDENCIES +--------------------------- + +.. versionadded:: 3.8 + +Get manually added dependencies to other top-level targets. + +This read-only property can be used to query all dependencies that +were added for this target with the :command:`add_dependencies` +command. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..266ccf0787db6ec1daa95043185b03590c04fac9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst.txt @@ -0,0 +1,70 @@ +MAP_IMPORTED_CONFIG_ +---------------------------- + +Map from project configuration to +:ref:`imported target `'s configuration. + +Set this to the list of configurations of an imported target that may +be used for the current project's ```` configuration. Targets +imported from another project may not provide the same set of +configuration names available in the current project. Setting this +property tells CMake what imported configurations are suitable for use +when building the ```` configuration. The first configuration in +the list found to be provided by the imported target (i.e. via +:prop_tgt:`IMPORTED_LOCATION_` for the mapped-to ````) +is selected. As a special case, an empty list element refers to the +configuration-less imported target location +(i.e. :prop_tgt:`IMPORTED_LOCATION`). + +If this property is set and no matching configurations are available, +then the imported target is considered to be not found. This property +is ignored for non-imported targets. + +This property is initialized by the value of the +:variable:`CMAKE_MAP_IMPORTED_CONFIG_` variable if it is set when a +target is created. + +Example +^^^^^^^ + +For example creating imported C++ library ``foo``: + +.. code-block:: cmake + + add_library(foo STATIC IMPORTED) + +Use ``foo_debug`` path for ``Debug`` build type: + +.. code-block:: cmake + + set_property( + TARGET foo APPEND PROPERTY IMPORTED_CONFIGURATIONS DEBUG + ) + + set_target_properties(foo PROPERTIES + IMPORTED_LINK_INTERFACE_LANGUAGES_DEBUG "CXX" + IMPORTED_LOCATION_DEBUG "${foo_debug}" + ) + +Use ``foo_release`` path for ``Release`` build type: + +.. code-block:: cmake + + set_property( + TARGET foo APPEND PROPERTY IMPORTED_CONFIGURATIONS RELEASE + ) + + set_target_properties(foo PROPERTIES + IMPORTED_LINK_INTERFACE_LANGUAGES_RELEASE "CXX" + IMPORTED_LOCATION_RELEASE "${foo_release}" + ) + +Use ``Release`` version of library for ``MinSizeRel`` and ``RelWithDebInfo`` +build types: + +.. code-block:: cmake + + set_target_properties(foo PROPERTIES + MAP_IMPORTED_CONFIG_MINSIZEREL Release + MAP_IMPORTED_CONFIG_RELWITHDEBINFO Release + ) diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7e08b483c468c1b124907170d19746a2b75803e8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst.txt @@ -0,0 +1,35 @@ +MSVC_DEBUG_INFORMATION_FORMAT +----------------------------- + +.. versionadded:: 3.25 + +Select debug information format when targeting the MSVC ABI. + +The allowed values are: + +.. include:: MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt + +Use :manual:`generator expressions ` to +support per-configuration specification. For example, the code: + +.. code-block:: cmake + + add_executable(foo foo.c) + set_property(TARGET foo PROPERTY + MSVC_DEBUG_INFORMATION_FORMAT "$<$:ProgramDatabase>") + +selects for the target ``foo`` the program database debug information format +for the Debug configuration. + +This property is initialized from the value of the +:variable:`CMAKE_MSVC_DEBUG_INFORMATION_FORMAT` variable, if it is set. +If this property is not set, CMake selects a debug information format using +the default value ``$<$:ProgramDatabase>``, if +supported by the compiler, and otherwise +``$<$:Embedded>``. + +.. note:: + + This property has effect only when policy :policy:`CMP0141` is set to ``NEW`` + prior to the first :command:`project` or :command:`enable_language` command + that enables a language using a compiler targeting the MSVC ABI. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/MSVC_RUNTIME_LIBRARY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/MSVC_RUNTIME_LIBRARY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9f13d38a706231b351bcf7d040227f412ea62e90 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/MSVC_RUNTIME_LIBRARY.rst.txt @@ -0,0 +1,33 @@ +MSVC_RUNTIME_LIBRARY +-------------------- + +.. versionadded:: 3.15 + +Select the MSVC runtime library for use by compilers targeting the MSVC ABI. + +The allowed values are: + +.. include:: MSVC_RUNTIME_LIBRARY-VALUES.txt + +Use :manual:`generator expressions ` to +support per-configuration specification. For example, the code: + +.. code-block:: cmake + + add_executable(foo foo.c) + set_property(TARGET foo PROPERTY + MSVC_RUNTIME_LIBRARY "MultiThreaded$<$:Debug>") + +selects for the target ``foo`` a multi-threaded statically-linked runtime +library with or without debug information depending on the configuration. + +The property is initialized from the value of the +:variable:`CMAKE_MSVC_RUNTIME_LIBRARY` variable, if it is set. +If the property is not set, then CMake uses the default value +``MultiThreaded$<$:Debug>DLL`` to select a MSVC runtime library. + +.. note:: + + This property has effect only when policy :policy:`CMP0091` is set to ``NEW`` + prior to the first :command:`project` or :command:`enable_language` command + that enables a language using a compiler targeting the MSVC ABI. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ddd84f23c51ee72d058b872873a866455f1970b5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/NAME.rst.txt @@ -0,0 +1,6 @@ +NAME +---- + +Logical name for the target. + +Read-only logical name for the target as used by CMake. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/NO_SONAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/NO_SONAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d381a9c3b7be1044666c064918fe3ae24b337c34 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/NO_SONAME.rst.txt @@ -0,0 +1,14 @@ +NO_SONAME +--------- + +Whether to set ``soname`` when linking a shared library. + +Enable this boolean property if a generated ``SHARED`` library +should not have ``soname`` set. Default is to set ``soname`` on all +shared libraries as long as the platform supports it. +Generally, use this property only for leaf private libraries or +plugins. If you use it on normal shared libraries which other targets +link against, on some platforms a linker will insert a full path to +the library (as specified at link time) into the dynamic section of +the dependent binary. Therefore, once installed, dynamic loader may +eventually fail to locate the library for the binary. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..458618b7e7d25f77aebd2713fd4f0f6a62c99dfb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst.txt @@ -0,0 +1,29 @@ +NO_SYSTEM_FROM_IMPORTED +----------------------- + +Do not treat include directories from the interfaces of consumed +:ref:`imported targets` as system directories. + +When the consumed target's :prop_tgt:`SYSTEM` property is set to true, the +contents of the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` target property are +treated as system includes or, on Apple platforms, when the target is a +framework, it will be treated as system. By default, :prop_tgt:`SYSTEM` is +true for imported targets and false for other target types. If the +``NO_SYSTEM_FROM_IMPORTED`` property is set to true on a *consuming* target, +compilation of sources in that consuming target will not treat the contents of +the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` of consumed imported targets as +system includes, even if that imported target's :prop_tgt:`SYSTEM` property +is false. + +Directories listed in the :prop_tgt:`INTERFACE_SYSTEM_INCLUDE_DIRECTORIES` +property of consumed targets are not affected by ``NO_SYSTEM_FROM_IMPORTED``. +Those directories will always be treated as system include directories by +consumers. + +This property is initialized by the value of the +:variable:`CMAKE_NO_SYSTEM_FROM_IMPORTED` variable if it is set when a target +is created. + +See the :prop_tgt:`EXPORT_NO_SYSTEM` target property to set this behavior +on the target providing the include directories rather than the target +consuming them. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/OBJCXX_EXTENSIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/OBJCXX_EXTENSIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9a629fd92f4120bd7a357928108d0968275f3fec --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/OBJCXX_EXTENSIONS.rst.txt @@ -0,0 +1,24 @@ +OBJCXX_EXTENSIONS +----------------- + +.. versionadded:: 3.16 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu++11`` instead of ``-std=c++11`` to the compile line. This +property is ``ON`` by default. The basic ObjC++ standard level is +controlled by the :prop_tgt:`OBJCXX_STANDARD` target property. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +If the property is not set, and the project has set the :prop_tgt:`CXX_EXTENSIONS`, +the value of :prop_tgt:`CXX_EXTENSIONS` is set for ``OBJCXX_EXTENSIONS``. + +This property is initialized by the value of +the :variable:`CMAKE_OBJCXX_EXTENSIONS` variable if set when a target is +created and otherwise by the value of +:variable:`CMAKE_OBJCXX_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` +(see :policy:`CMP0128`). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/OBJCXX_STANDARD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/OBJCXX_STANDARD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..03108e133c695503d39ab2a4b3fa289c45433d66 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/OBJCXX_STANDARD.rst.txt @@ -0,0 +1,63 @@ +OBJCXX_STANDARD +--------------- + +.. versionadded:: 3.16 + +The ObjC++ standard whose features are requested to build this target. + +This property specifies the ObjC++ standard whose features are requested +to build this target. For some compilers, this results in adding a +flag such as ``-std=gnu++11`` to the compile line. + +Supported values are: + +``98`` + Objective C++98 + +``11`` + Objective C++11 + +``14`` + Objective C++14 + +``17`` + Objective C++17 + +``20`` + Objective C++20 + +``23`` + .. versionadded:: 3.20 + + Objective C++23 + +``26`` + .. versionadded:: 3.25 + + Objective C++26. CMake 3.25 and later *recognize* ``26`` as a valid value, + no version has support for any compiler. + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY OBJCXX_STANDARD 11) + +with a compiler which does not support ``-std=gnu++11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu++98`` flag if supported. This "decay" behavior may be controlled +with the :prop_tgt:`OBJCXX_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`OBJCXX_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +If the property is not set, and the project has set the :prop_tgt:`CXX_STANDARD`, +the value of :prop_tgt:`CXX_STANDARD` is set for ``OBJCXX_STANDARD``. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_OBJCXX_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2c3c77cd5e3847797a60f610ae18a985d3d8610c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst.txt @@ -0,0 +1,22 @@ +OBJCXX_STANDARD_REQUIRED +------------------------ + +.. versionadded:: 3.16 + +Boolean describing whether the value of :prop_tgt:`OBJCXX_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`OBJCXX_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`OBJCXX_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. + +If the property is not set, and the project has set the :prop_tgt:`CXX_STANDARD_REQUIRED`, +the value of :prop_tgt:`CXX_STANDARD_REQUIRED` is set for ``OBJCXX_STANDARD_REQUIRED``. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_OBJCXX_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/OBJC_EXTENSIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/OBJC_EXTENSIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2914045fb4d1f761a206dcb6c703afe4e729a7f0 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/OBJC_EXTENSIONS.rst.txt @@ -0,0 +1,24 @@ +OBJC_EXTENSIONS +--------------- + +.. versionadded:: 3.16 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu11`` instead of ``-std=c11`` to the compile line. This +property is ``ON`` by default. The basic OBJC standard level is +controlled by the :prop_tgt:`OBJC_STANDARD` target property. + +If the property is not set, and the project has set the :prop_tgt:`C_EXTENSIONS`, +the value of :prop_tgt:`C_EXTENSIONS` is set for ``OBJC_EXTENSIONS``. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_OBJC_EXTENSIONS` variable if set when a target is created +and otherwise by the value of +:variable:`CMAKE_OBJC_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` +(see :policy:`CMP0128`). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/OBJC_STANDARD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/OBJC_STANDARD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a3c56531308ce465b72fed548c5af503104347da --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/OBJC_STANDARD.rst.txt @@ -0,0 +1,56 @@ +OBJC_STANDARD +------------- + +.. versionadded:: 3.16 + +The OBJC standard whose features are requested to build this target. + +This property specifies the OBJC standard whose features are requested +to build this target. For some compilers, this results in adding a +flag such as ``-std=gnu11`` to the compile line. + +Supported values are: + +``90`` + Objective C89/C90 + +``99`` + Objective C99 + +``11`` + Objective C11 + +``17`` + .. versionadded:: 3.21 + + Objective C17 + +``23`` + .. versionadded:: 3.21 + + Objective C23 + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY OBJC_STANDARD 11) + +with a compiler which does not support ``-std=gnu11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu99`` or ``-std=gnu90`` flag if supported. This "decay" behavior may +be controlled with the :prop_tgt:`OBJC_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`OBJC_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +If the property is not set, and the project has set the :prop_tgt:`C_STANDARD`, +the value of :prop_tgt:`C_STANDARD` is set for ``OBJC_STANDARD``. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_OBJC_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/OBJC_STANDARD_REQUIRED.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/OBJC_STANDARD_REQUIRED.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8b0a9284d61bc195b241cd9b7eedf11028f4a465 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/OBJC_STANDARD_REQUIRED.rst.txt @@ -0,0 +1,22 @@ +OBJC_STANDARD_REQUIRED +---------------------- + +.. versionadded:: 3.16 + +Boolean describing whether the value of :prop_tgt:`OBJC_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`OBJC_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`OBJC_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. + +If the property is not set, and the project has set the :prop_tgt:`C_STANDARD_REQUIRED`, +the value of :prop_tgt:`C_STANDARD_REQUIRED` is set for ``OBJC_STANDARD_REQUIRED``. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_OBJC_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/OPTIMIZE_DEPENDENCIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/OPTIMIZE_DEPENDENCIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d17251f57a0aec7fce7fd7610afcd2eb4cad7a1f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/OPTIMIZE_DEPENDENCIES.rst.txt @@ -0,0 +1,43 @@ +OPTIMIZE_DEPENDENCIES +--------------------- + +.. versionadded:: 3.19 + +Activates dependency optimization of static and object libraries. + +When this property is set to true, some dependencies for a static or object +library may be removed at generation time if they are not necessary to build +the library, since static and object libraries don't actually link against +anything. + +If a static or object library has dependency optimization enabled, it first +discards all dependencies. Then, it looks through all of the direct and +indirect dependencies that it initially had, and adds them back if they meet +any of the following criteria: + +* The dependency was added to the library by :command:`add_dependencies`. +* The dependency was added to the library through a source file in the library + generated by a custom command that uses the dependency. +* The dependency has any ``PRE_BUILD``, ``PRE_LINK``, or ``POST_BUILD`` custom + commands associated with it. +* The dependency contains any source files that were generated by a custom + command. +* The dependency contains any languages which produce side effects that are + relevant to the library. Currently, all languages except C, C++, Objective-C, + Objective-C++, assembly, and CUDA are assumed to produce side effects. + However, side effects from one language are assumed not to be relevant to + another (for example, a Fortran library is assumed to not have any side + effects that are relevant for a Swift library.) + +As an example, assume you have a static Fortran library which depends on a +static C library, which in turn depends on a static Fortran library. The +top-level Fortran library has optimization enabled, but the middle C library +does not. If you build the top Fortran library, the bottom Fortran library will +also build, but not the middle C library, since the C library does not have any +side effects that are relevant for the Fortran library. However, if you build +the middle C library, the bottom Fortran library will also build, even though +it does not have any side effects that are relevant to the C library, since the +C library does not have optimization enabled. + +This property is initialized by the value of the +:variable:`CMAKE_OPTIMIZE_DEPENDENCIES` variable when the target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/OSX_ARCHITECTURES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/OSX_ARCHITECTURES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..996a4be7215fa943d312656da30343881b827bb6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/OSX_ARCHITECTURES.rst.txt @@ -0,0 +1,11 @@ +OSX_ARCHITECTURES +----------------- + +Target specific architectures for macOS. + +The ``OSX_ARCHITECTURES`` property sets the target binary architecture for +targets on macOS (``-arch``). This property is initialized by the value of the +variable :variable:`CMAKE_OSX_ARCHITECTURES` if it is set when a target is +created. Use :prop_tgt:`OSX_ARCHITECTURES_` to set the binary +architectures on a per-configuration basis, where ```` is an +upper-case name (e.g. ``OSX_ARCHITECTURES_DEBUG``). diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..06da4fb09dbf43e5bd46162bc914353853ff75a7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst.txt @@ -0,0 +1,7 @@ +OSX_ARCHITECTURES_ +-------------------------- + +Per-configuration macOS and iOS binary architectures for a target. + +This property is the configuration-specific version of +:prop_tgt:`OSX_ARCHITECTURES`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/OUTPUT_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/OUTPUT_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4b33b38e06bc2069fa20686b0b795e9fe9ddb2b1 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/OUTPUT_NAME.rst.txt @@ -0,0 +1,22 @@ +OUTPUT_NAME +----------- + +Output name for target files. + +This sets the base name for output files created for an executable or +library target. If not set, the logical target name is used by +default during generation. The value is not set by default during +configuration. + +Contents of ``OUTPUT_NAME`` and the variants listed below may use +:manual:`generator expressions `. + +See also the variants: + +* :prop_tgt:`OUTPUT_NAME_` +* :prop_tgt:`ARCHIVE_OUTPUT_NAME_` +* :prop_tgt:`ARCHIVE_OUTPUT_NAME` +* :prop_tgt:`LIBRARY_OUTPUT_NAME_` +* :prop_tgt:`LIBRARY_OUTPUT_NAME` +* :prop_tgt:`RUNTIME_OUTPUT_NAME_` +* :prop_tgt:`RUNTIME_OUTPUT_NAME` diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/OUTPUT_NAME_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/OUTPUT_NAME_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..41b782f98e0c20cf9512128a851e436c50c6041f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/OUTPUT_NAME_CONFIG.rst.txt @@ -0,0 +1,7 @@ +OUTPUT_NAME_ +-------------------- + +Per-configuration target file base name. + +This is the configuration-specific version of the :prop_tgt:`OUTPUT_NAME` +target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PCH_INSTANTIATE_TEMPLATES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PCH_INSTANTIATE_TEMPLATES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7c1af2acd3f64ec6914c212f641eebd30a532e30 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PCH_INSTANTIATE_TEMPLATES.rst.txt @@ -0,0 +1,13 @@ +PCH_INSTANTIATE_TEMPLATES +------------------------- + +.. versionadded:: 3.19 + +When this property is set to true, the precompiled header compiler options +will contain a flag to instantiate templates during the generation of the PCH +if supported. This can significantly improve compile times. Supported in Clang +since version 11. + +This property is initialized by the value of the +:variable:`CMAKE_PCH_INSTANTIATE_TEMPLATES` variable if it is set when a target +is created. If that variable is not set, the property defaults to ``ON``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PCH_WARN_INVALID.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PCH_WARN_INVALID.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2d5ec55caa82d759af0705bf758a317093c898aa --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PCH_WARN_INVALID.rst.txt @@ -0,0 +1,12 @@ +PCH_WARN_INVALID +---------------- + +.. versionadded:: 3.18 + +When this property is set to true, the precompile header compiler options +will contain a compiler flag which should warn about invalid precompiled +headers e.g. ``-Winvalid-pch`` for GNU compiler. + +This property is initialized by the value of the +:variable:`CMAKE_PCH_WARN_INVALID` variable if it is set when a target is +created. If that variable is not set, the property defaults to ``ON``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PDB_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PDB_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3a65796690817ba5f5cd8790842c6f953ecc65a3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PDB_NAME.rst.txt @@ -0,0 +1,12 @@ +PDB_NAME +-------- + +Output name for the MS debug symbol ``.pdb`` file generated by the +linker for an executable or shared library target. + +This property specifies the base name for the debug symbols file. +If not set, the :prop_tgt:`OUTPUT_NAME` target property value or +logical target name is used by default. + +.. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_NAME` +.. include:: PDB_NOTE.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PDB_NAME_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PDB_NAME_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..cb3121c2f38dccc0c0b94ff6a80c98ad8db5766f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PDB_NAME_CONFIG.rst.txt @@ -0,0 +1,10 @@ +PDB_NAME_ +----------------- + +Per-configuration output name for the MS debug symbol ``.pdb`` file +generated by the linker for an executable or shared library target. + +This is the configuration-specific version of :prop_tgt:`PDB_NAME`. + +.. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_NAME_` +.. include:: PDB_NOTE.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PDB_OUTPUT_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PDB_OUTPUT_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2f667f364eaa1e8d06961734eccfc0201525f619 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PDB_OUTPUT_DIRECTORY.rst.txt @@ -0,0 +1,19 @@ +PDB_OUTPUT_DIRECTORY +-------------------- + +Output directory for the MS debug symbols ``.pdb`` file +generated by the linker for an executable or shared library target. + +This property specifies the directory into which the MS debug symbols +will be placed by the linker. The property value may use +:manual:`generator expressions `. +Multi-configuration generators append a per-configuration +subdirectory to the specified directory unless a generator expression +is used. + +This property is initialized by the value of the +:variable:`CMAKE_PDB_OUTPUT_DIRECTORY` variable if it is +set when a target is created. + +.. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY` +.. include:: PDB_NOTE.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6c550831f213a09f876b783960ecd4ecc84c272b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst.txt @@ -0,0 +1,19 @@ +PDB_OUTPUT_DIRECTORY_ +----------------------------- + +Per-configuration output directory for the MS debug symbol ``.pdb`` file +generated by the linker for an executable or shared library target. + +This is a per-configuration version of :prop_tgt:`PDB_OUTPUT_DIRECTORY`, +but multi-configuration generators (:ref:`Visual Studio Generators`, +:generator:`Xcode`) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the +:variable:`CMAKE_PDB_OUTPUT_DIRECTORY_` variable if it is +set when a target is created. + +Contents of ``PDB_OUTPUT_DIRECTORY_`` may use +:manual:`generator expressions `. + +.. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY_` +.. include:: PDB_NOTE.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/POSITION_INDEPENDENT_CODE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/POSITION_INDEPENDENT_CODE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0aaf66bd0ef0c22fca53fce780b0ca72ddd3e29b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/POSITION_INDEPENDENT_CODE.rst.txt @@ -0,0 +1,16 @@ +POSITION_INDEPENDENT_CODE +------------------------- + +Whether to create a position-independent target + +The ``POSITION_INDEPENDENT_CODE`` property determines whether position +independent executables or shared libraries will be created. This +property is ``True`` by default for ``SHARED`` and ``MODULE`` library +targets and ``False`` otherwise. This property is initialized by the value +of the :variable:`CMAKE_POSITION_INDEPENDENT_CODE` variable if it is set +when a target is created. + +.. note:: + + For executable targets, the link step is controlled by the :policy:`CMP0083` + policy and the :module:`CheckPIESupported` module. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/POST_INSTALL_SCRIPT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/POST_INSTALL_SCRIPT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..23935bcdfdcbe9b6446842c2c14a0561545ffabd --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/POST_INSTALL_SCRIPT.rst.txt @@ -0,0 +1,9 @@ +POST_INSTALL_SCRIPT +------------------- + +Deprecated install support. + +The :prop_tgt:`PRE_INSTALL_SCRIPT` and ``POST_INSTALL_SCRIPT`` properties are +the old way to specify CMake scripts to run before and after installing a +target. They are used only when the old ``INSTALL_TARGETS`` command is +used to install the target. Use the :command:`install` command instead. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PRECOMPILE_HEADERS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PRECOMPILE_HEADERS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..af27947631cef6f240c4042b46df5aba272c5de5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PRECOMPILE_HEADERS.rst.txt @@ -0,0 +1,14 @@ +PRECOMPILE_HEADERS +------------------ + +.. versionadded:: 3.16 + +List of header files to precompile. + +This property holds a :ref:`semicolon-separated list ` +of header files to precompile specified so far for its target. +Use the :command:`target_precompile_headers` command to append more header +files. + +This property supports +:manual:`generator expressions `. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PRECOMPILE_HEADERS_REUSE_FROM.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PRECOMPILE_HEADERS_REUSE_FROM.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6f5635b4e482f04e6dc29de3b86a039d669e2db2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PRECOMPILE_HEADERS_REUSE_FROM.rst.txt @@ -0,0 +1,9 @@ +PRECOMPILE_HEADERS_REUSE_FROM +----------------------------- + +.. versionadded:: 3.16 + +Target from which to reuse the precompiled headers build artifact. + +See the second signature of :command:`target_precompile_headers` command +for more detailed information. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PREFIX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PREFIX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a40129268d4fe391fab6f801c2192a59824c9f96 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PREFIX.rst.txt @@ -0,0 +1,7 @@ +PREFIX +------ + +What comes before the library name. + +A target property that can be set to override the prefix (such as +``lib``) on a library name. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PRE_INSTALL_SCRIPT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PRE_INSTALL_SCRIPT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..43432f4d8dee52f638c94e4a2662cbef8d0c19a8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PRE_INSTALL_SCRIPT.rst.txt @@ -0,0 +1,9 @@ +PRE_INSTALL_SCRIPT +------------------ + +Deprecated install support. + +The ``PRE_INSTALL_SCRIPT`` and :prop_tgt:`POST_INSTALL_SCRIPT` properties are +the old way to specify CMake scripts to run before and after installing a +target. They are used only when the old ``INSTALL_TARGETS`` command is +used to install the target. Use the :command:`install` command instead. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PRIVATE_HEADER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PRIVATE_HEADER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..23e1f8e6f3bd30eb142a8eea3937e4e2b4b9ff5e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PRIVATE_HEADER.rst.txt @@ -0,0 +1,11 @@ +PRIVATE_HEADER +-------------- + +Specify private header files in a :prop_tgt:`FRAMEWORK` shared library target. + +Shared library targets marked with the :prop_tgt:`FRAMEWORK` property generate +frameworks on macOS, iOS and normal shared libraries on other platforms. +This property may be set to a list of header files to be placed in the +PrivateHeaders directory inside the framework folder. On non-Apple +platforms these headers may be installed using the ``PRIVATE_HEADER`` +option to the :command:`install(TARGETS)` command. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PROJECT_LABEL.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PROJECT_LABEL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a1491ee139892c74ac63339415402ca6e11dc714 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PROJECT_LABEL.rst.txt @@ -0,0 +1,7 @@ +PROJECT_LABEL +------------- + +Change the name of a target in an IDE. + +Can be used to change the name of the target in an IDE like Visual +Studio. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/PUBLIC_HEADER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/PUBLIC_HEADER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..915e39cd255a30f2b0482fcb923b51685867491a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/PUBLIC_HEADER.rst.txt @@ -0,0 +1,11 @@ +PUBLIC_HEADER +------------- + +Specify public header files in a :prop_tgt:`FRAMEWORK` shared library target. + +Shared library targets marked with the :prop_tgt:`FRAMEWORK` property generate +frameworks on macOS, iOS and normal shared libraries on other platforms. +This property may be set to a list of header files to be placed in the +``Headers`` directory inside the framework folder. On non-Apple platforms +these headers may be installed using the ``PUBLIC_HEADER`` option to the +:command:`install(TARGETS)` command. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/RESOURCE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/RESOURCE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e5a1cb677989da86ccb37420140a187b04401cd5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/RESOURCE.rst.txt @@ -0,0 +1,58 @@ +RESOURCE +-------- + +Specify resource files in a :prop_tgt:`FRAMEWORK` or :prop_tgt:`BUNDLE`. + +Target marked with the :prop_tgt:`FRAMEWORK` or :prop_tgt:`BUNDLE` property +generate framework or application bundle (both macOS and iOS is supported) +or normal shared libraries on other platforms. +This property may be set to a list of files to be placed in the corresponding +directory (eg. ``Resources`` directory for macOS) inside the bundle. +On non-Apple platforms these files may be installed using the ``RESOURCE`` +option to the :command:`install(TARGETS)` command. + +Following example of Application Bundle: + +.. code-block:: cmake + + add_executable(ExecutableTarget + addDemo.c + resourcefile.txt + appresourcedir/appres.txt) + + target_link_libraries(ExecutableTarget heymath mul) + + set(RESOURCE_FILES + resourcefile.txt + appresourcedir/appres.txt) + + set_target_properties(ExecutableTarget PROPERTIES + MACOSX_BUNDLE TRUE + MACOSX_FRAMEWORK_IDENTIFIER org.cmake.ExecutableTarget + RESOURCE "${RESOURCE_FILES}") + +will produce flat structure for iOS systems:: + + ExecutableTarget.app + appres.txt + ExecutableTarget + Info.plist + resourcefile.txt + +For macOS systems it will produce following directory structure:: + + ExecutableTarget.app/ + Contents + Info.plist + MacOS + ExecutableTarget + Resources + appres.txt + resourcefile.txt + +For Linux, such CMake script produce following files:: + + ExecutableTarget + Resources + appres.txt + resourcefile.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/RULE_LAUNCH_COMPILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/RULE_LAUNCH_COMPILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3f4305f21bb299c8e37f11222fe21e51b2bad0f1 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/RULE_LAUNCH_COMPILE.rst.txt @@ -0,0 +1,13 @@ +RULE_LAUNCH_COMPILE +------------------- + +Specify a launcher for compile rules. + +.. note:: + This property is intended for internal use by :manual:`ctest(1)`. Projects + and developers should use the :prop_tgt:`_COMPILER_LAUNCHER` target + properties or the associated :variable:`CMAKE__COMPILER_LAUNCHER` + variables instead. + +See the :prop_gbl:`global property ` of the same name +for details. This overrides the global and directory property for a target. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/RULE_LAUNCH_CUSTOM.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/RULE_LAUNCH_CUSTOM.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2db03177f815b7c02f932bd5bd89fc538bf60409 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/RULE_LAUNCH_CUSTOM.rst.txt @@ -0,0 +1,7 @@ +RULE_LAUNCH_CUSTOM +------------------ + +Specify a launcher for custom rules. + +See the global property of the same name for details. This overrides +the global and directory property for a target. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/RULE_LAUNCH_LINK.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/RULE_LAUNCH_LINK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..da93be259b8e5a0d02e2019d506663137fa7fbda --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/RULE_LAUNCH_LINK.rst.txt @@ -0,0 +1,13 @@ +RULE_LAUNCH_LINK +---------------- + +Specify a launcher for link rules. + +.. note:: + This property is intended for internal use by :manual:`ctest(1)`. Projects + and developers should use the :prop_tgt:`_LINKER_LAUNCHER` target + properties or the associated :variable:`CMAKE__LINKER_LAUNCHER` + variables instead. + +See the :prop_gbl:`global property ` of the same name for +details. This overrides the global and directory property for a target. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3c375463c9033e7bd72576267deee7806946b69a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst.txt @@ -0,0 +1,9 @@ +RUNTIME_OUTPUT_DIRECTORY +------------------------ + +.. |XXX| replace:: :ref:`RUNTIME ` +.. |xxx| replace:: runtime +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_RUNTIME_OUTPUT_DIRECTORY` +.. include:: XXX_OUTPUT_DIRECTORY.txt + +See also the :prop_tgt:`RUNTIME_OUTPUT_DIRECTORY_` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..67277548e099c8c8a97f0775eeabe48a32adac62 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst.txt @@ -0,0 +1,17 @@ +RUNTIME_OUTPUT_DIRECTORY_ +--------------------------------- + +Per-configuration output directory for +:ref:`RUNTIME ` target files. + +This is a per-configuration version of the +:prop_tgt:`RUNTIME_OUTPUT_DIRECTORY` target property, but +multi-configuration generators (:ref:`Visual Studio Generators`, +:generator:`Xcode`) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the +:variable:`CMAKE_RUNTIME_OUTPUT_DIRECTORY_` variable if +it is set when a target is created. + +Contents of ``RUNTIME_OUTPUT_DIRECTORY_`` may use +:manual:`generator expressions `. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..11729c3a59b6ba24259a716e2eb3e1dbef17ca37 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_NAME.rst.txt @@ -0,0 +1,8 @@ +RUNTIME_OUTPUT_NAME +------------------- + +.. |XXX| replace:: :ref:`RUNTIME ` +.. |xxx| replace:: runtime +.. include:: XXX_OUTPUT_NAME.txt + +See also the :prop_tgt:`RUNTIME_OUTPUT_NAME_` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b6a31bfdfe56288d8e42fd9e11609328545f5606 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst.txt @@ -0,0 +1,8 @@ +RUNTIME_OUTPUT_NAME_ +---------------------------- + +Per-configuration output name for +:ref:`RUNTIME ` target files. + +This is the configuration-specific version of the +:prop_tgt:`RUNTIME_OUTPUT_NAME` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/SKIP_BUILD_RPATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/SKIP_BUILD_RPATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..1fe170ca6bb9858f5240f2f8e469bcf776ae9aed --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/SKIP_BUILD_RPATH.rst.txt @@ -0,0 +1,10 @@ +SKIP_BUILD_RPATH +---------------- + +Should rpaths be used for the build tree. + +``SKIP_BUILD_RPATH`` is a boolean specifying whether to skip automatic +generation of an rpath allowing the target to run from the build tree, +see also the :prop_tgt:`BUILD_RPATH` target property. +This property is initialized by the value of the variable +:variable:`CMAKE_SKIP_BUILD_RPATH` if it is set when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/SOURCES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/SOURCES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..1688ef7063e10e40c12af946745ac4015ec4d907 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/SOURCES.rst.txt @@ -0,0 +1,38 @@ +SOURCES +------- + +This specifies the list of paths to source files for the target. +The following commands all set or add to the ``SOURCES`` target property +and are the usual way to manipulate it: + +* :command:`add_executable` +* :command:`add_library` +* :command:`add_custom_target` +* :command:`target_sources` + +Contents of ``SOURCES`` may use +:manual:`generator expressions `. +If a path starts with a generator expression, it is expected to +evaluate to an absolute path. Not doing so is considered undefined behavior. + +Paths that are for files generated by the build will be treated +as relative to the build directory of the target, if the path is not +already specified as an absolute path. Note that whether a file is seen as +generated may be affected by policies :policy:`CMP0118` and :policy:`CMP0163`. + +If a path does not start with a generator expression, is not an +absolute path and is not a generated file, it will be treated as relative to +the location selected by the first of the following that matches: + +* If a file by the specified path exists relative to the target's source + directory, use that file. +* If policy :policy:`CMP0115` is not set to ``NEW``, try appending each + known source file extension to the path and check if that exists + relative to the target's source directory. +* Repeat the above two steps, this time relative to the target's binary + directory instead. + +Note that the above decisions are made at generation time, not build time. + +See the :manual:`cmake-buildsystem(7)` manual for more on defining +buildsystem properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/SOURCE_DIR.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/SOURCE_DIR.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..78ce220ec79a37cd1e729b2a2bcdf4517b3a2568 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/SOURCE_DIR.rst.txt @@ -0,0 +1,8 @@ +SOURCE_DIR +---------- + +.. versionadded:: 3.4 + +This read-only property reports the value of the +:variable:`CMAKE_CURRENT_SOURCE_DIR` variable in the directory in which +the target was defined. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/SOVERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/SOVERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4f8b1b5389b0612d10b5a0e5ca67cb2c639be4cd --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/SOVERSION.rst.txt @@ -0,0 +1,39 @@ +SOVERSION +--------- + +ABI version number of a shared library target. + +For shared libraries :prop_tgt:`VERSION` and ``SOVERSION`` can be used to +specify the build version and ABI version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. +``SOVERSION`` is ignored if :prop_tgt:`NO_SONAME` property is set. + +.. include:: VERSION_SOVERSION_EXAMPLE.txt + +Windows Versions +^^^^^^^^^^^^^^^^ + +For shared libraries and executables on Windows the :prop_tgt:`VERSION` +attribute is parsed to extract a ``.`` version number. +These numbers are used as the image version of the binary. + +Mach-O Versions +^^^^^^^^^^^^^^^ + +For shared libraries and executables on Mach-O systems (e.g. macOS, iOS), +the ``SOVERSION`` property corresponds to the *compatibility version* and +:prop_tgt:`VERSION` corresponds to the *current version* (unless Mach-O +specific overrides are provided, as discussed below). +See the :prop_tgt:`FRAMEWORK` target property for an example. + +For shared libraries, the :prop_tgt:`MACHO_COMPATIBILITY_VERSION` and +:prop_tgt:`MACHO_CURRENT_VERSION` properties can be used to +override the *compatibility version* and *current version* respectively. +Note that ``SOVERSION`` will still be used to form the ``install_name`` +and both ``SOVERSION`` and :prop_tgt:`VERSION` may also affect the file +and symlink names. + +Versions of Mach-O binaries may be checked with the ``otool -L `` +command. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/STATIC_LIBRARY_FLAGS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/STATIC_LIBRARY_FLAGS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..66e0e8b96a9ebed3b320e447dae936f6651869ad --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/STATIC_LIBRARY_FLAGS.rst.txt @@ -0,0 +1,17 @@ +STATIC_LIBRARY_FLAGS +-------------------- + +Archiver (or MSVC librarian) flags for a static library target. +Targets that are shared libraries, modules, or executables need to use +the :prop_tgt:`LINK_OPTIONS` or :prop_tgt:`LINK_FLAGS` target properties. + +The ``STATIC_LIBRARY_FLAGS`` property, managed as a string, can be used to add +extra flags to the link step of a static library target. +:prop_tgt:`STATIC_LIBRARY_FLAGS_` will add to the configuration +````, for example, ``DEBUG``, ``RELEASE``, ``MINSIZEREL``, +``RELWITHDEBINFO``, ... + +.. note:: + + This property has been superseded by :prop_tgt:`STATIC_LIBRARY_OPTIONS` + property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5b97941dacb9ddf9c6f4db4246030fae7a8718a4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst.txt @@ -0,0 +1,12 @@ +STATIC_LIBRARY_FLAGS_ +----------------------------- + +Per-configuration archiver (or MSVC librarian) flags for a static library +target. + +This is the configuration-specific version of :prop_tgt:`STATIC_LIBRARY_FLAGS`. + +.. note:: + + This property has been superseded by :prop_tgt:`STATIC_LIBRARY_OPTIONS` + property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/STATIC_LIBRARY_OPTIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/STATIC_LIBRARY_OPTIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f5d943723ba9c1dfdd5759490d189930624d07c2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/STATIC_LIBRARY_OPTIONS.rst.txt @@ -0,0 +1,24 @@ +STATIC_LIBRARY_OPTIONS +---------------------- + +.. versionadded:: 3.13 + +Archiver (or MSVC librarian) flags for a static library target. +Targets that are shared libraries, modules, or executables need to use +the :prop_tgt:`LINK_OPTIONS` target property. + +This property holds a :ref:`semicolon-separated list ` of options +specified so far for its target. Use :command:`set_target_properties` or +:command:`set_property` commands to set its content. + +Contents of ``STATIC_LIBRARY_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)` manual +for more on defining buildsystem properties. + +.. note:: + + This property must be used in preference to :prop_tgt:`STATIC_LIBRARY_FLAGS` + property. + +.. include:: ../command/OPTIONS_SHELL.txt diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/SUFFIX.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/SUFFIX.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..32ec42910fb87cec3479c7a7b7b706f118adb2bf --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/SUFFIX.rst.txt @@ -0,0 +1,7 @@ +SUFFIX +------ + +What comes after the target name. + +A target property that can be set to override the suffix (such as +``.so`` or ``.exe``) on the name of a library, module or executable. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/SYSTEM.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/SYSTEM.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f5c11bcb8b0c508ef340854e1efb00b22ad067a4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/SYSTEM.rst.txt @@ -0,0 +1,26 @@ +SYSTEM +------ + +.. versionadded:: 3.25 + +Specifies that a target is a system target. This has the following +effects: + +* Entries of :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` are treated as + system include directories when compiling consumers. + Entries of :prop_tgt:`INTERFACE_SYSTEM_INCLUDE_DIRECTORIES` are not + affected, and will always be treated as system include directories. +* On Apple platforms, If the :prop_tgt:`FRAMEWORK` target property is true, + the frameworks directory is treated as system. + +For imported targets, this property defaults to true, which means +that their :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` and, if the +:prop_tgt:`FRAMEWORK` target property is true, frameworks directory are +treated as system directories by default. If their ``SYSTEM`` property is +false, then their :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` as well as +frameworks will not be treated as system. Use the :prop_tgt:`EXPORT_NO_SYSTEM` +property to change how a target's ``SYSTEM`` property is set when it is +installed. + +For non-imported targets, this target property is initialized from +the :prop_dir:`SYSTEM` directory property when the target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/Swift_COMPILATION_MODE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/Swift_COMPILATION_MODE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e26474a711c2a8b5c09377d98c066cff1336b474 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/Swift_COMPILATION_MODE.rst.txt @@ -0,0 +1,33 @@ +Swift_COMPILATION_MODE +---------------------- + +.. versionadded:: 3.29 + +Specify how Swift compiles a target. + +The allowed values are: + +.. include:: Swift_COMPILATION_MODE-VALUES.txt + +Use :manual:`generator expressions ` to support +per-configuration specification. For example, the code: + +.. code-block:: cmake + + add_library(foo foo.swift) + set_property(TARGET foo PROPERTY + Swift_COMPILATION_MODE "$,wholemodule,incremental>") + +sets the Swift compilation mode to wholemodule mode in the release configuration +and sets the property to incremental mode in other configurations. + +The property is initialized from the value of the +:variable:`CMAKE_Swift_COMPILATION_MODE` variable, if it is set. If the property +is not set or is empty, then CMake uses the default value ``incremental`` to +specify the swift compilation mode. + +.. note:: + + This property only has effect when policy :policy:`CMP0157` is set to ``NEW`` + prior to the first :command:`project` or :command:`enable_language` command + that enables the Swift language. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/Swift_DEPENDENCIES_FILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/Swift_DEPENDENCIES_FILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0f944b60a90c98d433368673d7721d09fbbda02b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/Swift_DEPENDENCIES_FILE.rst.txt @@ -0,0 +1,7 @@ +Swift_DEPENDENCIES_FILE +----------------------- + +.. versionadded:: 3.15 + +This property sets the path for the Swift dependency file (swiftdep) for the +target. If one is not specified, it will default to ``.swiftdeps``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/Swift_LANGUAGE_VERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/Swift_LANGUAGE_VERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d1d80a86e5849d76d5acc1bba7290a3588c8acfb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/Swift_LANGUAGE_VERSION.rst.txt @@ -0,0 +1,9 @@ +Swift_LANGUAGE_VERSION +---------------------- + +.. versionadded:: 3.16 + +This property sets the language version for the Swift sources in the target. If +one is not specified, it will default to +:variable:`CMAKE_Swift_LANGUAGE_VERSION` if specified, otherwise it is the +latest version supported by the compiler. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/Swift_MODULE_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/Swift_MODULE_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..77f8311a897990aed6fa834fccf0f8ba3b43adad --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/Swift_MODULE_DIRECTORY.rst.txt @@ -0,0 +1,24 @@ +Swift_MODULE_DIRECTORY +---------------------- + +.. versionadded:: 3.15 + +Specify output directory for Swift modules provided by the target. + +If the target contains Swift source files, this specifies the directory in which +the modules will be placed. When this property is not set, the modules will be +placed in the build directory corresponding to the target's source directory. +If the variable :variable:`CMAKE_Swift_MODULE_DIRECTORY` is set when a target is +created its value is used to initialize this property. + +.. warning:: + + This property does not currently provide a way to express per-config + module directories, so use with multi-config generators is problematic: + + * The :generator:`Xcode` generator does not implement the property at all. + + * The :generator:`Ninja Multi-Config` generator implements this property, + but module files generated for different build configurations have the + same path, which can lead to subtle problems when building more than + one configuration. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/Swift_MODULE_NAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/Swift_MODULE_NAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d941b5430440b26f15f10fd96bd2eef291638c68 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/Swift_MODULE_NAME.rst.txt @@ -0,0 +1,7 @@ +Swift_MODULE_NAME +----------------- + +.. versionadded:: 3.15 + +This property specifies the name of the Swift module. It is defaulted to the +name of the target. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/TEST_LAUNCHER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/TEST_LAUNCHER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..7eec3192b3be7740db9f5557694b2a2f8fe01478 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/TEST_LAUNCHER.rst.txt @@ -0,0 +1,23 @@ +TEST_LAUNCHER +------------- + +.. versionadded:: 3.29 + +Use the given launcher to run executables. +This command will be added as a prefix to :command:`add_test` commands +for build target system executables and is meant to be run on the host +machine. + +It effectively acts as a run script for tests in a similar way +to how :variable:`CMAKE__COMPILER_LAUNCHER` works for compilation. + +If this property contains a :ref:`semicolon-separated list `, then the first value is the command and remaining values are its +arguments. + +Contents of ``TEST_LAUNCHER`` may use +:manual:`generator expressions `. + +This property is initialized by the value of the +:variable:`CMAKE_TEST_LAUNCHER` variable if it is set when a target +is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/TRANSITIVE_COMPILE_PROPERTIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/TRANSITIVE_COMPILE_PROPERTIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b190f3ba23df1a4c7be7f388ffa812244d51c12a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/TRANSITIVE_COMPILE_PROPERTIES.rst.txt @@ -0,0 +1,19 @@ +TRANSITIVE_COMPILE_PROPERTIES +----------------------------- + +.. versionadded:: 3.30 + +Properties that the :genex:`TARGET_PROPERTY` generator expression, on the +target and its dependents, evaluates as the union of values collected from +the transitive closure of link dependencies, excluding entries guarded by +:genex:`LINK_ONLY`. + +The value is a :ref:`semicolon-separated list ` +of :ref:`custom transitive property ` names. +Any leading ``INTERFACE_`` prefix is ignored, e.g., ``INTERFACE_PROP`` is +treated as just ``PROP``. + +See documentation of the :genex:`TARGET_PROPERTY` generator expression +for details of custom transitive property evaluation. See also the +:prop_tgt:`TRANSITIVE_LINK_PROPERTIES` target property, which includes +entries guarded by :genex:`LINK_ONLY`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/TRANSITIVE_LINK_PROPERTIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/TRANSITIVE_LINK_PROPERTIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..adb5808a3d268cf70ef25f6a391758cec1360f6d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/TRANSITIVE_LINK_PROPERTIES.rst.txt @@ -0,0 +1,19 @@ +TRANSITIVE_LINK_PROPERTIES +-------------------------- + +.. versionadded:: 3.30 + +Properties that the :genex:`TARGET_PROPERTY` generator expression, on the +target and its dependents, evaluates as the union of values collected from +the transitive closure of link dependencies, including entries guarded by +:genex:`LINK_ONLY`. + +The value is a :ref:`semicolon-separated list ` +of :ref:`custom transitive property ` names. +Any leading ``INTERFACE_`` prefix is ignored, e.g., ``INTERFACE_PROP`` is +treated as just ``PROP``. + +See documentation of the :genex:`TARGET_PROPERTY` generator expression +for details of custom transitive property evaluation. See also the +:prop_tgt:`TRANSITIVE_COMPILE_PROPERTIES` target property, which excludes +entries guarded by :genex:`LINK_ONLY`.. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/TYPE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/TYPE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3136d119d26d1971d89ed65f664ec7370096e48e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/TYPE.rst.txt @@ -0,0 +1,9 @@ +TYPE +---- + +The type of the target. + +This read-only property can be used to test the type of the given +target. It will be one of ``STATIC_LIBRARY``, ``MODULE_LIBRARY``, +``SHARED_LIBRARY``, ``OBJECT_LIBRARY``, ``INTERFACE_LIBRARY``, ``EXECUTABLE`` +or one of the internal target types. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ee001713e0f604c41dec20abe777921c81ebdb07 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD.rst.txt @@ -0,0 +1,107 @@ +UNITY_BUILD +----------- + +.. versionadded:: 3.16 + +When this property is set to true, the target source files will be combined +into batches for faster compilation. This is done by creating a (set of) +unity sources which ``#include`` the original sources, then compiling these +unity sources instead of the originals. This is known as a *Unity* or *Jumbo* +build. + +CMake provides different algorithms for selecting which sources are grouped +together into a *bucket*. Algorithm selection is decided by the +:prop_tgt:`UNITY_BUILD_MODE` target property, which has the following acceptable +values: + +* ``BATCH`` + When in this mode CMake determines which files are grouped together. + The :prop_tgt:`UNITY_BUILD_BATCH_SIZE` property controls the upper limit on + how many sources can be combined per unity source file. + +* ``GROUP`` + When in this mode each target explicitly specifies how to group + source files. Each source file that has the same + :prop_sf:`UNITY_GROUP` value will be grouped together. Any sources + that don't have this property will be compiled individually. The + :prop_tgt:`UNITY_BUILD_BATCH_SIZE` property is ignored when using + this mode. + +If no explicit :prop_tgt:`UNITY_BUILD_MODE` has been specified, CMake will +default to ``BATCH``. + +Unity builds are supported for the following languages: + +``C`` + .. versionadded:: 3.16 + +``CXX`` + .. versionadded:: 3.16 + +``CUDA`` + .. versionadded:: 3.31 + +``OBJC`` + .. versionadded:: 3.29 + +``OBJCXX`` + .. versionadded:: 3.29 + +For targets that mix source files from more than one language, CMake +separates the languages such that each generated unity source file only +contains sources for a single language. + +This property is initialized by the value of the :variable:`CMAKE_UNITY_BUILD` +variable when a target is created. + +.. note:: + + Projects should not directly set the ``UNITY_BUILD`` property or its + associated :variable:`CMAKE_UNITY_BUILD` variable to true. Depending + on the capabilities of the build machine and compiler used, it might or + might not be appropriate to enable unity builds. Therefore, this feature + should be under developer control, which would normally be through the + developer choosing whether or not to set the :variable:`CMAKE_UNITY_BUILD` + variable on the :manual:`cmake(1)` command line or some other equivalent + method. However, it IS recommended to set the ``UNITY_BUILD`` target + property to false if it is known that enabling unity builds for the + target can lead to problems. + +ODR (One definition rule) errors +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +When multiple source files are included into one source file, as is done +for unity builds, it can potentially lead to ODR errors. CMake provides +a number of measures to help address such problems: + +* Any source file that has a non-empty :prop_sf:`COMPILE_OPTIONS`, + :prop_sf:`COMPILE_DEFINITIONS`, :prop_sf:`COMPILE_FLAGS`, or + :prop_sf:`INCLUDE_DIRECTORIES` source property will not be combined + into a unity source. + +* Any source file which is scanned for C++ module sources via + :prop_tgt:`CXX_SCAN_FOR_MODULES`, :prop_sf:`CXX_SCAN_FOR_MODULES`, or + membership of a ``CXX_MODULES`` file set will not be combined into a unity + source. See :manual:`cmake-cxxmodules(7)` for details. + +* Projects can prevent an individual source file from being combined into + a unity source by setting its :prop_sf:`SKIP_UNITY_BUILD_INCLUSION` + source property to true. This can be a more effective way to prevent + problems with specific files than disabling unity builds for an entire + target. + +* Projects can set :prop_tgt:`UNITY_BUILD_UNIQUE_ID` to cause a valid + C-identifier to be generated which is unique per file in a unity + build. This can be used to avoid problems with anonymous namespaces + in unity builds. + +* The :prop_tgt:`UNITY_BUILD_CODE_BEFORE_INCLUDE` and + :prop_tgt:`UNITY_BUILD_CODE_AFTER_INCLUDE` target properties can be used + to inject code into the unity source files before and after every + ``#include`` statement. + +* The order of source files added to the target via commands like + :command:`add_library`, :command:`add_executable` or + :command:`target_sources` will be preserved in the generated unity source + files. This can be used to manually enforce a specific grouping based on + the :prop_tgt:`UNITY_BUILD_BATCH_SIZE` target property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_BATCH_SIZE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_BATCH_SIZE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3886ec992a8c5d58cb6ab238d4de33b9cb124a5c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_BATCH_SIZE.rst.txt @@ -0,0 +1,25 @@ +UNITY_BUILD_BATCH_SIZE +---------------------- + +.. versionadded:: 3.16 + +Specifies the maximum number of source files that can be combined into any one +unity source file when unity builds are enabled by the :prop_tgt:`UNITY_BUILD` +target property. The original source files will be distributed across as many +unity source files as necessary to honor this limit. + +The initial value for this property is taken from the +:variable:`CMAKE_UNITY_BUILD_BATCH_SIZE` variable when the target is created. +If that variable has not been set, the initial value will be 8. + +The batch size needs to be selected carefully. If set too high, the size of +the combined source files could result in the compiler using excessive memory +or hitting other similar limits. In extreme cases, this can even result in +build failure. On the other hand, if the batch size is too low, there will be +little gain in build performance. + +Although strongly discouraged, the batch size may be set to a value of 0 to +combine all the sources for the target into a single unity file, regardless of +how many sources are involved. This runs the risk of creating an excessively +large unity source file and negatively impacting the build performance, so +a value of 0 is not generally recommended. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_CODE_AFTER_INCLUDE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_CODE_AFTER_INCLUDE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ac2b19c212a572b006e8962a01b87e575fe26bbb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_CODE_AFTER_INCLUDE.rst.txt @@ -0,0 +1,21 @@ +UNITY_BUILD_CODE_AFTER_INCLUDE +------------------------------ + +.. versionadded:: 3.16 + +Code snippet which is included verbatim by the :prop_tgt:`UNITY_BUILD` +feature just after every ``#include`` statement in the generated unity +source files. For example: + +.. code-block:: cmake + + set(after [[ + #if defined(NOMINMAX) + #undef NOMINMAX + #endif + ]]) + set_target_properties(myTarget PROPERTIES + UNITY_BUILD_CODE_AFTER_INCLUDE "${after}" + ) + +See also :prop_tgt:`UNITY_BUILD_CODE_BEFORE_INCLUDE`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_CODE_BEFORE_INCLUDE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_CODE_BEFORE_INCLUDE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6f0d56b721a5989cc223184e4674c40fbae6cb66 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_CODE_BEFORE_INCLUDE.rst.txt @@ -0,0 +1,21 @@ +UNITY_BUILD_CODE_BEFORE_INCLUDE +------------------------------- + +.. versionadded:: 3.16 + +Code snippet which is included verbatim by the :prop_tgt:`UNITY_BUILD` +feature just before every ``#include`` statement in the generated unity +source files. For example: + +.. code-block:: cmake + + set(before [[ + #if !defined(NOMINMAX) + #define NOMINMAX + #endif + ]]) + set_target_properties(myTarget PROPERTIES + UNITY_BUILD_CODE_BEFORE_INCLUDE "${before}" + ) + +See also :prop_tgt:`UNITY_BUILD_CODE_AFTER_INCLUDE`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_MODE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_MODE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d3d1fccbba857ca1dfc6883d3e178f81410fa240 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_MODE.rst.txt @@ -0,0 +1,60 @@ +UNITY_BUILD_MODE +---------------- + +.. versionadded:: 3.18 + +CMake provides different algorithms for selecting which sources are grouped +together into a *bucket*. Selection is decided by this property, +which has the following acceptable values: + +``BATCH`` + When in this mode CMake determines which files are grouped together. + The :prop_tgt:`UNITY_BUILD_BATCH_SIZE` property controls the upper limit on + how many sources can be combined per unity source file. + + Example usage: + + .. code-block:: cmake + + add_library(example_library + source1.cxx + source2.cxx + source3.cxx + source4.cxx) + + set_target_properties(example_library PROPERTIES + UNITY_BUILD_MODE BATCH + UNITY_BUILD_BATCH_SIZE 2 + ) + +``GROUP`` + When in this mode each target explicitly specifies how to group + source files. Each source file that has the same + :prop_sf:`UNITY_GROUP` value will be grouped together. Any sources + that don't have this property will be compiled individually. The + :prop_tgt:`UNITY_BUILD_BATCH_SIZE` property is ignored when using + this mode. + + Example usage: + + .. code-block:: cmake + + add_library(example_library + source1.cxx + source2.cxx + source3.cxx + source4.cxx) + + set_target_properties(example_library PROPERTIES + UNITY_BUILD_MODE GROUP + ) + + set_source_files_properties(source1.cxx source2.cxx source3.cxx + PROPERTIES UNITY_GROUP "bucket1" + ) + set_source_files_properties(source4.cxx + PROPERTIES UNITY_GROUP "bucket2" + ) + +If no explicit ``UNITY_BUILD_MODE`` has been specified, CMake will +default to ``BATCH``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_UNIQUE_ID.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_UNIQUE_ID.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d288dd3b4fbce448777b8311f9cfd4987fc0c2ff --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/UNITY_BUILD_UNIQUE_ID.rst.txt @@ -0,0 +1,55 @@ +UNITY_BUILD_UNIQUE_ID +--------------------- + +.. versionadded:: 3.20 + +The name of a valid C-identifier which is set to a unique per-file +value during unity builds. + +When this property is populated and when :prop_tgt:`UNITY_BUILD` +is true, the property value is used to define a compiler definition +of the specified name. The value of the defined symbol is unspecified, +but it is unique per file path. + +Given: + +.. code-block:: cmake + + set_target_properties(myTarget PROPERTIES + UNITY_BUILD "ON" + UNITY_BUILD_UNIQUE_ID "MY_UNITY_ID" + ) + +the ``MY_UNITY_ID`` symbol is defined to a unique per-file value. + +One known use case for this identifier is to disambiguate the +variables in an anonymous namespace in a limited scope. +Anonymous namespaces present a problem for unity builds because +they are used to ensure that certain variables and declarations +are scoped to a translation unit which is approximated by a +single source file. When source files are combined in a unity +build file, those variables in different files are combined in +a single translation unit and the names clash. This property can +be used to avoid that with code like the following: + +.. code-block:: cpp + + // Needed for when unity builds are disabled + #ifndef MY_UNITY_ID + #define MY_UNITY_ID + #endif + + namespace { namespace MY_UNITY_ID { + // The name 'i' clashes (or could clash) with other + // variables in other anonymous namespaces + int i = 42; + }} + + int use_var() + { + return MY_UNITY_ID::i; + } + +The pseudonymous namespace is used within a truly anonymous namespace. +On many platforms, this maintains the invariant that the symbols within +do not get external linkage when performing a unity build. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VERIFY_INTERFACE_HEADER_SETS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VERIFY_INTERFACE_HEADER_SETS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..bdd7792e472e9e8e6bd75a5e9a383a2bb8b8b1e3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VERIFY_INTERFACE_HEADER_SETS.rst.txt @@ -0,0 +1,41 @@ +VERIFY_INTERFACE_HEADER_SETS +---------------------------- + +.. versionadded:: 3.24 + +Used to verify that all headers in a target's ``PUBLIC`` and ``INTERFACE`` +header sets can be included on their own. + +When this property is set to true, and the target is an object library, static +library, shared library, interface library, or executable with exports enabled, +and the target has one or more ``PUBLIC`` or ``INTERFACE`` header sets, an +object library target named ``_verify_interface_header_sets`` is +created. This verification target has one source file per header in the +``PUBLIC`` and ``INTERFACE`` header sets. Each source file only includes its +associated header file. The verification target links against the original +target to get all of its usage requirements. The verification target has its +:prop_tgt:`EXCLUDE_FROM_ALL` and :prop_tgt:`DISABLE_PRECOMPILE_HEADERS` +properties set to true, and its :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTORCC`, +:prop_tgt:`AUTOUIC`, and :prop_tgt:`UNITY_BUILD` properties set to false. + +If the header's :prop_sf:`LANGUAGE` property is set, the value of that property +is used to determine the language with which to compile the header file. +Otherwise, if the target has any C++ sources, the header is compiled as C++. +Otherwise, if the target has any C sources, the header is compiled as C. +Otherwise, if C++ is enabled globally, the header is compiled as C++. +Otherwise, if C is enabled globally, the header is compiled as C. Otherwise, +the header file is not compiled. + +If the header's :prop_sf:`SKIP_LINTING` property is set to true, the file is +not compiled. + +If any verification targets are created, a top-level target called +``all_verify_interface_header_sets`` is created which depends on all +verification targets. + +This property is initialized by the value of the +:variable:`CMAKE_VERIFY_INTERFACE_HEADER_SETS` variable if it is set when +a target is created. + +If the project wishes to control which header sets are verified by this +property, it can set :prop_tgt:`INTERFACE_HEADER_SETS_TO_VERIFY`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f9cb020fe31c5f19e84e67de5c4cf143daa823ad --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VERSION.rst.txt @@ -0,0 +1,41 @@ +VERSION +------- + +Version number of a shared library target. + +For shared libraries ``VERSION`` and :prop_tgt:`SOVERSION` can be used +to specify the build version and ABI version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. For +executables ``VERSION`` can be used to specify the build version. When +building or installing appropriate symlinks are created if the +platform supports symlinks. + +.. include:: VERSION_SOVERSION_EXAMPLE.txt + +Windows Versions +^^^^^^^^^^^^^^^^ + +For shared libraries and executables on Windows the ``VERSION`` +attribute is parsed to extract a ``.`` version number. +These numbers are used as the image version of the binary. + +Mach-O Versions +^^^^^^^^^^^^^^^ + +For shared libraries and executables on Mach-O systems (e.g. macOS, iOS), +the :prop_tgt:`SOVERSION` property corresponds to the *compatibility version* +and ``VERSION`` corresponds to the *current version* (unless Mach-O specific +overrides are provided, as discussed below). +See the :prop_tgt:`FRAMEWORK` target property for an example. + +For shared libraries, the :prop_tgt:`MACHO_COMPATIBILITY_VERSION` and +:prop_tgt:`MACHO_CURRENT_VERSION` properties can be used to +override the *compatibility version* and *current version* respectively. +Note that :prop_tgt:`SOVERSION` will still be used to form the +``install_name`` and both :prop_tgt:`SOVERSION` and ``VERSION`` may also +affect the file and symlink names. + +Versions of Mach-O binaries may be checked with the ``otool -L `` +command. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..adbbc7103f9ba1d33bc326c4319820f4419af569 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst.txt @@ -0,0 +1,13 @@ +VISIBILITY_INLINES_HIDDEN +------------------------- + +Whether to add a compile flag to hide symbols of inline functions + +The ``VISIBILITY_INLINES_HIDDEN`` property determines whether a flag for +hiding symbols for inline functions, such as ``-fvisibility-inlines-hidden``, +should be used when invoking the compiler. This property affects compilation +in sources of all types of targets (subject to policy :policy:`CMP0063`). + +This property is initialized by +the value of the :variable:`CMAKE_VISIBILITY_INLINES_HIDDEN` variable if it +is set when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_CONFIGURATION_TYPE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_CONFIGURATION_TYPE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4adffd4f23dc67475710b64376ed75abecdaad7e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_CONFIGURATION_TYPE.rst.txt @@ -0,0 +1,14 @@ +VS_CONFIGURATION_TYPE +--------------------- + +.. versionadded:: 3.6 + +Visual Studio project configuration type. + +Sets the ``ConfigurationType`` attribute for a generated Visual Studio project. +The property value may use +:manual:`generator expressions `. +If this property is set, it overrides the default setting that is based on the +target type (e.g. ``StaticLibrary``, ``Application``, ...). + +Supported on :ref:`Visual Studio Generators` for VS 2010 and higher. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_COMMAND.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_COMMAND.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..75ff8502acd65555387f6eaf8056d4ecec10cec9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_COMMAND.rst.txt @@ -0,0 +1,15 @@ +VS_DEBUGGER_COMMAND +------------------- + +.. versionadded:: 3.12 + +Sets the local debugger command for Visual Studio C++ targets. +The property value may use +:manual:`generator expressions `. +This is defined in ```` in the Visual Studio +project file. This property is initialized by the value of the variable +:variable:`CMAKE_VS_DEBUGGER_COMMAND` if it is set when a target is +created. + +This property only works for :ref:`Visual Studio Generators`; +it is ignored on other generators. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_COMMAND_ARGUMENTS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_COMMAND_ARGUMENTS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f49cb7064ee641483673e3562f971d8bb50027e8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_COMMAND_ARGUMENTS.rst.txt @@ -0,0 +1,15 @@ +VS_DEBUGGER_COMMAND_ARGUMENTS +----------------------------- + +.. versionadded:: 3.13 + +Sets the local debugger command line arguments for Visual Studio C++ targets. +The property value may use +:manual:`generator expressions `. +This is defined in ```` in the Visual Studio +project file. This property is initialized by the value of the variable +:variable:`CMAKE_VS_DEBUGGER_COMMAND_ARGUMENTS` if it is set when a target is +created. + +This property only works for :ref:`Visual Studio Generators`; +it is ignored on other generators. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_ENVIRONMENT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_ENVIRONMENT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0352cd3ba1b0dbb2724c5aa48128bb4aa5037387 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_ENVIRONMENT.rst.txt @@ -0,0 +1,15 @@ +VS_DEBUGGER_ENVIRONMENT +----------------------- + +.. versionadded:: 3.13 + +Sets the local debugger environment for Visual Studio C++ targets. +The property value may use +:manual:`generator expressions `. +This is defined in ```` in the Visual Studio +project file. This property is initialized by the value of the variable +:variable:`CMAKE_VS_DEBUGGER_ENVIRONMENT` if it is set when a target is +created. + +This property only works for :ref:`Visual Studio Generators`; +it is ignored on other generators. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..dbf544267637d0f2acb919de7a036c32f1537a49 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst.txt @@ -0,0 +1,15 @@ +VS_DEBUGGER_WORKING_DIRECTORY +----------------------------- + +.. versionadded:: 3.8 + +Sets the local debugger working directory for Visual Studio C++ targets. +The property value may use +:manual:`generator expressions `. +This is defined in ```` in the Visual Studio +project file. This property is initialized by the value of the variable +:variable:`CMAKE_VS_DEBUGGER_WORKING_DIRECTORY` if it is set when a target is +created. + +This property only works for :ref:`Visual Studio Generators`; +it is ignored on other generators. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DESKTOP_EXTENSIONS_VERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DESKTOP_EXTENSIONS_VERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5fd23e18758cc8a8d1a54201c7e62df1fa0cd8b3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DESKTOP_EXTENSIONS_VERSION.rst.txt @@ -0,0 +1,12 @@ +VS_DESKTOP_EXTENSIONS_VERSION +----------------------------- + +.. versionadded:: 3.4 + +Visual Studio Windows 10 Desktop Extensions Version + +Specifies the version of the Desktop Extensions that should be included in the +target. For example ``10.0.10240.0``. If the value is not specified, the Desktop +Extensions will not be included. To use the same version of the extensions as +the Windows 10 SDK that is being used, you can use the +:variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION` variable. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_DOCUMENTATION_FILE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_DOCUMENTATION_FILE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a3882569e0d4fd40aadcc71f99758e8826330cdc --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_DOCUMENTATION_FILE.rst.txt @@ -0,0 +1,8 @@ +VS_DOTNET_DOCUMENTATION_FILE +---------------------------- + +.. versionadded:: 3.17 + +Visual Studio managed project .NET documentation output + +Sets the target XML documentation file output. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCEPROP_refname_TAG_tagname.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCEPROP_refname_TAG_tagname.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5b9caee08e573baa4299af816f4e60c41607b648 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCEPROP_refname_TAG_tagname.rst.txt @@ -0,0 +1,16 @@ +VS_DOTNET_REFERENCEPROP__TAG_ +----------------------------------------------- + +.. versionadded:: 3.10 + +Defines an XML property ```` for a .NET reference +````. + +Reference properties can be set for .NET references which are +defined by the target properties :prop_tgt:`VS_DOTNET_REFERENCES`, +:prop_tgt:`VS_DOTNET_REFERENCE_` +and also for project references to other C# targets which are +established by :command:`target_link_libraries()`. + +This property is only applicable to C# targets and Visual Studio +generators 2010 and later. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a661ad926a7214a4fa35189d7ea2adedad4887eb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCES.rst.txt @@ -0,0 +1,7 @@ +VS_DOTNET_REFERENCES +-------------------- + +Visual Studio managed project .NET references + +Adds one or more semicolon-delimited .NET references to a generated +Visual Studio project. For example, "System;System.Windows.Forms". diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCES_COPY_LOCAL.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCES_COPY_LOCAL.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..556fa8acc1001161d737dc5dec5c599e7aebb6be --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCES_COPY_LOCAL.rst.txt @@ -0,0 +1,9 @@ +VS_DOTNET_REFERENCES_COPY_LOCAL +------------------------------- + +.. versionadded:: 3.8 + +Sets the **Copy Local** property for all .NET hint references in the target + +Boolean property to enable/disable copying of .NET hint references to +output directory. The default is ``ON``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCE_refname.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCE_refname.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9c4d34abe9a7744d2439ddfae1e55555378257af --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_REFERENCE_refname.rst.txt @@ -0,0 +1,14 @@ +VS_DOTNET_REFERENCE_ +----------------------------- + +.. versionadded:: 3.8 + +Visual Studio managed project .NET reference with name ```` +and hint path. + +Adds one .NET reference to generated Visual Studio project. The +reference will have the name ```` and will point to the +assembly given as value of the property. + +See also :prop_tgt:`VS_DOTNET_REFERENCES` and +:prop_tgt:`VS_DOTNET_REFERENCES_COPY_LOCAL` diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_STARTUP_OBJECT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_STARTUP_OBJECT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8c69fdcb7420e802a71cdb4b8410a37fda5ceb97 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_STARTUP_OBJECT.rst.txt @@ -0,0 +1,21 @@ +VS_DOTNET_STARTUP_OBJECT +------------------------ + +.. versionadded:: 3.24 + +Sets the startup object property in Visual Studio .NET targets. +The property value defines a full qualified class name (including package +name), for example: ``MyCompany.Package.MyStarterClass``. + +If the property is unset, Visual Studio uses the first matching +``static void Main(string[])`` function signature by default. When more +than one ``Main()`` method is available in the current project, the property +becomes mandatory for building the project. + +This property only works for :ref:`Visual Studio Generators`; +it is ignored on other generators. + +.. code-block:: cmake + + set_property(TARGET ${TARGET_NAME} PROPERTY + VS_DOTNET_STARTUP_OBJECT "MyCompany.Package.MyStarterClass") diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6cb8f861cd1b52e30f388e2285fdbba86db1bc48 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst.txt @@ -0,0 +1,11 @@ +VS_DOTNET_TARGET_FRAMEWORK_VERSION +---------------------------------- + +Specify the .NET target framework version. + +Used to specify the .NET target framework version for C++/CLI. For +example, "v4.5". + +This property is deprecated and should not be used anymore. Use +:prop_tgt:`DOTNET_TARGET_FRAMEWORK` or +:prop_tgt:`DOTNET_TARGET_FRAMEWORK_VERSION` instead. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_DPI_AWARE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DPI_AWARE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..47ce1ce2a8d80639676002498abf5b5908790d0f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_DPI_AWARE.rst.txt @@ -0,0 +1,16 @@ +VS_DPI_AWARE +------------ + +.. versionadded:: 3.16 + +Set the Manifest Tool -> Input and Output -> DPI Awareness in the Visual Studio +target project properties. + +Valid values are ``PerMonitor``, ``ON``, or ``OFF``. + +For example: + +.. code-block:: cmake + + add_executable(myproject myproject.cpp) + set_property(TARGET myproject PROPERTY VS_DPI_AWARE "PerMonitor") diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_FILTER_PROPS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_FILTER_PROPS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3de0a16ec95aa4b3e94851e0715b09a837543829 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_FILTER_PROPS.rst.txt @@ -0,0 +1,10 @@ +VS_FILTER_PROPS +--------------- + +.. versionadded:: 3.30 + +Sets the filter props file to be included in the visual studio +C++ project filter file. + +The ``*.filter.props`` files can be used for Visual Studio wide +configuration which is independent from cmake. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_FRAMEWORK_REFERENCES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_FRAMEWORK_REFERENCES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..925ac68c3febd415b9c832ce71b0a625affe156e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_FRAMEWORK_REFERENCES.rst.txt @@ -0,0 +1,12 @@ +VS_FRAMEWORK_REFERENCES +----------------------- + +.. versionadded:: 3.31 + +Visual Studio framework references. +Specify a :ref:`semicolon-separated list ` of framework references +to be added to a generated Visual Studio project. For example: + +* "Microsoft.WindowsDesktop.App.WPF" for WPF applications +* "Microsoft.WindowsDesktop.App.WindowsForms" for WinForms applications +* "Microsoft.WindowsDesktop.App" for applications using both frameworks diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_KEYWORD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_KEYWORD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..072475fa188296e4fb09a704eabeb105bc6f9921 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_KEYWORD.rst.txt @@ -0,0 +1,9 @@ +VS_GLOBAL_KEYWORD +----------------- + +Visual Studio project keyword. + +Sets the "keyword" attribute for a generated Visual Studio project. +Defaults to "Win32Proj". You may wish to override this value with +"ManagedCProj", for example, in a Visual Studio managed C++ unit test +project. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f4d9efc8eb2ade5817c307ecdaa870b7d0eac43d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst.txt @@ -0,0 +1,15 @@ +VS_GLOBAL_PROJECT_TYPES +----------------------- + +Visual Studio project type(s). + +Can be set to one or more UUIDs recognized by Visual Studio to +indicate the type of project. This value is copied verbatim into the +generated project file. Example for a managed C++ unit testing +project: + +:: + + {3AC096D0-A1C2-E12C-1390-A8335801FDAB};{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942} + +UUIDs are semicolon-delimited. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a23c54005ee2fc4f90f6b6a9f2511f68a7a028d3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst.txt @@ -0,0 +1,7 @@ +VS_GLOBAL_ROOTNAMESPACE +----------------------- + +Visual Studio project root namespace. + +Sets the "RootNamespace" attribute for a generated Visual Studio +project. The attribute will be generated only if this is set. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_variable.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_variable.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..56b8021bef612e4520a685f6fc1534a08571e096 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_GLOBAL_variable.rst.txt @@ -0,0 +1,10 @@ +VS_GLOBAL_ +-------------------- + +Visual Studio project-specific global variable. + +Tell the Visual Studio generator to set the global variable +'' to a given value in the generated Visual Studio project. +Ignored on other generators. Qt integration works better if +VS_GLOBAL_QtVersion is set to the version FindQt4.cmake found. For +example, "4.7.3" diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_IOT_EXTENSIONS_VERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_IOT_EXTENSIONS_VERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ca6a3ca0063817d6a9f87f5517d6a18871c930bd --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_IOT_EXTENSIONS_VERSION.rst.txt @@ -0,0 +1,12 @@ +VS_IOT_EXTENSIONS_VERSION +------------------------- + +.. versionadded:: 3.4 + +Visual Studio Windows 10 IoT Extensions Version + +Specifies the version of the IoT Extensions that should be included in the +target. For example ``10.0.10240.0``. If the value is not specified, the IoT +Extensions will not be included. To use the same version of the extensions as +the Windows 10 SDK that is being used, you can use the +:variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION` variable. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_IOT_STARTUP_TASK.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_IOT_STARTUP_TASK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..259055d4e7310b2d3719502a5de9a281156b5a28 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_IOT_STARTUP_TASK.rst.txt @@ -0,0 +1,8 @@ +VS_IOT_STARTUP_TASK +------------------- + +.. versionadded:: 3.4 + +Visual Studio Windows 10 IoT Continuous Background Task + +Specifies that the target should be compiled as a Continuous Background Task library. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_JUST_MY_CODE_DEBUGGING.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_JUST_MY_CODE_DEBUGGING.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..724bd2f47f26a6cc98a7d5bbda0c94ba8ca371a5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_JUST_MY_CODE_DEBUGGING.rst.txt @@ -0,0 +1,12 @@ +VS_JUST_MY_CODE_DEBUGGING +------------------------- + +.. versionadded:: 3.15 + +Enable Just My Code with Visual Studio debugger. + +Supported on :ref:`Visual Studio Generators` for VS 2010 and higher, +:ref:`Makefile Generators` and the :generator:`Ninja` generators. + +This property is initialized by the :variable:`CMAKE_VS_JUST_MY_CODE_DEBUGGING` +variable if it is set when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_KEYWORD.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_KEYWORD.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8fbebfe0663b126ab43597a33906626d18c7aad6 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_KEYWORD.rst.txt @@ -0,0 +1,9 @@ +VS_KEYWORD +---------- + +Removed. This once specified the Visual Studio project keyword +for the :generator:`Visual Studio 9 2008` generator, and older, +but all of those generators have been removed. + +Use the :prop_tgt:`VS_GLOBAL_KEYWORD` target property to set the +keyword for remaining :ref:`Visual Studio Generators`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_MOBILE_EXTENSIONS_VERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_MOBILE_EXTENSIONS_VERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b307e84e84988ade447670f447a69caec58f4baa --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_MOBILE_EXTENSIONS_VERSION.rst.txt @@ -0,0 +1,12 @@ +VS_MOBILE_EXTENSIONS_VERSION +---------------------------- + +.. versionadded:: 3.4 + +Visual Studio Windows 10 Mobile Extensions Version + +Specifies the version of the Mobile Extensions that should be included in the +target. For example ``10.0.10240.0``. If the value is not specified, the Mobile +Extensions will not be included. To use the same version of the extensions as +the Windows 10 SDK that is being used, you can use the +:variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION` variable. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_NO_COMPILE_BATCHING.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_NO_COMPILE_BATCHING.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e14ae58816fec3beeccc550426d515c7d2370c99 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_NO_COMPILE_BATCHING.rst.txt @@ -0,0 +1,24 @@ +VS_NO_COMPILE_BATCHING +---------------------- + +.. versionadded:: 3.24 + +Turn off compile batching for the target. Usually MSBuild calls the compiler +with multiple c/cpp files and compiler starts subprocesses for each file to +make the build parallel. If you want compiler to be invoked with one file at +a time set ``VS_NO_COMPILE_BATCHING`` to ON. If this flag is set MSBuild will +call compiler with one c/cpp file at a time. Useful when you want to use tool +that replaces the compiler, for example some build caching tool. + +This property is initialized by the :variable:`CMAKE_VS_NO_COMPILE_BATCHING` +variable if it is set when a target is created. + +Example +^^^^^^^ + +This shows setting the property for the target ``foo``. + +.. code-block:: cmake + + add_library(foo SHARED foo.cpp) + set_property(TARGET foo PROPERTY VS_NO_COMPILE_BATCHING ON) diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_NO_SOLUTION_DEPLOY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_NO_SOLUTION_DEPLOY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..bf6ac10923aa7558a64a67544fecf10b943ca218 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_NO_SOLUTION_DEPLOY.rst.txt @@ -0,0 +1,48 @@ +VS_NO_SOLUTION_DEPLOY +--------------------- + +.. versionadded:: 3.15 + +Specify that the target should not be marked for deployment to a Windows CE +or Windows Phone device in the generated Visual Studio solution. + +Be default, all EXE and shared library (DLL) targets are marked to deploy to +the target device in the generated Visual Studio solution. + +Generator expressions are supported. + +There are reasons one might want to exclude a target / generated project from +deployment: + +- The library or executable may not be necessary in the primary deploy/debug + scenario, and excluding from deployment saves time in the + develop/download/debug cycle. +- There may be insufficient space on the target device to accommodate all of + the build products. +- Visual Studio 2013 requires a target device IP address be entered for each + target marked for deployment. For large numbers of targets, this can be + tedious. + NOTE: Visual Studio *will* deploy all project dependencies of a project + tagged for deployment to the IP address configured for that project even + if those dependencies are not tagged for deployment. + + +Example 1 +^^^^^^^^^ + +This shows setting the variable for the target foo. + +.. code-block:: cmake + + add_library(foo SHARED foo.cpp) + set_property(TARGET foo PROPERTY VS_NO_SOLUTION_DEPLOY ON) + +Example 2 +^^^^^^^^^ + +This shows setting the variable for the Release configuration only. + +.. code-block:: cmake + + add_library(foo SHARED foo.cpp) + set_property(TARGET foo PROPERTY VS_NO_SOLUTION_DEPLOY "$") diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_PACKAGE_REFERENCES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_PACKAGE_REFERENCES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ec175677240ee6ba6a122ef98ed8238ada9e74c4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_PACKAGE_REFERENCES.rst.txt @@ -0,0 +1,15 @@ +VS_PACKAGE_REFERENCES +--------------------- + +.. versionadded:: 3.15 + +Visual Studio package references for nuget. + +Adds one or more semicolon-delimited package references to a generated +Visual Studio project. The version of the package will be +underscore delimited. For example, ``boost_1.7.0;nunit_3.12.*``. + +.. code-block:: cmake + + set_property(TARGET ${TARGET_NAME} PROPERTY + VS_PACKAGE_REFERENCES "boost_1.7.0") diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_PLATFORM_TOOLSET.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_PLATFORM_TOOLSET.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..27a92d6b9da8d950dabc1b9327b39de7d25d0cf7 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_PLATFORM_TOOLSET.rst.txt @@ -0,0 +1,12 @@ +VS_PLATFORM_TOOLSET +------------------- + +.. versionadded:: 3.18 + +Overrides the platform toolset used to build a target. + +Only supported when the compiler used by the given toolset is the +same as the compiler used to build the whole source tree. + +This is especially useful to create driver projects with the toolsets +"WindowsUserModeDriver10.0" or "WindowsKernelModeDriver10.0". diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_PROJECT_IMPORT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_PROJECT_IMPORT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f5e9698a3f906b60cde2563a10709d6421c1b9e3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_PROJECT_IMPORT.rst.txt @@ -0,0 +1,10 @@ +VS_PROJECT_IMPORT +----------------- + +.. versionadded:: 3.15 + +Visual Studio managed project imports + +Adds to a generated Visual Studio project one or more semicolon-delimited paths +to .props files needed when building projects from some NuGet packages. +For example, ``my_packages_path/MyPackage.1.0.0/build/MyPackage.props``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_AUXPATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_AUXPATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..054f59e3ad5e5d54311b0b8deb26b5973ae15fba --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_AUXPATH.rst.txt @@ -0,0 +1,7 @@ +VS_SCC_AUXPATH +-------------- + +Visual Studio Source Code Control Aux Path. + +Can be set to change the visual studio source code control auxpath +property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_LOCALPATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_LOCALPATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b5b7721c5e38b5b4926d8b2ca1f4d6fc4055e0b0 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_LOCALPATH.rst.txt @@ -0,0 +1,7 @@ +VS_SCC_LOCALPATH +---------------- + +Visual Studio Source Code Control Local Path. + +Can be set to change the visual studio source code control local path +property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_PROJECTNAME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_PROJECTNAME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6d7f628d92e1214f2a48a73db0677c033078b232 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_PROJECTNAME.rst.txt @@ -0,0 +1,7 @@ +VS_SCC_PROJECTNAME +------------------ + +Visual Studio Source Code Control Project. + +Can be set to change the visual studio source code control project +name property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_PROVIDER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_PROVIDER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..80475af1f0a6bedc9ccedbeef9a841eae67aa989 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SCC_PROVIDER.rst.txt @@ -0,0 +1,7 @@ +VS_SCC_PROVIDER +--------------- + +Visual Studio Source Code Control Provider. + +Can be set to change the visual studio source code control provider +property. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_SDK_REFERENCES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SDK_REFERENCES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9a082e7fdebd56a9a6e0a51b9ead5573a34186bb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SDK_REFERENCES.rst.txt @@ -0,0 +1,9 @@ +VS_SDK_REFERENCES +----------------- + +.. versionadded:: 3.7 + +Visual Studio project SDK references. +Specify a :ref:`semicolon-separated list ` of SDK references +to be added to a generated Visual Studio project, e.g. +``Microsoft.AdMediatorWindows81, Version=1.0``. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_SOLUTION_DEPLOY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SOLUTION_DEPLOY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e56f411bd71a5fdf68ec6cd14c2d91c59d48c360 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SOLUTION_DEPLOY.rst.txt @@ -0,0 +1,29 @@ +VS_SOLUTION_DEPLOY +------------------ + +.. versionadded:: 3.18 + +Specify that the target should be marked for deployment when not targeting +Windows CE, Windows Phone or a Windows Store application. + +If the target platform doesn't support deployment, this property won't have +any effect. + +:manual:`Generator expressions ` are supported. + +Examples +^^^^^^^^ + +Always deploy target ``foo``: + +.. code-block:: cmake + + add_executable(foo SHARED foo.cpp) + set_property(TARGET foo PROPERTY VS_SOLUTION_DEPLOY ON) + +Deploy target ``foo`` for all configurations except ``Release``: + +.. code-block:: cmake + + add_executable(foo SHARED foo.cpp) + set_property(TARGET foo PROPERTY VS_SOLUTION_DEPLOY "$>") diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_SOURCE_SETTINGS_tool.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SOURCE_SETTINGS_tool.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b5a76fc444c7a980ddca095ab852b7ac9757a9b8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_SOURCE_SETTINGS_tool.rst.txt @@ -0,0 +1,21 @@ +VS_SOURCE_SETTINGS_ +------------------------- + +.. versionadded:: 3.18 + +Set any item metadata on all non-built files that use . + +Takes a list of ``Key=Value`` pairs. Tells the Visual Studio generator +to set ``Key`` to ``Value`` as item metadata on all non-built files +that use ````. + +For example: + +.. code-block:: cmake + + set_property(TARGET main PROPERTY VS_SOURCE_SETTINGS_FXCompile "Key=Value" "Key2=Value2") + +will set ``Key`` to ``Value`` and ``Key2`` to ``Value2`` for all +non-built files that use ``FXCompile``. + +:manual:`Generator expressions ` are supported. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_USER_PROPS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_USER_PROPS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8f2a105831e718f9491b28c5ad20e5aef2c337a3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_USER_PROPS.rst.txt @@ -0,0 +1,14 @@ +VS_USER_PROPS +------------- + +.. versionadded:: 3.8 + +Sets the user props file to be included in the visual studio +C++ project file. The standard path is +``$(UserRootDir)\\Microsoft.Cpp.$(Platform).user.props``, which is +in most cases the same as +``%LOCALAPPDATA%\\Microsoft\\MSBuild\\v4.0\\Microsoft.Cpp.Win32.user.props`` +or ``%LOCALAPPDATA%\\Microsoft\\MSBuild\\v4.0\\Microsoft.Cpp.x64.user.props``. + +The ``*.user.props`` files can be used for Visual Studio wide +configuration which is independent from cmake. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_USE_DEBUG_LIBRARIES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_USE_DEBUG_LIBRARIES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3d5ada47302ecc2caf3343b9bac103b9cd7e1a3a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_USE_DEBUG_LIBRARIES.rst.txt @@ -0,0 +1,28 @@ +VS_USE_DEBUG_LIBRARIES +---------------------- + +.. versionadded:: 3.30 + +.. |VS_USE_DEBUG_LIBRARIES| replace:: ``VS_USE_DEBUG_LIBRARIES`` +.. |MSVC_RUNTIME_LIBRARY| replace:: :prop_tgt:`MSVC_RUNTIME_LIBRARY` + +.. include:: VS_USE_DEBUG_LIBRARIES-PURPOSE.txt + +Use :manual:`generator expressions ` +for per-configuration specification. For example, the code: + +.. code-block:: cmake + + add_executable(foo foo.c) + set_property(TARGET foo PROPERTY + VS_USE_DEBUG_LIBRARIES "$") + +indicates that target ``foo`` considers its "Debug" and "Custom" +configurations to be debug configurations, and its other configurations +to be non-debug configurations. + +The property is initialized from the value of the +:variable:`CMAKE_VS_USE_DEBUG_LIBRARIES` variable, if it is set. +If the property is not set then CMake generates ``UseDebugLibraries`` using +heuristics to determine which configurations are debug configurations. +See policy :policy:`CMP0162`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ef3ceb0f764629143fc50c58096f86556d9a3dc2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION.rst.txt @@ -0,0 +1,17 @@ +VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION +-------------------------------------- + +.. versionadded:: 3.4 + +Visual Studio Windows Target Platform Minimum Version + +For Windows 10. Specifies the minimum version of the OS that is being +targeted. For example ``10.0.10240.0``. If the value is not specified, the +value of the :variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION` variable +will be used on WindowsStore projects. Otherwise the target platform +minimum version will not be specified for the project. + +.. versionadded:: 3.27 + This property is initialized by the value of the + :variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION` variable + if it is set when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINRT_COMPONENT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINRT_COMPONENT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8b4aaf7ac0b7fcce6f8a63eeece92f9898d2bf45 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINRT_COMPONENT.rst.txt @@ -0,0 +1,13 @@ +VS_WINRT_COMPONENT +------------------ + +.. versionadded:: 3.1 + +Mark a target as a Windows Runtime component for the Visual Studio generator. +Compile the target with ``C++/CX`` language extensions for Windows Runtime. +For ``SHARED`` and ``MODULE`` libraries, this also defines the +``_WINRT_DLL`` preprocessor macro. + +.. note:: + Currently this is implemented only by Visual Studio generators. + Support may be added to other generators in the future. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINRT_EXTENSIONS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINRT_EXTENSIONS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d1cba3471f159a575998073305a608a745b376d5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINRT_EXTENSIONS.rst.txt @@ -0,0 +1,5 @@ +VS_WINRT_EXTENSIONS +------------------- + +Deprecated. Use :prop_tgt:`VS_WINRT_COMPONENT` instead. +This property was an experimental partial implementation of that one. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINRT_REFERENCES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINRT_REFERENCES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..af98b2f7b73b479c57e1ea166c678fd2f34d486e --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/VS_WINRT_REFERENCES.rst.txt @@ -0,0 +1,7 @@ +VS_WINRT_REFERENCES +------------------- + +Visual Studio project Windows Runtime Metadata references + +Adds one or more semicolon-delimited WinRT references to a generated +Visual Studio project. For example, "Windows;Windows.UI.Core". diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/WATCOM_RUNTIME_LIBRARY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/WATCOM_RUNTIME_LIBRARY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3752862b2e137f541a2c8e6a00dce993668e2143 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/WATCOM_RUNTIME_LIBRARY.rst.txt @@ -0,0 +1,34 @@ +WATCOM_RUNTIME_LIBRARY +---------------------- + +.. versionadded:: 3.24 + +Select the Watcom runtime library for use by compilers targeting the Watcom ABI. + +The allowed values are: + +.. include:: WATCOM_RUNTIME_LIBRARY-VALUES.txt + +Use :manual:`generator expressions ` to +support per-configuration specification. + +For example, the code: + +.. code-block:: cmake + + add_executable(foo foo.c) + set_property(TARGET foo PROPERTY + WATCOM_RUNTIME_LIBRARY "MultiThreaded") + +selects for the target ``foo`` a multi-threaded statically-linked runtime +library. + +If this property is not set then CMake uses the default value +``MultiThreadedDLL`` on Windows and ``SingleThreaded`` on other +platforms to select a Watcom runtime library. + +.. note:: + + This property has effect only when policy :policy:`CMP0136` is set to ``NEW`` + prior to the first :command:`project` or :command:`enable_language` command + that enables a language using a compiler targeting the Watcom ABI. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/WIN32_EXECUTABLE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/WIN32_EXECUTABLE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..eac28ae3bd3da2e913f1f195a03ae2b2476520a0 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/WIN32_EXECUTABLE.rst.txt @@ -0,0 +1,17 @@ +WIN32_EXECUTABLE +---------------- + +Build an executable with a WinMain entry point on windows. + +When this property is set to true the executable when linked on +Windows will be created with a WinMain() entry point instead of just +main(). This makes it a GUI executable instead of a console application. +See the :variable:`CMAKE_MFC_FLAG` variable documentation to +configure use of the Microsoft Foundation Classes (MFC) for WinMain +executables. This property is initialized by the value of the +:variable:`CMAKE_WIN32_EXECUTABLE` variable if it is set when +a target is created. + +This property supports +:manual:`generator expressions `, except if the +target is managed (contains C# code.) diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..00f32f61eafb52d6024cf97e9c8170687666ce7d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst.txt @@ -0,0 +1,28 @@ +WINDOWS_EXPORT_ALL_SYMBOLS +-------------------------- + +.. versionadded:: 3.4 + +This property is implemented only for MS-compatible tools on Windows. + +Enable this boolean property to automatically create a module definition +(``.def``) file with all global symbols found in the input ``.obj`` files +for a ``SHARED`` library (or executable with :prop_tgt:`ENABLE_EXPORTS`) +on Windows. The module definition file will be passed to the linker +causing all symbols to be exported from the ``.dll``. +For global *data* symbols, ``__declspec(dllimport)`` must still be used when +compiling against the code in the ``.dll``. All other function symbols will +be automatically exported and imported by callers. This simplifies porting +projects to Windows by reducing the need for explicit ``dllexport`` markup, +even in ``C++`` classes. + +When this property is enabled, zero or more ``.def`` files may also be +specified as source files of the target. The exports named by these files +will be merged with those detected from the object files to generate a +single module definition file to be passed to the linker. This can be +used to export symbols from a ``.dll`` that are not in any of its object +files but are added by the linker from dependencies (e.g. ``msvcrt.lib``). + +This property is initialized by the value of +the :variable:`CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS` variable if it is set +when a target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fbe760815fc54205709eb7d4e2386b0351cbee21 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst.txt @@ -0,0 +1,22 @@ +XCODE_ATTRIBUTE_ +------------------------------ + +Set Xcode target attributes directly. + +Tell the :generator:`Xcode` generator to set ```` to a given +value in the generated Xcode project. Ignored on other generators. + +This offers low-level control over the generated Xcode project file. +It is meant as a last resort for specifying settings that CMake does +not otherwise have a way to control. Although this can override a +setting CMake normally produces on its own, doing so bypasses CMake's +model of the project and can break things. + +See the :variable:`CMAKE_XCODE_ATTRIBUTE_` variable +to set attributes on all targets in a directory tree. + +Contents of ``XCODE_ATTRIBUTE_`` 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. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_FRAMEWORKS_CODE_SIGN_ON_COPY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_FRAMEWORKS_CODE_SIGN_ON_COPY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2a4d66672c96d351ced6ce88baec5d81797be4c9 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_FRAMEWORKS_CODE_SIGN_ON_COPY.rst.txt @@ -0,0 +1,13 @@ +XCODE_EMBED_FRAMEWORKS_CODE_SIGN_ON_COPY +---------------------------------------- + +.. versionadded:: 3.20 + +Tell the :generator:`Xcode` generator to perform code signing for all the +frameworks and libraries that are embedded using the +:prop_tgt:`XCODE_EMBED_FRAMEWORKS >` property. + +.. versionadded:: 3.21 + +This property was generalized to other types of embedded items. See +:prop_tgt:`XCODE_EMBED__CODE_SIGN_ON_COPY` for the more general form. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_FRAMEWORKS_REMOVE_HEADERS_ON_COPY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_FRAMEWORKS_REMOVE_HEADERS_ON_COPY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..04daa8559f868d18184b1fb89cd066af43a2b78a --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_FRAMEWORKS_REMOVE_HEADERS_ON_COPY.rst.txt @@ -0,0 +1,14 @@ +XCODE_EMBED_FRAMEWORKS_REMOVE_HEADERS_ON_COPY +--------------------------------------------- + +.. versionadded:: 3.20 + +Tell the :generator:`Xcode` generator to remove headers from all the +frameworks that are embedded using the +:prop_tgt:`XCODE_EMBED_FRAMEWORKS >` property. + +.. versionadded:: 3.21 + +This property was generalized to other types of embedded items. See +:prop_tgt:`XCODE_EMBED__REMOVE_HEADERS_ON_COPY` for the more +general form. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..0354f978c48fcb953d1acc87a34f33fe9e749654 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type.rst.txt @@ -0,0 +1,70 @@ +XCODE_EMBED_ +------------------ + +.. versionadded:: 3.20 + +Tell the :generator:`Xcode` generator to embed the specified list of items into +the target bundle. ```` specifies the embed build phase to use. +See the Xcode documentation for the base location of each ````. + +The supported values for ```` are: + +``FRAMEWORKS`` + The specified items will be added to the ``Embed Frameworks`` build phase. + The items can be CMake target names or paths to frameworks or libraries. + +``APP_EXTENSIONS`` + .. versionadded:: 3.21 + + The specified items will be added to the ``Embed App Extensions`` build + phase, with ``Destination`` set to ``PlugIns and Foundation Extensions`` + They must be CMake target names. + +``EXTENSIONKIT_EXTENSIONS`` + .. versionadded:: 3.26 + + The specified items will be added to the ``Embed App Extensions`` build + phase, with ``Destination`` set to ``ExtensionKit Extensions`` + They must be CMake target names, and should likely have the + ``XCODE_PRODUCT_TYPE`` target property set to + ``com.apple.product-type.extensionkit-extension`` + as well as the ``XCODE_EXPLICIT_FILE_TYPE`` to + ``wrapper.extensionkit-extension`` + +``PLUGINS`` + .. versionadded:: 3.23 + + The specified items will be added to the ``Embed PlugIns`` build phase. + They must be CMake target names. + +``RESOURCES`` + .. versionadded:: 3.28 + + The specified items will be added to the ``Embed Resources`` build phase. + They must be CMake target names or folder paths. + +``XPC_SERVICES`` + .. versionadded:: 3.29 + + The specified items will be added to the ``Embed XPC Services`` build phase. + They must be CMake target names. + +When listing a target as any of the things to embed, Xcode must see that target +as part of the same Xcode project, or a sub-project of the one defining the +bundle. In order to satisfy this constraint, the CMake project must ensure +at least one of the following: + +* The :variable:`CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT_ONLY` variable is set + to true in the top level ``CMakeLists.txt`` file. This is the simplest and + most robust approach. +* Define the target-to-embed in a subdirectory of the one that defines the + target being embedded into. +* If the target-to-embed and the target being embedded into are in separate, + unrelated directories (i.e. they are siblings, not one a parent of the + other), ensure they have a common :command:`project` call in a parent + directory and no other :command:`project` calls between themselves and that + common :command:`project` call. + +See also :prop_tgt:`XCODE_EMBED__PATH`, +:prop_tgt:`XCODE_EMBED__REMOVE_HEADERS_ON_COPY` and +:prop_tgt:`XCODE_EMBED__CODE_SIGN_ON_COPY`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type_CODE_SIGN_ON_COPY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type_CODE_SIGN_ON_COPY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ca35c2551fab37fa14d8a7c5f390dfa38329b477 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type_CODE_SIGN_ON_COPY.rst.txt @@ -0,0 +1,24 @@ +XCODE_EMBED__CODE_SIGN_ON_COPY +------------------------------------ + +.. versionadded:: 3.20 + +Boolean property used only by the :generator:`Xcode` generator. It specifies +whether to perform code signing for the items that are embedded using the +:prop_tgt:`XCODE_EMBED_` property. + +The supported values for ```` are: + +``FRAMEWORKS`` + +``APP_EXTENSIONS`` + .. versionadded:: 3.21 + +``EXTENSIONKIT_EXTENSIONS`` + .. versionadded:: 3.26 + +``PLUGINS`` + .. versionadded:: 3.23 + +If a ``XCODE_EMBED__CODE_SIGN_ON_COPY`` property is not defined on the +target, no code signing on copy will be performed for that ````. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type_PATH.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type_PATH.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..255aa68686a6760a34c7033d0ac75d1cdc04707b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type_PATH.rst.txt @@ -0,0 +1,30 @@ +XCODE_EMBED__PATH +----------------------- + +.. versionadded:: 3.20 + +This property is used only by the :generator:`Xcode` generator. When defined, +it specifies the relative path to use when embedding the items specified by +:prop_tgt:`XCODE_EMBED_`. The path is relative +to the base location of the ``Embed XXX`` build phase associated with +````. See the Xcode documentation for the base location of each +````. + +The supported values for ```` are: + +``FRAMEWORKS`` + +``APP_EXTENSIONS`` + .. versionadded:: 3.21 + +``EXTENSIONKIT_EXTENSIONS`` + .. versionadded:: 3.26 + +``PLUGINS`` + .. versionadded:: 3.23 + +``RESOURCES`` + .. versionadded:: 3.28 + +``XPC_SERVICES`` + .. versionadded:: 3.29 diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type_REMOVE_HEADERS_ON_COPY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type_REMOVE_HEADERS_ON_COPY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..da8f61bb4c2cdf09481a4b37e83b7fe5eb31d247 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EMBED_type_REMOVE_HEADERS_ON_COPY.rst.txt @@ -0,0 +1,29 @@ +XCODE_EMBED__REMOVE_HEADERS_ON_COPY +----------------------------------------- + +.. versionadded:: 3.20 + +Boolean property used only by the :generator:`Xcode` generator. It specifies +whether to remove headers from all the frameworks that are embedded using the +:prop_tgt:`XCODE_EMBED_` property. + +The supported values for ```` are: + +``FRAMEWORKS`` + If the ``XCODE_EMBED_FRAMEWORKS_REMOVE_HEADERS_ON_COPY`` property is not + defined, headers will not be removed on copy by default. + +``APP_EXTENSIONS`` + .. versionadded:: 3.21 + + If the ``XCODE_EMBED_APP_EXTENSIONS_REMOVE_HEADERS_ON_COPY`` property is not + defined, headers WILL be removed on copy by default. + +``EXTENSIONKIT_EXTENSIONS`` + .. versionadded:: 3.26 + + If the ``XCODE_EMBED_APP_EXTENSIONS_REMOVE_HEADERS_ON_COPY`` property is not + defined, headers WILL be removed on copy by default. + +``PLUGINS`` + .. versionadded:: 3.23 diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EXPLICIT_FILE_TYPE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EXPLICIT_FILE_TYPE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e01a0342b8f43d174e641b15abd95d3e78ce5abb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_EXPLICIT_FILE_TYPE.rst.txt @@ -0,0 +1,10 @@ +XCODE_EXPLICIT_FILE_TYPE +------------------------ + +.. versionadded:: 3.8 + +Set the Xcode ``explicitFileType`` attribute on its reference to a +target. CMake computes a default based on target type but +can be told explicitly with this property. + +See also :prop_tgt:`XCODE_PRODUCT_TYPE`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_GENERATE_SCHEME.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_GENERATE_SCHEME.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..fa3c5bceedf438d10197d1a10f7b2c200512b6e1 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_GENERATE_SCHEME.rst.txt @@ -0,0 +1,48 @@ +XCODE_GENERATE_SCHEME +--------------------- + +.. versionadded:: 3.15 + +If enabled, the :generator:`Xcode` generator will generate schema files. These +are useful to invoke analyze, archive, build-for-testing and test +actions from the command line. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_GENERATE_SCHEME` if it is set when a target +is created. + +The following target properties overwrite the default of the +corresponding settings on the "Diagnostic" tab for each schema file. +Each of those is initialized by the respective ``CMAKE_`` variable +at target creation time. + +- :prop_tgt:`XCODE_SCHEME_ADDRESS_SANITIZER` +- :prop_tgt:`XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN` +- :prop_tgt:`XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER` +- :prop_tgt:`XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS` +- :prop_tgt:`XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE` +- :prop_tgt:`XCODE_SCHEME_GUARD_MALLOC` +- :prop_tgt:`XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP` +- :prop_tgt:`XCODE_SCHEME_MALLOC_GUARD_EDGES` +- :prop_tgt:`XCODE_SCHEME_MALLOC_SCRIBBLE` +- :prop_tgt:`XCODE_SCHEME_MALLOC_STACK` +- :prop_tgt:`XCODE_SCHEME_THREAD_SANITIZER` +- :prop_tgt:`XCODE_SCHEME_THREAD_SANITIZER_STOP` +- :prop_tgt:`XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER` +- :prop_tgt:`XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP` +- :prop_tgt:`XCODE_SCHEME_LAUNCH_CONFIGURATION` +- :prop_tgt:`XCODE_SCHEME_ENABLE_GPU_API_VALIDATION` +- :prop_tgt:`XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION` +- :prop_tgt:`XCODE_SCHEME_ZOMBIE_OBJECTS` + +The following target properties will be applied on the +"Info", "Arguments", and "Options" tab: + +- :prop_tgt:`XCODE_SCHEME_ARGUMENTS` +- :prop_tgt:`XCODE_SCHEME_DEBUG_AS_ROOT` +- :prop_tgt:`XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING` +- :prop_tgt:`XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE` +- :prop_tgt:`XCODE_SCHEME_ENVIRONMENT` +- :prop_tgt:`XCODE_SCHEME_EXECUTABLE` +- :prop_tgt:`XCODE_SCHEME_LAUNCH_MODE` +- :prop_tgt:`XCODE_SCHEME_WORKING_DIRECTORY` diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_LINK_BUILD_PHASE_MODE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_LINK_BUILD_PHASE_MODE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..836cc6b88ade68b40a106276323af941b9f6d1e5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_LINK_BUILD_PHASE_MODE.rst.txt @@ -0,0 +1,55 @@ +XCODE_LINK_BUILD_PHASE_MODE +--------------------------- + +.. versionadded:: 3.19 + +When using the :generator:`Xcode` generator, libraries to be linked will be +specified in the Xcode project file using either the "Link Binary With +Libraries" build phase or directly as linker flags. The former allows Xcode +to manage build paths, which may be necessary when creating Xcode archives +because it may use different build paths to a regular build. + +This property controls usage of "Link Binary With Libraries" build phase for +a target that is an app bundle, executable, shared library, shared framework +or a module library. + +Possible values are: + +* ``NONE`` + The libraries will be linked by specifying the linker flags directly. + +* ``BUILT_ONLY`` + The "Link Binary With Libraries" build phase will be used to link to another + target under the following conditions: + + - The target to be linked to is a regular non-imported, non-interface library + target. + - The output directory of the target being built has not been changed from + its default (see :prop_tgt:`RUNTIME_OUTPUT_DIRECTORY` and + :prop_tgt:`LIBRARY_OUTPUT_DIRECTORY`). + +* ``KNOWN_LOCATION`` + The "Link Binary With Libraries" build phase will be used to link to another + target under the same conditions as with ``BUILT_ONLY`` and also: + + - Imported library targets except those of type ``UNKNOWN``. + - Any non-target library specified directly with a path. + +For all other cases, the libraries will be linked by specifying the linker +flags directly. + +.. warning:: + Libraries linked using "Link Binary With Libraries" are linked after the + ones linked through regular linker flags. This order should be taken into + account when different static libraries contain symbols with the same name, + as the former ones will take precedence over the latter. + +.. warning:: + If two or more directories contain libraries with identical file names and + some libraries are linked from those directories, the library search path + lookup will end up linking libraries from the first directory. This is a + known limitation of Xcode. + +This property is initialized by the value of the +:variable:`CMAKE_XCODE_LINK_BUILD_PHASE_MODE` variable if it is set when a +target is created. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_PRODUCT_TYPE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_PRODUCT_TYPE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..17a9c3f303ff0e6237b3c95ec49351d1ddd2c92d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_PRODUCT_TYPE.rst.txt @@ -0,0 +1,10 @@ +XCODE_PRODUCT_TYPE +------------------ + +.. versionadded:: 3.8 + +Set the Xcode ``productType`` attribute on its reference to a +target. CMake computes a default based on target type but +can be told explicitly with this property. + +See also :prop_tgt:`XCODE_EXPLICIT_FILE_TYPE`. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..c72ec06888e800b90adb586b422776f315c08d6f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_ADDRESS_SANITIZER +------------------------------ + +.. versionadded:: 3.13 + +Whether to enable ``Address Sanitizer`` in the Diagnostics +section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..293b5d4aa49ebd05a53c19c24cc8c675c3e7176c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN +----------------------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Detect use of stack after return`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ARGUMENTS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ARGUMENTS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2bfcb41b372c9c7c9dbf0490f6b21645f8e00bc4 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ARGUMENTS.rst.txt @@ -0,0 +1,12 @@ +XCODE_SCHEME_ARGUMENTS +---------------------- + +.. versionadded:: 3.13 + +Specify command line arguments that should be added to the Arguments +section of the generated Xcode scheme. + +If set to a list of arguments those will be added to the scheme. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DEBUG_AS_ROOT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DEBUG_AS_ROOT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2523deb5683e9a3e6fecffeb43c352247fb89a15 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DEBUG_AS_ROOT.rst.txt @@ -0,0 +1,9 @@ +XCODE_SCHEME_DEBUG_AS_ROOT +-------------------------- + +.. versionadded:: 3.15 + +Whether to debug the target as 'root'. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..bbcae356a99f9b910fb6a3829aa9eda611a11923 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst.txt @@ -0,0 +1,15 @@ +XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING +-------------------------------------- + +.. versionadded:: 3.16 + +Whether to enable +``Allow debugging when using document Versions Browser`` +in the Options section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3d315a2bf695b751376f1286316a216be60cbc97 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER +---------------------------------------- + +.. versionadded:: 3.13 + +Whether to disable the ``Main Thread Checker`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2ca20f72e1b918b87851a07fcf5f407698aca7bd --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS +---------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Dynamic Library Loads`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..278c9ef107457650657cb2bd86744f9889578960 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE +------------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Dynamic Linker API usage`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENABLE_GPU_API_VALIDATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENABLE_GPU_API_VALIDATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3b801c50362980018de7cc49c9594ac3fc2a09fa --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENABLE_GPU_API_VALIDATION.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_ENABLE_GPU_API_VALIDATION +-------------------------------------- + +.. versionadded:: 3.25 + +Property value for ``Metal: API Validation`` in the Options section of +the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ENABLE_GPU_API_VALIDATION` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6ffd6943d8846fd73dcecbfffbf162dbdfe9e233 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE.rst.txt @@ -0,0 +1,15 @@ +XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE +------------------------------------------ + +.. versionadded:: 3.23 + +Property value for ``GPU Frame Capture`` in the Options section of +the generated Xcode scheme. Example values are `Metal` and +`Disabled`. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5358087d59941d8056aa2ce6f3eb729bfe26be52 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION +----------------------------------------- + +.. versionadded:: 3.25 + +Property value for ``Metal: Shader Validation`` in the Options section of +the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENVIRONMENT.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENVIRONMENT.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..16542f841a189956ca515e3f85dbc07135d9194d --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ENVIRONMENT.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_ENVIRONMENT +------------------------ + +.. versionadded:: 3.13 + +Specify environment variables that should be added to the Arguments +section of the generated Xcode scheme. + +If set to a list of environment variables and values of the form +``MYVAR=value`` those environment variables will be added to the +scheme. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_EXECUTABLE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_EXECUTABLE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b453f108d1d26028008337a3e62ec04281bffa77 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_EXECUTABLE.rst.txt @@ -0,0 +1,11 @@ +XCODE_SCHEME_EXECUTABLE +----------------------- + +.. versionadded:: 3.13 + +Specify path to executable in the Info section of the generated +Xcode scheme. If not set the schema generator will select the +current target if it is actually executable. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_GUARD_MALLOC.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_GUARD_MALLOC.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4b242a2efeefc181381f6d0d6b35063e6656e521 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_GUARD_MALLOC.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_GUARD_MALLOC +------------------------------ + +.. versionadded:: 3.13 + +Whether to enable ``Guard Malloc`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_GUARD_MALLOC` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_LAUNCH_CONFIGURATION.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_LAUNCH_CONFIGURATION.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..9643322008dce16c949460e51de80e14806a075b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_LAUNCH_CONFIGURATION.rst.txt @@ -0,0 +1,13 @@ +XCODE_SCHEME_LAUNCH_CONFIGURATION +--------------------------------- + +.. versionadded:: 3.25 + +Set the build configuration to run the target. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_LAUNCH_CONFIGURATION` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_LAUNCH_MODE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_LAUNCH_MODE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..df5ae07ef8beb33b491a5086b03c6517aebe9b1b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_LAUNCH_MODE.rst.txt @@ -0,0 +1,22 @@ +XCODE_SCHEME_LAUNCH_MODE +------------------------ + +.. versionadded:: 3.25 + +Property value for ``Launch`` in the Info section of the generated Xcode +scheme. + +Possible values are: + +``AUTO`` + Launch automatically. This is the default. + +``WAIT`` + Wait for the executable to be launched. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_LAUNCH_MODE` if it is set when a target is +created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..2a813aaadf700185296b4a7f6b6af14acb5a7f53 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst.txt @@ -0,0 +1,15 @@ +XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP +------------------------------------- + +.. versionadded:: 3.13 + +Whether to enable the ``Main Thread Checker`` option +``Pause on issues`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MALLOC_GUARD_EDGES.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MALLOC_GUARD_EDGES.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..750da748c78454f9a898e695f9aa6aacf2741b9c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MALLOC_GUARD_EDGES.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_MALLOC_GUARD_EDGES +------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Malloc Guard Edges`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MALLOC_SCRIBBLE.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MALLOC_SCRIBBLE.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..4ebd21b350b6ba116ca8c78c19cc9ec3bff12484 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MALLOC_SCRIBBLE.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_MALLOC_SCRIBBLE +------------------------------ + +.. versionadded:: 3.13 + +Whether to enable ``Malloc Scribble`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MALLOC_STACK.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MALLOC_STACK.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..5afe34e4f1f356f70adfc69050956bd2fd12f742 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_MALLOC_STACK.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_MALLOC_STACK +------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Malloc Stack`` in the Diagnostics +section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_MALLOC_STACK` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..cc774c440ed33b1127d282576b5cd6a17c955b1c --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_THREAD_SANITIZER +----------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Thread Sanitizer`` in the Diagnostics +section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_THREAD_SANITIZER` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER_STOP.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER_STOP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3bb25964defa0a69a23cba7fa084886eb0aeeba3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER_STOP.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_THREAD_SANITIZER_STOP +---------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Thread Sanitizer - Pause on issues`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..1146130ede04a8dc01d25c2435b0d56cae4581a8 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER +------------------------------------------ + +.. versionadded:: 3.13 + +Whether to enable ``Undefined Behavior Sanitizer`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..358f298da22a9333849aba8e069cf42eb69c35d5 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst.txt @@ -0,0 +1,15 @@ +XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP +----------------------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Undefined Behavior Sanitizer`` option +``Pause on issues`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_WORKING_DIRECTORY.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_WORKING_DIRECTORY.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..d8d56fc3872c6435deb16edd2962f87c450f6906 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_WORKING_DIRECTORY.rst.txt @@ -0,0 +1,15 @@ +XCODE_SCHEME_WORKING_DIRECTORY +------------------------------ + +.. versionadded:: 3.17 + +Specify the ``Working Directory`` of the *Run* and *Profile* +actions in the generated Xcode scheme. In case the value contains +generator expressions those are evaluated. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_WORKING_DIRECTORY` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ZOMBIE_OBJECTS.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ZOMBIE_OBJECTS.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6030109ce644487b07ddd13b36423071dc00e248 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_SCHEME_ZOMBIE_OBJECTS.rst.txt @@ -0,0 +1,14 @@ +XCODE_SCHEME_ZOMBIE_OBJECTS +------------------------------ + +.. versionadded:: 3.13 + +Whether to enable ``Zombie Objects`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ZOMBIE_OBJECTS` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_XCCONFIG.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_XCCONFIG.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..f44e42253bdcc61ad33f3bbed493a442cd248677 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCODE_XCCONFIG.rst.txt @@ -0,0 +1,14 @@ +XCODE_XCCONFIG +-------------- + +.. versionadded:: 3.24 + +If set, the :generator:`Xcode` generator will register the specified +file as a target-level XCConfig file. For global XCConfig files see +the :variable:`CMAKE_XCODE_XCCONFIG` variable. + +This feature is intended to ease migration from native Xcode projects +to CMake projects. + +Contents of ``XCODE_XCCONFIG`` may use +:manual:`generator expressions `. diff --git a/cmake/doc/cmake/html/_sources/prop_tgt/XCTEST.rst.txt b/cmake/doc/cmake/html/_sources/prop_tgt/XCTEST.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..67e9a70459628436efbf90ad0dd7d8ba34892ca3 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/prop_tgt/XCTEST.rst.txt @@ -0,0 +1,15 @@ +XCTEST +------ + +.. versionadded:: 3.3 + +This target is a XCTest CFBundle on the Mac. + +This property will usually get set via the :command:`xctest_add_bundle` +macro in :module:`FindXCTest` module. + +If a module library target has this property set to true it will be +built as a CFBundle when built on the Mac. It will have the directory +structure required for a CFBundle. + +This property depends on :prop_tgt:`BUNDLE` to be effective. diff --git a/cmake/doc/cmake/html/_sources/release/3.0.rst.txt b/cmake/doc/cmake/html/_sources/release/3.0.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..e37c1309472e73d357513ca6e407772655dc2767 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/release/3.0.rst.txt @@ -0,0 +1,473 @@ +CMake 3.0 Release Notes +*********************** + +.. only:: html + + .. contents:: + +Changes made since CMake 2.8.12 include the following. + +Documentation Changes +===================== + +* The CMake documentation has been converted to reStructuredText and + now transforms via Sphinx (``__) into man and + html pages. This allows the documentation to be properly indexed + and to contain cross-references. + + Conversion from the old internal documentation format was done by + an automatic process so some documents may still contain artifacts. + They will be updated incrementally over time. + + A basic reStructuredText processor has been implemented to support + ``cmake --help-command`` and similar command-line options. + +* New manuals were added: + + - :manual:`cmake-buildsystem(7)` + - :manual:`cmake-commands(7)`, replacing ``cmakecommands(1)`` + and ``cmakecompat(1)`` + - :manual:`cmake-developer(7)` + - :manual:`cmake-generator-expressions(7)` + - :manual:`cmake-generators(7)` + - :manual:`cmake-language(7)` + - :manual:`cmake-modules(7)`, replacing ``cmakemodules(1)`` + - :manual:`cmake-packages(7)` + - :manual:`cmake-policies(7)`, replacing ``cmakepolicies(1)`` + - :manual:`cmake-properties(7)`, replacing ``cmakeprops(1)`` + - :manual:`cmake-qt(7)` + - :manual:`cmake-toolchains(7)` + - :manual:`cmake-variables(7)`, replacing ``cmakevars(1)`` + +* Release notes for CMake 3.0.0 and above will now be included with + the html documentation. + +New Features +============ + +Syntax +------ + +* The CMake language has been extended with + :ref:`Bracket Argument` and :ref:`Bracket Comment` + syntax inspired by Lua long brackets:: + + set(x [===[bracket argument]===] #[[bracket comment]]) + + Content between equal-length open- and close-brackets is taken + literally with no variable replacements. + + .. warning:: + This syntax change could not be made in a fully compatible + way. No policy is possible because syntax parsing occurs before + any chance to set a policy. Existing code using an unquoted + argument that starts with an open bracket will be interpreted + differently without any diagnostic. Fortunately the syntax is + obscure enough that this problem is unlikely in practice. + +Generators +---------- + +* A new :generator:`CodeLite` extra generator is available + for use with the Makefile or Ninja generators. + +* A new :generator:`Kate` extra generator is available + for use with the Makefile or Ninja generators. + +* The :generator:`Ninja` generator learned to use ``ninja`` job pools + when specified by a new :prop_gbl:`JOB_POOLS` global property. + +Commands +-------- + +* The :command:`add_library` command learned a new ``INTERFACE`` + library type. Interface libraries have no build rules but may + have properties defining + :manual:`usage requirements ` + and may be installed, exported, and imported. This is useful to + create header-only libraries that have concrete link dependencies + on other libraries. + +* The :command:`export()` command learned a new ``EXPORT`` mode that + retrieves the list of targets to export from an export set configured + by the :command:`install(TARGETS)` command ``EXPORT`` option. This + makes it easy to export from the build tree the same targets that + are exported from the install tree. + +* The :command:`export` command learned to work with multiple dependent + export sets, thus allowing multiple packages to be built and exported + from a single tree. The feature requires CMake to wait until the + generation step to write the output file. This means one should not + :command:`include` the generated targets file later during project + configuration because it will not be available. + Use :ref:`Alias Targets` instead. See policy :policy:`CMP0024`. + +* The :command:`install(FILES)` command learned to support + :manual:`generator expressions ` + in the list of files. + +* The :command:`project` command learned to set some version variables + to values specified by the new ``VERSION`` option or to empty strings. + See policy :policy:`CMP0048`. + +* The :command:`string` command learned a new ``CONCAT`` mode. + It is particularly useful in combination with the new + :ref:`Bracket Argument` syntax. + +* The :command:`unset` command learned a ``PARENT_SCOPE`` option + matching that of the :command:`set` command. + +* The :command:`include_external_msproject` command learned + to handle non-C++ projects like ``.vbproj`` or ``.csproj``. + +* The :command:`ctest_update` command learned to update work trees + managed by the Perforce (p4) version control tool. + +* The :command:`message` command learned a ``DEPRECATION`` mode. Such + messages are not issued by default, but may be issued as a warning if + :variable:`CMAKE_WARN_DEPRECATED` is enabled, or as an error if + :variable:`CMAKE_ERROR_DEPRECATED` is enabled. + +* The :command:`target_link_libraries` command now allows repeated use of + the ``LINK_PUBLIC`` and ``LINK_PRIVATE`` keywords. + +Variables +--------- + +* Variable :variable:`CMAKE_FIND_NO_INSTALL_PREFIX` has been + introduced to tell CMake not to add the value of + :variable:`CMAKE_INSTALL_PREFIX` to the + :variable:`CMAKE_SYSTEM_PREFIX_PATH` variable by default. + This is useful when building a project that installs some + of its own dependencies to avoid finding files it is about + to replace. + +* Variable :variable:`CMAKE_STAGING_PREFIX` was introduced for use + when cross-compiling to specify an installation prefix on the + host system that differs from a :variable:`CMAKE_INSTALL_PREFIX` + value meant for the target system. + +* Variable :variable:`CMAKE_SYSROOT` was introduced to specify the + toolchain SDK installation prefix, typically for cross-compiling. + This is used to pass a ``--sysroot`` option to the compiler and + as a prefix searched by ``find_*`` commands. + +* Variable :variable:`CMAKE__COMPILER_TARGET` was introduced + for use when cross-compiling to specify the target platform in the + :ref:`toolchain file ` specified by the + :variable:`CMAKE_TOOLCHAIN_FILE` variable. + This is used to pass an option such as ``--target=`` to some + cross-compiling compiler drivers. + +* Variable :variable:`CMAKE_MAP_IMPORTED_CONFIG_` has been + introduced to optionally initialize the + :prop_tgt:`MAP_IMPORTED_CONFIG_` target property. + +Properties +---------- + +* The :prop_dir:`ADDITIONAL_MAKE_CLEAN_FILES` directory property + learned to support + :manual:`generator expressions `. + +* A new directory property :prop_dir:`CMAKE_CONFIGURE_DEPENDS` + was introduced to allow projects to specify additional + files on which the configuration process depends. CMake will + re-run at build time when one of these files is modified. + Previously this was only possible to achieve by specifying + such files as the input to a :command:`configure_file` command. + +* A new :ref:`Qt AUTORCC` feature replaces the need to + invoke ``qt4_add_resources()`` by allowing ``.qrc`` files to + be listed as target sources. + +* A new :ref:`Qt AUTOUIC` feature replaces the need to + invoke ``qt4_wrap_ui()``. + +* Test properties learned to support + :manual:`generator expressions `. + This is useful to specify per-configuration values for test + properties like :prop_test:`REQUIRED_FILES` and + :prop_test:`WORKING_DIRECTORY`. + +* A new :prop_test:`SKIP_RETURN_CODE` test property was introduced + to tell :manual:`ctest(1)` to treat a particular test return code as + if the test were not run. This is useful for test drivers to report + that certain test requirements were not available. + +* New types of :ref:`Compatible Interface Properties` were introduced, + namely the :prop_tgt:`COMPATIBLE_INTERFACE_NUMBER_MAX` and + :prop_tgt:`COMPATIBLE_INTERFACE_NUMBER_MIN` for calculating numeric + maximum and minimum values respectively. + +Modules +------- + +* The :module:`CheckTypeSize` module ``check_type_size`` macro and + the :module:`CheckStructHasMember` module ``check_struct_has_member`` + macro learned a new ``LANGUAGE`` option to optionally check C++ types. + +* The :module:`ExternalData` module learned to work with no + URL templates if a local store is available. + +* The :module:`ExternalProject` function ``ExternalProject_Add`` + learned a new ``GIT_SUBMODULES`` option to specify a subset + of available submodules to checkout. + +* A new :module:`FindBacktrace` module has been added to support + :command:`find_package(Backtrace)` calls. + +* A new :module:`FindLua` module has been added to support + :command:`find_package(Lua)` calls. + +* The :module:`FindBoost` module learned a new ``Boost_NAMESPACE`` + option to change the ``boost`` prefix on library names. + +* The :module:`FindBoost` module learned to control search + for libraries with the ``g`` tag (for MS debug runtime) with + a new ``Boost_USE_DEBUG_RUNTIME`` option. It is ``ON`` by + default to preserve existing behavior. + +* The :module:`FindJava` and :module:`FindJNI` modules learned + to use a ``JAVA_HOME`` CMake variable or environment variable, + and then try ``/usr/libexec/java_home`` on OS X. + +* The :module:`UseJava` module ``add_jar`` function learned a new + ``MANIFEST`` option to pass the ``-m`` option to ``jar``. + +* A new :module:`CMakeFindDependencyMacro` module was introduced with + a ``find_dependency`` macro to find transitive dependencies in + a :manual:`package configuration file `. Such + dependencies are omitted by the listing of the :module:`FeatureSummary` + module. + +* The :module:`FindQt4` module learned to create :ref:`Imported Targets` + for Qt executables. This helps disambiguate when using multiple + :manual:`Qt versions ` in the same buildsystem. + +* The :module:`FindRuby` module learned to search for Ruby 2.0 and 2.1. + +Generator Expressions +--------------------- + +* New ``$`` and ``$`` + :manual:`generator expressions ` + have been added. + +* The ``$`` + :manual:`generator expression ` now has + a variant which takes no argument. This is equivalent to the + ``$`` expression. + +* New ``$`` and ``$`` + :manual:`generator expressions ` + generator expressions have been added. + +* A new ``$`` + :manual:`generator expression ` has + been added. + +Other +----- + +* The :manual:`cmake(1)` ``-E`` option learned a new ``sleep`` command. + +* The :manual:`ccmake(1)` dialog learned to honor the + :prop_cache:`STRINGS` cache entry property to cycle through + the enumerated list of possible values. + +* The :manual:`cmake-gui(1)` dialog learned to remember window + settings between sessions. + +* The :manual:`cmake-gui(1)` dialog learned to remember the type + of a cache entry for completion in the ``Add Entry`` dialog. + +New Diagnostics +=============== + +* Directories named in the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` + target property of imported targets linked conditionally by a + :manual:`generator expression ` + were not checked for existence. Now they are checked. + See policy :policy:`CMP0027`. + +* Build target names must now match a validity pattern and may no longer + conflict with CMake-defined targets. See policy :policy:`CMP0037`. + +* Build targets that specify themselves as a link dependency were + silently accepted but are now diagnosed. See :policy:`CMP0038`. + +* The :command:`target_link_libraries` command used to silently ignore + calls specifying as their first argument build targets created by + :command:`add_custom_target` but now diagnoses this mistake. + See policy :policy:`CMP0039`. + +* The :command:`add_custom_command` command used to silently ignore + calls specifying the ``TARGET`` option with a non-existent target + but now diagnoses this mistake. See policy :policy:`CMP0040`. + +* Relative paths in the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` + target property used to be silently accepted if they contained a + :manual:`generator expression ` + but are now rejected. See policy :policy:`CMP0041`. + +* The :command:`get_target_property` command learned to reject calls + specifying a non-existent target. See policy :policy:`CMP0045`. + +* The :command:`add_dependencies` command learned to reject calls + specifying a dependency on a non-existent target. + See policy :policy:`CMP0046`. + +* Link dependency analysis learned to assume names containing ``::`` + refer to :ref:`Alias Targets` or :ref:`Imported Targets`. It will + now produce an error if such a linked target is missing. Previously + in this case CMake generated a link line that failed at build time. + See policy :policy:`CMP0028`. + +* When the :command:`project` or :command:`enable_language` commands + initialize support for a language, it is now an error if the full + path to the compiler cannot be found and stored in the corresponding + :variable:`CMAKE__COMPILER` variable. This produces nicer error + messages up front and stops processing when no working compiler + is known to be available. + +* Target sources specified with the :command:`add_library` or + :command:`add_executable` command learned to reject items which + require an undocumented extra layer of variable expansion. + See policy :policy:`CMP0049`. + +* Use of :command:`add_custom_command` undocumented ``SOURCE`` + signatures now results in an error. See policy :policy:`CMP0050`. + +Deprecated and Removed Features +=============================== + +* Compatibility options supporting code written for CMake versions + prior to 2.4 have been removed. + +* Several long-outdated commands that should no longer be called + have been disallowed in new code by policies: + + - Policy :policy:`CMP0029` disallows :command:`subdir_depends` + - Policy :policy:`CMP0030` disallows :command:`use_mangled_mesa` + - Policy :policy:`CMP0031` disallows :command:`load_command` + - Policy :policy:`CMP0032` disallows :command:`output_required_files` + - Policy :policy:`CMP0033` disallows :command:`export_library_dependencies` + - Policy :policy:`CMP0034` disallows :command:`utility_source` + - Policy :policy:`CMP0035` disallows :command:`variable_requires` + - Policy :policy:`CMP0036` disallows :command:`build_name` + +* The :manual:`cmake(1)` ``-i`` wizard mode has been removed. + Instead use an interactive dialog such as :manual:`ccmake(1)` + or use the ``-D`` option to set cache values from the command line. + +* The builtin documentation formatters that supported command-line + options such as ``--help-man`` and ``--help-html`` have been removed + in favor of the above-mentioned new documentation system. These and + other command-line options that used to generate man- and html- + formatted pages no longer work. The :manual:`cmake(1)` + ``--help-custom-modules`` option now produces a warning at runtime + and generates a minimal document that reports the limitation. + +* The :prop_dir:`COMPILE_DEFINITIONS_` directory properties and the + :prop_tgt:`COMPILE_DEFINITIONS_` target properties have been + deprecated. Instead set the corresponding :prop_dir:`COMPILE_DEFINITIONS` + directory property or :prop_tgt:`COMPILE_DEFINITIONS` target property and + use :manual:`generator expressions ` like + ``$`` to specify per-configuration definitions. + See policy :policy:`CMP0043`. + +* The :prop_tgt:`LOCATION` target property should no longer be read from + non-IMPORTED targets. It does not make sense in multi-configuration + generators since the build configuration is not known while configuring + the project. It has been superseded by the ``$`` generator + expression. See policy :policy:`CMP0026`. + +* The :prop_tgt:`COMPILE_FLAGS` target property is now documented + as deprecated, though no warning is issued. Use the + :prop_tgt:`COMPILE_OPTIONS` target property or the + :command:`target_compile_options` command instead. + +* The :module:`GenerateExportHeader` module ``add_compiler_export_flags`` + function is now deprecated. It has been superseded by the + :prop_tgt:`_VISIBILITY_PRESET` and + :prop_tgt:`VISIBILITY_INLINES_HIDDEN` target properties. + +Other Changes +============= + +* The version scheme was changed to use only two components for + the feature level instead of three. The third component will + now be used for bug-fix releases or the date of development versions. + See the :variable:`CMAKE_VERSION` variable documentation for details. + +* The default install locations of CMake itself on Windows and + OS X no longer contain the CMake version number. This allows + for easy replacement without re-generating local build trees + manually. + +* Generators for Visual Studio 10 (2010) and later were renamed to + include the product year like generators for older VS versions: + + - ``Visual Studio 10`` -> :generator:`Visual Studio 10 2010` + - ``Visual Studio 11`` -> :generator:`Visual Studio 11 2012` + - ``Visual Studio 12`` -> :generator:`Visual Studio 12 2013` + + This clarifies which generator goes with each Visual Studio + version. The old names are recognized for compatibility. + +* The :variable:`CMAKE__COMPILER_ID` value for Apple-provided + Clang is now ``AppleClang``. It must be distinct from upstream + Clang because the version numbers differ. + See policy :policy:`CMP0025`. + +* The :variable:`CMAKE__COMPILER_ID` value for ``qcc`` on QNX + is now ``QCC``. It must be distinct from ``GNU`` because the + command-line options differ. See policy :policy:`CMP0047`. + +* On 64-bit OS X the :variable:`CMAKE_HOST_SYSTEM_PROCESSOR` value + is now correctly detected as ``x86_64`` instead of ``i386``. + +* On OS X, CMake learned to enable behavior specified by the + :prop_tgt:`MACOSX_RPATH` target property by default. This activates + use of ``@rpath`` for runtime shared library searches. + See policy :policy:`CMP0042`. + +* The :command:`build_command` command now returns a :manual:`cmake(1)` + ``--build`` command line instead of a direct invocation of the native + build tool. When using ``Visual Studio`` generators, CMake and CTest + no longer require :variable:`CMAKE_MAKE_PROGRAM` to be located up front. + Selection of the proper msbuild or devenv tool is now performed as + late as possible when the solution (``.sln``) file is available so + it can depend on project content. + +* The :manual:`cmake(1)` ``--build`` command now shares its own stdout + and stderr pipes with the native build tool by default. + The ``--use-stderr`` option that once activated this is now ignored. + +* The ``$`` and ``$`` + :manual:`generator expressions ` + used to perform case-insensitive comparison but have now been + corrected to perform case-sensitive comparison. + See policy :policy:`CMP0044`. + +* The builtin ``edit_cache`` target will no longer select + :manual:`ccmake(1)` by default when no interactive terminal will + be available (e.g. with :generator:`Ninja` or an IDE generator). + Instead :manual:`cmake-gui(1)` will be preferred if available. + +* The :module:`ExternalProject` download step learned to + re-attempt download in certain cases to be more robust to + temporary network failure. + +* The :module:`FeatureSummary` no longer lists transitive + dependencies since they were not directly requested by the + current project. + +* The ``cmake-mode.el`` major Emacs editing mode has been cleaned + up and enhanced in several ways. + +* Include directories specified in the + :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` of :ref:`Imported Targets` + are treated as ``SYSTEM`` includes by default when handled as + :ref:`usage requirements `. diff --git a/cmake/doc/cmake/html/_sources/release/3.1.rst.txt b/cmake/doc/cmake/html/_sources/release/3.1.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..3f4712b84a86a87c209bd5ea5f7b05c94c4776c2 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/release/3.1.rst.txt @@ -0,0 +1,425 @@ +CMake 3.1 Release Notes +*********************** + +.. only:: html + + .. contents:: + +Changes made since CMake 3.0 include the following. + +Documentation Changes +===================== + +* A new :manual:`cmake-compile-features(7)` manual was added. + +New Features +============ + +Generators +---------- + +* The :generator:`Visual Studio 14 2015` generator was added. + +Windows Phone and Windows Store +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +* Generators for Visual Studio 11 (2012) and above learned to generate + projects for Windows Phone and Windows Store. One may set the + :variable:`CMAKE_SYSTEM_NAME` variable to ``WindowsPhone`` + or ``WindowsStore`` on the :manual:`cmake(1)` command-line + or in a :variable:`CMAKE_TOOLCHAIN_FILE` to activate these platforms. + Also set :variable:`CMAKE_SYSTEM_VERSION` to ``8.0`` or ``8.1`` to + specify the version of Windows to be targeted. + +NVIDIA Nsight Tegra +^^^^^^^^^^^^^^^^^^^ + +* Generators for Visual Studio 10 (2010) and above learned to generate + projects for NVIDIA Nsight Tegra Visual Studio Edition. One may set + the :variable:`CMAKE_SYSTEM_NAME` variable to ``Android`` on the + :manual:`cmake(1)` command-line or in a :variable:`CMAKE_TOOLCHAIN_FILE` + to activate this platform. + +Syntax +------ + +* The :manual:`cmake-language(7)` syntax for :ref:`Variable References` and + :ref:`Escape Sequences` was simplified in order to allow a much faster + implementation. See policy :policy:`CMP0053`. + +* The :command:`if` command no longer automatically dereferences + variables named in quoted or bracket arguments. See policy + :policy:`CMP0054`. + +Commands +-------- + +* The :command:`add_custom_command` command learned to interpret + :manual:`cmake-generator-expressions(7)` in arguments to ``DEPENDS``. + +* The :command:`export(PACKAGE)` command learned to check the + :variable:`CMAKE_EXPORT_NO_PACKAGE_REGISTRY` variable to skip + exporting the package. + +* The :command:`file(STRINGS)` command gained a new ``ENCODING`` + option to enable extraction of ``UTF-8`` strings. + +* The :command:`find_package` command learned to check the + :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` and + :variable:`CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY` + variables to skip searching the package registries. + +* The :command:`get_property` command learned a new ``INSTALL`` scope + for properties. + +* The :command:`install` command learned a ``MESSAGE_NEVER`` option + to avoid output during installation. + +* The :command:`set_property` command learned a new ``INSTALL`` scope + for properties. + +* The :command:`string` command learned a new ``GENEX_STRIP`` subcommand + which removes + :manual:`generator expression `. + +* The :command:`string` command learned a new ``UUID`` subcommand + to generate a universally unique identifier. + +* New :command:`target_compile_features` command allows populating the + :prop_tgt:`COMPILE_FEATURES` target property, just like any other + build variable. + +* The :command:`target_sources` command was added to add to the + :prop_tgt:`SOURCES` target property. + +Variables +--------- + +* The Visual Studio generators for versions 8 (2005) and above + learned to read the target platform name from a new + :variable:`CMAKE_GENERATOR_PLATFORM` variable when it is + not specified as part of the generator name. The platform + name may be specified on the :manual:`cmake(1)` command line + with the ``-A`` option, e.g. ``-G "Visual Studio 12 2013" -A x64``. + +* The :variable:`CMAKE_GENERATOR_TOOLSET` variable may now be + initialized in a toolchain file specified by the + :variable:`CMAKE_TOOLCHAIN_FILE` variable. This is useful + when cross-compiling with the Xcode or Visual Studio + generators. + +* The :variable:`CMAKE_INSTALL_MESSAGE` variable was introduced to + optionally reduce output installation. + +Properties +---------- + +* New :prop_tgt:`CXX_STANDARD` and :prop_tgt:`CXX_EXTENSIONS` target + properties may specify values which CMake uses to compute required + compile options such as ``-std=c++11`` or ``-std=gnu++11``. The + :variable:`CMAKE_CXX_STANDARD` and :variable:`CMAKE_CXX_EXTENSIONS` + variables may be set to initialize the target properties. + +* New :prop_tgt:`C_STANDARD` and :prop_tgt:`C_EXTENSIONS` target + properties may specify values which CMake uses to compute required + compile options such as ``-std=c11`` or ``-std=gnu11``. The + :variable:`CMAKE_C_STANDARD` and :variable:`CMAKE_C_EXTENSIONS` + variables may be set to initialize the target properties. + +* New :prop_tgt:`COMPILE_FEATURES` target property may contain a list + of features required to compile a target. CMake uses this + information to ensure that the compiler in use is capable of building + the target, and to add any necessary compile flags to support language + features. + +* New :prop_tgt:`COMPILE_PDB_NAME` and + :prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY` target properties + were introduced to specify the MSVC compiler program database + file location (``cl /Fd``). This complements the existing + :prop_tgt:`PDB_NAME` and :prop_tgt:`PDB_OUTPUT_DIRECTORY` + target properties that specify the linker program database + file location (``link /pdb``). + +* The :prop_tgt:`INTERFACE_LINK_LIBRARIES` target property now supports + a ``$`` + :manual:`generator expression `. + +* A new :prop_tgt:`INTERFACE_SOURCES` target property was introduced. This is + consumed by dependent targets, which compile and link the listed sources. + +* The :prop_tgt:`SOURCES` target property now contains + :manual:`generator expression ` + such as ``TARGET_OBJECTS`` when read at configure time, if + policy :policy:`CMP0051` is ``NEW``. + +* The :prop_tgt:`SOURCES` target property now generally supports + :manual:`generator expression `. The + generator expressions may be used in the :command:`add_library` and + :command:`add_executable` commands. + +* It is now possible to write and append to the :prop_tgt:`SOURCES` target + property. The :variable:`CMAKE_DEBUG_TARGET_PROPERTIES` variable may be + used to trace the origin of sources. + +* A :prop_sf:`VS_DEPLOYMENT_CONTENT` source file property was added + to tell the Visual Studio generators to mark content for deployment + in Windows Phone and Windows Store projects. + +* A :prop_sf:`VS_DEPLOYMENT_LOCATION` source file property was added + to tell the Visual Studio generators the relative location of content + marked for deployment in Windows Phone and Windows Store projects. + +* The :prop_tgt:`VS_WINRT_COMPONENT` target property was created to + tell Visual Studio generators to compile a shared library as a + Windows Runtime (WinRT) component. + +* The :generator:`Xcode` generator learned to check source + file properties :prop_sf:`XCODE_EXPLICIT_FILE_TYPE` and + :prop_sf:`XCODE_LAST_KNOWN_FILE_TYPE` for a custom Xcode + file reference type. + +Modules +------- + +* The :module:`BundleUtilities` module learned to resolve and replace + ``@rpath`` placeholders on OS X to correctly bundle applications + using them. + +* The :module:`CMakePackageConfigHelpers` module + :command:`configure_package_config_file` command learned a new + ``INSTALL_PREFIX`` option to generate package configuration files + meant for a prefix other than :variable:`CMAKE_INSTALL_PREFIX`. + +* The :module:`CheckFortranSourceCompiles` module was added to + provide a ``CHECK_Fortran_SOURCE_COMPILES`` macro. + +* The :module:`ExternalData` module learned to tolerate a ``DATA{}`` + reference to a missing source file with a warning instead of + rejecting it with an error. This helps developers write new + ``DATA{}`` references to test reference outputs that have not + yet been created. + +* The :module:`ExternalProject` module learned to support lzma-compressed + source tarballs with ``.7z``, ``.tar.xz``, and ``.txz`` extensions. + +* The :module:`ExternalProject` module ``ExternalProject_Add`` command + learned a new ``BUILD_ALWAYS`` option to cause the external project + build step to run every time the host project is built. + +* The :module:`ExternalProject` module ``ExternalProject_Add`` command + learned a new ``EXCLUDE_FROM_ALL`` option to cause the external + project target to have the :prop_tgt:`EXCLUDE_FROM_ALL` target + property set. + +* The :module:`ExternalProject` module ``ExternalProject_Add_Step`` command + learned a new ``EXCLUDE_FROM_MAIN`` option to cause the step to not be + a direct dependency of the main external project target. + +* The :module:`ExternalProject` module ``ExternalProject_Add`` command + learned a new ``DOWNLOAD_NO_PROGRESS`` option to disable progress + output while downloading the source tarball. + +* The :module:`FeatureSummary` module ``feature_summary`` API + learned to accept multiple values for the ``WHAT`` option and + combine them appropriately. + +* The :module:`FindCUDA` module learned to support ``fatbin`` and ``cubin`` + modules. + +* The :module:`FindGTest` module ``gtest_add_tests`` macro learned + a new ``AUTO`` option to automatically read the :prop_tgt:`SOURCES` + target property of the test executable and scan the source files + for tests to be added. + +* The :module:`FindGLEW` module now provides imported targets. + +* The :module:`FindGLUT` module now provides imported targets. + +* The :module:`FindHg` module gained a new ``Hg_WC_INFO`` macro to + help run ``hg`` to extract information about a Mercurial work copy. + +* The :module:`FindOpenCL` module was introduced. + +* The :module:`FindOpenMP` module learned to support Fortran. + +* The :module:`FindPkgConfig` module learned to use the ``PKG_CONFIG`` + environment variable value as the ``pkg-config`` executable, if set. + +* The :module:`FindXercesC` module was introduced. + +* The :module:`FindZLIB` module now provides imported targets. + +* The :module:`GenerateExportHeader` module ``generate_export_header`` + function learned to allow use with :ref:`Object Libraries`. + +* The :module:`InstallRequiredSystemLibraries` module gained a new + ``CMAKE_INSTALL_OPENMP_LIBRARIES`` option to install MSVC OpenMP + runtime libraries. + +* The :module:`UseSWIG` module learned to detect the module name + from ``.i`` source files if possible to avoid the need to set + the ``SWIG_MODULE_NAME`` source file property explicitly. + +* The :module:`WriteCompilerDetectionHeader` module was added to allow + creation of a portable header file for compiler optional feature detection. + +Generator Expressions +--------------------- + +* New ``COMPILE_FEATURES`` + :manual:`generator expression ` allows + setting build properties based on available compiler features. + +CTest +----- + +* The :command:`ctest_coverage` command learned to read variable + ``CTEST_COVERAGE_EXTRA_FLAGS`` to set ``CoverageExtraFlags``. + +* The :command:`ctest_coverage` command learned to support + Intel coverage files with the ``codecov`` tool. + +* The :command:`ctest_memcheck` command learned to support sanitizer + modes, including ``AddressSanitizer``, ``MemorySanitizer``, + ``ThreadSanitizer``, and ``UndefinedBehaviorSanitizer``. + Options may be set using the new + :variable:`CTEST_MEMORYCHECK_SANITIZER_OPTIONS` variable. + +CPack +----- + +* :manual:`cpack(1)` gained an ``IFW`` generator to package using + Qt Framework Installer tools. See the :cpack_gen:`CPack IFW Generator`. + +* :manual:`cpack(1)` gained ``7Z`` and ``TXZ`` generators supporting + lzma-compressed archives. + +* The :cpack_gen:`CPack DEB Generator` learned a new + :variable:`CPACK_DEBIAN_COMPRESSION_TYPE` variable to set the + tarball compression type. + +* The :cpack_gen:`CPack WIX Generator` learned to support + a :prop_inst:`CPACK_WIX_ACL` installed file property to + specify an Access Control List. + +Other +----- + +* The :manual:`cmake(1)` ``-E`` option learned a new ``env`` command. + +* The :manual:`cmake(1)` ``-E tar`` command learned to support + lzma-compressed files. + +* :ref:`Object Libraries` may now have extra sources that do not + compile to object files so long as they would not affect linking + of a normal library (e.g. ``.dat`` is okay but not ``.def``). + +* Visual Studio generators for VS 8 and later learned to support + the ``ASM_MASM`` language. + +* The Visual Studio generators learned to treat ``.hlsl`` source + files as High Level Shading Language sources (using ``FXCompile`` + in ``.vcxproj`` files). Source file properties + :prop_sf:`VS_SHADER_TYPE`, :prop_sf:`VS_SHADER_MODEL`, and + :prop_sf:`VS_SHADER_ENTRYPOINT` were added added to specify the + shader type, model, and entry point name. + +New Diagnostics +=============== + +* Policy :policy:`CMP0052` introduced to control directories in the + :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` of exported targets. + +Deprecated and Removed Features +=============================== + +* In CMake 3.0 the :command:`target_link_libraries` command + accidentally began allowing unquoted arguments to use + :manual:`generator expressions ` + containing a (``;`` separated) list within them. For example:: + + set(libs B C) + target_link_libraries(A PUBLIC $) + + This is equivalent to writing:: + + target_link_libraries(A PUBLIC $) + + and was never intended to work. It did not work in CMake 2.8.12. + Such generator expressions should be in quoted arguments:: + + set(libs B C) + target_link_libraries(A PUBLIC "$") + + CMake 3.1 again requires the quotes for this to work correctly. + +* Prior to CMake 3.1 the Makefile generators did not escape ``#`` + correctly inside make variable assignments used in generated + makefiles, causing them to be treated as comments. This made + code like:: + + add_compile_options(-Wno-#pragma-messages) + + not work in Makefile generators, but work in other generators. + Now it is escaped correctly, making the behavior consistent + across generators. However, some projects may have tried to + workaround the original bug with code like:: + + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-\\#pragma-messages") + + This added the needed escape for Makefile generators but also + caused other generators to pass ``-Wno-\#pragma-messages`` to + the shell, which would work only in POSIX shells. + Unfortunately the escaping fix could not be made in a compatible + way so this platform- and generator-specific workaround no + longer works. Project code may test the :variable:`CMAKE_VERSION` + variable value to make the workaround version-specific too. + +* Callbacks established by the :command:`variable_watch` command will no + longer receive the ``ALLOWED_UNKNOWN_READ_ACCESS`` access type when + the undocumented ``CMAKE_ALLOW_UNKNOWN_VARIABLE_READ_ACCESS`` variable is + set. Uninitialized variable accesses will always be reported as + ``UNKNOWN_READ_ACCESS``. + +* The :module:`CMakeDetermineVSServicePack` module now warns that + it is deprecated and should not longer be used. Use the + :variable:`CMAKE__COMPILER_VERSION` variable instead. + +* The :module:`FindITK` module has been removed altogether. + It was a thin-wrapper around ``find_package(ITK ... NO_MODULE)``. + This produces much clearer error messages when ITK is not found. + +* The :module:`FindVTK` module has been removed altogether. + It was a thin-wrapper around ``find_package(VTK ... NO_MODULE)``. + This produces much clearer error messages when VTK is not found. + + The module also provided compatibility support for finding VTK 4.0. + This capability has been dropped. + +Other Changes +============= + +* The :manual:`cmake-gui(1)` learned to capture output from child + processes started by the :command:`execute_process` command + and display it in the output window. + +* The :manual:`cmake-language(7)` internal implementation of generator + expression and list expansion parsers have been optimized and shows + non-trivial speedup on large projects. + +* The Makefile generators learned to use response files with GNU tools + on Windows to pass library directories and names to the linker. + +* When generating linker command-lines, CMake now avoids repeating + items corresponding to SHARED library targets. + +* Support for the Open Watcom compiler has been overhauled. + The :variable:`CMAKE__COMPILER_ID` is now ``OpenWatcom``, + and the :variable:`CMAKE__COMPILER_VERSION` now uses + the Open Watcom external version numbering. The external + version numbers are lower than the internal version number + by 11. + +* The ``cmake-mode.el`` major Emacs editing mode no longer + treats ``_`` as part of words, making it more consistent + with other major modes. diff --git a/cmake/doc/cmake/html/_sources/release/3.10.rst.txt b/cmake/doc/cmake/html/_sources/release/3.10.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..03fce92e4d900cbdc4744b15262fb0ea27dc1465 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/release/3.10.rst.txt @@ -0,0 +1,282 @@ +CMake 3.10 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.9 include the following. + +New Features +============ + +Platforms +--------- + +* The `flang`_ Fortran compiler is now supported, with compiler id ``Flang``. + +* A new minimal platform file for ``Midipix`` was added. + +* Support for the MSVC ARM64 architecture was added. + Visual Studio 2017 Update 4 and above offer an ARM64 toolchain. + +* Support for the IAR ARM Compiler was improved. + +.. _`flang`: https://github.com/flang-compiler/flang + +Generators +---------- + +* The :ref:`Makefile Generators` and the :generator:`Ninja` generator learned + to add compiler launcher tools like ccache along with the compiler for the + ``CUDA`` language (``C`` and ``CXX`` were supported previously). See the + :variable:`CMAKE__COMPILER_LAUNCHER` variable and + :prop_tgt:`_COMPILER_LAUNCHER` target property for details. + +* The :generator:`CodeBlocks` extra generator learned to optionally exclude + files from outside the project root directory from the generated project. + See the :variable:`CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES` variable. + +Commands +-------- + +* The :command:`cmake_host_system_information` command learned more keys + to get information about the processor capabilities and the host OS + version. + +* The :command:`configure_file` command learned to support indented + ``# cmakedefine`` and ``# cmakedefine01``. Spaces and/or tabs between + the ``#`` character and the ``cmakedefine``/``cmakedefine01`` words + are now understood and preserved in the output. + +* The :command:`execute_process` command gained a ``RESULTS_VARIABLE`` + option to collect a list of results from all children in a pipeline + of processes when multiple ``COMMAND`` arguments are given. + +* The :command:`include_guard` command was introduced to allow guarding + CMake scripts from being included more than once. The command supports + ``DIRECTORY`` and ``GLOBAL`` options to adjust the corresponding include guard + scope. If no options given, include guard is similar to basic variable-based + check. + +* The :command:`string` command learned a new ``PREPEND`` subcommand. + +* The :command:`string(TIMESTAMP)` command now supports ``%A`` + for full weekday name and ``%B`` for full month name. + +Variables +--------- + +* A :variable:`CMAKE_DIRECTORY_LABELS` variable was added to specify + labels for all tests in a directory. + +Properties +---------- + +* A :prop_tgt:`_CPPCHECK` target property and supporting + :variable:`CMAKE__CPPCHECK` variable were introduced to tell + the :ref:`Makefile Generators` and the :generator:`Ninja` generator to + run ``cppcheck`` with the compiler for ``C`` and ``CXX`` languages. + +* A :prop_dir:`LABELS` directory property was added to specify labels + for all targets and tests in a directory. + +* A :prop_dir:`TEST_INCLUDE_FILES` directory property was added to + list any number of files to be included when running tests with + :manual:`ctest(1)`. This generalizes the :prop_dir:`TEST_INCLUDE_FILE` + property. + +* The :prop_tgt:`VS_DOTNET_REFERENCEPROP__TAG_` + target property was added to support custom XML tags for reference + assemblies in C# targets. + +* Source file properties :prop_sf:`VS_SHADER_OUTPUT_HEADER_FILE` and + :prop_sf:`VS_SHADER_VARIABLE_NAME` have been added to specify more + details of ``.hlsl`` sources with :ref:`Visual Studio Generators`. + +Modules +------- + +* The :module:`FindCurses` module gained a ``CURSES_NEED_WIDE`` option + to request the wide-character variant. + +* The :module:`FindEXPAT` module now provides imported targets. + +* The :module:`FindFreetype` module now provides imported targets. + +* :module:`FindMPI` gained a number of new features, including: + + * Language-specific components have been added to the module. + * Many more MPI environments are now supported. + * The environmental support for Fortran has been improved. + * A user now has fine-grained control over the MPI selection process, + including passing custom parameters to the MPI compiler. + * The version of the implemented MPI standard is now being exposed. + * MPI-2 C++ bindings can now be detected and also suppressed if so desired. + * The available Fortran bindings are now being detected and verified. + * Various MPI-3 information can be requested, including the library version + and Fortran capabilities of the individual bindings. + * Statically linked MPI implementations are supported. + +* A :module:`FindOpenACC` module was added to detect compiler support + for OpenACC. Currently only supports PGI, GNU and Cray compilers. + +* The :module:`FindOpenGL` module gained support for GLVND on Linux. + +* The :module:`FindOpenMP` module gained support for + language-specific components. + +* A :module:`FindPatch` module was added to find the ``patch`` + command-line executable. + +* The :module:`FindProtobuf` module :command:`protobuf_generate_cpp` command + gained a ``DESCRIPTORS`` option to generate descriptor files. + +* The :module:`GoogleTest` module gained a new command + :command:`gtest_discover_tests` implementing dynamic (build-time) test + discovery. Unlike the source parsing approach, dynamic discovery executes + the test (in 'list available tests' mode) at build time to discover tests. + This is robust against unusual ways of labeling tests, provides much better + support for advanced features such as parameterized tests, and does not + require re-running CMake to discover added or removed tests within a test + executable. Note that a breaking change was made in CMake 3.10.3 to address + an ambiguity of the ``TIMEOUT`` keyword (see :ref:`Release Notes 3.10.3`). + +* The :module:`InstallRequiredSystemLibraries` module gained support + for installing Intel compiler runtimes. + +Autogen +------- + +* When using :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` with a + multi configuration generator (e.g. :generator:`Xcode`), + included ``*.moc``, ``moc_*.cpp`` and ``ui_*.h`` files are generated in + ``/include_`` instead of + ``/include``. + +* When using :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC`, + source files that are :prop_sf:`GENERATED` will be processed as well. + They were ignored by :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC` + in earlier releases. + See policy :policy:`CMP0071`. + +* When using :prop_tgt:`AUTOMOC`, CMake searches for the strings ``Q_OBJECT``, + ``Q_GADGET`` or ``Q_NAMESPACE`` in a source file to determine if it needs + to be ``moc`` processed. The new :variable:`CMAKE_AUTOMOC_MACRO_NAMES` + variable and :prop_tgt:`AUTOMOC_MACRO_NAMES` target property may be set + to register additional strings (macro names) to search for. + +* When using :prop_tgt:`AUTOMOC`, the new + :variable:`CMAKE_AUTOMOC_COMPILER_PREDEFINES` variable and + :prop_tgt:`AUTOMOC_COMPILER_PREDEFINES` target property specify whether + to enable or disable the generation of the compiler pre definitions file + ``moc_predefs.h``. + +CTest +----- + +* A :variable:`CTEST_LABELS_FOR_SUBPROJECTS` CTest module variable and CTest + script variable were added to specify a list of labels that should be + treated as subprojects by CDash. To use this value in both the CTest module + and the ctest command line :ref:`Dashboard Client` mode (e.g. ``ctest -S``) + set it in the ``CTestConfig.cmake`` config file. + +CPack +----- + +* A :cpack_gen:`CPack FreeBSD Generator` was added for FreeBSD ``pkg(8)``. + +* The :cpack_gen:`CPack DEB Generator` was enabled on Windows. While not + fully featured (due to the lack of external UNIX tools) this will allow + building basic cross-platform Debian packages. + +* The :cpack_gen:`CPack DEB Generator` learned to set package release + version in ``Version`` info property. + See the :variable:`CPACK_DEBIAN_PACKAGE_RELEASE` variable. + +* The :cpack_gen:`CPack DEB Generator` learned more strict package + version checking that complies with Debian rules. + +* The :module:`CPackIFW` module :command:`cpack_ifw_configure_component` and + :command:`cpack_ifw_configure_component_group` commands gained a new + ``REPLACES`` and ``CHECKABLE`` options. + +* The :cpack_gen:`CPack IFW Generator` gained new + :variable:`CPACK_IFW_PACKAGE_FILE_EXTENSION` variable to customize + target binary format. + +* The :cpack_gen:`CPack IFW Generator` gained new + :variable:`CPACK_IFW_REPOSITORIES_DIRECTORIES` variable to specify + additional repositories dirs that will be used to resolve and + repack dependent components. This feature is only available when + using QtIFW 3.1 or later. + +* The :cpack_gen:`CPack RPM Generator` and :cpack_gen:`CPack DEB Generator` + learned to set the package epoch version. + See :variable:`CPACK_RPM_PACKAGE_EPOCH` and + :variable:`CPACK_DEBIAN_PACKAGE_EPOCH` variables. + +Other +----- + +* The :manual:`cmake(1)` ``-E`` mode gained support for ``sha1sum``, + ``sha224sum``, ``sha256sum``, ``sha384sum``, and ``sha512sum``. + +* The graphviz output now distinguishes among the different dependency types + ``PUBLIC``, ``PRIVATE`` and ``INTERFACE`` and represents them in the output + graph as solid, dashed and dotted edges. + +Deprecated and Removed Features +=============================== + +* Support for building CMake itself with C++98 compilers was dropped. + CMake is now implemented using C++11. + +* Support for building CMake on HP-UX has been dropped pending better + support for C++11 and a port of libuv. See `CMake Issue 17137`_. + Use CMake 3.9 or lower instead for HP-UX support. + +.. _`CMake Issue 17137`: https://gitlab.kitware.com/cmake/cmake/-/issues/17137 + +Other Changes +============= + +* On FreeBSD the C++ compiler named ``c++`` is now the preferred default. + +* The :command:`file(GENERATE)` command now interprets relative paths + given to its ``OUTPUT`` and ``INPUT`` arguments with respect to the + caller's current binary and source directories, respectively. + See policy :policy:`CMP0070`. + +* The :command:`get_filename_component` ``PROGRAM`` mode semantics + have been revised to not tolerate unquoted spaces in the path + to the program while also accepting arguments. While technically + incompatible with the old behavior, it is expected that behavior + under typical use cases with properly-quoted command-lines has + not changed. + +Updates +======= + +Changes made since CMake 3.10.0 include the following. + +3.10.1 +------ + +* The :manual:`cmake-server(7)` ``codemodel`` response cross-references + field added by 3.10.0 has been dropped due to excessive memory usage. + Another approach will be needed to provide backtrace information. + +.. _`Release Notes 3.10.3`: + +3.10.3 +------ + +* CMake 3.10.1 added a ``TIMEOUT`` option to :command:`gtest_discover_tests` + from the :module:`GoogleTest` module. That keyword clashed with the + ``TIMEOUT`` test property, which is one of the common properties that + would be set with the command's ``PROPERTIES`` keyword, usually leading + to legal but unintended behavior. The keyword was changed to + ``DISCOVERY_TIMEOUT`` in CMake 3.10.3 to address this problem. The + ambiguous behavior of the :command:`gtest_discover_tests` command's + ``TIMEOUT`` keyword in 3.10.1 and 3.10.2 has not been preserved. diff --git a/cmake/doc/cmake/html/_sources/release/3.11.rst.txt b/cmake/doc/cmake/html/_sources/release/3.11.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..6e1520aaed19745ba392b5481814d33b068e6afa --- /dev/null +++ b/cmake/doc/cmake/html/_sources/release/3.11.rst.txt @@ -0,0 +1,307 @@ +CMake 3.11 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.10 include the following. + +New Features +============ + +Platforms +--------- + +* TI C/C++ compilers are now supported by the :generator:`Ninja` generator. + +Generators +---------- + +* The :generator:`CodeBlocks` extra generator learned to check a + :variable:`CMAKE_CODEBLOCKS_COMPILER_ID` variable for a custom + compiler identification value to place in the project file. + +* The :ref:`Makefile Generators` and the :generator:`Ninja` generator learned + to add compiler launcher tools along with the compiler for the ``Fortran`` + language (``C``, ``CXX``, and ``CUDA`` were supported previously). + See the :variable:`CMAKE__COMPILER_LAUNCHER` variable and + :prop_tgt:`_COMPILER_LAUNCHER` target property for details. + +* :ref:`Visual Studio Generators` learned to support the ``COMPILE_LANGUAGE`` + :manual:`generator expression ` in + target-wide :prop_tgt:`COMPILE_DEFINITIONS`, + :prop_tgt:`INCLUDE_DIRECTORIES`, :prop_tgt:`COMPILE_OPTIONS`, and + :command:`file(GENERATE)`. See generator expression documentation + for caveats. + +* The :generator:`Xcode` generator learned to support the ``COMPILE_LANGUAGE`` + :manual:`generator expression ` in + target-wide :prop_tgt:`COMPILE_DEFINITIONS` and + :prop_tgt:`INCLUDE_DIRECTORIES`. It previously supported only + :prop_tgt:`COMPILE_OPTIONS` and :command:`file(GENERATE)`. + See generator expression documentation for caveats. + +Commands +-------- + +* :command:`add_library` and :command:`add_executable` commands can now be + called without any sources and will not complain as long as sources are + added later via the :command:`target_sources` command. + +* The :command:`file(DOWNLOAD)` and :command:`file(UPLOAD)` commands + gained ``NETRC`` and ``NETRC_FILE`` options to specify use of a + ``.netrc`` file. + +* The :command:`target_compile_definitions` command learned to set the + :prop_tgt:`INTERFACE_COMPILE_DEFINITIONS` property on + :ref:`Imported Targets`. + +* The :command:`target_compile_features` command learned to set the + :prop_tgt:`INTERFACE_COMPILE_FEATURES` property on :ref:`Imported Targets`. + +* The :command:`target_compile_options` command learned to set the + :prop_tgt:`INTERFACE_COMPILE_OPTIONS` property on :ref:`Imported Targets`. + +* The :command:`target_include_directories` command learned to set the + :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` property on + :ref:`Imported Targets`. + +* The :command:`target_sources` command learned to set the + :prop_tgt:`INTERFACE_SOURCES` property on :ref:`Imported Targets`. + +* The :command:`target_link_libraries` command learned to set the + :prop_tgt:`INTERFACE_LINK_LIBRARIES` property on :ref:`Imported Targets`. + +Variables +--------- + +* A :variable:`CMAKE_GENERATOR_INSTANCE` variable was introduced + to hold the selected instance of the generator's corresponding + native tools if multiple are available. This is used by the + :generator:`Visual Studio 15 2017` generator to hold the + selected instance of Visual Studio persistently. + +* A :variable:`CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS` variable was added + to enable setting of default permissions for directories created implicitly + during installation of files by :command:`install` and + :command:`file(INSTALL)`, e.g. during ``make install``. + +* A :variable:`CMAKE_JOB_POOLS` variable was added specify a value to use for + the :prop_gbl:`JOB_POOLS` property. This enables control over build + parallelism with command line configuration parameters when using the Ninja + generator. + +* The :variable:`CMAKE_NETRC` and :variable:`CMAKE_NETRC_FILE` variables + were added to specify use of a ``.netrc`` file by the + :command:`file(DOWNLOAD)` and :command:`file(UPLOAD)` commands and + the :module:`ExternalProject` module. + +* A :variable:`CMAKE_CUDA_SEPARABLE_COMPILATION` variable was added to + initialize the :prop_tgt:`CUDA_SEPARABLE_COMPILATION` target property + on targets when they are created. + +Properties +---------- + +* The :prop_sf:`COMPILE_DEFINITIONS` source file property learned to support + :manual:`generator expressions `. + +* A :prop_sf:`COMPILE_OPTIONS` source file property was added to manage list + of options to pass to the compiler. + +* An :prop_tgt:`IMPORTED_GLOBAL` target property was added to indicate + whether an :ref:`IMPORTED target ` is globally visible. + It is automatically set to a true value for targets created with the + ``GLOBAL`` option to :command:`add_library` or :command:`add_executable`. + Additionally, project code may now *promote* a local imported target + to be globally visible by setting this property to ``TRUE``. + +* An :prop_sf:`INCLUDE_DIRECTORIES` source file property was added to specify + list of preprocessor include file search directories. + +* Source file properties :prop_sf:`VS_SHADER_DISABLE_OPTIMIZATIONS` and + :prop_sf:`VS_SHADER_ENABLE_DEBUG` have been added to specify more + details of ``.hlsl`` sources with :ref:`Visual Studio Generators`. + +Modules +------- + +* The :module:`CheckIncludeFiles` module :command:`CHECK_INCLUDE_FILES` + command gained a ``LANGUAGE`` option to specify whether to check using the + ``C`` or ``CXX`` compiler. + +* The :module:`CMakePackageConfigHelpers` module + :command:`write_basic_package_version_file` command learned a new + ``SameMinorVersion`` mode for the ``COMPATIBILITY`` argument. + +* The :module:`ExternalProject` module learned to substitute ```` + in comments, commands, working directory and byproducts. + +* The :module:`ExternalProject` module gained ``NETRC`` and ``NETRC_FILE`` + options to specify use of a ``.netrc`` file. + +* A new :module:`FetchContent` module was added which supports populating + content at configure time using any of the download/update methods + supported by :command:`ExternalProject_Add`. This allows the content + to be used immediately during the configure stage, such as with + :command:`add_subdirectory`, etc. Hierarchical project structures are + well supported, allowing parent projects to override the content details + of child projects and ensuring content is not populated multiple times + throughout the whole project tree. + +* The :module:`FindBLAS` and :module:`FindLAPACK` modules learned to support + `FLAME`_ ``blis`` and ``libflame``. + +* The :module:`FindDoxygen` module :command:`doxygen_add_docs` function + now supports a new ``DOXYGEN_VERBATIM_VARS`` list variable. Any + ``DOXYGEN_...`` variable contained in that list will bypass the automatic + quoting logic, leaving its contents untouched when transferring them to the + output ``Doxyfile``. + +* A :module:`FindIconv` module was added to locate iconv support. + +* The :module:`GenerateExportHeader` module ``GENERATE_EXPORT_HEADER`` command + gained an ``INCLUDE_GUARD_NAME`` option to change the name of the include + guard symbol written to the generated export header. + Additionally, it now adds a comment after the closing ``#endif`` on the + generated export header's include guard. + +* The :module:`UseJava` module ``add_jar`` command gained a + ``GENERATE_NATIVE_HEADERS`` option to generate native header files + using ``javac -h`` for ``javac`` 1.8 or above. This supersedes + ``create_javah``, which no longer works with JDK 1.10 and above due + to removal of the ``javah`` tool by `JEP 313`_. + +.. _`FLAME`: https://github.com/flame +.. _`JEP 313`: https://openjdk.org/jeps/313 + +Autogen +------- + +* When using :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC`, CMake now starts + multiple parallel ``moc`` or ``uic`` processes to reduce the build time. + A new :variable:`CMAKE_AUTOGEN_PARALLEL` variable and + :prop_tgt:`AUTOGEN_PARALLEL` target property may be set to specify the + number of parallel ``moc`` or ``uic`` processes to start. The default + is derived from the number of CPUs on the host. + +CTest +----- + +* The :command:`ctest_start` command no longer sets + :variable:`CTEST_RUN_CURRENT_SCRIPT` due to issues with scoping if it is + called from inside a function. Instead, it sets an internal variable in + CTest. However, setting :variable:`CTEST_RUN_CURRENT_SCRIPT` to 0 at the + global scope still prevents the script from being re-run at the end. + +CPack +----- + +* :manual:`cpack(1)` gained ``--trace`` and ``--trace-expand`` options. + +* The :cpack_gen:`CPack IFW Generator` gained new + :variable:`CPACK_IFW_PACKAGE_REMOVE_TARGET_DIR` variable to control + if the target directory should not be deleted when uninstalling. + +* The :cpack_gen:`CPack RPM Generator` learned to enable enforcing of execute + privileges on programs and shared libraries. + See :variable:`CPACK_RPM_INSTALL_WITH_EXEC` variable. + +* A :variable:`CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS` variable was added + which serves the same purpose during packaging (e.g. ``make package``) as the + :variable:`CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS` variable serves during + installation (e.g. ``make install``). + +Other +----- + +* :ref:`Alias Targets` may now alias :ref:`Imported Targets` that are + created with the ``GLOBAL`` option to :command:`add_library`. + +* :ref:`Interface Libraries` may now have custom properties set on them if + they start with either an underscore (``_``) or a lowercase ASCII character. + The original intention was to only allow properties which made sense for + ``INTERFACE`` libraries, but it also blocked usage of custom properties. + +* The :manual:`cmake(1)` ``--open `` command-line option was added + to open generated IDE projects like Visual Studio solutions or Xcode + projects. + +Deprecated and Removed Features +=============================== + +* An explicit deprecation diagnostic was added for policies ``CMP0037`` + through ``CMP0054`` (``CMP0036`` and below were already deprecated). + The :manual:`cmake-policies(7)` manual explains that the OLD behaviors + of all policies are deprecated and that projects should port to the + NEW behaviors. + +* The ``KDevelop3`` generator has been removed. + +Other Changes +============= + +* Policy :policy:`CMP0037` no longer reserves target names associated + with optional features, such as ``test`` and ``package``, unless + the corresponding feature is enabled. + +* The :module:`FindOpenGL` module now prefers GLVND libraries if available. + See policy :policy:`CMP0072`. + +* The minimum deployment target set in the + :variable:`CMAKE_OSX_DEPLOYMENT_TARGET` variable used to be only + applied for macOS regardless of the selected SDK. It is now properly + set for the target platform selected by :variable:`CMAKE_OSX_SYSROOT`. + For example, if the sysroot variable specifies an iOS SDK then the + value in ``CMAKE_OSX_DEPLOYMENT_TARGET`` is interpreted as minimum + iOS version. + +* The :generator:`Xcode` generator behavior of generating one project + file per :command:`project()` command may now be controlled with the + :variable:`CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT_ONLY` variable. + This could be useful to speed up the CMake generation step for + large projects and to work-around a bug in the ``ZERO_CHECK`` logic. + +* Since the ``CMakeCache.txt`` format does not support newlines in values, + values containing newlines are now truncated before writing to the file. + In addition, a warning comment is written to the cache file, and a warning + message is displayed to the user on the console. + +Updates +======= + +Changes made since CMake 3.11.0 include the following. + +3.11.1 +------ + +* The :module:`CheckIncludeFile` module ``check_include_file`` macro, + :module:`CheckIncludeFileCXX` module ``check_include_file_cxx`` macro, + and :module:`CheckIncludeFiles` module ``check_include_files`` macro + were taught to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable in + CMake 3.11.0. This has been reverted due to changing behavior of + checks for existing projects. It may be restored in the future + with a policy for compatibility. + +3.11.2 +------ + +* Calling :command:`add_library` to create an alias of an imported + target that is not globally visible now causes an error again as + it did prior to 3.11.0. This diagnostic was accidentally dropped + from CMake 3.11.0 and 3.11.1 by the change to allow globally visible + imported targets to be aliased. + +* The :module:`FindQt4` module ``qt4_wrap_cpp``, ``qt4_wrap_ui`` and + ``qt4_add_resources`` macros now set :prop_sf:`SKIP_AUTOMOC` and + :prop_sf:`SKIP_AUTOUIC` on their generated files. These files never + need to be processed by moc or uic, and we must say so explicitly to + account for policy :policy:`CMP0071`. + +3.11.3 +------ + +* CMake 3.11.0 introduced support for resolving symbolic links on + Windows in code paths that typically do so on UNIX. This has been + reverted due to breakage on ``subst`` drives. diff --git a/cmake/doc/cmake/html/_sources/release/3.12.rst.txt b/cmake/doc/cmake/html/_sources/release/3.12.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..dcdae1d1bae14f54812ece5d892597abcb5400fb --- /dev/null +++ b/cmake/doc/cmake/html/_sources/release/3.12.rst.txt @@ -0,0 +1,305 @@ +CMake 3.12 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.11 include the following. + +New Features +============ + +Generators +---------- + +* The :ref:`Visual Studio Generators` for VS 2017 learned to support a + ``version=14.##`` option in the :variable:`CMAKE_GENERATOR_TOOLSET` + value (e.g. via the :manual:`cmake(1)` ``-T`` option) to specify a + toolset version number. + +Command-Line +------------ + +* The :manual:`cmake(1)` :ref:`Build Tool Mode` (``cmake --build``) gained + ``--parallel []`` and ``-j []`` options to specify a parallel + build level. They map to corresponding options of the native build tool. + +Commands +-------- + +* The :command:`add_compile_definitions` command was added to set preprocessor + definitions at directory level. This supersedes :command:`add_definitions`. + +* The :command:`cmake_minimum_required` and :command:`cmake_policy(VERSION)` + commands now accept a version range using the form ``[...]``. + The ```` version is required but policies are set based on the + older of the running CMake version and the version specified by + ````. This allows projects to specify a range of versions + for which they have been updated and avoid explicit policy settings. + +* The :command:`file(GLOB)` and :command:`file(GLOB_RECURSE)` commands + learned a new flag ``CONFIGURE_DEPENDS`` which enables expression of + build system dependency on globbed directory's contents. + +* The :command:`file(TOUCH)` and :command:`file(TOUCH_NOCREATE)` commands + were added to expose ``TOUCH`` functionality without having to use + CMake's command-line tool mode with :command:`execute_process`. + +* The :command:`find_package` command now searches prefixes specified by + the :variable:`_ROOT` CMake variable and the + :envvar:`_ROOT` environment variable. Package roots are + maintained as a stack so nested calls to all ``find_*`` commands inside + find modules also search the roots as prefixes. + See policy :policy:`CMP0074`. + +* The :command:`install` command learned an optional ``NAMELINK_COMPONENT`` + parameter, which allows you to change the component for a shared library's + namelink. If none is specified, the value of ``COMPONENT`` is used by + default. + +* The :command:`list` command learned a ``JOIN`` sub-command + to concatenate list's elements separated by a glue string. + +* The :command:`list` command learned a ``SUBLIST`` sub-command + to get a sublist of the list. + +* The :command:`list` command learned a ``TRANSFORM`` sub-command + to apply various string transformation to list's elements. + +* The :command:`project` command learned an optional ``HOMEPAGE_URL`` + parameter which has the effect of setting variables like + :variable:`PROJECT_HOMEPAGE_URL`, :variable:`_HOMEPAGE_URL` + and :variable:`CMAKE_PROJECT_HOMEPAGE_URL`. + +* The :command:`string` command learned a ``JOIN`` sub-command + to concatenate input strings separated by a glue string. + +* :command:`target_compile_options` and :command:`add_compile_options` + commands gained a ``SHELL:`` prefix to specify a group of related + options using shell-like quoting. + +* The :command:`target_link_libraries` command now supports + :ref:`Object Libraries`. Linking to an object library uses its object + files in direct dependents and also propagates usage requirements. + +Variables +--------- + +* The :variable:`CMAKE_FOLDER` variable was added to initialize the + :prop_tgt:`FOLDER` property on all targets. + +* The :variable:`CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION` variable + was defined to initialize all + :prop_tgt:`DOTNET_TARGET_FRAMEWORK_VERSION` target properties. + +* ``CMAKE_PROJECT_VERSION*`` variables have been introduced: + + - :variable:`CMAKE_PROJECT_VERSION` + - :variable:`CMAKE_PROJECT_VERSION_MAJOR` + - :variable:`CMAKE_PROJECT_VERSION_MINOR` + - :variable:`CMAKE_PROJECT_VERSION_PATCH` + - :variable:`CMAKE_PROJECT_VERSION_TWEAK` + +* The :variable:`CMAKE_SUPPRESS_REGENERATION` variable was extended to + support the :generator:`Ninja` and :ref:`Makefile Generators`. + It is also now documented. + +* ``CMAKE_VS_SDK_*_DIRECTORIES`` variables were defined to tell + :ref:`Visual Studio Generators` for VS 2010 and above how to populate + fields in ``.vcxproj`` files that specify SDK directories. The + variables are: + + - :variable:`CMAKE_VS_SDK_EXCLUDE_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_EXECUTABLE_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_INCLUDE_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_LIBRARY_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_LIBRARY_WINRT_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_REFERENCE_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_SOURCE_DIRECTORIES` + +* A :variable:`MSVC_TOOLSET_VERSION` variable was added to provide the + MSVC toolset version associated with the current MSVC compiler version + in :variable:`MSVC_VERSION`. + +Properties +---------- + +* The :prop_tgt:`COMMON_LANGUAGE_RUNTIME` target property was introduced + to configure the use of managed C++ for :ref:`Visual Studio Generators` + for VS 2010 and above. + A corresponding :prop_tgt:`IMPORTED_COMMON_LANGUAGE_RUNTIME` target + property was added to support ``C++/CLI`` for imported targets. + +* The :prop_tgt:`DOTNET_TARGET_FRAMEWORK_VERSION` target property + was introduced as replacement for + :prop_tgt:`VS_DOTNET_TARGET_FRAMEWORK_VERSION`, which is considered + deprecated now. + +* An :prop_tgt:`EXPORT_PROPERTIES` target property was added to specify a + custom list of target properties to include in targets exported by the + :command:`install(EXPORT)` and :command:`export` commands. + +* The :prop_tgt:`PDB_OUTPUT_DIRECTORY` property learned to support + :manual:`generator expressions `. + +* A :prop_dir:`TESTS` directory property was added to hold the list of + tests defined by the :command:`add_test` command. + +* A :prop_tgt:`VS_DEBUGGER_COMMAND` target property was created to set the + debugging command line with :ref:`Visual Studio Generators` for VS 2010 + and above. + +* HLSL source file properties :prop_sf:`VS_SHADER_DISABLE_OPTIMIZATIONS` + and :prop_sf:`VS_SHADER_ENABLE_DEBUG` gained support for generator + expressions. + +* HLSL source file property :prop_sf:`VS_SHADER_OBJECT_FILE_NAME` has been + added to the :ref:`Visual Studio Generators` for VS 2010 and above. + The property specifies the file name of the compiled shader object. + +Modules +------- + +* The :module:`FindALSA` module now provides imported targets. + +* The :module:`FindCURL` module now provides imported targets. + +* The :module:`FindJPEG` module now provides imported targets. + +* The :module:`FindLibXml2` module now provides imported targets. + +* The :module:`FindMatlab` module now supports the Matlab Runtime + Compiler (MCR) for compiling and linking matlab extensions. + +* A :module:`FindODBC` module was added to find an Open Database Connectivity + (ODBC) library. + +* The :module:`FindPkgConfig` module has learned to export the found + libraries with full path for direct consumption with the + :command:`target_link_libraries` command. + +* New :module:`FindPython3` and :module:`FindPython2` modules, as well as + a new :module:`FindPython` module, have been added to provide a new way + to locate python environments. + +* The :module:`UseSWIG` module gained a whole refresh and is now more + consistent with standard CMake commands to generate libraries and is + fully configurable through properties. + +* The :module:`UseSWIG` module learned to manage multiple behaviors through + ``UseSWIG_MODULE_VERSION`` variable to ensure legacy support as well as more + robust handling of ``SWIG`` advanced features (like ``%template``). + +* The :module:`UseSWIG` module learned to support CSHARP variant + wrapper files. + +* The :module:`WriteCompilerDetectionHeader` module gained a ``BARE_FEATURES`` + option to add a compatibility define for the exact keyword of a new language + feature. + +Generator Expressions +--------------------- + +* A new ``$`` and ``$`` + :manual:`generator expression ` + has been added to enable consumption of generator expressions whose + evaluation results itself in generator expressions. + +* A new ``$`` + :manual:`generator expression ` + has been added. + +* A new ``$`` + :manual:`generator expression ` + has been added. + +* A new ``$`` + :manual:`generator expression ` + has been added. + +CTest +----- + +* The :command:`ctest_start` command has been reworked so that you can simply + call ``ctest_start(APPEND)`` and it will read all the needed information from + the TAG file. The argument parsing has also been relaxed so that the order of + the arguments is less significant. + +* A :prop_test:`PROCESSOR_AFFINITY` test property was added to request + that CTest run a test with CPU affinity for a set of processors + disjoint from other concurrently running tests with the property set. + +CPack +----- + +* The :module:`CPack` module now uses variables + :variable:`CMAKE_PROJECT_VERSION_MAJOR`, + :variable:`CMAKE_PROJECT_VERSION_MINOR` and + :variable:`CMAKE_PROJECT_VERSION_PATCH` + to initialize corresponding CPack variables. + +* A :cpack_gen:`CPack NuGet Generator` was was added with basic + support for `NuGet`_. + +.. _NuGet: https://learn.microsoft.com/en-us/nuget/what-is-nuget + +Other +----- + +* The :manual:`Compile Features ` functionality + is now aware of C++ 20. No specific features are yet enumerated besides + the ``cxx_std_20`` meta-feature. + +* The :manual:`Compile Features ` functionality + is now aware of the availability of C features in MSVC since VS 2010. + +* The :manual:`Compile Features ` functionality + is now aware of C language standards supported by Texas Instruments C + compilers. + +Deprecated and Removed Features +=============================== + +* The :generator:`Visual Studio 8 2005` generator has been removed. + +* CMake no longer produces ``_LIB_DEPENDS`` cache entries + for library targets. See policy :policy:`CMP0073`. + +Other Changes +============= + +* Include flags for directories marked as ``SYSTEM`` are now moved after + non-system directories. The ``-isystem`` flag does this automatically, + so moving them explicitly to the end makes the behavior consistent on + compilers that do not have any ``-isystem`` flag. + +* Fortran dependency scanning now supports dependencies implied by + `Fortran Submodules`_. + +* The existence and functionality of the file + ``${CMAKE_BINARY_DIR}/cmake_install.cmake`` has now been documented in the + :command:`install` documentation so that external packaging software can take + advantage of CPack-style component installs. + +* The :module:`CheckIncludeFile` module ``check_include_file`` macro + learned to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable. + See policy :policy:`CMP0075`. + +* The :module:`CheckIncludeFileCXX` module ``check_include_file_cxx`` macro + learned to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable. + See policy :policy:`CMP0075`. + +* The :module:`CheckIncludeFiles` module ``check_include_files`` macro + learned to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable. + See policy :policy:`CMP0075`. + +* The :manual:`cmake(1)` ``-E copy_directory`` tool now fails when the + source directory does not exist. Previously it succeeded by creating + an empty destination directory. + +* The :module:`UseSWIG` module :command:`swig_add_library` command + (and legacy ``swig_add_module`` command) now set the prefix of + Java modules to ``""`` for MINGW, MSYS, and CYGWIN environments. + +.. _Fortran Submodules: https://fortranwiki.org/fortran/show/Submodules diff --git a/cmake/doc/cmake/html/_sources/release/3.13.rst.txt b/cmake/doc/cmake/html/_sources/release/3.13.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a8dd0baf7c87871d929397c85a28ee9ecb4e96bf --- /dev/null +++ b/cmake/doc/cmake/html/_sources/release/3.13.rst.txt @@ -0,0 +1,289 @@ +CMake 3.13 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.12 include the following. + +New Features +============ + +Generators +---------- + +* The :ref:`Visual Studio Generators` for VS 2010 and above learned to + support the :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` target property + and supporting :module:`CheckIPOSupported` module. + +* The :generator:`Xcode` generator learned to configure more Xcode Scheme + fields. See the :variable:`CMAKE_XCODE_GENERATE_SCHEME` variable. + +* The :generator:`Green Hills MULTI` generator has been updated: + + - Added support for architecture selection through + :variable:`CMAKE_GENERATOR_PLATFORM`: + e.g. ``arm``, ``ppc``, and ``86``. + + - Added support for toolset selection through + :variable:`CMAKE_GENERATOR_TOOLSET`, + e.g. ``comp_201205``, ``comp_201510``, ``comp_201722_beta``. + + - Added support for platform selection through ``GHS_TARGET_PLATFORM``, + e.g. ``integrity``, ``linux``, ``standalone``, etc. + + - No longer checks that ``arm`` based compilers are installed but ensures + that the correct ``gbuild.exe`` exists. + + - No longer hard-codes ARM files, BSP, toolset, or OS locations. + +Command-Line +------------ + +* The :manual:`cmake(1)` command gained the ``-S `` + command line option to specify the location of the source directory. + This option can be used independently of ``-B``. + +* The :manual:`cmake(1)` command gained the ``-B `` + command line option to specify the location of the build directory. + This option can be used independently of ``-S``. + +* The :manual:`cmake(1)` ``-E create_symlink`` command can now be used + on Windows. + +Commands +-------- + +* The :command:`add_custom_command` and :command:`add_custom_target` commands + learned to support generator expressions in ``WORKING_DIRECTORY`` options. + +* The :command:`add_link_options` command was created to add link + options in the current directory. + +* The :command:`install(TARGETS)` command learned to install targets + created outside the current directory. + +* The :command:`link_directories` command gained options to control + insertion position. + +* The :command:`list(SORT)` command gained options to control the + comparison operation used to order the entries. + +* The :command:`math` command gained options for hexadecimal. + +* The :command:`target_link_directories` command was created to + specify link directories for targets and their dependents. + +* The :command:`target_link_options` command was created to + specify link options for targets and their dependents. + +* The :command:`target_link_libraries` command may now be called + to modify targets created outside the current directory. + See policy :policy:`CMP0079`. + +Variables +--------- + +* A :variable:`CMAKE_AUTOGEN_VERBOSE` variable was added to optionally + increase the verbosity of :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTOUIC` + and :prop_tgt:`AUTORCC` from within CMake project code. + +* A :variable:`CMAKE_VS_GLOBALS` variable was added to initialize + :prop_tgt:`VS_GLOBAL_` target properties on targets as + they are created. + +Properties +---------- + +* The :prop_tgt:`DEPLOYMENT_ADDITIONAL_FILES` target property was + added to tell the :generator:`Visual Studio 9 2008` generator + to specify additional files for deployment to WinCE devices + for remote debugging. + +* The :prop_tgt:`INTERFACE_LINK_DEPENDS` target property was created + to specify transitive link dependencies on files. + +* The :prop_tgt:`LINK_DEPENDS` target property learned to support + :manual:`generator expressions `. + +* :prop_tgt:`LINK_DIRECTORIES` and :prop_tgt:`INTERFACE_LINK_DIRECTORIES` + target properties were added to collect link directories for a target + and its dependents. Use the :command:`target_link_directories` command + to set them. + +* :prop_tgt:`LINK_OPTIONS` and :prop_tgt:`INTERFACE_LINK_OPTIONS` target + properties were added to collect link options for a target and its + dependents. Use the :command:`target_link_options` command to set them. + +* A :prop_dir:`LINK_OPTIONS` directory property was added to collect + link options for targets created under the current directory. + Use the :command:`add_link_options` command to set it. + +* A :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property was created + to specify archiver options to use when creating static libraries. + +* A :prop_tgt:`VS_DEBUGGER_COMMAND_ARGUMENTS` target property was created to + set the debugging command line arguments with + :ref:`Visual Studio Generators` for VS 2010 and above. + +* A :prop_tgt:`VS_DEBUGGER_ENVIRONMENT` target property was created to + set the debugging environment with + :ref:`Visual Studio Generators` for VS 2010 and above. + +* The :prop_tgt:`VS_DEBUGGER_COMMAND` and + :prop_tgt:`VS_DEBUGGER_WORKING_DIRECTORY` target properties + now support generator expressions. + +Modules +------- + +* The :module:`FindBoost` module gained a ``Boost_ARCHITECTURE`` option + to specify a Boost architecture-specific library filename fragment. + +* The :module:`FindCURL` module learned to find debug and release variants + separately. + +* The :module:`FindMatlab` module gained new components ``ENGINE_LIBRARY`` and + ``DATAARRAY_LIBRARY`` to request finding the Matlab C++ Engine and DataArray + libraries respectively. + +* The :module:`FindMatlab` module now explicitly exports mexFunction in Visual + Studio. + +* The :module:`FindMatlab` module gained a new ``MCC_COMPILER`` + component to request finding the Matlab Compiler add-on. + +* The :module:`FindPkgConfig` module gained an option to create imported + targets in global scope. + +* The :module:`FindPkgConfig` module gained support for ``<`` and ``>`` + operators for version checks in addition to the already supported + operators ``>=``, ``<=``, and ``=``. + +* Modules :module:`FindPython3`, :module:`FindPython2` and :module:`FindPython` + gain capability to control order of resource lookup on macOS (Framework) and + Windows (Registry). + +* The :module:`FindSubversion` module ``Subversion_WC_INFO`` command + gained an ``IGNORE_SVN_FAILURE`` option to suppress failures, + e.g. when the source tree is not under Subversion control. + +* The :module:`UseSWIG` module learned to manage target property + :prop_tgt:`INCLUDE_DIRECTORIES` for ``SWIG`` compilation. + +CTest +----- + +* :manual:`ctest(1)` gained a ``--progress`` option to enable a live + test progress summary when output goes to a terminal. + +CPack +----- + +* The :cpack_gen:`CPack DEB Generator` learned to split debug symbols into + a corresponding .ddeb package when ``CPACK_DEBIAN_DEBUGINFO_PACKAGE`` is + set. + +* The :cpack_gen:`CPack DEB Generator` learned to honor the ``SOURCE_DATE_EPOCH`` + environment variable when packaging files. This is useful for generating + reproducible packages. + +* CPack gained a new :cpack_gen:`CPack External Generator` which is used to + export the CPack metadata in a format that other software can understand. The + intention of this generator is to allow external packaging software to take + advantage of CPack's features when it may not be possible to use CPack for + the entire packaging process. + +Deprecated and Removed Features +=============================== + +* An explicit deprecation diagnostic was added for policies ``CMP0055`` + through ``CMP0063`` (``CMP0054`` and below were already deprecated). + The :manual:`cmake-policies(7)` manual explains that the OLD behaviors + of all policies are deprecated and that projects should port to the + NEW behaviors. + +Other Changes +============= + +* The precompiled binaries provided on ``cmake.org`` now include + qthelp-format documentation. + +* The :command:`option` command now honors an existing normal variable + of the same name and does nothing instead of possibly creating a cache + entry (or setting its type) and removing the normal variable. + See policy :policy:`CMP0077`. + +* The :ref:`Makefile Generators` learned to remove custom command and + custom target byproducts during ``make clean``. + +* The :command:`target_sources` command now interprets relative source file + paths as relative to the current source directory. This simplifies + incrementally building up a target's sources from subdirectories. The + :policy:`CMP0076` policy was added to provide backward compatibility with + the old behavior where required. + +* The :module:`BundleUtilities` module may no longer be included at configure + time. This was always a bug anyway. See policy :policy:`CMP0080`. + +* The :module:`UseSWIG` module has changed strategy for target naming. + See policy :policy:`CMP0078`. + +* The :prop_tgt:`LINK_DIRECTORIES` target property now expects absolute paths. + See policy :policy:`CMP0081`. + +* The CPack generators have been moved into their own separate section + in the documentation, rather than having the documentation in their + internal implementation modules. + These internal implementation modules are also no longer available + to scripts that may have been incorrectly including them, because + they should never have been available in the first place. + +Updates +======= + +Changes made since CMake 3.13.0 include the following. + +3.13.2 +------ + +* CMake 3.13.0 included a change to pass compiler implicit include + directories to the ``moc`` tool for :prop_tgt:`AUTOMOC`. This has + been reverted due to regressing existing builds and will need + further investigation before being re-introduced in a later release. + +3.13.3 +------ + +* The :generator:`Visual Studio 15 2017` generator has been fixed to work + when VS 2019 is installed. + +* CMake now checks that at least one of the source or binary directory + is specified when running CMake and issues an error if both are missing. + This has always been a documented requirement, but the implementation + previously accidentally accepted cases in which neither are specified + so long as some other argument is given, and silently used the current + working directory as the source and build tree. + +3.13.4 +------ + +* The error added by 3.13.3 in cases that neither a source or binary + directory is specified has been downgraded to a warning. While this + was never intended, documented, nor supported behavior, some projects + relied on it. The error has been downgraded to a warning for the + remainder of the 3.13.x release series to allow a transition period, + but it may become a fatal error again in a later release. Scripts + relying on the old behavior can be trivially fixed by specifying + the path to the source tree (even if just ``.``) explicitly and + continue to work with all versions of CMake. + +3.13.5 +------ + +* In CMake 3.13.0 through 3.13.4, calling :command:`target_link_libraries` + to add ``PRIVATE`` dependencies to a static library created in another + directory (under policy :policy:`CMP0079` ``NEW`` behavior) would + incorrectly propagate usage requirements of those dependencies to + dependents that link the static library. This has been fixed. diff --git a/cmake/doc/cmake/html/_sources/release/3.14.rst.txt b/cmake/doc/cmake/html/_sources/release/3.14.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..ab59ee24cefeef0e8bcca388ee6f61602bfdbe08 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/release/3.14.rst.txt @@ -0,0 +1,439 @@ +CMake 3.14 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.13 include the following. + +New Features +============ + +Generators +---------- + +* The :generator:`Visual Studio 16 2019` generator was added. This is + experimental and based on "Visual Studio 2019 Preview 4" because this + version of VS has not been released. + + The VS 2019 generator differs from generators for earlier versions + in that it does not provide variants that specify the target platform + in the generator name. Instead :variable:`CMAKE_GENERATOR_PLATFORM` + must be used, e.g. through the ``-A`` command-line option. Furthermore, + the default target platform (architecture) is now based on the *host* + platform. The VS host toolset selection is now based on the host + architecture as well. + +* The :generator:`Green Hills MULTI` generator has been updated: + + * Now supports :ref:`Object Libraries`. + + * Now warns on unsupported project types such as shared libraries. + + * Now generates a top-level ``.top.gpj`` for each directory + calling the :command:`project` command. The top-level project file + ``default.gpj`` is no longer created. + + * Now honors target renaming and destination output control properties + such as :prop_tgt:`RUNTIME_OUTPUT_DIRECTORY` and :prop_tgt:`OUTPUT_NAME`. + This also fixes support for installation rules generated by + :command:`install`. + + * Now honors source file properties :prop_sf:`INCLUDE_DIRECTORIES`, + :prop_sf:`COMPILE_DEFINITIONS`, and :prop_sf:`COMPILE_OPTIONS`. + + * Now supports Dynamic Download Integrity Applications which did not include + Integrate Files via :prop_tgt:`GHS_INTEGRITY_APP` and setting a target + link flag of ``-dynamic``. + + * The contents of project files now sorts sources groups and files by name. + Set the :prop_tgt:`GHS_NO_SOURCE_GROUP_FILE` target property to ``ON`` to + generate a single project file for the target instead of a project file for + each source group. Set the :variable:`CMAKE_GHS_NO_SOURCE_GROUP_FILE` + variable to enable this for all targets. + +File-Based API +-------------- + +* A file-based api for clients to get semantic buildsystem information + has been added. See the :manual:`cmake-file-api(7)` manual. + This is intended to replace the :manual:`cmake-server(7)` mode for IDEs. + +Platforms +--------- + +* CMake now supports + :ref:`Cross Compiling for iOS, tvOS, or watchOS ` + using simple toolchain files. + +Command-Line +------------ + +* The :manual:`cmake(1)` :ref:`Build Tool Mode ` + (``cmake --build``) gained ``--verbose`` and ``-v`` options to + specify verbose build output. Some generators such as Xcode don't + support this option currently. + +* The :manual:`cmake(1)` ``-E compare_files`` command learned a new + ``--ignore-eol`` option to specify that end-of-line differences + (e.g. LF vs CRLF) should be ignored when comparing files. + +* The :manual:`cmake-gui(1)` dialog gained new ``-S`` and ``-B`` arguments to + explicitly specify source and build directories. + +Commands +-------- + +* The :command:`file` command learned a new sub-command, ``CREATE_LINK``, + which can be used to create hard or symbolic links. + +* The :command:`file` command learned a new sub-command, ``READ_SYMLINK``, + which can be used to determine the path that a symlink points to. + +* The :command:`file` command gained a ``SIZE`` mode to get the size + of a file on disk. + +* The :command:`find_package` command learned to optionally resolve + symbolic links in the paths to package configuration files. + See the :variable:`CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS` variable. + +* The :command:`get_filename_component` command gained new + ``LAST_EXT`` and ``NAME_WLE`` variants to work with the + extension after the last ``.`` in the name. + +* The :command:`if` command gained support for checking if cache variables + are defined with the ``DEFINED CACHE{VAR}`` syntax. + +* The :command:`install(CODE)` and :command:`install(SCRIPT)` commands + learned to support generator expressions. See policy :policy:`CMP0087`. + +* The :command:`install(TARGETS)` command learned how to install to an + appropriate default directory for a given target type, based on + variables from the :module:`GNUInstallDirs` module and built-in defaults, + in lieu of a ``DESTINATION`` argument. + +* The :command:`install(FILES)` and :command:`install(DIRECTORY)` commands + learned a new set of parameters for installing files as a file type, + setting the destination based on the appropriate variables from + :module:`GNUInstallDirs` and built-in defaults, in lieu of a + ``DESTINATION`` argument. + +* The :command:`list` operations ``REMOVE_ITEM``, ``REMOVE_DUPLICATES``, + ``SORT``, ``REVERSE``, and ``FILTER`` all now accept a non-existent variable + as the list since these operations on empty lists is also the empty list. + +* The :command:`list` operation ``REMOVE_AT`` now indicates that the given + indices are invalid for a non-existent variable or empty list. + +* The :command:`try_compile` and :command:`try_run` commands gained a new + ``LINK_OPTIONS`` option. + +Variables +--------- + +* A :variable:`CMAKE_BUILD_RPATH_USE_ORIGIN` variable and corresponding + :prop_tgt:`BUILD_RPATH_USE_ORIGIN` target property were added to + enable use of relative runtime paths (RPATHs). This helps achieving + relocatable and reproducible builds that are invariant of the build + directory. + +* A :variable:`CMAKE_VS_PLATFORM_NAME_DEFAULT` variable was added for + :ref:`Visual Studio Generators` to report their default platform used + when :variable:`CMAKE_GENERATOR_PLATFORM` is not set explicitly. + +Properties +---------- + +* A :prop_gbl:`CMAKE_ROLE` global property was added to allow scripts to + determine whether they're running in project mode, script mode, + find-package mode, CTest, or CPack. + +* The :prop_tgt:`CUDA_RESOLVE_DEVICE_SYMBOLS` target property is now supported + on shared library, module library, and executable targets. Previously it was + only honored on static libraries. + +* The :prop_tgt:`EXCLUDE_FROM_ALL` target property was created to override + the setting of its directory. A target will now be built as part of "all" + if its :prop_tgt:`EXCLUDE_FROM_ALL` property is set to ``OFF``, even if its + containing directory is marked as :prop_dir:`EXCLUDE_FROM_ALL`. + +* :prop_tgt:`INTERFACE_POSITION_INDEPENDENT_CODE` target property gains the + support of :manual:`generator expressions `. + +Modules +------- + +* The family of modules to check capabilities (like + :module:`CheckCSourceCompiles`) gain capability to manage ``LINK_OPTIONS``. + +* A :module:`CheckFortranSourceRuns` module was added to provide a + :command:`check_fortran_source_runs` command to check if a Fortran + source snippet compiles and runs. + +* The :module:`CMakePackageConfigHelpers` module's + :command:`write_basic_package_version_file` command gained a new + ``ARCH_INDEPENDENT`` option for supporting architecture-independent + packages. + +* The :module:`ExternalProject` module :command:`ExternalProject_Add` command + gained ``LOG_DIR`` and ``LOG_MERGED_STDOUTERR`` options to control logging. + +* The :module:`ExternalProject` module :command:`ExternalProject_Add` command + gained ``LOG_PATCH`` to optionally log the patch step. + +* The :module:`ExternalProject` module :command:`ExternalProject_Add` command + learned to apply ``SOURCE_SUBDIR`` when ``BUILD_IN_SOURCE`` is also used. + The ``BUILD_COMMAND`` is run in the given ``SOURCE_SUBDIR`` of the + ``SOURCE_DIR``. + +* The :module:`FetchContent` module gained a new + :command:`FetchContent_MakeAvailable` command. It accepts a list of + dependency names, which it then iterates over, populating and adding + each one to the main build using the canonical pattern. This + significantly reduces the amount of boilerplate needed in a project. + +* The :module:`FindBISON` module's ``BISON_TARGET`` command now runs ``bison`` + with :variable:`CMAKE_CURRENT_BINARY_DIR` as the working directory. + See policy :policy:`CMP0088`. + +* The :module:`FindCURL` module gained support for requesting + protocols as package components. + +* The :module:`FindFontconfig` module was added to find `fontconfig`_. + +* The :module:`FindGDAL` module now provides imported targets. + +* The :module:`FindGIF` module now provides imported targets. + +* The :module:`FindGit` module now provides an imported target for the + Git executable. + +* The :module:`FindIce` module learned to find ``slice2confluence`` + and ``slice2matlab``. + +* The :module:`FindLibinput` module was added to find `libinput`_. + +* The :module:`FindLibLZMA` module now provides imported targets. + +* The :module:`FindMatlab` module gained new options ``R2017b`` and + ``R2018a`` to specify the MEX API version to use; these options + mirror the new options to the ``mex`` command in MATLAB R2018a. + The option ``MX_LIBRARY`` is no longer needed. + +* The :module:`FindPostgreSQL` module now provides imported targets. + +* The :module:`FindPython`, :module:`FindPython2`, and :module:`FindPython3` + modules gained support for ``NumPy`` component. + +* The :module:`FindPython2`, :module:`FindPython3`, and :module:`FindPython` + modules now support running in script mode by skipping the creation of + imported targets and helper functions. + +* The :module:`FindSQLite3` module was added to find the SQLite v3.x library. + +* The :module:`FindX11` had the following variables renamed in order to match + their library names rather than header names. The old variables are provided + for compatibility: + + - ``X11_Xxf86misc_INCLUDE_PATH`` instead of ``X11_xf86misc_INCLUDE_PATH`` + - ``X11_Xxf86misc_LIB`` instead of ``X11_xf86misc_LIB`` + - ``X11_Xxf86misc_FOUND`` instead of ``X11_xf86misc_FOUND`` + - ``X11_Xxf86vm_INCLUDE_PATH`` instead of ``X11_xf86vmode_INCLUDE_PATH`` + - ``X11_Xxf86vm_LIB`` instead of ``X11_xf86vmode_LIB`` + - ``X11_Xxf86vm_FOUND`` instead of ``X11_xf86vmode_FOUND`` + - ``X11_xkbfile_INCLUDE_PATH`` instead of ``X11_Xkbfile_INCLUDE_PATH`` + - ``X11_xkbfile_LIB`` instead of ``X11_Xkbfile_LIB`` + - ``X11_xkbfile_FOUND`` instead of ``X11_Xkbfile_FOUND`` + - ``X11_Xtst_INCLUDE_PATH`` instead of ``X11_XTest_INCLUDE_PATH`` + - ``X11_Xtst_LIB`` instead of ``X11_XTest_LIB`` + - ``X11_Xtst_FOUND`` instead of ``X11_XTest_FOUND`` + - ``X11_Xss_INCLUDE_PATH`` instead of ``X11_Xscreensaver_INCLUDE_PATH`` + - ``X11_Xss_LIB`` instead of ``X11_Xscreensaver_LIB`` + - ``X11_Xss_FOUND`` instead of ``X11_Xscreensaver_FOUND`` + + The following variables are deprecated completely since they were + essentially duplicates: + + - ``X11_Xinput_INCLUDE_PATH`` (use ``X11_Xi_INCLUDE_PATH``) + - ``X11_Xinput_LIB`` (use ``X11_Xi_LIB``) + - ``X11_Xinput_FOUND`` (use ``X11_Xi_FOUND``) + +* The :module:`FindX11` now provides ``X11_Xext_INCLUDE_PATH``. + +* The :module:`FindX11` now provides imported targets. + +* The :module:`UseSWIG` module learned to pass ``-module `` to + the ``SWIG`` compiler if the file property ``SWIG_MODULE_NAME`` is defined. + See policy :policy:`CMP0086`. + +* The :module:`UseSWIG` module gained an option to specify + ``SWIG`` source file extensions. + +.. _`fontconfig`: https://www.freedesktop.org/wiki/Software/fontconfig/ +.. _`libinput`: https://www.freedesktop.org/wiki/Software/libinput/ + +Generator Expressions +--------------------- + +* The ``$`` and ``$`` + :manual:`generator expressions ` were added. + +* The ``$`` generator expression now correctly handles an + empty argument. See :policy:`CMP0085` for details. + +Autogen +------- + +* The :prop_tgt:`AUTOMOC_EXECUTABLE`, :prop_tgt:`AUTORCC_EXECUTABLE`, and + :prop_tgt:`AUTOUIC_EXECUTABLE` target properties were added. They all + take a path to an executable and force automoc/autorcc/autouic to use + this executable. + + Setting these will also prevent the configure time testing for these + executables. This is mainly useful when you build these tools yourself. + +* The new variables :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET`, + :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET_NAME`, + :variable:`CMAKE_GLOBAL_AUTORCC_TARGET` and + :variable:`CMAKE_GLOBAL_AUTORCC_TARGET_NAME` control the generation + of global ``autogen`` and ``autorcc`` targets. + +* A new :variable:`CMAKE_AUTOGEN_ORIGIN_DEPENDS` variable and + :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS` target property may be set to enable or + disable forwarding of the origin target dependencies to the corresponding + :ref:`_autogen` target. + +CTest +----- + +* :manual:`ctest(1)` gained a ``--show-only=json-v1`` option to show the + list of tests in a machine-readable JSON format. + See the :ref:`Show as JSON Object Model` section of the manual. + +* The :command:`ctest_submit` command learned a new ``Done`` part that can be used + to inform CDash that a build is complete and that no more parts will be uploaded. + +* CTest learned to accept the dashboard server submission URL from a single + variable. See the ``SubmitURL`` setting in :manual:`ctest(1)`, + the :variable:`CTEST_SUBMIT_URL` variable, and the ``SUBMIT_URL`` + argument of the :command:`ctest_submit` command. + +Deprecated and Removed Features +=============================== + +* An explicit deprecation diagnostic was added for policies ``CMP0064`` + and ``CMP0065`` (``CMP0063`` and below were already deprecated). + The :manual:`cmake-policies(7)` manual explains that the OLD behaviors + of all policies are deprecated and that projects should port to the + NEW behaviors. + +* The :generator:`Xcode` generator deprecated support for Xcode + versions prior to Xcode 5. Support for those will be dropped in a + future version of CMake. + +* The :module:`FindQt` module is no longer used by the :command:`find_package` + command as a find module. This allows the Qt Project upstream to optionally + provide its own ``QtConfig.cmake`` package configuration file and have + applications use it via ``find_package(Qt)`` rather than + ``find_package(Qt CONFIG)``. See policy :policy:`CMP0084`. + +* Support for running CMake on Windows XP and Windows Vista has been dropped. + The precompiled Windows binaries provided on ``cmake.org`` now require + Windows 7 or higher. + +* CTest no longer supports submissions via ``ftp``, ``scp``, ``cp``, and + ``xmlrpc``. CDash is the only maintained testing dashboard for CTest, + and it only supports submissions over ``http`` and ``https``. + +Other Changes +============= + +* Object library linking has been fixed to propagate private link libraries + of object libraries to consuming targets. + +* Install rules under :command:`add_subdirectory` now interleave with those in + the calling directory. See policy :policy:`CMP0082` for details. + +* CMake now imposes a maximum recursion limit to prevent a stack overflow on + scripts that recurse infinitely. The limit can be adjusted at runtime with + :variable:`CMAKE_MAXIMUM_RECURSION_DEPTH`. + +* When using cppcheck via the :variable:`CMAKE__CPPCHECK` variable + or :prop_tgt:`_CPPCHECK` property, the build will now fail if + ``cppcheck`` returns non-zero as configured by its command-line options. + +* Required link options to manage Position Independent Executable are now + added when :prop_tgt:`POSITION_INDEPENDENT_CODE` is set. The project is + responsible for using the :module:`CheckPIESupported` module to check for + ``PIE`` support to ensure that the :prop_tgt:`POSITION_INDEPENDENT_CODE` + target property will be honored at link time for executables. This behavior + is controlled by policy :policy:`CMP0083`. + +* :ref:`Visual Studio Generators` for VS 2010 and above learned + to support the ``VS_DEBUGGER_*`` properties on targets created + via :command:`add_custom_target`. + +* The :module:`CPack` module no longer defaults to the ``paxr`` value in the + :variable:`CPACK_DEBIAN_ARCHIVE_TYPE` variable, because ``dpkg`` has + never supported the PAX tar format. The ``paxr`` value will be mapped + to ``gnutar`` and a deprecation message emitted. + +* CMake no longer issues a warning if a target listed in an + :command:`install(TARGETS)` command has its :prop_tgt:`EXCLUDE_FROM_ALL` + property set to true. + +Updates +======= + +Changes made since CMake 3.14.0 include the following. + +3.14.1 +------ + +* The :module:`FindFontconfig` module added by 3.14.0 accidentally + used uppercase ``FONTCONFIG_*`` variable names that do not match + our conventions. 3.14.1 revises the module to use ``Fontconfig_*`` + variable names. This is incompatible with 3.14.0 but since the + module is new in the 3.14 series usage should not yet be widespread. + +3.14.3 +------ + +* The :variable:`CMAKE_VS_PLATFORM_NAME_DEFAULT` variable was added + to help toolchain files work with the :generator:`Visual Studio 16 2019` + generator where the default platform now depends on the host platform. + +3.14.4 +------ + +* In CMake 3.14.0 through 3.14.3, calling :command:`target_link_libraries` + to add ``PRIVATE`` dependencies to a static library created in another + directory (under policy :policy:`CMP0079` ``NEW`` behavior) would + incorrectly propagate usage requirements of those dependencies to + dependents that link the static library. This has been fixed. + The bug also existed in 3.13.0 through 3.13.4 and is fixed in 3.13.5. + +3.14.5 +------ + +* Entries of the ``CPATH`` environment variable are no longer excluded + from explicit use via :command:`include_directories` and + :command:`target_include_directories` as they were in CMake 3.14.0 + through 3.14.4. + +3.14.6 +------ + +* In CMake 3.14.0 through 3.14.5, the :module:`FindBISON` module + policy :policy:`CMP0088` ``NEW`` behavior accidentally interpreted + a relative path to the ``.y`` input as relative to the build tree + directory instead of the source tree directory. This has been fixed. + +3.14.7 +------ + +* In CMake 3.14.0 through 3.14.6, the :prop_dir:`EXCLUDE_FROM_ALL` + directory property was regressed from pre-3.14 behavior and caused + targets within the directory to be excluded even from its own "all". + This has been fixed. diff --git a/cmake/doc/cmake/html/_sources/release/3.15.rst.txt b/cmake/doc/cmake/html/_sources/release/3.15.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..de3ced0c6d18f913abd62113d6834f724d8fff4f --- /dev/null +++ b/cmake/doc/cmake/html/_sources/release/3.15.rst.txt @@ -0,0 +1,392 @@ +CMake 3.15 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.14 include the following. + +New Features +============ + +Generators +---------- + +* The :generator:`Xcode` generator now supports per-target schemes. + See the :variable:`CMAKE_XCODE_GENERATE_SCHEME` variable and + :prop_tgt:`XCODE_GENERATE_SCHEME` target property. + +* The :generator:`Green Hills MULTI` generator has been updated: + + * It now supports the :command:`add_custom_command` and + :command:`add_custom_target` commands. + + * It is now available on Linux. + +Languages +--------- + +* Preliminary support for the ``Swift`` language was added to the + :generator:`Ninja` generator: + + * Use the :envvar:`SWIFTC` environment variable to specify a compiler. + + * The :prop_tgt:`Swift_DEPENDENCIES_FILE` target property and + :prop_sf:`Swift_DEPENDENCIES_FILE` source file property were added + to customize dependency files. + + * The :prop_tgt:`Swift_MODULE_NAME` target property was added to + customize the Swift module name. + + * The :prop_sf:`Swift_DIAGNOSTICS_FILE` source property was added to + indicate where to write the serialized Swift diagnostics. + + The Swift support is experimental, not considered stable, and may change + in future releases of CMake. + +Compilers +--------- + +* The ``Clang`` compiler variant on Windows that targets the MSVC ABI + but has a GNU-like command line is now supported. + +* Support for the Clang-based ARM compiler was added with compiler id + ``ARMClang``. + +* Support was added for the IAR compiler architectures Renesas RX, + RL78, RH850 and Texas Instruments MSP430. + +* Support was added for the IAR compilers built for Linux (IAR BuildLx). + +Command-Line +------------ + +* The :envvar:`CMAKE_GENERATOR` environment variable was added + to specify a default generator to use when :manual:`cmake(1)` is + run without a ``-G`` option. Additionally, environment variables + :envvar:`CMAKE_GENERATOR_PLATFORM`, :envvar:`CMAKE_GENERATOR_TOOLSET`, + and :envvar:`CMAKE_GENERATOR_INSTANCE` were created to configure + the generator. + +* The :manual:`cmake(1)` ``--build`` tool ``--target`` parameter gained support + for multiple targets, e.g. ``cmake --build . --target Library1 Library2``. + It now also has a short form ``-t`` alias, e.g. + ``cmake --build . -t Library1 Library2``. + +* The :manual:`cmake(1)` command gained a new ``--install`` option. + This may be used after building a project to run installation without + using the generated build system or the native build tool. + +* The :manual:`cmake(1)` command learned a new CLI option ``--loglevel``. + +* The :manual:`cmake(1)` ``-E remove_directory`` command-line tool learned + to support removing multiple directories. + +* The :manual:`cmake(1)` ``-E tar`` tool has been improved: + + * It now continues adding files to an archive even if some of the files + are not readable. This behavior is more consistent with the + classic ``tar`` tool. + + * It now parses all flags, and if an invalid flag was provided, a + warning is issued. + + * It now displays an error if no action flag was specified, along with a + list of possible actions: ``t`` (list), ``c`` (create) or ``x`` (extract). + + * It now supports extracting (``-x``) or listing (``-t``) only specific + files or directories. + + * It now supports Zstandard compression with a ``--zstd`` option. + Zstandard was designed to give a compression ratio comparable to that + of the DEFLATE (zip) algorithm, but faster, especially for decompression. + +Commands +-------- + +* The :command:`add_custom_command` and :command:`add_custom_target` commands + gained a new ``JOB_POOL`` option that works with the :generator:`Ninja` + generator to set the pool variable on the build statement. + +* The :command:`add_library` command ``ALIAS`` option learned to support + import libraries of the ``UNKNOWN`` type. + +* The :command:`cmake_parse_arguments` command gained an additional + ``_KEYWORDS_MISSING_VALUES`` output variable to report + keyword arguments that were given by the caller with no values. + +* The :command:`execute_process` command gained a ``COMMAND_ECHO`` option + and supporting :variable:`CMAKE_EXECUTE_PROCESS_COMMAND_ECHO` variable + to enable echoing of the command-line string before execution. + +* The :command:`file(INSTALL)` command learned a new argument, + ``FOLLOW_SYMLINK_CHAIN``, which can be used to recursively resolve and + install symlinks. + +* :command:`list` learned new sub-commands: + ``PREPEND``, ``POP_FRONT`` and ``POP_BACK``. + +* The :command:`message` command learned new types: + ``NOTICE``, ``VERBOSE``, ``DEBUG`` and ``TRACE``. + +* The :command:`string` learned a new sub-command ``REPEAT``. + +Variables +--------- + +* The :variable:`CMAKE_CROSSCOMPILING_EMULATOR` variable and corresponding + :prop_tgt:`CROSSCOMPILING_EMULATOR` target property learned to support + arguments to the emulator. + +* The :variable:`CMAKE_FIND_PACKAGE_PREFER_CONFIG` variable was added to tell + :command:`find_package` calls to look for a package configuration + file first even if a find module is available. + +* The :variable:`CMAKE_FRAMEWORK` variable was added to initialize the + :prop_tgt:`FRAMEWORK` property on all targets. + +* The :variable:`CMAKE_VS_JUST_MY_CODE_DEBUGGING` variable and + :prop_tgt:`VS_JUST_MY_CODE_DEBUGGING` target property were added to + enable the Just My Code feature of the Visual Studio Debugger when + compiling with MSVC cl 19.05 and higher. + +* The :variable:`CMAKE_MSVC_RUNTIME_LIBRARY` variable and + :prop_tgt:`MSVC_RUNTIME_LIBRARY` target property were introduced to + select the runtime library used by compilers targeting the MSVC ABI. + See policy :policy:`CMP0091`. + +* The :variable:`CMAKE_PROJECT_INCLUDE` and + :variable:`CMAKE_PROJECT_INCLUDE_BEFORE` variables were added to allow + injection of custom code at the sites of :command:`project` calls + without knowing the project name a priori. + +Properties +---------- + +* The :prop_tgt:`ADDITIONAL_CLEAN_FILES` target property and + :prop_dir:`ADDITIONAL_CLEAN_FILES` directory property were added. + They allow to register additional files that should be removed during + the clean stage. + +* The :prop_tgt:`PUBLIC_HEADER` and :prop_tgt:`PRIVATE_HEADER` properties + may now be set on :ref:`Interface Libraries`. The headers specified by those + properties can be installed using the :command:`install(TARGETS)` command by + passing the ``PUBLIC_HEADER`` and ``PRIVATE_HEADER`` arguments respectively. + +* The :prop_tgt:`VS_PACKAGE_REFERENCES` target property was added to + tell :ref:`Visual Studio Generators` to add references to ``nuget`` + packages. + +* The :prop_tgt:`VS_PROJECT_IMPORT` target property was added to allow + managed Visual Studio project files to import external ``.props`` files. + +* The :prop_tgt:`VS_NO_SOLUTION_DEPLOY` target property was added to + tell :ref:`Visual Studio Generators` whether to deploy an artifact + to the WinCE or Windows Phone target device. + +Modules +------- + +* The :module:`FindBoost` module was reworked to expose a more consistent + user experience between its "Config" and "Module" modes and with other + find modules in general. + + * A new imported target ``Boost::headers`` is now defined (same + as ``Boost::boost``). + + * New output variables ``Boost_VERSION_MACRO``, + ``Boost_VERSION_MAJOR``, ``Boost_VERSION_MINOR``, + ``Boost_VERSION_PATCH``, and ``Boost_VERSION_COUNT`` + were added. + + * The ``QUIET`` argument passed to :command:`find_package` is no + longer ignored in config mode. Note that the CMake package shipped with + Boost ``1.70.0`` ignores the ``QUIET`` argument passed to + :command:`find_package`. This is fixed in the next Boost release. + + * The input switch ``Boost_DETAILED_FAILURE_MSG`` was removed. + + * ``Boost_VERSION`` now reports the version in ``x.y.z`` + format in module mode. See policy :policy:`CMP0093`. + +* The :module:`FindCups` module now provides imported targets. + +* The :module:`FindEnvModules` module was added to use Lua- and TCL-based + environment modules in :ref:`CTest Scripts `. + +* The :module:`FindGLEW` module now provides an interface more consistent + with what upstream GLEW provides in its own CMake package files. + +* The :module:`FindPkgConfig` now populates :prop_tgt:`INTERFACE_LINK_OPTIONS` + property of imported targets with other (non-library) linker flags. + +* The :module:`FindPostgreSQL` module learned to find debug and release + variants separately. + +* Modules :module:`FindPython3`, :module:`FindPython2` and :module:`FindPython` + gained additional lookup strategies and controls, and a new default. + See policy :policy:`CMP0094`. + +* Modules :module:`FindPython`, :module:`FindPython2` and :module:`FindPython3` + gain a new target (respectively ``Python::Module``, ``Python2::Module`` + and ``Python3::Module``) which can be used to develop Python modules. + +* Modules :module:`FindPython3`, :module:`FindPython2` and :module:`FindPython` + gain capability to control how virtual environments are handled. + +* The :module:`UseSWIG` module learned to manage alternate library names + by passing ``-interface `` for ``python`` language or + ``-dllimport `` for ``CSharp`` language to the ``SWIG`` + compiler. + +Generator Expressions +--------------------- + +* The generator expressions :genex:`$`, + :genex:`$`, :genex:`$`, + :genex:`$`, :genex:`$`, + :genex:`$`, and :genex:`$` learned to + support matching one value from a comma-separated list. + +* The :genex:`$` and :genex:`$` + generator expressions were added. + +* The :genex:`$` generator expression was introduced to + allow specification of compile options for target files based on the + :variable:`CMAKE__COMPILER_ID` and :prop_sf:`LANGUAGE` of + each source file. + +* A :genex:`$` generator expression has + been added. + +* A :genex:`$` generator expression has been added. + +* The :genex:`$` generator expression gained support for a + list of paths. + +* New ``$`` :manual:`generator expressions + ` were added to retrieve the prefix, base + name, and suffix of the file names of various artifacts: + + * :genex:`$` + * :genex:`$` + * :genex:`$` + * :genex:`$` + * :genex:`$` + * :genex:`$` + * :genex:`$` + +* The :genex:`$` generator expression is now supported + on ``SHARED``, ``STATIC``, ``MODULE`` libraries and executables. + +CTest +----- + +* The :command:`ctest_submit` command learned a new option: ``BUILD_ID``. + This can be used to store the ID assigned to this build by CDash to a + variable. + +* The :command:`ctest_update` command learned to honor a new variable: + :variable:`CTEST_UPDATE_VERSION_OVERRIDE`. This can be used to specify + the current version of your source tree rather than using the update + command to discover the current version that is checked out. + +CPack +----- + +* The :cpack_gen:`CPack IFW Generator` gained a new + :variable:`CPACK_IFW_PACKAGE_STYLE_SHEET` variable to customize the + installer stylesheet. + +Deprecated and Removed Features +=============================== + +* The :manual:`cmake-server(7)` mode has been deprecated and will be + removed from a future version of CMake. Please port clients to use + the :manual:`cmake-file-api(7)` instead. + +* The :prop_dir:`ADDITIONAL_MAKE_CLEAN_FILES` directory property is now + deprecated. Use the :prop_dir:`ADDITIONAL_CLEAN_FILES` directory property + instead. + +* The variable :variable:`CMAKE_AUTOMOC_RELAXED_MODE` is considered + deprecated. Support still exists but will be removed in future versions. + +* The :command:`export(PACKAGE)` command now does nothing unless + enabled via :variable:`CMAKE_EXPORT_PACKAGE_REGISTRY`. + See policy :policy:`CMP0090`. + +* The :generator:`Xcode` generator now requires at least Xcode 5. + +* An explicit deprecation diagnostic was added for policy ``CMP0066`` + (``CMP0065`` and below were already deprecated). + The :manual:`cmake-policies(7)` manual explains that the OLD behaviors + of all policies are deprecated and that projects should port to the + NEW behaviors. + +Other Changes +============= + +* If a feature specified by :command:`target_compile_features` is available + in the compiler's default standard level, CMake 3.14 and below incorrectly + added unnecessary ``-std=`` flags that could lower the standard level. + This bug has been fixed in CMake 3.15. This behavior change may expose + bugs in existing projects that were relying on undocumented implementation + details. Specifying compile features only ensures that the compiler runs + in a mode that has those features, not that any specific standard level is + used or explicit ``-std=`` flag passed. + +* CMake learned how to compile C++14 with the IBM AIX XL compiler + and the SunPro compiler and to compile C++20 with the AppleClang compiler. + +* With MSVC-like compilers the value of :variable:`CMAKE__FLAGS` + no longer contains warning flags like ``/W3`` by default. + See policy :policy:`CMP0092`. + +* IBM Clang-based XL compilers that define ``__ibmxl__`` now use the + compiler id ``XLClang`` instead of ``XL``. See policy :policy:`CMP0089`. + +* The :command:`file(REMOVE)` and :command:`file(REMOVE_RECURSE)` commands + were changed to ignore empty arguments with a warning instead of treating + them as a relative path and removing the contents of the current directory. + +Updates +======= + +Changes made since CMake 3.15.0 include the following. + +3.15.1 +------ + +* In CMake 3.15.0 support for the GNU-like ``Clang`` compiler targeting the + MSVC ABI implemented :variable:`CMAKE_CXX_STANDARD` values 98 and 11 using + the corresponding ``-std=`` flags. However, these modes do not work with + the MSVC standard library. Therefore CMake 3.15.1 passes C++14 standard + flags even for C++98 and C++11. This is consistent with MSVC itself which + always runs in a mode aware of C++14. + +* Preliminary Swift support added in 3.15.0 has been updated. + +3.15.2 +------ + +* In CMake 3.15.0 and 3.15.1 the :variable:`CMAKE_FIND_PACKAGE_PREFER_CONFIG` + variable caused the :command:`find_package` command to fail on a missing + package even without the ``REQUIRED`` option. This has been fixed. + +3.15.3 +------ + +* ``CrayPrgEnv`` compiler wrapper support has been updated for the 19.06 + release of the Cray Programming Environment for which the default linking + mode on XC Cray systems is now dynamic instead of static. + +3.15.4 +------ + +* In CMake 3.15.0 through 3.15.3, the :prop_dir:`EXCLUDE_FROM_ALL` + directory property was regressed from pre-3.14 behavior and caused + targets within the directory to be excluded even from its own "all". + This has been fixed. + The bug also existed in 3.14.0 through 3.14.6 and is fixed in 3.14.7. diff --git a/cmake/doc/cmake/html/_sources/release/3.16.rst.txt b/cmake/doc/cmake/html/_sources/release/3.16.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..28273a762f8b53496b5ab9d422db09393654551b --- /dev/null +++ b/cmake/doc/cmake/html/_sources/release/3.16.rst.txt @@ -0,0 +1,324 @@ +CMake 3.16 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.15 include the following. + +New Features +============ + +Languages +--------- + +* CMake learned to support the Objective C (``OBJC``) and Objective C++ + (``OBJCXX``) languages. They may be enabled via the :command:`project` + and :command:`enable_language` commands. When ``OBJC`` or ``OBJCXX`` + is enabled, source files with the ``.m`` or ``.mm``, respectively, + will be compiled as Objective C or C++. Otherwise they will be treated + as plain C++ sources as they were before. + +Compilers +--------- + +* The ``Clang`` compiler is now supported on ``Solaris``. + +Platforms +--------- + +* On AIX, executables using the :prop_tgt:`ENABLE_EXPORTS` target property + now produce a linker import file with a ``.imp`` extension in addition + to the executable file. Plugins (created via :command:`add_library` with + the ``MODULE`` option) that use :command:`target_link_libraries` to link + to the executable for its symbols are now linked using the import file. + The :command:`install(TARGETS)` command now installs the import file as + an ``ARCHIVE`` artifact. + +* On AIX, runtime linking is no longer enabled by default. CMake provides + the linker enough information to resolve all symbols up front. + One may manually enable runtime linking for shared libraries and/or + loadable modules by adding ``-Wl,-G`` to their link flags + (e.g. in the :variable:`CMAKE_SHARED_LINKER_FLAGS` or + :variable:`CMAKE_MODULE_LINKER_FLAGS` variable). + One may manually enable runtime linking for executables by adding + ``-Wl,-brtl`` to their link flags (e.g. in the + :variable:`CMAKE_EXE_LINKER_FLAGS` variable). + +Command-Line +------------ + +* :manual:`cmake(1)` ``-E`` now supports ``true`` and ``false`` commands, + which do nothing while returning exit codes of 0 and 1, respectively. + +* :manual:`cmake(1)` gained a ``--trace-redirect=`` command line + option that can be used to redirect ``--trace`` output to a file instead + of ``stderr``. + +* The :manual:`cmake(1)` ``--loglevel`` command line option has been + renamed to ``--log-level`` to make it consistent with the naming of other + command line options. The ``--loglevel`` option is still supported to + preserve backward compatibility. + +Commands +-------- + +* The :command:`add_test` command learned the option ``COMMAND_EXPAND_LISTS`` + which causes lists in the ``COMMAND`` argument to be expanded, including + lists created by generator expressions. + +* The :command:`file` command learned a new sub-command, + ``GET_RUNTIME_DEPENDENCIES``, which allows you to recursively get the list of + libraries linked by an executable or library. This sub-command is intended as + a replacement for :module:`GetPrerequisites`. + +* The :command:`find_file`, :command:`find_library`, :command:`find_path`, + :command:`find_package`, and :command:`find_program` commands have learned to + check the following variables to control the default behavior for groups of + search locations: + + * :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` - Controls the default + behavior of searching the :variable:`_ROOT` variables. + + * :variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH` - Controls the default + behavior of searching the CMake-specific environment variables. + + * :variable:`CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH` - Controls the default + behavior of searching the standard system environment variables. + + * :variable:`CMAKE_FIND_USE_CMAKE_PATH` - Controls the default behavior of + searching the CMake-specific cache variables. + + * :variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH` - Controls the default + behavior of searching the platform-specific CMake variables. + +* The :command:`find_package` command has learned to check the + :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` variable to control the default + behavior of searching the CMake user package registry and to check the + :variable:`CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY` variable to control + the default behavior of searching the CMake system package registry. + +* The :command:`message` command learned indentation control with the new + :variable:`CMAKE_MESSAGE_INDENT` variable. + +* The :command:`target_precompile_headers` command was added to specify + a list of headers to precompile for faster compilation times. + +Variables +--------- + +* The :variable:`CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS` variable has been + introduced to optionally initialize the + :prop_tgt:`CUDA_RESOLVE_DEVICE_SYMBOLS` target property. + +* The :variable:`CMAKE_ECLIPSE_RESOURCE_ENCODING` variable was added to + specify the resource encoding for the the :generator:`Eclipse CDT4` extra + generator. + +* The :variable:`CMAKE_UNITY_BUILD` variable was added to initialize the + :prop_tgt:`UNITY_BUILD` target property to tell generators to batch + include source files for faster compilation times. + +Properties +---------- + +* The :prop_tgt:`BUILD_RPATH` and :prop_tgt:`INSTALL_RPATH` target properties + now support :manual:`generator expressions `. + +* The :prop_tgt:`INSTALL_REMOVE_ENVIRONMENT_RPATH` target property was + added to remove compiler-defined ``RPATH`` entries from a target. + This property is initialized by the + :variable:`CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH` variable. + +* The :prop_tgt:`PRECOMPILE_HEADERS` target property was added to specify + a list of headers to precompile for faster compilation times. + Set it using the :command:`target_precompile_headers` command. + +* The :prop_tgt:`UNITY_BUILD` target property was added to tell + generators to batch include source files for faster compilation + times. + +* The :prop_tgt:`VS_CONFIGURATION_TYPE` target property now supports + :manual:`generator expressions `. + +* The :prop_tgt:`VS_DPI_AWARE` target property was added to tell + :ref:`Visual Studio Generators` to set the ``EnableDpiAwareness`` + property in ``.vcxproj`` files. + +* The :prop_tgt:`XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING` target property was + added to tell the :generator:`Xcode` generator to set the value of the + ``Allow debugging when using document Versions Browser`` schema option. + +Modules +------- + +* The :module:`FindDoxygen` module :command:`doxygen_add_docs` command + gained a new ``USE_STAMP_FILE`` option. When this option present, + the custom target created by the command will only re-run Doxygen if + any of the source files have changed since the last successful run. + +* The :module:`FindGnuTLS` module now provides an imported target. + +* The :module:`FindPackageHandleStandardArgs` module + :command:`find_package_handle_standard_args` command gained + a new ``REASON_FAILURE_MESSAGE`` option to specify a message + giving the reason for the failure. + +* The :module:`FindPkgConfig` module :command:`pkg_search_module` macro + now defines a ``_MODULE_NAME`` result variable containing the + first matching module name. + +* The :module:`FindPython3` and :module:`FindPython` modules gained + options to control which ``ABIs`` will be searched. + +* The :module:`FindPython3`, :module:`FindPython2`, and :module:`FindPython` + modules now support direct specification of artifacts via cache entries. + +Autogen +------- + +* When using :prop_tgt:`AUTOMOC`, the new :variable:`CMAKE_AUTOMOC_PATH_PREFIX` + variable or :prop_tgt:`AUTOMOC_PATH_PREFIX` target property may be enabled + to generate the ``-p`` path prefix + option for ``moc``. This ensures that ``moc`` output files are identical + on different build setups (given, that the headers compiled by ``moc`` are + in an :command:`include directory `). + Also it ensures that ``moc`` output files will compile correctly when the + source and/or build directory is a symbolic link. + +CTest +----- + +* :manual:`ctest(1)` now has the ability to schedule tests based on resource + requirements for each test. See :ref:`ctest-resource-allocation` for + details. + +* A new test property, :prop_test:`SKIP_REGULAR_EXPRESSION`, has been added. + This property is similar to :prop_test:`FAIL_REGULAR_EXPRESSION` and + :prop_test:`PASS_REGULAR_EXPRESSION`, but with the same meaning as + :prop_test:`SKIP_RETURN_CODE`. This is useful, for example, in cases where + the user has no control over the return code of the test. For example, in + Catch2, the return value is the number of assertion failed, therefore it is + impossible to use it for :prop_test:`SKIP_RETURN_CODE`. + +CPack +----- + +* :manual:`cpack(1)` learned support for multiple configurations for ``-C`` + option. + +* The :cpack_gen:`CPack DEB Generator` is now able to format generic text + (usually used as the description for multiple CPack generators) according + to the `Debian Policy Manual`_. See the + :variable:`CPACK_PACKAGE_DESCRIPTION_FILE` and + :variable:`CPACK_DEBIAN__DESCRIPTION` variables. + +* The :cpack_gen:`CPack Archive Generator` learned to generate ``.tar.zst`` + packages with Zstandard compression. + +.. _`Debian Policy Manual`: https://www.debian.org/doc/debian-policy/ch-controlfields.html#description + +Deprecated and Removed Features +=============================== + +* An explicit deprecation diagnostic was added for policy ``CMP0067`` + (``CMP0066`` and below were already deprecated). + The :manual:`cmake-policies(7)` manual explains that the OLD behaviors + of all policies are deprecated and that projects should port to the + NEW behaviors. + +* The :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` variable has been + deprecated. Use the :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` variable + instead. + +* The :module:`GetPrerequisites` module has been deprecated, as it has been + superseded by :command:`file(GET_RUNTIME_DEPENDENCIES)`. + +* The ``CPACK_INSTALL_SCRIPT`` variable has been deprecated in favor of the + new, more accurately named :variable:`CPACK_INSTALL_SCRIPTS` variable. + +Other Changes +============= + +* The :manual:`cmake(1)` ``-C `` option now evaluates the + initial cache script with :variable:`CMAKE_SOURCE_DIR` and + :variable:`CMAKE_BINARY_DIR` set to the top-level source and build trees. + +* The :manual:`cmake(1)` ``-E remove_directory`` command-line tool, + when given the path to a symlink to a directory, now removes just + the symlink. It no longer removes content of the linked directory. + +* The :manual:`ctest(1)` ``--build-makeprogram`` command-line option now + specifies the make program used when configuring a project with the + :generator:`Ninja` generator or the :ref:`Makefile Generators`. + +* The :module:`ExternalProject` module :command:`ExternalProject_Add` command + has been updated so that ``GIT_SUBMODULES ""`` initializes no submodules. + See policy :policy:`CMP0097`. + +* The :module:`FindGTest` module has been updated to recognize + MSVC build trees generated by GTest 1.8.1. + +* The :command:`project` command no longer strips leading zeros in version + components. See policy :policy:`CMP0096`. + +* The Qt Compressed Help file is now named ``CMake.qch``, which no longer + contains the release version in the file name. When CMake is upgraded + in-place, the name and location of this file will remain constant. + Tools such as IDEs, help viewers, etc. should now be able to refer to this + file at a fixed location that remains valid across CMake upgrades. + +* ``RPATH`` entries are properly escaped in the generated CMake scripts + used for installation. See policy :policy:`CMP0095`. + +* When using :variable:`CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS` on Windows the + auto-generated exports are now updated only when the object files + providing the symbols are updated. + +Updates +======= + +Changes made since CMake 3.16.0 include the following. + +3.16.2 +------ + +* CMake 3.16.0 and 3.16.1 processed ``.hh`` files with :prop_tgt:`AUTOMOC`. + This was a behavior change from CMake 3.15 and below that can break + existing projects, so it has been reverted as of 3.16.2. + +3.16.5 +------ + +* The :module:`FindPython`, :module:`FindPython2`, and :module:`FindPython3` + modules no longer create cache entries for ``Python{,2,3}_LIBRARY_RELEASE`` + and ``Python{,2,3}_LIBRARY_DEBUG``. Those values are always computed from + other results and so should not be cached. The entries were created by + CMake 3.16.0 through 3.16.4 but were always ``FORCE``-set and could not + be meaningfully edited by users. + + Additionally, the modules no longer expose their internal ``_Python*`` + cache entries publicly. CMake 3.16.0 through 3.16.4 accidentally + made them visible as advanced cache entries. + +3.16.7 +------ + +* Selection of the Objective C or C++ compiler now considers the + :envvar:`CC` or :envvar:`CXX` environment variable if the + :envvar:`OBJC` or :envvar:`OBJCXX` environment variable is not set. + +* The :module:`FindPkgConfig` module now extracts include directories + prefixed with ``-isystem`` into the ``*_INCLUDE_DIRS`` variables and + :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` target properties. + Previously they would be places in ``*_CFLAGS_OTHER`` variables and + :prop_tgt:`INTERFACE_COMPILE_OPTIONS` target properties. + +3.16.9 +------ + +* The default value of :variable:`CMAKE_AUTOMOC_PATH_PREFIX` was changed to + ``OFF`` because this feature can break existing projects that have + identically named header files in different include directories. + This restores compatibility with behavior of CMake 3.15 and below. diff --git a/cmake/doc/cmake/html/_sources/release/3.17.rst.txt b/cmake/doc/cmake/html/_sources/release/3.17.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..a27d638a8e45c4a9d48546c69eebf95bd4e52931 --- /dev/null +++ b/cmake/doc/cmake/html/_sources/release/3.17.rst.txt @@ -0,0 +1,357 @@ +CMake 3.17 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.16 include the following. + +New Features +============ + +Generators +---------- + +* :manual:`cmake(1)` gained a :generator:`Ninja Multi-Config` generator, + which is similar to the :generator:`Ninja` generator but can be used to build + multiple configurations at once. + +* :ref:`Visual Studio Generators` learned to support per-config sources. + Previously only :ref:`Command-Line Build Tool Generators` supported them. + +* :ref:`Visual Studio Generators` for VS 2010 and above now support + specifying the ``VCTargetsPath`` value for project files in + :variable:`CMAKE_GENERATOR_TOOLSET` setting. + +* :ref:`Visual Studio Generators` for VS 2010 and above learned to + support .NET Standard and .NET Core. See the + :prop_tgt:`DOTNET_TARGET_FRAMEWORK` target property and + associated :variable:`CMAKE_DOTNET_TARGET_FRAMEWORK` variable. + +Languages +--------- + +* The :manual:`Compile Features ` functionality + now offers meta-features for the CUDA language standard levels + (e.g. ``cuda_std_03``, ``cuda_std_14``). See + :prop_gbl:`CMAKE_CUDA_KNOWN_FEATURES`. + +Compilers +--------- + +* The IBM XL Fortran compiler is now supported by the :generator:`Ninja` + generator. + +Command-Line +------------ + +* :manual:`cmake(1)` gained a ``--debug-find`` command-line option to + enable additional human-readable output on where ``find_*`` commands search. + +* :manual:`cmake(1)` gained a ``--trace-format`` command-line option that + can be used to set the ``--trace`` output format. Currently, the old + human readable and the new JSON format are supported. The new JSON format + is easier to parse automatically than the existing format. + +* :manual:`cmake(1)` gained a ``-E rm`` command-line tool that can be + used to remove directories and files. This supersedes the existing + ``-E remove`` and ``-E remove_directory`` tools and has better semantics. + +Commands +-------- + +* The :command:`add_custom_command` command learned to interpret paths in + ``DEPENDS`` arguments that are specified relative to the current + binary directory. + +* The :command:`foreach` command learned a new ``ZIP_LISTS`` option to iterate + over multiple lists simultaneously. + +* The :command:`load_cache(READ_WITH_PREFIX)` command mode is now allowed + when using ``cmake -P`` to :ref:`Run a Script