jcs.org
qemu with hax to log dma reads & writes
jcs.org/2018/11/12/vfio
qapi: Clean up build of generated documentation
Rename intermediate qemu-qapi.texi to qemu-qmp-qapi.texi to match its
user qemu-qmp-ref.texi, just like qemu-ga-qapi.texi matches
qemu-ga-ref.texi.
Build the intermediate .texi next to the sources and the final output
in docs/ instead of dumping them into the build root.
Fix version.texi dependencies so that only the targets that actually
need it depend on it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-8-git-send-email-armbru@redhat.com>
+22
-19
+5
-5
.gitignore
+5
-5
.gitignore
···
99
99
/pc-bios/optionrom/kvmvapic.img
100
100
/pc-bios/s390-ccw/s390-ccw.elf
101
101
/pc-bios/s390-ccw/s390-ccw.img
102
+
/docs/qemu-ga-qapi.texi
102
103
/docs/qemu-ga-ref.html
104
+
/docs/qemu-ga-ref.info*
103
105
/docs/qemu-ga-ref.txt
106
+
/docs/qemu-qmp-qapi.texi
104
107
/docs/qemu-qmp-ref.html
108
+
/docs/qemu-qmp-ref.info*
105
109
/docs/qemu-qmp-ref.txt
106
-
docs/qemu-ga-ref.info*
107
-
docs/qemu-qmp-ref.info*
108
-
/qemu-ga-qapi.texi
109
-
/qemu-qapi.texi
110
-
/version.texi
110
+
/docs/version.texi
111
111
*.tps
112
112
.stgit-*
113
113
cscope.*
+15
-12
Makefile
+15
-12
Makefile
···
516
516
rm -f qemu-doc.vr qemu-doc.txt
517
517
rm -f config.log
518
518
rm -f linux-headers/asm
519
-
rm -f qemu-ga-qapi.texi qemu-qapi.texi version.texi
519
+
rm -f docs/qemu-ga-qapi.texi docs/qemu-qmp-qapi.texi docs/version.texi
520
520
rm -f docs/qemu-qmp-ref.7 docs/qemu-ga-ref.7
521
521
rm -f docs/qemu-qmp-ref.txt docs/qemu-ga-ref.txt
522
522
rm -f docs/qemu-qmp-ref.pdf docs/qemu-ga-ref.pdf
···
663
663
664
664
# documentation
665
665
MAKEINFO=makeinfo
666
-
MAKEINFOFLAGS=--no-split --number-sections
666
+
MAKEINFOFLAGS=--no-split --number-sections -I docs
667
667
TEXIFLAG=$(if $(V),,--quiet)
668
668
669
-
version.texi: $(SRC_PATH)/VERSION
669
+
docs/version.texi: $(SRC_PATH)/VERSION
670
670
$(call quiet-command,echo "@set VERSION $(VERSION)" > $@,"GEN","$@")
671
671
672
-
%.html: %.texi version.texi
672
+
%.html: %.texi
673
673
$(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \
674
674
--html $< -o $@,"GEN","$@")
675
675
676
-
%.info: %.texi version.texi
676
+
%.info: %.texi
677
677
$(call quiet-command,$(MAKEINFO) $(MAKEINFOFLAGS) $< -o $@,"GEN","$@")
678
678
679
-
%.txt: %.texi version.texi
679
+
%.txt: %.texi
680
680
$(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \
681
681
--plaintext $< -o $@,"GEN","$@")
682
682
683
-
%.pdf: %.texi version.texi
684
-
$(call quiet-command,texi2pdf $(TEXIFLAG) -I $(SRC_PATH) -I . $< -o $@,"GEN","$@")
683
+
%.pdf: %.texi
684
+
$(call quiet-command,texi2pdf $(TEXIFLAG) -I $(SRC_PATH) -I docs $< -o $@,"GEN","$@")
685
+
686
+
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
687
+
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
685
688
686
689
qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool
687
690
$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@")
···
695
698
qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/scripts/hxtool
696
699
$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@")
697
700
698
-
qemu-qapi.texi: $(qapi-modules) $(qapi-py)
701
+
docs/qemu-qmp-qapi.texi: $(qapi-modules) $(qapi-py)
699
702
$(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi2texi.py $< > $@,"GEN","$@")
700
703
701
-
qemu-ga-qapi.texi: $(SRC_PATH)/qga/qapi-schema.json $(qapi-py)
704
+
docs/qemu-ga-qapi.texi: $(SRC_PATH)/qga/qapi-schema.json $(qapi-py)
702
705
$(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi2texi.py $< > $@,"GEN","$@")
703
706
704
707
qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi
···
719
722
qemu-monitor-info.texi
720
723
721
724
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: \
722
-
docs/qemu-ga-ref.texi qemu-ga-qapi.texi
725
+
docs/qemu-ga-ref.texi docs/qemu-ga-qapi.texi
723
726
724
727
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: \
725
-
docs/qemu-qmp-ref.texi qemu-qapi.texi
728
+
docs/qemu-qmp-ref.texi docs/qemu-qmp-qapi.texi
726
729
727
730
728
731
ifdef CONFIG_WIN32
+1
-1
docs/qemu-qmp-ref.texi
+1
-1
docs/qemu-qmp-ref.texi
+1
-1
rules.mak
+1
-1
rules.mak
···
380
380
endef
381
381
382
382
TEXI2MAN = $(call quiet-command, \
383
-
perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< $@.pod && \
383
+
perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl -I docs $< $@.pod && \
384
384
$(POD2MAN) --section=$(subst .,,$(suffix $@)) --center=" " --release=" " $@.pod > $@, \
385
385
"GEN","$@")
386
386