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