diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/ANDROID_STL_TYPE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/ANDROID_STL_TYPE.rst new file mode 100644 index 0000000000000000000000000000000000000000..20b9acfd206465206ab33a712ad983086c67f1f4 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/ANDROID_STL_TYPE.rst @@ -0,0 +1,29 @@ +ANDROID_STL_TYPE +---------------- + +.. versionadded:: 3.4 + +When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio +Edition`, this property specifies the type of STL support for the project. +This is a string property that could set to the one of the following values: + +``none`` + No C++ Support +``system`` + Minimal C++ without STL +``gabi++_static`` + GAbi++ Static +``gabi++_shared`` + GAbi++ Shared +``gnustl_static`` + GNU libstdc++ Static +``gnustl_shared`` + GNU libstdc++ Shared +``stlport_static`` + STLport Static +``stlport_shared`` + STLport Shared + +This property is initialized by the value of the +:variable:`CMAKE_ANDROID_STL_TYPE` variable if it is set when a target is +created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000000000000000000000000000000000000..00620aa2037dcc9cde0d69498b61548cd6c9c7eb --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst @@ -0,0 +1,12 @@ +ARCHIVE_OUTPUT_DIRECTORY +------------------------ + +.. |XXX| replace:: :ref:`ARCHIVE ` +.. |xxx| replace:: archive +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_ARCHIVE_OUTPUT_DIRECTORY` +.. include:: XXX_OUTPUT_DIRECTORY.txt + +.. |IDEM| replace:: in the same directory +.. include:: MACOS_IMPORT_FILES.txt + +See also the :prop_tgt:`ARCHIVE_OUTPUT_DIRECTORY_` target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..bb965b2af66217db084b1ca60f46e34769025ee3 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,16 @@ +ARCHIVE_OUTPUT_DIRECTORY_ +--------------------------------- + +Per-configuration output directory for +:ref:`ARCHIVE ` target files. + +This is a per-configuration version of the +:prop_tgt:`ARCHIVE_OUTPUT_DIRECTORY` target property, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the +:variable:`CMAKE_ARCHIVE_OUTPUT_DIRECTORY_` variable if +it is set when a target is created. + +Contents of ``ARCHIVE_OUTPUT_DIRECTORY_`` may use +:manual:`generator expressions `. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..dcb25af0647f2c443f8e9a1ad27a04ae5ed2e9cd --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst @@ -0,0 +1,11 @@ +ARCHIVE_OUTPUT_NAME +------------------- + +.. |XXX| replace:: :ref:`ARCHIVE ` +.. |xxx| replace:: archive +.. include:: XXX_OUTPUT_NAME.txt + +.. |IDEM| replace:: with the same name +.. include:: MACOS_IMPORT_FILES.txt + +See also the :prop_tgt:`ARCHIVE_OUTPUT_NAME_` target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..356bebaeb6a1a873b370d209d6e82cb02e14aa4d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,8 @@ +ARCHIVE_OUTPUT_NAME_ +---------------------------- + +Per-configuration output name for +:ref:`ARCHIVE ` target files. + +This is the configuration-specific version of the +:prop_tgt:`ARCHIVE_OUTPUT_NAME` target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_BETTER_GRAPH_MULTI_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_BETTER_GRAPH_MULTI_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..0f1211892dacbe45b972e213098cd943c9e64d3d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_BETTER_GRAPH_MULTI_CONFIG.rst @@ -0,0 +1,22 @@ +AUTOGEN_BETTER_GRAPH_MULTI_CONFIG +--------------------------------- + +.. versionadded:: 3.29 + +``AUTOGEN_BETTER_GRAPH_MULTI_CONFIG`` is a boolean property that can be set +on a target to have better dependency graph for multi-configuration generators. +When this property is enabled, ``CMake`` will generate more per-config targets. +Thus, the dependency graph will be more accurate for multi-configuration +generators and some recompilations will be avoided. + +If the Qt version is 6.8 or newer, this property is enabled by default. +If the Qt version is older than 6.8, this property is disabled by default. +Consult the Qt documentation to check if the property can be enabled for older +Qt versions. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +This property is initialized by the +:variable:`CMAKE_AUTOGEN_BETTER_GRAPH_MULTI_CONFIG` variable if it is set when +a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst new file mode 100644 index 0000000000000000000000000000000000000000..d802e739834aff4ba4a697a8fdbae28a12df2247 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_BUILD_DIR.rst @@ -0,0 +1,19 @@ +AUTOGEN_BUILD_DIR +----------------- + +.. versionadded:: 3.9 + +Directory where :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` +generate files for the target. + +The directory is created on demand and automatically added to the +:prop_tgt:`ADDITIONAL_CLEAN_FILES` target property. + +When unset or empty the directory ``/_autogen`` is used where +```` is :variable:`CMAKE_CURRENT_BINARY_DIR` and ```` +is :prop_tgt:`NAME`. + +By default ``AUTOGEN_BUILD_DIR`` is unset. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_COMMAND_LINE_LENGTH_MAX.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_COMMAND_LINE_LENGTH_MAX.rst new file mode 100644 index 0000000000000000000000000000000000000000..3259ac293095d2d85501345842fbb4cb856df8f4 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_COMMAND_LINE_LENGTH_MAX.rst @@ -0,0 +1,18 @@ +AUTOGEN_COMMAND_LINE_LENGTH_MAX +------------------------------- + +.. versionadded:: 3.29 + +Command line length limit for autogen targets, i.e. ``moc`` or ``uic``, +that triggers the use of response files on Windows instead of passing all +arguments to the command line. + +- An empty (or unset) value sets the limit to 32000 +- A positive non zero integer value sets the exact command line length + limit. + +By default ``AUTOGEN_COMMAND_LINE_LENGTH_MAX`` is initialized from +:variable:`CMAKE_AUTOGEN_COMMAND_LINE_LENGTH_MAX`. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst new file mode 100644 index 0000000000000000000000000000000000000000..15374d0f0329a9180159f3738580fb7c27b43b98 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_ORIGIN_DEPENDS.rst @@ -0,0 +1,48 @@ +AUTOGEN_ORIGIN_DEPENDS +---------------------- + +.. versionadded:: 3.14 + +Switch for forwarding origin target dependencies to the corresponding +:ref:`_autogen` target. + + .. note:: + + If Qt 5.15 or later is used and the generator is either :generator:`Ninja` + or :ref:`Makefile Generators`, origin target dependencies are forwarded to + the :ref:`_autogen_timestamp_deps` target instead of + :ref:`_autogen` + + +Targets which have their :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` property +``ON`` have a corresponding :ref:`_autogen` target which generates +``moc`` and ``uic`` files. As this :ref:`_autogen` target is created at +generate-time, it is not possible to define dependencies of it using +e.g. :command:`add_dependencies`. Instead the ``AUTOGEN_ORIGIN_DEPENDS`` +target property decides whether the origin target dependencies should be +forwarded to the :ref:`_autogen` target or not. + +By default ``AUTOGEN_ORIGIN_DEPENDS`` is initialized from +:variable:`CMAKE_AUTOGEN_ORIGIN_DEPENDS` which is ``ON`` by default. + +In total the dependencies of the :ref:`_autogen` target are composed +from + +- forwarded origin target dependencies + (enabled by default via ``AUTOGEN_ORIGIN_DEPENDS``) +- additional user defined dependencies from :prop_tgt:`AUTOGEN_TARGET_DEPENDS` + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +.. note:: + + Disabling ``AUTOGEN_ORIGIN_DEPENDS`` is useful to avoid building of + origin target dependencies when building the :ref:`_autogen` target + only. This is especially interesting when a + :variable:`global autogen target ` is enabled. + + When the :ref:`_autogen` target doesn't require all the origin target's + dependencies, and ``AUTOGEN_ORIGIN_DEPENDS`` is disabled, it might be + necessary to extend :prop_tgt:`AUTOGEN_TARGET_DEPENDS` to add missing + dependencies. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_PARALLEL.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_PARALLEL.rst new file mode 100644 index 0000000000000000000000000000000000000000..5249efdf3ee9fdaf9191444476f776e570ae04c8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_PARALLEL.rst @@ -0,0 +1,23 @@ +AUTOGEN_PARALLEL +---------------- + +.. versionadded:: 3.11 + +Number of parallel ``moc`` or ``uic`` processes to start when using +:prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`. + +The custom :ref:`_autogen` target starts a number of threads of which +each one parses a source file and on demand starts a ``moc`` or ``uic`` +process. ``AUTOGEN_PARALLEL`` controls how many parallel threads +(and therefore ``moc`` or ``uic`` processes) are started. + +- An empty (or unset) value or the string ``AUTO`` sets the number of + threads/processes to the number of physical CPUs on the host system. +- A positive non zero integer value sets the exact thread/process count. +- Otherwise a single thread/process is started. + +By default ``AUTOGEN_PARALLEL`` is initialized from +:variable:`CMAKE_AUTOGEN_PARALLEL`. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst new file mode 100644 index 0000000000000000000000000000000000000000..01a53e009df48614a1cc150548158c98290dbee0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst @@ -0,0 +1,46 @@ +AUTOGEN_TARGET_DEPENDS +---------------------- + +Additional target dependencies of the corresponding :ref:`_autogen` +target. + + .. note:: + + If Qt 5.15 or later is used and the generator is either :generator:`Ninja` + or :ref:`Makefile Generators`, additional target dependencies are added to + the :ref:`_autogen_timestamp_deps` target instead of the + :ref:`_autogen` target. + + +Targets which have their :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` property +``ON`` have a corresponding :ref:`_autogen` target which generates +``moc`` and ``uic`` files. As this :ref:`_autogen` target is created +at generate-time, it is not possible to define dependencies of it using e.g. +:command:`add_dependencies`. Instead the ``AUTOGEN_TARGET_DEPENDS`` target +property can be set to a :ref:`;-list ` of additional +dependencies for the :ref:`_autogen` target. Dependencies can be target +names or file names. + +In total the dependencies of the :ref:`_autogen` target are composed +from + +- forwarded origin target dependencies + (enabled by default via :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS`) +- additional user defined dependencies from ``AUTOGEN_TARGET_DEPENDS`` + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +Use cases +^^^^^^^^^ + +If :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` depends on a file that is either + +- a :prop_sf:`GENERATED` non C++ file (e.g. a :prop_sf:`GENERATED` ``.json`` + or ``.ui`` file) or +- a :prop_sf:`GENERATED` C++ file that isn't recognized by :prop_tgt:`AUTOMOC` + and :prop_tgt:`AUTOUIC` because it's skipped by :prop_sf:`SKIP_AUTOMOC`, + :prop_sf:`SKIP_AUTOUIC`, :prop_sf:`SKIP_AUTOGEN` or :policy:`CMP0071` or +- a file that isn't in the origin target's sources + +it must be added to ``AUTOGEN_TARGET_DEPENDS``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_USE_SYSTEM_INCLUDE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_USE_SYSTEM_INCLUDE.rst new file mode 100644 index 0000000000000000000000000000000000000000..163b416ed5aded8dd2d81c84c86a6c2bf6505ba3 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOGEN_USE_SYSTEM_INCLUDE.rst @@ -0,0 +1,19 @@ +AUTOGEN_USE_SYSTEM_INCLUDE +-------------------------- + +.. versionadded:: 3.27 + +``AUTOGEN_USE_SYSTEM_INCLUDE`` is a boolean property that can be set +on a target to indicate that the autogen target include directory should +be added as a system include directory or normal include directory to the +target. + +If this property is not set, the autogen target include directory is added +as a system include directory by default. See policy :policy:`CMP0151`. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +This property is initialized by the +:variable:`CMAKE_AUTOGEN_USE_SYSTEM_INCLUDE` variable if it is set when +a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC.rst new file mode 100644 index 0000000000000000000000000000000000000000..93b237f6fb78929e941f118ae56a4d2d035134e8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC.rst @@ -0,0 +1,257 @@ +AUTOMOC +------- + +Should the target be processed with auto-moc (for Qt projects). + +``AUTOMOC`` is a boolean specifying whether CMake will handle the Qt ``moc`` +preprocessor automatically, i.e. without having to use commands like +:module:`QT4_WRAP_CPP() `, `qt5_wrap_cpp()`_, etc. +Currently, Qt versions 4 to 6 are supported. + +.. _qt5_wrap_cpp(): https://doc.qt.io/qt-5/qtcore-cmake-qt5-wrap-cpp.html + +This property is initialized by the value of the :variable:`CMAKE_AUTOMOC` +variable if it is set when a target is created. + +When this property is set ``ON``, CMake will scan the header and +source files at build time and invoke ``moc`` accordingly. + + +Header file processing +^^^^^^^^^^^^^^^^^^^^^^ + +At configuration time, a list of header files that should be scanned by +``AUTOMOC`` is computed from the target's sources. + +- All header files in the target's sources are added to the scan list. +- For all C++ source files ``.`` in the + target's sources, CMake searches for + + - a regular header with the same base name + (``.``) and + - a private header with the same base name and a ``_p`` suffix + (``_p.``) + + and adds these to the scan list. + +At build time, CMake scans each unknown or modified header file from the +list and searches for + +- a Qt macro from :prop_tgt:`AUTOMOC_MACRO_NAMES`, +- additional file dependencies from the ``FILE`` argument of a + ``Q_PLUGIN_METADATA`` macro and +- additional file dependencies detected by filters defined in + :prop_tgt:`AUTOMOC_DEPEND_FILTERS`. + +If a Qt macro is found, then the header will be compiled by the ``moc`` to the +output file ``moc_.cpp``. The complete output file path is +described in the section `Output file location`_. + +The header will be ``moc`` compiled again if a file from the additional file +dependencies changes. + +Header ``moc`` output files ``moc_.cpp`` can be included in source +files. In the section `Including header moc files in sources`_ there is more +information on that topic. + + +Source file processing +^^^^^^^^^^^^^^^^^^^^^^ + +At build time, CMake scans each unknown or modified C++ source file from the +target's sources for + +- a Qt macro from :prop_tgt:`AUTOMOC_MACRO_NAMES`, +- includes of header ``moc`` files + (see `Including header moc files in sources`_), +- additional file dependencies from the ``FILE`` argument of a + ``Q_PLUGIN_METADATA`` macro and +- additional file dependencies detected by filters defined in + :prop_tgt:`AUTOMOC_DEPEND_FILTERS`. + +If a Qt macro is found, then the C++ source file +``.`` is expected to as well contain an include +statement + +.. code-block:: c++ + + #include <.moc> // or + #include ".moc" + +The source file then will be compiled by the ``moc`` to the output file +``.moc``. A description of the complete output file path is in section +`Output file location`_. + +The source will be ``moc`` compiled again if a file from the additional file +dependencies changes. + +Including header moc files in sources +""""""""""""""""""""""""""""""""""""" + +A source file can include the ``moc`` output file of a header +``.`` by using an include statement of +the form + +.. code-block:: c++ + + #include .cpp> // or + #include "moc_.cpp" + +If the ``moc`` output file of a header is included by a source, it will +be generated in a different location than if it was not included. This is +described in the section `Output file location`_. + + +Output file location +^^^^^^^^^^^^^^^^^^^^ + +Included moc output files +""""""""""""""""""""""""" + +``moc`` output files that are included by a source file will be generated in + +- ``/include`` + for single configuration generators or in +- ``/include_`` + for :prop_gbl:`multi configuration ` generators. + +Where ```` is the value of the target property +:prop_tgt:`AUTOGEN_BUILD_DIR`. + +The include directory is automatically added to the target's +:prop_tgt:`INCLUDE_DIRECTORIES`. + +Not included moc output files +""""""""""""""""""""""""""""" + +``moc`` output files that are not included in a source file will be generated +in + +- ``/`` + for single configuration generators or in, +- ``/include_/`` + for :prop_gbl:`multi configuration ` generators. + +Where ```` is a checksum computed from the relative +parent directory path of the ``moc`` input file. This scheme allows to have +``moc`` input files with the same name in different directories. + +All not included ``moc`` output files will be included automatically by the +CMake generated file + +- ``/mocs_compilation.cpp``, or +- ``/mocs_compilation_$.cpp``, + +which is added to the target's sources. + + +Qt version detection +^^^^^^^^^^^^^^^^^^^^ + +``AUTOMOC`` enabled targets need to know the Qt major and minor +version they're working with. The major version usually is provided by the +``INTERFACE_QT_MAJOR_VERSION`` property of the ``Qt[456]Core`` library, +that the target links to. To find the minor version, CMake builds a list of +available Qt versions from + +- ``Qt6Core_VERSION_MAJOR`` and ``Qt6Core_VERSION_MINOR`` variables + (usually set by ``find_package(Qt6...)``) +- ``Qt6Core_VERSION_MAJOR`` and ``Qt6Core_VERSION_MINOR`` directory properties +- ``Qt5Core_VERSION_MAJOR`` and ``Qt5Core_VERSION_MINOR`` variables + (usually set by ``find_package(Qt5...)``) +- ``Qt5Core_VERSION_MAJOR`` and ``Qt5Core_VERSION_MINOR`` directory properties +- ``QT_VERSION_MAJOR`` and ``QT_VERSION_MINOR`` variables + (usually set by ``find_package(Qt4...)``) +- ``QT_VERSION_MAJOR`` and ``QT_VERSION_MINOR`` directory properties + +in the context of the :command:`add_executable` or :command:`add_library` call. + +Assumed ``INTERFACE_QT_MAJOR_VERSION`` is a valid number, the first +entry in the list with a matching major version is taken. If no matching major +version was found, an error is generated. +If ``INTERFACE_QT_MAJOR_VERSION`` is not a valid number, the first +entry in the list is taken. + +A ``find_package(Qt[456]...)`` call sets the ``QT/Qt[56]Core_VERSION_MAJOR/MINOR`` +variables. If the call is in a different context than the +:command:`add_executable` or :command:`add_library` call, e.g. in a function, +then the version variables might not be available to the ``AUTOMOC`` +enabled target. +In that case the version variables can be forwarded from the +``find_package(Qt[456]...)`` calling context to the :command:`add_executable` +or :command:`add_library` calling context as directory properties. +The following Qt5 example demonstrates the procedure. + +.. code-block:: cmake + + function (add_qt5_client) + find_package(Qt5 REQUIRED QUIET COMPONENTS Core Widgets) + ... + set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" + PROPERTY Qt5Core_VERSION_MAJOR "${Qt5Core_VERSION_MAJOR}") + set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" + PROPERTY Qt5Core_VERSION_MINOR "${Qt5Core_VERSION_MAJOR}") + ... + endfunction () + ... + add_qt5_client() + add_executable(myTarget main.cpp) + target_link_libraries(myTarget Qt5::QtWidgets) + set_property(TARGET myTarget PROPERTY AUTOMOC ON) + + +Modifiers +^^^^^^^^^ + +:prop_tgt:`AUTOMOC_EXECUTABLE`: +The ``moc`` executable will be detected automatically, but can be forced to +a certain binary using this target property. + +:prop_tgt:`AUTOMOC_MOC_OPTIONS`: +Additional command line options for ``moc`` can be set in this target property. + +:prop_tgt:`AUTOMOC_MACRO_NAMES`: +This list of Qt macro names can be extended to search for additional macros in +headers and sources. + +:prop_tgt:`AUTOMOC_DEPEND_FILTERS`: +``moc`` dependency file names can be extracted from headers or sources by +defining file name filters in this target property. + +:prop_tgt:`AUTOMOC_COMPILER_PREDEFINES`: +Compiler pre definitions for ``moc`` are written to the ``moc_predefs.h`` file. +The generation of this file can be enabled or disabled in this target property. + +:prop_sf:`SKIP_AUTOMOC`: +Sources and headers can be excluded from ``AUTOMOC`` processing by +setting this source file property. + +:prop_sf:`SKIP_AUTOGEN`: +Source files can be excluded from ``AUTOMOC``, +:prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` processing by +setting this source file property. + +:prop_gbl:`AUTOGEN_SOURCE_GROUP`: +This global property can be used to group files generated by +``AUTOMOC`` or :prop_tgt:`AUTORCC` together in an IDE, e.g. in MSVS. + +:prop_gbl:`AUTOGEN_TARGETS_FOLDER`: +This global property can be used to group ``AUTOMOC``, +:prop_tgt:`AUTOUIC` and :prop_tgt:`AUTORCC` targets together in an IDE, +e.g. in MSVS. + +:variable:`CMAKE_GLOBAL_AUTOGEN_TARGET`: +A global ``autogen`` target, that depends on all ``AUTOMOC`` or +:prop_tgt:`AUTOUIC` generated :ref:`_autogen` targets in the project, +will be generated when this variable is ``ON``. + +:prop_tgt:`AUTOGEN_PARALLEL`: +This target property controls the number of ``moc`` or ``uic`` processes to +start in parallel during builds. + +:prop_tgt:`AUTOGEN_COMMAND_LINE_LENGTH_MAX`: +This target property controls the limit when to use response files for +``moc`` or ``uic`` processes on Windows. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst new file mode 100644 index 0000000000000000000000000000000000000000..6820507dbde6d76ccfe8b7e5bb8a355ad1ed3f85 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_COMPILER_PREDEFINES.rst @@ -0,0 +1,26 @@ +AUTOMOC_COMPILER_PREDEFINES +--------------------------- + +.. versionadded:: 3.10 + +Boolean value used by :prop_tgt:`AUTOMOC` to determine if the +compiler pre definitions file ``moc_predefs.h`` should be generated. + +CMake generates a ``moc_predefs.h`` file with compiler pre definitions +from the output of the command defined in +:variable:`CMAKE_CXX_COMPILER_PREDEFINES_COMMAND _COMPILER_PREDEFINES_COMMAND>` +when + +- :prop_tgt:`AUTOMOC` is enabled, +- ``AUTOMOC_COMPILER_PREDEFINES`` is enabled, +- :variable:`CMAKE_CXX_COMPILER_PREDEFINES_COMMAND _COMPILER_PREDEFINES_COMMAND>` isn't empty and +- the Qt version is greater or equal 5.8. + +The ``moc_predefs.h`` file, which is generated in :prop_tgt:`AUTOGEN_BUILD_DIR`, +is passed to ``moc`` as the argument to the ``--include`` option. + +By default ``AUTOMOC_COMPILER_PREDEFINES`` is initialized from +:variable:`CMAKE_AUTOMOC_COMPILER_PREDEFINES`, which is ON by default. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst new file mode 100644 index 0000000000000000000000000000000000000000..ef7688ad704ea645ef6cdbaaa0bc7c83392f3a2b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst @@ -0,0 +1,109 @@ +AUTOMOC_DEPEND_FILTERS +---------------------- + +.. versionadded:: 3.9 + +Filter definitions used by :prop_tgt:`AUTOMOC` to extract file names from a +source file that are registered as additional dependencies for the +``moc`` file of the source file. + +Filters are defined as ``KEYWORD;REGULAR_EXPRESSION`` pairs. First the file +content is searched for ``KEYWORD``. If it is found at least once, then file +names are extracted by successively searching for ``REGULAR_EXPRESSION`` and +taking the first match group. + +The file name found in the first match group is searched for + +- first in the vicinity of the source file +- and afterwards in the target's :prop_tgt:`INCLUDE_DIRECTORIES`. + +If any of the extracted files changes, then the ``moc`` file for the source +file gets rebuilt even when the source file itself doesn't change. + +If any of the extracted files is :prop_sf:`GENERATED` or if it is not in the +target's sources, then it might be necessary to add it to the +:ref:`_autogen` target dependencies. +See :prop_tgt:`AUTOGEN_TARGET_DEPENDS` for reference. + +By default ``AUTOMOC_DEPEND_FILTERS`` is initialized from +:variable:`CMAKE_AUTOMOC_DEPEND_FILTERS`, which is empty by default. + +From Qt 5.15.0 on this variable is ignored as ``moc`` is able to output the +correct dependencies. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + + +Example 1 +^^^^^^^^^ + +A header file ``my_class.hpp`` uses a custom macro ``JSON_FILE_MACRO`` which +is defined in an other header ``macros.hpp``. +We want the ``moc`` file of ``my_class.hpp`` to depend on the file name +argument of ``JSON_FILE_MACRO``:: + + // my_class.hpp + class My_Class : public QObject + { + Q_OBJECT + JSON_FILE_MACRO ( "info.json" ) + ... + }; + +In ``CMakeLists.txt`` we add a filter to +:variable:`CMAKE_AUTOMOC_DEPEND_FILTERS` like this:: + + list( APPEND CMAKE_AUTOMOC_DEPEND_FILTERS + "JSON_FILE_MACRO" + "[\n][ \t]*JSON_FILE_MACRO[ \t]*\\([ \t]*\"([^\"]+)\"" + ) + +We assume ``info.json`` is a plain (not :prop_sf:`GENERATED`) file that is +listed in the target's source. Therefore we do not need to add it to +:prop_tgt:`AUTOGEN_TARGET_DEPENDS`. + +Example 2 +^^^^^^^^^ + +In the target ``my_target`` a header file ``complex_class.hpp`` uses a +custom macro ``JSON_BASED_CLASS`` which is defined in an other header +``macros.hpp``:: + + // macros.hpp + ... + #define JSON_BASED_CLASS(name, json) \ + class name : public QObject \ + { \ + Q_OBJECT \ + Q_PLUGIN_METADATA(IID "demo" FILE json) \ + name() {} \ + }; + ... + +:: + + // complex_class.hpp + #pragma once + JSON_BASED_CLASS(Complex_Class, "meta.json") + // end of file + +Since ``complex_class.hpp`` doesn't contain a ``Q_OBJECT`` macro it would be +ignored by :prop_tgt:`AUTOMOC`. We change this by adding ``JSON_BASED_CLASS`` +to :variable:`CMAKE_AUTOMOC_MACRO_NAMES`:: + + list(APPEND CMAKE_AUTOMOC_MACRO_NAMES "JSON_BASED_CLASS") + +We want the ``moc`` file of ``complex_class.hpp`` to depend on +``meta.json``. So we add a filter to +:variable:`CMAKE_AUTOMOC_DEPEND_FILTERS`:: + + list(APPEND CMAKE_AUTOMOC_DEPEND_FILTERS + "JSON_BASED_CLASS" + "[\n^][ \t]*JSON_BASED_CLASS[ \t]*\\([^,]*,[ \t]*\"([^\"]+)\"" + ) + +Additionally we assume ``meta.json`` is :prop_sf:`GENERATED` which is +why we have to add it to :prop_tgt:`AUTOGEN_TARGET_DEPENDS`:: + + set_property(TARGET my_target APPEND PROPERTY AUTOGEN_TARGET_DEPENDS "meta.json") diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst new file mode 100644 index 0000000000000000000000000000000000000000..da2a67e1748425f105a602deef0bf5a6614626ec --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_EXECUTABLE.rst @@ -0,0 +1,17 @@ +AUTOMOC_EXECUTABLE +------------------ + +.. versionadded:: 3.14 + +``AUTOMOC_EXECUTABLE`` is file path pointing to the ``moc`` +executable to use for :prop_tgt:`AUTOMOC` enabled files. Setting +this property will make CMake skip the automatic detection of the +``moc`` binary as well as the sanity-tests normally run to ensure +that the binary is available and working as expected. + +Usually this property does not need to be set. Only consider this +property if auto-detection of ``moc`` can not work -- e.g. because +you are building the ``moc`` binary as part of your project. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst new file mode 100644 index 0000000000000000000000000000000000000000..4d958e10225352ef1bac3fcd4569a07eb66af5fa --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst @@ -0,0 +1,38 @@ +AUTOMOC_MACRO_NAMES +------------------- + +.. versionadded:: 3.10 + +A :ref:`semicolon-separated list ` of macro names used by +:prop_tgt:`AUTOMOC` to determine if a C++ file needs to be processed by ``moc``. + +This property is only used if the :prop_tgt:`AUTOMOC` property is ``ON`` +for this target. + +When running :prop_tgt:`AUTOMOC`, CMake searches for the strings listed in +``AUTOMOC_MACRO_NAMES`` in C++ source and header files. +If any of the strings is found + +- as the first non space string on a new line or +- as the first non space string after a ``{`` on a new line, + +then the file will be processed by ``moc``. + +By default ``AUTOMOC_MACRO_NAMES`` is initialized from +:variable:`CMAKE_AUTOMOC_MACRO_NAMES`. + +See also the :prop_tgt:`INTERFACE_AUTOMOC_MACRO_NAMES` target property. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +Example +^^^^^^^ + +In this case the ``Q_OBJECT`` macro is hidden inside another macro +called ``CUSTOM_MACRO``. To let CMake know that source files that contain +``CUSTOM_MACRO`` need to be ``moc`` processed, we call: + +.. code-block:: cmake + + set_property(TARGET tgt APPEND PROPERTY AUTOMOC_MACRO_NAMES "CUSTOM_MACRO") diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..65c3df26346f01f0cef27b691963150f3f80b95a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst @@ -0,0 +1,53 @@ +AUTOMOC_MOC_OPTIONS +------------------- + +Additional options for ``moc`` when using :prop_tgt:`AUTOMOC` + +This property is only used if the :prop_tgt:`AUTOMOC` property is ``ON`` +for this target. In this case, it holds additional command line +options which will be used when ``moc`` is executed during the build, i.e. +it is equivalent to the optional ``OPTIONS`` argument of the +:module:`qt4_wrap_cpp() ` macro. + +This property is initialized by the value of the +:variable:`CMAKE_AUTOMOC_MOC_OPTIONS` variable if it is set when a target +is created, or an empty string otherwise. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +EXAMPLE +^^^^^^^ + +In this example, the ``moc`` tool is invoked with the ``-D_EXTRA_DEFINE`` +option when generating the moc file for ``object.cpp``. + +``CMakeLists.txt`` + .. code-block:: cmake + + add_executable(mocOptions object.cpp main.cpp) + set_property(TARGET mocOptions PROPERTY AUTOMOC ON) + target_compile_options(mocOptions PRIVATE "-D_EXTRA_DEFINE") + set_property(TARGET mocOptions PROPERTY AUTOMOC_MOC_OPTIONS "-D_EXTRA_DEFINE") + target_link_libraries(mocOptions Qt6::Core) + +``object.hpp`` + .. code-block:: c++ + + #ifndef Object_HPP + #define Object_HPP + + #include + + #ifdef _EXTRA_DEFINE + class Object : public QObject + { + Q_OBJECT + public: + + Object(); + + }; + #endif + + #endif diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst new file mode 100644 index 0000000000000000000000000000000000000000..582e085b879598b3102104cd2b589bba4dc1b5e7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOMOC_PATH_PREFIX.rst @@ -0,0 +1,33 @@ +AUTOMOC_PATH_PREFIX +------------------- + +.. versionadded:: 3.16 + +When this property is ``ON``, CMake will generate the ``-p`` path prefix +option for ``moc`` on :prop_tgt:`AUTOMOC` enabled Qt targets. + +To generate the path prefix, CMake tests if the header compiled by ``moc`` +is in any of the target +:command:`include directories `. If so, CMake will +compute the relative path accordingly. If the header is not in the +:command:`include directories `, CMake will omit +the ``-p`` path prefix option. ``moc`` usually generates a +relative include path in that case. + +``AUTOMOC_PATH_PREFIX`` is initialized from the variable +:variable:`CMAKE_AUTOMOC_PATH_PREFIX`, which is ``OFF`` by default. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +Reproducible builds +^^^^^^^^^^^^^^^^^^^ + +For reproducible builds it is recommended to keep headers that are ``moc`` +compiled in one of the target +:command:`include directories ` and set +``AUTOMOC_PATH_PREFIX`` to ``ON``. This ensures that: + +- ``moc`` output files are identical on different build setups, +- ``moc`` output files will compile correctly when the source and/or + build directory is a symbolic link. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC.rst new file mode 100644 index 0000000000000000000000000000000000000000..3ca833aa8a9bc9cd8687f1e91f8431a71ad5964c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC.rst @@ -0,0 +1,64 @@ +AUTORCC +------- + +Should the target be processed with auto-rcc (for Qt projects). + +``AUTORCC`` is a boolean specifying whether CMake will handle +the Qt ``rcc`` code generator automatically, i.e. without having to use +commands like :module:`QT4_ADD_RESOURCES() `, `qt5_add_resources()`_, +etc. Currently, Qt versions 4 to 6 are supported. + +.. _`qt5_add_resources()`: https://doc.qt.io/qt-5/qtcore-cmake-qt5-add-resources.html + +When this property is ``ON``, CMake will handle ``.qrc`` files added +as target sources at build time and invoke ``rcc`` accordingly. +This property is initialized by the value of the :variable:`CMAKE_AUTORCC` +variable if it is set when a target is created. + +By default ``AUTORCC`` is processed by a +:command:`custom command `. +If the ``.qrc`` file is :prop_sf:`GENERATED`, a +:command:`custom target ` is used instead. + +When there are multiple ``.qrc`` files with the same name, CMake will +generate unspecified unique output file names for ``rcc``. Therefore, if +``Q_INIT_RESOURCE()`` or ``Q_CLEANUP_RESOURCE()`` need to be used, the +``.qrc`` file name must be unique. + + +Modifiers +^^^^^^^^^ + +:prop_tgt:`AUTORCC_EXECUTABLE`: +The ``rcc`` executable will be detected automatically, but can be forced to +a certain binary by setting this target property. + +:prop_tgt:`AUTORCC_OPTIONS`: +Additional command line options for ``rcc`` can be set via this target +property. The corresponding :prop_sf:`AUTORCC_OPTIONS` source file property +can be used to specify options to be applied only to a specific ``.qrc`` file. + +:prop_sf:`SKIP_AUTORCC`: +``.qrc`` files can be excluded from ``AUTORCC`` processing by +setting this source file property. + +:prop_sf:`SKIP_AUTOGEN`: +Source files can be excluded from :prop_tgt:`AUTOMOC`, +:prop_tgt:`AUTOUIC` and ``AUTORCC`` processing by +setting this source file property. + +:prop_gbl:`AUTOGEN_SOURCE_GROUP`: +This global property can be used to group files generated by +:prop_tgt:`AUTOMOC` or ``AUTORCC`` together in an IDE, e.g. in MSVS. + +:prop_gbl:`AUTOGEN_TARGETS_FOLDER`: +This global property can be used to group :prop_tgt:`AUTOMOC`, +:prop_tgt:`AUTOUIC` and ``AUTORCC`` targets together in an IDE, +e.g. in MSVS. + +:variable:`CMAKE_GLOBAL_AUTORCC_TARGET`: +A global ``autorcc`` target that depends on all ``AUTORCC`` targets +in the project will be generated when this variable is ``ON``. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC_EXECUTABLE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC_EXECUTABLE.rst new file mode 100644 index 0000000000000000000000000000000000000000..e0e5c6a9bd2ae8c38d29465cbde566ea26f058d8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC_EXECUTABLE.rst @@ -0,0 +1,17 @@ +AUTORCC_EXECUTABLE +------------------ + +.. versionadded:: 3.14 + +``AUTORCC_EXECUTABLE`` is file path pointing to the ``rcc`` +executable to use for :prop_tgt:`AUTORCC` enabled files. Setting +this property will make CMake skip the automatic detection of the +``rcc`` binary as well as the sanity-tests normally run to ensure +that the binary is available and working as expected. + +Usually this property does not need to be set. Only consider this +property if auto-detection of ``rcc`` can not work -- e.g. because +you are building the ``rcc`` binary as part of your project. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC_OPTIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC_OPTIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..0812c3e6c1a9d78a479c2be07e68b9ba4bac3405 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTORCC_OPTIONS.rst @@ -0,0 +1,28 @@ +AUTORCC_OPTIONS +--------------- + +Additional options for ``rcc`` when using :prop_tgt:`AUTORCC` + +This property holds additional command line options which will be used +when ``rcc`` is executed during the build via :prop_tgt:`AUTORCC`, +i.e. it is equivalent to the optional ``OPTIONS`` argument of the +:module:`qt4_add_resources() ` macro. + +This property is initialized by the value of the +:variable:`CMAKE_AUTORCC_OPTIONS` variable if it is set when a target is +created, or an empty string otherwise. + +The options set on the target may be overridden by :prop_sf:`AUTORCC_OPTIONS` +set on the ``.qrc`` source file. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +EXAMPLE +^^^^^^^ + +.. code-block:: cmake + + # ... + set_property(TARGET tgt PROPERTY AUTORCC_OPTIONS "--compress;9") + # ... diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC.rst new file mode 100644 index 0000000000000000000000000000000000000000..589f7befad1120b47f08834377b696d2467de994 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC.rst @@ -0,0 +1,91 @@ +AUTOUIC +------- + +Should the target be processed with auto-uic (for Qt projects). + +``AUTOUIC`` is a boolean specifying whether CMake will handle +the Qt ``uic`` code generator automatically, i.e. without having to use +commands like :module:`QT4_WRAP_UI() `, `qt5_wrap_ui()`_, etc. +Currently, Qt versions 4 to 6 are supported. + +.. _`qt5_wrap_ui()`: https://doc.qt.io/qt-5/qtwidgets-cmake-qt5-wrap-ui.html + +This property is initialized by the value of the :variable:`CMAKE_AUTOUIC` +variable if it is set when a target is created. + +When this property is ``ON``, CMake will scan the header and source files at +build time and invoke ``uic`` accordingly. + + +Header and source file processing +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +At build time, CMake scans each header and source file from the +target's sources for include statements of the form + +.. code-block:: c++ + + #include "ui_.h" + +Once such an include statement is found in a file, CMake searches for the +``uic`` input file ``.ui`` + +- in the vicinity of the file and +- in the :prop_tgt:`AUTOUIC_SEARCH_PATHS` of the target. + +If the ``.ui`` file was found, ``uic`` is called on it to generate +``ui_.h`` in the directory + +- ``/include`` for single configuration generators or in +- ``/include_`` for + :prop_gbl:`multi configuration ` generators. + +Where ```` is the value of the target property +:prop_tgt:`AUTOGEN_BUILD_DIR`. + +The include directory is automatically added to the target's +:prop_tgt:`INCLUDE_DIRECTORIES`. + + +Modifiers +^^^^^^^^^ + +:prop_tgt:`AUTOUIC_EXECUTABLE`: +The ``uic`` executable will be detected automatically, but can be forced to +a certain binary using this target property. + +:prop_tgt:`AUTOUIC_OPTIONS`: +Additional command line options for ``uic`` can be set via this target +property. The corresponding :prop_sf:`AUTOUIC_OPTIONS` source file property +can be used to specify options to be applied only to a specific +``.ui`` file. + +:prop_sf:`SKIP_AUTOUIC`: +Source files can be excluded from ``AUTOUIC`` processing by setting +this source file property. + +:prop_sf:`SKIP_AUTOGEN`: +Source files can be excluded from :prop_tgt:`AUTOMOC`, +``AUTOUIC`` and :prop_tgt:`AUTORCC` processing by +setting this source file property. + +:prop_gbl:`AUTOGEN_TARGETS_FOLDER`: +This global property can be used to group :prop_tgt:`AUTOMOC`, +``AUTOUIC`` and :prop_tgt:`AUTORCC` targets together in an IDE, +e.g. in MSVS. + +:variable:`CMAKE_GLOBAL_AUTOGEN_TARGET`: +A global ``autogen`` target, that depends on all :prop_tgt:`AUTOMOC` or +``AUTOUIC`` generated :ref:`_autogen` targets in the project, +will be generated when this variable is ``ON``. + +:prop_tgt:`AUTOGEN_PARALLEL`: +This target property controls the number of ``moc`` or ``uic`` processes to +start in parallel during builds. + +:prop_tgt:`AUTOGEN_COMMAND_LINE_LENGTH_MAX`: +This target property controls the limit when to use response files for +``moc`` or ``uic`` processes on Windows. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst new file mode 100644 index 0000000000000000000000000000000000000000..4257e627debcd47be419d55603d915f32c58f50b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_EXECUTABLE.rst @@ -0,0 +1,17 @@ +AUTOUIC_EXECUTABLE +------------------ + +.. versionadded:: 3.14 + +``AUTOUIC_EXECUTABLE`` is file path pointing to the ``uic`` +executable to use for :prop_tgt:`AUTOUIC` enabled files. Setting +this property will make CMake skip the automatic detection of the +``uic`` binary as well as the sanity-tests normally run to ensure +that the binary is available and working as expected. + +Usually this property does not need to be set. Only consider this +property if auto-detection of ``uic`` can not work -- e.g. because +you are building the ``uic`` binary as part of your project. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_OPTIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_OPTIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..7bb6d83d5cfcb66dfa6a5781f799452e245470e1 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_OPTIONS.rst @@ -0,0 +1,34 @@ +AUTOUIC_OPTIONS +--------------- + +.. versionadded:: 3.0 + +Additional options for ``uic`` when using :prop_tgt:`AUTOUIC` + +This property holds additional command line options which will be used when +``uic`` is executed during the build via :prop_tgt:`AUTOUIC`, i.e. it is +equivalent to the optional ``OPTIONS`` argument of the +:module:`qt4_wrap_ui() ` macro. + +This property is initialized by the value of the +:variable:`CMAKE_AUTOUIC_OPTIONS` variable if it is set when a target is +created, or an empty string otherwise. + +The options set on the target may be overridden by :prop_sf:`AUTOUIC_OPTIONS` +set on the ``.ui`` source file. + +This property may use "generator expressions" with the syntax ``$<...>``. +See the :manual:`cmake-generator-expressions(7)` manual for available +expressions. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +EXAMPLE +^^^^^^^ + +.. code-block:: cmake + + # ... + set_property(TARGET tgt PROPERTY AUTOUIC_OPTIONS "--no-protection") + # ... diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_SEARCH_PATHS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_SEARCH_PATHS.rst new file mode 100644 index 0000000000000000000000000000000000000000..993fea9706d7280a32d46d9f6998f1c9686002b0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/AUTOUIC_SEARCH_PATHS.rst @@ -0,0 +1,14 @@ +AUTOUIC_SEARCH_PATHS +-------------------- + +.. versionadded:: 3.9 + +Search path list used by :prop_tgt:`AUTOUIC` to find included +``.ui`` files. + +This property is initialized by the value of the +:variable:`CMAKE_AUTOUIC_SEARCH_PATHS` variable if it is set +when a target is created. Otherwise it is empty. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/BINARY_DIR.rst b/cmake/share/cmake-3.31/Help/prop_tgt/BINARY_DIR.rst new file mode 100644 index 0000000000000000000000000000000000000000..15058b1c602627b2b1411922d4e6a54d3b431bbb --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/BINARY_DIR.rst @@ -0,0 +1,8 @@ +BINARY_DIR +---------- + +.. versionadded:: 3.4 + +This read-only property reports the value of the +:variable:`CMAKE_CURRENT_BINARY_DIR` variable in the directory in which +the target was defined. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_RPATH.rst b/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_RPATH.rst new file mode 100644 index 0000000000000000000000000000000000000000..3828d69fd7dbce19fcd4e96b3c0e4b0612819c76 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_RPATH.rst @@ -0,0 +1,36 @@ +BUILD_RPATH +----------- + +.. versionadded:: 3.8 + +A :ref:`semicolon-separated list ` specifying +runtime path (``RPATH``) entries to add to binaries linked in the +build tree (for platforms that support it). By default, CMake sets +the runtime path of binaries in the build tree to contain search +paths it knows are needed to find the shared libraries they link. +Projects may set ``BUILD_RPATH`` to specify additional search paths. + +The build-tree runtime path will *not* be used for binaries in the +install tree. It will be replaced with the install-tree runtime path +during the installation step. See also the :prop_tgt:`INSTALL_RPATH` +target property. + +This property is initialized by the value of the variable +:variable:`CMAKE_BUILD_RPATH` if it is set when a target is created. + +This property supports +:manual:`generator expressions `. + +Other settings that affect the build-tree runtime path include: + +* The :variable:`CMAKE_SKIP_RPATH` variable completely disables runtime + paths in both the build tree and install tree. + +* The :prop_tgt:`SKIP_BUILD_RPATH` target property disables setting any + runtime path in the build tree. + +* The :prop_tgt:`BUILD_RPATH_USE_ORIGIN` target property causes the + automatically-generated runtime path to use entries relative to ``$ORIGIN``. + +* The :prop_tgt:`BUILD_WITH_INSTALL_RPATH` target property causes binaries + in the build tree to be built with the install-tree runtime path. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst b/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst new file mode 100644 index 0000000000000000000000000000000000000000..d4c1daa7d4fc576b0d9c67b61d038e77bb0f4c2a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_RPATH_USE_ORIGIN.rst @@ -0,0 +1,26 @@ +BUILD_RPATH_USE_ORIGIN +---------------------- + +.. versionadded:: 3.14 + +Whether to use relative paths for the build ``RPATH``. + +This property is initialized by the value of the variable +:variable:`CMAKE_BUILD_RPATH_USE_ORIGIN`. + +On platforms that support runtime paths (``RPATH``) with the +``$ORIGIN`` token, setting this property to ``TRUE`` enables relative +paths in the build ``RPATH`` for executables and shared libraries that +point to shared libraries in the same build tree. + +Normally the build ``RPATH`` of a binary contains absolute paths +to the directory of each shared library it links to. The ``RPATH`` +entries for directories contained within the build tree can be made +relative to enable relocatable builds and to help achieve reproducible +builds by omitting the build directory from the build environment. + +This property has no effect on platforms that do not support the +``$ORIGIN`` token in ``RPATH``, or when the :variable:`CMAKE_SKIP_RPATH` +variable is set. The runtime path set through the +:prop_tgt:`BUILD_RPATH` target property is also unaffected by this +property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst b/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst new file mode 100644 index 0000000000000000000000000000000000000000..ab38f4de9f27b7cef957305230ed78da8f1e3835 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_WITH_INSTALL_NAME_DIR.rst @@ -0,0 +1,15 @@ +BUILD_WITH_INSTALL_NAME_DIR +--------------------------- + +.. versionadded:: 3.9 + +``BUILD_WITH_INSTALL_NAME_DIR`` is a boolean specifying whether the macOS +``install_name`` of a target in the build tree uses the directory given by +:prop_tgt:`INSTALL_NAME_DIR`. This setting only applies to targets on macOS. + +This property is initialized by the value of the variable +:variable:`CMAKE_BUILD_WITH_INSTALL_NAME_DIR` if it is set when a target is +created. + +If this property is not set and policy :policy:`CMP0068` is not ``NEW``, the +value of :prop_tgt:`BUILD_WITH_INSTALL_RPATH` is used in its place. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst b/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst new file mode 100644 index 0000000000000000000000000000000000000000..6b4dfb8003e9e93554d93d119ce247fe0868d524 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst @@ -0,0 +1,15 @@ +BUILD_WITH_INSTALL_RPATH +------------------------ + +``BUILD_WITH_INSTALL_RPATH`` is a boolean specifying whether to link the target +in the build tree with the :prop_tgt:`INSTALL_RPATH`. This takes precedence +over :prop_tgt:`SKIP_BUILD_RPATH` and avoids the need for relinking before +installation. + +This property is initialized by the value of the +:variable:`CMAKE_BUILD_WITH_INSTALL_RPATH` variable if it is set when a target +is created. + +If policy :policy:`CMP0068` is not ``NEW``, this property also controls use of +:prop_tgt:`INSTALL_NAME_DIR` in the build tree on macOS. Either way, the +:prop_tgt:`BUILD_WITH_INSTALL_NAME_DIR` target property takes precedence. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/BUNDLE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/BUNDLE.rst new file mode 100644 index 0000000000000000000000000000000000000000..d66296b99e05e4a48e80b85c9f8c0ffbdc80b032 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/BUNDLE.rst @@ -0,0 +1,9 @@ +BUNDLE +------ + +This target is a ``CFBundle`` on the macOS. + +If a module library target has this property set to true it will be +built as a ``CFBundle`` when built on the mac. It will have the directory +structure required for a ``CFBundle`` and will be suitable to be used for +creating Browser Plugins or other application resources. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/BUNDLE_EXTENSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/BUNDLE_EXTENSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..eda440ffe09793645b5069dbc60f760d481aed1d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/BUNDLE_EXTENSION.rst @@ -0,0 +1,8 @@ +BUNDLE_EXTENSION +---------------- + +The file extension used to name a :prop_tgt:`BUNDLE`, a :prop_tgt:`FRAMEWORK`, +or a :prop_tgt:`MACOSX_BUNDLE` target on the macOS and iOS. + +The default value is ``bundle``, ``framework``, or ``app`` for the respective +target types. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst new file mode 100644 index 0000000000000000000000000000000000000000..d10323218c71b6e3aeae332602641ec194e12f77 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMMON_LANGUAGE_RUNTIME.rst @@ -0,0 +1,41 @@ +COMMON_LANGUAGE_RUNTIME +----------------------- + +.. versionadded:: 3.12 + +By setting this target property, the target is configured to build with +``C++/CLI`` support. + +The Visual Studio generator defines the ``clr`` parameter depending on +the value of the ``COMMON_LANGUAGE_RUNTIME`` target property: + +Not Set (default) + + Native C++. + +``""`` (set but empty) + + Mixed unmanaged/managed C++ using .NET Framework. + +``netcore`` + .. versionadded:: 3.26 + + Mixed unmanaged/managed C++ using .NET Core. + + This required VS 2019's v142 toolset or higher. + +``pure`` + + Managed C++. + +``safe`` + + Managed C++. + +This property is only evaluated :ref:`Visual Studio Generators` for +VS 2010 and above. + +To be able to build managed C++ targets with VS 2017 and above the component +``C++/CLI support`` must be installed, which may not be done by default. + +See also :prop_tgt:`IMPORTED_COMMON_LANGUAGE_RUNTIME` diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst new file mode 100644 index 0000000000000000000000000000000000000000..658f2470f1d970e5f36a636bde25e5ecd47cf47c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst @@ -0,0 +1,20 @@ +COMPATIBLE_INTERFACE_BOOL +------------------------- + +Properties which must be compatible with their link interface + +The ``COMPATIBLE_INTERFACE_BOOL`` property may contain a list of +properties for this target which must be consistent when evaluated as a +boolean with the ``INTERFACE`` variant of the property in all linked +dependees. For example, if a property ``FOO`` appears in the list, then +for each dependee, the ``INTERFACE_FOO`` property content in all of its +dependencies must be consistent with each other, and with the ``FOO`` +property in the depender. + +Consistency in this sense has the meaning that if the property is set, +then it must have the same boolean value as all others, and if the +property is not set, then it is ignored. + +Note that for each dependee, the set of properties specified in this +property must not intersect with the set specified in any of the other +:ref:`Compatible Interface Properties`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MAX.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MAX.rst new file mode 100644 index 0000000000000000000000000000000000000000..8694c6f788478e3beb9920fd8d893ddce6e1cdb7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MAX.rst @@ -0,0 +1,18 @@ +COMPATIBLE_INTERFACE_NUMBER_MAX +------------------------------- + +Properties whose maximum value from the link interface will be used. + +The ``COMPATIBLE_INTERFACE_NUMBER_MAX`` property may contain a list of +properties for this target whose maximum value may be read at generate +time when evaluated in the ``INTERFACE`` variant of the property in all +linked dependees. For example, if a property ``FOO`` appears in the list, +then for each dependee, the ``INTERFACE_FOO`` property content in all of +its dependencies will be compared with each other and with the ``FOO`` +property in the depender. When reading the ``FOO`` property at generate +time, the maximum value will be returned. If the property is not set, +then it is ignored. + +Note that for each dependee, the set of properties specified in this +property must not intersect with the set specified in any of the other +:ref:`Compatible Interface Properties`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MIN.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MIN.rst new file mode 100644 index 0000000000000000000000000000000000000000..1c07499656a18f35d6a86cceefe333e4edd94937 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MIN.rst @@ -0,0 +1,18 @@ +COMPATIBLE_INTERFACE_NUMBER_MIN +------------------------------- + +Properties whose minimum value from the link interface will be used. + +The ``COMPATIBLE_INTERFACE_NUMBER_MIN`` property may contain a list of +properties for this target whose minimum value may be read at generate +time when evaluated in the ``INTERFACE`` variant of the property of all +linked dependees. For example, if a +property ``FOO`` appears in the list, then for each dependee, the +``INTERFACE_FOO`` property content in all of its dependencies will be +compared with each other and with the ``FOO`` property in the depender. +When reading the ``FOO`` property at generate time, the minimum value +will be returned. If the property is not set, then it is ignored. + +Note that for each dependee, the set of properties specified in this +property must not intersect with the set specified in any of the other +:ref:`Compatible Interface Properties`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst new file mode 100644 index 0000000000000000000000000000000000000000..a94f8b1e9af4605c13c830028e541559163e91bb --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst @@ -0,0 +1,16 @@ +COMPATIBLE_INTERFACE_STRING +--------------------------- + +Properties which must be string-compatible with their link interface + +The ``COMPATIBLE_INTERFACE_STRING`` property may contain a list of +properties for this target which must be the same when evaluated as a +string in the ``INTERFACE`` variant of the property all linked dependees. +For example, if a property ``FOO`` appears in the list, then for each +dependee, the ``INTERFACE_FOO`` property content in all of its +dependencies must be equal with each other, and with the ``FOO`` property +in the depender. If the property is not set, then it is ignored. + +Note that for each dependee, the set of properties specified in this +property must not intersect with the set specified in any of the other +:ref:`Compatible Interface Properties`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_DEFINITIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..eef58398340cf995520497ba528a30a435e71bef --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_DEFINITIONS.rst @@ -0,0 +1,28 @@ +COMPILE_DEFINITIONS +------------------- + +Preprocessor definitions for compiling a target's sources. + +The ``COMPILE_DEFINITIONS`` property may be set to a semicolon-separated +list of preprocessor definitions using the syntax ``VAR`` or ``VAR=value``. +Function-style definitions are not supported. CMake will +automatically escape the value correctly for the native build system +(note that CMake language syntax may require escapes to specify some +values). + +CMake will automatically drop some definitions that are not supported +by the native build tool. + +.. versionadded:: 3.26 + Any leading ``-D`` on an item will be removed. + +.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt + +Contents of ``COMPILE_DEFINITIONS`` may use "generator expressions" with the +syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual +for available expressions. See the :manual:`cmake-buildsystem(7)` manual +for more on defining buildsystem properties. + +The corresponding :prop_tgt:`COMPILE_DEFINITIONS_` property may +be set to specify per-configuration definitions. Generator expressions +should be preferred instead of setting the alternative property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..5927ba56d74cb51a170b5c206df66d0322f903b3 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst @@ -0,0 +1,16 @@ +COMPILE_DEFINITIONS_ +---------------------------- + +Ignored. See CMake Policy :policy:`CMP0043`. + +Per-configuration preprocessor definitions on a target. + +This is the configuration-specific version of :prop_tgt:`COMPILE_DEFINITIONS` +where ```` is an upper-case name (ex. ``COMPILE_DEFINITIONS_DEBUG``). + +Contents of ``COMPILE_DEFINITIONS_`` may use "generator expressions" +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. See the :manual:`cmake-buildsystem(7)` +manual for more on defining buildsystem properties. + +Generator expressions should be preferred instead of setting this property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_FEATURES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_FEATURES.rst new file mode 100644 index 0000000000000000000000000000000000000000..7daebb832c3d9efa3d78bb9b3dcde54549afe40c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_FEATURES.rst @@ -0,0 +1,15 @@ +COMPILE_FEATURES +---------------- + +.. versionadded:: 3.1 + +Compiler features enabled for this target. + +The list of features in this property are a subset of the features listed +in the :variable:`CMAKE_C_COMPILE_FEATURES`, :variable:`CMAKE_CUDA_COMPILE_FEATURES`, and +:variable:`CMAKE_CXX_COMPILE_FEATURES` variables. + +Contents of ``COMPILE_FEATURES`` may use "generator expressions" with the +syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. See the :manual:`cmake-compile-features(7)` manual +for information on compile features and a list of supported compilers. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_FLAGS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_FLAGS.rst new file mode 100644 index 0000000000000000000000000000000000000000..20dc9c03ea9fb904c2e7710558b2a19b7e7491f0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_FLAGS.rst @@ -0,0 +1,14 @@ +COMPILE_FLAGS +------------- + +Additional flags to use when compiling this target's sources. + +The ``COMPILE_FLAGS`` property sets additional compiler flags used to +build sources within the target. Use :prop_tgt:`COMPILE_DEFINITIONS` +to pass additional preprocessor definitions. + +.. note:: + + This property has been superseded by the :prop_tgt:`COMPILE_OPTIONS` property. + Alternatively, you can also use the :command:`target_compile_options` command + instead. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_OPTIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_OPTIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..9b08701d3c72a13ab2f301d7e2e6a056d660e8b7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_OPTIONS.rst @@ -0,0 +1,27 @@ +COMPILE_OPTIONS +--------------- + +List of options to pass to the compiler. + +This property holds a :ref:`semicolon-separated list ` +of options specified so far for its target. Use the +:command:`target_compile_options` command to append more options. +The options will be added after flags in the +:variable:`CMAKE__FLAGS` and :variable:`CMAKE__FLAGS_` +variables, but before those propagated from dependencies by the +:prop_tgt:`INTERFACE_COMPILE_OPTIONS` property. + +This property adds compile options for all languages in a target. +Use the :genex:`COMPILE_LANGUAGE` generator expression to specify +per-language compile options. + +This property is initialized by the :prop_dir:`COMPILE_OPTIONS` directory +property when a target is created, and is used by the generators to set +the options for the compiler. + +Contents of ``COMPILE_OPTIONS`` may use "generator expressions" with the +syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual +for available expressions. See the :manual:`cmake-buildsystem(7)` manual +for more on defining buildsystem properties. + +.. include:: ../command/OPTIONS_SHELL.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..571feb4e958a811c516c502cd8da7b38822d4bfb --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NAME.rst @@ -0,0 +1,13 @@ +COMPILE_PDB_NAME +---------------- + +.. versionadded:: 3.1 + +Output name for the MS debug symbol ``.pdb`` file generated by the +compiler while building source files. + +This property specifies the base name for the debug symbols file. +If not set, the default is unspecified. + +.. |PDB_XXX| replace:: :prop_tgt:`PDB_NAME` +.. include:: COMPILE_PDB_NOTE.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..dc79f021e8dc4e27a0c23476bc5148b8ec71a59e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst @@ -0,0 +1,12 @@ +COMPILE_PDB_NAME_ +------------------------- + +.. versionadded:: 3.1 + +Per-configuration output name for the MS debug symbol ``.pdb`` file +generated by the compiler while building source files. + +This is the configuration-specific version of :prop_tgt:`COMPILE_PDB_NAME`. + +.. |PDB_XXX| replace:: :prop_tgt:`PDB_NAME_` +.. include:: COMPILE_PDB_NOTE.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NOTE.txt b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NOTE.txt new file mode 100644 index 0000000000000000000000000000000000000000..6d5b8e9804c31902421cb5bb55aaf747ca13f01e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_NOTE.txt @@ -0,0 +1,5 @@ +.. note:: + The compiler-generated program database files are specified by the + ``/Fd`` compiler flag and are not the same as linker-generated + program database files specified by the ``/pdb`` linker flag. + Use the |PDB_XXX| property to specify the latter. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000000000000000000000000000000000000..7a3770a40782254d3e8f5b8681d04fe13b5c5a81 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst @@ -0,0 +1,15 @@ +COMPILE_PDB_OUTPUT_DIRECTORY +---------------------------- + +.. versionadded:: 3.1 + +Output directory for the MS debug symbol ``.pdb`` file +generated by the compiler while building source files. + +This property specifies the directory into which the MS debug symbols +will be placed by the compiler. This property is initialized by the +value of the :variable:`CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY` variable +if it is set when a target is created. + +.. |PDB_XXX| replace:: :prop_tgt:`PDB_OUTPUT_DIRECTORY` +.. include:: COMPILE_PDB_NOTE.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..6ca9e32f404fca8eebf53035b50cf792d2786d91 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,18 @@ +COMPILE_PDB_OUTPUT_DIRECTORY_ +------------------------------------- + +.. versionadded:: 3.1 + +Per-configuration output directory for the MS debug symbol ``.pdb`` file +generated by the compiler while building source files. + +This is a per-configuration version of +:prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY`, +but multi-configuration generators (Visual Studio, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the +:variable:`CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_` variable +if it is set when a target is created. + +.. |PDB_XXX| replace:: :prop_tgt:`PDB_OUTPUT_DIRECTORY_` +.. include:: COMPILE_PDB_NOTE.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst new file mode 100644 index 0000000000000000000000000000000000000000..8b8d8f71eeb52d751592c17cdc37d6aa75c2ba89 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst @@ -0,0 +1,37 @@ +COMPILE_WARNING_AS_ERROR +------------------------ + +.. versionadded:: 3.24 + +Specify whether to treat warnings on compile as errors. +If enabled, adds a flag to treat warnings on compile as errors. +If the :option:`cmake --compile-no-warning-as-error` option is given +on the :manual:`cmake(1)` command line, this property is ignored. + +This property is not implemented for all compilers. It is silently ignored +if there is no implementation for the compiler being used. The currently +implemented :variable:`compiler IDs _COMPILER_ID>` are: + +* ``GNU`` +* ``Clang`` +* ``AppleClang`` +* ``Fujitsu`` +* ``FujitsuClang`` +* ``IBMClang`` +* ``Intel`` +* ``IntelLLVM`` +* ``LCC`` +* ``MSVC`` +* ``NVHPC`` +* ``NVIDIA`` (CUDA) +* ``QCC`` +* ``SunPro`` +* ``Tasking`` +* ``TI`` +* ``VisualAge`` +* ``XL`` +* ``XLClang`` + +This property is initialized by the value of the variable +:variable:`CMAKE_COMPILE_WARNING_AS_ERROR` if it is set when a target is +created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..cc62789ceda960bc2fafc2666da9ee590d2258a9 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst @@ -0,0 +1,8 @@ +_OUTPUT_NAME +-------------------- + +Old per-configuration target file base name. +Use :prop_tgt:`OUTPUT_NAME_` instead. + +This is a configuration-specific version of the :prop_tgt:`OUTPUT_NAME` +target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CONFIG_POSTFIX.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CONFIG_POSTFIX.rst new file mode 100644 index 0000000000000000000000000000000000000000..6d75de6168d1239e7b93eab27058a42dde23061d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CONFIG_POSTFIX.rst @@ -0,0 +1,13 @@ +_POSTFIX +---------------- + +Postfix to append to the target file name for configuration ````. + +When building with configuration ```` the value of this property +is appended to the target file name built on disk. For non-executable +targets, this property is initialized by the value of the +:variable:`CMAKE__POSTFIX` variable if it is set when a target is +created. This property is ignored on macOS for Frameworks and App Bundles. + +For macOS see also the :prop_tgt:`FRAMEWORK_MULTI_CONFIG_POSTFIX_` +target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CROSSCOMPILING_EMULATOR.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CROSSCOMPILING_EMULATOR.rst new file mode 100644 index 0000000000000000000000000000000000000000..d58cab5a27b3e6d2505e1e5685b028ed77c4d45d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CROSSCOMPILING_EMULATOR.rst @@ -0,0 +1,22 @@ +CROSSCOMPILING_EMULATOR +----------------------- + +.. versionadded:: 3.3 + +Use the given emulator to run executables created when crosscompiling. +This command will be added as a prefix to :command:`add_test`, +:command:`add_custom_command`, and :command:`add_custom_target` commands +for built target system executables. + +.. versionadded:: 3.15 + If this property contains a :ref:`semicolon-separated list `, then the first value is the command and remaining values are its + arguments. + +.. versionadded:: 3.29 + Contents of ``CROSSCOMPILING_EMULATOR`` may use + :manual:`generator expressions `. + +This property is initialized by the value of the +:variable:`CMAKE_CROSSCOMPILING_EMULATOR` variable if it is set when a target +is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_ARCHITECTURES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_ARCHITECTURES.rst new file mode 100644 index 0000000000000000000000000000000000000000..5183fec765549ce963a4c1280b72a7b331a0ecaa --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_ARCHITECTURES.rst @@ -0,0 +1,61 @@ +CUDA_ARCHITECTURES +------------------ + +.. versionadded:: 3.18 + +List of architectures to generate device code for. + +An architecture can be suffixed by either ``-real`` or ``-virtual`` to specify +the kind of architecture to generate code for. +If no suffix is given then code is generated for both real and virtual +architectures. + +A non-empty false value (e.g. ``OFF``) disables adding architectures. +This is intended to support packagers and rare cases where full control +over the passed flags is required. + +This property is initialized by the value of the :variable:`CMAKE_CUDA_ARCHITECTURES` +variable if it is set when a target is created. + +The ``CUDA_ARCHITECTURES`` target property must be set to a non-empty value on targets +that compile CUDA sources, or it is an error. See policy :policy:`CMP0104`. + +The ``CUDA_ARCHITECTURES`` may be set to one of the following special values: + +``all`` + .. versionadded:: 3.23 + + Compile for all supported major and minor real architectures, + and the highest major virtual architecture. + +``all-major`` + .. versionadded:: 3.23 + + Compile for all supported major real architectures, and the highest + major virtual architecture. + +``native`` + .. versionadded:: 3.24 + + Compile for the architecture(s) of the host's GPU(s). + +Examples +^^^^^^^^ + +.. code-block:: cmake + + set_target_properties(tgt PROPERTIES CUDA_ARCHITECTURES "35;50;72") + +Generates code for real and virtual architectures ``30``, ``50`` and ``72``. + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY CUDA_ARCHITECTURES 70-real 72-virtual) + +Generates code for real architecture ``70`` and virtual architecture ``72``. + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY CUDA_ARCHITECTURES OFF) + +CMake will not pass any architecture flags to the compiler. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_CUBIN_COMPILATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_CUBIN_COMPILATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..7931ce559c7d4c8b82a2dffef8219eb551ffc52e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_CUBIN_COMPILATION.rst @@ -0,0 +1,14 @@ +CUDA_CUBIN_COMPILATION +---------------------- + +.. versionadded:: 3.27 + +Compile CUDA sources to ``.cubin`` files instead of ``.obj`` files +within :ref:`Object Libraries`. + +For example: + +.. code-block:: cmake + + add_library(mycubin OBJECT a.cu b.cu) + set_property(TARGET mycubin PROPERTY CUDA_CUBIN_COMPILATION ON) diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_EXTENSIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_EXTENSIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..a9beae84460df08e8009286e57d1021e8911764b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_EXTENSIONS.rst @@ -0,0 +1,21 @@ +CUDA_EXTENSIONS +--------------- + +.. versionadded:: 3.8 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu++11`` instead of ``-std=c++11`` to the compile line. This +property is ``ON`` by default. The basic CUDA/C++ standard level is +controlled by the :prop_tgt:`CUDA_STANDARD` target property. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CUDA_EXTENSIONS` variable if set when a target is created +and otherwise by the value of +:variable:`CMAKE_CUDA_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` +(see :policy:`CMP0128`). diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_FATBIN_COMPILATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_FATBIN_COMPILATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..583abac6db33eeff3c0e06f957c494e0f069dd3d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_FATBIN_COMPILATION.rst @@ -0,0 +1,14 @@ +CUDA_FATBIN_COMPILATION +----------------------- + +.. versionadded:: 3.27 + +Compile CUDA sources to ``.fatbin`` files instead of ``.obj`` files +within :ref:`Object Libraries`. + +For example: + +.. code-block:: cmake + + add_library(myfbins OBJECT a.cu b.cu) + set_property(TARGET myfbins PROPERTY CUDA_FATBIN_COMPILATION ON) diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_OPTIX_COMPILATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_OPTIX_COMPILATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..1ae0aabb5e98ab474d2085364658fe6fc3319993 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_OPTIX_COMPILATION.rst @@ -0,0 +1,14 @@ +CUDA_OPTIX_COMPILATION +---------------------- + +.. versionadded:: 3.27 + +Compile CUDA sources to ``.optixir`` files instead of ``.obj`` files +within :ref:`Object Libraries`. + +For example: + +.. code-block:: cmake + + add_library(myoptix OBJECT a.cu b.cu) + set_property(TARGET myoptix PROPERTY CUDA_OPTIX_COMPILATION ON) diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_PTX_COMPILATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_PTX_COMPILATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..b0694a2205e8fc75929e206b9aa26a3572cf5df3 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_PTX_COMPILATION.rst @@ -0,0 +1,14 @@ +CUDA_PTX_COMPILATION +-------------------- + +.. versionadded:: 3.9 + +Compile CUDA sources to ``.ptx`` files instead of ``.obj`` files +within :ref:`Object Libraries`. + +For example: + +.. code-block:: cmake + + add_library(myptx OBJECT a.cu b.cu) + set_property(TARGET myptx PROPERTY CUDA_PTX_COMPILATION ON) diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_RESOLVE_DEVICE_SYMBOLS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_RESOLVE_DEVICE_SYMBOLS.rst new file mode 100644 index 0000000000000000000000000000000000000000..414c1cbf1b983882c6a42f833e45455474fb171f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_RESOLVE_DEVICE_SYMBOLS.rst @@ -0,0 +1,32 @@ +CUDA_RESOLVE_DEVICE_SYMBOLS +--------------------------- + +.. versionadded:: 3.9 + +CUDA only: Enables device linking for the specific library target where +required. + +If set, this will tell the required compilers to enable device linking +on the library target. Device linking is an additional link step +required by some CUDA compilers when :prop_tgt:`CUDA_SEPARABLE_COMPILATION` is +enabled. Normally device linking is deferred until a shared library or +executable is generated, allowing for multiple static libraries to resolve +device symbols at the same time when they are used by a shared library or +executable. + +If this property or :variable:`CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS` is unset, +static libraries are treated as if it is disabled while shared, module, +and executable targets behave as if it is on. + +If :variable:`CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS` has been defined, +this property is initialized to the value the variable and overriding +the default behavior. + +Note that device linking is not supported for :ref:`Object Libraries`. + + +For instance: + +.. code-block:: cmake + + set_property(TARGET mystaticlib PROPERTY CUDA_RESOLVE_DEVICE_SYMBOLS ON) diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_RUNTIME_LIBRARY-VALUES.txt b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_RUNTIME_LIBRARY-VALUES.txt new file mode 100644 index 0000000000000000000000000000000000000000..3a6cfb7289ee334839765f921bc99ecbc76be224 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_RUNTIME_LIBRARY-VALUES.txt @@ -0,0 +1,9 @@ +``None`` + Link with ``-cudart=none`` or equivalent flag(s) to use no CUDA + runtime library. +``Shared`` + Link with ``-cudart=shared`` or equivalent flag(s) to use a + dynamically-linked CUDA runtime library. +``Static`` + Link with ``-cudart=static`` or equivalent flag(s) to use a + statically-linked CUDA runtime library. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst new file mode 100644 index 0000000000000000000000000000000000000000..b901212b8087c81d167dfc0651214c81df71824c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst @@ -0,0 +1,23 @@ +CUDA_RUNTIME_LIBRARY +-------------------- + +.. versionadded:: 3.17 + +Select the CUDA runtime library for use by compilers targeting the CUDA language. + +The allowed case insensitive values are: + +.. include:: CUDA_RUNTIME_LIBRARY-VALUES.txt + +Contents of ``CUDA_RUNTIME_LIBRARY`` may use +:manual:`generator expressions `. + +If that property is not set then CMake uses an appropriate default +value based on the compiler to select the CUDA runtime library. + +.. note:: + + This property has effect only when the ``CUDA`` language is enabled. To + control the CUDA runtime linking when only using the CUDA SDK with the + ``C`` or ``C++`` language we recommend using the :module:`FindCUDAToolkit` + module. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_SEPARABLE_COMPILATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_SEPARABLE_COMPILATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..73071c0e87bf0ecca9736d1f854c2eb9cdce7052 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_SEPARABLE_COMPILATION.rst @@ -0,0 +1,19 @@ +CUDA_SEPARABLE_COMPILATION +-------------------------- + +.. versionadded:: 3.8 + +CUDA only: Enables separate compilation of device code + +If set this will enable separable compilation for all CUDA files for +the given target. + +For instance: + +.. code-block:: cmake + + set_property(TARGET myexe PROPERTY CUDA_SEPARABLE_COMPILATION ON) + +This property is initialized by the value of the +:variable:`CMAKE_CUDA_SEPARABLE_COMPILATION` variable if it is set when a +target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_STANDARD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_STANDARD.rst new file mode 100644 index 0000000000000000000000000000000000000000..d68449a43e7f6b70bafdfd42f38a4d28e366682a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_STANDARD.rst @@ -0,0 +1,68 @@ +CUDA_STANDARD +------------- + +.. versionadded:: 3.8 + +The CUDA/C++ standard whose features are requested to build this target. + +This property specifies the CUDA/C++ standard whose features are requested +to build this target. For some compilers, this results in adding a +flag such as ``-std=gnu++11`` to the compile line. + +Supported values are: + +``98`` + CUDA C++98. Note that this maps to the same as ``03`` internally. + +``03`` + CUDA C++03 + +``11`` + CUDA C++11 + +``14`` + CUDA C++14. While CMake 3.8 and later *recognize* ``14`` as a valid value, + CMake 3.9 was the first version to include support for any compiler. + +``17`` + CUDA C++17. While CMake 3.8 and later *recognize* ``17`` as a valid value, + CMake 3.18 was the first version to include support for any compiler. + +``20`` + .. versionadded:: 3.12 + + CUDA C++20. While CMake 3.12 and later *recognize* ``20`` as a valid value, + CMake 3.18 was the first version to include support for any compiler. + +``23`` + .. versionadded:: 3.20 + + CUDA C++23 + +``26`` + .. versionadded:: 3.25 + + CUDA C++26. CMake 3.25 and later *recognize* ``26`` as a valid value, + no version has support for any compiler. + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY CUDA_STANDARD 11) + +with a compiler which does not support ``-std=gnu++11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu++03`` flag if supported. This "decay" behavior may be controlled +with the :prop_tgt:`CUDA_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`CUDA_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CUDA_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_STANDARD_REQUIRED.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_STANDARD_REQUIRED.rst new file mode 100644 index 0000000000000000000000000000000000000000..58c833b84740890ec02d07f2f86a12f19c3f05eb --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CUDA_STANDARD_REQUIRED.rst @@ -0,0 +1,20 @@ +CUDA_STANDARD_REQUIRED +---------------------- + +.. versionadded:: 3.8 + +Boolean describing whether the value of :prop_tgt:`CUDA_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`CUDA_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`CUDA_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. For compilers that have no notion of a standard level, such as +MSVC 1800 (Visual Studio 2013) and lower, this has no effect. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CUDA_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CXX_EXTENSIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_EXTENSIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..ec8db2e943f072068df06ab6ebb0fffc26444a67 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_EXTENSIONS.rst @@ -0,0 +1,21 @@ +CXX_EXTENSIONS +-------------- + +.. versionadded:: 3.1 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu++11`` instead of ``-std=c++11`` to the compile line. This +property is ``ON`` by default. The basic C++ standard level is +controlled by the :prop_tgt:`CXX_STANDARD` target property. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CXX_EXTENSIONS` variable if set when a target is created +and otherwise by the value of +:variable:`CMAKE_CXX_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` (see +:policy:`CMP0128`). diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_DIRS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_DIRS.rst new file mode 100644 index 0000000000000000000000000000000000000000..14e1ca7f4a5d5b9f7b70c3db903b74bc0fe678c9 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_DIRS.rst @@ -0,0 +1,15 @@ +CXX_MODULE_DIRS +--------------- + +.. versionadded:: 3.28 + +Semicolon-separated list of base directories of the target's default +C++ module set (i.e. the file set with name and type ``CXX_MODULES``). The +property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`CXX_MODULE_DIRS_` for the list of base directories in +other C++ module sets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_DIRS_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_DIRS_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..67817c657d6391f2b9afefee0936cedcc03ebec1 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_DIRS_NAME.rst @@ -0,0 +1,15 @@ +CXX_MODULE_DIRS_ +---------------------- + +.. versionadded:: 3.28 + +Semicolon-separated list of base directories of the target's ```` C++ +module set, which has the set type ``CXX_MODULES``. The property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`CXX_MODULE_DIRS` for the list of base directories in the +default C++ module set. See :prop_tgt:`CXX_MODULE_SETS` for the file set names +of all C++ module sets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_SET.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_SET.rst new file mode 100644 index 0000000000000000000000000000000000000000..c6a8279d8f1679643df8b9e3d8b858336f074ee8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_SET.rst @@ -0,0 +1,16 @@ +CXX_MODULE_SET +-------------- + +.. versionadded:: 3.28 + +Semicolon-separated list of files in the target's default C++ module set, +(i.e. the file set with name and type ``CXX_MODULES``). If any of the paths +are relative, they are computed relative to the target's source directory. The +property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`CXX_MODULE_SET_` for the list of files in other C++ +module sets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_SETS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_SETS.rst new file mode 100644 index 0000000000000000000000000000000000000000..bbe32551deb822935d5afcddd44e81b1754e7029 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_SETS.rst @@ -0,0 +1,14 @@ +CXX_MODULE_SETS +--------------- + +.. versionadded:: 3.28 + +Read-only list of the target's ``PRIVATE`` and ``PUBLIC`` C++ module sets (i.e. +all file sets with the type ``CXX_MODULES``). Files listed in these file sets +are treated as source files for the purpose of IDE integration. + +C++ module sets may be defined using the :command:`target_sources` command +``FILE_SET`` option with type ``CXX_MODULES``. + +See also :prop_tgt:`CXX_MODULE_SET_`, :prop_tgt:`CXX_MODULE_SET` and +:prop_tgt:`INTERFACE_CXX_MODULE_SETS`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_SET_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_SET_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..7bdb492a23b39b930a37e72803199dcc42d502a8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_SET_NAME.rst @@ -0,0 +1,16 @@ +CXX_MODULE_SET_ +--------------------- + +.. versionadded:: 3.28 + +Semicolon-separated list of files in the target's ```` C++ module set, +which has the set type ``CXX_MODULES``. If any of the paths are relative, they +are computed relative to the target's source directory. The property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`CXX_MODULE_SET` for the list of files in the default C++ module +set. See :prop_tgt:`CXX_MODULE_SETS` for the file set names of all C++ module +sets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_STD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_STD.rst new file mode 100644 index 0000000000000000000000000000000000000000..817136d2360ecc45f98c424ec61cd596bc901517 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_MODULE_STD.rst @@ -0,0 +1,41 @@ +CXX_MODULE_STD +-------------- + +.. versionadded:: 3.30 + +``CXX_MODULE_STD`` is a boolean specifying whether the target may use +``import std;`` its C++ sources or not. + +.. note :: + + This setting is meaningful only when experimental support for ``import + std;`` has been enabled by the ``CMAKE_EXPERIMENTAL_CXX_IMPORT_STD`` gate. + +When this property is explicitly set to ``ON``, CMake will add a dependency to +a target which provides the C++ standard library's modules for the C++ +standard applied to the target. This target is only applicable within the +current build and will not appear in the exported interfaces of the targets. +When consumed, these targets will be reapplied as necessary. + +.. note: + + Similar to the introduction of :prop:`CXX_SCAN_FOR_MODULES`, this property + defaults to _not_ adding ``import std`` support to targets using + ``cxx_std_23`` without an explicit request in order to preserve existing + behavior for projects using C++23 without ``import std``. A future policy + to change the default behavior is expected once the feature sees wider + usage. + +This property's value is not relevant for targets which disable scanning (see +:prop_tgt:`CXX_SCAN_FOR_MODULES`). Additionally, this property only applies to +targets utilizing C++23 (``cxx_std_23``) or newer. + +The property supports +:manual:`generator expressions `, however +expressions that depend upon the configuration, the consuming target, or the +linker language are not allowed. Whether a target uses ``import std`` should +not depend upon such things as it is a static property of the target's source +code. + +Targets which are exported with C++ module sources will have this property's +resolved value exported. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CXX_SCAN_FOR_MODULES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_SCAN_FOR_MODULES.rst new file mode 100644 index 0000000000000000000000000000000000000000..19d40761545cfe4c57c8877669e4566b9f6a2621 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_SCAN_FOR_MODULES.rst @@ -0,0 +1,22 @@ +CXX_SCAN_FOR_MODULES +-------------------- + +.. versionadded:: 3.28 + +``CXX_SCAN_FOR_MODULES`` is a boolean specifying whether CMake will scan C++ +sources in the target for module dependencies. See also the +:prop_sf:`CXX_SCAN_FOR_MODULES` for per-source settings which, if set, +overrides the target-wide settings. + +This property is initialized by the value of the +:variable:`CMAKE_CXX_SCAN_FOR_MODULES` variable if it is set when a target is +created. + +When this property is set ``ON`` or unset, CMake will scan the target's +``CXX`` sources at build time and add module dependency information to the +compile line as necessary. When this property is set ``OFF``, CMake will not +scan the target's ``CXX`` sources at build time. + +Note that scanning is only performed if C++20 or higher is enabled for the +target. Scanning for modules in the target's sources belonging to file sets +of type ``CXX_MODULES`` is always performed. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CXX_STANDARD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_STANDARD.rst new file mode 100644 index 0000000000000000000000000000000000000000..661056b82da6dab635269901fcb05eb57be03938 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_STANDARD.rst @@ -0,0 +1,66 @@ +CXX_STANDARD +------------ + +.. versionadded:: 3.1 + +The C++ standard whose features are requested to build this target. + +This property specifies the C++ standard whose features are requested +to build this target. For some compilers, this results in adding a +flag such as ``-std=gnu++11`` to the compile line. For compilers that +have no notion of a standard level, such as Microsoft Visual C++ before +2015 Update 3, this has no effect. + +Supported values are: + +``98`` + C++98 + +``11`` + C++11 + +``14`` + C++14 + +``17`` + .. versionadded:: 3.8 + + C++17 + +``20`` + .. versionadded:: 3.12 + + C++20 + +``23`` + .. versionadded:: 3.20 + + C++23 + +``26`` + .. versionadded:: 3.25 + + C++26. CMake 3.25 and later *recognize* ``26`` as a valid value, + no version has support for any compiler. + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY CXX_STANDARD 11) + +with a compiler which does not support ``-std=gnu++11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu++98`` flag if supported. This "decay" behavior may be controlled +with the :prop_tgt:`CXX_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`CXX_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CXX_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/CXX_STANDARD_REQUIRED.rst b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_STANDARD_REQUIRED.rst new file mode 100644 index 0000000000000000000000000000000000000000..262942bd670926cc31d60c0aa9e79f1fd1f65e9c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/CXX_STANDARD_REQUIRED.rst @@ -0,0 +1,20 @@ +CXX_STANDARD_REQUIRED +--------------------- + +.. versionadded:: 3.1 + +Boolean describing whether the value of :prop_tgt:`CXX_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`CXX_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`CXX_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. For compilers that have no notion of a standard level, such as +MSVC 1800 (Visual Studio 2013) and lower, this has no effect. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_CXX_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/C_EXTENSIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/C_EXTENSIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..3ea145893cf314a16438e3d3eb6b5dc559cdb16f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/C_EXTENSIONS.rst @@ -0,0 +1,21 @@ +C_EXTENSIONS +------------ + +.. versionadded:: 3.1 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu11`` instead of ``-std=c11`` to the compile line. This +property is ``ON`` by default. The basic C standard level is +controlled by the :prop_tgt:`C_STANDARD` target property. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_C_EXTENSIONS` variable if set when a target is created and +otherwise by the value of +:variable:`CMAKE_C_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` (see +:policy:`CMP0128`). diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/C_STANDARD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/C_STANDARD.rst new file mode 100644 index 0000000000000000000000000000000000000000..2fb6e7b985e69b89b41a733290c70f7e8e05619e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/C_STANDARD.rst @@ -0,0 +1,55 @@ +C_STANDARD +---------- + +.. versionadded:: 3.1 + +The C standard whose features are requested to build this target. + +This property specifies the C standard whose features are requested +to build this target. For some compilers, this results in adding a +flag such as ``-std=gnu11`` to the compile line. For compilers that +have no notion of a C standard level, such as Microsoft Visual C++ before +VS 16.7, this property has no effect. + +Supported values are: + +``90`` + C89/C90 + +``99`` + C99 + +``11`` + C11 + +``17`` + .. versionadded:: 3.21 + + C17 + +``23`` + .. versionadded:: 3.21 + + C23 + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY C_STANDARD 11) + +with a compiler which does not support ``-std=gnu11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu99`` or ``-std=gnu90`` flag if supported. This "decay" behavior may +be controlled with the :prop_tgt:`C_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`C_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_C_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/C_STANDARD_REQUIRED.rst b/cmake/share/cmake-3.31/Help/prop_tgt/C_STANDARD_REQUIRED.rst new file mode 100644 index 0000000000000000000000000000000000000000..9cf7c88ade3e192acdb717a014241245ab0bf5c0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/C_STANDARD_REQUIRED.rst @@ -0,0 +1,20 @@ +C_STANDARD_REQUIRED +------------------- + +.. versionadded:: 3.1 + +Boolean describing whether the value of :prop_tgt:`C_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`C_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`C_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. For compilers that have no notion of a C standard level, such +as Microsoft Visual C++ before VS 16.7, this property has no effect. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_C_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/DEBUG_POSTFIX.rst b/cmake/share/cmake-3.31/Help/prop_tgt/DEBUG_POSTFIX.rst new file mode 100644 index 0000000000000000000000000000000000000000..60c89166e9485f9e7a1bf66b84d87e45d6ce79ae --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/DEBUG_POSTFIX.rst @@ -0,0 +1,7 @@ +DEBUG_POSTFIX +------------- + +See target property :prop_tgt:`_POSTFIX`. + +This property is a special case of the more-general :prop_tgt:`_POSTFIX` +property for the ``DEBUG`` configuration. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/DEFINE_SYMBOL.rst b/cmake/share/cmake-3.31/Help/prop_tgt/DEFINE_SYMBOL.rst new file mode 100644 index 0000000000000000000000000000000000000000..304de16dc273447e44b42129d38f7ec5ebbd6cb5 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/DEFINE_SYMBOL.rst @@ -0,0 +1,17 @@ +DEFINE_SYMBOL +------------- + +Define a symbol when compiling this target's sources. + +``DEFINE_SYMBOL`` sets the name of the preprocessor symbol defined when +compiling sources in a shared library. If not set here then it is set +to ``target_EXPORTS`` by default (with some substitutions if the target is +not a valid C identifier). This is useful for headers to know whether +they are being included from inside their library or outside to +properly setup dllexport/dllimport decorations on Windows. + +On POSIX platforms, this can optionally be used to control the visibility +of symbols. + +CMake provides support for such decorations with the :module:`GenerateExportHeader` +module. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/DEPLOYMENT_ADDITIONAL_FILES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/DEPLOYMENT_ADDITIONAL_FILES.rst new file mode 100644 index 0000000000000000000000000000000000000000..684128513b0f8e71fe31fc4722f16d93d1e29af2 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/DEPLOYMENT_ADDITIONAL_FILES.rst @@ -0,0 +1,20 @@ +DEPLOYMENT_ADDITIONAL_FILES +--------------------------- + +.. versionadded:: 3.13 + +Set the WinCE project ``AdditionalFiles`` in ``DeploymentTool`` in ``.vcproj`` +files generated by the :ref:`Visual Studio Generators`. +This is useful when you want to debug on remote WinCE device. +Specify additional files that will be copied to the device. +For example: + +.. code-block:: cmake + + set_property(TARGET ${TARGET} PROPERTY + DEPLOYMENT_ADDITIONAL_FILES "english.lng|local_folder|remote_folder|0" + "german.lng|local_folder|remote_folder|0") + +produces:: + + diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst new file mode 100644 index 0000000000000000000000000000000000000000..d6127904115ad91dd49daf7645aaa973984ef56a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY.rst @@ -0,0 +1,20 @@ +DEPLOYMENT_REMOTE_DIRECTORY +--------------------------- + +.. versionadded:: 3.6 + +Set the WinCE project ``RemoteDirectory`` in ``DeploymentTool`` and +``RemoteExecutable`` in ``DebuggerTool`` in ``.vcproj`` files generated +by the :ref:`Visual Studio Generators`. +This is useful when you want to debug on remote WinCE device. +For example: + +.. code-block:: cmake + + set_property(TARGET ${TARGET} PROPERTY + DEPLOYMENT_REMOTE_DIRECTORY "\\FlashStorage") + +produces:: + + + diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/DEPRECATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/DEPRECATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..05d0327a436f731e13d7db043cd40bc8cdb547ce --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/DEPRECATION.rst @@ -0,0 +1,14 @@ +DEPRECATION +----------- + +.. versionadded:: 3.17 + +Deprecation message from imported target's developer. + +``DEPRECATION`` is the message regarding a deprecation status to be displayed +to downstream users of a target. + +The message is formatted as follows: + +* Lines that do not start in whitespace are wrapped as paragraph text. +* Lines that start in whitespace are preserved as preformatted text. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/DISABLE_PRECOMPILE_HEADERS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/DISABLE_PRECOMPILE_HEADERS.rst new file mode 100644 index 0000000000000000000000000000000000000000..fa3b73e923aa3995baa5b8a69ed367259126bfda --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/DISABLE_PRECOMPILE_HEADERS.rst @@ -0,0 +1,10 @@ +DISABLE_PRECOMPILE_HEADERS +-------------------------- + +.. versionadded:: 3.16 + +Disables the precompilation of header files specified by +:prop_tgt:`PRECOMPILE_HEADERS` property. + +If the property is not set, CMake will use the value provided +by :variable:`CMAKE_DISABLE_PRECOMPILE_HEADERS`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/DLL_NAME_WITH_SOVERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/DLL_NAME_WITH_SOVERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..1ca193fb3752058d667bbe1920d33208b87f3167 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/DLL_NAME_WITH_SOVERSION.rst @@ -0,0 +1,17 @@ +DLL_NAME_WITH_SOVERSION +----------------------- + +.. versionadded:: 3.27 + +This property controls whether the :prop_tgt:`SOVERSION` target +property is added to the filename of generated DLL filenames +for the Windows platform, which is selected when the +:variable:`WIN32` variable is set. + +The value of the listed property is appended to the +basename of the runtime component of the shared library +target as ``-``. + +Please note that setting this property has no effect +if versioned filenames are globally disabled with the +:variable:`CMAKE_PLATFORM_NO_VERSIONED_SONAME` variable. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/DOTNET_SDK.rst b/cmake/share/cmake-3.31/Help/prop_tgt/DOTNET_SDK.rst new file mode 100644 index 0000000000000000000000000000000000000000..e2f1981f670b3aaa4933a335279d179116e8d9f7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/DOTNET_SDK.rst @@ -0,0 +1,25 @@ +DOTNET_SDK +---------- + +.. versionadded:: 3.23 + +Specify the .NET SDK for C# projects. For example: ``Microsoft.NET.Sdk``. + +This property tells :ref:`Visual Studio Generators` for VS 2019 and +above to generate a .NET SDK-style project using the specified SDK. +The property is meaningful only to these generators, and only in C# +targets. It is ignored for C++ projects, even if they are managed +(e.g. using :prop_tgt:`COMMON_LANGUAGE_RUNTIME`). + +This property must be a non-empty string to generate .NET SDK-style projects. +CMake does not perform any validations for the value of the property. + +This property may be initialized for all targets using the +:variable:`CMAKE_DOTNET_SDK` variable. + +.. note:: + + The :ref:`Visual Studio Generators` in this version of CMake have not + yet learned to support :command:`add_custom_command` in .NET SDK-style + projects. It is currently an error to attach a custom command to a + target with the ``DOTNET_SDK`` property set. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK.rst b/cmake/share/cmake-3.31/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK.rst new file mode 100644 index 0000000000000000000000000000000000000000..457d406b008eaf5bbbd807f6d2dc697b82c1363e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK.rst @@ -0,0 +1,15 @@ +DOTNET_TARGET_FRAMEWORK +----------------------- + +.. versionadded:: 3.17 + +Specify the .NET target framework. + +Used to specify the .NET target framework for C++/CLI and C#. For +example: ``netcoreapp2.1``. + +This property is only evaluated for :ref:`Visual Studio Generators` +VS 2010 and above. + +Can be initialized for all targets using the variable +:variable:`CMAKE_DOTNET_TARGET_FRAMEWORK`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK_VERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK_VERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..26081841bcf8b78f684ea5570a3ffdf3db3bd8fd --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/DOTNET_TARGET_FRAMEWORK_VERSION.rst @@ -0,0 +1,17 @@ +DOTNET_TARGET_FRAMEWORK_VERSION +------------------------------- + +.. versionadded:: 3.12 + +Specify the .NET target framework version. + +Used to specify the .NET target framework version for C++/CLI and C#. +For example: ``v4.5``. + +This property is only evaluated for :ref:`Visual Studio Generators` +VS 2010 and above. + +To initialize this variable for all targets set +:variable:`CMAKE_DOTNET_TARGET_FRAMEWORK` or +:variable:`CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION`. If both are set, +the latter is ignored. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/ENABLE_EXPORTS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/ENABLE_EXPORTS.rst new file mode 100644 index 0000000000000000000000000000000000000000..3036fe087d2c91389c6e5aed45178bfd14df784b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/ENABLE_EXPORTS.rst @@ -0,0 +1,59 @@ +ENABLE_EXPORTS +-------------- + +Specify whether an executable or a shared library exports symbols. + +Normally an executable does not export any symbols because it is the +final program. It is possible for an executable to export symbols to +be used by loadable modules. When this property is set to true CMake +will allow other targets to "link" to the executable with the +:command:`target_link_libraries` command. On all platforms a target-level +dependency on the executable is created for targets that link to it. +Handling of the executable on the link lines of the loadable modules +varies by platform: + +* On Windows-based systems (including Cygwin) an "import library" is + created along with the executable to list the exported symbols. + Loadable modules link to the import library to get the symbols. + +* On macOS, loadable modules link to the executable itself using the + ``-bundle_loader`` flag. + +* On AIX, a linker "import file" is created along with the executable + to list the exported symbols for import when linking other targets. + Loadable modules link to the import file to get the symbols. + +* On other platforms, loadable modules are simply linked without + referencing the executable since the dynamic loader will + automatically bind symbols when the module is loaded. + +This property is initialized by the value of the +:variable:`CMAKE_EXECUTABLE_ENABLE_EXPORTS` variable, if it is set when an +executable target is created. If :variable:`CMAKE_EXECUTABLE_ENABLE_EXPORTS` +is not set, the :variable:`CMAKE_ENABLE_EXPORTS` variable is used to initialize +the property instead for backward compatibility reasons. +See below for alternative initialization behavior for shared library targets. + +.. versionadded:: 3.27 + To link with a shared library on macOS, or to a shared framework on any Apple + platform, a linker import file can be used instead of the actual shared + library. These linker import files are also known as text-based stubs, and + they have a ``.tbd`` file extension. + + The generation of these linker import files, as well as their consumption, is + controlled by this property. When this property is set to true on a shared + library target, CMake will generate a ``.tbd`` file for the library. + Other targets that link to the shared library target will then use this + ``.tbd`` file when linking rather than linking to the shared library binary. + + .. note:: + + For backward compatibility reasons, this property will be ignored if the + :prop_tgt:`XCODE_ATTRIBUTE_GENERATE_TEXT_BASED_STUBS >` + target property or the + :variable:`CMAKE_XCODE_ATTRIBUTE_GENERATE_TEXT_BASED_STUBS >` + variable is set to false. + + For shared library targets, this property is initialized by the value of the + :variable:`CMAKE_SHARED_LIBRARY_ENABLE_EXPORTS` variable, if it is set when + the target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/EXCLUDE_FROM_ALL.rst b/cmake/share/cmake-3.31/Help/prop_tgt/EXCLUDE_FROM_ALL.rst new file mode 100644 index 0000000000000000000000000000000000000000..ca85458a66cf0ea24a448de338715456637ea583 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/EXCLUDE_FROM_ALL.rst @@ -0,0 +1,28 @@ +EXCLUDE_FROM_ALL +---------------- + +Set this target property to a true (or false) value to exclude (or include) +the target from the "all" target of the containing directory and its +ancestors. If excluded, running e.g. ``make`` in the containing directory +or its ancestors will not build the target by default. + +If this target property is not set then the target will be included in +the "all" target of the containing directory. Furthermore, it will be +included in the "all" target of its ancestor directories unless the +:prop_dir:`EXCLUDE_FROM_ALL` directory property is set. + +With ``EXCLUDE_FROM_ALL`` set to false or not set at all, the target +will be brought up to date as part of doing a ``make install`` or its +equivalent for the CMake generator being used. + +If a target has ``EXCLUDE_FROM_ALL`` set to true, it may still be listed +in an :command:`install(TARGETS)` command, but the user is responsible for +ensuring that the target's build artifacts are not missing or outdated when +an install is performed. + +This property may use "generator expressions" with the syntax ``$<...>``. See +the :manual:`cmake-generator-expressions(7)` manual for available expressions. + +Only the "Ninja Multi-Config" generator supports a property value that varies by +configuration. For all other generators the value of this property must be the +same for all configurations. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst new file mode 100644 index 0000000000000000000000000000000000000000..6f74eaa7534ba2ca697db0a6a35c9a899d01f0f3 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst @@ -0,0 +1,8 @@ +EXCLUDE_FROM_DEFAULT_BUILD +-------------------------- + +Exclude target from ``Build Solution``. + +This property is only used by Visual Studio generators. +When set to ``TRUE``, the target will not be built when you press +``Build Solution``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..2d6eb7ecdf19b5b98d9b7cad1bee541b2776c6c7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst @@ -0,0 +1,10 @@ +EXCLUDE_FROM_DEFAULT_BUILD_ +----------------------------------- + +Per-configuration version of target exclusion from ``Build Solution``. + +This is the configuration-specific version of +:prop_tgt:`EXCLUDE_FROM_DEFAULT_BUILD`. If the generic +:prop_tgt:`EXCLUDE_FROM_DEFAULT_BUILD` is also set on a target, +``EXCLUDE_FROM_DEFAULT_BUILD_`` takes +precedence in configurations for which it has a value. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_BUILD_DATABASE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_BUILD_DATABASE.rst new file mode 100644 index 0000000000000000000000000000000000000000..fda6308cd813d70393b31b2b6d81d0218e58a95a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_BUILD_DATABASE.rst @@ -0,0 +1,15 @@ +EXPORT_BUILD_DATABASE +--------------------- + +.. versionadded:: 3.31 + +Enable/Disable output of a build database for a target. + +This property is initialized by the value of the variable +:variable:`CMAKE_EXPORT_BUILD_DATABASE` if it is set when a target is created. + +.. note :: + + This property is meaningful only when experimental support for build + databases has been enabled by the + ``CMAKE_EXPERIMENTAL_EXPORT_BUILD_DATABASE`` gate. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_COMPILE_COMMANDS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_COMPILE_COMMANDS.rst new file mode 100644 index 0000000000000000000000000000000000000000..dadaf2b6d2a58dcd32ed20c634cc411d00d487ee --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_COMPILE_COMMANDS.rst @@ -0,0 +1,9 @@ +EXPORT_COMPILE_COMMANDS +----------------------- + +.. versionadded:: 3.20 + +Enable/Disable output of compile commands during generation for a target. + +This property is initialized by the value of the variable +:variable:`CMAKE_EXPORT_COMPILE_COMMANDS` if it is set when a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_FIND_PACKAGE_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_FIND_PACKAGE_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..4f010b6e9eb479a18ba8bd4f9de735076fb9e4a7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_FIND_PACKAGE_NAME.rst @@ -0,0 +1,14 @@ +EXPORT_FIND_PACKAGE_NAME +------------------------ + +.. note:: + + Experimental. Gated by ``CMAKE_EXPERIMENTAL_EXPORT_PACKAGE_DEPENDENCIES``. + +Control the package name associated with a dependency target when exporting a +:command:`find_dependency` call in :command:`install(EXPORT)` or +:command:`export(EXPORT)`. This can be used to assign a package name to a +package that is built by CMake and exported, or to override the package in the +:command:`find_package` call that created the target. + +This property is initialized by :variable:`CMAKE_EXPORT_FIND_PACKAGE_NAME`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..a722db73a3c344b090dbc4aab1cb1939bdc56410 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_NAME.rst @@ -0,0 +1,8 @@ +EXPORT_NAME +----------- + +Exported name for target files. + +This sets the name for the ``IMPORTED`` target generated by the +:command:`install(EXPORT)` and :command:`export` commands. +If not set, the logical target name is used by default. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_NO_SYSTEM.rst b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_NO_SYSTEM.rst new file mode 100644 index 0000000000000000000000000000000000000000..c341e403465e58b0e409cf687fcc0efbba267fe7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_NO_SYSTEM.rst @@ -0,0 +1,13 @@ +EXPORT_NO_SYSTEM +---------------- + +.. versionadded:: 3.25 + +This property affects the behavior of the :command:`install(EXPORT)` and +:command:`export` commands when they install or export the target respectively. +When ``EXPORT_NO_SYSTEM`` is set to true, those commands generate an imported +target with :prop_tgt:`SYSTEM` property set to false. + +See the :prop_tgt:`NO_SYSTEM_FROM_IMPORTED` target property to set this +behavior on the target *consuming* the include directories rather than the +one *providing* them. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_PROPERTIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_PROPERTIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..ad30a620d403566f91a02b19f451f0c10abccd4a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/EXPORT_PROPERTIES.rst @@ -0,0 +1,24 @@ +EXPORT_PROPERTIES +----------------- + +.. versionadded:: 3.12 + +List additional properties to export for a target. + +This property contains a list of property names that should be exported by +the :command:`install(EXPORT)` and :command:`export` commands. By default +only a limited number of properties are exported. This property can be used +to additionally export other properties as well. + +Properties starting with ``INTERFACE_`` or ``IMPORTED_`` are not allowed as +they are reserved for internal CMake use. + +Properties containing generator expressions are also not allowed. + +.. note:: + + Since CMake 3.19, :ref:`Interface Libraries` may have arbitrary + target properties. If a project exports an interface library + with custom properties, the resulting package may not work with + dependents configured by older versions of CMake that reject the + custom properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/EchoString.rst b/cmake/share/cmake-3.31/Help/prop_tgt/EchoString.rst new file mode 100644 index 0000000000000000000000000000000000000000..dec7337a7cc61c9c50c666750b1435beec3843be --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/EchoString.rst @@ -0,0 +1,7 @@ +EchoString +---------- + +A message to be displayed when the target is built. + +A message to display on some generators (such as :ref:`Makefile Generators`) +when the target is built. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/FOLDER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/FOLDER.rst new file mode 100644 index 0000000000000000000000000000000000000000..deda3abad84b5f6641fcd558b7aad7f6b545a56d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/FOLDER.rst @@ -0,0 +1,20 @@ +FOLDER +------ + +For IDEs that present targets using a folder hierarchy, this property +specifies the name of the folder to place the target under. +To nest folders, use ``FOLDER`` values such as ``GUI/Dialogs`` with ``/`` +characters separating folder levels. Targets with no ``FOLDER`` property +will appear as top level entities. Targets with the same ``FOLDER`` +property value will appear in the same folder as siblings. + +Only some CMake generators honor the ``FOLDER`` property +(e.g. :generator:`Xcode` or any of the +:ref:`Visual Studio ` generators). +Those generators that don't will simply ignore it. + +This property is initialized by the value of the variable +:variable:`CMAKE_FOLDER` if it is set when a target is created. + +The global property :prop_gbl:`USE_FOLDERS` must be set to true, otherwise +the ``FOLDER`` property is ignored. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/FRAMEWORK.rst b/cmake/share/cmake-3.31/Help/prop_tgt/FRAMEWORK.rst new file mode 100644 index 0000000000000000000000000000000000000000..0551c8530c2f487cb461e8db79492d63746fd145 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/FRAMEWORK.rst @@ -0,0 +1,37 @@ +FRAMEWORK +--------- + +Build ``SHARED`` or ``STATIC`` library as Framework Bundle on the macOS and iOS. + +If such a library target has this property set to ``TRUE`` it will be +built as a framework when built on the macOS and iOS. It will have the +directory structure required for a framework and will be suitable to +be used with the ``-framework`` option. This property is initialized by the +value of the :variable:`CMAKE_FRAMEWORK` variable if it is set when a target is +created. + +To customize ``Info.plist`` file in the framework, use +:prop_tgt:`MACOSX_FRAMEWORK_INFO_PLIST` target property. + +For macOS see also the :prop_tgt:`FRAMEWORK_VERSION` target property. + +Example of creation ``dynamicFramework``: + +.. code-block:: cmake + + add_library(dynamicFramework SHARED + dynamicFramework.c + dynamicFramework.h + ) + set_target_properties(dynamicFramework PROPERTIES + FRAMEWORK TRUE + FRAMEWORK_VERSION C + MACOSX_FRAMEWORK_IDENTIFIER com.cmake.dynamicFramework + MACOSX_FRAMEWORK_INFO_PLIST Info.plist + # "current version" in semantic format in Mach-O binary file + VERSION 16.4.0 + # "compatibility version" in semantic format in Mach-O binary file + SOVERSION 1.0.0 + PUBLIC_HEADER dynamicFramework.h + XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY "iPhone Developer" + ) diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..5eaa7182dbdd4aa72b2c7ce1d716d74ec48e003c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst @@ -0,0 +1,28 @@ +FRAMEWORK_MULTI_CONFIG_POSTFIX_ +--------------------------------------- + +.. versionadded:: 3.18 + +Postfix to append to the framework file name for configuration ````, +when using a multi-config generator (like Xcode and Ninja Multi-Config). + +When building with configuration ```` the value of this property +is appended to the framework file name built on disk. + +For example, given a framework called ``my_fw``, a value of ``_debug`` +for the ``FRAMEWORK_MULTI_CONFIG_POSTFIX_DEBUG`` property, and +``Debug;Release`` in :variable:`CMAKE_CONFIGURATION_TYPES`, the following +relevant files would be created for the ``Debug`` and ``Release`` +configurations: + +- ``Release/my_fw.framework/my_fw`` +- ``Release/my_fw.framework/Versions/A/my_fw`` +- ``Debug/my_fw.framework/my_fw_debug`` +- ``Debug/my_fw.framework/Versions/A/my_fw_debug`` + +For framework targets, this property is initialized by the value of the +:variable:`CMAKE_FRAMEWORK_MULTI_CONFIG_POSTFIX_` variable if it +is set when a target is created. + +This property is ignored for non-framework targets, and when using single +config generators. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/FRAMEWORK_VERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/FRAMEWORK_VERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..dbcff615a801e2c85ec7d2dab36c04db4bc8d62e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/FRAMEWORK_VERSION.rst @@ -0,0 +1,10 @@ +FRAMEWORK_VERSION +----------------- + +.. versionadded:: 3.4 + +Version of a framework created using the :prop_tgt:`FRAMEWORK` target +property (e.g. ``A``). + +This property only affects macOS, as iOS doesn't have versioned +directory structure. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_BUILDING_INSTRINSIC_MODULES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_BUILDING_INSTRINSIC_MODULES.rst new file mode 100644 index 0000000000000000000000000000000000000000..afd44714534ae6244b083088796672110418b3cd --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_BUILDING_INSTRINSIC_MODULES.rst @@ -0,0 +1,16 @@ +Fortran_BUILDING_INSTRINSIC_MODULES +----------------------------------- + +.. versionadded:: 3.22 + +Instructs the CMake Fortran preprocessor that the target is building +Fortran intrinsics for building a Fortran compiler. + +This property is off by default and should be turned only on projects +that build a Fortran compiler. It should not be turned on for projects +that use a Fortran compiler. + +Turning this property on will correctly add dependencies for building +Fortran intrinsic modules whereas turning the property off will ignore +Fortran intrinsic modules in the dependency graph as they are supplied +by the compiler itself. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_FORMAT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_FORMAT.rst new file mode 100644 index 0000000000000000000000000000000000000000..9597d4a00a20c0106d5e84954270e72b6731085d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_FORMAT.rst @@ -0,0 +1,11 @@ +Fortran_FORMAT +-------------- + +Set to ``FIXED`` or ``FREE`` to indicate the Fortran source layout. + +This property tells CMake whether the Fortran source files in a target +use fixed-format or free-format. CMake will pass the corresponding +format flag to the compiler. Use the source-specific ``Fortran_FORMAT`` +property to change the format of a specific source file. If the +variable :variable:`CMAKE_Fortran_FORMAT` is set when a target is created its +value is used to initialize this property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst new file mode 100644 index 0000000000000000000000000000000000000000..92fc8dafb9916d639965f4e48beade8eb69eb396 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst @@ -0,0 +1,25 @@ +Fortran_MODULE_DIRECTORY +------------------------ + +Specify output directory for Fortran modules provided by the target. + +If the target contains Fortran source files that provide modules and +the compiler supports a module output directory this specifies the +directory in which the modules will be placed. When this property is +not set the modules will be placed in the build directory +corresponding to the target's source directory. If the variable +:variable:`CMAKE_Fortran_MODULE_DIRECTORY` is set when a target is created its +value is used to initialize this property. + +When using one of the :ref:`Visual Studio Generators` with the Intel Fortran +plugin installed in Visual Studio, a subdirectory named after the +configuration will be appended to the path where modules are created. +For example, if ``Fortran_MODULE_DIRECTORY`` is set to ``C:/some/path``, +modules will end up in ``C:/some/path/Debug`` (or +``C:/some/path/Release`` etc.) when an Intel Fortran ``.vfproj`` file is +generated, and in ``C:/some/path`` when any other generator is used. + +Note that some compilers will automatically search the module output +directory for modules USEd during compilation but others will not. If +your sources USE modules their location must be specified by +:prop_tgt:`INCLUDE_DIRECTORIES` regardless of this property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_PREPROCESS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_PREPROCESS.rst new file mode 100644 index 0000000000000000000000000000000000000000..2a2cc1ecbaf3abb944d93e3a48ac3f5ebee7fc51 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/Fortran_PREPROCESS.rst @@ -0,0 +1,25 @@ +Fortran_PREPROCESS +------------------ + +.. versionadded:: 3.18 + +Control whether the Fortran source file should be unconditionally +preprocessed. + +If unset or empty, rely on the compiler to determine whether the file +should be preprocessed. If explicitly set to ``OFF`` then the file does not +need to be preprocessed. If explicitly set to ``ON``, then the file does +need to be preprocessed as part of the compilation step. + +When using the :generator:`Ninja` generator, all source files are +first preprocessed in order to generate module dependency +information. Setting this property to ``OFF`` will make ``Ninja`` +skip this step. + +Use the source-specific :prop_sf:`Fortran_PREPROCESS` property if a single +file needs to be preprocessed. If the variable +:variable:`CMAKE_Fortran_PREPROCESS` is set when a target is created its +value is used to initialize this property. + +.. note:: For some compilers, ``NAG``, ``PGI`` and ``Solaris Studio``, + setting this to ``OFF`` will have no effect. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/GENERATOR_FILE_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/GENERATOR_FILE_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..8b703458ce868414b582d3f51fe0ddbaeb70a959 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/GENERATOR_FILE_NAME.rst @@ -0,0 +1,9 @@ +GENERATOR_FILE_NAME +------------------- + +Generator's file for this target. + +An internal property used by some generators to record the name of the +project or dsp file associated with this target. Note that at +configure time, this property is only set for targets created by +:command:`include_external_msproject`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/GHS_INTEGRITY_APP.rst b/cmake/share/cmake-3.31/Help/prop_tgt/GHS_INTEGRITY_APP.rst new file mode 100644 index 0000000000000000000000000000000000000000..de3649368ca9227e843f8635a0bc9a33ba63a809 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/GHS_INTEGRITY_APP.rst @@ -0,0 +1,12 @@ +GHS_INTEGRITY_APP +----------------- + +.. versionadded:: 3.14 + +``ON`` / ``OFF`` boolean to determine if an executable target should +be treated as an `Integrity Application`. + +If no value is set and if a ``.int`` file is added as a source file to the +executable target it will be treated as an `Integrity Application`. + +Supported on :generator:`Green Hills MULTI`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/GHS_NO_SOURCE_GROUP_FILE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/GHS_NO_SOURCE_GROUP_FILE.rst new file mode 100644 index 0000000000000000000000000000000000000000..d7184704489cf47a68aff090f0fb682739de93c7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/GHS_NO_SOURCE_GROUP_FILE.rst @@ -0,0 +1,15 @@ +GHS_NO_SOURCE_GROUP_FILE +------------------------ + +.. versionadded:: 3.14 + +``ON`` / ``OFF`` boolean to control if the project file for a target should +be one single file or multiple files. + +The default behavior or when the property is ``OFF`` is to generate a project +file for the target and then a sub-project file for each source group. + +When this property is ``ON`` or if :variable:`CMAKE_GHS_NO_SOURCE_GROUP_FILE` +is ``ON`` then only a single project file is generated for the target. + +Supported on :generator:`Green Hills MULTI`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/GNUtoMS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/GNUtoMS.rst new file mode 100644 index 0000000000000000000000000000000000000000..6413415e0618fb256bd74f49c4550fa56cebb9f0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/GNUtoMS.rst @@ -0,0 +1,17 @@ +GNUtoMS +------- + +Convert GNU import library (``.dll.a``) to MS format (``.lib``). + +When linking a shared library or executable that exports symbols using +GNU tools on Windows (MinGW/MSYS) with Visual Studio installed convert +the import library (``.dll.a``) from GNU to MS format (``.lib``). Both import +libraries will be installed by :command:`install(TARGETS)` and exported by +:command:`install(EXPORT)` and :command:`export` to be linked +by applications with either GNU- or MS-compatible tools. + +If the variable ``CMAKE_GNUtoMS`` is set when a target is created its +value is used to initialize this property. The variable must be set +prior to the first command that enables a language such as :command:`project` +or :command:`enable_language`. CMake provides the variable as an option to the +user automatically when configuring on Windows with GNU tools. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/HAS_CXX.rst b/cmake/share/cmake-3.31/Help/prop_tgt/HAS_CXX.rst new file mode 100644 index 0000000000000000000000000000000000000000..e23421b4cc78ed830ecc2d094975b407e7e932d9 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/HAS_CXX.rst @@ -0,0 +1,7 @@ +HAS_CXX +------- + +Link the target using the C++ linker tool (obsolete). + +This is equivalent to setting the :prop_tgt:`LINKER_LANGUAGE` +property to ``CXX``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_DIRS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_DIRS.rst new file mode 100644 index 0000000000000000000000000000000000000000..827f5c3158cceeb4a08fc88f28d9f09766e875d1 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_DIRS.rst @@ -0,0 +1,14 @@ +HEADER_DIRS +----------- + +.. versionadded:: 3.23 + +Semicolon-separated list of base directories of the target's default +header set (i.e. the file set with name and type ``HEADERS``). The property +supports :manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`HEADER_DIRS_` for the list of base directories in +other header sets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_DIRS_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_DIRS_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..e3fcb8fce97920e046398baf2eab67b66f98f56b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_DIRS_NAME.rst @@ -0,0 +1,15 @@ +HEADER_DIRS_ +------------------ + +.. versionadded:: 3.23 + +Semicolon-separated list of base directories of the target's ```` +header set, which has the set type ``HEADERS``. The property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`HEADER_DIRS` for the list of base directories in the +default header set. See :prop_tgt:`HEADER_SETS` for the file set names of all +header sets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_SET.rst b/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_SET.rst new file mode 100644 index 0000000000000000000000000000000000000000..84fea602896fba0bda6cb35337d1cedd6ac53913 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_SET.rst @@ -0,0 +1,15 @@ +HEADER_SET +---------- + +.. versionadded:: 3.23 + +Semicolon-separated list of files in the target's default header set, +(i.e. the file set with name and type ``HEADERS``). If any of the paths +are relative, they are computed relative to the target's source directory. +The property supports +:manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`HEADER_SET_` for the list of files in other header sets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_SETS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_SETS.rst new file mode 100644 index 0000000000000000000000000000000000000000..983a1c4b689fc1ad9392d5c33779b8f1f65c03f0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_SETS.rst @@ -0,0 +1,15 @@ +HEADER_SETS +----------- + +.. versionadded:: 3.23 + +Read-only list of the target's ``PRIVATE`` and ``PUBLIC`` header sets (i.e. +all file sets with the type ``HEADERS``). Files listed in these file sets are +treated as source files for the purpose of IDE integration. The files also +have their :prop_sf:`HEADER_FILE_ONLY` property set to ``TRUE``. + +Header sets may be defined using the :command:`target_sources` command +``FILE_SET`` option with type ``HEADERS``. + +See also :prop_tgt:`HEADER_SET_`, :prop_tgt:`HEADER_SET` and +:prop_tgt:`INTERFACE_HEADER_SETS`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_SET_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_SET_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..e7fe5e4aff29514e535126ca875affd73b72562f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/HEADER_SET_NAME.rst @@ -0,0 +1,15 @@ +HEADER_SET_ +----------------- + +.. versionadded:: 3.23 + +Semicolon-separated list of files in the target's ```` header set, +which has the set type ``HEADERS``. If any of the paths are relative, +they are computed relative to the target's source directory. The property +supports :manual:`generator expressions `. + +This property is normally only set by :command:`target_sources(FILE_SET)` +rather than being manipulated directly. + +See :prop_tgt:`HEADER_SET` for the list of files in the default header set. +See :prop_tgt:`HEADER_SETS` for the file set names of all header sets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/HIP_ARCHITECTURES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/HIP_ARCHITECTURES.rst new file mode 100644 index 0000000000000000000000000000000000000000..3b5b2d665605d06dae2a2202608539c24efcd787 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/HIP_ARCHITECTURES.rst @@ -0,0 +1,28 @@ +HIP_ARCHITECTURES +----------------- + +.. versionadded:: 3.21 + +List of GPU architectures to for which to generate device code. +Architecture names are interpreted based on :variable:`CMAKE_HIP_PLATFORM`. + +A non-empty false value (e.g. ``OFF``) disables adding architectures. +This is intended to support packagers and rare cases where full control +over the passed flags is required. + +This property is initialized by the value of the :variable:`CMAKE_HIP_ARCHITECTURES` +variable if it is set when a target is created. + +The HIP compilation model has two modes: whole and separable. Whole compilation +generates device code at compile time. Separable compilation generates device +code at link time. Therefore the ``HIP_ARCHITECTURES`` target property should +be set on targets that compile or link with any HIP sources. + +Examples +^^^^^^^^ + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY HIP_ARCHITECTURES gfx801 gfx900) + +Generates code for both ``gfx801`` and ``gfx900``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/HIP_EXTENSIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/HIP_EXTENSIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..d824a2852f6e315ed50fa00b7929e18f21896625 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/HIP_EXTENSIONS.rst @@ -0,0 +1,21 @@ +HIP_EXTENSIONS +-------------- + +.. versionadded:: 3.21 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu++11`` instead of ``-std=c++11`` to the compile line. This +property is ``ON`` by default. The basic HIP/C++ standard level is +controlled by the :prop_tgt:`HIP_STANDARD` target property. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_HIP_EXTENSIONS` variable if set when a target is created +and otherwise by the value of +:variable:`CMAKE_HIP_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` (see +:policy:`CMP0128`). diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/HIP_STANDARD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/HIP_STANDARD.rst new file mode 100644 index 0000000000000000000000000000000000000000..0121c18287110e9411734909f713ae27ae7ef6bf --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/HIP_STANDARD.rst @@ -0,0 +1,54 @@ +HIP_STANDARD +------------ + +.. versionadded:: 3.21 + +The HIP/C++ standard requested to build this target. + +Supported values are: + +``98`` + HIP C++98 + +``11`` + HIP C++11 + +``14`` + HIP C++14 + +``17`` + HIP C++17 + +``20`` + HIP C++20 + +``23`` + HIP C++23 + +``26`` + .. versionadded:: 3.25 + + HIP C++26. CMake 3.25 and later *recognize* ``26`` as a valid value, + no version has support for any compiler. + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY HIP_STANDARD 11) + +with a compiler which does not support ``-std=gnu++11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu++98`` flag if supported. This "decay" behavior may be controlled +with the :prop_tgt:`HIP_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`HIP_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_HIP_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/HIP_STANDARD_REQUIRED.rst b/cmake/share/cmake-3.31/Help/prop_tgt/HIP_STANDARD_REQUIRED.rst new file mode 100644 index 0000000000000000000000000000000000000000..a093ee307c4fe21494fbd1aabeb95c898a2064c2 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/HIP_STANDARD_REQUIRED.rst @@ -0,0 +1,19 @@ +HIP_STANDARD_REQUIRED +--------------------- + +.. versionadded:: 3.21 + +Boolean describing whether the value of :prop_tgt:`HIP_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`HIP_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`HIP_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_HIP_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst new file mode 100644 index 0000000000000000000000000000000000000000..9532f596ac291c16ace10d88840eb7554bc8db8e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst @@ -0,0 +1,32 @@ +IMPLICIT_DEPENDS_INCLUDE_TRANSFORM +---------------------------------- + +Specify ``#include`` line transforms for dependencies in a target. + +This property specifies rules to transform macro-like ``#include`` lines +during implicit dependency scanning of C and C++ source files. The +list of rules must be semicolon-separated with each entry of the form +``A_MACRO(%)=value-with-%`` (the ``%`` must be literal). During dependency +scanning occurrences of ``A_MACRO(...)`` on ``#include`` lines will be +replaced by the value given with the macro argument substituted for +``%``. For example, the entry + +:: + + MYDIR(%)= + +will convert lines of the form + +:: + + #include MYDIR(myheader.h) + +to + +:: + + #include + +allowing the dependency to be followed. + +This property applies to sources in the target on which it is set. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED.rst new file mode 100644 index 0000000000000000000000000000000000000000..5ea2547f8e3df93f1e86d53bbcaea62827e09863 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED.rst @@ -0,0 +1,8 @@ +IMPORTED +-------- + +Read-only indication of whether a target is ``IMPORTED``. + +The boolean value of this property is ``True`` for targets created with +the ``IMPORTED`` option to :command:`add_executable` or :command:`add_library`. +It is ``False`` for targets built within the project. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_COMMON_LANGUAGE_RUNTIME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_COMMON_LANGUAGE_RUNTIME.rst new file mode 100644 index 0000000000000000000000000000000000000000..a82548f8309596dfae032b52c432671d1256d61c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_COMMON_LANGUAGE_RUNTIME.rst @@ -0,0 +1,10 @@ +IMPORTED_COMMON_LANGUAGE_RUNTIME +-------------------------------- + +.. versionadded:: 3.12 + +Property to define if the target uses ``C++/CLI``. + +Ignored for non-imported targets. + +See also the :prop_tgt:`COMMON_LANGUAGE_RUNTIME` target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..19bb0f00735081cfdfbb655ddfa8daf91d536066 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst @@ -0,0 +1,22 @@ +IMPORTED_CONFIGURATIONS +----------------------- + +Configurations provided for an :ref:`imported target `. + +Set this to the list of configuration names available for an imported +target. For each configuration named, the imported target's artifacts +must be specified in other target properties: + +* :prop_tgt:`IMPORTED_LOCATION_`, or +* :prop_tgt:`IMPORTED_IMPLIB_` (on DLL platforms, on AIX for + :ref:`Executables ` or on Apple for + :ref:`Shared Libraries `), or +* :prop_tgt:`IMPORTED_OBJECTS_` (for :ref:`Object Libraries`), or +* :prop_tgt:`IMPORTED_LIBNAME_` (for :ref:`Interface Libraries`). + +The configuration names correspond to those defined in the project from +which the target is imported. If the importing project uses a different +set of configurations, the names may be mapped using the +:prop_tgt:`MAP_IMPORTED_CONFIG_` target property. + +The ``IMPORTED_CONFIGURATIONS`` property is ignored for non-imported targets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_DEFINITIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..a93c3ac7674eda365647ead56397edb90028761d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_DEFINITIONS.rst @@ -0,0 +1,10 @@ +IMPORTED_CXX_MODULES_COMPILE_DEFINITIONS +---------------------------------------- + +.. versionadded:: 3.28 + +Preprocessor definitions for compiling an ``IMPORTED`` target's C++ module +sources. + +CMake will automatically drop some definitions that are not supported +by the native build tool. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_FEATURES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_FEATURES.rst new file mode 100644 index 0000000000000000000000000000000000000000..13a38560ff55b9f236d096b7c68873c233513e4c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_FEATURES.rst @@ -0,0 +1,9 @@ +IMPORTED_CXX_MODULES_COMPILE_FEATURES +------------------------------------- + +.. versionadded:: 3.28 + +Compiler features enabled for this ``IMPORTED`` target's C++ modules. + +The value of this property is used by the generators to set the include +paths for the compiler. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_OPTIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_OPTIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..1f46ecc29b86e0e2170f667112e871e5ff8e389b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_OPTIONS.rst @@ -0,0 +1,9 @@ +IMPORTED_CXX_MODULES_COMPILE_OPTIONS +------------------------------------ + +.. versionadded:: 3.28 + +List of options to pass to the compiler for this ``IMPORTED`` target's C++ +modules. + +.. include:: ../command/OPTIONS_SHELL.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_INCLUDE_DIRECTORIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..c6c3c3e8f0cded1818518fa15052615f99748503 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_INCLUDE_DIRECTORIES.rst @@ -0,0 +1,10 @@ +IMPORTED_CXX_MODULES_INCLUDE_DIRECTORIES +---------------------------------------- + +.. versionadded:: 3.28 + +List of preprocessor include file search directories when compiling C++ +modules for ``IMPORTED`` targets. + +The value of this property is used by the generators to set the include +paths for the compiler. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_LINK_LIBRARIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_LINK_LIBRARIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..40e345469d74a3141199de82fcba87bd420304df --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_CXX_MODULES_LINK_LIBRARIES.rst @@ -0,0 +1,7 @@ +IMPORTED_CXX_MODULES_LINK_LIBRARIES +----------------------------------- + +.. versionadded:: 3.28 + +List of direct dependencies to use for usage requirements for C++ modules in +the target's C++ modules. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_GLOBAL.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_GLOBAL.rst new file mode 100644 index 0000000000000000000000000000000000000000..9d96e965f078ceaa78eb7123f1b19b81bbb3d54a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_GLOBAL.rst @@ -0,0 +1,32 @@ +IMPORTED_GLOBAL +--------------- + +.. versionadded:: 3.11 + +Indication of whether an :ref:`IMPORTED target ` is +globally visible. + +The boolean value of this property is True for targets created with the +``IMPORTED`` ``GLOBAL`` options to :command:`add_executable()` or +:command:`add_library()`. It is always False for targets built within the +project. + +For targets created with the ``IMPORTED`` option to +:command:`add_executable()` or :command:`add_library()` but without the +additional option ``GLOBAL`` this is False, too. However, setting this +property for such a locally ``IMPORTED`` target to True promotes that +target to global scope. This promotion can only be done in the same +directory where that ``IMPORTED`` target was created in the first place. + +.. note:: + + Once an imported target has been made global, it cannot be changed back to + non-global. Therefore, if a project sets this property, it may only + provide a value of True. CMake will issue an error if the project tries to + set the property to a non-True value, even if the value was already False. + +.. note:: + + Local :ref:`ALIAS targets ` created before promoting an + :ref:`IMPORTED target ` from ``LOCAL`` to ``GLOBAL``, keep + their initial scope (see :prop_tgt:`ALIAS_GLOBAL` target property). diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_IMPLIB.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_IMPLIB.rst new file mode 100644 index 0000000000000000000000000000000000000000..89b43ba3454abf01a14bfaeaebf678de24a9ab57 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_IMPLIB.rst @@ -0,0 +1,39 @@ +IMPORTED_IMPLIB +--------------- + +Full path to the import library for an ``IMPORTED`` target. + +This property may be set: + +* On DLL platforms, to the location of the ``.lib`` part of the DLL. +* .. versionadded:: 3.16 + On AIX, to an import file (e.g. ``.imp``) created for executables that + export symbols (see the :prop_tgt:`ENABLE_EXPORTS` target property). +* .. versionadded:: 3.27 + On Apple platforms, to an import file (e.g. ``.tbd``) created for shared + libraries or frameworks (see the :prop_tgt:`ENABLE_EXPORTS` target + property). For frameworks, this is the location of the ``.tbd`` file + symlink just inside the framework folder. +* .. versionadded:: 3.28 + On non-DLL platforms, to the location of a shared library. + When set without also specifying an :prop_tgt:`IMPORTED_LOCATION`, + the library is considered to be a stub, and its location will not + be added as a runtime search path to dependents that link it. + +.. versionchanged:: 3.28 + If an imported target is an Apple framework or XCFramework, the preferred + arrangement is to set :prop_tgt:`IMPORTED_LOCATION` to the ``.framework`` + or ``.xcframework`` directory. CMake will then find the relevant ``.tbd`` + file inside that framework or XCFramework automatically without requiring + ``IMPORTED_IMPLIB`` to be set. + +The ``IMPORTED_IMPLIB`` target property may be overridden for a +given configuration ```` by the configuration-specific +:prop_tgt:`IMPORTED_IMPLIB_` target property. Furthermore, +the :prop_tgt:`MAP_IMPORTED_CONFIG_` target property may be +used to map between a project's configurations and those of an imported +target. If none of these is set then the name of any other configuration +listed in the :prop_tgt:`IMPORTED_CONFIGURATIONS` target property may be +selected and its :prop_tgt:`IMPORTED_IMPLIB_` value used. + +This property is ignored for non-imported targets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..69fab10da453c461499ac2ee119f3b6e82ddf348 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_IMPLIB_ +------------------------ + +-specific version of :prop_tgt:`IMPORTED_IMPLIB` property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LIBNAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LIBNAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..ef73a9a13038569c2f59f57c22e394a6ac2df453 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LIBNAME.rst @@ -0,0 +1,25 @@ +IMPORTED_LIBNAME +---------------- + +.. versionadded:: 3.8 + +Specify the link library name for an :ref:`imported ` +:ref:`Interface Library `. + +An interface library builds no library file itself but does specify +usage requirements for its consumers. The ``IMPORTED_LIBNAME`` +property may be set to specify a single library name to be placed +on the link line in place of the interface library target name as +a requirement for using the interface. + +This property is intended for use in naming libraries provided by +a platform SDK for which the full path to a library file may not +be known. The value may be a plain library name such as ``foo`` +but may *not* be a path (e.g. ``/usr/lib/libfoo.so``) or a flag +(e.g. ``-Wl,...``). The name is never treated as a library target +name even if it happens to name one. + +The ``IMPORTED_LIBNAME`` property is allowed only on +:ref:`imported ` :ref:`Interface Libraries` +and is rejected on targets of other types (for which +the :prop_tgt:`IMPORTED_LOCATION` target property may be used). diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LIBNAME_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LIBNAME_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..a140065792cc0cd0146a6aab042fec4e60648dd4 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LIBNAME_CONFIG.rst @@ -0,0 +1,9 @@ +IMPORTED_LIBNAME_ +------------------------- + +.. versionadded:: 3.8 + +-specific version of :prop_tgt:`IMPORTED_LIBNAME` property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..b158c1fa6b2a5d02bc07932dd85745ec38c406f4 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst @@ -0,0 +1,14 @@ +IMPORTED_LINK_DEPENDENT_LIBRARIES +--------------------------------- + +Dependent shared libraries of an imported shared library. + +Shared libraries may be linked to other shared libraries as part of +their implementation. On some platforms the linker searches for the +dependent libraries of shared libraries they are including in the +link. Set this property to the list of dependent shared libraries of +an imported library. The list should be disjoint from the list of +interface libraries in the :prop_tgt:`INTERFACE_LINK_LIBRARIES` property. On +platforms requiring dependent shared libraries to be found at link +time CMake uses this list to add appropriate files or paths to the +link command line. Ignored for non-imported targets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..6fb6b959072c42ae3900690969462a9804fbcf63 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst @@ -0,0 +1,8 @@ +IMPORTED_LINK_DEPENDENT_LIBRARIES_ +------------------------------------------ + +-specific version of :prop_tgt:`IMPORTED_LINK_DEPENDENT_LIBRARIES`. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst new file mode 100644 index 0000000000000000000000000000000000000000..5a5a836fe0aa97d9f1778695b88cdceaa5633b0c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst @@ -0,0 +1,14 @@ +IMPORTED_LINK_INTERFACE_LANGUAGES +--------------------------------- + +Languages compiled into an ``IMPORTED`` static library. + +Set this to the list of languages of source files compiled to produce +a ``STATIC IMPORTED`` library (such as ``C`` or ``CXX``). CMake accounts for +these languages when computing how to link a target to the imported +library. For example, when a C executable links to an imported C++ +static library CMake chooses the C++ linker to satisfy language +runtime dependencies of the static library. + +This property is ignored for targets that are not ``STATIC`` libraries. +This property is ignored for non-imported targets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..6fa3abdbbf29fc126e4f55b79a7f51dcd684a863 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst @@ -0,0 +1,8 @@ +IMPORTED_LINK_INTERFACE_LANGUAGES_ +------------------------------------------ + +-specific version of :prop_tgt:`IMPORTED_LINK_INTERFACE_LANGUAGES`. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..5248fdcc3acc7cec28728131f65ee574576bb137 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst @@ -0,0 +1,16 @@ +IMPORTED_LINK_INTERFACE_LIBRARIES +--------------------------------- + +Transitive link interface of an ``IMPORTED`` target. + +Set this to the list of libraries whose interface is included when an +``IMPORTED`` library target is linked to another target. The libraries +will be included on the link line for the target. Unlike the +:prop_tgt:`LINK_INTERFACE_LIBRARIES` property, this property applies to all +imported target types, including ``STATIC`` libraries. This property is +ignored for non-imported targets. + +This property is ignored if the target also has a non-empty +:prop_tgt:`INTERFACE_LINK_LIBRARIES` property. + +This property is deprecated. Use :prop_tgt:`INTERFACE_LINK_LIBRARIES` instead. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..effb5910e8382dcc1af62c964b8e59e1c5395db6 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst @@ -0,0 +1,13 @@ +IMPORTED_LINK_INTERFACE_LIBRARIES_ +------------------------------------------ + +-specific version of :prop_tgt:`IMPORTED_LINK_INTERFACE_LIBRARIES`. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. + +This property is ignored if the target also has a non-empty +:prop_tgt:`INTERFACE_LINK_LIBRARIES` property. + +This property is deprecated. Use :prop_tgt:`INTERFACE_LINK_LIBRARIES` instead. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst new file mode 100644 index 0000000000000000000000000000000000000000..c3f3e8dcb07b54bc17315f8cd654231190222849 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst @@ -0,0 +1,6 @@ +IMPORTED_LINK_INTERFACE_MULTIPLICITY +------------------------------------ + +Repetition count for cycles of ``IMPORTED`` static libraries. + +This is :prop_tgt:`LINK_INTERFACE_MULTIPLICITY` for ``IMPORTED`` targets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..c03e44f6d7c9c5ed39619b4308864873d793fbc5 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_LINK_INTERFACE_MULTIPLICITY_ +--------------------------------------------- + +-specific version of :prop_tgt:`IMPORTED_LINK_INTERFACE_MULTIPLICITY`. + +If set, this property completely overrides the generic property for +the named configuration. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LOCATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LOCATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..03ce714af27daa48b8d534e6d489d849e611000c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LOCATION.rst @@ -0,0 +1,38 @@ +IMPORTED_LOCATION +----------------- + +Full path to the main file on disk for an ``IMPORTED`` target. + +Set this to the location of an ``IMPORTED`` target file on disk. For +executables this is the location of the executable file. For ``STATIC`` +libraries and modules this is the location of the library or module. +For ``SHARED`` libraries on non-DLL platforms this is the location of the +shared library. For application bundles on macOS this is the location of +the executable file inside ``Contents/MacOS`` within the bundle folder. +For frameworks on macOS this is the location of the +library file symlink just inside the framework folder. For DLLs this +is the location of the ``.dll`` part of the library. For ``UNKNOWN`` +libraries this is the location of the file to be linked. Ignored for +non-imported targets. + +.. versionadded:: 3.28 + + For ordinary frameworks on Apple platforms, this may be the location of the + ``.framework`` folder itself. For XCFrameworks, it may be the location of + the ``.xcframework`` folder, in which case any target that links against it + will get the selected library's ``Headers`` directory as a usage requirement. + +The ``IMPORTED_LOCATION`` target property may be overridden for a +given configuration ```` by the configuration-specific +:prop_tgt:`IMPORTED_LOCATION_` target property. Furthermore, +the :prop_tgt:`MAP_IMPORTED_CONFIG_` target property may be +used to map between a project's configurations and those of an imported +target. If none of these is set then the name of any other configuration +listed in the :prop_tgt:`IMPORTED_CONFIGURATIONS` target property may be +selected and its :prop_tgt:`IMPORTED_LOCATION_` value used. + +To get the location of an imported target read one of the :prop_tgt:`LOCATION` +or :prop_tgt:`LOCATION_` properties. + +For platforms with import libraries (e.g. Windows, AIX or Apple) see also +:prop_tgt:`IMPORTED_IMPLIB`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..fb8a1d1c71b0e39971cf0aaa38af964aec196c66 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_LOCATION_ +-------------------------- + +-specific version of :prop_tgt:`IMPORTED_LOCATION` property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_NO_SONAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_NO_SONAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..10837b55827c9a8a8a1b9569f5ce12c14ffde6f5 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_NO_SONAME.rst @@ -0,0 +1,9 @@ +IMPORTED_NO_SONAME +------------------ + +Specifies that an ``IMPORTED`` shared library target has no ``soname``. + +Set this property to true for an imported shared library file that has +no ``soname`` field. CMake may adjust generated link commands for some +platforms to prevent the linker from using the path to the library in +place of its missing ``soname``. Ignored for non-imported targets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..9dc739b71178cc36f6e7d4e19f25efa77754921d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_NO_SONAME_ +--------------------------- + +-specific version of :prop_tgt:`IMPORTED_NO_SONAME` property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_NO_SYSTEM.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_NO_SYSTEM.rst new file mode 100644 index 0000000000000000000000000000000000000000..f805905ede29af886737f9a1d2bb82906e574023 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_NO_SYSTEM.rst @@ -0,0 +1,37 @@ +IMPORTED_NO_SYSTEM +------------------ + +.. versionadded:: 3.23 + +.. deprecated:: 3.25 + + ``IMPORTED_NO_SYSTEM`` is deprecated. Please use the following alternatives + instead: + + * Set :prop_tgt:`SYSTEM` to false if you don't want a target's include + directories to be treated as system directories when compiling consumers. + * Set :prop_tgt:`EXPORT_NO_SYSTEM` to true if you don't want the include + directories of the imported target generated by :command:`install(EXPORT)` + and :command:`export` commands to be treated as system directories when + compiling consumers. + +Setting ``IMPORTED_NO_SYSTEM`` to true on an +:ref:`imported target ` specifies that it is not a +system target. This has the following effects: + +* Entries of :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` are not treated + as system include directories when compiling consumers (regardless of + the value of the consumed target's :prop_tgt:`SYSTEM` property), as they + would be by default. Entries of + :prop_tgt:`INTERFACE_SYSTEM_INCLUDE_DIRECTORIES` are not affected, + and will always be treated as system include directories. +* On Apple platforms, when the target is a framework, it will not be treated as + system. + +This property can also be enabled on a non-imported target. Doing so does +not affect the build system, but does tell the :command:`install(EXPORT)` and +:command:`export` commands to enable it on the imported targets they generate. + +See the :prop_tgt:`NO_SYSTEM_FROM_IMPORTED` target property to set this +behavior on the target *consuming* the include directories rather than +the one *providing* them. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_OBJECTS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_OBJECTS.rst new file mode 100644 index 0000000000000000000000000000000000000000..416de5a3ced8328b9e0d90bdec724eab2b4d0e34 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_OBJECTS.rst @@ -0,0 +1,91 @@ +IMPORTED_OBJECTS +---------------- + +.. versionadded:: 3.9 + +A :ref:`semicolon-separated list ` of absolute paths +to the object files on disk for an :ref:`imported ` +:ref:`object library `. + +Ignored for non-imported targets. + +Projects may skip ``IMPORTED_OBJECTS`` if the configuration-specific +property :prop_tgt:`IMPORTED_OBJECTS_` is set instead, except in +situations as noted in the section below. + + +Xcode Generator Considerations +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 3.20 + +For Apple platforms, a project may be built for more than one architecture. +This is controlled by the :variable:`CMAKE_OSX_ARCHITECTURES` variable. +For all but the :generator:`Xcode` generator, CMake invokes compilers once +per source file and passes multiple ``-arch`` flags, leading to a single +object file which will be a universal binary. Such object files work well +when listed in the ``IMPORTED_OBJECTS`` of a separate CMake build, even for +the :generator:`Xcode` generator. But producing such object files with the +:generator:`Xcode` generator is more difficult, since it invokes the compiler +once per architecture for each source file. Unlike the other generators, +it does not generate universal object file binaries. + +A further complication with the :generator:`Xcode` generator is that when +targeting device platforms (iOS, tvOS, visionOS or watchOS), the :generator:`Xcode` +generator has the ability to use either the device or simulator SDK without +needing CMake to be re-run. The SDK can be selected at build time. +But since some architectures can be supported by both the device and the +simulator SDKs (e.g. ``arm64`` with Xcode 12 or later), not all combinations +can be represented in a single universal binary. The only solution in this +case is to have multiple object files. + +``IMPORTED_OBJECTS`` doesn't support generator expressions, so every file +it lists needs to be valid for every architecture and SDK. If incorporating +object files that are not universal binaries, the path and/or file name of +each object file has to somehow encapsulate the different architectures and +SDKs. With the :generator:`Xcode` generator, Xcode variables of the form +``$(...)`` can be used to represent these aspects and Xcode will substitute +the appropriate values at build time. CMake doesn't interpret these +variables and embeds them unchanged in the Xcode project file. +``$(CURRENT_ARCH)`` can be used to represent the architecture, while +``$(EFFECTIVE_PLATFORM_NAME)`` can be used to differentiate between SDKs. + +The following shows one example of how these two variables can be used to +refer to an object file whose location depends on both the SDK and the +architecture: + +.. code-block:: cmake + + add_library(someObjs OBJECT IMPORTED) + + set_property(TARGET someObjs PROPERTY IMPORTED_OBJECTS + # Quotes are required because of the () + "/path/to/somewhere/objects$(EFFECTIVE_PLATFORM_NAME)/$(CURRENT_ARCH)/func.o" + ) + + # Example paths: + # /path/to/somewhere/objects-iphoneos/arm64/func.o + # /path/to/somewhere/objects-iphonesimulator/x86_64/func.o + +In some cases, you may want to have configuration-specific object files +as well. The ``$(CONFIGURATION)`` Xcode variable is often used for this and +can be used in conjunction with the others mentioned above: + +.. code-block:: cmake + + add_library(someObjs OBJECT IMPORTED) + set_property(TARGET someObjs PROPERTY IMPORTED_OBJECTS + "/path/to/somewhere/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)/$(CURRENT_ARCH)/func.o" + ) + + # Example paths: + # /path/to/somewhere/Release-iphoneos/arm64/func.o + # /path/to/somewhere/Debug-iphonesimulator/x86_64/func.o + +When any Xcode variable is used, CMake is not able to fully evaluate the +path(s) at configure time. One consequence of this is that the +configuration-specific :prop_tgt:`IMPORTED_OBJECTS_` properties cannot +be used, since CMake cannot determine whether an object file exists at a +particular ```` location. The ``IMPORTED_OBJECTS`` property must be +used for these situations and the configuration-specific aspects of the path +should be handled by the ``$(CONFIGURATION)`` Xcode variable. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_OBJECTS_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_OBJECTS_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..7674b4743b0c5f5d476fbfa15c31ed95a5d39655 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_OBJECTS_CONFIG.rst @@ -0,0 +1,20 @@ +IMPORTED_OBJECTS_ +------------------------- + +.. versionadded:: 3.9 + +````-specific version of :prop_tgt:`IMPORTED_OBJECTS` property. + +Configuration names correspond to those provided by the project from +which the target is imported. + + +Xcode Generator Considerations +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Do not use this ````-specific property if you need to use Xcode +variables like ``$(CURRENT_ARCH)`` or ``$(EFFECTIVE_PLATFORM_NAME)`` in +the value. The ````-specific properties will be ignored in such +cases because CMake cannot determine whether a file exists at the +configuration-specific path at configuration time. For such cases, use +:prop_tgt:`IMPORTED_OBJECTS` instead. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_SONAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_SONAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..c6d6ebeba1f85c1a574e9e3115013628420f378f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_SONAME.rst @@ -0,0 +1,8 @@ +IMPORTED_SONAME +--------------- + +The ``soname`` of an ``IMPORTED`` target of shared library type. + +Set this to the ``soname`` embedded in an imported shared library. This +is meaningful only on platforms supporting the feature. Ignored for +non-imported targets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..7f93bf978f226987ac251c9abc5dda74dc2a5ac8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_SONAME_ +------------------------ + +-specific version of :prop_tgt:`IMPORTED_SONAME` property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORT_PREFIX.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORT_PREFIX.rst new file mode 100644 index 0000000000000000000000000000000000000000..12b75e252c873ffe451ead8ee6313d55efea4bdd --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORT_PREFIX.rst @@ -0,0 +1,9 @@ +IMPORT_PREFIX +------------- + +What comes before the import library name. + +Similar to the target property :prop_tgt:`PREFIX`, but used for import libraries +(typically corresponding to a ``DLL``) instead of regular libraries. A +target property that can be set to override the prefix (such as ``lib``) +on an import library name. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IMPORT_SUFFIX.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORT_SUFFIX.rst new file mode 100644 index 0000000000000000000000000000000000000000..ce48a7357b5bd390a939fcbe2ae1af18746bf882 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IMPORT_SUFFIX.rst @@ -0,0 +1,9 @@ +IMPORT_SUFFIX +------------- + +What comes after the import library name. + +Similar to the target property :prop_tgt:`SUFFIX`, but used +for import libraries (typically corresponding to a ``DLL``) instead of +regular libraries. A target property that can be set to override +the suffix (such as ``.lib``) on an import library name. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INCLUDE_DIRECTORIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..c62021ea73e9c028d3df5a5787feba85495b76ea --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INCLUDE_DIRECTORIES.rst @@ -0,0 +1,24 @@ +INCLUDE_DIRECTORIES +------------------- + +List of preprocessor include file search directories. + +This property specifies the list of directories given so far to the +:command:`target_include_directories` command. In addition to accepting +values from that command, values may be set directly on any +target using the :command:`set_property` command. A target gets its +initial value for this property from the value of the +:prop_dir:`INCLUDE_DIRECTORIES` directory property. Both directory and +target property values are adjusted by calls to the +:command:`include_directories` command. + +The value of this property is used by the generators to set the include +paths for the compiler. + +Relative paths should not be added to this property directly. Use one of +the commands above instead to handle relative paths. + +Contents of ``INCLUDE_DIRECTORIES`` may use :manual:`cmake-generator-expressions(7)` with +the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. See the :manual:`cmake-buildsystem(7)` +manual for more on defining buildsystem properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_NAME_DIR.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_NAME_DIR.rst new file mode 100644 index 0000000000000000000000000000000000000000..01c4d1a7ea56b0d40e2eee94e61bed9f4e1e01d7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_NAME_DIR.rst @@ -0,0 +1,23 @@ +INSTALL_NAME_DIR +---------------- + +Directory name for installed targets on Apple platforms. + +``INSTALL_NAME_DIR`` is a string specifying the directory portion of the +"install_name" field of shared libraries on Apple platforms for +installed targets. When not set, the default directory used is determined +by :prop_tgt:`MACOSX_RPATH`. If the :prop_tgt:`BUILD_WITH_INSTALL_NAME_DIR` +property is set, this will be used already in the build tree. +Policies :policy:`CMP0068` and :policy:`CMP0042` are also relevant. + +This property is initialized by the value of the variable +:variable:`CMAKE_INSTALL_NAME_DIR` if it is set when a target is +created. + +This property supports :manual:`generator expressions `. +In particular, the :genex:`$` generator expression can be +used to set the directory relative to the install-time prefix. + +On platforms that support runtime paths (``RPATH``), refer to the +:prop_tgt:`INSTALL_RPATH` target property. +Under Windows, the :genex:`TARGET_RUNTIME_DLLS` generator expression is related. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst new file mode 100644 index 0000000000000000000000000000000000000000..62ebca6126715bbe1461ebc264fed6f8f9c89708 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst @@ -0,0 +1,18 @@ +INSTALL_REMOVE_ENVIRONMENT_RPATH +-------------------------------- + +.. versionadded:: 3.16 + +Controls whether toolchain-defined rpaths should be removed during installation. + +When a target is being installed, CMake may need to rewrite its rpath +information. This occurs when the install rpath (as specified by the +:prop_tgt:`INSTALL_RPATH` target property) has different contents to the rpath +that the target was built with. Some toolchains insert their own rpath +contents into the binary as part of the build. By default, CMake will +preserve those extra inserted contents in the install rpath. For those +scenarios where such toolchain-inserted entries need to be discarded during +install, set the ``INSTALL_REMOVE_ENVIRONMENT_RPATH`` target property to true. + +This property is initialized by the value of +:variable:`CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH` when the target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_RPATH.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_RPATH.rst new file mode 100644 index 0000000000000000000000000000000000000000..d5fddd9f6ce75c82af35684d05e80e8baf39f4dd --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_RPATH.rst @@ -0,0 +1,36 @@ +INSTALL_RPATH +------------- + +The rpath to use for installed targets. + +By default, the install rpath is empty. It can be set using this property, +which is a semicolon-separated list specifying the rpath to use in installed +targets (for platforms that support it). This property is initialized +by the value of the variable :variable:`CMAKE_INSTALL_RPATH` if it is set +when a target is created. +Beside setting the install rpath manually, using the +:prop_tgt:`INSTALL_RPATH_USE_LINK_PATH` target property it can also be +generated automatically by CMake. + +Normally CMake uses the build tree for the RPATH when building executables +etc on systems that use RPATH, see the :prop_tgt:`BUILD_RPATH` target +property. When the software is installed +the targets are edited (or relinked) by CMake (see +:variable:`CMAKE_NO_BUILTIN_CHRPATH`) to have the install RPATH. +This editing during installation can be avoided via +the :prop_tgt:`BUILD_WITH_INSTALL_RPATH` target property. + +For handling toolchain-dependent RPATH entries the +:prop_tgt:`INSTALL_REMOVE_ENVIRONMENT_RPATH` can be used. +Runtime paths can be disabled completely via the :variable:`CMAKE_SKIP_RPATH` +variable. + +Because the rpath may contain ``${ORIGIN}``, which coincides with CMake syntax, +the contents of ``INSTALL_RPATH`` are properly escaped in the +``cmake_install.cmake`` script (see policy :policy:`CMP0095`.) + +This property supports +:manual:`generator expressions `. + +On Apple platforms, refer to the :prop_tgt:`INSTALL_NAME_DIR` target property. +Under Windows, the :genex:`TARGET_RUNTIME_DLLS` generator expression is related. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst new file mode 100644 index 0000000000000000000000000000000000000000..9b03983cb9a52a51b6544b6abf5eb928777c710e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst @@ -0,0 +1,14 @@ +INSTALL_RPATH_USE_LINK_PATH +--------------------------- + +Add paths to linker search and installed rpath. + +``INSTALL_RPATH_USE_LINK_PATH`` is a boolean that if set to ``TRUE`` +will append to the runtime search path (rpath) of installed binaries +any directories outside the project that are in the linker search path or +contain linked library files. The directories are appended after the +value of the :prop_tgt:`INSTALL_RPATH` target property. + +This property is initialized by the value of the variable +:variable:`CMAKE_INSTALL_RPATH_USE_LINK_PATH` if it is set when a target is +created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_AUTOMOC_MACRO_NAMES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_AUTOMOC_MACRO_NAMES.rst new file mode 100644 index 0000000000000000000000000000000000000000..09cd66cc1778781e7730d2de71135401d503ff8d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_AUTOMOC_MACRO_NAMES.rst @@ -0,0 +1,89 @@ +INTERFACE_AUTOMOC_MACRO_NAMES +----------------------------- + +.. versionadded:: 3.27 + +A :ref:`semicolon-separated list ` of macro names for +:prop_tgt:`AUTOMOC` to be propagated to consumers. + +When a target with :prop_tgt:`AUTOMOC` enabled links to a library that sets +``INTERFACE_AUTOMOC_MACRO_NAMES``, the target inherits the listed macro names +and merges them with those specified in its own :prop_tgt:`AUTOMOC_MACRO_NAMES` +property. The target will then automatically generate MOC files for source +files that contain the inherited macro names too, not just the macro names +specified in its own :prop_tgt:`AUTOMOC_MACRO_NAMES` property. + +By default ``INTERFACE_AUTOMOC_MACRO_NAMES`` is empty. + +See the :manual:`cmake-qt(7)` manual for more information on using CMake +with Qt. + +Example 1 +^^^^^^^^^ + +In this example, ``myapp`` inherits the macro names ``STATIC_LIB_1`` and +``STATIC_LIB_2`` from ``static_lib``. The ``moc`` tool will then automatically +be run on any of the ``myapp`` sources which contain ``STATIC_LIB_1`` or +``STATIC_LIB_2``. + +.. code-block:: cmake + + set(AUTOMOC ON) + add_executable(myapp main.cpp) + target_link_libraries(myapp PRIVATE static_lib) + + add_library(static_lib STATIC static.cpp) + set_property(TARGET static_lib PROPERTY + INTERFACE_AUTOMOC_MACRO_NAMES "STATIC_LIB_1;STATIC_LIB_2" + ) + +Example 2 +^^^^^^^^^ + +In this example, the ``INTERFACE_AUTOMOC_MACRO_NAMES`` target property of the +various ``*_deep_lib`` libraries will propagate to ``shared_lib``, +``static_lib`` and ``interface_lib``. Because the linking relationships are +specified as ``PUBLIC`` and ``INTERFACE``, those macro names will also further +propagate transitively up to ``app``. + +.. code-block:: cmake + + set(AUTOMOC ON) + + add_library(shared_deep_lib SHARED deep_lib.cpp) + add_library(static_deep_lib STATIC deep_lib.cpp) + add_library(interface_deep_lib INTERFACE) + + set_property(TARGET shared_deep_lib PROPERTY + INTERFACE_AUTOMOC_MACRO_NAMES "SHARED_LINK_LIB" + ) + set_property(TARGET static_deep_lib PROPERTY + INTERFACE_AUTOMOC_MACRO_NAMES "STATIC_LINK_LIB" + ) + set_property(TARGET interface_deep_lib PROPERTY + INTERFACE_AUTOMOC_MACRO_NAMES "INTERFACE_LINK_LIB" + ) + + add_library(shared_lib SHARED lib.cpp) + add_library(static_lib STATIC lib.cpp) + add_library(interface_lib INTERFACE) + + # PUBLIC and INTERFACE here ensure the macro names propagate to any + # consumers of shared_lib, static_lib or interface_lib too + target_link_libraries(shared_lib PUBLIC shared_deep_lib) + target_link_libraries(static_lib PUBLIC static_deep_lib) + target_link_libraries(interface_lib INTERFACE interface_deep_lib) + + # This consumer will receive all three of the above custom macro names as + # transitive usage requirements + add_executable(app main.cpp) + target_link_libraries(app PRIVATE shared_lib static_lib interface_lib) + +In the above: + +* ``shared_lib`` sources will be processed by ``moc`` if they contain + ``SHARED_LINK_LIB``. +* ``static_lib`` sources will be processed by ``moc`` if they contain + ``STATIC_LINK_LIB``. +* ``app`` sources will be processed by ``moc`` if they contain + ``SHARED_LINK_LIB``, ``STATIC_LINK_LIB`` or ``INTERFACE_LINK_LIB``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_AUTOUIC_OPTIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_AUTOUIC_OPTIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..303cdc3222edc09fe4c7dc0fada82cc115fadb3f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_AUTOUIC_OPTIONS.rst @@ -0,0 +1,16 @@ +INTERFACE_AUTOUIC_OPTIONS +------------------------- + +.. versionadded:: 3.0 + +List of interface options to pass to uic. + +Targets may populate this property to publish the options +required to use when invoking ``uic``. Consuming targets can add entries to their +own :prop_tgt:`AUTOUIC_OPTIONS` property such as +``$`` to use the uic options +specified in the interface of ``foo``. This is done automatically by +the :command:`target_link_libraries` command. + +This property supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_BUILD_PROPERTY.txt b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_BUILD_PROPERTY.txt new file mode 100644 index 0000000000000000000000000000000000000000..fd0d9503b7df2023269b5b15ea2e70b682ed323f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_BUILD_PROPERTY.txt @@ -0,0 +1,16 @@ + +List of public |property_name| requirements for a library. + +Targets may populate this property to publish the |property_name| +required to compile against the headers for the target. The |command_name| +command populates this property with values given to the ``PUBLIC`` and +``INTERFACE`` keywords. Projects may also get and set the property directly. + +When target dependencies are specified using :command:`target_link_libraries`, +CMake will read this property from all target dependencies to determine the +build properties of the consumer. + +Contents of |PROPERTY_INTERFACE_NAME| may use "generator expressions" +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. See the :manual:`cmake-buildsystem(7)` +-manual for more on defining buildsystem properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..02d58c53aac9283b6fd16df2f083fb3ccb31ba24 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst @@ -0,0 +1,8 @@ +INTERFACE_COMPILE_DEFINITIONS +----------------------------- + +.. |property_name| replace:: compile definitions +.. |command_name| replace:: :command:`target_compile_definitions` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_COMPILE_DEFINITIONS`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`COMPILE_DEFINITIONS` +.. include:: INTERFACE_BUILD_PROPERTY.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst new file mode 100644 index 0000000000000000000000000000000000000000..b9cfbbe9358d009505bc5079e2237ff2782810c9 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst @@ -0,0 +1,13 @@ +INTERFACE_COMPILE_FEATURES +-------------------------- + +.. versionadded:: 3.1 + +.. |property_name| replace:: compile features +.. |command_name| replace:: :command:`target_compile_features` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_COMPILE_FEATURES`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`COMPILE_FEATURES` +.. include:: INTERFACE_BUILD_PROPERTY.txt + +See the :manual:`cmake-compile-features(7)` manual for information on compile +features and a list of supported compilers. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..cdb15e53768ec63579ef611429d8c3891d332165 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst @@ -0,0 +1,8 @@ +INTERFACE_COMPILE_OPTIONS +------------------------- + +.. |property_name| replace:: compile options +.. |command_name| replace:: :command:`target_compile_options` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_COMPILE_OPTIONS`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`COMPILE_OPTIONS` +.. include:: INTERFACE_BUILD_PROPERTY.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_CXX_MODULE_SETS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_CXX_MODULE_SETS.rst new file mode 100644 index 0000000000000000000000000000000000000000..8914b0457d2674aa4c42d96f8a901a275de387cd --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_CXX_MODULE_SETS.rst @@ -0,0 +1,14 @@ +INTERFACE_CXX_MODULE_SETS +------------------------- + +.. versionadded:: 3.28 + +Read-only list of the target's ``PUBLIC`` C++ module sets (i.e. all file sets +with the type ``CXX_MODULES``). Files listed in these C++ module sets can be +installed with :command:`install(TARGETS)` and exported with +:command:`install(EXPORT)` and :command:`export`. + +C++ module sets may be defined using the :command:`target_sources` command +``FILE_SET`` option with type ``CXX_MODULES``. + +See also :prop_tgt:`CXX_MODULE_SETS`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_HEADER_SETS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_HEADER_SETS.rst new file mode 100644 index 0000000000000000000000000000000000000000..4e94892862787ad75547fcf33ed9c718352f0145 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_HEADER_SETS.rst @@ -0,0 +1,14 @@ +INTERFACE_HEADER_SETS +--------------------- + +.. versionadded:: 3.23 + +Read-only list of the target's ``INTERFACE`` and ``PUBLIC`` header sets (i.e. +all file sets with the type ``HEADERS``). Files listed in these header sets +can be installed with :command:`install(TARGETS)` and exported with +:command:`install(EXPORT)` and :command:`export`. + +Header sets may be defined using the :command:`target_sources` command +``FILE_SET`` option with type ``HEADERS``. + +See also :prop_tgt:`HEADER_SETS`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_HEADER_SETS_TO_VERIFY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_HEADER_SETS_TO_VERIFY.rst new file mode 100644 index 0000000000000000000000000000000000000000..14304e663adf40619992be0b25c237abaec93465 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_HEADER_SETS_TO_VERIFY.rst @@ -0,0 +1,13 @@ +INTERFACE_HEADER_SETS_TO_VERIFY +------------------------------- + +.. versionadded:: 3.24 + +Used to specify which ``PUBLIC`` and ``INTERFACE`` header sets of a target +should be verified. + +This property contains a semicolon-separated list of header sets which +should be verified if :prop_tgt:`VERIFY_INTERFACE_HEADER_SETS` is set to +``TRUE``. If the list is empty, all ``PUBLIC`` and ``INTERFACE`` header sets +are verified. (If the project does not want to verify any header sets on the +target, simply set :prop_tgt:`VERIFY_INTERFACE_HEADER_SETS` to ``FALSE``.) diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..0b6be3d25e8c0fb71a1e0dc23b18af9a9b2291bb --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst @@ -0,0 +1,28 @@ +INTERFACE_INCLUDE_DIRECTORIES +----------------------------- + +.. |property_name| replace:: include directories +.. |command_name| replace:: :command:`target_include_directories` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_INCLUDE_DIRECTORIES`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`INCLUDE_DIRECTORIES` +.. include:: INTERFACE_BUILD_PROPERTY.txt + +Include directories usage requirements commonly differ between the build-tree +and the install-tree. The ``BUILD_INTERFACE`` and ``INSTALL_INTERFACE`` +generator expressions can be used to describe separate usage requirements +based on the usage location. Relative paths are allowed within the +``INSTALL_INTERFACE`` expression and are interpreted relative to the +installation prefix. For example: + +.. code-block:: cmake + + target_include_directories(mylib INTERFACE + $ + $ # /include/mylib + ) + +Creating Relocatable Packages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. |INTERFACE_PROPERTY_LINK| replace:: ``INTERFACE_INCLUDE_DIRECTORIES`` +.. include:: /include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_DEPENDS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_DEPENDS.rst new file mode 100644 index 0000000000000000000000000000000000000000..037dc5767251090dda985e491dca7bc925aa78d6 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_DEPENDS.rst @@ -0,0 +1,34 @@ +INTERFACE_LINK_DEPENDS +---------------------- + +.. versionadded:: 3.13 + +Additional public interface files on which a target binary depends for linking. + +This property is supported only by :generator:`Ninja` and +:ref:`Makefile Generators`. +It is intended to specify dependencies on "linker scripts" for +custom Makefile link rules. + +When target dependencies are specified using :command:`target_link_libraries`, +CMake will read this property from all target dependencies to determine the +build properties of the consumer. + +Contents of ``INTERFACE_LINK_DEPENDS`` may use "generator expressions" +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. See the :manual:`cmake-buildsystem(7)` +-manual for more on defining buildsystem properties. + +Link dependency files usage requirements commonly differ between the build-tree +and the install-tree. The ``BUILD_INTERFACE`` and ``INSTALL_INTERFACE`` +generator expressions can be used to describe separate usage requirements +based on the usage location. Relative paths are allowed within the +``INSTALL_INTERFACE`` expression and are interpreted relative to the +installation prefix. For example: + +.. code-block:: cmake + + set_property(TARGET mylib PROPERTY INTERFACE_LINK_DEPENDS + $ + $ # /mylinkscript + ) diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..f597086eca6d48b393ee54d05fce6414cd04325c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst @@ -0,0 +1,10 @@ +INTERFACE_LINK_DIRECTORIES +-------------------------- + +.. versionadded:: 3.13 + +.. |property_name| replace:: link directories +.. |command_name| replace:: :command:`target_link_directories` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_LINK_DIRECTORIES`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`LINK_DIRECTORIES` +.. include:: INTERFACE_BUILD_PROPERTY.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..a3438ca4db96e2b890af390f18e7f591f6937546 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst @@ -0,0 +1,39 @@ +INTERFACE_LINK_LIBRARIES +------------------------ + +List public interface libraries for a library. + +This property contains the list of transitive link dependencies. When +the target is linked into another target using the +:command:`target_link_libraries` command, the libraries listed (and +recursively their link interface libraries) will be provided to the +other target also. This property is overridden by the +:prop_tgt:`LINK_INTERFACE_LIBRARIES` or +:prop_tgt:`LINK_INTERFACE_LIBRARIES_` property if policy +:policy:`CMP0022` is ``OLD`` or unset. + +The value of this property is used by the generators when constructing +the link rule for a dependent target. A dependent target's direct +link dependencies, specified by its :prop_tgt:`LINK_LIBRARIES` target +property, are linked first, followed by indirect dependencies from the +transitive closure of the direct dependencies' +``INTERFACE_LINK_LIBRARIES`` properties. See policy :policy:`CMP0022`. + +Contents of ``INTERFACE_LINK_LIBRARIES`` may use "generator expressions" +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. See the :manual:`cmake-buildsystem(7)` +manual for more on defining buildsystem properties. + +.. include:: LINK_LIBRARIES_INDIRECTION.txt + +``INTERFACE_LINK_LIBRARIES`` adds transitive link dependencies for a +target's dependents. In advanced use cases, one may update the +direct link dependencies of a target's dependents by using the +:prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` and +:prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` target properties. + +Creating Relocatable Packages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. |INTERFACE_PROPERTY_LINK| replace:: ``INTERFACE_LINK_LIBRARIES`` +.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.rst new file mode 100644 index 0000000000000000000000000000000000000000..f6ce020756049d154bcec482baeeb2e8d951d4c9 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.rst @@ -0,0 +1,236 @@ +INTERFACE_LINK_LIBRARIES_DIRECT +------------------------------- + +.. versionadded:: 3.24 + +List of libraries that consumers of this library should treat +as direct link dependencies. + +This target property may be set to *include* items in a dependent +target's final set of direct link dependencies. See the +:prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` target property +to exclude items. + +The initial set of a dependent target's direct link dependencies is +specified by its :prop_tgt:`LINK_LIBRARIES` target property. Indirect +link dependencies are specified by the transitive closure of the direct +link dependencies' :prop_tgt:`INTERFACE_LINK_LIBRARIES` properties. +Any link dependency may specify additional direct link dependencies +using the ``INTERFACE_LINK_LIBRARIES_DIRECT`` target property. +The set of direct link dependencies is then filtered to exclude items named +by any dependency's :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` +target property. + +.. |INTERFACE_PROPERTY_LINK_DIRECT| replace:: ``INTERFACE_LINK_LIBRARIES_DIRECT`` +.. include:: INTERFACE_LINK_LIBRARIES_DIRECT.txt + +Direct Link Dependencies as Usage Requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The ``INTERFACE_LINK_LIBRARIES_DIRECT`` and +``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` target properties +are :ref:`usage requirements `. +Their effects propagate to dependent targets transitively, and can +therefore affect the direct link dependencies of every target in a +chain of dependent libraries. Whenever some library target ``X`` links +to another library target ``Y`` whose direct or transitive usage +requirements contain ``INTERFACE_LINK_LIBRARIES_DIRECT`` or +``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE``, the properties may affect +``X``'s list of direct link dependencies: + +* If ``X`` is a shared library or executable, its dependencies are linked. + They also affect the usage requirements with which ``X``'s sources are + compiled. + +* If ``X`` is a static library or object library, it does not actually + link, so its dependencies at most affect the usage requirements with + which ``X``'s sources are compiled. + +The properties may also affect the list of direct link dependencies +on ``X``'s dependents: + +* If ``X`` links ``Y`` publicly: + + .. code-block:: cmake + + target_link_libraries(X PUBLIC Y) + + then ``Y`` is placed in ``X``'s :prop_tgt:`INTERFACE_LINK_LIBRARIES`, + so ``Y``'s usage requirements, including ``INTERFACE_LINK_LIBRARIES_DIRECT``, + ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE``, and the usage requirements + declared by the direct link dependencies they add, are propagated to + ``X``'s dependents. + +* If ``X`` is a static library or object library, and links ``Y`` privately: + + .. code-block:: cmake + + target_link_libraries(X PRIVATE Y) + + then ``$`` is placed in ``X``'s + :prop_tgt:`INTERFACE_LINK_LIBRARIES`. ``Y``'s linking requirements, + including ``INTERFACE_LINK_LIBRARIES_DIRECT``, + ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE``, and the transitive link + dependencies declared by the direct link dependencies they add, are + propagated to ``X``'s dependents. However, ``Y``'s non-linking + usage requirements are blocked by the :genex:`LINK_ONLY` generator + expression, and are not propagated to ``X``'s dependents. + +* If ``X`` is a shared library or executable, and links ``Y`` privately: + + .. code-block:: cmake + + target_link_libraries(X PRIVATE Y) + + then ``Y`` is not placed in ``X``'s :prop_tgt:`INTERFACE_LINK_LIBRARIES`, + so ``Y``'s usage requirements, even ``INTERFACE_LINK_LIBRARIES_DIRECT`` + and ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE``, are not propagated to + ``X``'s dependents. + +* In all cases, the content of ``X``'s :prop_tgt:`INTERFACE_LINK_LIBRARIES` + is not affected by ``Y``'s ``INTERFACE_LINK_LIBRARIES_DIRECT`` or + ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE``. + +One may limit the effects of ``INTERFACE_LINK_LIBRARIES_DIRECT`` and +``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` to a subset of dependent +targets by using the :genex:`TARGET_PROPERTY` generator expression. +For example, to limit the effects to executable targets, use an +entry of the form:: + + "$<$,EXECUTABLE>:...>" + +Similarly, to limit the effects to specific targets, use an entry +of the form:: + + "$<$>:...>" + +This entry will only affect targets that set their ``USE_IT`` +target property to a true value. + +Direct Link Dependency Ordering +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The list of direct link dependencies for a target is computed from an +initial ordered list in its :prop_tgt:`LINK_LIBRARIES` target property. +For each item, additional direct link dependencies are discovered from +its direct and transitive ``INTERFACE_LINK_LIBRARIES_DIRECT`` usage +requirements. Each discovered item is injected before the item that +specified it. However, a discovered item is added at most once, +and only if it did not appear anywhere in the initial list. +This gives :prop_tgt:`LINK_LIBRARIES` control over ordering of +those direct link dependencies that it explicitly specifies. + +Once all direct link dependencies have been collected, items named by +all of their :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` +usage requirements are removed from the final list. This does not +affect the order of the items that remain. + +Example: Static Plugins +^^^^^^^^^^^^^^^^^^^^^^^ + +Consider a static library ``Foo`` that provides a static plugin +``FooPlugin`` to consuming application executables, where the +implementation of the plugin depends on ``Foo`` and other things. +In this case, the application should link to ``FooPlugin`` directly, +before ``Foo``. However, the application author only knows about ``Foo``. +We can express this as follows: + +.. code-block:: cmake + + # Core library used by other components. + add_library(Core STATIC core.cpp) + + # Foo is a static library for use by applications. + # Implementation of Foo depends on Core. + add_library(Foo STATIC foo.cpp foo_plugin_helper.cpp) + target_link_libraries(Foo PRIVATE Core) + + # Extra parts of Foo for use by its static plugins. + # Implementation of Foo's extra parts depends on both Core and Foo. + add_library(FooExtras STATIC foo_extras.cpp) + target_link_libraries(FooExtras PRIVATE Core Foo) + + # The Foo library has an associated static plugin + # that should be linked into the final executable. + # Implementation of the plugin depends on Core, Foo, and FooExtras. + add_library(FooPlugin STATIC foo_plugin.cpp) + target_link_libraries(FooPlugin PRIVATE Core Foo FooExtras) + + # An app that links Foo should link Foo's plugin directly. + set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT FooPlugin) + + # An app does not need to link Foo directly because the plugin links it. + set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE Foo) + +An application ``app`` only needs to specify that it links to ``Foo``: + +.. code-block:: cmake + + add_executable(app main.cpp) + target_link_libraries(app PRIVATE Foo) + +The ``INTERFACE_LINK_LIBRARIES_DIRECT`` target property on ``Foo`` tells +CMake to pretend that ``app`` also links directly to ``FooPlugin``. +The ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` target property on ``Foo`` +tells CMake to pretend that ``app`` did *not* link directly to ``Foo``. +Instead, ``Foo`` will be linked as a dependency of ``FooPlugin``. The +final link line for ``app`` will link the libraries in the following +order: + +* ``FooPlugin`` as a direct link dependency of ``app`` + (via ``Foo``'s usage requirements). +* ``FooExtras`` as a dependency of ``FooPlugin``. +* ``Foo`` as a dependency of ``FooPlugin`` and ``FooExtras``. +* ``Core`` as a dependency of ``FooPlugin``, ``FooExtras``, and ``Foo``. + +Note that without the ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` target +property, ``Foo`` would be linked twice: once as a direct dependency +of ``app``, and once as a dependency of ``FooPlugin``. + +Example: Opt-In Static Plugins +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In the above `Example: Static Plugins`_, the ``app`` executable specifies +that it links directly to ``Foo``. In a real application, there might +be an intermediate library: + +.. code-block:: cmake + + add_library(app_impl STATIC app_impl.cpp) + target_link_libraries(app_impl PRIVATE Foo) + + add_executable(app main.cpp) + target_link_libraries(app PRIVATE app_impl) + +In this case we do not want ``Foo``'s ``INTERFACE_LINK_LIBRARIES_DIRECT`` +and ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` target properties to affect +the direct dependencies of ``app_impl``. To avoid this, we can revise +the property values to make their effects opt-in: + +.. code-block:: cmake + + # An app that links Foo should link Foo's plugin directly. + set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT + "$<$>:FooPlugin>" + ) + + # An app does not need to link Foo directly because the plugin links it. + set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE + "$<$>:Foo>" + ) + +Now, the ``app`` executable can opt-in to get ``Foo``'s plugin(s): + +.. code-block:: cmake + + set_property(TARGET app PROPERTY FOO_STATIC_PLUGINS 1) + +The final link line for ``app`` will now link the libraries in the following +order: + +* ``FooPlugin`` as a direct link dependency of ``app`` + (via ``Foo``'s usage requirements). +* ``app_impl`` as a direct link dependency of ``app``. +* ``FooExtras`` as a dependency of ``FooPlugin``. +* ``Foo`` as a dependency of ``app_impl``, ``FooPlugin``, and ``FooExtras``. +* ``Core`` as a dependency of ``FooPlugin``, ``FooExtras``, and ``Foo``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.txt b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.txt new file mode 100644 index 0000000000000000000000000000000000000000..d52bf86cf874f11eb9171371ce0d01730b4bc3d2 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.txt @@ -0,0 +1,9 @@ +The value of |INTERFACE_PROPERTY_LINK_DIRECT| may use +:manual:`generator expressions `. + +.. note:: + + The |INTERFACE_PROPERTY_LINK_DIRECT| target property is intended for + advanced use cases such as injection of static plugins into a consuming + executable. It should not be used as a substitute for organizing + normal calls to :command:`target_link_libraries`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE.rst new file mode 100644 index 0000000000000000000000000000000000000000..b6196c095bc030950c2670d3c0f8ace388a0813b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE.rst @@ -0,0 +1,34 @@ +INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE +--------------------------------------- + +.. versionadded:: 3.24 + +List of libraries that consumers of this library should *not* treat +as direct link dependencies. + +This target property may be set to *exclude* items from a dependent +target's final set of direct link dependencies. This property is +processed after the :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` +target property of all other dependencies of the dependent target, so +exclusion from direct link dependence takes priority over inclusion. + +The initial set of a dependent target's direct link dependencies is +specified by its :prop_tgt:`LINK_LIBRARIES` target property. Indirect +link dependencies are specified by the transitive closure of the direct +link dependencies' :prop_tgt:`INTERFACE_LINK_LIBRARIES` properties. +Any link dependency may specify additional direct link dependencies +using the :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` target property. +The set of direct link dependencies is then filtered to exclude items named +by any dependency's ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` target +property. + +Excluding an item from a dependent target's direct link dependencies +does not mean the dependent target won't link the item. The item +may still be linked as an indirect link dependency via the +:prop_tgt:`INTERFACE_LINK_LIBRARIES` property on other dependencies. + +.. |INTERFACE_PROPERTY_LINK_DIRECT| replace:: ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` +.. include:: INTERFACE_LINK_LIBRARIES_DIRECT.txt + +See the :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` target property +documentation for more details and examples. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..8ba55dc1d4b2e75114ce719235678a1fa0e85aa4 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst @@ -0,0 +1,10 @@ +INTERFACE_LINK_OPTIONS +---------------------- + +.. versionadded:: 3.13 + +.. |property_name| replace:: link options +.. |command_name| replace:: :command:`target_link_options` +.. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_LINK_OPTIONS`` +.. |PROPERTY_LINK| replace:: :prop_tgt:`LINK_OPTIONS` +.. include:: INTERFACE_BUILD_PROPERTY.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst new file mode 100644 index 0000000000000000000000000000000000000000..4a5cf4758ddf83956c384dbfb39498ace8c840af --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst @@ -0,0 +1,22 @@ +INTERFACE_POSITION_INDEPENDENT_CODE +----------------------------------- + +Whether consumers need to create a position-independent target + +The ``INTERFACE_POSITION_INDEPENDENT_CODE`` property informs consumers of +this target whether they must set their +:prop_tgt:`POSITION_INDEPENDENT_CODE` property to ``ON``. If this +property is set to ``ON``, then the :prop_tgt:`POSITION_INDEPENDENT_CODE` +property on all consumers will be set to ``ON``. Similarly, if this +property is set to ``OFF``, then the :prop_tgt:`POSITION_INDEPENDENT_CODE` +property on all consumers will be set to ``OFF``. If this property is +undefined, then consumers will determine their +:prop_tgt:`POSITION_INDEPENDENT_CODE` property by other means. Consumers +must ensure that the targets that they link to have a consistent +requirement for their ``INTERFACE_POSITION_INDEPENDENT_CODE`` property. + +Contents of ``INTERFACE_POSITION_INDEPENDENT_CODE`` may use +"generator expressions" with the syntax ``$<...>``. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. +See the :manual:`cmake-buildsystem(7)` manual for more on defining buildsystem +properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_PRECOMPILE_HEADERS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_PRECOMPILE_HEADERS.rst new file mode 100644 index 0000000000000000000000000000000000000000..49efd3789284a17fb00c161bea04f65f45648437 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_PRECOMPILE_HEADERS.rst @@ -0,0 +1,18 @@ +INTERFACE_PRECOMPILE_HEADERS +---------------------------- + +.. versionadded:: 3.16 + +List of interface header files to precompile into consuming targets. + +Targets may populate this property to publish the header files +for consuming targets to precompile. The :command:`target_precompile_headers` +command populates this property with values given to the ``PUBLIC`` and +``INTERFACE`` keywords. Projects may also get and set the property directly. +See the discussion in :command:`target_precompile_headers` for guidance on +appropriate use of this property for installed or exported targets. + +Contents of ``INTERFACE_PRECOMPILE_HEADERS`` may use "generator expressions" +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. See the :manual:`cmake-buildsystem(7)` +manual for more on defining buildsystem properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_SOURCES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_SOURCES.rst new file mode 100644 index 0000000000000000000000000000000000000000..60a741da32d0d12029c5fbbf5f9722f8ea36e140 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_SOURCES.rst @@ -0,0 +1,20 @@ +INTERFACE_SOURCES +----------------- + +.. versionadded:: 3.1 + +List of interface sources to compile into consuming targets. + +Targets may populate this property to publish the sources +for consuming targets to compile. The :command:`target_sources` command +populates this property with values given to the ``PUBLIC`` and +``INTERFACE`` keywords. Projects may also get and set the property directly. + +When target dependencies are specified using :command:`target_link_libraries`, +CMake will read this property from all target dependencies to determine the +sources of the consumer. + +Contents of ``INTERFACE_SOURCES`` may use "generator expressions" +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. See the :manual:`cmake-buildsystem(7)` +manual for more on defining buildsystem properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..390372787bf30ab30e541c4e09837ac4e1ad00d3 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst @@ -0,0 +1,31 @@ +INTERFACE_SYSTEM_INCLUDE_DIRECTORIES +------------------------------------ + +List of public system include directories for a library. + +Targets may populate this property to publish the include directories +which contain system headers, and therefore should not result in +compiler warnings. Additionally, system include directories are searched +after normal include directories regardless of the order specified. + +When the :command:`target_include_directories` command is given the +``SYSTEM`` keyword, it populates this property with values provided after the +``PUBLIC`` and ``INTERFACE`` keywords. + +Projects may also get and set the property directly, but must be aware that +adding directories to this property does not make those directories used +during compilation. Adding directories to this property marks directories +as system directories which otherwise would be used in a non-system manner. +This can appear similar to duplication, so prefer the high-level +:command:`target_include_directories` command with the ``SYSTEM`` keyword +and avoid setting the property directly. + +When target dependencies are specified using :command:`target_link_libraries`, +CMake will read this property from all target dependencies to mark the +same include directories as containing system headers. + +Contents of ``INTERFACE_SYSTEM_INCLUDE_DIRECTORIES`` may use "generator +expressions" with the syntax ``$<...>``. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. +See the :manual:`cmake-buildsystem(7)` manual for more on defining +buildsystem properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..0a8f06ffa08922c91a52cfc2cd87f29b76598735 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst @@ -0,0 +1,17 @@ +INTERPROCEDURAL_OPTIMIZATION +---------------------------- + +Enable interprocedural optimization for a target. + +If set to true, enables interprocedural optimizations if they are +known :module:`to be supported ` by the compiler. Depending +on value of policy :policy:`CMP0069`, the error will be reported or ignored, +if interprocedural optimization is enabled but not supported. + +This property is initialized by the +:variable:`CMAKE_INTERPROCEDURAL_OPTIMIZATION` variable if it is set when a +target is created. + +There is also the per-configuration :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION_` +target property, which overrides :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` +if it is set. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..e5108e67b37a83ff4c6396c6c14ddecb5287582e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst @@ -0,0 +1,12 @@ +INTERPROCEDURAL_OPTIMIZATION_ +------------------------------------- + +Per-configuration interprocedural optimization for a target. + +This is a per-configuration version of :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION`. +If set, this property overrides the generic property for the named +configuration. + +This property is initialized by the +:variable:`CMAKE_INTERPROCEDURAL_OPTIMIZATION_` variable if it is set +when a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/IOS_INSTALL_COMBINED.rst b/cmake/share/cmake-3.31/Help/prop_tgt/IOS_INSTALL_COMBINED.rst new file mode 100644 index 0000000000000000000000000000000000000000..1d2b457e9f3d8d2e5e750d782b8cebe96d0108eb --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/IOS_INSTALL_COMBINED.rst @@ -0,0 +1,28 @@ +IOS_INSTALL_COMBINED +-------------------- + +.. versionadded:: 3.5 +.. deprecated:: 3.28 + + :prop_tgt:`IOS_INSTALL_COMBINED` was designed to make universal binaries + containing iOS/arm* device code paired with iOS Simulator/x86_64 code + (or similar for other Apple embedded platforms). Universal binaries can only + differentiate code based on CPU type, so this only made sense before the + days of arm64 macOS machines (i.e. iOS Simulator/arm64). Apple now + recommends xcframeworks, which contain multiple binaries for different + platforms, for this use case. + +Build a combined (device and simulator) target when installing. + +When this property is set to false, which is the default, then it will +either be built with the device SDK or the simulator SDK depending on the SDK +set. But if this property is set to true then the target will at install time +also be built for the other SDK and combined into one library. + +.. note:: + + If a selected architecture is available for both device SDK and simulator + SDK it will be built for the SDK selected by :variable:`CMAKE_OSX_SYSROOT` + and removed from the other SDK. + +This feature requires at least Xcode version 6. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/ISPC_HEADER_DIRECTORY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/ISPC_HEADER_DIRECTORY.rst new file mode 100644 index 0000000000000000000000000000000000000000..24eb855bedc2dcff711f5cb0807069caf3b13604 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/ISPC_HEADER_DIRECTORY.rst @@ -0,0 +1,13 @@ +ISPC_HEADER_DIRECTORY +--------------------- + +.. versionadded:: 3.19 + +Specify relative output directory for ISPC headers provided by the target. + +If the target contains ISPC source files, this specifies the directory in which +the generated headers will be placed. Relative paths are treated with respect to +the value of :variable:`CMAKE_CURRENT_BINARY_DIR`. When this property is not set, the +headers will be placed a generator defined build directory. If the variable +:variable:`CMAKE_ISPC_HEADER_DIRECTORY` is set when a target is created +its value is used to initialize this property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/ISPC_HEADER_SUFFIX.rst b/cmake/share/cmake-3.31/Help/prop_tgt/ISPC_HEADER_SUFFIX.rst new file mode 100644 index 0000000000000000000000000000000000000000..223d038d9f4f81961e53fc00412e2dd4da308aaa --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/ISPC_HEADER_SUFFIX.rst @@ -0,0 +1,14 @@ +ISPC_HEADER_SUFFIX +------------------ + +.. versionadded:: 3.19.2 + +Specify output suffix to be used for ISPC generated headers provided by the target. + +This property is initialized by the value of the :variable:`CMAKE_ISPC_HEADER_SUFFIX` +variable if it is set when a target is created. + +If the target contains ISPC source files, this specifies the header suffix to +be used for the generated headers. + +The default value is ``_ispc.h``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/ISPC_INSTRUCTION_SETS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/ISPC_INSTRUCTION_SETS.rst new file mode 100644 index 0000000000000000000000000000000000000000..5328f66c5d9a1ab8e0b41302cd4e4f8160a8ba2d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/ISPC_INSTRUCTION_SETS.rst @@ -0,0 +1,21 @@ +ISPC_INSTRUCTION_SETS +--------------------- + +.. versionadded:: 3.19 + +List of instruction set architectures to generate code for. + +This property is initialized by the value of the :variable:`CMAKE_ISPC_INSTRUCTION_SETS` +variable if it is set when a target is created. + +The ``ISPC_INSTRUCTION_SETS`` target property must be used when generating for multiple +instruction sets so that CMake can track what object files will be generated. + +Examples +^^^^^^^^ + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY ISPC_INSTRUCTION_SETS avx2-i32x4 avx512skx-i32x835) + +Generates code for avx2 and avx512skx target architectures. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/JOB_POOL_COMPILE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/JOB_POOL_COMPILE.rst new file mode 100644 index 0000000000000000000000000000000000000000..6a0806453ea7e51cb8f96dee83548139f48f18e0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/JOB_POOL_COMPILE.rst @@ -0,0 +1,17 @@ +JOB_POOL_COMPILE +---------------- + +Ninja only: Pool used for compiling. + +The number of parallel compile processes could be limited by defining +pools with the global :prop_gbl:`JOB_POOLS` +property and then specifying here the pool name. + +For instance: + +.. code-block:: cmake + + set_property(TARGET myexe PROPERTY JOB_POOL_COMPILE ten_jobs) + +This property is initialized by the value of +:variable:`CMAKE_JOB_POOL_COMPILE`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/JOB_POOL_LINK.rst b/cmake/share/cmake-3.31/Help/prop_tgt/JOB_POOL_LINK.rst new file mode 100644 index 0000000000000000000000000000000000000000..d71243749141cf3c363e0c5abc5499141d9088d2 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/JOB_POOL_LINK.rst @@ -0,0 +1,16 @@ +JOB_POOL_LINK +------------- + +Ninja only: Pool used for linking. + +The number of parallel link processes could be limited by defining +pools with the global :prop_gbl:`JOB_POOLS` +property and then specifying here the pool name. + +For instance: + +.. code-block:: cmake + + set_property(TARGET myexe PROPERTY JOB_POOL_LINK two_jobs) + +This property is initialized by the value of :variable:`CMAKE_JOB_POOL_LINK`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst new file mode 100644 index 0000000000000000000000000000000000000000..4bdaeec360850eb4a70c64c433c28c5df6842152 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst @@ -0,0 +1,23 @@ +JOB_POOL_PRECOMPILE_HEADER +-------------------------- + +.. versionadded:: 3.17 + +Ninja only: Pool used for generating pre-compiled headers. + +The number of parallel compile processes could be limited by defining +pools with the global :prop_gbl:`JOB_POOLS` +property and then specifying here the pool name. + +For instance: + +.. code-block:: cmake + + set_property(TARGET myexe PROPERTY JOB_POOL_PRECOMPILE_HEADER two_jobs) + +This property is initialized by the value of +:variable:`CMAKE_JOB_POOL_PRECOMPILE_HEADER`. + +If neither ``JOB_POOL_PRECOMPILE_HEADER`` nor +:variable:`CMAKE_JOB_POOL_PRECOMPILE_HEADER` are set then +:prop_tgt:`JOB_POOL_COMPILE` will be used for this task. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LABELS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LABELS.rst new file mode 100644 index 0000000000000000000000000000000000000000..8483507e6f5d257b2f9c086866d3da9a7c5361c5 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LABELS.rst @@ -0,0 +1,6 @@ +LABELS +------ + +Specify a list of text labels associated with a target. + +Target label semantics are currently unspecified. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CLANG_TIDY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CLANG_TIDY.rst new file mode 100644 index 0000000000000000000000000000000000000000..c0054e304db68d95ff8e9fc495e5351e7b97d7da --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CLANG_TIDY.rst @@ -0,0 +1,41 @@ +_CLANG_TIDY +----------------- + +.. versionadded:: 3.6 + +This property is implemented only when ```` is ``C``, ``CXX``, ``OBJC`` +or ``OBJCXX``. + +Specify a :ref:`semicolon-separated list ` containing +a command line for the ``clang-tidy`` tool. The :ref:`Makefile Generators` +and the :generator:`Ninja` generator will run this tool along with the +compiler and report a warning if the tool reports any problems. + +The specified ``clang-tidy`` command line will be invoked with additional +arguments specifying the source file and, after ``--``, the full compiler +command line. + +.. versionchanged:: 3.25 + + If the specified ``clang-tidy`` command line includes the ``-p`` option, + it will be invoked without ``--`` and the full compiler command line. + ``clang-tidy`` will look up the source file in the specified compiler + commands database. + +This property is initialized by the value of +the :variable:`CMAKE__CLANG_TIDY` variable if it is set +when a target is created. + +.. versionadded:: 3.27 + + This property supports + :manual:`generator expressions `. + +.. versionadded:: 3.27 + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting tools defined by :prop_tgt:`_CPPLINT`, + ``_CLANG_TIDY``, :prop_tgt:`_CPPCHECK`, and + :prop_tgt:`_INCLUDE_WHAT_YOU_USE`. When :prop_sf:`SKIP_LINTING` is + set to true on a source file, those tools will not be run on that specific + file. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst new file mode 100644 index 0000000000000000000000000000000000000000..c19dfe4d0d08729346f5ebcc427010e8c70f4e8c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst @@ -0,0 +1,29 @@ +_CLANG_TIDY_EXPORT_FIXES_DIR +---------------------------------- + +.. versionadded:: 3.26 + +This property is implemented only when ```` is ``C``, ``CXX``, ``OBJC`` +or ``OBJCXX``, and only has an effect when :prop_tgt:`_CLANG_TIDY` is +set. + +Specify a directory for the ``clang-tidy`` tool to put ``.yaml`` files +containing its suggested changes in. This can be used for automated mass +refactoring by ``clang-tidy``. Each object file that gets compiled will have a +corresponding ``.yaml`` file in this directory. After the build is completed, +you can run ``clang-apply-replacements`` on this directory to simultaneously +apply all suggested changes to the code base. If this property is not an +absolute directory, it is assumed to be relative to the target's binary +directory. This property should be preferred over adding an ``--export-fixes`` +or ``--fix`` argument directly to the :prop_tgt:`_CLANG_TIDY` property. + +When this property is set, CMake takes ownership of the specified directory, +and may create, modify, or delete files and directories within the directory +at any time during configure or build time. Users should use a dedicated +directory for exporting clang-tidy fixes to avoid having files deleted or +overwritten by CMake. Users should not create, modify, or delete files in this +directory. + +This property is initialized by the value of +the :variable:`CMAKE__CLANG_TIDY_EXPORT_FIXES_DIR` variable if it is set +when a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LANG_COMPILER_LAUNCHER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_COMPILER_LAUNCHER.rst new file mode 100644 index 0000000000000000000000000000000000000000..928ff938f6656ca64b2cf30a7b3b8e12c463a77e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_COMPILER_LAUNCHER.rst @@ -0,0 +1,21 @@ +_COMPILER_LAUNCHER +------------------------ + +.. versionadded:: 3.4 + +This property is implemented only when ```` is ``C``, ``CXX``, +``Fortran``, ``HIP``, ``ISPC``, ``OBJC``, ``OBJCXX``, or ``CUDA``. + +Specify a :ref:`semicolon-separated list ` containing a command line +for a compiler launching tool. The :ref:`Makefile Generators` and the +:generator:`Ninja` generator will run this tool and pass the compiler and +its arguments to the tool. Some example tools are distcc and ccache. + +This property is initialized by the value of +the :variable:`CMAKE__COMPILER_LAUNCHER` variable if it is set +when a target is created. + +.. versionadded:: 3.25 + + The property value may use + :manual:`generator expressions `. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CPPCHECK.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CPPCHECK.rst new file mode 100644 index 0000000000000000000000000000000000000000..d74e373c96ad303ebdf65f33eecdcdd97ac60ef9 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CPPCHECK.rst @@ -0,0 +1,31 @@ +_CPPCHECK +--------------- + +.. versionadded:: 3.10 + +This property is supported only when ```` is ``C`` or ``CXX``. + +Specify a :ref:`semicolon-separated list ` containing a command line +for the ``cppcheck`` static analysis tool. The :ref:`Makefile Generators` +and the :generator:`Ninja` generator will run ``cppcheck`` along with the +compiler and report any problems. If the command-line specifies the +exit code options to ``cppcheck`` then the build will fail if the +tool returns non-zero. + +This property is initialized by the value of the +:variable:`CMAKE__CPPCHECK` variable if it is set when a target is +created. + +.. versionadded:: 3.27 + + This property supports + :manual:`generator expressions `. + +.. versionadded:: 3.27 + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting tools defined by :prop_tgt:`_CPPLINT`, + :prop_tgt:`_CLANG_TIDY`, ``_CPPCHECK``, and + :prop_tgt:`_INCLUDE_WHAT_YOU_USE`. When :prop_sf:`SKIP_LINTING` is + set to true on a source file, those tools will not be run on that specific + file. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CPPLINT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CPPLINT.rst new file mode 100644 index 0000000000000000000000000000000000000000..882806e3f9cc4854abe4632ed90c962cb7b4a20a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_CPPLINT.rst @@ -0,0 +1,29 @@ +_CPPLINT +-------------- + +.. versionadded:: 3.8 + +This property is supported only when ```` is ``C`` or ``CXX``. + +Specify a :ref:`semicolon-separated list ` containing a command line +for the ``cpplint`` style checker. The :ref:`Makefile Generators` and the +:generator:`Ninja` generator will run ``cpplint`` along with the compiler +and report any problems. + +This property is initialized by the value of the +:variable:`CMAKE__CPPLINT` variable if it is set when a target is +created. + +.. versionadded:: 3.27 + + This property supports + :manual:`generator expressions `. + +.. versionadded:: 3.27 + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting tools defined by ``_CPPLINT``, + :prop_tgt:`_CLANG_TIDY`, :prop_tgt:`_CPPCHECK`, and + :prop_tgt:`_INCLUDE_WHAT_YOU_USE`. When :prop_sf:`SKIP_LINTING` is + set to true on a source file, those tools will not be run on that specific + file. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LANG_EXTENSIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_EXTENSIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..3a333d9d84937c6d0c5d723c83652d4629d427bd --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_EXTENSIONS.rst @@ -0,0 +1,24 @@ +_EXTENSIONS +----------------- + +The variations are: + +* :prop_tgt:`C_EXTENSIONS` +* :prop_tgt:`CXX_EXTENSIONS` +* :prop_tgt:`CUDA_EXTENSIONS` +* :prop_tgt:`HIP_EXTENSIONS` +* :prop_tgt:`OBJC_EXTENSIONS` +* :prop_tgt:`OBJCXX_EXTENSIONS` + +These properties specify whether compiler-specific extensions are requested. + +These properties are initialized by the value of the +:variable:`CMAKE__EXTENSIONS` variable if it is set when a target is +created and otherwise by the value of +:variable:`CMAKE__EXTENSIONS_DEFAULT` (see :policy:`CMP0128`). + +For supported CMake versions see the respective pages. +To control language standard versions see :prop_tgt:`_STANDARD`. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst new file mode 100644 index 0000000000000000000000000000000000000000..bcc02d8593ff8a2db44b4945abbda64377becf01 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst @@ -0,0 +1,29 @@ +_INCLUDE_WHAT_YOU_USE +--------------------------- + +.. versionadded:: 3.3 + +This property is implemented only when ```` is ``C`` or ``CXX``. + +Specify a :ref:`semicolon-separated list ` containing a command +line for the ``include-what-you-use`` tool. The :ref:`Makefile Generators` +and the :generator:`Ninja` generator will run this tool along with the +compiler and report a warning if the tool reports any problems. + +This property is initialized by the value of +the :variable:`CMAKE__INCLUDE_WHAT_YOU_USE` variable if it is set +when a target is created. + +.. versionadded:: 3.27 + + This property supports + :manual:`generator expressions `. + +.. versionadded:: 3.27 + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting tools defined by :prop_tgt:`_CPPLINT`, + :prop_tgt:`_CLANG_TIDY`, :prop_tgt:`_CPPCHECK`, and + ``_INCLUDE_WHAT_YOU_USE``. When :prop_sf:`SKIP_LINTING` is + set to true on a source file, those tools will not be run on that specific + file. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LANG_LINKER_LAUNCHER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_LINKER_LAUNCHER.rst new file mode 100644 index 0000000000000000000000000000000000000000..19c140b8ad88d5ba399e5d8e12f697f59ab2ab89 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_LINKER_LAUNCHER.rst @@ -0,0 +1,21 @@ +_LINKER_LAUNCHER +---------------------- + +.. versionadded:: 3.21 + +This property is implemented only when ```` is ``C``, ``CXX``, +``OBJC``, or ``OBJCXX`` + +Specify a :ref:`semicolon-separated list ` containing a +command line for a linker launching tool. The :ref:`Makefile Generators` and the +:generator:`Ninja` generator will run this tool and pass the linker and its +arguments to the tool. This is useful for tools such as static analyzers. + +This property is initialized by the value of the +:variable:`CMAKE__LINKER_LAUNCHER` variable if it is set when a target is +created. + +.. versionadded:: 3.27 + + The property value may use + :manual:`generator expressions `. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LANG_STANDARD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_STANDARD.rst new file mode 100644 index 0000000000000000000000000000000000000000..8b0c1de3b93b925058412244b0cbbe38baa53935 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_STANDARD.rst @@ -0,0 +1,33 @@ +_STANDARD +--------------- + +The variations are: + +* :prop_tgt:`C_STANDARD` +* :prop_tgt:`CXX_STANDARD` +* :prop_tgt:`CUDA_STANDARD` +* :prop_tgt:`HIP_STANDARD` +* :prop_tgt:`OBJC_STANDARD` +* :prop_tgt:`OBJCXX_STANDARD` + +These properties specify language standard versions which are requested. When a +newer standard is specified than is supported by the compiler, then it will +fallback to the latest supported standard. This "decay" behavior may be +controlled with the :prop_tgt:`_STANDARD_REQUIRED` target property. + +Note that the actual language standard used may be higher than that specified +by ``_STANDARD``, regardless of the value of +:prop_tgt:`_STANDARD_REQUIRED`. In particular, +:ref:`usage requirements ` or the use of +:manual:`compile features ` can raise the required +language standard above what ``_STANDARD`` specifies. + +These properties are initialized by the value of the +:variable:`CMAKE__STANDARD` variable if it is set when a target is +created. + +For supported values and CMake versions see the respective pages. +To control compiler-specific extensions see :prop_tgt:`_EXTENSIONS`. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LANG_STANDARD_REQUIRED.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_STANDARD_REQUIRED.rst new file mode 100644 index 0000000000000000000000000000000000000000..d7ead8a4fdf7c6fa1cb6e820385ad191d44bc2d2 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_STANDARD_REQUIRED.rst @@ -0,0 +1,32 @@ +_STANDARD_REQUIRED +------------------------ + +The variations are: + +* :prop_tgt:`C_STANDARD_REQUIRED` +* :prop_tgt:`CXX_STANDARD_REQUIRED` +* :prop_tgt:`CUDA_STANDARD_REQUIRED` +* :prop_tgt:`HIP_STANDARD_REQUIRED` +* :prop_tgt:`OBJC_STANDARD_REQUIRED` +* :prop_tgt:`OBJCXX_STANDARD_REQUIRED` + +These properties specify whether the value of :prop_tgt:`_STANDARD` is a +requirement. When false or unset, the :prop_tgt:`_STANDARD` target +property is treated as optional and may "decay" to a previous standard if the +requested standard is not available. When ``_STANDARD_REQUIRED`` is set +to true, :prop_tgt:`_STANDARD` becomes a hard requirement and a fatal +error will be issued if that requirement cannot be met. + +Note that the actual language standard used may be higher than that specified +by :prop_tgt:`_STANDARD`, regardless of the value of +``_STANDARD_REQUIRED``. In particular, +:ref:`usage requirements ` or the use of +:manual:`compile features ` can raise the required +language standard above what :prop_tgt:`_STANDARD` specifies. + +These properties are initialized by the value of the +:variable:`CMAKE__STANDARD_REQUIRED` variable if it is set when a target +is created. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst new file mode 100644 index 0000000000000000000000000000000000000000..b178413ddb9519224f3114ac555689853e7e65a7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst @@ -0,0 +1,13 @@ +_VISIBILITY_PRESET +------------------------ + +Value for symbol visibility compile flags + +The ``_VISIBILITY_PRESET`` property determines the value passed in a +visibility related compile option, such as ``-fvisibility=`` for ````. +This property affects compilation in sources of all types of targets +(subject to policy :policy:`CMP0063`). + +This property is initialized by the value of the +:variable:`CMAKE__VISIBILITY_PRESET` variable if it is set when a +target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000000000000000000000000000000000000..c7098d816f17f01ea4c146bcfc6a38ce14f9f25d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst @@ -0,0 +1,9 @@ +LIBRARY_OUTPUT_DIRECTORY +------------------------ + +.. |XXX| replace:: :ref:`LIBRARY ` +.. |xxx| replace:: library +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_LIBRARY_OUTPUT_DIRECTORY` +.. include:: XXX_OUTPUT_DIRECTORY.txt + +See also the :prop_tgt:`LIBRARY_OUTPUT_DIRECTORY_` target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..43d96fc26a5bacfa690f9c390474ef1481382c4e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,17 @@ +LIBRARY_OUTPUT_DIRECTORY_ +--------------------------------- + +Per-configuration output directory for +:ref:`LIBRARY ` target files. + +This is a per-configuration version of the +:prop_tgt:`LIBRARY_OUTPUT_DIRECTORY` target property, but +multi-configuration generators (:ref:`Visual Studio Generators`, +:generator:`Xcode`) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the +:variable:`CMAKE_LIBRARY_OUTPUT_DIRECTORY_` variable if +it is set when a target is created. + +Contents of ``LIBRARY_OUTPUT_DIRECTORY_`` may use +:manual:`generator expressions `. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..ac23d7aa7128258209f30aaad248f1c95f0f14e8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst @@ -0,0 +1,8 @@ +LIBRARY_OUTPUT_NAME +------------------- + +.. |XXX| replace:: :ref:`LIBRARY ` +.. |xxx| replace:: library +.. include:: XXX_OUTPUT_NAME.txt + +See also the :prop_tgt:`LIBRARY_OUTPUT_NAME_` target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..47cf69ec220110c89b316d1936c1f484d949c9e0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,8 @@ +LIBRARY_OUTPUT_NAME_ +---------------------------- + +Per-configuration output name for +:ref:`LIBRARY ` target files. + +This is the configuration-specific version of the +:prop_tgt:`LIBRARY_OUTPUT_NAME` target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINKER_LANGUAGE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINKER_LANGUAGE.rst new file mode 100644 index 0000000000000000000000000000000000000000..33a30398b4b24dde228325aa02f3f9d356e383ad --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINKER_LANGUAGE.rst @@ -0,0 +1,16 @@ +LINKER_LANGUAGE +--------------- + +Specifies language whose compiler will invoke the linker. + +For executables, shared libraries, and modules, this sets the language +whose compiler is used to link the target (such as "C" or "CXX"). A +typical value for an executable is the language of the source file +providing the program entry point (main). If not set, the language +with the highest linker preference value is the default. Details of +the linker preferences are considered internal, but some limited +discussion can be found under the internal +:variable:`CMAKE__LINKER_PREFERENCE` variables. + +If this property is not set by the user, it will be calculated at +generate-time by CMake. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINKER_TYPE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINKER_TYPE.rst new file mode 100644 index 0000000000000000000000000000000000000000..4df02c9cdcdf3a985fde2fe847995af36f80281e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINKER_TYPE.rst @@ -0,0 +1,27 @@ +LINKER_TYPE +----------- + +.. versionadded:: 3.29 + +Specify which linker will be used for the link step. The property value may use +:manual:`generator expressions `. + +.. include:: ../variable/LINKER_PREDEFINED_TYPES.txt + +This property is not supported on :generator:`Green Hills MULTI` generator. + +The implementation details for the selected linker will be provided by the +:variable:`CMAKE__USING_LINKER_` variable. For example: + +.. code-block:: cmake + + add_library(lib1 SHARED ...) + set_property(TARGET lib1 PROPERTY LINKER_TYPE LLD) + +This specifies that ``lib1`` should use linker type ``LLD`` for the link step. +The command line options that will be passed to the toolchain will be provided +by the ``CMAKE__USING_LINKER_LLD`` variable. + +Note that the linker would typically be set using :variable:`CMAKE_LINKER_TYPE` +for the whole build rather than setting the ``LINKER_TYPE`` property on +individual targets. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_DEPENDS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_DEPENDS.rst new file mode 100644 index 0000000000000000000000000000000000000000..fd6b3f5dbfab1816ad25699b4301fbc6df097447 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_DEPENDS.rst @@ -0,0 +1,18 @@ +LINK_DEPENDS +------------ + +Additional files on which a target binary depends for linking. + +Specifies a semicolon-separated list of full-paths to files on which +the link rule for this target depends. The target binary will be +linked if any of the named files is newer than it. + +This property is supported only by :generator:`Ninja` and +:ref:`Makefile Generators`. It is +intended to specify dependencies on "linker scripts" for custom Makefile link +rules. + +Contents of ``LINK_DEPENDS`` may use "generator expressions" with +the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. See the :manual:`cmake-buildsystem(7)` +manual for more on defining buildsystem properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst new file mode 100644 index 0000000000000000000000000000000000000000..574718bb3ce820670948e955cff5dd22c46d7732 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst @@ -0,0 +1,15 @@ +LINK_DEPENDS_NO_SHARED +---------------------- + +Do not depend on linked shared library files. + +Set this property to true to tell CMake generators not to add +file-level dependencies on the shared library files linked by this +target. Modification to the shared libraries will not be sufficient +to re-link this target. Logical target-level dependencies will not be +affected so the linked shared libraries will still be brought up to +date before this target is built. + +This property is initialized by the value of the +:variable:`CMAKE_LINK_DEPENDS_NO_SHARED` variable if it is set when a +target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_DIRECTORIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_DIRECTORIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..e40e9f01b4579f0559054843b38f93232256e418 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_DIRECTORIES.rst @@ -0,0 +1,20 @@ +LINK_DIRECTORIES +---------------- + +.. versionadded:: 3.13 + +List of directories to use for the link step of shared library, module +and executable targets. + +This property holds a :ref:`semicolon-separated list ` of directories +specified so far for its target. Use the :command:`target_link_directories` +command to append more search directories. + +This property is initialized by the :prop_dir:`LINK_DIRECTORIES` directory +property when a target is created, and is used by the generators to set +the search directories for the linker. + +Contents of ``LINK_DIRECTORIES`` may use "generator expressions" with the +syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual +for available expressions. See the :manual:`cmake-buildsystem(7)` manual +for more on defining buildsystem properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_FLAGS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_FLAGS.rst new file mode 100644 index 0000000000000000000000000000000000000000..a64aa2bd669daf9ae2b66b51aeeacdb445a4a8b8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_FLAGS.rst @@ -0,0 +1,16 @@ +LINK_FLAGS +---------- + +Additional flags to use when linking this target if it is a shared library, +module library, or an executable. Static libraries need to use +:prop_tgt:`STATIC_LIBRARY_OPTIONS` or :prop_tgt:`STATIC_LIBRARY_FLAGS` +properties. + +The ``LINK_FLAGS`` property, managed as a string, can be used to add extra +flags to the link step of a target. :prop_tgt:`LINK_FLAGS_` will add +to the configuration ````, for example, ``DEBUG``, ``RELEASE``, +``MINSIZEREL``, ``RELWITHDEBINFO``, ... + +.. note:: + + This property has been superseded by :prop_tgt:`LINK_OPTIONS` property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_FLAGS_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_FLAGS_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..2b5f9f578f84d7e7dc5b09ce12475142ca205474 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_FLAGS_CONFIG.rst @@ -0,0 +1,11 @@ +LINK_FLAGS_ +------------------- + +Per-configuration linker flags for a ``SHARED`` library, ``MODULE`` or +``EXECUTABLE`` target. + +This is the configuration-specific version of :prop_tgt:`LINK_FLAGS`. + +.. note:: + + This property has been superseded by :prop_tgt:`LINK_OPTIONS` property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..9d1df1814e88d499c0a2536ed6b4fd804cf6b825 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst @@ -0,0 +1,31 @@ +LINK_INTERFACE_LIBRARIES +------------------------ + +List public interface libraries for a shared library or executable. + +By default linking to a shared library target transitively links to +targets with which the library itself was linked. For an executable +with exports (see the :prop_tgt:`ENABLE_EXPORTS` target property) no +default transitive link dependencies are used. This property replaces the default +transitive link dependencies with an explicit list. When the target +is linked into another target using the :command:`target_link_libraries` +command, the libraries listed (and recursively +their link interface libraries) will be provided to the other target +also. If the list is empty then no transitive link dependencies will +be incorporated when this target is linked into another target even if +the default set is non-empty. This property is initialized by the +value of the :variable:`CMAKE_LINK_INTERFACE_LIBRARIES` variable if it is +set when a target is created. This property is ignored for ``STATIC`` +libraries. + +This property is overridden by the :prop_tgt:`INTERFACE_LINK_LIBRARIES` +property if policy :policy:`CMP0022` is ``NEW``. + +This property is deprecated. Use :prop_tgt:`INTERFACE_LINK_LIBRARIES` +instead. + +Creating Relocatable Packages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. |INTERFACE_PROPERTY_LINK| replace:: ``LINK_INTERFACE_LIBRARIES`` +.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..b3082a602ad95461e8fb9a97e4c22447984502e9 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst @@ -0,0 +1,20 @@ +LINK_INTERFACE_LIBRARIES_ +--------------------------------- + +Per-configuration list of public interface libraries for a target. + +This is the configuration-specific version of +:prop_tgt:`LINK_INTERFACE_LIBRARIES`. If set, this property completely +overrides the generic property for the named configuration. + +This property is overridden by the :prop_tgt:`INTERFACE_LINK_LIBRARIES` +property if policy :policy:`CMP0022` is ``NEW``. + +This property is deprecated. Use :prop_tgt:`INTERFACE_LINK_LIBRARIES` +instead. + +Creating Relocatable Packages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. |INTERFACE_PROPERTY_LINK| replace:: ``LINK_INTERFACE_LIBRARIES_`` +.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst new file mode 100644 index 0000000000000000000000000000000000000000..17b4720a1a2cd2309b9d25246f8f03ea2fbd6000 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst @@ -0,0 +1,12 @@ +LINK_INTERFACE_MULTIPLICITY +--------------------------- + +Repetition count for ``STATIC`` libraries with cyclic dependencies. + +When linking to a ``STATIC`` library target with cyclic dependencies the +linker may need to scan more than once through the archives in the +strongly connected component of the dependency graph. CMake by +default constructs the link line so that the linker will scan through +the component at least twice. This property specifies the minimum +number of scans if it is larger than the default. CMake uses the +largest value specified by any target in a component. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..619aa3fd7d4a5fafb2ca8d127384c0b700b8a2b7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst @@ -0,0 +1,8 @@ +LINK_INTERFACE_MULTIPLICITY_ +------------------------------------ + +Per-configuration repetition count for cycles of ``STATIC`` libraries. + +This is the configuration-specific version of +:prop_tgt:`LINK_INTERFACE_MULTIPLICITY`. If set, this property completely +overrides the generic property for the named configuration. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..bb01e4bf305fec8b1fbcc6f1ccd855073c5a6088 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES.rst @@ -0,0 +1,35 @@ +LINK_LIBRARIES +-------------- + +List of direct link dependencies. + +This property specifies the list of libraries or targets which will be +used for linking. In addition to accepting values from the +:command:`target_link_libraries` command, values may be set directly on +any target using the :command:`set_property` command. + +The value of this property is used by the generators to construct the +link rule for the target. The direct link dependencies are linked first, +followed by indirect dependencies from the transitive closure of the +direct dependencies' :prop_tgt:`INTERFACE_LINK_LIBRARIES` properties. +See policy :policy:`CMP0022`. + +Contents of ``LINK_LIBRARIES`` may use +:manual:`generator expressions ` with the +syntax ``$<...>``. Policy :policy:`CMP0131` affects the behavior of the +:genex:`LINK_ONLY` generator expression for this property. + +See the :manual:`cmake-buildsystem(7)` manual for more on defining +buildsystem properties. + +.. include:: LINK_LIBRARIES_INDIRECTION.txt + +In advanced use cases, the list of direct link dependencies specified +by this property may be updated by usage requirements from dependencies. +See the :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` and +:prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` target properties. + +See the :variable:`CMAKE_LINK_LIBRARIES_STRATEGY` variable and +corresponding :prop_tgt:`LINK_LIBRARIES_STRATEGY` target property +for details on how CMake orders direct link dependencies on linker +command lines. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES_INDIRECTION.txt b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES_INDIRECTION.txt new file mode 100644 index 0000000000000000000000000000000000000000..19e3348c846a9ff6f8d26117981aef14fad0a2b5 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES_INDIRECTION.txt @@ -0,0 +1,10 @@ +.. note:: + A call to :command:`target_link_libraries( ...)` may update this + property on ````. If ```` was not created in the same + directory as the call then :command:`target_link_libraries` will wrap each + entry with the form ``::@(directory-id);...;::@``, where the ``::@`` is + literal and the ``(directory-id)`` is unspecified. + This tells the generators that the named libraries must be looked up in + the scope of the caller rather than in the scope in which the + ```` was created. Valid directory ids are stripped on export + by the :command:`install(EXPORT)` and :command:`export` commands. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst new file mode 100644 index 0000000000000000000000000000000000000000..1d1f736304f79db52ce965bf0ea593ee59f9b2a4 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES_ONLY_TARGETS.rst @@ -0,0 +1,56 @@ +LINK_LIBRARIES_ONLY_TARGETS +--------------------------- + +.. versionadded:: 3.23 + +Enforce that link items that can be target names are actually existing targets. + +Set this property to a true value to enable additional checks on the contents +of the :prop_tgt:`LINK_LIBRARIES` and :prop_tgt:`INTERFACE_LINK_LIBRARIES` +target properties, typically populated by :command:`target_link_libraries`. +Checks are also applied to libraries added to a target through the +:prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` properties of its dependencies. +CMake will verify that link items that might be target names actually name +existing targets. An item is considered a possible target name if: + +* it does not contain a ``/`` or ``\``, and +* it does not start in ``-``, and +* (for historical reasons) it does not start in ``$`` or `````. + +This property is initialized by the value of the +:variable:`CMAKE_LINK_LIBRARIES_ONLY_TARGETS` variable when a non-imported +target is created. The property may be explicitly enabled on an imported +target to check its link interface. + +In the following example, CMake will halt with an error at configure time +because ``miLib`` is not a target: + +.. code-block:: cmake + + set(CMAKE_LINK_LIBRARIES_ONLY_TARGETS ON) + add_library(myLib STATIC myLib.c) + add_executable(myExe myExe.c) + target_link_libraries(myExe PRIVATE miLib) # typo for myLib + +In order to link toolchain-provided libraries by name while still +enforcing ``LINK_LIBRARIES_ONLY_TARGETS``, use an +:ref:`imported ` +:ref:`Interface Library ` with the +:prop_tgt:`IMPORTED_LIBNAME` target property: + +.. code-block:: cmake + + add_library(toolchain::m INTERFACE IMPORTED) + set_property(TARGET toolchain::m PROPERTY IMPORTED_LIBNAME "m") + target_link_libraries(myExe PRIVATE toolchain::m) + +See also policy :policy:`CMP0028`. + +.. note:: + + If :prop_tgt:`INTERFACE_LINK_LIBRARIES` contains generator expressions, + its actual list of link items may depend on the type and properties of + the consuming target. In such cases CMake may not always detect names + of missing targets that only appear for specific consumers. + A future version of CMake with improved heuristics may start triggering + errors on projects accepted by previous versions of CMake. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES_STRATEGY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES_STRATEGY.rst new file mode 100644 index 0000000000000000000000000000000000000000..7eaef5ea6e3fb5e5e3f61a19089fc6c69e0e0806 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARIES_STRATEGY.rst @@ -0,0 +1,87 @@ +LINK_LIBRARIES_STRATEGY +----------------------- + +.. versionadded:: 3.31 + +Specify a strategy for ordering a target's direct link dependencies +on linker command lines. This property is initialized by the value of the +:variable:`CMAKE_LINK_LIBRARIES_STRATEGY` variable if it is set when a +target is created. + +CMake generates a target's link line using its :ref:`Target Link Properties`. +In particular, the :prop_tgt:`LINK_LIBRARIES` target property records the +target's direct link dependencies, typically populated by calls to +:command:`target_link_libraries`. Indirect link dependencies are +propagated from those entries of :prop_tgt:`LINK_LIBRARIES` that name +library targets by following the transitive closure of their +:prop_tgt:`INTERFACE_LINK_LIBRARIES` properties. CMake supports multiple +strategies for nominally ordering direct and indirect link dependencies, +which are then filtered for `Toolchain-Specific Behavior`_. + +Consider this example for the strategies below: + +.. code-block:: cmake + + add_library(A STATIC ...) + add_library(B STATIC ...) + add_library(C STATIC ...) + add_executable(main ...) + target_link_libraries(B PRIVATE A) + target_link_libraries(C PRIVATE A) + target_link_libraries(main PRIVATE A B C) + +The supported strategies are: + +``REORDER_MINIMALLY`` + Entries of :prop_tgt:`LINK_LIBRARIES` always appear first and in their + original order. Indirect link dependencies not satisfied by the + original entries may be reordered and de-duplicated with respect to + one another, but are always appended after the original entries. + This may result in less efficient link lines, but gives projects + control of ordering among independent entries. Such control may be + important when intermixing link flags with libraries, or when multiple + libraries provide a given symbol. + + This is the default. + + In the above example, this strategy computes a link line for ``main`` + by starting with its original entries ``A B C``, and then appends + another ``A`` to satisfy the dependencies of ``B`` and ``C`` on ``A``. + The nominal order produced by this strategy is ``A B C A``. + + Note that additional filtering for `Toolchain-Specific Behavior`_ + may de-duplicate ``A`` on the actual linker invocation in the + generated build system, resulting in either ``A B C`` or ``B C A``. + +``REORDER_FREELY`` + Entries of :prop_tgt:`LINK_LIBRARIES` may be reordered, de-duplicated, + and intermixed with indirect link dependencies. This may result in + more efficient link lines, but does not give projects any control of + ordering among independent entries. + + In the above example, this strategy computes a link line for ``main`` + by re-ordering its original entries ``A B C`` to satisfy the + dependencies of ``B`` and ``C`` on ``A``. + The nominal order produced by this strategy is ``B C A``. + +Toolchain-Specific Behavior +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +After one of the above strategies produces a nominal order among +direct and indirect link dependencies, the actual linker invocation +in the generated build system may de-duplicate entries based on +platform-specific requirements and linker capabilities. +See policy :policy:`CMP0156`. + +For example, if the ``REORDER_MINIMALLY`` strategy produces ``A B C A``, +the actual link line may de-duplicate ``A`` as follows: + +* If ``A`` is a static library and the linker re-scans automatically, + the first occurrence is kept, resulting in ``A B C``. + See policy :policy:`CMP0179` + +* If ``A`` is a shared library on Windows, the first + occurrence is kept, resulting in ``A B C``. + +* If ``A`` is a shared library on macOS or UNIX platforms, the last + occurrence is kept, resulting in ``B C A``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARY_OVERRIDE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARY_OVERRIDE.rst new file mode 100644 index 0000000000000000000000000000000000000000..31eed85e80e139fd3bd47a28b3308cf134ccc08d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARY_OVERRIDE.rst @@ -0,0 +1,65 @@ +LINK_LIBRARY_OVERRIDE +--------------------- + +.. versionadded:: 3.24 + +Override the library features associated with libraries from +:genex:`LINK_LIBRARY` generator expressions. This can be used to resolve +incompatible library features that result from specifying different features +for the same library in different :genex:`LINK_LIBRARY` generator expressions. + +This property supports overriding multiple libraries and features. It expects +a :ref:`semicolon-separated list `, where each list item +has the following form:: + + feature[,link-item]* + +For each comma-separated ``link-item``, any existing library feature associated +with it will be ignored for the target this property is set on. The item +will instead be associated with the specified ``feature``. Each ``link-item`` +can be anything that would be accepted as part of a ``library-list`` in a +:genex:`LINK_LIBRARY` generator expression. + +.. code-block:: cmake + + add_library(lib1 ...) + add_library(lib2 ...) + add_library(lib3 ...) + + target_link_libraries(lib1 PUBLIC "$") + target_link_libraries(lib2 PUBLIC "$") + target_link_libraries(lib3 PRIVATE lib1 lib2) + + # lib1 is associated with both feature2 and no feature. Without any override, + # this would result in a fatal error at generation time for lib3. + # Define an override to resolve the incompatible feature associations. + set_property(TARGET lib3 PROPERTY LINK_LIBRARY_OVERRIDE "feature2,lib1,external") + + # lib1 and external will now be associated with feature2 instead when linking lib3 + +It is also possible to override any feature with the pre-defined ``DEFAULT`` +library feature. This effectively discards any feature for that link item, +for that target only (``lib3`` in this example): + +.. code-block:: cmake + + # When linking lib3, discard any library feature for lib1, and use feature2 for external + set_property(TARGET lib3 PROPERTY LINK_LIBRARY_OVERRIDE + "DEFAULT,lib1" + "feature2,external" + ) + +The above example also demonstrates how to specify different feature overrides +for different link items. See the :prop_tgt:`LINK_LIBRARY_OVERRIDE_` +target property for an alternative way of overriding library features for +individual libraries, which may be simpler in some cases. If both properties +are defined and specify an override for the same link item, +:prop_tgt:`LINK_LIBRARY_OVERRIDE_` takes precedence over +``LINK_LIBRARY_OVERRIDE``. + +Contents of ``LINK_LIBRARY_OVERRIDE`` may use +:manual:`generator expressions `. + +For more information about library features, see the +:variable:`CMAKE__LINK_LIBRARY_USING_` and +:variable:`CMAKE_LINK_LIBRARY_USING_` variables. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARY_OVERRIDE_LIBRARY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARY_OVERRIDE_LIBRARY.rst new file mode 100644 index 0000000000000000000000000000000000000000..6c2efdd777c525a331096276d43d70753ca4c89b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_LIBRARY_OVERRIDE_LIBRARY.rst @@ -0,0 +1,51 @@ +LINK_LIBRARY_OVERRIDE_ +------------------------------- + +.. versionadded:: 3.24 + +Override the library feature associated with ```` from +:genex:`LINK_LIBRARY` generator expressions. This can be used to resolve +incompatible library features that result from specifying different features +for ```` in different :genex:`LINK_LIBRARY` generator expressions. + +When set on a target, this property holds a single library feature name, which +will be applied to ```` when linking that target. + +.. code-block:: cmake + + add_library(lib1 ...) + add_library(lib2 ...) + add_library(lib3 ...) + + target_link_libraries(lib1 PUBLIC "$") + target_link_libraries(lib2 PUBLIC "$") + target_link_libraries(lib3 PRIVATE lib1 lib2) + + # lib1 is associated with both feature2 and no feature. Without any override, + # this would result in a fatal error at generation time for lib3. + # Define an override to resolve the incompatible feature associations. + set_property(TARGET lib3 PROPERTY LINK_LIBRARY_OVERRIDE_lib1 feature2) + + # lib1 will now be associated with feature2 instead when linking lib3 + +It is also possible to override any feature with the pre-defined ``DEFAULT`` +library feature. This effectively discards any feature for that link item, +for that target only (``lib3`` in this example): + +.. code-block:: cmake + + # When linking lib3, discard any library feature for lib1 + set_property(TARGET lib3 PROPERTY LINK_LIBRARY_OVERRIDE_lib1 DEFAULT) + +See the :prop_tgt:`LINK_LIBRARY_OVERRIDE` target property for an alternative +way of overriding library features for multiple libraries at once. If both +properties are defined and specify an override for the same link item, +``LINK_LIBRARY_OVERRIDE_`` takes precedence over +:prop_tgt:`LINK_LIBRARY_OVERRIDE`. + +Contents of ``LINK_LIBRARY_OVERRIDE_`` may use +:manual:`generator expressions `. + +For more information about library features, see the +:variable:`CMAKE__LINK_LIBRARY_USING_` and +:variable:`CMAKE_LINK_LIBRARY_USING_` variables. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_OPTIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_OPTIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..8bc8bc33fe6983388595f059e265457d183d735d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_OPTIONS.rst @@ -0,0 +1,36 @@ +LINK_OPTIONS +------------ + +.. versionadded:: 3.13 + +List of options to use for the link step of shared library, module +and executable targets as well as the device link step. Targets that are static +libraries need to use the :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property. + +These options are used for both normal linking and device linking +(see policy :policy:`CMP0105`). To control link options for normal and device +link steps, :genex:`$` and :genex:`$` generator +expressions can be used. + +This property holds a :ref:`semicolon-separated list ` of +options specified so far for its target. Use the :command:`target_link_options` +command to append more options. + +This property is initialized by the :prop_dir:`LINK_OPTIONS` directory +property when a target is created, and is used by the generators to set +the options for the compiler. + +Contents of ``LINK_OPTIONS`` may use "generator expressions" with the +syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual +for available expressions. See the :manual:`cmake-buildsystem(7)` manual +for more on defining buildsystem properties. + +.. note:: + + This property must be used in preference to :prop_tgt:`LINK_FLAGS` property. + +.. include:: ../command/DEVICE_LINK_OPTIONS.txt + +.. include:: ../command/OPTIONS_SHELL.txt + +.. include:: ../command/LINK_OPTIONS_LINKER.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst new file mode 100644 index 0000000000000000000000000000000000000000..350968242208a162c3901d8cfeaf831488701653 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst @@ -0,0 +1,19 @@ +LINK_SEARCH_END_STATIC +---------------------- + +End a link line such that static system libraries are used. + +Some linkers support switches such as ``-Bstatic`` and ``-Bdynamic`` to +determine whether to use static or shared libraries for ``-lXXX`` options. +CMake uses these options to set the link type for libraries whose full +paths are not known or (in some cases) are in implicit link +directories for the platform. By default CMake adds an option at the +end of the library list (if necessary) to set the linker search type +back to its starting type. This property switches the final linker +search type to ``-Bstatic`` regardless of how it started. + +This property is initialized by the value of the variable +:variable:`CMAKE_LINK_SEARCH_END_STATIC` if it is set +when a target is created. + +See also :prop_tgt:`LINK_SEARCH_START_STATIC`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst new file mode 100644 index 0000000000000000000000000000000000000000..e81852de805b93443a996277dc2683f5f8e567bd --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst @@ -0,0 +1,20 @@ +LINK_SEARCH_START_STATIC +------------------------ + +Assume the linker looks for static libraries by default. + +Some linkers support switches such as ``-Bstatic`` and ``-Bdynamic`` to +determine whether to use static or shared libraries for ``-lXXX`` options. +CMake uses these options to set the link type for libraries whose full +paths are not known or (in some cases) are in implicit link +directories for the platform. By default the linker search type is +assumed to be ``-Bdynamic`` at the beginning of the library list. This +property switches the assumption to ``-Bstatic``. It is intended for use +when linking an executable statically (e.g. with the GNU ``-static`` +option). + +This property is initialized by the value of the variable + :variable:`CMAKE_LINK_SEARCH_START_STATIC` if it is set + when a target is created. + +See also :prop_tgt:`LINK_SEARCH_END_STATIC`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LINK_WHAT_YOU_USE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_WHAT_YOU_USE.rst new file mode 100644 index 0000000000000000000000000000000000000000..f993d525393eecc089ef39327c8cafa9cdb02d5b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LINK_WHAT_YOU_USE.rst @@ -0,0 +1,23 @@ +LINK_WHAT_YOU_USE +----------------- + +.. versionadded:: 3.7 + +This is a boolean option that, when set to ``TRUE``, will automatically run +contents of variable :variable:`CMAKE_LINK_WHAT_YOU_USE_CHECK` on the target +after it is linked. In addition, the linker flag specified by variable +:variable:`CMAKE__LINK_WHAT_YOU_USE_FLAG` will be passed to the target +with the link command so that all libraries specified on the command line will +be linked into the target. This will result in the link producing a list of +libraries that provide no symbols used by this target but are being linked to +it. + +.. note:: + + For now, it is only supported for ``ELF`` platforms and is only applicable to + executable and shared or module library targets. This property will be + ignored for any other targets and configurations. + +This property is initialized by the value of +the :variable:`CMAKE_LINK_WHAT_YOU_USE` variable if it is set +when a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LOCATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LOCATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..8697d42c490fffcdea3ce1a691cc89a9acaa53bf --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LOCATION.rst @@ -0,0 +1,28 @@ +LOCATION +-------- + +Read-only location of a target on disk. + +For an imported target, this read-only property returns the value of +the ``LOCATION_`` property for an unspecified configuration +```` provided by the target. + +For a non-imported target, this property is provided for compatibility +with CMake 2.4 and below. It was meant to get the location of an +executable target's output file for use in :command:`add_custom_command`. The +path may contain a build-system-specific portion that is replaced at +build time with the configuration getting built (such as +``$(ConfigurationName)`` in VS). In CMake 2.6 and above +:command:`add_custom_command` automatically recognizes a target name in its +``COMMAND`` and ``DEPENDS`` options and computes the target location. In +CMake 2.8.4 and above :command:`add_custom_command` recognizes +:manual:`generator expressions ` +to refer to target locations anywhere in the command. +Therefore this property is not needed for creating custom commands. + +Do not set properties that affect the location of a target after +reading this property. These include properties whose names match +``(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_)?``, +``(IMPLIB_)?(PREFIX|SUFFIX)``, or "LINKER_LANGUAGE". Failure to follow +this rule is not diagnosed and leaves the location of the target +undefined. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/LOCATION_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/LOCATION_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..e3fbef717abc33a804913a6e8a858b689452c98c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/LOCATION_CONFIG.rst @@ -0,0 +1,20 @@ +LOCATION_ +----------------- + +Read-only property providing a target location on disk. + +A read-only property that indicates where a target's main file is +located on disk for the configuration ````. The property is +defined only for library and executable targets. An imported target +may provide a set of configurations different from that of the +importing project. By default CMake looks for an exact-match but +otherwise uses an arbitrary available configuration. Use the +:prop_tgt:`MAP_IMPORTED_CONFIG_` property to map imported +configurations explicitly. + +Do not set properties that affect the location of a target after +reading this property. These include properties whose names match +``(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_)?``, +``(IMPLIB_)?(PREFIX|SUFFIX)``, or :prop_tgt:`LINKER_LANGUAGE`. +Failure to follow this rule is not diagnosed and leaves +the location of the target undefined. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..568fa9ec56be897deea44fd184ab38c6c2b738a8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst @@ -0,0 +1,27 @@ +MACHO_COMPATIBILITY_VERSION +--------------------------- + +.. versionadded:: 3.17 + +What compatibility version number is this target for Mach-O binaries. + +For shared libraries on Mach-O systems (e.g. macOS, iOS) +the ``MACHO_COMPATIBILITY_VERSION`` property corresponds to the +*compatibility version* and :prop_tgt:`MACHO_CURRENT_VERSION` corresponds to +the *current version*. These are both embedded in the shared library binary +and can be checked with the ``otool -L `` command. + +It should be noted that the :prop_tgt:`MACHO_CURRENT_VERSION` and +``MACHO_COMPATIBILITY_VERSION`` properties do not affect the file +names or version-related symlinks that CMake generates for the library. +The :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` target properties still +control the file and symlink names. The ``install_name`` is also still +controlled by :prop_tgt:`SOVERSION`. + +When :prop_tgt:`MACHO_CURRENT_VERSION` and ``MACHO_COMPATIBILITY_VERSION`` +are not given, :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` are used for +the version details to be embedded in the binaries respectively. +The :prop_tgt:`MACHO_CURRENT_VERSION` and ``MACHO_COMPATIBILITY_VERSION`` +properties only need to be given if the project needs to decouple the file +and symlink naming from the version details embedded in the binaries +(e.g. to match libtool conventions). diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MACHO_CURRENT_VERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/MACHO_CURRENT_VERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..9407c8239a8f04436ea2e19a870c70989060e5a2 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MACHO_CURRENT_VERSION.rst @@ -0,0 +1,27 @@ +MACHO_CURRENT_VERSION +--------------------- + +.. versionadded:: 3.17 + +What current version number is this target for Mach-O binaries. + +For shared libraries on Mach-O systems (e.g. macOS, iOS) +the :prop_tgt:`MACHO_COMPATIBILITY_VERSION` property corresponds to the +*compatibility version* and ``MACHO_CURRENT_VERSION`` corresponds to the +*current version*. These are both embedded in the shared library binary +and can be checked with the ``otool -L `` command. + +It should be noted that the ``MACHO_CURRENT_VERSION`` and +:prop_tgt:`MACHO_COMPATIBILITY_VERSION` properties do not affect the file +names or version-related symlinks that CMake generates for the library. +The :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` target properties still +control the file and symlink names. The ``install_name`` is also still +controlled by :prop_tgt:`SOVERSION`. + +When ``MACHO_CURRENT_VERSION`` and :prop_tgt:`MACHO_COMPATIBILITY_VERSION` +are not given, :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` are used for +the version details to be embedded in the binaries respectively. +The ``MACHO_CURRENT_VERSION`` and :prop_tgt:`MACHO_COMPATIBILITY_VERSION` +properties only need to be given if the project needs to decouple the file +and symlink naming from the version details embedded in the binaries +(e.g. to match libtool conventions). diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_BUNDLE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_BUNDLE.rst new file mode 100644 index 0000000000000000000000000000000000000000..2830cea5ebf161d35b1691897d1294af2e47a49d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_BUNDLE.rst @@ -0,0 +1,12 @@ +MACOSX_BUNDLE +------------- + +Build an executable as an Application Bundle on macOS or iOS. + +When this property is set to ``TRUE`` the executable when built on macOS +or iOS will be created as an application bundle. This makes it +a GUI executable that can be launched from the Finder. See the +:prop_tgt:`MACOSX_BUNDLE_INFO_PLIST` target property for information about +creation of the ``Info.plist`` file for the application bundle. +This property is initialized by the value of the variable +:variable:`CMAKE_MACOSX_BUNDLE` if it is set when a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst b/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst new file mode 100644 index 0000000000000000000000000000000000000000..d91570c581b0210386b388080065466826b8a327 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst @@ -0,0 +1,35 @@ +MACOSX_BUNDLE_INFO_PLIST +------------------------ + +Specify a custom ``Info.plist`` template for a macOS and iOS Application Bundle. + +An executable target with :prop_tgt:`MACOSX_BUNDLE` enabled will be built as an +application bundle on macOS. By default its ``Info.plist`` file is created +by configuring a template called ``MacOSXBundleInfo.plist.in`` located in the +:variable:`CMAKE_MODULE_PATH`. This property specifies an alternative template +file name which may be a full path. + +The following target properties may be set to specify content to be +configured into the file: + +``MACOSX_BUNDLE_BUNDLE_NAME`` + Sets ``CFBundleName``. +``MACOSX_BUNDLE_BUNDLE_VERSION`` + Sets ``CFBundleVersion``. +``MACOSX_BUNDLE_COPYRIGHT`` + Sets ``NSHumanReadableCopyright``. +``MACOSX_BUNDLE_GUI_IDENTIFIER`` + Sets ``CFBundleIdentifier``. +``MACOSX_BUNDLE_ICON_FILE`` + Sets ``CFBundleIconFile``. +``MACOSX_BUNDLE_INFO_STRING`` + Sets ``CFBundleGetInfoString``. +``MACOSX_BUNDLE_LONG_VERSION_STRING`` + Sets ``CFBundleLongVersionString``. +``MACOSX_BUNDLE_SHORT_VERSION_STRING`` + Sets ``CFBundleShortVersionString``. + +CMake variables of the same name may be set to affect all targets in a +directory that do not have each specific property set. If a custom +``Info.plist`` is specified by this property it may of course hard-code +all the settings instead of using the target properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst b/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst new file mode 100644 index 0000000000000000000000000000000000000000..77c85ad776cd9cf8c4d39ffd23ccea25c1f8bfb0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst @@ -0,0 +1,35 @@ +MACOSX_FRAMEWORK_INFO_PLIST +--------------------------- + +Specify a custom ``Info.plist`` template for a macOS and iOS Framework. + +A library target with :prop_tgt:`FRAMEWORK` enabled will be built as a +framework on macOS. By default its ``Info.plist`` file is created by +configuring a template called ``MacOSXFrameworkInfo.plist.in`` located in the +:variable:`CMAKE_MODULE_PATH`. This property specifies an alternative template +file name which may be a full path. + +The following target properties may be set to specify content to be +configured into the file: + +``MACOSX_FRAMEWORK_BUNDLE_NAME`` + .. versionadded:: 3.31 + + Sets ``CFBundleName``. + +``MACOSX_FRAMEWORK_BUNDLE_VERSION`` + Sets ``CFBundleVersion``. + +``MACOSX_FRAMEWORK_ICON_FILE`` + Sets ``CFBundleIconFile``. + +``MACOSX_FRAMEWORK_IDENTIFIER`` + Sets ``CFBundleIdentifier``. + +``MACOSX_FRAMEWORK_SHORT_VERSION_STRING`` + Sets ``CFBundleShortVersionString``. + +CMake variables of the same name may be set to affect all targets in a +directory that do not have each specific property set. If a custom +``Info.plist`` is specified by this property it may of course hard-code +all the settings instead of using the target properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_RPATH.rst b/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_RPATH.rst new file mode 100644 index 0000000000000000000000000000000000000000..b52ab675720760e062522e9fc56839f86d5b6d40 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MACOSX_RPATH.rst @@ -0,0 +1,23 @@ +MACOSX_RPATH +------------ + +Whether this target on macOS or iOS is located at runtime using rpaths. + +When this property is set to ``TRUE``, the directory portion of +the ``install_name`` field of this shared library will be ``@rpath`` +unless overridden by :prop_tgt:`INSTALL_NAME_DIR`. This indicates +the shared library is to be found at runtime using runtime +paths (rpaths). + +This property is initialized by the value of the variable +:variable:`CMAKE_MACOSX_RPATH` if it is set when a target is +created. + +Runtime paths will also be embedded in binaries using this target and +can be controlled by the :prop_tgt:`INSTALL_RPATH` target property on +the target linking to this target. + +Policy :policy:`CMP0042` was introduced to change the default value of +``MACOSX_RPATH`` to ``TRUE``. This is because use of ``@rpath`` is a +more flexible and powerful alternative to ``@executable_path`` and +``@loader_path``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MACOS_IMPORT_FILES.txt b/cmake/share/cmake-3.31/Help/prop_tgt/MACOS_IMPORT_FILES.txt new file mode 100644 index 0000000000000000000000000000000000000000..d6291009f79a9422d733a59a73c7c3cc042d4215 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MACOS_IMPORT_FILES.txt @@ -0,0 +1,12 @@ +.. note:: + + On macOS, this property will be ignored for the linker import files (e.g. + ``.tbd`` files, see :prop_tgt:`ENABLE_EXPORTS` property for details) when: + + * The :prop_tgt:`FRAMEWORK` is set, because the framework layout cannot be + changed. + * The :generator:`Xcode` generator is used, due to the limitations and + constraints of the ``Xcode`` tool. + + In both cases, the linker import files will be generated |IDEM| as the shared + library. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MANUALLY_ADDED_DEPENDENCIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/MANUALLY_ADDED_DEPENDENCIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..4d15f8f4c0cf4471be0a2a18e11c4fae049cd8d6 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MANUALLY_ADDED_DEPENDENCIES.rst @@ -0,0 +1,10 @@ +MANUALLY_ADDED_DEPENDENCIES +--------------------------- + +.. versionadded:: 3.8 + +Get manually added dependencies to other top-level targets. + +This read-only property can be used to query all dependencies that +were added for this target with the :command:`add_dependencies` +command. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..5883ec440f2b8250b7eaa7c837deb9b40c239594 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst @@ -0,0 +1,70 @@ +MAP_IMPORTED_CONFIG_ +---------------------------- + +Map from project configuration to +:ref:`imported target `'s configuration. + +Set this to the list of configurations of an imported target that may +be used for the current project's ```` configuration. Targets +imported from another project may not provide the same set of +configuration names available in the current project. Setting this +property tells CMake what imported configurations are suitable for use +when building the ```` configuration. The first configuration in +the list found to be provided by the imported target (i.e. via +:prop_tgt:`IMPORTED_LOCATION_` for the mapped-to ````) +is selected. As a special case, an empty list element refers to the +configuration-less imported target location +(i.e. :prop_tgt:`IMPORTED_LOCATION`). + +If this property is set and no matching configurations are available, +then the imported target is considered to be not found. This property +is ignored for non-imported targets. + +This property is initialized by the value of the +:variable:`CMAKE_MAP_IMPORTED_CONFIG_` variable if it is set when a +target is created. + +Example +^^^^^^^ + +For example creating imported C++ library ``foo``: + +.. code-block:: cmake + + add_library(foo STATIC IMPORTED) + +Use ``foo_debug`` path for ``Debug`` build type: + +.. code-block:: cmake + + set_property( + TARGET foo APPEND PROPERTY IMPORTED_CONFIGURATIONS DEBUG + ) + + set_target_properties(foo PROPERTIES + IMPORTED_LINK_INTERFACE_LANGUAGES_DEBUG "CXX" + IMPORTED_LOCATION_DEBUG "${foo_debug}" + ) + +Use ``foo_release`` path for ``Release`` build type: + +.. code-block:: cmake + + set_property( + TARGET foo APPEND PROPERTY IMPORTED_CONFIGURATIONS RELEASE + ) + + set_target_properties(foo PROPERTIES + IMPORTED_LINK_INTERFACE_LANGUAGES_RELEASE "CXX" + IMPORTED_LOCATION_RELEASE "${foo_release}" + ) + +Use ``Release`` version of library for ``MinSizeRel`` and ``RelWithDebInfo`` +build types: + +.. code-block:: cmake + + set_target_properties(foo PROPERTIES + MAP_IMPORTED_CONFIG_MINSIZEREL Release + MAP_IMPORTED_CONFIG_RELWITHDEBINFO Release + ) diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt b/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt new file mode 100644 index 0000000000000000000000000000000000000000..7780878b48d33e4ad1fc55bd12a471f45d0341f5 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt @@ -0,0 +1,16 @@ +``Embedded`` + Compile with ``-Z7`` or equivalent flag(s) to produce object files + with full symbolic debugging information. +``ProgramDatabase`` + Compile with ``-Zi`` or equivalent flag(s) to produce a program + database that contains all the symbolic debugging information. +``EditAndContinue`` + Compile with ``-ZI`` or equivalent flag(s) to produce a program + database that supports the Edit and Continue feature. + +The value is ignored on compilers not targeting the MSVC ABI, but an +unsupported value will be rejected as an error when using a compiler +targeting the MSVC ABI. + +The value may also be the empty string (``""``), in which case no debug +information format flag will be added explicitly by CMake. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst new file mode 100644 index 0000000000000000000000000000000000000000..a6c02e412ad7b0c8a25510789339541a97e9c094 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst @@ -0,0 +1,35 @@ +MSVC_DEBUG_INFORMATION_FORMAT +----------------------------- + +.. versionadded:: 3.25 + +Select debug information format when targeting the MSVC ABI. + +The allowed values are: + +.. include:: MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt + +Use :manual:`generator expressions ` to +support per-configuration specification. For example, the code: + +.. code-block:: cmake + + add_executable(foo foo.c) + set_property(TARGET foo PROPERTY + MSVC_DEBUG_INFORMATION_FORMAT "$<$:ProgramDatabase>") + +selects for the target ``foo`` the program database debug information format +for the Debug configuration. + +This property is initialized from the value of the +:variable:`CMAKE_MSVC_DEBUG_INFORMATION_FORMAT` variable, if it is set. +If this property is not set, CMake selects a debug information format using +the default value ``$<$:ProgramDatabase>``, if +supported by the compiler, and otherwise +``$<$:Embedded>``. + +.. note:: + + This property has effect only when policy :policy:`CMP0141` is set to ``NEW`` + prior to the first :command:`project` or :command:`enable_language` command + that enables a language using a compiler targeting the MSVC ABI. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_RUNTIME_LIBRARY-VALUES.txt b/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_RUNTIME_LIBRARY-VALUES.txt new file mode 100644 index 0000000000000000000000000000000000000000..77d86177e26556b282392129056fc4ff4fd25127 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_RUNTIME_LIBRARY-VALUES.txt @@ -0,0 +1,21 @@ +``MultiThreaded`` + Compile with ``-MT`` or equivalent flag(s) to use a multi-threaded + statically-linked runtime library. +``MultiThreadedDLL`` + Compile with ``-MD`` or equivalent flag(s) to use a multi-threaded + dynamically-linked runtime library. +``MultiThreadedDebug`` + Compile with ``-MTd`` or equivalent flag(s) to use a multi-threaded + statically-linked runtime library. +``MultiThreadedDebugDLL`` + Compile with ``-MDd`` or equivalent flag(s) to use a multi-threaded + dynamically-linked runtime library. + +The value is ignored on compilers not targeting the MSVC ABI, but an +unsupported value will be rejected as an error when using a compiler +targeting the MSVC ABI. + +The value may also be the empty string (``""``) in which case no runtime +library selection flag will be added explicitly by CMake. Note that with +:ref:`Visual Studio Generators` the native build system may choose to +add its own default runtime library selection flag. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst new file mode 100644 index 0000000000000000000000000000000000000000..6fb11049aa4250df8f09381e44317c1ee377fc4f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst @@ -0,0 +1,33 @@ +MSVC_RUNTIME_LIBRARY +-------------------- + +.. versionadded:: 3.15 + +Select the MSVC runtime library for use by compilers targeting the MSVC ABI. + +The allowed values are: + +.. include:: MSVC_RUNTIME_LIBRARY-VALUES.txt + +Use :manual:`generator expressions ` to +support per-configuration specification. For example, the code: + +.. code-block:: cmake + + add_executable(foo foo.c) + set_property(TARGET foo PROPERTY + MSVC_RUNTIME_LIBRARY "MultiThreaded$<$:Debug>") + +selects for the target ``foo`` a multi-threaded statically-linked runtime +library with or without debug information depending on the configuration. + +The property is initialized from the value of the +:variable:`CMAKE_MSVC_RUNTIME_LIBRARY` variable, if it is set. +If the property is not set, then CMake uses the default value +``MultiThreaded$<$:Debug>DLL`` to select a MSVC runtime library. + +.. note:: + + This property has effect only when policy :policy:`CMP0091` is set to ``NEW`` + prior to the first :command:`project` or :command:`enable_language` command + that enables a language using a compiler targeting the MSVC ABI. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..06c582ae9f5d6b093198f0fa0d29320dfcdc254b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/NAME.rst @@ -0,0 +1,6 @@ +NAME +---- + +Logical name for the target. + +Read-only logical name for the target as used by CMake. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/NO_SONAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/NO_SONAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..f3ab4e76f7a59659dc1448d202db6bd0f1be2984 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/NO_SONAME.rst @@ -0,0 +1,14 @@ +NO_SONAME +--------- + +Whether to set ``soname`` when linking a shared library. + +Enable this boolean property if a generated ``SHARED`` library +should not have ``soname`` set. Default is to set ``soname`` on all +shared libraries as long as the platform supports it. +Generally, use this property only for leaf private libraries or +plugins. If you use it on normal shared libraries which other targets +link against, on some platforms a linker will insert a full path to +the library (as specified at link time) into the dynamic section of +the dependent binary. Therefore, once installed, dynamic loader may +eventually fail to locate the library for the binary. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst b/cmake/share/cmake-3.31/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst new file mode 100644 index 0000000000000000000000000000000000000000..0b876330e31c9ba5d312f058a5b78bd4d673f0ad --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst @@ -0,0 +1,29 @@ +NO_SYSTEM_FROM_IMPORTED +----------------------- + +Do not treat include directories from the interfaces of consumed +:ref:`imported targets` as system directories. + +When the consumed target's :prop_tgt:`SYSTEM` property is set to true, the +contents of the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` target property are +treated as system includes or, on Apple platforms, when the target is a +framework, it will be treated as system. By default, :prop_tgt:`SYSTEM` is +true for imported targets and false for other target types. If the +``NO_SYSTEM_FROM_IMPORTED`` property is set to true on a *consuming* target, +compilation of sources in that consuming target will not treat the contents of +the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` of consumed imported targets as +system includes, even if that imported target's :prop_tgt:`SYSTEM` property +is false. + +Directories listed in the :prop_tgt:`INTERFACE_SYSTEM_INCLUDE_DIRECTORIES` +property of consumed targets are not affected by ``NO_SYSTEM_FROM_IMPORTED``. +Those directories will always be treated as system include directories by +consumers. + +This property is initialized by the value of the +:variable:`CMAKE_NO_SYSTEM_FROM_IMPORTED` variable if it is set when a target +is created. + +See the :prop_tgt:`EXPORT_NO_SYSTEM` target property to set this behavior +on the target providing the include directories rather than the target +consuming them. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/OBJCXX_EXTENSIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/OBJCXX_EXTENSIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..619101bdd629daf9de1bd5624319aa7211f3a75d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/OBJCXX_EXTENSIONS.rst @@ -0,0 +1,24 @@ +OBJCXX_EXTENSIONS +----------------- + +.. versionadded:: 3.16 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu++11`` instead of ``-std=c++11`` to the compile line. This +property is ``ON`` by default. The basic ObjC++ standard level is +controlled by the :prop_tgt:`OBJCXX_STANDARD` target property. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +If the property is not set, and the project has set the :prop_tgt:`CXX_EXTENSIONS`, +the value of :prop_tgt:`CXX_EXTENSIONS` is set for ``OBJCXX_EXTENSIONS``. + +This property is initialized by the value of +the :variable:`CMAKE_OBJCXX_EXTENSIONS` variable if set when a target is +created and otherwise by the value of +:variable:`CMAKE_OBJCXX_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` +(see :policy:`CMP0128`). diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/OBJCXX_STANDARD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/OBJCXX_STANDARD.rst new file mode 100644 index 0000000000000000000000000000000000000000..9ba559fb844b4e31fb2fc7fa0b055831453d5016 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/OBJCXX_STANDARD.rst @@ -0,0 +1,63 @@ +OBJCXX_STANDARD +--------------- + +.. versionadded:: 3.16 + +The ObjC++ standard whose features are requested to build this target. + +This property specifies the ObjC++ standard whose features are requested +to build this target. For some compilers, this results in adding a +flag such as ``-std=gnu++11`` to the compile line. + +Supported values are: + +``98`` + Objective C++98 + +``11`` + Objective C++11 + +``14`` + Objective C++14 + +``17`` + Objective C++17 + +``20`` + Objective C++20 + +``23`` + .. versionadded:: 3.20 + + Objective C++23 + +``26`` + .. versionadded:: 3.25 + + Objective C++26. CMake 3.25 and later *recognize* ``26`` as a valid value, + no version has support for any compiler. + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY OBJCXX_STANDARD 11) + +with a compiler which does not support ``-std=gnu++11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu++98`` flag if supported. This "decay" behavior may be controlled +with the :prop_tgt:`OBJCXX_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`OBJCXX_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +If the property is not set, and the project has set the :prop_tgt:`CXX_STANDARD`, +the value of :prop_tgt:`CXX_STANDARD` is set for ``OBJCXX_STANDARD``. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_OBJCXX_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst b/cmake/share/cmake-3.31/Help/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst new file mode 100644 index 0000000000000000000000000000000000000000..56633140d92c85075a12c15e7c84b2346b2a7737 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/OBJCXX_STANDARD_REQUIRED.rst @@ -0,0 +1,22 @@ +OBJCXX_STANDARD_REQUIRED +------------------------ + +.. versionadded:: 3.16 + +Boolean describing whether the value of :prop_tgt:`OBJCXX_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`OBJCXX_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`OBJCXX_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. + +If the property is not set, and the project has set the :prop_tgt:`CXX_STANDARD_REQUIRED`, +the value of :prop_tgt:`CXX_STANDARD_REQUIRED` is set for ``OBJCXX_STANDARD_REQUIRED``. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_OBJCXX_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/OBJC_EXTENSIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/OBJC_EXTENSIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..92a0b8461b60326c0b5b79fc06e916ead0605a40 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/OBJC_EXTENSIONS.rst @@ -0,0 +1,24 @@ +OBJC_EXTENSIONS +--------------- + +.. versionadded:: 3.16 + +Boolean specifying whether compiler specific extensions are requested. + +This property specifies whether compiler specific extensions should be +used. For some compilers, this results in adding a flag such +as ``-std=gnu11`` instead of ``-std=c11`` to the compile line. This +property is ``ON`` by default. The basic OBJC standard level is +controlled by the :prop_tgt:`OBJC_STANDARD` target property. + +If the property is not set, and the project has set the :prop_tgt:`C_EXTENSIONS`, +the value of :prop_tgt:`C_EXTENSIONS` is set for ``OBJC_EXTENSIONS``. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_OBJC_EXTENSIONS` variable if set when a target is created +and otherwise by the value of +:variable:`CMAKE_OBJC_EXTENSIONS_DEFAULT _EXTENSIONS_DEFAULT>` +(see :policy:`CMP0128`). diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/OBJC_STANDARD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/OBJC_STANDARD.rst new file mode 100644 index 0000000000000000000000000000000000000000..42f8e2b5f0a62896cb1e7108f1474985f2794faa --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/OBJC_STANDARD.rst @@ -0,0 +1,56 @@ +OBJC_STANDARD +------------- + +.. versionadded:: 3.16 + +The OBJC standard whose features are requested to build this target. + +This property specifies the OBJC standard whose features are requested +to build this target. For some compilers, this results in adding a +flag such as ``-std=gnu11`` to the compile line. + +Supported values are: + +``90`` + Objective C89/C90 + +``99`` + Objective C99 + +``11`` + Objective C11 + +``17`` + .. versionadded:: 3.21 + + Objective C17 + +``23`` + .. versionadded:: 3.21 + + Objective C23 + +If the value requested does not result in a compile flag being added for +the compiler in use, a previous standard flag will be added instead. This +means that using: + +.. code-block:: cmake + + set_property(TARGET tgt PROPERTY OBJC_STANDARD 11) + +with a compiler which does not support ``-std=gnu11`` or an equivalent +flag will not result in an error or warning, but will instead add the +``-std=gnu99`` or ``-std=gnu90`` flag if supported. This "decay" behavior may +be controlled with the :prop_tgt:`OBJC_STANDARD_REQUIRED` target property. +Additionally, the :prop_tgt:`OBJC_EXTENSIONS` target property may be used to +control whether compiler-specific extensions are enabled on a per-target basis. + +If the property is not set, and the project has set the :prop_tgt:`C_STANDARD`, +the value of :prop_tgt:`C_STANDARD` is set for ``OBJC_STANDARD``. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_OBJC_STANDARD` variable if it is set when a target +is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/OBJC_STANDARD_REQUIRED.rst b/cmake/share/cmake-3.31/Help/prop_tgt/OBJC_STANDARD_REQUIRED.rst new file mode 100644 index 0000000000000000000000000000000000000000..5e0b2fca4361d8be1b3b2dc3fa93bfa9eea2ddd0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/OBJC_STANDARD_REQUIRED.rst @@ -0,0 +1,22 @@ +OBJC_STANDARD_REQUIRED +---------------------- + +.. versionadded:: 3.16 + +Boolean describing whether the value of :prop_tgt:`OBJC_STANDARD` is a requirement. + +If this property is set to ``ON``, then the value of the +:prop_tgt:`OBJC_STANDARD` target property is treated as a requirement. If this +property is ``OFF`` or unset, the :prop_tgt:`OBJC_STANDARD` target property is +treated as optional and may "decay" to a previous standard if the requested is +not available. + +If the property is not set, and the project has set the :prop_tgt:`C_STANDARD_REQUIRED`, +the value of :prop_tgt:`C_STANDARD_REQUIRED` is set for ``OBJC_STANDARD_REQUIRED``. + +See the :manual:`cmake-compile-features(7)` manual for information on +compile features and a list of supported compilers. + +This property is initialized by the value of +the :variable:`CMAKE_OBJC_STANDARD_REQUIRED` variable if it is set when a +target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/OPTIMIZE_DEPENDENCIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/OPTIMIZE_DEPENDENCIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..e8d8087ba83d5285fac36cd53651b2c2f7443b0f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/OPTIMIZE_DEPENDENCIES.rst @@ -0,0 +1,43 @@ +OPTIMIZE_DEPENDENCIES +--------------------- + +.. versionadded:: 3.19 + +Activates dependency optimization of static and object libraries. + +When this property is set to true, some dependencies for a static or object +library may be removed at generation time if they are not necessary to build +the library, since static and object libraries don't actually link against +anything. + +If a static or object library has dependency optimization enabled, it first +discards all dependencies. Then, it looks through all of the direct and +indirect dependencies that it initially had, and adds them back if they meet +any of the following criteria: + +* The dependency was added to the library by :command:`add_dependencies`. +* The dependency was added to the library through a source file in the library + generated by a custom command that uses the dependency. +* The dependency has any ``PRE_BUILD``, ``PRE_LINK``, or ``POST_BUILD`` custom + commands associated with it. +* The dependency contains any source files that were generated by a custom + command. +* The dependency contains any languages which produce side effects that are + relevant to the library. Currently, all languages except C, C++, Objective-C, + Objective-C++, assembly, and CUDA are assumed to produce side effects. + However, side effects from one language are assumed not to be relevant to + another (for example, a Fortran library is assumed to not have any side + effects that are relevant for a Swift library.) + +As an example, assume you have a static Fortran library which depends on a +static C library, which in turn depends on a static Fortran library. The +top-level Fortran library has optimization enabled, but the middle C library +does not. If you build the top Fortran library, the bottom Fortran library will +also build, but not the middle C library, since the C library does not have any +side effects that are relevant for the Fortran library. However, if you build +the middle C library, the bottom Fortran library will also build, even though +it does not have any side effects that are relevant to the C library, since the +C library does not have optimization enabled. + +This property is initialized by the value of the +:variable:`CMAKE_OPTIMIZE_DEPENDENCIES` variable when the target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/OSX_ARCHITECTURES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/OSX_ARCHITECTURES.rst new file mode 100644 index 0000000000000000000000000000000000000000..f1aa90edc244183f2993d0b720f44dda89d0fe3a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/OSX_ARCHITECTURES.rst @@ -0,0 +1,11 @@ +OSX_ARCHITECTURES +----------------- + +Target specific architectures for macOS. + +The ``OSX_ARCHITECTURES`` property sets the target binary architecture for +targets on macOS (``-arch``). This property is initialized by the value of the +variable :variable:`CMAKE_OSX_ARCHITECTURES` if it is set when a target is +created. Use :prop_tgt:`OSX_ARCHITECTURES_` to set the binary +architectures on a per-configuration basis, where ```` is an +upper-case name (e.g. ``OSX_ARCHITECTURES_DEBUG``). diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..5969ebdc3d33ecd88dedb4e141799472cffddc2c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst @@ -0,0 +1,7 @@ +OSX_ARCHITECTURES_ +-------------------------- + +Per-configuration macOS and iOS binary architectures for a target. + +This property is the configuration-specific version of +:prop_tgt:`OSX_ARCHITECTURES`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/OUTPUT_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/OUTPUT_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..4ca1cca992768bd92dc48aeb367e443c0d2d2adb --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/OUTPUT_NAME.rst @@ -0,0 +1,22 @@ +OUTPUT_NAME +----------- + +Output name for target files. + +This sets the base name for output files created for an executable or +library target. If not set, the logical target name is used by +default during generation. The value is not set by default during +configuration. + +Contents of ``OUTPUT_NAME`` and the variants listed below may use +:manual:`generator expressions `. + +See also the variants: + +* :prop_tgt:`OUTPUT_NAME_` +* :prop_tgt:`ARCHIVE_OUTPUT_NAME_` +* :prop_tgt:`ARCHIVE_OUTPUT_NAME` +* :prop_tgt:`LIBRARY_OUTPUT_NAME_` +* :prop_tgt:`LIBRARY_OUTPUT_NAME` +* :prop_tgt:`RUNTIME_OUTPUT_NAME_` +* :prop_tgt:`RUNTIME_OUTPUT_NAME` diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..562379a8dd87cd77775c858110653f5d09b4a267 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,7 @@ +OUTPUT_NAME_ +-------------------- + +Per-configuration target file base name. + +This is the configuration-specific version of the :prop_tgt:`OUTPUT_NAME` +target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PCH_INSTANTIATE_TEMPLATES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PCH_INSTANTIATE_TEMPLATES.rst new file mode 100644 index 0000000000000000000000000000000000000000..1b25c34ef87eec30e0ec9b38cd3e63a9f079e33f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PCH_INSTANTIATE_TEMPLATES.rst @@ -0,0 +1,13 @@ +PCH_INSTANTIATE_TEMPLATES +------------------------- + +.. versionadded:: 3.19 + +When this property is set to true, the precompiled header compiler options +will contain a flag to instantiate templates during the generation of the PCH +if supported. This can significantly improve compile times. Supported in Clang +since version 11. + +This property is initialized by the value of the +:variable:`CMAKE_PCH_INSTANTIATE_TEMPLATES` variable if it is set when a target +is created. If that variable is not set, the property defaults to ``ON``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PCH_WARN_INVALID.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PCH_WARN_INVALID.rst new file mode 100644 index 0000000000000000000000000000000000000000..27b8243b504e8e2698113bcc8db5be2b83825412 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PCH_WARN_INVALID.rst @@ -0,0 +1,12 @@ +PCH_WARN_INVALID +---------------- + +.. versionadded:: 3.18 + +When this property is set to true, the precompile header compiler options +will contain a compiler flag which should warn about invalid precompiled +headers e.g. ``-Winvalid-pch`` for GNU compiler. + +This property is initialized by the value of the +:variable:`CMAKE_PCH_WARN_INVALID` variable if it is set when a target is +created. If that variable is not set, the property defaults to ``ON``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PDB_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PDB_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..09a7a022defc0b3826bfc60a0fa292b34a778ad2 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PDB_NAME.rst @@ -0,0 +1,12 @@ +PDB_NAME +-------- + +Output name for the MS debug symbol ``.pdb`` file generated by the +linker for an executable or shared library target. + +This property specifies the base name for the debug symbols file. +If not set, the :prop_tgt:`OUTPUT_NAME` target property value or +logical target name is used by default. + +.. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_NAME` +.. include:: PDB_NOTE.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PDB_NAME_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PDB_NAME_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..45993c7c7a79b8e30ed95c2b131fd8744f176db5 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PDB_NAME_CONFIG.rst @@ -0,0 +1,10 @@ +PDB_NAME_ +----------------- + +Per-configuration output name for the MS debug symbol ``.pdb`` file +generated by the linker for an executable or shared library target. + +This is the configuration-specific version of :prop_tgt:`PDB_NAME`. + +.. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_NAME_` +.. include:: PDB_NOTE.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PDB_NOTE.txt b/cmake/share/cmake-3.31/Help/prop_tgt/PDB_NOTE.txt new file mode 100644 index 0000000000000000000000000000000000000000..4388a29301817852ab03567ec868cd5ea91a301c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PDB_NOTE.txt @@ -0,0 +1,9 @@ +.. note:: + This property does not apply to STATIC library targets because no linker + is invoked to produce them so they have no linker-generated ``.pdb`` file + containing debug symbols. + + The linker-generated program database files are specified by the + ``/pdb`` linker flag and are not the same as compiler-generated + program database files specified by the ``/Fd`` compiler flag. + Use the |COMPILE_PDB_XXX| property to specify the latter. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000000000000000000000000000000000000..eef64db987a10618bc548a4b5b7586781661e561 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst @@ -0,0 +1,19 @@ +PDB_OUTPUT_DIRECTORY +-------------------- + +Output directory for the MS debug symbols ``.pdb`` file +generated by the linker for an executable or shared library target. + +This property specifies the directory into which the MS debug symbols +will be placed by the linker. The property value may use +:manual:`generator expressions `. +Multi-configuration generators append a per-configuration +subdirectory to the specified directory unless a generator expression +is used. + +This property is initialized by the value of the +:variable:`CMAKE_PDB_OUTPUT_DIRECTORY` variable if it is +set when a target is created. + +.. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY` +.. include:: PDB_NOTE.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..8d5cd894489b45827192f5586a37546b5008c0c3 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,19 @@ +PDB_OUTPUT_DIRECTORY_ +----------------------------- + +Per-configuration output directory for the MS debug symbol ``.pdb`` file +generated by the linker for an executable or shared library target. + +This is a per-configuration version of :prop_tgt:`PDB_OUTPUT_DIRECTORY`, +but multi-configuration generators (:ref:`Visual Studio Generators`, +:generator:`Xcode`) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the +:variable:`CMAKE_PDB_OUTPUT_DIRECTORY_` variable if it is +set when a target is created. + +Contents of ``PDB_OUTPUT_DIRECTORY_`` may use +:manual:`generator expressions `. + +.. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY_` +.. include:: PDB_NOTE.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst new file mode 100644 index 0000000000000000000000000000000000000000..586f7e371e6abca74484f31fc9d5a752e20c54c0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst @@ -0,0 +1,16 @@ +POSITION_INDEPENDENT_CODE +------------------------- + +Whether to create a position-independent target + +The ``POSITION_INDEPENDENT_CODE`` property determines whether position +independent executables or shared libraries will be created. This +property is ``True`` by default for ``SHARED`` and ``MODULE`` library +targets and ``False`` otherwise. This property is initialized by the value +of the :variable:`CMAKE_POSITION_INDEPENDENT_CODE` variable if it is set +when a target is created. + +.. note:: + + For executable targets, the link step is controlled by the :policy:`CMP0083` + policy and the :module:`CheckPIESupported` module. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/POST_INSTALL_SCRIPT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/POST_INSTALL_SCRIPT.rst new file mode 100644 index 0000000000000000000000000000000000000000..5c6af060862ed30def36059a8c7eb87f56e53e4e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/POST_INSTALL_SCRIPT.rst @@ -0,0 +1,9 @@ +POST_INSTALL_SCRIPT +------------------- + +Deprecated install support. + +The :prop_tgt:`PRE_INSTALL_SCRIPT` and ``POST_INSTALL_SCRIPT`` properties are +the old way to specify CMake scripts to run before and after installing a +target. They are used only when the old ``INSTALL_TARGETS`` command is +used to install the target. Use the :command:`install` command instead. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PRECOMPILE_HEADERS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PRECOMPILE_HEADERS.rst new file mode 100644 index 0000000000000000000000000000000000000000..582e4f348880348ceb2aeab94302cb37b334ed61 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PRECOMPILE_HEADERS.rst @@ -0,0 +1,14 @@ +PRECOMPILE_HEADERS +------------------ + +.. versionadded:: 3.16 + +List of header files to precompile. + +This property holds a :ref:`semicolon-separated list ` +of header files to precompile specified so far for its target. +Use the :command:`target_precompile_headers` command to append more header +files. + +This property supports +:manual:`generator expressions `. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PRECOMPILE_HEADERS_REUSE_FROM.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PRECOMPILE_HEADERS_REUSE_FROM.rst new file mode 100644 index 0000000000000000000000000000000000000000..ce1f70cd1a41c1698bede700be4e538851e7297e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PRECOMPILE_HEADERS_REUSE_FROM.rst @@ -0,0 +1,9 @@ +PRECOMPILE_HEADERS_REUSE_FROM +----------------------------- + +.. versionadded:: 3.16 + +Target from which to reuse the precompiled headers build artifact. + +See the second signature of :command:`target_precompile_headers` command +for more detailed information. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PREFIX.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PREFIX.rst new file mode 100644 index 0000000000000000000000000000000000000000..ecc168e3b7db269a01d7738438767b610cf1de70 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PREFIX.rst @@ -0,0 +1,7 @@ +PREFIX +------ + +What comes before the library name. + +A target property that can be set to override the prefix (such as +``lib``) on a library name. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst new file mode 100644 index 0000000000000000000000000000000000000000..7ba39df16e1ccfc9db305b5e782060c9d56b4e3a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst @@ -0,0 +1,9 @@ +PRE_INSTALL_SCRIPT +------------------ + +Deprecated install support. + +The ``PRE_INSTALL_SCRIPT`` and :prop_tgt:`POST_INSTALL_SCRIPT` properties are +the old way to specify CMake scripts to run before and after installing a +target. They are used only when the old ``INSTALL_TARGETS`` command is +used to install the target. Use the :command:`install` command instead. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PRIVATE_HEADER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PRIVATE_HEADER.rst new file mode 100644 index 0000000000000000000000000000000000000000..80ec338a9fb949ec0b839bedb2353fc2b14b3318 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PRIVATE_HEADER.rst @@ -0,0 +1,11 @@ +PRIVATE_HEADER +-------------- + +Specify private header files in a :prop_tgt:`FRAMEWORK` shared library target. + +Shared library targets marked with the :prop_tgt:`FRAMEWORK` property generate +frameworks on macOS, iOS and normal shared libraries on other platforms. +This property may be set to a list of header files to be placed in the +PrivateHeaders directory inside the framework folder. On non-Apple +platforms these headers may be installed using the ``PRIVATE_HEADER`` +option to the :command:`install(TARGETS)` command. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PROJECT_LABEL.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PROJECT_LABEL.rst new file mode 100644 index 0000000000000000000000000000000000000000..714bf8dea9884219ff97ac64f2a0a663dde4ffca --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PROJECT_LABEL.rst @@ -0,0 +1,7 @@ +PROJECT_LABEL +------------- + +Change the name of a target in an IDE. + +Can be used to change the name of the target in an IDE like Visual +Studio. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/PUBLIC_HEADER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/PUBLIC_HEADER.rst new file mode 100644 index 0000000000000000000000000000000000000000..57553aaf98379b76bc0bd3e77d6b98801075c0ce --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/PUBLIC_HEADER.rst @@ -0,0 +1,11 @@ +PUBLIC_HEADER +------------- + +Specify public header files in a :prop_tgt:`FRAMEWORK` shared library target. + +Shared library targets marked with the :prop_tgt:`FRAMEWORK` property generate +frameworks on macOS, iOS and normal shared libraries on other platforms. +This property may be set to a list of header files to be placed in the +``Headers`` directory inside the framework folder. On non-Apple platforms +these headers may be installed using the ``PUBLIC_HEADER`` option to the +:command:`install(TARGETS)` command. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/RESOURCE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/RESOURCE.rst new file mode 100644 index 0000000000000000000000000000000000000000..2997b956e33881e81b5cd4bdae318756a07090e3 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/RESOURCE.rst @@ -0,0 +1,58 @@ +RESOURCE +-------- + +Specify resource files in a :prop_tgt:`FRAMEWORK` or :prop_tgt:`BUNDLE`. + +Target marked with the :prop_tgt:`FRAMEWORK` or :prop_tgt:`BUNDLE` property +generate framework or application bundle (both macOS and iOS is supported) +or normal shared libraries on other platforms. +This property may be set to a list of files to be placed in the corresponding +directory (eg. ``Resources`` directory for macOS) inside the bundle. +On non-Apple platforms these files may be installed using the ``RESOURCE`` +option to the :command:`install(TARGETS)` command. + +Following example of Application Bundle: + +.. code-block:: cmake + + add_executable(ExecutableTarget + addDemo.c + resourcefile.txt + appresourcedir/appres.txt) + + target_link_libraries(ExecutableTarget heymath mul) + + set(RESOURCE_FILES + resourcefile.txt + appresourcedir/appres.txt) + + set_target_properties(ExecutableTarget PROPERTIES + MACOSX_BUNDLE TRUE + MACOSX_FRAMEWORK_IDENTIFIER org.cmake.ExecutableTarget + RESOURCE "${RESOURCE_FILES}") + +will produce flat structure for iOS systems:: + + ExecutableTarget.app + appres.txt + ExecutableTarget + Info.plist + resourcefile.txt + +For macOS systems it will produce following directory structure:: + + ExecutableTarget.app/ + Contents + Info.plist + MacOS + ExecutableTarget + Resources + appres.txt + resourcefile.txt + +For Linux, such CMake script produce following files:: + + ExecutableTarget + Resources + appres.txt + resourcefile.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst new file mode 100644 index 0000000000000000000000000000000000000000..4b3c5015de32e9783dd9dc080cb293346f8ae6c1 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst @@ -0,0 +1,13 @@ +RULE_LAUNCH_COMPILE +------------------- + +Specify a launcher for compile rules. + +.. note:: + This property is intended for internal use by :manual:`ctest(1)`. Projects + and developers should use the :prop_tgt:`_COMPILER_LAUNCHER` target + properties or the associated :variable:`CMAKE__COMPILER_LAUNCHER` + variables instead. + +See the :prop_gbl:`global property ` of the same name +for details. This overrides the global and directory property for a target. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst b/cmake/share/cmake-3.31/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst new file mode 100644 index 0000000000000000000000000000000000000000..766ddb9a06245d769408ee3d71c4b5f5ab5775e0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_CUSTOM +------------------ + +Specify a launcher for custom rules. + +See the global property of the same name for details. This overrides +the global and directory property for a target. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/RULE_LAUNCH_LINK.rst b/cmake/share/cmake-3.31/Help/prop_tgt/RULE_LAUNCH_LINK.rst new file mode 100644 index 0000000000000000000000000000000000000000..5ef42b1a0b825582fde00cf70a01a8ac65bbef84 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/RULE_LAUNCH_LINK.rst @@ -0,0 +1,13 @@ +RULE_LAUNCH_LINK +---------------- + +Specify a launcher for link rules. + +.. note:: + This property is intended for internal use by :manual:`ctest(1)`. Projects + and developers should use the :prop_tgt:`_LINKER_LAUNCHER` target + properties or the associated :variable:`CMAKE__LINKER_LAUNCHER` + variables instead. + +See the :prop_gbl:`global property ` of the same name for +details. This overrides the global and directory property for a target. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000000000000000000000000000000000000..98af73de04260b043acb83108d72e37a77db0b84 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst @@ -0,0 +1,9 @@ +RUNTIME_OUTPUT_DIRECTORY +------------------------ + +.. |XXX| replace:: :ref:`RUNTIME ` +.. |xxx| replace:: runtime +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_RUNTIME_OUTPUT_DIRECTORY` +.. include:: XXX_OUTPUT_DIRECTORY.txt + +See also the :prop_tgt:`RUNTIME_OUTPUT_DIRECTORY_` target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..8b03edd49973033b001f1bea16338051978f6abd --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,17 @@ +RUNTIME_OUTPUT_DIRECTORY_ +--------------------------------- + +Per-configuration output directory for +:ref:`RUNTIME ` target files. + +This is a per-configuration version of the +:prop_tgt:`RUNTIME_OUTPUT_DIRECTORY` target property, but +multi-configuration generators (:ref:`Visual Studio Generators`, +:generator:`Xcode`) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the +:variable:`CMAKE_RUNTIME_OUTPUT_DIRECTORY_` variable if +it is set when a target is created. + +Contents of ``RUNTIME_OUTPUT_DIRECTORY_`` may use +:manual:`generator expressions `. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..e15363420b86476b374b9a3d14d11f3c2613c236 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst @@ -0,0 +1,8 @@ +RUNTIME_OUTPUT_NAME +------------------- + +.. |XXX| replace:: :ref:`RUNTIME ` +.. |xxx| replace:: runtime +.. include:: XXX_OUTPUT_NAME.txt + +See also the :prop_tgt:`RUNTIME_OUTPUT_NAME_` target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..1b5a6596bcfa2190bb12c5641e8fe4ed18257558 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,8 @@ +RUNTIME_OUTPUT_NAME_ +---------------------------- + +Per-configuration output name for +:ref:`RUNTIME ` target files. + +This is the configuration-specific version of the +:prop_tgt:`RUNTIME_OUTPUT_NAME` target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/SKIP_BUILD_RPATH.rst b/cmake/share/cmake-3.31/Help/prop_tgt/SKIP_BUILD_RPATH.rst new file mode 100644 index 0000000000000000000000000000000000000000..755410ac27b835fb3837b2d630f102912e08d43e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/SKIP_BUILD_RPATH.rst @@ -0,0 +1,10 @@ +SKIP_BUILD_RPATH +---------------- + +Should rpaths be used for the build tree. + +``SKIP_BUILD_RPATH`` is a boolean specifying whether to skip automatic +generation of an rpath allowing the target to run from the build tree, +see also the :prop_tgt:`BUILD_RPATH` target property. +This property is initialized by the value of the variable +:variable:`CMAKE_SKIP_BUILD_RPATH` if it is set when a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/SOURCES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/SOURCES.rst new file mode 100644 index 0000000000000000000000000000000000000000..de5b45fb4bb834f61b45ee9533600198b07957c2 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/SOURCES.rst @@ -0,0 +1,38 @@ +SOURCES +------- + +This specifies the list of paths to source files for the target. +The following commands all set or add to the ``SOURCES`` target property +and are the usual way to manipulate it: + +* :command:`add_executable` +* :command:`add_library` +* :command:`add_custom_target` +* :command:`target_sources` + +Contents of ``SOURCES`` may use +:manual:`generator expressions `. +If a path starts with a generator expression, it is expected to +evaluate to an absolute path. Not doing so is considered undefined behavior. + +Paths that are for files generated by the build will be treated +as relative to the build directory of the target, if the path is not +already specified as an absolute path. Note that whether a file is seen as +generated may be affected by policies :policy:`CMP0118` and :policy:`CMP0163`. + +If a path does not start with a generator expression, is not an +absolute path and is not a generated file, it will be treated as relative to +the location selected by the first of the following that matches: + +* If a file by the specified path exists relative to the target's source + directory, use that file. +* If policy :policy:`CMP0115` is not set to ``NEW``, try appending each + known source file extension to the path and check if that exists + relative to the target's source directory. +* Repeat the above two steps, this time relative to the target's binary + directory instead. + +Note that the above decisions are made at generation time, not build time. + +See the :manual:`cmake-buildsystem(7)` manual for more on defining +buildsystem properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/SOURCE_DIR.rst b/cmake/share/cmake-3.31/Help/prop_tgt/SOURCE_DIR.rst new file mode 100644 index 0000000000000000000000000000000000000000..a419db2b735aa296c635fe080822e2f8418675f7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/SOURCE_DIR.rst @@ -0,0 +1,8 @@ +SOURCE_DIR +---------- + +.. versionadded:: 3.4 + +This read-only property reports the value of the +:variable:`CMAKE_CURRENT_SOURCE_DIR` variable in the directory in which +the target was defined. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/SOVERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/SOVERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..4cc5432f08e7a23b16d8be07ddcf4d80c908b244 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/SOVERSION.rst @@ -0,0 +1,39 @@ +SOVERSION +--------- + +ABI version number of a shared library target. + +For shared libraries :prop_tgt:`VERSION` and ``SOVERSION`` can be used to +specify the build version and ABI version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. +``SOVERSION`` is ignored if :prop_tgt:`NO_SONAME` property is set. + +.. include:: VERSION_SOVERSION_EXAMPLE.txt + +Windows Versions +^^^^^^^^^^^^^^^^ + +For shared libraries and executables on Windows the :prop_tgt:`VERSION` +attribute is parsed to extract a ``.`` version number. +These numbers are used as the image version of the binary. + +Mach-O Versions +^^^^^^^^^^^^^^^ + +For shared libraries and executables on Mach-O systems (e.g. macOS, iOS), +the ``SOVERSION`` property corresponds to the *compatibility version* and +:prop_tgt:`VERSION` corresponds to the *current version* (unless Mach-O +specific overrides are provided, as discussed below). +See the :prop_tgt:`FRAMEWORK` target property for an example. + +For shared libraries, the :prop_tgt:`MACHO_COMPATIBILITY_VERSION` and +:prop_tgt:`MACHO_CURRENT_VERSION` properties can be used to +override the *compatibility version* and *current version* respectively. +Note that ``SOVERSION`` will still be used to form the ``install_name`` +and both ``SOVERSION`` and :prop_tgt:`VERSION` may also affect the file +and symlink names. + +Versions of Mach-O binaries may be checked with the ``otool -L `` +command. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst new file mode 100644 index 0000000000000000000000000000000000000000..4a030277b40617e68a51716d80cdc94916bd4dea --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst @@ -0,0 +1,17 @@ +STATIC_LIBRARY_FLAGS +-------------------- + +Archiver (or MSVC librarian) flags for a static library target. +Targets that are shared libraries, modules, or executables need to use +the :prop_tgt:`LINK_OPTIONS` or :prop_tgt:`LINK_FLAGS` target properties. + +The ``STATIC_LIBRARY_FLAGS`` property, managed as a string, can be used to add +extra flags to the link step of a static library target. +:prop_tgt:`STATIC_LIBRARY_FLAGS_` will add to the configuration +````, for example, ``DEBUG``, ``RELEASE``, ``MINSIZEREL``, +``RELWITHDEBINFO``, ... + +.. note:: + + This property has been superseded by :prop_tgt:`STATIC_LIBRARY_OPTIONS` + property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..22faa9e19b4c331179b38275020553201437bb74 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst @@ -0,0 +1,12 @@ +STATIC_LIBRARY_FLAGS_ +----------------------------- + +Per-configuration archiver (or MSVC librarian) flags for a static library +target. + +This is the configuration-specific version of :prop_tgt:`STATIC_LIBRARY_FLAGS`. + +.. note:: + + This property has been superseded by :prop_tgt:`STATIC_LIBRARY_OPTIONS` + property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..447cd701e78fb80fd66fdde4a75299578a52e628 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst @@ -0,0 +1,24 @@ +STATIC_LIBRARY_OPTIONS +---------------------- + +.. versionadded:: 3.13 + +Archiver (or MSVC librarian) flags for a static library target. +Targets that are shared libraries, modules, or executables need to use +the :prop_tgt:`LINK_OPTIONS` target property. + +This property holds a :ref:`semicolon-separated list ` of options +specified so far for its target. Use :command:`set_target_properties` or +:command:`set_property` commands to set its content. + +Contents of ``STATIC_LIBRARY_OPTIONS`` may use "generator expressions" with the +syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual +for available expressions. See the :manual:`cmake-buildsystem(7)` manual +for more on defining buildsystem properties. + +.. note:: + + This property must be used in preference to :prop_tgt:`STATIC_LIBRARY_FLAGS` + property. + +.. include:: ../command/OPTIONS_SHELL.txt diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/SUFFIX.rst b/cmake/share/cmake-3.31/Help/prop_tgt/SUFFIX.rst new file mode 100644 index 0000000000000000000000000000000000000000..f36dfaba9afb03b23499389a9e59d359f22293bf --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/SUFFIX.rst @@ -0,0 +1,7 @@ +SUFFIX +------ + +What comes after the target name. + +A target property that can be set to override the suffix (such as +``.so`` or ``.exe``) on the name of a library, module or executable. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/SYSTEM.rst b/cmake/share/cmake-3.31/Help/prop_tgt/SYSTEM.rst new file mode 100644 index 0000000000000000000000000000000000000000..fd4d7d1576ac4c244d384f28a55cc44b30685c9a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/SYSTEM.rst @@ -0,0 +1,26 @@ +SYSTEM +------ + +.. versionadded:: 3.25 + +Specifies that a target is a system target. This has the following +effects: + +* Entries of :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` are treated as + system include directories when compiling consumers. + Entries of :prop_tgt:`INTERFACE_SYSTEM_INCLUDE_DIRECTORIES` are not + affected, and will always be treated as system include directories. +* On Apple platforms, If the :prop_tgt:`FRAMEWORK` target property is true, + the frameworks directory is treated as system. + +For imported targets, this property defaults to true, which means +that their :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` and, if the +:prop_tgt:`FRAMEWORK` target property is true, frameworks directory are +treated as system directories by default. If their ``SYSTEM`` property is +false, then their :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` as well as +frameworks will not be treated as system. Use the :prop_tgt:`EXPORT_NO_SYSTEM` +property to change how a target's ``SYSTEM`` property is set when it is +installed. + +For non-imported targets, this target property is initialized from +the :prop_dir:`SYSTEM` directory property when the target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/Swift_COMPILATION_MODE-VALUES.txt b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_COMPILATION_MODE-VALUES.txt new file mode 100644 index 0000000000000000000000000000000000000000..44a016cd12699efd5013d2dad8d5e44eb8aa2916 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_COMPILATION_MODE-VALUES.txt @@ -0,0 +1,19 @@ +``incremental`` + Compiles each Swift source in the module separately, resulting in better + parallelism in the build. The compiler emits additional information into + the build directory improving rebuild performance when small changes are made + to the source between rebuilds. This is the best option to use while + iterating on changes in a project. + +``wholemodule`` + Whole-module optimizations are slowest to compile, but results in the most + optimized library. The entire context is loaded into once instance of the + compiler, so there is no parallelism across source files in the module. + +``singlefile`` + Compiles each source in a Swift modules separately, resulting in better + parallelism. Unlike the ``incremental`` build mode, no additional information + is emitted by the compiler during the build, so rebuilding after making small + changes to the source file will not run faster. This option should be used + sparingly, preferring ``incremental`` builds, unless working around a compiler + bug. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/Swift_COMPILATION_MODE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_COMPILATION_MODE.rst new file mode 100644 index 0000000000000000000000000000000000000000..5f80d6fd40ee991daf2dbd12089f498fbb52c852 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_COMPILATION_MODE.rst @@ -0,0 +1,33 @@ +Swift_COMPILATION_MODE +---------------------- + +.. versionadded:: 3.29 + +Specify how Swift compiles a target. + +The allowed values are: + +.. include:: Swift_COMPILATION_MODE-VALUES.txt + +Use :manual:`generator expressions ` to support +per-configuration specification. For example, the code: + +.. code-block:: cmake + + add_library(foo foo.swift) + set_property(TARGET foo PROPERTY + Swift_COMPILATION_MODE "$,wholemodule,incremental>") + +sets the Swift compilation mode to wholemodule mode in the release configuration +and sets the property to incremental mode in other configurations. + +The property is initialized from the value of the +:variable:`CMAKE_Swift_COMPILATION_MODE` variable, if it is set. If the property +is not set or is empty, then CMake uses the default value ``incremental`` to +specify the swift compilation mode. + +.. note:: + + This property only has effect when policy :policy:`CMP0157` is set to ``NEW`` + prior to the first :command:`project` or :command:`enable_language` command + that enables the Swift language. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/Swift_DEPENDENCIES_FILE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_DEPENDENCIES_FILE.rst new file mode 100644 index 0000000000000000000000000000000000000000..8213a603ccb2f5dd2f343c8714c5ae1b0c346bc5 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_DEPENDENCIES_FILE.rst @@ -0,0 +1,7 @@ +Swift_DEPENDENCIES_FILE +----------------------- + +.. versionadded:: 3.15 + +This property sets the path for the Swift dependency file (swiftdep) for the +target. If one is not specified, it will default to ``.swiftdeps``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/Swift_LANGUAGE_VERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_LANGUAGE_VERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..7a04f89dc9fd6427b1738b20be04aadc95700f57 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_LANGUAGE_VERSION.rst @@ -0,0 +1,9 @@ +Swift_LANGUAGE_VERSION +---------------------- + +.. versionadded:: 3.16 + +This property sets the language version for the Swift sources in the target. If +one is not specified, it will default to +:variable:`CMAKE_Swift_LANGUAGE_VERSION` if specified, otherwise it is the +latest version supported by the compiler. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/Swift_MODULE_DIRECTORY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_MODULE_DIRECTORY.rst new file mode 100644 index 0000000000000000000000000000000000000000..5a2ea261dd277a305c8ddf8ea9b1a1116ca82789 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_MODULE_DIRECTORY.rst @@ -0,0 +1,24 @@ +Swift_MODULE_DIRECTORY +---------------------- + +.. versionadded:: 3.15 + +Specify output directory for Swift modules provided by the target. + +If the target contains Swift source files, this specifies the directory in which +the modules will be placed. When this property is not set, the modules will be +placed in the build directory corresponding to the target's source directory. +If the variable :variable:`CMAKE_Swift_MODULE_DIRECTORY` is set when a target is +created its value is used to initialize this property. + +.. warning:: + + This property does not currently provide a way to express per-config + module directories, so use with multi-config generators is problematic: + + * The :generator:`Xcode` generator does not implement the property at all. + + * The :generator:`Ninja Multi-Config` generator implements this property, + but module files generated for different build configurations have the + same path, which can lead to subtle problems when building more than + one configuration. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/Swift_MODULE_NAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_MODULE_NAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..1728feb8b864d8ff67c1c7472f1c629afb69cd93 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/Swift_MODULE_NAME.rst @@ -0,0 +1,7 @@ +Swift_MODULE_NAME +----------------- + +.. versionadded:: 3.15 + +This property specifies the name of the Swift module. It is defaulted to the +name of the target. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/TEST_LAUNCHER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/TEST_LAUNCHER.rst new file mode 100644 index 0000000000000000000000000000000000000000..3ca9fe3bfb68d59f27779583df9e58a0fdd958c2 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/TEST_LAUNCHER.rst @@ -0,0 +1,23 @@ +TEST_LAUNCHER +------------- + +.. versionadded:: 3.29 + +Use the given launcher to run executables. +This command will be added as a prefix to :command:`add_test` commands +for build target system executables and is meant to be run on the host +machine. + +It effectively acts as a run script for tests in a similar way +to how :variable:`CMAKE__COMPILER_LAUNCHER` works for compilation. + +If this property contains a :ref:`semicolon-separated list `, then the first value is the command and remaining values are its +arguments. + +Contents of ``TEST_LAUNCHER`` may use +:manual:`generator expressions `. + +This property is initialized by the value of the +:variable:`CMAKE_TEST_LAUNCHER` variable if it is set when a target +is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/TRANSITIVE_COMPILE_PROPERTIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/TRANSITIVE_COMPILE_PROPERTIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..b0d9ddb40a3acd3c8f99538fab515c745a68d848 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/TRANSITIVE_COMPILE_PROPERTIES.rst @@ -0,0 +1,19 @@ +TRANSITIVE_COMPILE_PROPERTIES +----------------------------- + +.. versionadded:: 3.30 + +Properties that the :genex:`TARGET_PROPERTY` generator expression, on the +target and its dependents, evaluates as the union of values collected from +the transitive closure of link dependencies, excluding entries guarded by +:genex:`LINK_ONLY`. + +The value is a :ref:`semicolon-separated list ` +of :ref:`custom transitive property ` names. +Any leading ``INTERFACE_`` prefix is ignored, e.g., ``INTERFACE_PROP`` is +treated as just ``PROP``. + +See documentation of the :genex:`TARGET_PROPERTY` generator expression +for details of custom transitive property evaluation. See also the +:prop_tgt:`TRANSITIVE_LINK_PROPERTIES` target property, which includes +entries guarded by :genex:`LINK_ONLY`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/TRANSITIVE_LINK_PROPERTIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/TRANSITIVE_LINK_PROPERTIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..98352777d2fbb0ad3573c22ba75628c13a1a767c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/TRANSITIVE_LINK_PROPERTIES.rst @@ -0,0 +1,19 @@ +TRANSITIVE_LINK_PROPERTIES +-------------------------- + +.. versionadded:: 3.30 + +Properties that the :genex:`TARGET_PROPERTY` generator expression, on the +target and its dependents, evaluates as the union of values collected from +the transitive closure of link dependencies, including entries guarded by +:genex:`LINK_ONLY`. + +The value is a :ref:`semicolon-separated list ` +of :ref:`custom transitive property ` names. +Any leading ``INTERFACE_`` prefix is ignored, e.g., ``INTERFACE_PROP`` is +treated as just ``PROP``. + +See documentation of the :genex:`TARGET_PROPERTY` generator expression +for details of custom transitive property evaluation. See also the +:prop_tgt:`TRANSITIVE_COMPILE_PROPERTIES` target property, which excludes +entries guarded by :genex:`LINK_ONLY`.. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/TYPE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/TYPE.rst new file mode 100644 index 0000000000000000000000000000000000000000..ea83ac71f940e6d2213e59a4c77e344463cce428 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/TYPE.rst @@ -0,0 +1,9 @@ +TYPE +---- + +The type of the target. + +This read-only property can be used to test the type of the given +target. It will be one of ``STATIC_LIBRARY``, ``MODULE_LIBRARY``, +``SHARED_LIBRARY``, ``OBJECT_LIBRARY``, ``INTERFACE_LIBRARY``, ``EXECUTABLE`` +or one of the internal target types. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD.rst new file mode 100644 index 0000000000000000000000000000000000000000..a4bbadb66190bc874b638c8574b137b94a23ff06 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD.rst @@ -0,0 +1,107 @@ +UNITY_BUILD +----------- + +.. versionadded:: 3.16 + +When this property is set to true, the target source files will be combined +into batches for faster compilation. This is done by creating a (set of) +unity sources which ``#include`` the original sources, then compiling these +unity sources instead of the originals. This is known as a *Unity* or *Jumbo* +build. + +CMake provides different algorithms for selecting which sources are grouped +together into a *bucket*. Algorithm selection is decided by the +:prop_tgt:`UNITY_BUILD_MODE` target property, which has the following acceptable +values: + +* ``BATCH`` + When in this mode CMake determines which files are grouped together. + The :prop_tgt:`UNITY_BUILD_BATCH_SIZE` property controls the upper limit on + how many sources can be combined per unity source file. + +* ``GROUP`` + When in this mode each target explicitly specifies how to group + source files. Each source file that has the same + :prop_sf:`UNITY_GROUP` value will be grouped together. Any sources + that don't have this property will be compiled individually. The + :prop_tgt:`UNITY_BUILD_BATCH_SIZE` property is ignored when using + this mode. + +If no explicit :prop_tgt:`UNITY_BUILD_MODE` has been specified, CMake will +default to ``BATCH``. + +Unity builds are supported for the following languages: + +``C`` + .. versionadded:: 3.16 + +``CXX`` + .. versionadded:: 3.16 + +``CUDA`` + .. versionadded:: 3.31 + +``OBJC`` + .. versionadded:: 3.29 + +``OBJCXX`` + .. versionadded:: 3.29 + +For targets that mix source files from more than one language, CMake +separates the languages such that each generated unity source file only +contains sources for a single language. + +This property is initialized by the value of the :variable:`CMAKE_UNITY_BUILD` +variable when a target is created. + +.. note:: + + Projects should not directly set the ``UNITY_BUILD`` property or its + associated :variable:`CMAKE_UNITY_BUILD` variable to true. Depending + on the capabilities of the build machine and compiler used, it might or + might not be appropriate to enable unity builds. Therefore, this feature + should be under developer control, which would normally be through the + developer choosing whether or not to set the :variable:`CMAKE_UNITY_BUILD` + variable on the :manual:`cmake(1)` command line or some other equivalent + method. However, it IS recommended to set the ``UNITY_BUILD`` target + property to false if it is known that enabling unity builds for the + target can lead to problems. + +ODR (One definition rule) errors +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +When multiple source files are included into one source file, as is done +for unity builds, it can potentially lead to ODR errors. CMake provides +a number of measures to help address such problems: + +* Any source file that has a non-empty :prop_sf:`COMPILE_OPTIONS`, + :prop_sf:`COMPILE_DEFINITIONS`, :prop_sf:`COMPILE_FLAGS`, or + :prop_sf:`INCLUDE_DIRECTORIES` source property will not be combined + into a unity source. + +* Any source file which is scanned for C++ module sources via + :prop_tgt:`CXX_SCAN_FOR_MODULES`, :prop_sf:`CXX_SCAN_FOR_MODULES`, or + membership of a ``CXX_MODULES`` file set will not be combined into a unity + source. See :manual:`cmake-cxxmodules(7)` for details. + +* Projects can prevent an individual source file from being combined into + a unity source by setting its :prop_sf:`SKIP_UNITY_BUILD_INCLUSION` + source property to true. This can be a more effective way to prevent + problems with specific files than disabling unity builds for an entire + target. + +* Projects can set :prop_tgt:`UNITY_BUILD_UNIQUE_ID` to cause a valid + C-identifier to be generated which is unique per file in a unity + build. This can be used to avoid problems with anonymous namespaces + in unity builds. + +* The :prop_tgt:`UNITY_BUILD_CODE_BEFORE_INCLUDE` and + :prop_tgt:`UNITY_BUILD_CODE_AFTER_INCLUDE` target properties can be used + to inject code into the unity source files before and after every + ``#include`` statement. + +* The order of source files added to the target via commands like + :command:`add_library`, :command:`add_executable` or + :command:`target_sources` will be preserved in the generated unity source + files. This can be used to manually enforce a specific grouping based on + the :prop_tgt:`UNITY_BUILD_BATCH_SIZE` target property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_BATCH_SIZE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_BATCH_SIZE.rst new file mode 100644 index 0000000000000000000000000000000000000000..dfa9050d87473bbc915b23ced92edbd58f61d759 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_BATCH_SIZE.rst @@ -0,0 +1,25 @@ +UNITY_BUILD_BATCH_SIZE +---------------------- + +.. versionadded:: 3.16 + +Specifies the maximum number of source files that can be combined into any one +unity source file when unity builds are enabled by the :prop_tgt:`UNITY_BUILD` +target property. The original source files will be distributed across as many +unity source files as necessary to honor this limit. + +The initial value for this property is taken from the +:variable:`CMAKE_UNITY_BUILD_BATCH_SIZE` variable when the target is created. +If that variable has not been set, the initial value will be 8. + +The batch size needs to be selected carefully. If set too high, the size of +the combined source files could result in the compiler using excessive memory +or hitting other similar limits. In extreme cases, this can even result in +build failure. On the other hand, if the batch size is too low, there will be +little gain in build performance. + +Although strongly discouraged, the batch size may be set to a value of 0 to +combine all the sources for the target into a single unity file, regardless of +how many sources are involved. This runs the risk of creating an excessively +large unity source file and negatively impacting the build performance, so +a value of 0 is not generally recommended. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_CODE_AFTER_INCLUDE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_CODE_AFTER_INCLUDE.rst new file mode 100644 index 0000000000000000000000000000000000000000..e8fc8ba8be0f283e8c0be002b490cc734d3089c6 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_CODE_AFTER_INCLUDE.rst @@ -0,0 +1,21 @@ +UNITY_BUILD_CODE_AFTER_INCLUDE +------------------------------ + +.. versionadded:: 3.16 + +Code snippet which is included verbatim by the :prop_tgt:`UNITY_BUILD` +feature just after every ``#include`` statement in the generated unity +source files. For example: + +.. code-block:: cmake + + set(after [[ + #if defined(NOMINMAX) + #undef NOMINMAX + #endif + ]]) + set_target_properties(myTarget PROPERTIES + UNITY_BUILD_CODE_AFTER_INCLUDE "${after}" + ) + +See also :prop_tgt:`UNITY_BUILD_CODE_BEFORE_INCLUDE`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_CODE_BEFORE_INCLUDE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_CODE_BEFORE_INCLUDE.rst new file mode 100644 index 0000000000000000000000000000000000000000..eabb1f21aa617acf8133e3fe5dffb816610b7be8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_CODE_BEFORE_INCLUDE.rst @@ -0,0 +1,21 @@ +UNITY_BUILD_CODE_BEFORE_INCLUDE +------------------------------- + +.. versionadded:: 3.16 + +Code snippet which is included verbatim by the :prop_tgt:`UNITY_BUILD` +feature just before every ``#include`` statement in the generated unity +source files. For example: + +.. code-block:: cmake + + set(before [[ + #if !defined(NOMINMAX) + #define NOMINMAX + #endif + ]]) + set_target_properties(myTarget PROPERTIES + UNITY_BUILD_CODE_BEFORE_INCLUDE "${before}" + ) + +See also :prop_tgt:`UNITY_BUILD_CODE_AFTER_INCLUDE`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_MODE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_MODE.rst new file mode 100644 index 0000000000000000000000000000000000000000..9e68ac14da72d6d7cf09cd9a983ea5c6a80c02a9 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_MODE.rst @@ -0,0 +1,60 @@ +UNITY_BUILD_MODE +---------------- + +.. versionadded:: 3.18 + +CMake provides different algorithms for selecting which sources are grouped +together into a *bucket*. Selection is decided by this property, +which has the following acceptable values: + +``BATCH`` + When in this mode CMake determines which files are grouped together. + The :prop_tgt:`UNITY_BUILD_BATCH_SIZE` property controls the upper limit on + how many sources can be combined per unity source file. + + Example usage: + + .. code-block:: cmake + + add_library(example_library + source1.cxx + source2.cxx + source3.cxx + source4.cxx) + + set_target_properties(example_library PROPERTIES + UNITY_BUILD_MODE BATCH + UNITY_BUILD_BATCH_SIZE 2 + ) + +``GROUP`` + When in this mode each target explicitly specifies how to group + source files. Each source file that has the same + :prop_sf:`UNITY_GROUP` value will be grouped together. Any sources + that don't have this property will be compiled individually. The + :prop_tgt:`UNITY_BUILD_BATCH_SIZE` property is ignored when using + this mode. + + Example usage: + + .. code-block:: cmake + + add_library(example_library + source1.cxx + source2.cxx + source3.cxx + source4.cxx) + + set_target_properties(example_library PROPERTIES + UNITY_BUILD_MODE GROUP + ) + + set_source_files_properties(source1.cxx source2.cxx source3.cxx + PROPERTIES UNITY_GROUP "bucket1" + ) + set_source_files_properties(source4.cxx + PROPERTIES UNITY_GROUP "bucket2" + ) + +If no explicit ``UNITY_BUILD_MODE`` has been specified, CMake will +default to ``BATCH``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_UNIQUE_ID.rst b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_UNIQUE_ID.rst new file mode 100644 index 0000000000000000000000000000000000000000..c4280fe215bae8602e7bc8ed6523fb2af80e8ac5 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/UNITY_BUILD_UNIQUE_ID.rst @@ -0,0 +1,55 @@ +UNITY_BUILD_UNIQUE_ID +--------------------- + +.. versionadded:: 3.20 + +The name of a valid C-identifier which is set to a unique per-file +value during unity builds. + +When this property is populated and when :prop_tgt:`UNITY_BUILD` +is true, the property value is used to define a compiler definition +of the specified name. The value of the defined symbol is unspecified, +but it is unique per file path. + +Given: + +.. code-block:: cmake + + set_target_properties(myTarget PROPERTIES + UNITY_BUILD "ON" + UNITY_BUILD_UNIQUE_ID "MY_UNITY_ID" + ) + +the ``MY_UNITY_ID`` symbol is defined to a unique per-file value. + +One known use case for this identifier is to disambiguate the +variables in an anonymous namespace in a limited scope. +Anonymous namespaces present a problem for unity builds because +they are used to ensure that certain variables and declarations +are scoped to a translation unit which is approximated by a +single source file. When source files are combined in a unity +build file, those variables in different files are combined in +a single translation unit and the names clash. This property can +be used to avoid that with code like the following: + +.. code-block:: cpp + + // Needed for when unity builds are disabled + #ifndef MY_UNITY_ID + #define MY_UNITY_ID + #endif + + namespace { namespace MY_UNITY_ID { + // The name 'i' clashes (or could clash) with other + // variables in other anonymous namespaces + int i = 42; + }} + + int use_var() + { + return MY_UNITY_ID::i; + } + +The pseudonymous namespace is used within a truly anonymous namespace. +On many platforms, this maintains the invariant that the symbols within +do not get external linkage when performing a unity build. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VERIFY_INTERFACE_HEADER_SETS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VERIFY_INTERFACE_HEADER_SETS.rst new file mode 100644 index 0000000000000000000000000000000000000000..b2b1cacb9b63bfe971724815071b45a94dc096d0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VERIFY_INTERFACE_HEADER_SETS.rst @@ -0,0 +1,41 @@ +VERIFY_INTERFACE_HEADER_SETS +---------------------------- + +.. versionadded:: 3.24 + +Used to verify that all headers in a target's ``PUBLIC`` and ``INTERFACE`` +header sets can be included on their own. + +When this property is set to true, and the target is an object library, static +library, shared library, interface library, or executable with exports enabled, +and the target has one or more ``PUBLIC`` or ``INTERFACE`` header sets, an +object library target named ``_verify_interface_header_sets`` is +created. This verification target has one source file per header in the +``PUBLIC`` and ``INTERFACE`` header sets. Each source file only includes its +associated header file. The verification target links against the original +target to get all of its usage requirements. The verification target has its +:prop_tgt:`EXCLUDE_FROM_ALL` and :prop_tgt:`DISABLE_PRECOMPILE_HEADERS` +properties set to true, and its :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTORCC`, +:prop_tgt:`AUTOUIC`, and :prop_tgt:`UNITY_BUILD` properties set to false. + +If the header's :prop_sf:`LANGUAGE` property is set, the value of that property +is used to determine the language with which to compile the header file. +Otherwise, if the target has any C++ sources, the header is compiled as C++. +Otherwise, if the target has any C sources, the header is compiled as C. +Otherwise, if C++ is enabled globally, the header is compiled as C++. +Otherwise, if C is enabled globally, the header is compiled as C. Otherwise, +the header file is not compiled. + +If the header's :prop_sf:`SKIP_LINTING` property is set to true, the file is +not compiled. + +If any verification targets are created, a top-level target called +``all_verify_interface_header_sets`` is created which depends on all +verification targets. + +This property is initialized by the value of the +:variable:`CMAKE_VERIFY_INTERFACE_HEADER_SETS` variable if it is set when +a target is created. + +If the project wishes to control which header sets are verified by this +property, it can set :prop_tgt:`INTERFACE_HEADER_SETS_TO_VERIFY`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..1b6a4730fa3c16b39b32a018352848b2480cf590 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VERSION.rst @@ -0,0 +1,41 @@ +VERSION +------- + +Version number of a shared library target. + +For shared libraries ``VERSION`` and :prop_tgt:`SOVERSION` can be used +to specify the build version and ABI version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. For +executables ``VERSION`` can be used to specify the build version. When +building or installing appropriate symlinks are created if the +platform supports symlinks. + +.. include:: VERSION_SOVERSION_EXAMPLE.txt + +Windows Versions +^^^^^^^^^^^^^^^^ + +For shared libraries and executables on Windows the ``VERSION`` +attribute is parsed to extract a ``.`` version number. +These numbers are used as the image version of the binary. + +Mach-O Versions +^^^^^^^^^^^^^^^ + +For shared libraries and executables on Mach-O systems (e.g. macOS, iOS), +the :prop_tgt:`SOVERSION` property corresponds to the *compatibility version* +and ``VERSION`` corresponds to the *current version* (unless Mach-O specific +overrides are provided, as discussed below). +See the :prop_tgt:`FRAMEWORK` target property for an example. + +For shared libraries, the :prop_tgt:`MACHO_COMPATIBILITY_VERSION` and +:prop_tgt:`MACHO_CURRENT_VERSION` properties can be used to +override the *compatibility version* and *current version* respectively. +Note that :prop_tgt:`SOVERSION` will still be used to form the +``install_name`` and both :prop_tgt:`SOVERSION` and ``VERSION`` may also +affect the file and symlink names. + +Versions of Mach-O binaries may be checked with the ``otool -L `` +command. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VERSION_SOVERSION_EXAMPLE.txt b/cmake/share/cmake-3.31/Help/prop_tgt/VERSION_SOVERSION_EXAMPLE.txt new file mode 100644 index 0000000000000000000000000000000000000000..6c8aa2c0ce7283402e6d47b92d4845c13eb20c6b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VERSION_SOVERSION_EXAMPLE.txt @@ -0,0 +1,9 @@ +A common convention is to specify both ``VERSION`` and ``SOVERSION`` +such that ``SOVERSION`` matches the first component of ``VERSION``: + +.. code-block:: cmake + + set_target_properties(mylib PROPERTIES VERSION 1.2.3 SOVERSION 1) + +The idea is that breaking changes to the ABI increment both the +``SOVERSION`` and the major ``VERSION`` number. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst new file mode 100644 index 0000000000000000000000000000000000000000..cbfaf85eb10b7976e34f7a26d83a972580cd6536 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst @@ -0,0 +1,13 @@ +VISIBILITY_INLINES_HIDDEN +------------------------- + +Whether to add a compile flag to hide symbols of inline functions + +The ``VISIBILITY_INLINES_HIDDEN`` property determines whether a flag for +hiding symbols for inline functions, such as ``-fvisibility-inlines-hidden``, +should be used when invoking the compiler. This property affects compilation +in sources of all types of targets (subject to policy :policy:`CMP0063`). + +This property is initialized by +the value of the :variable:`CMAKE_VISIBILITY_INLINES_HIDDEN` variable if it +is set when a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_CONFIGURATION_TYPE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_CONFIGURATION_TYPE.rst new file mode 100644 index 0000000000000000000000000000000000000000..b7edbb22356031a6e2547b91304f3d8b3169e4e0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_CONFIGURATION_TYPE.rst @@ -0,0 +1,14 @@ +VS_CONFIGURATION_TYPE +--------------------- + +.. versionadded:: 3.6 + +Visual Studio project configuration type. + +Sets the ``ConfigurationType`` attribute for a generated Visual Studio project. +The property value may use +:manual:`generator expressions `. +If this property is set, it overrides the default setting that is based on the +target type (e.g. ``StaticLibrary``, ``Application``, ...). + +Supported on :ref:`Visual Studio Generators` for VS 2010 and higher. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_COMMAND.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_COMMAND.rst new file mode 100644 index 0000000000000000000000000000000000000000..e888299c7fcb7c966005864c9ec5ae8e25210f0e --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_COMMAND.rst @@ -0,0 +1,15 @@ +VS_DEBUGGER_COMMAND +------------------- + +.. versionadded:: 3.12 + +Sets the local debugger command for Visual Studio C++ targets. +The property value may use +:manual:`generator expressions `. +This is defined in ```` in the Visual Studio +project file. This property is initialized by the value of the variable +:variable:`CMAKE_VS_DEBUGGER_COMMAND` if it is set when a target is +created. + +This property only works for :ref:`Visual Studio Generators`; +it is ignored on other generators. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_COMMAND_ARGUMENTS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_COMMAND_ARGUMENTS.rst new file mode 100644 index 0000000000000000000000000000000000000000..92de3d475f7d1e43a883a26d2b52a7d436152007 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_COMMAND_ARGUMENTS.rst @@ -0,0 +1,15 @@ +VS_DEBUGGER_COMMAND_ARGUMENTS +----------------------------- + +.. versionadded:: 3.13 + +Sets the local debugger command line arguments for Visual Studio C++ targets. +The property value may use +:manual:`generator expressions `. +This is defined in ```` in the Visual Studio +project file. This property is initialized by the value of the variable +:variable:`CMAKE_VS_DEBUGGER_COMMAND_ARGUMENTS` if it is set when a target is +created. + +This property only works for :ref:`Visual Studio Generators`; +it is ignored on other generators. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_ENVIRONMENT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_ENVIRONMENT.rst new file mode 100644 index 0000000000000000000000000000000000000000..ed94963cb90f915bb12f4860ba4e6b193f60fd0f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_ENVIRONMENT.rst @@ -0,0 +1,15 @@ +VS_DEBUGGER_ENVIRONMENT +----------------------- + +.. versionadded:: 3.13 + +Sets the local debugger environment for Visual Studio C++ targets. +The property value may use +:manual:`generator expressions `. +This is defined in ```` in the Visual Studio +project file. This property is initialized by the value of the variable +:variable:`CMAKE_VS_DEBUGGER_ENVIRONMENT` if it is set when a target is +created. + +This property only works for :ref:`Visual Studio Generators`; +it is ignored on other generators. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst new file mode 100644 index 0000000000000000000000000000000000000000..8a189b86fa6a0022b5cca4192752de883fb6f431 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst @@ -0,0 +1,15 @@ +VS_DEBUGGER_WORKING_DIRECTORY +----------------------------- + +.. versionadded:: 3.8 + +Sets the local debugger working directory for Visual Studio C++ targets. +The property value may use +:manual:`generator expressions `. +This is defined in ```` in the Visual Studio +project file. This property is initialized by the value of the variable +:variable:`CMAKE_VS_DEBUGGER_WORKING_DIRECTORY` if it is set when a target is +created. + +This property only works for :ref:`Visual Studio Generators`; +it is ignored on other generators. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DESKTOP_EXTENSIONS_VERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DESKTOP_EXTENSIONS_VERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..3d02395d4859406cfc6cb1d90da3c867eeb24a56 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DESKTOP_EXTENSIONS_VERSION.rst @@ -0,0 +1,12 @@ +VS_DESKTOP_EXTENSIONS_VERSION +----------------------------- + +.. versionadded:: 3.4 + +Visual Studio Windows 10 Desktop Extensions Version + +Specifies the version of the Desktop Extensions that should be included in the +target. For example ``10.0.10240.0``. If the value is not specified, the Desktop +Extensions will not be included. To use the same version of the extensions as +the Windows 10 SDK that is being used, you can use the +:variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION` variable. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_DOCUMENTATION_FILE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_DOCUMENTATION_FILE.rst new file mode 100644 index 0000000000000000000000000000000000000000..9d97265231f12dbc54a1ae0dea87838216698bf9 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_DOCUMENTATION_FILE.rst @@ -0,0 +1,8 @@ +VS_DOTNET_DOCUMENTATION_FILE +---------------------------- + +.. versionadded:: 3.17 + +Visual Studio managed project .NET documentation output + +Sets the target XML documentation file output. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCEPROP_refname_TAG_tagname.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCEPROP_refname_TAG_tagname.rst new file mode 100644 index 0000000000000000000000000000000000000000..101cd5999015913af6789694d5d98f7628c94e30 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCEPROP_refname_TAG_tagname.rst @@ -0,0 +1,16 @@ +VS_DOTNET_REFERENCEPROP__TAG_ +----------------------------------------------- + +.. versionadded:: 3.10 + +Defines an XML property ```` for a .NET reference +````. + +Reference properties can be set for .NET references which are +defined by the target properties :prop_tgt:`VS_DOTNET_REFERENCES`, +:prop_tgt:`VS_DOTNET_REFERENCE_` +and also for project references to other C# targets which are +established by :command:`target_link_libraries()`. + +This property is only applicable to C# targets and Visual Studio +generators 2010 and later. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCES.rst new file mode 100644 index 0000000000000000000000000000000000000000..b53b774fccf5a51a862830b4d4d839323c0e76f0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCES.rst @@ -0,0 +1,7 @@ +VS_DOTNET_REFERENCES +-------------------- + +Visual Studio managed project .NET references + +Adds one or more semicolon-delimited .NET references to a generated +Visual Studio project. For example, "System;System.Windows.Forms". diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCES_COPY_LOCAL.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCES_COPY_LOCAL.rst new file mode 100644 index 0000000000000000000000000000000000000000..3609b588656fdb05758c4f66a12360dbf51f94d7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCES_COPY_LOCAL.rst @@ -0,0 +1,9 @@ +VS_DOTNET_REFERENCES_COPY_LOCAL +------------------------------- + +.. versionadded:: 3.8 + +Sets the **Copy Local** property for all .NET hint references in the target + +Boolean property to enable/disable copying of .NET hint references to +output directory. The default is ``ON``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCE_refname.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCE_refname.rst new file mode 100644 index 0000000000000000000000000000000000000000..0b1932917acb26c09b14a1b8e4f677ad94cb1bec --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_REFERENCE_refname.rst @@ -0,0 +1,14 @@ +VS_DOTNET_REFERENCE_ +----------------------------- + +.. versionadded:: 3.8 + +Visual Studio managed project .NET reference with name ```` +and hint path. + +Adds one .NET reference to generated Visual Studio project. The +reference will have the name ```` and will point to the +assembly given as value of the property. + +See also :prop_tgt:`VS_DOTNET_REFERENCES` and +:prop_tgt:`VS_DOTNET_REFERENCES_COPY_LOCAL` diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_STARTUP_OBJECT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_STARTUP_OBJECT.rst new file mode 100644 index 0000000000000000000000000000000000000000..6c39c5ba46f8960599ecdb2da2c2fa89a1a1122c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_STARTUP_OBJECT.rst @@ -0,0 +1,21 @@ +VS_DOTNET_STARTUP_OBJECT +------------------------ + +.. versionadded:: 3.24 + +Sets the startup object property in Visual Studio .NET targets. +The property value defines a full qualified class name (including package +name), for example: ``MyCompany.Package.MyStarterClass``. + +If the property is unset, Visual Studio uses the first matching +``static void Main(string[])`` function signature by default. When more +than one ``Main()`` method is available in the current project, the property +becomes mandatory for building the project. + +This property only works for :ref:`Visual Studio Generators`; +it is ignored on other generators. + +.. code-block:: cmake + + set_property(TARGET ${TARGET_NAME} PROPERTY + VS_DOTNET_STARTUP_OBJECT "MyCompany.Package.MyStarterClass") diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..6e2a61f5cb702468dab801f07575110670e197ca --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst @@ -0,0 +1,11 @@ +VS_DOTNET_TARGET_FRAMEWORK_VERSION +---------------------------------- + +Specify the .NET target framework version. + +Used to specify the .NET target framework version for C++/CLI. For +example, "v4.5". + +This property is deprecated and should not be used anymore. Use +:prop_tgt:`DOTNET_TARGET_FRAMEWORK` or +:prop_tgt:`DOTNET_TARGET_FRAMEWORK_VERSION` instead. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_DPI_AWARE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DPI_AWARE.rst new file mode 100644 index 0000000000000000000000000000000000000000..6598cc132f2b82f3d599ace70fe1955efcd473e2 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_DPI_AWARE.rst @@ -0,0 +1,16 @@ +VS_DPI_AWARE +------------ + +.. versionadded:: 3.16 + +Set the Manifest Tool -> Input and Output -> DPI Awareness in the Visual Studio +target project properties. + +Valid values are ``PerMonitor``, ``ON``, or ``OFF``. + +For example: + +.. code-block:: cmake + + add_executable(myproject myproject.cpp) + set_property(TARGET myproject PROPERTY VS_DPI_AWARE "PerMonitor") diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_FILTER_PROPS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_FILTER_PROPS.rst new file mode 100644 index 0000000000000000000000000000000000000000..69b09fa30380dddfb2103c27eea2ce4b1c61d124 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_FILTER_PROPS.rst @@ -0,0 +1,10 @@ +VS_FILTER_PROPS +--------------- + +.. versionadded:: 3.30 + +Sets the filter props file to be included in the visual studio +C++ project filter file. + +The ``*.filter.props`` files can be used for Visual Studio wide +configuration which is independent from cmake. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_FRAMEWORK_REFERENCES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_FRAMEWORK_REFERENCES.rst new file mode 100644 index 0000000000000000000000000000000000000000..74c5a2a7fded1987038636768796a52c0008e3d6 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_FRAMEWORK_REFERENCES.rst @@ -0,0 +1,12 @@ +VS_FRAMEWORK_REFERENCES +----------------------- + +.. versionadded:: 3.31 + +Visual Studio framework references. +Specify a :ref:`semicolon-separated list ` of framework references +to be added to a generated Visual Studio project. For example: + +* "Microsoft.WindowsDesktop.App.WPF" for WPF applications +* "Microsoft.WindowsDesktop.App.WindowsForms" for WinForms applications +* "Microsoft.WindowsDesktop.App" for applications using both frameworks diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst new file mode 100644 index 0000000000000000000000000000000000000000..b284f7a577280876d65ec3fc67365d9e4fdd9946 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst @@ -0,0 +1,9 @@ +VS_GLOBAL_KEYWORD +----------------- + +Visual Studio project keyword. + +Sets the "keyword" attribute for a generated Visual Studio project. +Defaults to "Win32Proj". You may wish to override this value with +"ManagedCProj", for example, in a Visual Studio managed C++ unit test +project. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst new file mode 100644 index 0000000000000000000000000000000000000000..ba635a451309a611f44e963d9952b2e7b191f47b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst @@ -0,0 +1,15 @@ +VS_GLOBAL_PROJECT_TYPES +----------------------- + +Visual Studio project type(s). + +Can be set to one or more UUIDs recognized by Visual Studio to +indicate the type of project. This value is copied verbatim into the +generated project file. Example for a managed C++ unit testing +project: + +:: + + {3AC096D0-A1C2-E12C-1390-A8335801FDAB};{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942} + +UUIDs are semicolon-delimited. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst new file mode 100644 index 0000000000000000000000000000000000000000..a1791d7142848a015471f4335100c0dad9c0941c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst @@ -0,0 +1,7 @@ +VS_GLOBAL_ROOTNAMESPACE +----------------------- + +Visual Studio project root namespace. + +Sets the "RootNamespace" attribute for a generated Visual Studio +project. The attribute will be generated only if this is set. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_variable.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_variable.rst new file mode 100644 index 0000000000000000000000000000000000000000..f098f2668b2380b58c3e05fcea15833a66bf7d92 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_GLOBAL_variable.rst @@ -0,0 +1,10 @@ +VS_GLOBAL_ +-------------------- + +Visual Studio project-specific global variable. + +Tell the Visual Studio generator to set the global variable +'' to a given value in the generated Visual Studio project. +Ignored on other generators. Qt integration works better if +VS_GLOBAL_QtVersion is set to the version FindQt4.cmake found. For +example, "4.7.3" diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_IOT_EXTENSIONS_VERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_IOT_EXTENSIONS_VERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..74ffe660c5160a9cc2b18200b3a18aeb7a927e86 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_IOT_EXTENSIONS_VERSION.rst @@ -0,0 +1,12 @@ +VS_IOT_EXTENSIONS_VERSION +------------------------- + +.. versionadded:: 3.4 + +Visual Studio Windows 10 IoT Extensions Version + +Specifies the version of the IoT Extensions that should be included in the +target. For example ``10.0.10240.0``. If the value is not specified, the IoT +Extensions will not be included. To use the same version of the extensions as +the Windows 10 SDK that is being used, you can use the +:variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION` variable. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_IOT_STARTUP_TASK.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_IOT_STARTUP_TASK.rst new file mode 100644 index 0000000000000000000000000000000000000000..4db0fdd1ae64b8e91ea38cf8079b5eb6256e2f65 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_IOT_STARTUP_TASK.rst @@ -0,0 +1,8 @@ +VS_IOT_STARTUP_TASK +------------------- + +.. versionadded:: 3.4 + +Visual Studio Windows 10 IoT Continuous Background Task + +Specifies that the target should be compiled as a Continuous Background Task library. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_JUST_MY_CODE_DEBUGGING.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_JUST_MY_CODE_DEBUGGING.rst new file mode 100644 index 0000000000000000000000000000000000000000..700eed14d30c57f05cd6cbe1c1e9e69c120f7402 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_JUST_MY_CODE_DEBUGGING.rst @@ -0,0 +1,12 @@ +VS_JUST_MY_CODE_DEBUGGING +------------------------- + +.. versionadded:: 3.15 + +Enable Just My Code with Visual Studio debugger. + +Supported on :ref:`Visual Studio Generators` for VS 2010 and higher, +:ref:`Makefile Generators` and the :generator:`Ninja` generators. + +This property is initialized by the :variable:`CMAKE_VS_JUST_MY_CODE_DEBUGGING` +variable if it is set when a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_KEYWORD.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_KEYWORD.rst new file mode 100644 index 0000000000000000000000000000000000000000..865f327e0421603514156e134f9e79a83de62ebe --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_KEYWORD.rst @@ -0,0 +1,9 @@ +VS_KEYWORD +---------- + +Removed. This once specified the Visual Studio project keyword +for the :generator:`Visual Studio 9 2008` generator, and older, +but all of those generators have been removed. + +Use the :prop_tgt:`VS_GLOBAL_KEYWORD` target property to set the +keyword for remaining :ref:`Visual Studio Generators`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_MOBILE_EXTENSIONS_VERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_MOBILE_EXTENSIONS_VERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..e1f83c494bdeb95e623c55e48f1d8228821f3100 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_MOBILE_EXTENSIONS_VERSION.rst @@ -0,0 +1,12 @@ +VS_MOBILE_EXTENSIONS_VERSION +---------------------------- + +.. versionadded:: 3.4 + +Visual Studio Windows 10 Mobile Extensions Version + +Specifies the version of the Mobile Extensions that should be included in the +target. For example ``10.0.10240.0``. If the value is not specified, the Mobile +Extensions will not be included. To use the same version of the extensions as +the Windows 10 SDK that is being used, you can use the +:variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION` variable. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_NO_COMPILE_BATCHING.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_NO_COMPILE_BATCHING.rst new file mode 100644 index 0000000000000000000000000000000000000000..20904d56ec34b5defefd6564fb509f219fc10e3f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_NO_COMPILE_BATCHING.rst @@ -0,0 +1,24 @@ +VS_NO_COMPILE_BATCHING +---------------------- + +.. versionadded:: 3.24 + +Turn off compile batching for the target. Usually MSBuild calls the compiler +with multiple c/cpp files and compiler starts subprocesses for each file to +make the build parallel. If you want compiler to be invoked with one file at +a time set ``VS_NO_COMPILE_BATCHING`` to ON. If this flag is set MSBuild will +call compiler with one c/cpp file at a time. Useful when you want to use tool +that replaces the compiler, for example some build caching tool. + +This property is initialized by the :variable:`CMAKE_VS_NO_COMPILE_BATCHING` +variable if it is set when a target is created. + +Example +^^^^^^^ + +This shows setting the property for the target ``foo``. + +.. code-block:: cmake + + add_library(foo SHARED foo.cpp) + set_property(TARGET foo PROPERTY VS_NO_COMPILE_BATCHING ON) diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_NO_SOLUTION_DEPLOY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_NO_SOLUTION_DEPLOY.rst new file mode 100644 index 0000000000000000000000000000000000000000..c55c9c2aacfa4ee70b61aadde323325339ef634c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_NO_SOLUTION_DEPLOY.rst @@ -0,0 +1,48 @@ +VS_NO_SOLUTION_DEPLOY +--------------------- + +.. versionadded:: 3.15 + +Specify that the target should not be marked for deployment to a Windows CE +or Windows Phone device in the generated Visual Studio solution. + +Be default, all EXE and shared library (DLL) targets are marked to deploy to +the target device in the generated Visual Studio solution. + +Generator expressions are supported. + +There are reasons one might want to exclude a target / generated project from +deployment: + +- The library or executable may not be necessary in the primary deploy/debug + scenario, and excluding from deployment saves time in the + develop/download/debug cycle. +- There may be insufficient space on the target device to accommodate all of + the build products. +- Visual Studio 2013 requires a target device IP address be entered for each + target marked for deployment. For large numbers of targets, this can be + tedious. + NOTE: Visual Studio *will* deploy all project dependencies of a project + tagged for deployment to the IP address configured for that project even + if those dependencies are not tagged for deployment. + + +Example 1 +^^^^^^^^^ + +This shows setting the variable for the target foo. + +.. code-block:: cmake + + add_library(foo SHARED foo.cpp) + set_property(TARGET foo PROPERTY VS_NO_SOLUTION_DEPLOY ON) + +Example 2 +^^^^^^^^^ + +This shows setting the variable for the Release configuration only. + +.. code-block:: cmake + + add_library(foo SHARED foo.cpp) + set_property(TARGET foo PROPERTY VS_NO_SOLUTION_DEPLOY "$") diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_PACKAGE_REFERENCES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_PACKAGE_REFERENCES.rst new file mode 100644 index 0000000000000000000000000000000000000000..121e8d6f6dc2bab52bb2031dfa204c8a58319419 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_PACKAGE_REFERENCES.rst @@ -0,0 +1,15 @@ +VS_PACKAGE_REFERENCES +--------------------- + +.. versionadded:: 3.15 + +Visual Studio package references for nuget. + +Adds one or more semicolon-delimited package references to a generated +Visual Studio project. The version of the package will be +underscore delimited. For example, ``boost_1.7.0;nunit_3.12.*``. + +.. code-block:: cmake + + set_property(TARGET ${TARGET_NAME} PROPERTY + VS_PACKAGE_REFERENCES "boost_1.7.0") diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_PLATFORM_TOOLSET.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_PLATFORM_TOOLSET.rst new file mode 100644 index 0000000000000000000000000000000000000000..aff0749db4f48057009cf446cc691dd65395aef7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_PLATFORM_TOOLSET.rst @@ -0,0 +1,12 @@ +VS_PLATFORM_TOOLSET +------------------- + +.. versionadded:: 3.18 + +Overrides the platform toolset used to build a target. + +Only supported when the compiler used by the given toolset is the +same as the compiler used to build the whole source tree. + +This is especially useful to create driver projects with the toolsets +"WindowsUserModeDriver10.0" or "WindowsKernelModeDriver10.0". diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_PROJECT_IMPORT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_PROJECT_IMPORT.rst new file mode 100644 index 0000000000000000000000000000000000000000..428329d0476ed6d641af640cae739ea74570d989 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_PROJECT_IMPORT.rst @@ -0,0 +1,10 @@ +VS_PROJECT_IMPORT +----------------- + +.. versionadded:: 3.15 + +Visual Studio managed project imports + +Adds to a generated Visual Studio project one or more semicolon-delimited paths +to .props files needed when building projects from some NuGet packages. +For example, ``my_packages_path/MyPackage.1.0.0/build/MyPackage.props``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_AUXPATH.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_AUXPATH.rst new file mode 100644 index 0000000000000000000000000000000000000000..248214e65582f2bdea086d379fda0b6b7a1c4e87 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_AUXPATH.rst @@ -0,0 +1,7 @@ +VS_SCC_AUXPATH +-------------- + +Visual Studio Source Code Control Aux Path. + +Can be set to change the visual studio source code control auxpath +property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_LOCALPATH.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_LOCALPATH.rst new file mode 100644 index 0000000000000000000000000000000000000000..6ebbfebee1d1054a61488d2a07e29b373b8f5759 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_LOCALPATH.rst @@ -0,0 +1,7 @@ +VS_SCC_LOCALPATH +---------------- + +Visual Studio Source Code Control Local Path. + +Can be set to change the visual studio source code control local path +property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_PROJECTNAME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_PROJECTNAME.rst new file mode 100644 index 0000000000000000000000000000000000000000..bbacb38dc35ca8fc037ffb5a02873939fd054b6c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_PROJECTNAME.rst @@ -0,0 +1,7 @@ +VS_SCC_PROJECTNAME +------------------ + +Visual Studio Source Code Control Project. + +Can be set to change the visual studio source code control project +name property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_PROVIDER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_PROVIDER.rst new file mode 100644 index 0000000000000000000000000000000000000000..be33433a8ff2f818525034075ff6b3430bb104c0 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SCC_PROVIDER.rst @@ -0,0 +1,7 @@ +VS_SCC_PROVIDER +--------------- + +Visual Studio Source Code Control Provider. + +Can be set to change the visual studio source code control provider +property. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_SDK_REFERENCES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SDK_REFERENCES.rst new file mode 100644 index 0000000000000000000000000000000000000000..3b9ca7b3ebacb98e9dd4834ecc00f4e6feb18946 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SDK_REFERENCES.rst @@ -0,0 +1,9 @@ +VS_SDK_REFERENCES +----------------- + +.. versionadded:: 3.7 + +Visual Studio project SDK references. +Specify a :ref:`semicolon-separated list ` of SDK references +to be added to a generated Visual Studio project, e.g. +``Microsoft.AdMediatorWindows81, Version=1.0``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst new file mode 100644 index 0000000000000000000000000000000000000000..1e4b4434bf93b730ed1dd48659ae9743fbc54b87 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst @@ -0,0 +1,29 @@ +VS_SOLUTION_DEPLOY +------------------ + +.. versionadded:: 3.18 + +Specify that the target should be marked for deployment when not targeting +Windows CE, Windows Phone or a Windows Store application. + +If the target platform doesn't support deployment, this property won't have +any effect. + +:manual:`Generator expressions ` are supported. + +Examples +^^^^^^^^ + +Always deploy target ``foo``: + +.. code-block:: cmake + + add_executable(foo SHARED foo.cpp) + set_property(TARGET foo PROPERTY VS_SOLUTION_DEPLOY ON) + +Deploy target ``foo`` for all configurations except ``Release``: + +.. code-block:: cmake + + add_executable(foo SHARED foo.cpp) + set_property(TARGET foo PROPERTY VS_SOLUTION_DEPLOY "$>") diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst new file mode 100644 index 0000000000000000000000000000000000000000..fb48dded6a3db1d9c75005c32d662666417bb2d6 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst @@ -0,0 +1,21 @@ +VS_SOURCE_SETTINGS_ +------------------------- + +.. versionadded:: 3.18 + +Set any item metadata on all non-built files that use . + +Takes a list of ``Key=Value`` pairs. Tells the Visual Studio generator +to set ``Key`` to ``Value`` as item metadata on all non-built files +that use ````. + +For example: + +.. code-block:: cmake + + set_property(TARGET main PROPERTY VS_SOURCE_SETTINGS_FXCompile "Key=Value" "Key2=Value2") + +will set ``Key`` to ``Value`` and ``Key2`` to ``Value2`` for all +non-built files that use ``FXCompile``. + +:manual:`Generator expressions ` are supported. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_USER_PROPS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_USER_PROPS.rst new file mode 100644 index 0000000000000000000000000000000000000000..f227ab258378e1f09e1d58c354f03962ca698e09 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_USER_PROPS.rst @@ -0,0 +1,14 @@ +VS_USER_PROPS +------------- + +.. versionadded:: 3.8 + +Sets the user props file to be included in the visual studio +C++ project file. The standard path is +``$(UserRootDir)\\Microsoft.Cpp.$(Platform).user.props``, which is +in most cases the same as +``%LOCALAPPDATA%\\Microsoft\\MSBuild\\v4.0\\Microsoft.Cpp.Win32.user.props`` +or ``%LOCALAPPDATA%\\Microsoft\\MSBuild\\v4.0\\Microsoft.Cpp.x64.user.props``. + +The ``*.user.props`` files can be used for Visual Studio wide +configuration which is independent from cmake. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES-PURPOSE.txt b/cmake/share/cmake-3.31/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES-PURPOSE.txt new file mode 100644 index 0000000000000000000000000000000000000000..d313b06f6fdb7e2f3b2f42df5d622df21f700856 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES-PURPOSE.txt @@ -0,0 +1,18 @@ +Indicate to :ref:`Visual Studio Generators` what configurations are considered +debug configurations. This controls the ``UseDebugLibraries`` setting in +each configuration of a ``.vcxproj`` file. + +The "Use Debug Libraries" setting in Visual Studio projects, despite its +specific-sounding name, is a general-purpose indicator of what configurations +are considered debug configurations. In standalone projects, this may affect +MSBuild's default selection of MSVC runtime library, optimization flags, +runtime checks, and similar settings. In CMake projects those settings are +typically generated explicitly based on the project's specification, e.g., +the MSVC runtime library is controlled by |MSVC_RUNTIME_LIBRARY|. However, +the ``UseDebugLibraries`` indicator is useful for reference by both humans +and tools, and may also affect the behavior of platform-specific SDKs. + +Set |VS_USE_DEBUG_LIBRARIES| to a true or false value to indicate whether +each configuration is considered a debug configuration. The value may also +be the empty string (``""``) in which case no ``UseDebugLibraries`` will be +added explicitly by CMake, and MSBuild will use its default value, ``false``. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES.rst new file mode 100644 index 0000000000000000000000000000000000000000..fb4b423e55cf23b4fbb62c828fe542a00c6160c4 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES.rst @@ -0,0 +1,28 @@ +VS_USE_DEBUG_LIBRARIES +---------------------- + +.. versionadded:: 3.30 + +.. |VS_USE_DEBUG_LIBRARIES| replace:: ``VS_USE_DEBUG_LIBRARIES`` +.. |MSVC_RUNTIME_LIBRARY| replace:: :prop_tgt:`MSVC_RUNTIME_LIBRARY` + +.. include:: VS_USE_DEBUG_LIBRARIES-PURPOSE.txt + +Use :manual:`generator expressions ` +for per-configuration specification. For example, the code: + +.. code-block:: cmake + + add_executable(foo foo.c) + set_property(TARGET foo PROPERTY + VS_USE_DEBUG_LIBRARIES "$") + +indicates that target ``foo`` considers its "Debug" and "Custom" +configurations to be debug configurations, and its other configurations +to be non-debug configurations. + +The property is initialized from the value of the +:variable:`CMAKE_VS_USE_DEBUG_LIBRARIES` variable, if it is set. +If the property is not set then CMake generates ``UseDebugLibraries`` using +heuristics to determine which configurations are debug configurations. +See policy :policy:`CMP0162`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION.rst new file mode 100644 index 0000000000000000000000000000000000000000..dbd0453b2b19c29f51fc1df661ded0a16f33346d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION.rst @@ -0,0 +1,17 @@ +VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION +-------------------------------------- + +.. versionadded:: 3.4 + +Visual Studio Windows Target Platform Minimum Version + +For Windows 10. Specifies the minimum version of the OS that is being +targeted. For example ``10.0.10240.0``. If the value is not specified, the +value of the :variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION` variable +will be used on WindowsStore projects. Otherwise the target platform +minimum version will not be specified for the project. + +.. versionadded:: 3.27 + This property is initialized by the value of the + :variable:`CMAKE_VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION` variable + if it is set when a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINRT_COMPONENT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINRT_COMPONENT.rst new file mode 100644 index 0000000000000000000000000000000000000000..21c46c14d10867066eef24ee3300c675e4f41222 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINRT_COMPONENT.rst @@ -0,0 +1,13 @@ +VS_WINRT_COMPONENT +------------------ + +.. versionadded:: 3.1 + +Mark a target as a Windows Runtime component for the Visual Studio generator. +Compile the target with ``C++/CX`` language extensions for Windows Runtime. +For ``SHARED`` and ``MODULE`` libraries, this also defines the +``_WINRT_DLL`` preprocessor macro. + +.. note:: + Currently this is implemented only by Visual Studio generators. + Support may be added to other generators in the future. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst new file mode 100644 index 0000000000000000000000000000000000000000..978df581b0d2f87155eabe3b36e965b80dd15738 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst @@ -0,0 +1,5 @@ +VS_WINRT_EXTENSIONS +------------------- + +Deprecated. Use :prop_tgt:`VS_WINRT_COMPONENT` instead. +This property was an experimental partial implementation of that one. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINRT_REFERENCES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINRT_REFERENCES.rst new file mode 100644 index 0000000000000000000000000000000000000000..68987197e522eec22482519f89a5985d8646a428 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/VS_WINRT_REFERENCES.rst @@ -0,0 +1,7 @@ +VS_WINRT_REFERENCES +------------------- + +Visual Studio project Windows Runtime Metadata references + +Adds one or more semicolon-delimited WinRT references to a generated +Visual Studio project. For example, "Windows;Windows.UI.Core". diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY-VALUES.txt b/cmake/share/cmake-3.31/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY-VALUES.txt new file mode 100644 index 0000000000000000000000000000000000000000..b9d0ae865ea62c47c442ff47efac96ccec93c254 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY-VALUES.txt @@ -0,0 +1,20 @@ +``SingleThreaded`` + Compile without additional flags to use a single-threaded + statically-linked runtime library. +``SingleThreadedDLL`` + Compile with ``-br`` or equivalent flag(s) to use a single-threaded + dynamically-linked runtime library. This is not available for Linux + targets. +``MultiThreaded`` + Compile with ``-bm`` or equivalent flag(s) to use a multi-threaded + statically-linked runtime library. +``MultiThreadedDLL`` + Compile with ``-bm -br`` or equivalent flag(s) to use a multi-threaded + dynamically-linked runtime library. This is not available for Linux + targets. + +The value is ignored on non-Watcom compilers but an unsupported value will +be rejected as an error when using a compiler targeting the Watcom ABI. + +The value may also be the empty string (``""``) in which case no runtime +library selection flag will be added explicitly by CMake. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY.rst new file mode 100644 index 0000000000000000000000000000000000000000..27e8a4d6e594c0e54233a90729b070ddcbac0ebb --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY.rst @@ -0,0 +1,34 @@ +WATCOM_RUNTIME_LIBRARY +---------------------- + +.. versionadded:: 3.24 + +Select the Watcom runtime library for use by compilers targeting the Watcom ABI. + +The allowed values are: + +.. include:: WATCOM_RUNTIME_LIBRARY-VALUES.txt + +Use :manual:`generator expressions ` to +support per-configuration specification. + +For example, the code: + +.. code-block:: cmake + + add_executable(foo foo.c) + set_property(TARGET foo PROPERTY + WATCOM_RUNTIME_LIBRARY "MultiThreaded") + +selects for the target ``foo`` a multi-threaded statically-linked runtime +library. + +If this property is not set then CMake uses the default value +``MultiThreadedDLL`` on Windows and ``SingleThreaded`` on other +platforms to select a Watcom runtime library. + +.. note:: + + This property has effect only when policy :policy:`CMP0136` is set to ``NEW`` + prior to the first :command:`project` or :command:`enable_language` command + that enables a language using a compiler targeting the Watcom ABI. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/WIN32_EXECUTABLE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/WIN32_EXECUTABLE.rst new file mode 100644 index 0000000000000000000000000000000000000000..989d8667e473eda9aa44bad15ecd5ef865bc8bee --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/WIN32_EXECUTABLE.rst @@ -0,0 +1,17 @@ +WIN32_EXECUTABLE +---------------- + +Build an executable with a WinMain entry point on windows. + +When this property is set to true the executable when linked on +Windows will be created with a WinMain() entry point instead of just +main(). This makes it a GUI executable instead of a console application. +See the :variable:`CMAKE_MFC_FLAG` variable documentation to +configure use of the Microsoft Foundation Classes (MFC) for WinMain +executables. This property is initialized by the value of the +:variable:`CMAKE_WIN32_EXECUTABLE` variable if it is set when +a target is created. + +This property supports +:manual:`generator expressions `, except if the +target is managed (contains C# code.) diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst new file mode 100644 index 0000000000000000000000000000000000000000..b59679d478f344f0f347e09f04f91085ec8bd360 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst @@ -0,0 +1,28 @@ +WINDOWS_EXPORT_ALL_SYMBOLS +-------------------------- + +.. versionadded:: 3.4 + +This property is implemented only for MS-compatible tools on Windows. + +Enable this boolean property to automatically create a module definition +(``.def``) file with all global symbols found in the input ``.obj`` files +for a ``SHARED`` library (or executable with :prop_tgt:`ENABLE_EXPORTS`) +on Windows. The module definition file will be passed to the linker +causing all symbols to be exported from the ``.dll``. +For global *data* symbols, ``__declspec(dllimport)`` must still be used when +compiling against the code in the ``.dll``. All other function symbols will +be automatically exported and imported by callers. This simplifies porting +projects to Windows by reducing the need for explicit ``dllexport`` markup, +even in ``C++`` classes. + +When this property is enabled, zero or more ``.def`` files may also be +specified as source files of the target. The exports named by these files +will be merged with those detected from the object files to generate a +single module definition file to be passed to the linker. This can be +used to export symbols from a ``.dll`` that are not in any of its object +files but are added by the linker from dependencies (e.g. ``msvcrt.lib``). + +This property is initialized by the value of +the :variable:`CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS` variable if it is set +when a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..7430d2b60170cb49d1bd61b21ba7b3039e87b285 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst @@ -0,0 +1,22 @@ +XCODE_ATTRIBUTE_ +------------------------------ + +Set Xcode target attributes directly. + +Tell the :generator:`Xcode` generator to set ```` to a given +value in the generated Xcode project. Ignored on other generators. + +This offers low-level control over the generated Xcode project file. +It is meant as a last resort for specifying settings that CMake does +not otherwise have a way to control. Although this can override a +setting CMake normally produces on its own, doing so bypasses CMake's +model of the project and can break things. + +See the :variable:`CMAKE_XCODE_ATTRIBUTE_` variable +to set attributes on all targets in a directory tree. + +Contents of ``XCODE_ATTRIBUTE_`` may use +"generator expressions" with the syntax ``$<...>``. See the +:manual:`cmake-generator-expressions(7)` manual for available +expressions. See the :manual:`cmake-buildsystem(7)` manual +for more on defining buildsystem properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_FRAMEWORKS_CODE_SIGN_ON_COPY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_FRAMEWORKS_CODE_SIGN_ON_COPY.rst new file mode 100644 index 0000000000000000000000000000000000000000..fb656b0663958849bb219f83749eb13e3a3e195f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_FRAMEWORKS_CODE_SIGN_ON_COPY.rst @@ -0,0 +1,13 @@ +XCODE_EMBED_FRAMEWORKS_CODE_SIGN_ON_COPY +---------------------------------------- + +.. versionadded:: 3.20 + +Tell the :generator:`Xcode` generator to perform code signing for all the +frameworks and libraries that are embedded using the +:prop_tgt:`XCODE_EMBED_FRAMEWORKS >` property. + +.. versionadded:: 3.21 + +This property was generalized to other types of embedded items. See +:prop_tgt:`XCODE_EMBED__CODE_SIGN_ON_COPY` for the more general form. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_FRAMEWORKS_REMOVE_HEADERS_ON_COPY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_FRAMEWORKS_REMOVE_HEADERS_ON_COPY.rst new file mode 100644 index 0000000000000000000000000000000000000000..10ed5dd9496072f89a744c3c6fcc85c043bd0591 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_FRAMEWORKS_REMOVE_HEADERS_ON_COPY.rst @@ -0,0 +1,14 @@ +XCODE_EMBED_FRAMEWORKS_REMOVE_HEADERS_ON_COPY +--------------------------------------------- + +.. versionadded:: 3.20 + +Tell the :generator:`Xcode` generator to remove headers from all the +frameworks that are embedded using the +:prop_tgt:`XCODE_EMBED_FRAMEWORKS >` property. + +.. versionadded:: 3.21 + +This property was generalized to other types of embedded items. See +:prop_tgt:`XCODE_EMBED__REMOVE_HEADERS_ON_COPY` for the more +general form. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type.rst new file mode 100644 index 0000000000000000000000000000000000000000..8716f786f798be71756cbdca635a2643fcbd270a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type.rst @@ -0,0 +1,70 @@ +XCODE_EMBED_ +------------------ + +.. versionadded:: 3.20 + +Tell the :generator:`Xcode` generator to embed the specified list of items into +the target bundle. ```` specifies the embed build phase to use. +See the Xcode documentation for the base location of each ````. + +The supported values for ```` are: + +``FRAMEWORKS`` + The specified items will be added to the ``Embed Frameworks`` build phase. + The items can be CMake target names or paths to frameworks or libraries. + +``APP_EXTENSIONS`` + .. versionadded:: 3.21 + + The specified items will be added to the ``Embed App Extensions`` build + phase, with ``Destination`` set to ``PlugIns and Foundation Extensions`` + They must be CMake target names. + +``EXTENSIONKIT_EXTENSIONS`` + .. versionadded:: 3.26 + + The specified items will be added to the ``Embed App Extensions`` build + phase, with ``Destination`` set to ``ExtensionKit Extensions`` + They must be CMake target names, and should likely have the + ``XCODE_PRODUCT_TYPE`` target property set to + ``com.apple.product-type.extensionkit-extension`` + as well as the ``XCODE_EXPLICIT_FILE_TYPE`` to + ``wrapper.extensionkit-extension`` + +``PLUGINS`` + .. versionadded:: 3.23 + + The specified items will be added to the ``Embed PlugIns`` build phase. + They must be CMake target names. + +``RESOURCES`` + .. versionadded:: 3.28 + + The specified items will be added to the ``Embed Resources`` build phase. + They must be CMake target names or folder paths. + +``XPC_SERVICES`` + .. versionadded:: 3.29 + + The specified items will be added to the ``Embed XPC Services`` build phase. + They must be CMake target names. + +When listing a target as any of the things to embed, Xcode must see that target +as part of the same Xcode project, or a sub-project of the one defining the +bundle. In order to satisfy this constraint, the CMake project must ensure +at least one of the following: + +* The :variable:`CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT_ONLY` variable is set + to true in the top level ``CMakeLists.txt`` file. This is the simplest and + most robust approach. +* Define the target-to-embed in a subdirectory of the one that defines the + target being embedded into. +* If the target-to-embed and the target being embedded into are in separate, + unrelated directories (i.e. they are siblings, not one a parent of the + other), ensure they have a common :command:`project` call in a parent + directory and no other :command:`project` calls between themselves and that + common :command:`project` call. + +See also :prop_tgt:`XCODE_EMBED__PATH`, +:prop_tgt:`XCODE_EMBED__REMOVE_HEADERS_ON_COPY` and +:prop_tgt:`XCODE_EMBED__CODE_SIGN_ON_COPY`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type_CODE_SIGN_ON_COPY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type_CODE_SIGN_ON_COPY.rst new file mode 100644 index 0000000000000000000000000000000000000000..5f9ceab17776fa6b3a1fa98823ddc972b7d4ecba --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type_CODE_SIGN_ON_COPY.rst @@ -0,0 +1,24 @@ +XCODE_EMBED__CODE_SIGN_ON_COPY +------------------------------------ + +.. versionadded:: 3.20 + +Boolean property used only by the :generator:`Xcode` generator. It specifies +whether to perform code signing for the items that are embedded using the +:prop_tgt:`XCODE_EMBED_` property. + +The supported values for ```` are: + +``FRAMEWORKS`` + +``APP_EXTENSIONS`` + .. versionadded:: 3.21 + +``EXTENSIONKIT_EXTENSIONS`` + .. versionadded:: 3.26 + +``PLUGINS`` + .. versionadded:: 3.23 + +If a ``XCODE_EMBED__CODE_SIGN_ON_COPY`` property is not defined on the +target, no code signing on copy will be performed for that ````. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type_PATH.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type_PATH.rst new file mode 100644 index 0000000000000000000000000000000000000000..aa0b93b719c709d0157e4c8ca5537db50322ab4c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type_PATH.rst @@ -0,0 +1,30 @@ +XCODE_EMBED__PATH +----------------------- + +.. versionadded:: 3.20 + +This property is used only by the :generator:`Xcode` generator. When defined, +it specifies the relative path to use when embedding the items specified by +:prop_tgt:`XCODE_EMBED_`. The path is relative +to the base location of the ``Embed XXX`` build phase associated with +````. See the Xcode documentation for the base location of each +````. + +The supported values for ```` are: + +``FRAMEWORKS`` + +``APP_EXTENSIONS`` + .. versionadded:: 3.21 + +``EXTENSIONKIT_EXTENSIONS`` + .. versionadded:: 3.26 + +``PLUGINS`` + .. versionadded:: 3.23 + +``RESOURCES`` + .. versionadded:: 3.28 + +``XPC_SERVICES`` + .. versionadded:: 3.29 diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type_REMOVE_HEADERS_ON_COPY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type_REMOVE_HEADERS_ON_COPY.rst new file mode 100644 index 0000000000000000000000000000000000000000..49dbbbe0e667fdc376bcee0e98ac5372728b26a8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EMBED_type_REMOVE_HEADERS_ON_COPY.rst @@ -0,0 +1,29 @@ +XCODE_EMBED__REMOVE_HEADERS_ON_COPY +----------------------------------------- + +.. versionadded:: 3.20 + +Boolean property used only by the :generator:`Xcode` generator. It specifies +whether to remove headers from all the frameworks that are embedded using the +:prop_tgt:`XCODE_EMBED_` property. + +The supported values for ```` are: + +``FRAMEWORKS`` + If the ``XCODE_EMBED_FRAMEWORKS_REMOVE_HEADERS_ON_COPY`` property is not + defined, headers will not be removed on copy by default. + +``APP_EXTENSIONS`` + .. versionadded:: 3.21 + + If the ``XCODE_EMBED_APP_EXTENSIONS_REMOVE_HEADERS_ON_COPY`` property is not + defined, headers WILL be removed on copy by default. + +``EXTENSIONKIT_EXTENSIONS`` + .. versionadded:: 3.26 + + If the ``XCODE_EMBED_APP_EXTENSIONS_REMOVE_HEADERS_ON_COPY`` property is not + defined, headers WILL be removed on copy by default. + +``PLUGINS`` + .. versionadded:: 3.23 diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EXPLICIT_FILE_TYPE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EXPLICIT_FILE_TYPE.rst new file mode 100644 index 0000000000000000000000000000000000000000..3f78c2d6c0e4438c01c8c40f21358d6be6c55ce5 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_EXPLICIT_FILE_TYPE.rst @@ -0,0 +1,10 @@ +XCODE_EXPLICIT_FILE_TYPE +------------------------ + +.. versionadded:: 3.8 + +Set the Xcode ``explicitFileType`` attribute on its reference to a +target. CMake computes a default based on target type but +can be told explicitly with this property. + +See also :prop_tgt:`XCODE_PRODUCT_TYPE`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_GENERATE_SCHEME.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_GENERATE_SCHEME.rst new file mode 100644 index 0000000000000000000000000000000000000000..4fcdab082adb8987ec014b4c7c98cfb3aa885d99 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_GENERATE_SCHEME.rst @@ -0,0 +1,48 @@ +XCODE_GENERATE_SCHEME +--------------------- + +.. versionadded:: 3.15 + +If enabled, the :generator:`Xcode` generator will generate schema files. These +are useful to invoke analyze, archive, build-for-testing and test +actions from the command line. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_GENERATE_SCHEME` if it is set when a target +is created. + +The following target properties overwrite the default of the +corresponding settings on the "Diagnostic" tab for each schema file. +Each of those is initialized by the respective ``CMAKE_`` variable +at target creation time. + +- :prop_tgt:`XCODE_SCHEME_ADDRESS_SANITIZER` +- :prop_tgt:`XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN` +- :prop_tgt:`XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER` +- :prop_tgt:`XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS` +- :prop_tgt:`XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE` +- :prop_tgt:`XCODE_SCHEME_GUARD_MALLOC` +- :prop_tgt:`XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP` +- :prop_tgt:`XCODE_SCHEME_MALLOC_GUARD_EDGES` +- :prop_tgt:`XCODE_SCHEME_MALLOC_SCRIBBLE` +- :prop_tgt:`XCODE_SCHEME_MALLOC_STACK` +- :prop_tgt:`XCODE_SCHEME_THREAD_SANITIZER` +- :prop_tgt:`XCODE_SCHEME_THREAD_SANITIZER_STOP` +- :prop_tgt:`XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER` +- :prop_tgt:`XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP` +- :prop_tgt:`XCODE_SCHEME_LAUNCH_CONFIGURATION` +- :prop_tgt:`XCODE_SCHEME_ENABLE_GPU_API_VALIDATION` +- :prop_tgt:`XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION` +- :prop_tgt:`XCODE_SCHEME_ZOMBIE_OBJECTS` + +The following target properties will be applied on the +"Info", "Arguments", and "Options" tab: + +- :prop_tgt:`XCODE_SCHEME_ARGUMENTS` +- :prop_tgt:`XCODE_SCHEME_DEBUG_AS_ROOT` +- :prop_tgt:`XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING` +- :prop_tgt:`XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE` +- :prop_tgt:`XCODE_SCHEME_ENVIRONMENT` +- :prop_tgt:`XCODE_SCHEME_EXECUTABLE` +- :prop_tgt:`XCODE_SCHEME_LAUNCH_MODE` +- :prop_tgt:`XCODE_SCHEME_WORKING_DIRECTORY` diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_LINK_BUILD_PHASE_MODE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_LINK_BUILD_PHASE_MODE.rst new file mode 100644 index 0000000000000000000000000000000000000000..482f0c5d5457b180abde9ecdfa546309a2b1a916 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_LINK_BUILD_PHASE_MODE.rst @@ -0,0 +1,55 @@ +XCODE_LINK_BUILD_PHASE_MODE +--------------------------- + +.. versionadded:: 3.19 + +When using the :generator:`Xcode` generator, libraries to be linked will be +specified in the Xcode project file using either the "Link Binary With +Libraries" build phase or directly as linker flags. The former allows Xcode +to manage build paths, which may be necessary when creating Xcode archives +because it may use different build paths to a regular build. + +This property controls usage of "Link Binary With Libraries" build phase for +a target that is an app bundle, executable, shared library, shared framework +or a module library. + +Possible values are: + +* ``NONE`` + The libraries will be linked by specifying the linker flags directly. + +* ``BUILT_ONLY`` + The "Link Binary With Libraries" build phase will be used to link to another + target under the following conditions: + + - The target to be linked to is a regular non-imported, non-interface library + target. + - The output directory of the target being built has not been changed from + its default (see :prop_tgt:`RUNTIME_OUTPUT_DIRECTORY` and + :prop_tgt:`LIBRARY_OUTPUT_DIRECTORY`). + +* ``KNOWN_LOCATION`` + The "Link Binary With Libraries" build phase will be used to link to another + target under the same conditions as with ``BUILT_ONLY`` and also: + + - Imported library targets except those of type ``UNKNOWN``. + - Any non-target library specified directly with a path. + +For all other cases, the libraries will be linked by specifying the linker +flags directly. + +.. warning:: + Libraries linked using "Link Binary With Libraries" are linked after the + ones linked through regular linker flags. This order should be taken into + account when different static libraries contain symbols with the same name, + as the former ones will take precedence over the latter. + +.. warning:: + If two or more directories contain libraries with identical file names and + some libraries are linked from those directories, the library search path + lookup will end up linking libraries from the first directory. This is a + known limitation of Xcode. + +This property is initialized by the value of the +:variable:`CMAKE_XCODE_LINK_BUILD_PHASE_MODE` variable if it is set when a +target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_PRODUCT_TYPE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_PRODUCT_TYPE.rst new file mode 100644 index 0000000000000000000000000000000000000000..fb6387687c07b5e72693a0d63579789b09c97718 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_PRODUCT_TYPE.rst @@ -0,0 +1,10 @@ +XCODE_PRODUCT_TYPE +------------------ + +.. versionadded:: 3.8 + +Set the Xcode ``productType`` attribute on its reference to a +target. CMake computes a default based on target type but +can be told explicitly with this property. + +See also :prop_tgt:`XCODE_EXPLICIT_FILE_TYPE`. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER.rst new file mode 100644 index 0000000000000000000000000000000000000000..f84ea378a9c75cd19beced3323309bb4185c8b53 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_ADDRESS_SANITIZER +------------------------------ + +.. versionadded:: 3.13 + +Whether to enable ``Address Sanitizer`` in the Diagnostics +section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst new file mode 100644 index 0000000000000000000000000000000000000000..30bcb996a0b2273542656a4b8a8bc3f0c9056519 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN +----------------------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Detect use of stack after return`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ARGUMENTS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ARGUMENTS.rst new file mode 100644 index 0000000000000000000000000000000000000000..a2718bf3f84d3abde6df141c2f14ee88ef3c2c8d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ARGUMENTS.rst @@ -0,0 +1,12 @@ +XCODE_SCHEME_ARGUMENTS +---------------------- + +.. versionadded:: 3.13 + +Specify command line arguments that should be added to the Arguments +section of the generated Xcode scheme. + +If set to a list of arguments those will be added to the scheme. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DEBUG_AS_ROOT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DEBUG_AS_ROOT.rst new file mode 100644 index 0000000000000000000000000000000000000000..4b71eddc6d50918c1b647ed5b7327233a06794df --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DEBUG_AS_ROOT.rst @@ -0,0 +1,9 @@ +XCODE_SCHEME_DEBUG_AS_ROOT +-------------------------- + +.. versionadded:: 3.15 + +Whether to debug the target as 'root'. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst new file mode 100644 index 0000000000000000000000000000000000000000..b157bb4c33cf69b16c4951c90af205b32d5521b3 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING.rst @@ -0,0 +1,15 @@ +XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING +-------------------------------------- + +.. versionadded:: 3.16 + +Whether to enable +``Allow debugging when using document Versions Browser`` +in the Options section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst new file mode 100644 index 0000000000000000000000000000000000000000..fddc134994d1eb855affbef44d30b54a579aa279 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER +---------------------------------------- + +.. versionadded:: 3.13 + +Whether to disable the ``Main Thread Checker`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst new file mode 100644 index 0000000000000000000000000000000000000000..11af42d1bf4decac4aeaacf47b73847dcf7afba1 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS +---------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Dynamic Library Loads`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst new file mode 100644 index 0000000000000000000000000000000000000000..037dd9f254b679f8dcb9803f785a52e9a7b6d6b8 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE +------------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Dynamic Linker API usage`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENABLE_GPU_API_VALIDATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENABLE_GPU_API_VALIDATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..fc18503c10d752580a679225a6266fe8eeb01355 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENABLE_GPU_API_VALIDATION.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_ENABLE_GPU_API_VALIDATION +-------------------------------------- + +.. versionadded:: 3.25 + +Property value for ``Metal: API Validation`` in the Options section of +the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ENABLE_GPU_API_VALIDATION` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE.rst new file mode 100644 index 0000000000000000000000000000000000000000..8589a760afcc6889befcb1f4736da7cc0cba699f --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE.rst @@ -0,0 +1,15 @@ +XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE +------------------------------------------ + +.. versionadded:: 3.23 + +Property value for ``GPU Frame Capture`` in the Options section of +the generated Xcode scheme. Example values are `Metal` and +`Disabled`. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..53d4c9f0b421baa7854ab4549eac04ab37fdbea2 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION +----------------------------------------- + +.. versionadded:: 3.25 + +Property value for ``Metal: Shader Validation`` in the Options section of +the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENVIRONMENT.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENVIRONMENT.rst new file mode 100644 index 0000000000000000000000000000000000000000..839408eccd709d51c536857b251c9cbc2ae8bd62 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ENVIRONMENT.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_ENVIRONMENT +------------------------ + +.. versionadded:: 3.13 + +Specify environment variables that should be added to the Arguments +section of the generated Xcode scheme. + +If set to a list of environment variables and values of the form +``MYVAR=value`` those environment variables will be added to the +scheme. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_EXECUTABLE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_EXECUTABLE.rst new file mode 100644 index 0000000000000000000000000000000000000000..217a54301e6d186586b9a32ae49e677422719282 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_EXECUTABLE.rst @@ -0,0 +1,11 @@ +XCODE_SCHEME_EXECUTABLE +----------------------- + +.. versionadded:: 3.13 + +Specify path to executable in the Info section of the generated +Xcode scheme. If not set the schema generator will select the +current target if it is actually executable. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_GUARD_MALLOC.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_GUARD_MALLOC.rst new file mode 100644 index 0000000000000000000000000000000000000000..990041d739dc1db5f86d30aaec4c278b52144d73 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_GUARD_MALLOC.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_GUARD_MALLOC +------------------------------ + +.. versionadded:: 3.13 + +Whether to enable ``Guard Malloc`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_GUARD_MALLOC` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_LAUNCH_CONFIGURATION.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_LAUNCH_CONFIGURATION.rst new file mode 100644 index 0000000000000000000000000000000000000000..1a6c03734bcade134a50ede45ddd13cb51d094d6 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_LAUNCH_CONFIGURATION.rst @@ -0,0 +1,13 @@ +XCODE_SCHEME_LAUNCH_CONFIGURATION +--------------------------------- + +.. versionadded:: 3.25 + +Set the build configuration to run the target. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_LAUNCH_CONFIGURATION` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_LAUNCH_MODE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_LAUNCH_MODE.rst new file mode 100644 index 0000000000000000000000000000000000000000..cfb52cd4b84589660cb24a4fcf7a27c4be7ad1d7 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_LAUNCH_MODE.rst @@ -0,0 +1,22 @@ +XCODE_SCHEME_LAUNCH_MODE +------------------------ + +.. versionadded:: 3.25 + +Property value for ``Launch`` in the Info section of the generated Xcode +scheme. + +Possible values are: + +``AUTO`` + Launch automatically. This is the default. + +``WAIT`` + Wait for the executable to be launched. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_LAUNCH_MODE` if it is set when a target is +created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst new file mode 100644 index 0000000000000000000000000000000000000000..65146ac321c3096dcda3b01fefd4cecf8def5184 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP.rst @@ -0,0 +1,15 @@ +XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP +------------------------------------- + +.. versionadded:: 3.13 + +Whether to enable the ``Main Thread Checker`` option +``Pause on issues`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MALLOC_GUARD_EDGES.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MALLOC_GUARD_EDGES.rst new file mode 100644 index 0000000000000000000000000000000000000000..a0de99675d5901a5578fd193eba67947669444b3 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MALLOC_GUARD_EDGES.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_MALLOC_GUARD_EDGES +------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Malloc Guard Edges`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MALLOC_SCRIBBLE.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MALLOC_SCRIBBLE.rst new file mode 100644 index 0000000000000000000000000000000000000000..85b273269f305d1958f08b511d9f57a8c3c339bd --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MALLOC_SCRIBBLE.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_MALLOC_SCRIBBLE +------------------------------ + +.. versionadded:: 3.13 + +Whether to enable ``Malloc Scribble`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MALLOC_STACK.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MALLOC_STACK.rst new file mode 100644 index 0000000000000000000000000000000000000000..335179b1047330b8874231049eaf44b18d0c7b3a --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_MALLOC_STACK.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_MALLOC_STACK +------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Malloc Stack`` in the Diagnostics +section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_MALLOC_STACK` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER.rst new file mode 100644 index 0000000000000000000000000000000000000000..6eca56d7d6bc086a58f247a995893d74e96dc3ba --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_THREAD_SANITIZER +----------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Thread Sanitizer`` in the Diagnostics +section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_THREAD_SANITIZER` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER_STOP.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER_STOP.rst new file mode 100644 index 0000000000000000000000000000000000000000..bd6f0e8144626715ce720672191b01cfdbcc8341 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_THREAD_SANITIZER_STOP.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_THREAD_SANITIZER_STOP +---------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Thread Sanitizer - Pause on issues`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst new file mode 100644 index 0000000000000000000000000000000000000000..508cb7f527800c5b7231004b1bd7c9fb48264129 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER +------------------------------------------ + +.. versionadded:: 3.13 + +Whether to enable ``Undefined Behavior Sanitizer`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst new file mode 100644 index 0000000000000000000000000000000000000000..5213538879c02dccef3e69ea0a5711596e933c5d --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP.rst @@ -0,0 +1,15 @@ +XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP +----------------------------------------------- + +.. versionadded:: 3.13 + +Whether to enable ``Undefined Behavior Sanitizer`` option +``Pause on issues`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP` +if it is set when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_WORKING_DIRECTORY.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_WORKING_DIRECTORY.rst new file mode 100644 index 0000000000000000000000000000000000000000..8c4da11d5f73148193741cca67b4316314bce659 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_WORKING_DIRECTORY.rst @@ -0,0 +1,15 @@ +XCODE_SCHEME_WORKING_DIRECTORY +------------------------------ + +.. versionadded:: 3.17 + +Specify the ``Working Directory`` of the *Run* and *Profile* +actions in the generated Xcode scheme. In case the value contains +generator expressions those are evaluated. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_WORKING_DIRECTORY` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ZOMBIE_OBJECTS.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ZOMBIE_OBJECTS.rst new file mode 100644 index 0000000000000000000000000000000000000000..7d6c71db288e17257cfc66481933587d07deb7a5 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_SCHEME_ZOMBIE_OBJECTS.rst @@ -0,0 +1,14 @@ +XCODE_SCHEME_ZOMBIE_OBJECTS +------------------------------ + +.. versionadded:: 3.13 + +Whether to enable ``Zombie Objects`` +in the Diagnostics section of the generated Xcode scheme. + +This property is initialized by the value of the variable +:variable:`CMAKE_XCODE_SCHEME_ZOMBIE_OBJECTS` if it is set +when a target is created. + +Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property +documentation to see all Xcode schema related properties. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_XCCONFIG.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_XCCONFIG.rst new file mode 100644 index 0000000000000000000000000000000000000000..405ee5f356dd25ee9de6f8c32c71e901fb6b8b89 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCODE_XCCONFIG.rst @@ -0,0 +1,14 @@ +XCODE_XCCONFIG +-------------- + +.. versionadded:: 3.24 + +If set, the :generator:`Xcode` generator will register the specified +file as a target-level XCConfig file. For global XCConfig files see +the :variable:`CMAKE_XCODE_XCCONFIG` variable. + +This feature is intended to ease migration from native Xcode projects +to CMake projects. + +Contents of ``XCODE_XCCONFIG`` may use +:manual:`generator expressions `. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XCTEST.rst b/cmake/share/cmake-3.31/Help/prop_tgt/XCTEST.rst new file mode 100644 index 0000000000000000000000000000000000000000..e1c3f9c29749c37a5b872f1aa94355a8073529dc --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XCTEST.rst @@ -0,0 +1,15 @@ +XCTEST +------ + +.. versionadded:: 3.3 + +This target is a XCTest CFBundle on the Mac. + +This property will usually get set via the :command:`xctest_add_bundle` +macro in :module:`FindXCTest` module. + +If a module library target has this property set to true it will be +built as a CFBundle when built on the Mac. It will have the directory +structure required for a CFBundle. + +This property depends on :prop_tgt:`BUNDLE` to be effective. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt b/cmake/share/cmake-3.31/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt new file mode 100644 index 0000000000000000000000000000000000000000..d594e47b9bb3e6b2de2aa3638b2d74d5a4e89910 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt @@ -0,0 +1,12 @@ +Output directory in which to build |XXX| target files. + +This property specifies the directory into which |xxx| target files +should be built. The property value may use +:manual:`generator expressions `. +Multi-configuration generators (:ref:`Visual Studio `, +:generator:`Xcode`, :generator:`Ninja Multi-Config`) append a +per-configuration subdirectory to the specified directory unless a generator +expression is used. + +This property is initialized by the value of the +|CMAKE_XXX_OUTPUT_DIRECTORY| variable if it is set when a target is created. diff --git a/cmake/share/cmake-3.31/Help/prop_tgt/XXX_OUTPUT_NAME.txt b/cmake/share/cmake-3.31/Help/prop_tgt/XXX_OUTPUT_NAME.txt new file mode 100644 index 0000000000000000000000000000000000000000..86933c22b566288855c555909d03c6dd9816f01b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/prop_tgt/XXX_OUTPUT_NAME.txt @@ -0,0 +1,5 @@ +Output name for |XXX| target files. + +This property specifies the base name for |xxx| target files. It +overrides :prop_tgt:`OUTPUT_NAME` and :prop_tgt:`OUTPUT_NAME_` +properties. diff --git a/cmake/share/cmake-3.31/Help/release/3.0.rst b/cmake/share/cmake-3.31/Help/release/3.0.rst new file mode 100644 index 0000000000000000000000000000000000000000..356c45e4cacff449bba04eda71c3f7526d402d28 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/release/3.0.rst @@ -0,0 +1,473 @@ +CMake 3.0 Release Notes +*********************** + +.. only:: html + + .. contents:: + +Changes made since CMake 2.8.12 include the following. + +Documentation Changes +===================== + +* The CMake documentation has been converted to reStructuredText and + now transforms via Sphinx (``__) into man and + html pages. This allows the documentation to be properly indexed + and to contain cross-references. + + Conversion from the old internal documentation format was done by + an automatic process so some documents may still contain artifacts. + They will be updated incrementally over time. + + A basic reStructuredText processor has been implemented to support + ``cmake --help-command`` and similar command-line options. + +* New manuals were added: + + - :manual:`cmake-buildsystem(7)` + - :manual:`cmake-commands(7)`, replacing ``cmakecommands(1)`` + and ``cmakecompat(1)`` + - :manual:`cmake-developer(7)` + - :manual:`cmake-generator-expressions(7)` + - :manual:`cmake-generators(7)` + - :manual:`cmake-language(7)` + - :manual:`cmake-modules(7)`, replacing ``cmakemodules(1)`` + - :manual:`cmake-packages(7)` + - :manual:`cmake-policies(7)`, replacing ``cmakepolicies(1)`` + - :manual:`cmake-properties(7)`, replacing ``cmakeprops(1)`` + - :manual:`cmake-qt(7)` + - :manual:`cmake-toolchains(7)` + - :manual:`cmake-variables(7)`, replacing ``cmakevars(1)`` + +* Release notes for CMake 3.0.0 and above will now be included with + the html documentation. + +New Features +============ + +Syntax +------ + +* The CMake language has been extended with + :ref:`Bracket Argument` and :ref:`Bracket Comment` + syntax inspired by Lua long brackets:: + + set(x [===[bracket argument]===] #[[bracket comment]]) + + Content between equal-length open- and close-brackets is taken + literally with no variable replacements. + + .. warning:: + This syntax change could not be made in a fully compatible + way. No policy is possible because syntax parsing occurs before + any chance to set a policy. Existing code using an unquoted + argument that starts with an open bracket will be interpreted + differently without any diagnostic. Fortunately the syntax is + obscure enough that this problem is unlikely in practice. + +Generators +---------- + +* A new :generator:`CodeLite` extra generator is available + for use with the Makefile or Ninja generators. + +* A new :generator:`Kate` extra generator is available + for use with the Makefile or Ninja generators. + +* The :generator:`Ninja` generator learned to use ``ninja`` job pools + when specified by a new :prop_gbl:`JOB_POOLS` global property. + +Commands +-------- + +* The :command:`add_library` command learned a new ``INTERFACE`` + library type. Interface libraries have no build rules but may + have properties defining + :manual:`usage requirements ` + and may be installed, exported, and imported. This is useful to + create header-only libraries that have concrete link dependencies + on other libraries. + +* The :command:`export()` command learned a new ``EXPORT`` mode that + retrieves the list of targets to export from an export set configured + by the :command:`install(TARGETS)` command ``EXPORT`` option. This + makes it easy to export from the build tree the same targets that + are exported from the install tree. + +* The :command:`export` command learned to work with multiple dependent + export sets, thus allowing multiple packages to be built and exported + from a single tree. The feature requires CMake to wait until the + generation step to write the output file. This means one should not + :command:`include` the generated targets file later during project + configuration because it will not be available. + Use :ref:`Alias Targets` instead. See policy :policy:`CMP0024`. + +* The :command:`install(FILES)` command learned to support + :manual:`generator expressions ` + in the list of files. + +* The :command:`project` command learned to set some version variables + to values specified by the new ``VERSION`` option or to empty strings. + See policy :policy:`CMP0048`. + +* The :command:`string` command learned a new ``CONCAT`` mode. + It is particularly useful in combination with the new + :ref:`Bracket Argument` syntax. + +* The :command:`unset` command learned a ``PARENT_SCOPE`` option + matching that of the :command:`set` command. + +* The :command:`include_external_msproject` command learned + to handle non-C++ projects like ``.vbproj`` or ``.csproj``. + +* The :command:`ctest_update` command learned to update work trees + managed by the Perforce (p4) version control tool. + +* The :command:`message` command learned a ``DEPRECATION`` mode. Such + messages are not issued by default, but may be issued as a warning if + :variable:`CMAKE_WARN_DEPRECATED` is enabled, or as an error if + :variable:`CMAKE_ERROR_DEPRECATED` is enabled. + +* The :command:`target_link_libraries` command now allows repeated use of + the ``LINK_PUBLIC`` and ``LINK_PRIVATE`` keywords. + +Variables +--------- + +* Variable :variable:`CMAKE_FIND_NO_INSTALL_PREFIX` has been + introduced to tell CMake not to add the value of + :variable:`CMAKE_INSTALL_PREFIX` to the + :variable:`CMAKE_SYSTEM_PREFIX_PATH` variable by default. + This is useful when building a project that installs some + of its own dependencies to avoid finding files it is about + to replace. + +* Variable :variable:`CMAKE_STAGING_PREFIX` was introduced for use + when cross-compiling to specify an installation prefix on the + host system that differs from a :variable:`CMAKE_INSTALL_PREFIX` + value meant for the target system. + +* Variable :variable:`CMAKE_SYSROOT` was introduced to specify the + toolchain SDK installation prefix, typically for cross-compiling. + This is used to pass a ``--sysroot`` option to the compiler and + as a prefix searched by ``find_*`` commands. + +* Variable :variable:`CMAKE__COMPILER_TARGET` was introduced + for use when cross-compiling to specify the target platform in the + :ref:`toolchain file ` specified by the + :variable:`CMAKE_TOOLCHAIN_FILE` variable. + This is used to pass an option such as ``--target=`` to some + cross-compiling compiler drivers. + +* Variable :variable:`CMAKE_MAP_IMPORTED_CONFIG_` has been + introduced to optionally initialize the + :prop_tgt:`MAP_IMPORTED_CONFIG_` target property. + +Properties +---------- + +* The :prop_dir:`ADDITIONAL_MAKE_CLEAN_FILES` directory property + learned to support + :manual:`generator expressions `. + +* A new directory property :prop_dir:`CMAKE_CONFIGURE_DEPENDS` + was introduced to allow projects to specify additional + files on which the configuration process depends. CMake will + re-run at build time when one of these files is modified. + Previously this was only possible to achieve by specifying + such files as the input to a :command:`configure_file` command. + +* A new :ref:`Qt AUTORCC` feature replaces the need to + invoke ``qt4_add_resources()`` by allowing ``.qrc`` files to + be listed as target sources. + +* A new :ref:`Qt AUTOUIC` feature replaces the need to + invoke ``qt4_wrap_ui()``. + +* Test properties learned to support + :manual:`generator expressions `. + This is useful to specify per-configuration values for test + properties like :prop_test:`REQUIRED_FILES` and + :prop_test:`WORKING_DIRECTORY`. + +* A new :prop_test:`SKIP_RETURN_CODE` test property was introduced + to tell :manual:`ctest(1)` to treat a particular test return code as + if the test were not run. This is useful for test drivers to report + that certain test requirements were not available. + +* New types of :ref:`Compatible Interface Properties` were introduced, + namely the :prop_tgt:`COMPATIBLE_INTERFACE_NUMBER_MAX` and + :prop_tgt:`COMPATIBLE_INTERFACE_NUMBER_MIN` for calculating numeric + maximum and minimum values respectively. + +Modules +------- + +* The :module:`CheckTypeSize` module ``check_type_size`` macro and + the :module:`CheckStructHasMember` module ``check_struct_has_member`` + macro learned a new ``LANGUAGE`` option to optionally check C++ types. + +* The :module:`ExternalData` module learned to work with no + URL templates if a local store is available. + +* The :module:`ExternalProject` function ``ExternalProject_Add`` + learned a new ``GIT_SUBMODULES`` option to specify a subset + of available submodules to checkout. + +* A new :module:`FindBacktrace` module has been added to support + :command:`find_package(Backtrace)` calls. + +* A new :module:`FindLua` module has been added to support + :command:`find_package(Lua)` calls. + +* The :module:`FindBoost` module learned a new ``Boost_NAMESPACE`` + option to change the ``boost`` prefix on library names. + +* The :module:`FindBoost` module learned to control search + for libraries with the ``g`` tag (for MS debug runtime) with + a new ``Boost_USE_DEBUG_RUNTIME`` option. It is ``ON`` by + default to preserve existing behavior. + +* The :module:`FindJava` and :module:`FindJNI` modules learned + to use a ``JAVA_HOME`` CMake variable or environment variable, + and then try ``/usr/libexec/java_home`` on OS X. + +* The :module:`UseJava` module ``add_jar`` function learned a new + ``MANIFEST`` option to pass the ``-m`` option to ``jar``. + +* A new :module:`CMakeFindDependencyMacro` module was introduced with + a ``find_dependency`` macro to find transitive dependencies in + a :manual:`package configuration file `. Such + dependencies are omitted by the listing of the :module:`FeatureSummary` + module. + +* The :module:`FindQt4` module learned to create :ref:`Imported Targets` + for Qt executables. This helps disambiguate when using multiple + :manual:`Qt versions ` in the same buildsystem. + +* The :module:`FindRuby` module learned to search for Ruby 2.0 and 2.1. + +Generator Expressions +--------------------- + +* New ``$`` and ``$`` + :manual:`generator expressions ` + have been added. + +* The ``$`` + :manual:`generator expression ` now has + a variant which takes no argument. This is equivalent to the + ``$`` expression. + +* New ``$`` and ``$`` + :manual:`generator expressions ` + generator expressions have been added. + +* A new ``$`` + :manual:`generator expression ` has + been added. + +Other +----- + +* The :manual:`cmake(1)` ``-E`` option learned a new ``sleep`` command. + +* The :manual:`ccmake(1)` dialog learned to honor the + :prop_cache:`STRINGS` cache entry property to cycle through + the enumerated list of possible values. + +* The :manual:`cmake-gui(1)` dialog learned to remember window + settings between sessions. + +* The :manual:`cmake-gui(1)` dialog learned to remember the type + of a cache entry for completion in the ``Add Entry`` dialog. + +New Diagnostics +=============== + +* Directories named in the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` + target property of imported targets linked conditionally by a + :manual:`generator expression ` + were not checked for existence. Now they are checked. + See policy :policy:`CMP0027`. + +* Build target names must now match a validity pattern and may no longer + conflict with CMake-defined targets. See policy :policy:`CMP0037`. + +* Build targets that specify themselves as a link dependency were + silently accepted but are now diagnosed. See :policy:`CMP0038`. + +* The :command:`target_link_libraries` command used to silently ignore + calls specifying as their first argument build targets created by + :command:`add_custom_target` but now diagnoses this mistake. + See policy :policy:`CMP0039`. + +* The :command:`add_custom_command` command used to silently ignore + calls specifying the ``TARGET`` option with a non-existent target + but now diagnoses this mistake. See policy :policy:`CMP0040`. + +* Relative paths in the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` + target property used to be silently accepted if they contained a + :manual:`generator expression ` + but are now rejected. See policy :policy:`CMP0041`. + +* The :command:`get_target_property` command learned to reject calls + specifying a non-existent target. See policy :policy:`CMP0045`. + +* The :command:`add_dependencies` command learned to reject calls + specifying a dependency on a non-existent target. + See policy :policy:`CMP0046`. + +* Link dependency analysis learned to assume names containing ``::`` + refer to :ref:`Alias Targets` or :ref:`Imported Targets`. It will + now produce an error if such a linked target is missing. Previously + in this case CMake generated a link line that failed at build time. + See policy :policy:`CMP0028`. + +* When the :command:`project` or :command:`enable_language` commands + initialize support for a language, it is now an error if the full + path to the compiler cannot be found and stored in the corresponding + :variable:`CMAKE__COMPILER` variable. This produces nicer error + messages up front and stops processing when no working compiler + is known to be available. + +* Target sources specified with the :command:`add_library` or + :command:`add_executable` command learned to reject items which + require an undocumented extra layer of variable expansion. + See policy :policy:`CMP0049`. + +* Use of :command:`add_custom_command` undocumented ``SOURCE`` + signatures now results in an error. See policy :policy:`CMP0050`. + +Deprecated and Removed Features +=============================== + +* Compatibility options supporting code written for CMake versions + prior to 2.4 have been removed. + +* Several long-outdated commands that should no longer be called + have been disallowed in new code by policies: + + - Policy :policy:`CMP0029` disallows :command:`subdir_depends` + - Policy :policy:`CMP0030` disallows :command:`use_mangled_mesa` + - Policy :policy:`CMP0031` disallows :command:`load_command` + - Policy :policy:`CMP0032` disallows :command:`output_required_files` + - Policy :policy:`CMP0033` disallows :command:`export_library_dependencies` + - Policy :policy:`CMP0034` disallows :command:`utility_source` + - Policy :policy:`CMP0035` disallows :command:`variable_requires` + - Policy :policy:`CMP0036` disallows :command:`build_name` + +* The :manual:`cmake(1)` ``-i`` wizard mode has been removed. + Instead use an interactive dialog such as :manual:`ccmake(1)` + or use the ``-D`` option to set cache values from the command line. + +* The builtin documentation formatters that supported command-line + options such as ``--help-man`` and ``--help-html`` have been removed + in favor of the above-mentioned new documentation system. These and + other command-line options that used to generate man- and html- + formatted pages no longer work. The :manual:`cmake(1)` + ``--help-custom-modules`` option now produces a warning at runtime + and generates a minimal document that reports the limitation. + +* The :prop_dir:`COMPILE_DEFINITIONS_` directory properties and the + :prop_tgt:`COMPILE_DEFINITIONS_` target properties have been + deprecated. Instead set the corresponding :prop_dir:`COMPILE_DEFINITIONS` + directory property or :prop_tgt:`COMPILE_DEFINITIONS` target property and + use :manual:`generator expressions ` like + ``$`` to specify per-configuration definitions. + See policy :policy:`CMP0043`. + +* The :prop_tgt:`LOCATION` target property should no longer be read from + non-IMPORTED targets. It does not make sense in multi-configuration + generators since the build configuration is not known while configuring + the project. It has been superseded by the ``$`` generator + expression. See policy :policy:`CMP0026`. + +* The :prop_tgt:`COMPILE_FLAGS` target property is now documented + as deprecated, though no warning is issued. Use the + :prop_tgt:`COMPILE_OPTIONS` target property or the + :command:`target_compile_options` command instead. + +* The :module:`GenerateExportHeader` module ``add_compiler_export_flags`` + function is now deprecated. It has been superseded by the + :prop_tgt:`_VISIBILITY_PRESET` and + :prop_tgt:`VISIBILITY_INLINES_HIDDEN` target properties. + +Other Changes +============= + +* The version scheme was changed to use only two components for + the feature level instead of three. The third component will + now be used for bug-fix releases or the date of development versions. + See the :variable:`CMAKE_VERSION` variable documentation for details. + +* The default install locations of CMake itself on Windows and + OS X no longer contain the CMake version number. This allows + for easy replacement without re-generating local build trees + manually. + +* Generators for Visual Studio 10 (2010) and later were renamed to + include the product year like generators for older VS versions: + + - ``Visual Studio 10`` -> :generator:`Visual Studio 10 2010` + - ``Visual Studio 11`` -> :generator:`Visual Studio 11 2012` + - ``Visual Studio 12`` -> :generator:`Visual Studio 12 2013` + + This clarifies which generator goes with each Visual Studio + version. The old names are recognized for compatibility. + +* The :variable:`CMAKE__COMPILER_ID` value for Apple-provided + Clang is now ``AppleClang``. It must be distinct from upstream + Clang because the version numbers differ. + See policy :policy:`CMP0025`. + +* The :variable:`CMAKE__COMPILER_ID` value for ``qcc`` on QNX + is now ``QCC``. It must be distinct from ``GNU`` because the + command-line options differ. See policy :policy:`CMP0047`. + +* On 64-bit OS X the :variable:`CMAKE_HOST_SYSTEM_PROCESSOR` value + is now correctly detected as ``x86_64`` instead of ``i386``. + +* On OS X, CMake learned to enable behavior specified by the + :prop_tgt:`MACOSX_RPATH` target property by default. This activates + use of ``@rpath`` for runtime shared library searches. + See policy :policy:`CMP0042`. + +* The :command:`build_command` command now returns a :manual:`cmake(1)` + ``--build`` command line instead of a direct invocation of the native + build tool. When using ``Visual Studio`` generators, CMake and CTest + no longer require :variable:`CMAKE_MAKE_PROGRAM` to be located up front. + Selection of the proper msbuild or devenv tool is now performed as + late as possible when the solution (``.sln``) file is available so + it can depend on project content. + +* The :manual:`cmake(1)` ``--build`` command now shares its own stdout + and stderr pipes with the native build tool by default. + The ``--use-stderr`` option that once activated this is now ignored. + +* The ``$`` and ``$`` + :manual:`generator expressions ` + used to perform case-insensitive comparison but have now been + corrected to perform case-sensitive comparison. + See policy :policy:`CMP0044`. + +* The builtin ``edit_cache`` target will no longer select + :manual:`ccmake(1)` by default when no interactive terminal will + be available (e.g. with :generator:`Ninja` or an IDE generator). + Instead :manual:`cmake-gui(1)` will be preferred if available. + +* The :module:`ExternalProject` download step learned to + re-attempt download in certain cases to be more robust to + temporary network failure. + +* The :module:`FeatureSummary` no longer lists transitive + dependencies since they were not directly requested by the + current project. + +* The ``cmake-mode.el`` major Emacs editing mode has been cleaned + up and enhanced in several ways. + +* Include directories specified in the + :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` of :ref:`Imported Targets` + are treated as ``SYSTEM`` includes by default when handled as + :ref:`usage requirements `. diff --git a/cmake/share/cmake-3.31/Help/release/3.1.rst b/cmake/share/cmake-3.31/Help/release/3.1.rst new file mode 100644 index 0000000000000000000000000000000000000000..81227417cda78cbebe54b2bcafc3da08a32c72dd --- /dev/null +++ b/cmake/share/cmake-3.31/Help/release/3.1.rst @@ -0,0 +1,425 @@ +CMake 3.1 Release Notes +*********************** + +.. only:: html + + .. contents:: + +Changes made since CMake 3.0 include the following. + +Documentation Changes +===================== + +* A new :manual:`cmake-compile-features(7)` manual was added. + +New Features +============ + +Generators +---------- + +* The :generator:`Visual Studio 14 2015` generator was added. + +Windows Phone and Windows Store +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +* Generators for Visual Studio 11 (2012) and above learned to generate + projects for Windows Phone and Windows Store. One may set the + :variable:`CMAKE_SYSTEM_NAME` variable to ``WindowsPhone`` + or ``WindowsStore`` on the :manual:`cmake(1)` command-line + or in a :variable:`CMAKE_TOOLCHAIN_FILE` to activate these platforms. + Also set :variable:`CMAKE_SYSTEM_VERSION` to ``8.0`` or ``8.1`` to + specify the version of Windows to be targeted. + +NVIDIA Nsight Tegra +^^^^^^^^^^^^^^^^^^^ + +* Generators for Visual Studio 10 (2010) and above learned to generate + projects for NVIDIA Nsight Tegra Visual Studio Edition. One may set + the :variable:`CMAKE_SYSTEM_NAME` variable to ``Android`` on the + :manual:`cmake(1)` command-line or in a :variable:`CMAKE_TOOLCHAIN_FILE` + to activate this platform. + +Syntax +------ + +* The :manual:`cmake-language(7)` syntax for :ref:`Variable References` and + :ref:`Escape Sequences` was simplified in order to allow a much faster + implementation. See policy :policy:`CMP0053`. + +* The :command:`if` command no longer automatically dereferences + variables named in quoted or bracket arguments. See policy + :policy:`CMP0054`. + +Commands +-------- + +* The :command:`add_custom_command` command learned to interpret + :manual:`cmake-generator-expressions(7)` in arguments to ``DEPENDS``. + +* The :command:`export(PACKAGE)` command learned to check the + :variable:`CMAKE_EXPORT_NO_PACKAGE_REGISTRY` variable to skip + exporting the package. + +* The :command:`file(STRINGS)` command gained a new ``ENCODING`` + option to enable extraction of ``UTF-8`` strings. + +* The :command:`find_package` command learned to check the + :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` and + :variable:`CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY` + variables to skip searching the package registries. + +* The :command:`get_property` command learned a new ``INSTALL`` scope + for properties. + +* The :command:`install` command learned a ``MESSAGE_NEVER`` option + to avoid output during installation. + +* The :command:`set_property` command learned a new ``INSTALL`` scope + for properties. + +* The :command:`string` command learned a new ``GENEX_STRIP`` subcommand + which removes + :manual:`generator expression `. + +* The :command:`string` command learned a new ``UUID`` subcommand + to generate a universally unique identifier. + +* New :command:`target_compile_features` command allows populating the + :prop_tgt:`COMPILE_FEATURES` target property, just like any other + build variable. + +* The :command:`target_sources` command was added to add to the + :prop_tgt:`SOURCES` target property. + +Variables +--------- + +* The Visual Studio generators for versions 8 (2005) and above + learned to read the target platform name from a new + :variable:`CMAKE_GENERATOR_PLATFORM` variable when it is + not specified as part of the generator name. The platform + name may be specified on the :manual:`cmake(1)` command line + with the ``-A`` option, e.g. ``-G "Visual Studio 12 2013" -A x64``. + +* The :variable:`CMAKE_GENERATOR_TOOLSET` variable may now be + initialized in a toolchain file specified by the + :variable:`CMAKE_TOOLCHAIN_FILE` variable. This is useful + when cross-compiling with the Xcode or Visual Studio + generators. + +* The :variable:`CMAKE_INSTALL_MESSAGE` variable was introduced to + optionally reduce output installation. + +Properties +---------- + +* New :prop_tgt:`CXX_STANDARD` and :prop_tgt:`CXX_EXTENSIONS` target + properties may specify values which CMake uses to compute required + compile options such as ``-std=c++11`` or ``-std=gnu++11``. The + :variable:`CMAKE_CXX_STANDARD` and :variable:`CMAKE_CXX_EXTENSIONS` + variables may be set to initialize the target properties. + +* New :prop_tgt:`C_STANDARD` and :prop_tgt:`C_EXTENSIONS` target + properties may specify values which CMake uses to compute required + compile options such as ``-std=c11`` or ``-std=gnu11``. The + :variable:`CMAKE_C_STANDARD` and :variable:`CMAKE_C_EXTENSIONS` + variables may be set to initialize the target properties. + +* New :prop_tgt:`COMPILE_FEATURES` target property may contain a list + of features required to compile a target. CMake uses this + information to ensure that the compiler in use is capable of building + the target, and to add any necessary compile flags to support language + features. + +* New :prop_tgt:`COMPILE_PDB_NAME` and + :prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY` target properties + were introduced to specify the MSVC compiler program database + file location (``cl /Fd``). This complements the existing + :prop_tgt:`PDB_NAME` and :prop_tgt:`PDB_OUTPUT_DIRECTORY` + target properties that specify the linker program database + file location (``link /pdb``). + +* The :prop_tgt:`INTERFACE_LINK_LIBRARIES` target property now supports + a ``$`` + :manual:`generator expression `. + +* A new :prop_tgt:`INTERFACE_SOURCES` target property was introduced. This is + consumed by dependent targets, which compile and link the listed sources. + +* The :prop_tgt:`SOURCES` target property now contains + :manual:`generator expression ` + such as ``TARGET_OBJECTS`` when read at configure time, if + policy :policy:`CMP0051` is ``NEW``. + +* The :prop_tgt:`SOURCES` target property now generally supports + :manual:`generator expression `. The + generator expressions may be used in the :command:`add_library` and + :command:`add_executable` commands. + +* It is now possible to write and append to the :prop_tgt:`SOURCES` target + property. The :variable:`CMAKE_DEBUG_TARGET_PROPERTIES` variable may be + used to trace the origin of sources. + +* A :prop_sf:`VS_DEPLOYMENT_CONTENT` source file property was added + to tell the Visual Studio generators to mark content for deployment + in Windows Phone and Windows Store projects. + +* A :prop_sf:`VS_DEPLOYMENT_LOCATION` source file property was added + to tell the Visual Studio generators the relative location of content + marked for deployment in Windows Phone and Windows Store projects. + +* The :prop_tgt:`VS_WINRT_COMPONENT` target property was created to + tell Visual Studio generators to compile a shared library as a + Windows Runtime (WinRT) component. + +* The :generator:`Xcode` generator learned to check source + file properties :prop_sf:`XCODE_EXPLICIT_FILE_TYPE` and + :prop_sf:`XCODE_LAST_KNOWN_FILE_TYPE` for a custom Xcode + file reference type. + +Modules +------- + +* The :module:`BundleUtilities` module learned to resolve and replace + ``@rpath`` placeholders on OS X to correctly bundle applications + using them. + +* The :module:`CMakePackageConfigHelpers` module + :command:`configure_package_config_file` command learned a new + ``INSTALL_PREFIX`` option to generate package configuration files + meant for a prefix other than :variable:`CMAKE_INSTALL_PREFIX`. + +* The :module:`CheckFortranSourceCompiles` module was added to + provide a ``CHECK_Fortran_SOURCE_COMPILES`` macro. + +* The :module:`ExternalData` module learned to tolerate a ``DATA{}`` + reference to a missing source file with a warning instead of + rejecting it with an error. This helps developers write new + ``DATA{}`` references to test reference outputs that have not + yet been created. + +* The :module:`ExternalProject` module learned to support lzma-compressed + source tarballs with ``.7z``, ``.tar.xz``, and ``.txz`` extensions. + +* The :module:`ExternalProject` module ``ExternalProject_Add`` command + learned a new ``BUILD_ALWAYS`` option to cause the external project + build step to run every time the host project is built. + +* The :module:`ExternalProject` module ``ExternalProject_Add`` command + learned a new ``EXCLUDE_FROM_ALL`` option to cause the external + project target to have the :prop_tgt:`EXCLUDE_FROM_ALL` target + property set. + +* The :module:`ExternalProject` module ``ExternalProject_Add_Step`` command + learned a new ``EXCLUDE_FROM_MAIN`` option to cause the step to not be + a direct dependency of the main external project target. + +* The :module:`ExternalProject` module ``ExternalProject_Add`` command + learned a new ``DOWNLOAD_NO_PROGRESS`` option to disable progress + output while downloading the source tarball. + +* The :module:`FeatureSummary` module ``feature_summary`` API + learned to accept multiple values for the ``WHAT`` option and + combine them appropriately. + +* The :module:`FindCUDA` module learned to support ``fatbin`` and ``cubin`` + modules. + +* The :module:`FindGTest` module ``gtest_add_tests`` macro learned + a new ``AUTO`` option to automatically read the :prop_tgt:`SOURCES` + target property of the test executable and scan the source files + for tests to be added. + +* The :module:`FindGLEW` module now provides imported targets. + +* The :module:`FindGLUT` module now provides imported targets. + +* The :module:`FindHg` module gained a new ``Hg_WC_INFO`` macro to + help run ``hg`` to extract information about a Mercurial work copy. + +* The :module:`FindOpenCL` module was introduced. + +* The :module:`FindOpenMP` module learned to support Fortran. + +* The :module:`FindPkgConfig` module learned to use the ``PKG_CONFIG`` + environment variable value as the ``pkg-config`` executable, if set. + +* The :module:`FindXercesC` module was introduced. + +* The :module:`FindZLIB` module now provides imported targets. + +* The :module:`GenerateExportHeader` module ``generate_export_header`` + function learned to allow use with :ref:`Object Libraries`. + +* The :module:`InstallRequiredSystemLibraries` module gained a new + ``CMAKE_INSTALL_OPENMP_LIBRARIES`` option to install MSVC OpenMP + runtime libraries. + +* The :module:`UseSWIG` module learned to detect the module name + from ``.i`` source files if possible to avoid the need to set + the ``SWIG_MODULE_NAME`` source file property explicitly. + +* The :module:`WriteCompilerDetectionHeader` module was added to allow + creation of a portable header file for compiler optional feature detection. + +Generator Expressions +--------------------- + +* New ``COMPILE_FEATURES`` + :manual:`generator expression ` allows + setting build properties based on available compiler features. + +CTest +----- + +* The :command:`ctest_coverage` command learned to read variable + ``CTEST_COVERAGE_EXTRA_FLAGS`` to set ``CoverageExtraFlags``. + +* The :command:`ctest_coverage` command learned to support + Intel coverage files with the ``codecov`` tool. + +* The :command:`ctest_memcheck` command learned to support sanitizer + modes, including ``AddressSanitizer``, ``MemorySanitizer``, + ``ThreadSanitizer``, and ``UndefinedBehaviorSanitizer``. + Options may be set using the new + :variable:`CTEST_MEMORYCHECK_SANITIZER_OPTIONS` variable. + +CPack +----- + +* :manual:`cpack(1)` gained an ``IFW`` generator to package using + Qt Framework Installer tools. See the :cpack_gen:`CPack IFW Generator`. + +* :manual:`cpack(1)` gained ``7Z`` and ``TXZ`` generators supporting + lzma-compressed archives. + +* The :cpack_gen:`CPack DEB Generator` learned a new + :variable:`CPACK_DEBIAN_COMPRESSION_TYPE` variable to set the + tarball compression type. + +* The :cpack_gen:`CPack WIX Generator` learned to support + a :prop_inst:`CPACK_WIX_ACL` installed file property to + specify an Access Control List. + +Other +----- + +* The :manual:`cmake(1)` ``-E`` option learned a new ``env`` command. + +* The :manual:`cmake(1)` ``-E tar`` command learned to support + lzma-compressed files. + +* :ref:`Object Libraries` may now have extra sources that do not + compile to object files so long as they would not affect linking + of a normal library (e.g. ``.dat`` is okay but not ``.def``). + +* Visual Studio generators for VS 8 and later learned to support + the ``ASM_MASM`` language. + +* The Visual Studio generators learned to treat ``.hlsl`` source + files as High Level Shading Language sources (using ``FXCompile`` + in ``.vcxproj`` files). Source file properties + :prop_sf:`VS_SHADER_TYPE`, :prop_sf:`VS_SHADER_MODEL`, and + :prop_sf:`VS_SHADER_ENTRYPOINT` were added added to specify the + shader type, model, and entry point name. + +New Diagnostics +=============== + +* Policy :policy:`CMP0052` introduced to control directories in the + :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` of exported targets. + +Deprecated and Removed Features +=============================== + +* In CMake 3.0 the :command:`target_link_libraries` command + accidentally began allowing unquoted arguments to use + :manual:`generator expressions ` + containing a (``;`` separated) list within them. For example:: + + set(libs B C) + target_link_libraries(A PUBLIC $) + + This is equivalent to writing:: + + target_link_libraries(A PUBLIC $) + + and was never intended to work. It did not work in CMake 2.8.12. + Such generator expressions should be in quoted arguments:: + + set(libs B C) + target_link_libraries(A PUBLIC "$") + + CMake 3.1 again requires the quotes for this to work correctly. + +* Prior to CMake 3.1 the Makefile generators did not escape ``#`` + correctly inside make variable assignments used in generated + makefiles, causing them to be treated as comments. This made + code like:: + + add_compile_options(-Wno-#pragma-messages) + + not work in Makefile generators, but work in other generators. + Now it is escaped correctly, making the behavior consistent + across generators. However, some projects may have tried to + workaround the original bug with code like:: + + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-\\#pragma-messages") + + This added the needed escape for Makefile generators but also + caused other generators to pass ``-Wno-\#pragma-messages`` to + the shell, which would work only in POSIX shells. + Unfortunately the escaping fix could not be made in a compatible + way so this platform- and generator-specific workaround no + longer works. Project code may test the :variable:`CMAKE_VERSION` + variable value to make the workaround version-specific too. + +* Callbacks established by the :command:`variable_watch` command will no + longer receive the ``ALLOWED_UNKNOWN_READ_ACCESS`` access type when + the undocumented ``CMAKE_ALLOW_UNKNOWN_VARIABLE_READ_ACCESS`` variable is + set. Uninitialized variable accesses will always be reported as + ``UNKNOWN_READ_ACCESS``. + +* The :module:`CMakeDetermineVSServicePack` module now warns that + it is deprecated and should not longer be used. Use the + :variable:`CMAKE__COMPILER_VERSION` variable instead. + +* The :module:`FindITK` module has been removed altogether. + It was a thin-wrapper around ``find_package(ITK ... NO_MODULE)``. + This produces much clearer error messages when ITK is not found. + +* The :module:`FindVTK` module has been removed altogether. + It was a thin-wrapper around ``find_package(VTK ... NO_MODULE)``. + This produces much clearer error messages when VTK is not found. + + The module also provided compatibility support for finding VTK 4.0. + This capability has been dropped. + +Other Changes +============= + +* The :manual:`cmake-gui(1)` learned to capture output from child + processes started by the :command:`execute_process` command + and display it in the output window. + +* The :manual:`cmake-language(7)` internal implementation of generator + expression and list expansion parsers have been optimized and shows + non-trivial speedup on large projects. + +* The Makefile generators learned to use response files with GNU tools + on Windows to pass library directories and names to the linker. + +* When generating linker command-lines, CMake now avoids repeating + items corresponding to SHARED library targets. + +* Support for the Open Watcom compiler has been overhauled. + The :variable:`CMAKE__COMPILER_ID` is now ``OpenWatcom``, + and the :variable:`CMAKE__COMPILER_VERSION` now uses + the Open Watcom external version numbering. The external + version numbers are lower than the internal version number + by 11. + +* The ``cmake-mode.el`` major Emacs editing mode no longer + treats ``_`` as part of words, making it more consistent + with other major modes. diff --git a/cmake/share/cmake-3.31/Help/release/3.10.rst b/cmake/share/cmake-3.31/Help/release/3.10.rst new file mode 100644 index 0000000000000000000000000000000000000000..a892f37709f5e9e34d590b225f70ad20336685b1 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/release/3.10.rst @@ -0,0 +1,282 @@ +CMake 3.10 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.9 include the following. + +New Features +============ + +Platforms +--------- + +* The `flang`_ Fortran compiler is now supported, with compiler id ``Flang``. + +* A new minimal platform file for ``Midipix`` was added. + +* Support for the MSVC ARM64 architecture was added. + Visual Studio 2017 Update 4 and above offer an ARM64 toolchain. + +* Support for the IAR ARM Compiler was improved. + +.. _`flang`: https://github.com/flang-compiler/flang + +Generators +---------- + +* The :ref:`Makefile Generators` and the :generator:`Ninja` generator learned + to add compiler launcher tools like ccache along with the compiler for the + ``CUDA`` language (``C`` and ``CXX`` were supported previously). See the + :variable:`CMAKE__COMPILER_LAUNCHER` variable and + :prop_tgt:`_COMPILER_LAUNCHER` target property for details. + +* The :generator:`CodeBlocks` extra generator learned to optionally exclude + files from outside the project root directory from the generated project. + See the :variable:`CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES` variable. + +Commands +-------- + +* The :command:`cmake_host_system_information` command learned more keys + to get information about the processor capabilities and the host OS + version. + +* The :command:`configure_file` command learned to support indented + ``# cmakedefine`` and ``# cmakedefine01``. Spaces and/or tabs between + the ``#`` character and the ``cmakedefine``/``cmakedefine01`` words + are now understood and preserved in the output. + +* The :command:`execute_process` command gained a ``RESULTS_VARIABLE`` + option to collect a list of results from all children in a pipeline + of processes when multiple ``COMMAND`` arguments are given. + +* The :command:`include_guard` command was introduced to allow guarding + CMake scripts from being included more than once. The command supports + ``DIRECTORY`` and ``GLOBAL`` options to adjust the corresponding include guard + scope. If no options given, include guard is similar to basic variable-based + check. + +* The :command:`string` command learned a new ``PREPEND`` subcommand. + +* The :command:`string(TIMESTAMP)` command now supports ``%A`` + for full weekday name and ``%B`` for full month name. + +Variables +--------- + +* A :variable:`CMAKE_DIRECTORY_LABELS` variable was added to specify + labels for all tests in a directory. + +Properties +---------- + +* A :prop_tgt:`_CPPCHECK` target property and supporting + :variable:`CMAKE__CPPCHECK` variable were introduced to tell + the :ref:`Makefile Generators` and the :generator:`Ninja` generator to + run ``cppcheck`` with the compiler for ``C`` and ``CXX`` languages. + +* A :prop_dir:`LABELS` directory property was added to specify labels + for all targets and tests in a directory. + +* A :prop_dir:`TEST_INCLUDE_FILES` directory property was added to + list any number of files to be included when running tests with + :manual:`ctest(1)`. This generalizes the :prop_dir:`TEST_INCLUDE_FILE` + property. + +* The :prop_tgt:`VS_DOTNET_REFERENCEPROP__TAG_` + target property was added to support custom XML tags for reference + assemblies in C# targets. + +* Source file properties :prop_sf:`VS_SHADER_OUTPUT_HEADER_FILE` and + :prop_sf:`VS_SHADER_VARIABLE_NAME` have been added to specify more + details of ``.hlsl`` sources with :ref:`Visual Studio Generators`. + +Modules +------- + +* The :module:`FindCurses` module gained a ``CURSES_NEED_WIDE`` option + to request the wide-character variant. + +* The :module:`FindEXPAT` module now provides imported targets. + +* The :module:`FindFreetype` module now provides imported targets. + +* :module:`FindMPI` gained a number of new features, including: + + * Language-specific components have been added to the module. + * Many more MPI environments are now supported. + * The environmental support for Fortran has been improved. + * A user now has fine-grained control over the MPI selection process, + including passing custom parameters to the MPI compiler. + * The version of the implemented MPI standard is now being exposed. + * MPI-2 C++ bindings can now be detected and also suppressed if so desired. + * The available Fortran bindings are now being detected and verified. + * Various MPI-3 information can be requested, including the library version + and Fortran capabilities of the individual bindings. + * Statically linked MPI implementations are supported. + +* A :module:`FindOpenACC` module was added to detect compiler support + for OpenACC. Currently only supports PGI, GNU and Cray compilers. + +* The :module:`FindOpenGL` module gained support for GLVND on Linux. + +* The :module:`FindOpenMP` module gained support for + language-specific components. + +* A :module:`FindPatch` module was added to find the ``patch`` + command-line executable. + +* The :module:`FindProtobuf` module :command:`protobuf_generate_cpp` command + gained a ``DESCRIPTORS`` option to generate descriptor files. + +* The :module:`GoogleTest` module gained a new command + :command:`gtest_discover_tests` implementing dynamic (build-time) test + discovery. Unlike the source parsing approach, dynamic discovery executes + the test (in 'list available tests' mode) at build time to discover tests. + This is robust against unusual ways of labeling tests, provides much better + support for advanced features such as parameterized tests, and does not + require re-running CMake to discover added or removed tests within a test + executable. Note that a breaking change was made in CMake 3.10.3 to address + an ambiguity of the ``TIMEOUT`` keyword (see :ref:`Release Notes 3.10.3`). + +* The :module:`InstallRequiredSystemLibraries` module gained support + for installing Intel compiler runtimes. + +Autogen +------- + +* When using :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC` with a + multi configuration generator (e.g. :generator:`Xcode`), + included ``*.moc``, ``moc_*.cpp`` and ``ui_*.h`` files are generated in + ``/include_`` instead of + ``/include``. + +* When using :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC`, + source files that are :prop_sf:`GENERATED` will be processed as well. + They were ignored by :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC` + in earlier releases. + See policy :policy:`CMP0071`. + +* When using :prop_tgt:`AUTOMOC`, CMake searches for the strings ``Q_OBJECT``, + ``Q_GADGET`` or ``Q_NAMESPACE`` in a source file to determine if it needs + to be ``moc`` processed. The new :variable:`CMAKE_AUTOMOC_MACRO_NAMES` + variable and :prop_tgt:`AUTOMOC_MACRO_NAMES` target property may be set + to register additional strings (macro names) to search for. + +* When using :prop_tgt:`AUTOMOC`, the new + :variable:`CMAKE_AUTOMOC_COMPILER_PREDEFINES` variable and + :prop_tgt:`AUTOMOC_COMPILER_PREDEFINES` target property specify whether + to enable or disable the generation of the compiler pre definitions file + ``moc_predefs.h``. + +CTest +----- + +* A :variable:`CTEST_LABELS_FOR_SUBPROJECTS` CTest module variable and CTest + script variable were added to specify a list of labels that should be + treated as subprojects by CDash. To use this value in both the CTest module + and the ctest command line :ref:`Dashboard Client` mode (e.g. ``ctest -S``) + set it in the ``CTestConfig.cmake`` config file. + +CPack +----- + +* A :cpack_gen:`CPack FreeBSD Generator` was added for FreeBSD ``pkg(8)``. + +* The :cpack_gen:`CPack DEB Generator` was enabled on Windows. While not + fully featured (due to the lack of external UNIX tools) this will allow + building basic cross-platform Debian packages. + +* The :cpack_gen:`CPack DEB Generator` learned to set package release + version in ``Version`` info property. + See the :variable:`CPACK_DEBIAN_PACKAGE_RELEASE` variable. + +* The :cpack_gen:`CPack DEB Generator` learned more strict package + version checking that complies with Debian rules. + +* The :module:`CPackIFW` module :command:`cpack_ifw_configure_component` and + :command:`cpack_ifw_configure_component_group` commands gained a new + ``REPLACES`` and ``CHECKABLE`` options. + +* The :cpack_gen:`CPack IFW Generator` gained new + :variable:`CPACK_IFW_PACKAGE_FILE_EXTENSION` variable to customize + target binary format. + +* The :cpack_gen:`CPack IFW Generator` gained new + :variable:`CPACK_IFW_REPOSITORIES_DIRECTORIES` variable to specify + additional repositories dirs that will be used to resolve and + repack dependent components. This feature is only available when + using QtIFW 3.1 or later. + +* The :cpack_gen:`CPack RPM Generator` and :cpack_gen:`CPack DEB Generator` + learned to set the package epoch version. + See :variable:`CPACK_RPM_PACKAGE_EPOCH` and + :variable:`CPACK_DEBIAN_PACKAGE_EPOCH` variables. + +Other +----- + +* The :manual:`cmake(1)` ``-E`` mode gained support for ``sha1sum``, + ``sha224sum``, ``sha256sum``, ``sha384sum``, and ``sha512sum``. + +* The graphviz output now distinguishes among the different dependency types + ``PUBLIC``, ``PRIVATE`` and ``INTERFACE`` and represents them in the output + graph as solid, dashed and dotted edges. + +Deprecated and Removed Features +=============================== + +* Support for building CMake itself with C++98 compilers was dropped. + CMake is now implemented using C++11. + +* Support for building CMake on HP-UX has been dropped pending better + support for C++11 and a port of libuv. See `CMake Issue 17137`_. + Use CMake 3.9 or lower instead for HP-UX support. + +.. _`CMake Issue 17137`: https://gitlab.kitware.com/cmake/cmake/-/issues/17137 + +Other Changes +============= + +* On FreeBSD the C++ compiler named ``c++`` is now the preferred default. + +* The :command:`file(GENERATE)` command now interprets relative paths + given to its ``OUTPUT`` and ``INPUT`` arguments with respect to the + caller's current binary and source directories, respectively. + See policy :policy:`CMP0070`. + +* The :command:`get_filename_component` ``PROGRAM`` mode semantics + have been revised to not tolerate unquoted spaces in the path + to the program while also accepting arguments. While technically + incompatible with the old behavior, it is expected that behavior + under typical use cases with properly-quoted command-lines has + not changed. + +Updates +======= + +Changes made since CMake 3.10.0 include the following. + +3.10.1 +------ + +* The :manual:`cmake-server(7)` ``codemodel`` response cross-references + field added by 3.10.0 has been dropped due to excessive memory usage. + Another approach will be needed to provide backtrace information. + +.. _`Release Notes 3.10.3`: + +3.10.3 +------ + +* CMake 3.10.1 added a ``TIMEOUT`` option to :command:`gtest_discover_tests` + from the :module:`GoogleTest` module. That keyword clashed with the + ``TIMEOUT`` test property, which is one of the common properties that + would be set with the command's ``PROPERTIES`` keyword, usually leading + to legal but unintended behavior. The keyword was changed to + ``DISCOVERY_TIMEOUT`` in CMake 3.10.3 to address this problem. The + ambiguous behavior of the :command:`gtest_discover_tests` command's + ``TIMEOUT`` keyword in 3.10.1 and 3.10.2 has not been preserved. diff --git a/cmake/share/cmake-3.31/Help/release/3.11.rst b/cmake/share/cmake-3.31/Help/release/3.11.rst new file mode 100644 index 0000000000000000000000000000000000000000..466cb2cd85b328a4a9753cfa9bc7d7d4f6c07d6b --- /dev/null +++ b/cmake/share/cmake-3.31/Help/release/3.11.rst @@ -0,0 +1,307 @@ +CMake 3.11 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.10 include the following. + +New Features +============ + +Platforms +--------- + +* TI C/C++ compilers are now supported by the :generator:`Ninja` generator. + +Generators +---------- + +* The :generator:`CodeBlocks` extra generator learned to check a + :variable:`CMAKE_CODEBLOCKS_COMPILER_ID` variable for a custom + compiler identification value to place in the project file. + +* The :ref:`Makefile Generators` and the :generator:`Ninja` generator learned + to add compiler launcher tools along with the compiler for the ``Fortran`` + language (``C``, ``CXX``, and ``CUDA`` were supported previously). + See the :variable:`CMAKE__COMPILER_LAUNCHER` variable and + :prop_tgt:`_COMPILER_LAUNCHER` target property for details. + +* :ref:`Visual Studio Generators` learned to support the ``COMPILE_LANGUAGE`` + :manual:`generator expression ` in + target-wide :prop_tgt:`COMPILE_DEFINITIONS`, + :prop_tgt:`INCLUDE_DIRECTORIES`, :prop_tgt:`COMPILE_OPTIONS`, and + :command:`file(GENERATE)`. See generator expression documentation + for caveats. + +* The :generator:`Xcode` generator learned to support the ``COMPILE_LANGUAGE`` + :manual:`generator expression ` in + target-wide :prop_tgt:`COMPILE_DEFINITIONS` and + :prop_tgt:`INCLUDE_DIRECTORIES`. It previously supported only + :prop_tgt:`COMPILE_OPTIONS` and :command:`file(GENERATE)`. + See generator expression documentation for caveats. + +Commands +-------- + +* :command:`add_library` and :command:`add_executable` commands can now be + called without any sources and will not complain as long as sources are + added later via the :command:`target_sources` command. + +* The :command:`file(DOWNLOAD)` and :command:`file(UPLOAD)` commands + gained ``NETRC`` and ``NETRC_FILE`` options to specify use of a + ``.netrc`` file. + +* The :command:`target_compile_definitions` command learned to set the + :prop_tgt:`INTERFACE_COMPILE_DEFINITIONS` property on + :ref:`Imported Targets`. + +* The :command:`target_compile_features` command learned to set the + :prop_tgt:`INTERFACE_COMPILE_FEATURES` property on :ref:`Imported Targets`. + +* The :command:`target_compile_options` command learned to set the + :prop_tgt:`INTERFACE_COMPILE_OPTIONS` property on :ref:`Imported Targets`. + +* The :command:`target_include_directories` command learned to set the + :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` property on + :ref:`Imported Targets`. + +* The :command:`target_sources` command learned to set the + :prop_tgt:`INTERFACE_SOURCES` property on :ref:`Imported Targets`. + +* The :command:`target_link_libraries` command learned to set the + :prop_tgt:`INTERFACE_LINK_LIBRARIES` property on :ref:`Imported Targets`. + +Variables +--------- + +* A :variable:`CMAKE_GENERATOR_INSTANCE` variable was introduced + to hold the selected instance of the generator's corresponding + native tools if multiple are available. This is used by the + :generator:`Visual Studio 15 2017` generator to hold the + selected instance of Visual Studio persistently. + +* A :variable:`CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS` variable was added + to enable setting of default permissions for directories created implicitly + during installation of files by :command:`install` and + :command:`file(INSTALL)`, e.g. during ``make install``. + +* A :variable:`CMAKE_JOB_POOLS` variable was added specify a value to use for + the :prop_gbl:`JOB_POOLS` property. This enables control over build + parallelism with command line configuration parameters when using the Ninja + generator. + +* The :variable:`CMAKE_NETRC` and :variable:`CMAKE_NETRC_FILE` variables + were added to specify use of a ``.netrc`` file by the + :command:`file(DOWNLOAD)` and :command:`file(UPLOAD)` commands and + the :module:`ExternalProject` module. + +* A :variable:`CMAKE_CUDA_SEPARABLE_COMPILATION` variable was added to + initialize the :prop_tgt:`CUDA_SEPARABLE_COMPILATION` target property + on targets when they are created. + +Properties +---------- + +* The :prop_sf:`COMPILE_DEFINITIONS` source file property learned to support + :manual:`generator expressions `. + +* A :prop_sf:`COMPILE_OPTIONS` source file property was added to manage list + of options to pass to the compiler. + +* An :prop_tgt:`IMPORTED_GLOBAL` target property was added to indicate + whether an :ref:`IMPORTED target ` is globally visible. + It is automatically set to a true value for targets created with the + ``GLOBAL`` option to :command:`add_library` or :command:`add_executable`. + Additionally, project code may now *promote* a local imported target + to be globally visible by setting this property to ``TRUE``. + +* An :prop_sf:`INCLUDE_DIRECTORIES` source file property was added to specify + list of preprocessor include file search directories. + +* Source file properties :prop_sf:`VS_SHADER_DISABLE_OPTIMIZATIONS` and + :prop_sf:`VS_SHADER_ENABLE_DEBUG` have been added to specify more + details of ``.hlsl`` sources with :ref:`Visual Studio Generators`. + +Modules +------- + +* The :module:`CheckIncludeFiles` module :command:`CHECK_INCLUDE_FILES` + command gained a ``LANGUAGE`` option to specify whether to check using the + ``C`` or ``CXX`` compiler. + +* The :module:`CMakePackageConfigHelpers` module + :command:`write_basic_package_version_file` command learned a new + ``SameMinorVersion`` mode for the ``COMPATIBILITY`` argument. + +* The :module:`ExternalProject` module learned to substitute ```` + in comments, commands, working directory and byproducts. + +* The :module:`ExternalProject` module gained ``NETRC`` and ``NETRC_FILE`` + options to specify use of a ``.netrc`` file. + +* A new :module:`FetchContent` module was added which supports populating + content at configure time using any of the download/update methods + supported by :command:`ExternalProject_Add`. This allows the content + to be used immediately during the configure stage, such as with + :command:`add_subdirectory`, etc. Hierarchical project structures are + well supported, allowing parent projects to override the content details + of child projects and ensuring content is not populated multiple times + throughout the whole project tree. + +* The :module:`FindBLAS` and :module:`FindLAPACK` modules learned to support + `FLAME`_ ``blis`` and ``libflame``. + +* The :module:`FindDoxygen` module :command:`doxygen_add_docs` function + now supports a new ``DOXYGEN_VERBATIM_VARS`` list variable. Any + ``DOXYGEN_...`` variable contained in that list will bypass the automatic + quoting logic, leaving its contents untouched when transferring them to the + output ``Doxyfile``. + +* A :module:`FindIconv` module was added to locate iconv support. + +* The :module:`GenerateExportHeader` module ``GENERATE_EXPORT_HEADER`` command + gained an ``INCLUDE_GUARD_NAME`` option to change the name of the include + guard symbol written to the generated export header. + Additionally, it now adds a comment after the closing ``#endif`` on the + generated export header's include guard. + +* The :module:`UseJava` module ``add_jar`` command gained a + ``GENERATE_NATIVE_HEADERS`` option to generate native header files + using ``javac -h`` for ``javac`` 1.8 or above. This supersedes + ``create_javah``, which no longer works with JDK 1.10 and above due + to removal of the ``javah`` tool by `JEP 313`_. + +.. _`FLAME`: https://github.com/flame +.. _`JEP 313`: https://openjdk.org/jeps/313 + +Autogen +------- + +* When using :prop_tgt:`AUTOMOC` or :prop_tgt:`AUTOUIC`, CMake now starts + multiple parallel ``moc`` or ``uic`` processes to reduce the build time. + A new :variable:`CMAKE_AUTOGEN_PARALLEL` variable and + :prop_tgt:`AUTOGEN_PARALLEL` target property may be set to specify the + number of parallel ``moc`` or ``uic`` processes to start. The default + is derived from the number of CPUs on the host. + +CTest +----- + +* The :command:`ctest_start` command no longer sets + :variable:`CTEST_RUN_CURRENT_SCRIPT` due to issues with scoping if it is + called from inside a function. Instead, it sets an internal variable in + CTest. However, setting :variable:`CTEST_RUN_CURRENT_SCRIPT` to 0 at the + global scope still prevents the script from being re-run at the end. + +CPack +----- + +* :manual:`cpack(1)` gained ``--trace`` and ``--trace-expand`` options. + +* The :cpack_gen:`CPack IFW Generator` gained new + :variable:`CPACK_IFW_PACKAGE_REMOVE_TARGET_DIR` variable to control + if the target directory should not be deleted when uninstalling. + +* The :cpack_gen:`CPack RPM Generator` learned to enable enforcing of execute + privileges on programs and shared libraries. + See :variable:`CPACK_RPM_INSTALL_WITH_EXEC` variable. + +* A :variable:`CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS` variable was added + which serves the same purpose during packaging (e.g. ``make package``) as the + :variable:`CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS` variable serves during + installation (e.g. ``make install``). + +Other +----- + +* :ref:`Alias Targets` may now alias :ref:`Imported Targets` that are + created with the ``GLOBAL`` option to :command:`add_library`. + +* :ref:`Interface Libraries` may now have custom properties set on them if + they start with either an underscore (``_``) or a lowercase ASCII character. + The original intention was to only allow properties which made sense for + ``INTERFACE`` libraries, but it also blocked usage of custom properties. + +* The :manual:`cmake(1)` ``--open `` command-line option was added + to open generated IDE projects like Visual Studio solutions or Xcode + projects. + +Deprecated and Removed Features +=============================== + +* An explicit deprecation diagnostic was added for policies ``CMP0037`` + through ``CMP0054`` (``CMP0036`` and below were already deprecated). + The :manual:`cmake-policies(7)` manual explains that the OLD behaviors + of all policies are deprecated and that projects should port to the + NEW behaviors. + +* The ``KDevelop3`` generator has been removed. + +Other Changes +============= + +* Policy :policy:`CMP0037` no longer reserves target names associated + with optional features, such as ``test`` and ``package``, unless + the corresponding feature is enabled. + +* The :module:`FindOpenGL` module now prefers GLVND libraries if available. + See policy :policy:`CMP0072`. + +* The minimum deployment target set in the + :variable:`CMAKE_OSX_DEPLOYMENT_TARGET` variable used to be only + applied for macOS regardless of the selected SDK. It is now properly + set for the target platform selected by :variable:`CMAKE_OSX_SYSROOT`. + For example, if the sysroot variable specifies an iOS SDK then the + value in ``CMAKE_OSX_DEPLOYMENT_TARGET`` is interpreted as minimum + iOS version. + +* The :generator:`Xcode` generator behavior of generating one project + file per :command:`project()` command may now be controlled with the + :variable:`CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT_ONLY` variable. + This could be useful to speed up the CMake generation step for + large projects and to work-around a bug in the ``ZERO_CHECK`` logic. + +* Since the ``CMakeCache.txt`` format does not support newlines in values, + values containing newlines are now truncated before writing to the file. + In addition, a warning comment is written to the cache file, and a warning + message is displayed to the user on the console. + +Updates +======= + +Changes made since CMake 3.11.0 include the following. + +3.11.1 +------ + +* The :module:`CheckIncludeFile` module ``check_include_file`` macro, + :module:`CheckIncludeFileCXX` module ``check_include_file_cxx`` macro, + and :module:`CheckIncludeFiles` module ``check_include_files`` macro + were taught to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable in + CMake 3.11.0. This has been reverted due to changing behavior of + checks for existing projects. It may be restored in the future + with a policy for compatibility. + +3.11.2 +------ + +* Calling :command:`add_library` to create an alias of an imported + target that is not globally visible now causes an error again as + it did prior to 3.11.0. This diagnostic was accidentally dropped + from CMake 3.11.0 and 3.11.1 by the change to allow globally visible + imported targets to be aliased. + +* The :module:`FindQt4` module ``qt4_wrap_cpp``, ``qt4_wrap_ui`` and + ``qt4_add_resources`` macros now set :prop_sf:`SKIP_AUTOMOC` and + :prop_sf:`SKIP_AUTOUIC` on their generated files. These files never + need to be processed by moc or uic, and we must say so explicitly to + account for policy :policy:`CMP0071`. + +3.11.3 +------ + +* CMake 3.11.0 introduced support for resolving symbolic links on + Windows in code paths that typically do so on UNIX. This has been + reverted due to breakage on ``subst`` drives. diff --git a/cmake/share/cmake-3.31/Help/release/3.12.rst b/cmake/share/cmake-3.31/Help/release/3.12.rst new file mode 100644 index 0000000000000000000000000000000000000000..8cf1e24b7ff3611e808401af89ebb7a707950a25 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/release/3.12.rst @@ -0,0 +1,305 @@ +CMake 3.12 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.11 include the following. + +New Features +============ + +Generators +---------- + +* The :ref:`Visual Studio Generators` for VS 2017 learned to support a + ``version=14.##`` option in the :variable:`CMAKE_GENERATOR_TOOLSET` + value (e.g. via the :manual:`cmake(1)` ``-T`` option) to specify a + toolset version number. + +Command-Line +------------ + +* The :manual:`cmake(1)` :ref:`Build Tool Mode` (``cmake --build``) gained + ``--parallel []`` and ``-j []`` options to specify a parallel + build level. They map to corresponding options of the native build tool. + +Commands +-------- + +* The :command:`add_compile_definitions` command was added to set preprocessor + definitions at directory level. This supersedes :command:`add_definitions`. + +* The :command:`cmake_minimum_required` and :command:`cmake_policy(VERSION)` + commands now accept a version range using the form ``[...]``. + The ```` version is required but policies are set based on the + older of the running CMake version and the version specified by + ````. This allows projects to specify a range of versions + for which they have been updated and avoid explicit policy settings. + +* The :command:`file(GLOB)` and :command:`file(GLOB_RECURSE)` commands + learned a new flag ``CONFIGURE_DEPENDS`` which enables expression of + build system dependency on globbed directory's contents. + +* The :command:`file(TOUCH)` and :command:`file(TOUCH_NOCREATE)` commands + were added to expose ``TOUCH`` functionality without having to use + CMake's command-line tool mode with :command:`execute_process`. + +* The :command:`find_package` command now searches prefixes specified by + the :variable:`_ROOT` CMake variable and the + :envvar:`_ROOT` environment variable. Package roots are + maintained as a stack so nested calls to all ``find_*`` commands inside + find modules also search the roots as prefixes. + See policy :policy:`CMP0074`. + +* The :command:`install` command learned an optional ``NAMELINK_COMPONENT`` + parameter, which allows you to change the component for a shared library's + namelink. If none is specified, the value of ``COMPONENT`` is used by + default. + +* The :command:`list` command learned a ``JOIN`` sub-command + to concatenate list's elements separated by a glue string. + +* The :command:`list` command learned a ``SUBLIST`` sub-command + to get a sublist of the list. + +* The :command:`list` command learned a ``TRANSFORM`` sub-command + to apply various string transformation to list's elements. + +* The :command:`project` command learned an optional ``HOMEPAGE_URL`` + parameter which has the effect of setting variables like + :variable:`PROJECT_HOMEPAGE_URL`, :variable:`_HOMEPAGE_URL` + and :variable:`CMAKE_PROJECT_HOMEPAGE_URL`. + +* The :command:`string` command learned a ``JOIN`` sub-command + to concatenate input strings separated by a glue string. + +* :command:`target_compile_options` and :command:`add_compile_options` + commands gained a ``SHELL:`` prefix to specify a group of related + options using shell-like quoting. + +* The :command:`target_link_libraries` command now supports + :ref:`Object Libraries`. Linking to an object library uses its object + files in direct dependents and also propagates usage requirements. + +Variables +--------- + +* The :variable:`CMAKE_FOLDER` variable was added to initialize the + :prop_tgt:`FOLDER` property on all targets. + +* The :variable:`CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION` variable + was defined to initialize all + :prop_tgt:`DOTNET_TARGET_FRAMEWORK_VERSION` target properties. + +* ``CMAKE_PROJECT_VERSION*`` variables have been introduced: + + - :variable:`CMAKE_PROJECT_VERSION` + - :variable:`CMAKE_PROJECT_VERSION_MAJOR` + - :variable:`CMAKE_PROJECT_VERSION_MINOR` + - :variable:`CMAKE_PROJECT_VERSION_PATCH` + - :variable:`CMAKE_PROJECT_VERSION_TWEAK` + +* The :variable:`CMAKE_SUPPRESS_REGENERATION` variable was extended to + support the :generator:`Ninja` and :ref:`Makefile Generators`. + It is also now documented. + +* ``CMAKE_VS_SDK_*_DIRECTORIES`` variables were defined to tell + :ref:`Visual Studio Generators` for VS 2010 and above how to populate + fields in ``.vcxproj`` files that specify SDK directories. The + variables are: + + - :variable:`CMAKE_VS_SDK_EXCLUDE_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_EXECUTABLE_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_INCLUDE_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_LIBRARY_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_LIBRARY_WINRT_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_REFERENCE_DIRECTORIES` + - :variable:`CMAKE_VS_SDK_SOURCE_DIRECTORIES` + +* A :variable:`MSVC_TOOLSET_VERSION` variable was added to provide the + MSVC toolset version associated with the current MSVC compiler version + in :variable:`MSVC_VERSION`. + +Properties +---------- + +* The :prop_tgt:`COMMON_LANGUAGE_RUNTIME` target property was introduced + to configure the use of managed C++ for :ref:`Visual Studio Generators` + for VS 2010 and above. + A corresponding :prop_tgt:`IMPORTED_COMMON_LANGUAGE_RUNTIME` target + property was added to support ``C++/CLI`` for imported targets. + +* The :prop_tgt:`DOTNET_TARGET_FRAMEWORK_VERSION` target property + was introduced as replacement for + :prop_tgt:`VS_DOTNET_TARGET_FRAMEWORK_VERSION`, which is considered + deprecated now. + +* An :prop_tgt:`EXPORT_PROPERTIES` target property was added to specify a + custom list of target properties to include in targets exported by the + :command:`install(EXPORT)` and :command:`export` commands. + +* The :prop_tgt:`PDB_OUTPUT_DIRECTORY` property learned to support + :manual:`generator expressions `. + +* A :prop_dir:`TESTS` directory property was added to hold the list of + tests defined by the :command:`add_test` command. + +* A :prop_tgt:`VS_DEBUGGER_COMMAND` target property was created to set the + debugging command line with :ref:`Visual Studio Generators` for VS 2010 + and above. + +* HLSL source file properties :prop_sf:`VS_SHADER_DISABLE_OPTIMIZATIONS` + and :prop_sf:`VS_SHADER_ENABLE_DEBUG` gained support for generator + expressions. + +* HLSL source file property :prop_sf:`VS_SHADER_OBJECT_FILE_NAME` has been + added to the :ref:`Visual Studio Generators` for VS 2010 and above. + The property specifies the file name of the compiled shader object. + +Modules +------- + +* The :module:`FindALSA` module now provides imported targets. + +* The :module:`FindCURL` module now provides imported targets. + +* The :module:`FindJPEG` module now provides imported targets. + +* The :module:`FindLibXml2` module now provides imported targets. + +* The :module:`FindMatlab` module now supports the Matlab Runtime + Compiler (MCR) for compiling and linking matlab extensions. + +* A :module:`FindODBC` module was added to find an Open Database Connectivity + (ODBC) library. + +* The :module:`FindPkgConfig` module has learned to export the found + libraries with full path for direct consumption with the + :command:`target_link_libraries` command. + +* New :module:`FindPython3` and :module:`FindPython2` modules, as well as + a new :module:`FindPython` module, have been added to provide a new way + to locate python environments. + +* The :module:`UseSWIG` module gained a whole refresh and is now more + consistent with standard CMake commands to generate libraries and is + fully configurable through properties. + +* The :module:`UseSWIG` module learned to manage multiple behaviors through + ``UseSWIG_MODULE_VERSION`` variable to ensure legacy support as well as more + robust handling of ``SWIG`` advanced features (like ``%template``). + +* The :module:`UseSWIG` module learned to support CSHARP variant + wrapper files. + +* The :module:`WriteCompilerDetectionHeader` module gained a ``BARE_FEATURES`` + option to add a compatibility define for the exact keyword of a new language + feature. + +Generator Expressions +--------------------- + +* A new ``$`` and ``$`` + :manual:`generator expression ` + has been added to enable consumption of generator expressions whose + evaluation results itself in generator expressions. + +* A new ``$`` + :manual:`generator expression ` + has been added. + +* A new ``$`` + :manual:`generator expression ` + has been added. + +* A new ``$`` + :manual:`generator expression ` + has been added. + +CTest +----- + +* The :command:`ctest_start` command has been reworked so that you can simply + call ``ctest_start(APPEND)`` and it will read all the needed information from + the TAG file. The argument parsing has also been relaxed so that the order of + the arguments is less significant. + +* A :prop_test:`PROCESSOR_AFFINITY` test property was added to request + that CTest run a test with CPU affinity for a set of processors + disjoint from other concurrently running tests with the property set. + +CPack +----- + +* The :module:`CPack` module now uses variables + :variable:`CMAKE_PROJECT_VERSION_MAJOR`, + :variable:`CMAKE_PROJECT_VERSION_MINOR` and + :variable:`CMAKE_PROJECT_VERSION_PATCH` + to initialize corresponding CPack variables. + +* A :cpack_gen:`CPack NuGet Generator` was was added with basic + support for `NuGet`_. + +.. _NuGet: https://learn.microsoft.com/en-us/nuget/what-is-nuget + +Other +----- + +* The :manual:`Compile Features ` functionality + is now aware of C++ 20. No specific features are yet enumerated besides + the ``cxx_std_20`` meta-feature. + +* The :manual:`Compile Features ` functionality + is now aware of the availability of C features in MSVC since VS 2010. + +* The :manual:`Compile Features ` functionality + is now aware of C language standards supported by Texas Instruments C + compilers. + +Deprecated and Removed Features +=============================== + +* The :generator:`Visual Studio 8 2005` generator has been removed. + +* CMake no longer produces ``_LIB_DEPENDS`` cache entries + for library targets. See policy :policy:`CMP0073`. + +Other Changes +============= + +* Include flags for directories marked as ``SYSTEM`` are now moved after + non-system directories. The ``-isystem`` flag does this automatically, + so moving them explicitly to the end makes the behavior consistent on + compilers that do not have any ``-isystem`` flag. + +* Fortran dependency scanning now supports dependencies implied by + `Fortran Submodules`_. + +* The existence and functionality of the file + ``${CMAKE_BINARY_DIR}/cmake_install.cmake`` has now been documented in the + :command:`install` documentation so that external packaging software can take + advantage of CPack-style component installs. + +* The :module:`CheckIncludeFile` module ``check_include_file`` macro + learned to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable. + See policy :policy:`CMP0075`. + +* The :module:`CheckIncludeFileCXX` module ``check_include_file_cxx`` macro + learned to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable. + See policy :policy:`CMP0075`. + +* The :module:`CheckIncludeFiles` module ``check_include_files`` macro + learned to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable. + See policy :policy:`CMP0075`. + +* The :manual:`cmake(1)` ``-E copy_directory`` tool now fails when the + source directory does not exist. Previously it succeeded by creating + an empty destination directory. + +* The :module:`UseSWIG` module :command:`swig_add_library` command + (and legacy ``swig_add_module`` command) now set the prefix of + Java modules to ``""`` for MINGW, MSYS, and CYGWIN environments. + +.. _Fortran Submodules: https://fortranwiki.org/fortran/show/Submodules diff --git a/cmake/share/cmake-3.31/Help/release/3.13.rst b/cmake/share/cmake-3.31/Help/release/3.13.rst new file mode 100644 index 0000000000000000000000000000000000000000..6e028bb07804801fa5abcfe7bc5b69c425b9d106 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/release/3.13.rst @@ -0,0 +1,289 @@ +CMake 3.13 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.12 include the following. + +New Features +============ + +Generators +---------- + +* The :ref:`Visual Studio Generators` for VS 2010 and above learned to + support the :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` target property + and supporting :module:`CheckIPOSupported` module. + +* The :generator:`Xcode` generator learned to configure more Xcode Scheme + fields. See the :variable:`CMAKE_XCODE_GENERATE_SCHEME` variable. + +* The :generator:`Green Hills MULTI` generator has been updated: + + - Added support for architecture selection through + :variable:`CMAKE_GENERATOR_PLATFORM`: + e.g. ``arm``, ``ppc``, and ``86``. + + - Added support for toolset selection through + :variable:`CMAKE_GENERATOR_TOOLSET`, + e.g. ``comp_201205``, ``comp_201510``, ``comp_201722_beta``. + + - Added support for platform selection through ``GHS_TARGET_PLATFORM``, + e.g. ``integrity``, ``linux``, ``standalone``, etc. + + - No longer checks that ``arm`` based compilers are installed but ensures + that the correct ``gbuild.exe`` exists. + + - No longer hard-codes ARM files, BSP, toolset, or OS locations. + +Command-Line +------------ + +* The :manual:`cmake(1)` command gained the ``-S `` + command line option to specify the location of the source directory. + This option can be used independently of ``-B``. + +* The :manual:`cmake(1)` command gained the ``-B `` + command line option to specify the location of the build directory. + This option can be used independently of ``-S``. + +* The :manual:`cmake(1)` ``-E create_symlink`` command can now be used + on Windows. + +Commands +-------- + +* The :command:`add_custom_command` and :command:`add_custom_target` commands + learned to support generator expressions in ``WORKING_DIRECTORY`` options. + +* The :command:`add_link_options` command was created to add link + options in the current directory. + +* The :command:`install(TARGETS)` command learned to install targets + created outside the current directory. + +* The :command:`link_directories` command gained options to control + insertion position. + +* The :command:`list(SORT)` command gained options to control the + comparison operation used to order the entries. + +* The :command:`math` command gained options for hexadecimal. + +* The :command:`target_link_directories` command was created to + specify link directories for targets and their dependents. + +* The :command:`target_link_options` command was created to + specify link options for targets and their dependents. + +* The :command:`target_link_libraries` command may now be called + to modify targets created outside the current directory. + See policy :policy:`CMP0079`. + +Variables +--------- + +* A :variable:`CMAKE_AUTOGEN_VERBOSE` variable was added to optionally + increase the verbosity of :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTOUIC` + and :prop_tgt:`AUTORCC` from within CMake project code. + +* A :variable:`CMAKE_VS_GLOBALS` variable was added to initialize + :prop_tgt:`VS_GLOBAL_` target properties on targets as + they are created. + +Properties +---------- + +* The :prop_tgt:`DEPLOYMENT_ADDITIONAL_FILES` target property was + added to tell the :generator:`Visual Studio 9 2008` generator + to specify additional files for deployment to WinCE devices + for remote debugging. + +* The :prop_tgt:`INTERFACE_LINK_DEPENDS` target property was created + to specify transitive link dependencies on files. + +* The :prop_tgt:`LINK_DEPENDS` target property learned to support + :manual:`generator expressions `. + +* :prop_tgt:`LINK_DIRECTORIES` and :prop_tgt:`INTERFACE_LINK_DIRECTORIES` + target properties were added to collect link directories for a target + and its dependents. Use the :command:`target_link_directories` command + to set them. + +* :prop_tgt:`LINK_OPTIONS` and :prop_tgt:`INTERFACE_LINK_OPTIONS` target + properties were added to collect link options for a target and its + dependents. Use the :command:`target_link_options` command to set them. + +* A :prop_dir:`LINK_OPTIONS` directory property was added to collect + link options for targets created under the current directory. + Use the :command:`add_link_options` command to set it. + +* A :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property was created + to specify archiver options to use when creating static libraries. + +* A :prop_tgt:`VS_DEBUGGER_COMMAND_ARGUMENTS` target property was created to + set the debugging command line arguments with + :ref:`Visual Studio Generators` for VS 2010 and above. + +* A :prop_tgt:`VS_DEBUGGER_ENVIRONMENT` target property was created to + set the debugging environment with + :ref:`Visual Studio Generators` for VS 2010 and above. + +* The :prop_tgt:`VS_DEBUGGER_COMMAND` and + :prop_tgt:`VS_DEBUGGER_WORKING_DIRECTORY` target properties + now support generator expressions. + +Modules +------- + +* The :module:`FindBoost` module gained a ``Boost_ARCHITECTURE`` option + to specify a Boost architecture-specific library filename fragment. + +* The :module:`FindCURL` module learned to find debug and release variants + separately. + +* The :module:`FindMatlab` module gained new components ``ENGINE_LIBRARY`` and + ``DATAARRAY_LIBRARY`` to request finding the Matlab C++ Engine and DataArray + libraries respectively. + +* The :module:`FindMatlab` module now explicitly exports mexFunction in Visual + Studio. + +* The :module:`FindMatlab` module gained a new ``MCC_COMPILER`` + component to request finding the Matlab Compiler add-on. + +* The :module:`FindPkgConfig` module gained an option to create imported + targets in global scope. + +* The :module:`FindPkgConfig` module gained support for ``<`` and ``>`` + operators for version checks in addition to the already supported + operators ``>=``, ``<=``, and ``=``. + +* Modules :module:`FindPython3`, :module:`FindPython2` and :module:`FindPython` + gain capability to control order of resource lookup on macOS (Framework) and + Windows (Registry). + +* The :module:`FindSubversion` module ``Subversion_WC_INFO`` command + gained an ``IGNORE_SVN_FAILURE`` option to suppress failures, + e.g. when the source tree is not under Subversion control. + +* The :module:`UseSWIG` module learned to manage target property + :prop_tgt:`INCLUDE_DIRECTORIES` for ``SWIG`` compilation. + +CTest +----- + +* :manual:`ctest(1)` gained a ``--progress`` option to enable a live + test progress summary when output goes to a terminal. + +CPack +----- + +* The :cpack_gen:`CPack DEB Generator` learned to split debug symbols into + a corresponding .ddeb package when ``CPACK_DEBIAN_DEBUGINFO_PACKAGE`` is + set. + +* The :cpack_gen:`CPack DEB Generator` learned to honor the ``SOURCE_DATE_EPOCH`` + environment variable when packaging files. This is useful for generating + reproducible packages. + +* CPack gained a new :cpack_gen:`CPack External Generator` which is used to + export the CPack metadata in a format that other software can understand. The + intention of this generator is to allow external packaging software to take + advantage of CPack's features when it may not be possible to use CPack for + the entire packaging process. + +Deprecated and Removed Features +=============================== + +* An explicit deprecation diagnostic was added for policies ``CMP0055`` + through ``CMP0063`` (``CMP0054`` and below were already deprecated). + The :manual:`cmake-policies(7)` manual explains that the OLD behaviors + of all policies are deprecated and that projects should port to the + NEW behaviors. + +Other Changes +============= + +* The precompiled binaries provided on ``cmake.org`` now include + qthelp-format documentation. + +* The :command:`option` command now honors an existing normal variable + of the same name and does nothing instead of possibly creating a cache + entry (or setting its type) and removing the normal variable. + See policy :policy:`CMP0077`. + +* The :ref:`Makefile Generators` learned to remove custom command and + custom target byproducts during ``make clean``. + +* The :command:`target_sources` command now interprets relative source file + paths as relative to the current source directory. This simplifies + incrementally building up a target's sources from subdirectories. The + :policy:`CMP0076` policy was added to provide backward compatibility with + the old behavior where required. + +* The :module:`BundleUtilities` module may no longer be included at configure + time. This was always a bug anyway. See policy :policy:`CMP0080`. + +* The :module:`UseSWIG` module has changed strategy for target naming. + See policy :policy:`CMP0078`. + +* The :prop_tgt:`LINK_DIRECTORIES` target property now expects absolute paths. + See policy :policy:`CMP0081`. + +* The CPack generators have been moved into their own separate section + in the documentation, rather than having the documentation in their + internal implementation modules. + These internal implementation modules are also no longer available + to scripts that may have been incorrectly including them, because + they should never have been available in the first place. + +Updates +======= + +Changes made since CMake 3.13.0 include the following. + +3.13.2 +------ + +* CMake 3.13.0 included a change to pass compiler implicit include + directories to the ``moc`` tool for :prop_tgt:`AUTOMOC`. This has + been reverted due to regressing existing builds and will need + further investigation before being re-introduced in a later release. + +3.13.3 +------ + +* The :generator:`Visual Studio 15 2017` generator has been fixed to work + when VS 2019 is installed. + +* CMake now checks that at least one of the source or binary directory + is specified when running CMake and issues an error if both are missing. + This has always been a documented requirement, but the implementation + previously accidentally accepted cases in which neither are specified + so long as some other argument is given, and silently used the current + working directory as the source and build tree. + +3.13.4 +------ + +* The error added by 3.13.3 in cases that neither a source or binary + directory is specified has been downgraded to a warning. While this + was never intended, documented, nor supported behavior, some projects + relied on it. The error has been downgraded to a warning for the + remainder of the 3.13.x release series to allow a transition period, + but it may become a fatal error again in a later release. Scripts + relying on the old behavior can be trivially fixed by specifying + the path to the source tree (even if just ``.``) explicitly and + continue to work with all versions of CMake. + +3.13.5 +------ + +* In CMake 3.13.0 through 3.13.4, calling :command:`target_link_libraries` + to add ``PRIVATE`` dependencies to a static library created in another + directory (under policy :policy:`CMP0079` ``NEW`` behavior) would + incorrectly propagate usage requirements of those dependencies to + dependents that link the static library. This has been fixed. diff --git a/cmake/share/cmake-3.31/Help/release/3.14.rst b/cmake/share/cmake-3.31/Help/release/3.14.rst new file mode 100644 index 0000000000000000000000000000000000000000..514c0703a4972244e63812f7c7d6e24f6927100c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/release/3.14.rst @@ -0,0 +1,439 @@ +CMake 3.14 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.13 include the following. + +New Features +============ + +Generators +---------- + +* The :generator:`Visual Studio 16 2019` generator was added. This is + experimental and based on "Visual Studio 2019 Preview 4" because this + version of VS has not been released. + + The VS 2019 generator differs from generators for earlier versions + in that it does not provide variants that specify the target platform + in the generator name. Instead :variable:`CMAKE_GENERATOR_PLATFORM` + must be used, e.g. through the ``-A`` command-line option. Furthermore, + the default target platform (architecture) is now based on the *host* + platform. The VS host toolset selection is now based on the host + architecture as well. + +* The :generator:`Green Hills MULTI` generator has been updated: + + * Now supports :ref:`Object Libraries`. + + * Now warns on unsupported project types such as shared libraries. + + * Now generates a top-level ``.top.gpj`` for each directory + calling the :command:`project` command. The top-level project file + ``default.gpj`` is no longer created. + + * Now honors target renaming and destination output control properties + such as :prop_tgt:`RUNTIME_OUTPUT_DIRECTORY` and :prop_tgt:`OUTPUT_NAME`. + This also fixes support for installation rules generated by + :command:`install`. + + * Now honors source file properties :prop_sf:`INCLUDE_DIRECTORIES`, + :prop_sf:`COMPILE_DEFINITIONS`, and :prop_sf:`COMPILE_OPTIONS`. + + * Now supports Dynamic Download Integrity Applications which did not include + Integrate Files via :prop_tgt:`GHS_INTEGRITY_APP` and setting a target + link flag of ``-dynamic``. + + * The contents of project files now sorts sources groups and files by name. + Set the :prop_tgt:`GHS_NO_SOURCE_GROUP_FILE` target property to ``ON`` to + generate a single project file for the target instead of a project file for + each source group. Set the :variable:`CMAKE_GHS_NO_SOURCE_GROUP_FILE` + variable to enable this for all targets. + +File-Based API +-------------- + +* A file-based api for clients to get semantic buildsystem information + has been added. See the :manual:`cmake-file-api(7)` manual. + This is intended to replace the :manual:`cmake-server(7)` mode for IDEs. + +Platforms +--------- + +* CMake now supports + :ref:`Cross Compiling for iOS, tvOS, or watchOS ` + using simple toolchain files. + +Command-Line +------------ + +* The :manual:`cmake(1)` :ref:`Build Tool Mode ` + (``cmake --build``) gained ``--verbose`` and ``-v`` options to + specify verbose build output. Some generators such as Xcode don't + support this option currently. + +* The :manual:`cmake(1)` ``-E compare_files`` command learned a new + ``--ignore-eol`` option to specify that end-of-line differences + (e.g. LF vs CRLF) should be ignored when comparing files. + +* The :manual:`cmake-gui(1)` dialog gained new ``-S`` and ``-B`` arguments to + explicitly specify source and build directories. + +Commands +-------- + +* The :command:`file` command learned a new sub-command, ``CREATE_LINK``, + which can be used to create hard or symbolic links. + +* The :command:`file` command learned a new sub-command, ``READ_SYMLINK``, + which can be used to determine the path that a symlink points to. + +* The :command:`file` command gained a ``SIZE`` mode to get the size + of a file on disk. + +* The :command:`find_package` command learned to optionally resolve + symbolic links in the paths to package configuration files. + See the :variable:`CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS` variable. + +* The :command:`get_filename_component` command gained new + ``LAST_EXT`` and ``NAME_WLE`` variants to work with the + extension after the last ``.`` in the name. + +* The :command:`if` command gained support for checking if cache variables + are defined with the ``DEFINED CACHE{VAR}`` syntax. + +* The :command:`install(CODE)` and :command:`install(SCRIPT)` commands + learned to support generator expressions. See policy :policy:`CMP0087`. + +* The :command:`install(TARGETS)` command learned how to install to an + appropriate default directory for a given target type, based on + variables from the :module:`GNUInstallDirs` module and built-in defaults, + in lieu of a ``DESTINATION`` argument. + +* The :command:`install(FILES)` and :command:`install(DIRECTORY)` commands + learned a new set of parameters for installing files as a file type, + setting the destination based on the appropriate variables from + :module:`GNUInstallDirs` and built-in defaults, in lieu of a + ``DESTINATION`` argument. + +* The :command:`list` operations ``REMOVE_ITEM``, ``REMOVE_DUPLICATES``, + ``SORT``, ``REVERSE``, and ``FILTER`` all now accept a non-existent variable + as the list since these operations on empty lists is also the empty list. + +* The :command:`list` operation ``REMOVE_AT`` now indicates that the given + indices are invalid for a non-existent variable or empty list. + +* The :command:`try_compile` and :command:`try_run` commands gained a new + ``LINK_OPTIONS`` option. + +Variables +--------- + +* A :variable:`CMAKE_BUILD_RPATH_USE_ORIGIN` variable and corresponding + :prop_tgt:`BUILD_RPATH_USE_ORIGIN` target property were added to + enable use of relative runtime paths (RPATHs). This helps achieving + relocatable and reproducible builds that are invariant of the build + directory. + +* A :variable:`CMAKE_VS_PLATFORM_NAME_DEFAULT` variable was added for + :ref:`Visual Studio Generators` to report their default platform used + when :variable:`CMAKE_GENERATOR_PLATFORM` is not set explicitly. + +Properties +---------- + +* A :prop_gbl:`CMAKE_ROLE` global property was added to allow scripts to + determine whether they're running in project mode, script mode, + find-package mode, CTest, or CPack. + +* The :prop_tgt:`CUDA_RESOLVE_DEVICE_SYMBOLS` target property is now supported + on shared library, module library, and executable targets. Previously it was + only honored on static libraries. + +* The :prop_tgt:`EXCLUDE_FROM_ALL` target property was created to override + the setting of its directory. A target will now be built as part of "all" + if its :prop_tgt:`EXCLUDE_FROM_ALL` property is set to ``OFF``, even if its + containing directory is marked as :prop_dir:`EXCLUDE_FROM_ALL`. + +* :prop_tgt:`INTERFACE_POSITION_INDEPENDENT_CODE` target property gains the + support of :manual:`generator expressions `. + +Modules +------- + +* The family of modules to check capabilities (like + :module:`CheckCSourceCompiles`) gain capability to manage ``LINK_OPTIONS``. + +* A :module:`CheckFortranSourceRuns` module was added to provide a + :command:`check_fortran_source_runs` command to check if a Fortran + source snippet compiles and runs. + +* The :module:`CMakePackageConfigHelpers` module's + :command:`write_basic_package_version_file` command gained a new + ``ARCH_INDEPENDENT`` option for supporting architecture-independent + packages. + +* The :module:`ExternalProject` module :command:`ExternalProject_Add` command + gained ``LOG_DIR`` and ``LOG_MERGED_STDOUTERR`` options to control logging. + +* The :module:`ExternalProject` module :command:`ExternalProject_Add` command + gained ``LOG_PATCH`` to optionally log the patch step. + +* The :module:`ExternalProject` module :command:`ExternalProject_Add` command + learned to apply ``SOURCE_SUBDIR`` when ``BUILD_IN_SOURCE`` is also used. + The ``BUILD_COMMAND`` is run in the given ``SOURCE_SUBDIR`` of the + ``SOURCE_DIR``. + +* The :module:`FetchContent` module gained a new + :command:`FetchContent_MakeAvailable` command. It accepts a list of + dependency names, which it then iterates over, populating and adding + each one to the main build using the canonical pattern. This + significantly reduces the amount of boilerplate needed in a project. + +* The :module:`FindBISON` module's ``BISON_TARGET`` command now runs ``bison`` + with :variable:`CMAKE_CURRENT_BINARY_DIR` as the working directory. + See policy :policy:`CMP0088`. + +* The :module:`FindCURL` module gained support for requesting + protocols as package components. + +* The :module:`FindFontconfig` module was added to find `fontconfig`_. + +* The :module:`FindGDAL` module now provides imported targets. + +* The :module:`FindGIF` module now provides imported targets. + +* The :module:`FindGit` module now provides an imported target for the + Git executable. + +* The :module:`FindIce` module learned to find ``slice2confluence`` + and ``slice2matlab``. + +* The :module:`FindLibinput` module was added to find `libinput`_. + +* The :module:`FindLibLZMA` module now provides imported targets. + +* The :module:`FindMatlab` module gained new options ``R2017b`` and + ``R2018a`` to specify the MEX API version to use; these options + mirror the new options to the ``mex`` command in MATLAB R2018a. + The option ``MX_LIBRARY`` is no longer needed. + +* The :module:`FindPostgreSQL` module now provides imported targets. + +* The :module:`FindPython`, :module:`FindPython2`, and :module:`FindPython3` + modules gained support for ``NumPy`` component. + +* The :module:`FindPython2`, :module:`FindPython3`, and :module:`FindPython` + modules now support running in script mode by skipping the creation of + imported targets and helper functions. + +* The :module:`FindSQLite3` module was added to find the SQLite v3.x library. + +* The :module:`FindX11` had the following variables renamed in order to match + their library names rather than header names. The old variables are provided + for compatibility: + + - ``X11_Xxf86misc_INCLUDE_PATH`` instead of ``X11_xf86misc_INCLUDE_PATH`` + - ``X11_Xxf86misc_LIB`` instead of ``X11_xf86misc_LIB`` + - ``X11_Xxf86misc_FOUND`` instead of ``X11_xf86misc_FOUND`` + - ``X11_Xxf86vm_INCLUDE_PATH`` instead of ``X11_xf86vmode_INCLUDE_PATH`` + - ``X11_Xxf86vm_LIB`` instead of ``X11_xf86vmode_LIB`` + - ``X11_Xxf86vm_FOUND`` instead of ``X11_xf86vmode_FOUND`` + - ``X11_xkbfile_INCLUDE_PATH`` instead of ``X11_Xkbfile_INCLUDE_PATH`` + - ``X11_xkbfile_LIB`` instead of ``X11_Xkbfile_LIB`` + - ``X11_xkbfile_FOUND`` instead of ``X11_Xkbfile_FOUND`` + - ``X11_Xtst_INCLUDE_PATH`` instead of ``X11_XTest_INCLUDE_PATH`` + - ``X11_Xtst_LIB`` instead of ``X11_XTest_LIB`` + - ``X11_Xtst_FOUND`` instead of ``X11_XTest_FOUND`` + - ``X11_Xss_INCLUDE_PATH`` instead of ``X11_Xscreensaver_INCLUDE_PATH`` + - ``X11_Xss_LIB`` instead of ``X11_Xscreensaver_LIB`` + - ``X11_Xss_FOUND`` instead of ``X11_Xscreensaver_FOUND`` + + The following variables are deprecated completely since they were + essentially duplicates: + + - ``X11_Xinput_INCLUDE_PATH`` (use ``X11_Xi_INCLUDE_PATH``) + - ``X11_Xinput_LIB`` (use ``X11_Xi_LIB``) + - ``X11_Xinput_FOUND`` (use ``X11_Xi_FOUND``) + +* The :module:`FindX11` now provides ``X11_Xext_INCLUDE_PATH``. + +* The :module:`FindX11` now provides imported targets. + +* The :module:`UseSWIG` module learned to pass ``-module `` to + the ``SWIG`` compiler if the file property ``SWIG_MODULE_NAME`` is defined. + See policy :policy:`CMP0086`. + +* The :module:`UseSWIG` module gained an option to specify + ``SWIG`` source file extensions. + +.. _`fontconfig`: https://www.freedesktop.org/wiki/Software/fontconfig/ +.. _`libinput`: https://www.freedesktop.org/wiki/Software/libinput/ + +Generator Expressions +--------------------- + +* The ``$`` and ``$`` + :manual:`generator expressions ` were added. + +* The ``$`` generator expression now correctly handles an + empty argument. See :policy:`CMP0085` for details. + +Autogen +------- + +* The :prop_tgt:`AUTOMOC_EXECUTABLE`, :prop_tgt:`AUTORCC_EXECUTABLE`, and + :prop_tgt:`AUTOUIC_EXECUTABLE` target properties were added. They all + take a path to an executable and force automoc/autorcc/autouic to use + this executable. + + Setting these will also prevent the configure time testing for these + executables. This is mainly useful when you build these tools yourself. + +* The new variables :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET`, + :variable:`CMAKE_GLOBAL_AUTOGEN_TARGET_NAME`, + :variable:`CMAKE_GLOBAL_AUTORCC_TARGET` and + :variable:`CMAKE_GLOBAL_AUTORCC_TARGET_NAME` control the generation + of global ``autogen`` and ``autorcc`` targets. + +* A new :variable:`CMAKE_AUTOGEN_ORIGIN_DEPENDS` variable and + :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS` target property may be set to enable or + disable forwarding of the origin target dependencies to the corresponding + :ref:`_autogen` target. + +CTest +----- + +* :manual:`ctest(1)` gained a ``--show-only=json-v1`` option to show the + list of tests in a machine-readable JSON format. + See the :ref:`Show as JSON Object Model` section of the manual. + +* The :command:`ctest_submit` command learned a new ``Done`` part that can be used + to inform CDash that a build is complete and that no more parts will be uploaded. + +* CTest learned to accept the dashboard server submission URL from a single + variable. See the ``SubmitURL`` setting in :manual:`ctest(1)`, + the :variable:`CTEST_SUBMIT_URL` variable, and the ``SUBMIT_URL`` + argument of the :command:`ctest_submit` command. + +Deprecated and Removed Features +=============================== + +* An explicit deprecation diagnostic was added for policies ``CMP0064`` + and ``CMP0065`` (``CMP0063`` and below were already deprecated). + The :manual:`cmake-policies(7)` manual explains that the OLD behaviors + of all policies are deprecated and that projects should port to the + NEW behaviors. + +* The :generator:`Xcode` generator deprecated support for Xcode + versions prior to Xcode 5. Support for those will be dropped in a + future version of CMake. + +* The :module:`FindQt` module is no longer used by the :command:`find_package` + command as a find module. This allows the Qt Project upstream to optionally + provide its own ``QtConfig.cmake`` package configuration file and have + applications use it via ``find_package(Qt)`` rather than + ``find_package(Qt CONFIG)``. See policy :policy:`CMP0084`. + +* Support for running CMake on Windows XP and Windows Vista has been dropped. + The precompiled Windows binaries provided on ``cmake.org`` now require + Windows 7 or higher. + +* CTest no longer supports submissions via ``ftp``, ``scp``, ``cp``, and + ``xmlrpc``. CDash is the only maintained testing dashboard for CTest, + and it only supports submissions over ``http`` and ``https``. + +Other Changes +============= + +* Object library linking has been fixed to propagate private link libraries + of object libraries to consuming targets. + +* Install rules under :command:`add_subdirectory` now interleave with those in + the calling directory. See policy :policy:`CMP0082` for details. + +* CMake now imposes a maximum recursion limit to prevent a stack overflow on + scripts that recurse infinitely. The limit can be adjusted at runtime with + :variable:`CMAKE_MAXIMUM_RECURSION_DEPTH`. + +* When using cppcheck via the :variable:`CMAKE__CPPCHECK` variable + or :prop_tgt:`_CPPCHECK` property, the build will now fail if + ``cppcheck`` returns non-zero as configured by its command-line options. + +* Required link options to manage Position Independent Executable are now + added when :prop_tgt:`POSITION_INDEPENDENT_CODE` is set. The project is + responsible for using the :module:`CheckPIESupported` module to check for + ``PIE`` support to ensure that the :prop_tgt:`POSITION_INDEPENDENT_CODE` + target property will be honored at link time for executables. This behavior + is controlled by policy :policy:`CMP0083`. + +* :ref:`Visual Studio Generators` for VS 2010 and above learned + to support the ``VS_DEBUGGER_*`` properties on targets created + via :command:`add_custom_target`. + +* The :module:`CPack` module no longer defaults to the ``paxr`` value in the + :variable:`CPACK_DEBIAN_ARCHIVE_TYPE` variable, because ``dpkg`` has + never supported the PAX tar format. The ``paxr`` value will be mapped + to ``gnutar`` and a deprecation message emitted. + +* CMake no longer issues a warning if a target listed in an + :command:`install(TARGETS)` command has its :prop_tgt:`EXCLUDE_FROM_ALL` + property set to true. + +Updates +======= + +Changes made since CMake 3.14.0 include the following. + +3.14.1 +------ + +* The :module:`FindFontconfig` module added by 3.14.0 accidentally + used uppercase ``FONTCONFIG_*`` variable names that do not match + our conventions. 3.14.1 revises the module to use ``Fontconfig_*`` + variable names. This is incompatible with 3.14.0 but since the + module is new in the 3.14 series usage should not yet be widespread. + +3.14.3 +------ + +* The :variable:`CMAKE_VS_PLATFORM_NAME_DEFAULT` variable was added + to help toolchain files work with the :generator:`Visual Studio 16 2019` + generator where the default platform now depends on the host platform. + +3.14.4 +------ + +* In CMake 3.14.0 through 3.14.3, calling :command:`target_link_libraries` + to add ``PRIVATE`` dependencies to a static library created in another + directory (under policy :policy:`CMP0079` ``NEW`` behavior) would + incorrectly propagate usage requirements of those dependencies to + dependents that link the static library. This has been fixed. + The bug also existed in 3.13.0 through 3.13.4 and is fixed in 3.13.5. + +3.14.5 +------ + +* Entries of the ``CPATH`` environment variable are no longer excluded + from explicit use via :command:`include_directories` and + :command:`target_include_directories` as they were in CMake 3.14.0 + through 3.14.4. + +3.14.6 +------ + +* In CMake 3.14.0 through 3.14.5, the :module:`FindBISON` module + policy :policy:`CMP0088` ``NEW`` behavior accidentally interpreted + a relative path to the ``.y`` input as relative to the build tree + directory instead of the source tree directory. This has been fixed. + +3.14.7 +------ + +* In CMake 3.14.0 through 3.14.6, the :prop_dir:`EXCLUDE_FROM_ALL` + directory property was regressed from pre-3.14 behavior and caused + targets within the directory to be excluded even from its own "all". + This has been fixed. diff --git a/cmake/share/cmake-3.31/Help/release/3.15.rst b/cmake/share/cmake-3.31/Help/release/3.15.rst new file mode 100644 index 0000000000000000000000000000000000000000..2539bb0b1cc771026313aa02eaaad4aa436c1e2c --- /dev/null +++ b/cmake/share/cmake-3.31/Help/release/3.15.rst @@ -0,0 +1,392 @@ +CMake 3.15 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.14 include the following. + +New Features +============ + +Generators +---------- + +* The :generator:`Xcode` generator now supports per-target schemes. + See the :variable:`CMAKE_XCODE_GENERATE_SCHEME` variable and + :prop_tgt:`XCODE_GENERATE_SCHEME` target property. + +* The :generator:`Green Hills MULTI` generator has been updated: + + * It now supports the :command:`add_custom_command` and + :command:`add_custom_target` commands. + + * It is now available on Linux. + +Languages +--------- + +* Preliminary support for the ``Swift`` language was added to the + :generator:`Ninja` generator: + + * Use the :envvar:`SWIFTC` environment variable to specify a compiler. + + * The :prop_tgt:`Swift_DEPENDENCIES_FILE` target property and + :prop_sf:`Swift_DEPENDENCIES_FILE` source file property were added + to customize dependency files. + + * The :prop_tgt:`Swift_MODULE_NAME` target property was added to + customize the Swift module name. + + * The :prop_sf:`Swift_DIAGNOSTICS_FILE` source property was added to + indicate where to write the serialized Swift diagnostics. + + The Swift support is experimental, not considered stable, and may change + in future releases of CMake. + +Compilers +--------- + +* The ``Clang`` compiler variant on Windows that targets the MSVC ABI + but has a GNU-like command line is now supported. + +* Support for the Clang-based ARM compiler was added with compiler id + ``ARMClang``. + +* Support was added for the IAR compiler architectures Renesas RX, + RL78, RH850 and Texas Instruments MSP430. + +* Support was added for the IAR compilers built for Linux (IAR BuildLx). + +Command-Line +------------ + +* The :envvar:`CMAKE_GENERATOR` environment variable was added + to specify a default generator to use when :manual:`cmake(1)` is + run without a ``-G`` option. Additionally, environment variables + :envvar:`CMAKE_GENERATOR_PLATFORM`, :envvar:`CMAKE_GENERATOR_TOOLSET`, + and :envvar:`CMAKE_GENERATOR_INSTANCE` were created to configure + the generator. + +* The :manual:`cmake(1)` ``--build`` tool ``--target`` parameter gained support + for multiple targets, e.g. ``cmake --build . --target Library1 Library2``. + It now also has a short form ``-t`` alias, e.g. + ``cmake --build . -t Library1 Library2``. + +* The :manual:`cmake(1)` command gained a new ``--install`` option. + This may be used after building a project to run installation without + using the generated build system or the native build tool. + +* The :manual:`cmake(1)` command learned a new CLI option ``--loglevel``. + +* The :manual:`cmake(1)` ``-E remove_directory`` command-line tool learned + to support removing multiple directories. + +* The :manual:`cmake(1)` ``-E tar`` tool has been improved: + + * It now continues adding files to an archive even if some of the files + are not readable. This behavior is more consistent with the + classic ``tar`` tool. + + * It now parses all flags, and if an invalid flag was provided, a + warning is issued. + + * It now displays an error if no action flag was specified, along with a + list of possible actions: ``t`` (list), ``c`` (create) or ``x`` (extract). + + * It now supports extracting (``-x``) or listing (``-t``) only specific + files or directories. + + * It now supports Zstandard compression with a ``--zstd`` option. + Zstandard was designed to give a compression ratio comparable to that + of the DEFLATE (zip) algorithm, but faster, especially for decompression. + +Commands +-------- + +* The :command:`add_custom_command` and :command:`add_custom_target` commands + gained a new ``JOB_POOL`` option that works with the :generator:`Ninja` + generator to set the pool variable on the build statement. + +* The :command:`add_library` command ``ALIAS`` option learned to support + import libraries of the ``UNKNOWN`` type. + +* The :command:`cmake_parse_arguments` command gained an additional + ``_KEYWORDS_MISSING_VALUES`` output variable to report + keyword arguments that were given by the caller with no values. + +* The :command:`execute_process` command gained a ``COMMAND_ECHO`` option + and supporting :variable:`CMAKE_EXECUTE_PROCESS_COMMAND_ECHO` variable + to enable echoing of the command-line string before execution. + +* The :command:`file(INSTALL)` command learned a new argument, + ``FOLLOW_SYMLINK_CHAIN``, which can be used to recursively resolve and + install symlinks. + +* :command:`list` learned new sub-commands: + ``PREPEND``, ``POP_FRONT`` and ``POP_BACK``. + +* The :command:`message` command learned new types: + ``NOTICE``, ``VERBOSE``, ``DEBUG`` and ``TRACE``. + +* The :command:`string` learned a new sub-command ``REPEAT``. + +Variables +--------- + +* The :variable:`CMAKE_CROSSCOMPILING_EMULATOR` variable and corresponding + :prop_tgt:`CROSSCOMPILING_EMULATOR` target property learned to support + arguments to the emulator. + +* The :variable:`CMAKE_FIND_PACKAGE_PREFER_CONFIG` variable was added to tell + :command:`find_package` calls to look for a package configuration + file first even if a find module is available. + +* The :variable:`CMAKE_FRAMEWORK` variable was added to initialize the + :prop_tgt:`FRAMEWORK` property on all targets. + +* The :variable:`CMAKE_VS_JUST_MY_CODE_DEBUGGING` variable and + :prop_tgt:`VS_JUST_MY_CODE_DEBUGGING` target property were added to + enable the Just My Code feature of the Visual Studio Debugger when + compiling with MSVC cl 19.05 and higher. + +* The :variable:`CMAKE_MSVC_RUNTIME_LIBRARY` variable and + :prop_tgt:`MSVC_RUNTIME_LIBRARY` target property were introduced to + select the runtime library used by compilers targeting the MSVC ABI. + See policy :policy:`CMP0091`. + +* The :variable:`CMAKE_PROJECT_INCLUDE` and + :variable:`CMAKE_PROJECT_INCLUDE_BEFORE` variables were added to allow + injection of custom code at the sites of :command:`project` calls + without knowing the project name a priori. + +Properties +---------- + +* The :prop_tgt:`ADDITIONAL_CLEAN_FILES` target property and + :prop_dir:`ADDITIONAL_CLEAN_FILES` directory property were added. + They allow to register additional files that should be removed during + the clean stage. + +* The :prop_tgt:`PUBLIC_HEADER` and :prop_tgt:`PRIVATE_HEADER` properties + may now be set on :ref:`Interface Libraries`. The headers specified by those + properties can be installed using the :command:`install(TARGETS)` command by + passing the ``PUBLIC_HEADER`` and ``PRIVATE_HEADER`` arguments respectively. + +* The :prop_tgt:`VS_PACKAGE_REFERENCES` target property was added to + tell :ref:`Visual Studio Generators` to add references to ``nuget`` + packages. + +* The :prop_tgt:`VS_PROJECT_IMPORT` target property was added to allow + managed Visual Studio project files to import external ``.props`` files. + +* The :prop_tgt:`VS_NO_SOLUTION_DEPLOY` target property was added to + tell :ref:`Visual Studio Generators` whether to deploy an artifact + to the WinCE or Windows Phone target device. + +Modules +------- + +* The :module:`FindBoost` module was reworked to expose a more consistent + user experience between its "Config" and "Module" modes and with other + find modules in general. + + * A new imported target ``Boost::headers`` is now defined (same + as ``Boost::boost``). + + * New output variables ``Boost_VERSION_MACRO``, + ``Boost_VERSION_MAJOR``, ``Boost_VERSION_MINOR``, + ``Boost_VERSION_PATCH``, and ``Boost_VERSION_COUNT`` + were added. + + * The ``QUIET`` argument passed to :command:`find_package` is no + longer ignored in config mode. Note that the CMake package shipped with + Boost ``1.70.0`` ignores the ``QUIET`` argument passed to + :command:`find_package`. This is fixed in the next Boost release. + + * The input switch ``Boost_DETAILED_FAILURE_MSG`` was removed. + + * ``Boost_VERSION`` now reports the version in ``x.y.z`` + format in module mode. See policy :policy:`CMP0093`. + +* The :module:`FindCups` module now provides imported targets. + +* The :module:`FindEnvModules` module was added to use Lua- and TCL-based + environment modules in :ref:`CTest Scripts `. + +* The :module:`FindGLEW` module now provides an interface more consistent + with what upstream GLEW provides in its own CMake package files. + +* The :module:`FindPkgConfig` now populates :prop_tgt:`INTERFACE_LINK_OPTIONS` + property of imported targets with other (non-library) linker flags. + +* The :module:`FindPostgreSQL` module learned to find debug and release + variants separately. + +* Modules :module:`FindPython3`, :module:`FindPython2` and :module:`FindPython` + gained additional lookup strategies and controls, and a new default. + See policy :policy:`CMP0094`. + +* Modules :module:`FindPython`, :module:`FindPython2` and :module:`FindPython3` + gain a new target (respectively ``Python::Module``, ``Python2::Module`` + and ``Python3::Module``) which can be used to develop Python modules. + +* Modules :module:`FindPython3`, :module:`FindPython2` and :module:`FindPython` + gain capability to control how virtual environments are handled. + +* The :module:`UseSWIG` module learned to manage alternate library names + by passing ``-interface `` for ``python`` language or + ``-dllimport `` for ``CSharp`` language to the ``SWIG`` + compiler. + +Generator Expressions +--------------------- + +* The generator expressions :genex:`$`, + :genex:`$`, :genex:`$`, + :genex:`$`, :genex:`$`, + :genex:`$`, and :genex:`$` learned to + support matching one value from a comma-separated list. + +* The :genex:`$` and :genex:`$` + generator expressions were added. + +* The :genex:`$` generator expression was introduced to + allow specification of compile options for target files based on the + :variable:`CMAKE__COMPILER_ID` and :prop_sf:`LANGUAGE` of + each source file. + +* A :genex:`$` generator expression has + been added. + +* A :genex:`$` generator expression has been added. + +* The :genex:`$` generator expression gained support for a + list of paths. + +* New ``$`` :manual:`generator expressions + ` were added to retrieve the prefix, base + name, and suffix of the file names of various artifacts: + + * :genex:`$` + * :genex:`$` + * :genex:`$` + * :genex:`$` + * :genex:`$` + * :genex:`$` + * :genex:`$` + +* The :genex:`$` generator expression is now supported + on ``SHARED``, ``STATIC``, ``MODULE`` libraries and executables. + +CTest +----- + +* The :command:`ctest_submit` command learned a new option: ``BUILD_ID``. + This can be used to store the ID assigned to this build by CDash to a + variable. + +* The :command:`ctest_update` command learned to honor a new variable: + :variable:`CTEST_UPDATE_VERSION_OVERRIDE`. This can be used to specify + the current version of your source tree rather than using the update + command to discover the current version that is checked out. + +CPack +----- + +* The :cpack_gen:`CPack IFW Generator` gained a new + :variable:`CPACK_IFW_PACKAGE_STYLE_SHEET` variable to customize the + installer stylesheet. + +Deprecated and Removed Features +=============================== + +* The :manual:`cmake-server(7)` mode has been deprecated and will be + removed from a future version of CMake. Please port clients to use + the :manual:`cmake-file-api(7)` instead. + +* The :prop_dir:`ADDITIONAL_MAKE_CLEAN_FILES` directory property is now + deprecated. Use the :prop_dir:`ADDITIONAL_CLEAN_FILES` directory property + instead. + +* The variable :variable:`CMAKE_AUTOMOC_RELAXED_MODE` is considered + deprecated. Support still exists but will be removed in future versions. + +* The :command:`export(PACKAGE)` command now does nothing unless + enabled via :variable:`CMAKE_EXPORT_PACKAGE_REGISTRY`. + See policy :policy:`CMP0090`. + +* The :generator:`Xcode` generator now requires at least Xcode 5. + +* An explicit deprecation diagnostic was added for policy ``CMP0066`` + (``CMP0065`` and below were already deprecated). + The :manual:`cmake-policies(7)` manual explains that the OLD behaviors + of all policies are deprecated and that projects should port to the + NEW behaviors. + +Other Changes +============= + +* If a feature specified by :command:`target_compile_features` is available + in the compiler's default standard level, CMake 3.14 and below incorrectly + added unnecessary ``-std=`` flags that could lower the standard level. + This bug has been fixed in CMake 3.15. This behavior change may expose + bugs in existing projects that were relying on undocumented implementation + details. Specifying compile features only ensures that the compiler runs + in a mode that has those features, not that any specific standard level is + used or explicit ``-std=`` flag passed. + +* CMake learned how to compile C++14 with the IBM AIX XL compiler + and the SunPro compiler and to compile C++20 with the AppleClang compiler. + +* With MSVC-like compilers the value of :variable:`CMAKE__FLAGS` + no longer contains warning flags like ``/W3`` by default. + See policy :policy:`CMP0092`. + +* IBM Clang-based XL compilers that define ``__ibmxl__`` now use the + compiler id ``XLClang`` instead of ``XL``. See policy :policy:`CMP0089`. + +* The :command:`file(REMOVE)` and :command:`file(REMOVE_RECURSE)` commands + were changed to ignore empty arguments with a warning instead of treating + them as a relative path and removing the contents of the current directory. + +Updates +======= + +Changes made since CMake 3.15.0 include the following. + +3.15.1 +------ + +* In CMake 3.15.0 support for the GNU-like ``Clang`` compiler targeting the + MSVC ABI implemented :variable:`CMAKE_CXX_STANDARD` values 98 and 11 using + the corresponding ``-std=`` flags. However, these modes do not work with + the MSVC standard library. Therefore CMake 3.15.1 passes C++14 standard + flags even for C++98 and C++11. This is consistent with MSVC itself which + always runs in a mode aware of C++14. + +* Preliminary Swift support added in 3.15.0 has been updated. + +3.15.2 +------ + +* In CMake 3.15.0 and 3.15.1 the :variable:`CMAKE_FIND_PACKAGE_PREFER_CONFIG` + variable caused the :command:`find_package` command to fail on a missing + package even without the ``REQUIRED`` option. This has been fixed. + +3.15.3 +------ + +* ``CrayPrgEnv`` compiler wrapper support has been updated for the 19.06 + release of the Cray Programming Environment for which the default linking + mode on XC Cray systems is now dynamic instead of static. + +3.15.4 +------ + +* In CMake 3.15.0 through 3.15.3, the :prop_dir:`EXCLUDE_FROM_ALL` + directory property was regressed from pre-3.14 behavior and caused + targets within the directory to be excluded even from its own "all". + This has been fixed. + The bug also existed in 3.14.0 through 3.14.6 and is fixed in 3.14.7. diff --git a/cmake/share/cmake-3.31/Help/release/3.16.rst b/cmake/share/cmake-3.31/Help/release/3.16.rst new file mode 100644 index 0000000000000000000000000000000000000000..d8cb46eb33638aeaf0ebd4b1e5e4b8b7035c9b39 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/release/3.16.rst @@ -0,0 +1,324 @@ +CMake 3.16 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.15 include the following. + +New Features +============ + +Languages +--------- + +* CMake learned to support the Objective C (``OBJC``) and Objective C++ + (``OBJCXX``) languages. They may be enabled via the :command:`project` + and :command:`enable_language` commands. When ``OBJC`` or ``OBJCXX`` + is enabled, source files with the ``.m`` or ``.mm``, respectively, + will be compiled as Objective C or C++. Otherwise they will be treated + as plain C++ sources as they were before. + +Compilers +--------- + +* The ``Clang`` compiler is now supported on ``Solaris``. + +Platforms +--------- + +* On AIX, executables using the :prop_tgt:`ENABLE_EXPORTS` target property + now produce a linker import file with a ``.imp`` extension in addition + to the executable file. Plugins (created via :command:`add_library` with + the ``MODULE`` option) that use :command:`target_link_libraries` to link + to the executable for its symbols are now linked using the import file. + The :command:`install(TARGETS)` command now installs the import file as + an ``ARCHIVE`` artifact. + +* On AIX, runtime linking is no longer enabled by default. CMake provides + the linker enough information to resolve all symbols up front. + One may manually enable runtime linking for shared libraries and/or + loadable modules by adding ``-Wl,-G`` to their link flags + (e.g. in the :variable:`CMAKE_SHARED_LINKER_FLAGS` or + :variable:`CMAKE_MODULE_LINKER_FLAGS` variable). + One may manually enable runtime linking for executables by adding + ``-Wl,-brtl`` to their link flags (e.g. in the + :variable:`CMAKE_EXE_LINKER_FLAGS` variable). + +Command-Line +------------ + +* :manual:`cmake(1)` ``-E`` now supports ``true`` and ``false`` commands, + which do nothing while returning exit codes of 0 and 1, respectively. + +* :manual:`cmake(1)` gained a ``--trace-redirect=`` command line + option that can be used to redirect ``--trace`` output to a file instead + of ``stderr``. + +* The :manual:`cmake(1)` ``--loglevel`` command line option has been + renamed to ``--log-level`` to make it consistent with the naming of other + command line options. The ``--loglevel`` option is still supported to + preserve backward compatibility. + +Commands +-------- + +* The :command:`add_test` command learned the option ``COMMAND_EXPAND_LISTS`` + which causes lists in the ``COMMAND`` argument to be expanded, including + lists created by generator expressions. + +* The :command:`file` command learned a new sub-command, + ``GET_RUNTIME_DEPENDENCIES``, which allows you to recursively get the list of + libraries linked by an executable or library. This sub-command is intended as + a replacement for :module:`GetPrerequisites`. + +* The :command:`find_file`, :command:`find_library`, :command:`find_path`, + :command:`find_package`, and :command:`find_program` commands have learned to + check the following variables to control the default behavior for groups of + search locations: + + * :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` - Controls the default + behavior of searching the :variable:`_ROOT` variables. + + * :variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH` - Controls the default + behavior of searching the CMake-specific environment variables. + + * :variable:`CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH` - Controls the default + behavior of searching the standard system environment variables. + + * :variable:`CMAKE_FIND_USE_CMAKE_PATH` - Controls the default behavior of + searching the CMake-specific cache variables. + + * :variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH` - Controls the default + behavior of searching the platform-specific CMake variables. + +* The :command:`find_package` command has learned to check the + :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` variable to control the default + behavior of searching the CMake user package registry and to check the + :variable:`CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY` variable to control + the default behavior of searching the CMake system package registry. + +* The :command:`message` command learned indentation control with the new + :variable:`CMAKE_MESSAGE_INDENT` variable. + +* The :command:`target_precompile_headers` command was added to specify + a list of headers to precompile for faster compilation times. + +Variables +--------- + +* The :variable:`CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS` variable has been + introduced to optionally initialize the + :prop_tgt:`CUDA_RESOLVE_DEVICE_SYMBOLS` target property. + +* The :variable:`CMAKE_ECLIPSE_RESOURCE_ENCODING` variable was added to + specify the resource encoding for the the :generator:`Eclipse CDT4` extra + generator. + +* The :variable:`CMAKE_UNITY_BUILD` variable was added to initialize the + :prop_tgt:`UNITY_BUILD` target property to tell generators to batch + include source files for faster compilation times. + +Properties +---------- + +* The :prop_tgt:`BUILD_RPATH` and :prop_tgt:`INSTALL_RPATH` target properties + now support :manual:`generator expressions `. + +* The :prop_tgt:`INSTALL_REMOVE_ENVIRONMENT_RPATH` target property was + added to remove compiler-defined ``RPATH`` entries from a target. + This property is initialized by the + :variable:`CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH` variable. + +* The :prop_tgt:`PRECOMPILE_HEADERS` target property was added to specify + a list of headers to precompile for faster compilation times. + Set it using the :command:`target_precompile_headers` command. + +* The :prop_tgt:`UNITY_BUILD` target property was added to tell + generators to batch include source files for faster compilation + times. + +* The :prop_tgt:`VS_CONFIGURATION_TYPE` target property now supports + :manual:`generator expressions `. + +* The :prop_tgt:`VS_DPI_AWARE` target property was added to tell + :ref:`Visual Studio Generators` to set the ``EnableDpiAwareness`` + property in ``.vcxproj`` files. + +* The :prop_tgt:`XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING` target property was + added to tell the :generator:`Xcode` generator to set the value of the + ``Allow debugging when using document Versions Browser`` schema option. + +Modules +------- + +* The :module:`FindDoxygen` module :command:`doxygen_add_docs` command + gained a new ``USE_STAMP_FILE`` option. When this option present, + the custom target created by the command will only re-run Doxygen if + any of the source files have changed since the last successful run. + +* The :module:`FindGnuTLS` module now provides an imported target. + +* The :module:`FindPackageHandleStandardArgs` module + :command:`find_package_handle_standard_args` command gained + a new ``REASON_FAILURE_MESSAGE`` option to specify a message + giving the reason for the failure. + +* The :module:`FindPkgConfig` module :command:`pkg_search_module` macro + now defines a ``_MODULE_NAME`` result variable containing the + first matching module name. + +* The :module:`FindPython3` and :module:`FindPython` modules gained + options to control which ``ABIs`` will be searched. + +* The :module:`FindPython3`, :module:`FindPython2`, and :module:`FindPython` + modules now support direct specification of artifacts via cache entries. + +Autogen +------- + +* When using :prop_tgt:`AUTOMOC`, the new :variable:`CMAKE_AUTOMOC_PATH_PREFIX` + variable or :prop_tgt:`AUTOMOC_PATH_PREFIX` target property may be enabled + to generate the ``-p`` path prefix + option for ``moc``. This ensures that ``moc`` output files are identical + on different build setups (given, that the headers compiled by ``moc`` are + in an :command:`include directory `). + Also it ensures that ``moc`` output files will compile correctly when the + source and/or build directory is a symbolic link. + +CTest +----- + +* :manual:`ctest(1)` now has the ability to schedule tests based on resource + requirements for each test. See :ref:`ctest-resource-allocation` for + details. + +* A new test property, :prop_test:`SKIP_REGULAR_EXPRESSION`, has been added. + This property is similar to :prop_test:`FAIL_REGULAR_EXPRESSION` and + :prop_test:`PASS_REGULAR_EXPRESSION`, but with the same meaning as + :prop_test:`SKIP_RETURN_CODE`. This is useful, for example, in cases where + the user has no control over the return code of the test. For example, in + Catch2, the return value is the number of assertion failed, therefore it is + impossible to use it for :prop_test:`SKIP_RETURN_CODE`. + +CPack +----- + +* :manual:`cpack(1)` learned support for multiple configurations for ``-C`` + option. + +* The :cpack_gen:`CPack DEB Generator` is now able to format generic text + (usually used as the description for multiple CPack generators) according + to the `Debian Policy Manual`_. See the + :variable:`CPACK_PACKAGE_DESCRIPTION_FILE` and + :variable:`CPACK_DEBIAN__DESCRIPTION` variables. + +* The :cpack_gen:`CPack Archive Generator` learned to generate ``.tar.zst`` + packages with Zstandard compression. + +.. _`Debian Policy Manual`: https://www.debian.org/doc/debian-policy/ch-controlfields.html#description + +Deprecated and Removed Features +=============================== + +* An explicit deprecation diagnostic was added for policy ``CMP0067`` + (``CMP0066`` and below were already deprecated). + The :manual:`cmake-policies(7)` manual explains that the OLD behaviors + of all policies are deprecated and that projects should port to the + NEW behaviors. + +* The :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` variable has been + deprecated. Use the :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` variable + instead. + +* The :module:`GetPrerequisites` module has been deprecated, as it has been + superseded by :command:`file(GET_RUNTIME_DEPENDENCIES)`. + +* The ``CPACK_INSTALL_SCRIPT`` variable has been deprecated in favor of the + new, more accurately named :variable:`CPACK_INSTALL_SCRIPTS` variable. + +Other Changes +============= + +* The :manual:`cmake(1)` ``-C `` option now evaluates the + initial cache script with :variable:`CMAKE_SOURCE_DIR` and + :variable:`CMAKE_BINARY_DIR` set to the top-level source and build trees. + +* The :manual:`cmake(1)` ``-E remove_directory`` command-line tool, + when given the path to a symlink to a directory, now removes just + the symlink. It no longer removes content of the linked directory. + +* The :manual:`ctest(1)` ``--build-makeprogram`` command-line option now + specifies the make program used when configuring a project with the + :generator:`Ninja` generator or the :ref:`Makefile Generators`. + +* The :module:`ExternalProject` module :command:`ExternalProject_Add` command + has been updated so that ``GIT_SUBMODULES ""`` initializes no submodules. + See policy :policy:`CMP0097`. + +* The :module:`FindGTest` module has been updated to recognize + MSVC build trees generated by GTest 1.8.1. + +* The :command:`project` command no longer strips leading zeros in version + components. See policy :policy:`CMP0096`. + +* The Qt Compressed Help file is now named ``CMake.qch``, which no longer + contains the release version in the file name. When CMake is upgraded + in-place, the name and location of this file will remain constant. + Tools such as IDEs, help viewers, etc. should now be able to refer to this + file at a fixed location that remains valid across CMake upgrades. + +* ``RPATH`` entries are properly escaped in the generated CMake scripts + used for installation. See policy :policy:`CMP0095`. + +* When using :variable:`CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS` on Windows the + auto-generated exports are now updated only when the object files + providing the symbols are updated. + +Updates +======= + +Changes made since CMake 3.16.0 include the following. + +3.16.2 +------ + +* CMake 3.16.0 and 3.16.1 processed ``.hh`` files with :prop_tgt:`AUTOMOC`. + This was a behavior change from CMake 3.15 and below that can break + existing projects, so it has been reverted as of 3.16.2. + +3.16.5 +------ + +* The :module:`FindPython`, :module:`FindPython2`, and :module:`FindPython3` + modules no longer create cache entries for ``Python{,2,3}_LIBRARY_RELEASE`` + and ``Python{,2,3}_LIBRARY_DEBUG``. Those values are always computed from + other results and so should not be cached. The entries were created by + CMake 3.16.0 through 3.16.4 but were always ``FORCE``-set and could not + be meaningfully edited by users. + + Additionally, the modules no longer expose their internal ``_Python*`` + cache entries publicly. CMake 3.16.0 through 3.16.4 accidentally + made them visible as advanced cache entries. + +3.16.7 +------ + +* Selection of the Objective C or C++ compiler now considers the + :envvar:`CC` or :envvar:`CXX` environment variable if the + :envvar:`OBJC` or :envvar:`OBJCXX` environment variable is not set. + +* The :module:`FindPkgConfig` module now extracts include directories + prefixed with ``-isystem`` into the ``*_INCLUDE_DIRS`` variables and + :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` target properties. + Previously they would be places in ``*_CFLAGS_OTHER`` variables and + :prop_tgt:`INTERFACE_COMPILE_OPTIONS` target properties. + +3.16.9 +------ + +* The default value of :variable:`CMAKE_AUTOMOC_PATH_PREFIX` was changed to + ``OFF`` because this feature can break existing projects that have + identically named header files in different include directories. + This restores compatibility with behavior of CMake 3.15 and below. diff --git a/cmake/share/cmake-3.31/Help/release/3.17.rst b/cmake/share/cmake-3.31/Help/release/3.17.rst new file mode 100644 index 0000000000000000000000000000000000000000..cd28f8cb57b07aacbcde3aa965ff98856dfc3565 --- /dev/null +++ b/cmake/share/cmake-3.31/Help/release/3.17.rst @@ -0,0 +1,357 @@ +CMake 3.17 Release Notes +************************ + +.. only:: html + + .. contents:: + +Changes made since CMake 3.16 include the following. + +New Features +============ + +Generators +---------- + +* :manual:`cmake(1)` gained a :generator:`Ninja Multi-Config` generator, + which is similar to the :generator:`Ninja` generator but can be used to build + multiple configurations at once. + +* :ref:`Visual Studio Generators` learned to support per-config sources. + Previously only :ref:`Command-Line Build Tool Generators` supported them. + +* :ref:`Visual Studio Generators` for VS 2010 and above now support + specifying the ``VCTargetsPath`` value for project files in + :variable:`CMAKE_GENERATOR_TOOLSET` setting. + +* :ref:`Visual Studio Generators` for VS 2010 and above learned to + support .NET Standard and .NET Core. See the + :prop_tgt:`DOTNET_TARGET_FRAMEWORK` target property and + associated :variable:`CMAKE_DOTNET_TARGET_FRAMEWORK` variable. + +Languages +--------- + +* The :manual:`Compile Features ` functionality + now offers meta-features for the CUDA language standard levels + (e.g. ``cuda_std_03``, ``cuda_std_14``). See + :prop_gbl:`CMAKE_CUDA_KNOWN_FEATURES`. + +Compilers +--------- + +* The IBM XL Fortran compiler is now supported by the :generator:`Ninja` + generator. + +Command-Line +------------ + +* :manual:`cmake(1)` gained a ``--debug-find`` command-line option to + enable additional human-readable output on where ``find_*`` commands search. + +* :manual:`cmake(1)` gained a ``--trace-format`` command-line option that + can be used to set the ``--trace`` output format. Currently, the old + human readable and the new JSON format are supported. The new JSON format + is easier to parse automatically than the existing format. + +* :manual:`cmake(1)` gained a ``-E rm`` command-line tool that can be + used to remove directories and files. This supersedes the existing + ``-E remove`` and ``-E remove_directory`` tools and has better semantics. + +Commands +-------- + +* The :command:`add_custom_command` command learned to interpret paths in + ``DEPENDS`` arguments that are specified relative to the current + binary directory. + +* The :command:`foreach` command learned a new ``ZIP_LISTS`` option to iterate + over multiple lists simultaneously. + +* The :command:`load_cache(READ_WITH_PREFIX)` command mode is now allowed + when using ``cmake -P`` to :ref:`Run a Script