]> git.notmuchmail.org Git - notmuch/blobdiff - TODO
TODO: Add a todo item for adding a message as a blob, rather than a filename.
[notmuch] / TODO
diff --git a/TODO b/TODO
index c0c307730722b596789aef5a94b91a5290f6d31a..2778604cb361ed4fe6489da72951414704093da3 100644 (file)
--- a/TODO
+++ b/TODO
+Fix the things that are causing the most pain to new users
+----------------------------------------------------------
+1. A new import is tagging all messages as "inbox" -- total pain
+
+2. Allow an easy way to get tags from directory names (if the user has them)
+
 Emacs interface (notmuch.el)
 ----------------------------
+Enhance '+' and '-' in the search view to operate on an entire region
+if set.
+
+Fix '*' to work by simply calling '+' or '-' on a region consisting of
+the entire buffer.
+
+Add a global keybinding table for notmuch, and then view-specific
+tables that add to it.
+       
+Add a '|' binding from the search view.
+
+Add support for choosing from one of the user's configured email
+addresses for the From line.
+
+Make 'notmuch-show-pipe-message have a private history.
+
+Add support for a delete keybinding that adds a "deleted" tag to the
+current message/thread and make searches not return deleted messages
+by default, (unless the user asks explicitly for deleted messags in
+the search query).
+
+Add support to "mute" a thread (add a "muted" tag and then don't
+display threads in searches by default where any message of the thread
+has the "muted" tag).
+
+Fix i-search to open up invisible citations as necessary.
+
+Emacs saved-search interface
+----------------------------
+Here's a proposal Carl wrote (id:87einafy4u.fsf@yoom.home.cworth.org):
+
+  So what I'm imagining for the default notmuch view is something like
+  this:
+
+          Welcome to notmuch.
+
+              Notmuch search: _________________________________________
+
+          Saved searches:
+
+              55,342      All messages
+                  22      Inbox
+
+          Recent searches:
+
+                   1      from:"someone special" and tag:unread
+                  34      tag:notmuch and tag:todo
+
+          Click (or press Enter) on any search to see the results.
+          Right-click (or press Space) on any recent search to save it.
+
+  So the "saved searches" portion of the view is basically just what
+  notmuch-folder displays now. Above that there's an obvious place to
+  start a new search, (in a slightly more "web-browser-like" way than the
+  typical mini-buffer approach).
+
+  All recent searches appear in the list at the bottom automatically, and
+  there's the documented mechanism for saving a search, (giving it a name
+  and having it appear above).
+
+Portability
+-----------
+Fix configure script to test each compiler warning we want to use.
+
+Completion
+----------
+Fix bash completion to complete multiple search options (both --first
+and *then* --max-threads), and also complete value for --sort=
+(oldest-first or newest-first).
 
 notmuch command-line tool
 -------------------------
-Give "notmuch restore" some progress indicator. Until we get the
-Xapian bugs fixed that are making this operation slow, we really need
-to let the user know that things are still moving.
-
-Fix notmuch.c to call add_timestamp/get_timestamp with path names
-relative to the database path. (Otherwise, moving the database to a
-new directory will result in notmuch creating new timestamp documents
-and leaving stale ones behind.)
-
-Ensure that "notmuch new" is sane if its first, giant indexing session
-gets interrupted, (that is, ensure that any results indexed so far are
-flushed).
-
-Fix notmuch.c to use a DIR prefix for directory timestamps, (the idea
-being that it can then add other non-directory timestamps such as for
-noting how far back in the past mail has been indexed, and whether it
-needs to re-tag messages based on a theoretical "auto-tags"
-configuration file).
-
-Make "notmuch new" notice when a mail directory has gone more than a
-month without receiving new mail and use that to trigger the printing
-of the note that the user might want to mark the directory read-only.
-
-Also make "notmuch new" optionally able to just mark those month-old
-directories read-only on its own. (Could conflict with low-volume
-lists such as announce lists if they are setup to deliver to their own
-maildirs.)
+Fix the --format=json option to not imply --entire-thread.
+
+Implement "notmuch search --exclude-threads=<search-terms>" to allow
+for excluding muted threads, (and any other negative, thread-based
+filtering that the user wants to do).
+
+Fix "notmuch show" so that the UI doesn't fail to show a thread that
+is visible in a search buffer, but happens to no longer match the
+current search. (Perhaps add a --matching=<secondary-search-terms>
+option (or similar) to "notmuch show".) For now, this is being worked
+around in the emacs interface by noticing that "notmuch show" returns
+nothing and re-rerunning the command without the extra arguments.
+
+Teach "notmuch search" to return many different kinds of results. Some
+ideas:
+
+       notmuch search --output=threads # Default if no --output is given
+       notmuch search --output=messages
+       notmuch search --output=tags
+       notmuch search --output=addresses
+       notmuch search --output=terms
+
+Add a "--format" option to "notmuch search", (something printf-like
+for selecting what gets printed).
+
+Add a "--count-only" (or so?) option to "notmuch search" for returning
+the count of search results.
+
+Give "notmuch restore" some progress indicator.
+
+Fix "notmuch restore" to operate in a single pass much like "notmuch
+dump" does, rather than doing N searches into the database, each
+matching 1/N messages.
+
+Add a "-f <filename>" option to select an alternate configuration
+file.
+
+Allow configuration for filename patterns that should be ignored when
+indexing.
 
 notmuch library
 ---------------
