summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKonstantin Ryabitsev <konstantin@linuxfoundation.org>2021-10-20 10:45:44 -0400
committerKonstantin Ryabitsev <konstantin@linuxfoundation.org>2021-10-20 10:45:44 -0400
commit3a5ebbe9d91a44bd9a5107130e551b33bbf2d102 (patch)
tree51b67e2236ca3e104b376de70a5a6f035cc1b6f4
parent7c1d044ff1d5235e598d4c777c4abfe60e0a09a8 (diff)
downloadb4-3a5ebbe9d91a44bd9a5107130e551b33bbf2d102.tar.gz
ty: document flag changes
We've replaced "b4 ty -s" with "b4 ty -t" to better disambiguate it from "b4 -S" which does the actual mail sending. This commit documents this change, plus adds -S,--send-email and --dry-run flags. Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
-rw-r--r--man/b4.534
-rw-r--r--man/b4.5.rst25
2 files changed, 49 insertions, 10 deletions
diff --git a/man/b4.5 b/man/b4.5
index ef2a917..6da1b35 100644
--- a/man/b4.5
+++ b/man/b4.5
@@ -49,7 +49,7 @@ 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
+\fIb4 shazam\fP: Similar to \fIam\fP, but lets you apply patches directly
.IP \(bu 2
\fIb4 pr\fP: Work with pull requests
.IP \(bu 2
@@ -202,6 +202,15 @@ TBD.
.SS b4 attest
.sp
usage: b4 attest [\-h] patchfile [patchfile ...]
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+This functionality is now implemented via an auxiliary library called
+"patatt". You may instead install and use patatt directly with the
+same results.
+.UNINDENT
+.UNINDENT
.INDENT 0.0
.TP
.B positional arguments:
@@ -252,7 +261,7 @@ 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
@@ -269,24 +278,39 @@ Write thanks files into this dir (default=.)
.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
+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
+\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
-\fIExample\fP: b4 ty \-\-auto
+\fIExample\fP: b4 ty \-aS \-\-dry\-run
.SS b4 diff
.sp
usage: b4 diff [\-h] [\-g GITDIR] [\-p USEPROJECT] [\-C] [\-v WANTVERS [WANTVERS ...]] [\-n] [\-o OUTDIFF] [\-c] [\-m AMBOX AMBOX] [msgid]
diff --git a/man/b4.5.rst b/man/b4.5.rst
index 7a507aa..19e96af 100644
--- a/man/b4.5.rst
+++ b/man/b4.5.rst
@@ -29,7 +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 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
@@ -131,6 +131,12 @@ b4 attest
~~~~~~~~~
usage: b4 attest [-h] patchfile [patchfile ...]
+.. note::
+
+ This functionality is now implemented via an auxiliary library called
+ "patatt". You may instead install and use patatt directly with the
+ same results.
+
positional arguments:
patchfile Patches to attest
@@ -163,7 +169,7 @@ optional arguments:
b4 ty
~~~~~
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]
optional arguments:
-h, --help show this help message and exit
@@ -172,15 +178,24 @@ optional arguments:
-o OUTDIR, --outdir OUTDIR
Write thanks files into this dir (default=.)
-l, --list List pull requests and patch series you have retrieved
- -s SEND, --send SEND Generate thankyous for specific entries from -l (e.g.: 1,3-5,7-; or "all")
+ -t THANK_FOR, --thank-for THANK_FOR
+ Generate thankyous for specific entries from -l (e.g.: 1,3-5,7-; or "all")
-d DISCARD, --discard DISCARD
Discard specific messages from -l (e.g.: 1,3-5,7-; or "all")
- -a, --auto Use the Auto-Thankanator to figure out what got applied/merged
+ -a, --auto Use the Auto-Thankanator gun to figure out what got applied/merged
-b BRANCH, --branch BRANCH
The branch to check against, instead of current
--since SINCE The --since option to use when auto-matching patches (default=1.week)
+ -S, --send-email Send email instead of writing out .thanks files
+ --dry-run Print out emails instead of sending them
+
+.. note::
+
+ To send mails directly using -S, you should have a configured
+ [sendemail] section somewhere in your applicable git configuration
+ files (global or in-tree).
-*Example*: b4 ty --auto
+*Example*: b4 ty -aS --dry-run
b4 diff
~~~~~~~