emacs: Add instructions to the hidden citations/signatures.
[notmuch] / TODO
1 Fix the things that are causing the most pain to new users
2 ----------------------------------------------------------
3 1. A new import is tagging all messages as "inbox" -- total pain
4
5 2. Allow an easy way to get tags from directory names (if the user has them)
6
7 3. Fix Xapian defect #250 so tagging is fast.
8
9 Emacs interface (notmuch.el)
10 ----------------------------
11 Enhance '+' and '-' in the search view to operate on an entire region
12 if set.
13
14 Fix '*' to work by simply calling '+' or '-' on a region consisting of
15 the entire buffer.
16
17 Add a global keybinding table for notmuch, and then view-specific
18 tables that add to it.
19
20 Add a command to archive all threads in a search view.
21         
22 Add a '|' binding from the search view.
23
24 When a thread has been entirely read, start out by closing all
25 messages except those that matched the search terms.
26
27 Add support for choosing from one of the user's configured email
28 addresses for the From line.
29
30 Make 'notmuch-show-pipe-message have a private history.
31
32 Add support for a delete keybinding that adds a "deleted" tag to the
33 current message/thread and make searches not return deleted messages
34 by default, (unless the user asks explicitly for deleted messags in
35 the search query).
36
37 Add support to "mute" a thread (add a "muted" tag and then don't
38 display threads in searches by default where any message of the thread
39 has the "muted" tag).
40
41 Portability
42 -----------
43 Fix configure script to test each compiler warning we want to use.
44
45 Completion
46 ----------
47 Fix bash completion to complete multiple search options (both --first
48 and *then* --max-threads), and also complete value for --sort=
49 (oldest-first or newest-first).
50
51 notmuch command-line tool
52 -------------------------
53 Implement "notmuch search --exclude-threads=<search-terms>" to allow
54 for excluding muted threads, (and any other negative, thread-based
55 filtering that the user wants to do).
56
57 Fix "notmuch show" so that the UI doesn't fail to show a thread that
58 is visible in a search buffer, but happens to no longer match the
59 current search. (Perhaps add a --matching=<secondary-search-terms>
60 option (or similar) to "notmuch show".)
61
62 Teach "notmuch search" to return many different kinds of results. Some
63 ideas:
64
65         notmuch search --for threads    # Default if no --for is given
66         notmuch search --for messages
67         notmuch search --for tags
68         notmuch search --for addresses
69         notmuch search --for terms
70
71 Add a "--format" option to "notmuch search", (something printf-like
72 for selecting what gets printed).
73
74 Add a "--count-only" (or so?) option to "notmuch search" for returning
75 the count of search results.
76
77 Give "notmuch restore" some progress indicator. Until we get the
78 Xapian bugs fixed that are making this operation slow, we really need
79 to let the user know that things are still moving.
80
81 Fix "notmuch restore" to operate in a single pass much like "notmuch
82 dump" does, rather than doing N searches into the database, each
83 matching 1/N messages.
84
85 Add a "-f <filename>" option to select an alternate configuration
86 file.
87
88 Fix notmuch.c to call add_timestamp/get_timestamp with path names
89 relative to the database path. (Otherwise, moving the database to a
90 new directory will result in notmuch creating new timestamp documents
91 and leaving stale ones behind.)
92
93 Fix notmuch.c to use a DIR prefix for directory timestamps, (the idea
94 being that it can then add other non-directory timestamps such as for
95 noting how far back in the past mail has been indexed, and whether it
96 needs to re-tag messages based on a theoretical "auto-tags"
97 configuration file).
98
99 Make "notmuch new" notice when a mail directory has gone more than a
100 month without receiving new mail and use that to trigger the printing
101 of the note that the user might want to mark the directory read-only.
102
103 Also make "notmuch new" optionally able to just mark those month-old
104 directories read-only on its own. (Could conflict with low-volume
105 lists such as announce lists if they are setup to deliver to their own
106 maildirs.)
107
108 Allow configuration for filename patterns that should be ignored when
109 indexing.
110
111 notmuch library
112 ---------------
113 Index content from citations, please.
114
115 Provide a sane syntax for date ranges. First, we don't want to require
116 both endpoints to be specified. For example it would be nice to be
117 able to say things like "since:2009-01-1" or "until:2009-01-1" and
118 have the other endpoint be implicit. Second we'd like to support
119 relative specifications of time such as "since:'2 months ago'". To do
120 any of this we're probably going to need to break down an write our
121 own parser for the query string rather than using Xapian's QueryParser
122 class.
123
124 Make failure to read a file (such as a permissions problem) a warning
125 rather than an error (should be similar to the existing warning for a
126 non-mail file).
127
128 Add support for files that are moved or deleted (which obviously need
129 to be handled differently).
130
131 Actually compile and install a libnotmuch shared library.
132
133 Fix to use the *last* Message-ID header if multiple such headers are
134 encountered, (I noticed this is one thing that kept me from seeing the
135 same message-ID values as sup).
136
137 Add support for the user to specify custom headers to be indexed.
138
139 Add support for configuring "virtual tags" which are a tuple of
140 (tag-name, search-specification). The database is responsible for
141 ensuring that the virtual tag is always consistent.
142
143 Indicate to the user if two files with the same message ID have
144 content that is actually different in some interesting way. Perhaps
145 notmuch initially sees all changes as interesting, and quickly learns
146 from the user which changes are not interesting (such as the very
147 common mailing-list footer).
148
149 General
150 -------
151 Audit everything for dealing with out-of-memory (and drop xutil.c).
152
153 Write a test suite.
154
155 Achieve 100% test coverage with the test suite.
156
157 Investigate why the notmuch database is slightly larger than the sup
158 database for the same corpus of email.
159
160 Xapian
161 ------
162 Fix defect #250
163
164         replace_document should make minimal changes to database file
165         http://trac.xapian.org/ticket/250
166
167         It looks like it's going to be easy to fix. Here's the file to
168         change:
169
170                 xapian-core/backends/flint/flint_database.cc
171
172         And look for:
173
174           // FIXME - in the case where there is overlap between the new
175           // termlist and the old termlist, it would be better to compare the
176           // two lists, and make the minimum set of modifications required.
177           // This would lead to smaller changesets for replication, and
178           // probably be faster overall
179
180         So I think this might be as easy as just walking over two
181         sorted lists looking for differences.
182
183         Note that this is in the currently default "flint" backend,
184         but the Xapian folks are probably more interested in fixing
185         the in-development "chert" backend. So the patch to get
186         upstreamed there will probably also fix:
187
188                 xapian-core/backends/chert/chert_database.cc
189
190         (I'm hoping the fix will be the same---an identical comment
191         exists there.)
192
193         Also, if you want to experiment with the chert backend,
194         compile current Xapian source and run notmuch with
195         XAPIAN_PREFER_CHERT=1. I haven't tried that yet, but there are
196         claims that a chert database can be 40% smaller than an
197         equivalent flint database.
198
199 Report this bug:
200
201         "tag:foo and tag:bar and -tag:deleted" goes insane
202
203         This seems to be triggered by a Boolean operator next to a
204         token starting with a non-word character---suddenly all the
205         Boolean operators get treated as literal tokens)