summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2022-01-13 20:59:48 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2022-01-20 14:05:35 (GMT)
commitfce24e4f102686c5c103db301bb698e0ea82765f (patch)
treee5effdc88ea773c899b08b084aaf89dc936885dc /Help
parent1ca83ae2bbf9e474c46b6ea094c5035420bbfd45 (diff)
downloadCMake-fce24e4f102686c5c103db301bb698e0ea82765f.zip
CMake-fce24e4f102686c5c103db301bb698e0ea82765f.tar.gz
CMake-fce24e4f102686c5c103db301bb698e0ea82765f.tar.bz2
define_property(): Add INITIALIZE_FROM_VARIABLE argument
Fixes: #20698
Diffstat (limited to 'Help')
-rw-r--r--Help/command/define_property.rst8
-rw-r--r--Help/release/dev/target-properties-from-variables.rst5
2 files changed, 12 insertions, 1 deletions
diff --git a/Help/command/define_property.rst b/Help/command/define_property.rst
index 9474513..3bd958e 100644
--- a/Help/command/define_property.rst
+++ b/Help/command/define_property.rst
@@ -9,7 +9,8 @@ Define and document custom properties.
TEST | VARIABLE | CACHED_VARIABLE>
PROPERTY <name> [INHERITED]
[BRIEF_DOCS <brief-doc> [docs...]]
- [FULL_DOCS <full-doc> [docs...]])
+ [FULL_DOCS <full-doc> [docs...]]
+ [INITIALIZE_FROM_VARIABLE <variable>])
Defines one property in a scope for use with the :command:`set_property` and
:command:`get_property` commands. This is primarily useful to associate
@@ -57,3 +58,8 @@ The ``BRIEF_DOCS`` and ``FULL_DOCS`` options are followed by strings to be
associated with the property as its brief and full documentation.
Corresponding options to the :command:`get_property` command will retrieve
the documentation.
+
+The ``INITIALIZE_FROM_VARIABLE`` option is followed by the name of a variable
+from which to initialize the property. The variable name must end with the
+property name, must have a prefix before the property name, and must not begin
+with ``CMAKE_`` or ``_CMAKE_``.
diff --git a/Help/release/dev/target-properties-from-variables.rst b/Help/release/dev/target-properties-from-variables.rst
new file mode 100644
index 0000000..99857c4
--- /dev/null
+++ b/Help/release/dev/target-properties-from-variables.rst
@@ -0,0 +1,5 @@
+target-properties-from-variables
+--------------------------------
+
+* The :command:`define_property` command gained a new
+ ``INITIALIZE_FROM_VARIABLE`` argument.