From 3a5ebbe9d91a44bd9a5107130e551b33bbf2d102 Mon Sep 17 00:00:00 2001 From: Konstantin Ryabitsev Date: Wed, 20 Oct 2021 10:45:44 -0400 Subject: 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 --- man/b4.5.rst | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) (limited to 'man/b4.5.rst') 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 ~~~~~~~ -- cgit v1.2.3