From: Tomi Ollila <tomi.ollila@iki.fi>
Date: Sat, 25 Jan 2014 11:46:13 +0000 (+0200)
Subject: Re: [PATCH] lib: update documentation for notmuch_database_get_directory
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=4d852f7c507ea1237ef5e398f8df9e1678738f10;p=notmuch-archives.git

Re: [PATCH] lib: update documentation for notmuch_database_get_directory
---

diff --git a/8c/f8a9f27ec3d2fcab14f06de57778c5c7e93644 b/8c/f8a9f27ec3d2fcab14f06de57778c5c7e93644
new file mode 100644
index 000000000..87c7b1d34
--- /dev/null
+++ b/8c/f8a9f27ec3d2fcab14f06de57778c5c7e93644
@@ -0,0 +1,92 @@
+Return-Path: <tomi.ollila@iki.fi>
+X-Original-To: notmuch@notmuchmail.org
+Delivered-To: notmuch@notmuchmail.org
+Received: from localhost (localhost [127.0.0.1])
+	by olra.theworths.org (Postfix) with ESMTP id 40378431FBD
+	for <notmuch@notmuchmail.org>; Sat, 25 Jan 2014 03:46:26 -0800 (PST)
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
+X-Spam-Flag: NO
+X-Spam-Score: 0
+X-Spam-Level: 
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]
+	autolearn=disabled
+Received: from olra.theworths.org ([127.0.0.1])
+	by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
+	with ESMTP id nUYqsEpjp5ci for <notmuch@notmuchmail.org>;
+	Sat, 25 Jan 2014 03:46:18 -0800 (PST)
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])
+	by olra.theworths.org (Postfix) with ESMTP id DB2C6431FBC
+	for <notmuch@notmuchmail.org>; Sat, 25 Jan 2014 03:46:17 -0800 (PST)
+Received: from guru.guru-group.fi (localhost [IPv6:::1])
+	by guru.guru-group.fi (Postfix) with ESMTP id 4F7F71000B3;
+	Sat, 25 Jan 2014 13:46:13 +0200 (EET)
+From: Tomi Ollila <tomi.ollila@iki.fi>
+To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
+Subject: Re: [PATCH] lib: update documentation for
+	notmuch_database_get_directory
+In-Reply-To: <1390619263-14813-1-git-send-email-david@tethera.net>
+References: <87ppngon33.fsf@zancas.localnet>
+	<1390619263-14813-1-git-send-email-david@tethera.net>
+User-Agent: Notmuch/0.17+41~g8e7fabf (http://notmuchmail.org) Emacs/24.3.1
+	(x86_64-unknown-linux-gnu)
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL
+	$[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F
+	!)g;OY^,BjTbr)Np:%c_o'jj,Z
+Date: Sat, 25 Jan 2014 13:46:13 +0200
+Message-ID: <m2mwikuvwa.fsf@guru.guru-group.fi>
+MIME-Version: 1.0
+Content-Type: text/plain
+X-BeenThere: notmuch@notmuchmail.org
+X-Mailman-Version: 2.1.13
+Precedence: list
+List-Id: "Use and development of the notmuch mail system."
+	<notmuch.notmuchmail.org>
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
+	<mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>
+List-Post: <mailto:notmuch@notmuchmail.org>
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
+	<mailto:notmuch-request@notmuchmail.org?subject=subscribe>
+X-List-Received-Date: Sat, 25 Jan 2014 11:46:26 -0000
+
+On Sat, Jan 25 2014, David Bremner <david@tethera.net> wrote:
+
+> Clarify that using the directory after destroying the corresponding
+> database is not permitted.
+>
+> This is implicit in the description of notmuch_database_destroy, but
+> it doesn't hurt to be explicit, and we do express similar "ownership"
+> relationships at other places in the docs.
+> ---
+
+LGTM.
+
+Tomi
+
+
+>  lib/notmuch.h | 4 ++++
+>  1 file changed, 4 insertions(+)
+>
+> diff --git a/lib/notmuch.h b/lib/notmuch.h
+> index 68896ae..3df1ade 100644
+> --- a/lib/notmuch.h
+> +++ b/lib/notmuch.h
+> @@ -415,6 +415,10 @@ notmuch_database_end_atomic (notmuch_database_t *notmuch);
+>   * If this directory object does not exist in the database, this
+>   * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
+>   *
+> + * Otherwise the returned directory object is owned by the database
+> + * and as such, will only be valid until notmuch_database_destroy is
+> + * called.
+> + *
+>   * Return value:
+>   *
+>   * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
+> -- 
+> 1.8.5.2
+>
+> _______________________________________________
+> notmuch mailing list
+> notmuch@notmuchmail.org
+> http://notmuchmail.org/mailman/listinfo/notmuch