diff options
author | Alex Turbov <i.zaufi@gmail.com> | 2022-08-04 10:38:46 +0400 |
---|---|---|
committer | Alex Turbov <i.zaufi@gmail.com> | 2022-08-04 19:33:42 +0400 |
commit | 183a49cbfe0359072e379a30295355ecfb9c70a5 (patch) | |
tree | 83596268292dc1e505114359707f54bfbe185241 /Modules/CTestUseLaunchers.cmake | |
parent | 765d2768f11641f5d22d8e3203f709fc8cd284ac (diff) | |
download | cmake-183a49cbfe0359072e379a30295355ecfb9c70a5.tar.gz |
Help: Replace mentions of ``-S`` option with :option:`-S` role
Diffstat (limited to 'Modules/CTestUseLaunchers.cmake')
-rw-r--r-- | Modules/CTestUseLaunchers.cmake | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Modules/CTestUseLaunchers.cmake b/Modules/CTestUseLaunchers.cmake index 23a206b2a5..5c544f8cd9 100644 --- a/Modules/CTestUseLaunchers.cmake +++ b/Modules/CTestUseLaunchers.cmake @@ -11,7 +11,7 @@ CTestUseLaunchers is automatically included when you include(CTest). However, it is split out into its own module file so projects can use the CTEST_USE_LAUNCHERS functionality independently. -To use launchers, set CTEST_USE_LAUNCHERS to ON in a ctest -S +To use launchers, set CTEST_USE_LAUNCHERS to ON in a :option:`ctest -S` dashboard script, and then also set it in the cache of the configured project. Both cmake and ctest need to know the value of it for the launchers to work properly. CMake needs to know in order to generate @@ -27,9 +27,12 @@ variable initialization only occurs if CTEST_USE_LAUNCHERS is not already defined. .. versionadded:: 3.8 - If CTEST_USE_LAUNCHERS is on in a ctest -S script + If CTEST_USE_LAUNCHERS is on in a :option:`ctest -S` script the ctest_configure command will add -DCTEST_USE_LAUNCHERS:BOOL=TRUE to the cmake command used to configure the project. + +.. TODO Use RST markup + #]=======================================================================] if(NOT DEFINED CTEST_USE_LAUNCHERS AND DEFINED ENV{CTEST_USE_LAUNCHERS_DEFAULT}) |