From: Thomas Monjalon <thomas@monjalon.net>
To: Bruce Richardson <bruce.richardson@intel.com>
Cc: dev@dpdk.org, david.marchand@redhat.com
Subject: Re: [dpdk-dev] [PATCH] doc: make sphinx errors more visible
Date: Fri, 16 Oct 2020 11:27:14 +0200 [thread overview]
Message-ID: <50089949.kCDsZEtK6n@thomas> (raw)
In-Reply-To: <20201016091818.GC1008@bricha3-MOBL.ger.corp.intel.com>
16/10/2020 11:18, Bruce Richardson:
> On Fri, Oct 16, 2020 at 05:39:55AM +0200, Thomas Monjalon wrote:
> > When running Sphinx through ninja, the wrapper configured in meson
> > redirects stdout to a log file.
> > It makes more important to print issues on stderr.
> >
> > Some warnings generated by the conf.py were hidden because
> > printed on stdout. The first improvement is to print them on stderr.
> >
> > The second measure is to stop processing if meson was configured
> > with --werror.
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > ---
> > buildtools/call-sphinx-build.py | 3 +++
> > doc/guides/conf.py | 19 +++++++++++++++----
> > 2 files changed, 18 insertions(+), 4 deletions(-)
> >
> > diff --git a/buildtools/call-sphinx-build.py b/buildtools/call-sphinx-build.py
> > index 26b199220a..8b266bec9b 100755
> > --- a/buildtools/call-sphinx-build.py
> > +++ b/buildtools/call-sphinx-build.py
> > @@ -14,6 +14,9 @@
> >
> > # set the version in environment for sphinx to pick up
> > os.environ['DPDK_VERSION'] = version
> > +# forward error policy to conf.py
> > +if '-W' in extra_args:
> > + os.environ['SPHINX_STOP_ON_ERROR'] = 'true'
> >
>
> Actually, I'm not sure this is necessary. Since the conf.py is processed
> from within the sphinx process itself, you can access sys.argv directly
> from within conf.py, rather than having to pass variables through the
> environment.
Great idea, thanks
next prev parent reply other threads:[~2020-10-16 9:27 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-16 3:39 Thomas Monjalon
2020-10-16 9:18 ` Bruce Richardson
2020-10-16 9:27 ` Thomas Monjalon [this message]
2020-10-16 12:39 ` [dpdk-dev] [PATCH v2] " Thomas Monjalon
2020-10-16 12:43 ` Bruce Richardson
2020-10-16 15:57 ` Thomas Monjalon
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=50089949.kCDsZEtK6n@thomas \
--to=thomas@monjalon.net \
--cc=bruce.richardson@intel.com \
--cc=david.marchand@redhat.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).