summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZack Galbreath <zack.galbreath@kitware.com>2019-03-07 14:44:45 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2019-03-07 15:08:34 (GMT)
commit46c5830394fc38c6c23cb5ba58efec69b90b33f5 (patch)
tree272e699cfef9ebe6a0ab6daae6c64db131c3c4d3
parent3a5ccabd15ac535d73cd8d129974dea9d670b58a (diff)
downloadCMake-46c5830394fc38c6c23cb5ba58efec69b90b33f5.zip
CMake-46c5830394fc38c6c23cb5ba58efec69b90b33f5.tar.gz
CMake-46c5830394fc38c6c23cb5ba58efec69b90b33f5.tar.bz2
Help: provide example for HTTPHEADER option to ctest_submit
-rw-r--r--Help/command/ctest_submit.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst
index fba03fd..ca9d058 100644
--- a/Help/command/ctest_submit.rst
+++ b/Help/command/ctest_submit.rst
@@ -46,7 +46,15 @@ The options are:
``HTTPHEADER <HTTP-header>``
Specify HTTP header to be included in the request to CDash during submission.
- This suboption can be repeated several times.
+ For example, CDash can be configured to only accept submissions from
+ authenticated clients. In this case, you should provide a bearer token in your
+ header:
+
+ ::
+
+ ctest_submit(HTTPHEADER "Authorization: Bearer <auth-token>")
+
+ This suboption can be repeated several times for multiple headers.
``RETRY_COUNT <count>``
Specify how many times to retry a timed-out submission.