diff options
| author | Brad King <brad.king@kitware.com> | 2016-08-24 13:45:41 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2016-08-24 13:45:41 (GMT) |
| commit | 21a7809bfaa02ec3d11620676636e65b47065b62 (patch) | |
| tree | 27c73f6e6227c17784aa4f79169fad8c95ed6318 /Help | |
| parent | 5c8b69b0f5408bb59a92ff3f061bd76efa773eff (diff) | |
| parent | 15cc50fbb505b526e28c708e4e1b16e79a66799c (diff) | |
| download | CMake-21a7809bfaa02ec3d11620676636e65b47065b62.zip CMake-21a7809bfaa02ec3d11620676636e65b47065b62.tar.gz CMake-21a7809bfaa02ec3d11620676636e65b47065b62.tar.bz2 | |
Merge topic 'doc-get_cmake_property'
15cc50fb Help: Clarify get_cmake_property command documentation
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/get_cmake_property.rst | 11 |
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. |