summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorZack Galbreath <zack.galbreath@kitware.com>2017-05-03 14:50:04 (GMT)
committerZack Galbreath <zack.galbreath@kitware.com>2017-05-04 16:21:21 (GMT)
commit1a7d00bd12f261428edb8fef09461bee8067ceee (patch)
tree7d998892f75ff11470ff6c884d4e168bdddd6c63 /Help
parent294cf948dc37799e1980685afbf1fa585ad5b0fb (diff)
downloadCMake-1a7d00bd12f261428edb8fef09461bee8067ceee.zip
CMake-1a7d00bd12f261428edb8fef09461bee8067ceee.tar.gz
CMake-1a7d00bd12f261428edb8fef09461bee8067ceee.tar.bz2
ctest_submit: Add HTTPHEADER option
Allow CTest script writers to specify additional HTTP headers to be sent to CDash during submission. The motivating case for this feature is a corresponding change in CDash. This will allow projects to refuse submissions from any site not bearing a valid authentication token.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/ctest_submit.rst10
-rw-r--r--Help/release/dev/ctest_submit_headers.rst5
2 files changed, 13 insertions, 2 deletions
diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst
index a7d9708..6b49da3 100644
--- a/Help/command/ctest_submit.rst
+++ b/Help/command/ctest_submit.rst
@@ -6,6 +6,7 @@ Perform the :ref:`CTest Submit Step` as a :ref:`Dashboard Client`.
::
ctest_submit([PARTS <part>...] [FILES <file>...]
+ [HTTPHEADER <header>]
[RETRY_COUNT <count>]
[RETRY_DELAY <delay>]
[RETURN_VALUE <result-var>]
@@ -36,6 +37,10 @@ The options are:
Specify an explicit list of specific files to be submitted.
Each individual file must exist at the time of the call.
+``HTTPHEADER <HTTP-header>``
+ Specify HTTP header to be included in the request to CDash during submission.
+ This suboption can be repeated several times.
+
``RETRY_COUNT <count>``
Specify how many times to retry a timed-out submission.
@@ -57,6 +62,7 @@ Submit to CDash Upload API
::
ctest_submit(CDASH_UPLOAD <file> [CDASH_UPLOAD_TYPE <type>]
+ [HTTPHEADER <header>]
[RETRY_COUNT <count>]
[RETRY_DELAY <delay>]
[QUIET])
@@ -67,5 +73,5 @@ 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 ``RETRY_COUNT``, ``RETRY_DELAY``, and ``QUIET``
-options as described above.
+This signature accepts the ``HTTPHEADER``, ``RETRY_COUNT``, ``RETRY_DELAY``, and
+``QUIET`` options as described above.
diff --git a/Help/release/dev/ctest_submit_headers.rst b/Help/release/dev/ctest_submit_headers.rst
new file mode 100644
index 0000000..61fbc7a
--- /dev/null
+++ b/Help/release/dev/ctest_submit_headers.rst
@@ -0,0 +1,5 @@
+ctest_submit_headers
+--------------------
+
+* The :command:`ctest_submit` command gained a ``HTTPHEADER`` option
+ to specify custom headers to send during submission.