From: Thomas Monjalon <thomas@monjalon.net>
To: David Hunt <david.hunt@intel.com>,
john.mcnamara@intel.com, marko.kovacevic@intel.com
Cc: Ferruh Yigit <ferruh.yigit@intel.com>,
Bernard Iremonger <bernard.iremonger@intel.com>,
dev@dpdk.org, David Marchand <david.marchand@redhat.com>,
Bruce Richardson <bruce.richardson@intel.com>,
techboard@dpdk.org
Subject: Re: [dpdk-dev] [PATCH v2] doc: rework vm power manager user guide
Date: Tue, 25 Feb 2020 18:47:31 +0100 [thread overview]
Message-ID: <2094532.KTMopqUuYO@xps> (raw)
In-Reply-To: <2915716.TQGk6oTFT5@xps>
25/02/2020 17:59, Thomas Monjalon:
> 25/02/2020 17:46, Ferruh Yigit:
> > On 2/17/2020 10:48 AM, David Hunt wrote:
> > > Review and re-work of vm_power_manager documentation. Hopefully this
> > > is clearer, easier to follow.
> > >
> > > Signed-off-by: David Hunt <david.hunt@intel.com>
> > <...>
> >
> > Bernard reported following errors [1] in DPDK 20.02-rc4 caused by this patch,
> > while building the docs in Ubuntu with "Sphinx (sphinx-build) 1.3.6".
> >
> > I can't reproduce it with "sphinx-build 1.8.5" on Ubuntu, or with "sphinx-build
> > 2.3.1" on Fedora.
> >
> > I am putting this as a record, not sure if something needs to be done.
> >
> > @John, do we have a minimum required sphinx version required?
> >
> >
> >
> > [1]
> > .../doc/guides/sample_app_ug/vm_power_management.rst:420: ERROR: Malformed table.
> > Column span alignment problem in table line 5.
> >
> > .../doc/guides/sample_app_ug/vm_power_management.rst:545: ERROR: Malformed table.
> > Column span alignment problem in table line 5.
> >
> > .../doc/guides/sample_app_ug/vm_power_management.rst:754: ERROR: Malformed table.
> > Column span alignment problem in table line 5.
>
>
> Thank you for reporting.
> I was testing PDF on the server at the same time and discovered this issue.
>
> We should avoid big tables.
> Here the table have only two columns so they can be formatted differently.
> One option is to use the definition lists:
> https://docutils.sourceforge.io/docs/user/rst/quickref.html#definition-lists
>
> Please could we have a fix very quickly?
> It is a blocker for the release (planned to be done in the next hour).
I did the fix myself.
I think we must talk about having a doc maintainer, really.
prev parent reply other threads:[~2020-02-25 17:47 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-07 9:13 [dpdk-dev] [PATCH v1] " David Hunt
2020-02-16 11:13 ` Thomas Monjalon
2020-02-17 10:44 ` Hunt, David
2020-02-17 10:48 ` [dpdk-dev] [PATCH v2] " David Hunt
2020-02-21 18:02 ` Thomas Monjalon
2020-02-25 16:46 ` Ferruh Yigit
2020-02-25 16:59 ` Thomas Monjalon
2020-02-25 17:47 ` 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=2094532.KTMopqUuYO@xps \
--to=thomas@monjalon.net \
--cc=bernard.iremonger@intel.com \
--cc=bruce.richardson@intel.com \
--cc=david.hunt@intel.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
--cc=techboard@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).