This commit is contained in:
kleuter
2023-11-01 21:39:10 +01:00
parent 5c4154eda2
commit 94b1c5907b
3387 changed files with 0 additions and 0 deletions

View File

@ -0,0 +1,23 @@
ADDITIONAL_CLEAN_FILES
----------------------
.. versionadded:: 3.15
A :ref:`;-list <CMake Language Lists>` of files or directories that will be
removed as a part of the global ``clean`` target. It is useful for
specifying generated files or directories that are used by multiple targets
or by CMake itself, or that are generated in ways which cannot be captured as
outputs or byproducts of custom commands.
If an additional clean file is specific to a single target only, then the
:prop_tgt:`ADDITIONAL_CLEAN_FILES` target property would usually be a better
choice than this directory property.
Relative paths are allowed and are interpreted relative to the
current binary directory.
Contents of ``ADDITIONAL_CLEAN_FILES`` may use
:manual:`generator expressions <cmake-generator-expressions(7)>`.
This property only works for the :generator:`Ninja` and the Makefile
generators. It is ignored by other generators.

View File

@ -0,0 +1,17 @@
ADDITIONAL_MAKE_CLEAN_FILES
---------------------------
.. deprecated:: 3.15
Use :prop_dir:`ADDITIONAL_CLEAN_FILES` instead.
Additional files to remove during the clean stage.
A :ref:`;-list <CMake Language Lists>` of files that will be removed as a
part of the ``make clean`` target.
Arguments to ``ADDITIONAL_MAKE_CLEAN_FILES`` may use
:manual:`generator expressions <cmake-generator-expressions(7)>`.
This property only works for the Makefile generators.
It is ignored on other generators.

View File

@ -0,0 +1,7 @@
BINARY_DIR
----------
.. versionadded:: 3.7
This read-only directory property reports absolute path to the binary
directory corresponding to the source on which it is read.

View File

@ -0,0 +1,15 @@
BUILDSYSTEM_TARGETS
-------------------
.. versionadded:: 3.7
This read-only directory property contains a
:ref:`semicolon-separated list <CMake Language Lists>` of buildsystem targets added in the
directory by calls to the :command:`add_library`, :command:`add_executable`,
and :command:`add_custom_target` commands. The list does not include any
:ref:`Imported Targets` or :ref:`Alias Targets`, but does include
:ref:`Interface Libraries`. Each entry in the list is the logical name
of a target, suitable to pass to the :command:`get_property` command
``TARGET`` option.
See also the :prop_dir:`IMPORTED_TARGETS` directory property.

View File

@ -0,0 +1,7 @@
CACHE_VARIABLES
---------------
List of cache variables available in the current directory.
This read-only property specifies the list of CMake cache variables
currently defined. It is intended for debugging purposes.

View File

@ -0,0 +1,6 @@
CLEAN_NO_CUSTOM
---------------
Set to true to tell :ref:`Makefile Generators` not to remove the outputs of
custom commands for this directory during the ``make clean`` operation.
This is ignored on other generators because it is not possible to implement.

View File

@ -0,0 +1,9 @@
CMAKE_CONFIGURE_DEPENDS
-----------------------
Tell CMake about additional input files to the configuration process.
If any named file is modified the build system will re-run CMake to
re-configure the file and generate the build system again.
Specify files as a semicolon-separated list of paths. Relative paths
are interpreted as relative to the current source directory.

View File

@ -0,0 +1,34 @@
COMPILE_DEFINITIONS
-------------------
Preprocessor definitions for compiling a directory's sources.
This property specifies the list of options given so far to the
:command:`add_compile_definitions` (or :command:`add_definitions`) command.
The ``COMPILE_DEFINITIONS`` property may be set to a semicolon-separated
list of preprocessor definitions using the syntax ``VAR`` or ``VAR=value``.
Function-style definitions are not supported. CMake will
automatically escape the value correctly for the native build system
(note that CMake language syntax may require escapes to specify some
values).
This property will be initialized in each directory by its value in the
directory's parent.
CMake will automatically drop some definitions that are not supported
by the native build tool.
.. versionadded:: 3.26
Any leading ``-D`` on an item will be removed.
.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt
Contents of ``COMPILE_DEFINITIONS`` may use "generator expressions" with
the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
manual for available expressions. See the :manual:`cmake-buildsystem(7)`
manual for more on defining buildsystem properties.
The corresponding :prop_dir:`COMPILE_DEFINITIONS_<CONFIG>` property may
be set to specify per-configuration definitions. Generator expressions
should be preferred instead of setting the alternative property.

View File

