[PATCH] emacs: add `notmuch-archive-tags' cross references in docstrings
[notmuch-archives.git] / ee / f5d00b70aab5fe84ecb276bf67ac06c0ec5121
1 Return-Path: <bremner@tethera.net>\r
2 X-Original-To: notmuch@notmuchmail.org\r
3 Delivered-To: notmuch@notmuchmail.org\r
4 Received: from localhost (localhost [127.0.0.1])\r
5         by olra.theworths.org (Postfix) with ESMTP id E4D18429E4C\r
6         for <notmuch@notmuchmail.org>; Sun,  2 Jun 2013 07:29:51 -0700 (PDT)\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
8 X-Spam-Flag: NO\r
9 X-Spam-Score: -2.3\r
10 X-Spam-Level: \r
11 X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
12         tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
13 Received: from olra.theworths.org ([127.0.0.1])\r
14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
15         with ESMTP id oajxg3-LtJen for <notmuch@notmuchmail.org>;\r
16         Sun,  2 Jun 2013 07:29:44 -0700 (PDT)\r
17 Received: from tempo.its.unb.ca (tempo.its.unb.ca [131.202.1.21])\r
18         (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
19         (No client certificate requested)\r
20         by olra.theworths.org (Postfix) with ESMTPS id 39074429E40\r
21         for <notmuch@notmuchmail.org>; Sun,  2 Jun 2013 07:29:44 -0700 (PDT)\r
22 Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238])\r
23         by tempo.its.unb.ca (8.13.8/8.13.8) with ESMTP id r52ETbYj018387;\r
24         Sun, 2 Jun 2013 11:29:37 -0300\r
25 Received: from fctnnbsc30w-156034082078.dhcp-dynamic.fibreop.nb.bellaliant.net\r
26         ([156.34.82.78] helo=zancas.localnet)\r
27         by tesseract.cs.unb.ca with esmtpsa\r
28         (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80)\r
29         (envelope-from <bremner@tethera.net>)\r
30         id 1Uj9Hs-0006h3-SO; Sun, 02 Jun 2013 11:29:37 -0300\r
31 Received: from bremner by zancas.localnet with local (Exim 4.80)\r
32         (envelope-from <bremner@tethera.net>)\r
33         id 1Uj9Hn-0006wY-9F; Sun, 02 Jun 2013 11:29:31 -0300\r
34 From: david@tethera.net\r
35 To: notmuch@notmuchmail.org\r
36 Subject: [PATCH] emacs: add `notmuch-archive-tags' cross references in\r
37         docstrings\r
38 Date: Sun,  2 Jun 2013 11:29:17 -0300\r
39 Message-Id: <1370183357-26653-1-git-send-email-david@tethera.net>\r
40 X-Mailer: git-send-email 1.8.2.rc2\r
41 In-Reply-To: <1370181885-23021-1-git-send-email-david@tethera.net>\r
42 References: <1370181885-23021-1-git-send-email-david@tethera.net>\r
43 X-Spam_bar: -\r
44 Cc: David Bremner <bremner@debian.org>\r
45 X-BeenThere: notmuch@notmuchmail.org\r
46 X-Mailman-Version: 2.1.13\r
47 Precedence: list\r
48 List-Id: "Use and development of the notmuch mail system."\r
49         <notmuch.notmuchmail.org>\r
50 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
51         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
52 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
53 List-Post: <mailto:notmuch@notmuchmail.org>\r
54 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
55 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
56         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
57 X-List-Received-Date: Sun, 02 Jun 2013 14:29:52 -0000\r
58 \r
59 From: David Bremner <bremner@debian.org>\r
60 \r
61 Several function docstrings refer to behaviour in docstrings that is\r
62 really controlled by notmuch-archive-tags. Add cross references, and\r
63 replace hardcoding.\r
64 ---\r
65  emacs/notmuch-show.el |  4 ++--\r
66  emacs/notmuch.el      | 27 ++++++++++++++++-----------\r
67  2 files changed, 18 insertions(+), 13 deletions(-)\r
68 \r
69 diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el\r
70 index 600e802..c281f05 100644\r
71 --- a/emacs/notmuch-show.el\r
72 +++ b/emacs/notmuch-show.el\r
73 @@ -1529,8 +1529,8 @@ This command is intended to be one of the simplest ways to\r
74  process a thread of email. It works exactly like\r
75  notmuch-show-advance, in that it scrolls through messages in a\r
76  show buffer, except that when it gets to the end of the buffer it\r
77 -archives the entire current thread, (remove the \"inbox\" tag\r
78 -from each message), kills the buffer, and displays the next\r
79 +archives the entire current thread, (apply changes in\r
80 +`notmuch-archive-tags'), kills the buffer, and displays the next\r
81  thread from the search from which this thread was originally\r
82  shown."\r
83    (interactive)\r
84 diff --git a/emacs/notmuch.el b/emacs/notmuch.el\r
85 index 5a8c957..e78334d 100644\r
86 --- a/emacs/notmuch.el\r
87 +++ b/emacs/notmuch.el\r
88 @@ -386,17 +386,22 @@ number of matched messages and total messages in the thread,\r
89  participants in the thread, a representative subject line, and\r
90  any tags).\r
91  \r
92 -Pressing \\[notmuch-search-show-thread] on any line displays that thread. The '\\[notmuch-search-add-tag]' and '\\[notmuch-search-remove-tag]'\r
93 -keys can be used to add or remove tags from a thread. The '\\[notmuch-search-archive-thread]' key\r
94 -is a convenience for archiving a thread (removing the \"inbox\"\r
95 -tag). The '\\[notmuch-search-tag-all]' key can be used to add and/or remove tags from all\r
96 -messages (as opposed to threads) that match the current query.  Use with caution, as this\r
97 -will also tag matching messages that arrived *after* constructing the buffer.\r
98 -\r
99 -Other useful commands are '\\[notmuch-search-filter]' for filtering the current search\r
100 -based on an additional query string, '\\[notmuch-search-filter-by-tag]' for filtering to include\r
101 -only messages with a given tag, and '\\[notmuch-search]' to execute a new, global\r
102 -search.\r
103 +Pressing \\[notmuch-search-show-thread] on any line displays that\r
104 +thread. The '\\[notmuch-search-add-tag]' and\r
105 +'\\[notmuch-search-remove-tag]' keys can be used to add or remove\r
106 +tags from a thread. The '\\[notmuch-search-archive-thread]' key\r
107 +is a convenience for archiving a thread (applying changes in\r
108 +`notmuch-archive-tags'). The '\\[notmuch-search-tag-all]' key can\r
109 +be used to add and/or remove tags from all messages (as opposed\r
110 +to threads) that match the current query.  Use with caution, as\r
111 +this will also tag matching messages that arrived *after*\r
112 +constructing the buffer.\r
113 +\r
114 +Other useful commands are '\\[notmuch-search-filter]' for\r
115 +filtering the current search based on an additional query string,\r
116 +'\\[notmuch-search-filter-by-tag]' for filtering to include only\r
117 +messages with a given tag, and '\\[notmuch-search]' to execute a\r
118 +new, global search.\r
119  \r
120  Complete list of currently available key bindings:\r
121  \r
122 -- \r
123 1.8.2.rc2\r
124 \r