diff options
| author | Craig Scott <craig.scott@crascit.com> | 2024-08-23 23:15:16 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2024-08-23 23:16:03 (GMT) |
| commit | d48834d277bc9be593751cbdaa0873ca1b849d06 (patch) | |
| tree | 0fa6fe4f9adbdab4655562853d9cb27ac7ad9247 /Help/command | |
| parent | 2233964cb159dc1e5224572af82cd642e344ded1 (diff) | |
| parent | a1fdcb9d474d83e3adbd249acd670b23a025dbeb (diff) | |
| download | CMake-d48834d277bc9be593751cbdaa0873ca1b849d06.zip CMake-d48834d277bc9be593751cbdaa0873ca1b849d06.tar.gz CMake-d48834d277bc9be593751cbdaa0873ca1b849d06.tar.bz2 | |
Merge topic 'doc-get_property-undefined'
a1fdcb9d47 Help: get_property() result var is unset if property is not set
edee1b18b2 Help: Minor formatting and grammar fixes for get_property()
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !9769
Diffstat (limited to 'Help/command')
| -rw-r--r-- | Help/command/get_property.rst | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/Help/command/get_property.rst b/Help/command/get_property.rst index a0a12bb..202bfd9 100644 --- a/Help/command/get_property.rst +++ b/Help/command/get_property.rst @@ -29,7 +29,7 @@ It must be one of the following: Scope is unique and does not accept a name. ``DIRECTORY`` - Scope defaults to the current directory but another + Scope defaults to the current directory, but another directory (already processed by CMake) may be named by the full or relative path ``<dir>``. Relative paths are treated as relative to the current source directory. @@ -79,10 +79,10 @@ It must be one of the following: ``DIRECTORY <dir>`` The test property will be read from the ``<dir>`` directory's - scope. CMake must already know about the directory, either by having added - it through a call to :command:`add_subdirectory` or ``<dir>`` being the top - level directory. Relative paths are treated as relative to the current - source directory. ``<dir>`` may reference a binary directory. + scope. CMake must already know about the directory, either by having + added it through a call to :command:`add_subdirectory` or ``<dir>`` being + the top level directory. Relative paths are treated as relative to the + current source directory. ``<dir>`` may reference a binary directory. ``CACHE`` Scope must name one cache entry. @@ -91,19 +91,20 @@ It must be one of the following: Scope is unique and does not accept a name. The required ``PROPERTY`` option is immediately followed by the name of -the property to get. If the property is not set an empty value is -returned, although some properties support inheriting from a parent scope -if defined to behave that way (see :command:`define_property`). +the property to get. If the property is not set, the named ``<variable>`` +will be unset in the calling scope upon return, although some properties +support inheriting from a parent scope if defined to behave that way +(see :command:`define_property`). -If the ``SET`` option is given the variable is set to a boolean +If the ``SET`` option is given, the variable is set to a boolean value indicating whether the property has been set. If the ``DEFINED`` -option is given the variable is set to a boolean value indicating -whether the property has been defined such as with the +option is given, the variable is set to a boolean value indicating +whether the property has been defined, such as with the :command:`define_property` command. -If ``BRIEF_DOCS`` or ``FULL_DOCS`` is given then the variable is set to a +If ``BRIEF_DOCS`` or ``FULL_DOCS`` is given, then the variable is set to a string containing documentation for the requested property. If -documentation is requested for a property that has not been defined +documentation is requested for a property that has not been defined, ``NOTFOUND`` is returned. .. note:: |