[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 01/13] docs: add table of contents to QAPI references
From: |
Daniel P . Berrangé |
Subject: |
[PULL 01/13] docs: add table of contents to QAPI references |
Date: |
Mon, 14 Jun 2021 15:15:37 +0100 |
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>
---
docs/interop/qemu-ga-ref.rst | 3 +++
docs/interop/qemu-qmp-ref.rst | 3 +++
docs/interop/qemu-storage-daemon-qmp-ref.rst | 3 +++
3 files changed, 9 insertions(+)
diff --git a/docs/interop/qemu-ga-ref.rst b/docs/interop/qemu-ga-ref.rst
index 3f1c4f908f..db1e946124 100644
--- a/docs/interop/qemu-ga-ref.rst
+++ b/docs/interop/qemu-ga-ref.rst
@@ -10,4 +10,7 @@ QEMU Guest Agent Protocol Reference
TODO: display the QEMU version, both here and in our Sphinx manuals
more generally.
+.. contents::
+ :depth: 3
+
.. qapi-doc:: qga/qapi-schema.json
diff --git a/docs/interop/qemu-qmp-ref.rst b/docs/interop/qemu-qmp-ref.rst
index c8abaaf8e3..b5bebf6b9a 100644
--- a/docs/interop/qemu-qmp-ref.rst
+++ b/docs/interop/qemu-qmp-ref.rst
@@ -10,4 +10,7 @@ QEMU QMP Reference Manual
TODO: display the QEMU version, both here and in our Sphinx manuals
more generally.
+.. contents::
+ :depth: 3
+
.. qapi-doc:: qapi/qapi-schema.json
diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.rst
b/docs/interop/qemu-storage-daemon-qmp-ref.rst
index caf9dad23a..d0ebb42ebd 100644
--- a/docs/interop/qemu-storage-daemon-qmp-ref.rst
+++ b/docs/interop/qemu-storage-daemon-qmp-ref.rst
@@ -10,4 +10,7 @@ QEMU Storage Daemon QMP Reference Manual
TODO: display the QEMU version, both here and in our Sphinx manuals
more generally.
+.. contents::
+ :depth: 3
+
.. qapi-doc:: storage-daemon/qapi/qapi-schema.json
--
2.31.1
- [PULL 00/13] Misc fixes patches, Daniel P . Berrangé, 2021/06/14
- [PULL 01/13] docs: add table of contents to QAPI references,
Daniel P . Berrangé <=
- [PULL 02/13] docs: document how to pass secret data to QEMU, Daniel P . Berrangé, 2021/06/14
- [PULL 03/13] docs: document usage of the authorization framework, Daniel P . Berrangé, 2021/06/14
- [PULL 04/13] docs: recommend SCRAM-SHA-256 SASL mech instead of SHA-1 variant, Daniel P . Berrangé, 2021/06/14
- [PULL 05/13] sasl: remove comment about obsolete kerberos versions, Daniel P . Berrangé, 2021/06/14
- [PULL 06/13] migration: add trace point when vm_stop_force_state fails, Daniel P . Berrangé, 2021/06/14
- [PULL 07/13] softmmu: add trace point when bdrv_flush_all fails, Daniel P . Berrangé, 2021/06/14
- [PULL 08/13] block: preserve errno from fdatasync failures, Daniel P . Berrangé, 2021/06/14
- [PULL 10/13] block: remove duplicate trace.h include, Daniel P . Berrangé, 2021/06/14
- [PULL 11/13] migration: use GDateTime for formatting timestamp in snapshot names, Daniel P . Berrangé, 2021/06/14
- [PULL 09/13] block: add trace point when fdatasync fails, Daniel P . Berrangé, 2021/06/14