From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 4BAA1A04B5; Tue, 29 Sep 2020 18:56:07 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id EB55F1DA86; Tue, 29 Sep 2020 18:55:19 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 2F1FF1D91B for <dev@dpdk.org>; Tue, 29 Sep 2020 18:55:13 +0200 (CEST) IronPort-SDR: I14+lnnghvx+t0ZsdyD9bA4rAlHzNiC1U1Pn0QKdLO349ZNXiug2bNo4Zb4ywyFd+xw2VIH0D6 VzHouuCcaW5A== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="159612212" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="159612212" 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:08 -0700 IronPort-SDR: LZ2FNv8poCL14W++XNk2B9P+FfkRiJw6KNcq77O8ivyWTfc/wlAmKTjKWMWRNQiA/0IFOFS6VG c6Unq+Q20KgA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="307833173" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga003.jf.intel.com with ESMTP; 29 Sep 2020 09:55:07 -0700 From: Bruce Richardson <bruce.richardson@intel.com> To: dev@dpdk.org Cc: thomas@monjalon.net, Bruce Richardson <bruce.richardson@intel.com> Date: Tue, 29 Sep 2020 17:54:56 +0100 Message-Id: <20200929165502.336919-1-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 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2 0/6] improve building docs X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org> When building the documentation, a lot of text is output, meaning that any warnings can be missed in all the text. Unfortunately, ninja merges both stderr and stdout of all tasks so one cannot just redirect stdout to a separate location as part of the build command to rectify that. Therefore, since we rarely care about the output of the doc builds, only output the stderr text and write the standard output text to a log file in the relevant build folder (i.e. build/doc/guides or build/doc/api) Related to this, we can catch documentation bugs earlier by setting WARN_AS_ERRORS for doxygen, meaning the build will fail if any API documentation warnings as encountered. Rather than setting this globally, we can link it to the global build --werror setting. --- V2: added in patches to fix API doc issue, and enable WARN_AS_ERRORS Bruce Richardson (6): doc/api: hide verbose doxygen standard output doc/api: align output folder with sphinx guides doc/api: put output log file in build directory doc/guides: suppress printing out standard output ethdev: fix mis-named parameter doc/api: make doc warnings errors when werror option set buildtools/call-sphinx-build.py | 6 ++++-- doc/api/doxy-api.conf.in | 1 + doc/api/generate_doxygen.sh | 6 ++++-- doc/api/meson.build | 10 +++++++--- lib/librte_ethdev/rte_ethdev.h | 2 +- 5 files changed, 17 insertions(+), 8 deletions(-) -- 2.25.1