Re: api-doc: return status for notmuch_query_search_threads_st ...

diff --git a/f8/84049f28ce0070be7a192f40015453bfb3b0d0 b/f8/84049f28ce0070be7a192f40015453bfb3b0d0
new file mode 100644 (file)
index 0000000..c41c187
--- /dev/null
+++ b/f8/84049f28ce0070be7a192f40015453bfb3b0d0
@@ -0,0 +1,112 @@
+Return-Path: <eg@gaute.vetsj.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 609806DE0A94\r
+ for <notmuch@notmuchmail.org>; Sun,  7 Feb 2016 02:14:15 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.29\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.29 tagged_above=-999 required=5 tests=[AWL=0.411, \r
+ DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_LOW=-0.7,\r
+ RCVD_IN_MSPIKE_H2=-0.001] autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id nGB4_PZqv8DL for <notmuch@notmuchmail.org>;\r
+ Sun,  7 Feb 2016 02:14:13 -0800 (PST)\r
+Received: from mail-lb0-f176.google.com (mail-lb0-f176.google.com\r
+ [209.85.217.176])\r
+ by arlo.cworth.org (Postfix) with ESMTPS id E36CC6DE0A7F\r
+ for <notmuch@notmuchmail.org>; Sun,  7 Feb 2016 02:14:12 -0800 (PST)\r
+Received: by mail-lb0-f176.google.com with SMTP id x4so70878959lbm.0\r
+ for <notmuch@notmuchmail.org>; Sun, 07 Feb 2016 02:14:12 -0800 (PST)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+ d=gaute-vetsj-com.20150623.gappssmtp.com; s=20150623;\r
+ h=date:from:subject:to:references:in-reply-to:user-agent:message-id\r
+ :mime-version:content-type:content-transfer-encoding;\r
+ bh=iNvc3N3dRxG0otTg9KxrxGHz8AyQ1izys++x1tSgm3s=;\r
+ b=P4BmMxuFUHnEcgum40eiSidvG/Qm4mr/HCwqGpBS2ZtxheL3qfGy5YOA3F38LJcJbX\r
+ zNIEtE13aGILh/V53gHmlhyH6QP88mMxl5o1gHwsXU+1aMJPKz8Qm4PKKncUOdk405mF\r
+ uNvcYv42B1sVz8YpCKpjg0GK9OuRQJd7VK1l2LOYbAaCBwZl09bB33GJg4ynaUXKt1xE\r
+ E4go1/29n31BKl5U1e7jAzv1VLS2Cf5LuPxBC5Zs0PH6WkJYI5zh6aK1B9eelwhco6st\r
+ UEMOowgDGj5kxKZj/eFMTRtgaPa8nBn5wMGzmrjIJj/7kD340HhUBU3n1o14HlL1MP0+\r
+ vxdQ==\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+ d=1e100.net; s=20130820;\r
+ h=x-gm-message-state:date:from:subject:to:references:in-reply-to\r
+ :user-agent:message-id:mime-version:content-type\r
+ :content-transfer-encoding;\r
+ bh=iNvc3N3dRxG0otTg9KxrxGHz8AyQ1izys++x1tSgm3s=;\r
+ b=SzC0kUEjmGedtxWb4kcVFlc6kDhcNwUZkbDGkfPkyjZ9FxnSXu3TCH1hoTn7Jgwhnz\r
+ 7QIXMhjj1S+VPOaSbrguEsSts9Gpvb6Q0qvGPwCDzm6lqqjcKSit5tbfguldC7kDF9pl\r
+ kg9u+y8c7Vbg/jmHnehbV4M4m5hxcFo7BaU2wrutW8OHELt6zmUp3M287zslpB1NOWKg\r
+ wbbWqtH0V7epSCl8z0tlPAScpIgAsizk3gZE8s/eTbmvuYGRJazJq8LKUz0P/CSXdMoe\r
+ zSPCEQNwWtIfuPHzspKfMesieR8RQEaC1FurrGJPeMVtScoYbfE1b720zsBWz70EtRLJ\r
+ 4meg==\r
+X-Gm-Message-State:\r
+ AG10YORzwnpH2Bxmtc/g2dq60q1Zvu1QDehlpJl/aVcp8uRgvV7fByd+NyqqNKAHp91KiA==\r
+X-Received: by 10.112.161.131 with SMTP id xs3mr9205195lbb.65.1454840051295;\r
+ Sun, 07 Feb 2016 02:14:11 -0800 (PST)\r
+Received: from localhost (c6878BF51.dhcp.as2116.net. [81.191.120.104])\r
+ by smtp.gmail.com with ESMTPSA id a67sm3318677lfe.6.2016.02.07.02.14.10\r
+ for <notmuch@notmuchmail.org>\r
+ (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\r
+ Sun, 07 Feb 2016 02:14:10 -0800 (PST)\r
+Date: Sun, 07 Feb 2016 10:14:09 +0000\r
+From: Gaute Hope <eg@gaute.vetsj.com>\r
+Subject: Re: api-doc: return status for notmuch_query_search_threads_st ...\r
+To: notmuch@notmuchmail.org\r
+References: <1454839405-astroid-0-pyvwjk7jt8-6563@strange>\r
+In-Reply-To: <1454839405-astroid-0-pyvwjk7jt8-6563@strange>\r
+User-Agent: astroid/v0.5 (https://github.com/gauteh/astroid)\r
+Message-Id: <1454839957-astroid-3-etu8luubzc-6563@strange>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=utf-8; format=flowed\r
+Content-Transfer-Encoding: quoted-printable\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://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: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 07 Feb 2016 10:14:15 -0000\r
+\r
+Gaute Hope writes on February 7, 2016 11:06:\r
+> Hi,\r
+>=20\r
+> I am switching from the deprecated notmuch_query_search_threads to\r
+> notmuch_query_search_threads_st, but the api-documentation does not\r
+> specify what status values are returned and what they mean.\r
+>=20\r
+> The same goes for notmuch_query_search_messages_st (...).\r
+\r
+Indeed the typical usage section is also outdated (for both):\r
+\r
+```\r
+notmuch_query_t *query;\r
+notmuch_messages_t *messages;\r
+notmuch_message_t *message;\r
+\r
+query =3D notmuch_query_create (database, query_string);\r
+\r
+for (messages =3D notmuch_query_search_messages (query);\r
+     notmuch_messages_valid (messages);\r
+     notmuch_messages_move_to_next (messages))\r
+{\r
+    message =3D notmuch_messages_get (messages);\r
+    ....\r
+    notmuch_message_destroy (message);\r
+}\r
+\r
+notmuch_query_destroy (query);\r
+```\r
+\r
+-gaute\r
+=\r