@ -0,0 +1,19 @@
COMPILE_DEFINITIONS_<CONFIG>
----------------------------
Ignored. See CMake Policy :policy:`CMP0043`.
Per-configuration preprocessor definitions in a directory.
This is the configuration-specific version of :prop_dir:`COMPILE_DEFINITIONS`
where ``<CONFIG>`` is an upper-case name (ex. ``COMPILE_DEFINITIONS_DEBUG``).
This property will be initialized in each directory by its value in
the directory's parent.
Contents of ``COMPILE_DEFINITIONS_<CONFIG>`` 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.

View File

@ -0,0 +1,16 @@
COMPILE_OPTIONS
---------------
List of options to pass to the compiler.
This property holds a :ref:`semicolon-separated list <CMake Language Lists>` of options
given so far to the :command:`add_compile_options` command.
This property is used to initialize the :prop_tgt:`COMPILE_OPTIONS` target
property when a target is created, which is used by the generators to set
the options for the compiler.
Contents of ``COMPILE_OPTIONS`` may use "generator expressions" with the
syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual
for available expressions. See the :manual:`cmake-buildsystem(7)` manual
for more on defining buildsystem properties.

View File

@ -0,0 +1,13 @@
DEFINITIONS
-----------
For CMake 2.4 compatibility only. Use :prop_dir:`COMPILE_DEFINITIONS`
instead.
This read-only property specifies the list of flags given so far to
the :command:`add_definitions` command. It is intended for debugging
purposes. Use the :prop_dir:`COMPILE_DEFINITIONS` directory property
instead.
This built-in read-only property does not exist if policy
:policy:`CMP0059` is set to ``NEW``.

View File

@ -0,0 +1,13 @@
EXCLUDE_FROM_ALL
----------------
Set this directory property to a true value on a subdirectory to exclude
its targets from the "all" target of its ancestors. If excluded, running
e.g. ``make`` in the parent directory will not build targets the
subdirectory by default. This does not affect the "all" target of the
subdirectory itself. Running e.g. ``make`` inside the subdirectory will
still build its targets.
If the :prop_tgt:`EXCLUDE_FROM_ALL` target property is set on a target
then its value determines whether the target is included in the "all"
target of this directory and its ancestors.

View File

@ -0,0 +1,34 @@
IMPLICIT_DEPENDS_INCLUDE_TRANSFORM
----------------------------------
Specify ``#include`` line transforms for dependencies in a directory.
This property specifies rules to transform macro-like ``#include`` lines
during implicit dependency scanning of C and C++ source files. The
list of rules must be semicolon-separated with each entry of the form
``A_MACRO(%)=value-with-%`` (the ``%`` must be literal). During dependency
scanning occurrences of ``A_MACRO(...)`` on ``#include`` lines will be
replaced by the value given with the macro argument substituted for
``%``. For example, the entry
::
MYDIR(%)=<mydir/%>
will convert lines of the form
::
#include MYDIR(myheader.h)
to
::
#include <mydir/myheader.h>
allowing the dependency to be followed.
This property applies to sources in all targets within a directory.
The property value is initialized in each directory by its value in
the directory's parent.

View File

@ -0,0 +1,14 @@
IMPORTED_TARGETS
----------------
.. versionadded:: 3.21
This read-only directory property contains a
:ref:`semicolon-separated list <CMake Language Lists>` of
:ref:`Imported Targets` added in the directory by calls to the
:command:`add_library` and :command:`add_executable` commands.
Each entry in the list is the logical name of a target, suitable
to pass to the :command:`get_property` command ``TARGET`` option
when called in the same directory.
See also the :prop_dir:`BUILDSYSTEM_TARGETS` directory property.

View File

@ -0,0 +1,32 @@
INCLUDE_DIRECTORIES
-------------------
List of preprocessor include file search directories.
This property specifies the list of directories given so far to the
:command:`include_directories` command.
This property is used to populate the :prop_tgt:`INCLUDE_DIRECTORIES`
target property, which is used by the generators to set the include
directories for the compiler.
In addition to accepting values from that command, values may be set
directly on any directory using the :command:`set_property` command, and can be
set on the current directory using the :command:`set_directory_properties`
command. A directory gets its initial value from its parent directory if it has
one. The initial value of the :prop_tgt:`INCLUDE_DIRECTORIES` target property
comes from the value of this property. Both directory and target property
values are adjusted by calls to the :command:`include_directories` command.
Calls to :command:`set_property` or :command:`set_directory_properties`,
however, will update the directory property value without updating target
property values. Therefore direct property updates must be made before
calls to :command:`add_executable` or :command:`add_library` for targets
they are meant to affect.
The target property values are used by the generators to set the
include paths for the compiler.
Contents of ``INCLUDE_DIRECTORIES`` may use "generator expressions" with
the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
manual for available expressions. See the :manual:`cmake-buildsystem(7)`
manual for more on defining buildsystem properties.

