Fix typo in notmuch.h documentation regarding database open modes

[notmuch] / TODO

diff --git a/TODO b/TODO
index da8f7c9ba02775f47846d29cbb6fbe67adac7fe3..8dd0878034734aa1765ae0d2163114d412b24d54 100644 (file)
--- a/TODO
+++ b/TODO
@@ -4,31 +4,19 @@ Fix the things that are causing the most pain to new users
 
 2. Allow an easy way to get tags from directory names (if the user has them)
 
 
 2. Allow an easy way to get tags from directory names (if the user has them)
 

-3. Make emacs fast for big search results (see "lazy searching" below)
-
-4. Fix Xapian defect #250 so tagging is fast.
-

 Emacs interface (notmuch.el)
 ----------------------------
 Emacs interface (notmuch.el)
 ----------------------------

-Make the keybindings help ('?') display the summary of each command's
-documentation, not the function name.
+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 global keybinding table for notmuch, and then view-specific
 tables that add to it.

-
-Add a command to archive all threads in a search view.
-
-Lazy searching: call "notmuch search" with --first and --max to fill
-just a screenful of results, and then fill in more as ther user pages
-through the buffer.
-
+       

 Add a '|' binding from the search view.
 
 Add a '|' binding from the search view.
 

-Add a binding to run a search from notmuch-show-mode.
-
-When a thread has been entirely read, start out by closing all
-messages except those that matched the search terms.
-

 Add support for choosing from one of the user's configured email
 addresses for the From line.
 
 Add support for choosing from one of the user's configured email
 addresses for the From line.
 


@@ -43,14 +31,48 @@ 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.
+
+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.
 
 Portability
 -----------
 Fix configure script to test each compiler warning we want to use.
 

-Implement strndup locally (or call talloc_strndup instead).
-
-Implement getline locally, (look at gnulib).
-

 Completion
 ----------
 Fix bash completion to complete multiple search options (both --first
 Completion
 ----------
 Fix bash completion to complete multiple search options (both --first


@@ -59,14 +81,27 @@ and *then* --max-threads), and also complete value for --sort=
 
 notmuch command-line tool
 -------------------------
 
 notmuch command-line tool
 -------------------------

+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:
 
 Teach "notmuch search" to return many different kinds of results. Some
 ideas:
 

-       notmuch search --for threads    # Default if no --for is given
-       notmuch search --for messages
-       notmuch search --for tags
-       notmuch search --for addresses
-       notmuch search --for terms
+       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).


@@ -74,53 +109,42 @@ for selecting what gets printed).
 Add a "--count-only" (or so?) option to "notmuch search" for returning
 the count of search results.
 
 Add a "--count-only" (or so?) option to "notmuch search" for returning
 the count of search results.
 

-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.
+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.
 
 
 Add a "-f <filename>" option to select an alternate configuration
 file.
 

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

 Allow configuration for filename patterns that should be ignored when
 indexing.
 
 Allow configuration for filename patterns that should be ignored when
 indexing.
 

+Replace the "notmuch part --part=id" command with "notmuch show
+--part=id", (David Edmonson wants to rewrite some of "notmuch show" to
+provide more MIME-structure information in its output first).
+
+Replace the "notmuch search-tags" command with "notmuch search
+--output=tags".
+

 notmuch library
 ---------------
 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
 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 enpoint be implicit. Second we'de like to support
+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.
 
 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.
 

-Add support for files that are moved or deleted (which obviously need
-to be handled differently).
+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.
 
 
 Actually compile and install a libnotmuch shared library.
 


@@ -128,71 +152,76 @@ 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).
 
 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.
 

-Think about optimizing chunked searches (max-threads > 0) to avoid
-repeating work. That would be saving state from the previous chunk and
-reusing it if the next search is the next chunk with the same search
-string.
-
-General
--------
-Audit everything for dealing with out-of-memory (and drop xutil.c).
-
-Write a test suite.
+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.)
+
+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.
+
+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 ana 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
+----------
+Start testing --format=json.

 
 Achieve 100% test coverage with the test suite.
 
 
 Achieve 100% test coverage with the test suite.
 

-Investigate why the notmuch database is slightly larger than the sup
-database for the same corpus of email.
+Modularize test suite (to be able to run individual tests).

 
 

-Xapian
-------
-Fix defect #250
+Summarize test results at the end.

 
 

-       replace_document should make minimal changes to database file
-       http://trac.xapian.org/ticket/250
+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)'"

 
 

-       It looks like it's going to be easy to fix. Here's the file to
-       change:
+Test "notmuch reply" choosing the correct email address from the
+Received header when no configured email address appears in To or Cc.

 
 

-               xapian-core/backends/flint/flint_database.cc
-
-       And look for:
-
-         // FIXME - in the case where there is overlap between the new
-         // termlist and the old termlist, it would be better to compare the
-         // two lists, and make the minimum set of modifications required.
-         // This would lead to smaller changesets for replication, and
-         // probably be faster overall
-
-       So I think this might be as easy as just walking over two
-       sorted lists looking for differences.
-
-       Note that this is in the currently default "flint" backend,
-       but the Xapian folks are probably more interested in fixing
-       the in-development "chert" backend. So the patch to get
-       upstreamed there will probably also fix:
-
-               xapian-core/backends/chert/chert_database.cc
-
-       (I'm hoping the fix will be the same---an identical comment
-       exists there.)
-
-       Also, if you want to experiment with the chert backend,
-       compile current Xapian source and run notmuch with
-       XAPIAN_PREFER_CHERT=1. I haven't tried that yet, but there are
-       claims that a chert database can be 40% smaller than an
-       equivalent flint database.
-
-Report this bug:
-
-       "tag:foo and tag:bar and -tag:deleted" goes insane
+General
+-------
+Audit everything for dealing with out-of-memory (and drop xutil.c).

 
 

-       This seems to be triggered by a Boolean operator next to a
-       token starting with a non-word character---suddenly all the
-       Boolean operators get treated as literal tokens)
+Investigate why the notmuch database is slightly larger than the sup
+database for the same corpus of email.