60/a161fd065bba979774f1a3cc62c240e69be1c7

   1 Return-Path: <bremner@tethera.net>\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 DC425431FBC\r
   6         for <notmuch@notmuchmail.org>; Fri, 24 Jan 2014 19:08:03 -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 2iIo0c9793KY for <notmuch@notmuchmail.org>;\r
  16         Fri, 24 Jan 2014 19:07:57 -0800 (PST)\r
  17 Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
  18         (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
  19         (No client certificate requested)\r
  20         by olra.theworths.org (Postfix) with ESMTPS id B50D3431FB6\r
  21         for <notmuch@notmuchmail.org>; Fri, 24 Jan 2014 19:07:57 -0800 (PST)\r
  22 Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
  23         (envelope-from <bremner@tethera.net>)\r
  24         id 1W6tb7-0007Po-7Z; Fri, 24 Jan 2014 23:07:53 -0400\r
  25 Received: (nullmailer pid 15283 invoked by uid 1000); Sat, 25 Jan 2014\r
  26         03:07:47 -0000\r
  27 From: David Bremner <david@tethera.net>\r
  28 To: notmuch@notmuchmail.org\r
  29 Subject: [PATCH] lib: update documentation for notmuch_database_get_directory\r
  30 Date: Fri, 24 Jan 2014 23:07:43 -0400\r
  31 Message-Id: <1390619263-14813-1-git-send-email-david@tethera.net>\r
  32 X-Mailer: git-send-email 1.8.5.2\r
  33 In-Reply-To: <87ppngon33.fsf@zancas.localnet>\r
  34 References: <87ppngon33.fsf@zancas.localnet>\r
  35 X-BeenThere: notmuch@notmuchmail.org\r
  36 X-Mailman-Version: 2.1.13\r
  37 Precedence: list\r
  38 List-Id: "Use and development of the notmuch mail system."\r
  39         <notmuch.notmuchmail.org>\r
  40 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  41         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  42 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  43 List-Post: <mailto:notmuch@notmuchmail.org>\r
  44 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  45 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  46         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  47 X-List-Received-Date: Sat, 25 Jan 2014 03:08:04 -0000\r
  48 \r
  49 Clarify that using the directory after destroying the corresponding\r
  50 database is not permitted.\r
  51 \r
  52 This is implicit in the description of notmuch_database_destroy, but\r
  53 it doesn't hurt to be explicit, and we do express similar "ownership"\r
  54 relationships at other places in the docs.\r
  55 ---\r
  56  lib/notmuch.h | 4 ++++\r
  57  1 file changed, 4 insertions(+)\r
  58 \r
  59 diff --git a/lib/notmuch.h b/lib/notmuch.h\r
  60 index 68896ae..3df1ade 100644\r
  61 --- a/lib/notmuch.h\r
  62 +++ b/lib/notmuch.h\r
  63 @@ -415,6 +415,10 @@ notmuch_database_end_atomic (notmuch_database_t *notmuch);\r
  64   * If this directory object does not exist in the database, this\r
  65   * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.\r
  66   *\r
  67 + * Otherwise the returned directory object is owned by the database\r
  68 + * and as such, will only be valid until notmuch_database_destroy is\r
  69 + * called.\r
  70 + *\r
  71   * Return value:\r
  72   *\r
  73   * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.\r
  74 -- \r
  75 1.8.5.2\r
  76 \r