View File

@ -0,0 +1,9 @@
INCLUDE_REGULAR_EXPRESSION
--------------------------
Include file scanning regular expression.
This property specifies the regular expression used during
dependency scanning to match include files that should be followed.
See the :command:`include_regular_expression` command for a high-level
interface to set this property.

View File

@ -0,0 +1,6 @@
INTERPROCEDURAL_OPTIMIZATION
----------------------------
This directory property does not exist anymore.
See the target property :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` instead.

View File

@ -0,0 +1,6 @@
INTERPROCEDURAL_OPTIMIZATION_<CONFIG>
-------------------------------------
This directory property does not exist anymore.
See the target property :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION_<CONFIG>` instead.

View File

@ -0,0 +1,15 @@
LABELS
------
.. versionadded:: 3.10
Specify a list of text labels associated with a directory and all of its
subdirectories. This is equivalent to setting the :prop_tgt:`LABELS` target
property and the :prop_test:`LABELS` test property on all targets and tests in
the current directory and subdirectories. Note: Launchers must enabled to
propagate labels to targets.
The :variable:`CMAKE_DIRECTORY_LABELS` variable can be used to initialize this
property.
The list is reported in dashboard submissions.

View File

@ -0,0 +1,17 @@
LINK_DIRECTORIES
----------------
List of linker search directories.
This property holds a :ref:`semicolon-separated list <CMake Language Lists>` of directories
and is typically populated using the :command:`link_directories` command.
It gets its initial value from its parent directory, if it has one.
The directory property is used to initialize the :prop_tgt:`LINK_DIRECTORIES`
target property when a target is created. That target property is used
by the generators to set the library search directories for the linker.
Contents of ``LINK_DIRECTORIES`` may use "generator expressions" with
the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
manual for available expressions. See the :manual:`cmake-buildsystem(7)`
manual for more on defining buildsystem properties.

View File

@ -0,0 +1,19 @@
LINK_OPTIONS
------------
.. versionadded:: 3.13
List of options to use for the link step of shared library, module
and executable targets as well as the device link step.
This property holds a :ref:`semicolon-separated list <CMake Language Lists>` of options
given so far to the :command:`add_link_options` command.
This property is used to initialize the :prop_tgt:`LINK_OPTIONS` target
property when a target is created, which is used by the generators to set
the options for the compiler.
Contents of ``LINK_OPTIONS`` may use "generator expressions" with the
syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual
for available expressions. See the :manual:`cmake-buildsystem(7)` manual
for more on defining buildsystem properties.

View File

@ -0,0 +1,10 @@
LISTFILE_STACK
--------------
The current stack of listfiles being processed.
This property is mainly useful when trying to debug errors in your
CMake scripts. It returns a list of what list files are currently
being processed, in order. So if one listfile does an
:command:`include` command then that is effectively pushing the
included listfile onto the stack.

View File

@ -0,0 +1,8 @@
MACROS
------
List of macro commands available in the current directory.
This read-only property specifies the list of CMake macros currently
defined. It is intended for debugging purposes. See the :command:`macro`
command.

View File

@ -0,0 +1,8 @@
PARENT_DIRECTORY
----------------
Source directory that added current subdirectory.
This read-only property specifies the source directory that added the
current source directory as a subdirectory of the build. In the
top-level directory the value is the empty-string.

View File

@ -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:`<LANG>_COMPILER_LAUNCHER` target
properties or the associated :variable:`CMAKE_<LANG>_COMPILER_LAUNCHER`
variables instead.
See the :prop_gbl:`global property <RULE_LAUNCH_COMPILE>` of the same name
for details. This overrides the global property for a directory.

View File

@ -0,0 +1,7 @@
RULE_LAUNCH_CUSTOM
------------------
Specify a launcher for custom rules.
See the global property of the same name for details. This overrides
the global property for a directory.

View File

@ -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:`<LANG>_LINKER_LAUNCHER` target
properties or the associated :variable:`CMAKE_<LANG>_LINKER_LAUNCHER`
variables instead.
See the :prop_gbl:`global property <RULE_LAUNCH_LINK>` of the same name for
details. This overrides the global property for a directory.

View File

@ -0,0 +1,7 @@
SOURCE_DIR
----------
.. versionadded:: 3.7
This read-only directory property reports absolute path to the source
directory on which it is read.

View File

