summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorscivision <scivision@users.noreply.github.com>2023-02-24 14:59:06 (GMT)
committerscivision <scivision@users.noreply.github.com>2023-02-24 17:32:41 (GMT)
commit9b56aabd99d7412777ef8182bae2298e922d22b5 (patch)
tree21515e61321462bf44c91416f224911bf8129b6c /Help
parent35ca2d524befc71b840808cce4e0a773ef722b71 (diff)
downloadCMake-9b56aabd99d7412777ef8182bae2298e922d22b5.zip
CMake-9b56aabd99d7412777ef8182bae2298e922d22b5.tar.gz
CMake-9b56aabd99d7412777ef8182bae2298e922d22b5.tar.bz2
Help:file: document HTTPHEADER more
Some servers have allow-lists for HTTP UserAgent for example. CMake project devs would benefit from this hint about setting authorization tokens and HTTP User Agent.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/file.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/Help/command/file.rst b/Help/command/file.rst
index df895d0..6ab7421 100644
--- a/Help/command/file.rst
+++ b/Help/command/file.rst
@@ -1077,7 +1077,14 @@ Options to both ``DOWNLOAD`` and ``UPLOAD`` are:
``HTTPHEADER <HTTP-header>``
.. versionadded:: 3.7
- HTTP header for operation. Suboption can be repeated several times.
+ HTTP header for ``DOWNLOAD`` and ``UPLOAD`` operations. ``HTTPHEADER`` can be
+ repeated for multiple options:
+
+ .. code-block:: cmake
+
+ file(DOWNLOAD <url>
+ HTTPHEADER "Authorization: Bearer <auth-token>"
+ HTTPHEADER "UserAgent: Mozilla/5.0")
``NETRC <level>``
.. versionadded:: 3.11