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

[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>
> 
> ---
> changes in v2
> * Fixed typos. Typos not found even with checkpatch from kernel 5.5.4, but
>   when the codespell package is installed, the typos are magically
>   revealed!
> * Moved the text blocks from within the high level image out into normal
>   text for easier future maintenance.
> ---
>  .../img/vm_power_mgr_highlevel.svg            | 2043 +++++++++++------
>  .../img/vm_power_mgr_vm_request_seq.svg       | 1455 +++++-------
>  .../sample_app_ug/vm_power_management.rst     | 1216 +++++-----
>  3 files changed, 2653 insertions(+), 2061 deletions(-)
> 

<...>

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.