RFC: Patch to build manual files in build dir

[Andreas Jaeger <aj at suse dot de>]

The appended patch is my current work-in-progress on building the manual
in the build directory and not anymore in the source directory.

It passes "make dvi info html" - and builds all of them in the build
dir. Missing is "make install" and "make clean".

I'd like to see your comments on whether I should continue this and what
kind of changes you suggest.

I'll enhance the ChangeLog later.

Thanks,
Andreas

2012-04-22  Andreas Jaeger  <aj@suse.de>

        [BZ #13570]
	* manual/libc-texinfo.sh: Add extra parameter for the build
	directory. Create all files in the build directory.
	* manual/Makefile: Build in build directory.


---
 manual/Makefile        |   75 ++++++++++++++++++++++++++---------------------
 manual/libc-texinfo.sh |   19 +++++++-----
 2 files changed, 52 insertions(+), 42 deletions(-)

diff --git a/manual/Makefile b/manual/Makefile
index daddd29..3d0af74 100644
--- a/manual/Makefile
+++ b/manual/Makefile
@@ -26,8 +26,6 @@ INSTALL_INFO = install-info
 
 .PHONY: all dvi pdf info html
 all: dvi
-dvi: libc.dvi
-pdf: libc.pdf
 
 # Get glibc's configuration info.
 ifneq (,$(wildcard ../Makeconfig))
@@ -38,11 +36,14 @@ TEXI2DVI = texi2dvi
 AWK = gawk
 endif
 
+dvi: $(objpfx)libc.dvi
+pdf: $(objpfx)libc.pdf
+
 TEXI2PDF = texi2dvi --pdf
 
 ifneq ($(strip $(MAKEINFO)),:)
 all: info
-info: libc.info
+info: $(objpfx)libc.info
 endif
 
 # scripts we use
@@ -61,8 +62,8 @@ add-chapters = $(wildcard $(foreach d, $(add-ons), ../$d/$d.texi))
 appendices = lang.texi header.texi install.texi maint.texi contrib.texi
 licenses = freemanuals.texi lgpl-2.1.texi fdl-1.3.texi
 
--include texis
-texis: texis.awk $(chapters) $(add-chapters) $(appendices) $(licenses)
+-include $(objpfx)texis
+$(objpfx)texis: texis.awk $(chapters) $(add-chapters) $(appendices) $(licenses)
 	$(AWK) -f $^ > $@.T
 	mv -f $@.T $@
 
@@ -70,34 +71,40 @@ nonexamples = $(filter-out $(add-chapters) %.c.texi, $(texis))
 examples = $(filter-out $(foreach d, $(add-ons), ../$d/%.c.texi), \
 			$(filter %.c.texi, $(texis)))
 
+# Generated files directly included from libc.texinfo.
+libc-texi-generated = chapters.texi top-menu.texi dir-add.texi \
+		      libm-err.texi version.texi
+
+# Add path to build dir for generated files
+texis-path := $(filter-out $(libc-texi-generated) summary.texi, $(texis)) \
+	 $(addprefix $(objpfx),$(filter $(libc-texi-generated) summary.texi, $(texis)))
+
 # Kludge: implicit rule so Make knows the one command does it all.
-chapters.% top-menu.%: libc-texinfo.sh $(texis) Makefile
-	AWK=$(AWK) $(SHELL) $< '$(chapters)' \
+chapters.% top-menu.%: libc-texinfo.sh $(texis-path) Makefile
+	AWK=$(AWK) $(SHELL) $< $(objpfx) \
+				'$(chapters)' \
 			       '$(add-chapters)' \
 			       '$(appendices) $(licenses)'
 
-# Generated files directly included from libc.texinfo.
-libc-texi-generated = chapters.texi top-menu.texi dir-add.texi \
-		      libm-err.texi version.texi
 
-libc.dvi libc.pdf libc.info: $(libc-texi-generated)
-libc.dvi libc.pdf: texinfo.tex
+$(objpfx)libc.dvi $(objpfx)libc.pdf $(objpfx)libc.info: $(addprefix $(objpfx),$(libc-texi-generated))
+$(objpfx)libc.dvi $(objpfx)libc.pdf: texinfo.tex
 
-html: libc/index.html
-libc/index.html: $(libc-texi-generated)
-	$(MAKEINFO) --html libc.texinfo
+html: $(objpfx)libc/index.html
+$(objpfx)libc/index.html: $(addprefix $(objpfx),$(libc-texi-generated))
+	$(MAKEINFO) -P $(objpfx) -o $(objpfx)libc --html libc.texinfo
 
 # Generate the summary from the Texinfo source files for each chapter.
-summary.texi: stamp-summary ;
-stamp-summary: summary.awk $(filter-out summary.texi, $(texis))
-	$(AWK) -f $^ | sort -t'' -df -k 1,1 | tr '\014' '\012' > summary-tmp
-	$(move-if-change) summary-tmp summary.texi
+$(objpfx)summary.texi: $(objpfx)stamp-summary ;
+$(objpfx)stamp-summary: summary.awk $(filter-out $(objpfx)summary.texi, $(texis-path))
+	$(AWK) -f $^ | sort -t'' -df -k 1,1 | tr '\014' '\012' > $(objpfx)summary-tmp
+	$(move-if-change) $(objpfx)summary-tmp $(objpfx)summary.texi
 	touch $@
 
 # Generate a file which can be added to the `dir' content to provide direct
 # access to the documentation of the function, variables, and other
 # definitions.
-dir-add.texi: xtract-typefun.awk $(texis)
+$(objpfx)dir-add.texi: xtract-typefun.awk $(texis-path)
 	(echo "@dircategory GNU C library functions and macros";	\
 	 echo "@direntry";						\
 	 $(AWK) -f $^ | sort;						\
@@ -105,19 +112,19 @@ dir-add.texi: xtract-typefun.awk $(texis)
 	mv -f $@.new $@
 
 # The table with the math errors is generated.
-libm-err.texi: stamp-libm-err
-stamp-libm-err: libm-err-tab.pl $(wildcard $(foreach dir,$(sysdirs),\
+$(objpfx)libm-err.texi: $(objpfx)stamp-libm-err
+$(objpfx)stamp-libm-err: libm-err-tab.pl $(wildcard $(foreach dir,$(sysdirs),\
 						     $(dir)/libm-test-ulps))
 	pwd=`pwd`; \
-	$(PERL) $< $$pwd/.. > libm-err-tmp
-	$(move-if-change) libm-err-tmp libm-err.texi
+	$(PERL) $< $$pwd/.. > $(objpfx)libm-err-tmp
+	$(move-if-change) $(objpfx)libm-err-tmp $(objpfx)libm-err.texi
 	touch $@
 
 # Generate a file with the version number.
-version.texi: stamp-version ;
-stamp-version: $(common-objpfx)config.make
-	echo "@set VERSION $(version)" > version-tmp
-	$(move-if-change) version-tmp version.texi
+$(objpfx)version.texi: $(objpfx)stamp-version ;
+$(objpfx)stamp-version: $(common-objpfx)config.make
+	echo "@set VERSION $(version)" > $(objpfx)version-tmp
+	$(move-if-change) $(objpfx)version-tmp $(objpfx)version.texi
 	touch $@
 
 # Generate Texinfo files from the C source for the example programs.
@@ -130,14 +137,14 @@ stamp-version: $(common-objpfx)config.make
 	    $< | expand > $@.new
 	mv -f $@.new $@
 
-%.info: %.texinfo
-	LANGUAGE=C LC_ALL=C $(MAKEINFO) $<
+$(objpfx)%.info: %.texinfo
+	LANGUAGE=C LC_ALL=C $(MAKEINFO) -P $(objpfx) --output=$@ $<
 
-%.dvi: %.texinfo
-	$(TEXI2DVI) $<
+$(objpfx)%.dvi: %.texinfo
+	cd $(objpfx);$(TEXI2DVI) -I $(shell cd $(<D) && pwd) --output=$@ $(shell cd $(<D) && pwd)/$<
 
 %.pdf: %.texinfo
-	$(TEXI2PDF) $<
+	$(TEXI2PDF) -I $(objpfx) $<
 
 # Distribution.
 minimal-dist = summary.awk texis.awk tsort.awk libc-texinfo.sh libc.texinfo \
@@ -192,7 +199,7 @@ endif
 # Catchall implicit rule for other installation targets from the parent.
 install-%: ;
 
-$(inst_infodir)/libc.info: libc.info installdirs
+$(inst_infodir)/libc.info: $(objpfx)libc.info installdirs
 	for file in $<*; do \
 	  $(INSTALL_DATA) $$file $(@D)/$$file; \
 	done
diff --git a/manual/libc-texinfo.sh b/manual/libc-texinfo.sh
index 79ac977..60e224b 100644
--- a/manual/libc-texinfo.sh
+++ b/manual/libc-texinfo.sh
@@ -1,10 +1,13 @@
 #! /bin/sh
 
+OUTDIR=$1
+shift
+
 # Create libc.texinfo from the chapter files.
 
-trap "rm -f *.$$; exit 1" 1 2 15
+trap "rm -f ${OUTDIR}*.$$; exit 1" 1 2 15
 
-exec 3>incl.$$ 4>smenu.$$ 5>lmenu.$$
+exec 3>${OUTDIR}incl.$$ 4>${OUTDIR}smenu.$$ 5>${OUTDIR}lmenu.$$
 
 build_menu () {
   while IFS=: read file node; do
@@ -51,7 +54,7 @@ collect_nodes $3 | build_menu
 
 exec 3>&- 4>&- 5>&-
 
-mv -f incl.$$ chapters.texi
+mv -f ${OUTDIR}incl.$$ ${OUTDIR}chapters.texi
 
 {
  echo '@menu'
@@ -72,7 +75,7 @@ mv -f incl.$$ chapters.texi
   }
 
   !/^\*/ { print; }
- ' smenu.$$
+ ' ${OUTDIR}smenu.$$
  cat <<EOF
 * Free Manuals::		 Free Software Needs Free Documentation.
 * Copying::                      The GNU Lesser General Public License says
@@ -90,8 +93,8 @@ Indices
 
  --- The Detailed Node Listing ---
 EOF
- cat lmenu.$$
- echo '@end menu'; } >top-menu.texi.$$
-mv -f top-menu.texi.$$ top-menu.texi
+ cat ${OUTDIR}lmenu.$$
+ echo '@end menu'; } >${OUTDIR}top-menu.texi.$$
+mv -f ${OUTDIR}top-menu.texi.$$ ${OUTDIR}top-menu.texi
 
-rm -f *.$$
+rm -f ${OUTDIR}*.$$
-- 
1.7.7


-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 NÃrnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix ImendÃrffer,HRB16746 (AG NÃrnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126