From patchwork Tue Sep 29 16:54:57 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 79220 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 4F29EA04B5; Tue, 29 Sep 2020 18:55:15 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 7C96B1C1B9; Tue, 29 Sep 2020 18:55:13 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id D265F1BFCC for ; Tue, 29 Sep 2020 18:55:11 +0200 (CEST) IronPort-SDR: z/Q7KNMCb+R46J8MoPYvWN3D0h67K9InUHbep8haJRNENvLerp9ELc/+Yo4tkekWWAwidzVwKm DvoGc0FN5L/A== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="159612213" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="159612213" 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:09 -0700 IronPort-SDR: 5VpSuVWkixHwGu8GWmgR2+wyQX3W2H8A38s6c1yiHp8bpUeWcLhiWcVnR/GvcXwlEgC1MOFvtj oQkjomKQFDsw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="307833180" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga003.jf.intel.com with ESMTP; 29 Sep 2020 09:55:08 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: thomas@monjalon.net, Bruce Richardson Date: Tue, 29 Sep 2020 17:54:57 +0100 Message-Id: <20200929165502.336919-2-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 Subject: [dpdk-dev] [PATCH v2 1/6] doc/api: hide verbose doxygen standard output 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" The standard output of doxygen is very verbose, and since ninja mixes stdout and stderr together it makes it difficult to see any warnings from the doxygen run. Therefore, we can just log the standard output to file, and only output the stderr to make warnings clear. Suggested-by: Thomas Monjalon Signed-off-by: Bruce Richardson --- doc/api/generate_doxygen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/generate_doxygen.sh b/doc/api/generate_doxygen.sh index ee509e896..b4d66eb15 100755 --- a/doc/api/generate_doxygen.sh +++ b/doc/api/generate_doxygen.sh @@ -7,7 +7,7 @@ OUTDIR=$2 SCRIPTCSS=$3 # run doxygen, capturing all the header files it processed -doxygen "${DOXYCONF}" | tee doxygen.out +doxygen "${DOXYCONF}" > doxygen.out echo "$OUTDIR: $(awk '/Preprocessing/ {printf("%s ", substr($2, 1, length($2) - 3))}' doxygen.out)" > $OUTDIR.d "${SCRIPTCSS}" "${OUTDIR}"/doxygen.css From patchwork Tue Sep 29 16:54:58 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 79221 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id E994AA04B5; Tue, 29 Sep 2020 18:55:32 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id DA82D1DA05; Tue, 29 Sep 2020 18:55:16 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 787861C033 for ; Tue, 29 Sep 2020 18:55:12 +0200 (CEST) IronPort-SDR: v+b9VxbJb5ERObcVqBiQDlwd/GMhUSgulVoEwi60S5d2R345Gi7hP6hHYWjbE55KOKu7QUiFiS oXGz/lCNaIHA== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="159612218" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="159612218" 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:10 -0700 IronPort-SDR: jgpTr5f5swq6aVjPIkfjRdmCS8kB+3Ivu1XaRh+18sAkwMQ1y+Mc6X3KKgvi2m94jEogq5MrBo xp/VwycVeDiQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="307833195" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga003.jf.intel.com with ESMTP; 29 Sep 2020 09:55:09 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: thomas@monjalon.net, Bruce Richardson Date: Tue, 29 Sep 2020 17:54:58 +0100 Message-Id: <20200929165502.336919-3-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 Subject: [dpdk-dev] [PATCH v2 2/6] doc/api: align output folder with sphinx guides 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" The API docs were output to "/doc/api/api" folder, which was ugly-looking with the repeated "api", and inconsistent with the sphinx guides which were written to "/doc/guides/html". Changing the doxygen output folder to "html" fixes both these issues. Signed-off-by: Bruce Richardson --- doc/api/meson.build | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/meson.build b/doc/api/meson.build index 49d5b9a15..e9b49f9c2 100644 --- a/doc/api/meson.build +++ b/doc/api/meson.build @@ -34,7 +34,7 @@ cdata = configuration_data() cdata.set('VERSION', meson.project_version()) cdata.set('API_EXAMPLES', join_paths(meson.build_root(), 'doc', 'api', 'examples.dox')) cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api')) -cdata.set('HTML_OUTPUT', 'api') +cdata.set('HTML_OUTPUT', 'html') cdata.set('TOPDIR', meson.source_root()) cdata.set('STRIP_FROM_PATH', meson.source_root()) @@ -45,8 +45,8 @@ doxy_conf = configure_file(input: 'doxy-api.conf.in', doxy_build = custom_target('doxygen', depends: example, input: doxy_conf, - output: 'api', - depfile: 'api.d', + output: 'html', + depfile: 'html.d', command: [generate_doxygen, '@INPUT@', '@OUTPUT@', generate_css], install: get_option('enable_docs'), install_dir: htmldir, From patchwork Tue Sep 29 16:54:59 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 79222 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id B22AFA04B5; Tue, 29 Sep 2020 18:55:51 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 76CA31DA61; Tue, 29 Sep 2020 18:55:18 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 208121D6F6 for ; Tue, 29 Sep 2020 18:55:13 +0200 (CEST) IronPort-SDR: xnGVnQK0RsamMhxBEZARA5LjWWKjfVhjLeDqv3r7hc2Z1ITZSSyg89JPf4dN/rOGrlkNyn7/Y1 om7LD0qocsNg== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="159612222" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="159612222" 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:11 -0700 IronPort-SDR: d0BFfUFPbyFwz8aq3id5fSy5HDeAUKzZ2VSxEiEeitxuMuQ4Pms3Tk0i3zykbFknT/iJ5RoeX6 UShcGqi4q7+w== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="307833202" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga003.jf.intel.com with ESMTP; 29 Sep 2020 09:55:10 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: thomas@monjalon.net, Bruce Richardson Date: Tue, 29 Sep 2020 17:54:59 +0100 Message-Id: <20200929165502.336919-4-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 Subject: [dpdk-dev] [PATCH v2 3/6] doc/api: put output log file in build directory 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" The meson documentation states that projects should not rely upon the custom_target build commands are run from any given directory. Therefore, rather than writing the standout output from doxygen to the current directory - which could be anywhere in future, put it into the api directory, so that it is in a known location. Signed-off-by: Bruce Richardson --- doc/api/generate_doxygen.sh | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/generate_doxygen.sh b/doc/api/generate_doxygen.sh index b4d66eb15..1350e5049 100755 --- a/doc/api/generate_doxygen.sh +++ b/doc/api/generate_doxygen.sh @@ -6,8 +6,10 @@ DOXYCONF=$1 OUTDIR=$2 SCRIPTCSS=$3 +OUT_FILE=$(dirname $OUTDIR)/doxygen.out + # run doxygen, capturing all the header files it processed -doxygen "${DOXYCONF}" > doxygen.out -echo "$OUTDIR: $(awk '/Preprocessing/ {printf("%s ", substr($2, 1, length($2) - 3))}' doxygen.out)" > $OUTDIR.d +doxygen "${DOXYCONF}" > $OUT_FILE +echo "$OUTDIR: $(awk '/Preprocessing/ {printf("%s ", substr($2, 1, length($2) - 3))}' $OUT_FILE)" > $OUTDIR.d "${SCRIPTCSS}" "${OUTDIR}"/doxygen.css From patchwork Tue Sep 29 16:55:00 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 79224 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 93248A04B5; Tue, 29 Sep 2020 18:56:25 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 7D2B11DA93; Tue, 29 Sep 2020 18:55:21 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 91E341C033 for ; Tue, 29 Sep 2020 18:55:14 +0200 (CEST) IronPort-SDR: OYoimlLSIHp0lF/Di60JB4fBfZfTl2s5J/HbkPOjy5k5+SbnzxZJya5oLDw3N8Hom0hs9FYh61 FTMkNZmbHc6w== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="159612224" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="159612224" 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:12 -0700 IronPort-SDR: OowvfLFwDqIh0KiXj3ebvUMyKJsnCuwdAdKykiAw+Dt1ztzxnjNlH4XVFtGsI0ebMdL6Gz4tMi gaaJND93zibg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="307833210" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga003.jf.intel.com with ESMTP; 29 Sep 2020 09:55:11 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: thomas@monjalon.net, Bruce Richardson Date: Tue, 29 Sep 2020 17:55:00 +0100 Message-Id: <20200929165502.336919-5-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 Subject: [dpdk-dev] [PATCH v2 4/6] doc/guides: suppress printing out standard output 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" To see only errors and warnings from the doc builds, we can send the standard output text to a logfile and have only the stderr messages printed. This is similar to what is done for the API documentation. Signed-off-by: Bruce Richardson --- buildtools/call-sphinx-build.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/buildtools/call-sphinx-build.py b/buildtools/call-sphinx-build.py index fa6f26b37..0dce59f64 100755 --- a/buildtools/call-sphinx-build.py +++ b/buildtools/call-sphinx-build.py @@ -27,8 +27,10 @@ srcfiles.extend([join(root, f) for f in files]) # run sphinx, putting the html output in a "html" directory -process = run(sphinx_cmd + ['-b', 'html', src, join(dst, 'html')], check=True) -print(str(process.args) + ' Done OK') +with open(join(dst, 'sphinx_html.out'), 'w') as out: + process = run(sphinx_cmd + ['-b', 'html', src, join(dst, 'html')], + check=True, + stdout=out) # create a gcc format .d file giving all the dependencies of this doc build with open(join(dst, '.html.d'), 'w') as d: From patchwork Tue Sep 29 16:55:01 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 79225 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 3F872A04B5; Tue, 29 Sep 2020 18:56:49 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 0B3931DAA0; Tue, 29 Sep 2020 18:55:23 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id B717C1D9CE for ; Tue, 29 Sep 2020 18:55:14 +0200 (CEST) IronPort-SDR: jKd1XqhlbIxuUf2A3/BCcJAVbv4Wx1XXEQYym2+lLdEEwRlUHnj+OibMSTJkhw6Wj0Bb24xDLl oEE+rCWE9oNQ== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="159612228" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="159612228" 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:13 -0700 IronPort-SDR: MqcUzb+XnJGn6SkfDGYmAj4/CURZib5y9qbWzbgQsWAuNV2z6fgmStKKBI6mK+p0KEgok/6X4G CUjazwQ62BFw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="307833215" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga003.jf.intel.com with ESMTP; 29 Sep 2020 09:55:12 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: thomas@monjalon.net, Bruce Richardson , i.dyukov@samsung.com Date: Tue, 29 Sep 2020 17:55:01 +0100 Message-Id: <20200929165502.336919-6-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 Subject: [dpdk-dev] [PATCH v2 5/6] ethdev: fix mis-named parameter 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" The parameter to rte_eth_link_speed_to_str was called "speed_link" in the function prototype in the header file, but "link_speed" everywhere else. This showed up as warnings when building the API docs, due to missing and undocumented parameters from doxygen's viewpoint. Rename the prototype value to the correct name to fix these issues. Fixes: fbf931c9c392 ("ethdev: format link status text") Cc: i.dyukov@samsung.com Signed-off-by: Bruce Richardson --- lib/librte_ethdev/rte_ethdev.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h index 645a18664..9759f1330 100644 --- a/lib/librte_ethdev/rte_ethdev.h +++ b/lib/librte_ethdev/rte_ethdev.h @@ -2452,7 +2452,7 @@ int rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link); * No free is required. */ __rte_experimental -const char *rte_eth_link_speed_to_str(uint32_t speed_link); +const char *rte_eth_link_speed_to_str(uint32_t link_speed); /** * @warning From patchwork Tue Sep 29 16:55:02 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 79226 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org 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 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',