codekingpro commited on
Commit
3fac847
·
verified ·
1 Parent(s): 87f8c36

Add files using upload-large-folder tool

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. cmake/doc/cmake/html/_sources/policy/CMP0144.rst.txt +25 -0
  2. cmake/doc/cmake/html/_sources/policy/CMP0145.rst.txt +29 -0
  3. cmake/doc/cmake/html/_sources/policy/CMP0146.rst.txt +28 -0
  4. cmake/doc/cmake/html/_sources/policy/CMP0147.rst.txt +23 -0
  5. cmake/doc/cmake/html/_sources/policy/CMP0148.rst.txt +28 -0
  6. cmake/doc/cmake/html/_sources/policy/CMP0149.rst.txt +53 -0
  7. cmake/doc/cmake/html/_sources/policy/CMP0150.rst.txt +39 -0
  8. cmake/doc/cmake/html/_sources/policy/CMP0151.rst.txt +27 -0
  9. cmake/doc/cmake/html/_sources/policy/CMP0152.rst.txt +21 -0
  10. cmake/doc/cmake/html/_sources/policy/CMP0153.rst.txt +14 -0
  11. cmake/doc/cmake/html/_sources/policy/CMP0154.rst.txt +58 -0
  12. cmake/doc/cmake/html/_sources/policy/CMP0155.rst.txt +27 -0
  13. cmake/doc/cmake/html/_sources/policy/CMP0156.rst.txt +51 -0
  14. cmake/doc/cmake/html/_sources/policy/CMP0157.rst.txt +47 -0
  15. cmake/doc/cmake/html/_sources/policy/CMP0158.rst.txt +28 -0
  16. cmake/doc/cmake/html/_sources/policy/CMP0159.rst.txt +23 -0
  17. cmake/doc/cmake/html/_sources/policy/CMP0160.rst.txt +39 -0
  18. cmake/doc/cmake/html/_sources/policy/CMP0161.rst.txt +36 -0
  19. cmake/doc/cmake/html/_sources/policy/CMP0162.rst.txt +47 -0
  20. cmake/doc/cmake/html/_sources/policy/CMP0163.rst.txt +37 -0
  21. cmake/doc/cmake/html/_sources/policy/CMP0164.rst.txt +31 -0
  22. cmake/doc/cmake/html/_sources/policy/CMP0165.rst.txt +26 -0
  23. cmake/doc/cmake/html/_sources/policy/CMP0166.rst.txt +40 -0
  24. cmake/doc/cmake/html/_sources/policy/CMP0167.rst.txt +28 -0
  25. cmake/doc/cmake/html/_sources/policy/CMP0168.rst.txt +72 -0
  26. cmake/doc/cmake/html/_sources/policy/CMP0169.rst.txt +49 -0
  27. cmake/doc/cmake/html/_sources/policy/CMP0170.rst.txt +30 -0
  28. cmake/doc/cmake/html/_sources/policy/CMP0171.rst.txt +26 -0
  29. cmake/doc/cmake/html/_sources/policy/CMP0172.rst.txt +39 -0
  30. cmake/doc/cmake/html/_sources/policy/CMP0173.rst.txt +22 -0
  31. cmake/doc/cmake/html/_sources/policy/CMP0174.rst.txt +37 -0
  32. cmake/doc/cmake/html/_sources/policy/CMP0175.rst.txt +40 -0
  33. cmake/doc/cmake/html/_sources/policy/CMP0176.rst.txt +27 -0
  34. cmake/doc/cmake/html/_sources/policy/CMP0177.rst.txt +38 -0
  35. cmake/doc/cmake/html/_sources/policy/CMP0178.rst.txt +37 -0
  36. cmake/doc/cmake/html/_sources/policy/CMP0179.rst.txt +28 -0
  37. cmake/doc/cmake/html/_sources/policy/CMP0180.rst.txt +36 -0
  38. cmake/doc/cmake/html/_sources/prop_cache/ADVANCED.rst.txt +8 -0
  39. cmake/doc/cmake/html/_sources/prop_cache/HELPSTRING.rst.txt +7 -0
  40. cmake/doc/cmake/html/_sources/prop_cache/MODIFIED.rst.txt +7 -0
  41. cmake/doc/cmake/html/_sources/prop_cache/STRINGS.rst.txt +9 -0
  42. cmake/doc/cmake/html/_sources/prop_cache/TYPE.rst.txt +21 -0
  43. cmake/doc/cmake/html/_sources/prop_cache/VALUE.rst.txt +7 -0
  44. cmake/doc/cmake/html/_sources/prop_dir/ADDITIONAL_CLEAN_FILES.rst.txt +23 -0
  45. cmake/doc/cmake/html/_sources/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst.txt +17 -0
  46. cmake/doc/cmake/html/_sources/prop_dir/BINARY_DIR.rst.txt +7 -0
  47. cmake/doc/cmake/html/_sources/prop_dir/BUILDSYSTEM_TARGETS.rst.txt +15 -0
  48. cmake/doc/cmake/html/_sources/prop_dir/CACHE_VARIABLES.rst.txt +7 -0
  49. cmake/doc/cmake/html/_sources/prop_dir/CLEAN_NO_CUSTOM.rst.txt +6 -0
  50. cmake/doc/cmake/html/_sources/prop_dir/CMAKE_CONFIGURE_DEPENDS.rst.txt +9 -0
