summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2016-08-23 15:14:09 (GMT)
committerBrad King <brad.king@kitware.com>2016-08-23 15:14:09 (GMT)
commit15cc50fbb505b526e28c708e4e1b16e79a66799c (patch)
treedfe6012507da0954d1d04a794a2811d467f8d0a9 /Help
parent797f7ad87d6f1b6dd7cbbb553d5525ac8ee390f1 (diff)
downloadCMake-15cc50fbb505b526e28c708e4e1b16e79a66799c.zip
CMake-15cc50fbb505b526e28c708e4e1b16e79a66799c.tar.gz
CMake-15cc50fbb505b526e28c708e4e1b16e79a66799c.tar.bz2
Help: Clarify get_cmake_property command documentation
Closes: #13810, #16258
Diffstat (limited to 'Help')
-rw-r--r--Help/command/get_cmake_property.rst11
1 files changed, 8 insertions, 3 deletions
diff --git a/Help/command/get_cmake_property.rst b/Help/command/get_cmake_property.rst
index 3a6fb41..497ab4e 100644
--- a/Help/command/get_cmake_property.rst
+++ b/Help/command/get_cmake_property.rst
@@ -1,15 +1,20 @@
get_cmake_property
------------------
-Get a property of the CMake instance.
+Get a global property of the CMake instance.
::
get_cmake_property(VAR property)
-Get a property from the CMake instance. The value of the property is
+Get a global property from the CMake instance. The value of the property is
stored in the variable ``VAR``. If the property is not found, ``VAR``
will be set to "NOTFOUND". See the :manual:`cmake-properties(7)` manual
for available properties.
-See also the more general :command:`get_property` command.
+See also the :command:`get_property` command ``GLOBAL`` option.
+
+In addition to global properties, this command (for historical reasons)
+also supports the :prop_dir:`VARIABLES` and :prop_dir:`MACROS` directory
+properties. It also supports a special ``COMPONENTS`` global property that
+lists the components given to the :command:`install` command.