[PATCH] emacs: add `notmuch-archive-tags' cross references in docstrings
authordavid <david@tethera.net>
Sun, 2 Jun 2013 14:29:17 +0000 (11:29 +2100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:55:18 +0000 (09:55 -0800)
ee/f5d00b70aab5fe84ecb276bf67ac06c0ec5121 [new file with mode: 0644]

diff --git a/ee/f5d00b70aab5fe84ecb276bf67ac06c0ec5121 b/ee/f5d00b70aab5fe84ecb276bf67ac06c0ec5121
new file mode 100644 (file)
index 0000000..ca48d32
--- /dev/null
@@ -0,0 +1,124 @@
+Return-Path: <bremner@tethera.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id E4D18429E4C\r
+       for <notmuch@notmuchmail.org>; Sun,  2 Jun 2013 07:29:51 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -2.3\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id oajxg3-LtJen for <notmuch@notmuchmail.org>;\r
+       Sun,  2 Jun 2013 07:29:44 -0700 (PDT)\r
+Received: from tempo.its.unb.ca (tempo.its.unb.ca [131.202.1.21])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 39074429E40\r
+       for <notmuch@notmuchmail.org>; Sun,  2 Jun 2013 07:29:44 -0700 (PDT)\r
+Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238])\r
+       by tempo.its.unb.ca (8.13.8/8.13.8) with ESMTP id r52ETbYj018387;\r
+       Sun, 2 Jun 2013 11:29:37 -0300\r
+Received: from fctnnbsc30w-156034082078.dhcp-dynamic.fibreop.nb.bellaliant.net\r
+       ([156.34.82.78] helo=zancas.localnet)\r
+       by tesseract.cs.unb.ca with esmtpsa\r
+       (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1Uj9Hs-0006h3-SO; Sun, 02 Jun 2013 11:29:37 -0300\r
+Received: from bremner by zancas.localnet with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1Uj9Hn-0006wY-9F; Sun, 02 Jun 2013 11:29:31 -0300\r
+From: david@tethera.net\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] emacs: add `notmuch-archive-tags' cross references in\r
+       docstrings\r
+Date: Sun,  2 Jun 2013 11:29:17 -0300\r
+Message-Id: <1370183357-26653-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.8.2.rc2\r
+In-Reply-To: <1370181885-23021-1-git-send-email-david@tethera.net>\r
+References: <1370181885-23021-1-git-send-email-david@tethera.net>\r
+X-Spam_bar: -\r
+Cc: David Bremner <bremner@debian.org>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 02 Jun 2013 14:29:52 -0000\r
+\r
+From: David Bremner <bremner@debian.org>\r
+\r
+Several function docstrings refer to behaviour in docstrings that is\r
+really controlled by notmuch-archive-tags. Add cross references, and\r
+replace hardcoding.\r
+---\r
+ emacs/notmuch-show.el |  4 ++--\r
+ emacs/notmuch.el      | 27 ++++++++++++++++-----------\r
+ 2 files changed, 18 insertions(+), 13 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el\r
+index 600e802..c281f05 100644\r
+--- a/emacs/notmuch-show.el\r
++++ b/emacs/notmuch-show.el\r
+@@ -1529,8 +1529,8 @@ This command is intended to be one of the simplest ways to\r
+ process a thread of email. It works exactly like\r
+ notmuch-show-advance, in that it scrolls through messages in a\r
+ show buffer, except that when it gets to the end of the buffer it\r
+-archives the entire current thread, (remove the \"inbox\" tag\r
+-from each message), kills the buffer, and displays the next\r
++archives the entire current thread, (apply changes in\r
++`notmuch-archive-tags'), kills the buffer, and displays the next\r
+ thread from the search from which this thread was originally\r
+ shown."\r
+   (interactive)\r
+diff --git a/emacs/notmuch.el b/emacs/notmuch.el\r
+index 5a8c957..e78334d 100644\r
+--- a/emacs/notmuch.el\r
++++ b/emacs/notmuch.el\r
+@@ -386,17 +386,22 @@ number of matched messages and total messages in the thread,\r
+ participants in the thread, a representative subject line, and\r
+ any tags).\r
\r
+-Pressing \\[notmuch-search-show-thread] on any line displays that thread. The '\\[notmuch-search-add-tag]' and '\\[notmuch-search-remove-tag]'\r
+-keys can be used to add or remove tags from a thread. The '\\[notmuch-search-archive-thread]' key\r
+-is a convenience for archiving a thread (removing the \"inbox\"\r
+-tag). The '\\[notmuch-search-tag-all]' key can be used to add and/or remove tags from all\r
+-messages (as opposed to threads) that match the current query.  Use with caution, as this\r
+-will also tag matching messages that arrived *after* constructing the buffer.\r
+-\r
+-Other useful commands are '\\[notmuch-search-filter]' for filtering the current search\r
+-based on an additional query string, '\\[notmuch-search-filter-by-tag]' for filtering to include\r
+-only messages with a given tag, and '\\[notmuch-search]' to execute a new, global\r
+-search.\r
++Pressing \\[notmuch-search-show-thread] on any line displays that\r
++thread. The '\\[notmuch-search-add-tag]' and\r
++'\\[notmuch-search-remove-tag]' keys can be used to add or remove\r
++tags from a thread. The '\\[notmuch-search-archive-thread]' key\r
++is a convenience for archiving a thread (applying changes in\r
++`notmuch-archive-tags'). The '\\[notmuch-search-tag-all]' key can\r
++be used to add and/or remove tags from all messages (as opposed\r
++to threads) that match the current query.  Use with caution, as\r
++this will also tag matching messages that arrived *after*\r
++constructing the buffer.\r
++\r
++Other useful commands are '\\[notmuch-search-filter]' for\r
++filtering the current search based on an additional query string,\r
++'\\[notmuch-search-filter-by-tag]' for filtering to include only\r
++messages with a given tag, and '\\[notmuch-search]' to execute a\r
++new, global search.\r
\r
+ Complete list of currently available key bindings:\r
\r
+-- \r
+1.8.2.rc2\r
+\r