summaryrefslogtreecommitdiffstats
path: root/Help/prop_tgt/TEST_LAUNCHER.rst
diff options
context:
space:
mode:
authorRalf Habacker <ralf.habacker@freenet.de>2023-11-11 16:33:39 (GMT)
committerBrad King <brad.king@kitware.com>2023-12-13 15:20:43 (GMT)
commit1ec0372ed4b450e242fdb8f6a7d2862baa61b501 (patch)
tree2ae040a6f48ea682b62f72b56b593b72f3f286c5 /Help/prop_tgt/TEST_LAUNCHER.rst
parent478a5f4e044d253971e71a41ad6fc6b8aa4e1c07 (diff)
downloadCMake-1ec0372ed4b450e242fdb8f6a7d2862baa61b501.zip
CMake-1ec0372ed4b450e242fdb8f6a7d2862baa61b501.tar.gz
CMake-1ec0372ed4b450e242fdb8f6a7d2862baa61b501.tar.bz2
add_test: Optionally use a launcher for tests running in-project targets
Add a `CMAKE_TEST_LAUNCHER` variable and corresponding `TEST_LAUNCHER` target property. Issue: #23672
Diffstat (limited to 'Help/prop_tgt/TEST_LAUNCHER.rst')
-rw-r--r--Help/prop_tgt/TEST_LAUNCHER.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/Help/prop_tgt/TEST_LAUNCHER.rst b/Help/prop_tgt/TEST_LAUNCHER.rst
new file mode 100644
index 0000000..2e44492
--- /dev/null
+++ b/Help/prop_tgt/TEST_LAUNCHER.rst
@@ -0,0 +1,20 @@
+TEST_LAUNCHER
+-------------
+
+.. versionadded:: 3.29
+
+Use the given launcher to run executables.
+This command will be added as a prefix to :command:`add_test` commands
+for build target system executables and is meant to be run on the host
+machine.
+
+It effectively acts as a run script for tests in a similar way
+to how :variable:`CMAKE_<LANG>_COMPILER_LAUNCHER` works for compilation.
+
+If this property contains a :ref:`semicolon-separated list <CMake Language
+Lists>`, then the first value is the command and remaining values are its
+arguments.
+
+This property is initialized by the value of the
+:variable:`CMAKE_TEST_LAUNCHER` variable if it is set when a target
+is created.