[Qemu-devel] [PATCH][RFC] Make documentation optional

[Michael Renzmann <mrenzmann@otaku42.de>]

[-- Attachment #1: Type: text/plain, Size: 527 bytes --]

Hi.

The compilation of the latest qemu CVS version aborted due to a missing
texi2html package. In my opinion, the build shouldn't depend on
texi2html and pod2man. I suggest to make the documentation optional and
warn the user if any of the necessary tools are missing.

The attached patch modifies Makefile such that the documentation will
only be generated when the necessary tools are available. The
installation has been fixed such that missing documentation file won't
break the compilation.

Comments welcome.

Bye, Mike

[-- Attachment #2: qemu-cvs-docs.diff --]
[-- Type: text/x-patch, Size: 3659 bytes --]

diff -urN qemu-cvs/CVS/Entries qemu-cvs-o42/CVS/Entries
--- qemu-cvs/CVS/Entries	2006-02-10 06:51:34.000000000 +0100
+++ qemu-cvs-o42/CVS/Entries	2006-02-10 08:33:19.000000000 +0100
@@ -87,4 +87,16 @@
 /vl.c/1.163/Wed Feb  8 22:46:31 2006//
 /vl.h/1.104/Wed Feb  8 04:42:17 2006//
 /x86_64.ld/1.1/Thu Jan  6 20:50:00 2005//
-D
+D/audio////
+D/fpu////
+D/hw////
+D/keymaps////
+D/linux-user////
+D/pc-bios////
+D/slirp////
+D/target-arm////
+D/target-i386////
+D/target-mips////
+D/target-ppc////
+D/target-sparc////
+D/tests////
diff -urN qemu-cvs/CVS/Entries.Log qemu-cvs-o42/CVS/Entries.Log
--- qemu-cvs/CVS/Entries.Log	2006-02-10 06:51:39.000000000 +0100
+++ qemu-cvs-o42/CVS/Entries.Log	1970-01-01 01:00:00.000000000 +0100
@@ -1,13 +0,0 @@
-A D/audio////
-A D/fpu////
-A D/hw////
-A D/keymaps////
-A D/linux-user////
-A D/pc-bios////
-A D/slirp////
-A D/target-arm////
-A D/target-i386////
-A D/target-mips////
-A D/target-ppc////
-A D/target-sparc////
-A D/tests////
diff -urN qemu-cvs/Makefile qemu-cvs-o42/Makefile
--- qemu-cvs/Makefile	2006-02-08 23:39:17.000000000 +0100
+++ qemu-cvs-o42/Makefile	2006-02-10 08:31:17.000000000 +0100
@@ -28,6 +28,7 @@
 # avoid old build problems by removing potentially incorrect old files
 	rm -f config.mak config.h op-i386.h opc-i386.h gen-op-i386.h op-arm.h opc-arm.h gen-op-arm.h 
 	rm -f *.o *.a $(TOOLS) dyngen$(EXESUF) TAGS *.pod *~ */*~
+	rm -f $(DOCS)
 	$(MAKE) -C tests clean
 	for d in $(TARGET_DIRS); do \
 	$(MAKE) -C $$d $@ || exit 1 ; \
@@ -43,7 +44,7 @@
 ar      de     en-us  fi  fr-be  hr     it  lv  nl         pl  ru     th \
 common  de-ch  es     fo  fr-ca  hu     ja  mk  nl-be      pt  sl     tr
 
-install: all 
+install: all
 	mkdir -p "$(bindir)"
 	install -m 755 -s $(TOOLS) "$(bindir)"
 	mkdir -p "$(datadir)"
@@ -52,11 +53,19 @@
                        pc-bios/ppc_rom.bin pc-bios/video.x \
                        pc-bios/proll.elf \
                        pc-bios/linux_boot.bin "$(datadir)"
-	mkdir -p "$(docdir)"
-	install -m 644 qemu-doc.html  qemu-tech.html "$(docdir)"
+	if [ -f "./*.html" ]; then \
+	    mkdir -p "$(docdir)" ; \
+	    install -m 644 qemu-doc.html  qemu-tech.html "$(docdir)" ; \
+	else \
+	    echo "INFO: skipped installation of HTML documentation" ; \
+	fi
 ifndef CONFIG_WIN32
-	mkdir -p "$(mandir)/man1"
-	install qemu.1 qemu-img.1 "$(mandir)/man1"
+	if [ -f "./*.1" ]; then \
+	    mkdir -p "$(mandir)/man1" ; \
+	    install qemu.1 qemu-img.1 "$(mandir)/man1" ; \
+	else \
+	    echo "INFO: skipped installation of man pages" ; \
+	fi
 	mkdir -p "$(datadir)/keymaps"
 	install -m 644 $(addprefix keymaps/,$(KEYMAPS)) "$(datadir)/keymaps"
 endif
@@ -78,15 +87,27 @@
 
 # documentation
 %.html: %.texi
-	texi2html -monolithic -number $<
+	if [ -n "$(shell which texi2html)" ]; then \
+	    texi2html -monolithic -number $< ; \
+	else \
+	    echo "WARNING: texi2html not found, skipped generation of" $< ; \
+	fi
 
 qemu.1: qemu-doc.texi
-	./texi2pod.pl $< qemu.pod
-	pod2man --section=1 --center=" " --release=" " qemu.pod > $@
+	if [ -n "$(shell which pod2man)" ]; then \
+		./texi2pod.pl $< qemu.pod ; \
+		pod2man --section=1 --center=" " --release=" " qemu.pod > $@ ; \
+	else \
+		echo "WARNING: pod2man not found, skipped generation of" $@ ; \
+	fi
 
 qemu-img.1: qemu-img.texi
-	./texi2pod.pl $< qemu-img.pod
-	pod2man --section=1 --center=" " --release=" " qemu-img.pod > $@
+	if [ -n "$(shell which pod2man)" ]; then \
+		./texi2pod.pl $< qemu-img.pod ; \
+		pod2man --section=1 --center=" " --release=" " qemu-img.pod > $@ ; \
+	else \
+		echo "WARNING: pod2man not found, skipped generation of" $@ ; \
+	fi
 
 FILE=qemu-$(shell cat VERSION)