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 /Help | |
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
Diffstat (limited to 'Help')
-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 |
3 files changed, 5 insertions, 5 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`. |