[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 2/4] docs: generate qemu-storage-daemon-qmp-ref(7) man page

From: Stefan Hajnoczi
Subject: [PATCH 2/4] docs: generate qemu-storage-daemon-qmp-ref(7) man page
Date: Tue, 8 Sep 2020 10:31:11 +0100

Although qemu-storage-daemon QMP commands are identical to QEMU QMP
commands they are a subset. 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.

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
 docs/interop/qemu-storage-daemon-qmp-ref.texi | 80 +++++++++++++++++++
 meson.build                                   |  9 +++
 storage-daemon/qapi/meson.build               |  2 +
 3 files changed, 91 insertions(+)
 create mode 100644 docs/interop/qemu-storage-daemon-qmp-ref.texi

diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.texi 
new file mode 100644
index 0000000000..a6a70c9674
--- /dev/null
+++ b/docs/interop/qemu-storage-daemon-qmp-ref.texi
@@ -0,0 +1,80 @@
+\input texinfo
+@setfilename qemu-storage-daemon-qmp-ref.info
+@include version.texi
+@exampleindent 0
+@paragraphindent 0
+@settitle QEMU Storage Daemon QMP Reference Manual
+@center @image{docs/qemu_logo}
+@end iftex
+This is the QEMU Storage Daemon QMP reference manual.
+Copyright @copyright{} 2020 The QEMU Project developers
+This manual is free documentation: you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 2 of the
+License, or (at your option) any later version.
+This manual is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+General Public License for more details.
+You should have received a copy of the GNU General Public License
+along with this manual.  If not, see http://www.gnu.org/licenses/.
+@end quotation
+@end copying
+@dircategory QEMU
+* QEMU-Storage-Daemon-QMP-Ref: (qemu-storage-daemon-qmp-ref). QEMU Storage 
Daemon QMP Reference Manual
+@end direntry
+@title QEMU Storage Daemon QMP Reference Manual
+@subtitle QEMU version @value{VERSION}
+@vskip 0pt plus 1filll
+@end titlepage
+@node Top
+@top QEMU Storage Daemon QMP reference
+@end ifnottex
+* API Reference::
+* Commands and Events Index::
+* Data Types Index::
+@end menu
+@node API Reference
+@chapter API Reference
+@c for texi2pod:
+@c man begin DESCRIPTION
+@include storage-daemon/qapi/qapi-doc.texi
+@c man end
+@node Commands and Events Index
+@unnumbered Commands and Events Index
+@printindex fn
+@node Data Types Index
+@unnumbered Data Types Index
+@printindex tp
diff --git a/meson.build b/meson.build
index 5aaa364730..0ff19ce699 100644
--- a/meson.build
+++ b/meson.build
@@ -1162,6 +1162,15 @@ if build_docs
   if 'CONFIG_GUEST_AGENT' in config_host
     texi += {'qemu-ga-ref': ['docs/interop/qemu-ga-ref.texi', 
qga_qapi_doc_texi, version_texi]}
+  if have_tools
+    texi += {
+      'qemu-storage-daemon-qmp-ref': [
+       'docs/interop/qemu-storage-daemon-qmp-ref.texi',
+       qsd_qapi_doc_texi,
+       version_texi
+      ]
+    }
+  endif
   if makeinfo.found()
     cmd = [
diff --git a/storage-daemon/qapi/meson.build b/storage-daemon/qapi/meson.build
index cea618bec0..7c48a388d4 100644
--- a/storage-daemon/qapi/meson.build
+++ b/storage-daemon/qapi/meson.build
@@ -4,4 +4,6 @@ qsd_qapi_files = custom_target('QAPI files for 
                                command: [ qapi_gen, '-o', 
'storage-daemon/qapi', '@INPUT@' ],
                                depend_files: [ qapi_inputs, qapi_gen_depends ])
+qsd_qapi_doc_texi = qsd_qapi_files[-1]

reply via email to

[Prev in Thread] Current Thread [Next in Thread]