[PATCH 03/11] lib: Document extent of some return values

diff --git a/44/93e231ab83ba62825a7d5698edf781b34d4bb5 b/44/93e231ab83ba62825a7d5698edf781b34d4bb5
new file mode 100644 (file)
index 0000000..2b33a2d
--- /dev/null
+++ b/44/93e231ab83ba62825a7d5698edf781b34d4bb5
@@ -0,0 +1,102 @@
+Return-Path: <amdragon@mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 474D2431FAF\r
+       for <notmuch@notmuchmail.org>; Mon,  7 Oct 2013 15:34:08 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id onFgapJpdosg for <notmuch@notmuchmail.org>;\r
+       Mon,  7 Oct 2013 15:34:04 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-8.mit.edu (dmz-mailsec-scanner-8.mit.edu\r
+       [18.7.68.37])\r
+       by olra.theworths.org (Postfix) with ESMTP id 62412431FD7\r
+       for <notmuch@notmuchmail.org>; Mon,  7 Oct 2013 15:33:37 -0700 (PDT)\r
+X-AuditID: 12074425-b7f1c8e0000009c7-2e-525336c054ba\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+       by dmz-mailsec-scanner-8.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 2B.58.02503.0C633525; Mon,  7 Oct 2013 18:33:36 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id r97MXQ29024734; \r
+       Mon, 7 Oct 2013 18:33:26 -0400\r
+Received: from drake.dyndns.org (26-4-172.dynamic.csail.mit.edu [18.26.4.172])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r97MXNuF028500\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Mon, 7 Oct 2013 18:33:25 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1VTJMh-0006bl-KC; Mon, 07 Oct 2013 18:33:23 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 03/11] lib: Document extent of some return values\r
+Date: Mon,  7 Oct 2013 18:33:13 -0400\r
+Message-Id: <1381185201-25197-4-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.8.4.rc3\r
+In-Reply-To: <1381185201-25197-1-git-send-email-amdragon@mit.edu>\r
+References: <1381185201-25197-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrMIsWRmVeSWpSXmKPExsUixG6nrnvALDjIYN5MG4vrN2cyOzB6PFt1\r
+       izmAMYrLJiU1J7MstUjfLoEr48a9W2wF6zkqZqx4w9jA+IGti5GTQ0LARKK1+wgrhC0mceHe\r
+       eqA4F4eQwD5GiWNnrrJDOBsYJRo/H2WEcA4zSXyf8ogZwpnLKPF//2dGkH42AQ2JbfuXg9ki\r
+       AtISO+/OBprLwcEsoCbxp0sFJCws4Cix7/x6JhCbRUBV4uTp3+wgNq+Ag8TJheuhTlKSWHhq\r
+       G9hJnED1SzZeBIsLAdXM3b+IdQIj/wJGhlWMsim5Vbq5iZk5xanJusXJiXl5qUW6Fnq5mSV6\r
+       qSmlmxjBYeOiuoNxwiGlQ4wCHIxKPLwZR4OChFgTy4orcw8xSnIwKYnyPjAODhLiS8pPqcxI\r
+       LM6ILyrNSS0+xCjBwawkwitgBJTjTUmsrEotyodJSXOwKInz3uKwDxISSE8sSc1OTS1ILYLJ\r
+       ynBwKEnw3jEBahQsSk1PrUjLzClBSDNxcIIM5wEavgakhre4IDG3ODMdIn+KUVFKnPcjSEIA\r
+       JJFRmgfXC4vrV4ziQK8I87KYAlXxAFMCXPcroMFMQIN12QNBBpckIqSkGhi5i7oP9W625fT+\r
+       Hrf4D5/t0T5Z7fN8fpN+W+85yvKi+8pTb3uOQrt/Wzpbd297EXavZ6rw6ST3ybOjOcu2ZJz5\r
+       wC+58YbCFalbW04e/lNWfJPjTbUvK9evykqHoCDrr/aHBdw5t51umOdT6rxkoSxfokjw8cYn\r
+       OQIbpD0e7ui3Pcdsd3qqir8SS3FGoqEWc1FxIgDoEq/AxgIAAA==\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Mon, 07 Oct 2013 22:34:09 -0000\r
+\r
+This documents the extent of the notmuch_messages_t* pointers returned\r
+by notmuch_thread_get_toplevel_messages and\r
+notmuch_thread_get_messages.\r
+---\r
+ lib/notmuch.h | 4 ++++\r
+ 1 file changed, 4 insertions(+)\r
+\r
+diff --git a/lib/notmuch.h b/lib/notmuch.h\r
+index 998a4ae..217bf46 100644\r
+--- a/lib/notmuch.h\r
++++ b/lib/notmuch.h\r
+@@ -746,12 +746,16 @@ notmuch_thread_get_total_messages (notmuch_thread_t *thread);\r
+  * This iterator will not necessarily iterate over all of the messages\r
+  * in the thread. It will only iterate over the messages in the thread\r
+  * which are not replies to other messages in the thread.\r
++ *\r
++ * The returned list will be destroyed when the thread is destroyed.\r
+  */\r
+ notmuch_messages_t *\r
+ notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);\r
+ \r
+ /* Get a notmuch_thread_t iterator for all messages in 'thread' in\r
+  * oldest-first order.\r
++ *\r
++ * The returned list will be destroyed when the thread is destroyed.\r
+  */\r
+ notmuch_messages_t *\r
+ notmuch_thread_get_messages (notmuch_thread_t *thread);\r
+-- \r
+1.8.4.rc3\r
+\r