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 0280CA04B5; Tue, 29 Sep 2020 18:41:04 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id AFD411DA50; Tue, 29 Sep 2020 18:41:02 +0200 (CEST) Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by dpdk.org (Postfix) with ESMTP id 6FC6C1DA09 for ; Tue, 29 Sep 2020 18:41:01 +0200 (CEST) IronPort-SDR: eM2SWk8Jg5oGGlVaiW8W0U1y3jGxCkeje4aJX/NsVjSaNhGaTFPpKGI4V4gjNPS/nD6qW/BfQa wt8Yxu7J8Hrg== X-IronPort-AV: E=McAfee;i="6000,8403,9759"; a="142249706" X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="142249706" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga107.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 29 Sep 2020 09:40:51 -0700 IronPort-SDR: uAHsGDYfNronRBPb6DCDvfoelRfp8N5dL0VIPMYtW//wv1D8hkmCWtRtCCNJxrClyLPYbBWLGm vkElWXuCQ9bw== X-IronPort-AV: E=Sophos;i="5.77,319,1596524400"; d="scan'208";a="350325479" Received: from bricha3-mobl.ger.corp.intel.com ([10.213.220.178]) by fmsmga003-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-SHA; 29 Sep 2020 09:40:50 -0700 Date: Tue, 29 Sep 2020 17:40:46 +0100 From: Bruce Richardson To: Thomas Monjalon Cc: dev@dpdk.org Message-ID: <20200929164046.GE966@bricha3-MOBL.ger.corp.intel.com> References: <20200929153413.280581-1-bruce.richardson@intel.com> <3530692.ZXM58GVc4I@thomas> <20200929162325.GC966@bricha3-MOBL.ger.corp.intel.com> <5733395.4N6NXWAPF1@thomas> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <5733395.4N6NXWAPF1@thomas> Subject: Re: [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" On Tue, Sep 29, 2020 at 06:31:49PM +0200, Thomas Monjalon wrote: > 29/09/2020 18:23, Bruce Richardson: > > On Tue, Sep 29, 2020 at 05:55:44PM +0200, Thomas Monjalon wrote: > > > > 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. > > > [...] > > > > -doxygen "${DOXYCONF}" | tee doxygen.out > > > > +doxygen "${DOXYCONF}" > doxygen.out > > > > > > ninja is printing extra lines: > > > ninja: Entering directory `build' > > > [0/1] Running external command doc > > > Building docs: Doxygen_API HTML_Guides > > > > > > It makes hard to detect whether all run fine or not. > > > Can we remove these extra lines with a ninja option? > > > Can we return an error if there are some errors in doxygen? > > > > > If doxygen fails, then the whole build should fail - though to be honest > > that is hard to test since most invalid changes I've tried making end up > > just as warnings. The wrapper script for doxygen has "-e" flag so it should > > fail if any part of it does, i.e. doxygen, and ninja always returns error > > if any subtask fails. > > > > There is also the WARN_AS_ERROR setting for doxygen which we can use if you > > want to be stricter [1]. Once all warnings are fixed, I'd suggest setting > > that based on the werror setting for the build as a whole. > > > > [1] https://www.doxygen.nl/manual/config.html#cfg_warn_as_error > > Yes good idea. > Can we make WARN_AS_ERROR depending on the meson option -werror? > Yes, very easily, because the doxygen config file is adjustable from meson. If you want I can do a v2 with a fix for doxygen ethdev and the setting for WARN_AS_ERROR added as extra patches to this.