From: David Bremner <david@tethera.net>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: [PATCH] lib: update transaction documentation
Date: Sat, 22 May 2021 08:10:26 -0300 [thread overview]
Message-ID: <20210522111026.1481127-1-david@tethera.net> (raw)
In-Reply-To: <20210522012040.1412467-6-david@tethera.net>
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.30.2
next prev parent reply other threads:[~2021-05-22 11:10 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-22 1:20 Commit after some number of transactions David Bremner
2021-05-22 1:20 ` [PATCH 1/5] database/close: remove misleading code / comment David Bremner
2021-05-22 1:20 ` [PATCH 2/5] lib/config: add NOTMUCH_CONFIG_AUTOCOMMIT David Bremner
2021-05-22 1:20 ` [PATCH 3/5] test: add known broken test for closing with open transaction David Bremner
2021-05-22 1:20 ` [PATCH 4/5] lib: autocommit after some number of completed transactions David Bremner
2021-05-22 1:20 ` [PATCH 5/5] doc: document database.autocommit variable David Bremner
2021-05-22 11:10 ` David Bremner [this message]
2021-05-24 17:14 ` Commit after some number of transactions David Bremner
2021-06-27 17:11 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210522111026.1481127-1-david@tethera.net \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).