From patchwork Tue Sep 29 15:34:10 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 79205 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 1BE02A04BC; Tue, 29 Sep 2020 17:35:03 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id ED7FF1D6F8; Tue, 29 Sep 2020 17:34:30 +0200 (CEST) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 266091D6B5 for ; Tue, 29 Sep 2020 17:34:21 +0200 (CEST) IronPort-SDR: rhda6lKmDVfWiMJs3duMCv/xLtMz6zp7Pm+2S110EM6cZJYVAy5ZSu6WMhd+liS66KCo8OmtwI I5oYrCTrweFQ== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="223809934" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="223809934" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 29 Sep 2020 08:34:21 -0700 IronPort-SDR: Xxa44H8eviZ1BG25r5QWVlzNx3KrZiQ3oEsK3pRjtwxZb3/tmSJ/kI4iGnFfYWKWdI58BWZaLE v5+fjO3Z+Xyg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="514726421" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by fmsmga005.fm.intel.com with ESMTP; 29 Sep 2020 08:34:20 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: thomas@monjalon.net, Bruce Richardson Date: Tue, 29 Sep 2020 16:34:10 +0100 Message-Id: <20200929153413.280581-2-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200929153413.280581-1-bruce.richardson@intel.com> References: <20200929153413.280581-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 1/4] 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 15:34:11 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 79204 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 AAA22A04BC; Tue, 29 Sep 2020 17:34:42 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id C9A661D6CD; Tue, 29 Sep 2020 17:34:27 +0200 (CEST) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 280201D6BF for ; Tue, 29 Sep 2020 17:34:22 +0200 (CEST) IronPort-SDR: bcdGjYI0TwEZ7tvfPkViTrEMpteEKQWQLfROh5Hl7qMhj9X5r1FXUK1PHESDiYFjGrtUlR0wDb fGbSXcrhYQAw== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="223809937" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="223809937" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 29 Sep 2020 08:34:22 -0700 IronPort-SDR: 1fuCquKbTXK8UL/mWE7GZtPGEc8K4uP4h1EtrN+6YHMtHgHTWFW2Ry8hhqf5oijLtNO/A47o1s IEUcK0EWu4aQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="514726430" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by fmsmga005.fm.intel.com with ESMTP; 29 Sep 2020 08:34:21 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: thomas@monjalon.net, Bruce Richardson Date: Tue, 29 Sep 2020 16:34:11 +0100 Message-Id: <20200929153413.280581-3-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200929153413.280581-1-bruce.richardson@intel.com> References: <20200929153413.280581-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 2/4] 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 doxgen 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 15:34:12 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 79206 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 84508A04BC; Tue, 29 Sep 2020 17:35:21 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id CAE1A1D704; Tue, 29 Sep 2020 17:34:46 +0200 (CEST) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 7714C1D6F7 for ; Tue, 29 Sep 2020 17:34:45 +0200 (CEST) IronPort-SDR: wFgY3UNJd+u1fiKPj8N4AoI5cj3SfmLTqCte5LIcfE7rG5XEXdfqXpJ5suepnJFOAkEkozcphs AKQ0DBJDYkag== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="223809945" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="223809945" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 29 Sep 2020 08:34:24 -0700 IronPort-SDR: Shq/zQ52mkW9ZFjCN3c4p/uF1u2xSoUlL3PWgBskI2vyK+emlmQK5IgUMP3XyOuRyzqrYtabQG x+RRvaxIgIxw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="514726437" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by fmsmga005.fm.intel.com with ESMTP; 29 Sep 2020 08:34:23 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: thomas@monjalon.net, Bruce Richardson Date: Tue, 29 Sep 2020 16:34:12 +0100 Message-Id: <20200929153413.280581-4-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200929153413.280581-1-bruce.richardson@intel.com> References: <20200929153413.280581-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 3/4] 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 15:34:13 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 79207 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 CC92FA04BC; Tue, 29 Sep 2020 17:35:40 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id C75FC1D91B; Tue, 29 Sep 2020 17:34:51 +0200 (CEST) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 3C81A1D72D for ; Tue, 29 Sep 2020 17:34:46 +0200 (CEST) IronPort-SDR: Ie92YE21C+cCAdUEkCzSO1kD59sKUY7pIJ20otG6wrSvPZBjLr6Eii3U7xjXZh3XKncAYjQy2W O0zJ7rvMZElQ== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="223809953" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="223809953" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 29 Sep 2020 08:34:27 -0700 IronPort-SDR: bnYxVZaATAHyy6jotKyUfjzC6UPSDAVpeRDQO3dIMmQULJaHI6wB+YKo3rXKh5rKIFOiQcPzCc 2nqt1TdsD/aw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="514726445" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by fmsmga005.fm.intel.com with ESMTP; 29 Sep 2020 08:34:26 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: thomas@monjalon.net, Bruce Richardson Date: Tue, 29 Sep 2020 16:34:13 +0100 Message-Id: <20200929153413.280581-5-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200929153413.280581-1-bruce.richardson@intel.com> References: <20200929153413.280581-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 4/4] 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: