[PATCH] lib: update documentation for notmuch_database_get_directory

diff --git a/60/a161fd065bba979774f1a3cc62c240e69be1c7 b/60/a161fd065bba979774f1a3cc62c240e69be1c7
new file mode 100644 (file)
index 0000000..d9436c3
--- /dev/null
+++ b/60/a161fd065bba979774f1a3cc62c240e69be1c7
@@ -0,0 +1,76 @@
+Return-Path: <bremner@tethera.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id DC425431FBC\r
+       for <notmuch@notmuchmail.org>; Fri, 24 Jan 2014 19:08:03 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id 2iIo0c9793KY for <notmuch@notmuchmail.org>;\r
+       Fri, 24 Jan 2014 19:07:57 -0800 (PST)\r
+Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
+       (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id B50D3431FB6\r
+       for <notmuch@notmuchmail.org>; Fri, 24 Jan 2014 19:07:57 -0800 (PST)\r
+Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1W6tb7-0007Po-7Z; Fri, 24 Jan 2014 23:07:53 -0400\r
+Received: (nullmailer pid 15283 invoked by uid 1000); Sat, 25 Jan 2014\r
+       03:07:47 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] lib: update documentation for notmuch_database_get_directory\r
+Date: Fri, 24 Jan 2014 23:07:43 -0400\r
+Message-Id: <1390619263-14813-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.8.5.2\r
+In-Reply-To: <87ppngon33.fsf@zancas.localnet>\r
+References: <87ppngon33.fsf@zancas.localnet>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://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: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 25 Jan 2014 03:08:04 -0000\r
+\r
+Clarify that using the directory after destroying the corresponding\r
+database is not permitted.\r
+\r
+This is implicit in the description of notmuch_database_destroy, but\r
+it doesn't hurt to be explicit, and we do express similar "ownership"\r
+relationships at other places in the docs.\r
+---\r
+ lib/notmuch.h | 4 ++++\r
+ 1 file changed, 4 insertions(+)\r
+\r
+diff --git a/lib/notmuch.h b/lib/notmuch.h\r
+index 68896ae..3df1ade 100644\r
+--- a/lib/notmuch.h\r
++++ b/lib/notmuch.h\r
+@@ -415,6 +415,10 @@ notmuch_database_end_atomic (notmuch_database_t *notmuch);\r
+  * If this directory object does not exist in the database, this\r
+  * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.\r
+  *\r
++ * Otherwise the returned directory object is owned by the database\r
++ * and as such, will only be valid until notmuch_database_destroy is\r
++ * called.\r
++ *\r
+  * Return value:\r
+  *\r
+  * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.\r
+-- \r
+1.8.5.2\r
+\r