Re: Filesystem functionality used by notmuch
[notmuch-archives.git] / 8c / f8a9f27ec3d2fcab14f06de57778c5c7e93644
1 Return-Path: <tomi.ollila@iki.fi>\r
2 X-Original-To: notmuch@notmuchmail.org\r
3 Delivered-To: notmuch@notmuchmail.org\r
4 Received: from localhost (localhost [127.0.0.1])\r
5         by olra.theworths.org (Postfix) with ESMTP id 40378431FBD\r
6         for <notmuch@notmuchmail.org>; Sat, 25 Jan 2014 03:46:26 -0800 (PST)\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
8 X-Spam-Flag: NO\r
9 X-Spam-Score: 0\r
10 X-Spam-Level: \r
11 X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
12         autolearn=disabled\r
13 Received: from olra.theworths.org ([127.0.0.1])\r
14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
15         with ESMTP id nUYqsEpjp5ci for <notmuch@notmuchmail.org>;\r
16         Sat, 25 Jan 2014 03:46:18 -0800 (PST)\r
17 Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
18         by olra.theworths.org (Postfix) with ESMTP id DB2C6431FBC\r
19         for <notmuch@notmuchmail.org>; Sat, 25 Jan 2014 03:46:17 -0800 (PST)\r
20 Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
21         by guru.guru-group.fi (Postfix) with ESMTP id 4F7F71000B3;\r
22         Sat, 25 Jan 2014 13:46:13 +0200 (EET)\r
23 From: Tomi Ollila <tomi.ollila@iki.fi>\r
24 To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
25 Subject: Re: [PATCH] lib: update documentation for\r
26         notmuch_database_get_directory\r
27 In-Reply-To: <1390619263-14813-1-git-send-email-david@tethera.net>\r
28 References: <87ppngon33.fsf@zancas.localnet>\r
29         <1390619263-14813-1-git-send-email-david@tethera.net>\r
30 User-Agent: Notmuch/0.17+41~g8e7fabf (http://notmuchmail.org) Emacs/24.3.1\r
31         (x86_64-unknown-linux-gnu)\r
32 X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
33         $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
34         !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
35 Date: Sat, 25 Jan 2014 13:46:13 +0200\r
36 Message-ID: <m2mwikuvwa.fsf@guru.guru-group.fi>\r
37 MIME-Version: 1.0\r
38 Content-Type: text/plain\r
39 X-BeenThere: notmuch@notmuchmail.org\r
40 X-Mailman-Version: 2.1.13\r
41 Precedence: list\r
42 List-Id: "Use and development of the notmuch mail system."\r
43         <notmuch.notmuchmail.org>\r
44 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
45         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
46 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
47 List-Post: <mailto:notmuch@notmuchmail.org>\r
48 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
49 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
50         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
51 X-List-Received-Date: Sat, 25 Jan 2014 11:46:26 -0000\r
52 \r
53 On Sat, Jan 25 2014, David Bremner <david@tethera.net> wrote:\r
54 \r
55 > Clarify that using the directory after destroying the corresponding\r
56 > database is not permitted.\r
57 >\r
58 > This is implicit in the description of notmuch_database_destroy, but\r
59 > it doesn't hurt to be explicit, and we do express similar "ownership"\r
60 > relationships at other places in the docs.\r
61 > ---\r
62 \r
63 LGTM.\r
64 \r
65 Tomi\r
66 \r
67 \r
68 >  lib/notmuch.h | 4 ++++\r
69 >  1 file changed, 4 insertions(+)\r
70 >\r
71 > diff --git a/lib/notmuch.h b/lib/notmuch.h\r
72 > index 68896ae..3df1ade 100644\r
73 > --- a/lib/notmuch.h\r
74 > +++ b/lib/notmuch.h\r
75 > @@ -415,6 +415,10 @@ notmuch_database_end_atomic (notmuch_database_t *notmuch);\r
76 >   * If this directory object does not exist in the database, this\r
77 >   * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.\r
78 >   *\r
79 > + * Otherwise the returned directory object is owned by the database\r
80 > + * and as such, will only be valid until notmuch_database_destroy is\r
81 > + * called.\r
82 > + *\r
83 >   * Return value:\r
84 >   *\r
85 >   * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.\r
86 > -- \r
87 > 1.8.5.2\r
88 >\r
89 > _______________________________________________\r
90 > notmuch mailing list\r
91 > notmuch@notmuchmail.org\r
92 > http://notmuchmail.org/mailman/listinfo/notmuch\r