[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v5 11/20] docs/interop: Convert qemu-qmp-ref to rST
From: |
Peter Maydell |
Subject: |
[PATCH v5 11/20] docs/interop: Convert qemu-qmp-ref to rST |
Date: |
Mon, 10 Aug 2020 20:50:10 +0100 |
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.
This commit removes the 'info', 'txt' and 'pdf' Makefile
targets, because we no longer generate any documentation
except for the Sphinx HTML manuals and the manpages.
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
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 ----------------------------------
Makefile | 38 ++++------------
6 files changed, 15 insertions(+), 111 deletions(-)
create mode 100644 docs/interop/qemu-qmp-ref.rst
delete mode 100644 docs/interop/qemu-qmp-ref.texi
diff --git a/docs/index.html.in b/docs/index.html.in
index 99d4d8075fc..b3dfb7a4611 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -12,7 +12,6 @@
<li><a href="tools/index.html">Tools Guide</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="interop/qemu-qmp-ref.html">QMP Reference
Manual</a></li>
</ul>
</body>
</html>
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 <mdroth@linux.vnet.ibm.com>'], 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 738cdbe185e..cd78d679d82 100644
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -19,6 +19,7 @@ Contents:
pr-helper
qemu-ga
qemu-ga-ref
+ qemu-qmp-ref
vhost-user
vhost-user-gpu
vhost-vdpa
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
diff --git a/Makefile b/Makefile
index f0cca10b427..3df1cf68333 100644
--- a/Makefile
+++ b/Makefile
@@ -123,7 +123,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
# The following list considers only the storage daemon main module. All other
# modules are currently shared with the main schema, so we don't actually
@@ -370,7 +369,6 @@ 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)/system/qemu-cpu-models.7
DOCS+=$(MANUAL_BUILDDIR)/index.html
@@ -644,8 +642,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 \
@@ -800,11 +797,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 -rf .doctrees
$(call clean-manual,devel)
$(call clean-manual,interop)
@@ -858,7 +850,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
@@ -874,14 +866,11 @@ install-sphinxdocs: sphinxdocs
install-doc: $(DOCS) install-sphinxdocs
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)"
- $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/interop"
- $(INSTALL_DATA) docs/interop/qemu-qmp-ref.html
"$(DESTDIR)$(qemu_docdir)/interop"
- $(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt
"$(DESTDIR)$(qemu_docdir)/interop"
ifdef CONFIG_POSIX
$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/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) $(MANUAL_BUILDDIR)/system/qemu-cpu-models.7
"$(DESTDIR)$(mandir)/man7"
ifeq ($(CONFIG_TOOLS),y)
@@ -1087,7 +1076,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)
@@ -1103,9 +1092,9 @@ $(MANUAL_BUILDDIR)/user/index.html: $(call
manual-deps,user)
$(call build-manual,user,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.1 qemu-block-drivers.7
qemu-cpu-models.7)
@@ -1119,18 +1108,7 @@ $(MANUAL_BUILDDIR)/index.html:
$(SRC_PATH)/docs/index.html.in qemu-version.h
$(call quiet-command, sed "s|@@VERSION@@|${VERSION}|g" $< >$@, \
"GEN","$@")
-docs/interop/qemu-qmp-qapi.texi: qapi/qapi-doc.texi
- @cp -p $< $@
-
-html: docs/interop/qemu-qmp-ref.html sphinxdocs
-info: docs/interop/qemu-qmp-ref.info
-pdf: docs/interop/qemu-qmp-ref.pdf
-txt: docs/interop/qemu-qmp-ref.txt
-
-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
+html: sphinxdocs
$(filter %.1 %.7 %.8,$(DOCS)): scripts/texi2pod.pl
@@ -1271,7 +1249,7 @@ endif
$(call print-help,vm-help,Help about targets running tests inside VM)
@echo ''
@echo 'Documentation targets:'
- $(call print-help,html info pdf txt,Build documentation in specified
format)
+ $(call print-help,html,Build HTML documentation)
ifdef CONFIG_GCOV
$(call print-help,coverage-report,Create code coverage report)
endif
--
2.20.1
- [PATCH v5 03/20] qapi/block-core.json: Fix nbd-server-start docs, (continued)
- [PATCH v5 03/20] qapi/block-core.json: Fix nbd-server-start docs, Peter Maydell, 2020/08/10
- [PATCH v5 04/20] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/08/10
- [PATCH v5 05/20] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/08/10
- [PATCH v5 06/20] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension, Peter Maydell, 2020/08/10
- [PATCH v5 07/20] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/08/10
- [PATCH v5 08/20] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/08/10
- [PATCH v5 10/20] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/08/10
- [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/08/10
- [PATCH v5 11/20] docs/interop: Convert qemu-qmp-ref to rST,
Peter Maydell <=
- [PATCH v5 12/20] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/08/10
- [PATCH v5 13/20] qga/qapi-schema.json: Add some headings, Peter Maydell, 2020/08/10
- [PATCH v5 15/20] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions, Peter Maydell, 2020/08/10
- [PATCH v5 14/20] scripts/qapi: Remove texinfo generation support, Peter Maydell, 2020/08/10
- [PATCH v5 16/20] Makefile: Remove redundant Texinfo related rules, Peter Maydell, 2020/08/10
- [PATCH v5 18/20] Remove Texinfo related files from .gitignore and git.orderfile, Peter Maydell, 2020/08/10
- [PATCH v5 17/20] scripts/texi2pod: Delete unused script, Peter Maydell, 2020/08/10
- [PATCH v5 19/20] configure: Drop texinfo requirement, Peter Maydell, 2020/08/10
- [PATCH v5 20/20] Remove texinfo dependency from docker and CI configs, Peter Maydell, 2020/08/10
- Re: [PATCH v5 00/20] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/08/27