From 70bf7e4c8563576241e15fcea9380d491d7e5cd7 Mon Sep 17 00:00:00 2001 From: Konstantin Ryabitsev Date: Thu, 16 Jun 2022 13:31:32 -0400 Subject: Add a note about proxying requests Proxying requests is possible via the HTTPS_PROXY env variable, so make a note of that in the manpage. Suggested-by: David Vernet Link: https://lore.kernel.org/tools/20220218153128.914071-1-void@manifault.com Signed-off-by: Konstantin Ryabitsev --- man/b4.5 | 28 ++++++++++++++++++---------- man/b4.5.rst | 29 +++++++++++++++++++---------- 2 files changed, 37 insertions(+), 20 deletions(-) diff --git a/man/b4.5 b/man/b4.5 index 7d4a62e..150d193 100644 --- a/man/b4.5 +++ b/man/b4.5 @@ -27,12 +27,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "B4" 5 "2021-09-01" "0.9.0" "" +.TH "B4" 5 "2022-06-16" "0.9.0" "" .SH NAME B4 \- Work with code submissions in a public-inbox archive .SH SYNOPSIS .sp -b4 {mbox,am,shazam,attest,pr,ty,diff} [options] +b4 {mbox,am,shazam,pr,diff,ty,kr} [options] .SH DESCRIPTION .sp This is a helper utility to work with patches and pull requests made @@ -45,21 +45,21 @@ precursor to Lore and Data in the Star Trek universe. .SH SUBCOMMANDS .INDENT 0.0 .IP \(bu 2 -\fIb4 mbox\fP: Download a thread as an mbox file +\fImbox\fP: Download a thread as an mbox file .IP \(bu 2 -\fIb4 am\fP: Create an mbox file that is ready to git\-am +\fIam\fP: Create an mbox file that is ready to git\-am .IP \(bu 2 -\fIb4 shazam\fP: Similar to \fIam\fP, but lets you treat patch series similar to pull requests +\fIshazam\fP: Apply patch series to git repositories .IP \(bu 2 -\fIb4 pr\fP: Work with pull requests +\fIpr\fP: Work with pull requests .IP \(bu 2 -\fIb4 diff\fP: Show range\-diff style diffs between patch versions +\fIdiff\fP: Show range\-diff style diffs between patch versions .IP \(bu 2 -\fIb4 ty\fP: Create templated replies for processed patches and pull requests +\fIty\fP: Create templated replies for processed patches and pull requests .IP \(bu 2 -\fIb4 attest\fP: (EXPERIMENTAL) Add cryptographic attestation to patches +\fIkr\fP (EXPERIMENTAL) Operate on patatt\-compatible keyrings .IP \(bu 2 -\fIb4 kr\fP (EXPERIMENTAL) Operate on patatt\-compatible keyrings +\fIattest\fP: (DEPRECATED) Add cryptographic attestation to patches .UNINDENT .SH OPTIONS .INDENT 0.0 @@ -280,6 +280,9 @@ usage: b4 attest [\-h] patchfile [patchfile ...] \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 +\fBThis subcommand is deprecated and will be removed in a future +version of b4.\fP +.sp This functionality is now implemented via an auxiliary library called "patatt". You may instead install and use patatt directly with the same results. @@ -549,6 +552,11 @@ Default configuration, with explanations: .fi .UNINDENT .UNINDENT +.SH PROXYING REQUESTS +.sp +Commands making remote HTTP requests may be configured to use a proxy by +setting the \fBHTTPS_PROXY\fP environment variable, as described in +\fI\%https://docs.python\-requests.org/en/latest/user/advanced/#proxies\fP\&. .SH SUPPORT .sp Please email \fI\%tools@linux.kernel.org\fP with support requests, diff --git a/man/b4.5.rst b/man/b4.5.rst index 739e196..246d224 100644 --- a/man/b4.5.rst +++ b/man/b4.5.rst @@ -5,7 +5,7 @@ Work with code submissions in a public-inbox archive ---------------------------------------------------- :Author: mricon@kernel.org -:Date: 2021-09-01 +:Date: 2022-06-16 :Copyright: The Linux Foundation and contributors :License: GPLv2+ :Version: 0.9.0 @@ -13,7 +13,7 @@ Work with code submissions in a public-inbox archive SYNOPSIS -------- -b4 {mbox,am,shazam,attest,pr,ty,diff} [options] +b4 {mbox,am,shazam,pr,diff,ty,kr} [options] DESCRIPTION ----------- @@ -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 treat patch series similar to pull requests -* *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 +* *mbox*: Download a thread as an mbox file +* *am*: Create an mbox file that is ready to git-am +* *shazam*: Apply patch series to git repositories +* *pr*: Work with pull requests +* *diff*: Show range-diff style diffs between patch versions +* *ty*: Create templated replies for processed patches and pull requests +* *kr* (EXPERIMENTAL) Operate on patatt-compatible keyrings +* *attest*: (DEPRECATED) Add cryptographic attestation to patches OPTIONS ------- @@ -182,6 +182,9 @@ usage: b4 attest [-h] patchfile [patchfile ...] .. note:: + **This subcommand is deprecated and will be removed in a future + version of b4.** + This functionality is now implemented via an auxiliary library called "patatt". You may instead install and use patatt directly with the same results. @@ -373,6 +376,12 @@ Default configuration, with explanations:: # Separate multiple entries using comma (spaces are ignored), shell-style globbing accepted email-exclude = *@codeaurora.org, example@example.com +PROXYING REQUESTS +----------------- +Commands making remote HTTP requests may be configured to use a proxy 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, -- cgit v1.2.3