Add files using upload-large-folder tool
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- cmake/share/cmake-3.31/Help/prop_tgt/ANDROID_STL_TYPE.rst +29 -0
- cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst +12 -0
- cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst +16 -0
- cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst +11 -0
- cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst +8 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_BETTER_GRAPH_MULTI_CONFIG.rst +22 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst +19 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_COMMAND_LINE_LENGTH_MAX.rst +18 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst +48 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_PARALLEL.rst +23 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst +46 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_USE_SYSTEM_INCLUDE.rst +19 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC.rst +257 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst +26 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst +109 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst +17 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst +38 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst +53 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst +33 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC.rst +64 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC_EXECUTABLE.rst +17 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC_OPTIONS.rst +28 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC.rst +91 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst +17 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_OPTIONS.rst +34 -0
- cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_SEARCH_PATHS.rst +14 -0
- cmake/share/cmake-3.31/Help/prop_tgt/BINARY_DIR.rst +8 -0
- cmake/share/cmake-3.31/Help/prop_tgt/BUILD_RPATH.rst +36 -0
- cmake/share/cmake-3.31/Help/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst +26 -0
- cmake/share/cmake-3.31/Help/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst +15 -0
- cmake/share/cmake-3.31/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst +15 -0
- cmake/share/cmake-3.31/Help/prop_tgt/BUNDLE.rst +9 -0
- cmake/share/cmake-3.31/Help/prop_tgt/BUNDLE_EXTENSION.rst +8 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst +41 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst +20 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MAX.rst +18 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MIN.rst +18 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst +16 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_DEFINITIONS.rst +28 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst +16 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_FEATURES.rst +15 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_FLAGS.rst +14 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_OPTIONS.rst +27 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NAME.rst +13 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst +12 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NOTE.txt +5 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst +15 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst +18 -0
- cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst +37 -0
- cmake/share/cmake-3.31/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst +8 -0
cmake/share/cmake-3.31/Help/prop_tgt/ANDROID_STL_TYPE.rst
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ANDROID_STL_TYPE
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.4
|
| 5 |
+
|
| 6 |
+
When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio
|
| 7 |
+
Edition`, this property specifies the type of STL support for the project.
|
| 8 |
+
This is a string property that could set to the one of the following values:
|
| 9 |
+
|
| 10 |
+
``none``
|
| 11 |
+
No C++ Support
|
| 12 |
+
``system``
|
| 13 |
+
Minimal C++ without STL
|
| 14 |
+
``gabi++_static``
|
| 15 |
+
GAbi++ Static
|
| 16 |
+
``gabi++_shared``
|
| 17 |
+
GAbi++ Shared
|
| 18 |
+
``gnustl_static``
|
| 19 |
+
GNU libstdc++ Static
|
| 20 |
+
``gnustl_shared``
|
| 21 |
+
GNU libstdc++ Shared
|
| 22 |
+
``stlport_static``
|
| 23 |
+
STLport Static
|
| 24 |
+
``stlport_shared``
|
| 25 |
+
STLport Shared
|
| 26 |
+
|
| 27 |
+
This property is initialized by the value of the
|
| 28 |
+
:variable:`CMAKE_ANDROID_STL_TYPE` variable if it is set when a target is
|
| 29 |
+
created.
|
cmake/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.
|
cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>
|
| 2 |
+
---------------------------------
|
| 3 |
+
|
| 4 |
+
Per-configuration output directory for
|
| 5 |
+
:ref:`ARCHIVE <Archive Output Artifacts>` target files.
|
| 6 |
+
|
| 7 |
+
This is a per-configuration version of the
|
| 8 |
+
:prop_tgt:`ARCHIVE_OUTPUT_DIRECTORY` target property, but
|
| 9 |
+
multi-configuration generators (VS, Xcode) do NOT append a
|
| 10 |
+
per-configuration subdirectory to the specified directory. This
|
| 11 |
+
property is initialized by the value of the
|
| 12 |
+
:variable:`CMAKE_ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>` variable if
|
| 13 |
+
it is set when a target is created.
|
| 14 |
+
|
| 15 |
+
Contents of ``ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>`` may use
|
| 16 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ARCHIVE_OUTPUT_NAME
|
| 2 |
+
-------------------
|
| 3 |
+
|
| 4 |
+
.. |XXX| replace:: :ref:`ARCHIVE <Archive Output Artifacts>`
|
| 5 |
+
.. |xxx| replace:: archive
|
| 6 |
+
.. include:: XXX_OUTPUT_NAME.txt
|
| 7 |
+
|
| 8 |
+
.. |IDEM| replace:: with the same name
|
| 9 |
+
.. include:: MACOS_IMPORT_FILES.txt
|
| 10 |
+
|
| 11 |
+
See also the :prop_tgt:`ARCHIVE_OUTPUT_NAME_<CONFIG>` target property.
|
cmake/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.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_BETTER_GRAPH_MULTI_CONFIG.rst
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOGEN_BETTER_GRAPH_MULTI_CONFIG
|
| 2 |
+
---------------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.29
|
| 5 |
+
|
| 6 |
+
``AUTOGEN_BETTER_GRAPH_MULTI_CONFIG`` is a boolean property that can be set
|
| 7 |
+
on a target to have better dependency graph for multi-configuration generators.
|
| 8 |
+
When this property is enabled, ``CMake`` will generate more per-config targets.
|
| 9 |
+
Thus, the dependency graph will be more accurate for multi-configuration
|
| 10 |
+
generators and some recompilations will be avoided.
|
| 11 |
+
|
| 12 |
+
If the Qt version is 6.8 or newer, this property is enabled by default.
|
| 13 |
+
If the Qt version is older than 6.8, this property is disabled by default.
|
| 14 |
+
Consult the Qt documentation to check if the property can be enabled for older
|
| 15 |
+
Qt versions.
|
| 16 |
+
|
| 17 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 18 |
+
with Qt.
|
| 19 |
+
|
| 20 |
+
This property is initialized by the
|
| 21 |
+
:variable:`CMAKE_AUTOGEN_BETTER_GRAPH_MULTI_CONFIG` variable if it is set when
|
| 22 |
+
a target is created.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOGEN_BUILD_DIR
|
| 2 |
+
-----------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.9
|
| 5 |
+
|
| 6 |
+
Directory where :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC`
|
| 7 |
+
generate files for the target.
|
| 8 |
+
|
| 9 |
+
The directory is created on demand and automatically added to the
|
| 10 |
+
:prop_tgt:`ADDITIONAL_CLEAN_FILES` target property.
|
| 11 |
+
|
| 12 |
+
When unset or empty the directory ``<dir>/<target-name>_autogen`` is used where
|
| 13 |
+
``<dir>`` is :variable:`CMAKE_CURRENT_BINARY_DIR` and ``<target-name>``
|
| 14 |
+
is :prop_tgt:`NAME`.
|
| 15 |
+
|
| 16 |
+
By default ``AUTOGEN_BUILD_DIR`` is unset.
|
| 17 |
+
|
| 18 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 19 |
+
with Qt.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_COMMAND_LINE_LENGTH_MAX.rst
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOGEN_COMMAND_LINE_LENGTH_MAX
|
| 2 |
+
-------------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.29
|
| 5 |
+
|
| 6 |
+
Command line length limit for autogen targets, i.e. ``moc`` or ``uic``,
|
| 7 |
+
that triggers the use of response files on Windows instead of passing all
|
| 8 |
+
arguments to the command line.
|
| 9 |
+
|
| 10 |
+
- An empty (or unset) value sets the limit to 32000
|
| 11 |
+
- A positive non zero integer value sets the exact command line length
|
| 12 |
+
limit.
|
| 13 |
+
|
| 14 |
+
By default ``AUTOGEN_COMMAND_LINE_LENGTH_MAX`` is initialized from
|
| 15 |
+
:variable:`CMAKE_AUTOGEN_COMMAND_LINE_LENGTH_MAX`.
|
| 16 |
+
|
| 17 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 18 |
+
with Qt.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOGEN_ORIGIN_DEPENDS
|
| 2 |
+
----------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.14
|
| 5 |
+
|
| 6 |
+
Switch for forwarding origin target dependencies to the corresponding
|
| 7 |
+
:ref:`<ORIGIN>_autogen` target.
|
| 8 |
+
|
| 9 |
+
.. note::
|
| 10 |
+
|
| 11 |
+
If Qt 5.15 or later is used and the generator is either :generator:`Ninja`
|
| 12 |
+
or :ref:`Makefile Generators`, origin target dependencies are forwarded to
|
| 13 |
+
the :ref:`<ORIGIN>_autogen_timestamp_deps` target instead of
|
| 14 |
+
:ref:`<ORIGIN>_autogen`
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
Targets which have their :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` property
|
| 18 |
+
``ON`` have a corresponding :ref:`<ORIGIN>_autogen` target which generates
|
| 19 |
+
``moc`` and ``uic`` files. As this :ref:`<ORIGIN>_autogen` target is created at
|
| 20 |
+
generate-time, it is not possible to define dependencies of it using
|
| 21 |
+
e.g. :command:`add_dependencies`. Instead the ``AUTOGEN_ORIGIN_DEPENDS``
|
| 22 |
+
target property decides whether the origin target dependencies should be
|
| 23 |
+
forwarded to the :ref:`<ORIGIN>_autogen` target or not.
|
| 24 |
+
|
| 25 |
+
By default ``AUTOGEN_ORIGIN_DEPENDS`` is initialized from
|
| 26 |
+
:variable:`CMAKE_AUTOGEN_ORIGIN_DEPENDS` which is ``ON`` by default.
|
| 27 |
+
|
| 28 |
+
In total the dependencies of the :ref:`<ORIGIN>_autogen` target are composed
|
| 29 |
+
from
|
| 30 |
+
|
| 31 |
+
- forwarded origin target dependencies
|
| 32 |
+
(enabled by default via ``AUTOGEN_ORIGIN_DEPENDS``)
|
| 33 |
+
- additional user defined dependencies from :prop_tgt:`AUTOGEN_TARGET_DEPENDS`
|
| 34 |
+
|
| 35 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 36 |
+
with Qt.
|
| 37 |
+
|
| 38 |
+
.. note::
|
| 39 |
+
|
| 40 |
+
Disabling ``AUTOGEN_ORIGIN_DEPENDS`` is useful to avoid building of
|
| 41 |
+
origin target dependencies when building the :ref:`<ORIGIN>_autogen` target
|
| 42 |
+
only. This is especially interesting when a
|
| 43 |
+
:variable:`global autogen target <CMAKE_GLOBAL_AUTOGEN_TARGET>` is enabled.
|
| 44 |
+
|
| 45 |
+
When the :ref:`<ORIGIN>_autogen` target doesn't require all the origin target's
|
| 46 |
+
dependencies, and ``AUTOGEN_ORIGIN_DEPENDS`` is disabled, it might be
|
| 47 |
+
necessary to extend :prop_tgt:`AUTOGEN_TARGET_DEPENDS` to add missing
|
| 48 |
+
dependencies.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_PARALLEL.rst
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOGEN_PARALLEL
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.11
|
| 5 |
+
|
| 6 |
+
Number of parallel ``moc`` or ``uic`` processes to start when using
|
| 7 |
+
:prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`.
|
| 8 |
+
|
| 9 |
+
The custom :ref:`<ORIGIN>_autogen` target starts a number of threads of which
|
| 10 |
+
each one parses a source file and on demand starts a ``moc`` or ``uic``
|
| 11 |
+
process. ``AUTOGEN_PARALLEL`` controls how many parallel threads
|
| 12 |
+
(and therefore ``moc`` or ``uic`` processes) are started.
|
| 13 |
+
|
| 14 |
+
- An empty (or unset) value or the string ``AUTO`` sets the number of
|
| 15 |
+
threads/processes to the number of physical CPUs on the host system.
|
| 16 |
+
- A positive non zero integer value sets the exact thread/process count.
|
| 17 |
+
- Otherwise a single thread/process is started.
|
| 18 |
+
|
| 19 |
+
By default ``AUTOGEN_PARALLEL`` is initialized from
|
| 20 |
+
:variable:`CMAKE_AUTOGEN_PARALLEL`.
|
| 21 |
+
|
| 22 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 23 |
+
with Qt.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOGEN_TARGET_DEPENDS
|
| 2 |
+
----------------------
|
| 3 |
+
|
| 4 |
+
Additional target dependencies of the corresponding :ref:`<ORIGIN>_autogen`
|
| 5 |
+
target.
|
| 6 |
+
|
| 7 |
+
.. note::
|
| 8 |
+
|
| 9 |
+
If Qt 5.15 or later is used and the generator is either :generator:`Ninja`
|
| 10 |
+
or :ref:`Makefile Generators`, additional target dependencies are added to
|
| 11 |
+
the :ref:`<ORIGIN>_autogen_timestamp_deps` target instead of the
|
| 12 |
+
:ref:`<ORIGIN>_autogen` target.
|
| 13 |
+
|
| 14 |
+
|
| 15 |
+
Targets which have their :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` property
|
| 16 |
+
``ON`` have a corresponding :ref:`<ORIGIN>_autogen` target which generates
|
| 17 |
+
``moc`` and ``uic`` files. As this :ref:`<ORIGIN>_autogen` target is created
|
| 18 |
+
at generate-time, it is not possible to define dependencies of it using e.g.
|
| 19 |
+
:command:`add_dependencies`. Instead the ``AUTOGEN_TARGET_DEPENDS`` target
|
| 20 |
+
property can be set to a :ref:`;-list <CMake Language Lists>` of additional
|
| 21 |
+
dependencies for the :ref:`<ORIGIN>_autogen` target. Dependencies can be target
|
| 22 |
+
names or file names.
|
| 23 |
+
|
| 24 |
+
In total the dependencies of the :ref:`<ORIGIN>_autogen` target are composed
|
| 25 |
+
from
|
| 26 |
+
|
| 27 |
+
- forwarded origin target dependencies
|
| 28 |
+
(enabled by default via :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS`)
|
| 29 |
+
- additional user defined dependencies from ``AUTOGEN_TARGET_DEPENDS``
|
| 30 |
+
|
| 31 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 32 |
+
with Qt.
|
| 33 |
+
|
| 34 |
+
Use cases
|
| 35 |
+
^^^^^^^^^
|
| 36 |
+
|
| 37 |
+
If :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` depends on a file that is either
|
| 38 |
+
|
| 39 |
+
- a :prop_sf:`GENERATED` non C++ file (e.g. a :prop_sf:`GENERATED` ``.json``
|
| 40 |
+
or ``.ui`` file) or
|
| 41 |
+
- a :prop_sf:`GENERATED` C++ file that isn't recognized by :prop_tgt:`AUTOMOC`
|
| 42 |
+
and :prop_tgt:`AUTOUIC` because it's skipped by :prop_sf:`SKIP_AUTOMOC`,
|
| 43 |
+
:prop_sf:`SKIP_AUTOUIC`, :prop_sf:`SKIP_AUTOGEN` or :policy:`CMP0071` or
|
| 44 |
+
- a file that isn't in the origin target's sources
|
| 45 |
+
|
| 46 |
+
it must be added to ``AUTOGEN_TARGET_DEPENDS``.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_USE_SYSTEM_INCLUDE.rst
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOGEN_USE_SYSTEM_INCLUDE
|
| 2 |
+
--------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.27
|
| 5 |
+
|
| 6 |
+
``AUTOGEN_USE_SYSTEM_INCLUDE`` is a boolean property that can be set
|
| 7 |
+
on a target to indicate that the autogen target include directory should
|
| 8 |
+
be added as a system include directory or normal include directory to the
|
| 9 |
+
target.
|
| 10 |
+
|
| 11 |
+
If this property is not set, the autogen target include directory is added
|
| 12 |
+
as a system include directory by default. See policy :policy:`CMP0151`.
|
| 13 |
+
|
| 14 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 15 |
+
with Qt.
|
| 16 |
+
|
| 17 |
+
This property is initialized by the
|
| 18 |
+
:variable:`CMAKE_AUTOGEN_USE_SYSTEM_INCLUDE` variable if it is set when
|
| 19 |
+
a target is created.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC.rst
ADDED
|
@@ -0,0 +1,257 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOMOC
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
Should the target be processed with auto-moc (for Qt projects).
|
| 5 |
+
|
| 6 |
+
``AUTOMOC`` is a boolean specifying whether CMake will handle the Qt ``moc``
|
| 7 |
+
preprocessor automatically, i.e. without having to use commands like
|
| 8 |
+
:module:`QT4_WRAP_CPP() <FindQt4>`, `qt5_wrap_cpp()`_, etc.
|
| 9 |
+
Currently, Qt versions 4 to 6 are supported.
|
| 10 |
+
|
| 11 |
+
.. _qt5_wrap_cpp(): https://doc.qt.io/qt-5/qtcore-cmake-qt5-wrap-cpp.html
|
| 12 |
+
|
| 13 |
+
This property is initialized by the value of the :variable:`CMAKE_AUTOMOC`
|
| 14 |
+
variable if it is set when a target is created.
|
| 15 |
+
|
| 16 |
+
When this property is set ``ON``, CMake will scan the header and
|
| 17 |
+
source files at build time and invoke ``moc`` accordingly.
|
| 18 |
+
|
| 19 |
+
|
| 20 |
+
Header file processing
|
| 21 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 22 |
+
|
| 23 |
+
At configuration time, a list of header files that should be scanned by
|
| 24 |
+
``AUTOMOC`` is computed from the target's sources.
|
| 25 |
+
|
| 26 |
+
- All header files in the target's sources are added to the scan list.
|
| 27 |
+
- For all C++ source files ``<source_base>.<source_extension>`` in the
|
| 28 |
+
target's sources, CMake searches for
|
| 29 |
+
|
| 30 |
+
- a regular header with the same base name
|
| 31 |
+
(``<source_base>.<header_extention>``) and
|
| 32 |
+
- a private header with the same base name and a ``_p`` suffix
|
| 33 |
+
(``<source_base>_p.<header_extention>``)
|
| 34 |
+
|
| 35 |
+
and adds these to the scan list.
|
| 36 |
+
|
| 37 |
+
At build time, CMake scans each unknown or modified header file from the
|
| 38 |
+
list and searches for
|
| 39 |
+
|
| 40 |
+
- a Qt macro from :prop_tgt:`AUTOMOC_MACRO_NAMES`,
|
| 41 |
+
- additional file dependencies from the ``FILE`` argument of a
|
| 42 |
+
``Q_PLUGIN_METADATA`` macro and
|
| 43 |
+
- additional file dependencies detected by filters defined in
|
| 44 |
+
:prop_tgt:`AUTOMOC_DEPEND_FILTERS`.
|
| 45 |
+
|
| 46 |
+
If a Qt macro is found, then the header will be compiled by the ``moc`` to the
|
| 47 |
+
output file ``moc_<base_name>.cpp``. The complete output file path is
|
| 48 |
+
described in the section `Output file location`_.
|
| 49 |
+
|
| 50 |
+
The header will be ``moc`` compiled again if a file from the additional file
|
| 51 |
+
dependencies changes.
|
| 52 |
+
|
| 53 |
+
Header ``moc`` output files ``moc_<base_name>.cpp`` can be included in source
|
| 54 |
+
files. In the section `Including header moc files in sources`_ there is more
|
| 55 |
+
information on that topic.
|
| 56 |
+
|
| 57 |
+
|
| 58 |
+
Source file processing
|
| 59 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 60 |
+
|
| 61 |
+
At build time, CMake scans each unknown or modified C++ source file from the
|
| 62 |
+
target's sources for
|
| 63 |
+
|
| 64 |
+
- a Qt macro from :prop_tgt:`AUTOMOC_MACRO_NAMES`,
|
| 65 |
+
- includes of header ``moc`` files
|
| 66 |
+
(see `Including header moc files in sources`_),
|
| 67 |
+
- additional file dependencies from the ``FILE`` argument of a
|
| 68 |
+
``Q_PLUGIN_METADATA`` macro and
|
| 69 |
+
- additional file dependencies detected by filters defined in
|
| 70 |
+
:prop_tgt:`AUTOMOC_DEPEND_FILTERS`.
|
| 71 |
+
|
| 72 |
+
If a Qt macro is found, then the C++ source file
|
| 73 |
+
``<base>.<source_extension>`` is expected to as well contain an include
|
| 74 |
+
statement
|
| 75 |
+
|
| 76 |
+
.. code-block:: c++
|
| 77 |
+
|
| 78 |
+
#include <<base>.moc> // or
|
| 79 |
+
#include "<base>.moc"
|
| 80 |
+
|
| 81 |
+
The source file then will be compiled by the ``moc`` to the output file
|
| 82 |
+
``<base>.moc``. A description of the complete output file path is in section
|
| 83 |
+
`Output file location`_.
|
| 84 |
+
|
| 85 |
+
The source will be ``moc`` compiled again if a file from the additional file
|
| 86 |
+
dependencies changes.
|
| 87 |
+
|
| 88 |
+
Including header moc files in sources
|
| 89 |
+
"""""""""""""""""""""""""""""""""""""
|
| 90 |
+
|
| 91 |
+
A source file can include the ``moc`` output file of a header
|
| 92 |
+
``<header_base>.<header_extension>`` by using an include statement of
|
| 93 |
+
the form
|
| 94 |
+
|
| 95 |
+
.. code-block:: c++
|
| 96 |
+
|
| 97 |
+
#include <moc_<header_base>.cpp> // or
|
| 98 |
+
#include "moc_<header_base>.cpp"
|
| 99 |
+
|
| 100 |
+
If the ``moc`` output file of a header is included by a source, it will
|
| 101 |
+
be generated in a different location than if it was not included. This is
|
| 102 |
+
described in the section `Output file location`_.
|
| 103 |
+
|
| 104 |
+
|
| 105 |
+
Output file location
|
| 106 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 107 |
+
|
| 108 |
+
Included moc output files
|
| 109 |
+
"""""""""""""""""""""""""
|
| 110 |
+
|
| 111 |
+
``moc`` output files that are included by a source file will be generated in
|
| 112 |
+
|
| 113 |
+
- ``<AUTOGEN_BUILD_DIR>/include``
|
| 114 |
+
for single configuration generators or in
|
| 115 |
+
- ``<AUTOGEN_BUILD_DIR>/include_<CONFIG>``
|
| 116 |
+
for :prop_gbl:`multi configuration <GENERATOR_IS_MULTI_CONFIG>` generators.
|
| 117 |
+
|
| 118 |
+
Where ``<AUTOGEN_BUILD_DIR>`` is the value of the target property
|
| 119 |
+
:prop_tgt:`AUTOGEN_BUILD_DIR`.
|
| 120 |
+
|
| 121 |
+
The include directory is automatically added to the target's
|
| 122 |
+
:prop_tgt:`INCLUDE_DIRECTORIES`.
|
| 123 |
+
|
| 124 |
+
Not included moc output files
|
| 125 |
+
"""""""""""""""""""""""""""""
|
| 126 |
+
|
| 127 |
+
``moc`` output files that are not included in a source file will be generated
|
| 128 |
+
in
|
| 129 |
+
|
| 130 |
+
- ``<AUTOGEN_BUILD_DIR>/<SOURCE_DIR_CHECKSUM>``
|
| 131 |
+
for single configuration generators or in,
|
| 132 |
+
- ``<AUTOGEN_BUILD_DIR>/include_<CONFIG>/<SOURCE_DIR_CHECKSUM>``
|
| 133 |
+
for :prop_gbl:`multi configuration <GENERATOR_IS_MULTI_CONFIG>` generators.
|
| 134 |
+
|
| 135 |
+
Where ``<SOURCE_DIR_CHECKSUM>`` is a checksum computed from the relative
|
| 136 |
+
parent directory path of the ``moc`` input file. This scheme allows to have
|
| 137 |
+
``moc`` input files with the same name in different directories.
|
| 138 |
+
|
| 139 |
+
All not included ``moc`` output files will be included automatically by the
|
| 140 |
+
CMake generated file
|
| 141 |
+
|
| 142 |
+
- ``<AUTOGEN_BUILD_DIR>/mocs_compilation.cpp``, or
|
| 143 |
+
- ``<AUTOGEN_BUILD_DIR>/mocs_compilation_$<CONFIG>.cpp``,
|
| 144 |
+
|
| 145 |
+
which is added to the target's sources.
|
| 146 |
+
|
| 147 |
+
|
| 148 |
+
Qt version detection
|
| 149 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 150 |
+
|
| 151 |
+
``AUTOMOC`` enabled targets need to know the Qt major and minor
|
| 152 |
+
version they're working with. The major version usually is provided by the
|
| 153 |
+
``INTERFACE_QT_MAJOR_VERSION`` property of the ``Qt[456]Core`` library,
|
| 154 |
+
that the target links to. To find the minor version, CMake builds a list of
|
| 155 |
+
available Qt versions from
|
| 156 |
+
|
| 157 |
+
- ``Qt6Core_VERSION_MAJOR`` and ``Qt6Core_VERSION_MINOR`` variables
|
| 158 |
+
(usually set by ``find_package(Qt6...)``)
|
| 159 |
+
- ``Qt6Core_VERSION_MAJOR`` and ``Qt6Core_VERSION_MINOR`` directory properties
|
| 160 |
+
- ``Qt5Core_VERSION_MAJOR`` and ``Qt5Core_VERSION_MINOR`` variables
|
| 161 |
+
(usually set by ``find_package(Qt5...)``)
|
| 162 |
+
- ``Qt5Core_VERSION_MAJOR`` and ``Qt5Core_VERSION_MINOR`` directory properties
|
| 163 |
+
- ``QT_VERSION_MAJOR`` and ``QT_VERSION_MINOR`` variables
|
| 164 |
+
(usually set by ``find_package(Qt4...)``)
|
| 165 |
+
- ``QT_VERSION_MAJOR`` and ``QT_VERSION_MINOR`` directory properties
|
| 166 |
+
|
| 167 |
+
in the context of the :command:`add_executable` or :command:`add_library` call.
|
| 168 |
+
|
| 169 |
+
Assumed ``INTERFACE_QT_MAJOR_VERSION`` is a valid number, the first
|
| 170 |
+
entry in the list with a matching major version is taken. If no matching major
|
| 171 |
+
version was found, an error is generated.
|
| 172 |
+
If ``INTERFACE_QT_MAJOR_VERSION`` is not a valid number, the first
|
| 173 |
+
entry in the list is taken.
|
| 174 |
+
|
| 175 |
+
A ``find_package(Qt[456]...)`` call sets the ``QT/Qt[56]Core_VERSION_MAJOR/MINOR``
|
| 176 |
+
variables. If the call is in a different context than the
|
| 177 |
+
:command:`add_executable` or :command:`add_library` call, e.g. in a function,
|
| 178 |
+
then the version variables might not be available to the ``AUTOMOC``
|
| 179 |
+
enabled target.
|
| 180 |
+
In that case the version variables can be forwarded from the
|
| 181 |
+
``find_package(Qt[456]...)`` calling context to the :command:`add_executable`
|
| 182 |
+
or :command:`add_library` calling context as directory properties.
|
| 183 |
+
The following Qt5 example demonstrates the procedure.
|
| 184 |
+
|
| 185 |
+
.. code-block:: cmake
|
| 186 |
+
|
| 187 |
+
function (add_qt5_client)
|
| 188 |
+
find_package(Qt5 REQUIRED QUIET COMPONENTS Core Widgets)
|
| 189 |
+
...
|
| 190 |
+
set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
|
| 191 |
+
PROPERTY Qt5Core_VERSION_MAJOR "${Qt5Core_VERSION_MAJOR}")
|
| 192 |
+
set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
|
| 193 |
+
PROPERTY Qt5Core_VERSION_MINOR "${Qt5Core_VERSION_MAJOR}")
|
| 194 |
+
...
|
| 195 |
+
endfunction ()
|
| 196 |
+
...
|
| 197 |
+
add_qt5_client()
|
| 198 |
+
add_executable(myTarget main.cpp)
|
| 199 |
+
target_link_libraries(myTarget Qt5::QtWidgets)
|
| 200 |
+
set_property(TARGET myTarget PROPERTY AUTOMOC ON)
|
| 201 |
+
|
| 202 |
+
|
| 203 |
+
Modifiers
|
| 204 |
+
^^^^^^^^^
|
| 205 |
+
|
| 206 |
+
:prop_tgt:`AUTOMOC_EXECUTABLE`:
|
| 207 |
+
The ``moc`` executable will be detected automatically, but can be forced to
|
| 208 |
+
a certain binary using this target property.
|
| 209 |
+
|
| 210 |
+
:prop_tgt:`AUTOMOC_MOC_OPTIONS`:
|
| 211 |
+
Additional command line options for ``moc`` can be set in this target property.
|
| 212 |
+
|
| 213 |
+
:prop_tgt:`AUTOMOC_MACRO_NAMES`:
|
| 214 |
+
This list of Qt macro names can be extended to search for additional macros in
|
| 215 |
+
headers and sources.
|
| 216 |
+
|
| 217 |
+
:prop_tgt:`AUTOMOC_DEPEND_FILTERS`:
|
| 218 |
+
``moc`` dependency file names can be extracted from headers or sources by
|
| 219 |
+
defining file name filters in this target property.
|
| 220 |
+
|
| 221 |
+
:prop_tgt:`AUTOMOC_COMPILER_PREDEFINES`:
|
| 222 |
+
Compiler pre definitions for ``moc`` are written to the ``moc_predefs.h`` file.
|
| 223 |
+
The generation of this file can be enabled or disabled in this target property.
|
| 224 |
+
|
| 225 |
+
:prop_sf:`SKIP_AUTOMOC`:
|
| 226 |
+
Sources and headers can be excluded from ``AUTOMOC`` processing by
|
| 227 |
+
setting this source file property.
|
| 228 |
+
|
| 229 |
+
:prop_sf:`SKIP_AUTOGEN`:
|
| 230 |
+
Source files can be excluded from ``AUTOMOC``,
|
| 231 |
+
:prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` processing by
|
| 232 |
+
setting this source file property.
|
| 233 |
+
|
| 234 |
+
:prop_gbl:`AUTOGEN_SOURCE_GROUP`:
|
| 235 |
+
This global property can be used to group files generated by
|
| 236 |
+
``AUTOMOC`` or :prop_tgt:`AUTORCC` together in an IDE, e.g. in MSVS.
|
| 237 |
+
|
| 238 |
+
:prop_gbl:`AUTOGEN_TARGETS_FOLDER`:
|
| 239 |
+
This global property can be used to group ``AUTOMOC``,
|
| 240 |
+
:prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` targets together in an IDE,
|
| 241 |
+
e.g. in MSVS.
|
| 242 |
+
|
| 243 |
+
:variable:`CMAKE_GLOBAL_AUTOGEN_TARGET`:
|
| 244 |
+
A global ``autogen`` target, that depends on all ``AUTOMOC`` or
|
| 245 |
+
:prop_tgt:`AUTOUIC` generated :ref:`<ORIGIN>_autogen` targets in the project,
|
| 246 |
+
will be generated when this variable is ``ON``.
|
| 247 |
+
|
| 248 |
+
:prop_tgt:`AUTOGEN_PARALLEL`:
|
| 249 |
+
This target property controls the number of ``moc`` or ``uic`` processes to
|
| 250 |
+
start in parallel during builds.
|
| 251 |
+
|
| 252 |
+
:prop_tgt:`AUTOGEN_COMMAND_LINE_LENGTH_MAX`:
|
| 253 |
+
This target property controls the limit when to use response files for
|
| 254 |
+
``moc`` or ``uic`` processes on Windows.
|
| 255 |
+
|
| 256 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 257 |
+
with Qt.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOMOC_COMPILER_PREDEFINES
|
| 2 |
+
---------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.10
|
| 5 |
+
|
| 6 |
+
Boolean value used by :prop_tgt:`AUTOMOC` to determine if the
|
| 7 |
+
compiler pre definitions file ``moc_predefs.h`` should be generated.
|
| 8 |
+
|
| 9 |
+
CMake generates a ``moc_predefs.h`` file with compiler pre definitions
|
| 10 |
+
from the output of the command defined in
|
| 11 |
+
:variable:`CMAKE_CXX_COMPILER_PREDEFINES_COMMAND <CMAKE_<LANG>_COMPILER_PREDEFINES_COMMAND>`
|
| 12 |
+
when
|
| 13 |
+
|
| 14 |
+
- :prop_tgt:`AUTOMOC` is enabled,
|
| 15 |
+
- ``AUTOMOC_COMPILER_PREDEFINES`` is enabled,
|
| 16 |
+
- :variable:`CMAKE_CXX_COMPILER_PREDEFINES_COMMAND <CMAKE_<LANG>_COMPILER_PREDEFINES_COMMAND>` isn't empty and
|
| 17 |
+
- the Qt version is greater or equal 5.8.
|
| 18 |
+
|
| 19 |
+
The ``moc_predefs.h`` file, which is generated in :prop_tgt:`AUTOGEN_BUILD_DIR`,
|
| 20 |
+
is passed to ``moc`` as the argument to the ``--include`` option.
|
| 21 |
+
|
| 22 |
+
By default ``AUTOMOC_COMPILER_PREDEFINES`` is initialized from
|
| 23 |
+
:variable:`CMAKE_AUTOMOC_COMPILER_PREDEFINES`, which is ON by default.
|
| 24 |
+
|
| 25 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 26 |
+
with Qt.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOMOC_DEPEND_FILTERS
|
| 2 |
+
----------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.9
|
| 5 |
+
|
| 6 |
+
Filter definitions used by :prop_tgt:`AUTOMOC` to extract file names from a
|
| 7 |
+
source file that are registered as additional dependencies for the
|
| 8 |
+
``moc`` file of the source file.
|
| 9 |
+
|
| 10 |
+
Filters are defined as ``KEYWORD;REGULAR_EXPRESSION`` pairs. First the file
|
| 11 |
+
content is searched for ``KEYWORD``. If it is found at least once, then file
|
| 12 |
+
names are extracted by successively searching for ``REGULAR_EXPRESSION`` and
|
| 13 |
+
taking the first match group.
|
| 14 |
+
|
| 15 |
+
The file name found in the first match group is searched for
|
| 16 |
+
|
| 17 |
+
- first in the vicinity of the source file
|
| 18 |
+
- and afterwards in the target's :prop_tgt:`INCLUDE_DIRECTORIES`.
|
| 19 |
+
|
| 20 |
+
If any of the extracted files changes, then the ``moc`` file for the source
|
| 21 |
+
file gets rebuilt even when the source file itself doesn't change.
|
| 22 |
+
|
| 23 |
+
If any of the extracted files is :prop_sf:`GENERATED` or if it is not in the
|
| 24 |
+
target's sources, then it might be necessary to add it to the
|
| 25 |
+
:ref:`<ORIGIN>_autogen` target dependencies.
|
| 26 |
+
See :prop_tgt:`AUTOGEN_TARGET_DEPENDS` for reference.
|
| 27 |
+
|
| 28 |
+
By default ``AUTOMOC_DEPEND_FILTERS`` is initialized from
|
| 29 |
+
:variable:`CMAKE_AUTOMOC_DEPEND_FILTERS`, which is empty by default.
|
| 30 |
+
|
| 31 |
+
From Qt 5.15.0 on this variable is ignored as ``moc`` is able to output the
|
| 32 |
+
correct dependencies.
|
| 33 |
+
|
| 34 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 35 |
+
with Qt.
|
| 36 |
+
|
| 37 |
+
|
| 38 |
+
Example 1
|
| 39 |
+
^^^^^^^^^
|
| 40 |
+
|
| 41 |
+
A header file ``my_class.hpp`` uses a custom macro ``JSON_FILE_MACRO`` which
|
| 42 |
+
is defined in an other header ``macros.hpp``.
|
| 43 |
+
We want the ``moc`` file of ``my_class.hpp`` to depend on the file name
|
| 44 |
+
argument of ``JSON_FILE_MACRO``::
|
| 45 |
+
|
| 46 |
+
// my_class.hpp
|
| 47 |
+
class My_Class : public QObject
|
| 48 |
+
{
|
| 49 |
+
Q_OBJECT
|
| 50 |
+
JSON_FILE_MACRO ( "info.json" )
|
| 51 |
+
...
|
| 52 |
+
};
|
| 53 |
+
|
| 54 |
+
In ``CMakeLists.txt`` we add a filter to
|
| 55 |
+
:variable:`CMAKE_AUTOMOC_DEPEND_FILTERS` like this::
|
| 56 |
+
|
| 57 |
+
list( APPEND CMAKE_AUTOMOC_DEPEND_FILTERS
|
| 58 |
+
"JSON_FILE_MACRO"
|
| 59 |
+
"[\n][ \t]*JSON_FILE_MACRO[ \t]*\\([ \t]*\"([^\"]+)\""
|
| 60 |
+
)
|
| 61 |
+
|
| 62 |
+
We assume ``info.json`` is a plain (not :prop_sf:`GENERATED`) file that is
|
| 63 |
+
listed in the target's source. Therefore we do not need to add it to
|
| 64 |
+
:prop_tgt:`AUTOGEN_TARGET_DEPENDS`.
|
| 65 |
+
|
| 66 |
+
Example 2
|
| 67 |
+
^^^^^^^^^
|
| 68 |
+
|
| 69 |
+
In the target ``my_target`` a header file ``complex_class.hpp`` uses a
|
| 70 |
+
custom macro ``JSON_BASED_CLASS`` which is defined in an other header
|
| 71 |
+
``macros.hpp``::
|
| 72 |
+
|
| 73 |
+
// macros.hpp
|
| 74 |
+
...
|
| 75 |
+
#define JSON_BASED_CLASS(name, json) \
|
| 76 |
+
class name : public QObject \
|
| 77 |
+
{ \
|
| 78 |
+
Q_OBJECT \
|
| 79 |
+
Q_PLUGIN_METADATA(IID "demo" FILE json) \
|
| 80 |
+
name() {} \
|
| 81 |
+
};
|
| 82 |
+
...
|
| 83 |
+
|
| 84 |
+
::
|
| 85 |
+
|
| 86 |
+
// complex_class.hpp
|
| 87 |
+
#pragma once
|
| 88 |
+
JSON_BASED_CLASS(Complex_Class, "meta.json")
|
| 89 |
+
// end of file
|
| 90 |
+
|
| 91 |
+
Since ``complex_class.hpp`` doesn't contain a ``Q_OBJECT`` macro it would be
|
| 92 |
+
ignored by :prop_tgt:`AUTOMOC`. We change this by adding ``JSON_BASED_CLASS``
|
| 93 |
+
to :variable:`CMAKE_AUTOMOC_MACRO_NAMES`::
|
| 94 |
+
|
| 95 |
+
list(APPEND CMAKE_AUTOMOC_MACRO_NAMES "JSON_BASED_CLASS")
|
| 96 |
+
|
| 97 |
+
We want the ``moc`` file of ``complex_class.hpp`` to depend on
|
| 98 |
+
``meta.json``. So we add a filter to
|
| 99 |
+
:variable:`CMAKE_AUTOMOC_DEPEND_FILTERS`::
|
| 100 |
+
|
| 101 |
+
list(APPEND CMAKE_AUTOMOC_DEPEND_FILTERS
|
| 102 |
+
"JSON_BASED_CLASS"
|
| 103 |
+
"[\n^][ \t]*JSON_BASED_CLASS[ \t]*\\([^,]*,[ \t]*\"([^\"]+)\""
|
| 104 |
+
)
|
| 105 |
+
|
| 106 |
+
Additionally we assume ``meta.json`` is :prop_sf:`GENERATED` which is
|
| 107 |
+
why we have to add it to :prop_tgt:`AUTOGEN_TARGET_DEPENDS`::
|
| 108 |
+
|
| 109 |
+
set_property(TARGET my_target APPEND PROPERTY AUTOGEN_TARGET_DEPENDS "meta.json")
|
cmake/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.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOMOC_MACRO_NAMES
|
| 2 |
+
-------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.10
|
| 5 |
+
|
| 6 |
+
A :ref:`semicolon-separated list <CMake Language Lists>` of macro names used by
|
| 7 |
+
:prop_tgt:`AUTOMOC` to determine if a C++ file needs to be processed by ``moc``.
|
| 8 |
+
|
| 9 |
+
This property is only used if the :prop_tgt:`AUTOMOC` property is ``ON``
|
| 10 |
+
for this target.
|
| 11 |
+
|
| 12 |
+
When running :prop_tgt:`AUTOMOC`, CMake searches for the strings listed in
|
| 13 |
+
``AUTOMOC_MACRO_NAMES`` in C++ source and header files.
|
| 14 |
+
If any of the strings is found
|
| 15 |
+
|
| 16 |
+
- as the first non space string on a new line or
|
| 17 |
+
- as the first non space string after a ``{`` on a new line,
|
| 18 |
+
|
| 19 |
+
then the file will be processed by ``moc``.
|
| 20 |
+
|
| 21 |
+
By default ``AUTOMOC_MACRO_NAMES`` is initialized from
|
| 22 |
+
:variable:`CMAKE_AUTOMOC_MACRO_NAMES`.
|
| 23 |
+
|
| 24 |
+
See also the :prop_tgt:`INTERFACE_AUTOMOC_MACRO_NAMES` target property.
|
| 25 |
+
|
| 26 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 27 |
+
with Qt.
|
| 28 |
+
|
| 29 |
+
Example
|
| 30 |
+
^^^^^^^
|
| 31 |
+
|
| 32 |
+
In this case the ``Q_OBJECT`` macro is hidden inside another macro
|
| 33 |
+
called ``CUSTOM_MACRO``. To let CMake know that source files that contain
|
| 34 |
+
``CUSTOM_MACRO`` need to be ``moc`` processed, we call:
|
| 35 |
+
|
| 36 |
+
.. code-block:: cmake
|
| 37 |
+
|
| 38 |
+
set_property(TARGET tgt APPEND PROPERTY AUTOMOC_MACRO_NAMES "CUSTOM_MACRO")
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOMOC_MOC_OPTIONS
|
| 2 |
+
-------------------
|
| 3 |
+
|
| 4 |
+
Additional options for ``moc`` when using :prop_tgt:`AUTOMOC`
|
| 5 |
+
|
| 6 |
+
This property is only used if the :prop_tgt:`AUTOMOC` property is ``ON``
|
| 7 |
+
for this target. In this case, it holds additional command line
|
| 8 |
+
options which will be used when ``moc`` is executed during the build, i.e.
|
| 9 |
+
it is equivalent to the optional ``OPTIONS`` argument of the
|
| 10 |
+
:module:`qt4_wrap_cpp() <FindQt4>` macro.
|
| 11 |
+
|
| 12 |
+
This property is initialized by the value of the
|
| 13 |
+
:variable:`CMAKE_AUTOMOC_MOC_OPTIONS` variable if it is set when a target
|
| 14 |
+
is created, or an empty string otherwise.
|
| 15 |
+
|
| 16 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 17 |
+
with Qt.
|
| 18 |
+
|
| 19 |
+
EXAMPLE
|
| 20 |
+
^^^^^^^
|
| 21 |
+
|
| 22 |
+
In this example, the ``moc`` tool is invoked with the ``-D_EXTRA_DEFINE``
|
| 23 |
+
option when generating the moc file for ``object.cpp``.
|
| 24 |
+
|
| 25 |
+
``CMakeLists.txt``
|
| 26 |
+
.. code-block:: cmake
|
| 27 |
+
|
| 28 |
+
add_executable(mocOptions object.cpp main.cpp)
|
| 29 |
+
set_property(TARGET mocOptions PROPERTY AUTOMOC ON)
|
| 30 |
+
target_compile_options(mocOptions PRIVATE "-D_EXTRA_DEFINE")
|
| 31 |
+
set_property(TARGET mocOptions PROPERTY AUTOMOC_MOC_OPTIONS "-D_EXTRA_DEFINE")
|
| 32 |
+
target_link_libraries(mocOptions Qt6::Core)
|
| 33 |
+
|
| 34 |
+
``object.hpp``
|
| 35 |
+
.. code-block:: c++
|
| 36 |
+
|
| 37 |
+
#ifndef Object_HPP
|
| 38 |
+
#define Object_HPP
|
| 39 |
+
|
| 40 |
+
#include <QObject>
|
| 41 |
+
|
| 42 |
+
#ifdef _EXTRA_DEFINE
|
| 43 |
+
class Object : public QObject
|
| 44 |
+
{
|
| 45 |
+
Q_OBJECT
|
| 46 |
+
public:
|
| 47 |
+
|
| 48 |
+
Object();
|
| 49 |
+
|
| 50 |
+
};
|
| 51 |
+
#endif
|
| 52 |
+
|
| 53 |
+
#endif
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOMOC_PATH_PREFIX
|
| 2 |
+
-------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.16
|
| 5 |
+
|
| 6 |
+
When this property is ``ON``, CMake will generate the ``-p`` path prefix
|
| 7 |
+
option for ``moc`` on :prop_tgt:`AUTOMOC` enabled Qt targets.
|
| 8 |
+
|
| 9 |
+
To generate the path prefix, CMake tests if the header compiled by ``moc``
|
| 10 |
+
is in any of the target
|
| 11 |
+
:command:`include directories <target_include_directories>`. If so, CMake will
|
| 12 |
+
compute the relative path accordingly. If the header is not in the
|
| 13 |
+
:command:`include directories <target_include_directories>`, CMake will omit
|
| 14 |
+
the ``-p`` path prefix option. ``moc`` usually generates a
|
| 15 |
+
relative include path in that case.
|
| 16 |
+
|
| 17 |
+
``AUTOMOC_PATH_PREFIX`` is initialized from the variable
|
| 18 |
+
:variable:`CMAKE_AUTOMOC_PATH_PREFIX`, which is ``OFF`` by default.
|
| 19 |
+
|
| 20 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 21 |
+
with Qt.
|
| 22 |
+
|
| 23 |
+
Reproducible builds
|
| 24 |
+
^^^^^^^^^^^^^^^^^^^
|
| 25 |
+
|
| 26 |
+
For reproducible builds it is recommended to keep headers that are ``moc``
|
| 27 |
+
compiled in one of the target
|
| 28 |
+
:command:`include directories <target_include_directories>` and set
|
| 29 |
+
``AUTOMOC_PATH_PREFIX`` to ``ON``. This ensures that:
|
| 30 |
+
|
| 31 |
+
- ``moc`` output files are identical on different build setups,
|
| 32 |
+
- ``moc`` output files will compile correctly when the source and/or
|
| 33 |
+
build directory is a symbolic link.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC.rst
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTORCC
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
Should the target be processed with auto-rcc (for Qt projects).
|
| 5 |
+
|
| 6 |
+
``AUTORCC`` is a boolean specifying whether CMake will handle
|
| 7 |
+
the Qt ``rcc`` code generator automatically, i.e. without having to use
|
| 8 |
+
commands like :module:`QT4_ADD_RESOURCES() <FindQt4>`, `qt5_add_resources()`_,
|
| 9 |
+
etc. Currently, Qt versions 4 to 6 are supported.
|
| 10 |
+
|
| 11 |
+
.. _`qt5_add_resources()`: https://doc.qt.io/qt-5/qtcore-cmake-qt5-add-resources.html
|
| 12 |
+
|
| 13 |
+
When this property is ``ON``, CMake will handle ``.qrc`` files added
|
| 14 |
+
as target sources at build time and invoke ``rcc`` accordingly.
|
| 15 |
+
This property is initialized by the value of the :variable:`CMAKE_AUTORCC`
|
| 16 |
+
variable if it is set when a target is created.
|
| 17 |
+
|
| 18 |
+
By default ``AUTORCC`` is processed by a
|
| 19 |
+
:command:`custom command <add_custom_command>`.
|
| 20 |
+
If the ``.qrc`` file is :prop_sf:`GENERATED`, a
|
| 21 |
+
:command:`custom target <add_custom_target>` is used instead.
|
| 22 |
+
|
| 23 |
+
When there are multiple ``.qrc`` files with the same name, CMake will
|
| 24 |
+
generate unspecified unique output file names for ``rcc``. Therefore, if
|
| 25 |
+
``Q_INIT_RESOURCE()`` or ``Q_CLEANUP_RESOURCE()`` need to be used, the
|
| 26 |
+
``.qrc`` file name must be unique.
|
| 27 |
+
|
| 28 |
+
|
| 29 |
+
Modifiers
|
| 30 |
+
^^^^^^^^^
|
| 31 |
+
|
| 32 |
+
:prop_tgt:`AUTORCC_EXECUTABLE`:
|
| 33 |
+
The ``rcc`` executable will be detected automatically, but can be forced to
|
| 34 |
+
a certain binary by setting this target property.
|
| 35 |
+
|
| 36 |
+
:prop_tgt:`AUTORCC_OPTIONS`:
|
| 37 |
+
Additional command line options for ``rcc`` can be set via this target
|
| 38 |
+
property. The corresponding :prop_sf:`AUTORCC_OPTIONS` source file property
|
| 39 |
+
can be used to specify options to be applied only to a specific ``.qrc`` file.
|
| 40 |
+
|
| 41 |
+
:prop_sf:`SKIP_AUTORCC`:
|
| 42 |
+
``.qrc`` files can be excluded from ``AUTORCC`` processing by
|
| 43 |
+
setting this source file property.
|
| 44 |
+
|
| 45 |
+
:prop_sf:`SKIP_AUTOGEN`:
|
| 46 |
+
Source files can be excluded from :prop_tgt:`AUTOMOC`,
|
| 47 |
+
:prop_tgt:`AUTOUIC` and ``AUTORCC`` processing by
|
| 48 |
+
setting this source file property.
|
| 49 |
+
|
| 50 |
+
:prop_gbl:`AUTOGEN_SOURCE_GROUP`:
|
| 51 |
+
This global property can be used to group files generated by
|
| 52 |
+
:prop_tgt:`AUTOMOC` or ``AUTORCC`` together in an IDE, e.g. in MSVS.
|
| 53 |
+
|
| 54 |
+
:prop_gbl:`AUTOGEN_TARGETS_FOLDER`:
|
| 55 |
+
This global property can be used to group :prop_tgt:`AUTOMOC`,
|
| 56 |
+
:prop_tgt:`AUTOUIC` and ``AUTORCC`` targets together in an IDE,
|
| 57 |
+
e.g. in MSVS.
|
| 58 |
+
|
| 59 |
+
:variable:`CMAKE_GLOBAL_AUTORCC_TARGET`:
|
| 60 |
+
A global ``autorcc`` target that depends on all ``AUTORCC`` targets
|
| 61 |
+
in the project will be generated when this variable is ``ON``.
|
| 62 |
+
|
| 63 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 64 |
+
with Qt.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC_EXECUTABLE.rst
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTORCC_EXECUTABLE
|
| 2 |
+
------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.14
|
| 5 |
+
|
| 6 |
+
``AUTORCC_EXECUTABLE`` is file path pointing to the ``rcc``
|
| 7 |
+
executable to use for :prop_tgt:`AUTORCC` enabled files. Setting
|
| 8 |
+
this property will make CMake skip the automatic detection of the
|
| 9 |
+
``rcc`` 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 ``rcc`` can not work -- e.g. because
|
| 14 |
+
you are building the ``rcc`` binary as part of your project.
|
| 15 |
+
|
| 16 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 17 |
+
with Qt.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC_OPTIONS.rst
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTORCC_OPTIONS
|
| 2 |
+
---------------
|
| 3 |
+
|
| 4 |
+
Additional options for ``rcc`` when using :prop_tgt:`AUTORCC`
|
| 5 |
+
|
| 6 |
+
This property holds additional command line options which will be used
|
| 7 |
+
when ``rcc`` is executed during the build via :prop_tgt:`AUTORCC`,
|
| 8 |
+
i.e. it is equivalent to the optional ``OPTIONS`` argument of the
|
| 9 |
+
:module:`qt4_add_resources() <FindQt4>` macro.
|
| 10 |
+
|
| 11 |
+
This property is initialized by the value of the
|
| 12 |
+
:variable:`CMAKE_AUTORCC_OPTIONS` variable if it is set when a target is
|
| 13 |
+
created, or an empty string otherwise.
|
| 14 |
+
|
| 15 |
+
The options set on the target may be overridden by :prop_sf:`AUTORCC_OPTIONS`
|
| 16 |
+
set on the ``.qrc`` source file.
|
| 17 |
+
|
| 18 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 19 |
+
with Qt.
|
| 20 |
+
|
| 21 |
+
EXAMPLE
|
| 22 |
+
^^^^^^^
|
| 23 |
+
|
| 24 |
+
.. code-block:: cmake
|
| 25 |
+
|
| 26 |
+
# ...
|
| 27 |
+
set_property(TARGET tgt PROPERTY AUTORCC_OPTIONS "--compress;9")
|
| 28 |
+
# ...
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC.rst
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOUIC
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
Should the target be processed with auto-uic (for Qt projects).
|
| 5 |
+
|
| 6 |
+
``AUTOUIC`` is a boolean specifying whether CMake will handle
|
| 7 |
+
the Qt ``uic`` code generator automatically, i.e. without having to use
|
| 8 |
+
commands like :module:`QT4_WRAP_UI() <FindQt4>`, `qt5_wrap_ui()`_, etc.
|
| 9 |
+
Currently, Qt versions 4 to 6 are supported.
|
| 10 |
+
|
| 11 |
+
.. _`qt5_wrap_ui()`: https://doc.qt.io/qt-5/qtwidgets-cmake-qt5-wrap-ui.html
|
| 12 |
+
|
| 13 |
+
This property is initialized by the value of the :variable:`CMAKE_AUTOUIC`
|
| 14 |
+
variable if it is set when a target is created.
|
| 15 |
+
|
| 16 |
+
When this property is ``ON``, CMake will scan the header and source files at
|
| 17 |
+
build time and invoke ``uic`` accordingly.
|
| 18 |
+
|
| 19 |
+
|
| 20 |
+
Header and source file processing
|
| 21 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 22 |
+
|
| 23 |
+
At build time, CMake scans each header and source file from the
|
| 24 |
+
target's sources for include statements of the form
|
| 25 |
+
|
| 26 |
+
.. code-block:: c++
|
| 27 |
+
|
| 28 |
+
#include "ui_<ui_base>.h"
|
| 29 |
+
|
| 30 |
+
Once such an include statement is found in a file, CMake searches for the
|
| 31 |
+
``uic`` input file ``<ui_base>.ui``
|
| 32 |
+
|
| 33 |
+
- in the vicinity of the file and
|
| 34 |
+
- in the :prop_tgt:`AUTOUIC_SEARCH_PATHS` of the target.
|
| 35 |
+
|
| 36 |
+
If the ``<ui_base>.ui`` file was found, ``uic`` is called on it to generate
|
| 37 |
+
``ui_<ui_base>.h`` in the directory
|
| 38 |
+
|
| 39 |
+
- ``<AUTOGEN_BUILD_DIR>/include`` for single configuration generators or in
|
| 40 |
+
- ``<AUTOGEN_BUILD_DIR>/include_<CONFIG>`` for
|
| 41 |
+
:prop_gbl:`multi configuration <GENERATOR_IS_MULTI_CONFIG>` generators.
|
| 42 |
+
|
| 43 |
+
Where ``<AUTOGEN_BUILD_DIR>`` is the value of the target property
|
| 44 |
+
:prop_tgt:`AUTOGEN_BUILD_DIR`.
|
| 45 |
+
|
| 46 |
+
The include directory is automatically added to the target's
|
| 47 |
+
:prop_tgt:`INCLUDE_DIRECTORIES`.
|
| 48 |
+
|
| 49 |
+
|
| 50 |
+
Modifiers
|
| 51 |
+
^^^^^^^^^
|
| 52 |
+
|
| 53 |
+
:prop_tgt:`AUTOUIC_EXECUTABLE`:
|
| 54 |
+
The ``uic`` executable will be detected automatically, but can be forced to
|
| 55 |
+
a certain binary using this target property.
|
| 56 |
+
|
| 57 |
+
:prop_tgt:`AUTOUIC_OPTIONS`:
|
| 58 |
+
Additional command line options for ``uic`` can be set via this target
|
| 59 |
+
property. The corresponding :prop_sf:`AUTOUIC_OPTIONS` source file property
|
| 60 |
+
can be used to specify options to be applied only to a specific
|
| 61 |
+
``<base_name>.ui`` file.
|
| 62 |
+
|
| 63 |
+
:prop_sf:`SKIP_AUTOUIC`:
|
| 64 |
+
Source files can be excluded from ``AUTOUIC`` processing by setting
|
| 65 |
+
this source file property.
|
| 66 |
+
|
| 67 |
+
:prop_sf:`SKIP_AUTOGEN`:
|
| 68 |
+
Source files can be excluded from :prop_tgt:`AUTOMOC`,
|
| 69 |
+
``AUTOUIC`` and :prop_tgt:`AUTORCC` processing by
|
| 70 |
+
setting this source file property.
|
| 71 |
+
|
| 72 |
+
:prop_gbl:`AUTOGEN_TARGETS_FOLDER`:
|
| 73 |
+
This global property can be used to group :prop_tgt:`AUTOMOC`,
|
| 74 |
+
``AUTOUIC`` and :prop_tgt:`AUTORCC` targets together in an IDE,
|
| 75 |
+
e.g. in MSVS.
|
| 76 |
+
|
| 77 |
+
:variable:`CMAKE_GLOBAL_AUTOGEN_TARGET`:
|
| 78 |
+
A global ``autogen`` target, that depends on all :prop_tgt:`AUTOMOC` or
|
| 79 |
+
``AUTOUIC`` generated :ref:`<ORIGIN>_autogen` targets in the project,
|
| 80 |
+
will be generated when this variable is ``ON``.
|
| 81 |
+
|
| 82 |
+
:prop_tgt:`AUTOGEN_PARALLEL`:
|
| 83 |
+
This target property controls the number of ``moc`` or ``uic`` processes to
|
| 84 |
+
start in parallel during builds.
|
| 85 |
+
|
| 86 |
+
:prop_tgt:`AUTOGEN_COMMAND_LINE_LENGTH_MAX`:
|
| 87 |
+
This target property controls the limit when to use response files for
|
| 88 |
+
``moc`` or ``uic`` processes on Windows.
|
| 89 |
+
|
| 90 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 91 |
+
with Qt.
|
cmake/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.
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_OPTIONS.rst
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOUIC_OPTIONS
|
| 2 |
+
---------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.0
|
| 5 |
+
|
| 6 |
+
Additional options for ``uic`` when using :prop_tgt:`AUTOUIC`
|
| 7 |
+
|
| 8 |
+
This property holds additional command line options which will be used when
|
| 9 |
+
``uic`` is executed during the build via :prop_tgt:`AUTOUIC`, i.e. it is
|
| 10 |
+
equivalent to the optional ``OPTIONS`` argument of the
|
| 11 |
+
:module:`qt4_wrap_ui() <FindQt4>` macro.
|
| 12 |
+
|
| 13 |
+
This property is initialized by the value of the
|
| 14 |
+
:variable:`CMAKE_AUTOUIC_OPTIONS` variable if it is set when a target is
|
| 15 |
+
created, or an empty string otherwise.
|
| 16 |
+
|
| 17 |
+
The options set on the target may be overridden by :prop_sf:`AUTOUIC_OPTIONS`
|
| 18 |
+
set on the ``.ui`` source file.
|
| 19 |
+
|
| 20 |
+
This property may use "generator expressions" with the syntax ``$<...>``.
|
| 21 |
+
See the :manual:`cmake-generator-expressions(7)` manual for available
|
| 22 |
+
expressions.
|
| 23 |
+
|
| 24 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 25 |
+
with Qt.
|
| 26 |
+
|
| 27 |
+
EXAMPLE
|
| 28 |
+
^^^^^^^
|
| 29 |
+
|
| 30 |
+
.. code-block:: cmake
|
| 31 |
+
|
| 32 |
+
# ...
|
| 33 |
+
set_property(TARGET tgt PROPERTY AUTOUIC_OPTIONS "--no-protection")
|
| 34 |
+
# ...
|
cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_SEARCH_PATHS.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
AUTOUIC_SEARCH_PATHS
|
| 2 |
+
--------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.9
|
| 5 |
+
|
| 6 |
+
Search path list used by :prop_tgt:`AUTOUIC` to find included
|
| 7 |
+
``.ui`` files.
|
| 8 |
+
|
| 9 |
+
This property is initialized by the value of the
|
| 10 |
+
:variable:`CMAKE_AUTOUIC_SEARCH_PATHS` variable if it is set
|
| 11 |
+
when a target is created. Otherwise it is empty.
|
| 12 |
+
|
| 13 |
+
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
| 14 |
+
with Qt.
|
cmake/share/cmake-3.31/Help/prop_tgt/BINARY_DIR.rst
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
BINARY_DIR
|
| 2 |
+
----------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.4
|
| 5 |
+
|
| 6 |
+
This read-only property reports the value of the
|
| 7 |
+
:variable:`CMAKE_CURRENT_BINARY_DIR` variable in the directory in which
|
| 8 |
+
the target was defined.
|
cmake/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.
|
cmake/share/cmake-3.31/Help/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
BUILD_RPATH_USE_ORIGIN
|
| 2 |
+
----------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.14
|
| 5 |
+
|
| 6 |
+
Whether to use relative paths for the build ``RPATH``.
|
| 7 |
+
|
| 8 |
+
This property is initialized by the value of the variable
|
| 9 |
+
:variable:`CMAKE_BUILD_RPATH_USE_ORIGIN`.
|
| 10 |
+
|
| 11 |
+
On platforms that support runtime paths (``RPATH``) with the
|
| 12 |
+
``$ORIGIN`` token, setting this property to ``TRUE`` enables relative
|
| 13 |
+
paths in the build ``RPATH`` for executables and shared libraries that
|
| 14 |
+
point to shared libraries in the same build tree.
|
| 15 |
+
|
| 16 |
+
Normally the build ``RPATH`` of a binary contains absolute paths
|
| 17 |
+
to the directory of each shared library it links to. The ``RPATH``
|
| 18 |
+
entries for directories contained within the build tree can be made
|
| 19 |
+
relative to enable relocatable builds and to help achieve reproducible
|
| 20 |
+
builds by omitting the build directory from the build environment.
|
| 21 |
+
|
| 22 |
+
This property has no effect on platforms that do not support the
|
| 23 |
+
``$ORIGIN`` token in ``RPATH``, or when the :variable:`CMAKE_SKIP_RPATH`
|
| 24 |
+
variable is set. The runtime path set through the
|
| 25 |
+
:prop_tgt:`BUILD_RPATH` target property is also unaffected by this
|
| 26 |
+
property.
|
cmake/share/cmake-3.31/Help/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
BUILD_WITH_INSTALL_NAME_DIR
|
| 2 |
+
---------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.9
|
| 5 |
+
|
| 6 |
+
``BUILD_WITH_INSTALL_NAME_DIR`` is a boolean specifying whether the macOS
|
| 7 |
+
``install_name`` of a target in the build tree uses the directory given by
|
| 8 |
+
:prop_tgt:`INSTALL_NAME_DIR`. This setting only applies to targets on macOS.
|
| 9 |
+
|
| 10 |
+
This property is initialized by the value of the variable
|
| 11 |
+
:variable:`CMAKE_BUILD_WITH_INSTALL_NAME_DIR` if it is set when a target is
|
| 12 |
+
created.
|
| 13 |
+
|
| 14 |
+
If this property is not set and policy :policy:`CMP0068` is not ``NEW``, the
|
| 15 |
+
value of :prop_tgt:`BUILD_WITH_INSTALL_RPATH` is used in its place.
|
cmake/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.
|
cmake/share/cmake-3.31/Help/prop_tgt/BUNDLE.rst
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
BUNDLE
|
| 2 |
+
------
|
| 3 |
+
|
| 4 |
+
This target is a ``CFBundle`` on the macOS.
|
| 5 |
+
|
| 6 |
+
If a module library target has this property set to true it will be
|
| 7 |
+
built as a ``CFBundle`` when built on the mac. It will have the directory
|
| 8 |
+
structure required for a ``CFBundle`` and will be suitable to be used for
|
| 9 |
+
creating Browser Plugins or other application resources.
|
cmake/share/cmake-3.31/Help/prop_tgt/BUNDLE_EXTENSION.rst
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
BUNDLE_EXTENSION
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
The file extension used to name a :prop_tgt:`BUNDLE`, a :prop_tgt:`FRAMEWORK`,
|
| 5 |
+
or a :prop_tgt:`MACOSX_BUNDLE` target on the macOS and iOS.
|
| 6 |
+
|
| 7 |
+
The default value is ``bundle``, ``framework``, or ``app`` for the respective
|
| 8 |
+
target types.
|
cmake/share/cmake-3.31/Help/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMMON_LANGUAGE_RUNTIME
|
| 2 |
+
-----------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.12
|
| 5 |
+
|
| 6 |
+
By setting this target property, the target is configured to build with
|
| 7 |
+
``C++/CLI`` support.
|
| 8 |
+
|
| 9 |
+
The Visual Studio generator defines the ``clr`` parameter depending on
|
| 10 |
+
the value of the ``COMMON_LANGUAGE_RUNTIME`` target property:
|
| 11 |
+
|
| 12 |
+
Not Set (default)
|
| 13 |
+
|
| 14 |
+
Native C++.
|
| 15 |
+
|
| 16 |
+
``""`` (set but empty)
|
| 17 |
+
|
| 18 |
+
Mixed unmanaged/managed C++ using .NET Framework.
|
| 19 |
+
|
| 20 |
+
``netcore``
|
| 21 |
+
.. versionadded:: 3.26
|
| 22 |
+
|
| 23 |
+
Mixed unmanaged/managed C++ using .NET Core.
|
| 24 |
+
|
| 25 |
+
This required VS 2019's v142 toolset or higher.
|
| 26 |
+
|
| 27 |
+
``pure``
|
| 28 |
+
|
| 29 |
+
Managed C++.
|
| 30 |
+
|
| 31 |
+
``safe``
|
| 32 |
+
|
| 33 |
+
Managed C++.
|
| 34 |
+
|
| 35 |
+
This property is only evaluated :ref:`Visual Studio Generators` for
|
| 36 |
+
VS 2010 and above.
|
| 37 |
+
|
| 38 |
+
To be able to build managed C++ targets with VS 2017 and above the component
|
| 39 |
+
``C++/CLI support`` must be installed, which may not be done by default.
|
| 40 |
+
|
| 41 |
+
See also :prop_tgt:`IMPORTED_COMMON_LANGUAGE_RUNTIME`
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPATIBLE_INTERFACE_BOOL
|
| 2 |
+
-------------------------
|
| 3 |
+
|
| 4 |
+
Properties which must be compatible with their link interface
|
| 5 |
+
|
| 6 |
+
The ``COMPATIBLE_INTERFACE_BOOL`` property may contain a list of
|
| 7 |
+
properties for this target which must be consistent when evaluated as a
|
| 8 |
+
boolean with the ``INTERFACE`` variant of the property in all linked
|
| 9 |
+
dependees. For example, if a property ``FOO`` appears in the list, then
|
| 10 |
+
for each dependee, the ``INTERFACE_FOO`` property content in all of its
|
| 11 |
+
dependencies must be consistent with each other, and with the ``FOO``
|
| 12 |
+
property in the depender.
|
| 13 |
+
|
| 14 |
+
Consistency in this sense has the meaning that if the property is set,
|
| 15 |
+
then it must have the same boolean value as all others, and if the
|
| 16 |
+
property is not set, then it is ignored.
|
| 17 |
+
|
| 18 |
+
Note that for each dependee, the set of properties specified in this
|
| 19 |
+
property must not intersect with the set specified in any of the other
|
| 20 |
+
:ref:`Compatible Interface Properties`.
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MAX.rst
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPATIBLE_INTERFACE_NUMBER_MAX
|
| 2 |
+
-------------------------------
|
| 3 |
+
|
| 4 |
+
Properties whose maximum value from the link interface will be used.
|
| 5 |
+
|
| 6 |
+
The ``COMPATIBLE_INTERFACE_NUMBER_MAX`` property may contain a list of
|
| 7 |
+
properties for this target whose maximum value may be read at generate
|
| 8 |
+
time when evaluated in the ``INTERFACE`` variant of the property in all
|
| 9 |
+
linked dependees. For example, if a property ``FOO`` appears in the list,
|
| 10 |
+
then for each dependee, the ``INTERFACE_FOO`` property content in all of
|
| 11 |
+
its dependencies will be compared with each other and with the ``FOO``
|
| 12 |
+
property in the depender. When reading the ``FOO`` property at generate
|
| 13 |
+
time, the maximum value will be returned. If the property is not set,
|
| 14 |
+
then it is ignored.
|
| 15 |
+
|
| 16 |
+
Note that for each dependee, the set of properties specified in this
|
| 17 |
+
property must not intersect with the set specified in any of the other
|
| 18 |
+
:ref:`Compatible Interface Properties`.
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MIN.rst
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPATIBLE_INTERFACE_NUMBER_MIN
|
| 2 |
+
-------------------------------
|
| 3 |
+
|
| 4 |
+
Properties whose minimum value from the link interface will be used.
|
| 5 |
+
|
| 6 |
+
The ``COMPATIBLE_INTERFACE_NUMBER_MIN`` property may contain a list of
|
| 7 |
+
properties for this target whose minimum value may be read at generate
|
| 8 |
+
time when evaluated in the ``INTERFACE`` variant of the property of all
|
| 9 |
+
linked dependees. For example, if a
|
| 10 |
+
property ``FOO`` appears in the list, then for each dependee, the
|
| 11 |
+
``INTERFACE_FOO`` property content in all of its dependencies will be
|
| 12 |
+
compared with each other and with the ``FOO`` property in the depender.
|
| 13 |
+
When reading the ``FOO`` property at generate time, the minimum value
|
| 14 |
+
will be returned. If the property is not set, then it is ignored.
|
| 15 |
+
|
| 16 |
+
Note that for each dependee, the set of properties specified in this
|
| 17 |
+
property must not intersect with the set specified in any of the other
|
| 18 |
+
:ref:`Compatible Interface Properties`.
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPATIBLE_INTERFACE_STRING
|
| 2 |
+
---------------------------
|
| 3 |
+
|
| 4 |
+
Properties which must be string-compatible with their link interface
|
| 5 |
+
|
| 6 |
+
The ``COMPATIBLE_INTERFACE_STRING`` property may contain a list of
|
| 7 |
+
properties for this target which must be the same when evaluated as a
|
| 8 |
+
string in the ``INTERFACE`` variant of the property all linked dependees.
|
| 9 |
+
For example, if a property ``FOO`` appears in the list, then for each
|
| 10 |
+
dependee, the ``INTERFACE_FOO`` property content in all of its
|
| 11 |
+
dependencies must be equal with each other, and with the ``FOO`` property
|
| 12 |
+
in the depender. If the property is not set, then it is ignored.
|
| 13 |
+
|
| 14 |
+
Note that for each dependee, the set of properties specified in this
|
| 15 |
+
property must not intersect with the set specified in any of the other
|
| 16 |
+
:ref:`Compatible Interface Properties`.
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_DEFINITIONS.rst
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPILE_DEFINITIONS
|
| 2 |
+
-------------------
|
| 3 |
+
|
| 4 |
+
Preprocessor definitions for compiling a target's sources.
|
| 5 |
+
|
| 6 |
+
The ``COMPILE_DEFINITIONS`` property may be set to a semicolon-separated
|
| 7 |
+
list of preprocessor definitions using the syntax ``VAR`` or ``VAR=value``.
|
| 8 |
+
Function-style definitions are not supported. CMake will
|
| 9 |
+
automatically escape the value correctly for the native build system
|
| 10 |
+
(note that CMake language syntax may require escapes to specify some
|
| 11 |
+
values).
|
| 12 |
+
|
| 13 |
+
CMake will automatically drop some definitions that are not supported
|
| 14 |
+
by the native build tool.
|
| 15 |
+
|
| 16 |
+
.. versionadded:: 3.26
|
| 17 |
+
Any leading ``-D`` on an item will be removed.
|
| 18 |
+
|
| 19 |
+
.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt
|
| 20 |
+
|
| 21 |
+
Contents of ``COMPILE_DEFINITIONS`` may use "generator expressions" with the
|
| 22 |
+
syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual
|
| 23 |
+
for available expressions. See the :manual:`cmake-buildsystem(7)` manual
|
| 24 |
+
for more on defining buildsystem properties.
|
| 25 |
+
|
| 26 |
+
The corresponding :prop_tgt:`COMPILE_DEFINITIONS_<CONFIG>` property may
|
| 27 |
+
be set to specify per-configuration definitions. Generator expressions
|
| 28 |
+
should be preferred instead of setting the alternative property.
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPILE_DEFINITIONS_<CONFIG>
|
| 2 |
+
----------------------------
|
| 3 |
+
|
| 4 |
+
Ignored. See CMake Policy :policy:`CMP0043`.
|
| 5 |
+
|
| 6 |
+
Per-configuration preprocessor definitions on a target.
|
| 7 |
+
|
| 8 |
+
This is the configuration-specific version of :prop_tgt:`COMPILE_DEFINITIONS`
|
| 9 |
+
where ``<CONFIG>`` is an upper-case name (ex. ``COMPILE_DEFINITIONS_DEBUG``).
|
| 10 |
+
|
| 11 |
+
Contents of ``COMPILE_DEFINITIONS_<CONFIG>`` may use "generator expressions"
|
| 12 |
+
with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
|
| 13 |
+
manual for available expressions. See the :manual:`cmake-buildsystem(7)`
|
| 14 |
+
manual for more on defining buildsystem properties.
|
| 15 |
+
|
| 16 |
+
Generator expressions should be preferred instead of setting this property.
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_FEATURES.rst
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPILE_FEATURES
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.1
|
| 5 |
+
|
| 6 |
+
Compiler features enabled for this target.
|
| 7 |
+
|
| 8 |
+
The list of features in this property are a subset of the features listed
|
| 9 |
+
in the :variable:`CMAKE_C_COMPILE_FEATURES`, :variable:`CMAKE_CUDA_COMPILE_FEATURES`, and
|
| 10 |
+
:variable:`CMAKE_CXX_COMPILE_FEATURES` variables.
|
| 11 |
+
|
| 12 |
+
Contents of ``COMPILE_FEATURES`` may use "generator expressions" with the
|
| 13 |
+
syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for
|
| 14 |
+
available expressions. See the :manual:`cmake-compile-features(7)` manual
|
| 15 |
+
for information on compile features and a list of supported compilers.
|
cmake/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.
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_OPTIONS.rst
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPILE_OPTIONS
|
| 2 |
+
---------------
|
| 3 |
+
|
| 4 |
+
List of options to pass to the compiler.
|
| 5 |
+
|
| 6 |
+
This property holds a :ref:`semicolon-separated list <CMake Language Lists>`
|
| 7 |
+
of options specified so far for its target. Use the
|
| 8 |
+
:command:`target_compile_options` command to append more options.
|
| 9 |
+
The options will be added after flags in the
|
| 10 |
+
:variable:`CMAKE_<LANG>_FLAGS` and :variable:`CMAKE_<LANG>_FLAGS_<CONFIG>`
|
| 11 |
+
variables, but before those propagated from dependencies by the
|
| 12 |
+
:prop_tgt:`INTERFACE_COMPILE_OPTIONS` property.
|
| 13 |
+
|
| 14 |
+
This property adds compile options for all languages in a target.
|
| 15 |
+
Use the :genex:`COMPILE_LANGUAGE` generator expression to specify
|
| 16 |
+
per-language compile options.
|
| 17 |
+
|
| 18 |
+
This property is initialized by the :prop_dir:`COMPILE_OPTIONS` directory
|
| 19 |
+
property when a target is created, and is used by the generators to set
|
| 20 |
+
the options for the compiler.
|
| 21 |
+
|
| 22 |
+
Contents of ``COMPILE_OPTIONS`` may use "generator expressions" with the
|
| 23 |
+
syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual
|
| 24 |
+
for available expressions. See the :manual:`cmake-buildsystem(7)` manual
|
| 25 |
+
for more on defining buildsystem properties.
|
| 26 |
+
|
| 27 |
+
.. include:: ../command/OPTIONS_SHELL.txt
|
cmake/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
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPILE_PDB_NAME_<CONFIG>
|
| 2 |
+
-------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.1
|
| 5 |
+
|
| 6 |
+
Per-configuration output name for the MS debug symbol ``.pdb`` file
|
| 7 |
+
generated by the compiler while building source files.
|
| 8 |
+
|
| 9 |
+
This is the configuration-specific version of :prop_tgt:`COMPILE_PDB_NAME`.
|
| 10 |
+
|
| 11 |
+
.. |PDB_XXX| replace:: :prop_tgt:`PDB_NAME_<CONFIG>`
|
| 12 |
+
.. include:: COMPILE_PDB_NOTE.txt
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NOTE.txt
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. note::
|
| 2 |
+
The compiler-generated program database files are specified by the
|
| 3 |
+
``/Fd`` compiler flag and are not the same as linker-generated
|
| 4 |
+
program database files specified by the ``/pdb`` linker flag.
|
| 5 |
+
Use the |PDB_XXX| property to specify the latter.
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPILE_PDB_OUTPUT_DIRECTORY
|
| 2 |
+
----------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.1
|
| 5 |
+
|
| 6 |
+
Output directory for the MS debug symbol ``.pdb`` file
|
| 7 |
+
generated by the compiler while building source files.
|
| 8 |
+
|
| 9 |
+
This property specifies the directory into which the MS debug symbols
|
| 10 |
+
will be placed by the compiler. This property is initialized by the
|
| 11 |
+
value of the :variable:`CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY` variable
|
| 12 |
+
if it is set when a target is created.
|
| 13 |
+
|
| 14 |
+
.. |PDB_XXX| replace:: :prop_tgt:`PDB_OUTPUT_DIRECTORY`
|
| 15 |
+
.. include:: COMPILE_PDB_NOTE.txt
|
cmake/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
|
cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
COMPILE_WARNING_AS_ERROR
|
| 2 |
+
------------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.24
|
| 5 |
+
|
| 6 |
+
Specify whether to treat warnings on compile as errors.
|
| 7 |
+
If enabled, adds a flag to treat warnings on compile as errors.
|
| 8 |
+
If the :option:`cmake --compile-no-warning-as-error` option is given
|
| 9 |
+
on the :manual:`cmake(1)` command line, this property is ignored.
|
| 10 |
+
|
| 11 |
+
This property is not implemented for all compilers. It is silently ignored
|
| 12 |
+
if there is no implementation for the compiler being used. The currently
|
| 13 |
+
implemented :variable:`compiler IDs <CMAKE_<LANG>_COMPILER_ID>` are:
|
| 14 |
+
|
| 15 |
+
* ``GNU``
|
| 16 |
+
* ``Clang``
|
| 17 |
+
* ``AppleClang``
|
| 18 |
+
* ``Fujitsu``
|
| 19 |
+
* ``FujitsuClang``
|
| 20 |
+
* ``IBMClang``
|
| 21 |
+
* ``Intel``
|
| 22 |
+
* ``IntelLLVM``
|
| 23 |
+
* ``LCC``
|
| 24 |
+
* ``MSVC``
|
| 25 |
+
* ``NVHPC``
|
| 26 |
+
* ``NVIDIA`` (CUDA)
|
| 27 |
+
* ``QCC``
|
| 28 |
+
* ``SunPro``
|
| 29 |
+
* ``Tasking``
|
| 30 |
+
* ``TI``
|
| 31 |
+
* ``VisualAge``
|
| 32 |
+
* ``XL``
|
| 33 |
+
* ``XLClang``
|
| 34 |
+
|
| 35 |
+
This property is initialized by the value of the variable
|
| 36 |
+
:variable:`CMAKE_COMPILE_WARNING_AS_ERROR` if it is set when a target is
|
| 37 |
+
created.
|
cmake/share/cmake-3.31/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<CONFIG>_OUTPUT_NAME
|
| 2 |
+
--------------------
|
| 3 |
+
|
| 4 |
+
Old per-configuration target file base name.
|
| 5 |
+
Use :prop_tgt:`OUTPUT_NAME_<CONFIG>` instead.
|
| 6 |
+
|
| 7 |
+
This is a configuration-specific version of the :prop_tgt:`OUTPUT_NAME`
|
| 8 |
+
target property.
|