Re: [PATCH 1/2] lib: define DEPRECATED macro, document its use.
authorJani Nikula <jani@nikula.org>
Sat, 7 Mar 2015 16:52:48 +0000 (18:52 +0200)
committerW. Trevor King <wking@tremily.us>
Sat, 20 Aug 2016 21:48:20 +0000 (14:48 -0700)
84/5c4e34b9ec81f85b71f023ecb57fa7aabc6f5d [new file with mode: 0644]

diff --git a/84/5c4e34b9ec81f85b71f023ecb57fa7aabc6f5d b/84/5c4e34b9ec81f85b71f023ecb57fa7aabc6f5d
new file mode 100644 (file)
index 0000000..64cff86
--- /dev/null
@@ -0,0 +1,136 @@
+Return-Path: <jani@nikula.org>\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 A250B431FBC\r
+       for <notmuch@notmuchmail.org>; Sat,  7 Mar 2015 08:52:33 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 1.738\r
+X-Spam-Level: *\r
+X-Spam-Status: No, score=1.738 tagged_above=-999 required=5\r
+       tests=[DNS_FROM_AHBL_RHSBL=2.438, RCVD_IN_DNSWL_LOW=-0.7]\r
+       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 rzr9WDn9thhd for <notmuch@notmuchmail.org>;\r
+       Sat,  7 Mar 2015 08:52:30 -0800 (PST)\r
+Received: from mail-wi0-f182.google.com (mail-wi0-f182.google.com\r
+       [209.85.212.182]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 34C42431FAE\r
+       for <notmuch@notmuchmail.org>; Sat,  7 Mar 2015 08:52:30 -0800 (PST)\r
+Received: by wiwl15 with SMTP id l15so10425168wiw.0\r
+       for <notmuch@notmuchmail.org>; Sat, 07 Mar 2015 08:52:29 -0800 (PST)\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:from:to:subject:in-reply-to:references\r
+       :user-agent:date:message-id:mime-version:content-type;\r
+       bh=A23WUMtuldzubV9z5XrSjHLPAWUBWUaHg5gUWi2WV+E=;\r
+       b=g+7bUXwUFf2T5dSaEmNRPI+9GzabDEVvzBGgwK2xZiKNcHOY8PcJGS1juhayrjUNEQ\r
+       mNy+wIPXmAyDjyNGmeqou0r/nmKAeLnvIE+iLvSCzJxZArtCVOVC3iiWwdis7lCpVL1D\r
+       FrH9IMB34KyyuoiXcoCISxirPZ63BmsxCh8fZa1H/JeTsVBUvyJ1xph5o+pelDeWoqve\r
+       mUerTKapwKOCxrWgYuO7J7CrYc1CYEU1YlrDbxVLFws2LQsmr7ewKisN/BRglsI+OgnM\r
+       2LVZ+KSwUdxrHkzCja8O5YxjnuuuOGQQzsk2GFF94XdwEtc/nkzBC4WrR6xYg36/3YVA\r
+       k5kw==\r
+X-Gm-Message-State:\r
+ ALoCoQlVm8EhjcEISK9XfIr8rM/bxRS4I+GifeFQ1b0mdlgYIEUKjBlwIYwT3M0EKzMyyyJQdiDR\r
+X-Received: by 10.180.219.102 with SMTP id pn6mr43017026wic.50.1425747149213; \r
+       Sat, 07 Mar 2015 08:52:29 -0800 (PST)\r
+Received: from localhost (mobile-internet-bcee3b-76.dhcp.inet.fi.\r
+       [188.238.59.76]) by mx.google.com with ESMTPSA id\r
+       a13sm20043420wjx.30.2015.03.07.08.52.28\r
+       (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\r
+       Sat, 07 Mar 2015 08:52:28 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 1/2] lib: define DEPRECATED macro, document its use.\r
+In-Reply-To: <1425746508-16224-1-git-send-email-david@tethera.net>\r
+References: <1425746508-16224-1-git-send-email-david@tethera.net>\r
+User-Agent: Notmuch/0.19+74~g6aeef2e (http://notmuchmail.org) Emacs/24.4.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Sat, 07 Mar 2015 18:52:48 +0200\r
+Message-ID: <87k2ysiwbj.fsf@nikula.org>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\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:52:33 -0000\r
+\r
+On Sat, 07 Mar 2015, David Bremner <david@tethera.net> wrote:\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
+\r
+Is that perhaps a too generic name for a macro? NOTMUCH_DEPRECATED?\r
+\r
+Otherwise seems nice. Did not actually try it.\r
+\r
+BR,\r
+Jani.\r
+\r
+> +    __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))\r
+>  #endif /* __DOXYGEN__ */\r
+>  \r
+>  /**\r
+> -- \r
+> 2.1.4\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r