[PATCH] doc: forbid further operations on a closed database

Subject: [PATCH] doc: forbid further operations on a closed database

Date: Mon, 27 Jun 2016 20:38:40 +0200

To: David Bremner, notmuch@notmuchmail.org

Cc:

From: David Bremner


We could add many null pointer checks, but currently I don't see a use
case that justifies it.
---
 lib/notmuch.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/lib/notmuch.h b/lib/notmuch.h
index d4a97cb..2faa146 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.
-- 
2.8.1


Thread: