summaryrefslogtreecommitdiff
path: root/mbox-extract-patch.1.pod
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2020-02-20 22:12:52 -0700
committerSean Whitton <spwhitton@spwhitton.name>2020-02-20 22:12:52 -0700
commitcc1f96c07dd0612e9ae44e41f889dd40315f0d75 (patch)
treebc960e456d1cba9a4070376d63443b1ec8b8f947 /mbox-extract-patch.1.pod
parent46cedb673ae6e63724d010d3fb6a47cc209502f5 (diff)
parentbbf1fc63fa1d88ea204a8cf272511ca85a828794 (diff)
downloadmailscripts-cc1f96c07dd0612e9ae44e41f889dd40315f0d75.tar.gz
Merge tag '0.18' into buster-bpo
release 0.18 # gpg: Signature made Sat 15 Feb 2020 03:11:16 PM MST # gpg: using RSA key 9B917007AE030E36E4FC248B695B7AE4BF066240 # gpg: issuer "spwhitton@spwhitton.name" # gpg: Good signature from "Sean Whitton <spwhitton@spwhitton.name>" [ultimate] # Primary key fingerprint: 8DC2 487E 51AB DD90 B5C4 753F 0F56 D055 3B6D 411B # Subkey fingerprint: 9B91 7007 AE03 0E36 E4FC 248B 695B 7AE4 BF06 6240
Diffstat (limited to 'mbox-extract-patch.1.pod')
-rw-r--r--mbox-extract-patch.1.pod70
1 files changed, 70 insertions, 0 deletions
diff --git a/mbox-extract-patch.1.pod b/mbox-extract-patch.1.pod
new file mode 100644
index 0000000..943c322
--- /dev/null
+++ b/mbox-extract-patch.1.pod
@@ -0,0 +1,70 @@
+=head1 NAME
+
+mbox-extract-patch - extract a git patch series from an mbox
+
+=head1 SYNOPSIS
+
+B<mbox-extract-patch> [I<OPTIONS>] <I<MBOX>
+
+=head1 DESCRIPTION
+
+B<mbox-extract-patch> extracts a series of git patches from an mbox.
+It is designed to extract patches that were originally sent using
+git-send-email(1). It skips cover letters and replies/reviews in its
+output.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-v>|B<--reroll-count=>I<N>
+
+Try to extract the I<N>th version of a patch series, where these
+patches are identified by subject prefixes like "[PATCH vI<N> 1/3]".
+
+If this option is not specified, and there is more than one series,
+default to extracting the version of the patch series with the highest
+version number we find.
+
+Note that this option should not usually be needed, because best
+practices when sharing patches with git-send-email(1) include starting
+a new thread when posting a revised series. The I<--in-reply-to>
+option to git-format-patch(1) is used mainly for posting a patch
+series in reply to a bug report.
+
+=item B<--trailers>
+
+Extract and add to patches lines like
+
+ Acked-by: A. Developer <a.dev@example.net>
+
+sent in reply to those patches. B<--trailers> is on by default, and
+B<--no-trailers> can be used to disable adding the trailers.
+
+=item B<--cover-letter-trailers>
+
+Additionally add to all patches in the series any trailers sent in
+reply to the cover letter of the patch series.
+
+=back
+
+=head1 EXAMPLE
+
+=over 4
+
+ % git checkout -b test-feature
+ % mbox-extract-patch <thread.mbox | git am
+
+=back
+
+=head1 LIMITATIONS
+
+Detection of cover letters is currently quite simplistic.
+
+=head1 SEE ALSO
+
+notmuch(1), git-send-email(1), notmuch-extract-patch(1)
+
+=head1 AUTHOR
+
+Sean Whitton <spwhitton@spwhitton.name>