From 34379f005b3ebab952113ce641ac666b85d7840a Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Fri, 5 Jan 2024 15:37:39 +1100 Subject: Help: Use consistently in property getter commands Property-related commands used a mix of , , or to specify the variable to store the result in. The form is particularly confusing, since being uppercase it looks more like a keyword. Use consistently across all the commands so that the behavior is clear. --- Help/command/get_cmake_property.rst | 6 +++--- Help/command/get_target_property.rst | 14 +++++++------- Help/command/get_test_property.rst | 8 ++++---- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/Help/command/get_cmake_property.rst b/Help/command/get_cmake_property.rst index b1d18a0..9f78a86 100644 --- a/Help/command/get_cmake_property.rst +++ b/Help/command/get_cmake_property.rst @@ -5,11 +5,11 @@ Get a global property of the CMake instance. .. code-block:: cmake - get_cmake_property( ) + get_cmake_property( ) Gets a global property from the CMake instance. The value of -the ```` is stored in the variable ````. -If the property is not found, ```` will be set to ``NOTFOUND``. +the ```` is stored in the specified ````. +If the property is not found, ```` will be set to ``NOTFOUND``. See the :manual:`cmake-properties(7)` manual for available properties. In addition to global properties, this command (for historical reasons) diff --git a/Help/command/get_target_property.rst b/Help/command/get_target_property.rst index 20027ee..f4135cf 100644 --- a/Help/command/get_target_property.rst +++ b/Help/command/get_target_property.rst @@ -5,15 +5,15 @@ Get a property from a target. .. code-block:: cmake - get_target_property( ) + get_target_property( ) -Get a property from a target. The value of the property is stored in -the variable ````. If the target property is not found, the behavior +Get a property from a target. The value of the property is stored in the +specified ````. If the target property is not found, the behavior depends on whether it has been defined to be an ``INHERITED`` property -or not (see :command:`define_property`). Non-inherited properties will -set ```` to ``-NOTFOUND``, whereas inherited properties will search -the relevant parent scope as described for the :command:`define_property` -command and if still unable to find the property, ```` will be set to +or not (see :command:`define_property`). Non-inherited properties will set +```` to ``-NOTFOUND``, whereas inherited properties will +search the relevant parent scope as described for the :command:`define_property` +command and if still unable to find the property, ```` will be set to an empty string. Use :command:`set_target_properties` to set target property values. diff --git a/Help/command/get_test_property.rst b/Help/command/get_test_property.rst index 08ddd4e..866894d 100644 --- a/Help/command/get_test_property.rst +++ b/Help/command/get_test_property.rst @@ -5,15 +5,15 @@ Get a property of the test. .. code-block:: cmake - get_test_property( [DIRECTORY ] ) + get_test_property( [DIRECTORY ] ) Get a property from the test. The value of the property is stored in -the variable ````. If the test property is not found, the behavior +the specified ````. If the test property is not found, the behavior depends on whether it has been defined to be an ``INHERITED`` property or not (see :command:`define_property`). Non-inherited properties will set -```` to ``NOTFOUND``, whereas inherited properties will search the +```` to ``NOTFOUND``, whereas inherited properties will search the relevant parent scope as described for the :command:`define_property` -command and if still unable to find the property, ```` will be set to +command and if still unable to find the property, ```` will be set to an empty string. For a list of standard properties you can type -- cgit v0.12