Re: [PATCH v5 10/20] docs/interop: Convert qemu-ga-ref to rST

[Markus Armbruster]

Peter Maydell <peter.maydell@linaro.org> writes:

> Convert qemu-ga-ref to rST format. This includes dropping
> the plain-text, pdf and info format outputs for this document;
> as with all our other Sphinx-based documentation, we provide
> HTML and manpage only.
>
> The qemu-ga-ref.rst is somewhat more stripped down than
> the .texi was, because we do not (currently) attempt to
> generate indexes for the commands, events and data types
> being documented.

I'll miss the plain text output (I may get by with formatting the man
output, but even if that works, it's still an extra step).  Others may
miss the index.  Oh well, march of progress.

> As the GA ref is now part of the Sphinx 'interop' manual,
> we can delete the direct link from index.html.in.
>
> Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
[...]
> diff --git a/docs/interop/qemu-ga-ref.rst b/docs/interop/qemu-ga-ref.rst
> new file mode 100644
> index 00000000000..013eac0bb53
> --- /dev/null
> +++ b/docs/interop/qemu-ga-ref.rst
> @@ -0,0 +1,4 @@
> +QEMU Guest Agent Protocol Reference
> +===================================
> +
> +.. qapi-doc:: qga/qapi-schema.json
> diff --git a/docs/interop/qemu-ga-ref.texi b/docs/interop/qemu-ga-ref.texi
> deleted file mode 100644
> index ddb76ce1c2a..00000000000
> --- a/docs/interop/qemu-ga-ref.texi
> +++ /dev/null
> @@ -1,80 +0,0 @@
> -\input texinfo
> -@setfilename qemu-ga-ref.info
> -
> -@include version.texi
> -
> -@exampleindent 0
> -@paragraphindent 0
> -
> -@settitle QEMU Guest Agent Protocol Reference
> -
> -@iftex
> -@center @image{docs/qemu_logo}
> -@end iftex
> -
> -@copying
> -This is the QEMU Guest Agent Protocol reference manual.
> -
> -Copyright @copyright{} 2016 The QEMU Project developers
> -
> -@quotation
> -This manual is free documentation: you can redistribute it and/or
> -modify it under the terms of the GNU General Public License as
> -published by the Free Software Foundation, either version 2 of the
> -License, or (at your option) any later version.
> -
> -This manual is distributed in the hope that it will be useful, but
> -WITHOUT ANY WARRANTY; without even the implied warranty of
> -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
> -General Public License for more details.
> -
> -You should have received a copy of the GNU General Public License
> -along with this manual.  If not, see http://www.gnu.org/licenses/.
> -@end quotation
> -@end copying

Does the interop manual carry an equivalent copyright notice?

[...]
> diff --git a/Makefile b/Makefile
> index 13dd708c4af..f0cca10b427 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -371,7 +371,7 @@ DOCS+=$(MANUAL_BUILDDIR)/tools/virtiofsd.1
>  endif
>  DOCS+=$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7
>  DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt 
> docs/interop/qemu-qmp-ref.7
> -DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt 
> docs/interop/qemu-ga-ref.7
> +DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-ga-ref.7
>  DOCS+=$(MANUAL_BUILDDIR)/system/qemu-cpu-models.7
>  DOCS+=$(MANUAL_BUILDDIR)/index.html
>  ifdef CONFIG_VIRTFS
> @@ -800,11 +800,11 @@ distclean: clean
>       rm -f config.log
>       rm -f linux-headers/asm
>       rm -f docs/version.texi
> -     rm -f docs/interop/qemu-ga-qapi.texi docs/interop/qemu-qmp-qapi.texi
> -     rm -f docs/interop/qemu-qmp-ref.7 docs/interop/qemu-ga-ref.7
> -     rm -f docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt
> -     rm -f docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf
> -     rm -f docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html
> +     rm -f docs/interop/qemu-qmp-qapi.texi
> +     rm -f docs/interop/qemu-qmp-ref.7
> +     rm -f docs/interop/qemu-qmp-ref.txt
> +     rm -f docs/interop/qemu-qmp-ref.pdf
> +     rm -f docs/interop/qemu-qmp-ref.html
>       rm -rf .doctrees
>       $(call clean-manual,devel)
>       $(call clean-manual,interop)

Please update .gitignore. as well.

[...]

Comments apply to the next patch, too.