[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 04/17] docs: generate qemu-storage-daemon-qmp-ref(7) man page
From: |
Kevin Wolf |
Subject: |
[PULL 04/17] docs: generate qemu-storage-daemon-qmp-ref(7) man page |
Date: |
Fri, 18 Dec 2020 13:10:28 +0100 |
From: Stefan Hajnoczi <stefanha@redhat.com>
Although individual qemu-storage-daemon QMP commands are identical to
QEMU QMP commands, qemu-storage-daemon only supports a subset of QEMU's
QMP commands. Generate a manual page of just the commands supported by
qemu-storage-daemon so that users know exactly what is available in
qemu-storage-daemon.
Add an h1 heading in storage-daemon/qapi/qapi-schema.json so that
block-core.json is at the h2 heading level.
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Message-Id: <20201209103802.350848-2-stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
---
docs/interop/conf.py | 2 ++
docs/interop/index.rst | 1 +
docs/interop/qemu-storage-daemon-qmp-ref.rst | 13 +++++++++++++
docs/meson.build | 1 +
storage-daemon/qapi/qapi-schema.json | 3 +++
5 files changed, 20 insertions(+)
create mode 100644 docs/interop/qemu-storage-daemon-qmp-ref.rst
diff --git a/docs/interop/conf.py b/docs/interop/conf.py
index 2634ca3410..f4370aaa13 100644
--- a/docs/interop/conf.py
+++ b/docs/interop/conf.py
@@ -23,4 +23,6 @@ man_pages = [
[], 7),
('qemu-qmp-ref', 'qemu-qmp-ref', 'QEMU QMP Reference Manual',
[], 7),
+ ('qemu-storage-daemon-qmp-ref', 'qemu-storage-daemon-qmp-ref',
+ 'QEMU Storage Daemon QMP Reference Manual', [], 7),
]
diff --git a/docs/interop/index.rst b/docs/interop/index.rst
index cd78d679d8..95d56495f6 100644
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -20,6 +20,7 @@ Contents:
qemu-ga
qemu-ga-ref
qemu-qmp-ref
+ qemu-storage-daemon-qmp-ref
vhost-user
vhost-user-gpu
vhost-vdpa
diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.rst
b/docs/interop/qemu-storage-daemon-qmp-ref.rst
new file mode 100644
index 0000000000..caf9dad23a
--- /dev/null
+++ b/docs/interop/qemu-storage-daemon-qmp-ref.rst
@@ -0,0 +1,13 @@
+QEMU Storage Daemon QMP Reference Manual
+========================================
+
+..
+ 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.
+
+.. qapi-doc:: storage-daemon/qapi/qapi-schema.json
diff --git a/docs/meson.build b/docs/meson.build
index bb8fe4c9e4..71641b4fe0 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -56,6 +56,7 @@ if build_docs
'qemu-ga.8': (have_tools ? 'man8' : ''),
'qemu-ga-ref.7': 'man7',
'qemu-qmp-ref.7': 'man7',
+ 'qemu-storage-daemon-qmp-ref.7': (have_tools ? 'man7' : ''),
},
'tools': {
'qemu-img.1': (have_tools ? 'man1' : ''),
diff --git a/storage-daemon/qapi/qapi-schema.json
b/storage-daemon/qapi/qapi-schema.json
index c6ad5ae1e3..28117c3aac 100644
--- a/storage-daemon/qapi/qapi-schema.json
+++ b/storage-daemon/qapi/qapi-schema.json
@@ -15,6 +15,9 @@
{ 'include': '../../qapi/pragma.json' }
+##
+# = Block devices
+##
{ 'include': '../../qapi/block-core.json' }
{ 'include': '../../qapi/block-export.json' }
{ 'include': '../../qapi/char.json' }
--
2.29.2
- [PULL 00/17] Block layer patches, Kevin Wolf, 2020/12/18
- [PULL 01/17] iotests/210: Fix reference output, Kevin Wolf, 2020/12/18
- [PULL 02/17] hw/block/nand: Decommission the NAND museum, Kevin Wolf, 2020/12/18
- [PULL 03/17] block/nfs: fix int overflow in nfs_client_open_qdict, Kevin Wolf, 2020/12/18
- [PULL 04/17] docs: generate qemu-storage-daemon-qmp-ref(7) man page,
Kevin Wolf <=
- [PULL 05/17] docs: add qemu-storage-daemon(1) man page, Kevin Wolf, 2020/12/18
- [PULL 06/17] MAINTAINERS: add Kevin Wolf as storage daemon maintainer, Kevin Wolf, 2020/12/18
- [PULL 07/17] iotests: make _filter_qom_path more strict, Kevin Wolf, 2020/12/18
- [PULL 08/17] iotests:172: use _filter_qom_path, Kevin Wolf, 2020/12/18
- [PULL 09/17] block/vpc: Make vpc_open() read the full dynamic header, Kevin Wolf, 2020/12/18
- [PULL 11/17] block/vpc: Don't abuse the footer buffer for dynamic header, Kevin Wolf, 2020/12/18
- [PULL 10/17] block/vpc: Don't abuse the footer buffer as BAT sector buffer, Kevin Wolf, 2020/12/18
- [PULL 13/17] block/vpc: Pad VHDDynDiskHeader, replace uint8_t[] buffers, Kevin Wolf, 2020/12/18
- [PULL 14/17] block/vpc: Use sizeof() instead of 1024 for dynamic header size, Kevin Wolf, 2020/12/18
- [PULL 12/17] block/vpc: Make vpc_checksum() take void *, Kevin Wolf, 2020/12/18