Commit de710f37 authored by Brad King's avatar Brad King

Help: Add placeholder documents for CTest Script variables

Provide a minimal explanation of each variable by simply naming
the corresponding ctest(1) setting and linking to the ctest(1)
manual.
parent 8785b3d8
......@@ -308,6 +308,57 @@ Variables for Languages
/variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS
/variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG
Variables for CTest
===================
.. toctree::
:maxdepth: 1
/variable/CTEST_BINARY_DIRECTORY
/variable/CTEST_BUILD_COMMAND
/variable/CTEST_BUILD_NAME
/variable/CTEST_BZR_COMMAND
/variable/CTEST_BZR_UPDATE_OPTIONS
/variable/CTEST_CHECKOUT_COMMAND
/variable/CTEST_CONFIGURATION_TYPE
/variable/CTEST_CONFIGURE_COMMAND
/variable/CTEST_COVERAGE_COMMAND
/variable/CTEST_COVERAGE_EXTRA_FLAGS
/variable/CTEST_CURL_OPTIONS
/variable/CTEST_CVS_CHECKOUT
/variable/CTEST_CVS_COMMAND
/variable/CTEST_CVS_UPDATE_OPTIONS
/variable/CTEST_DROP_LOCATION
/variable/CTEST_DROP_METHOD
/variable/CTEST_DROP_SITE
/variable/CTEST_DROP_SITE_CDASH
/variable/CTEST_DROP_SITE_PASSWORD
/variable/CTEST_DROP_SITE_USER
/variable/CTEST_GIT_COMMAND
/variable/CTEST_GIT_UPDATE_CUSTOM
/variable/CTEST_GIT_UPDATE_OPTIONS
/variable/CTEST_HG_COMMAND
/variable/CTEST_HG_UPDATE_OPTIONS
/variable/CTEST_MEMORYCHECK_COMMAND
/variable/CTEST_MEMORYCHECK_COMMAND_OPTIONS
/variable/CTEST_MEMORYCHECK_SUPPRESSIONS_FILE
/variable/CTEST_NIGHTLY_START_TIME
/variable/CTEST_P4_CLIENT
/variable/CTEST_P4_COMMAND
/variable/CTEST_P4_OPTIONS
/variable/CTEST_P4_UPDATE_OPTIONS
/variable/CTEST_SCP_COMMAND
/variable/CTEST_SITE
/variable/CTEST_SOURCE_DIRECTORY
/variable/CTEST_SVN_COMMAND
/variable/CTEST_SVN_OPTIONS
/variable/CTEST_SVN_UPDATE_OPTIONS
/variable/CTEST_TEST_TIMEOUT
/variable/CTEST_TRIGGER_SITE
/variable/CTEST_UPDATE_COMMAND
/variable/CTEST_UPDATE_OPTIONS
/variable/CTEST_USE_LAUNCHERS
Variables for CPack
===================
......
CTEST_BINARY_DIRECTORY
----------------------
Specify the CTest ``BuildDirectory`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_BUILD_COMMAND
-------------------
Specify the CTest ``MakeCommand`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_BUILD_NAME
----------------
Specify the CTest ``BuildName`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_BZR_COMMAND
-----------------
Specify the CTest ``BZRCommand`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_BZR_UPDATE_OPTIONS
------------------------
Specify the CTest ``BZRUpdateOptions`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_CHECKOUT_COMMAND
----------------------
Tell the :command:`ctest_start` command how to checkout or initialize
the source directory in a :manual:`ctest(1)` dashboard client script.
CTEST_CONFIGURATION_TYPE
------------------------
Specify the CTest ``DefaultCTestConfigurationType`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_CONFIGURE_COMMAND
-----------------------
Specify the CTest ``ConfigureCommand`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_COVERAGE_COMMAND
----------------------
Specify the CTest ``CoverageCommand`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_COVERAGE_EXTRA_FLAGS
--------------------------
Specify the CTest ``CoverageExtraFlags`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_CURL_OPTIONS
------------------
Specify the CTest ``CurlOptions`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_CVS_CHECKOUT
------------------
Deprecated. Use :variable:`CTEST_CHECKOUT_COMMAND` instead.
CTEST_CVS_COMMAND
-----------------
Specify the CTest ``CVSCommand`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_CVS_UPDATE_OPTIONS
------------------------
Specify the CTest ``CVSUpdateOptions`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_DROP_LOCATION
-------------------
Specify the CTest ``DropLocation`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_DROP_METHOD
-----------------
Specify the CTest ``DropMethod`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_DROP_SITE
---------------
Specify the CTest ``DropSite`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_DROP_SITE_CDASH
---------------------
Specify the CTest ``IsCDash`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_DROP_SITE_PASSWORD
------------------------
Specify the CTest ``DropSitePassword`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_DROP_SITE_USER
--------------------
Specify the CTest ``DropSiteUser`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_GIT_COMMAND
-----------------
Specify the CTest ``GITCommand`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_GIT_UPDATE_CUSTOM
-----------------------
Specify the CTest ``GITUpdateCustom`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_GIT_UPDATE_OPTIONS
------------------------
Specify the CTest ``GITUpdateOptions`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_HG_COMMAND
----------------
Specify the CTest ``HGCommand`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_HG_UPDATE_OPTIONS
-----------------------
Specify the CTest ``HGUpdateOptions`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_MEMORYCHECK_COMMAND
-------------------------
Specify the CTest ``MemoryCheckCommand`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_MEMORYCHECK_COMMAND_OPTIONS
---------------------------------
Specify the CTest ``MemoryCheckCommandOptions`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_MEMORYCHECK_SUPPRESSIONS_FILE
-----------------------------------
Specify the CTest ``MemoryCheckSuppressionFile`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_NIGHTLY_START_TIME
------------------------
Specify the CTest ``NightlyStartTime`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_P4_CLIENT
---------------
Specify the CTest ``P4Client`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_P4_COMMAND
----------------
Specify the CTest ``P4Command`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_P4_OPTIONS
----------------
Specify the CTest ``P4Options`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_P4_UPDATE_OPTIONS
-----------------------
Specify the CTest ``P4UpdateOptions`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_SCP_COMMAND
-----------------
Specify the CTest ``SCPCommand`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_SITE
----------
Specify the CTest ``Site`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_SOURCE_DIRECTORY
----------------------
Specify the CTest ``SourceDirectory`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_SVN_COMMAND
-----------------
Specify the CTest ``SVNCommand`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_SVN_OPTIONS
-----------------
Specify the CTest ``SVNOptions`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_SVN_UPDATE_OPTIONS
------------------------
Specify the CTest ``SVNUpdateOptions`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_TEST_TIMEOUT
------------------
Specify the CTest ``TimeOut`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_TRIGGER_SITE
------------------
Specify the CTest ``TriggerSite`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_UPDATE_COMMAND
--------------------
Specify the CTest ``UpdateCommand`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_UPDATE_OPTIONS
--------------------
Specify the CTest ``UpdateOptions`` setting
in a :manual:`ctest(1)` dashboard client script.
CTEST_USE_LAUNCHERS
-------------------
Specify the CTest ``UseLaunchers`` setting
in a :manual:`ctest(1)` dashboard client script.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment