notmuch search: Add a new --output=(summary|threads|messages|tags) option.

[notmuch] / TODO

diff --git a/TODO b/TODO
index 572dac8ee3e3709d5a78fb7ddb496a04950bc6bc..08f0882bcc1a8e9e0bd6015ada0a91c4156056d1 100644 (file)
--- a/TODO
+++ b/TODO
@@ -6,8 +6,12 @@ Fix the things that are causing the most pain to new users
 
 Emacs interface (notmuch.el)
 ----------------------------
 
 Emacs interface (notmuch.el)
 ----------------------------

-Enhance '+' and '-' in the search view to operate on an entire region
-if set.
+Switch the notmuch-search view to use "notmuch search --format=json"
+to fix large classes of bugs regarding poorly-escaped output and lame
+regular expressions. (The most recently found, unfixed example is the
+sender's name containing ';' which causes emacs to drop a search
+result.) This may require removing the outer array from the current
+"notmuch search --format=json" results.

 
 Fix '*' to work by simply calling '+' or '-' on a region consisting of
 the entire buffer.
 
 Fix '*' to work by simply calling '+' or '-' on a region consisting of
 the entire buffer.


@@ -31,43 +35,27 @@ 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).
 
 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.
-

 Make '=' count from the end rather than from the beginning if more
 than half-way through the buffer.
 
 Make '=' count from the end rather than from the beginning if more
 than half-way through the buffer.
 

-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: _________________________________________
+Fix to automatically wrap long headers (for RFC compliance) before
+sending. This should probably just be fixed in message-mode itself,
+(but perhaps we can have a notmuch-message-mode that layers this on
+top).

 
 

-          Saved searches:
+Stop hiding the headers so much in the thread-view mode.

 
 

-              55,342      All messages
-                  22      Inbox
+Allow opening a message in thread-view mode by clicking on either
+line.

 
 

-          Recent searches:
+Automatically open a message when navigating to it with N or P.

 
 

-                   1      from:"someone special" and tag:unread
-                  34      tag:notmuch and tag:todo
+Change 'a' command in thread-view mode to only archive open messages.

 
 

-          Click (or press Enter) on any search to see the results.
-          Right-click (or press Space) on any recent search to save it.
+Add a binding to open all closed messages.

 
 

-  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).
+Change the 'a'rchive command in the thread view to only archive open
+messages.

 
 Portability
 -----------
 
 Portability
 -----------


@@ -81,6 +69,13 @@ and *then* --max-threads), and also complete value for --sort=
 
 notmuch command-line tool
 -------------------------
 
 notmuch command-line tool
 -------------------------

+Replace "notmuch reply" with "notmuch compose --reply <search-terms>".
+This would enable a plain "notmuch compose" to be used to construct an
+initial message, (which would then have the properly configured name
+and email address in the From: line. We could also then easily support
+"notmuch compose --from <something>" to support getting at alternate
+email addresses.
+

 Fix the --format=json option to not imply --entire-thread.
 
 Implement "notmuch search --exclude-threads=<search-terms>" to allow
 Fix the --format=json option to not imply --entire-thread.
 
 Implement "notmuch search --exclude-threads=<search-terms>" to allow


@@ -94,21 +89,9 @@ 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.
 
 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 "--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
 Give "notmuch restore" some progress indicator.
 
 Fix "notmuch restore" to operate in a single pass much like "notmuch


@@ -128,6 +111,20 @@ provide more MIME-structure information in its output first).
 Replace the "notmuch search-tags" command with "notmuch search
 --output=tags".
 
 Replace the "notmuch search-tags" command with "notmuch search
 --output=tags".
 

+Fix to avoid this ugly message:
+
+       (process:17197): gmime-CRITICAL **: g_mime_message_get_mime_part: assertion `GMIME_IS_MESSAGE (message)' failed
+       Warning: Not indexing empty mime part.
+
+  This probably means adding a test case to generate that message,
+  filing an upstream bug against GMime, and then silencing the
+  notmuch-generated portion of the warning (so that once GMime is
+  fixed, this is all silent).
+
+Simplify notmuch-reply to simply print the headers (we have the
+original values) rather than calling GMime (which encodes) and adding
+the confusing gmime-filter-headers.c code (which decodes).
+

 notmuch library
 ---------------
 Add an interface to accept a "key" and a byte stream, rather than a
 notmuch library
 ---------------
 Add an interface to accept a "key" and a byte stream, rather than a


@@ -146,14 +143,10 @@ 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).
 
 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
 encountered, (I noticed this is one thing that kept me from seeing the
 same message-ID values as sup).
 
 Fix to use the *last* Message-ID header if multiple such headers are
 encountered, (I noticed this is one thing that kept me from seeing the
 same message-ID values as sup).
 

-Add support for the user to specify custom headers to be indexed.
-

 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.
 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.


@@ -187,17 +180,63 @@ notmuch searches. Here was one proposal made in IRC:
 Provide a ~me Xapian synonym for all of the user's configured email
 addresses.
 
 Provide a ~me Xapian synonym for all of the user's configured email
 addresses.
 

-Test suite
-----------
-Achieve 100% test coverage with the test suite.
+Add symbol hiding so that we don't risk leaking any private symbols
+into the shared-library interface.

 
 

-Modularize test suite (to be able to run individual tests).
+Audit all libnotmuch entry points to ensure that all Xapian calls are
+wrapped in a try/catch block.

 
 

-Summarize test results at the end.
+Fix the "count" functionality to be exact as Olly explained in IRC:

 
 

-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)'"
+       ojwb> cworth: if you set the check_at_least parameter to the
+       database size, get_matches_estimated() will be exact
+
+Search syntax
+-------------
+Implement support for "tag:*" to expand to all tags.
+
+Fix "notmuch search to:" to be less confusing. Many users expect this
+to search for all messages with a To: header, but it instead searches
+for all messages with the word "to". If we don't provide the first
+behavior, perhaps we should exit on an error when a configured prefix
+is provided with no value?
+
+Support "*" in all cases and not just as a special case. That is, "* "
+should also work, as well as "* and tag:inbox".
+
+Implement a syntax for requesting set-theoertic operations on results
+of multiple searches. For example, I would like to do:
+
+       "tag:inbox" SET-SUBTRACT "tag:muted"
+
+    as well as:
+
+       "tag:notmuch and <date-range>" SET-INTERSECT
+       "tag:notmuch and not (tag:merged or tag:postponed)"
+
+    See id:3wdpr282yz2.fsf@testarossa.amd.com for more details on the
+    use cases of the above.
+
+Database changes
+----------------
+Store a reference term for every message-id that appears in
+References. We just started doing this for newly-added documents, but
+at the next convenient database-schema upgrade, we should go back and
+fix old messages to be consistent.
+
+Start indexing the List-Id header, (and re-index this header for
+existing messages at the next database upgrade).
+
+Start indexing the message file's directory and make it available for
+search as "folder:" (and re-index this value for existing messages at
+the next database upgrade).
+
+Add support for the user to specify custom headers to be indexed (and
+re-index these for existing messages at the next database upgrade).
+
+Test suite
+----------
+Achieve 100% test coverage with the test suite.

 
 General
 -------
 
 General
 -------


@@ -205,3 +244,11 @@ 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.
 
 Investigate why the notmuch database is slightly larger than the sup
 database for the same corpus of email.

+
+Makefile should print message teaching user about LD_LIBRARY_PATH (or
+similar) if libdir is not set to a directory examined by ldconfig.
+
+Fix notmuch build system to work with gold, (apt-get
+binutils-gold). Need the notmuch binary to explicitly link againsts
+libraries it depends on, (rather than just getting them via
+libnotmuch).