| Message ID | 20190228145624.24885-2-peter.maydell@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Enable build and install of our rST docs | expand |
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é <philmd@redhat.com> Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com> > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > Reviewed-by: Alex Bennée <alex.bennee@linaro.org> > --- > 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 > { >
On Thu, 28 Feb 2019 at 16:14, Philippe Mathieu-Daudé <philmd@redhat.com> wrote: > 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? I didn't know about this option and it sounds like a good idea. But we probably want to only enable it on git builds (the same as with -Werror). I think I'd rather add -W after this lands (so we can see if it's generating warnings on any of our build hosts that would cause build failure that we need to fix before enabling it). thanks -- PMM
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 {
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. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Alex Bennée <alex.bennee@linaro.org> --- docs/cpu-hotplug.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) -- 2.20.1