[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v3 08/12] docs/interop: Convert qemu-qmp-ref to rST
From: |
Peter Maydell |
Subject: |
[PATCH v3 08/12] docs/interop: Convert qemu-qmp-ref to rST |
Date: |
Tue, 25 Feb 2020 14:04:33 +0000 |
Convert qemu-qmp-ref to rST format. This includes dropping
the plain-text, pdf and info format outputs for this document;
as with all our other Sphinx-based documentation, we provide
HTML and manpage only.
The qemu-qmp-ref.rst is somewhat more stripped down than
the .texi was, because we do not (currently) attempt to
generate indexes for the commands, events and data types
being documented.
Again, we drop the direct link from index.html.in now that
the QMP ref is part of the interop manual.
Signed-off-by: Peter Maydell <address@hidden>
---
Makefile | 39 +++++------------
docs/index.html.in | 1 -
docs/interop/conf.py | 2 +
docs/interop/index.rst | 1 +
docs/interop/qemu-qmp-ref.rst | 4 ++
docs/interop/qemu-qmp-ref.texi | 80 ----------------------------------
6 files changed, 18 insertions(+), 109 deletions(-)
create mode 100644 docs/interop/qemu-qmp-ref.rst
delete mode 100644 docs/interop/qemu-qmp-ref.texi
diff --git a/Makefile b/Makefile
index bdda1232b27..f6e7f500416 100644
--- a/Makefile
+++ b/Makefile
@@ -126,7 +126,6 @@ GENERATED_QAPI_FILES += qapi/qapi-events.h
qapi/qapi-events.c
GENERATED_QAPI_FILES += $(QAPI_MODULES:%=qapi/qapi-events-%.h)
GENERATED_QAPI_FILES += $(QAPI_MODULES:%=qapi/qapi-events-%.c)
GENERATED_QAPI_FILES += qapi/qapi-introspect.c qapi/qapi-introspect.h
-GENERATED_QAPI_FILES += qapi/qapi-doc.texi
generated-files-y += $(GENERATED_QAPI_FILES)
@@ -352,8 +351,8 @@ ifeq
($(CONFIG_LINUX)$(CONFIG_SECCOMP)$(CONFIG_LIBCAP_NG),yyy)
DOCS+=$(MANUAL_BUILDDIR)/tools/virtiofsd.1
endif
DOCS+=$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7
-DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt
docs/interop/qemu-qmp-ref.7
DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-ga-ref.7
+DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-qmp-ref.7
DOCS+=docs/qemu-cpu-models.7
DOCS+=$(MANUAL_BUILDDIR)/index.html
ifdef CONFIG_VIRTFS
@@ -628,8 +627,7 @@ $(SRC_PATH)/scripts/qapi-gen.py
qga/qapi-generated/qga-qapi-types.c qga/qapi-generated/qga-qapi-types.h \
qga/qapi-generated/qga-qapi-visit.c qga/qapi-generated/qga-qapi-visit.h \
qga/qapi-generated/qga-qapi-commands.h qga/qapi-generated/qga-qapi-commands.c \
-qga/qapi-generated/qga-qapi-init-commands.h
qga/qapi-generated/qga-qapi-init-commands.c \
-qga/qapi-generated/qga-qapi-doc.texi: \
+qga/qapi-generated/qga-qapi-init-commands.h
qga/qapi-generated/qga-qapi-init-commands.c: \
qga/qapi-generated/qapi-gen-timestamp ;
qga/qapi-generated/qapi-gen-timestamp: $(SRC_PATH)/qga/qapi-schema.json
$(qapi-py)
$(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi-gen.py \
@@ -775,11 +773,6 @@ distclean: clean
rm -f config.log
rm -f linux-headers/asm
rm -f docs/version.texi
- rm -f docs/interop/qemu-qmp-qapi.texi
- rm -f docs/interop/qemu-qmp-ref.7
- rm -f docs/interop/qemu-qmp-ref.txt
- rm -f docs/interop/qemu-qmp-ref.pdf
- rm -f docs/interop/qemu-qmp-ref.html
rm -f docs/qemu-cpu-models.7
rm -rf .doctrees
$(call clean-manual,devel)
@@ -834,7 +827,7 @@ endif
# and also any sphinx-built manpages.
define install-manual =
for d in $$(cd $(MANUAL_BUILDDIR) && find $1 -type d); do $(INSTALL_DIR)
"$(DESTDIR)$(qemu_docdir)/$$d"; done
-for f in $$(cd $(MANUAL_BUILDDIR) && find $1 -type f -a '!' '(' -name
'*.[0-9]' -o -name 'qemu-*-qapi.*' -o -name 'qemu-qmp-ref.*' ')' ); do
$(INSTALL_DATA) "$(MANUAL_BUILDDIR)/$$f" "$(DESTDIR)$(qemu_docdir)/$$f"; done
+for f in $$(cd $(MANUAL_BUILDDIR) && find $1 -type f -a '!' -name '*.[0-9]');
do $(INSTALL_DATA) "$(MANUAL_BUILDDIR)/$$f" "$(DESTDIR)$(qemu_docdir)/$$f"; done
endef
# Note that we deliberately do not install the "devel" manual: it is
@@ -851,13 +844,11 @@ install-doc: $(DOCS) install-sphinxdocs
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)"
$(INSTALL_DATA) qemu-doc.html "$(DESTDIR)$(qemu_docdir)"
$(INSTALL_DATA) qemu-doc.txt "$(DESTDIR)$(qemu_docdir)"
- $(INSTALL_DATA) docs/interop/qemu-qmp-ref.html
"$(DESTDIR)$(qemu_docdir)"
- $(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)"
ifdef CONFIG_POSIX
$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
$(INSTALL_DATA) qemu.1 "$(DESTDIR)$(mandir)/man1"
$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man7"
- $(INSTALL_DATA) docs/interop/qemu-qmp-ref.7 "$(DESTDIR)$(mandir)/man7"
+ $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-qmp-ref.7
"$(DESTDIR)$(mandir)/man7"
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-block-drivers.7
"$(DESTDIR)$(mandir)/man7"
$(INSTALL_DATA) docs/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7"
ifeq ($(CONFIG_TOOLS),y)
@@ -1060,7 +1051,7 @@ endef
$(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel)
$(call build-manual,devel,html)
-$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop)
$(SRC_PATH)/qga/qapi-schema.json $(qapi-py)
+$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop)
$(SRC_PATH)/qga/qapi-schema.json $(qapi-modules) $(qapi-py)
$(call build-manual,interop,html)
$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
@@ -1073,9 +1064,9 @@ $(MANUAL_BUILDDIR)/tools/index.html: $(call
manual-deps,tools) $(SRC_PATH)/qemu-
$(call build-manual,tools,html)
$(call define-manpage-rule,interop,\
- qemu-ga.8 qemu-ga-ref.7,\
+ qemu-ga.8 qemu-ga-ref.7 qemu-qmp-ref.7,\
$(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/qga/qapi-schema.json \
- $(qapi-py))
+ $(qapi-modules) $(qapi-py))
$(call define-manpage-rule,system,qemu-block-drivers.7)
@@ -1098,17 +1089,14 @@ qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx
$(SRC_PATH)/scripts/hxtool
qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-info.hx
$(SRC_PATH)/scripts/hxtool
$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< >
$@,"GEN","$@")
-docs/interop/qemu-qmp-qapi.texi: qapi/qapi-doc.texi
- @cp -p $< $@
-
qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi
qemu-monitor-info.texi
qemu.1: qemu-option-trace.texi
docs/qemu-cpu-models.7: docs/qemu-cpu-models.texi
-html: qemu-doc.html docs/interop/qemu-qmp-ref.html sphinxdocs
-info: qemu-doc.info docs/interop/qemu-qmp-ref.info
-pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf
-txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt
+html: qemu-doc.html sphinxdocs
+info: qemu-doc.info
+pdf: qemu-doc.pdf
+txt: qemu-doc.txt
qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \
qemu-options.texi \
@@ -1117,11 +1105,6 @@ qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \
qemu-monitor-info.texi \
docs/qemu-cpu-models.texi docs/security.texi
-docs/interop/qemu-qmp-ref.dvi docs/interop/qemu-qmp-ref.html \
- docs/interop/qemu-qmp-ref.info docs/interop/qemu-qmp-ref.pdf \
- docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7: \
- docs/interop/qemu-qmp-ref.texi docs/interop/qemu-qmp-qapi.texi
-
$(filter %.1 %.7 %.8,$(DOCS)): scripts/texi2pod.pl
# Reports/Analysis
diff --git a/docs/index.html.in b/docs/index.html.in
index ce10ce55a23..ca321368be0 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -8,7 +8,6 @@
<h1>QEMU @@VERSION@@ Documentation</h1>
<ul>
<li><a href="qemu-doc.html">User Documentation</a></li>
- <li><a href="qemu-qmp-ref.html">QMP Reference Manual</a></li>
<li><a href="interop/index.html">System Emulation Management and
Interoperability Guide</a></li>
<li><a href="specs/index.html">System Emulation Guest Hardware
Specifications</a></li>
<li><a href="system/index.html">System Emulation User's
Guide</a></li>
diff --git a/docs/interop/conf.py b/docs/interop/conf.py
index e83632e0108..43de386d33d 100644
--- a/docs/interop/conf.py
+++ b/docs/interop/conf.py
@@ -21,4 +21,6 @@ man_pages = [
['Michael Roth <address@hidden>'], 8),
('qemu-ga-ref', 'qemu-ga-ref', u'QEMU Guest Agent Protocol Reference',
[], 7),
+ ('qemu-qmp-ref', 'qemu-qmp-ref', u'QEMU QMP Reference Manual',
+ [], 7),
]
diff --git a/docs/interop/index.rst b/docs/interop/index.rst
index f3af38dce17..2cd97c6ff42 100644
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -19,5 +19,6 @@ Contents:
pr-helper
qemu-ga
qemu-ga-ref
+ qemu-qmp-ref
vhost-user
vhost-user-gpu
diff --git a/docs/interop/qemu-qmp-ref.rst b/docs/interop/qemu-qmp-ref.rst
new file mode 100644
index 00000000000..e640903abaf
--- /dev/null
+++ b/docs/interop/qemu-qmp-ref.rst
@@ -0,0 +1,4 @@
+QEMU QMP Reference Manual
+=========================
+
+.. qapi-doc:: qapi/qapi-schema.json
diff --git a/docs/interop/qemu-qmp-ref.texi b/docs/interop/qemu-qmp-ref.texi
deleted file mode 100644
index bb25758bd02..00000000000
--- a/docs/interop/qemu-qmp-ref.texi
+++ /dev/null
@@ -1,80 +0,0 @@
-\input texinfo
-@setfilename qemu-qmp-ref.info
-
-@include version.texi
-
-@exampleindent 0
-@paragraphindent 0
-
-@settitle QEMU QMP Reference Manual
-
-@iftex
-@center @image{docs/qemu_logo}
-@end iftex
-
-@copying
-This is the QEMU QMP reference manual.
-
-Copyright @copyright{} 2016 The QEMU Project developers
-
-@quotation
-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
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-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
-@direntry
-* QEMU-QMP-Ref: (qemu-qmp-ref). QEMU QMP Reference Manual
-@end direntry
-
-@titlepage
-@title QMP Reference Manual
-@subtitle QEMU version @value{VERSION}
-@page
-@vskip 0pt plus 1filll
-@insertcopying
-@end titlepage
-
-@contents
-
-@ifnottex
-@node Top
-@top QEMU QMP reference
-@end ifnottex
-
-@menu
-* 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 qemu-qmp-qapi.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
-
-@bye
--
2.20.1
- [PATCH v3 00/12] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/02/25
- [PATCH v3 01/12] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/02/25
- [PATCH v3 02/12] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/02/25
- [PATCH v3 03/12] tests/qapi/doc-good.json: Clean up markup, Peter Maydell, 2020/02/25
- [PATCH v3 04/12] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/02/25
- [PATCH v3 05/12] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/02/25
- [PATCH v3 09/12] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/02/25
- [PATCH v3 06/12] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/02/25
- [PATCH v3 07/12] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/02/25
- [PATCH v3 10/12] qga/qapi-schema.json: Add some headings, Peter Maydell, 2020/02/25
- [PATCH v3 08/12] docs/interop: Convert qemu-qmp-ref to rST,
Peter Maydell <=
- [PATCH v3 12/12] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions, Peter Maydell, 2020/02/25
- [PATCH v3 11/12] scripts/qapi: Remove texinfo generation support, Peter Maydell, 2020/02/25
- Re: [PATCH v3 00/12] Convert QAPI doc comments to generate rST instead of texinfo, Markus Armbruster, 2020/02/26