[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH v2 01/11] docs/cpu-hotplug.rst: Fix rST markup i
From: |
Philippe Mathieu-Daudé |
Subject: |
Re: [Qemu-devel] [PATCH v2 01/11] docs/cpu-hotplug.rst: Fix rST markup issues |
Date: |
Thu, 28 Feb 2019 17:14:09 +0100 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.5.1 |
On 2/28/19 3:56 PM, Peter Maydell wrote:
> sphinx-build complains:
>
> docs/cpu-hotplug.rst:67: ERROR: Unexpected indentation.
> docs/cpu-hotplug.rst:69: ERROR: Unexpected indentation.
> docs/cpu-hotplug.rst:74: WARNING: Block quote ends without a blank line;
> unexpected unindent.
> docs/cpu-hotplug.rst:75: WARNING: Block quote ends without a blank line;
> unexpected unindent.
> docs/cpu-hotplug.rst:76: SEVERE: Unexpected section title.
>
> }
> {
> docs/cpu-hotplug.rst:78: WARNING: Block quote ends without a blank line;
> unexpected unindent.
>
> These are the result of not indicating one of the literal
> blocks by finishing the preceding paragraph with the "::" marker.
I applied your series then revert this patch to test how failures are
handled. On rebuild nothing happend, I was worried about caching then
remember something in your cover, read it again and understood this file
is not in watched directory so not generated.
Then I moved this file in a watched dir. I see warnings are not fatal,
and from the manpage there is the '-W' option:
sphinx-build(1)
-W Turn warnings into errors.
This means that the build stops at the first warning
and sphinx-build exits with exit status 1.
Can we use this by default, as of C warnings?
This should be our default on the CI builds anyway.
Meanwhile for this patch:
Reviewed-by: Philippe Mathieu-Daudé <address@hidden>
Tested-by: Philippe Mathieu-Daudé <address@hidden>
>
> Signed-off-by: Peter Maydell <address@hidden>
> Reviewed-by: Alex Bennée <address@hidden>
> ---
> docs/cpu-hotplug.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/docs/cpu-hotplug.rst b/docs/cpu-hotplug.rst
> index 1c268e00b41..e2d4e893b01 100644
> --- a/docs/cpu-hotplug.rst
> +++ b/docs/cpu-hotplug.rst
> @@ -60,7 +60,7 @@ vCPU hotplug
> hot-plugged (no "qom-path" member). From its output in step (3), we
> can see that ``IvyBridge-IBRS-x86_64-cpu`` is present in socket 0,
> while hot-plugging a CPU into socket 1 requires passing the listed
> - properties to QMP ``device_add``:
> + properties to QMP ``device_add``::
>
> (QEMU) device_add id=cpu-2 driver=IvyBridge-IBRS-x86_64-cpu
> socket-id=1 core-id=0 thread-id=0
> {
>
- [Qemu-devel] [PATCH v2 00/11] Enable build and install of our rST docs, Peter Maydell, 2019/02/28
- [Qemu-devel] [PATCH v2 01/11] docs/cpu-hotplug.rst: Fix rST markup issues, Peter Maydell, 2019/02/28
- Re: [Qemu-devel] [PATCH v2 01/11] docs/cpu-hotplug.rst: Fix rST markup issues,
Philippe Mathieu-Daudé <=
- [Qemu-devel] [PATCH v2 02/11] docs: Convert memory.txt to rst format, Peter Maydell, 2019/02/28
- [Qemu-devel] [PATCH v2 03/11] docs: Commit initial files from sphinx-quickstart, Peter Maydell, 2019/02/28
- [Qemu-devel] [PATCH v2 05/11] docs/conf.py: Configure the 'alabaster' theme, Peter Maydell, 2019/02/28
- [Qemu-devel] [PATCH v2 04/11] docs/conf.py: Disable unused _static directory, Peter Maydell, 2019/02/28
- [Qemu-devel] [PATCH v2 06/11] docs/conf.py: Don't include rST sources in HTML build, Peter Maydell, 2019/02/28
- [Qemu-devel] [PATCH v2 08/11] docs: Provide separate conf.py for each manual we want, Peter Maydell, 2019/02/28
- [Qemu-devel] [PATCH v2 07/11] docs/conf.py: Disable option warnings, Peter Maydell, 2019/02/28