From: Kevin Traynor <ktraynor@redhat.com>
To: Bruce Richardson <bruce.richardson@intel.com>
Cc: dev@dpdk.org, anatoly.burakov@intel.com, stable@dpdk.org
Subject: Re: [PATCH] doc: add eal_args.include to toctree
Date: Thu, 31 Mar 2022 17:29:59 +0100 [thread overview]
Message-ID: <ed87d292-d2ed-8ead-5433-8b65a5762308@redhat.com> (raw)
In-Reply-To: <YkWx3HLIlbLGzxaI@bricha3-MOBL.ger.corp.intel.com>
On 31/03/2022 14:51, Bruce Richardson wrote:
> On Thu, Mar 31, 2022 at 02:26:54PM +0100, Kevin Traynor wrote:
>> A warning is observed on RHEL 8.4.
>>
>> [1/1] Generating html_guides with a custom command
>> /root/dpdk/doc/guides/linux_gsg/eal_args.include.rst:
>> WARNING: document isn't included in any toctree
>>
>> Add file to toctree to remove warning.
>>
>> Fixes: 3ee567cfec37 ("doc: document all EAL parameters in one place")
>> Cc: stable@dpdk.org
>>
>> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
>> ---
>> doc/guides/linux_gsg/index.rst | 1 +
>> 1 file changed, 1 insertion(+)
>>
>> diff --git a/doc/guides/linux_gsg/index.rst b/doc/guides/linux_gsg/index.rst
>> index 16a9a67260..cffa4998d8 100644
>> --- a/doc/guides/linux_gsg/index.rst
>> +++ b/doc/guides/linux_gsg/index.rst
>> @@ -17,4 +17,5 @@ Getting Started Guide for Linux
>> linux_drivers
>> build_sample_apps
>> + eal_args.include
>> linux_eal_parameters
>> enable_func
>
> I think this is a false-positive warning, that shouldn't be fixed in this
> way. That file is not one to be put at the top level of the doc - instead
> it is included by both freesd and linux gsg guides within the relevant
> sections. If we can't suppress this warning, maybe we need to rename the
> file to not end with a .rst extension.
>
Ok, it's not a big deal anyway, RHEL 8.4 is using an old version of
sphinx (1.7.6). I can't reproduce on Fedora with a newer version (3.4.3)
and no one else seems to see it.
I tried to remove the warning with :orphan: but I'm not sure it's that
well supported in that version. Removing the .rst doesn't seem like the
right thing either. I'm ok to live with the warning on older sphinx.
Thanks for replying.
Kevin.
> /Bruce
>
prev parent reply other threads:[~2022-03-31 16:30 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-31 13:26 Kevin Traynor
2022-03-31 13:51 ` Bruce Richardson
2022-03-31 16:29 ` Kevin Traynor [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=ed87d292-d2ed-8ead-5433-8b65a5762308@redhat.com \
--to=ktraynor@redhat.com \
--cc=anatoly.burakov@intel.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=stable@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).