aboutsummaryrefslogtreecommitdiff
path: root/man/b4.5
diff options
context:
space:
mode:
Diffstat (limited to 'man/b4.5')
-rw-r--r--man/b4.5337
1 files changed, 239 insertions, 98 deletions
diff --git a/man/b4.5 b/man/b4.5
index de44247..bf50ed7 100644
--- a/man/b4.5
+++ b/man/b4.5
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH B4 5 "2020-11-20" "0.7.0" ""
-.SH NAME
-B4 \- Work with code submissions in a public-inbox archive
.
.nr rst2man-indent-level 0
.
@@ -30,9 +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 "2022-06-16" "0.9.0" ""
+.SH NAME
+B4 \- Work with code submissions in a public-inbox archive
.SH SYNOPSIS
.sp
-b4 {mbox,am,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,166 +45,283 @@ 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 pr\fP: Work with pull requests
+\fIshazam\fP: Apply patch series to git repositories
.IP \(bu 2
-\fIb4 diff\fP: Show range\-diff style diffs between patch versions
+\fIpr\fP: Work with pull requests
.IP \(bu 2
-\fIb4 ty\fP: Create templated replies for processed patches and pull requests
+\fIdiff\fP: Show range\-diff style diffs between patch versions
.IP \(bu 2
-\fIb4 attest\fP: (EXPERIMENTAL) Add cryptographic attestation to patches
+\fIty\fP: Create templated replies for processed patches and pull requests
.IP \(bu 2
-\fIb4 kr\fP (EXPERIMENTAL) Operate on patatt\-compatible keyrings
+\fIkr\fP (EXPERIMENTAL) Operate on patatt\-compatible keyrings
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
-.B \-h\fP,\fB \-\-help
+.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
-.B \-d\fP,\fB \-\-debug
+.B \-d\fP,\fB \-\-debug
Add more debugging info to the output (default: False)
.TP
-.B \-q\fP,\fB \-\-quiet
+.B \-q\fP,\fB \-\-quiet
Output critical information only (default: False)
+.TP
+.B \-n\fP,\fB \-\-no\-interactive
+Do not ask any interactive questions (default: False)
.UNINDENT
.SH SUBCOMMAND OPTIONS
.SS b4 mbox
+.sp
+This command allows retrieving entire threads from a remote public\-inbox
+instance. The resulting mbox file can then be opened with most MUA
+clients for actions like replying to conversations or reviewing patch
+submissions.
.INDENT 0.0
.TP
.B usage:
-b4 mbox [\-h] [\-o OUTDIR] [\-p USEPROJECT] [\-c] [\-n WANTNAME] [\-m LOCALMBOX] [msgid]
+b4 mbox [\-h] [\-p USEPROJECT] [\-m LOCALMBOX] [\-C] [\-o OUTDIR] [\-c] [\-n WANTNAME] [\-M] [\-f] [msgid]
.TP
.B positional arguments:
msgid Message ID to process, or pipe a raw message
.TP
-.B optional arguments:
+.B options:
.INDENT 7.0
.TP
-.B \-h\fP,\fB \-\-help
+.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
+.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
+Use a specific project instead of default (linux\-mm, linux\-hardening, etc)
+.TP
+.BI \-m \ LOCALMBOX\fR,\fB \ \-\-use\-local\-mbox \ LOCALMBOX
+Instead of grabbing a thread from lore, process this mbox file (or \- for stdin)
+.TP
+.B \-C\fP,\fB \-\-no\-cache
+Do not use local cache
+.TP
.BI \-o \ OUTDIR\fR,\fB \ \-\-outdir \ OUTDIR
Output into this directory (or use \- to output mailbox contents to stdout)
.TP
-.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
-Use a specific project instead of guessing (linux\-mm, linux\-hardening, etc)
-.TP
-.B \-c\fP,\fB \-\-check\-newer\-revisions
+.B \-c\fP,\fB \-\-check\-newer\-revisions
Check if newer patch revisions exist
.TP
.BI \-n \ WANTNAME\fR,\fB \ \-\-mbox\-name \ WANTNAME
-Filename to name the mbox file
-.TP
-.BI \-m \ LOCALMBOX\fR,\fB \ \-\-use\-local\-mbox \ LOCALMBOX
-Instead of grabbing a thread from lore, process this mbox file
-(or use \- for stdin)
+Filename to name the mbox destination
.TP
-.B \-C\fP,\fB \-\-no\-cache
-Do not use local cache
+.B \-M\fP,\fB \-\-save\-as\-maildir
+Save as maildir (avoids mbox format ambiguities)
.TP
-.B \-f\fP,\fB \-\-filter\-dupes
+.B \-f\fP,\fB \-\-filter\-dupes
When adding messages to existing maildir, filter out duplicates
-.TP
-.B \-M\fP,\fB \-\-save\-as\-maildir
-Save as maildir (avoids mbox format ambiguities)
.UNINDENT
.UNINDENT
.sp
\fIExample\fP: b4 mbox \fI\%20200313231252.64999\-1\-keescook@chromium.org\fP
.SS b4 am
+.sp
+This command allows retrieving threads from a public\-inbox instance and
+preparing them for applying to a git repository using the "git am"
+command. It will automatically perform the following operations:
+.INDENT 0.0
+.IP \(bu 2
+pick the latest submitted version of the series (it can check for
+newer threads using \fB\-c\fP as well)
+.IP \(bu 2
+check DKIM signatures and patatt attestation on all patches and code
+review messages
+.IP \(bu 2
+collate all submitted code\-review trailers (Reviewed\-by, Acked\-by,
+etc) and put them into the commit message
+.IP \(bu 2
+add your own Signed\-off\-by trailer (with \fB\-s\fP)
+.IP \(bu 2
+reroll series from partial updates (e.g. someone submits a v2 of a
+single patch instead of rerolling the entire series)
+.IP \(bu 2
+guess where in the tree history the patches belong, if the exact
+commit\-base is not specified (with \fB\-g\fP)
+.IP \(bu 2
+prepare the tree for a 3\-way merge (with \fB\-3\fP)
+.IP \(bu 2
+cherry\-pick a subset of patches from a large series (with \fB\-P\fP)
+.UNINDENT
.INDENT 0.0
.TP
.B usage:
-b4 am [\-h] [\-o OUTDIR] [\-p USEPROJECT] [\-c] [\-n WANTNAME] [\-m LOCALMBOX] [\-v WANTVER] [\-t] [\-T] [\-s] [\-l] [\-Q] [msgid]
+b4 am [\-h] [\-p USEPROJECT] [\-m LOCALMBOX] [\-C] [\-o OUTDIR] [\-c] [\-n WANTNAME] [\-M] [\-v WANTVER] [\-t] [\-S] [\-T] [\-s] [\-l] [\-P CHERRYPICK] [\-\-cc\-trailers] [\-\-no\-parent] [\-\-allow\-unicode\-control\-chars] [\-Q] [\-g] [\-b GUESSBRANCH [GUESSBRANCH ...]] [\-\-guess\-lookback GUESSDAYS] [\-3] [\-\-no\-cover] [\-\-no\-partial\-reroll] [msgid]
.TP
.B positional arguments:
msgid Message ID to process, or pipe a raw message
.TP
-.B optional arguments:
+.B options:
.INDENT 7.0
.TP
-.B \-h\fP,\fB \-\-help
+.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
+.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
+Use a specific project instead of default (linux\-mm, linux\-hardening, etc)
+.TP
+.BI \-m \ LOCALMBOX\fR,\fB \ \-\-use\-local\-mbox \ LOCALMBOX
+Instead of grabbing a thread from lore, process this mbox file (or \- for stdin)
+.TP
+.B \-C\fP,\fB \-\-no\-cache
+Do not use local cache
+.TP
.BI \-o \ OUTDIR\fR,\fB \ \-\-outdir \ OUTDIR
Output into this directory (or use \- to output mailbox contents to stdout)
.TP
-.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
-Use a specific project instead of guessing (linux\-mm, linux\-hardening, etc)
-.TP
-.B \-c\fP,\fB \-\-check\-newer\-revisions
+.B \-c\fP,\fB \-\-check\-newer\-revisions
Check if newer patch revisions exist
.TP
.BI \-n \ WANTNAME\fR,\fB \ \-\-mbox\-name \ WANTNAME
-Filename to name the mbox file
-.TP
-.BI \-m \ LOCALMBOX\fR,\fB \ \-\-use\-local\-mbox \ LOCALMBOX
-Instead of grabbing a thread from lore, process this mbox file
-(or use \- for stdin)
+Filename to name the mbox destination
.TP
-.B \-M\fP,\fB \-\-save\-as\-maildir
+.B \-M\fP,\fB \-\-save\-as\-maildir
Save as maildir (avoids mbox format ambiguities)
.TP
-.B \-C\fP,\fB \-\-no\-cache
-Do not use local cache
-.TP
.BI \-v \ WANTVER\fR,\fB \ \-\-use\-version \ WANTVER
Get a specific version of the patch/series
.TP
-.B \-t\fP,\fB \-\-apply\-cover\-trailers
+.B \-t\fP,\fB \-\-apply\-cover\-trailers
Apply trailers sent to the cover letter to all patches
.TP
-.B \-S\fP,\fB \-\-sloppy\-trailers
+.B \-S\fP,\fB \-\-sloppy\-trailers
Apply trailers without email address match checking
.TP
-.B \-T\fP,\fB \-\-no\-add\-trailers
+.B \-T\fP,\fB \-\-no\-add\-trailers
Do not add or sort any trailers
.TP
-.B \-s\fP,\fB \-\-add\-my\-sob
+.B \-s\fP,\fB \-\-add\-my\-sob
Add your own signed\-off\-by to every patch
.TP
-.B \-l\fP,\fB \-\-add\-link
-Add a lore.kernel.org/r/ link to every patch
-.TP
-.B \-Q\fP,\fB \-\-quilt\-ready
-Save patches in a quilt\-ready folder
+.B \-l\fP,\fB \-\-add\-link
+Add a Link: with message\-id lookup URL to every patch
.TP
.BI \-P \ CHERRYPICK\fR,\fB \ \-\-cherry\-pick \ CHERRYPICK
-Cherry\-pick a subset of patches (e.g. "\-P 1\-2,4,6\-", "\-P _" to use just the msgid specified, or "\-P *globbing*" to match on commit subject)
+Cherry\-pick a subset of patches (e.g. "\-P 1\-2,4,6\-", "\-P _" to use just the msgid specified, or "\-P \fIglobbing\fP" to match on commit subject)
.TP
-.B \-g\fP,\fB \-\-guess\-base
+.B \-\-cc\-trailers
+Copy all Cc\(aqd addresses into Cc: trailers
+.TP
+.B \-\-no\-parent
+Break thread at the msgid specified and ignore any parent messages
+.TP
+.B \-\-allow\-unicode\-control\-chars
+Allow unicode control characters (very rarely legitimate)
+.TP
+.B \-Q\fP,\fB \-\-quilt\-ready
+Save patches in a quilt\-ready folder
+.TP
+.B \-g\fP,\fB \-\-guess\-base
Try to guess the base of the series (if not specified)
+.UNINDENT
+.INDENT 7.0
.TP
-.B \-3\fP,\fB \-\-prep\-3way
-Prepare for a 3\-way merge (tries to ensure that all index blobs exist by making a fake commit range)
+.B \-b GUESSBRANCH [GUESSBRANCH ...], \-\-guess\-branch GUESSBRANCH [GUESSBRANCH ...]
+When guessing base, restrict to this branch (use with \-g)
+.UNINDENT
+.INDENT 7.0
+.TP
+.BI \-\-guess\-lookback \ GUESSDAYS
+When guessing base, go back this many days from the patch date (default: 2 weeks)
.TP
-.B \-\-cc\-trailers
-Copy all Cc\(aqd addresses into Cc: trailers, if not already present
+.B \-3\fP,\fB \-\-prep\-3way
+Prepare for a 3\-way merge (tries to ensure that all index blobs exist by making a fake commit range)
.TP
-.B \-\-no\-cover
+.B \-\-no\-cover
Do not save the cover letter (on by default when using \-o \-)
.TP
-.B \-\-no\-partial\-reroll
+.B \-\-no\-partial\-reroll
Do not reroll partial series when detected
.UNINDENT
.UNINDENT
.sp
\fIExample\fP: b4 am \fI\%20200313231252.64999\-1\-keescook@chromium.org\fP
-.SS b4 attest
+.SS b4 shazam
+.sp
+This is very similar to \fBb4 am\fP, but will also apply patches
+directly to the current git tree using \fBgit am\fP\&. Alternatively, when
+used with \fB\-H\fP, it can fetch the patch series into \fBFETCH_HEAD\fP as
+if it were a pull request, so it can be reviewed and merged. In this
+case, the cover letter is used as a template for the merge commit.
.sp
-usage: b4 attest [\-h] patchfile [patchfile ...]
+If you want to automatically invoke git\-merge, you can use \fB\-M\fP
+instead of \fB\-H\fP\&.
.INDENT 0.0
.TP
+.B usage:
+b4 shazam [\-h] [\-p USEPROJECT] [\-m LOCALMBOX] [\-C] [\-v WANTVER] [\-t] [\-S] [\-T] [\-s] [\-l] [\-P CHERRYPICK] [\-\-cc\-trailers] [\-\-no\-parent] [\-\-allow\-unicode\-control\-chars] [\-H | \-M] [\-\-guess\-lookback GUESSDAYS] [msgid]
+.TP
.B positional arguments:
-patchfile Patches to attest
+msgid Message ID to process, or pipe a raw message
+.TP
+.B options:
+.INDENT 7.0
+.TP
+.B \-h\fP,\fB \-\-help
+show this help message and exit
+.TP
+.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
+Use a specific project instead of default (linux\-mm, linux\-hardening, etc)
+.TP
+.BI \-m \ LOCALMBOX\fR,\fB \ \-\-use\-local\-mbox \ LOCALMBOX
+Instead of grabbing a thread from lore, process this mbox file (or \- for stdin)
+.TP
+.B \-C\fP,\fB \-\-no\-cache
+Do not use local cache
+.TP
+.BI \-v \ WANTVER\fR,\fB \ \-\-use\-version \ WANTVER
+Get a specific version of the patch/series
+.TP
+.B \-t\fP,\fB \-\-apply\-cover\-trailers
+Apply trailers sent to the cover letter to all patches
+.TP
+.B \-S\fP,\fB \-\-sloppy\-trailers
+Apply trailers without email address match checking
+.TP
+.B \-T\fP,\fB \-\-no\-add\-trailers
+Do not add or sort any trailers
+.TP
+.B \-s\fP,\fB \-\-add\-my\-sob
+Add your own signed\-off\-by to every patch
+.TP
+.B \-l\fP,\fB \-\-add\-link
+Add a Link: with message\-id lookup URL to every patch
+.TP
+.BI \-P \ CHERRYPICK\fR,\fB \ \-\-cherry\-pick \ CHERRYPICK
+Cherry\-pick a subset of patches (e.g. "\-P 1\-2,4,6\-", "\-P _" to use just the msgid specified, or "\-P \fIglobbing\fP" to match on commit subject)
+.TP
+.B \-\-cc\-trailers
+Copy all Cc\(aqd addresses into Cc: trailers
+.TP
+.B \-\-no\-parent
+Break thread at the msgid specified and ignore any parent messages
+.TP
+.B \-\-allow\-unicode\-control\-chars
+Allow unicode control characters (very rarely legitimate)
+.TP
+.B \-H\fP,\fB \-\-make\-fetch\-head
+Attempt to treat series as a pull request and fetch it into FETCH_HEAD
+.TP
+.B \-M\fP,\fB \-\-merge
+Attempt to merge series as if it were a pull request (execs git\-merge)
+.TP
+.BI \-\-guess\-lookback \ GUESSDAYS
+(use with \-H or \-M) When guessing base, go back this many days from the patch date (default: 3 weeks)
+.UNINDENT
.UNINDENT
.sp
-\fIExample\fP: b4 attest outgoing/*.patch
+\fIExample\fP: b4 shazam \-H \fI\%20200313231252.64999\-1\-keescook@chromium.org\fP
.SS b4 pr
+.sp
+This command is for working with pull requests submitted using
+\fBgit\-request\-pull\fP\&.
.INDENT 0.0
.TP
.B usage:
@@ -216,7 +333,7 @@ msgid Message ID to process, or pipe a raw message
.B optional arguments:
.INDENT 7.0
.TP
-.B \-h\fP,\fB \-\-help
+.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.BI \-g \ GITDIR\fR,\fB \ \-\-gitdir \ GITDIR
@@ -225,16 +342,16 @@ Operate on this git tree instead of current dir
.BI \-b \ BRANCH\fR,\fB \ \-\-branch \ BRANCH
Check out FETCH_HEAD into this branch after fetching
.TP
-.B \-c\fP,\fB \-\-check
+.B \-c\fP,\fB \-\-check
Check if pull request has already been applied
.TP
-.B \-e\fP,\fB \-\-explode
+.B \-e\fP,\fB \-\-explode
Convert a pull request into an mbox full of patches
.TP
.BI \-o \ OUTMBOX\fR,\fB \ \-\-output\-mbox \ OUTMBOX
Save exploded messages into this mailbox (default: msgid.mbx)
.TP
-.B \-l\fP,\fB \-\-retrieve\-links
+.B \-l\fP,\fB \-\-retrieve\-links
Attempt to retrieve any Link: URLs (use with \-e)
.TP
.BI \-f \ MAILFROM\fR,\fB \ \-\-from\-addr \ MAILFROM
@@ -247,12 +364,12 @@ Use this From: in exploded messages (use with \-e)
.INDENT 0.0
.TP
.B usage:
-b4 ty [\-h] [\-g GITDIR] [\-o OUTDIR] [\-l] [\-s SEND [SEND ...]] [\-d DISCARD [DISCARD ...]] [\-a] [\-b BRANCH] [\-\-since SINCE]
+b4 ty [\-h] [\-g GITDIR] [\-o OUTDIR] [\-l] [\-t THANK_FOR [THANK_FOR ...]] [\-d DISCARD [DISCARD ...]] [\-a] [\-b BRANCH] [\-\-since SINCE] [\-S] [\-\-dry\-run]
.TP
.B optional arguments:
.INDENT 7.0
.TP
-.B \-h\fP,\fB \-\-help
+.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.BI \-g \ GITDIR\fR,\fB \ \-\-gitdir \ GITDIR
@@ -261,32 +378,48 @@ Operate on this git tree instead of current dir
.BI \-o \ OUTDIR\fR,\fB \ \-\-outdir \ OUTDIR
Write thanks files into this dir (default=.)
.TP
-.B \-l\fP,\fB \-\-list
+.B \-l\fP,\fB \-\-list
List pull requests and patch series you have retrieved
.TP
-.BI \-s \ SEND\fR,\fB \ \-\-send \ SEND
+.BI \-t \ THANK_FOR\fR,\fB \ \-\-thank\-for \ THANK_FOR
Generate thankyous for specific entries from \-l (e.g.: 1,3\-5,7\-; or "all")
.TP
.BI \-d \ DISCARD\fR,\fB \ \-\-discard \ DISCARD
Discard specific messages from \-l (e.g.: 1,3\-5,7\-; or "all")
.TP
-.B \-a\fP,\fB \-\-auto
-Use the Auto\-Thankanator to figure out what got applied/merged
+.B \-a\fP,\fB \-\-auto
+Use the Auto\-Thankanator gun to figure out what got applied/merged
.TP
.BI \-b \ BRANCH\fR,\fB \ \-\-branch \ BRANCH
The branch to check against, instead of current
.TP
.BI \-\-since \ SINCE
The \-\-since option to use when auto\-matching patches (default=1.week)
+.TP
+.B \-S\fP,\fB \-\-send\-email
+Send email instead of writing out .thanks files
+.TP
+.B \-\-dry\-run
+Print out emails instead of sending them
.UNINDENT
.UNINDENT
.sp
-\fIExample\fP: b4 ty \-\-auto
-.SS b4 diff
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+To send mails directly using \-S, you should have a configured
+[sendemail] section somewhere in your applicable git configuration
+files (global or in\-tree).
+.UNINDENT
+.UNINDENT
.sp
-usage: b4 diff [\-h] [\-g GITDIR] [\-p USEPROJECT] [\-C] [\-v WANTVERS [WANTVERS ...]] [\-n] [\-o OUTDIFF] [\-c] [\-m AMBOX AMBOX] [msgid]
+\fIExample\fP: b4 ty \-aS \-\-dry\-run
+.SS b4 diff
.INDENT 0.0
.TP
+.B usage:
+b4 diff [\-h] [\-g GITDIR] [\-p USEPROJECT] [\-C] [\-v WANTVERS [WANTVERS ...]] [\-n] [\-o OUTDIFF] [\-c] [\-m AMBOX AMBOX] [msgid]
+.TP
.B positional arguments:
msgid Message ID to process, pipe a raw message, or use \-m
.UNINDENT
@@ -296,7 +429,7 @@ optional arguments:
.INDENT 3.5
.INDENT 0.0
.TP
-.B \-h\fP,\fB \-\-help
+.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.BI \-g \ GITDIR\fR,\fB \ \-\-gitdir \ GITDIR
@@ -305,7 +438,7 @@ Operate on this git tree instead of current dir
.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
Use a specific project instead of guessing (linux\-mm, linux\-hardening, etc)
.TP
-.B \-C\fP,\fB \-\-no\-cache
+.B \-C\fP,\fB \-\-no\-cache
Do not use local cache
.UNINDENT
.INDENT 0.0
@@ -315,13 +448,13 @@ Compare specific versions instead of latest and one before that, e.g. \-v 3 5
.UNINDENT
.INDENT 0.0
.TP
-.B \-n\fP,\fB \-\-no\-diff
+.B \-n\fP,\fB \-\-no\-diff
Do not generate a diff, just show the command to do it
.TP
.BI \-o \ OUTDIFF\fR,\fB \ \-\-output\-diff \ OUTDIFF
Save diff into this file instead of outputting to stdout
.TP
-.B \-c\fP,\fB \-\-color
+.B \-c\fP,\fB \-\-color
Force color output even when writing to file
.UNINDENT
.INDENT 0.0
@@ -334,17 +467,18 @@ Compare two mbx files prepared with "b4 am"
.sp
\fIExample\fP: b4 diff \fI\%20200526205322.23465\-1\-mic@digikod.net\fP
.SS b4 kr
-.sp
-usage: b4 kr [\-h] [\-p USEPROJECT] [\-m LOCALMBOX] [\-C] [\-\-show\-keys] [msgid]
.INDENT 0.0
.TP
+.B usage:
+b4 kr [\-h] [\-p USEPROJECT] [\-m LOCALMBOX] [\-C] [\-\-show\-keys] [msgid]
+.TP
.B positional arguments:
msgid Message ID to process, or pipe a raw message
.TP
.B optional arguments:
.INDENT 7.0
.TP
-.B \-h\fP,\fB \-\-help
+.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
@@ -353,10 +487,10 @@ Use a specific project instead of guessing (linux\-mm, linux\-hardening, etc)
.BI \-m \ LOCALMBOX\fR,\fB \ \-\-use\-local\-mbox \ LOCALMBOX
Instead of grabbing a thread from lore, process this mbox file (or \- for stdin)
.TP
-.B \-C\fP,\fB \-\-no\-cache
+.B \-C\fP,\fB \-\-no\-cache
Do not use local cache
.TP
-.B \-\-show\-keys
+.B \-\-show\-keys
Show all developer keys from the thread
.UNINDENT
.UNINDENT
@@ -393,13 +527,6 @@ Default configuration, with explanations:
# public\-inbox, python, and git
save\-maildirs = no
#
- # When processing thread trailers, sort them in this order.
- # Can use shell\-globbing and must end with ,*
- # Some sorting orders:
- #trailer\-order=link*,fixes*,cc*,reported*,suggested*,original*,co\-*,tested*,reviewed*,acked*,signed\-off*,*
- #trailer\-order = fixes*,reported*,suggested*,original*,co\-*,signed\-off*,tested*,reviewed*,acked*,cc*,link*,*
- trailer\-order = _preserve_
- #
# Attestation\-checking configuration parameters
# off: do not bother checking attestation
# check: print an attaboy when attestation is found
@@ -437,10 +564,24 @@ Default configuration, with explanations:
thanks\-pr\-template = None
# See thanks\-am\-template.example. If not set, a default template will be used.
thanks\-am\-template = None
+ # additional flags to pass to "git am" when we run "b4 shazam"
+ shazam\-am\-flags = None
+ # additional flags to pass to "git merge" when we run "b4 shazam \-M"
+ shazam\-merge\-flags = \-\-signoff
+ # Used when preparing merge messages from cover letters. See shazam\-merge\-template.example
+ shazam\-merge\-template = None
+ # Use to exclude certain mail addresses from ever being added to auto\-generated mail
+ # Separate multiple entries using comma (spaces are ignored), shell\-style globbing accepted
+ email\-exclude = *@codeaurora.org, example@example.com
.ft P
.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,