DPDK patches and discussions
 help / color / Atom feed
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
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



  reply index

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

DPDK patches and discussions

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ http://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/ public-inbox