summaryrefslogtreecommitdiffstats
path: root/Help/command/get_cmake_property.rst
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 15:17:36 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-15 18:12:03 (GMT)
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/command/get_cmake_property.rst
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadCMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Help/command/get_cmake_property.rst')
-rw-r--r--Help/command/get_cmake_property.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/Help/command/get_cmake_property.rst b/Help/command/get_cmake_property.rst
new file mode 100644
index 0000000..bcfc5e8
--- /dev/null
+++ b/Help/command/get_cmake_property.rst
@@ -0,0 +1,15 @@
+get_cmake_property
+------------------
+
+Get a property of the CMake instance.
+
+::
+
+ get_cmake_property(VAR property)
+
+Get a 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". Some supported properties include: VARIABLES,
+CACHE_VARIABLES, COMMANDS, MACROS, and COMPONENTS.
+
+See also the more general get_property() command.