summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2023-08-11 14:44:14 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2023-08-11 14:50:52 (GMT)
commit2ccb897d86598daa983f77ce764411c5723b568c (patch)
treef12a2bab221a7dff8efa4b08bffd6bc7f92772e6 /Help
parent84e76fedb0255ac4d0524f47268be79598b096fc (diff)
downloadCMake-2ccb897d86598daa983f77ce764411c5723b568c.zip
CMake-2ccb897d86598daa983f77ce764411c5723b568c.tar.gz
CMake-2ccb897d86598daa983f77ce764411c5723b568c.tar.bz2
get_test_property(): Add DIRECTORY option
Diffstat (limited to 'Help')
-rw-r--r--Help/command/get_test_property.rst13
-rw-r--r--Help/release/dev/test-properties-directory.rst3
2 files changed, 15 insertions, 1 deletions
diff --git a/Help/command/get_test_property.rst b/Help/command/get_test_property.rst
index 2b6f354..1fcf24e 100644
--- a/Help/command/get_test_property.rst
+++ b/Help/command/get_test_property.rst
@@ -5,7 +5,7 @@ Get a property of the test.
.. code-block:: cmake
- get_test_property(test property VAR)
+ get_test_property(test property [DIRECTORY <dir>] VAR)
Get a property from the test. The value of the property is stored in
the variable ``VAR``. If the test property is not found, the behavior
@@ -19,6 +19,17 @@ an empty string.
For a list of standard properties you can type
:option:`cmake --help-property-list`.
+.. versionadded:: 3.28
+ Directory scope can be overridden with the following sub-option:
+
+ ``DIRECTORY <dir>``
+ The test property will be read from the ``<dir>`` directory's
+ scope. CMake must already know about that source directory, either by
+ having added it through a call to :command:`add_subdirectory` or ``<dir>``
+ being the top level source directory. Relative paths are treated as
+ relative to the current source directory. ``<dir>`` may reference a binary
+ directory.
+
See Also
^^^^^^^^
diff --git a/Help/release/dev/test-properties-directory.rst b/Help/release/dev/test-properties-directory.rst
index 2daa533..9df7051 100644
--- a/Help/release/dev/test-properties-directory.rst
+++ b/Help/release/dev/test-properties-directory.rst
@@ -10,3 +10,6 @@ test-properties-directory
* The ``TEST`` mode of the :command:`get_property` command gained a
``DIRECTORY`` sub-option, which allows you to get properties on tests in
other directories.
+* The :command:`get_test_property` command gained a ``DIRECTORY``
+ sub-option, which allows you to get properties on tests in other
+ directories.