qemu/docs/interop/qemu-ga-ref.rst

QEMU Guest Agent Protocol Reference
===================================

..
   TODO: the old Texinfo manual used to note that this manual
   is GPL-v2-or-later. We should make that reader-visible
   both here and in our Sphinx manuals more generally.

..
   TODO: display the QEMU version, both here and in our Sphinx manuals
   more generally.

.. contents::
   :depth: 3

.. qapi-doc:: qga/qapi-schema.json
docs/interop: Convert qemu-ga-ref to rST 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. 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> Message-Id: <20200925162316.21205-9-peter.maydell@linaro.org> Reviewed-by: Markus Armbruster <armbru@redhat.com> [Unicode legacy literal dumbed down to plain string literal, TODO comment on displaying QEMU version added] Signed-off-by: Markus Armbruster <armbru@redhat.com> 2020-09-25 19:23:03 +03:00			`QEMU Guest Agent Protocol Reference`
			`===================================`

			`..`
			`TODO: the old Texinfo manual used to note that this manual`
			`is GPL-v2-or-later. We should make that reader-visible`
			`both here and in our Sphinx manuals more generally.`

			`..`
			`TODO: display the QEMU version, both here and in our Sphinx manuals`
			`more generally.`

docs: add table of contents to QAPI references The QAPI reference docs for the guest agent, storage daemon and QMP are all rather long and hard to navigate unless you already know the name of the command and can do full text search for it. A table of contents in each doc will help people locate stuff much more easily. Reviewed-by: Connor Kuehl <ckuehl@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> 2021-05-11 12:23:52 +03:00			`.. contents::`
			`:depth: 3`

docs/interop: Convert qemu-ga-ref to rST 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. 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> Message-Id: <20200925162316.21205-9-peter.maydell@linaro.org> Reviewed-by: Markus Armbruster <armbru@redhat.com> [Unicode legacy literal dumbed down to plain string literal, TODO comment on displaying QEMU version added] Signed-off-by: Markus Armbruster <armbru@redhat.com> 2020-09-25 19:23:03 +03:00			`.. qapi-doc:: qga/qapi-schema.json`