summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--mailscripts.el6
-rw-r--r--notmuch-extract-patch.1.pod13
2 files changed, 18 insertions, 1 deletions
diff --git a/mailscripts.el b/mailscripts.el
index 33b6187..c4edd5a 100644
--- a/mailscripts.el
+++ b/mailscripts.el
@@ -43,7 +43,11 @@ If NO-OPEN, don't open the thread."
;;;###autoload
(defun notmuch-extract-thread-patches (repo branch)
- "Extract patch series in current thread to new branch BRANCH in repo REPO."
+ "Extract patch series in current thread to new branch BRANCH in repo REPO.
+
+See notmuch-extract-patch(1) manpage for limitations: in
+particular, this Emacs Lisp function supports passing only entire
+threads to the notmuch-extract-patch(1) command."
(interactive "Dgit repo: \nsnew branch name: ")
(let ((thread-id notmuch-show-thread-id)
(default-directory (expand-file-name repo)))
diff --git a/notmuch-extract-patch.1.pod b/notmuch-extract-patch.1.pod
index ee0c6f6..21095bc 100644
--- a/notmuch-extract-patch.1.pod
+++ b/notmuch-extract-patch.1.pod
@@ -26,6 +26,19 @@ None.
=back
+=head1 LIMITATIONS
+
+B<notmuch-extract-patch> assumes one patch series per query. So if
+there is more than one patch series in a thread, you will need to
+construct a notmuch query that includes only the patches you want to
+extract, which somewhat defeats the purpose of this script.
+
+This should not happen often 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
+B<notmuch-extract-patch> is used mainly for posting a patch series in
+reply to a bug report.
+
=head1 SEE ALSO
notmuch(1), git-send-email(1)