[PATCH 2/5] lib: deprecate notmuch_query_search_{threads, messages}

diff --git a/d6/083b6e56c785deaa76ff1208a0e75db90a2d48 b/d6/083b6e56c785deaa76ff1208a0e75db90a2d48
new file mode 100644 (file)
index 0000000..1d10c29
--- /dev/null
+++ b/d6/083b6e56c785deaa76ff1208a0e75db90a2d48
@@ -0,0 +1,128 @@
+Return-Path: <bremner@tesseract.cs.unb.ca>\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 AE8A1431FC7\r
+       for <notmuch@notmuchmail.org>; Sat,  7 Mar 2015 11:24:48 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 2.438\r
+X-Spam-Level: **\r
+X-Spam-Status: No, score=2.438 tagged_above=-999 required=5\r
+       tests=[DNS_FROM_AHBL_RHSBL=2.438] 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 oWlIwK9ntXpN for <notmuch@notmuchmail.org>;\r
+       Sat,  7 Mar 2015 11:24:48 -0800 (PST)\r
+Received: from mx.xen14.node3324.gplhost.com (gitolite.debian.net\r
+       [87.98.215.224])\r
+       (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 2EAB5431FC4\r
+       for <notmuch@notmuchmail.org>; Sat,  7 Mar 2015 11:24:48 -0800 (PST)\r
+Received: from remotemail by mx.xen14.node3324.gplhost.com with local (Exim\r
+       4.80) (envelope-from <bremner@tesseract.cs.unb.ca>)\r
+       id 1YUKKU-0004DV-SZ; Sat, 07 Mar 2015 19:24:06 +0000\r
+Received: (nullmailer pid 28723 invoked by uid 1000); Sat, 07 Mar 2015\r
+       19:23:13 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 2/5] lib: deprecate notmuch_query_search_{threads, messages}\r
+Date: Sat,  7 Mar 2015 20:22:59 +0100\r
+Message-Id: <1425756182-28468-3-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 2.1.4\r
+In-Reply-To: <1425756182-28468-1-git-send-email-david@tethera.net>\r
+References: <1425756182-28468-1-git-send-email-david@tethera.net>\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: Sat, 07 Mar 2015 19:24:48 -0000\r
+\r
+The CLI (and bindings) code should really be updated to use the new\r
+status-code-returning versions. Here are some warnings to prod us (and\r
+other clients) to do so.\r
+---\r
+ lib/notmuch.h | 41 ++++++++++++++++++++++++++---------------\r
+ 1 file changed, 26 insertions(+), 15 deletions(-)\r
+\r
+diff --git a/lib/notmuch.h b/lib/notmuch.h\r
+index 5352479..087f3f0 100644\r
+--- a/lib/notmuch.h\r
++++ b/lib/notmuch.h\r
+@@ -781,20 +781,25 @@ notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);\r
+  * notmuch_threads_destroy function, but there's no good reason\r
+  * to call it if the query is about to be destroyed).\r
+  *\r
+- * If a Xapian exception occurs this function will return NULL.\r
+- * For better error reporting, use the _st variant.\r
+- */\r
+-notmuch_threads_t *\r
+-notmuch_query_search_threads (notmuch_query_t *query);\r
+-\r
+-/**\r
+- * Like notmuch_query_search_threads, but with a status return.\r
+  */\r
+ notmuch_status_t\r
+ notmuch_query_search_threads_st (notmuch_query_t *query,\r
+                                notmuch_threads_t **out);\r
+ \r
+ /**\r
++ * Like notmuch_query_search_threads_st, but without a status return.\r
++ *\r
++ * If a Xapian exception occurs this function will return NULL.\r
++ *\r
++ * @deprecated Deprecated as of libnotmuch 4.2 (notmuch 0.20). Please\r
++ * use notmuch_query_search_threads_st instead.\r
++ *\r
++ */\r
++NOTMUCH_DEPRECATED(4,2)\r
++notmuch_threads_t *\r
++notmuch_query_search_threads (notmuch_query_t *query);\r
++\r
++/**\r
+  * Execute a query for messages, returning a notmuch_messages_t object\r
+  * which can be used to iterate over the results. The returned\r
+  * messages object is owned by the query and as such, will only be\r
+@@ -832,17 +837,23 @@ notmuch_query_search_threads_st (notmuch_query_t *query,\r
+  * reason to call it if the query is about to be destroyed).\r
+  *\r
+  * If a Xapian exception occurs this function will return NULL.\r
+- * For better error reporting, use the _st variant.\r
+- */\r
+-notmuch_messages_t *\r
+-notmuch_query_search_messages (notmuch_query_t *query);\r
+-\r
+-/**\r
+- * Like notmuch_query_search_messages, but with a status return.\r
++ *\r
+  */\r
+ notmuch_status_t\r
+ notmuch_query_search_messages_st (notmuch_query_t *query,\r
+                                 notmuch_messages_t **out);\r
++/**\r
++ * Like notmuch_query_search_messages, but without a status return.\r
++ *\r
++ * If a Xapian exception occurs this function will return NULL.\r
++ *\r
++ * @deprecated Deprecated as of libnotmuch 4.2 (notmuch 0.20). Please use\r
++ * notmuch_query_search_messages_st instead.\r
++ *\r
++ */\r
++NOTMUCH_DEPRECATED(4,2)\r
++notmuch_messages_t *\r
++notmuch_query_search_messages (notmuch_query_t *query);\r
+ \r
+ /**\r
+  * Destroy a notmuch_query_t along with any associated resources.\r
+-- \r
+2.1.4\r
+\r