notmuch/lib/notmuch.h, branch 0.2

Fix typo in notmuch.h documentation regarding database open modes

2010-04-13T15:39:10Z

Reviewed-by: Carl Worth : The original proposal for having different open modes used the name WRITABLE. I didn't like that name, (easy to misspell as WRITEABLE even for native English speakers). So we renamed it to READ_WRITE immediately, but apparently some of the documentation held the old name for a while.

lib: Handle "*" as a query string to match all messages.

2010-04-10T00:43:58Z

This seems like a generally useful thing to support, (but the previous support through an empty string was not convenient for some users, (such as the command-line client).

Clarify documentation of notmuch_database_add_message.

2010-03-31T20:31:10Z

For the case of adding a file that already exist, (with the same filename). In this case, nothing will happen to the database, but that wasn't clear before.

Fix a few documentation typos in notmuch.h

2010-03-09T18:32:58Z

Fix a few documentation typos in notmuch.h Signed-off-by: Fernando Carrijo

Update documentation of notmuch_query_create

2010-03-09T18:29:38Z

Commit cd467caf renamed notmuch_query_search to notmuch_query_search_messages. Commit 1ba3d46f created notmuch_query_search_threads. We better keep the docs of notmuch_query_create consistent with those changes. Signed-off-by: Fernando Carrijo Edited-by: Carl Worth to explicitly list the full name of each function being referenced.

lib: Document what move_to_next does at the end of the list.

2010-03-09T17:24:45Z

Explicitly mention that there's an invalid position after the last item in the list.

lib: Rename iterator functions to prepare for reverse iteration.

2010-03-09T17:22:29Z

We rename 'has_more' to 'valid' so that it can function whether iterating in a forward or reverse direction. We also rename 'advance' to 'move_to_next' to setup parallel naming with the proposed functions 'move_to_first', 'move_to_last', and 'move_to_previous'.

notmuch.h: Fix a couple of typos in the documentation.

2010-02-06T01:31:40Z

Obviously, the spell-checker isn't able to catch every mistake I make.

notmuch new: Print upgrade progress report as a percentage.

2010-01-10T01:38:23Z

Previously we were printing a number of messages upgraded so far. The original motivation for this was to accurately reflect the fact that there are two passes, (so each message is processed twice and it's not accurate to represent with a single count). But as it turns out, the second pass takes zero time (relatively speaking) so we're still not accounting for it. If nothing else, the percentage-based reporting makes for a cleaner API for the progress_notify function.

lib: Implement versioning in the database and provide upgrade function.

2010-01-08T02:26:31Z

The recent support for renames in the database is our first time (since notmuch has had more than a single user) that we have a database format change. To support smooth upgrades we now encode a database format version number in the Xapian metadata. Going forward notmuch will emit a warning if used to read from a database with a newer version than it natively supports, and will refuse to write to a database with a newer version. The library also provides functions to query the database format version: notmuch_database_get_version to ask if notmuch wants a newer version than that: notmuch_database_needs_upgrade and a function to actually perform that upgrade: notmuch_database_upgrade