From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 0AFA5A04B5; Tue, 29 Sep 2020 18:57:08 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id A924E1DAAA; Tue, 29 Sep 2020 18:55:26 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 5A2991D9CE for ; Tue, 29 Sep 2020 18:55:15 +0200 (CEST) IronPort-SDR: OgHV8h+/H/hzI3FGft/ZcW3UYShdBmz/3uOrc32B9Zac7ZdKMVPXOkkJAKRZHsxLpXDfdhjsyg 6vD7heO0RS6A== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="159612233" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="159612233" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 29 Sep 2020 09:55:14 -0700 IronPort-SDR: yTssgmK6mbRK9yFOD49g5ug/D0RiglHYtCgF4GCfCTCueIjxA40Hbp/bRu0xlcoPLTDlBO8K7r RQr3Z9dQIZdg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="307833221" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga003.jf.intel.com with ESMTP; 29 Sep 2020 09:55:13 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: thomas@monjalon.net, Bruce Richardson Date: Tue, 29 Sep 2020 17:55:02 +0100 Message-Id: <20200929165502.336919-7-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200929165502.336919-1-bruce.richardson@intel.com> References: <20200929153413.280581-1-bruce.richardson@intel.com> <20200929165502.336919-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2 6/6] doc/api: make doc warnings errors when werror option set X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" When the --werror meson build option is set, we can set the WARN_AS_ERRORS doxygen option in the doxygen config flag to get the same behaviour for API doc building as for building the rest of DPDK. This can help catch documentation errors sooner in the development process. Signed-off-by: Bruce Richardson --- doc/api/doxy-api.conf.in | 1 + doc/api/meson.build | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in index 42d38919d..9182ee852 100644 --- a/doc/api/doxy-api.conf.in +++ b/doc/api/doxy-api.conf.in @@ -89,6 +89,7 @@ HIDE_SCOPE_NAMES = YES GENERATE_DEPRECATEDLIST = YES VERBATIM_HEADERS = NO ALPHABETICAL_INDEX = NO +WARN_AS_ERROR = @WARN_AS_ERROR@ HTML_TIMESTAMP = NO HTML_DYNAMIC_SECTIONS = YES diff --git a/doc/api/meson.build b/doc/api/meson.build index e9b49f9c2..4f51f5d72 100644 --- a/doc/api/meson.build +++ b/doc/api/meson.build @@ -37,6 +37,10 @@ cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api')) cdata.set('HTML_OUTPUT', 'html') cdata.set('TOPDIR', meson.source_root()) cdata.set('STRIP_FROM_PATH', meson.source_root()) +cdata.set('WARN_AS_ERROR', 'NO') +if get_option('werror') + cdata.set('WARN_AS_ERROR', 'YES') +endif doxy_conf = configure_file(input: 'doxy-api.conf.in', output: 'doxy-api.conf', -- 2.25.1