kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Help: Clarify get_cmake_property command documentation 

Closes: #13810, #16258
This commit is contained in:
Brad King 2016-08-23 11:14:09 -04:00
parent 797f7ad87d
commit 15cc50fbb5
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Help/command/get_cmake_property.rst
View File

@ -1,15 +1,20 @@
get_cmake_property get_cmake_property
------------------ ------------------
Get a property of the CMake instance. Get a global property of the CMake instance.
:: ::
get_cmake_property(VAR property) 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`` stored in the variable ``VAR``. If the property is not found, ``VAR``
will be set to "NOTFOUND". See the :manual:`cmake-properties(7)` manual will be set to "NOTFOUND". See the :manual:`cmake-properties(7)` manual
for available properties. 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.