From: David Bremner Date: Sat, 25 Jan 2014 03:07:43 +0000 (+2000) Subject: [PATCH] lib: update documentation for notmuch_database_get_directory X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=d877478171218874f77266f98fce29bdbd7ff961;p=notmuch-archives.git [PATCH] lib: update documentation for notmuch_database_get_directory --- diff --git a/60/a161fd065bba979774f1a3cc62c240e69be1c7 b/60/a161fd065bba979774f1a3cc62c240e69be1c7 new file mode 100644 index 000000000..d9436c3e5 --- /dev/null +++ b/60/a161fd065bba979774f1a3cc62c240e69be1c7 @@ -0,0 +1,76 @@ +Return-Path: +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 DC425431FBC + for ; Fri, 24 Jan 2014 19:08:03 -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 2iIo0c9793KY for ; + Fri, 24 Jan 2014 19:07:57 -0800 (PST) +Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155]) + (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id B50D3431FB6 + for ; Fri, 24 Jan 2014 19:07:57 -0800 (PST) +Received: from remotemail by yantan.tethera.net with local (Exim 4.80) + (envelope-from ) + id 1W6tb7-0007Po-7Z; Fri, 24 Jan 2014 23:07:53 -0400 +Received: (nullmailer pid 15283 invoked by uid 1000); Sat, 25 Jan 2014 + 03:07:47 -0000 +From: David Bremner +To: notmuch@notmuchmail.org +Subject: [PATCH] lib: update documentation for notmuch_database_get_directory +Date: Fri, 24 Jan 2014 23:07:43 -0400 +Message-Id: <1390619263-14813-1-git-send-email-david@tethera.net> +X-Mailer: git-send-email 1.8.5.2 +In-Reply-To: <87ppngon33.fsf@zancas.localnet> +References: <87ppngon33.fsf@zancas.localnet> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sat, 25 Jan 2014 03:08:04 -0000 + +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. +--- + 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 +