summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2019-03-07 15:52:07 +0000
committerKitware Robot <kwrobot@kitware.com>2019-03-07 10:52:15 -0500
commite58e38f2fbd31fd1527c19c2a33151a6c23ff22f (patch)
treea601e5eb7f23448a45e2eec98b384d38456a68fb
parent2992ba2d02c1cdfe1ea181e3d560087126c700a1 (diff)
parent46c5830394fc38c6c23cb5ba58efec69b90b33f5 (diff)
downloadcmake-e58e38f2fbd31fd1527c19c2a33151a6c23ff22f.tar.gz
Merge topic 'more_header_docs'
46c5830394 Help: provide example for HTTPHEADER option to ctest_submit Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3072
-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 fba03fd586..ca9d058fb8 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.