diff mbox series

[1/2] man: Update man page to mention HTTPS_PROXY

Message ID 20220218153128.914071-1-void@manifault.com (mailing list archive)
State New, archived
Headers show
Series [1/2] man: Update man page to mention HTTPS_PROXY | expand

Commit Message

David Vernet Feb. 18, 2022, 3:31 p.m. UTC 
Certain b4 commands may send requests to https://lore.kernel.org, such
as to fetch a thread of patches as an mbox file. b4 internally uses the
python-requests library to perform these requests, and thus the requests
may be proxied by setting the HTTPS_PROXY environment variable.

The fact that b4 uses the python-requests library is an implementation
detail, so this diff adds a small 'PROXYING REQUESTS' section to the man
page that informs the user that they may use the HTTPS_PROXY environment
variable to enable proxying.

Link: https://lore.kernel.org/all/20220118174144.2445150-1-void@manifault.com/
Signed-off-by: David Vernet <void@manifault.com>
---
 man/b4.5.rst | 6 ++++++
 1 file changed, 6 insertions(+)
diff mbox series

Patch

diff --git a/man/b4.5.rst b/man/b4.5.rst
index 19e96af..ab12804 100644
--- a/man/b4.5.rst
+++ b/man/b4.5.rst
@@ -321,6 +321,12 @@  Default configuration, with explanations::
       # Used when preparing merge messages from cover letters. See shazam-merge-template.example
       shazam-merge-template = None
 
+PROXYING REQUESTS
+-----------------
+Commands making requests to lore may be configured to proxy those requests
+by setting the **HTTPS_PROXY** environment variable, as described in
+https://docs.python-requests.org/en/latest/user/advanced/#proxies.
+
 SUPPORT
 -------
 Please email tools@linux.kernel.org with support requests,