aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorKonstantin Ryabitsev <konstantin@linuxfoundation.org>2021-09-30 10:41:06 -0400
committerKonstantin Ryabitsev <konstantin@linuxfoundation.org>2021-09-30 10:41:06 -0400
commita9cdedaad75ff982d733a38a0157787610f25651 (patch)
treedd00aede5c4c87b45f13119486faed2b9535639d /man
parent0f46d4c8bf35c7762e96271e7061d42e8dae79e4 (diff)
downloadb4-a9cdedaad75ff982d733a38a0157787610f25651.tar.gz
shazam: document template usage in manpage
The flags and functionality of shazam may still change, so not documenting the rest of the usage yet. Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Diffstat (limited to 'man')
-rw-r--r--man/b4.511
-rw-r--r--man/b4.5.rst12
2 files changed, 18 insertions, 5 deletions
diff --git a/man/b4.5 b/man/b4.5
index 5ff5185..ef2a917 100644
--- a/man/b4.5
+++ b/man/b4.5
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH B4 5 "2021-09-01" "0.8.0" ""
+.TH B4 5 "2021-09-01" "0.9.0" ""
.SH NAME
B4 \- Work with code submissions in a public-inbox archive
.
@@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
.SH SYNOPSIS
.sp
-b4 {mbox,am,attest,pr,ty,diff} [options]
+b4 {mbox,am,shazam,attest,pr,ty,diff} [options]
.SH DESCRIPTION
.sp
This is a helper utility to work with patches and pull requests made
@@ -49,6 +49,8 @@ precursor to Lore and Data in the Star Trek universe.
.IP \(bu 2
\fIb4 am\fP: Create an mbox file that is ready to git\-am
.IP \(bu 2
+\fIb4 shazam\fP: Similar to \fIam\fP, but lets you apply patches
+.IP \(bu 2
\fIb4 pr\fP: Work with pull requests
.IP \(bu 2
\fIb4 diff\fP: Show range\-diff style diffs between patch versions
@@ -194,6 +196,9 @@ Do not reroll partial series when detected
.UNINDENT
.sp
\fIExample\fP: b4 am \fI\%20200313231252.64999\-1\-keescook@chromium.org\fP
+.SH B4 SHAZAM
+.sp
+TBD.
.SS b4 attest
.sp
usage: b4 attest [\-h] patchfile [patchfile ...]
@@ -437,6 +442,8 @@ 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
+ # Used when preparing merge messages from cover letters. See shazam\-merge\-template.example
+ shazam\-merge\-template = None
.ft P
.fi
.UNINDENT
diff --git a/man/b4.5.rst b/man/b4.5.rst
index 6e060ec..7a507aa 100644
--- a/man/b4.5.rst
+++ b/man/b4.5.rst
@@ -8,12 +8,12 @@ Work with code submissions in a public-inbox archive
:Date: 2021-09-01
:Copyright: The Linux Foundation and contributors
:License: GPLv2+
-:Version: 0.8.0
+:Version: 0.9.0
:Manual section: 5
SYNOPSIS
--------
-b4 {mbox,am,attest,pr,ty,diff} [options]
+b4 {mbox,am,shazam,attest,pr,ty,diff} [options]
DESCRIPTION
-----------
@@ -29,6 +29,7 @@ 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
* *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
@@ -122,6 +123,10 @@ optional arguments:
*Example*: b4 am 20200313231252.64999-1-keescook@chromium.org
+b4 shazam
+---------
+TBD.
+
b4 attest
~~~~~~~~~
usage: b4 attest [-h] patchfile [patchfile ...]
@@ -298,7 +303,8 @@ 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
-
+ # Used when preparing merge messages from cover letters. See shazam-merge-template.example
+ shazam-merge-template = None
SUPPORT
-------