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

diff --git a/a4/bc22a9140d507907a2a420e56c31fea3ebeb40 b/a4/bc22a9140d507907a2a420e56c31fea3ebeb40
new file mode 100644 (file)
index 0000000..ec3073a
--- /dev/null
+++ b/a4/bc22a9140d507907a2a420e56c31fea3ebeb40
@@ -0,0 +1,71 @@
+Return-Path: <bremner@tesseract.cs.unb.ca>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id C6A366DE014D\r
+ for <notmuch@notmuchmail.org>; Mon, 27 Jun 2016 11:39:00 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.005\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.005 tagged_above=-999 required=5\r
+ tests=[AWL=-0.006, HEADER_FROM_DIFFERENT_DOMAINS=0.001]\r
+ autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id SOUpspIHCQFu for <notmuch@notmuchmail.org>;\r
+ Mon, 27 Jun 2016 11:38:52 -0700 (PDT)\r
+Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197])\r
+ by arlo.cworth.org (Postfix) with ESMTPS id 6D06B6DE00CC\r
+ for <notmuch@notmuchmail.org>; Mon, 27 Jun 2016 11:38:51 -0700 (PDT)\r
+Received: from remotemail by fethera.tethera.net with local (Exim 4.84)\r
+ (envelope-from <bremner@tesseract.cs.unb.ca>)\r
+ id 1bHbQV-0004zc-Gh; Mon, 27 Jun 2016 14:38:31 -0400\r
+Received: (nullmailer pid 18092 invoked by uid 1000);\r
+ Mon, 27 Jun 2016 18:38:44 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
+Subject: [PATCH] doc: forbid further operations on a closed database\r
+Date: Mon, 27 Jun 2016 20:38:40 +0200\r
+Message-Id: <1467052720-18041-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 2.8.1\r
+In-Reply-To: <87porqxmm5.fsf@tesseract.cs.unb.ca>\r
+References: <87porqxmm5.fsf@tesseract.cs.unb.ca>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch/>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Mon, 27 Jun 2016 18:39:00 -0000\r
+\r
+We could add many null pointer checks, but currently I don't see a use\r
+case that justifies it.\r
+---\r
+ lib/notmuch.h | 4 +++-\r
+ 1 file changed, 3 insertions(+), 1 deletion(-)\r
+\r
+diff --git a/lib/notmuch.h b/lib/notmuch.h\r
+index d4a97cb..2faa146 100644\r
+--- a/lib/notmuch.h\r
++++ b/lib/notmuch.h\r
+@@ -332,7 +332,9 @@ notmuch_database_status_string (const notmuch_database_t *notmuch);\r
+  * functions on objects derived from this database may either behave\r
+  * as if the database had not been closed (e.g., if the required data\r
+  * has been cached) or may fail with a\r
+- * NOTMUCH_STATUS_XAPIAN_EXCEPTION.\r
++ * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation\r
++ * permitted on the database itself is to call\r
++ * notmuch_database_destroy.\r
+  *\r
+  * notmuch_database_close can be called multiple times.  Later calls\r
+  * have no effect.\r
+-- \r
+2.8.1\r
+\r