44/93e231ab83ba62825a7d5698edf781b34d4bb5

   1 Return-Path: <amdragon@mit.edu>\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 474D2431FAF\r
   6         for <notmuch@notmuchmail.org>; Mon,  7 Oct 2013 15:34:08 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -0.7\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
  12         tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 onFgapJpdosg for <notmuch@notmuchmail.org>;\r
  16         Mon,  7 Oct 2013 15:34:04 -0700 (PDT)\r
  17 Received: from dmz-mailsec-scanner-8.mit.edu (dmz-mailsec-scanner-8.mit.edu\r
  18         [18.7.68.37])\r
  19         by olra.theworths.org (Postfix) with ESMTP id 62412431FD7\r
  20         for <notmuch@notmuchmail.org>; Mon,  7 Oct 2013 15:33:37 -0700 (PDT)\r
  21 X-AuditID: 12074425-b7f1c8e0000009c7-2e-525336c054ba\r
  22 Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
  23         by dmz-mailsec-scanner-8.mit.edu (Symantec Messaging Gateway) with SMTP\r
  24         id 2B.58.02503.0C633525; Mon,  7 Oct 2013 18:33:36 -0400 (EDT)\r
  25 Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
  26         by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id r97MXQ29024734; \r
  27         Mon, 7 Oct 2013 18:33:26 -0400\r
  28 Received: from drake.dyndns.org (26-4-172.dynamic.csail.mit.edu [18.26.4.172])\r
  29         (authenticated bits=0)\r
  30         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
  31         by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r97MXNuF028500\r
  32         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
  33         Mon, 7 Oct 2013 18:33:25 -0400\r
  34 Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
  35         (envelope-from <amdragon@mit.edu>)\r
  36         id 1VTJMh-0006bl-KC; Mon, 07 Oct 2013 18:33:23 -0400\r
  37 From: Austin Clements <amdragon@MIT.EDU>\r
  38 To: notmuch@notmuchmail.org\r
  39 Subject: [PATCH 03/11] lib: Document extent of some return values\r
  40 Date: Mon,  7 Oct 2013 18:33:13 -0400\r
  41 Message-Id: <1381185201-25197-4-git-send-email-amdragon@mit.edu>\r
  42 X-Mailer: git-send-email 1.8.4.rc3\r
  43 In-Reply-To: <1381185201-25197-1-git-send-email-amdragon@mit.edu>\r
  44 References: <1381185201-25197-1-git-send-email-amdragon@mit.edu>\r
  45 X-Brightmail-Tracker:\r
  46  H4sIAAAAAAAAA+NgFtrMIsWRmVeSWpSXmKPExsUixG6nrnvALDjIYN5MG4vrN2cyOzB6PFt1\r
  47         izmAMYrLJiU1J7MstUjfLoEr48a9W2wF6zkqZqx4w9jA+IGti5GTQ0LARKK1+wgrhC0mceHe\r
  48         eqA4F4eQwD5GiWNnrrJDOBsYJRo/H2WEcA4zSXyf8ogZwpnLKPF//2dGkH42AQ2JbfuXg9ki\r
  49         AtISO+/OBprLwcEsoCbxp0sFJCws4Cix7/x6JhCbRUBV4uTp3+wgNq+Ag8TJheuhTlKSWHhq\r
  50         G9hJnED1SzZeBIsLAdXM3b+IdQIj/wJGhlWMsim5Vbq5iZk5xanJusXJiXl5qUW6Fnq5mSV6\r
  51         qSmlmxjBYeOiuoNxwiGlQ4wCHIxKPLwZR4OChFgTy4orcw8xSnIwKYnyPjAODhLiS8pPqcxI\r
  52         LM6ILyrNSS0+xCjBwawkwitgBJTjTUmsrEotyodJSXOwKInz3uKwDxISSE8sSc1OTS1ILYLJ\r
  53         ynBwKEnw3jEBahQsSk1PrUjLzClBSDNxcIIM5wEavgakhre4IDG3ODMdIn+KUVFKnPcjSEIA\r
  54         JJFRmgfXC4vrV4ziQK8I87KYAlXxAFMCXPcroMFMQIN12QNBBpckIqSkGhi5i7oP9W625fT+\r
  55         Hrf4D5/t0T5Z7fN8fpN+W+85yvKi+8pTb3uOQrt/Wzpbd297EXavZ6rw6ST3ybOjOcu2ZJz5\r
  56         wC+58YbCFalbW04e/lNWfJPjTbUvK9evykqHoCDrr/aHBdw5t51umOdT6rxkoSxfokjw8cYn\r
  57         OQIbpD0e7ui3Pcdsd3qqir8SS3FGoqEWc1FxIgDoEq/AxgIAAA==\r
  58 X-BeenThere: notmuch@notmuchmail.org\r
  59 X-Mailman-Version: 2.1.13\r
  60 Precedence: list\r
  61 List-Id: "Use and development of the notmuch mail system."\r
  62         <notmuch.notmuchmail.org>\r
  63 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  64         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  65 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  66 List-Post: <mailto:notmuch@notmuchmail.org>\r
  67 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  68 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  69         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  70 X-List-Received-Date: Mon, 07 Oct 2013 22:34:09 -0000\r
  71 \r
  72 This documents the extent of the notmuch_messages_t* pointers returned\r
  73 by notmuch_thread_get_toplevel_messages and\r
  74 notmuch_thread_get_messages.\r
  75 ---\r
  76  lib/notmuch.h | 4 ++++\r
  77  1 file changed, 4 insertions(+)\r
  78 \r
  79 diff --git a/lib/notmuch.h b/lib/notmuch.h\r
  80 index 998a4ae..217bf46 100644\r
  81 --- a/lib/notmuch.h\r
  82 +++ b/lib/notmuch.h\r
  83 @@ -746,12 +746,16 @@ notmuch_thread_get_total_messages (notmuch_thread_t *thread);\r
  84   * This iterator will not necessarily iterate over all of the messages\r
  85   * in the thread. It will only iterate over the messages in the thread\r
  86   * which are not replies to other messages in the thread.\r
  87 + *\r
  88 + * The returned list will be destroyed when the thread is destroyed.\r
  89   */\r
  90  notmuch_messages_t *\r
  91  notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);\r
  92  \r
  93  /* Get a notmuch_thread_t iterator for all messages in 'thread' in\r
  94   * oldest-first order.\r
  95 + *\r
  96 + * The returned list will be destroyed when the thread is destroyed.\r
  97   */\r
  98  notmuch_messages_t *\r
  99  notmuch_thread_get_messages (notmuch_thread_t *thread);\r
 100 -- \r
 101 1.8.4.rc3\r
 102 \r