DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: Bruce Richardson <bruce.richardson@intel.com>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH v2 0/6] improve building docs
Date: Wed, 30 Sep 2020 16:32:27 +0200	[thread overview]
Message-ID: <4666152.Ah1uSTbYoE@thomas> (raw)
In-Reply-To: <20200929165502.336919-1-bruce.richardson@intel.com>

> 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.

Applied with suggested minor change, and without ethdev fix. Thanks



      parent reply	other threads:[~2020-09-30 14:32 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-29 15:34 [dpdk-dev] [PATCH 0/4] improve output when " Bruce Richardson
2020-09-29 15:34 ` [dpdk-dev] [PATCH 1/4] doc/api: hide verbose doxygen standard output Bruce Richardson
2020-09-29 15:55   ` Thomas Monjalon
2020-09-29 16:23     ` Bruce Richardson
2020-09-29 16:31       ` Thomas Monjalon
2020-09-29 16:40         ` Bruce Richardson
2020-09-29 15:34 ` [dpdk-dev] [PATCH 2/4] doc/api: align output folder with sphinx guides Bruce Richardson
2020-09-29 15:34 ` [dpdk-dev] [PATCH 3/4] doc/api: put output log file in build directory Bruce Richardson
2020-09-29 15:34 ` [dpdk-dev] [PATCH 4/4] doc/guides: suppress printing out standard output Bruce Richardson
2020-09-29 16:54 ` [dpdk-dev] [PATCH v2 0/6] improve building docs Bruce Richardson
2020-09-29 16:54   ` [dpdk-dev] [PATCH v2 1/6] doc/api: hide verbose doxygen standard output Bruce Richardson
2020-09-29 16:54   ` [dpdk-dev] [PATCH v2 2/6] doc/api: align output folder with sphinx guides Bruce Richardson
2020-09-29 16:54   ` [dpdk-dev] [PATCH v2 3/6] doc/api: put output log file in build directory Bruce Richardson
2020-09-29 16:55   ` [dpdk-dev] [PATCH v2 4/6] doc/guides: suppress printing out standard output Bruce Richardson
2020-09-29 16:55   ` [dpdk-dev] [PATCH v2 5/6] ethdev: fix mis-named parameter Bruce Richardson
2020-09-29 17:34     ` David Marchand
2020-09-29 17:34     ` Thomas Monjalon
2020-09-30  9:01       ` Bruce Richardson
2020-09-29 16:55   ` [dpdk-dev] [PATCH v2 6/6] doc/api: make doc warnings errors when werror option set Bruce Richardson
2020-09-29 17:33     ` Thomas Monjalon
2020-09-30 14:32   ` Thomas Monjalon [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4666152.Ah1uSTbYoE@thomas \
    --to=thomas@monjalon.net \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).