Add files using upload-large-folder tool
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_test.rst +117 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/aux_source_directory.rst +24 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_build.rst +93 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/endmacro.rst +14 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/execute_process.rst +184 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/list.rst +334 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/set_property.rst +135 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/target_link_libraries.rst +432 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/try_run.rst +165 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/variable_watch.rst +48 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0001.rst +21 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0069.rst +93 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0077.rst +61 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0118.rst +38 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0131.rst +30 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0133.rst +32 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0169.rst +49 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0175.rst +40 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0179.rst +28 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_cache/MODIFIED.rst +7 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/ANDROID_API_MIN.rst +9 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst +12 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst +8 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst +17 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst +17 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/BUILD_RPATH.rst +36 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst +15 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/COMPILE_FLAGS.rst +14 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NAME.rst +13 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst +18 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/C_EXTENSIONS.rst +21 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst +20 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/DEPRECATION.rst +14 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/DOTNET_SDK.rst +25 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/EXCLUDE_FROM_ALL.rst +28 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/EXPORT_NO_SYSTEM.rst +13 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/Fortran_PREPROCESS.rst +25 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/HEADER_SET.rst +15 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/HIP_STANDARD.rst +54 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_FEATURES.rst +9 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/IMPORTED_NO_SONAME.rst +9 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/IMPORT_PREFIX.rst +9 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/INTERFACE_AUTOMOC_MACRO_NAMES.rst +89 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst +28 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/JOB_POOL_COMPILE.rst +17 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/LANG_CPPLINT.rst +29 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/LANG_STANDARD.rst +33 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/LINK_DEPENDS.rst +18 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst +56 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/MACHO_CURRENT_VERSION.rst +27 -0
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_test.rst
ADDED
|
@@ -0,0 +1,117 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
add_test
|
| 2 |
+
--------
|
| 3 |
+
|
| 4 |
+
Add a test to the project to be run by :manual:`ctest(1)`.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
add_test(NAME <name> COMMAND <command> [<arg>...]
|
| 9 |
+
[CONFIGURATIONS <config>...]
|
| 10 |
+
[WORKING_DIRECTORY <dir>]
|
| 11 |
+
[COMMAND_EXPAND_LISTS])
|
| 12 |
+
|
| 13 |
+
Adds a test called ``<name>``. The test name may contain arbitrary
|
| 14 |
+
characters, expressed as a :ref:`Quoted Argument` or :ref:`Bracket Argument`
|
| 15 |
+
if necessary. See policy :policy:`CMP0110`.
|
| 16 |
+
|
| 17 |
+
CMake only generates tests if the :command:`enable_testing` command has been
|
| 18 |
+
invoked. The :module:`CTest` module invokes ``enable_testing`` automatically
|
| 19 |
+
unless ``BUILD_TESTING`` is set to ``OFF``.
|
| 20 |
+
|
| 21 |
+
Tests added with the ``add_test(NAME)`` signature support using
|
| 22 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`
|
| 23 |
+
in test properties set by :command:`set_property(TEST)` or
|
| 24 |
+
:command:`set_tests_properties`. Test properties may only be set in the
|
| 25 |
+
directory the test is created in.
|
| 26 |
+
|
| 27 |
+
``add_test`` options are:
|
| 28 |
+
|
| 29 |
+
``COMMAND``
|
| 30 |
+
Specify the test command-line.
|
| 31 |
+
|
| 32 |
+
If ``<command>`` specifies an executable target created by
|
| 33 |
+
:command:`add_executable`:
|
| 34 |
+
|
| 35 |
+
* It will automatically be replaced by the location of the executable
|
| 36 |
+
created at build time.
|
| 37 |
+
|
| 38 |
+
* .. versionadded:: 3.3
|
| 39 |
+
|
| 40 |
+
The target's :prop_tgt:`CROSSCOMPILING_EMULATOR`, if set, will be
|
| 41 |
+
used to run the command on the host::
|
| 42 |
+
|
| 43 |
+
<emulator> <command>
|
| 44 |
+
|
| 45 |
+
.. versionchanged:: 3.29
|
| 46 |
+
|
| 47 |
+
The emulator is used only when
|
| 48 |
+
:variable:`cross-compiling <CMAKE_CROSSCOMPILING>`.
|
| 49 |
+
See policy :policy:`CMP0158`.
|
| 50 |
+
|
| 51 |
+
* .. versionadded:: 3.29
|
| 52 |
+
|
| 53 |
+
The target's :prop_tgt:`TEST_LAUNCHER`, if set, will be
|
| 54 |
+
used to launch the command::
|
| 55 |
+
|
| 56 |
+
<launcher> <command>
|
| 57 |
+
|
| 58 |
+
If the :prop_tgt:`CROSSCOMPILING_EMULATOR` is also set, both are used::
|
| 59 |
+
|
| 60 |
+
<launcher> <emulator> <command>
|
| 61 |
+
|
| 62 |
+
The command may be specified using
|
| 63 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 64 |
+
|
| 65 |
+
``CONFIGURATIONS``
|
| 66 |
+
Restrict execution of the test only to the named configurations.
|
| 67 |
+
|
| 68 |
+
``WORKING_DIRECTORY``
|
| 69 |
+
Set the test property :prop_test:`WORKING_DIRECTORY` in which to execute the
|
| 70 |
+
test. If not specified, the test will be run in
|
| 71 |
+
:variable:`CMAKE_CURRENT_BINARY_DIR`. The working directory may be specified
|
| 72 |
+
using :manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 73 |
+
|
| 74 |
+
``COMMAND_EXPAND_LISTS``
|
| 75 |
+
.. versionadded:: 3.16
|
| 76 |
+
|
| 77 |
+
Lists in ``COMMAND`` arguments will be expanded, including those created with
|
| 78 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 79 |
+
|
| 80 |
+
If the test command exits with code ``0`` the test passes. Non-zero exit code
|
| 81 |
+
is a "failed" test. The test property :prop_test:`WILL_FAIL` inverts this
|
| 82 |
+
logic. Note that system-level test failures such as segmentation faults or
|
| 83 |
+
heap errors will still fail the test even if ``WILL_FAIL`` is true. Output
|
| 84 |
+
written to stdout or stderr is captured by :manual:`ctest(1)` and only
|
| 85 |
+
affects the pass/fail status via the :prop_test:`PASS_REGULAR_EXPRESSION`,
|
| 86 |
+
:prop_test:`FAIL_REGULAR_EXPRESSION`, or :prop_test:`SKIP_REGULAR_EXPRESSION`
|
| 87 |
+
test properties.
|
| 88 |
+
|
| 89 |
+
.. versionadded:: 3.16
|
| 90 |
+
Added :prop_test:`SKIP_REGULAR_EXPRESSION` property.
|
| 91 |
+
|
| 92 |
+
Example usage:
|
| 93 |
+
|
| 94 |
+
.. code-block:: cmake
|
| 95 |
+
|
| 96 |
+
add_test(NAME mytest
|
| 97 |
+
COMMAND testDriver --config $<CONFIG>
|
| 98 |
+
--exe $<TARGET_FILE:myexe>)
|
| 99 |
+
|
| 100 |
+
This creates a test ``mytest`` whose command runs a ``testDriver`` tool
|
| 101 |
+
passing the configuration name and the full path to the executable
|
| 102 |
+
file produced by target ``myexe``.
|
| 103 |
+
|
| 104 |
+
---------------------------------------------------------------------
|
| 105 |
+
|
| 106 |
+
The command syntax above is recommended over the older, less flexible form:
|
| 107 |
+
|
| 108 |
+
.. code-block:: cmake
|
| 109 |
+
|
| 110 |
+
add_test(<name> <command> [<arg>...])
|
| 111 |
+
|
| 112 |
+
Add a test called ``<name>`` with the given command-line.
|
| 113 |
+
|
| 114 |
+
Unlike the above ``NAME`` signature, target names are not supported
|
| 115 |
+
in the command-line. Furthermore, tests added with this signature do not
|
| 116 |
+
support :manual:`generator expressions <cmake-generator-expressions(7)>`
|
| 117 |
+
in the command-line or test properties.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/aux_source_directory.rst
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
aux_source_directory
|
| 2 |
+
--------------------
|
| 3 |
+
|
| 4 |
+
Find all source files in a directory.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
aux_source_directory(<dir> <variable>)
|
| 9 |
+
|
| 10 |
+
Collects the names of all the source files in the specified directory
|
| 11 |
+
and stores the list in the ``<variable>`` provided. This command is
|
| 12 |
+
intended to be used by projects that use explicit template
|
| 13 |
+
instantiation. Template instantiation files can be stored in a
|
| 14 |
+
``Templates`` subdirectory and collected automatically using this
|
| 15 |
+
command to avoid manually listing all instantiations.
|
| 16 |
+
|
| 17 |
+
It is tempting to use this command to avoid writing the list of source
|
| 18 |
+
files for a library or executable target. While this seems to work,
|
| 19 |
+
there is no way for CMake to generate a build system that knows when a
|
| 20 |
+
new source file has been added. Normally the generated build system
|
| 21 |
+
knows when it needs to rerun CMake because the ``CMakeLists.txt`` file is
|
| 22 |
+
modified to add a new source. When the source is just added to the
|
| 23 |
+
directory without modifying this file, one would have to manually
|
| 24 |
+
rerun CMake to generate a build system incorporating the new file.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_build.rst
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ctest_build
|
| 2 |
+
-----------
|
| 3 |
+
|
| 4 |
+
Perform the :ref:`CTest Build Step` as a :ref:`Dashboard Client`.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
ctest_build([BUILD <build-dir>] [APPEND]
|
| 9 |
+
[CONFIGURATION <config>]
|
| 10 |
+
[PARALLEL_LEVEL <parallel>]
|
| 11 |
+
[FLAGS <flags>]
|
| 12 |
+
[PROJECT_NAME <project-name>]
|
| 13 |
+
[TARGET <target-name>]
|
| 14 |
+
[NUMBER_ERRORS <num-err-var>]
|
| 15 |
+
[NUMBER_WARNINGS <num-warn-var>]
|
| 16 |
+
[RETURN_VALUE <result-var>]
|
| 17 |
+
[CAPTURE_CMAKE_ERROR <result-var>]
|
| 18 |
+
)
|
| 19 |
+
|
| 20 |
+
Build the project and store results in ``Build.xml``
|
| 21 |
+
for submission with the :command:`ctest_submit` command.
|
| 22 |
+
|
| 23 |
+
The :variable:`CTEST_BUILD_COMMAND` variable may be set to explicitly
|
| 24 |
+
specify the build command line. Otherwise the build command line is
|
| 25 |
+
computed automatically based on the options given.
|
| 26 |
+
|
| 27 |
+
The options are:
|
| 28 |
+
|
| 29 |
+
``BUILD <build-dir>``
|
| 30 |
+
Specify the top-level build directory. If not given, the
|
| 31 |
+
:variable:`CTEST_BINARY_DIRECTORY` variable is used.
|
| 32 |
+
|
| 33 |
+
``APPEND``
|
| 34 |
+
Mark ``Build.xml`` for append to results previously submitted to a
|
| 35 |
+
dashboard server since the last :command:`ctest_start` call.
|
| 36 |
+
Append semantics are defined by the dashboard server in use.
|
| 37 |
+
This does *not* cause results to be appended to a ``.xml`` file
|
| 38 |
+
produced by a previous call to this command.
|
| 39 |
+
|
| 40 |
+
``CONFIGURATION <config>``
|
| 41 |
+
Specify the build configuration (e.g. ``Debug``). If not
|
| 42 |
+
specified the ``CTEST_BUILD_CONFIGURATION`` variable will be checked.
|
| 43 |
+
Otherwise the :option:`-C \<cfg\> <ctest -C>` option given to the
|
| 44 |
+
:manual:`ctest(1)` command will be used, if any.
|
| 45 |
+
|
| 46 |
+
``PARALLEL_LEVEL <parallel>``
|
| 47 |
+
.. versionadded:: 3.21
|
| 48 |
+
|
| 49 |
+
Specify the parallel level of the underlying build system. If not
|
| 50 |
+
specified, the :envvar:`CMAKE_BUILD_PARALLEL_LEVEL` environment
|
| 51 |
+
variable will be checked.
|
| 52 |
+
|
| 53 |
+
``FLAGS <flags>``
|
| 54 |
+
Pass additional arguments to the underlying build command.
|
| 55 |
+
If not specified the ``CTEST_BUILD_FLAGS`` variable will be checked.
|
| 56 |
+
This can, e.g., be used to trigger a parallel build using the
|
| 57 |
+
``-j`` option of ``make``. See the :module:`ProcessorCount` module
|
| 58 |
+
for an example.
|
| 59 |
+
|
| 60 |
+
``PROJECT_NAME <project-name>``
|
| 61 |
+
Ignored since CMake 3.0.
|
| 62 |
+
|
| 63 |
+
.. versionchanged:: 3.14
|
| 64 |
+
This value is no longer required.
|
| 65 |
+
|
| 66 |
+
``TARGET <target-name>``
|
| 67 |
+
Specify the name of a target to build. If not specified the
|
| 68 |
+
``CTEST_BUILD_TARGET`` variable will be checked. Otherwise the
|
| 69 |
+
default target will be built. This is the "all" target
|
| 70 |
+
(called ``ALL_BUILD`` in :ref:`Visual Studio Generators`).
|
| 71 |
+
|
| 72 |
+
``NUMBER_ERRORS <num-err-var>``
|
| 73 |
+
Store the number of build errors detected in the given variable.
|
| 74 |
+
|
| 75 |
+
``NUMBER_WARNINGS <num-warn-var>``
|
| 76 |
+
Store the number of build warnings detected in the given variable.
|
| 77 |
+
|
| 78 |
+
``RETURN_VALUE <result-var>``
|
| 79 |
+
Store the return value of the native build tool in the given variable.
|
| 80 |
+
|
| 81 |
+
``CAPTURE_CMAKE_ERROR <result-var>``
|
| 82 |
+
.. versionadded:: 3.7
|
| 83 |
+
|
| 84 |
+
Store in the ``<result-var>`` variable -1 if there are any errors running
|
| 85 |
+
the command and prevent ctest from returning non-zero if an error occurs.
|
| 86 |
+
|
| 87 |
+
``QUIET``
|
| 88 |
+
.. versionadded:: 3.3
|
| 89 |
+
|
| 90 |
+
Suppress any CTest-specific non-error output that would have been
|
| 91 |
+
printed to the console otherwise. The summary of warnings / errors,
|
| 92 |
+
as well as the output from the native build tool is unaffected by
|
| 93 |
+
this option.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/endmacro.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
endmacro
|
| 2 |
+
--------
|
| 3 |
+
|
| 4 |
+
Ends a list of commands in a macro block.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
endmacro([<name>])
|
| 9 |
+
|
| 10 |
+
See the :command:`macro` command.
|
| 11 |
+
|
| 12 |
+
The optional ``<name>`` argument is supported for backward compatibility
|
| 13 |
+
only. If used it must be a verbatim repeat of the ``<name>`` argument
|
| 14 |
+
of the opening ``macro`` command.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/execute_process.rst
ADDED
|
@@ -0,0 +1,184 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
execute_process
|
| 2 |
+
---------------
|
| 3 |
+
|
| 4 |
+
Execute one or more child processes.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
execute_process(COMMAND <cmd1> [<arguments>]
|
| 9 |
+
[COMMAND <cmd2> [<arguments>]]...
|
| 10 |
+
[WORKING_DIRECTORY <directory>]
|
| 11 |
+
[TIMEOUT <seconds>]
|
| 12 |
+
[RESULT_VARIABLE <variable>]
|
| 13 |
+
[RESULTS_VARIABLE <variable>]
|
| 14 |
+
[OUTPUT_VARIABLE <variable>]
|
| 15 |
+
[ERROR_VARIABLE <variable>]
|
| 16 |
+
[INPUT_FILE <file>]
|
| 17 |
+
[OUTPUT_FILE <file>]
|
| 18 |
+
[ERROR_FILE <file>]
|
| 19 |
+
[OUTPUT_QUIET]
|
| 20 |
+
[ERROR_QUIET]
|
| 21 |
+
[COMMAND_ECHO <where>]
|
| 22 |
+
[OUTPUT_STRIP_TRAILING_WHITESPACE]
|
| 23 |
+
[ERROR_STRIP_TRAILING_WHITESPACE]
|
| 24 |
+
[ENCODING <name>]
|
| 25 |
+
[ECHO_OUTPUT_VARIABLE]
|
| 26 |
+
[ECHO_ERROR_VARIABLE]
|
| 27 |
+
[COMMAND_ERROR_IS_FATAL <ANY|LAST>])
|
| 28 |
+
|
| 29 |
+
Runs the given sequence of one or more commands.
|
| 30 |
+
|
| 31 |
+
Commands are executed concurrently as a pipeline, with the standard
|
| 32 |
+
output of each process piped to the standard input of the next.
|
| 33 |
+
A single standard error pipe is used for all processes.
|
| 34 |
+
|
| 35 |
+
``execute_process`` runs commands while CMake is configuring the project,
|
| 36 |
+
prior to build system generation. Use the :command:`add_custom_target` and
|
| 37 |
+
:command:`add_custom_command` commands to create custom commands that run
|
| 38 |
+
at build time.
|
| 39 |
+
|
| 40 |
+
Options:
|
| 41 |
+
|
| 42 |
+
``COMMAND``
|
| 43 |
+
A child process command line.
|
| 44 |
+
|
| 45 |
+
CMake executes the child process using operating system APIs directly:
|
| 46 |
+
|
| 47 |
+
* On POSIX platforms, the command line is passed to the
|
| 48 |
+
child process in an ``argv[]`` style array.
|
| 49 |
+
|
| 50 |
+
* On Windows platforms, the command line is encoded as a string such
|
| 51 |
+
that child processes using ``CommandLineToArgvW`` will decode the
|
| 52 |
+
original arguments.
|
| 53 |
+
|
| 54 |
+
No intermediate shell is used, so shell operators such as ``>``
|
| 55 |
+
are treated as normal arguments.
|
| 56 |
+
(Use the ``INPUT_*``, ``OUTPUT_*``, and ``ERROR_*`` options to
|
| 57 |
+
redirect stdin, stdout, and stderr.)
|
| 58 |
+
|
| 59 |
+
For **sequential execution** of multiple commands use multiple
|
| 60 |
+
``execute_process`` calls each with a single ``COMMAND`` argument.
|
| 61 |
+
|
| 62 |
+
``WORKING_DIRECTORY``
|
| 63 |
+
The named directory will be set as the current working directory of
|
| 64 |
+
the child processes.
|
| 65 |
+
|
| 66 |
+
``TIMEOUT``
|
| 67 |
+
After the specified number of seconds (fractions allowed), all unfinished
|
| 68 |
+
child processes will be terminated, and the ``RESULT_VARIABLE`` will be
|
| 69 |
+
set to a string mentioning the "timeout".
|
| 70 |
+
|
| 71 |
+
``RESULT_VARIABLE``
|
| 72 |
+
The variable will be set to contain the result of last child process.
|
| 73 |
+
This will be an integer return code from the last child or a string
|
| 74 |
+
describing an error condition.
|
| 75 |
+
|
| 76 |
+
``RESULTS_VARIABLE <variable>``
|
| 77 |
+
.. versionadded:: 3.10
|
| 78 |
+
|
| 79 |
+
The variable will be set to contain the result of all processes as a
|
| 80 |
+
:ref:`semicolon-separated list <CMake Language Lists>`, in order of the
|
| 81 |
+
given ``COMMAND`` arguments. Each entry will be an integer return code
|
| 82 |
+
from the corresponding child or a string describing an error condition.
|
| 83 |
+
|
| 84 |
+
``INPUT_FILE <file>``
|
| 85 |
+
``<file>`` is attached to the standard input pipe of the *first* ``COMMAND``
|
| 86 |
+
process.
|
| 87 |
+
|
| 88 |
+
``OUTPUT_FILE <file>``
|
| 89 |
+
``<file>`` is attached to the standard output pipe of the *last* ``COMMAND``
|
| 90 |
+
process.
|
| 91 |
+
|
| 92 |
+
``ERROR_FILE <file>``
|
| 93 |
+
``<file>`` is attached to the standard error pipe of *all* ``COMMAND``
|
| 94 |
+
processes.
|
| 95 |
+
|
| 96 |
+
.. versionadded:: 3.3
|
| 97 |
+
If the same ``<file>`` is named for both ``OUTPUT_FILE`` and ``ERROR_FILE``
|
| 98 |
+
then it will be used for both standard output and standard error pipes.
|
| 99 |
+
|
| 100 |
+
``OUTPUT_QUIET``, ``ERROR_QUIET``
|
| 101 |
+
The standard output on ``OUTPUT_VARIABLE`` or standard error on
|
| 102 |
+
``ERROR_VARIABLE`` are not connected (no variable content).
|
| 103 |
+
The ``*_FILE`` and ``ECHO_*_VARIABLE`` options are not affected.
|
| 104 |
+
|
| 105 |
+
``OUTPUT_VARIABLE``, ``ERROR_VARIABLE``
|
| 106 |
+
The variable named will be set with the contents of the standard output
|
| 107 |
+
and standard error pipes, respectively. If the same variable is named
|
| 108 |
+
for both pipes their output will be merged in the order produced.
|
| 109 |
+
|
| 110 |
+
``ECHO_OUTPUT_VARIABLE``, ``ECHO_ERROR_VARIABLE``
|
| 111 |
+
.. versionadded:: 3.18
|
| 112 |
+
|
| 113 |
+
The standard output or standard error will not be exclusively redirected to
|
| 114 |
+
the specified variables.
|
| 115 |
+
|
| 116 |
+
The output will be duplicated into the specified variables and also onto
|
| 117 |
+
standard output or standard error analogous to the ``tee`` Unix command.
|
| 118 |
+
|
| 119 |
+
.. note::
|
| 120 |
+
If more than one ``OUTPUT_*`` or ``ERROR_*`` option is given for the
|
| 121 |
+
same pipe the precedence is *not specified*.
|
| 122 |
+
If no ``OUTPUT_*`` or ``ERROR_*`` options are given the output will
|
| 123 |
+
be shared with the corresponding pipes of the CMake process itself.
|
| 124 |
+
|
| 125 |
+
``COMMAND_ECHO <where>``
|
| 126 |
+
.. versionadded:: 3.15
|
| 127 |
+
|
| 128 |
+
The command being run will be echo'ed to ``<where>`` with ``<where>``
|
| 129 |
+
being set to one of ``STDERR``, ``STDOUT`` or ``NONE``.
|
| 130 |
+
See the :variable:`CMAKE_EXECUTE_PROCESS_COMMAND_ECHO` variable for a way
|
| 131 |
+
to control the default behavior when this option is not present.
|
| 132 |
+
|
| 133 |
+
``ENCODING <name>``
|
| 134 |
+
.. versionadded:: 3.8
|
| 135 |
+
|
| 136 |
+
On Windows, the encoding that is used to decode output from the process.
|
| 137 |
+
Ignored on other platforms.
|
| 138 |
+
Valid encoding names are:
|
| 139 |
+
|
| 140 |
+
``NONE``
|
| 141 |
+
Perform no decoding. This assumes that the process output is encoded
|
| 142 |
+
in the same way as CMake's internal encoding (UTF-8).
|
| 143 |
+
|
| 144 |
+
This was the default in CMake 3.14 and older.
|
| 145 |
+
|
| 146 |
+
``AUTO``
|
| 147 |
+
Use the current active console's codepage or if that isn't
|
| 148 |
+
available then use ANSI.
|
| 149 |
+
|
| 150 |
+
This was the default in CMake 3.15 through 3.30.
|
| 151 |
+
|
| 152 |
+
``ANSI``
|
| 153 |
+
Use the ANSI codepage.
|
| 154 |
+
|
| 155 |
+
``OEM``
|
| 156 |
+
Use the original equipment manufacturer (OEM) code page.
|
| 157 |
+
|
| 158 |
+
``UTF-8``
|
| 159 |
+
.. versionadded:: 3.11
|
| 160 |
+
|
| 161 |
+
Use the UTF-8 codepage.
|
| 162 |
+
|
| 163 |
+
This is the default. See policy :policy:`CMP0176`.
|
| 164 |
+
|
| 165 |
+
``UTF8``
|
| 166 |
+
Use the UTF-8 codepage. Use of this name is discouraged in favor
|
| 167 |
+
of ``UTF-8`` to match the
|
| 168 |
+
`UTF-8 RFC <https://datatracker.ietf.org/doc/html/rfc3629>`_
|
| 169 |
+
naming convention.
|
| 170 |
+
|
| 171 |
+
``COMMAND_ERROR_IS_FATAL <ANY|LAST>``
|
| 172 |
+
.. versionadded:: 3.19
|
| 173 |
+
|
| 174 |
+
The option following ``COMMAND_ERROR_IS_FATAL`` determines the behavior when
|
| 175 |
+
an error is encountered:
|
| 176 |
+
|
| 177 |
+
``ANY``
|
| 178 |
+
If any of the commands in the list of commands fail, the
|
| 179 |
+
``execute_process()`` command halts with an error.
|
| 180 |
+
|
| 181 |
+
``LAST``
|
| 182 |
+
If the last command in the list of commands fails, the
|
| 183 |
+
``execute_process()`` command halts with an error. Commands earlier in the
|
| 184 |
+
list will not cause a fatal error.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/list.rst
ADDED
|
@@ -0,0 +1,334 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
list
|
| 2 |
+
----
|
| 3 |
+
|
| 4 |
+
Operations on :ref:`semicolon-separated lists <CMake Language Lists>`.
|
| 5 |
+
|
| 6 |
+
Synopsis
|
| 7 |
+
^^^^^^^^
|
| 8 |
+
|
| 9 |
+
.. parsed-literal::
|
| 10 |
+
|
| 11 |
+
`Reading`_
|
| 12 |
+
list(`LENGTH`_ <list> <out-var>)
|
| 13 |
+
list(`GET`_ <list> <element index> [<index> ...] <out-var>)
|
| 14 |
+
list(`JOIN`_ <list> <glue> <out-var>)
|
| 15 |
+
list(`SUBLIST`_ <list> <begin> <length> <out-var>)
|
| 16 |
+
|
| 17 |
+
`Search`_
|
| 18 |
+
list(`FIND`_ <list> <value> <out-var>)
|
| 19 |
+
|
| 20 |
+
`Modification`_
|
| 21 |
+
list(`APPEND`_ <list> [<element>...])
|
| 22 |
+
list(`FILTER`_ <list> {INCLUDE | EXCLUDE} REGEX <regex>)
|
| 23 |
+
list(`INSERT`_ <list> <index> [<element>...])
|
| 24 |
+
list(`POP_BACK`_ <list> [<out-var>...])
|
| 25 |
+
list(`POP_FRONT`_ <list> [<out-var>...])
|
| 26 |
+
list(`PREPEND`_ <list> [<element>...])
|
| 27 |
+
list(`REMOVE_ITEM`_ <list> <value>...)
|
| 28 |
+
list(`REMOVE_AT`_ <list> <index>...)
|
| 29 |
+
list(`REMOVE_DUPLICATES`_ <list>)
|
| 30 |
+
list(`TRANSFORM`_ <list> <ACTION> [...])
|
| 31 |
+
|
| 32 |
+
`Ordering`_
|
| 33 |
+
list(`REVERSE`_ <list>)
|
| 34 |
+
list(`SORT`_ <list> [...])
|
| 35 |
+
|
| 36 |
+
Introduction
|
| 37 |
+
^^^^^^^^^^^^
|
| 38 |
+
|
| 39 |
+
The list subcommands :cref:`APPEND`, :cref:`INSERT`, :cref:`FILTER`,
|
| 40 |
+
:cref:`PREPEND`, :cref:`POP_BACK`, :cref:`POP_FRONT`, :cref:`REMOVE_AT`,
|
| 41 |
+
:cref:`REMOVE_ITEM`, :cref:`REMOVE_DUPLICATES`, :cref:`REVERSE` and
|
| 42 |
+
:cref:`SORT` may create new values for the list within the current CMake
|
| 43 |
+
variable scope. Similar to the :command:`set` command, the ``list`` command
|
| 44 |
+
creates new variable values in the current scope, even if the list itself is
|
| 45 |
+
actually defined in a parent scope. To propagate the results of these
|
| 46 |
+
operations upwards, use :command:`set` with ``PARENT_SCOPE``,
|
| 47 |
+
:command:`set` with ``CACHE INTERNAL``, or some other means of value
|
| 48 |
+
propagation.
|
| 49 |
+
|
| 50 |
+
.. note::
|
| 51 |
+
|
| 52 |
+
A list in cmake is a ``;`` separated group of strings. To create a
|
| 53 |
+
list, the :command:`set` command can be used. For example,
|
| 54 |
+
``set(var a b c d e)`` creates a list with ``a;b;c;d;e``, and
|
| 55 |
+
``set(var "a b c d e")`` creates a string or a list with one item in it.
|
| 56 |
+
(Note that macro arguments are not variables, and therefore cannot be used
|
| 57 |
+
in ``LIST`` commands.)
|
| 58 |
+
|
| 59 |
+
Individual elements may not contain an unequal number of ``[`` and ``]``
|
| 60 |
+
characters, and may not end in a backslash (``\``).
|
| 61 |
+
See :ref:`semicolon-separated lists <CMake Language Lists>` for details.
|
| 62 |
+
|
| 63 |
+
.. note::
|
| 64 |
+
|
| 65 |
+
When specifying index values, if ``<element index>`` is 0 or greater, it
|
| 66 |
+
is indexed from the beginning of the list, with 0 representing the
|
| 67 |
+
first list element. If ``<element index>`` is -1 or lesser, it is indexed
|
| 68 |
+
from the end of the list, with -1 representing the last list element.
|
| 69 |
+
Be careful when counting with negative indices: they do not start from
|
| 70 |
+
0. -0 is equivalent to 0, the first list element.
|
| 71 |
+
|
| 72 |
+
Reading
|
| 73 |
+
^^^^^^^
|
| 74 |
+
|
| 75 |
+
.. signature::
|
| 76 |
+
list(LENGTH <list> <output variable>)
|
| 77 |
+
|
| 78 |
+
Returns the list's length.
|
| 79 |
+
|
| 80 |
+
.. signature::
|
| 81 |
+
list(GET <list> <element index> [<element index> ...] <output variable>)
|
| 82 |
+
|
| 83 |
+
Returns the list of elements specified by indices from the list.
|
| 84 |
+
|
| 85 |
+
.. signature:: list(JOIN <list> <glue> <output variable>)
|
| 86 |
+
|
| 87 |
+
.. versionadded:: 3.12
|
| 88 |
+
|
| 89 |
+
Returns a string joining all list's elements using the glue string.
|
| 90 |
+
To join multiple strings, which are not part of a list,
|
| 91 |
+
use :command:`string(JOIN)`.
|
| 92 |
+
|
| 93 |
+
.. signature::
|
| 94 |
+
list(SUBLIST <list> <begin> <length> <output variable>)
|
| 95 |
+
|
| 96 |
+
.. versionadded:: 3.12
|
| 97 |
+
|
| 98 |
+
Returns a sublist of the given list.
|
| 99 |
+
If ``<length>`` is 0, an empty list will be returned.
|
| 100 |
+
If ``<length>`` is -1 or the list is smaller than ``<begin>+<length>`` then
|
| 101 |
+
the remaining elements of the list starting at ``<begin>`` will be returned.
|
| 102 |
+
|
| 103 |
+
Search
|
| 104 |
+
^^^^^^
|
| 105 |
+
|
| 106 |
+
.. signature::
|
| 107 |
+
list(FIND <list> <value> <output variable>)
|
| 108 |
+
|
| 109 |
+
Returns the index of the element specified in the list
|
| 110 |
+
or ``-1`` if it wasn't found.
|
| 111 |
+
|
| 112 |
+
Modification
|
| 113 |
+
^^^^^^^^^^^^
|
| 114 |
+
|
| 115 |
+
.. signature::
|
| 116 |
+
list(APPEND <list> [<element> ...])
|
| 117 |
+
|
| 118 |
+
Appends elements to the list. If no variable named ``<list>`` exists in the
|
| 119 |
+
current scope its value is treated as empty and the elements are appended to
|
| 120 |
+
that empty list.
|
| 121 |
+
|
| 122 |
+
.. signature::
|
| 123 |
+
list(FILTER <list> <INCLUDE|EXCLUDE> REGEX <regular_expression>)
|
| 124 |
+
|
| 125 |
+
.. versionadded:: 3.6
|
| 126 |
+
|
| 127 |
+
Includes or removes items from the list that match the mode's pattern.
|
| 128 |
+
In ``REGEX`` mode, items will be matched against the given regular expression.
|
| 129 |
+
|
| 130 |
+
For more information on regular expressions look under
|
| 131 |
+
:ref:`string(REGEX) <Regex Specification>`.
|
| 132 |
+
|
| 133 |
+
.. signature::
|
| 134 |
+
list(INSERT <list> <element_index> <element> [<element> ...])
|
| 135 |
+
|
| 136 |
+
Inserts elements to the list to the specified index. It is an
|
| 137 |
+
error to specify an out-of-range index. Valid indexes are 0 to `N`
|
| 138 |
+
where `N` is the length of the list, inclusive. An empty list
|
| 139 |
+
has length 0. If no variable named ``<list>`` exists in the
|
| 140 |
+
current scope its value is treated as empty and the elements are
|
| 141 |
+
inserted in that empty list.
|
| 142 |
+
|
| 143 |
+
.. signature::
|
| 144 |
+
list(POP_BACK <list> [<out-var>...])
|
| 145 |
+
|
| 146 |
+
.. versionadded:: 3.15
|
| 147 |
+
|
| 148 |
+
If no variable name is given, removes exactly one element. Otherwise,
|
| 149 |
+
with `N` variable names provided, assign the last `N` elements' values
|
| 150 |
+
to the given variables and then remove the last `N` values from
|
| 151 |
+
``<list>``.
|
| 152 |
+
|
| 153 |
+
.. signature::
|
| 154 |
+
list(POP_FRONT <list> [<out-var>...])
|
| 155 |
+
|
| 156 |
+
.. versionadded:: 3.15
|
| 157 |
+
|
| 158 |
+
If no variable name is given, removes exactly one element. Otherwise,
|
| 159 |
+
with `N` variable names provided, assign the first `N` elements' values
|
| 160 |
+
to the given variables and then remove the first `N` values from
|
| 161 |
+
``<list>``.
|
| 162 |
+
|
| 163 |
+
.. signature::
|
| 164 |
+
list(PREPEND <list> [<element> ...])
|
| 165 |
+
|
| 166 |
+
.. versionadded:: 3.15
|
| 167 |
+
|
| 168 |
+
Insert elements to the 0th position in the list. If no variable named
|
| 169 |
+
``<list>`` exists in the current scope its value is treated as empty and
|
| 170 |
+
the elements are prepended to that empty list.
|
| 171 |
+
|
| 172 |
+
.. signature::
|
| 173 |
+
list(REMOVE_ITEM <list> <value> [<value> ...])
|
| 174 |
+
|
| 175 |
+
Removes all instances of the given items from the list.
|
| 176 |
+
|
| 177 |
+
.. signature::
|
| 178 |
+
list(REMOVE_AT <list> <index> [<index> ...])
|
| 179 |
+
|
| 180 |
+
Removes items at given indices from the list.
|
| 181 |
+
|
| 182 |
+
.. signature::
|
| 183 |
+
list(REMOVE_DUPLICATES <list>)
|
| 184 |
+
|
| 185 |
+
Removes duplicated items in the list. The relative order of items
|
| 186 |
+
is preserved, but if duplicates are encountered,
|
| 187 |
+
only the first instance is preserved.
|
| 188 |
+
|
| 189 |
+
.. signature::
|
| 190 |
+
list(TRANSFORM <list> <ACTION> [<SELECTOR>]
|
| 191 |
+
[OUTPUT_VARIABLE <output variable>])
|
| 192 |
+
|
| 193 |
+
.. versionadded:: 3.12
|
| 194 |
+
|
| 195 |
+
Transforms the list by applying an ``<ACTION>`` to all or, by specifying a
|
| 196 |
+
``<SELECTOR>``, to the selected elements of the list, storing the result
|
| 197 |
+
in-place or in the specified output variable.
|
| 198 |
+
|
| 199 |
+
.. note::
|
| 200 |
+
|
| 201 |
+
The ``TRANSFORM`` sub-command does not change the number of elements in the
|
| 202 |
+
list. If a ``<SELECTOR>`` is specified, only some elements will be changed,
|
| 203 |
+
the other ones will remain the same as before the transformation.
|
| 204 |
+
|
| 205 |
+
``<ACTION>`` specifies the action to apply to the elements of the list.
|
| 206 |
+
The actions have exactly the same semantics as sub-commands of the
|
| 207 |
+
:command:`string` command. ``<ACTION>`` must be one of the following:
|
| 208 |
+
|
| 209 |
+
:command:`APPEND <string(APPEND)>`, :command:`PREPEND <string(PREPEND)>`
|
| 210 |
+
Append, prepend specified value to each element of the list.
|
| 211 |
+
|
| 212 |
+
.. signature::
|
| 213 |
+
list(TRANSFORM <list> (APPEND|PREPEND) <value> ...)
|
| 214 |
+
:target: TRANSFORM_APPEND
|
| 215 |
+
|
| 216 |
+
:command:`TOLOWER <string(TOLOWER)>`, :command:`TOUPPER <string(TOUPPER)>`
|
| 217 |
+
Convert each element of the list to lower, upper characters.
|
| 218 |
+
|
| 219 |
+
.. signature::
|
| 220 |
+
list(TRANSFORM <list> (TOLOWER|TOUPPER) ...)
|
| 221 |
+
:target: TRANSFORM_TOLOWER
|
| 222 |
+
|
| 223 |
+
:command:`STRIP <string(STRIP)>`
|
| 224 |
+
Remove leading and trailing spaces from each element of the list.
|
| 225 |
+
|
| 226 |
+
.. signature::
|
| 227 |
+
list(TRANSFORM <list> STRIP ...)
|
| 228 |
+
:target: TRANSFORM_STRIP
|
| 229 |
+
|
| 230 |
+
:command:`GENEX_STRIP <string(GENEX_STRIP)>`
|
| 231 |
+
Strip any
|
| 232 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`
|
| 233 |
+
from each element of the list.
|
| 234 |
+
|
| 235 |
+
.. signature::
|
| 236 |
+
list(TRANSFORM <list> GENEX_STRIP ...)
|
| 237 |
+
:target: TRANSFORM_GENEX_STRIP
|
| 238 |
+
|
| 239 |
+
:command:`REPLACE <string(REGEX REPLACE)>`:
|
| 240 |
+
Match the regular expression as many times as possible and substitute
|
| 241 |
+
the replacement expression for the match for each element of the list
|
| 242 |
+
(same semantic as :command:`string(REGEX REPLACE)`).
|
| 243 |
+
|
| 244 |
+
.. signature::
|
| 245 |
+
list(TRANSFORM <list> REPLACE <regular_expression>
|
| 246 |
+
<replace_expression> ...)
|
| 247 |
+
:target: TRANSFORM_REPLACE
|
| 248 |
+
|
| 249 |
+
``<SELECTOR>`` determines which elements of the list will be transformed.
|
| 250 |
+
Only one type of selector can be specified at a time.
|
| 251 |
+
When given, ``<SELECTOR>`` must be one of the following:
|
| 252 |
+
|
| 253 |
+
``AT``
|
| 254 |
+
Specify a list of indexes.
|
| 255 |
+
|
| 256 |
+
.. code-block:: cmake
|
| 257 |
+
|
| 258 |
+
list(TRANSFORM <list> <ACTION> AT <index> [<index> ...] ...)
|
| 259 |
+
|
| 260 |
+
``FOR``
|
| 261 |
+
Specify a range with, optionally,
|
| 262 |
+
an increment used to iterate over the range.
|
| 263 |
+
|
| 264 |
+
.. code-block:: cmake
|
| 265 |
+
|
| 266 |
+
list(TRANSFORM <list> <ACTION> FOR <start> <stop> [<step>] ...)
|
| 267 |
+
|
| 268 |
+
``REGEX``
|
| 269 |
+
Specify a regular expression.
|
| 270 |
+
Only elements matching the regular expression will be transformed.
|
| 271 |
+
|
| 272 |
+
.. code-block:: cmake
|
| 273 |
+
|
| 274 |
+
list(TRANSFORM <list> <ACTION> REGEX <regular_expression> ...)
|
| 275 |
+
|
| 276 |
+
|
| 277 |
+
Ordering
|
| 278 |
+
^^^^^^^^
|
| 279 |
+
|
| 280 |
+
.. signature::
|
| 281 |
+
list(REVERSE <list>)
|
| 282 |
+
|
| 283 |
+
Reverses the contents of the list in-place.
|
| 284 |
+
|
| 285 |
+
.. signature::
|
| 286 |
+
list(SORT <list> [COMPARE <compare>] [CASE <case>] [ORDER <order>])
|
| 287 |
+
|
| 288 |
+
Sorts the list in-place alphabetically.
|
| 289 |
+
|
| 290 |
+
.. versionadded:: 3.13
|
| 291 |
+
Added the ``COMPARE``, ``CASE``, and ``ORDER`` options.
|
| 292 |
+
|
| 293 |
+
.. versionadded:: 3.18
|
| 294 |
+
Added the ``COMPARE NATURAL`` option.
|
| 295 |
+
|
| 296 |
+
Use the ``COMPARE`` keyword to select the comparison method for sorting.
|
| 297 |
+
The ``<compare>`` option should be one of:
|
| 298 |
+
|
| 299 |
+
``STRING``
|
| 300 |
+
Sorts a list of strings alphabetically.
|
| 301 |
+
This is the default behavior if the ``COMPARE`` option is not given.
|
| 302 |
+
|
| 303 |
+
``FILE_BASENAME``
|
| 304 |
+
Sorts a list of pathnames of files by their basenames.
|
| 305 |
+
|
| 306 |
+
``NATURAL``
|
| 307 |
+
Sorts a list of strings using natural order
|
| 308 |
+
(see ``strverscmp(3)`` manual), i.e. such that contiguous digits
|
| 309 |
+
are compared as whole numbers.
|
| 310 |
+
For example: the following list `10.0 1.1 2.1 8.0 2.0 3.1`
|
| 311 |
+
will be sorted as `1.1 2.0 2.1 3.1 8.0 10.0` if the ``NATURAL``
|
| 312 |
+
comparison is selected where it will be sorted as
|
| 313 |
+
`1.1 10.0 2.0 2.1 3.1 8.0` with the ``STRING`` comparison.
|
| 314 |
+
|
| 315 |
+
Use the ``CASE`` keyword to select a case sensitive or case insensitive
|
| 316 |
+
sort mode. The ``<case>`` option should be one of:
|
| 317 |
+
|
| 318 |
+
``SENSITIVE``
|
| 319 |
+
List items are sorted in a case-sensitive manner.
|
| 320 |
+
This is the default behavior if the ``CASE`` option is not given.
|
| 321 |
+
|
| 322 |
+
``INSENSITIVE``
|
| 323 |
+
List items are sorted case insensitively. The order of
|
| 324 |
+
items which differ only by upper/lowercase is not specified.
|
| 325 |
+
|
| 326 |
+
To control the sort order, the ``ORDER`` keyword can be given.
|
| 327 |
+
The ``<order>`` option should be one of:
|
| 328 |
+
|
| 329 |
+
``ASCENDING``
|
| 330 |
+
Sorts the list in ascending order.
|
| 331 |
+
This is the default behavior when the ``ORDER`` option is not given.
|
| 332 |
+
|
| 333 |
+
``DESCENDING``
|
| 334 |
+
Sorts the list in descending order.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/set_property.rst
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
set_property
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
Set a named property in a given scope.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
set_property(<GLOBAL |
|
| 9 |
+
DIRECTORY [<dir>] |
|
| 10 |
+
TARGET [<target1> ...] |
|
| 11 |
+
SOURCE [<src1> ...]
|
| 12 |
+
[DIRECTORY <dirs> ...]
|
| 13 |
+
[TARGET_DIRECTORY <targets> ...] |
|
| 14 |
+
INSTALL [<file1> ...] |
|
| 15 |
+
TEST [<test1> ...]
|
| 16 |
+
[DIRECTORY <dir>] |
|
| 17 |
+
CACHE [<entry1> ...] >
|
| 18 |
+
[APPEND] [APPEND_STRING]
|
| 19 |
+
PROPERTY <name> [<value1> ...])
|
| 20 |
+
|
| 21 |
+
Sets one property on zero or more objects of a scope.
|
| 22 |
+
|
| 23 |
+
The first argument determines the scope in which the property is set.
|
| 24 |
+
It must be one of the following:
|
| 25 |
+
|
| 26 |
+
``GLOBAL``
|
| 27 |
+
Scope is unique and does not accept a name.
|
| 28 |
+
|
| 29 |
+
``DIRECTORY``
|
| 30 |
+
Scope defaults to the current directory but other directories
|
| 31 |
+
(already processed by CMake) may be named by full or relative path.
|
| 32 |
+
Relative paths are treated as relative to the current source directory.
|
| 33 |
+
See also the :command:`set_directory_properties` command.
|
| 34 |
+
|
| 35 |
+
.. versionadded:: 3.19
|
| 36 |
+
``<dir>`` may reference a binary directory.
|
| 37 |
+
|
| 38 |
+
``TARGET``
|
| 39 |
+
Scope may name zero or more existing targets.
|
| 40 |
+
See also the :command:`set_target_properties` command.
|
| 41 |
+
|
| 42 |
+
:ref:`Alias Targets` do not support setting target properties.
|
| 43 |
+
|
| 44 |
+
``SOURCE``
|
| 45 |
+
Scope may name zero or more source files. By default, source file properties
|
| 46 |
+
are only visible to targets added in the same directory (``CMakeLists.txt``).
|
| 47 |
+
|
| 48 |
+
.. versionadded:: 3.18
|
| 49 |
+
Visibility can be set in other directory scopes using one or both of the
|
| 50 |
+
following sub-options:
|
| 51 |
+
|
| 52 |
+
``DIRECTORY <dirs>...``
|
| 53 |
+
The source file property will be set in each of the ``<dirs>``
|
| 54 |
+
directories' scopes. CMake must already know about
|
| 55 |
+
each of these directories, either by having added them through a call to
|
| 56 |
+
:command:`add_subdirectory` or it being the top level source directory.
|
| 57 |
+
Relative paths are treated as relative to the current source directory.
|
| 58 |
+
|
| 59 |
+
.. versionadded:: 3.19
|
| 60 |
+
``<dirs>`` may reference a binary directory.
|
| 61 |
+
|
| 62 |
+
``TARGET_DIRECTORY <targets>...``
|
| 63 |
+
The source file property will be set in each of the directory scopes
|
| 64 |
+
where any of the specified ``<targets>`` were created (the ``<targets>``
|
| 65 |
+
must therefore already exist).
|
| 66 |
+
|
| 67 |
+
See also the :command:`set_source_files_properties` command.
|
| 68 |
+
|
| 69 |
+
``INSTALL``
|
| 70 |
+
.. versionadded:: 3.1
|
| 71 |
+
|
| 72 |
+
Scope may name zero or more installed file paths.
|
| 73 |
+
These are made available to CPack to influence deployment.
|
| 74 |
+
|
| 75 |
+
Both the property key and value may use generator expressions.
|
| 76 |
+
Specific properties may apply to installed files and/or directories.
|
| 77 |
+
|
| 78 |
+
Path components have to be separated by forward slashes,
|
| 79 |
+
must be normalized and are case sensitive.
|
| 80 |
+
|
| 81 |
+
To reference the installation prefix itself with a relative path use ``.``.
|
| 82 |
+
|
| 83 |
+
Currently installed file properties are only defined for
|
| 84 |
+
the WIX generator where the given paths are relative
|
| 85 |
+
to the installation prefix.
|
| 86 |
+
|
| 87 |
+
``TEST``
|
| 88 |
+
Scope is limited to the directory the command is called in. It may name zero
|
| 89 |
+
or more existing tests. See also command :command:`set_tests_properties`.
|
| 90 |
+
|
| 91 |
+
Test property values may be specified using
|
| 92 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`
|
| 93 |
+
for tests created by the :command:`add_test(NAME)` signature.
|
| 94 |
+
|
| 95 |
+
.. versionadded:: 3.28
|
| 96 |
+
|
| 97 |
+
Visibility can be set in other directory scopes using the following sub-option:
|
| 98 |
+
|
| 99 |
+
``DIRECTORY <dir>``
|
| 100 |
+
The test property will be set in the ``<dir>`` directory's scope. CMake must
|
| 101 |
+
already know about this directory, either by having added it through a call
|
| 102 |
+
to :command:`add_subdirectory` or it being the top level source directory.
|
| 103 |
+
Relative paths are treated as relative to the current source directory.
|
| 104 |
+
``<dir>`` may reference a binary directory.
|
| 105 |
+
|
| 106 |
+
``CACHE``
|
| 107 |
+
Scope must name zero or more existing cache entries.
|
| 108 |
+
|
| 109 |
+
The required ``PROPERTY`` option is immediately followed by the name of
|
| 110 |
+
the property to set. Remaining arguments are used to compose the
|
| 111 |
+
property value in the form of a semicolon-separated list.
|
| 112 |
+
|
| 113 |
+
If the ``APPEND`` option is given the list is appended to any existing
|
| 114 |
+
property value (except that empty values are ignored and not appended).
|
| 115 |
+
If the ``APPEND_STRING`` option is given the string is
|
| 116 |
+
appended to any existing property value as string, i.e. it results in a
|
| 117 |
+
longer string and not a list of strings. When using ``APPEND`` or
|
| 118 |
+
``APPEND_STRING`` with a property defined to support ``INHERITED``
|
| 119 |
+
behavior (see :command:`define_property`), no inheriting occurs when
|
| 120 |
+
finding the initial value to append to. If the property is not already
|
| 121 |
+
directly set in the nominated scope, the command will behave as though
|
| 122 |
+
``APPEND`` or ``APPEND_STRING`` had not been given.
|
| 123 |
+
|
| 124 |
+
.. note::
|
| 125 |
+
|
| 126 |
+
The :prop_sf:`GENERATED` source file property may be globally visible.
|
| 127 |
+
See its documentation for details.
|
| 128 |
+
|
| 129 |
+
See Also
|
| 130 |
+
^^^^^^^^
|
| 131 |
+
|
| 132 |
+
* :command:`define_property`
|
| 133 |
+
* :command:`get_property`
|
| 134 |
+
* The :manual:`cmake-properties(7)` manual for a list of properties
|
| 135 |
+
in each scope.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/target_link_libraries.rst
ADDED
|
@@ -0,0 +1,432 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
target_link_libraries
|
| 2 |
+
---------------------
|
| 3 |
+
|
| 4 |
+
.. only:: html
|
| 5 |
+
|
| 6 |
+
.. contents::
|
| 7 |
+
|
| 8 |
+
Specify libraries or flags to use when linking a given target and/or
|
| 9 |
+
its dependents. :ref:`Usage requirements <Target Usage Requirements>`
|
| 10 |
+
from linked library targets will be propagated. Usage requirements
|
| 11 |
+
of a target's dependencies affect compilation of its own sources.
|
| 12 |
+
|
| 13 |
+
Overview
|
| 14 |
+
^^^^^^^^
|
| 15 |
+
|
| 16 |
+
This command has several signatures as detailed in subsections below.
|
| 17 |
+
All of them have the general form
|
| 18 |
+
|
| 19 |
+
.. code-block:: cmake
|
| 20 |
+
|
| 21 |
+
target_link_libraries(<target> ... <item>... ...)
|
| 22 |
+
|
| 23 |
+
The named ``<target>`` must have been created by a command such as
|
| 24 |
+
:command:`add_executable` or :command:`add_library` and must not be an
|
| 25 |
+
:ref:`ALIAS target <Alias Targets>`. If policy :policy:`CMP0079` is not
|
| 26 |
+
set to ``NEW`` then the target must have been created in the current
|
| 27 |
+
directory. Repeated calls for the same ``<target>`` append items in
|
| 28 |
+
the order called.
|
| 29 |
+
|
| 30 |
+
.. versionadded:: 3.13
|
| 31 |
+
The ``<target>`` doesn't have to be defined in the same directory as the
|
| 32 |
+
``target_link_libraries`` call.
|
| 33 |
+
|
| 34 |
+
Each ``<item>`` may be:
|
| 35 |
+
|
| 36 |
+
* **A library target name**: The generated link line will have the
|
| 37 |
+
full path to the linkable library file associated with the target.
|
| 38 |
+
The buildsystem will have a dependency to re-link ``<target>`` if
|
| 39 |
+
the library file changes.
|
| 40 |
+
|
| 41 |
+
The named target must be created by :command:`add_library` within
|
| 42 |
+
the project or as an :ref:`IMPORTED library <Imported Targets>`.
|
| 43 |
+
If it is created within the project an ordering dependency will
|
| 44 |
+
automatically be added in the build system to make sure the named
|
| 45 |
+
library target is up-to-date before the ``<target>`` links.
|
| 46 |
+
|
| 47 |
+
If an imported library has the :prop_tgt:`IMPORTED_NO_SONAME`
|
| 48 |
+
target property set, CMake may ask the linker to search for
|
| 49 |
+
the library instead of using the full path
|
| 50 |
+
(e.g. ``/usr/lib/libfoo.so`` becomes ``-lfoo``).
|
| 51 |
+
|
| 52 |
+
The full path to the target's artifact will be quoted/escaped for
|
| 53 |
+
the shell automatically.
|
| 54 |
+
|
| 55 |
+
* **A full path to a library file**: The generated link line will
|
| 56 |
+
normally preserve the full path to the file. The buildsystem will
|
| 57 |
+
have a dependency to re-link ``<target>`` if the library file changes.
|
| 58 |
+
|
| 59 |
+
There are some cases where CMake may ask the linker to search for
|
| 60 |
+
the library (e.g. ``/usr/lib/libfoo.so`` becomes ``-lfoo``), such
|
| 61 |
+
as when a shared library is detected to have no ``SONAME`` field.
|
| 62 |
+
See policy :policy:`CMP0060` for discussion of another case.
|
| 63 |
+
|
| 64 |
+
If the library file is in a macOS framework, the ``Headers`` directory
|
| 65 |
+
of the framework will also be processed as a
|
| 66 |
+
:ref:`usage requirement <Target Usage Requirements>`. This has the same
|
| 67 |
+
effect as passing the framework directory as an include directory.
|
| 68 |
+
|
| 69 |
+
.. versionadded:: 3.28
|
| 70 |
+
|
| 71 |
+
The library file may point to a ``.xcframework`` folder on Apple platforms.
|
| 72 |
+
If it does, the target will get the selected library's ``Headers``
|
| 73 |
+
directory as a usage requirement.
|
| 74 |
+
|
| 75 |
+
.. versionadded:: 3.8
|
| 76 |
+
On :ref:`Visual Studio Generators` for VS 2010 and above, library files
|
| 77 |
+
ending in ``.targets`` will be treated as MSBuild targets files and
|
| 78 |
+
imported into generated project files. This is not supported by other
|
| 79 |
+
generators.
|
| 80 |
+
|
| 81 |
+
The full path to the library file will be quoted/escaped for
|
| 82 |
+
the shell automatically.
|
| 83 |
+
|
| 84 |
+
* **A plain library name**: The generated link line will ask the linker
|
| 85 |
+
to search for the library (e.g. ``foo`` becomes ``-lfoo`` or ``foo.lib``).
|
| 86 |
+
|
| 87 |
+
The library name/flag is treated as a command-line string fragment and
|
| 88 |
+
will be used with no extra quoting or escaping.
|
| 89 |
+
|
| 90 |
+
* **A link flag**: Item names starting with ``-``, but not ``-l`` or
|
| 91 |
+
``-framework``, are treated as linker flags. Note that such flags will
|
| 92 |
+
be treated like any other library link item for purposes of transitive
|
| 93 |
+
dependencies, so they are generally safe to specify only as private link
|
| 94 |
+
items that will not propagate to dependents.
|
| 95 |
+
|
| 96 |
+
Link flags specified here are inserted into the link command in the same
|
| 97 |
+
place as the link libraries. This might not be correct, depending on
|
| 98 |
+
the linker. Use the :prop_tgt:`LINK_OPTIONS` target property or
|
| 99 |
+
:command:`target_link_options` command to add link
|
| 100 |
+
flags explicitly. The flags will then be placed at the toolchain-defined
|
| 101 |
+
flag position in the link command.
|
| 102 |
+
|
| 103 |
+
.. versionadded:: 3.13
|
| 104 |
+
:prop_tgt:`LINK_OPTIONS` target property and :command:`target_link_options`
|
| 105 |
+
command. For earlier versions of CMake, use :prop_tgt:`LINK_FLAGS`
|
| 106 |
+
property instead.
|
| 107 |
+
|
| 108 |
+
The link flag is treated as a command-line string fragment and
|
| 109 |
+
will be used with no extra quoting or escaping.
|
| 110 |
+
|
| 111 |
+
* **A generator expression**: A ``$<...>`` :manual:`generator expression
|
| 112 |
+
<cmake-generator-expressions(7)>` may evaluate to any of the above
|
| 113 |
+
items or to a :ref:`semicolon-separated list <CMake Language Lists>` of them.
|
| 114 |
+
If the ``...`` contains any ``;`` characters, e.g. after evaluation
|
| 115 |
+
of a ``${list}`` variable, be sure to use an explicitly quoted
|
| 116 |
+
argument ``"$<...>"`` so that this command receives it as a
|
| 117 |
+
single ``<item>``.
|
| 118 |
+
|
| 119 |
+
Additionally, a generator expression may be used as a fragment of
|
| 120 |
+
any of the above items, e.g. ``foo$<1:_d>``.
|
| 121 |
+
|
| 122 |
+
Note that generator expressions will not be used in OLD handling of
|
| 123 |
+
policy :policy:`CMP0003` or policy :policy:`CMP0004`.
|
| 124 |
+
|
| 125 |
+
* A ``debug``, ``optimized``, or ``general`` keyword immediately followed
|
| 126 |
+
by another ``<item>``. The item following such a keyword will be used
|
| 127 |
+
only for the corresponding build configuration. The ``debug`` keyword
|
| 128 |
+
corresponds to the ``Debug`` configuration (or to configurations named
|
| 129 |
+
in the :prop_gbl:`DEBUG_CONFIGURATIONS` global property if it is set).
|
| 130 |
+
The ``optimized`` keyword corresponds to all other configurations. The
|
| 131 |
+
``general`` keyword corresponds to all configurations, and is purely
|
| 132 |
+
optional. Higher granularity may be achieved for per-configuration
|
| 133 |
+
rules by creating and linking to
|
| 134 |
+
:ref:`IMPORTED library targets <Imported Targets>`.
|
| 135 |
+
These keywords are interpreted immediately by this command and therefore
|
| 136 |
+
have no special meaning when produced by a generator expression.
|
| 137 |
+
|
| 138 |
+
Items containing ``::``, such as ``Foo::Bar``, are assumed to be
|
| 139 |
+
:ref:`IMPORTED <Imported Targets>` or :ref:`ALIAS <Alias Targets>` library
|
| 140 |
+
target names and will cause an error if no such target exists.
|
| 141 |
+
See policy :policy:`CMP0028`.
|
| 142 |
+
|
| 143 |
+
See the :variable:`CMAKE_LINK_LIBRARIES_STRATEGY` variable and
|
| 144 |
+
corresponding :prop_tgt:`LINK_LIBRARIES_STRATEGY` target property
|
| 145 |
+
for details on how CMake orders direct link dependencies on linker
|
| 146 |
+
command lines.
|
| 147 |
+
|
| 148 |
+
See the :manual:`cmake-buildsystem(7)` manual for more on defining
|
| 149 |
+
buildsystem properties.
|
| 150 |
+
|
| 151 |
+
Libraries for a Target and/or its Dependents
|
| 152 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 153 |
+
|
| 154 |
+
.. code-block:: cmake
|
| 155 |
+
|
| 156 |
+
target_link_libraries(<target>
|
| 157 |
+
<PRIVATE|PUBLIC|INTERFACE> <item>...
|
| 158 |
+
[<PRIVATE|PUBLIC|INTERFACE> <item>...]...)
|
| 159 |
+
|
| 160 |
+
The ``PUBLIC``, ``PRIVATE`` and ``INTERFACE``
|
| 161 |
+
:ref:`scope <Target Command Scope>` keywords can be used to
|
| 162 |
+
specify both the link dependencies and the link interface in one command.
|
| 163 |
+
|
| 164 |
+
Libraries and targets following ``PUBLIC`` are linked to, and are made
|
| 165 |
+
part of the link interface. Libraries and targets following ``PRIVATE``
|
| 166 |
+
are linked to, but are not made part of the link interface. Libraries
|
| 167 |
+
following ``INTERFACE`` are appended to the link interface and are not
|
| 168 |
+
used for linking ``<target>``.
|
| 169 |
+
|
| 170 |
+
Libraries for both a Target and its Dependents
|
| 171 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 172 |
+
|
| 173 |
+
.. code-block:: cmake
|
| 174 |
+
|
| 175 |
+
target_link_libraries(<target> <item>...)
|
| 176 |
+
|
| 177 |
+
Library dependencies are transitive by default with this signature.
|
| 178 |
+
When this target is linked into another target then the libraries
|
| 179 |
+
linked to this target will appear on the link line for the other
|
| 180 |
+
target too. This transitive "link interface" is stored in the
|
| 181 |
+
:prop_tgt:`INTERFACE_LINK_LIBRARIES` target property and may be overridden
|
| 182 |
+
by setting the property directly. When :policy:`CMP0022` is not set to
|
| 183 |
+
``NEW``, transitive linking is built in but may be overridden by the
|
| 184 |
+
:prop_tgt:`LINK_INTERFACE_LIBRARIES` property. Calls to other signatures
|
| 185 |
+
of this command may set the property making any libraries linked
|
| 186 |
+
exclusively by this signature private.
|
| 187 |
+
|
| 188 |
+
Libraries for a Target and/or its Dependents (Legacy)
|
| 189 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 190 |
+
|
| 191 |
+
.. code-block:: cmake
|
| 192 |
+
|
| 193 |
+
target_link_libraries(<target>
|
| 194 |
+
<LINK_PRIVATE|LINK_PUBLIC> <lib>...
|
| 195 |
+
[<LINK_PRIVATE|LINK_PUBLIC> <lib>...]...)
|
| 196 |
+
|
| 197 |
+
The ``LINK_PUBLIC`` and ``LINK_PRIVATE`` modes can be used to specify both
|
| 198 |
+
the link dependencies and the link interface in one command.
|
| 199 |
+
|
| 200 |
+
This signature is for compatibility only. Prefer the ``PUBLIC`` or
|
| 201 |
+
``PRIVATE`` keywords instead.
|
| 202 |
+
|
| 203 |
+
Libraries and targets following ``LINK_PUBLIC`` are linked to, and are
|
| 204 |
+
made part of the :prop_tgt:`INTERFACE_LINK_LIBRARIES`. If policy
|
| 205 |
+
:policy:`CMP0022` is not ``NEW``, they are also made part of the
|
| 206 |
+
:prop_tgt:`LINK_INTERFACE_LIBRARIES`. Libraries and targets following
|
| 207 |
+
``LINK_PRIVATE`` are linked to, but are not made part of the
|
| 208 |
+
:prop_tgt:`INTERFACE_LINK_LIBRARIES` (or :prop_tgt:`LINK_INTERFACE_LIBRARIES`).
|
| 209 |
+
|
| 210 |
+
Libraries for Dependents Only (Legacy)
|
| 211 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 212 |
+
|
| 213 |
+
.. code-block:: cmake
|
| 214 |
+
|
| 215 |
+
target_link_libraries(<target> LINK_INTERFACE_LIBRARIES <item>...)
|
| 216 |
+
|
| 217 |
+
The ``LINK_INTERFACE_LIBRARIES`` mode appends the libraries to the
|
| 218 |
+
:prop_tgt:`INTERFACE_LINK_LIBRARIES` target property instead of using them
|
| 219 |
+
for linking. If policy :policy:`CMP0022` is not ``NEW``, then this mode
|
| 220 |
+
also appends libraries to the :prop_tgt:`LINK_INTERFACE_LIBRARIES` and its
|
| 221 |
+
per-configuration equivalent.
|
| 222 |
+
|
| 223 |
+
This signature is for compatibility only. Prefer the ``INTERFACE`` mode
|
| 224 |
+
instead.
|
| 225 |
+
|
| 226 |
+
Libraries specified as ``debug`` are wrapped in a generator expression to
|
| 227 |
+
correspond to debug builds. If policy :policy:`CMP0022` is
|
| 228 |
+
not ``NEW``, the libraries are also appended to the
|
| 229 |
+
:prop_tgt:`LINK_INTERFACE_LIBRARIES_DEBUG <LINK_INTERFACE_LIBRARIES_<CONFIG>>`
|
| 230 |
+
property (or to the properties corresponding to configurations listed in
|
| 231 |
+
the :prop_gbl:`DEBUG_CONFIGURATIONS` global property if it is set).
|
| 232 |
+
Libraries specified as ``optimized`` are appended to the
|
| 233 |
+
:prop_tgt:`INTERFACE_LINK_LIBRARIES` property. If policy :policy:`CMP0022`
|
| 234 |
+
is not ``NEW``, they are also appended to the
|
| 235 |
+
:prop_tgt:`LINK_INTERFACE_LIBRARIES` property. Libraries specified as
|
| 236 |
+
``general`` (or without any keyword) are treated as if specified for both
|
| 237 |
+
``debug`` and ``optimized``.
|
| 238 |
+
|
| 239 |
+
Linking Object Libraries
|
| 240 |
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
| 241 |
+
|
| 242 |
+
.. versionadded:: 3.12
|
| 243 |
+
|
| 244 |
+
:ref:`Object Libraries` may be used as the ``<target>`` (first) argument
|
| 245 |
+
of ``target_link_libraries`` to specify dependencies of their sources
|
| 246 |
+
on other libraries. For example, the code
|
| 247 |
+
|
| 248 |
+
.. code-block:: cmake
|
| 249 |
+
|
| 250 |
+
add_library(A SHARED a.c)
|
| 251 |
+
target_compile_definitions(A PUBLIC A)
|
| 252 |
+
|
| 253 |
+
add_library(obj OBJECT obj.c)
|
| 254 |
+
target_compile_definitions(obj PUBLIC OBJ)
|
| 255 |
+
target_link_libraries(obj PUBLIC A)
|
| 256 |
+
|
| 257 |
+
compiles ``obj.c`` with ``-DA -DOBJ`` and establishes usage requirements
|
| 258 |
+
for ``obj`` that propagate to its dependents.
|
| 259 |
+
|
| 260 |
+
Normal libraries and executables may link to :ref:`Object Libraries`
|
| 261 |
+
to get their objects and usage requirements. Continuing the above
|
| 262 |
+
example, the code
|
| 263 |
+
|
| 264 |
+
.. code-block:: cmake
|
| 265 |
+
|
| 266 |
+
add_library(B SHARED b.c)
|
| 267 |
+
target_link_libraries(B PUBLIC obj)
|
| 268 |
+
|
| 269 |
+
compiles ``b.c`` with ``-DA -DOBJ``, creates shared library ``B``
|
| 270 |
+
with object files from ``b.c`` and ``obj.c``, and links ``B`` to ``A``.
|
| 271 |
+
Furthermore, the code
|
| 272 |
+
|
| 273 |
+
.. code-block:: cmake
|
| 274 |
+
|
| 275 |
+
add_executable(main main.c)
|
| 276 |
+
target_link_libraries(main B)
|
| 277 |
+
|
| 278 |
+
compiles ``main.c`` with ``-DA -DOBJ`` and links executable ``main``
|
| 279 |
+
to ``B`` and ``A``. The object library's usage requirements are
|
| 280 |
+
propagated transitively through ``B``, but its object files are not.
|
| 281 |
+
|
| 282 |
+
:ref:`Object Libraries` may "link" to other object libraries to get
|
| 283 |
+
usage requirements, but since they do not have a link step nothing
|
| 284 |
+
is done with their object files. Continuing from the above example,
|
| 285 |
+
the code:
|
| 286 |
+
|
| 287 |
+
.. code-block:: cmake
|
| 288 |
+
|
| 289 |
+
add_library(obj2 OBJECT obj2.c)
|
| 290 |
+
target_link_libraries(obj2 PUBLIC obj)
|
| 291 |
+
|
| 292 |
+
add_executable(main2 main2.c)
|
| 293 |
+
target_link_libraries(main2 obj2)
|
| 294 |
+
|
| 295 |
+
compiles ``obj2.c`` with ``-DA -DOBJ``, creates executable ``main2``
|
| 296 |
+
with object files from ``main2.c`` and ``obj2.c``, and links ``main2``
|
| 297 |
+
to ``A``.
|
| 298 |
+
|
| 299 |
+
In other words, when :ref:`Object Libraries` appear in a target's
|
| 300 |
+
:prop_tgt:`INTERFACE_LINK_LIBRARIES` property they will be
|
| 301 |
+
treated as :ref:`Interface Libraries`, but when they appear in
|
| 302 |
+
a target's :prop_tgt:`LINK_LIBRARIES` property their object files
|
| 303 |
+
will be included in the link too.
|
| 304 |
+
|
| 305 |
+
.. _`Linking Object Libraries via $<TARGET_OBJECTS>`:
|
| 306 |
+
|
| 307 |
+
Linking Object Libraries via ``$<TARGET_OBJECTS>``
|
| 308 |
+
""""""""""""""""""""""""""""""""""""""""""""""""""
|
| 309 |
+
|
| 310 |
+
.. versionadded:: 3.21
|
| 311 |
+
|
| 312 |
+
The object files associated with an object library may be referenced
|
| 313 |
+
by the :genex:`$<TARGET_OBJECTS>` generator expression. Such object
|
| 314 |
+
files are placed on the link line *before* all libraries, regardless
|
| 315 |
+
of their relative order. Additionally, an ordering dependency will be
|
| 316 |
+
added to the build system to make sure the object library is up-to-date
|
| 317 |
+
before the dependent target links. For example, the code
|
| 318 |
+
|
| 319 |
+
.. code-block:: cmake
|
| 320 |
+
|
| 321 |
+
add_library(obj3 OBJECT obj3.c)
|
| 322 |
+
target_compile_definitions(obj3 PUBLIC OBJ3)
|
| 323 |
+
|
| 324 |
+
add_executable(main3 main3.c)
|
| 325 |
+
target_link_libraries(main3 PRIVATE a3 $<TARGET_OBJECTS:obj3> b3)
|
| 326 |
+
|
| 327 |
+
links executable ``main3`` with object files from ``main3.c``
|
| 328 |
+
and ``obj3.c`` followed by the ``a3`` and ``b3`` libraries.
|
| 329 |
+
``main3.c`` is *not* compiled with usage requirements from ``obj3``,
|
| 330 |
+
such as ``-DOBJ3``.
|
| 331 |
+
|
| 332 |
+
This approach can be used to achieve transitive inclusion of object
|
| 333 |
+
files in link lines as usage requirements. Continuing the above
|
| 334 |
+
example, the code
|
| 335 |
+
|
| 336 |
+
.. code-block:: cmake
|
| 337 |
+
|
| 338 |
+
add_library(iface_obj3 INTERFACE)
|
| 339 |
+
target_link_libraries(iface_obj3 INTERFACE obj3 $<TARGET_OBJECTS:obj3>)
|
| 340 |
+
|
| 341 |
+
creates an interface library ``iface_obj3`` that forwards the ``obj3``
|
| 342 |
+
usage requirements and adds the ``obj3`` object files to dependents'
|
| 343 |
+
link lines. The code
|
| 344 |
+
|
| 345 |
+
.. code-block:: cmake
|
| 346 |
+
|
| 347 |
+
add_executable(use_obj3 use_obj3.c)
|
| 348 |
+
target_link_libraries(use_obj3 PRIVATE iface_obj3)
|
| 349 |
+
|
| 350 |
+
compiles ``use_obj3.c`` with ``-DOBJ3`` and links executable ``use_obj3``
|
| 351 |
+
with object files from ``use_obj3.c`` and ``obj3.c``.
|
| 352 |
+
|
| 353 |
+
This also works transitively through a static library. Since a static
|
| 354 |
+
library does not link, it does not consume the object files from
|
| 355 |
+
object libraries referenced this way. Instead, the object files
|
| 356 |
+
become transitive link dependencies of the static library.
|
| 357 |
+
Continuing the above example, the code
|
| 358 |
+
|
| 359 |
+
.. code-block:: cmake
|
| 360 |
+
|
| 361 |
+
add_library(static3 STATIC static3.c)
|
| 362 |
+
target_link_libraries(static3 PRIVATE iface_obj3)
|
| 363 |
+
|
| 364 |
+
add_executable(use_static3 use_static3.c)
|
| 365 |
+
target_link_libraries(use_static3 PRIVATE static3)
|
| 366 |
+
|
| 367 |
+
compiles ``static3.c`` with ``-DOBJ3`` and creates ``libstatic3.a``
|
| 368 |
+
using only its own object file. ``use_static3.c`` is compiled *without*
|
| 369 |
+
``-DOBJ3`` because the usage requirement is not transitive through
|
| 370 |
+
the private dependency of ``static3``. However, the link dependencies
|
| 371 |
+
of ``static3`` are propagated, including the ``iface_obj3`` reference
|
| 372 |
+
to ``$<TARGET_OBJECTS:obj3>``. The ``use_static3`` executable is
|
| 373 |
+
created with object files from ``use_static3.c`` and ``obj3.c``, and
|
| 374 |
+
linked to library ``libstatic3.a``.
|
| 375 |
+
|
| 376 |
+
When using this approach, it is the project's responsibility to avoid
|
| 377 |
+
linking multiple dependent binaries to ``iface_obj3``, because they will
|
| 378 |
+
all get the ``obj3`` object files on their link lines.
|
| 379 |
+
|
| 380 |
+
.. note::
|
| 381 |
+
|
| 382 |
+
Referencing :genex:`$<TARGET_OBJECTS>` in ``target_link_libraries``
|
| 383 |
+
calls worked in versions of CMake prior to 3.21 for some cases,
|
| 384 |
+
but was not fully supported:
|
| 385 |
+
|
| 386 |
+
* It did not place the object files before libraries on link lines.
|
| 387 |
+
* It did not add an ordering dependency on the object library.
|
| 388 |
+
* It did not work in Xcode with multiple architectures.
|
| 389 |
+
|
| 390 |
+
Cyclic Dependencies of Static Libraries
|
| 391 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 392 |
+
|
| 393 |
+
The library dependency graph is normally acyclic (a DAG), but in the case
|
| 394 |
+
of mutually-dependent ``STATIC`` libraries CMake allows the graph to
|
| 395 |
+
contain cycles (strongly connected components). When another target links
|
| 396 |
+
to one of the libraries, CMake repeats the entire connected component.
|
| 397 |
+
For example, the code
|
| 398 |
+
|
| 399 |
+
.. code-block:: cmake
|
| 400 |
+
|
| 401 |
+
add_library(A STATIC a.c)
|
| 402 |
+
add_library(B STATIC b.c)
|
| 403 |
+
target_link_libraries(A B)
|
| 404 |
+
target_link_libraries(B A)
|
| 405 |
+
add_executable(main main.c)
|
| 406 |
+
target_link_libraries(main A)
|
| 407 |
+
|
| 408 |
+
links ``main`` to ``A B A B``. While one repetition is usually
|
| 409 |
+
sufficient, pathological object file and symbol arrangements can require
|
| 410 |
+
more. One may handle such cases by using the
|
| 411 |
+
:prop_tgt:`LINK_INTERFACE_MULTIPLICITY` target property or by manually
|
| 412 |
+
repeating the component in the last ``target_link_libraries`` call.
|
| 413 |
+
However, if two archives are really so interdependent they should probably
|
| 414 |
+
be combined into a single archive, perhaps by using :ref:`Object Libraries`.
|
| 415 |
+
|
| 416 |
+
Creating Relocatable Packages
|
| 417 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 418 |
+
|
| 419 |
+
.. |INTERFACE_PROPERTY_LINK| replace:: :prop_tgt:`INTERFACE_LINK_LIBRARIES`
|
| 420 |
+
.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt
|
| 421 |
+
|
| 422 |
+
See Also
|
| 423 |
+
^^^^^^^^
|
| 424 |
+
|
| 425 |
+
* :command:`target_compile_definitions`
|
| 426 |
+
* :command:`target_compile_features`
|
| 427 |
+
* :command:`target_compile_options`
|
| 428 |
+
* :command:`target_include_directories`
|
| 429 |
+
* :command:`target_link_directories`
|
| 430 |
+
* :command:`target_link_options`
|
| 431 |
+
* :command:`target_precompile_headers`
|
| 432 |
+
* :command:`target_sources`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/try_run.rst
ADDED
|
@@ -0,0 +1,165 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
try_run
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
.. only:: html
|
| 5 |
+
|
| 6 |
+
.. contents::
|
| 7 |
+
|
| 8 |
+
Try compiling and then running some code.
|
| 9 |
+
|
| 10 |
+
Try Compiling and Running Source Files
|
| 11 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 12 |
+
|
| 13 |
+
.. code-block:: cmake
|
| 14 |
+
|
| 15 |
+
try_run(<runResultVar> <compileResultVar>
|
| 16 |
+
[SOURCES_TYPE <type>]
|
| 17 |
+
<SOURCES <srcfile...> |
|
| 18 |
+
SOURCE_FROM_CONTENT <name> <content> |
|
| 19 |
+
SOURCE_FROM_VAR <name> <var> |
|
| 20 |
+
SOURCE_FROM_FILE <name> <path> >...
|
| 21 |
+
[LOG_DESCRIPTION <text>]
|
| 22 |
+
[NO_CACHE]
|
| 23 |
+
[NO_LOG]
|
| 24 |
+
[CMAKE_FLAGS <flags>...]
|
| 25 |
+
[COMPILE_DEFINITIONS <defs>...]
|
| 26 |
+
[LINK_OPTIONS <options>...]
|
| 27 |
+
[LINK_LIBRARIES <libs>...]
|
| 28 |
+
[COMPILE_OUTPUT_VARIABLE <var>]
|
| 29 |
+
[COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]
|
| 30 |
+
[<LANG>_STANDARD <std>]
|
| 31 |
+
[<LANG>_STANDARD_REQUIRED <bool>]
|
| 32 |
+
[<LANG>_EXTENSIONS <bool>]
|
| 33 |
+
[RUN_OUTPUT_VARIABLE <var>]
|
| 34 |
+
[RUN_OUTPUT_STDOUT_VARIABLE <var>]
|
| 35 |
+
[RUN_OUTPUT_STDERR_VARIABLE <var>]
|
| 36 |
+
[WORKING_DIRECTORY <var>]
|
| 37 |
+
[ARGS <args>...]
|
| 38 |
+
)
|
| 39 |
+
|
| 40 |
+
.. versionadded:: 3.25
|
| 41 |
+
|
| 42 |
+
Try building an executable from one or more source files. Build success
|
| 43 |
+
returns ``TRUE`` and build failure returns ``FALSE`` in ``<compileResultVar>``.
|
| 44 |
+
If the build succeeds, this runs the executable and stores the exit code in
|
| 45 |
+
``<runResultVar>``. If the executable was built, but failed to run, then
|
| 46 |
+
``<runResultVar>`` will be set to ``FAILED_TO_RUN``. See command
|
| 47 |
+
:command:`try_compile` for documentation of options common to both commands,
|
| 48 |
+
and for information on how the test project is constructed to build the source
|
| 49 |
+
file.
|
| 50 |
+
|
| 51 |
+
One or more source files must be provided. Additionally, one of ``SOURCES``
|
| 52 |
+
and/or ``SOURCE_FROM_*`` must precede other keywords.
|
| 53 |
+
|
| 54 |
+
.. versionadded:: 3.26
|
| 55 |
+
This command records a
|
| 56 |
+
:ref:`configure-log try_run event <try_run configure-log event>`
|
| 57 |
+
if the ``NO_LOG`` option is not specified.
|
| 58 |
+
|
| 59 |
+
This command supports an alternate signature for CMake older than 3.25.
|
| 60 |
+
The signature above is recommended for clarity.
|
| 61 |
+
|
| 62 |
+
.. code-block:: cmake
|
| 63 |
+
|
| 64 |
+
try_run(<runResultVar> <compileResultVar>
|
| 65 |
+
<bindir> <srcfile|SOURCES srcfile...>
|
| 66 |
+
[CMAKE_FLAGS <flags>...]
|
| 67 |
+
[COMPILE_DEFINITIONS <defs>...]
|
| 68 |
+
[LINK_OPTIONS <options>...]
|
| 69 |
+
[LINK_LIBRARIES <libs>...]
|
| 70 |
+
[LINKER_LANGUAGE <lang>]
|
| 71 |
+
[COMPILE_OUTPUT_VARIABLE <var>]
|
| 72 |
+
[COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]
|
| 73 |
+
[<LANG>_STANDARD <std>]
|
| 74 |
+
[<LANG>_STANDARD_REQUIRED <bool>]
|
| 75 |
+
[<LANG>_EXTENSIONS <bool>]
|
| 76 |
+
[RUN_OUTPUT_VARIABLE <var>]
|
| 77 |
+
[OUTPUT_VARIABLE <var>]
|
| 78 |
+
[WORKING_DIRECTORY <var>]
|
| 79 |
+
[ARGS <args>...]
|
| 80 |
+
)
|
| 81 |
+
|
| 82 |
+
.. _`try_run Options`:
|
| 83 |
+
|
| 84 |
+
Options
|
| 85 |
+
^^^^^^^
|
| 86 |
+
|
| 87 |
+
The options specific to ``try_run`` are:
|
| 88 |
+
|
| 89 |
+
``COMPILE_OUTPUT_VARIABLE <var>``
|
| 90 |
+
Report the compile step build output in a given variable.
|
| 91 |
+
|
| 92 |
+
``OUTPUT_VARIABLE <var>``
|
| 93 |
+
Report the compile build output and the output from running the executable
|
| 94 |
+
in the given variable. This option exists for legacy reasons and is only
|
| 95 |
+
supported by the old ``try_run`` signature.
|
| 96 |
+
Prefer ``COMPILE_OUTPUT_VARIABLE`` and ``RUN_OUTPUT_VARIABLE`` instead.
|
| 97 |
+
|
| 98 |
+
``RUN_OUTPUT_VARIABLE <var>``
|
| 99 |
+
Report the output from running the executable in a given variable.
|
| 100 |
+
|
| 101 |
+
``RUN_OUTPUT_STDOUT_VARIABLE <var>``
|
| 102 |
+
.. versionadded:: 3.25
|
| 103 |
+
|
| 104 |
+
Report the output of stdout from running the executable in a given variable.
|
| 105 |
+
|
| 106 |
+
``RUN_OUTPUT_STDERR_VARIABLE <var>``
|
| 107 |
+
.. versionadded:: 3.25
|
| 108 |
+
|
| 109 |
+
Report the output of stderr from running the executable in a given variable.
|
| 110 |
+
|
| 111 |
+
``WORKING_DIRECTORY <var>``
|
| 112 |
+
.. versionadded:: 3.20
|
| 113 |
+
|
| 114 |
+
Run the executable in the given directory. If no ``WORKING_DIRECTORY`` is
|
| 115 |
+
specified, the executable will run in ``<bindir>`` or the current build
|
| 116 |
+
directory.
|
| 117 |
+
|
| 118 |
+
``ARGS <args>...``
|
| 119 |
+
Additional arguments to pass to the executable when running it.
|
| 120 |
+
|
| 121 |
+
Other Behavior Settings
|
| 122 |
+
^^^^^^^^^^^^^^^^^^^^^^^
|
| 123 |
+
|
| 124 |
+
Set variable :variable:`CMAKE_TRY_COMPILE_CONFIGURATION` to choose a build
|
| 125 |
+
configuration:
|
| 126 |
+
|
| 127 |
+
* For multi-config generators, this selects which configuration to build.
|
| 128 |
+
|
| 129 |
+
* For single-config generators, this sets :variable:`CMAKE_BUILD_TYPE` in
|
| 130 |
+
the test project.
|
| 131 |
+
|
| 132 |
+
Behavior when Cross Compiling
|
| 133 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 134 |
+
|
| 135 |
+
.. versionadded:: 3.3
|
| 136 |
+
Use ``CMAKE_CROSSCOMPILING_EMULATOR`` when running cross-compiled binaries.
|
| 137 |
+
|
| 138 |
+
When cross compiling, the executable compiled in the first step
|
| 139 |
+
usually cannot be run on the build host. The ``try_run`` command checks
|
| 140 |
+
the :variable:`CMAKE_CROSSCOMPILING` variable to detect whether CMake is in
|
| 141 |
+
cross-compiling mode. If that is the case, it will still try to compile
|
| 142 |
+
the executable, but it will not try to run the executable unless the
|
| 143 |
+
:variable:`CMAKE_CROSSCOMPILING_EMULATOR` variable is set. Instead it
|
| 144 |
+
will create cache variables which must be filled by the user or by
|
| 145 |
+
presetting them in some CMake script file to the values the executable
|
| 146 |
+
would have produced if it had been run on its actual target platform.
|
| 147 |
+
These cache entries are:
|
| 148 |
+
|
| 149 |
+
``<runResultVar>``
|
| 150 |
+
Exit code if the executable were to be run on the target platform.
|
| 151 |
+
|
| 152 |
+
``<runResultVar>__TRYRUN_OUTPUT``
|
| 153 |
+
Output from stdout and stderr if the executable were to be run on
|
| 154 |
+
the target platform. This is created only if the
|
| 155 |
+
``RUN_OUTPUT_VARIABLE`` or ``OUTPUT_VARIABLE`` option was used.
|
| 156 |
+
|
| 157 |
+
In order to make cross compiling your project easier, use ``try_run``
|
| 158 |
+
only if really required. If you use ``try_run``, use the
|
| 159 |
+
``RUN_OUTPUT_STDOUT_VARIABLE``, ``RUN_OUTPUT_STDERR_VARIABLE``,
|
| 160 |
+
``RUN_OUTPUT_VARIABLE`` or ``OUTPUT_VARIABLE`` options only if really
|
| 161 |
+
required. Using them will require that when cross-compiling, the cache
|
| 162 |
+
variables will have to be set manually to the output of the executable.
|
| 163 |
+
You can also "guard" the calls to ``try_run`` with an :command:`if`
|
| 164 |
+
block checking the :variable:`CMAKE_CROSSCOMPILING` variable and
|
| 165 |
+
provide an easy-to-preset alternative for this case.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/variable_watch.rst
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
variable_watch
|
| 2 |
+
--------------
|
| 3 |
+
|
| 4 |
+
Watch the CMake variable for change.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
variable_watch(<variable> [<command>])
|
| 9 |
+
|
| 10 |
+
If the specified ``<variable>`` changes and no ``<command>`` is given,
|
| 11 |
+
a message will be printed to inform about the change.
|
| 12 |
+
|
| 13 |
+
If ``<command>`` is given, this command will be executed instead.
|
| 14 |
+
The command will receive the following arguments:
|
| 15 |
+
``COMMAND(<variable> <access> <value> <current_list_file> <stack>)``
|
| 16 |
+
|
| 17 |
+
``<variable>``
|
| 18 |
+
Name of the variable being accessed.
|
| 19 |
+
|
| 20 |
+
``<access>``
|
| 21 |
+
One of ``READ_ACCESS``, ``UNKNOWN_READ_ACCESS``, ``MODIFIED_ACCESS``,
|
| 22 |
+
``UNKNOWN_MODIFIED_ACCESS``, or ``REMOVED_ACCESS``. The ``UNKNOWN_``
|
| 23 |
+
values are only used when the variable has never been set. Once set,
|
| 24 |
+
they are never used again during the same CMake run, even if the
|
| 25 |
+
variable is later unset.
|
| 26 |
+
|
| 27 |
+
``<value>``
|
| 28 |
+
The value of the variable. On a modification, this is the new
|
| 29 |
+
(modified) value of the variable. On removal, the value is empty.
|
| 30 |
+
|
| 31 |
+
``<current_list_file>``
|
| 32 |
+
Full path to the file doing the access.
|
| 33 |
+
|
| 34 |
+
``<stack>``
|
| 35 |
+
List of absolute paths of all files currently on the stack of file
|
| 36 |
+
inclusion, with the bottom-most file first and the currently
|
| 37 |
+
processed file (that is, ``current_list_file``) last.
|
| 38 |
+
|
| 39 |
+
Note that for some accesses such as :command:`list(APPEND)`, the watcher
|
| 40 |
+
is executed twice, first with a read access and then with a write one.
|
| 41 |
+
Also note that an :command:`if(DEFINED)` query on the variable does not
|
| 42 |
+
register as an access and the watcher is not executed.
|
| 43 |
+
|
| 44 |
+
Only non-cache variables can be watched using this command. Access to
|
| 45 |
+
cache variables is never watched. However, the existence of a cache
|
| 46 |
+
variable ``var`` causes accesses to the non-cache variable ``var`` to
|
| 47 |
+
not use the ``UNKNOWN_`` prefix, even if a non-cache variable ``var``
|
| 48 |
+
has never existed.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0001.rst
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
CMP0001
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
``CMAKE_BACKWARDS_COMPATIBILITY`` should no longer be used.
|
| 5 |
+
|
| 6 |
+
The behavior is to check ``CMAKE_BACKWARDS_COMPATIBILITY`` and present
|
| 7 |
+
it to the user. The ``NEW`` behavior is to ignore
|
| 8 |
+
CMAKE_BACKWARDS_COMPATIBILITY completely.
|
| 9 |
+
|
| 10 |
+
In CMake 2.4 and below the variable ``CMAKE_BACKWARDS_COMPATIBILITY`` was
|
| 11 |
+
used to request compatibility with earlier versions of CMake. In
|
| 12 |
+
CMake 2.6 and above all compatibility issues are handled by policies
|
| 13 |
+
and the :command:`cmake_policy` command. However, CMake must still check
|
| 14 |
+
``CMAKE_BACKWARDS_COMPATIBILITY`` for projects written for CMake 2.4 and
|
| 15 |
+
below.
|
| 16 |
+
|
| 17 |
+
.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.0
|
| 18 |
+
.. |WARNS_OR_DOES_NOT_WARN| replace:: warns
|
| 19 |
+
.. include:: STANDARD_ADVICE.txt
|
| 20 |
+
|
| 21 |
+
.. include:: DEPRECATED.txt
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0069.rst
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
CMP0069
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.9
|
| 5 |
+
|
| 6 |
+
:prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` is enforced when enabled.
|
| 7 |
+
|
| 8 |
+
CMake 3.9 and newer prefer to add IPO flags whenever the
|
| 9 |
+
:prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` target property is enabled and
|
| 10 |
+
produce an error if flags are not known to CMake for the current compiler.
|
| 11 |
+
Since a given compiler may not support IPO flags in all environments in which
|
| 12 |
+
it is used, it is now the project's responsibility to use the
|
| 13 |
+
:module:`CheckIPOSupported` module to check for support before enabling the
|
| 14 |
+
:prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` target property. This approach
|
| 15 |
+
allows a project to conditionally activate IPO when supported. It also
|
| 16 |
+
allows an end user to set the :variable:`CMAKE_INTERPROCEDURAL_OPTIMIZATION`
|
| 17 |
+
variable in an environment known to support IPO even if the project does
|
| 18 |
+
not enable the property.
|
| 19 |
+
|
| 20 |
+
Since CMake 3.8 and lower only honored :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION`
|
| 21 |
+
for the Intel compiler on Linux, some projects may unconditionally enable the
|
| 22 |
+
target property. Policy ``CMP0069`` provides compatibility with such projects.
|
| 23 |
+
|
| 24 |
+
This policy takes effect whenever the IPO property is enabled. The ``OLD``
|
| 25 |
+
behavior for this policy is to add IPO flags only for Intel compiler on Linux.
|
| 26 |
+
The ``NEW`` behavior for this policy is to add IPO flags for the current
|
| 27 |
+
compiler or produce an error if CMake does not know the flags.
|
| 28 |
+
|
| 29 |
+
.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.9
|
| 30 |
+
.. |WARNS_OR_DOES_NOT_WARN| replace:: warns
|
| 31 |
+
.. include:: STANDARD_ADVICE.txt
|
| 32 |
+
|
| 33 |
+
.. include:: DEPRECATED.txt
|
| 34 |
+
|
| 35 |
+
Examples
|
| 36 |
+
^^^^^^^^
|
| 37 |
+
|
| 38 |
+
Behave like CMake 3.8 and do not apply any IPO flags except for Intel compiler
|
| 39 |
+
on Linux:
|
| 40 |
+
|
| 41 |
+
.. code-block:: cmake
|
| 42 |
+
|
| 43 |
+
cmake_minimum_required(VERSION 3.8)
|
| 44 |
+
project(foo)
|
| 45 |
+
|
| 46 |
+
# ...
|
| 47 |
+
|
| 48 |
+
set_property(TARGET ... PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
|
| 49 |
+
|
| 50 |
+
Use the :module:`CheckIPOSupported` module to detect whether IPO is
|
| 51 |
+
supported by the current compiler, environment, and CMake version.
|
| 52 |
+
Produce a fatal error if support is not available:
|
| 53 |
+
|
| 54 |
+
.. code-block:: cmake
|
| 55 |
+
|
| 56 |
+
cmake_minimum_required(VERSION 3.9) # CMP0069 NEW
|
| 57 |
+
project(foo)
|
| 58 |
+
|
| 59 |
+
include(CheckIPOSupported)
|
| 60 |
+
check_ipo_supported()
|
| 61 |
+
|
| 62 |
+
# ...
|
| 63 |
+
|
| 64 |
+
set_property(TARGET ... PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
|
| 65 |
+
|
| 66 |
+
Apply IPO flags only if compiler supports it:
|
| 67 |
+
|
| 68 |
+
.. code-block:: cmake
|
| 69 |
+
|
| 70 |
+
cmake_minimum_required(VERSION 3.9) # CMP0069 NEW
|
| 71 |
+
project(foo)
|
| 72 |
+
|
| 73 |
+
include(CheckIPOSupported)
|
| 74 |
+
|
| 75 |
+
# ...
|
| 76 |
+
|
| 77 |
+
check_ipo_supported(RESULT result)
|
| 78 |
+
if(result)
|
| 79 |
+
set_property(TARGET ... PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
|
| 80 |
+
endif()
|
| 81 |
+
|
| 82 |
+
Apply IPO flags without any checks. This may lead to build errors if IPO
|
| 83 |
+
is not supported by the compiler in the current environment. Produce an
|
| 84 |
+
error if CMake does not know IPO flags for the current compiler:
|
| 85 |
+
|
| 86 |
+
.. code-block:: cmake
|
| 87 |
+
|
| 88 |
+
cmake_minimum_required(VERSION 3.9) # CMP0069 NEW
|
| 89 |
+
project(foo)
|
| 90 |
+
|
| 91 |
+
# ...
|
| 92 |
+
|
| 93 |
+
set_property(TARGET ... PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0077.rst
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
CMP0077
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.13
|
| 5 |
+
|
| 6 |
+
:command:`option` honors normal variables.
|
| 7 |
+
|
| 8 |
+
The :command:`option` command is typically used to create a cache entry
|
| 9 |
+
to allow users to set the option. However, there are cases in which a
|
| 10 |
+
normal (non-cached) variable of the same name as the option may be
|
| 11 |
+
defined by the project prior to calling the :command:`option` command.
|
| 12 |
+
For example, a project that embeds another project as a subdirectory
|
| 13 |
+
may want to hard-code options of the subproject to build the way it needs.
|
| 14 |
+
|
| 15 |
+
For historical reasons in CMake 3.12 and below the :command:`option`
|
| 16 |
+
command *removes* a normal (non-cached) variable of the same name when:
|
| 17 |
+
|
| 18 |
+
* a cache entry of the specified name does not exist at all, or
|
| 19 |
+
* a cache entry of the specified name exists but has not been given
|
| 20 |
+
a type (e.g. via ``-D<name>=ON`` on the command line).
|
| 21 |
+
|
| 22 |
+
In both of these cases (typically on the first run in a new build tree),
|
| 23 |
+
the :command:`option` command gives the cache entry type ``BOOL`` and
|
| 24 |
+
removes any normal (non-cached) variable of the same name. In the
|
| 25 |
+
remaining case that the cache entry of the specified name already
|
| 26 |
+
exists and has a type (typically on later runs in a build tree), the
|
| 27 |
+
:command:`option` command changes nothing and any normal variable of
|
| 28 |
+
the same name remains set.
|
| 29 |
+
|
| 30 |
+
In CMake 3.13 and above the :command:`option` command prefers to
|
| 31 |
+
do nothing when a normal variable of the given name already exists.
|
| 32 |
+
It does not create or update a cache entry or remove the normal variable.
|
| 33 |
+
The new behavior is consistent between the first and later runs in a
|
| 34 |
+
build tree. This policy provides compatibility with projects that have
|
| 35 |
+
not been updated to expect the new behavior.
|
| 36 |
+
|
| 37 |
+
When the :command:`option` command sees a normal variable of the given
|
| 38 |
+
name:
|
| 39 |
+
|
| 40 |
+
* The ``OLD`` behavior for this policy is to proceed even when a normal
|
| 41 |
+
variable of the same name exists. If the cache entry does not already
|
| 42 |
+
exist and have a type then it is created and/or given a type and the
|
| 43 |
+
normal variable is removed.
|
| 44 |
+
|
| 45 |
+
* The ``NEW`` behavior for this policy is to do nothing when a normal
|
| 46 |
+
variable of the same name exists. The normal variable is not removed.
|
| 47 |
+
The cache entry is not created or updated and is ignored if it exists.
|
| 48 |
+
|
| 49 |
+
See :policy:`CMP0126` for a similar policy for the :command:`set(CACHE)`
|
| 50 |
+
command, but note that there are some differences in ``NEW`` behavior
|
| 51 |
+
between the two policies.
|
| 52 |
+
|
| 53 |
+
.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.13
|
| 54 |
+
.. |WARNS_OR_DOES_NOT_WARN| replace:: warns
|
| 55 |
+
.. include:: STANDARD_ADVICE.txt
|
| 56 |
+
|
| 57 |
+
Use the :variable:`CMAKE_POLICY_DEFAULT_CMP0077
|
| 58 |
+
<CMAKE_POLICY_DEFAULT_CMP\<NNNN\>>` variable to set the policy for
|
| 59 |
+
a third-party project in a subdirectory without modifying it.
|
| 60 |
+
|
| 61 |
+
.. include:: DEPRECATED.txt
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0118.rst
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
CMP0118
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.20
|
| 5 |
+
|
| 6 |
+
:prop_sf:`GENERATED` sources may be used across directories without manual marking.
|
| 7 |
+
|
| 8 |
+
In CMake 3.19 and below, the :prop_sf:`GENERATED` source file property,
|
| 9 |
+
like other source file properties, was scoped in every directory separately.
|
| 10 |
+
If a source file was generated in one directory, projects had to manually
|
| 11 |
+
set the ``GENERATED`` property in another directory in order to use the file.
|
| 12 |
+
|
| 13 |
+
Whether or not a source file is generated is an all-or-nothing global
|
| 14 |
+
property of the source: a source is either generated or it is not.
|
| 15 |
+
CMake 3.20 and above prefer to allow source files generated in one directory
|
| 16 |
+
to be used in other directories without manually marking them as ``GENERATED``.
|
| 17 |
+
Additionally, the ``GENERATED`` property may now be set only to boolean
|
| 18 |
+
values, and may not be turned off once turned on. This policy provides
|
| 19 |
+
compatibility for projects that have not been updated for this behavior.
|
| 20 |
+
|
| 21 |
+
The ``OLD`` behavior of this policy is to allow generated files to be used
|
| 22 |
+
only in directories in which their ``GENERATED`` property has been turned on.
|
| 23 |
+
The ``NEW`` behavior of this policy is to allow generated files to be used
|
| 24 |
+
in other directories without explicitly turning on the ``GENERATED`` property
|
| 25 |
+
for those directories.
|
| 26 |
+
|
| 27 |
+
.. versionadded:: 3.30
|
| 28 |
+
|
| 29 |
+
Policy :policy:`CMP0163` additionally makes the :prop_sf:`GENERATED` source
|
| 30 |
+
file property visible to :command:`get_property` and
|
| 31 |
+
:command:`get_source_file_property` calls in other directories.
|
| 32 |
+
|
| 33 |
+
.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.20
|
| 34 |
+
.. |WARNS_OR_DOES_NOT_WARN| replace::
|
| 35 |
+
warns about setting the ``GENERATED`` property to a non-boolean value
|
| 36 |
+
.. include:: STANDARD_ADVICE.txt
|
| 37 |
+
|
| 38 |
+
.. include:: DEPRECATED.txt
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0131.rst
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
CMP0131
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.24
|
| 5 |
+
|
| 6 |
+
:prop_tgt:`LINK_LIBRARIES` supports the :genex:`$<LINK_ONLY:...>`
|
| 7 |
+
generator expression.
|
| 8 |
+
|
| 9 |
+
CMake 3.23 and below documented the :genex:`$<LINK_ONLY:...>` generator
|
| 10 |
+
expression only for use in :prop_tgt:`INTERFACE_LINK_LIBRARIES`.
|
| 11 |
+
When used in :prop_tgt:`LINK_LIBRARIES`, the content guarded inside
|
| 12 |
+
:genex:`$<LINK_ONLY:...>` was always used, even when collecting non-linking
|
| 13 |
+
usage requirements such as :prop_tgt:`INTERFACE_COMPILE_DEFINITIONS`.
|
| 14 |
+
|
| 15 |
+
CMake 3.24 and above prefer to support :genex:`$<LINK_ONLY:...>`, when
|
| 16 |
+
used in :prop_tgt:`LINK_LIBRARIES`, by using the guarded content only
|
| 17 |
+
for link dependencies and not other usage requirements. This policy
|
| 18 |
+
provides compatibility for projects that have not been updated to
|
| 19 |
+
account for this change.
|
| 20 |
+
|
| 21 |
+
The ``OLD`` behavior for this policy is to use :prop_tgt:`LINK_LIBRARIES`
|
| 22 |
+
content guarded by :genex:`$<LINK_ONLY:...>` even for non-linking
|
| 23 |
+
usage requirements. The ``NEW`` behavior for this policy is to use
|
| 24 |
+
the guarded content only for link dependencies.
|
| 25 |
+
|
| 26 |
+
.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24
|
| 27 |
+
.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn
|
| 28 |
+
.. include:: STANDARD_ADVICE.txt
|
| 29 |
+
|
| 30 |
+
.. include:: DEPRECATED.txt
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0133.rst
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
CMP0133
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.24
|
| 5 |
+
|
| 6 |
+
The :module:`CPack` module disables SLA by default in the
|
| 7 |
+
:cpack_gen:`CPack DragNDrop Generator`.
|
| 8 |
+
|
| 9 |
+
The :cpack_gen:`CPack DragNDrop Generator` in CMake 3.22 and below attach a
|
| 10 |
+
Software License Agreement (SLA) to ``.dmg`` files using the file specified
|
| 11 |
+
by :variable:`CPACK_RESOURCE_FILE_LICENSE`, if set to a non-default value.
|
| 12 |
+
macOS 12.0 deprecated the tools used to do this, so CMake 3.23 added
|
| 13 |
+
the :variable:`CPACK_DMG_SLA_USE_RESOURCE_FILE_LICENSE` option to
|
| 14 |
+
control the behavior. CMake 3.23 enables that option by default for
|
| 15 |
+
compatibility with older versions. CMake 3.24 and above prefer to *not*
|
| 16 |
+
enable the :variable:`CPACK_DMG_SLA_USE_RESOURCE_FILE_LICENSE` option by
|
| 17 |
+
default. This policy provides compatibility with projects that have not
|
| 18 |
+
been updated to account for the lack of a SLA in their ``.dmg`` packages.
|
| 19 |
+
|
| 20 |
+
The ``OLD`` behavior for this policy is to enable
|
| 21 |
+
:variable:`CPACK_DMG_SLA_USE_RESOURCE_FILE_LICENSE` by default.
|
| 22 |
+
The ``NEW`` behavior for this policy is to not enable it by default.
|
| 23 |
+
|
| 24 |
+
.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24
|
| 25 |
+
.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default
|
| 26 |
+
.. include:: STANDARD_ADVICE.txt
|
| 27 |
+
|
| 28 |
+
See documentation of the
|
| 29 |
+
:variable:`CMAKE_POLICY_WARNING_CMP0133 <CMAKE_POLICY_WARNING_CMP<NNNN>>`
|
| 30 |
+
variable to control the warning.
|
| 31 |
+
|
| 32 |
+
.. include:: DEPRECATED.txt
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0169.rst
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
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0175.rst
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
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/policy/CMP0179.rst
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
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_cache/MODIFIED.rst
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.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/ANDROID_API_MIN.rst
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ANDROID_API_MIN
|
| 2 |
+
---------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.2
|
| 5 |
+
|
| 6 |
+
Set the Android MIN API version (e.g. ``9``). The version number
|
| 7 |
+
must be a positive decimal integer. This property is initialized by
|
| 8 |
+
the value of the :variable:`CMAKE_ANDROID_API_MIN` variable if it is set
|
| 9 |
+
when a target is created. Native code builds using this API version.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ARCHIVE_OUTPUT_DIRECTORY
|
| 2 |
+
------------------------
|
| 3 |
+
|
| 4 |
+
.. |XXX| replace:: :ref:`ARCHIVE <Archive Output Artifacts>`
|
| 5 |
+
.. |xxx| replace:: archive
|
| 6 |
+
.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_ARCHIVE_OUTPUT_DIRECTORY`
|
| 7 |
+
.. include:: XXX_OUTPUT_DIRECTORY.txt
|
| 8 |
+
|
| 9 |
+
.. |IDEM| replace:: in the same directory
|
| 10 |
+
.. include:: MACOS_IMPORT_FILES.txt
|
| 11 |
+
|
| 12 |
+
See also the :prop_tgt:`ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>` target property.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ARCHIVE_OUTPUT_NAME_<CONFIG>
|
| 2 |
+
----------------------------
|
| 3 |
+
|
| 4 |
+
Per-configuration output name for
|
| 5 |
+
:ref:`ARCHIVE <Archive Output Artifacts>` target files.
|
| 6 |
+
|
| 7 |
+
This is the configuration-specific version of the
|
| 8 |
+
:prop_tgt:`ARCHIVE_OUTPUT_NAME` target property.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOMOC_EXECUTABLE
|
| 2 |
+
------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.14
|
| 5 |
+
|
| 6 |
+
``AUTOMOC_EXECUTABLE`` is file path pointing to the ``moc``
|
| 7 |
+
executable to use for :prop_tgt:`AUTOMOC` enabled files. Setting
|
| 8 |
+
this property will make CMake skip the automatic detection of the
|
| 9 |
+
``moc`` binary as well as the sanity-tests normally run to ensure
|
| 10 |
+
that the binary is available and working as expected.
|
| 11 |
+
|
| 12 |
+
Usually this property does not need to be set. Only consider this
|
| 13 |
+
property if auto-detection of ``moc`` can not work -- e.g. because
|
| 14 |
+
you are building the ``moc`` binary as part of your project.
|
| 15 |
+
|
| 16 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 17 |
+
with Qt.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOUIC_EXECUTABLE
|
| 2 |
+
------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.14
|
| 5 |
+
|
| 6 |
+
``AUTOUIC_EXECUTABLE`` is file path pointing to the ``uic``
|
| 7 |
+
executable to use for :prop_tgt:`AUTOUIC` enabled files. Setting
|
| 8 |
+
this property will make CMake skip the automatic detection of the
|
| 9 |
+
``uic`` binary as well as the sanity-tests normally run to ensure
|
| 10 |
+
that the binary is available and working as expected.
|
| 11 |
+
|
| 12 |
+
Usually this property does not need to be set. Only consider this
|
| 13 |
+
property if auto-detection of ``uic`` can not work -- e.g. because
|
| 14 |
+
you are building the ``uic`` binary as part of your project.
|
| 15 |
+
|
| 16 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 17 |
+
with Qt.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/BUILD_RPATH.rst
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
BUILD_RPATH
|
| 2 |
+
-----------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.8
|
| 5 |
+
|
| 6 |
+
A :ref:`semicolon-separated list <CMake Language Lists>` specifying
|
| 7 |
+
runtime path (``RPATH``) entries to add to binaries linked in the
|
| 8 |
+
build tree (for platforms that support it). By default, CMake sets
|
| 9 |
+
the runtime path of binaries in the build tree to contain search
|
| 10 |
+
paths it knows are needed to find the shared libraries they link.
|
| 11 |
+
Projects may set ``BUILD_RPATH`` to specify additional search paths.
|
| 12 |
+
|
| 13 |
+
The build-tree runtime path will *not* be used for binaries in the
|
| 14 |
+
install tree. It will be replaced with the install-tree runtime path
|
| 15 |
+
during the installation step. See also the :prop_tgt:`INSTALL_RPATH`
|
| 16 |
+
target property.
|
| 17 |
+
|
| 18 |
+
This property is initialized by the value of the variable
|
| 19 |
+
:variable:`CMAKE_BUILD_RPATH` if it is set when a target is created.
|
| 20 |
+
|
| 21 |
+
This property supports
|
| 22 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 23 |
+
|
| 24 |
+
Other settings that affect the build-tree runtime path include:
|
| 25 |
+
|
| 26 |
+
* The :variable:`CMAKE_SKIP_RPATH` variable completely disables runtime
|
| 27 |
+
paths in both the build tree and install tree.
|
| 28 |
+
|
| 29 |
+
* The :prop_tgt:`SKIP_BUILD_RPATH` target property disables setting any
|
| 30 |
+
runtime path in the build tree.
|
| 31 |
+
|
| 32 |
+
* The :prop_tgt:`BUILD_RPATH_USE_ORIGIN` target property causes the
|
| 33 |
+
automatically-generated runtime path to use entries relative to ``$ORIGIN``.
|
| 34 |
+
|
| 35 |
+
* The :prop_tgt:`BUILD_WITH_INSTALL_RPATH` target property causes binaries
|
| 36 |
+
in the build tree to be built with the install-tree runtime path.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
BUILD_WITH_INSTALL_RPATH
|
| 2 |
+
------------------------
|
| 3 |
+
|
| 4 |
+
``BUILD_WITH_INSTALL_RPATH`` is a boolean specifying whether to link the target
|
| 5 |
+
in the build tree with the :prop_tgt:`INSTALL_RPATH`. This takes precedence
|
| 6 |
+
over :prop_tgt:`SKIP_BUILD_RPATH` and avoids the need for relinking before
|
| 7 |
+
installation.
|
| 8 |
+
|
| 9 |
+
This property is initialized by the value of the
|
| 10 |
+
:variable:`CMAKE_BUILD_WITH_INSTALL_RPATH` variable if it is set when a target
|
| 11 |
+
is created.
|
| 12 |
+
|
| 13 |
+
If policy :policy:`CMP0068` is not ``NEW``, this property also controls use of
|
| 14 |
+
:prop_tgt:`INSTALL_NAME_DIR` in the build tree on macOS. Either way, the
|
| 15 |
+
:prop_tgt:`BUILD_WITH_INSTALL_NAME_DIR` target property takes precedence.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/COMPILE_FLAGS.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPILE_FLAGS
|
| 2 |
+
-------------
|
| 3 |
+
|
| 4 |
+
Additional flags to use when compiling this target's sources.
|
| 5 |
+
|
| 6 |
+
The ``COMPILE_FLAGS`` property sets additional compiler flags used to
|
| 7 |
+
build sources within the target. Use :prop_tgt:`COMPILE_DEFINITIONS`
|
| 8 |
+
to pass additional preprocessor definitions.
|
| 9 |
+
|
| 10 |
+
.. note::
|
| 11 |
+
|
| 12 |
+
This property has been superseded by the :prop_tgt:`COMPILE_OPTIONS` property.
|
| 13 |
+
Alternatively, you can also use the :command:`target_compile_options` command
|
| 14 |
+
instead.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NAME.rst
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPILE_PDB_NAME
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.1
|
| 5 |
+
|
| 6 |
+
Output name for the MS debug symbol ``.pdb`` file generated by the
|
| 7 |
+
compiler while building source files.
|
| 8 |
+
|
| 9 |
+
This property specifies the base name for the debug symbols file.
|
| 10 |
+
If not set, the default is unspecified.
|
| 11 |
+
|
| 12 |
+
.. |PDB_XXX| replace:: :prop_tgt:`PDB_NAME`
|
| 13 |
+
.. include:: COMPILE_PDB_NOTE.txt
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG>
|
| 2 |
+
-------------------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.1
|
| 5 |
+
|
| 6 |
+
Per-configuration output directory for the MS debug symbol ``.pdb`` file
|
| 7 |
+
generated by the compiler while building source files.
|
| 8 |
+
|
| 9 |
+
This is a per-configuration version of
|
| 10 |
+
:prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY`,
|
| 11 |
+
but multi-configuration generators (Visual Studio, Xcode) do NOT append a
|
| 12 |
+
per-configuration subdirectory to the specified directory. This
|
| 13 |
+
property is initialized by the value of the
|
| 14 |
+
:variable:`CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG>` variable
|
| 15 |
+
if it is set when a target is created.
|
| 16 |
+
|
| 17 |
+
.. |PDB_XXX| replace:: :prop_tgt:`PDB_OUTPUT_DIRECTORY_<CONFIG>`
|
| 18 |
+
.. include:: COMPILE_PDB_NOTE.txt
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/C_EXTENSIONS.rst
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
C_EXTENSIONS
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.1
|
| 5 |
+
|
| 6 |
+
Boolean specifying whether compiler specific extensions are requested.
|
| 7 |
+
|
| 8 |
+
This property specifies whether compiler specific extensions should be
|
| 9 |
+
used. For some compilers, this results in adding a flag such
|
| 10 |
+
as ``-std=gnu11`` instead of ``-std=c11`` to the compile line. This
|
| 11 |
+
property is ``ON`` by default. The basic C standard level is
|
| 12 |
+
controlled by the :prop_tgt:`C_STANDARD` target property.
|
| 13 |
+
|
| 14 |
+
See the :manual:`cmake-compile-features(7)` manual for information on
|
| 15 |
+
compile features and a list of supported compilers.
|
| 16 |
+
|
| 17 |
+
This property is initialized by the value of
|
| 18 |
+
the :variable:`CMAKE_C_EXTENSIONS` variable if set when a target is created and
|
| 19 |
+
otherwise by the value of
|
| 20 |
+
:variable:`CMAKE_C_EXTENSIONS_DEFAULT <CMAKE_<LANG>_EXTENSIONS_DEFAULT>` (see
|
| 21 |
+
:policy:`CMP0128`).
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
DEPLOYMENT_REMOTE_DIRECTORY
|
| 2 |
+
---------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.6
|
| 5 |
+
|
| 6 |
+
Set the WinCE project ``RemoteDirectory`` in ``DeploymentTool`` and
|
| 7 |
+
``RemoteExecutable`` in ``DebuggerTool`` in ``.vcproj`` files generated
|
| 8 |
+
by the :ref:`Visual Studio Generators`.
|
| 9 |
+
This is useful when you want to debug on remote WinCE device.
|
| 10 |
+
For example:
|
| 11 |
+
|
| 12 |
+
.. code-block:: cmake
|
| 13 |
+
|
| 14 |
+
set_property(TARGET ${TARGET} PROPERTY
|
| 15 |
+
DEPLOYMENT_REMOTE_DIRECTORY "\\FlashStorage")
|
| 16 |
+
|
| 17 |
+
produces::
|
| 18 |
+
|
| 19 |
+
<DeploymentTool RemoteDirectory="\FlashStorage" ... />
|
| 20 |
+
<DebuggerTool RemoteExecutable="\FlashStorage\target_file" ... />
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/DEPRECATION.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
DEPRECATION
|
| 2 |
+
-----------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.17
|
| 5 |
+
|
| 6 |
+
Deprecation message from imported target's developer.
|
| 7 |
+
|
| 8 |
+
``DEPRECATION`` is the message regarding a deprecation status to be displayed
|
| 9 |
+
to downstream users of a target.
|
| 10 |
+
|
| 11 |
+
The message is formatted as follows:
|
| 12 |
+
|
| 13 |
+
* Lines that do not start in whitespace are wrapped as paragraph text.
|
| 14 |
+
* Lines that start in whitespace are preserved as preformatted text.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/DOTNET_SDK.rst
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
DOTNET_SDK
|
| 2 |
+
----------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.23
|
| 5 |
+
|
| 6 |
+
Specify the .NET SDK for C# projects. For example: ``Microsoft.NET.Sdk``.
|
| 7 |
+
|
| 8 |
+
This property tells :ref:`Visual Studio Generators` for VS 2019 and
|
| 9 |
+
above to generate a .NET SDK-style project using the specified SDK.
|
| 10 |
+
The property is meaningful only to these generators, and only in C#
|
| 11 |
+
targets. It is ignored for C++ projects, even if they are managed
|
| 12 |
+
(e.g. using :prop_tgt:`COMMON_LANGUAGE_RUNTIME`).
|
| 13 |
+
|
| 14 |
+
This property must be a non-empty string to generate .NET SDK-style projects.
|
| 15 |
+
CMake does not perform any validations for the value of the property.
|
| 16 |
+
|
| 17 |
+
This property may be initialized for all targets using the
|
| 18 |
+
:variable:`CMAKE_DOTNET_SDK` variable.
|
| 19 |
+
|
| 20 |
+
.. note::
|
| 21 |
+
|
| 22 |
+
The :ref:`Visual Studio Generators` in this version of CMake have not
|
| 23 |
+
yet learned to support :command:`add_custom_command` in .NET SDK-style
|
| 24 |
+
projects. It is currently an error to attach a custom command to a
|
| 25 |
+
target with the ``DOTNET_SDK`` property set.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/EXCLUDE_FROM_ALL.rst
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
EXCLUDE_FROM_ALL
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
Set this target property to a true (or false) value to exclude (or include)
|
| 5 |
+
the target from the "all" target of the containing directory and its
|
| 6 |
+
ancestors. If excluded, running e.g. ``make`` in the containing directory
|
| 7 |
+
or its ancestors will not build the target by default.
|
| 8 |
+
|
| 9 |
+
If this target property is not set then the target will be included in
|
| 10 |
+
the "all" target of the containing directory. Furthermore, it will be
|
| 11 |
+
included in the "all" target of its ancestor directories unless the
|
| 12 |
+
:prop_dir:`EXCLUDE_FROM_ALL` directory property is set.
|
| 13 |
+
|
| 14 |
+
With ``EXCLUDE_FROM_ALL`` set to false or not set at all, the target
|
| 15 |
+
will be brought up to date as part of doing a ``make install`` or its
|
| 16 |
+
equivalent for the CMake generator being used.
|
| 17 |
+
|
| 18 |
+
If a target has ``EXCLUDE_FROM_ALL`` set to true, it may still be listed
|
| 19 |
+
in an :command:`install(TARGETS)` command, but the user is responsible for
|
| 20 |
+
ensuring that the target's build artifacts are not missing or outdated when
|
| 21 |
+
an install is performed.
|
| 22 |
+
|
| 23 |
+
This property may use "generator expressions" with the syntax ``$<...>``. See
|
| 24 |
+
the :manual:`cmake-generator-expressions(7)` manual for available expressions.
|
| 25 |
+
|
| 26 |
+
Only the "Ninja Multi-Config" generator supports a property value that varies by
|
| 27 |
+
configuration. For all other generators the value of this property must be the
|
| 28 |
+
same for all configurations.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/EXPORT_NO_SYSTEM.rst
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
EXPORT_NO_SYSTEM
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.25
|
| 5 |
+
|
| 6 |
+
This property affects the behavior of the :command:`install(EXPORT)` and
|
| 7 |
+
:command:`export` commands when they install or export the target respectively.
|
| 8 |
+
When ``EXPORT_NO_SYSTEM`` is set to true, those commands generate an imported
|
| 9 |
+
target with :prop_tgt:`SYSTEM` property set to false.
|
| 10 |
+
|
| 11 |
+
See the :prop_tgt:`NO_SYSTEM_FROM_IMPORTED` target property to set this
|
| 12 |
+
behavior on the target *consuming* the include directories rather than the
|
| 13 |
+
one *providing* them.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/Fortran_PREPROCESS.rst
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Fortran_PREPROCESS
|
| 2 |
+
------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.18
|
| 5 |
+
|
| 6 |
+
Control whether the Fortran source file should be unconditionally
|
| 7 |
+
preprocessed.
|
| 8 |
+
|
| 9 |
+
If unset or empty, rely on the compiler to determine whether the file
|
| 10 |
+
should be preprocessed. If explicitly set to ``OFF`` then the file does not
|
| 11 |
+
need to be preprocessed. If explicitly set to ``ON``, then the file does
|
| 12 |
+
need to be preprocessed as part of the compilation step.
|
| 13 |
+
|
| 14 |
+
When using the :generator:`Ninja` generator, all source files are
|
| 15 |
+
first preprocessed in order to generate module dependency
|
| 16 |
+
information. Setting this property to ``OFF`` will make ``Ninja``
|
| 17 |
+
skip this step.
|
| 18 |
+
|
| 19 |
+
Use the source-specific :prop_sf:`Fortran_PREPROCESS` property if a single
|
| 20 |
+
file needs to be preprocessed. If the variable
|
| 21 |
+
:variable:`CMAKE_Fortran_PREPROCESS` is set when a target is created its
|
| 22 |
+
value is used to initialize this property.
|
| 23 |
+
|
| 24 |
+
.. note:: For some compilers, ``NAG``, ``PGI`` and ``Solaris Studio``,
|
| 25 |
+
setting this to ``OFF`` will have no effect.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/HEADER_SET.rst
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
HEADER_SET
|
| 2 |
+
----------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.23
|
| 5 |
+
|
| 6 |
+
Semicolon-separated list of files in the target's default header set,
|
| 7 |
+
(i.e. the file set with name and type ``HEADERS``). If any of the paths
|
| 8 |
+
are relative, they are computed relative to the target's source directory.
|
| 9 |
+
The property supports
|
| 10 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 11 |
+
|
| 12 |
+
This property is normally only set by :command:`target_sources(FILE_SET)`
|
| 13 |
+
rather than being manipulated directly.
|
| 14 |
+
|
| 15 |
+
See :prop_tgt:`HEADER_SET_<NAME>` for the list of files in other header sets.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/HIP_STANDARD.rst
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
HIP_STANDARD
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.21
|
| 5 |
+
|
| 6 |
+
The HIP/C++ standard requested to build this target.
|
| 7 |
+
|
| 8 |
+
Supported values are:
|
| 9 |
+
|
| 10 |
+
``98``
|
| 11 |
+
HIP C++98
|
| 12 |
+
|
| 13 |
+
``11``
|
| 14 |
+
HIP C++11
|
| 15 |
+
|
| 16 |
+
``14``
|
| 17 |
+
HIP C++14
|
| 18 |
+
|
| 19 |
+
``17``
|
| 20 |
+
HIP C++17
|
| 21 |
+
|
| 22 |
+
``20``
|
| 23 |
+
HIP C++20
|
| 24 |
+
|
| 25 |
+
``23``
|
| 26 |
+
HIP C++23
|
| 27 |
+
|
| 28 |
+
``26``
|
| 29 |
+
.. versionadded:: 3.25
|
| 30 |
+
|
| 31 |
+
HIP C++26. CMake 3.25 and later *recognize* ``26`` as a valid value,
|
| 32 |
+
no version has support for any compiler.
|
| 33 |
+
|
| 34 |
+
If the value requested does not result in a compile flag being added for
|
| 35 |
+
the compiler in use, a previous standard flag will be added instead. This
|
| 36 |
+
means that using:
|
| 37 |
+
|
| 38 |
+
.. code-block:: cmake
|
| 39 |
+
|
| 40 |
+
set_property(TARGET tgt PROPERTY HIP_STANDARD 11)
|
| 41 |
+
|
| 42 |
+
with a compiler which does not support ``-std=gnu++11`` or an equivalent
|
| 43 |
+
flag will not result in an error or warning, but will instead add the
|
| 44 |
+
``-std=gnu++98`` flag if supported. This "decay" behavior may be controlled
|
| 45 |
+
with the :prop_tgt:`HIP_STANDARD_REQUIRED` target property.
|
| 46 |
+
Additionally, the :prop_tgt:`HIP_EXTENSIONS` target property may be used to
|
| 47 |
+
control whether compiler-specific extensions are enabled on a per-target basis.
|
| 48 |
+
|
| 49 |
+
See the :manual:`cmake-compile-features(7)` manual for information on
|
| 50 |
+
compile features and a list of supported compilers.
|
| 51 |
+
|
| 52 |
+
This property is initialized by the value of
|
| 53 |
+
the :variable:`CMAKE_HIP_STANDARD` variable if it is set when a target
|
| 54 |
+
is created.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_FEATURES.rst
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
IMPORTED_CXX_MODULES_COMPILE_FEATURES
|
| 2 |
+
-------------------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.28
|
| 5 |
+
|
| 6 |
+
Compiler features enabled for this ``IMPORTED`` target's C++ modules.
|
| 7 |
+
|
| 8 |
+
The value of this property is used by the generators to set the include
|
| 9 |
+
paths for the compiler.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/IMPORTED_NO_SONAME.rst
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
IMPORTED_NO_SONAME
|
| 2 |
+
------------------
|
| 3 |
+
|
| 4 |
+
Specifies that an ``IMPORTED`` shared library target has no ``soname``.
|
| 5 |
+
|
| 6 |
+
Set this property to true for an imported shared library file that has
|
| 7 |
+
no ``soname`` field. CMake may adjust generated link commands for some
|
| 8 |
+
platforms to prevent the linker from using the path to the library in
|
| 9 |
+
place of its missing ``soname``. Ignored for non-imported targets.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/IMPORT_PREFIX.rst
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
IMPORT_PREFIX
|
| 2 |
+
-------------
|
| 3 |
+
|
| 4 |
+
What comes before the import library name.
|
| 5 |
+
|
| 6 |
+
Similar to the target property :prop_tgt:`PREFIX`, but used for import libraries
|
| 7 |
+
(typically corresponding to a ``DLL``) instead of regular libraries. A
|
| 8 |
+
target property that can be set to override the prefix (such as ``lib``)
|
| 9 |
+
on an import library name.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/INTERFACE_AUTOMOC_MACRO_NAMES.rst
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
INTERFACE_AUTOMOC_MACRO_NAMES
|
| 2 |
+
-----------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.27
|
| 5 |
+
|
| 6 |
+
A :ref:`semicolon-separated list <CMake Language Lists>` of macro names for
|
| 7 |
+
:prop_tgt:`AUTOMOC` to be propagated to consumers.
|
| 8 |
+
|
| 9 |
+
When a target with :prop_tgt:`AUTOMOC` enabled links to a library that sets
|
| 10 |
+
``INTERFACE_AUTOMOC_MACRO_NAMES``, the target inherits the listed macro names
|
| 11 |
+
and merges them with those specified in its own :prop_tgt:`AUTOMOC_MACRO_NAMES`
|
| 12 |
+
property. The target will then automatically generate MOC files for source
|
| 13 |
+
files that contain the inherited macro names too, not just the macro names
|
| 14 |
+
specified in its own :prop_tgt:`AUTOMOC_MACRO_NAMES` property.
|
| 15 |
+
|
| 16 |
+
By default ``INTERFACE_AUTOMOC_MACRO_NAMES`` is empty.
|
| 17 |
+
|
| 18 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 19 |
+
with Qt.
|
| 20 |
+
|
| 21 |
+
Example 1
|
| 22 |
+
^^^^^^^^^
|
| 23 |
+
|
| 24 |
+
In this example, ``myapp`` inherits the macro names ``STATIC_LIB_1`` and
|
| 25 |
+
``STATIC_LIB_2`` from ``static_lib``. The ``moc`` tool will then automatically
|
| 26 |
+
be run on any of the ``myapp`` sources which contain ``STATIC_LIB_1`` or
|
| 27 |
+
``STATIC_LIB_2``.
|
| 28 |
+
|
| 29 |
+
.. code-block:: cmake
|
| 30 |
+
|
| 31 |
+
set(AUTOMOC ON)
|
| 32 |
+
add_executable(myapp main.cpp)
|
| 33 |
+
target_link_libraries(myapp PRIVATE static_lib)
|
| 34 |
+
|
| 35 |
+
add_library(static_lib STATIC static.cpp)
|
| 36 |
+
set_property(TARGET static_lib PROPERTY
|
| 37 |
+
INTERFACE_AUTOMOC_MACRO_NAMES "STATIC_LIB_1;STATIC_LIB_2"
|
| 38 |
+
)
|
| 39 |
+
|
| 40 |
+
Example 2
|
| 41 |
+
^^^^^^^^^
|
| 42 |
+
|
| 43 |
+
In this example, the ``INTERFACE_AUTOMOC_MACRO_NAMES`` target property of the
|
| 44 |
+
various ``*_deep_lib`` libraries will propagate to ``shared_lib``,
|
| 45 |
+
``static_lib`` and ``interface_lib``. Because the linking relationships are
|
| 46 |
+
specified as ``PUBLIC`` and ``INTERFACE``, those macro names will also further
|
| 47 |
+
propagate transitively up to ``app``.
|
| 48 |
+
|
| 49 |
+
.. code-block:: cmake
|
| 50 |
+
|
| 51 |
+
set(AUTOMOC ON)
|
| 52 |
+
|
| 53 |
+
add_library(shared_deep_lib SHARED deep_lib.cpp)
|
| 54 |
+
add_library(static_deep_lib STATIC deep_lib.cpp)
|
| 55 |
+
add_library(interface_deep_lib INTERFACE)
|
| 56 |
+
|
| 57 |
+
set_property(TARGET shared_deep_lib PROPERTY
|
| 58 |
+
INTERFACE_AUTOMOC_MACRO_NAMES "SHARED_LINK_LIB"
|
| 59 |
+
)
|
| 60 |
+
set_property(TARGET static_deep_lib PROPERTY
|
| 61 |
+
INTERFACE_AUTOMOC_MACRO_NAMES "STATIC_LINK_LIB"
|
| 62 |
+
)
|
| 63 |
+
set_property(TARGET interface_deep_lib PROPERTY
|
| 64 |
+
INTERFACE_AUTOMOC_MACRO_NAMES "INTERFACE_LINK_LIB"
|
| 65 |
+
)
|
| 66 |
+
|
| 67 |
+
add_library(shared_lib SHARED lib.cpp)
|
| 68 |
+
add_library(static_lib STATIC lib.cpp)
|
| 69 |
+
add_library(interface_lib INTERFACE)
|
| 70 |
+
|
| 71 |
+
# PUBLIC and INTERFACE here ensure the macro names propagate to any
|
| 72 |
+
# consumers of shared_lib, static_lib or interface_lib too
|
| 73 |
+
target_link_libraries(shared_lib PUBLIC shared_deep_lib)
|
| 74 |
+
target_link_libraries(static_lib PUBLIC static_deep_lib)
|
| 75 |
+
target_link_libraries(interface_lib INTERFACE interface_deep_lib)
|
| 76 |
+
|
| 77 |
+
# This consumer will receive all three of the above custom macro names as
|
| 78 |
+
# transitive usage requirements
|
| 79 |
+
add_executable(app main.cpp)
|
| 80 |
+
target_link_libraries(app PRIVATE shared_lib static_lib interface_lib)
|
| 81 |
+
|
| 82 |
+
In the above:
|
| 83 |
+
|
| 84 |
+
* ``shared_lib`` sources will be processed by ``moc`` if they contain
|
| 85 |
+
``SHARED_LINK_LIB``.
|
| 86 |
+
* ``static_lib`` sources will be processed by ``moc`` if they contain
|
| 87 |
+
``STATIC_LINK_LIB``.
|
| 88 |
+
* ``app`` sources will be processed by ``moc`` if they contain
|
| 89 |
+
``SHARED_LINK_LIB``, ``STATIC_LINK_LIB`` or ``INTERFACE_LINK_LIB``.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
INTERFACE_INCLUDE_DIRECTORIES
|
| 2 |
+
-----------------------------
|
| 3 |
+
|
| 4 |
+
.. |property_name| replace:: include directories
|
| 5 |
+
.. |command_name| replace:: :command:`target_include_directories`
|
| 6 |
+
.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_INCLUDE_DIRECTORIES``
|
| 7 |
+
.. |PROPERTY_LINK| replace:: :prop_tgt:`INCLUDE_DIRECTORIES`
|
| 8 |
+
.. include:: INTERFACE_BUILD_PROPERTY.txt
|
| 9 |
+
|
| 10 |
+
Include directories usage requirements commonly differ between the build-tree
|
| 11 |
+
and the install-tree. The ``BUILD_INTERFACE`` and ``INSTALL_INTERFACE``
|
| 12 |
+
generator expressions can be used to describe separate usage requirements
|
| 13 |
+
based on the usage location. Relative paths are allowed within the
|
| 14 |
+
``INSTALL_INTERFACE`` expression and are interpreted relative to the
|
| 15 |
+
installation prefix. For example:
|
| 16 |
+
|
| 17 |
+
.. code-block:: cmake
|
| 18 |
+
|
| 19 |
+
target_include_directories(mylib INTERFACE
|
| 20 |
+
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/mylib>
|
| 21 |
+
$<INSTALL_INTERFACE:include/mylib> # <prefix>/include/mylib
|
| 22 |
+
)
|
| 23 |
+
|
| 24 |
+
Creating Relocatable Packages
|
| 25 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 26 |
+
|
| 27 |
+
.. |INTERFACE_PROPERTY_LINK| replace:: ``INTERFACE_INCLUDE_DIRECTORIES``
|
| 28 |
+
.. include:: /include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.txt
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/JOB_POOL_COMPILE.rst
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
JOB_POOL_COMPILE
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
Ninja only: Pool used for compiling.
|
| 5 |
+
|
| 6 |
+
The number of parallel compile processes could be limited by defining
|
| 7 |
+
pools with the global :prop_gbl:`JOB_POOLS`
|
| 8 |
+
property and then specifying here the pool name.
|
| 9 |
+
|
| 10 |
+
For instance:
|
| 11 |
+
|
| 12 |
+
.. code-block:: cmake
|
| 13 |
+
|
| 14 |
+
set_property(TARGET myexe PROPERTY JOB_POOL_COMPILE ten_jobs)
|
| 15 |
+
|
| 16 |
+
This property is initialized by the value of
|
| 17 |
+
:variable:`CMAKE_JOB_POOL_COMPILE`.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/LANG_CPPLINT.rst
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<LANG>_CPPLINT
|
| 2 |
+
--------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.8
|
| 5 |
+
|
| 6 |
+
This property is supported only when ``<LANG>`` is ``C`` or ``CXX``.
|
| 7 |
+
|
| 8 |
+
Specify a :ref:`semicolon-separated list <CMake Language Lists>` containing a command line
|
| 9 |
+
for the ``cpplint`` style checker. The :ref:`Makefile Generators` and the
|
| 10 |
+
:generator:`Ninja` generator will run ``cpplint`` along with the compiler
|
| 11 |
+
and report any problems.
|
| 12 |
+
|
| 13 |
+
This property is initialized by the value of the
|
| 14 |
+
:variable:`CMAKE_<LANG>_CPPLINT` variable if it is set when a target is
|
| 15 |
+
created.
|
| 16 |
+
|
| 17 |
+
.. versionadded:: 3.27
|
| 18 |
+
|
| 19 |
+
This property supports
|
| 20 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 21 |
+
|
| 22 |
+
.. versionadded:: 3.27
|
| 23 |
+
|
| 24 |
+
:prop_sf:`SKIP_LINTING` can be set on individual source files to exclude
|
| 25 |
+
them from the linting tools defined by ``<LANG>_CPPLINT``,
|
| 26 |
+
:prop_tgt:`<LANG>_CLANG_TIDY`, :prop_tgt:`<LANG>_CPPCHECK`, and
|
| 27 |
+
:prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE`. When :prop_sf:`SKIP_LINTING` is
|
| 28 |
+
set to true on a source file, those tools will not be run on that specific
|
| 29 |
+
file.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/LANG_STANDARD.rst
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<LANG>_STANDARD
|
| 2 |
+
---------------
|
| 3 |
+
|
| 4 |
+
The variations are:
|
| 5 |
+
|
| 6 |
+
* :prop_tgt:`C_STANDARD`
|
| 7 |
+
* :prop_tgt:`CXX_STANDARD`
|
| 8 |
+
* :prop_tgt:`CUDA_STANDARD`
|
| 9 |
+
* :prop_tgt:`HIP_STANDARD`
|
| 10 |
+
* :prop_tgt:`OBJC_STANDARD`
|
| 11 |
+
* :prop_tgt:`OBJCXX_STANDARD`
|
| 12 |
+
|
| 13 |
+
These properties specify language standard versions which are requested. When a
|
| 14 |
+
newer standard is specified than is supported by the compiler, then it will
|
| 15 |
+
fallback to the latest supported standard. This "decay" behavior may be
|
| 16 |
+
controlled with the :prop_tgt:`<LANG>_STANDARD_REQUIRED` target property.
|
| 17 |
+
|
| 18 |
+
Note that the actual language standard used may be higher than that specified
|
| 19 |
+
by ``<LANG>_STANDARD``, regardless of the value of
|
| 20 |
+
:prop_tgt:`<LANG>_STANDARD_REQUIRED`. In particular,
|
| 21 |
+
:ref:`usage requirements <Target Usage Requirements>` or the use of
|
| 22 |
+
:manual:`compile features <cmake-compile-features(7)>` can raise the required
|
| 23 |
+
language standard above what ``<LANG>_STANDARD`` specifies.
|
| 24 |
+
|
| 25 |
+
These properties are initialized by the value of the
|
| 26 |
+
:variable:`CMAKE_<LANG>_STANDARD` variable if it is set when a target is
|
| 27 |
+
created.
|
| 28 |
+
|
| 29 |
+
For supported values and CMake versions see the respective pages.
|
| 30 |
+
To control compiler-specific extensions see :prop_tgt:`<LANG>_EXTENSIONS`.
|
| 31 |
+
|
| 32 |
+
See the :manual:`cmake-compile-features(7)` manual for information on
|
| 33 |
+
compile features and a list of supported compilers.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/LINK_DEPENDS.rst
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
LINK_DEPENDS
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
Additional files on which a target binary depends for linking.
|
| 5 |
+
|
| 6 |
+
Specifies a semicolon-separated list of full-paths to files on which
|
| 7 |
+
the link rule for this target depends. The target binary will be
|
| 8 |
+
linked if any of the named files is newer than it.
|
| 9 |
+
|
| 10 |
+
This property is supported only by :generator:`Ninja` and
|
| 11 |
+
:ref:`Makefile Generators`. It is
|
| 12 |
+
intended to specify dependencies on "linker scripts" for custom Makefile link
|
| 13 |
+
rules.
|
| 14 |
+
|
| 15 |
+
Contents of ``LINK_DEPENDS`` may use "generator expressions" with
|
| 16 |
+
the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
|
| 17 |
+
manual for available expressions. See the :manual:`cmake-buildsystem(7)`
|
| 18 |
+
manual for more on defining buildsystem properties.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
LINK_LIBRARIES_ONLY_TARGETS
|
| 2 |
+
---------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.23
|
| 5 |
+
|
| 6 |
+
Enforce that link items that can be target names are actually existing targets.
|
| 7 |
+
|
| 8 |
+
Set this property to a true value to enable additional checks on the contents
|
| 9 |
+
of the :prop_tgt:`LINK_LIBRARIES` and :prop_tgt:`INTERFACE_LINK_LIBRARIES`
|
| 10 |
+
target properties, typically populated by :command:`target_link_libraries`.
|
| 11 |
+
Checks are also applied to libraries added to a target through the
|
| 12 |
+
:prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` properties of its dependencies.
|
| 13 |
+
CMake will verify that link items that might be target names actually name
|
| 14 |
+
existing targets. An item is considered a possible target name if:
|
| 15 |
+
|
| 16 |
+
* it does not contain a ``/`` or ``\``, and
|
| 17 |
+
* it does not start in ``-``, and
|
| 18 |
+
* (for historical reasons) it does not start in ``$`` or `````.
|
| 19 |
+
|
| 20 |
+
This property is initialized by the value of the
|
| 21 |
+
:variable:`CMAKE_LINK_LIBRARIES_ONLY_TARGETS` variable when a non-imported
|
| 22 |
+
target is created. The property may be explicitly enabled on an imported
|
| 23 |
+
target to check its link interface.
|
| 24 |
+
|
| 25 |
+
In the following example, CMake will halt with an error at configure time
|
| 26 |
+
because ``miLib`` is not a target:
|
| 27 |
+
|
| 28 |
+
.. code-block:: cmake
|
| 29 |
+
|
| 30 |
+
set(CMAKE_LINK_LIBRARIES_ONLY_TARGETS ON)
|
| 31 |
+
add_library(myLib STATIC myLib.c)
|
| 32 |
+
add_executable(myExe myExe.c)
|
| 33 |
+
target_link_libraries(myExe PRIVATE miLib) # typo for myLib
|
| 34 |
+
|
| 35 |
+
In order to link toolchain-provided libraries by name while still
|
| 36 |
+
enforcing ``LINK_LIBRARIES_ONLY_TARGETS``, use an
|
| 37 |
+
:ref:`imported <Imported Targets>`
|
| 38 |
+
:ref:`Interface Library <Interface Libraries>` with the
|
| 39 |
+
:prop_tgt:`IMPORTED_LIBNAME` target property:
|
| 40 |
+
|
| 41 |
+
.. code-block:: cmake
|
| 42 |
+
|
| 43 |
+
add_library(toolchain::m INTERFACE IMPORTED)
|
| 44 |
+
set_property(TARGET toolchain::m PROPERTY IMPORTED_LIBNAME "m")
|
| 45 |
+
target_link_libraries(myExe PRIVATE toolchain::m)
|
| 46 |
+
|
| 47 |
+
See also policy :policy:`CMP0028`.
|
| 48 |
+
|
| 49 |
+
.. note::
|
| 50 |
+
|
| 51 |
+
If :prop_tgt:`INTERFACE_LINK_LIBRARIES` contains generator expressions,
|
| 52 |
+
its actual list of link items may depend on the type and properties of
|
| 53 |
+
the consuming target. In such cases CMake may not always detect names
|
| 54 |
+
of missing targets that only appear for specific consumers.
|
| 55 |
+
A future version of CMake with improved heuristics may start triggering
|
| 56 |
+
errors on projects accepted by previous versions of CMake.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/prop_tgt/MACHO_CURRENT_VERSION.rst
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
MACHO_CURRENT_VERSION
|
| 2 |
+
---------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.17
|
| 5 |
+
|
| 6 |
+
What current version number is this target for Mach-O binaries.
|
| 7 |
+
|
| 8 |
+
For shared libraries on Mach-O systems (e.g. macOS, iOS)
|
| 9 |
+
the :prop_tgt:`MACHO_COMPATIBILITY_VERSION` property corresponds to the
|
| 10 |
+
*compatibility version* and ``MACHO_CURRENT_VERSION`` corresponds to the
|
| 11 |
+
*current version*. These are both embedded in the shared library binary
|
| 12 |
+
and can be checked with the ``otool -L <binary>`` command.
|
| 13 |
+
|
| 14 |
+
It should be noted that the ``MACHO_CURRENT_VERSION`` and
|
| 15 |
+
:prop_tgt:`MACHO_COMPATIBILITY_VERSION` properties do not affect the file
|
| 16 |
+
names or version-related symlinks that CMake generates for the library.
|
| 17 |
+
The :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` target properties still
|
| 18 |
+
control the file and symlink names. The ``install_name`` is also still
|
| 19 |
+
controlled by :prop_tgt:`SOVERSION`.
|
| 20 |
+
|
| 21 |
+
When ``MACHO_CURRENT_VERSION`` and :prop_tgt:`MACHO_COMPATIBILITY_VERSION`
|
| 22 |
+
are not given, :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` are used for
|
| 23 |
+
the version details to be embedded in the binaries respectively.
|
| 24 |
+
The ``MACHO_CURRENT_VERSION`` and :prop_tgt:`MACHO_COMPATIBILITY_VERSION`
|
| 25 |
+
properties only need to be given if the project needs to decouple the file
|
| 26 |
+
and symlink naming from the version details embedded in the binaries
|
| 27 |
+
(e.g. to match libtool conventions).
|