mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: generate qemu-storage-daemon-qmp-ref(7) man page

Browse Source 
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>
This commit is contained in:
Stefan Hajnoczi 2020-12-09 10:38:00 +00:00 committed by Kevin Wolf
parent 182454dc63
commit 23c02ace35
5 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/interop/conf.py
View File

@ -23,4 +23,6 @@ man_pages = [
[], 7), [], 7),
('qemu-qmp-ref', 'qemu-qmp-ref', 'QEMU QMP Reference Manual', ('qemu-qmp-ref', 'qemu-qmp-ref', 'QEMU QMP Reference Manual',
[], 7), [], 7),
('qemu-storage-daemon-qmp-ref', 'qemu-storage-daemon-qmp-ref',
'QEMU Storage Daemon QMP Reference Manual', [], 7),
] ]

1
docs/interop/index.rst
View File

@ -20,6 +20,7 @@ Contents:
qemu-ga qemu-ga
qemu-ga-ref qemu-ga-ref
qemu-qmp-ref qemu-qmp-ref
qemu-storage-daemon-qmp-ref
vhost-user vhost-user
vhost-user-gpu vhost-user-gpu
vhost-vdpa vhost-vdpa

13
docs/interop/qemu-storage-daemon-qmp-ref.rst Normal file
View File

@ -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

1
docs/meson.build
View File

@ -56,6 +56,7 @@ if build_docs
'qemu-ga.8': (have_tools ? 'man8' : ''), 'qemu-ga.8': (have_tools ? 'man8' : ''),
'qemu-ga-ref.7': 'man7', 'qemu-ga-ref.7': 'man7',
'qemu-qmp-ref.7': 'man7', 'qemu-qmp-ref.7': 'man7',
'qemu-storage-daemon-qmp-ref.7': (have_tools ? 'man7' : ''),
}, },
'tools': { 'tools': {
'qemu-img.1': (have_tools ? 'man1' : ''), 'qemu-img.1': (have_tools ? 'man1' : ''),

3
storage-daemon/qapi/qapi-schema.json
View File

@ -15,6 +15,9 @@
{ 'include': '../../qapi/pragma.json' } { 'include': '../../qapi/pragma.json' }
##
# = Block devices
##
{ 'include': '../../qapi/block-core.json' } { 'include': '../../qapi/block-core.json' }
{ 'include': '../../qapi/block-export.json' } { 'include': '../../qapi/block-export.json' }
{ 'include': '../../qapi/char.json' } { 'include': '../../qapi/char.json' }