cmake/doc/cmake/html/_sources/policy/CMP0144.rst.txt ADDED
@@ -0,0 +1,25 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0144
2
+ -------
3
+
4
+ .. versionadded:: 3.27
5
+
6
+ :command:`find_package` uses upper-case ``<PACKAGENAME>_ROOT`` variables.
7
+
8
+ In CMake 3.27 and above the :command:`find_package(<PackageName>)` command now
9
+ searches prefixes specified by the upper-case :variable:`<PACKAGENAME>_ROOT`
10
+ CMake variable and the :envvar:`<PACKAGENAME>_ROOT` environment variable
11
+ in addition to the case-preserved :variable:`<PackageName>_ROOT` and
12
+ :envvar:`<PackageName>_ROOT` variables used since policy :policy:`CMP0074`.
13
+ This policy provides compatibility with projects that have not been
14
+ updated to avoid using ``<PACKAGENAME>_ROOT`` variables for other purposes.
15
+
16
+ The ``OLD`` behavior for this policy is to ignore ``<PACKAGENAME>_ROOT``
17
+ variables if the original ``<PackageName>`` has lower-case characters.
18
+ The ``NEW`` behavior for this policy is to use ``<PACKAGENAME>_ROOT``
19
+ variables.
20
+
21
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27
22
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
23
+ .. include:: STANDARD_ADVICE.txt
24
+
25
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0145.rst.txt ADDED
@@ -0,0 +1,29 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0145
2
+ -------
3
+
4
+ .. versionadded:: 3.27
5
+
6
+ The :module:`Dart` and :module:`FindDart` modules are removed.
7
+
8
+ These modules were added very early in CMake's development to support
9
+ driving tests with a "DART" tool, but DART has not been distributed or
10
+ maintained for many years. Projects would ``include(Dart)`` to use it,
11
+ and the ``Dart`` module would run ``find_package(Dart)`` internally.
12
+ Since :manual:`ctest(1)` was created, the ``Dart`` module has just been
13
+ a compatibility shim that finds ``Dart`` to support some legacy
14
+ functionality and then forwards to the :module:`CTest` module.
15
+
16
+ CMake 3.27 and above prefer to not provide the :module:`Dart` or
17
+ :module:`FindDart` modules. This policy provides compatibility for
18
+ projects that have not been ported away from them. Projects using the
19
+ ``Dart`` module should be updated to use the :module:`CTest` module directly.
20
+
21
+ The ``OLD`` behavior of this policy is for ``include(Dart)`` and
22
+ ``find_package(Dart)`` to load the deprecated modules. The ``NEW``
23
+ behavior is for uses of the modules to fail as if they do not exist.
24
+
25
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27
26
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
27
+ .. include:: STANDARD_ADVICE.txt
28
+
29
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0146.rst.txt ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0146
2
+ -------
3
+
4
+ .. versionadded:: 3.27
5
+
6
+ The :module:`FindCUDA` module is removed.
7
+
8
+ The :module:`FindCUDA` module has been deprecated since CMake 3.10.
9
+ CMake 3.27 and above prefer to not provide the module.
10
+ This policy provides compatibility for projects that have not been
11
+ ported away from it.
12
+
13
+ Projects using the :module:`FindCUDA` module should be updated to use
14
+ CMake's first-class ``CUDA`` language support. List ``CUDA`` among the
15
+ languages named in the top-level call to the :command:`project` command,
16
+ or call the :command:`enable_language` command with ``CUDA``.
17
+ Then one can add CUDA (``.cu``) sources directly to targets,
18
+ similar to other languages.
19
+
20
+ The ``OLD`` behavior of this policy is for ``find_package(CUDA)`` to
21
+ load the deprecated module. The ``NEW`` behavior is for uses of the
22
+ module to fail as if it does not exist.
23
+
24
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27
25
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
26
+ .. include:: STANDARD_ADVICE.txt
27
+
28
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0147.rst.txt ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0147
2
+ -------
3
+
4
+ .. versionadded:: 3.27
5
+
6
+ :ref:`Visual Studio Generators` build custom commands in parallel.
7
+
8
+ Visual Studio 15.8 (2017) and newer support building custom commands in
9
+ parallel. CMake 3.27 and above prefer to enable this behavior by adding
10
+ a ``BuildInParallel`` setting to custom commands in ``.vcxproj`` files.
11
+ This policy provides compatibility for projects that have not been updated
12
+ to expect this, e.g., because their custom commands were accidentally
13
+ relying on serial execution by MSBuild.
14
+
15
+ The ``OLD`` behavior for this policy is to not add ``BuildInParallel``.
16
+ The ``NEW`` behavior for this policy is to add ``BuildInParallel`` for
17
+ VS 15.8 and newer.
18
+
19
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27
20
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
21
+ .. include:: STANDARD_ADVICE.txt
22
+
23
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0148.rst.txt ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0148
2
+ -------
3
+
4
+ .. versionadded:: 3.27
5
+
6
+ The :module:`FindPythonInterp` and :module:`FindPythonLibs` modules are removed.
7
+
8
+ These modules have been deprecated since CMake 3.12.
9
+ CMake 3.27 and above prefer to not provide the modules.
10
+ This policy provides compatibility for projects that have not been
11
+ ported away from them.
12
+
13
+ Projects using the :module:`FindPythonInterp` and/or :module:`FindPythonLibs`
14
+ modules should be updated to use one of their replacements:
15
+
16
+ * :module:`FindPython3`
17
+ * :module:`FindPython2`
18
+ * :module:`FindPython`
19
+
20
+ The ``OLD`` behavior of this policy is for ``find_package(PythonInterp)``
21
+ and ``find_package(PythonLibs)`` to load the deprecated modules. The ``NEW``
22
+ behavior is for uses of the modules to fail as if they do not exist.
23
+
24
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27
25
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
26
+ .. include:: STANDARD_ADVICE.txt
27
+
28
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0149.rst.txt ADDED
@@ -0,0 +1,53 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0149
2
+ -------
3
+
4
+ .. versionadded:: 3.27
5
+
6
+ :ref:`Visual Studio Generators` select latest Windows SDK by default.
7
+
8
+ Visual Studio Generators select a Windows SDK version to put in the
9
+ ``WindowsTargetPlatformVersion`` setting in ``.vcxproj`` files.
10
+ CMake sets the :variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION`
11
+ variable to the selected SDK version.
12
+
13
+ Prior to CMake 3.27, the SDK version was always selected by the value of
14
+ the :variable:`CMAKE_SYSTEM_VERSION` variable. Users or toolchain files
15
+ could set that variable to one of the exact Windows SDK versions available
16
+ on the host system. Since :variable:`CMAKE_SYSTEM_VERSION` defaults to
17
+ :variable:`CMAKE_HOST_SYSTEM_VERSION`, and it is not guaranteed that a
18
+ matching Windows SDK version is available, CMake had to fall back to
19
+ using the latest Windows SDK version if no exact match was available.
20
+ This approach was problematic:
21
+
22
+ * The latest Windows SDK might or might not be selected based on whether
23
+ the host version of Windows happens to match an available SDK version.
24
+
25
+ * An old Windows SDK version might be selected that has not been updated
26
+ for newer language standards such as C11.
27
+
28
+ CMake 3.27 and higher prefer to ignore the exact value of
29
+ :variable:`CMAKE_SYSTEM_VERSION` and by default select the latest SDK
30
+ version available. An exact SDK version may be specified explicitly
31
+ using a ``version=`` field in the :variable:`CMAKE_GENERATOR_PLATFORM`
32
+ variable. See :ref:`Visual Studio Platform Selection`.
33
+
34
+ This policy provides compatibility for projects, toolchain files, and
35
+ build scripts that have not been ported away from using
36
+ :variable:`CMAKE_SYSTEM_VERSION` to specify an exact SDK version.
37
+
38
+ .. note::
39
+
40
+ This policy must be set before the first :command:`project` or
41
+ :command:`enable_language` command invocation at the top of the
42
+ project. That is when :ref:`Visual Studio Generators` select a
43
+ Windows SDK.
44
+
45
+ The ``OLD`` behavior for this policy is to use the exact value of
46
+ :variable:`CMAKE_SYSTEM_VERSION` if possible. The ``NEW`` behavior
47
+ for this policy is to ignore it.
48
+
49
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27
50
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
51
+ .. include:: STANDARD_ADVICE.txt
52
+
53
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0150.rst.txt ADDED
@@ -0,0 +1,39 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0150
2
+ -------
3
+
4
+ .. versionadded:: 3.27
5
+
6
+ :command:`ExternalProject_Add` and :command:`FetchContent_Declare` commands
7
+ treat relative ``GIT_REPOSITORY`` paths as being relative to the parent
8
+ project's remote.
9
+
10
+ Earlier versions of these commands always treated relative paths in
11
+ ``GIT_REPOSITORY`` as local paths, but the base directory it was treated
12
+ as relative to was both undocumented and unintuitive. The ``OLD`` behavior
13
+ for this policy is to interpret relative paths used for ``GIT_REPOSITORY``
14
+ as local paths relative to the following:
15
+
16
+ * The parent directory of ``SOURCE_DIR`` for :command:`ExternalProject_Add`.
17
+ * ``FETCHCONTENT_BASE_DIR`` for :command:`FetchContent_Declare`.
18
+
19
+ The ``NEW`` behavior is to determine the remote from the parent project and
20
+ interpret the path relative to that remote. The value of
21
+ :variable:`CMAKE_CURRENT_SOURCE_DIR` when :command:`ExternalProject_Add` or
22
+ :command:`FetchContent_Declare` is called determines the parent project.
23
+ The remote is selected according to the following (the first match is used):
24
+
25
+ * If the parent project is checked out on a branch with an upstream remote
26
+ defined, use that remote.
27
+ * If only one remote is defined, use that remote.
28
+ * If multiple remotes are defined and one of them is named ``origin``, use
29
+ ``origin``'s remote but also issue a warning.
30
+
31
+ If an appropriate remote cannot be determined from the above, a fatal error
32
+ will be raised.
33
+
34
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27
35
+ .. |WARNS_OR_DOES_NOT_WARN| replace::
36
+ warns when a relative path is encountered
37
+ .. include:: STANDARD_ADVICE.txt
38
+
39
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0151.rst.txt ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0151
2
+ -------
3
+
4
+ .. versionadded:: 3.27
5
+
6
+ AUTOMOC include directory is a system include directory by default.
7
+
8
+ Headers generated for :ref:`Qt AUTOMOC` are placed in target-specific include
9
+ directories. CMake 3.26 and older added these as normal include directories.
10
+ CMake 3.27 and newer prefer to add them as system include directories.
11
+ This policy provides compatibility for projects that have not been updated
12
+ to expect this.
13
+
14
+ If the :prop_tgt:`AUTOGEN_USE_SYSTEM_INCLUDE` target property is set,
15
+ perhaps via the :variable:`CMAKE_AUTOGEN_USE_SYSTEM_INCLUDE` variable,
16
+ then its value is used regardless of the setting of this policy.
17
+
18
+ The ``OLD`` behavior for this policy is to add autogen include directory to
19
+ the target's include directories.
20
+ The ``NEW`` behavior for this policy is to add autogen include directory to
21
+ the target's system include directories.
22
+
23
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27
24
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
25
+ .. include:: STANDARD_ADVICE.txt
26
+
27
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0152.rst.txt ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0152
2
+ -------
3
+
4
+ .. versionadded:: 3.28
5
+
6
+ :command:`file(REAL_PATH)` resolves symlinks before collapsing ../ components.
7
+
8
+ In CMake 3.27 and below, :command:`file(REAL_PATH)` collapsed any ``../``
9
+ components in a path before resolving symlinks. This produced incorrect
10
+ results when the ``../`` collapsed away a symlink.
11
+
12
+ The ``OLD`` behavior for this policy is to collapse ``../`` components before
13
+ resolving symlinks.
14
+ The ``NEW`` behavior for this policy is to resolve all symlinks before
15
+ collapsing ``../`` components.
16
+
17
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.28
18
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
19
+ .. include:: STANDARD_ADVICE.txt
20
+
21
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0153.rst.txt ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0153
2
+ -------
3
+
4
+ .. versionadded:: 3.28
5
+
6
+ The :command:`exec_program` command should not be called.
7
+
8
+ This command has long been superseded by the :command:`execute_process`
9
+ command and has been deprecated since CMake 3.0.
10
+
11
+ .. |disallowed_version| replace:: 3.28
12
+ .. include:: DISALLOWED_COMMAND.txt
13
+
14
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0154.rst.txt ADDED
@@ -0,0 +1,58 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0154
2
+ -------
3
+
4
+ .. versionadded:: 3.28
5
+
6
+ Generated files are private by default in targets using :ref:`file sets`.
7
+
8
+ CMake 3.27 and below assume that any file generated as an output or byproduct
9
+ of :command:`add_custom_command` or :command:`add_custom_target` may be a
10
+ public header file meant for inclusion by dependents' source files. This
11
+ requires :ref:`Ninja Generators` to add conservative order-only dependencies
12
+ that prevent a target's source files from compiling before custom commands
13
+ from the target's dependencies are finished, even if those custom commands
14
+ only produce sources private to their own target.
15
+
16
+ :ref:`File Sets`, introduced by CMake 3.23, provide a way to express the
17
+ visibility of generated header files. CMake 3.28 and above prefer to
18
+ assume that, in targets using file sets, generated files are private to
19
+ their own target by default. Generated public headers must be specified
20
+ as members of a ``PUBLIC`` (or ``INTERFACE``) ``FILE_SET``, typically of
21
+ type ``HEADERS``. With this information, :ref:`Ninja Generators` may omit
22
+ the above-mentioned conservative dependencies and produce more efficient
23
+ build graphs.
24
+
25
+ Additionally, if the custom command's output is a member of a file set of type
26
+ ``CXX_MODULES``, it will additionally not be required to exist before
27
+ compiling other sources in the same target. Since these files should not be
28
+ included at compile time directly, they may not be implicitly required to
29
+ exist for other compilation rules.
30
+
31
+ This policy provides compatibility for projects using file sets in targets
32
+ with generated header files that have not been updated. Such projects
33
+ should be updated to express generated public headers in a file set.
34
+ For example:
35
+
36
+ .. code-block:: cmake
37
+
38
+ add_custom_command(
39
+ OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/foo.h
40
+ ...
41
+ )
42
+ target_sources(foo
43
+ PUBLIC FILE_SET HEADERS
44
+ BASE_DIRS ${CMAKE_CURRENT_BINARY_DIR}
45
+ FILES ${CMAKE_CURRENT_BINARY_DIR}/foo.h
46
+ )
47
+
48
+ The ``OLD`` behavior for this policy is to assume generated files are
49
+ public, even in targets using file sets, and for :ref:`Ninja Generators`
50
+ to produce conservative build graphs. The ``NEW`` behavior for this
51
+ policy is to assume generated files are private in targets using file sets,
52
+ and for :ref:`Ninja Generators` to produce more efficient build graphs.
53
+
54
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.28
55
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
56
+ .. include:: STANDARD_ADVICE.txt
57
+
58
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0155.rst.txt ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0155
2
+ -------
3
+
4
+ .. versionadded:: 3.28
5
+
6
+ C++ sources in targets with at least C++20 are scanned for imports
7
+ when supported.
8
+
9
+ CMake 3.27 and below assume that C++ sources do not ``import`` modules.
10
+ CMake 3.28 and above prefer to assume that C++ sources in targets using C++20
11
+ or higher might ``import`` modules, and must be scanned before compiling,
12
+ unless explicitly disabled. This policy provides compatibility for projects
13
+ that use C++20 or higher, without modules, that have not been updated to turn
14
+ off scanning, e.g., via the :variable:`CMAKE_CXX_SCAN_FOR_MODULES` variable.
15
+ See the :manual:`cmake-cxxmodules(7)` manual for more details on C++ module
16
+ support.
17
+
18
+ The ``OLD`` behavior for this policy is to assume that C++ 20 and newer
19
+ sources do not import modules. The ``NEW`` behavior for this policy is to
20
+ assume that C++ 20 and newer files may import modules if the compiler
21
+ understands how to scan for their dependencies, and need to be scanned.
22
+
23
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.28
24
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
25
+ .. include:: STANDARD_ADVICE.txt
26
+
27
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0156.rst.txt ADDED
@@ -0,0 +1,51 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0156
2
+ -------
3
+
4
+ .. versionadded:: 3.29
5
+
6
+ De-duplicate libraries on link lines based on linker capabilities.
7
+
8
+ Traditional linkers maintain a set of undefined symbols during linking. The
9
+ linker processes each file in the order in which it appears on the command
10
+ line, until the set of undefined symbols becomes empty. An object file is
11
+ linked into the output object when it is encountered, with its undefined
12
+ symbols added to the set. Upon encountering an archive file a traditional
13
+ linker searches the objects contained therein, and processes those that satisfy
14
+ symbols in the unresolved set.
15
+
16
+ Handling mutually dependent archives may be awkward when using a traditional
17
+ linker. Archive files may have to be specified multiple times.
18
+
19
+ Some linkers (for instance Apple or Windows linkers, as well as ``LLVM LLD``)
20
+ record all symbols found in objects and archives as they iterate over command
21
+ line arguments. When one of these linkers encounters an undefined symbol that
22
+ can be resolved by an object file contained in a previously processed archive
23
+ file, it immediately extracts and links it into the output object.
24
+
25
+ CMake 3.28 and below may generate link lines that repeat static libraries as
26
+ a traditional linker would need, even when using a linker that does not need it.
27
+ They may also de-duplicate shared libraries by keeping their last occurrence,
28
+ which on Windows platforms can change DLL load order.
29
+
30
+ CMake 3.29 and above prefer to apply different strategies based on linker
31
+ capabilities. So, when targeting Apple and Windows platforms, all
32
+ libraries are de-duplicated. Moreover, on Windows platforms, libraries
33
+ are de-duplicated by keeping their first occurrence, thus respecting the
34
+ project-specified order. This policy provides compatibility with projects
35
+ that have not been updated to expect the latter behavior.
36
+
37
+ .. note::
38
+
39
+ When this policy is set to ``NEW``, the policy :policy:`CMP0179` controls
40
+ which occurrence of the static libraries is kept when they are de-duplicated.
41
+
42
+ The ``OLD`` behavior for this policy is to always repeat static libraries
43
+ as if using a traditional linker, and always de-duplicate shared libraries
44
+ by keeping the last occurrence of each. The ``NEW`` behavior for this policy
45
+ is to apply different strategies based on linker capabilities.
46
+
47
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29
48
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
49
+ .. include:: STANDARD_ADVICE.txt
50
+
51
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0157.rst.txt ADDED
@@ -0,0 +1,47 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0157
2
+ -------
3
+
4
+ .. versionadded:: 3.29
5
+
6
+ Swift compilation mode is selected by an abstraction.
7
+
8
+ The Swift compiler can compile modules in different modes. The desired build
9
+ mode depends whether the developer is iterating and wants to incrementally make
10
+ changes, or if they are building a release for distribution and want more
11
+ optimizations applied to the resulting binary.
12
+
13
+ CMake versions 3.26 through 3.28 build Swift binaries with whole-module
14
+ optimizations enabled when configured in a non-debug build type.
15
+ For CMake versions earlier than 3.26, the developer needs to specify
16
+ the necessary flag manually for the :ref:`Ninja Generators`, and cannot
17
+ not specify whole-module optimizations to the :generator:`Xcode` generator.
18
+
19
+ CMake versions 3.29 and above prefer to set the compilation mode using
20
+ the :prop_tgt:`Swift_COMPILATION_MODE` target property, which can be
21
+ initialized by the :variable:`CMAKE_Swift_COMPILATION_MODE` variable.
22
+
23
+ This policy provides compatibility for projects that have not been updated.
24
+ The policy setting takes effect as of the first :command:`project` or
25
+ :command:`enable_language` command that enables the ``Swift`` language.
26
+
27
+ .. note::
28
+
29
+ Once the policy has taken effect at the top of a project, that choice
30
+ must be used throughout the tree. In projects that have nested projects
31
+ in subdirectories, be sure to convert everything together.
32
+
33
+ The ``OLD`` behavior for this policy builds all Swift targets in
34
+ ``wholemodule`` mode for non-debug configurations. :ref:`Ninja Generators`
35
+ prepend the ``-wmo`` flag to the default set of Swift flags.
36
+ The :generator:`Xcode` generator sets the ``SWIFT_COMPILATION_MODE``
37
+ attribute to ``wholemodule`` in the generated Xcode project file.
38
+
39
+ The ``NEW`` behavior for this policy is to apply the compilation mode specified
40
+ in the :prop_tgt:`Swift_COMPILATION_MODE` target property, initialized as each
41
+ target is created by the :variable:`CMAKE_Swift_COMPILATION_MODE` variable.
42
+
43
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29
44
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
45
+ .. include:: STANDARD_ADVICE.txt
46
+
47
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0158.rst.txt ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0158
2
+ -------
3
+
4
+ .. versionadded:: 3.29
5
+
6
+ :command:`add_test` honors :variable:`CMAKE_CROSSCOMPILING_EMULATOR` only
7
+ when :variable:`cross-compiling <CMAKE_CROSSCOMPILING>`.
8
+
9
+ In CMake 3.28 and below, :command:`add_test` unconditionally used the
10
+ :prop_tgt:`CROSSCOMPILING_EMULATOR` target property (initialized by the
11
+ :variable:`CMAKE_CROSSCOMPILING_EMULATOR` variable) to run test commands
12
+ naming executable targets. CMake 3.29 and above prefer to use the emulator
13
+ only when the :variable:`CMAKE_CROSSCOMPILING` variable is enabled. The
14
+ :variable:`CMAKE_TEST_LAUNCHER` variable may be used instead when not
15
+ cross-compiling. This policy provides compatibility for projects that
16
+ have not been updated.
17
+
18
+ The ``OLD`` behavior for this policy is for :command:`add_test` to use
19
+ the :prop_tgt:`CROSSCOMPILING_EMULATOR` target property unconditionally.
20
+ The ``NEW`` behavior for this policy is for :command:`add_test` to use
21
+ the :prop_tgt:`CROSSCOMPILING_EMULATOR` target property only when
22
+ :variable:`cross-compiling <CMAKE_CROSSCOMPILING>`.
23
+
24
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29
25
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
26
+ .. include:: STANDARD_ADVICE.txt
27
+
28
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0159.rst.txt ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0159
2
+ -------
3
+
4
+ .. versionadded:: 3.29
5
+
6
+ :command:`file(STRINGS)` with ``REGEX`` updates :variable:`CMAKE_MATCH_<n>`.
7
+
8
+ In CMake 3.28 and below the :command:`file(STRINGS)` command's ``REGEX``
9
+ option does not affect :variable:`CMAKE_MATCH_<n>` variables. CMake 3.29
10
+ and above prefer to update the :variable:`CMAKE_MATCH_<n>` variables using
11
+ captures from the last match in the file, similar to the
12
+ :command:`string(REGEX MATCHALL)` command. This policy provides
13
+ compatibility for projects that have not been updated to expect the behavior.
14
+
15
+ The ``OLD`` behavior for this policy is for :command:`file(STRINGS)` with
16
+ ``REGEX`` to not store capture groups in :variable:`CMAKE_MATCH_<n>`
17
+ variables. The ``NEW`` behavior is to store the capture groups.
18
+
19
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29
20
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
21
+ .. include:: STANDARD_ADVICE.txt
22
+
23
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0160.rst.txt ADDED
@@ -0,0 +1,39 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0160
2
+ -------
3
+
4
+ .. versionadded:: 3.29
5
+
6
+ More read-only target properties now error when trying to set them.
7
+
8
+ The :command:`set_target_properties` and :command:`set_property` commands
9
+ are intended to error out on all read-only properties. However, CMake 3.28 and
10
+ below only did this for the following properties:
11
+
12
+ * :prop_tgt:`HEADER_SETS`
13
+ * :prop_tgt:`INTERFACE_HEADER_SETS`
14
+ * :prop_tgt:`IMPORTED_GLOBAL`
15
+ * :prop_tgt:`MANUALLY_ADDED_DEPENDENCIES`
16
+ * :prop_tgt:`NAME`
17
+ * :prop_tgt:`TYPE`
18
+
19
+ This policy enforces the read-only nature of the following target properties:
20
+
21
+ * :prop_tgt:`ALIAS_GLOBAL`
22
+ * :prop_tgt:`BINARY_DIR`
23
+ * :prop_tgt:`CXX_MODULE_SETS`
24
+ * :prop_tgt:`IMPORTED`
25
+ * :prop_tgt:`INTERFACE_CXX_MODULE_SETS`
26
+ * :prop_tgt:`LOCATION`
27
+ * :prop_tgt:`LOCATION_<CONFIG>`
28
+ * :prop_tgt:`SOURCE_DIR`
29
+
30
+ The ``OLD`` behavior for this policy is to only error out for the properties
31
+ :prop_tgt:`MANUALLY_ADDED_DEPENDENCIES`, :prop_tgt:`NAME`, and :prop_tgt:`TYPE`.
32
+ The ``NEW`` behavior for this policy is to error out on all target properties
33
+ that are documented as read-only.
34
+
35
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29
36
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
37
+ .. include:: STANDARD_ADVICE.txt
38
+
39
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0161.rst.txt ADDED
@@ -0,0 +1,36 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0161
2
+ -------
3
+
4
+ .. versionadded:: 3.29
5
+
6
+ The :variable:`CPACK_PRODUCTBUILD_DOMAINS` variable defaults to true.
7
+
8
+ Before CMake 3.29, the :variable:`CPACK_PRODUCTBUILD_DOMAINS` variable is
9
+ unset by default. When using the :cpack_gen:`CPack productbuild Generator`,
10
+ this disables the use of the ``domains`` attribute in the productbuild
11
+ Distribution XML, and falls back to the ``auth`` attribute instead.
12
+ These attributes control where a productbuild package is allowed to be
13
+ installed. But the ``auth`` attribute has been deprecated by Apple,
14
+ so projects should migrate to using ``domains`` instead.
15
+
16
+ CMake 3.29 and above prefer to use a default value of true for
17
+ :variable:`CPACK_PRODUCTBUILD_DOMAINS`, which means ``domains`` will be used
18
+ by default unless the project explicitly sets
19
+ :variable:`CPACK_PRODUCTBUILD_DOMAINS` to false.
20
+ This policy provides compatibility with projects that enabled the
21
+ :cpack_gen:`CPack productbuild Generator`, but did not explicitly set
22
+ :variable:`CPACK_PRODUCTBUILD_DOMAINS`.
23
+
24
+ The ``OLD`` behavior for this policy is to leave
25
+ :variable:`CPACK_PRODUCTBUILD_DOMAINS` unset if it hasn't been set.
26
+ The ``NEW`` behavior for this policy is to use a default value of true for
27
+ :variable:`CPACK_PRODUCTBUILD_DOMAINS`.
28
+
29
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29
30
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
31
+ .. include:: STANDARD_ADVICE.txt
32
+ Note that a warning will only be emitted if the
33
+ :variable:`CPACK_BINARY_PRODUCTBUILD <CPACK_BINARY_<GENNAME>>` variable is
34
+ set to true and the project is being built for an Apple platform.
35
+
36
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0162.rst.txt ADDED
@@ -0,0 +1,47 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0162
2
+ -------
3
+
4
+ .. versionadded:: 3.30
5
+
6
+ :ref:`Visual Studio Generators` add ``UseDebugLibraries`` indicators by default.
7
+
8
+ The "Use Debug Libraries" setting in Visual Studio projects indicates what
9
+ configurations are considered debug configurations. In standalone projects,
10
+ this may affect MSBuild's default selection of MSVC runtime library,
11
+ optimization flags, runtime checks, and similar settings. CMake typically
12
+ generates all those settings explicitly based on the project's specification,
13
+ so CMake 3.29 and below do not write any ``UseDebugLibraries`` indicators to
14
+ ``.vcxproj`` files.
15
+
16
+ CMake 3.30 and above prefer to write ``UseDebugLibraries`` indicators because
17
+ they are useful for reference by both humans and tools, and may also affect
18
+ the behavior of platform-specific SDKs. The indicator for each configuration
19
+ of a target is determined as follows:
20
+
21
+ * If the target compiles sources for a known MSVC runtime library
22
+ (such as that specified by :prop_tgt:`MSVC_RUNTIME_LIBRARY`),
23
+ then ``UseDebugLibraries`` is ``true`` for configurations that
24
+ compile for a "Debug" runtime library, and ``false`` for others.
25
+
26
+ * Otherwise, such as in targets created by :command:`add_custom_target`,
27
+ ``UseDebugLibraries`` is ``true`` for the ``Debug`` configuration,
28
+ and ``false`` for others.
29
+
30
+ This policy provides compatibility for projects that have not been updated to
31
+ expect the indicators. The policy setting is recorded by each target as it is
32
+ created and used to determine the default behavior for that target's
33
+ ``.vcxproj`` file.
34
+
35
+ The ``OLD`` behavior for this policy is to not generate ``UseDebugLibraries``
36
+ indicators by default. The ``NEW`` behavior for this policy is to generate
37
+ ``UseDebugLibraries`` indicators by default.
38
+
39
+ If the :variable:`CMAKE_VS_USE_DEBUG_LIBRARIES` variable and/or
40
+ :prop_tgt:`VS_USE_DEBUG_LIBRARIES` target property is set, it explicitly
41
+ controls ``UseDebugLibraries`` generation regardless of this policy.
42
+
43
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30
44
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
45
+ .. include:: STANDARD_ADVICE.txt
46
+
47
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0163.rst.txt ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0163
2
+ -------
3
+
4
+ .. versionadded:: 3.30
5
+
6
+ The :prop_sf:`GENERATED` source file property is now visible in all directories.
7
+
8
+ In CMake 3.29 and below, the :prop_sf:`GENERATED` source file property,
9
+ like other source file properties, was scoped in every directory separately.
10
+ Although policy :policy:`CMP0118` allowed sources marked ``GENERATED`` in one
11
+ directory to be used in other directories without manually marking them as
12
+ ``GENERATED`` again, the ``GENERATED`` property was still not visible to
13
+ :command:`get_property` and :command:`get_source_file_property` calls.
14
+
15
+ Whether or not a source file is generated is an all-or-nothing global
16
+ property of the source: a source is either generated or it is not.
17
+ CMake 3.30 and above prefer to treat the :prop_sf:`GENERATED` source file
18
+ property as globally scoped. Once it is set in one directory, it is
19
+ immediately visible to :command:`get_property` and
20
+ :command:`get_source_file_property` calls in other directories.
21
+ This policy provides compatibility for projects that have not been
22
+ updated for this behavior.
23
+
24
+ The ``OLD`` behavior of this policy is for the ``GENERATED`` source file
25
+ property to be visible only in the directories in which it is set. The
26
+ ``NEW`` behavior of this policy is to allow the ``GENERATED`` source file
27
+ property to be visible in all directories once set in any directory.
28
+ Furthermore, the ``NEW`` behavior of this policy implies the ``NEW``
29
+ behavior of policy :policy:`CMP0118`: the ``GENERATED`` property may
30
+ be set only to boolean values, and may not be turned off once turned on.
31
+
32
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30
33
+ .. |WARNS_OR_DOES_NOT_WARN| replace::
34
+ does *not* warn
35
+ .. include:: STANDARD_ADVICE.txt
36
+
37
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0164.rst.txt ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0164
2
+ -------
3
+
4
+ .. versionadded:: 3.30
5
+
6
+ :command:`add_library` rejects ``SHARED`` libraries when not supported by
7
+ the platform.
8
+
9
+ In CMake 3.29 and below, on platforms that do not support shared libraries
10
+ (:prop_gbl:`TARGET_SUPPORTS_SHARED_LIBS` is false), the
11
+ :command:`add_library` command automatically converts ``SHARED`` libraries to
12
+ ``STATIC`` libraries to help users build projects on such platforms. However,
13
+ the semantics of shared and static libraries are different enough that such
14
+ automatic conversion cannot work in general. Projects using shared libraries
15
+ need to be ported to such platforms on a case-by-case basis.
16
+
17
+ In CMake 3.30 and above, :command:`add_library` prefers to reject creation
18
+ of shared libraries on platforms that do not support them, and fail with a
19
+ fatal error message. This policy provides compatibility for projects that
20
+ happened to work with the automatic conversion to static libraries and have
21
+ not been updated with an explicit port.
22
+
23
+ The ``OLD`` behavior for this policy is to implicitly create a static
24
+ library with a developer warning. The ``NEW`` behavior for this policy is
25
+ to fail.
26
+
27
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30
28
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn about the behavior change
29
+ .. include:: STANDARD_ADVICE.txt
30
+
31
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0165.rst.txt ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0165
2
+ -------
3
+
4
+ .. versionadded:: 3.30
5
+
6
+ :command:`enable_language` must not be called before :command:`project`.
7
+
8
+ In CMake 3.29 and below, if a project called :command:`enable_language`
9
+ before the first call to :command:`project`, the language would be enabled
10
+ but possibly using unset details that were expected to be set.
11
+ In CMake 3.30 and above, :command:`enable_language` prefers to reject this
12
+ case and stop with a fatal error instead if it detects that :command:`project`
13
+ has not yet been called. This policy provides compatibility for projects that
14
+ happened to work when :command:`enable_language` was called before
15
+ :command:`project` and have not been updated to call these commands in the
16
+ required order.
17
+
18
+ The ``OLD`` behavior for this policy is to allow :command:`enable_language`
19
+ to be called before :command:`project`. The ``NEW`` behavior for this policy
20
+ is to fail with a fatal error in such cases.
21
+
22
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30
23
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
24
+ .. include:: STANDARD_ADVICE.txt
25
+
26
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0166.rst.txt ADDED
@@ -0,0 +1,40 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0166
2
+ -------
3
+
4
+ .. versionadded:: 3.30
5
+
6
+ :genex:`TARGET_PROPERTY` evaluates link properties transitively over private
7
+ dependencies of static libraries.
8
+
9
+ In CMake 3.29 and below, the :genex:`TARGET_PROPERTY` generator expression
10
+ evaluates properties :prop_tgt:`INTERFACE_LINK_OPTIONS`,
11
+ :prop_tgt:`INTERFACE_LINK_DIRECTORIES`, and :prop_tgt:`INTERFACE_LINK_DEPENDS`
12
+ as if they were :ref:`Transitive Compile Properties` rather than
13
+ :ref:`Transitive Link Properties`, even when policy :policy:`CMP0099` is
14
+ set to ``NEW``. Private dependencies of static libraries, which appear in
15
+ their :prop_tgt:`INTERFACE_LINK_LIBRARIES` guarded by :genex:`LINK_ONLY`
16
+ generator expressions, are not followed. This is inconsistent with
17
+ evaluation of the same target properties during buildsystem generation.
18
+
19
+ CMake 3.30 and above prefer that :genex:`TARGET_PROPERTY` evaluates
20
+ properties :prop_tgt:`INTERFACE_LINK_OPTIONS`,
21
+ :prop_tgt:`INTERFACE_LINK_DIRECTORIES`, and :prop_tgt:`INTERFACE_LINK_DEPENDS`
22
+ as :ref:`Transitive Link Properties` such that private dependencies of static
23
+ libraries, which appear in their :prop_tgt:`INTERFACE_LINK_LIBRARIES` guarded
24
+ by :genex:`LINK_ONLY` generator expressions, are followed.
25
+ This policy provides compatibility for projects that have not been updated
26
+ to expect the new behavior.
27
+
28
+ The ``OLD`` behavior for this policy is for :genex:`TARGET_PROPERTY` to
29
+ evaluate properties :prop_tgt:`INTERFACE_LINK_OPTIONS`,
30
+ :prop_tgt:`INTERFACE_LINK_DIRECTORIES`, and :prop_tgt:`INTERFACE_LINK_DEPENDS`
31
+ as if they were :ref:`Transitive Compile Properties` by not following private
32
+ dependencies of static libraries. The ``NEW`` behavior for this policy is
33
+ to evaluate them as :ref:`Transitive Link Properties` by following private
34
+ dependencies of static libraries.
35
+
36
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30
37
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
38
+ .. include:: STANDARD_ADVICE.txt
39
+
40
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0167.rst.txt ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0167
2
+ -------
3
+
4
+ .. versionadded:: 3.30
5
+
6
+ The :module:`FindBoost` module is removed.
7
+
8
+ CMake 3.29 and below provide a ``FindBoost`` module, but it needs constant
9
+ updates to keep up with upstream Boost releases. Upstream Boost 1.70
10
+ and above provide a ``BoostConfig.cmake`` package configuration file.
11
+ ``find_package(Boost CONFIG)`` finds the upstream package directly,
12
+ without the find module.
13
+
14
+ CMake 3.30 and above prefer to not provide the ``FindBoost`` module
15
+ so that ``find_package(Boost)`` calls, without the ``CONFIG`` or
16
+ ``NO_MODULE`` options, find the upstream ``BoostConfig.cmake`` directly.
17
+ This policy provides compatibility for projects that have not been ported
18
+ to use the upstream Boost package.
19
+
20
+ The ``OLD`` behavior of this policy is for ``find_package(Boost)`` to
21
+ load CMake's :module:`FindBoost` module. The ``NEW`` behavior is for
22
+ ``find_package(Boost)`` to search for the upstream ``BoostConfig.cmake``.
23
+
24
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30
25
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
26
+ .. include:: STANDARD_ADVICE.txt
27
+
28
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0168.rst.txt ADDED
@@ -0,0 +1,72 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0168
2
+ -------
3
+
4
+ .. versionadded:: 3.30
5
+
6
+ The :module:`FetchContent` module implements steps directly instead of through
7
+ a sub-build.
8
+
9
+ CMake 3.29 and below implement FetchContent as a separate sub-build.
10
+ This required configuring that separate project and using a build tool.
11
+ This approach can be very slow with some generators and operating systems.
12
+ CMake 3.30 and above prefer to implement the download, update, and patch
13
+ steps directly as part of the main project.
14
+
15
+ The ``NEW`` behavior has the following characteristics:
16
+
17
+ * No sub-build is used. All operations are implemented directly from the
18
+ main project's CMake configure step. When running in CMake script mode,
19
+ no build tool needs to be available.
20
+ * Generator expressions and GNU Make variables of the form ``$(SOMEVAR)`` are
21
+ not supported. They should not be used in any argument to
22
+ :command:`FetchContent_Declare` or :command:`FetchContent_Populate`.
23
+ * All ``LOG_...`` and ``USES_TERMINAL_...`` options, the ``QUIET`` option, and
24
+ the :variable:`FETCHCONTENT_QUIET` variable are ignored.
25
+ :module:`FetchContent` output is always part of the main project's configure
26
+ output. This also means it now respects the message logging level (see
27
+ :variable:`CMAKE_MESSAGE_LOG_LEVEL` and
28
+ :option:`--log-level <cmake --log-level>`). The default message log level
29
+ should be comparable to using ``QUIET`` with the ``OLD`` policy setting,
30
+ except that warnings will now be shown.
31
+ * The ``PREFIX``, ``TMP_DIR``, ``STAMP_DIR``, ``LOG_DIR``, and ``DOWNLOAD_DIR``
32
+ options and their associated directory properties are ignored. The
33
+ :module:`FetchContent` module controls those locations internally.
34
+ * :option:`cmake --fresh` will remove the stamp and script files used for
35
+ tracking and populating the dependency. This will force the dependency's
36
+ download, update, and patch steps to be re-executed. The directory used for
37
+ downloads is not affected by :option:`cmake --fresh`, so any previously
38
+ downloaded files for the ``URL`` download method can still be re-used.
39
+
40
+ The ``OLD`` behavior has the following characteristics:
41
+
42
+ * A sub-build is always used to implement the download, update, and patch
43
+ steps. A build tool must be available, even when using
44
+ :command:`FetchContent_Populate` in CMake script mode.
45
+ * Generator expressions and GNU Make variables of the form ``$(SOMEVAR)`` can
46
+ be used, although such use is almost always inappropriate. They are evaluated
47
+ in the sub-build, so they do not see any information from the main build.
48
+ * All logging, terminal control, and directory options related to the download,
49
+ update, or patch steps are supported.
50
+ * If the ``QUIET`` option is used, or the :variable:`FETCHCONTENT_QUIET`
51
+ variable is set to true, warnings will not be shown in the output.
52
+ * :option:`cmake --fresh` has no effect on the dependency's stamp or script
53
+ files. Previously executed steps will only re-run if details about the
54
+ dependency have changed.
55
+
56
+ There's a reasonably good chance that users can set the
57
+ :variable:`CMAKE_POLICY_DEFAULT_CMP0168 <CMAKE_POLICY_DEFAULT_CMP<NNNN>>`
58
+ variable to ``NEW`` to globally switch to the ``NEW`` behavior while waiting
59
+ for the project and its dependencies to be updated use the ``NEW`` policy
60
+ setting by default. Projects don't typically make use of the features that the
61
+ ``NEW`` behavior no longer supports, and even those projects that do will often
62
+ still work fine when those options are ignored. Before setting this behavior
63
+ globally, check whether any :command:`FetchContent_Declare` or
64
+ :command:`FetchContent_Populate` calls use the ignored options in a way that
65
+ would change observable behavior, other than putting temporary or
66
+ internally-generated files in different locations.
67
+
68
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30
69
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
70
+ .. include:: STANDARD_ADVICE.txt
71
+
72
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0169.rst.txt ADDED
@@ -0,0 +1,49 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0169
2
+ -------
3
+
4
+ .. versionadded:: 3.30
5
+
6
+ Calling :command:`FetchContent_Populate` with a single argument (the name of
7
+ a declared dependency) is deprecated.
8
+
9
+ Prior to the introduction of :command:`FetchContent_MakeAvailable`, projects
10
+ populated previously declared content (with :command:`FetchContent_Declare`)
11
+ using the following pattern:
12
+
13
+ .. code-block:: cmake
14
+
15
+ FetchContent_GetProperties(depname)
16
+ if(NOT depname_POPULATED)
17
+ FetchContent_Populate(depname)
18
+ add_subdirectory(${depname_SOURCE_DIR} ${depname_BINARY_DIR})
19
+ endif()
20
+
21
+ The above pattern does not support a number of features that have been added
22
+ to :module:`FetchContent` over time. It ignores options like ``SYSTEM`` and
23
+ ``EXCLUDE_FROM_ALL`` which may be given to :command:`FetchContent_Declare`,
24
+ but can't be made known to the above project code. It also does not support
25
+ :ref:`dependency providers <dependency_providers_overview>`.
26
+ Projects should call :command:`FetchContent_MakeAvailable` instead of using
27
+ the above pattern.
28
+
29
+ CMake 3.30 and above prefers to reject calls to
30
+ :command:`FetchContent_Populate` with the name of a declared dependency.
31
+ This policy provides compatibility for projects that have not been updated
32
+ to call :command:`FetchContent_MakeAvailable` instead.
33
+
34
+ The ``OLD`` behavior of this policy allows :command:`FetchContent_Populate`
35
+ to be called with the name of a declared dependency.
36
+ The ``NEW`` behavior halts with a fatal error in such cases.
37
+
38
+ .. note::
39
+ Calling :command:`FetchContent_Populate` with the full population details
40
+ as command arguments rather than just a dependency name remains fully
41
+ supported. Only the form calling :command:`FetchContent_Populate` with a
42
+ single argument (the name of a previously declared dependency) is deprecated
43
+ with this policy.
44
+
45
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30
46
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
47
+ .. include:: STANDARD_ADVICE.txt
48
+
49
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0170.rst.txt ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0170
2
+ -------
3
+
4
+ .. versionadded:: 3.30
5
+
6
+ When ``FETCHCONTENT_FULLY_DISCONNECTED`` is set to true,
7
+ :command:`FetchContent_MakeAvailable` and :command:`FetchContent_Populate`
8
+ enforce the constraint that their source directory must already be populated.
9
+ The requirement has always been documented, but it was not checked or enforced
10
+ with CMake 3.29 or older. This sometimes led to hard-to-trace errors when a
11
+ project expected a dependency to have been populated, but its population was
12
+ silently skipped.
13
+
14
+ CMake 3.30 and above prefers to check and enforce the constraint.
15
+ This policy provides compatibility for situations where the user cannot easily
16
+ prevent ``FETCHCONTENT_FULLY_DISCONNECTED`` from being inappropriately set
17
+ to true.
18
+
19
+ The ``OLD`` behavior of this policy allows ``FETCHCONTENT_FULLY_DISCONNECTED``
20
+ to be set to true even if a dependency's source directory has not been
21
+ populated.
22
+ The ``NEW`` behavior halts with a fatal error if
23
+ ``FETCHCONTENT_FULLY_DISCONNECTED`` is set to true and a dependency population
24
+ would be skipped, but that dependency's source directory doesn't exist.
25
+
26
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30
27
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
28
+ .. include:: STANDARD_ADVICE.txt
29
+
30
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0171.rst.txt ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0171
2
+ -------
3
+
4
+ .. versionadded:: 3.31
5
+
6
+ ``codegen`` is a reserved target name.
7
+
8
+ CMake 3.30 and earlier did not reserve ``codegen`` as a builtin target name,
9
+ leaving projects free to create their own target with that name.
10
+ CMake 3.31 and later prefer to reserve ``codegen`` as a builtin target name
11
+ to drive custom commands created with the ``CODEGEN`` option to
12
+ :command:`add_custom_command`. In order to support building the ``codegen``
13
+ target in scripted environments, e.g., ``cmake --build . --target codegen``,
14
+ the ``codegen`` target needs to be generated even if no custom commands
15
+ use the ``CODEGEN`` option. This policy provides compatibility for projects
16
+ that have not been updated to avoid creating a target named ``codegen``.
17
+
18
+ The ``OLD`` behavior of this policy allows projects to create a target
19
+ with the name ``codegen``. The ``NEW`` behavior halts with a fatal error
20
+ if a target with the name ``codegen`` is created.
21
+
22
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31
23
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
24
+ .. include:: STANDARD_ADVICE.txt
25
+
26
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0172.rst.txt ADDED
@@ -0,0 +1,39 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0172
2
+ -------
3
+
4
+ .. versionadded:: 3.31
5
+
6
+ The :module:`CPack` module enables per-machine installation by default
7
+ in the :cpack_gen:`CPack WIX Generator`.
8
+
9
+ The :cpack_gen:`CPack WIX Generator`'s :variable:`CPACK_WIX_INSTALL_SCOPE`
10
+ option controls the scope of the generated Windows Installer package.
11
+ When :variable:`CPACK_WIX_VERSION` is set to 4 or higher, the default scope
12
+ is ``perMachine``. However, when using WIX 3 the default scope is ``NONE``,
13
+ and CPack does not set any ``InstallScope`` in the package specification.
14
+ The resulting installer requires administrative privileges and installs
15
+ into the system-wide ``ProgramFiles`` directory, but the start menu entry
16
+ and uninstaller registration are created only for the current user.
17
+
18
+ The :module:`CPack` module in CMake 3.30 and older does not specify any
19
+ :variable:`CPACK_WIX_INSTALL_SCOPE` value by default, so CPack uses no
20
+ installation scope by default with WIX 3. CMake 3.31 and newer instead
21
+ prefer to set :variable:`CPACK_WIX_INSTALL_SCOPE` to ``perMachine`` by
22
+ default to make the behavior consistent across all WIX versions. This
23
+ policy provides compatibility for projects that have not been updated
24
+ to expect ``perMachine`` behavior.
25
+
26
+ The ``OLD`` behavior for this policy is to not set
27
+ :variable:`CPACK_WIX_INSTALL_SCOPE` by default. The ``NEW`` behavior for
28
+ this policy is to set :variable:`CPACK_WIX_INSTALL_SCOPE` to ``perMachine``
29
+ by default.
30
+
31
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31
32
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default
33
+ .. include:: STANDARD_ADVICE.txt
34
+
35
+ See documentation of the
36
+ :variable:`CMAKE_POLICY_WARNING_CMP0172 <CMAKE_POLICY_WARNING_CMP<NNNN>>`
37
+ variable to control the warning.
38
+
39
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0173.rst.txt ADDED
@@ -0,0 +1,22 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0173
2
+ -------
3
+
4
+ .. versionadded:: 3.31
5
+
6
+ The :module:`CMakeFindFrameworks` module is removed.
7
+
8
+ CMake's framework handling has evolved well beyond what the
9
+ ``CMakeFindFrameworks`` module supports. The module lacks any handling of
10
+ XCFrameworks, it never documented the one command it provides, and
11
+ :command:`find_library` provides superior capabilities in all respects.
12
+
13
+ The ``OLD`` behavior of this policy is for :module:`CMakeFindFrameworks` to
14
+ continue to provide the undocumented ``cmake_find_frameworks()`` command.
15
+ The ``NEW`` behavior halts with a fatal error if anything tries to include
16
+ the module.
17
+
18
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31
19
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
20
+ .. include:: STANDARD_ADVICE.txt
21
+
22
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0174.rst.txt ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0174
2
+ -------
3
+
4
+ .. versionadded:: 3.31
5
+
6
+ :command:`cmake_parse_arguments(PARSE_ARGV)` defines a variable for an empty
7
+ string after a single-value keyword.
8
+
9
+ One of the main reasons for using the ``PARSE_ARGV`` form of the
10
+ :command:`cmake_parse_arguments` command is to more robustly handle corner
11
+ cases related to empty values. The non-``PARSE_ARGV`` form doesn't preserve
12
+ empty arguments, but the ``PARSE_ARGV`` form does. For each single-value
13
+ keyword given, a variable should be defined if the keyword is present, even
14
+ if it is followed by an empty string.
15
+
16
+ Prior to CMake 3.31, no variable would be defined if the value given after a
17
+ single-value keyword was an empty string. This meant the code could not detect
18
+ the difference between the keyword not being given, and it being given but with
19
+ an empty value, except by iterating over all the arguments and checking if the
20
+ keyword is present.
21
+
22
+ For the ``OLD`` behavior of this policy,
23
+ :command:`cmake_parse_arguments(PARSE_ARGV)` does not define a variable for a
24
+ single-value keyword followed by an empty string, or followed by no value at
25
+ all.
26
+
27
+ For the ``NEW`` behavior, :command:`cmake_parse_arguments(PARSE_ARGV)` always
28
+ defines a variable for each keyword given in the arguments, even a single-value
29
+ keyword with an empty string as its value or no value at all. With the
30
+ ``NEW`` behavior, the code can robustly check if a single-value keyword was
31
+ given using just ``if(DEFINED <prefix>_<keyword>)``.
32
+
33
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31
34
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
35
+ .. include:: STANDARD_ADVICE.txt
36
+
37
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0175.rst.txt ADDED
@@ -0,0 +1,40 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0175
2
+ -------
3
+
4
+ .. versionadded:: 3.31
5
+
6
+ :command:`add_custom_command` rejects invalid arguments.
7
+
8
+ CMake 3.30 and earlier silently ignored unsupported keywords and missing or
9
+ invalid arguments for the different forms of the :command:`add_custom_command`
10
+ command. CMake 3.31 implements more rigorous argument checking and will flag
11
+ invalid or missing arguments as errors.
12
+
13
+ The ``OLD`` behavior of this policy will accept the same invalid keywords or
14
+ arguments as CMake 3.30 and earlier. The ``NEW`` behavior will flag the
15
+ following as errors that previously went unreported:
16
+
17
+ * The ``OUTPUT`` form does not accept ``PRE_BUILD``, ``PRE_LINK``, or
18
+ ``POST_BUILD`` keywords.
19
+ * When the ``APPEND`` keyword is given, the ``OUTPUT`` form also does not
20
+ accept ``BYPRODUCTS``, ``COMMAND_EXPAND_LISTS``, ``DEPENDS_EXPLICIT_ONLY``,
21
+ ``DEPFILE``, ``JOB_POOL``, ``JOB_SERVER_AWARE``, ``USES_TERMINAL``, or
22
+ ``VERBATIM`` keywords.
23
+ * The ``TARGET`` form requires exactly one of ``PRE_BUILD``, ``PRE_LINK``, or
24
+ ``POST_BUILD`` to be given. Previously, if none were given, ``POST_BUILD``
25
+ was assumed, or if multiple keywords were given, the last one was used.
26
+ * The ``TARGET`` form does not accept ``DEPENDS``, ``DEPENDS_EXPLICIT_ONLY``,
27
+ ``DEPFILE``, ``IMPLICIT_DEPENDS``, ``MAIN_DEPENDENCY``, ``JOB_POOL``, or
28
+ ``JOB_SERVER_AWARE`` keywords.
29
+ * The ``TARGET`` form now requires at least one ``COMMAND`` to be given.
30
+ * If a keyword expects a value to be given after it, but no value is provided,
31
+ that was previously treated as though the keyword was not given at all.
32
+ * The ``COMMENT`` keyword expects exactly one value after it. If multiple
33
+ values are given, or if the ``COMMENT`` keyword is given more than once,
34
+ this is an error.
35
+
36
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31
37
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
38
+ .. include:: STANDARD_ADVICE.txt
39
+
40
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0176.rst.txt ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0176
2
+ -------
3
+
4
+ .. versionadded:: 3.31
5
+
6
+ :command:`execute_process` ``ENCODING`` is ``UTF-8`` by default.
7
+
8
+ The ``ENCODING`` option is meaningful only on Windows. It specifies the
9
+ character encoding expected in the process's output on stdout and stderr.
10
+ In CMake 3.14 and below the default encoding was ``NONE``, which corresponds
11
+ to CMake's internal UTF-8 encoding. In CMake 3.15 through CMake 3.30 the
12
+ default encoding was accidentally changed to ``AUTO``, but the change went
13
+ unnoticed and was not documented.
14
+
15
+ CMake 3.31 and above prefer the ``ENCODING`` default to be ``UTF-8``.
16
+ This policy provides compatibility with projects that may have been
17
+ relying on the default being ``AUTO``.
18
+
19
+ The ``OLD`` behavior of this policy is for :command:`execute_process`
20
+ to use ``AUTO`` by default if no ``ENCODING`` is specified. The ``NEW``
21
+ behavior for this policy is to use ``UTF-8`` as the default ``ENCODING``.
22
+
23
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31
24
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
25
+ .. include:: STANDARD_ADVICE.txt
26
+
27
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0177.rst.txt ADDED
@@ -0,0 +1,38 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0177
2
+ -------
3
+
4
+ .. versionadded:: 3.31
5
+
6
+ :command:`install` ``DESTINATION`` paths are normalized.
7
+
8
+ The :command:`install` command has a number of different forms, and most of
9
+ them take a ``DESTINATION`` keyword, some in more than one place.
10
+ CMake 3.30 and earlier used the value given after the ``DESTINATION`` keyword
11
+ as provided with no transformations. The :command:`install(EXPORT)` form
12
+ assumes the path contains no ``..`` or ``.`` path components when computing
13
+ a path relative to the ``DESTINATION``, and if the project provided a path
14
+ that violated that assumption, the computed path would be incorrect.
15
+
16
+ CMake 3.31 normalizes all ``DESTINATION`` values given in any form of the
17
+ :command:`install` command, except for the ``INCLUDES DESTINATION`` of the
18
+ :command:`install(TARGETS)` form. The normalization performed is the same
19
+ as for the :command:`cmake_path` command (see :ref:`Normalization`).
20
+
21
+ The ``OLD`` behavior of this policy performs no translation on the
22
+ ``DESTINATION`` values of any :command:`install` command. They are used
23
+ exactly as provided. If a destination path contains ``..`` or ``.`` path
24
+ components, :command:`install(EXPORT)` will use the same wrong paths as
25
+ CMake 3.30 and earlier.
26
+
27
+ The ``NEW`` behavior will normalize all ``DESTINATION`` values except for
28
+ ``INCLUDES DESTINATION``. If a destination path contains a generator
29
+ expression, it will be wrapped in a ``$<PATH:CMAKE_PATH,NORMALIZE,...>``
30
+ generator expression.
31
+
32
+ This policy was introduced in CMake version 3.31.
33
+ It may be set by :command:`cmake_policy` or :command:`cmake_minimum_required`.
34
+ If it is not set, CMake will warn if it detects a path that would be different
35
+ if normalized, and uses ``OLD`` behavior. If a destination path contains a
36
+ generator expression, no such warning will be issued regardless of the value.
37
+
38
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0178.rst.txt ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0178
2
+ -------
3
+
4
+ .. versionadded:: 3.31
5
+
6
+ Test command lines preserve empty arguments.
7
+
8
+ Empty values in the :prop_tgt:`TEST_LAUNCHER` and
9
+ :prop_tgt:`CROSSCOMPILING_EMULATOR` target properties are now preserved
10
+ for tests added by the following:
11
+
12
+ * The :command:`add_test` command.
13
+ * The :command:`ExternalData_Add_Test` command from the :module:`ExternalData`
14
+ module.
15
+ * The :command:`gtest_add_tests` or :command:`gtest_discover_tests` commands
16
+ from the :module:`GoogleTest` module.
17
+
18
+ For the :command:`gtest_add_tests` and :command:`gtest_discover_tests`
19
+ commands, empty elements in the values passed after the ``EXTRA_ARGS``
20
+ keyword are also now preserved.
21
+
22
+ The ``OLD`` behavior of this policy silently discards empty list items
23
+ from the :prop_tgt:`TEST_LAUNCHER` and :prop_tgt:`CROSSCOMPILING_EMULATOR`
24
+ target properties in the above-mentioned cases. It also silently discards
25
+ empty items from the values given after ``EXTRA_ARGS`` for the
26
+ :command:`gtest_add_tests` and :command:`gtest_discover_tests` commands.
27
+
28
+ The ``NEW`` behavior of this policy preserves empty list items in the
29
+ :prop_tgt:`TEST_LAUNCHER` and :prop_tgt:`CROSSCOMPILING_EMULATOR` target
30
+ properties, and in values given after ``EXTRA_ARGS`` for
31
+ :command:`gtest_add_tests` and :command:`gtest_discover_tests`.
32
+
33
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31
34
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: warns
35
+ .. include:: STANDARD_ADVICE.txt
36
+
37
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0179.rst.txt ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0179
2
+ -------
3
+
4
+ .. versionadded:: 3.31
5
+
6
+ De-duplication of static libraries on link lines keeps first occurrence.
7
+ This policy is only relevant when policy :policy:`CMP0156` is set to ``NEW``.
8
+
9
+ Based on the linker capabilities, the static libraries can
10
+ be de-duplicated. See policy :policy:`CMP0156` for more information.
11
+
12
+ CMake 3.30 and below may choose to keep, on some platforms, the last occurrence
13
+ of the static libraries rather than the fist occurrence when they are
14
+ de-duplicated.
15
+
16
+ CMake 3.31 and above prefer to keep, on all platforms, the first occurrence of
17
+ the static libraries when they are de-duplicated.
18
+
19
+ The ``OLD`` behavior for this policy is to keep, on some platforms, the last
20
+ occurrence of the static libraries when they are de-duplicated. The ``NEW``
21
+ behavior for this policy is to keep the first occurrence of the static
22
+ libraries when they are de-duplicated, regardless of the platform.
23
+
24
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31
25
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
26
+ .. include:: STANDARD_ADVICE.txt
27
+
28
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/policy/CMP0180.rst.txt ADDED
@@ -0,0 +1,36 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ CMP0180
2
+ -------
3
+
4
+ .. versionadded:: 3.31
5
+
6
+ :command:`project` always sets ``<PROJECT-NAME>_*`` as normal variables.
7
+
8
+ In CMake 3.29 and below, the :command:`project` command set
9
+ :variable:`<PROJECT-NAME>_SOURCE_DIR`, :variable:`<PROJECT-NAME>_BINARY_DIR`,
10
+ and :variable:`<PROJECT-NAME>_IS_TOP_LEVEL` as cache entries, but not as
11
+ normal variables. CMake 3.30 started setting them as normal variables,
12
+ but only if they are already set as normal variables. This was needed to
13
+ preserve support for some :module:`FetchContent` use cases under policy
14
+ :policy:`CMP0169`'s NEW behavior, while also preserving behavior of nested
15
+ directories that call :command:`project` with the same project name.
16
+ See release notes for 3.30.3, 3.30.4, and 3.30.5 for details.
17
+
18
+ CMake 3.31 and later prefer to always set ``<PROJECT-NAME>_SOURCE_DIR``,
19
+ ``<PROJECT-NAME>_BINARY_DIR``, and ``<PROJECT-NAME>_IS_TOP_LEVEL``, as both
20
+ cache entries and normal variables, regardless of what cache or normal
21
+ variables already exist. This policy provides compatibility for projects
22
+ that have not been updated to expect this behavior.
23
+
24
+ The ``OLD`` behavior for this policy will only set normal variables for
25
+ ``<PROJECT-NAME>_SOURCE_DIR``, ``<PROJECT-NAME>_BINARY_DIR``, and
26
+ ``<PROJECT-NAME>_IS_TOP_LEVEL`` if there is already a normal variable by that
27
+ name when :command:`project` is called.
28
+ The ``NEW`` behavior for this policy will always set normal variables for
29
+ ``<PROJECT-NAME>_SOURCE_DIR``, ``<PROJECT-NAME>_BINARY_DIR``, and
30
+ ``<PROJECT-NAME>_IS_TOP_LEVEL`` when :command:`project` is called.
31
+
32
+ .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31
33
+ .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
34
+ .. include:: STANDARD_ADVICE.txt
35
+
36
+ .. include:: DEPRECATED.txt
cmake/doc/cmake/html/_sources/prop_cache/ADVANCED.rst.txt ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ ADVANCED
2
+ --------
3
+
4
+ True if entry should be hidden by default in GUIs.
5
+
6
+ This is a boolean value indicating whether the entry is considered
7
+ interesting only for advanced configuration. The :command:`mark_as_advanced`
8
+ command modifies this property.
cmake/doc/cmake/html/_sources/prop_cache/HELPSTRING.rst.txt ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ HELPSTRING
2
+ ----------
3
+
4
+ Help associated with entry in GUIs.
5
+
6
+ This string summarizes the purpose of an entry to help users set it
7
+ through a CMake GUI.
cmake/doc/cmake/html/_sources/prop_cache/MODIFIED.rst.txt ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ MODIFIED
2
+ --------
3
+
4
+ Internal management property. Do not set or get.
5
+
6
+ This is an internal cache entry property managed by CMake to track
7
+ interactive user modification of entries. Ignore it.
cmake/doc/cmake/html/_sources/prop_cache/STRINGS.rst.txt ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ STRINGS
2
+ -------
3
+
4
+ Enumerate possible ``STRING`` entry values for GUI selection.
5
+
6
+ For cache entries with type ``STRING``, this enumerates a set of values.
7
+ CMake GUIs may use this to provide a selection widget instead of a
8
+ generic string entry field. This is for convenience only. CMake does
9
+ not enforce that the value matches one of those listed.
cmake/doc/cmake/html/_sources/prop_cache/TYPE.rst.txt ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ TYPE
2
+ ----
3
+
4
+ Widget type for entry in GUIs.
5
+
6
+ Cache entry values are always strings, but CMake GUIs present widgets
7
+ to help users set values. The GUIs use this property as a hint to
8
+ determine the widget type. Valid ``TYPE`` values are:
9
+
10
+ ::
11
+
12
+ BOOL = Boolean ON/OFF value.
13
+ PATH = Path to a directory.
14
+ FILEPATH = Path to a file.
15
+ STRING = Generic string value.
16
+ INTERNAL = Do not present in GUI at all.
17
+ STATIC = Value managed by CMake, do not change.
18
+ UNINITIALIZED = Type not yet specified.
19
+
20
+ Generally the ``TYPE`` of a cache entry should be set by the command which
21
+ creates it ( :command:`set`, :command:`option`, :command:`find_library`, etc.).
cmake/doc/cmake/html/_sources/prop_cache/VALUE.rst.txt ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ VALUE
2
+ -----
3
+
4
+ Value of a cache entry.
5
+
6
+ This property maps to the actual value of a cache entry. Setting this
7
+ property always sets the value without checking, so use with care.
cmake/doc/cmake/html/_sources/prop_dir/ADDITIONAL_CLEAN_FILES.rst.txt ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ADDITIONAL_CLEAN_FILES
2
+ ----------------------
3
+
4
+ .. versionadded:: 3.15
5
+
6
+ A :ref:`;-list <CMake Language Lists>` of files or directories that will be
7
+ removed as a part of the global ``clean`` target. It is useful for
8
+ specifying generated files or directories that are used by multiple targets
9
+ or by CMake itself, or that are generated in ways which cannot be captured as
10
+ outputs or byproducts of custom commands.
11
+
12
+ If an additional clean file is specific to a single target only, then the
13
+ :prop_tgt:`ADDITIONAL_CLEAN_FILES` target property would usually be a better
14
+ choice than this directory property.
15
+
16
+ Relative paths are allowed and are interpreted relative to the
17
+ current binary directory.
18
+
19
+ Contents of ``ADDITIONAL_CLEAN_FILES`` may use
20
+ :manual:`generator expressions <cmake-generator-expressions(7)>`.
21
+
22
+ This property only works for the :generator:`Ninja` and the Makefile
23
+ generators. It is ignored by other generators.
cmake/doc/cmake/html/_sources/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst.txt ADDED
@@ -0,0 +1,17 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ADDITIONAL_MAKE_CLEAN_FILES
2
+ ---------------------------
3
+
4
+ .. deprecated:: 3.15
5
+
6
+ Use :prop_dir:`ADDITIONAL_CLEAN_FILES` instead.
7
+
8
+ Additional files to remove during the clean stage.
9
+
10
+ A :ref:`;-list <CMake Language Lists>` of files that will be removed as a
11
+ part of the ``make clean`` target.
12
+
13
+ Arguments to ``ADDITIONAL_MAKE_CLEAN_FILES`` may use
14
+ :manual:`generator expressions <cmake-generator-expressions(7)>`.
15
+
16
+ This property only works for the Makefile generators.
17
+ It is ignored on other generators.
cmake/doc/cmake/html/_sources/prop_dir/BINARY_DIR.rst.txt ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ BINARY_DIR
2
+ ----------
3
+
4
+ .. versionadded:: 3.7
5
+
6
+ This read-only directory property reports absolute path to the binary
7
+ directory corresponding to the source on which it is read.
cmake/doc/cmake/html/_sources/prop_dir/BUILDSYSTEM_TARGETS.rst.txt ADDED
@@ -0,0 +1,15 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ BUILDSYSTEM_TARGETS
2
+ -------------------
3
+
4
+ .. versionadded:: 3.7
5
+
6
+ This read-only directory property contains a
7
+ :ref:`semicolon-separated list <CMake Language Lists>` of buildsystem targets added in the
8
+ directory by calls to the :command:`add_library`, :command:`add_executable`,
9
+ and :command:`add_custom_target` commands. The list does not include any
10
+ :ref:`Imported Targets` or :ref:`Alias Targets`, but does include
11
+ :ref:`Interface Libraries`. Each entry in the list is the logical name
12
+ of a target, suitable to pass to the :command:`get_property` command
13
+ ``TARGET`` option.
14
+
15
+ See also the :prop_dir:`IMPORTED_TARGETS` directory property.
cmake/doc/cmake/html/_sources/prop_dir/CACHE_VARIABLES.rst.txt ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ CACHE_VARIABLES
2
+ ---------------
3
+
4
+ List of cache variables available in the current directory.
5
+
6
+ This read-only property specifies the list of CMake cache variables
7
+ currently defined. It is intended for debugging purposes.
cmake/doc/cmake/html/_sources/prop_dir/CLEAN_NO_CUSTOM.rst.txt ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ CLEAN_NO_CUSTOM
2
+ ---------------
3
+
4
+ Set to true to tell :ref:`Makefile Generators` not to remove the outputs of
5
+ custom commands for this directory during the ``make clean`` operation.
6
+ This is ignored on other generators because it is not possible to implement.
cmake/doc/cmake/html/_sources/prop_dir/CMAKE_CONFIGURE_DEPENDS.rst.txt ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ CMAKE_CONFIGURE_DEPENDS
2
+ -----------------------
3
+
4
+ Tell CMake about additional input files to the configuration process.
5
+ If any named file is modified the build system will re-run CMake to
6
+ re-configure the file and generate the build system again.
7
+
8
+ Specify files as a semicolon-separated list of paths. Relative paths
9
+ are interpreted as relative to the current source directory.