man: Update man page to mention HTTPS_PROXY
PATCH 1/2 man: Update man page to mention HTTPS_PROXY
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.
--- man/b4.5.rst | 6 ++++++ 1 file changed, 6 insertions(+)
man/b4.5.rst +6 -0
@@ -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 [email protected] with support requests,
Signature · 1 line
2.30.2
PATCH 1/2 man: Update man page to mention HTTPS_PROXY
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.
--- man/b4.5.rst | 6 ++++++ 1 file changed, 6 insertions(+)
man/b4.5.rst +6 -0
@@ -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 [email protected] with support requests,
Signature · 1 line
2.30.2
PATCH 2/2 man: Update man page to use bold where appropriate
According to https://man7.org/linux/man-pages/man1/man.1.html, when writing a man page for a program, anything that should be typed exactly as shown should use bolded text. The b4 man page has a SUBCOMMANDS section where subcommands are listed as 'b4 <subcommand>', in italics. So as to match the guidance for man pages (as well as to match the examples provided at the link above), this diff updates the 'b4' portion of the aforementioned subcommand section to be bolded.
--- man/b4.5.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
man/b4.5.rst +8 -8
@@ -27,14 +27,14 @@ precursor to Lore and Data in the Star Trek universe. SUBCOMMANDS ----------- -* *b4 mbox*: Download a thread as an mbox file -* *b4 am*: Create an mbox file that is ready to git-am -* *b4 shazam*: Similar to *am*, but lets you apply patches directly -* *b4 pr*: Work with pull requests -* *b4 diff*: Show range-diff style diffs between patch versions -* *b4 ty*: Create templated replies for processed patches and pull requests -* *b4 attest*: (EXPERIMENTAL) Add cryptographic attestation to patches -* *b4 kr* (EXPERIMENTAL) Operate on patatt-compatible keyrings +* **b4** *mbox*: Download a thread as an mbox file +* **b4** *am*: Create an mbox file that is ready to git-am +* **b4** *shazam*: Similar to *am*, but lets you apply patches directly +* **b4** *pr*: Work with pull requests +* **b4** *diff*: Show range-diff style diffs between patch versions +* **b4** *ty*: Create templated replies for processed patches and pull requests +* **b4** *attest*: (EXPERIMENTAL) Add cryptographic attestation to patches +* **b4** *kr* (EXPERIMENTAL) Operate on patatt-compatible keyrings OPTIONS -------
Signature · 1 line
2.30.2
PATCH 2/2 man: Update man page to use bold where appropriate
In reply to David VernetAccording to https://man7.org/linux/man-pages/man1/man.1.html, when writing a man page for a program, anything that should be typed exactly as shown should use bolded text. The b4 man page has a SUBCOMMANDS section where subcommands are listed as 'b4 <subcommand>', in italics. So as to match the guidance for man pages (as well as to match the examples provided at the link above), this diff updates the 'b4' portion of the aforementioned subcommand section to be bolded.
--- man/b4.5.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
man/b4.5.rst +8 -8
@@ -27,14 +27,14 @@ precursor to Lore and Data in the Star Trek universe. SUBCOMMANDS ----------- -* *b4 mbox*: Download a thread as an mbox file -* *b4 am*: Create an mbox file that is ready to git-am -* *b4 shazam*: Similar to *am*, but lets you apply patches directly -* *b4 pr*: Work with pull requests -* *b4 diff*: Show range-diff style diffs between patch versions -* *b4 ty*: Create templated replies for processed patches and pull requests -* *b4 attest*: (EXPERIMENTAL) Add cryptographic attestation to patches -* *b4 kr* (EXPERIMENTAL) Operate on patatt-compatible keyrings +* **b4** *mbox*: Download a thread as an mbox file +* **b4** *am*: Create an mbox file that is ready to git-am +* **b4** *shazam*: Similar to *am*, but lets you apply patches directly +* **b4** *pr*: Work with pull requests +* **b4** *diff*: Show range-diff style diffs between patch versions +* **b4** *ty*: Create templated replies for processed patches and pull requests +* **b4** *attest*: (EXPERIMENTAL) Add cryptographic attestation to patches +* **b4** *kr* (EXPERIMENTAL) Operate on patatt-compatible keyrings OPTIONS -------
Signature · 1 line
2.30.2