summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorZack Galbreath <zack.galbreath@kitware.com>2015-07-08 01:50:32 (GMT)
committerBrad King <brad.king@kitware.com>2015-07-17 14:26:28 (GMT)
commit601ff0ec55517bc2a80e9a8cc2340f1c18b93490 (patch)
tree01bd5763d85ce64de94a3893539a205a58cb25a0 /Help
parent7a409983292e0917cf1299d55ca601a92fd4a36e (diff)
downloadCMake-601ff0ec55517bc2a80e9a8cc2340f1c18b93490.zip
CMake-601ff0ec55517bc2a80e9a8cc2340f1c18b93490.tar.gz
CMake-601ff0ec55517bc2a80e9a8cc2340f1c18b93490.tar.bz2
CTest: Optionally add a ChangeId attribute on XML Site tags
Add variable CTEST_CHANGE_ID to configure the setting. This allows CTest clients to give CDash information about what change is being tested so that CDash can take actions to report the results (e.g. to a pull request page).
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-variables.7.rst1
-rw-r--r--Help/variable/CTEST_CHANGE_ID.rst9
2 files changed, 10 insertions, 0 deletions
diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst
index f54436a..19d0c68 100644
--- a/Help/manual/cmake-variables.7.rst
+++ b/Help/manual/cmake-variables.7.rst
@@ -351,6 +351,7 @@ Variables for CTest
/variable/CTEST_BUILD_NAME
/variable/CTEST_BZR_COMMAND
/variable/CTEST_BZR_UPDATE_OPTIONS
+ /variable/CTEST_CHANGE_ID
/variable/CTEST_CHECKOUT_COMMAND
/variable/CTEST_CONFIGURATION_TYPE
/variable/CTEST_CONFIGURE_COMMAND
diff --git a/Help/variable/CTEST_CHANGE_ID.rst b/Help/variable/CTEST_CHANGE_ID.rst
new file mode 100644
index 0000000..a423f49
--- /dev/null
+++ b/Help/variable/CTEST_CHANGE_ID.rst
@@ -0,0 +1,9 @@
+CTEST_CHANGE_ID
+---------------
+
+Specify the CTest ``ChangeId`` setting
+in a :manual:`ctest(1)` dashboard client script.
+
+This setting allows CTest to pass arbitrary information about this
+build up to CDash. One use of this feature is to allow CDash to
+post comments on your pull request if anything goes wrong with your build.