From nobody Thu Nov 6 08:34:28 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zoho.com; dkim=fail spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1497525455469727.9480815329767; Thu, 15 Jun 2017 04:17:35 -0700 (PDT) Received: from localhost ([::1]:53247 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dLSmL-0006AE-18 for importer@patchew.org; Thu, 15 Jun 2017 07:17:33 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:41300) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dLSPV-0000Jq-0H for qemu-devel@nongnu.org; Thu, 15 Jun 2017 06:54:00 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dLSPT-0007mF-96 for qemu-devel@nongnu.org; Thu, 15 Jun 2017 06:53:57 -0400 Received: from mail-wr0-x244.google.com ([2a00:1450:400c:c0c::244]:35335) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dLSPS-0007ll-W2 for qemu-devel@nongnu.org; Thu, 15 Jun 2017 06:53:55 -0400 Received: by mail-wr0-x244.google.com with SMTP id z45so2765241wrb.2 for ; Thu, 15 Jun 2017 03:53:54 -0700 (PDT) Received: from 640k.lan (94-39-191-51.adsl-ull.clienti.tiscali.it. [94.39.191.51]) by smtp.gmail.com with ESMTPSA id f21sm3258597wra.5.2017.06.15.03.53.51 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 15 Jun 2017 03:53:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:subject:date:message-id:in-reply-to:references; bh=V4CG9HvE2jxER2BW8szLtd8MLboBo8Qr4uPE//s5zA8=; b=SW3fp7LSzEy79LqGaOpZ9RSeayaX8kttDou9dxoldF/hNOyfh2+fL3ngAA7fqDmhAp pDo0GM0r1EEDhOHeP79gBvtwtMoD0XljmH5PM6+QAHO7EOvjUe8D0+TD5rZC9vNHSZwf xOnMbPGA1wk+Mu3HSEm66WhEXsYJ122zIIod1/2xPrE0Xl6np0fiuCRTGUrQT+N75Ixu NxLiq9IQJK++fFCfzsPO/iqRnX0EP8x9St5uZuhdrDtrBnVWyaO2u5YIjKnOoFoUf1pM mmBUjU5nAWJCt3ZD3ATqpxXsAY8jJWwrRzGdDGYOEei/zl0+2gyPABJnpOWwDMJh4lq6 rb2w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:subject:date:message-id :in-reply-to:references; bh=V4CG9HvE2jxER2BW8szLtd8MLboBo8Qr4uPE//s5zA8=; b=Zg7zBP6OnobnIN2j0olfQ1JuqhoSnSazXrci99EPKwmyvSL+chEnPtHsexFXPCprq0 dsoqWGeBc9O9TaglBorHzRk/KWLB5YoH40jX7XpDGdQ9GMeQUsbMmnjJEUAo0wccRj/0 g174J0eoRXzb99pWuXBvZqhDmCBrSfIF31Fg3mNYN41Njb9LzyzhpVdAJfSN73Hakjbf F7CFA6yccxpMstx2XvEftVJjyOKMlHwC3jM9tbVA228zqiUKwWAOikL2fe+OFJej284p 3NB/I6bpnyDx5+HUaoXLbMcyLFH41PpAx47EHtephO1VeDqevlyVOPW/JRpF/q5abywT 0efQ== X-Gm-Message-State: AKS2vOz/q2+Du4QgJ6TKlRkwpL9C66+0ZyAAF9LThnucTzPfpy2VbHCg d4aZSjmUT25QV2MZBAw= X-Received: by 10.28.13.211 with SMTP id 202mr3141282wmn.23.1497524033628; Thu, 15 Jun 2017 03:53:53 -0700 (PDT) From: Paolo Bonzini To: qemu-devel@nongnu.org Date: Thu, 15 Jun 2017 12:52:58 +0200 Message-Id: <1497523981-38449-39-git-send-email-pbonzini@redhat.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1497523981-38449-1-git-send-email-pbonzini@redhat.com> References: <1497523981-38449-1-git-send-email-pbonzini@redhat.com> X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:400c:c0c::244 Subject: [Qemu-devel] [PULL 38/41] docs: create interop/ subdirectory X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZohoMail: RDKM_2 RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" This is for the future interoperability & management guide. It includes the QAPI docs, including the automatically generated ones, other socket protocols (vhost-user, VNC), and the qcow2 file format. Signed-off-by: Paolo Bonzini --- .gitignore | 16 ++--- Makefile | 69 +++++++++++++-----= ---- configure | 2 +- docs/{specs =3D> interop}/parallels.txt | 0 docs/{specs =3D> interop}/qcow2.txt | 0 docs/{specs =3D> interop}/qed_spec.txt | 0 docs/{ =3D> interop}/qemu-ga-ref.texi | 0 docs/{ =3D> interop}/qemu-qmp-ref.texi | 0 docs/{ =3D> interop}/qmp-intro.txt | 0 docs/{ =3D> interop}/qmp-spec.txt | 0 docs/{specs =3D> interop}/vhost-user.txt | 0 .../{ =3D> interop}/vnc-ledstate-Pseudo-encoding.txt | 0 rules.mak | 2 +- 13 files changed, 50 insertions(+), 39 deletions(-) rename docs/{specs =3D> interop}/parallels.txt (100%) rename docs/{specs =3D> interop}/qcow2.txt (100%) rename docs/{specs =3D> interop}/qed_spec.txt (100%) rename docs/{ =3D> interop}/qemu-ga-ref.texi (100%) rename docs/{ =3D> interop}/qemu-qmp-ref.texi (100%) rename docs/{ =3D> interop}/qmp-intro.txt (100%) rename docs/{ =3D> interop}/qmp-spec.txt (100%) rename docs/{specs =3D> interop}/vhost-user.txt (100%) rename docs/{ =3D> interop}/vnc-ledstate-Pseudo-encoding.txt (100%) diff --git a/.gitignore b/.gitignore index 55a001e..11bb1b1 100644 --- a/.gitignore +++ b/.gitignore @@ -99,14 +99,14 @@ /pc-bios/optionrom/kvmvapic.img /pc-bios/s390-ccw/s390-ccw.elf /pc-bios/s390-ccw/s390-ccw.img -/docs/qemu-ga-qapi.texi -/docs/qemu-ga-ref.html -/docs/qemu-ga-ref.info* -/docs/qemu-ga-ref.txt -/docs/qemu-qmp-qapi.texi -/docs/qemu-qmp-ref.html -/docs/qemu-qmp-ref.info* -/docs/qemu-qmp-ref.txt +/docs/interop/qemu-ga-qapi.texi +/docs/interop/qemu-ga-ref.html +/docs/interop/qemu-ga-ref.info* +/docs/interop/qemu-ga-ref.txt +/docs/interop/qemu-qmp-qapi.texi +/docs/interop/qemu-qmp-ref.html +/docs/interop/qemu-qmp-ref.info* +/docs/interop/qemu-qmp-ref.txt /docs/version.texi *.tps .stgit-* diff --git a/Makefile b/Makefile index 32d4441..c27389a 100644 --- a/Makefile +++ b/Makefile @@ -207,8 +207,8 @@ HELPERS-$(CONFIG_LINUX) =3D qemu-bridge-helper$(EXESUF) =20 ifdef BUILD_DOCS DOCS=3Dqemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga.8 -DOCS+=3Ddocs/qemu-qmp-ref.html docs/qemu-qmp-ref.txt docs/qemu-qmp-ref.7 -DOCS+=3Ddocs/qemu-ga-ref.html docs/qemu-ga-ref.txt docs/qemu-ga-ref.7 +DOCS+=3Ddocs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/= interop/qemu-qmp-ref.7 +DOCS+=3Ddocs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/in= terop/qemu-ga-ref.7 ifdef CONFIG_VIRTFS DOCS+=3Dfsdev/virtfs-proxy-helper.1 endif @@ -519,11 +519,12 @@ distclean: clean rm -f qemu-doc.vr qemu-doc.txt rm -f config.log rm -f linux-headers/asm - rm -f docs/qemu-ga-qapi.texi docs/qemu-qmp-qapi.texi docs/version.texi - rm -f docs/qemu-qmp-ref.7 docs/qemu-ga-ref.7 - rm -f docs/qemu-qmp-ref.txt docs/qemu-ga-ref.txt - rm -f docs/qemu-qmp-ref.pdf docs/qemu-ga-ref.pdf - rm -f docs/qemu-qmp-ref.html docs/qemu-ga-ref.html + rm -f docs/version.texi + rm -f docs/interop/qemu-ga-qapi.texi docs/interop/qemu-qmp-qapi.texi + rm -f docs/interop/qemu-qmp-ref.7 docs/interop/qemu-ga-ref.7 + rm -f docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt + rm -f docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf + rm -f docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html for d in $(TARGET_DIRS); do \ rm -rf $$d || exit 1 ; \ done @@ -562,13 +563,13 @@ install-doc: $(DOCS) $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) qemu-doc.html "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) qemu-doc.txt "$(DESTDIR)$(qemu_docdir)" - $(INSTALL_DATA) docs/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)" - $(INSTALL_DATA) docs/qemu-qmp-ref.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/qemu-qmp-ref.7 "$(DESTDIR)$(mandir)/man7" + $(INSTALL_DATA) docs/interop/qemu-qmp-ref.7 "$(DESTDIR)$(mandir)/man7" ifneq ($(TOOLS),) $(INSTALL_DATA) qemu-img.1 "$(DESTDIR)$(mandir)/man1" $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8" @@ -576,9 +577,9 @@ ifneq ($(TOOLS),) endif ifneq (,$(findstring qemu-ga,$(TOOLS))) $(INSTALL_DATA) qemu-ga.8 "$(DESTDIR)$(mandir)/man8" - $(INSTALL_DATA) docs/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)" - $(INSTALL_DATA) docs/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)" - $(INSTALL_DATA) docs/qemu-ga-ref.7 "$(DESTDIR)$(mandir)/man7" + $(INSTALL_DATA) docs/interop/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)" + $(INSTALL_DATA) docs/interop/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)" + $(INSTALL_DATA) docs/interop/qemu-ga-ref.7 "$(DESTDIR)$(mandir)/man7" endif endif ifdef CONFIG_VIRTFS @@ -666,8 +667,10 @@ ui/console-gl.o: $(SRC_PATH)/ui/console-gl.c \ =20 # documentation MAKEINFO=3Dmakeinfo -MAKEINFOFLAGS=3D--no-split --number-sections -I docs -TEXIFLAG=3D$(if $(V),,--quiet) +MAKEINFOINCLUDES=3D -I docs -I $( $@,"GEN","$@") @@ -684,10 +687,14 @@ docs/version.texi: $(SRC_PATH)/VERSION --plaintext $< -o $@,"GEN","$@") =20 %.pdf: %.texi - $(call quiet-command,texi2pdf $(TEXIFLAG) -I $(SRC_PATH) -I docs $< -o $@= ,"GEN","$@") + $(call quiet-command,texi2pdf $(TEXI2PDFFLAGS) $< -o $@,"GEN","$@") =20 -docs/qemu-ga-ref.html docs/qemu-ga-ref.info docs/qemu-ga-ref.txt docs/qemu= -ga-ref.pdf docs/qemu-ga-ref.7.pod: docs/version.texi -docs/qemu-qmp-ref.html docs/qemu-qmp-ref.info docs/qemu-qmp-ref.txt docs/q= emu-qmp-ref.pdf docs/qemu-qmp-ref.pod: docs/version.texi +docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.info \ + docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.pdf \ + docs/interop/qemu-ga-ref.7.pod: docs/version.texi +docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.info \ + docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.pdf \ + docs/interop/qemu-qmp-ref.pod: docs/version.texi =20 qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@= ") @@ -701,12 +708,12 @@ qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-info= .hx $(SRC_PATH)/scripts/hxt qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/scripts/hxtool $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@= ") =20 -docs/qemu-qmp-qapi.texi docs/qemu-ga-qapi.texi: $(SRC_PATH)/scripts/qapi2t= exi.py $(qapi-py) +docs/interop/qemu-qmp-qapi.texi docs/interop/qemu-ga-qapi.texi: $(SRC_PATH= )/scripts/qapi2texi.py $(qapi-py) =20 -docs/qemu-qmp-qapi.texi: $(qapi-modules) +docs/interop/qemu-qmp-qapi.texi: $(qapi-modules) $(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi2texi.py $< > $@,"= GEN","$@") =20 -docs/qemu-ga-qapi.texi: $(SRC_PATH)/qga/qapi-schema.json +docs/interop/qemu-ga-qapi.texi: $(SRC_PATH)/qga/qapi-schema.json $(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi2texi.py $< > $@,"= GEN","$@") =20 qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-inf= o.texi @@ -716,21 +723,25 @@ fsdev/virtfs-proxy-helper.1: fsdev/virtfs-proxy-helpe= r.texi qemu-nbd.8: qemu-nbd.texi qemu-option-trace.texi qemu-ga.8: qemu-ga.texi =20 -html: qemu-doc.html docs/qemu-qmp-ref.html docs/qemu-ga-ref.html -info: qemu-doc.info docs/qemu-qmp-ref.info docs/qemu-ga-ref.info -pdf: qemu-doc.pdf docs/qemu-qmp-ref.pdf docs/qemu-ga-ref.pdf -txt: qemu-doc.txt docs/qemu-qmp-ref.txt docs/qemu-ga-ref.txt +html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-re= f.html +info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-re= f.info +pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.p= df +txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.t= xt =20 qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \ qemu-img.texi qemu-nbd.texi qemu-options.texi qemu-option-trace.texi \ qemu-monitor.texi qemu-img-cmds.texi qemu-ga.texi \ qemu-monitor-info.texi =20 -docs/qemu-ga-ref.dvi docs/qemu-ga-ref.html docs/qemu-ga-ref.info docs/qemu= -ga-ref.pdf docs/qemu-ga-ref.txt docs/qemu-ga-ref.7: \ -docs/qemu-ga-ref.texi docs/qemu-ga-qapi.texi +docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \ + docs/interop/qemu-ga-ref.info docs/interop/qemu-ga-ref.pdf \ + docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7: \ + docs/interop/qemu-ga-ref.texi docs/interop/qemu-ga-qapi.texi =20 -docs/qemu-qmp-ref.dvi docs/qemu-qmp-ref.html docs/qemu-qmp-ref.info docs/q= emu-qmp-ref.pdf docs/qemu-qmp-ref.txt docs/qemu-qmp-ref.7: \ -docs/qemu-qmp-ref.texi docs/qemu-qmp-qapi.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 =20 =20 ifdef CONFIG_WIN32 diff --git a/configure b/configure index 48d5ceb..f70a3b5 100755 --- a/configure +++ b/configure @@ -6374,7 +6374,7 @@ fi =20 # build tree in object directory in case the source is not in the current = directory DIRS=3D"tests tests/tcg tests/tcg/cris tests/tcg/lm32 tests/libqos tests/q= api-schema tests/tcg/xtensa tests/qemu-iotests" -DIRS=3D"$DIRS docs fsdev" +DIRS=3D"$DIRS docs docs/interop fsdev" DIRS=3D"$DIRS pc-bios/optionrom pc-bios/spapr-rtas pc-bios/s390-ccw" DIRS=3D"$DIRS roms/seabios roms/vgabios" DIRS=3D"$DIRS qapi-generated" diff --git a/docs/specs/parallels.txt b/docs/interop/parallels.txt similarity index 100% rename from docs/specs/parallels.txt rename to docs/interop/parallels.txt diff --git a/docs/specs/qcow2.txt b/docs/interop/qcow2.txt similarity index 100% rename from docs/specs/qcow2.txt rename to docs/interop/qcow2.txt diff --git a/docs/specs/qed_spec.txt b/docs/interop/qed_spec.txt similarity index 100% rename from docs/specs/qed_spec.txt rename to docs/interop/qed_spec.txt diff --git a/docs/qemu-ga-ref.texi b/docs/interop/qemu-ga-ref.texi similarity index 100% rename from docs/qemu-ga-ref.texi rename to docs/interop/qemu-ga-ref.texi diff --git a/docs/qemu-qmp-ref.texi b/docs/interop/qemu-qmp-ref.texi similarity index 100% rename from docs/qemu-qmp-ref.texi rename to docs/interop/qemu-qmp-ref.texi diff --git a/docs/qmp-intro.txt b/docs/interop/qmp-intro.txt similarity index 100% rename from docs/qmp-intro.txt rename to docs/interop/qmp-intro.txt diff --git a/docs/qmp-spec.txt b/docs/interop/qmp-spec.txt similarity index 100% rename from docs/qmp-spec.txt rename to docs/interop/qmp-spec.txt diff --git a/docs/specs/vhost-user.txt b/docs/interop/vhost-user.txt similarity index 100% rename from docs/specs/vhost-user.txt rename to docs/interop/vhost-user.txt diff --git a/docs/vnc-ledstate-Pseudo-encoding.txt b/docs/interop/vnc-ledst= ate-Pseudo-encoding.txt similarity index 100% rename from docs/vnc-ledstate-Pseudo-encoding.txt rename to docs/interop/vnc-ledstate-Pseudo-encoding.txt diff --git a/rules.mak b/rules.mak index 2a2fb72..6e94333 100644 --- a/rules.mak +++ b/rules.mak @@ -377,7 +377,7 @@ define unnest-vars endef =20 TEXI2MAN =3D $(call quiet-command, \ - perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl -I docs $< $@.pod && \ + perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $(TEXI2PODFLAGS) $< $@.pod &&= \ $(POD2MAN) --section=3D$(subst .,,$(suffix $@)) --center=3D" " --release= =3D" " $@.pod > $@, \ "GEN","$@") =20 --=20 1.8.3.1