[PATCH 1/2] lib: define DEPRECATED macro, document its use.

diff --git a/07/85eced699e827bd708d6a34bc54d2bd901af53 b/07/85eced699e827bd708d6a34bc54d2bd901af53
new file mode 100644 (file)
index 0000000..e52e07b
--- /dev/null
+++ b/07/85eced699e827bd708d6a34bc54d2bd901af53
@@ -0,0 +1,101 @@
+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 90221431FBC\r
+       for <notmuch@notmuchmail.org>; Sat,  7 Mar 2015 08:42:54 -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 by14pzMuw6KE for <notmuch@notmuchmail.org>;\r
+       Sat,  7 Mar 2015 08:42:51 -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 4777D431FAE\r
+       for <notmuch@notmuchmail.org>; Sat,  7 Mar 2015 08:42:51 -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 1YUHnk-0003jF-TM; Sat, 07 Mar 2015 16:42:08 +0000\r
+Received: (nullmailer pid 16269 invoked by uid 1000); Sat, 07 Mar 2015\r
+       16:41:55 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 1/2] lib: define DEPRECATED macro, document its use.\r
+Date: Sat,  7 Mar 2015 17:41:47 +0100\r
+Message-Id: <1425746508-16224-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 2.1.4\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 16:42:54 -0000\r
+\r
+This has been tested with gcc and clang.\r
+---\r
+ devel/STYLE     | 10 ++++++++++\r
+ doc/doxygen.cfg |  2 +-\r
+ lib/notmuch.h   |  2 ++\r
+ 3 files changed, 13 insertions(+), 1 deletion(-)\r
+\r
+diff --git a/devel/STYLE b/devel/STYLE\r
+index 92de42c..fcd5e99 100644\r
+--- a/devel/STYLE\r
++++ b/devel/STYLE\r
+@@ -93,3 +93,13 @@ libnotmuch conventions\r
+ \r
+ * Code which needs to be accessed from both the CLI and from\r
+   libnotmuch should be factored out into libutil (under util/).\r
++\r
++* Deprecated functions should be marked with the DEPRECATED macro\r
++  which generates run time warnings with gcc and clang. In order not\r
++  to confuse doxygen this should go at the beginning of the\r
++  declaration like:\r
++\r
++  DEPRECATED(major,minor) notmuch_status_t notmuch_dwim(void *arg);\r
++\r
++  The @deprecated doxygen command can be used to generate markup in\r
++  the API docs.\r
+diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg\r
+index 42b6339..c033f34 100644\r
+--- a/doc/doxygen.cfg\r
++++ b/doc/doxygen.cfg\r
+@@ -74,7 +74,7 @@ STRICT_PROTO_MATCHING  = NO\r
+ GENERATE_TODOLIST      = NO\r
+ GENERATE_TESTLIST      = NO\r
+ GENERATE_BUGLIST       = NO\r
+-GENERATE_DEPRECATEDLIST= NO\r
++GENERATE_DEPRECATEDLIST= YES\r
+ ENABLED_SECTIONS       =\r
+ MAX_INITIALIZER_LINES  = 30\r
+ SHOW_USED_FILES        = NO\r
+diff --git a/lib/notmuch.h b/lib/notmuch.h\r
+index 3e326bf..5fb51ba 100644\r
+--- a/lib/notmuch.h\r
++++ b/lib/notmuch.h\r
+@@ -59,6 +59,8 @@ NOTMUCH_BEGIN_DECLS\r
+ #define LIBNOTMUCH_MINOR_VERSION      1\r
+ #define LIBNOTMUCH_MICRO_VERSION      0\r
+ \r
++#define DEPRECATED(major,minor) \\r
++    __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))\r
+ #endif /* __DOXYGEN__ */\r
+ \r
+ /**\r
+-- \r
+2.1.4\r
+\r