From: David Bremner <david@tethera.net>
Date: Mon, 27 Jun 2016 18:38:40 +0000 (+0200)
Subject: doc: forbid further operations on a closed database
X-Git-Url: http://rtime.felk.cvut.cz/gitweb/notmuch.git/commitdiff_plain/38f0d44a82d4a6584bd95f611dfb429057a37b62

doc: forbid further operations on a closed database

We could add many null pointer checks, but currently I don't see a use
case that justifies it.
---

diff --git a/lib/notmuch.h b/lib/notmuch.h
index d4a97cb8..2faa1468 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -332,7 +332,9 @@ notmuch_database_status_string (const notmuch_database_t *notmuch);
  * functions on objects derived from this database may either behave
  * as if the database had not been closed (e.g., if the required data
  * has been cached) or may fail with a
- * NOTMUCH_STATUS_XAPIAN_EXCEPTION.
+ * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
+ * permitted on the database itself is to call
+ * notmuch_database_destroy.
  *
  * notmuch_database_close can be called multiple times.  Later calls
  * have no effect.