summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorChristopher Tetreault <ctetreau@quicinc.com>2020-06-22 22:48:09 (GMT)
committerBrad King <brad.king@kitware.com>2020-06-23 12:17:59 (GMT)
commitf4b911a2c9fbf91c2f00d872c4adcef848fd51ec (patch)
treef569caa7554870f38c90b9e7913410b2aab55a99 /Help/command
parente66fe75792a2fbe9f3ffe237c748008906ae7116 (diff)
downloadCMake-f4b911a2c9fbf91c2f00d872c4adcef848fd51ec.zip
CMake-f4b911a2c9fbf91c2f00d872c4adcef848fd51ec.tar.gz
CMake-f4b911a2c9fbf91c2f00d872c4adcef848fd51ec.tar.bz2
Help: Update docs for failure result of get_target_property
If `get_target_property` fails to find a value for a non-inherited property, it appends `-NOTFOUND` to the var name and sets that as the result, rather than setting the value of the var to `NOTFOUND`.
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/get_target_property.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/Help/command/get_target_property.rst b/Help/command/get_target_property.rst
index 11e07ea..985b1ff 100644
--- a/Help/command/get_target_property.rst
+++ b/Help/command/get_target_property.rst
@@ -5,15 +5,15 @@ Get a property from a target.
.. code-block:: cmake
- get_target_property(VAR target property)
+ get_target_property(<VAR> target property)
Get a property from a target. The value of the property is stored in
-the variable ``VAR``. If the target property is not found, the behavior
+the variable ``<VAR>``. If the target property is not found, the behavior
depends on whether it has been defined to be an ``INHERITED`` property
or not (see :command:`define_property`). Non-inherited properties will
-set ``VAR`` to ``NOTFOUND``, whereas inherited properties will search the
-relevant parent scope as described for the :command:`define_property`
-command and if still unable to find the property, ``VAR`` will be set to
+set ``<VAR>`` to ``<VAR>-NOTFOUND``, whereas inherited properties will search
+the relevant parent scope as described for the :command:`define_property`
+command and if still unable to find the property, ``<VAR>`` will be set to
an empty string.
Use :command:`set_target_properties` to set target property values.