summaryrefslogtreecommitdiffstats
path: root/Help/command/get_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_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_property.rst')
-rw-r--r--Help/command/get_property.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/Help/command/get_property.rst b/Help/command/get_property.rst
new file mode 100644
index 0000000..c2937be
--- /dev/null
+++ b/Help/command/get_property.rst
@@ -0,0 +1,49 @@
+get_property
+------------
+
+Get a property.
+
+::
+
+ get_property(<variable>
+ <GLOBAL |
+ DIRECTORY [dir] |
+ TARGET <target> |
+ SOURCE <source> |
+ TEST <test> |
+ CACHE <entry> |
+ VARIABLE>
+ PROPERTY <name>
+ [SET | DEFINED | BRIEF_DOCS | FULL_DOCS])
+
+Get one property from one object in a scope. The first argument
+specifies the variable in which to store the result. The second
+argument determines the scope from which to get the property. It must
+be one of the following:
+
+GLOBAL scope is unique and does not accept a name.
+
+DIRECTORY scope defaults to the current directory but another
+directory (already processed by CMake) may be named by full or
+relative path.
+
+TARGET scope must name one existing target.
+
+SOURCE scope must name one source file.
+
+TEST scope must name one existing test.
+
+CACHE scope must name one cache entry.
+
+VARIABLE scope is unique and does not accept a name.
+
+The required PROPERTY option is immediately followed by the name of
+the property to get. If the property is not set an empty value is
+returned. If the SET option is given the variable is set to a boolean
+value indicating whether the property has been set. If the DEFINED
+option is given the variable is set to a boolean value indicating
+whether the property has been defined such as with define_property.
+If BRIEF_DOCS or FULL_DOCS is given then the variable is set to a
+string containing documentation for the requested property. If
+documentation is requested for a property that has not been defined
+NOTFOUND is returned.