mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-03 12:19:41 -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
37 lines
1.2 KiB
ReStructuredText
37 lines
1.2 KiB
ReStructuredText
get_directory_property
|
|
----------------------
|
|
|
|
Get a property of ``DIRECTORY`` scope.
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_directory_property(<variable> [DIRECTORY <dir>] <prop-name>)
|
|
|
|
Stores a property of directory scope in the named ``<variable>``.
|
|
|
|
The ``DIRECTORY`` argument specifies another directory from which
|
|
to retrieve the property value instead of the current directory.
|
|
Relative paths are treated as relative to the
|
|
current source directory. CMake must already know about the directory,
|
|
either by having added it through a call to :command:`add_subdirectory`
|
|
or being the top level directory.
|
|
|
|
.. versionadded:: 3.19
|
|
``<dir>`` may reference a binary directory.
|
|
|
|
If the property is not defined for the nominated directory scope,
|
|
an empty string is returned. In the case of ``INHERITED`` properties,
|
|
if the property is not found for the nominated directory scope,
|
|
the search will chain to a parent scope as described for the
|
|
:command:`define_property` command.
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_directory_property(<variable> [DIRECTORY <dir>]
|
|
DEFINITION <var-name>)
|
|
|
|
Get a variable definition from a directory. This form is useful to
|
|
get a variable definition from another directory.
|
|
|
|
See also the more general :command:`get_property` command.
|