From: Aaron Conole <aconole@redhat.com>
To: Bruce Richardson <bruce.richardson@intel.com>
Cc: david.marchand@redhat.com, dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH 2/2] doc: pass "werror" setting through to doc build
Date: Fri, 17 Jan 2020 12:59:45 -0500 [thread overview]
Message-ID: <f7t8sm6x8tq.fsf@dhcp-25.97.bos.redhat.com> (raw)
In-Reply-To: <20200117174216.GA1724@bricha3-MOBL.ger.corp.intel.com> (Bruce Richardson's message of "Fri, 17 Jan 2020 17:42:16 +0000")
Bruce Richardson <bruce.richardson@intel.com> writes:
> On Fri, Jan 17, 2020 at 08:34:01AM -0500, Aaron Conole wrote:
>> Bruce Richardson <bruce.richardson@intel.com> writes:
>>
>> > On Fri, Jan 17, 2020 at 08:16:55AM -0500, Aaron Conole wrote:
>> >> Bruce Richardson <bruce.richardson@intel.com> writes:
>> >>
>> >> > When werror is set for the build, we should pass that flag through to
>> >> > sphinx so that it can flag warnings as errors too.
>> >> >
>> >> > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
>> >> > ---
>> >>
>> >> I see that this actually works to generate the errors... BUT
>> >>
>> >> if we merge this it will break the build. Can you also insert a patch
>> >> to address the warning so that the series could be merged?
>> >>
>> >
>> > Ok, I didn't have any warnings in my setup, which is why I didn't see any
>> > problems. I assume that the warnings are showing up in travis? Anywhere
>> > else?
>>
>> I only saw them on Travis.
>>
> The error from sphinx in travis looks like a false positive that is fixed
> in later versions of sphinx. The error I see is:
>
> /home/travis/build/bruce-richardson/dpdk/doc/guides/linux_gsg/eal_args.include.rst::
> WARNING: document isn't included in any toctree
>
> However, that file is an include one that is included in both the linux and
> freebsd eal parameters docs, and so is not missing though not included in
> the index. What is the best approach to deal with this, do you think?
>
> * rework so it has a toctree entry e.g. by creating a new section for
> common parameters
> * other workaround in the code, e.g. rename the file to not end in .rst
> * can we update sphinx in the travis build to avoid the warning altogether?
I think the third option is best. Distributions can always disable
werror on doc builds or upgrade their own sphinx packages.
If that isn't acceptable to anyone else, then the 1st option is my
next choice. I dislike the approach of renaming the file.
> /Bruce
next prev parent reply other threads:[~2020-01-17 17:59 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-17 10:48 [dpdk-dev] [PATCH 1/2] doc: fix doc build when sphinx reports version to stderr Bruce Richardson
2020-01-17 10:48 ` [dpdk-dev] [PATCH 2/2] doc: pass "werror" setting through to doc build Bruce Richardson
2020-01-17 13:16 ` Aaron Conole
2020-01-17 13:25 ` Bruce Richardson
2020-01-17 13:34 ` Aaron Conole
2020-01-17 17:42 ` Bruce Richardson
2020-01-17 17:59 ` Aaron Conole [this message]
2020-06-22 14:00 ` [dpdk-dev] [PATCH v2] doc: fix doc build when sphinx reports version to stderr Bruce Richardson
2020-06-22 14:09 ` Power, Ciara
2020-06-22 14:20 ` David Marchand
2020-07-30 23:00 ` 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=f7t8sm6x8tq.fsf@dhcp-25.97.bos.redhat.com \
--to=aconole@redhat.com \
--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).