From 15cc50fbb505b526e28c708e4e1b16e79a66799c Mon Sep 17 00:00:00 2001 From: Brad King Date: Tue, 23 Aug 2016 11:14:09 -0400 Subject: [PATCH] Help: Clarify get_cmake_property command documentation Closes: #13810, #16258 --- Help/command/get_cmake_property.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/Help/command/get_cmake_property.rst b/Help/command/get_cmake_property.rst index 3a6fb41e1..497ab4eeb 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.