From b3df357fb0be454311b1b95e679b6e5b5c16112d Mon Sep 17 00:00:00 2001 From: Austin Clements Date: Fri, 25 Oct 2013 11:19:03 +2000 Subject: [PATCH] [PATCH v2 03/11] lib: Document extent of some return values --- 03/cceda4830a5662eda2388535326c08fa09377c | 103 ++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 03/cceda4830a5662eda2388535326c08fa09377c diff --git a/03/cceda4830a5662eda2388535326c08fa09377c b/03/cceda4830a5662eda2388535326c08fa09377c new file mode 100644 index 000000000..e499ead93 --- /dev/null +++ b/03/cceda4830a5662eda2388535326c08fa09377c @@ -0,0 +1,103 @@ +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 DC16D421161 + for ; Thu, 24 Oct 2013 08:19:33 -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 Do3b0VRLGNqs for ; + Thu, 24 Oct 2013 08:19:29 -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 92FB5429E47 + for ; Thu, 24 Oct 2013 08:19:22 -0700 (PDT) +X-AuditID: 12074425-b7f1c8e0000009c7-05-52693a7af5ad +Received: from mailhub-auth-1.mit.edu ( [18.9.21.35]) + by dmz-mailsec-scanner-8.mit.edu (Symantec Messaging Gateway) with SMTP + id F9.31.02503.A7A39625; Thu, 24 Oct 2013 11:19:22 -0400 (EDT) +Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) + by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id r9OFJF9p012678; + Thu, 24 Oct 2013 11:19:15 -0400 +Received: from drake.dyndns.org + (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com + [216.15.114.40]) (authenticated bits=0) + (User authenticated as amdragon@ATHENA.MIT.EDU) + by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r9OFJC53012911 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Thu, 24 Oct 2013 11:19:14 -0400 +Received: from amthrax by drake.dyndns.org with local (Exim 4.77) + (envelope-from ) + id 1VZMgq-0006dn-Na; Thu, 24 Oct 2013 11:19:12 -0400 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH v2 03/11] lib: Document extent of some return values +Date: Thu, 24 Oct 2013 11:19:03 -0400 +Message-Id: <1382627951-25252-4-git-send-email-amdragon@mit.edu> +X-Mailer: git-send-email 1.8.4.rc3 +In-Reply-To: <1382627951-25252-1-git-send-email-amdragon@mit.edu> +References: <1382627951-25252-1-git-send-email-amdragon@mit.edu> +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFjrKIsWRmVeSWpSXmKPExsUixCmqrFtllRlkcH2TpEXTdGeL1XN5LK7f + nMnswOyxc9Zddo9b91+zezxbdYs5gDmKyyYlNSezLLVI3y6BK6Nz7ySWgvUcFcdaF7I1MH5g + 62Lk5JAQMJH49P8AlC0mceHeeiCbi0NIYB+jRNsBGGcjo8StqwvZIZw7TBK/L29ihXDmMkqc + nPAdrJ9NQENi2/7ljCC2iIC0xM67s1lBbGaBaIkjl2cA1XBwCAu4SEz6XgcSZhFQlVjTcpMZ + xOYVcJC48ew71BlKEgtPbQNr5RRwlPj5+hrYSCGgml+/z7BMYORfwMiwilE2JbdKNzcxM6c4 + NVm3ODkxLy+1SNdCLzezRC81pXQTIyi02F1UdzBOOKR0iFGAg1GJh7fhU3qQEGtiWXFl7iFG + SQ4mJVHee6aZQUJ8SfkplRmJxRnxRaU5qcWHGCU4mJVEeKfpAeV4UxIrq1KL8mFS0hwsSuK8 + tzjsg4QE0hNLUrNTUwtSi2CyMhwcShK8/yyBGgWLUtNTK9Iyc0oQ0kwcnCDDeYCG3wOp4S0u + SMwtzkyHyJ9iVJQS5+UFRq+QAEgiozQPrhcW+68YxYFeEeb9ANLOA0wbcN2vgAYzAQ2esiQN + ZHBJIkJKqoGR79fzkhs7eqWlL6aFJ9/fPnX3fc4M/0Ltn8mv3XfG1zYVs8nkBau9+BYim1e6 + 6YryYrHNocEPl6wq/+OVefU/X7f+7lzB0t3vNj33XuYacvjZ2i1brsTq3er0aHEMOOz5Were + Qaag5hTm40Xbb0qkdS+cP++tRTSb6+ynn/uW3w2IfBh9dssdJZbijERDLeai4kQAPmBYZtgC AAA= +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: Thu, 24 Oct 2013 15:19:34 -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 9dab555..0fb7121 100644 +--- a/lib/notmuch.h ++++ b/lib/notmuch.h +@@ -765,12 +765,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 + -- 2.26.2