Re: [PATCH] lib: update documentation for notmuch_database_get_directory

diff --git a/8c/f8a9f27ec3d2fcab14f06de57778c5c7e93644 b/8c/f8a9f27ec3d2fcab14f06de57778c5c7e93644
new file mode 100644 (file)
index 0000000..87c7b1d
--- /dev/null
+++ b/8c/f8a9f27ec3d2fcab14f06de57778c5c7e93644
@@ -0,0 +1,92 @@
+Return-Path: <tomi.ollila@iki.fi>\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 40378431FBD\r
+       for <notmuch@notmuchmail.org>; Sat, 25 Jan 2014 03:46:26 -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 nUYqsEpjp5ci for <notmuch@notmuchmail.org>;\r
+       Sat, 25 Jan 2014 03:46:18 -0800 (PST)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id DB2C6431FBC\r
+       for <notmuch@notmuchmail.org>; Sat, 25 Jan 2014 03:46:17 -0800 (PST)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+       by guru.guru-group.fi (Postfix) with ESMTP id 4F7F71000B3;\r
+       Sat, 25 Jan 2014 13:46:13 +0200 (EET)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH] lib: update documentation for\r
+       notmuch_database_get_directory\r
+In-Reply-To: <1390619263-14813-1-git-send-email-david@tethera.net>\r
+References: <87ppngon33.fsf@zancas.localnet>\r
+       <1390619263-14813-1-git-send-email-david@tethera.net>\r
+User-Agent: Notmuch/0.17+41~g8e7fabf (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Sat, 25 Jan 2014 13:46:13 +0200\r
+Message-ID: <m2mwikuvwa.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\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 11:46:26 -0000\r
+\r
+On Sat, Jan 25 2014, David Bremner <david@tethera.net> wrote:\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
+\r
+LGTM.\r
+\r
+Tomi\r
+\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
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r