notmuch/lib/notmuch.h, branch 0.17

lib: Bump library version from 3.0.0 to 3.1.0

2013-12-07T02:31:19Z

This version of the library introduces LIBNOTMUCH_CHECK_VERSION and the *_VERSION macros. Bumping the version number is also necessary to make the comment on LIBNOTMUCH_CHECK_VERSION no longer a lie.

lib: Replace NOTMUCH__VERSION with LIBNOTMUCH__VERSION

2013-12-07T02:31:11Z

This makes it clear that these macros refer to the *library* version, and not to the notmuch application-level release. Since there are no consumers of these macros yet, this is now or never.

lib: Make VERSION macros agree with soname version

2013-12-07T02:31:04Z

We have two distinct "library version" numbers: the soname version and the version macros. We need both for different reasons: the version macros enable easy compile-time version detection (and conditional compilation), while the soname version enables runtime version detection (which includes the version checking done by things like the Python bindings). However, currently, these two version numbers are different, which is unnecessary and can lead to confusion (especially in things like Debian, which include the soname version in the package name). This patch makes them the same by bumping the version macros up to agree with the soname version. (We should probably keep the version number in just one place so they can't get out of sync, but that can be done in another patch.)

lib: Document extent of some return values

2013-11-09T00:14:08Z

This documents the extent of the notmuch_messages_t* pointers returned by notmuch_thread_get_toplevel_messages and notmuch_thread_get_messages.

lib: add library version check macro

2013-11-07T23:15:06Z

There have been some plans for making build incompatible changes to the library API. This is inconvenient, but it is much more so without a way to easily conditional build against multiple versions of notmuch. The macro has been lifted from glib.

lib: update documentation of callback functions for database_compact and database_upgrade.

2013-11-07T10:50:50Z

Compact was missing callback documentation entirely, and upgrade did not discuss the closure parameter.

lib: add closure parameter to compact status update callback

2013-11-07T10:46:42Z

This provides much more flexibility for the caller.

database: Add notmuch_database_compact_close

2013-10-10T00:46:49Z

This function uses Xapian's Compactor machinery to compact the notmuch database. The compacted database is built in a temporary directory and later moved into place while the original uncompacted database is preserved. Signed-off-by: Ben Gamari

lib: Document which strings are returned in UTF-8

2013-08-13T15:43:34Z

Any string that ultimately comes from notmuch_message_file_get_header is in UTF-8.

lib: Correct out-of-date doc comment

2013-08-13T15:43:07Z

notmuch_message_get_header started returning some headers straight from the database in 567bcbc, but this comment explicitly claimed all headers were read from the message file.