summaryrefslogtreecommitdiffstats
path: root/Help/command/get_cmake_property.rst
diff options
context:
space:
mode:
authorJoachim Wuttke (l) <j.wuttke@fz-juelich.de>2018-10-16 19:50:48 (GMT)
committerJoachim Wuttke (o) <j.wuttke@fz-juelich.de>2018-10-23 13:12:10 (GMT)
commitc2efb3efcd083523a73a2a9721b7101fbfc0fe0f (patch)
tree51feae595367cd8b91ab27c34000129c9a8c38b6 /Help/command/get_cmake_property.rst
parent7053dd301c694bbc5e13b7e32febd34596b22d4e (diff)
downloadCMake-c2efb3efcd083523a73a2a9721b7101fbfc0fe0f.zip
CMake-c2efb3efcd083523a73a2a9721b7101fbfc0fe0f.tar.gz
CMake-c2efb3efcd083523a73a2a9721b7101fbfc0fe0f.tar.bz2
Help: Revise docs on Scripting Commands
Revise docs for all "Scripting Commands", except four find_XXX that use a macro suite of their own. * Take full advantage of the improved syntax highlighting. * Make consequential use of <..> placeholders. * Clarify things here and there in the text. Specific improvements to some command docs: * "math": Correct description of novel hexadecimal capability. * "if", "foreach", "while": Provide link to "endif" etc * "foreach", "while": Mention "break" and "continue". * "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures; advise against negative arguments or reverse ranges (compare issue #18461) * "endif", "endfunction" etc: Explain that the argument is optional and maintained for compatibility only
Diffstat (limited to 'Help/command/get_cmake_property.rst')
-rw-r--r--Help/command/get_cmake_property.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Help/command/get_cmake_property.rst b/Help/command/get_cmake_property.rst
index 497ab4e..58bf741 100644
--- a/Help/command/get_cmake_property.rst
+++ b/Help/command/get_cmake_property.rst
@@ -3,14 +3,14 @@ get_cmake_property
Get a global property of the CMake instance.
-::
+.. code-block:: cmake
- get_cmake_property(VAR property)
+ get_cmake_property(<var> <property>)
-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.
+Gets 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 :command:`get_property` command ``GLOBAL`` option.