diff options
author | Sean Whitton <spwhitton@spwhitton.name> | 2018-07-26 16:27:01 +0800 |
---|---|---|
committer | Sean Whitton <spwhitton@spwhitton.name> | 2018-07-26 16:32:58 +0800 |
commit | dce35bdf1fc374b652f8fae98e59a9d26e88ab61 (patch) | |
tree | ac17ca3a8e3dce2d717af2286e1137b08117d462 | |
parent | d7c56828c7e3890cd343435daa9bdef30184d4eb (diff) | |
download | mailscripts-dce35bdf1fc374b652f8fae98e59a9d26e88ab61.tar.gz |
notmuch-extract-patch: note assumption that there is only one series
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
-rw-r--r-- | mailscripts.el | 6 | ||||
-rw-r--r-- | notmuch-extract-patch.1.pod | 13 |
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) |