From 6e7365fb2033d59d4040d20c1d05c0e652dfcc7b Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sat, 22 May 2021 08:07:17 -0300 Subject: [PATCH] lib: update transaction documentation Partly this is to recognize the semantics we inherit from Xapian, partly to mention the new autocommit feature. --- lib/notmuch.h | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/lib/notmuch.h b/lib/notmuch.h index 5c3be342..3b28bea3 100644 --- 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 - * 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: * @@ -670,7 +670,10 @@ notmuch_status_t 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: * -- 2.43.0