diff options
author | Kitware Robot <kwrobot@kitware.com> | 2013-10-15 11:17:36 -0400 |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-15 14:12:03 -0400 |
commit | f051814ed0e63badbfd68049354f36259dbf4b49 (patch) | |
tree | f4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Modules/CTestUseLaunchers.cmake | |
parent | e94958e99c4dec26c86ce8b76d744c04ba960675 (diff) | |
download | cmake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz |
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:
./convert-help.bash "/path/to/CMake-build/bin"
Then remove it.
Diffstat (limited to 'Modules/CTestUseLaunchers.cmake')
-rw-r--r-- | Modules/CTestUseLaunchers.cmake | 32 |
1 files changed, 19 insertions, 13 deletions
diff --git a/Modules/CTestUseLaunchers.cmake b/Modules/CTestUseLaunchers.cmake index 24f5f2e16d..2fab247eb5 100644 --- a/Modules/CTestUseLaunchers.cmake +++ b/Modules/CTestUseLaunchers.cmake @@ -1,21 +1,27 @@ -# - Set the RULE_LAUNCH_* global properties when CTEST_USE_LAUNCHERS is on. +#.rst: +# CTestUseLaunchers +# ----------------- +# +# Set the RULE_LAUNCH_* global properties when CTEST_USE_LAUNCHERS is on. +# # 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. +# 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 # 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 proper build -# rules, and ctest, in order to produce the proper error and warning -# analysis. +# 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 +# proper build rules, and ctest, in order to produce the proper error +# and warning analysis. # -# For convenience, you may set the ENV variable CTEST_USE_LAUNCHERS_DEFAULT -# in your ctest -S script, too. Then, as long as your CMakeLists uses -# include(CTest) or include(CTestUseLaunchers), it will use the value of the -# ENV variable to initialize a CTEST_USE_LAUNCHERS cache variable. This cache -# variable initialization only occurs if CTEST_USE_LAUNCHERS is not already -# defined. +# For convenience, you may set the ENV variable +# CTEST_USE_LAUNCHERS_DEFAULT in your ctest -S script, too. Then, as +# long as your CMakeLists uses include(CTest) or +# include(CTestUseLaunchers), it will use the value of the ENV variable +# to initialize a CTEST_USE_LAUNCHERS cache variable. This cache +# variable initialization only occurs if CTEST_USE_LAUNCHERS is not +# already defined. #============================================================================= # Copyright 2008-2012 Kitware, Inc. |