+Add an interface to accept a "key" and a byte stream, rather than a
+filename.
+
+Provide a sane syntax for date ranges. First, we don't want to require
+both endpoints to be specified. For example it would be nice to be
+able to say things like "since:2009-01-1" or "until:2009-01-1" and
+have the other endpoint be implicit. Second we'd like to support
+relative specifications of time such as "since:'2 months ago'". To do
+any of this we're probably going to need to break down an write our
+own parser for the query string rather than using Xapian's QueryParser
+class.
+
+Make failure to read a file (such as a permissions problem) a warning
+rather than an error (should be similar to the existing warning for a
+non-mail file).
+
 Actually compile and install a libnotmuch shared library.
 
 Fix to use the *last* Message-ID header if multiple such headers are
@@ -41,17 +144,54 @@ same message-ID values as sup).
 
 Add support for the user to specify custom headers to be indexed.
 
-Add support for automatic tagging of new messages based on particular
-search criteria, (likely using an InMemory database for the new
-messages).
+Add support for configuring "virtual tags" which are a tuple of
+(tag-name, search-specification). The database is responsible for
+ensuring that the virtual tag is always consistent.
 
-General
--------
-Audit everything for dealing with out-of-memory (and drop xutil.c).
+Indicate to the user if two files with the same message ID have
+content that is actually different in some interesting way. Perhaps
+notmuch initially sees all changes as interesting, and quickly learns
+from the user which changes are not interesting (such as the very
+common mailing-list footer).
+
+Fix notmuch_query_count_messages to share code with
+notmuch_query_search_messages rather than duplicating code. (And
+consider renaming it as well.)
 
-Write a test suite.
+Provide a mechanism for doing automatic address completion based on
+notmuch searches. Here was one proposal made in IRC:
 
+       <cworth> I guess all it would really have to be would be a way
+                to configure a series of searches to try in turn,
+                (presenting ambiguities at a given single level, and
+                advancing to the next level only if one level
+                returned no matches).
+       <cworth> So then I might have a series that looks like this:
+       <cworth> notmuch search --output=address_from tag:address_book_alias
+       <cworth> notmuch search --output=address_to tag:sent
+       <cworth> notmuch search --output=address_from
+       <cworth> I think I might like that quite a bit.
+       <cworth> And then we have a story for an address book for
+                non-emacs users.
+
+Provide a ~me Xapian synonym for all of the user's configured email
+addresses.
+
+Test suite
+----------
 Achieve 100% test coverage with the test suite.
 
+Modularize test suite (to be able to run individual tests).
+
+Summarize test results at the end.
+
+Fix the insane quoting nightmare of the test suite, (and once we do
+that we can actually test the implicit-phrase search feature such as
+"notmuch search 'body search (phrase)'"
+
+General
+-------
+Audit everything for dealing with out-of-memory (and drop xutil.c).
+
 Investigate why the notmuch database is slightly larger than the sup
 database for the same corpus of email.