Commit 56e8bdd4 authored by Marc-André Lureau's avatar Marc-André Lureau Committed by Markus Armbruster
Browse files

build-sys: add qapi doc generation targets 



Generate and install the man, txt and html versions of QAPI
documentation (generate and install qemu-doc.txt too).

Add it also to optional pdf/info targets.

Signed-off-by: default avatarMarc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20170113144135.5150-22-marcandre.lureau@redhat.com>
Reviewed-by: default avatarMarkus Armbruster <armbru@redhat.com>
Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
parent f8bab10b

.gitignore

+9 −0
Original line number Diff line number Diff line
@@ -105,6 +105,15 @@ 
/pc-bios/optionrom/kvmvapic.img

/pc-bios/s390-ccw/s390-ccw.elf

/pc-bios/s390-ccw/s390-ccw.img

/docs/qemu-ga-ref.html

/docs/qemu-ga-ref.txt

/docs/qemu-qmp-ref.html

/docs/qemu-qmp-ref.txt

docs/qemu-ga-ref.info*

docs/qemu-qmp-ref.info*

/qemu-ga-qapi.texi

/qemu-qapi.texi

*.tps

.stgit-*

cscope.*

tags

Makefile

+36 −7
Original line number Diff line number Diff line
@@ -91,6 +91,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

ifdef CONFIG_VIRTFS

DOCS+=fsdev/virtfs-proxy-helper.1

endif
@@ -265,6 +267,7 @@ qemu-ga$(EXESUF): QEMU_CFLAGS += -I qga/qapi-generated 
gen-out-type = $(subst .,-,$(suffix $@))



qapi-py = $(SRC_PATH)/scripts/qapi.py $(SRC_PATH)/scripts/ordereddict.py

qapi-py += $(SRC_PATH)/scripts/qapi2texi.py



qga/qapi-generated/qga-qapi-types.c qga/qapi-generated/qga-qapi-types.h :\

$(SRC_PATH)/qga/qapi-schema.json $(SRC_PATH)/scripts/qapi-types.py $(qapi-py)
@@ -393,6 +396,11 @@ distclean: clean 
	rm -f qemu-doc.vr

	rm -f config.log

	rm -f linux-headers/asm

	rm -f qemu-ga-qapi.texi qemu-qapi.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

	for d in $(TARGET_DIRS); do \

	rm -rf $$d || exit 1 ; \

        done
@@ -430,9 +438,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)"

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"

ifneq ($(TOOLS),)

	$(INSTALL_DATA) qemu-img.1 "$(DESTDIR)$(mandir)/man1"

	$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8"
@@ -440,6 +452,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"

endif

endif

ifdef CONFIG_VIRTFS
@@ -527,9 +542,10 @@ ui/console-gl.o: $(SRC_PATH)/ui/console-gl.c \ 
	ui/shader/texture-blit-vert.h ui/shader/texture-blit-frag.h



# documentation

MAKEINFO=makeinfo

MAKEINFO=makeinfo -D 'VERSION $(VERSION)'

MAKEINFOFLAGS=--no-split --number-sections

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

TEXIFLAG=$(if $(V),,--quiet) --command='@set VERSION $(VERSION)'



%.html: %.texi

	$(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \

	--html $< -o $@,"GEN","$@")
@@ -542,7 +558,7 @@ TEXIFLAG=$(if $(V),,--quiet) 
	--plaintext $< -o $@,"GEN","$@")



%.pdf: %.texi

	$(call quiet-command,texi2pdf $(TEXIFLAG) -I . $<,"GEN","$@")

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



qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool

	$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@")
@@ -556,6 +572,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","$@")



qemu-qapi.texi: $(qapi-modules) $(qapi-py)

	$(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi2texi.py $< > $@,"GEN" "$@")



qemu-ga-qapi.texi: $(SRC_PATH)/qga/qapi-schema.json $(qapi-py)

	$(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

qemu.1: qemu-option-trace.texi

qemu-img.1: qemu-img.texi qemu-option-trace.texi qemu-img-cmds.texi
@@ -563,16 +585,23 @@ 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

info: qemu-doc.info

pdf: qemu-doc.pdf

txt: qemu-doc.txt

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



qemu-doc.html qemu-doc.info qemu-doc.pdf: \

	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 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 qemu-qapi.texi





ifdef CONFIG_WIN32



INSTALLER = qemu-setup-$(VERSION)$(EXESUF)

configure

+1 −1
Original line number Diff line number Diff line
@@ -6198,7 +6198,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 fsdev"

DIRS="$DIRS docs 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/qmp-intro.txt

+1 −2
Original line number Diff line number Diff line
@@ -16,8 +16,7 @@ QMP is JSON[1] based and features the following: 
For detailed information on QMP's usage, please, refer to the following files:



o qmp-spec.txt      QEMU Machine Protocol current specification

o qmp-commands.txt  QMP supported commands (auto-generated at build-time)

o qmp-events.txt    List of available asynchronous events

o qemu-qmp-ref.html QEMU QMP commands and events (auto-generated at build-time)



[1] http://www.json.org

rules.mak

+2 −0
Original line number Diff line number Diff line
@@ -371,5 +371,7 @@ TEXI2MAN = $(call quiet-command, \ 


%.1:

	$(call TEXI2MAN)

%.7:

	$(call TEXI2MAN)

%.8:

	$(call TEXI2MAN)