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>
---
docs/interop/index.rst | 1 +
docs/interop/qemu-storage-daemon-qmp-ref.rst | 13 +++++++++++++
storage-daemon/qapi/qapi-schema.json | 3 +++
docs/interop/conf.py | 2 ++
docs/meson.build | 1 +
5 files changed, 20 insertions(+)
create mode 100644 docs/interop/qemu-storage-daemon-qmp-ref.rst
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/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' }
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/meson.build b/docs/meson.build
index ebd85d59f9..df5dc50485 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' : ''),
--
2.28.0
Am 09.12.2020 um 11:38 hat Stefan Hajnoczi geschrieben: > 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> > --- > docs/interop/index.rst | 1 + > docs/interop/qemu-storage-daemon-qmp-ref.rst | 13 +++++++++++++ > storage-daemon/qapi/qapi-schema.json | 3 +++ > docs/interop/conf.py | 2 ++ > docs/meson.build | 1 + > 5 files changed, 20 insertions(+) > create mode 100644 docs/interop/qemu-storage-daemon-qmp-ref.rst > > 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 Did you intend to actually merge the TODO comments like this into master or was this meant to be resolved before you send the series? Kevin
On Tue, Dec 15, 2020 at 05:11:06PM +0100, Kevin Wolf wrote: > > 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 > > Did you intend to actually merge the TODO comments like this into master > or was this meant to be resolved before you send the series? Thanks for pointing this out. Both qemu-qmp-ref.rst and qemu-ga-ref.rst have these comments and I copied them when creating the file. I don't intend to try to solve that in this series. Would you like to keep the comments or should I drop them?
On Wed, 16 Dec 2020 at 16:21, Stefan Hajnoczi <stefanha@redhat.com> wrote: > > On Tue, Dec 15, 2020 at 05:11:06PM +0100, Kevin Wolf wrote: > > > 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 > > > > Did you intend to actually merge the TODO comments like this into master > > or was this meant to be resolved before you send the series? > > Thanks for pointing this out. Both qemu-qmp-ref.rst and qemu-ga-ref.rst > have these comments and I copied them when creating the file. I don't > intend to try to solve that in this series. > > Would you like to keep the comments or should I drop them? FWIW, the ones in those two docs are the result of a request from Markus when we were doing the conversion of QAPI generated docs from Texinfo to rST -- the old separate Texinfo-generated docs ended up with a version/license statement in the generated docs. Fixing this depends I think on the "merge the 5 manuals into one single manual" patch; once that's done then it should be easier to have one consistent place to note license, copyright, version, etc. thanks -- PMM
Am 16.12.2020 um 17:21 hat Stefan Hajnoczi geschrieben: > On Tue, Dec 15, 2020 at 05:11:06PM +0100, Kevin Wolf wrote: > > > 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 > > > > Did you intend to actually merge the TODO comments like this into master > > or was this meant to be resolved before you send the series? > > Thanks for pointing this out. Both qemu-qmp-ref.rst and qemu-ga-ref.rst > have these comments and I copied them when creating the file. I don't > intend to try to solve that in this series. > > Would you like to keep the comments or should I drop them? Ah, I see. If the same already exists in other places, I'll just merge it as it is. Thanks! Kevin
On Wed, Dec 16, 2020 at 06:59:03PM +0100, Kevin Wolf wrote: > Am 16.12.2020 um 17:21 hat Stefan Hajnoczi geschrieben: > > On Tue, Dec 15, 2020 at 05:11:06PM +0100, Kevin Wolf wrote: > > > > 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 > > > > > > Did you intend to actually merge the TODO comments like this into master > > > or was this meant to be resolved before you send the series? > > > > Thanks for pointing this out. Both qemu-qmp-ref.rst and qemu-ga-ref.rst > > have these comments and I copied them when creating the file. I don't > > intend to try to solve that in this series. > > > > Would you like to keep the comments or should I drop them? > > Ah, I see. If the same already exists in other places, I'll just merge > it as it is. Thanks! Great, thanks! Stefan
© 2016 - 2026 Red Hat, Inc.