summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorZack Galbreath <zack.galbreath@kitware.com>2019-03-19 15:09:19 (GMT)
committerZack Galbreath <zack.galbreath@kitware.com>2019-03-22 13:37:08 (GMT)
commitba7e44eb7a319d15c7ac18bdf6d15487311a85a2 (patch)
tree00163a98115c833700f55973cc6755e350076df5 /Help
parent89abbdd8c8db5bf587373f2a00f6a816eddd8496 (diff)
downloadCMake-ba7e44eb7a319d15c7ac18bdf6d15487311a85a2.zip
CMake-ba7e44eb7a319d15c7ac18bdf6d15487311a85a2.tar.gz
CMake-ba7e44eb7a319d15c7ac18bdf6d15487311a85a2.tar.bz2
ctest_submit: Add option BUILD_ID
Fixes: #18968
Diffstat (limited to 'Help')
-rw-r--r--Help/command/ctest_submit.rst10
-rw-r--r--Help/release/dev/ctest_submit_get_buildid.rst6
2 files changed, 14 insertions, 2 deletions
diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst
index ac9eac1..983fc20 100644
--- a/Help/command/ctest_submit.rst
+++ b/Help/command/ctest_submit.rst
@@ -7,6 +7,7 @@ Perform the :ref:`CTest Submit Step` as a :ref:`Dashboard Client`.
ctest_submit([PARTS <part>...] [FILES <file>...]
[SUBMIT_URL <url>]
+ [BUILD_ID <result-var>]
[HTTPHEADER <header>]
[RETRY_COUNT <count>]
[RETRY_DELAY <delay>]
@@ -44,6 +45,10 @@ The options are:
The ``http`` or ``https`` URL of the dashboard server to send the submission
to. If not given, the :variable:`CTEST_SUBMIT_URL` variable is used.
+``BUILD_ID <result-var>``
+ Store in the ``<result-var>`` variable the ID assigned to this build by
+ CDash.
+
``HTTPHEADER <HTTP-header>``
Specify HTTP header to be included in the request to CDash during submission.
For example, CDash can be configured to only accept submissions from
@@ -94,5 +99,6 @@ with a content hash of the file. If CDash does not already have the file,
then it is uploaded. Along with the file, a CDash type string is specified
to tell CDash which handler to use to process the data.
-This signature accepts the ``SUBMIT_URL``, ``HTTPHEADER``, ``RETRY_COUNT``,
-``RETRY_DELAY``, ``RETURN_VALUE`` and ``QUIET`` options as described above.
+This signature accepts the ``SUBMIT_URL``, ``BUILD_ID``, ``HTTPHEADER``,
+``RETRY_COUNT``, ``RETRY_DELAY``, ``RETURN_VALUE`` and ``QUIET`` options
+as described above.
diff --git a/Help/release/dev/ctest_submit_get_buildid.rst b/Help/release/dev/ctest_submit_get_buildid.rst
new file mode 100644
index 0000000..39a0010
--- /dev/null
+++ b/Help/release/dev/ctest_submit_get_buildid.rst
@@ -0,0 +1,6 @@
+ctest_submit_get_buildid
+--------------------------
+
+* The :command:`ctest_submit` command learned a new option: ``BUILD_ID``.
+ This can be used to store the ID assigned to this build by CDash to a
+ variable.