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