Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-19 19:43:23 +08:00
Code Issues Projects Releases Wiki Activity

Help: Replace mentions of `-S option with :option:-S` role

Browse Source
This commit is contained in:
Alex Turbov
2022-08-04 10:38:46 +04:00
parent 765d2768f1
commit 183a49cbfe
4 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Help/command/ctest_run_script.rst
View File

@@ -1,15 +1,15 @@
ctest_run_script 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 ctest_run_script([NEW_PROCESS] script_file_name script_file_name1
script_file_name2 ... [RETURN_VALUE var]) script_file_name2 ... [RETURN_VALUE var])
Runs a script or scripts much like if it was run from ctest -S. If no Runs a script or scripts much like if it was run from :option:`ctest -S`.
argument is provided then the current script is run using the current 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 settings of the variables. If ``NEW_PROCESS`` is specified then each
script will be run in a separate process.If ``RETURN_VALUE`` is specified 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``. the return value of the last script run will be put into ``var``.

2
Help/command/ctest_start.rst
View File

@@ -45,7 +45,7 @@ The parameters are as follows:
ctest_start(Experimental GROUP GroupExperimental) ctest_start(Experimental GROUP GroupExperimental)
Later, in another ``ctest -S`` script: Later, in another :option:`ctest -S` script:
.. code-block:: cmake .. code-block:: cmake

2
Help/variable/CTEST_RUN_CURRENT_SCRIPT.rst
View File

@@ -4,4 +4,4 @@ CTEST_RUN_CURRENT_SCRIPT
.. versionadded:: 3.11 .. versionadded:: 3.11
Setting this to 0 prevents :manual:`ctest(1)` from being run again when it 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`.

7
Modules/CTestUseLaunchers.cmake
View File

@@ -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 However, it is split out into its own module file so projects can use
the CTEST_USE_LAUNCHERS functionality independently. 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 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 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 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. already defined.
.. versionadded:: 3.8 .. 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 the ctest_configure command will add -DCTEST_USE_LAUNCHERS:BOOL=TRUE
to the cmake command used to configure the project. 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}) if(NOT DEFINED CTEST_USE_LAUNCHERS AND DEFINED ENV{CTEST_USE_LAUNCHERS_DEFAULT})