mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-07 06:09:52 -06:00
c705279bae
This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
108 lines
4.0 KiB
ReStructuredText
108 lines
4.0 KiB
ReStructuredText
set_property
|
|
------------
|
|
|
|
Set a named property in a given scope.
|
|
|
|
.. code-block:: cmake
|
|
|
|
set_property(<GLOBAL |
|
|
DIRECTORY [<dir>] |
|
|
TARGET [<target1> ...] |
|
|
SOURCE [<src1> ...]
|
|
[DIRECTORY <dirs> ...] |
|
|
[TARGET_DIRECTORY <targets> ...]
|
|
INSTALL [<file1> ...] |
|
|
TEST [<test1> ...] |
|
|
CACHE [<entry1> ...] >
|
|
[APPEND] [APPEND_STRING]
|
|
PROPERTY <name> [<value1> ...])
|
|
|
|
Sets one property on zero or more objects of a scope.
|
|
|
|
The first argument determines the scope in which the property is set.
|
|
It must be one of the following:
|
|
|
|
``GLOBAL``
|
|
Scope is unique and does not accept a name.
|
|
|
|
``DIRECTORY``
|
|
Scope defaults to the current directory but other directories
|
|
(already processed by CMake) may be named by full or relative path.
|
|
Relative paths are treated as relative to the current source directory.
|
|
See also the :command:`set_directory_properties` command.
|
|
|
|
.. versionadded:: 3.19
|
|
``<dir>`` may reference a binary directory.
|
|
|
|
``TARGET``
|
|
Scope may name zero or more existing targets.
|
|
See also the :command:`set_target_properties` command.
|
|
|
|
``SOURCE``
|
|
Scope may name zero or more source files. By default, source file properties
|
|
are only visible to targets added in the same directory (``CMakeLists.txt``).
|
|
|
|
.. versionadded:: 3.18
|
|
Visibility can be set in other directory scopes using one or both of the
|
|
following sub-options:
|
|
|
|
``DIRECTORY <dirs>...``
|
|
The source file property will be set in each of the ``<dirs>``
|
|
directories' scopes. CMake must already know about
|
|
each of these directories, either by having added them through a call to
|
|
:command:`add_subdirectory` or it being the top level source directory.
|
|
Relative paths are treated as relative to the current source directory.
|
|
|
|
.. versionadded:: 3.19
|
|
``<dirs>`` may reference a binary directory.
|
|
|
|
``TARGET_DIRECTORY <targets>...``
|
|
The source file property will be set in each of the directory scopes
|
|
where any of the specified ``<targets>`` were created (the ``<targets>``
|
|
must therefore already exist).
|
|
|
|
See also the :command:`set_source_files_properties` command.
|
|
|
|
``INSTALL``
|
|
.. versionadded:: 3.1
|
|
|
|
Scope may name zero or more installed file paths.
|
|
These are made available to CPack to influence deployment.
|
|
|
|
Both the property key and value may use generator expressions.
|
|
Specific properties may apply to installed files and/or directories.
|
|
|
|
Path components have to be separated by forward slashes,
|
|
must be normalized and are case sensitive.
|
|
|
|
To reference the installation prefix itself with a relative path use ``.``.
|
|
|
|
Currently installed file properties are only defined for
|
|
the WIX generator where the given paths are relative
|
|
to the installation prefix.
|
|
|
|
``TEST``
|
|
Scope may name zero or more existing tests.
|
|
See also the :command:`set_tests_properties` command.
|
|
|
|
``CACHE``
|
|
Scope must name zero or more cache existing entries.
|
|
|
|
The required ``PROPERTY`` option is immediately followed by the name of
|
|
the property to set. Remaining arguments are used to compose the
|
|
property value in the form of a semicolon-separated list.
|
|
|
|
If the ``APPEND`` option is given the list is appended to any existing
|
|
property value (except that empty values are ignored and not appended).
|
|
If the ``APPEND_STRING`` option is given the string is
|
|
appended to any existing property value as string, i.e. it results in a
|
|
longer string and not a list of strings. When using ``APPEND`` or
|
|
``APPEND_STRING`` with a property defined to support ``INHERITED``
|
|
behavior (see :command:`define_property`), no inheriting occurs when
|
|
finding the initial value to append to. If the property is not already
|
|
directly set in the nominated scope, the command will behave as though
|
|
``APPEND`` or ``APPEND_STRING`` had not been given.
|
|
|
|
See the :manual:`cmake-properties(7)` manual for a list of properties
|
|
in each scope.
|