lib: update transaction documentation

Partly this is to recognize the semantics we inherit from Xapian,
partly to mention the new autocommit feature.

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 5c3be342700fddc8570e30f02f6e7bf99c45d5a4..3b28bea343bc9c329fc00ea3972d671a0cecde9a 100644 (file)
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -529,11 +529,11 @@ notmuch_database_status_string (const notmuch_database_t *notmuch);
  * have no effect.
  *
  * For writable databases, notmuch_database_close commits all changes
  * have no effect.
  *
  * For writable databases, notmuch_database_close commits all changes

- * to disk before closing the database.  If the caller is currently in
- * an atomic section (there was a notmuch_database_begin_atomic
- * without a matching notmuch_database_end_atomic), this will discard
- * changes made in that atomic section (but still commit changes made
- * prior to entering the atomic section).
+ * to disk before closing the database, unless the caller is currently
+ * in an atomic section (there was a notmuch_database_begin_atomic
+ * without a matching notmuch_database_end_atomic). In this case
+ * changes since the last commit are discarded. @see
+ * notmuch_database_end_atomic for more information.

  *
  * Return value:
  *
  *
  * Return value:
  *


@@ -670,7 +670,10 @@ notmuch_status_t
 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
 
 /**
 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
 
 /**

- * Indicate the end of an atomic database operation.
+ * Indicate the end of an atomic database operation.  If repeated
+ * (with matching notmuch_database_begin_atomic) "database.autocommit"
+ * times, commit the the transaction and all previous (non-cancelled)
+ * transactions to the database.

  *
  * Return value:
  *
  *
  * Return value:
  *