Commit d59157ea authored by Paolo Bonzini's avatar Paolo Bonzini
Browse files

docs: create interop/ subdirectory 



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: default avatarPaolo Bonzini <pbonzini@redhat.com>
parent 067b9136

.gitignore

+8 −8
Original line number Diff line number Diff line
@@ -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-*

Makefile

+40 −29
Original line number Diff line number Diff line
@@ -207,8 +207,8 @@ HELPERS-$(CONFIG_LINUX) = qemu-bridge-helper$(EXESUF) 


ifdef BUILD_DOCS

DOCS=qemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga.8

DOCS+=docs/qemu-qmp-ref.html docs/qemu-qmp-ref.txt docs/qemu-qmp-ref.7

DOCS+=docs/qemu-ga-ref.html docs/qemu-ga-ref.txt docs/qemu-ga-ref.7

DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7

DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7

ifdef CONFIG_VIRTFS

DOCS+=fsdev/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 \ 


# documentation

MAKEINFO=makeinfo

MAKEINFOFLAGS=--no-split --number-sections -I docs

TEXIFLAG=$(if $(V),,--quiet)

MAKEINFOINCLUDES= -I docs -I $(<D) -I $(@D)

MAKEINFOFLAGS=--no-split --number-sections $(MAKEINFOINCLUDES)

TEXI2PODFLAGS=$(MAKEINFOINCLUDES)

TEXI2PDFFLAGS=$(if $(V),,--quiet) -I $(SRC_PATH) $(MAKEINFOINCLUDES)



docs/version.texi: $(SRC_PATH)/VERSION

	$(call quiet-command,echo "@set VERSION $(VERSION)" > $@,"GEN","$@")
@@ -684,10 +687,14 @@ docs/version.texi: $(SRC_PATH)/VERSION 
	--plaintext $< -o $@,"GEN","$@")



%.pdf: %.texi

	$(call quiet-command,texi2pdf $(TEXIFLAG) -I $(SRC_PATH) -I docs $< -o $@,"GEN","$@")

	$(call quiet-command,texi2pdf $(TEXI2PDFFLAGS) $< -o $@,"GEN","$@")



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/qemu-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



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","$@")



docs/qemu-qmp-qapi.texi docs/qemu-ga-qapi.texi: $(SRC_PATH)/scripts/qapi2texi.py $(qapi-py)

docs/interop/qemu-qmp-qapi.texi docs/interop/qemu-ga-qapi.texi: $(SRC_PATH)/scripts/qapi2texi.py $(qapi-py)



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","$@")



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","$@")



qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi
@@ -716,21 +723,25 @@ fsdev/virtfs-proxy-helper.1: fsdev/virtfs-proxy-helper.texi 
qemu-nbd.8: qemu-nbd.texi qemu-option-trace.texi

qemu-ga.8: qemu-ga.texi



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-ref.html

info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-ref.info

pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf

txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt



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



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



docs/qemu-qmp-ref.dvi docs/qemu-qmp-ref.html docs/qemu-qmp-ref.info docs/qemu-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





ifdef CONFIG_WIN32

configure

+1 −1
Original line number Diff line number Diff line
@@ -6374,7 +6374,7 @@ fi 


# build tree in object directory in case the source is not in the current directory

DIRS="tests tests/tcg tests/tcg/cris tests/tcg/lm32 tests/libqos tests/qapi-schema tests/tcg/xtensa tests/qemu-iotests"

DIRS="$DIRS docs fsdev"

DIRS="$DIRS docs docs/interop fsdev"

DIRS="$DIRS pc-bios/optionrom pc-bios/spapr-rtas pc-bios/s390-ccw"

DIRS="$DIRS roms/seabios roms/vgabios"

DIRS="$DIRS qapi-generated"

docs/specs/parallels.txt→docs/interop/parallels.txt

+0 −0

File moved.

View file

docs/specs/qcow2.txt→docs/interop/qcow2.txt

+0 −0

File moved.

View file