[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH 1/2] docs/specs/index.rst: Fix minor syntax issu
From: |
Cédric Le Goater |
Subject: |
Re: [Qemu-devel] [PATCH 1/2] docs/specs/index.rst: Fix minor syntax issues |
Date: |
Mon, 10 Jun 2019 18:50:45 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.7.0 |
On 10/06/2019 17:24, Peter Maydell wrote:
> The docs/specs/index.rst has a couple of minor issues which
> we didn't notice because we weren't building the manual:
> * the ToC entry for the new PPC XIVE docs points to
> a nonexistent file
> * the initial comment needs to be marked by '..', not '.',
> or it will appear in the output
> * the title doesn't match the capitialization used by
> the existing interop or devel manuals, and uses
> 'full-system emulation' rather than the 'system emulation'
> that the interop manual title uses
>
> Fix these minor issues before we start trying to build the manual.
I only tested the pdf generation of each file with rst2pdf :/
> Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Cédric Le Goater <address@hidden>
Thanks,
C.
> ---
> docs/specs/index.rst | 9 +++++----
> 1 file changed, 5 insertions(+), 4 deletions(-)
>
> diff --git a/docs/specs/index.rst b/docs/specs/index.rst
> index 2e927519c2e..40adb97c5eb 100644
> --- a/docs/specs/index.rst
> +++ b/docs/specs/index.rst
> @@ -1,8 +1,8 @@
> -. This is the top level page for the 'specs' manual
> +.. This is the top level page for the 'specs' manual
>
>
> -QEMU full-system emulation guest hardware specifications
> -========================================================
> +QEMU System Emulation Guest Hardware Specifications
> +===================================================
>
>
> Contents:
> @@ -10,4 +10,5 @@ Contents:
> .. toctree::
> :maxdepth: 2
>
> - xive
> + ppc-xive
> + ppc-spapr-xive
>
[Qemu-devel] [PATCH 2/2] docs: Build and install specs manual, Peter Maydell, 2019/06/10