@ -0,0 +1,17 @@
SUBDIRECTORIES
--------------
.. versionadded:: 3.7
This read-only directory property contains a
:ref:`semicolon-separated list <CMake Language Lists>` of subdirectories processed so far by
the :command:`add_subdirectory` or :command:`subdirs` commands. Each entry is
the absolute path to the source directory (containing the ``CMakeLists.txt``
file). This is suitable to pass to the :command:`get_property` command
``DIRECTORY`` option.
.. note::
The :command:`subdirs` command does not process its arguments until
after the calling directory is fully processed. Therefore looking
up this property in the current directory will not see them.

View File

@ -0,0 +1,10 @@
SYSTEM
------
.. versionadded:: 3.25
This directory property is used to initialize the :prop_tgt:`SYSTEM`
target property for non-imported targets created in that directory.
It is set to true by :command:`add_subdirectory` and
:command:`FetchContent_Declare` when the ``SYSTEM`` option is given
as an argument to those commands.

View File

@ -0,0 +1,10 @@
TESTS
-----
.. versionadded:: 3.12
List of tests.
This read-only property holds a
:ref:`semicolon-separated list <CMake Language Lists>` of tests
defined so far, in the current directory, by the :command:`add_test` command.

View File

@ -0,0 +1,9 @@
TEST_INCLUDE_FILE
-----------------
Deprecated. Use :prop_dir:`TEST_INCLUDE_FILES` instead.
A cmake file that will be included when ctest is run.
If you specify ``TEST_INCLUDE_FILE``, that file will be included and
processed when ctest is run on the directory.

View File

@ -0,0 +1,9 @@
TEST_INCLUDE_FILES
------------------
.. versionadded:: 3.10
A list of cmake files that will be included when ctest is run.
If you specify ``TEST_INCLUDE_FILES``, those files will be included and
processed when ctest is run on the directory.

View File

@ -0,0 +1,7 @@
VARIABLES
---------
List of variables defined in the current directory.
This read-only property specifies the list of CMake variables
currently defined. It is intended for debugging purposes.

View File

@ -0,0 +1,31 @@
VS_GLOBAL_SECTION_POST_<section>
--------------------------------
Specify a postSolution global section in Visual Studio.
Setting a property like this generates an entry of the following form
in the solution file:
::
GlobalSection(<section>) = postSolution
<contents based on property value>
EndGlobalSection
The property must be set to a semicolon-separated list of ``key=value``
pairs. Each such pair will be transformed into an entry in the
solution global section. Whitespace around key and value is ignored.
List elements which do not contain an equal sign are skipped.
This property only works for Visual Studio 9 and above; it is ignored
on other generators. The property only applies when set on a
directory whose ``CMakeLists.txt`` contains a :command:`project` command.
Note that CMake generates postSolution sections ``ExtensibilityGlobals``
and ``ExtensibilityAddIns`` by default. If you set the corresponding
property, it will override the default section. For example, setting
``VS_GLOBAL_SECTION_POST_ExtensibilityGlobals`` will override the default
contents of the ``ExtensibilityGlobals`` section, while keeping
ExtensibilityAddIns on its default. However, CMake will always
add a ``SolutionGuid`` to the ``ExtensibilityGlobals`` section
if it is not specified explicitly.

View File

@ -0,0 +1,22 @@
VS_GLOBAL_SECTION_PRE_<section>
-------------------------------
Specify a preSolution global section in Visual Studio.
Setting a property like this generates an entry of the following form
in the solution file:
::
GlobalSection(<section>) = preSolution
<contents based on property value>
EndGlobalSection
The property must be set to a semicolon-separated list of ``key=value``
pairs. Each such pair will be transformed into an entry in the
solution global section. Whitespace around key and value is ignored.
List elements which do not contain an equal sign are skipped.
This property only works for Visual Studio 9 and above; it is ignored
on other generators. The property only applies when set on a
directory whose ``CMakeLists.txt`` contains a :command:`project` command.

View File

@ -0,0 +1,20 @@
VS_STARTUP_PROJECT
------------------
.. versionadded:: 3.6
Specify the default startup project in a Visual Studio solution.
The :ref:`Visual Studio Generators` create a ``.sln`` file for each directory
whose ``CMakeLists.txt`` file calls the :command:`project` command. Set this
property in the same directory as a :command:`project` command call (e.g. in
the top-level ``CMakeLists.txt`` file) to specify the default startup project
for the corresponding solution file.
The property must be set to the name of an existing target. This
will cause that project to be listed first in the generated solution
file causing Visual Studio to make it the startup project if the
solution has never been opened before.
If this property is not specified, then the ``ALL_BUILD`` project
will be the default.