07/85eced699e827bd708d6a34bc54d2bd901af53

   1 Return-Path: <bremner@tesseract.cs.unb.ca>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 90221431FBC\r
   6         for <notmuch@notmuchmail.org>; Sat,  7 Mar 2015 08:42:54 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 2.438\r
  10 X-Spam-Level: **\r
  11 X-Spam-Status: No, score=2.438 tagged_above=-999 required=5\r
  12         tests=[DNS_FROM_AHBL_RHSBL=2.438] autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id by14pzMuw6KE for <notmuch@notmuchmail.org>;\r
  16         Sat,  7 Mar 2015 08:42:51 -0800 (PST)\r
  17 Received: from mx.xen14.node3324.gplhost.com (gitolite.debian.net\r
  18         [87.98.215.224])\r
  19         (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id 4777D431FAE\r
  22         for <notmuch@notmuchmail.org>; Sat,  7 Mar 2015 08:42:51 -0800 (PST)\r
  23 Received: from remotemail by mx.xen14.node3324.gplhost.com with local (Exim\r
  24         4.80) (envelope-from <bremner@tesseract.cs.unb.ca>)\r
  25         id 1YUHnk-0003jF-TM; Sat, 07 Mar 2015 16:42:08 +0000\r
  26 Received: (nullmailer pid 16269 invoked by uid 1000); Sat, 07 Mar 2015\r
  27         16:41:55 -0000\r
  28 From: David Bremner <david@tethera.net>\r
  29 To: notmuch@notmuchmail.org\r
  30 Subject: [PATCH 1/2] lib: define DEPRECATED macro, document its use.\r
  31 Date: Sat,  7 Mar 2015 17:41:47 +0100\r
  32 Message-Id: <1425746508-16224-1-git-send-email-david@tethera.net>\r
  33 X-Mailer: git-send-email 2.1.4\r
  34 X-BeenThere: notmuch@notmuchmail.org\r
  35 X-Mailman-Version: 2.1.13\r
  36 Precedence: list\r
  37 List-Id: "Use and development of the notmuch mail system."\r
  38         <notmuch.notmuchmail.org>\r
  39 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  40         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  41 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  42 List-Post: <mailto:notmuch@notmuchmail.org>\r
  43 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  44 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  45         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  46 X-List-Received-Date: Sat, 07 Mar 2015 16:42:54 -0000\r
  47 \r
  48 This has been tested with gcc and clang.\r
  49 ---\r
  50  devel/STYLE     | 10 ++++++++++\r
  51  doc/doxygen.cfg |  2 +-\r
  52  lib/notmuch.h   |  2 ++\r
  53  3 files changed, 13 insertions(+), 1 deletion(-)\r
  54 \r
  55 diff --git a/devel/STYLE b/devel/STYLE\r
  56 index 92de42c..fcd5e99 100644\r
  57 --- a/devel/STYLE\r
  58 +++ b/devel/STYLE\r
  59 @@ -93,3 +93,13 @@ libnotmuch conventions\r
  60  \r
  61  * Code which needs to be accessed from both the CLI and from\r
  62    libnotmuch should be factored out into libutil (under util/).\r
  63 +\r
  64 +* Deprecated functions should be marked with the DEPRECATED macro\r
  65 +  which generates run time warnings with gcc and clang. In order not\r
  66 +  to confuse doxygen this should go at the beginning of the\r
  67 +  declaration like:\r
  68 +\r
  69 +  DEPRECATED(major,minor) notmuch_status_t notmuch_dwim(void *arg);\r
  70 +\r
  71 +  The @deprecated doxygen command can be used to generate markup in\r
  72 +  the API docs.\r
  73 diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg\r
  74 index 42b6339..c033f34 100644\r
  75 --- a/doc/doxygen.cfg\r
  76 +++ b/doc/doxygen.cfg\r
  77 @@ -74,7 +74,7 @@ STRICT_PROTO_MATCHING  = NO\r
  78  GENERATE_TODOLIST      = NO\r
  79  GENERATE_TESTLIST      = NO\r
  80  GENERATE_BUGLIST       = NO\r
  81 -GENERATE_DEPRECATEDLIST= NO\r
  82 +GENERATE_DEPRECATEDLIST= YES\r
  83  ENABLED_SECTIONS       =\r
  84  MAX_INITIALIZER_LINES  = 30\r
  85  SHOW_USED_FILES        = NO\r
  86 diff --git a/lib/notmuch.h b/lib/notmuch.h\r
  87 index 3e326bf..5fb51ba 100644\r
  88 --- a/lib/notmuch.h\r
  89 +++ b/lib/notmuch.h\r
  90 @@ -59,6 +59,8 @@ NOTMUCH_BEGIN_DECLS\r
  91  #define LIBNOTMUCH_MINOR_VERSION       1\r
  92  #define LIBNOTMUCH_MICRO_VERSION       0\r
  93  \r
  94 +#define DEPRECATED(major,minor) \\r
  95 +    __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))\r
  96  #endif /* __DOXYGEN__ */\r
  97  \r
  98  /**\r
  99 -- \r
 100 2.1.4\r
 101 \r