Document save-maildirs and -M options

Update the manpage to record the new flags.

Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>

2 files changed, 37 insertions, 32 deletions

diff --git a/man/b4.5 b/man/b4.5
index fabacc0..0edae24 100644
--- a/man/b4.5
+++ b/man/b4.5
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH B4 5 "2020-11-20" "0.6.0" ""
+.TH B4 5 "2020-11-20" "0.7.0" ""
 .SH NAME
 B4 \- Work with code submissions in a public-inbox archive
 .
@@ -99,12 +99,16 @@ 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)
 .TP
 .B \-C\fP,\fB  \-\-no\-cache
 Do not use local cache
 .TP
 .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
@@ -138,6 +142,10 @@ 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)
+.TP
+.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
@@ -161,7 +169,7 @@ Add your own signed\-off\-by to every patch
 Add a lore.kernel.org/r/ link to every patch
 .TP
 .B \-Q\fP,\fB  \-\-quilt\-ready
-Save mbox patches in a quilt\-ready folder
+Save patches in a quilt\-ready folder
 .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)
@@ -177,36 +185,23 @@ Copy all Cc\(aqd addresses into Cc: trailers, if not already present
 .TP
 .B \-\-no\-cover
 Do not save the cover letter (on by default when using \-o \-)
+.TP
+.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
 .sp
-usage: b4 attest [\-h] [\-f SENDER] [\-n] [\-o OUTPUT] patchfile [patchfile ...]
+usage: b4 attest [\-h] patchfile [patchfile ...]
 .INDENT 0.0
 .TP
 .B positional arguments:
 patchfile             Patches to attest
-.TP
-.B optional arguments:
-.INDENT 7.0
-.TP
-.B \-h\fP,\fB  \-\-help
-show this help message and exit
-.TP
-.BI \-f \ SENDER\fR,\fB \ \-\-from \ SENDER
-OBSOLETE: this option does nothing and will be removed
-.TP
-.B \-n\fP,\fB  \-\-no\-submit
-OBSOLETE: this option does nothing and will be removed
-.TP
-.BI \-o \ OUTPUT\fR,\fB \ \-\-output \ OUTPUT
-OBSOLETE: this option does nothing and will be removed
-.UNINDENT
 .UNINDENT
 .sp
-\fIExample\fP: b4 attest output/*.patch
+\fIExample\fP: b4 attest outgoing/*.patch
 .SS b4 pr
 .INDENT 0.0
 .TP
@@ -349,6 +344,11 @@ Default configuration, with explanations:
    # When recording Link: trailers, use this mask
    linkmask = https://lore.kernel.org/r/%s
    #
+   # Set to "yes" to save maildirs instead of mailboxes
+   # This will help avoid mboxo/mboxrd format inconsistencies between
+   # 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:
diff --git a/man/b4.5.rst b/man/b4.5.rst
index 583d6cc..2b803e0 100644
--- a/man/b4.5.rst
+++ b/man/b4.5.rst
@@ -8,7 +8,7 @@ Work with code submissions in a public-inbox archive
 :Date:      2020-11-20
 :Copyright: The Linux Foundation and contributors
 :License:   GPLv2+
-:Version:   0.6.0
+:Version:   0.7.0
 :Manual section: 5
 
 SYNOPSIS
@@ -62,8 +62,11 @@ optional arguments:
                         Filename to name the mbox file
   -m LOCALMBOX, --use-local-mbox LOCALMBOX
                         Instead of grabbing a thread from lore, process this mbox file
+                        (or use - for stdin)
   -C, --no-cache        Do not use local cache
   -f, --filter-dupes    When adding messages to existing maildir, filter out duplicates
+  -M, --save-as-maildir
+                        Save as maildir (avoids mbox format ambiguities)
 
 *Example*: b4 mbox 20200313231252.64999-1-keescook@chromium.org
 
@@ -87,6 +90,9 @@ optional arguments:
                         Filename to name the mbox file
   -m LOCALMBOX, --use-local-mbox LOCALMBOX
                         Instead of grabbing a thread from lore, process this mbox file
+                        (or use - for stdin)
+  -M, --save-as-maildir
+                        Save as maildir (avoids mbox format ambiguities)
   -C, --no-cache        Do not use local cache
   -v WANTVER, --use-version WANTVER
                         Get a specific version of the patch/series
@@ -98,7 +104,7 @@ optional arguments:
                         Do not add or sort any trailers
   -s, --add-my-sob      Add your own signed-off-by to every patch
   -l, --add-link        Add a lore.kernel.org/r/ link to every patch
-  -Q, --quilt-ready     Save mbox patches in a quilt-ready folder
+  -Q, --quilt-ready     Save patches in a quilt-ready folder
   -P CHERRYPICK, --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)
   -g, --guess-base
@@ -109,26 +115,20 @@ optional arguments:
                         Copy all Cc'd addresses into Cc: trailers, if not already present
   --no-cover
                         Do not save the cover letter (on by default when using -o -)
+  --no-partial-reroll
+                        Do not reroll partial series when detected
 
 
 *Example*: b4 am 20200313231252.64999-1-keescook@chromium.org
 
 b4 attest
 ~~~~~~~~~
-usage: b4 attest [-h] [-f SENDER] [-n] [-o OUTPUT] patchfile [patchfile ...]
+usage: b4 attest [-h] patchfile [patchfile ...]
 
 positional arguments:
   patchfile             Patches to attest
 
-optional arguments:
-  -h, --help            show this help message and exit
-  -f SENDER, --from SENDER
-                        OBSOLETE: this option does nothing and will be removed
-  -n, --no-submit       OBSOLETE: this option does nothing and will be removed
-  -o OUTPUT, --output OUTPUT
-                        OBSOLETE: this option does nothing and will be removed
- 
-*Example*: b4 attest output/\*.patch
+*Example*: b4 attest outgoing/\*.patch
 
 b4 pr
 ~~~~~
@@ -220,6 +220,11 @@ Default configuration, with explanations::
       # When recording Link: trailers, use this mask
       linkmask = https://lore.kernel.org/r/%s
       #
+      # Set to "yes" to save maildirs instead of mailboxes
+      # This will help avoid mboxo/mboxrd format inconsistencies between
+      # 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: