diff options
author | Alex Turbov <i.zaufi@gmail.com> | 2022-08-04 06:38:46 (GMT) |
---|---|---|
committer | Alex Turbov <i.zaufi@gmail.com> | 2022-08-04 15:33:42 (GMT) |
commit | 183a49cbfe0359072e379a30295355ecfb9c70a5 (patch) | |
tree | 83596268292dc1e505114359707f54bfbe185241 | |
parent | 765d2768f11641f5d22d8e3203f709fc8cd284ac (diff) | |
download | CMake-183a49cbfe0359072e379a30295355ecfb9c70a5.zip CMake-183a49cbfe0359072e379a30295355ecfb9c70a5.tar.gz CMake-183a49cbfe0359072e379a30295355ecfb9c70a5.tar.bz2 |
Help: Replace mentions of ``-S`` option with :option:`-S` role
-rw-r--r-- | Help/command/ctest_run_script.rst | 6 | ||||
-rw-r--r-- | Help/command/ctest_start.rst | 2 | ||||
-rw-r--r-- | Help/variable/CTEST_RUN_CURRENT_SCRIPT.rst | 2 | ||||
-rw-r--r-- | Modules/CTestUseLaunchers.cmake | 7 |
4 files changed, 10 insertions, 7 deletions
diff --git a/Help/command/ctest_run_script.rst b/Help/command/ctest_run_script.rst index 5ec543e..a2b348f 100644 --- a/Help/command/ctest_run_script.rst +++ b/Help/command/ctest_run_script.rst @@ -1,15 +1,15 @@ ctest_run_script ---------------- -runs a ctest -S script +runs a :option:`ctest -S` script :: ctest_run_script([NEW_PROCESS] script_file_name script_file_name1 script_file_name2 ... [RETURN_VALUE var]) -Runs a script or scripts much like if it was run from ctest -S. If no -argument is provided then the current script is run using the current +Runs a script or scripts much like if it was run from :option:`ctest -S`. +If no argument is provided then the current script is run using the current settings of the variables. If ``NEW_PROCESS`` is specified then each script will be run in a separate process.If ``RETURN_VALUE`` is specified the return value of the last script run will be put into ``var``. diff --git a/Help/command/ctest_start.rst b/Help/command/ctest_start.rst index c0f3c6d..921279a 100644 --- a/Help/command/ctest_start.rst +++ b/Help/command/ctest_start.rst @@ -45,7 +45,7 @@ The parameters are as follows: ctest_start(Experimental GROUP GroupExperimental) - Later, in another ``ctest -S`` script: + Later, in another :option:`ctest -S` script: .. code-block:: cmake diff --git a/Help/variable/CTEST_RUN_CURRENT_SCRIPT.rst b/Help/variable/CTEST_RUN_CURRENT_SCRIPT.rst index 32c85ad..8cb6eaa 100644 --- a/Help/variable/CTEST_RUN_CURRENT_SCRIPT.rst +++ b/Help/variable/CTEST_RUN_CURRENT_SCRIPT.rst @@ -4,4 +4,4 @@ CTEST_RUN_CURRENT_SCRIPT .. versionadded:: 3.11 Setting this to 0 prevents :manual:`ctest(1)` from being run again when it -reaches the end of a script run by calling ``ctest -S``. +reaches the end of a script run by calling :option:`ctest -S`. diff --git a/Modules/CTestUseLaunchers.cmake b/Modules/CTestUseLaunchers.cmake index 23a206b..5c544f8 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}) |