debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-21 18:38:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

lib: update transaction documentation

Browse source 
Partly this is to recognize the semantics we inherit from Xapian,
partly to mention the new autocommit feature.
This commit is contained in:
David Bremner 2021-05-22 08:07:17 -03:00
parent 42b5cb53ef
commit 6e7365fb20
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
lib/notmuch.h
View file

@ -529,11 +529,11 @@ notmuch_database_status_string (const notmuch_database_t *notmuch);
* have no effect. * have no effect.
* *
* For writable databases, notmuch_database_close commits all changes * For writable databases, notmuch_database_close commits all changes
* to disk before closing the database. If the caller is currently in * to disk before closing the database, unless the caller is currently
* an atomic section (there was a notmuch_database_begin_atomic * in an atomic section (there was a notmuch_database_begin_atomic
* without a matching notmuch_database_end_atomic), this will discard * without a matching notmuch_database_end_atomic). In this case
* changes made in that atomic section (but still commit changes made * changes since the last commit are discarded. @see
* prior to entering the atomic section). * 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:
* *