[dpdk-dev] [PATCH v2] doc: rework vm power manager user guide

Thomas Monjalon thomas at monjalon.net
Tue Feb 25 18:47:31 CET 2020


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 at 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.





More information about the dev mailing list