diff options
| author | Craig Scott <craig.scott@crascit.com> | 2018-03-21 10:32:21 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2018-03-21 10:39:54 (GMT) |
| commit | ff6234509e34269767b4f7d97a824e5899d0ba2a (patch) | |
| tree | 8f16ed9ad4b48254d349a3afdb970d118e59645d /Help/command/get_directory_property.rst | |
| parent | 9cc97ab4dc647b1ca9b67bb7300453c8341607a7 (diff) | |
| download | CMake-ff6234509e34269767b4f7d97a824e5899d0ba2a.zip CMake-ff6234509e34269767b4f7d97a824e5899d0ba2a.tar.gz CMake-ff6234509e34269767b4f7d97a824e5899d0ba2a.tar.bz2 | |
Help: Clarify behavior of INHERITED properties
Fixes: #17839
Diffstat (limited to 'Help/command/get_directory_property.rst')
| -rw-r--r-- | Help/command/get_directory_property.rst | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/Help/command/get_directory_property.rst b/Help/command/get_directory_property.rst index e50abe0..bf8349c 100644 --- a/Help/command/get_directory_property.rst +++ b/Help/command/get_directory_property.rst @@ -7,11 +7,16 @@ Get a property of ``DIRECTORY`` scope. get_directory_property(<variable> [DIRECTORY <dir>] <prop-name>) -Store a property of directory scope in the named variable. If the -property is not defined the empty-string is returned. The ``DIRECTORY`` -argument specifies another directory from which to retrieve the -property value. The specified directory must have already been -traversed by CMake. +Store a property of directory scope in the named ``<variable>``. +The ``DIRECTORY`` argument specifies another directory from which +to retrieve the property value instead of the current directory. +The specified directory must have already been traversed by CMake. + +If the property is not defined for the nominated directory scope, +an empty string is returned. In the case of ``INHERITED`` properties, +if the property is not found for the nominated directory scope, +the search will chain to a parent scope as described for the +:command:`define_property` command. :: |