summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2023-08-14 15:18:04 (GMT)
committerKitware Robot <kwrobot@kitware.com>2023-08-14 15:18:54 (GMT)
commit2eab65ca828084559e1019bd1263c5ab147bf135 (patch)
tree3fde898ff573722bbbe2f23cdb3a7c542b30e74a /Help
parent0d95b68bd807ccc4eee44619da29974caf3a1a1b (diff)
parent2ccb897d86598daa983f77ce764411c5723b568c (diff)
downloadCMake-2eab65ca828084559e1019bd1263c5ab147bf135.zip
CMake-2eab65ca828084559e1019bd1263c5ab147bf135.tar.gz
CMake-2eab65ca828084559e1019bd1263c5ab147bf135.tar.bz2
Merge topic 'test-properties-directory'
2ccb897d86 get_test_property(): Add DIRECTORY option 84e76fedb0 get_property(TEST): Add DIRECTORY option efc8f19cc5 set_tests_properties(): Add DIRECTORY option 753999d4db set_property(TEST): Add DIRECTORY option Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8709
Diffstat (limited to 'Help')
-rw-r--r--Help/command/get_property.rst13
-rw-r--r--Help/command/get_test_property.rst13
-rw-r--r--Help/command/set_property.rst14
-rw-r--r--Help/command/set_tests_properties.rst10
-rw-r--r--Help/release/dev/test-properties-directory.rst15
5 files changed, 62 insertions, 3 deletions
diff --git a/Help/command/get_property.rst b/Help/command/get_property.rst
index 6b9931e..a0a12bb 100644
--- a/Help/command/get_property.rst
+++ b/Help/command/get_property.rst
@@ -12,7 +12,8 @@ Get a property.
SOURCE <source>
[DIRECTORY <dir> | TARGET_DIRECTORY <target>] |
INSTALL <file> |
- TEST <test> |
+ TEST <test>
+ [DIRECTORY <dir>] |
CACHE <entry> |
VARIABLE >
PROPERTY <name>
@@ -73,6 +74,16 @@ It must be one of the following:
Scope must name one existing test.
See also the :command:`get_test_property` command.
+ .. 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 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.
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/command/set_property.rst b/Help/command/set_property.rst
index fc43974..f14b63d 100644
--- a/Help/command/set_property.rst
+++ b/Help/command/set_property.rst
@@ -12,7 +12,8 @@ Set a named property in a given scope.
[DIRECTORY <dirs> ...]
[TARGET_DIRECTORY <targets> ...] |
INSTALL [<file1> ...] |
- TEST [<test1> ...] |
+ TEST [<test1> ...]
+ [DIRECTORY <dir>] |
CACHE [<entry1> ...] >
[APPEND] [APPEND_STRING]
PROPERTY <name> [<value1> ...])
@@ -91,6 +92,17 @@ It must be one of the following:
:manual:`generator expressions <cmake-generator-expressions(7)>`
for tests created by the :command:`add_test(NAME)` signature.
+ .. versionadded:: 3.28
+
+ Visibility can be set in other directory scopes using the following sub-option:
+
+ ``DIRECTORY <dir>``
+ The test property will be set in the ``<dir>`` directory's scope. CMake must
+ already know about this directory, either by having added it through a call
+ to :command:`add_subdirectory` or it being the top level source directory.
+ Relative paths are treated as relative to the current source directory.
+ ``<dir>`` may reference a binary directory.
+
``CACHE``
Scope must name zero or more existing cache entries.
diff --git a/Help/command/set_tests_properties.rst b/Help/command/set_tests_properties.rst
index 1df9d73..da750e3 100644
--- a/Help/command/set_tests_properties.rst
+++ b/Help/command/set_tests_properties.rst
@@ -14,6 +14,16 @@ Test property values may be specified using
:manual:`generator expressions <cmake-generator-expressions(7)>`
for tests created by the :command:`add_test(NAME)` signature.
+.. versionadded:: 3.28
+ Visibility can be set in other directory scopes using the following option:
+
+ ``DIRECTORY <dir>``
+ The test properties will be set in the ``<dir>`` directory's scope.
+ CMake must already know about this directory, either by having added it
+ through a call to :command:`add_subdirectory` or it 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
new file mode 100644
index 0000000..9df7051
--- /dev/null
+++ b/Help/release/dev/test-properties-directory.rst
@@ -0,0 +1,15 @@
+test-properties-directory
+-------------------------
+
+* The ``TEST`` mode of the :command:`set_property` command gained a
+ ``DIRECTORY`` sub-option, which allows you to set properties on tests in
+ other directories.
+* The :command:`set_tests_properties` command gained a ``DIRECTORY``
+ sub-option, which allows you to set properties on tests in other
+ directories.
+* 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.