| Writing a book on programming is in itself an interesting exercise in building systems. The text of the book consists of many files, each of which needs various preprocessing steps. The examples are real programs that should be run and their output collected, post- processed , and included in the main text (so that they don't have to be cut and pasted, with the risk of introducing errors). During composition, it is useful to be able to view the text in different formats. Finally, delivering the material requires packaging. Of course, all of this must be repeatable and relatively easy to maintain. Sounds like a job for make ! This is one of the great beauties of make . It can be applied to an amazing variety of problems. This book was written in DocBook format (i.e., XML). Applying make to TEX, LATEX, or troff is standard procedure when using those tools. Example 11-1 shows the entire makefile for the book. It is about 440 lines long. The makefile is divided into these basic tasks : Example 11-1. The makefile to build the book # Build the book! # # The primary targets in this file are: # # show_pdf Generate the pdf and start a viewer # pdf Generate the pdf # print Print the pdf # show_html Generate the html and start a viewer # html Generate the html # xml Generate the xml # release Make a release tarball # clean Clean up generated files # BOOK_DIR := /test/book SOURCE_DIR := text OUTPUT_DIR := out EXAMPLES_DIR := examples QUIET = @ SHELL = bash AWK := awk CP := cp EGREP := egrep HTML_VIEWER := cygstart KILL := /bin/kill M4 := m4 MV := mv PDF_VIEWER := cygstart RM := rm -f MKDIR := mkdir -p LNDIR := lndir SED := sed SORT := sort TOUCH := touch XMLTO := xmlto XMLTO_FLAGS = -o $(OUTPUT_DIR) $(XML_VERBOSE) process-pgm := bin/process-includes make-depend := bin/make-depend m4-macros := text/macros.m4 # $(call process-includes, input-file, output-file) # Remove tabs, expand macros, and process include directives. define process-includes expand \ $(M4) --prefix-builtins --include=text $(m4-macros) - \ $(process-pgm) > endef # $(call file-exists, file-name) # Return non-null if a file exists. file-exists = $(wildcard ) # $(call maybe-mkdir, directory-name-opt) # Create a directory if it doesn't exist. # If directory-name-opt is omitted use $@ for the directory-name. maybe-mkdir = $(if $(call file-exists, \ $(if ,,$(dir $@))),, \ $(MKDIR) $(if ,,$(dir $@))) # $(kill-acroread) # Terminate the acrobat reader. define kill-acroread $(QUIET) ps -W \ $(AWK) 'BEGIN { FIELDWIDTHS = "9 47 100" } \ /AcroRd32/ { \ print "Killing " $; \ system( "$(KILL) -f " $ ) \ }' endef # $(call source-to-output, file-name) # Transform a source tree reference to an output tree reference. define source-to-output $(subst $(SOURCE_DIR),$(OUTPUT_DIR),) endef # $(call run-script-example, script-name, output-file) # Run an example makefile. define run-script-example ( cd $(dir ); \ $(notdir ) 2>&1 \ if $(EGREP) --silent '$$\(MAKE\)' [mM]akefile; \ then \ $(SED) -e 's/^++*/$$/'; \ else \ $(SED) -e 's/^++*/$$/' \ -e '/ing directory /d' \ -e 's/\[[0-9]\]//'; \ fi ) \ > $(TMP)/out.$$$$ & \ $(MV) $(TMP)/out.$$$$ endef # $(call generic-program-example,example-directory) # Create the rules to build a generic example. define generic-program-example $(eval _dir := $(OUTPUT_DIR)/) $(eval _make_out := $(_dir)/make.out) $(eval _run_out := $(_dir)/run.out) $(eval _clean := $(_dir)/clean) $(eval _run_make := $(_dir)/run-make) $(eval _run_run := $(_dir)/run-run) $(eval _sources := $(filter-out %/CVS, $(wildcard $(EXAMPLES_DIR)//*))) $(_run_out): $(_make_out) $(_run_run) $$(call run-script-example, $(_run_run), $$@) $(_make_out): $(_clean) $(_run_make) $$(call run-script-example, $(_run_make), $$@) $(_clean): $(_sources) Makefile $(RM) -r $(_dir) $(MKDIR) $(_dir) $(LNDIR) -silent ../../$(EXAMPLES_DIR)/ $(_dir) $(TOUCH) $$@ $(_run_make): printf "#! /bin/bash -x\nmake\n" > $$@ endef # Book output formats. BOOK_XML_OUT := $(OUTPUT_DIR)/book.xml BOOK_HTML_OUT := $(subst xml,html,$(BOOK_XML_OUT)) BOOK_FO_OUT := $(subst xml,fo,$(BOOK_XML_OUT)) BOOK_PDF_OUT := $(subst xml,pdf,$(BOOK_XML_OUT)) ALL_XML_SRC := $(wildcard $(SOURCE_DIR)/*.xml) ALL_XML_OUT := $(call source-to-output,$(ALL_XML_SRC)) DEPENDENCY_FILES := $(call source-to-output,$(subst .xml,.d,$(ALL_XML_SRC))) # xml/html/pdf - Produce the desired output format for the book. .PHONY: xml html pdf xml: $(OUTPUT_DIR)/validate html: $(BOOK_HTML_OUT) pdf: $(BOOK_PDF_OUT) # show_pdf - Generate a pdf file and display it. .PHONY: show_pdf show_html print show_pdf: $(BOOK_PDF_OUT) $(kill-acroread) $(PDF_VIEWER) $(BOOK_PDF_OUT) # show_html - Generate an html file and display it. show_html: $(BOOK_HTML_OUT) $(HTML_VIEWER) $(BOOK_HTML_OUT) # print - Print specified pages from the book. print: $(BOOK_FO_OUT) $(kill-acroread) java -Dstart=15 -Dend=15 $(FOP) $< -print > /dev/null # $(BOOK_PDF_OUT) - Generate the pdf file. $(BOOK_PDF_OUT): $(BOOK_FO_OUT) Makefile # $(BOOK_HTML_OUT) - Generate the html file. $(BOOK_HTML_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_FO_OUT) - Generate the fo intermediate output file. .INTERMEDIATE: $(BOOK_FO_OUT) $(BOOK_FO_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_XML_OUT) - Process all the xml input files. $(BOOK_XML_OUT): Makefile ################################################################# # FOP Support # FOP := org.apache.fop.apps.Fop # DEBUG_FOP - Define this to see fop processor output. ifndef DEBUG_FOP FOP_FLAGS := -q FOP_OUTPUT := $(SED) -e '/not implemented/d' \ -e '/relative-align/d' \ -e '/xsl-footnote-separator/d' endif # CLASSPATH - Compute the appropriate CLASSPATH for fop. export CLASSPATH CLASSPATH = $(patsubst %;,%, \ $(subst ; ,;, \ $(addprefix c:/usr/xslt-process-2.2/java/, \ $(addsuffix .jar;, \ xalan \ xercesImpl \ batik \ fop \ jimi-1.0 \ avalon-framework-cvs-20020315)))) # %.pdf - Pattern rule to produce pdf output from fo input. %.pdf: %.fo $(kill-acroread) java -Xmx128M $(FOP) $(FOP_FLAGS) $< $@ $(FOP_OUTPUT) # %.fo - Pattern rule to produce fo output from xml input. PAPER_SIZE := letter %.fo: %.xml XSLT_FLAGS="--stringparam paper.type $(PAPER_SIZE)" \ $(XMLTO) $(XMLTO_FLAGS) fo $< # %.html - Pattern rule to produce html output from xml input. %.html: %.xml $(XMLTO) $(XMLTO_FLAGS) html-nochunks $< # fop_help - Display fop processor help text. .PHONY: fop_help fop_help: -java org.apache.fop.apps.Fop -help -java org.apache.fop.apps.Fop -print help ################################################################# # release - Produce a release of the book. # RELEASE_TAR := mpwm-$(shell date +%F).tar.gz RELEASE_FILES := README Makefile *.pdf bin examples out text .PHONY: release release: $(BOOK_PDF_OUT) ln -sf $(BOOK_PDF_OUT) . tar --create \ --gzip \ --file=$(RELEASE_TAR) \ --exclude=CVS \ --exclude=semantic.cache \ --exclude=*~ \ $(RELEASE_FILES) ls -l $(RELEASE_TAR) ################################################################# # Rules for Chapter 1 examples. # # Here are all the example directories. EXAMPLES := \ ch01-bogus-tab \ ch01-cw1 \ ch01-hello \ ch01-cw2 \ ch01-cw2a \ ch02-cw3 \ ch02-cw4 \ ch02-cw4a \ ch02-cw5 \ ch02-cw5a \ ch02-cw5b \ ch02-cw6 \ ch02-make-clean \ ch03-assert-not-null \ ch03-debug-trace \ ch03-debug-trace-1 \ ch03-debug-trace-2 \ ch03-filter-failure \ ch03-find-program-1 \ ch03-find-program-2 \ ch03-findstring-1 \ ch03-grep \ ch03-include \ ch03-invalid-variable \ ch03-kill-acroread \ ch03-kill-program \ ch03-letters \ ch03-program-variables-1 \ ch03-program-variables-2 \ ch03-program-variables-3 \ ch03-program-variables-5 \ ch03-scoping-issue \ ch03-shell \ ch03-trailing-space \ ch04-extent \ ch04-for-loop-1 \ ch04-for-loop-2 \ ch04-for-loop-3 \ ch06-simple \ appb-defstruct \ appb-arithmetic # I would really like to use this foreach loop, but a bug in 3.80 # generates a fatal error. #$(foreach e,$(EXAMPLES),$(eval $(call generic-program-example,$e))) # Instead I expand the foreach by hand here. $(eval $(call generic-program-example,ch01-bogus-tab)) $(eval $(call generic-program-example,ch01-cw1)) $(eval $(call generic-program-example,ch01-hello)) $(eval $(call generic-program-example,ch01-cw2)) $(eval $(call generic-program-example,ch01-cw2a)) $(eval $(call generic-program-example,ch02-cw3)) $(eval $(call generic-program-example,ch02-cw4)) $(eval $(call generic-program-example,ch02-cw4a)) $(eval $(call generic-program-example,ch02-cw5)) $(eval $(call generic-program-example,ch02-cw5a)) $(eval $(call generic-program-example,ch02-cw5b)) $(eval $(call generic-program-example,ch02-cw6)) $(eval $(call generic-program-example,ch02-make-clean)) $(eval $(call generic-program-example,ch03-assert-not-null)) $(eval $(call generic-program-example,ch03-debug-trace)) $(eval $(call generic-program-example,ch03-debug-trace-1)) $(eval $(call generic-program-example,ch03-debug-trace-2)) $(eval $(call generic-program-example,ch03-filter-failure)) $(eval $(call generic-program-example,ch03-find-program-1)) $(eval $(call generic-program-example,ch03-find-program-2)) $(eval $(call generic-program-example,ch03-findstring-1)) $(eval $(call generic-program-example,ch03-grep)) $(eval $(call generic-program-example,ch03-include)) $(eval $(call generic-program-example,ch03-invalid-variable)) $(eval $(call generic-program-example,ch03-kill-acroread)) $(eval $(call generic-program-example,ch03-kill-program)) $(eval $(call generic-program-example,ch03-letters)) $(eval $(call generic-program-example,ch03-program-variables-1)) $(eval $(call generic-program-example,ch03-program-variables-2)) $(eval $(call generic-program-example,ch03-program-variables-3)) $(eval $(call generic-program-example,ch03-program-variables-5)) $(eval $(call generic-program-example,ch03-scoping-issue)) $(eval $(call generic-program-example,ch03-shell)) $(eval $(call generic-program-example,ch03-trailing-space)) $(eval $(call generic-program-example,ch04-extent)) $(eval $(call generic-program-example,ch04-for-loop-1)) $(eval $(call generic-program-example,ch04-for-loop-2)) $(eval $(call generic-program-example,ch04-for-loop-3)) $(eval $(call generic-program-example,ch06-simple)) $(eval $(call generic-program-example,ch10-echo-bash)) $(eval $(call generic-program-example,appb-defstruct)) $(eval $(call generic-program-example,appb-arithmetic)) ################################################################# # validate # # Check for 1) unexpanded m4 macros; b) tabs; c) FIXME comments; d) # RM: responses to Andy; e) duplicate m4 macros # validation_checks := $(OUTPUT_DIR)/chk_macros_tabs \ $(OUTPUT_DIR)/chk_fixme \ $(OUTPUT_DIR)/chk_duplicate_macros \ $(OUTPUT_DIR)/chk_orphaned_examples .PHONY: validate-only validate-only: $(OUTPUT_DIR)/validate $(OUTPUT_DIR)/validate: $(validation_checks) $(TOUCH) $@ $(OUTPUT_DIR)/chk_macros_tabs: $(ALL_XML_OUT) # Looking for macros and tabs... $(QUIET)! $(EGREP) --ignore-case \ --line-number \ --regexp='\b(m4_mp_)' \ --regexp='1' \ $^ $(TOUCH) $@ $(OUTPUT_DIR)/chk_fixme: $(ALL_XML_OUT) # Looking for RM: and FIXME... $(QUIET)$(AWK) \ '/FIXME/ { printf "%s:%s: %s\n", FILENAME, NR, $ # Build the book! # # The primary targets in this file are: # # show_pdf Generate the pdf and start a viewer # pdf Generate the pdf # print Print the pdf # show_html Generate the html and start a viewer # html Generate the html # xml Generate the xml # release Make a release tarball # clean Clean up generated files # BOOK_DIR := /test/book SOURCE_DIR := text OUTPUT_DIR := out EXAMPLES_DIR := examples QUIET = @ SHELL = bash AWK := awk CP := cp EGREP := egrep HTML_VIEWER := cygstart KILL := /bin/kill M4 := m4 MV := mv PDF_VIEWER := cygstart RM := rm -f MKDIR := mkdir -p LNDIR := lndir SED := sed SORT := sort TOUCH := touch XMLTO := xmlto XMLTO_FLAGS = -o $(OUTPUT_DIR) $(XML_VERBOSE) process-pgm := bin/process-includes make-depend := bin/make-depend m4-macros := text/macros.m4 # $(call process-includes, input-file, output-file) # Remove tabs, expand macros, and process include directives. define process-includes expand $1 \ $(M4) --prefix-builtins --include=text $(m4-macros) - \ $(process-pgm) > $2 endef # $(call file-exists, file-name) # Return non-null if a file exists. file-exists = $(wildcard $1) # $(call maybe-mkdir, directory-name-opt) # Create a directory if it doesn't exist. # If directory-name-opt is omitted use $@ for the directory-name. maybe-mkdir = $(if $(call file-exists, \ $(if $1,$1,$(dir $@))),, \ $(MKDIR) $(if $1,$1,$(dir $@))) # $(kill-acroread) # Terminate the acrobat reader. define kill-acroread $(QUIET) ps -W \ $(AWK) 'BEGIN { FIELDWIDTHS = "9 47 100" } \ /AcroRd32/ { \ print "Killing " $$3; \ system( "$(KILL) -f " $$1 ) \ }' endef # $(call source-to-output, file-name) # Transform a source tree reference to an output tree reference. define source-to-output $(subst $(SOURCE_DIR),$(OUTPUT_DIR),$1) endef # $(call run-script-example, script- name , output-file) # Run an example makefile. define run-script-example ( cd $(dir $1); \ $(notdir $1) 2>&1 \ if $(EGREP) --silent '\$$\(MAKE\)' [mM]akefile; \ then \ $(SED) -e 's/^++*/$$/'; \ else \ $(SED) -e 's/^++*/$$/' \ -e '/ing directory /d' \ -e 's/\[[0-9]\]//'; \ fi ) \ > $(TMP)/out.$$$$ & \ $(MV) $(TMP)/out.$$$$ $2 endef # $(call generic-program-example,example-directory) # Create the rules to build a generic example. define generic-program-example $(eval $1_dir := $(OUTPUT_DIR)/$1) $(eval $1_make_out := $($1_dir)/make.out) $(eval $1_run_out := $($1_dir)/run.out) $(eval $1_clean := $($1_dir)/clean) $(eval $1_run_make := $($1_dir)/run-make) $(eval $1_run_run := $($1_dir)/run-run) $(eval $1_sources := $(filter-out %/CVS, $(wildcard $(EXAMPLES_DIR)/$1/*))) $($1_run_out): $($1_make_out) $($1_run_run) $$(call run-script-example, $($1_run_run), $$@) $($1_make_out): $($1_clean) $($1_run_make) $$(call run-script-example, $($1_run_make), $$@) $($1_clean): $($1_sources) Makefile $(RM) -r $($1_dir) $(MKDIR) $($1_dir) $(LNDIR) -silent ../../$(EXAMPLES_DIR)/$1 $($1_dir) $(TOUCH) $$@ $($1_run_make): printf "#! /bin/bash -x\ nmake \n" > $$@ endef # Book output formats. BOOK_XML_OUT := $(OUTPUT_DIR)/book.xml BOOK_HTML_OUT := $(subst xml,html,$(BOOK_XML_OUT)) BOOK_FO_OUT := $(subst xml,fo,$(BOOK_XML_OUT)) BOOK_PDF_OUT := $(subst xml,pdf,$(BOOK_XML_OUT)) ALL_XML_SRC := $(wildcard $(SOURCE_DIR)/*.xml) ALL_XML_OUT := $(call source-to-output,$(ALL_XML_SRC)) DEPENDENCY_FILES := $(call source-to-output,$(subst .xml,.d,$(ALL_XML_SRC))) # xml/html/pdf - Produce the desired output format for the book. .PHONY: xml html pdf xml: $(OUTPUT_DIR)/validate html: $(BOOK_HTML_OUT) pdf: $(BOOK_PDF_OUT) # show_pdf - Generate a pdf file and display it. .PHONY: show_pdf show_html print show_pdf: $(BOOK_PDF_OUT) $(kill-acroread) $(PDF_VIEWER) $(BOOK_PDF_OUT) # show_html - Generate an html file and display it. show_html: $(BOOK_HTML_OUT) $(HTML_VIEWER) $(BOOK_HTML_OUT) # print - Print specified pages from the book. print: $(BOOK_FO_OUT) $(kill-acroread) java -Dstart=15 -Dend=15 $(FOP) $< -print > /dev/null # $(BOOK_PDF_OUT) - Generate the pdf file. $(BOOK_PDF_OUT): $(BOOK_FO_OUT) Makefile # $(BOOK_HTML_OUT) - Generate the html file. $(BOOK_HTML_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_FO_OUT) - Generate the fo intermediate output file. .INTERMEDIATE: $(BOOK_FO_OUT) $(BOOK_FO_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_XML_OUT) - Process all the xml input files. $(BOOK_XML_OUT): Makefile ################################################################# # FOP Support # FOP := org.apache.fop.apps.Fop # DEBUG_FOP - Define this to see fop processor output. ifndef DEBUG_FOP FOP_FLAGS := -q FOP_OUTPUT := $(SED) -e '/not implemented/d' \ -e '/relative-align/d' \ -e '/xsl-footnote-separator/d' endif # CLASSPATH - Compute the appropriate CLASSPATH for fop. export CLASSPATH CLASSPATH = $(patsubst %;,%, \ $(subst ; ,;, \ $(addprefix c:/usr/xslt-process-2.2/java/, \ $(addsuffix .jar;, \ xalan \ xercesImpl \ batik \ fop \ jimi-1.0 \ avalon-framework-cvs-20020315)))) # %.pdf - Pattern rule to produce pdf output from fo input. %.pdf: %.fo $(kill-acroread) java -Xmx128M $(FOP) $(FOP_FLAGS) $< $@ $(FOP_OUTPUT) # %.fo - Pattern rule to produce fo output from xml input. PAPER_SIZE := letter %.fo: %.xml XSLT_FLAGS="--stringparam paper.type $(PAPER_SIZE)" \ $(XMLTO) $(XMLTO_FLAGS) fo $< # %.html - Pattern rule to produce html output from xml input. %.html: %.xml $(XMLTO) $(XMLTO_FLAGS) html-nochunks $< # fop_help - Display fop processor help text. .PHONY: fop_help fop_help: -java org.apache.fop.apps.Fop -help -java org.apache.fop.apps.Fop -print help ################################################################# # release - Produce a release of the book. # RELEASE_TAR := mpwm-$(shell date +%F).tar.gz RELEASE_FILES := README Makefile *.pdf bin examples out text . PHONY : release release: $(BOOK_PDF_OUT) ln -sf $(BOOK_PDF_OUT) . tar --create \ --gzip \ --file=$(RELEASE_TAR) \ --exclude=CVS \ --exclude=semantic.cache \ --exclude=*~ \ $(RELEASE_FILES) ls -l $(RELEASE_TAR) ################################################################# # Rules for Chapter 1 examples. # # Here are all the example directories. EXAMPLES := \ ch01-bogus-tab \ ch01-cw1 \ ch01-hello \ ch01-cw2 \ ch01-cw2a \ ch02-cw3 \ ch02-cw4 \ ch02-cw4a \ ch02-cw5 \ ch02-cw5a \ ch02-cw5b \ ch02-cw6 \ ch02-make-clean \ ch03-assert-not-null \ ch03-debug-trace \ ch03-debug-trace-1 \ ch03-debug-trace-2 \ ch03-filter-failure \ ch03-find-program-1 \ ch03-find-program-2 \ ch03-findstring-1 \ ch03-grep \ ch03-include \ ch03-invalid-variable \ ch03-kill-acroread \ ch03-kill-program \ ch03-letters \ ch03-program-variables-1 \ ch03-program-variables-2 \ ch03-program-variables-3 \ ch03-program- variables -5 \ ch03-scoping-issue \ ch03-shell \ ch03-trailing-space \ ch04-extent \ ch04-for-loop-1 \ ch04-for-loop-2 \ ch04-for-loop-3 \ ch06-simple \ appb-defstruct \ appb-arithmetic # I would really like to use this foreach loop, but a bug in 3.80 # generates a fatal error. #$(foreach e,$(EXAMPLES),$(eval $(call generic-program-example,$e))) # Instead I expand the foreach by hand here. $(eval $(call generic-program-example,ch01- bogus -tab)) $(eval $(call generic-program-example,ch01-cw1)) $(eval $(call generic-program-example,ch01-hello)) $(eval $(call generic-program-example,ch01-cw2)) $(eval $(call generic-program-example,ch01-cw2a)) $(eval $(call generic-program-example,ch02-cw3)) $(eval $(call generic-program-example,ch02-cw4)) $(eval $(call generic-program-example,ch02-cw4a)) $(eval $(call generic-program-example,ch02-cw5)) $(eval $(call generic-program-example,ch02-cw5a)) $(eval $(call generic-program-example,ch02-cw5b)) $(eval $(call generic-program-example,ch02-cw6)) $(eval $(call generic-program-example,ch02-make-clean)) $(eval $(call generic-program-example,ch03-assert-not-null)) $(eval $(call generic-program-example,ch03-debug-trace)) $(eval $(call generic-program-example,ch03-debug-trace-1)) $(eval $(call generic-program-example,ch03-debug-trace-2)) $(eval $(call generic-program-example,ch03-filter-failure)) $(eval $(call generic-program-example,ch03-find-program-1)) $(eval $(call generic-program-example,ch03-find-program-2)) $(eval $(call generic-program-example,ch03-findstring-1)) $(eval $(call generic-program-example,ch03-grep)) $(eval $(call generic-program-example,ch03-include)) $(eval $(call generic-program-example,ch03-invalid-variable)) $(eval $(call generic-program-example,ch03-kill-acroread)) $(eval $(call generic-program-example,ch03-kill-program)) $(eval $(call generic-program-example,ch03- letters )) $(eval $(call generic-program-example,ch03-program-variables-1)) $(eval $(call generic-program-example,ch03-program-variables-2)) $(eval $(call generic-program-example,ch03-program-variables-3)) $(eval $(call generic-program-example,ch03-program-variables-5)) $(eval $(call generic-program-example,ch03-scoping-issue)) $(eval $(call generic-program-example,ch03-shell)) $(eval $(call generic-program-example,ch03-trailing-space)) $(eval $(call generic-program-example,ch04-extent)) $(eval $(call generic-program-example,ch04-for-loop-1)) $(eval $(call generic-program-example,ch04-for-loop-2)) $(eval $(call generic-program-example,ch04-for-loop-3)) $(eval $(call generic-program-example,ch06-simple)) $(eval $(call generic-program-example,ch10-echo-bash)) $(eval $(call generic-program-example,appb-defstruct)) $(eval $(call generic-program-example,appb-arithmetic)) ################################################################# # validate # # Check for 1) unexpanded m4 macros; b) tabs; c) FIXME comments; d) # RM: responses to Andy; e) duplicate m4 macros # validation_checks := $(OUTPUT_DIR)/chk_macros_tabs \ $(OUTPUT_DIR)/chk_fixme \ $(OUTPUT_DIR)/chk_duplicate_macros \ $(OUTPUT_DIR)/chk_orphaned_examples .PHONY: validate-only validate-only: $(OUTPUT_DIR)/validate $(OUTPUT_DIR)/validate: $(validation_checks) $(TOUCH) $@ $(OUTPUT_DIR)/chk_macros_tabs: $(ALL_XML_OUT) # Looking for macros and tabs... $(QUIET)! $(EGREP) --ignore-case \ --line-number \ --regexp='\b(m4_mp_)' \ --regexp='\011' \ $^ $(TOUCH) $@ $(OUTPUT_DIR)/chk_fixme: $(ALL_XML_OUT) # Looking for RM: and FIXME... $(QUIET)$(AWK) \ '/FIXME/ { printf "%s:%s: %s\n", FILENAME, NR, $$0 } \ /^ *RM:/ { \ if ( $$0 !~ /RM: Done/ ) \ printf "%s:%s: %s\n", FILENAME, NR, $$0 \ }' $(subst $(OUTPUT_DIR)/,$(SOURCE_DIR)/,$^) $(TOUCH) $@ $(OUTPUT_DIR)/chk_duplicate_macros: $(SOURCE_DIR)/macros.m4 # Looking for duplicate macros... $(QUIET)! $(EGREP) --only-matching \ "\`[^']+'," $< \ $(SORT) \ uniq -c \ $(AWK) '$$1 > 1 { printf "$<:0: %s\n", $$0 }' \ $(EGREP) "^" $(TOUCH) $@ ALL_EXAMPLES := $(TMP)/all_examples $(OUTPUT_DIR)/chk_orphaned_examples: $(ALL_EXAMPLES) $(DEPENDENCY_FILES) $(QUIET)$(AWK) -F/ '/(EXAMPLESOUTPUT)_DIR/ { print $$3 }' \ $(filter %.d,$^) \ $(SORT) -u \ comm -13 - $(filter-out %.d,$^) $(TOUCH) $@ .INTERMEDIATE: $(ALL_EXAMPLES) $(ALL_EXAMPLES): # Looking for unused examples... $(QUIET) ls -p $(EXAMPLES_DIR) \ $(AWK) '/CVS/ { next } \ /\// { print substr($$0, 1, length - 1) }' > $@ ################################################################# # clean # clean: $(kill-acroread) $(RM) -r $(OUTPUT_DIR) $(RM) $(SOURCE_DIR)/*~ $(SOURCE_DIR)/*.log semantic.cache $(RM) book.pdf ################################################################# # Dependency Management # # Don't read or remake includes if we are doing a clean. # ifneq "$(MAKECMDGOALS)" "clean" -include $(DEPENDENCY_FILES) endif vpath %.xml $(SOURCE_DIR) vpath %.tif $(SOURCE_DIR) vpath %.eps $(SOURCE_DIR) $(OUTPUT_DIR)/%.xml: %.xml $(process-pgm) $(m4-macros) $(call process-includes, $<, $@) $(OUTPUT_DIR)/%.tif: %.tif $(CP) $< $@ $(OUTPUT_DIR)/%.eps: %.eps $(CP) $< $@ $(OUTPUT_DIR)/%.d: %.xml $(make-depend) $(make-depend) $< > $@ ################################################################# # Create Output Directory # # Create the output directory if necessary. # DOCBOOK_IMAGES := $(OUTPUT_DIR)/release/images DRAFT_PNG := /usr/share/docbook-xsl/images/draft.png ifneq "$(MAKECMDGOALS)" "clean" _CREATE_OUTPUT_DIR := \ $(shell \ $(MKDIR) $(DOCBOOK_IMAGES) & \ $(CP) $(DRAFT_PNG) $(DOCBOOK_IMAGES); \ if ! [[ $(foreach d, \ $(notdir \ $(wildcard $(EXAMPLES_DIR)/ch*)), \ -e $(OUTPUT_DIR)/$d &) -e . ]]; \ then \ echo Linking examples... > /dev/stderr; \ $(LNDIR) $(BOOK_DIR)/$(EXAMPLES_DIR) $(BOOK_DIR)/$(OUTPUT_DIR); \ fi) endif } \ /^ *RM:/ { \ if ( $ # Build the book! # # The primary targets in this file are: # # show_pdf Generate the pdf and start a viewer # pdf Generate the pdf # print Print the pdf # show_html Generate the html and start a viewer # html Generate the html # xml Generate the xml # release Make a release tarball # clean Clean up generated files # BOOK_DIR := /test/book SOURCE_DIR := text OUTPUT_DIR := out EXAMPLES_DIR := examples QUIET = @ SHELL = bash AWK := awk CP := cp EGREP := egrep HTML_VIEWER := cygstart KILL := /bin/kill M4 := m4 MV := mv PDF_VIEWER := cygstart RM := rm -f MKDIR := mkdir -p LNDIR := lndir SED := sed SORT := sort TOUCH := touch XMLTO := xmlto XMLTO_FLAGS = -o $(OUTPUT_DIR) $(XML_VERBOSE) process-pgm := bin/process-includes make-depend := bin/make-depend m4-macros := text/macros.m4 # $(call process-includes, input-file, output-file) # Remove tabs, expand macros, and process include directives. define process-includes expand $1 \ $(M4) --prefix-builtins --include=text $(m4-macros) - \ $(process-pgm) > $2 endef # $(call file-exists, file-name) # Return non-null if a file exists. file-exists = $(wildcard $1) # $(call maybe-mkdir, directory-name-opt) # Create a directory if it doesn't exist. # If directory-name-opt is omitted use $@ for the directory-name. maybe-mkdir = $(if $(call file-exists, \ $(if $1,$1,$(dir $@))),, \ $(MKDIR) $(if $1,$1,$(dir $@))) # $(kill-acroread) # Terminate the acrobat reader. define kill-acroread $(QUIET) ps -W \ $(AWK) 'BEGIN { FIELDWIDTHS = "9 47 100" } \ /AcroRd32/ { \ print "Killing " $$3; \ system( "$(KILL) -f " $$1 ) \ }' endef # $(call source-to-output, file-name) # Transform a source tree reference to an output tree reference. define source-to-output $(subst $(SOURCE_DIR),$(OUTPUT_DIR),$1) endef # $(call run-script-example, script- name , output-file) # Run an example makefile. define run-script-example ( cd $(dir $1); \ $(notdir $1) 2>&1 \ if $(EGREP) --silent '\$$\(MAKE\)' [mM]akefile; \ then \ $(SED) -e 's/^++*/$$/'; \ else \ $(SED) -e 's/^++*/$$/' \ -e '/ing directory /d' \ -e 's/\[[0-9]\]//'; \ fi ) \ > $(TMP)/out.$$$$ & \ $(MV) $(TMP)/out.$$$$ $2 endef # $(call generic-program-example,example-directory) # Create the rules to build a generic example. define generic-program-example $(eval $1_dir := $(OUTPUT_DIR)/$1) $(eval $1_make_out := $($1_dir)/make.out) $(eval $1_run_out := $($1_dir)/run.out) $(eval $1_clean := $($1_dir)/clean) $(eval $1_run_make := $($1_dir)/run-make) $(eval $1_run_run := $($1_dir)/run-run) $(eval $1_sources := $(filter-out %/CVS, $(wildcard $(EXAMPLES_DIR)/$1/*))) $($1_run_out): $($1_make_out) $($1_run_run) $$(call run-script-example, $($1_run_run), $$@) $($1_make_out): $($1_clean) $($1_run_make) $$(call run-script-example, $($1_run_make), $$@) $($1_clean): $($1_sources) Makefile $(RM) -r $($1_dir) $(MKDIR) $($1_dir) $(LNDIR) -silent ../../$(EXAMPLES_DIR)/$1 $($1_dir) $(TOUCH) $$@ $($1_run_make): printf "#! /bin/bash -x\ nmake \n" > $$@ endef # Book output formats. BOOK_XML_OUT := $(OUTPUT_DIR)/book.xml BOOK_HTML_OUT := $(subst xml,html,$(BOOK_XML_OUT)) BOOK_FO_OUT := $(subst xml,fo,$(BOOK_XML_OUT)) BOOK_PDF_OUT := $(subst xml,pdf,$(BOOK_XML_OUT)) ALL_XML_SRC := $(wildcard $(SOURCE_DIR)/*.xml) ALL_XML_OUT := $(call source-to-output,$(ALL_XML_SRC)) DEPENDENCY_FILES := $(call source-to-output,$(subst .xml,.d,$(ALL_XML_SRC))) # xml/html/pdf - Produce the desired output format for the book. .PHONY: xml html pdf xml: $(OUTPUT_DIR)/validate html: $(BOOK_HTML_OUT) pdf: $(BOOK_PDF_OUT) # show_pdf - Generate a pdf file and display it. .PHONY: show_pdf show_html print show_pdf: $(BOOK_PDF_OUT) $(kill-acroread) $(PDF_VIEWER) $(BOOK_PDF_OUT) # show_html - Generate an html file and display it. show_html: $(BOOK_HTML_OUT) $(HTML_VIEWER) $(BOOK_HTML_OUT) # print - Print specified pages from the book. print: $(BOOK_FO_OUT) $(kill-acroread) java -Dstart=15 -Dend=15 $(FOP) $< -print > /dev/null # $(BOOK_PDF_OUT) - Generate the pdf file. $(BOOK_PDF_OUT): $(BOOK_FO_OUT) Makefile # $(BOOK_HTML_OUT) - Generate the html file. $(BOOK_HTML_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_FO_OUT) - Generate the fo intermediate output file. .INTERMEDIATE: $(BOOK_FO_OUT) $(BOOK_FO_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_XML_OUT) - Process all the xml input files. $(BOOK_XML_OUT): Makefile ################################################################# # FOP Support # FOP := org.apache.fop.apps.Fop # DEBUG_FOP - Define this to see fop processor output. ifndef DEBUG_FOP FOP_FLAGS := -q FOP_OUTPUT := $(SED) -e '/not implemented/d' \ -e '/relative-align/d' \ -e '/xsl-footnote-separator/d' endif # CLASSPATH - Compute the appropriate CLASSPATH for fop. export CLASSPATH CLASSPATH = $(patsubst %;,%, \ $(subst ; ,;, \ $(addprefix c:/usr/xslt-process-2.2/java/, \ $(addsuffix .jar;, \ xalan \ xercesImpl \ batik \ fop \ jimi-1.0 \ avalon-framework-cvs-20020315)))) # %.pdf - Pattern rule to produce pdf output from fo input. %.pdf: %.fo $(kill-acroread) java -Xmx128M $(FOP) $(FOP_FLAGS) $< $@ $(FOP_OUTPUT) # %.fo - Pattern rule to produce fo output from xml input. PAPER_SIZE := letter %.fo: %.xml XSLT_FLAGS="--stringparam paper.type $(PAPER_SIZE)" \ $(XMLTO) $(XMLTO_FLAGS) fo $< # %.html - Pattern rule to produce html output from xml input. %.html: %.xml $(XMLTO) $(XMLTO_FLAGS) html-nochunks $< # fop_help - Display fop processor help text. .PHONY: fop_help fop_help: -java org.apache.fop.apps.Fop -help -java org.apache.fop.apps.Fop -print help ################################################################# # release - Produce a release of the book. # RELEASE_TAR := mpwm-$(shell date +%F).tar.gz RELEASE_FILES := README Makefile *.pdf bin examples out text . PHONY : release release: $(BOOK_PDF_OUT) ln -sf $(BOOK_PDF_OUT) . tar --create \ --gzip \ --file=$(RELEASE_TAR) \ --exclude=CVS \ --exclude=semantic.cache \ --exclude=*~ \ $(RELEASE_FILES) ls -l $(RELEASE_TAR) ################################################################# # Rules for Chapter 1 examples. # # Here are all the example directories. EXAMPLES := \ ch01-bogus-tab \ ch01-cw1 \ ch01-hello \ ch01-cw2 \ ch01-cw2a \ ch02-cw3 \ ch02-cw4 \ ch02-cw4a \ ch02-cw5 \ ch02-cw5a \ ch02-cw5b \ ch02-cw6 \ ch02-make-clean \ ch03-assert-not-null \ ch03-debug-trace \ ch03-debug-trace-1 \ ch03-debug-trace-2 \ ch03-filter-failure \ ch03-find-program-1 \ ch03-find-program-2 \ ch03-findstring-1 \ ch03-grep \ ch03-include \ ch03-invalid-variable \ ch03-kill-acroread \ ch03-kill-program \ ch03-letters \ ch03-program-variables-1 \ ch03-program-variables-2 \ ch03-program-variables-3 \ ch03-program- variables -5 \ ch03-scoping-issue \ ch03-shell \ ch03-trailing-space \ ch04-extent \ ch04-for-loop-1 \ ch04-for-loop-2 \ ch04-for-loop-3 \ ch06-simple \ appb-defstruct \ appb-arithmetic # I would really like to use this foreach loop, but a bug in 3.80 # generates a fatal error. #$(foreach e,$(EXAMPLES),$(eval $(call generic-program-example,$e))) # Instead I expand the foreach by hand here. $(eval $(call generic-program-example,ch01- bogus -tab)) $(eval $(call generic-program-example,ch01-cw1)) $(eval $(call generic-program-example,ch01-hello)) $(eval $(call generic-program-example,ch01-cw2)) $(eval $(call generic-program-example,ch01-cw2a)) $(eval $(call generic-program-example,ch02-cw3)) $(eval $(call generic-program-example,ch02-cw4)) $(eval $(call generic-program-example,ch02-cw4a)) $(eval $(call generic-program-example,ch02-cw5)) $(eval $(call generic-program-example,ch02-cw5a)) $(eval $(call generic-program-example,ch02-cw5b)) $(eval $(call generic-program-example,ch02-cw6)) $(eval $(call generic-program-example,ch02-make-clean)) $(eval $(call generic-program-example,ch03-assert-not-null)) $(eval $(call generic-program-example,ch03-debug-trace)) $(eval $(call generic-program-example,ch03-debug-trace-1)) $(eval $(call generic-program-example,ch03-debug-trace-2)) $(eval $(call generic-program-example,ch03-filter-failure)) $(eval $(call generic-program-example,ch03-find-program-1)) $(eval $(call generic-program-example,ch03-find-program-2)) $(eval $(call generic-program-example,ch03-findstring-1)) $(eval $(call generic-program-example,ch03-grep)) $(eval $(call generic-program-example,ch03-include)) $(eval $(call generic-program-example,ch03-invalid-variable)) $(eval $(call generic-program-example,ch03-kill-acroread)) $(eval $(call generic-program-example,ch03-kill-program)) $(eval $(call generic-program-example,ch03- letters )) $(eval $(call generic-program-example,ch03-program-variables-1)) $(eval $(call generic-program-example,ch03-program-variables-2)) $(eval $(call generic-program-example,ch03-program-variables-3)) $(eval $(call generic-program-example,ch03-program-variables-5)) $(eval $(call generic-program-example,ch03-scoping-issue)) $(eval $(call generic-program-example,ch03-shell)) $(eval $(call generic-program-example,ch03-trailing-space)) $(eval $(call generic-program-example,ch04-extent)) $(eval $(call generic-program-example,ch04-for-loop-1)) $(eval $(call generic-program-example,ch04-for-loop-2)) $(eval $(call generic-program-example,ch04-for-loop-3)) $(eval $(call generic-program-example,ch06-simple)) $(eval $(call generic-program-example,ch10-echo-bash)) $(eval $(call generic-program-example,appb-defstruct)) $(eval $(call generic-program-example,appb-arithmetic)) ################################################################# # validate # # Check for 1) unexpanded m4 macros; b) tabs; c) FIXME comments; d) # RM: responses to Andy; e) duplicate m4 macros # validation_checks := $(OUTPUT_DIR)/chk_macros_tabs \ $(OUTPUT_DIR)/chk_fixme \ $(OUTPUT_DIR)/chk_duplicate_macros \ $(OUTPUT_DIR)/chk_orphaned_examples .PHONY: validate-only validate-only: $(OUTPUT_DIR)/validate $(OUTPUT_DIR)/validate: $(validation_checks) $(TOUCH) $@ $(OUTPUT_DIR)/chk_macros_tabs: $(ALL_XML_OUT) # Looking for macros and tabs... $(QUIET)! $(EGREP) --ignore-case \ --line-number \ --regexp='\b(m4_mp_)' \ --regexp='\011' \ $^ $(TOUCH) $@ $(OUTPUT_DIR)/chk_fixme: $(ALL_XML_OUT) # Looking for RM: and FIXME... $(QUIET)$(AWK) \ '/FIXME/ { printf "%s:%s: %s\n", FILENAME, NR, $$0 } \ /^ *RM:/ { \ if ( $$0 !~ /RM: Done/ ) \ printf "%s:%s: %s\n", FILENAME, NR, $$0 \ }' $(subst $(OUTPUT_DIR)/,$(SOURCE_DIR)/,$^) $(TOUCH) $@ $(OUTPUT_DIR)/chk_duplicate_macros: $(SOURCE_DIR)/macros.m4 # Looking for duplicate macros... $(QUIET)! $(EGREP) --only-matching \ "\`[^']+'," $< \ $(SORT) \ uniq -c \ $(AWK) '$$1 > 1 { printf "$<:0: %s\n", $$0 }' \ $(EGREP) "^" $(TOUCH) $@ ALL_EXAMPLES := $(TMP)/all_examples $(OUTPUT_DIR)/chk_orphaned_examples: $(ALL_EXAMPLES) $(DEPENDENCY_FILES) $(QUIET)$(AWK) -F/ '/(EXAMPLESOUTPUT)_DIR/ { print $$3 }' \ $(filter %.d,$^) \ $(SORT) -u \ comm -13 - $(filter-out %.d,$^) $(TOUCH) $@ .INTERMEDIATE: $(ALL_EXAMPLES) $(ALL_EXAMPLES): # Looking for unused examples... $(QUIET) ls -p $(EXAMPLES_DIR) \ $(AWK) '/CVS/ { next } \ /\// { print substr($$0, 1, length - 1) }' > $@ ################################################################# # clean # clean: $(kill-acroread) $(RM) -r $(OUTPUT_DIR) $(RM) $(SOURCE_DIR)/*~ $(SOURCE_DIR)/*.log semantic.cache $(RM) book.pdf ################################################################# # Dependency Management # # Don't read or remake includes if we are doing a clean. # ifneq "$(MAKECMDGOALS)" "clean" -include $(DEPENDENCY_FILES) endif vpath %.xml $(SOURCE_DIR) vpath %.tif $(SOURCE_DIR) vpath %.eps $(SOURCE_DIR) $(OUTPUT_DIR)/%.xml: %.xml $(process-pgm) $(m4-macros) $(call process-includes, $<, $@) $(OUTPUT_DIR)/%.tif: %.tif $(CP) $< $@ $(OUTPUT_DIR)/%.eps: %.eps $(CP) $< $@ $(OUTPUT_DIR)/%.d: %.xml $(make-depend) $(make-depend) $< > $@ ################################################################# # Create Output Directory # # Create the output directory if necessary. # DOCBOOK_IMAGES := $(OUTPUT_DIR)/release/images DRAFT_PNG := /usr/share/docbook-xsl/images/draft.png ifneq "$(MAKECMDGOALS)" "clean" _CREATE_OUTPUT_DIR := \ $(shell \ $(MKDIR) $(DOCBOOK_IMAGES) & \ $(CP) $(DRAFT_PNG) $(DOCBOOK_IMAGES); \ if ! [[ $(foreach d, \ $(notdir \ $(wildcard $(EXAMPLES_DIR)/ch*)), \ -e $(OUTPUT_DIR)/$d &) -e . ]]; \ then \ echo Linking examples... > /dev/stderr; \ $(LNDIR) $(BOOK_DIR)/$(EXAMPLES_DIR) $(BOOK_DIR)/$(OUTPUT_DIR); \ fi) endif !~ /RM: Done/ ) \ printf "%s:%s: %s\n", FILENAME, NR, $ # Build the book! # # The primary targets in this file are: # # show_pdf Generate the pdf and start a viewer # pdf Generate the pdf # print Print the pdf # show_html Generate the html and start a viewer # html Generate the html # xml Generate the xml # release Make a release tarball # clean Clean up generated files # BOOK_DIR := /test/book SOURCE_DIR := text OUTPUT_DIR := out EXAMPLES_DIR := examples QUIET = @ SHELL = bash AWK := awk CP := cp EGREP := egrep HTML_VIEWER := cygstart KILL := /bin/kill M4 := m4 MV := mv PDF_VIEWER := cygstart RM := rm -f MKDIR := mkdir -p LNDIR := lndir SED := sed SORT := sort TOUCH := touch XMLTO := xmlto XMLTO_FLAGS = -o $(OUTPUT_DIR) $(XML_VERBOSE) process-pgm := bin/process-includes make-depend := bin/make-depend m4-macros := text/macros.m4 # $(call process-includes, input-file, output-file) # Remove tabs, expand macros, and process include directives. define process-includes expand $1 \ $(M4) --prefix-builtins --include=text $(m4-macros) - \ $(process-pgm) > $2 endef # $(call file-exists, file-name) # Return non-null if a file exists. file-exists = $(wildcard $1) # $(call maybe-mkdir, directory-name-opt) # Create a directory if it doesn't exist. # If directory-name-opt is omitted use $@ for the directory-name. maybe-mkdir = $(if $(call file-exists, \ $(if $1,$1,$(dir $@))),, \ $(MKDIR) $(if $1,$1,$(dir $@))) # $(kill-acroread) # Terminate the acrobat reader. define kill-acroread $(QUIET) ps -W \ $(AWK) 'BEGIN { FIELDWIDTHS = "9 47 100" } \ /AcroRd32/ { \ print "Killing " $$3; \ system( "$(KILL) -f " $$1 ) \ }' endef # $(call source-to-output, file-name) # Transform a source tree reference to an output tree reference. define source-to-output $(subst $(SOURCE_DIR),$(OUTPUT_DIR),$1) endef # $(call run-script-example, script- name , output-file) # Run an example makefile. define run-script-example ( cd $(dir $1); \ $(notdir $1) 2>&1 \ if $(EGREP) --silent '\$$\(MAKE\)' [mM]akefile; \ then \ $(SED) -e 's/^++*/$$/'; \ else \ $(SED) -e 's/^++*/$$/' \ -e '/ing directory /d' \ -e 's/\[[0-9]\]//'; \ fi ) \ > $(TMP)/out.$$$$ & \ $(MV) $(TMP)/out.$$$$ $2 endef # $(call generic-program-example,example-directory) # Create the rules to build a generic example. define generic-program-example $(eval $1_dir := $(OUTPUT_DIR)/$1) $(eval $1_make_out := $($1_dir)/make.out) $(eval $1_run_out := $($1_dir)/run.out) $(eval $1_clean := $($1_dir)/clean) $(eval $1_run_make := $($1_dir)/run-make) $(eval $1_run_run := $($1_dir)/run-run) $(eval $1_sources := $(filter-out %/CVS, $(wildcard $(EXAMPLES_DIR)/$1/*))) $($1_run_out): $($1_make_out) $($1_run_run) $$(call run-script-example, $($1_run_run), $$@) $($1_make_out): $($1_clean) $($1_run_make) $$(call run-script-example, $($1_run_make), $$@) $($1_clean): $($1_sources) Makefile $(RM) -r $($1_dir) $(MKDIR) $($1_dir) $(LNDIR) -silent ../../$(EXAMPLES_DIR)/$1 $($1_dir) $(TOUCH) $$@ $($1_run_make): printf "#! /bin/bash -x\ nmake \n" > $$@ endef # Book output formats. BOOK_XML_OUT := $(OUTPUT_DIR)/book.xml BOOK_HTML_OUT := $(subst xml,html,$(BOOK_XML_OUT)) BOOK_FO_OUT := $(subst xml,fo,$(BOOK_XML_OUT)) BOOK_PDF_OUT := $(subst xml,pdf,$(BOOK_XML_OUT)) ALL_XML_SRC := $(wildcard $(SOURCE_DIR)/*.xml) ALL_XML_OUT := $(call source-to-output,$(ALL_XML_SRC)) DEPENDENCY_FILES := $(call source-to-output,$(subst .xml,.d,$(ALL_XML_SRC))) # xml/html/pdf - Produce the desired output format for the book. .PHONY: xml html pdf xml: $(OUTPUT_DIR)/validate html: $(BOOK_HTML_OUT) pdf: $(BOOK_PDF_OUT) # show_pdf - Generate a pdf file and display it. .PHONY: show_pdf show_html print show_pdf: $(BOOK_PDF_OUT) $(kill-acroread) $(PDF_VIEWER) $(BOOK_PDF_OUT) # show_html - Generate an html file and display it. show_html: $(BOOK_HTML_OUT) $(HTML_VIEWER) $(BOOK_HTML_OUT) # print - Print specified pages from the book. print: $(BOOK_FO_OUT) $(kill-acroread) java -Dstart=15 -Dend=15 $(FOP) $< -print > /dev/null # $(BOOK_PDF_OUT) - Generate the pdf file. $(BOOK_PDF_OUT): $(BOOK_FO_OUT) Makefile # $(BOOK_HTML_OUT) - Generate the html file. $(BOOK_HTML_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_FO_OUT) - Generate the fo intermediate output file. .INTERMEDIATE: $(BOOK_FO_OUT) $(BOOK_FO_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_XML_OUT) - Process all the xml input files. $(BOOK_XML_OUT): Makefile ################################################################# # FOP Support # FOP := org.apache.fop.apps.Fop # DEBUG_FOP - Define this to see fop processor output. ifndef DEBUG_FOP FOP_FLAGS := -q FOP_OUTPUT := $(SED) -e '/not implemented/d' \ -e '/relative-align/d' \ -e '/xsl-footnote-separator/d' endif # CLASSPATH - Compute the appropriate CLASSPATH for fop. export CLASSPATH CLASSPATH = $(patsubst %;,%, \ $(subst ; ,;, \ $(addprefix c:/usr/xslt-process-2.2/java/, \ $(addsuffix .jar;, \ xalan \ xercesImpl \ batik \ fop \ jimi-1.0 \ avalon-framework-cvs-20020315)))) # %.pdf - Pattern rule to produce pdf output from fo input. %.pdf: %.fo $(kill-acroread) java -Xmx128M $(FOP) $(FOP_FLAGS) $< $@ $(FOP_OUTPUT) # %.fo - Pattern rule to produce fo output from xml input. PAPER_SIZE := letter %.fo: %.xml XSLT_FLAGS="--stringparam paper.type $(PAPER_SIZE)" \ $(XMLTO) $(XMLTO_FLAGS) fo $< # %.html - Pattern rule to produce html output from xml input. %.html: %.xml $(XMLTO) $(XMLTO_FLAGS) html-nochunks $< # fop_help - Display fop processor help text. .PHONY: fop_help fop_help: -java org.apache.fop.apps.Fop -help -java org.apache.fop.apps.Fop -print help ################################################################# # release - Produce a release of the book. # RELEASE_TAR := mpwm-$(shell date +%F).tar.gz RELEASE_FILES := README Makefile *.pdf bin examples out text . PHONY : release release: $(BOOK_PDF_OUT) ln -sf $(BOOK_PDF_OUT) . tar --create \ --gzip \ --file=$(RELEASE_TAR) \ --exclude=CVS \ --exclude=semantic.cache \ --exclude=*~ \ $(RELEASE_FILES) ls -l $(RELEASE_TAR) ################################################################# # Rules for Chapter 1 examples. # # Here are all the example directories. EXAMPLES := \ ch01-bogus-tab \ ch01-cw1 \ ch01-hello \ ch01-cw2 \ ch01-cw2a \ ch02-cw3 \ ch02-cw4 \ ch02-cw4a \ ch02-cw5 \ ch02-cw5a \ ch02-cw5b \ ch02-cw6 \ ch02-make-clean \ ch03-assert-not-null \ ch03-debug-trace \ ch03-debug-trace-1 \ ch03-debug-trace-2 \ ch03-filter-failure \ ch03-find-program-1 \ ch03-find-program-2 \ ch03-findstring-1 \ ch03-grep \ ch03-include \ ch03-invalid-variable \ ch03-kill-acroread \ ch03-kill-program \ ch03-letters \ ch03-program-variables-1 \ ch03-program-variables-2 \ ch03-program-variables-3 \ ch03-program- variables -5 \ ch03-scoping-issue \ ch03-shell \ ch03-trailing-space \ ch04-extent \ ch04-for-loop-1 \ ch04-for-loop-2 \ ch04-for-loop-3 \ ch06-simple \ appb-defstruct \ appb-arithmetic # I would really like to use this foreach loop, but a bug in 3.80 # generates a fatal error. #$(foreach e,$(EXAMPLES),$(eval $(call generic-program-example,$e))) # Instead I expand the foreach by hand here. $(eval $(call generic-program-example,ch01- bogus -tab)) $(eval $(call generic-program-example,ch01-cw1)) $(eval $(call generic-program-example,ch01-hello)) $(eval $(call generic-program-example,ch01-cw2)) $(eval $(call generic-program-example,ch01-cw2a)) $(eval $(call generic-program-example,ch02-cw3)) $(eval $(call generic-program-example,ch02-cw4)) $(eval $(call generic-program-example,ch02-cw4a)) $(eval $(call generic-program-example,ch02-cw5)) $(eval $(call generic-program-example,ch02-cw5a)) $(eval $(call generic-program-example,ch02-cw5b)) $(eval $(call generic-program-example,ch02-cw6)) $(eval $(call generic-program-example,ch02-make-clean)) $(eval $(call generic-program-example,ch03-assert-not-null)) $(eval $(call generic-program-example,ch03-debug-trace)) $(eval $(call generic-program-example,ch03-debug-trace-1)) $(eval $(call generic-program-example,ch03-debug-trace-2)) $(eval $(call generic-program-example,ch03-filter-failure)) $(eval $(call generic-program-example,ch03-find-program-1)) $(eval $(call generic-program-example,ch03-find-program-2)) $(eval $(call generic-program-example,ch03-findstring-1)) $(eval $(call generic-program-example,ch03-grep)) $(eval $(call generic-program-example,ch03-include)) $(eval $(call generic-program-example,ch03-invalid-variable)) $(eval $(call generic-program-example,ch03-kill-acroread)) $(eval $(call generic-program-example,ch03-kill-program)) $(eval $(call generic-program-example,ch03- letters )) $(eval $(call generic-program-example,ch03-program-variables-1)) $(eval $(call generic-program-example,ch03-program-variables-2)) $(eval $(call generic-program-example,ch03-program-variables-3)) $(eval $(call generic-program-example,ch03-program-variables-5)) $(eval $(call generic-program-example,ch03-scoping-issue)) $(eval $(call generic-program-example,ch03-shell)) $(eval $(call generic-program-example,ch03-trailing-space)) $(eval $(call generic-program-example,ch04-extent)) $(eval $(call generic-program-example,ch04-for-loop-1)) $(eval $(call generic-program-example,ch04-for-loop-2)) $(eval $(call generic-program-example,ch04-for-loop-3)) $(eval $(call generic-program-example,ch06-simple)) $(eval $(call generic-program-example,ch10-echo-bash)) $(eval $(call generic-program-example,appb-defstruct)) $(eval $(call generic-program-example,appb-arithmetic)) ################################################################# # validate # # Check for 1) unexpanded m4 macros; b) tabs; c) FIXME comments; d) # RM: responses to Andy; e) duplicate m4 macros # validation_checks := $(OUTPUT_DIR)/chk_macros_tabs \ $(OUTPUT_DIR)/chk_fixme \ $(OUTPUT_DIR)/chk_duplicate_macros \ $(OUTPUT_DIR)/chk_orphaned_examples .PHONY: validate-only validate-only: $(OUTPUT_DIR)/validate $(OUTPUT_DIR)/validate: $(validation_checks) $(TOUCH) $@ $(OUTPUT_DIR)/chk_macros_tabs: $(ALL_XML_OUT) # Looking for macros and tabs... $(QUIET)! $(EGREP) --ignore-case \ --line-number \ --regexp='\b(m4_mp_)' \ --regexp='\011' \ $^ $(TOUCH) $@ $(OUTPUT_DIR)/chk_fixme: $(ALL_XML_OUT) # Looking for RM: and FIXME... $(QUIET)$(AWK) \ '/FIXME/ { printf "%s:%s: %s\n", FILENAME, NR, $$0 } \ /^ *RM:/ { \ if ( $$0 !~ /RM: Done/ ) \ printf "%s:%s: %s\n", FILENAME, NR, $$0 \ }' $(subst $(OUTPUT_DIR)/,$(SOURCE_DIR)/,$^) $(TOUCH) $@ $(OUTPUT_DIR)/chk_duplicate_macros: $(SOURCE_DIR)/macros.m4 # Looking for duplicate macros... $(QUIET)! $(EGREP) --only-matching \ "\`[^']+'," $< \ $(SORT) \ uniq -c \ $(AWK) '$$1 > 1 { printf "$<:0: %s\n", $$0 }' \ $(EGREP) "^" $(TOUCH) $@ ALL_EXAMPLES := $(TMP)/all_examples $(OUTPUT_DIR)/chk_orphaned_examples: $(ALL_EXAMPLES) $(DEPENDENCY_FILES) $(QUIET)$(AWK) -F/ '/(EXAMPLESOUTPUT)_DIR/ { print $$3 }' \ $(filter %.d,$^) \ $(SORT) -u \ comm -13 - $(filter-out %.d,$^) $(TOUCH) $@ .INTERMEDIATE: $(ALL_EXAMPLES) $(ALL_EXAMPLES): # Looking for unused examples... $(QUIET) ls -p $(EXAMPLES_DIR) \ $(AWK) '/CVS/ { next } \ /\// { print substr($$0, 1, length - 1) }' > $@ ################################################################# # clean # clean: $(kill-acroread) $(RM) -r $(OUTPUT_DIR) $(RM) $(SOURCE_DIR)/*~ $(SOURCE_DIR)/*.log semantic.cache $(RM) book.pdf ################################################################# # Dependency Management # # Don't read or remake includes if we are doing a clean. # ifneq "$(MAKECMDGOALS)" "clean" -include $(DEPENDENCY_FILES) endif vpath %.xml $(SOURCE_DIR) vpath %.tif $(SOURCE_DIR) vpath %.eps $(SOURCE_DIR) $(OUTPUT_DIR)/%.xml: %.xml $(process-pgm) $(m4-macros) $(call process-includes, $<, $@) $(OUTPUT_DIR)/%.tif: %.tif $(CP) $< $@ $(OUTPUT_DIR)/%.eps: %.eps $(CP) $< $@ $(OUTPUT_DIR)/%.d: %.xml $(make-depend) $(make-depend) $< > $@ ################################################################# # Create Output Directory # # Create the output directory if necessary. # DOCBOOK_IMAGES := $(OUTPUT_DIR)/release/images DRAFT_PNG := /usr/share/docbook-xsl/images/draft.png ifneq "$(MAKECMDGOALS)" "clean" _CREATE_OUTPUT_DIR := \ $(shell \ $(MKDIR) $(DOCBOOK_IMAGES) & \ $(CP) $(DRAFT_PNG) $(DOCBOOK_IMAGES); \ if ! [[ $(foreach d, \ $(notdir \ $(wildcard $(EXAMPLES_DIR)/ch*)), \ -e $(OUTPUT_DIR)/$d &) -e . ]]; \ then \ echo Linking examples... > /dev/stderr; \ $(LNDIR) $(BOOK_DIR)/$(EXAMPLES_DIR) $(BOOK_DIR)/$(OUTPUT_DIR); \ fi) endif \ }' $(subst $(OUTPUT_DIR)/,$(SOURCE_DIR)/,$^) $(TOUCH) $@ $(OUTPUT_DIR)/chk_duplicate_macros: $(SOURCE_DIR)/macros.m4 # Looking for duplicate macros... $(QUIET)! $(EGREP) --only-matching \ "\`[^']+'," $< \ $(SORT) \ uniq -c \ $(AWK) '$ > 1 { printf "$<:0: %s\n", $ # Build the book! # # The primary targets in this file are: # # show_pdf Generate the pdf and start a viewer # pdf Generate the pdf # print Print the pdf # show_html Generate the html and start a viewer # html Generate the html # xml Generate the xml # release Make a release tarball # clean Clean up generated files # BOOK_DIR := /test/book SOURCE_DIR := text OUTPUT_DIR := out EXAMPLES_DIR := examples QUIET = @ SHELL = bash AWK := awk CP := cp EGREP := egrep HTML_VIEWER := cygstart KILL := /bin/kill M4 := m4 MV := mv PDF_VIEWER := cygstart RM := rm -f MKDIR := mkdir -p LNDIR := lndir SED := sed SORT := sort TOUCH := touch XMLTO := xmlto XMLTO_FLAGS = -o $(OUTPUT_DIR) $(XML_VERBOSE) process-pgm := bin/process-includes make-depend := bin/make-depend m4-macros := text/macros.m4 # $(call process-includes, input-file, output-file) # Remove tabs, expand macros, and process include directives. define process-includes expand $1 \ $(M4) --prefix-builtins --include=text $(m4-macros) - \ $(process-pgm) > $2 endef # $(call file-exists, file-name) # Return non-null if a file exists. file-exists = $(wildcard $1) # $(call maybe-mkdir, directory-name-opt) # Create a directory if it doesn't exist. # If directory-name-opt is omitted use $@ for the directory-name. maybe-mkdir = $(if $(call file-exists, \ $(if $1,$1,$(dir $@))),, \ $(MKDIR) $(if $1,$1,$(dir $@))) # $(kill-acroread) # Terminate the acrobat reader. define kill-acroread $(QUIET) ps -W \ $(AWK) 'BEGIN { FIELDWIDTHS = "9 47 100" } \ /AcroRd32/ { \ print "Killing " $$3; \ system( "$(KILL) -f " $$1 ) \ }' endef # $(call source-to-output, file-name) # Transform a source tree reference to an output tree reference. define source-to-output $(subst $(SOURCE_DIR),$(OUTPUT_DIR),$1) endef # $(call run-script-example, script- name , output-file) # Run an example makefile. define run-script-example ( cd $(dir $1); \ $(notdir $1) 2>&1 \ if $(EGREP) --silent '\$$\(MAKE\)' [mM]akefile; \ then \ $(SED) -e 's/^++*/$$/'; \ else \ $(SED) -e 's/^++*/$$/' \ -e '/ing directory /d' \ -e 's/\[[0-9]\]//'; \ fi ) \ > $(TMP)/out.$$$$ & \ $(MV) $(TMP)/out.$$$$ $2 endef # $(call generic-program-example,example-directory) # Create the rules to build a generic example. define generic-program-example $(eval $1_dir := $(OUTPUT_DIR)/$1) $(eval $1_make_out := $($1_dir)/make.out) $(eval $1_run_out := $($1_dir)/run.out) $(eval $1_clean := $($1_dir)/clean) $(eval $1_run_make := $($1_dir)/run-make) $(eval $1_run_run := $($1_dir)/run-run) $(eval $1_sources := $(filter-out %/CVS, $(wildcard $(EXAMPLES_DIR)/$1/*))) $($1_run_out): $($1_make_out) $($1_run_run) $$(call run-script-example, $($1_run_run), $$@) $($1_make_out): $($1_clean) $($1_run_make) $$(call run-script-example, $($1_run_make), $$@) $($1_clean): $($1_sources) Makefile $(RM) -r $($1_dir) $(MKDIR) $($1_dir) $(LNDIR) -silent ../../$(EXAMPLES_DIR)/$1 $($1_dir) $(TOUCH) $$@ $($1_run_make): printf "#! /bin/bash -x\ nmake \n" > $$@ endef # Book output formats. BOOK_XML_OUT := $(OUTPUT_DIR)/book.xml BOOK_HTML_OUT := $(subst xml,html,$(BOOK_XML_OUT)) BOOK_FO_OUT := $(subst xml,fo,$(BOOK_XML_OUT)) BOOK_PDF_OUT := $(subst xml,pdf,$(BOOK_XML_OUT)) ALL_XML_SRC := $(wildcard $(SOURCE_DIR)/*.xml) ALL_XML_OUT := $(call source-to-output,$(ALL_XML_SRC)) DEPENDENCY_FILES := $(call source-to-output,$(subst .xml,.d,$(ALL_XML_SRC))) # xml/html/pdf - Produce the desired output format for the book. .PHONY: xml html pdf xml: $(OUTPUT_DIR)/validate html: $(BOOK_HTML_OUT) pdf: $(BOOK_PDF_OUT) # show_pdf - Generate a pdf file and display it. .PHONY: show_pdf show_html print show_pdf: $(BOOK_PDF_OUT) $(kill-acroread) $(PDF_VIEWER) $(BOOK_PDF_OUT) # show_html - Generate an html file and display it. show_html: $(BOOK_HTML_OUT) $(HTML_VIEWER) $(BOOK_HTML_OUT) # print - Print specified pages from the book. print: $(BOOK_FO_OUT) $(kill-acroread) java -Dstart=15 -Dend=15 $(FOP) $< -print > /dev/null # $(BOOK_PDF_OUT) - Generate the pdf file. $(BOOK_PDF_OUT): $(BOOK_FO_OUT) Makefile # $(BOOK_HTML_OUT) - Generate the html file. $(BOOK_HTML_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_FO_OUT) - Generate the fo intermediate output file. .INTERMEDIATE: $(BOOK_FO_OUT) $(BOOK_FO_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_XML_OUT) - Process all the xml input files. $(BOOK_XML_OUT): Makefile ################################################################# # FOP Support # FOP := org.apache.fop.apps.Fop # DEBUG_FOP - Define this to see fop processor output. ifndef DEBUG_FOP FOP_FLAGS := -q FOP_OUTPUT := $(SED) -e '/not implemented/d' \ -e '/relative-align/d' \ -e '/xsl-footnote-separator/d' endif # CLASSPATH - Compute the appropriate CLASSPATH for fop. export CLASSPATH CLASSPATH = $(patsubst %;,%, \ $(subst ; ,;, \ $(addprefix c:/usr/xslt-process-2.2/java/, \ $(addsuffix .jar;, \ xalan \ xercesImpl \ batik \ fop \ jimi-1.0 \ avalon-framework-cvs-20020315)))) # %.pdf - Pattern rule to produce pdf output from fo input. %.pdf: %.fo $(kill-acroread) java -Xmx128M $(FOP) $(FOP_FLAGS) $< $@ $(FOP_OUTPUT) # %.fo - Pattern rule to produce fo output from xml input. PAPER_SIZE := letter %.fo: %.xml XSLT_FLAGS="--stringparam paper.type $(PAPER_SIZE)" \ $(XMLTO) $(XMLTO_FLAGS) fo $< # %.html - Pattern rule to produce html output from xml input. %.html: %.xml $(XMLTO) $(XMLTO_FLAGS) html-nochunks $< # fop_help - Display fop processor help text. .PHONY: fop_help fop_help: -java org.apache.fop.apps.Fop -help -java org.apache.fop.apps.Fop -print help ################################################################# # release - Produce a release of the book. # RELEASE_TAR := mpwm-$(shell date +%F).tar.gz RELEASE_FILES := README Makefile *.pdf bin examples out text . PHONY : release release: $(BOOK_PDF_OUT) ln -sf $(BOOK_PDF_OUT) . tar --create \ --gzip \ --file=$(RELEASE_TAR) \ --exclude=CVS \ --exclude=semantic.cache \ --exclude=*~ \ $(RELEASE_FILES) ls -l $(RELEASE_TAR) ################################################################# # Rules for Chapter 1 examples. # # Here are all the example directories. EXAMPLES := \ ch01-bogus-tab \ ch01-cw1 \ ch01-hello \ ch01-cw2 \ ch01-cw2a \ ch02-cw3 \ ch02-cw4 \ ch02-cw4a \ ch02-cw5 \ ch02-cw5a \ ch02-cw5b \ ch02-cw6 \ ch02-make-clean \ ch03-assert-not-null \ ch03-debug-trace \ ch03-debug-trace-1 \ ch03-debug-trace-2 \ ch03-filter-failure \ ch03-find-program-1 \ ch03-find-program-2 \ ch03-findstring-1 \ ch03-grep \ ch03-include \ ch03-invalid-variable \ ch03-kill-acroread \ ch03-kill-program \ ch03-letters \ ch03-program-variables-1 \ ch03-program-variables-2 \ ch03-program-variables-3 \ ch03-program- variables -5 \ ch03-scoping-issue \ ch03-shell \ ch03-trailing-space \ ch04-extent \ ch04-for-loop-1 \ ch04-for-loop-2 \ ch04-for-loop-3 \ ch06-simple \ appb-defstruct \ appb-arithmetic # I would really like to use this foreach loop, but a bug in 3.80 # generates a fatal error. #$(foreach e,$(EXAMPLES),$(eval $(call generic-program-example,$e))) # Instead I expand the foreach by hand here. $(eval $(call generic-program-example,ch01- bogus -tab)) $(eval $(call generic-program-example,ch01-cw1)) $(eval $(call generic-program-example,ch01-hello)) $(eval $(call generic-program-example,ch01-cw2)) $(eval $(call generic-program-example,ch01-cw2a)) $(eval $(call generic-program-example,ch02-cw3)) $(eval $(call generic-program-example,ch02-cw4)) $(eval $(call generic-program-example,ch02-cw4a)) $(eval $(call generic-program-example,ch02-cw5)) $(eval $(call generic-program-example,ch02-cw5a)) $(eval $(call generic-program-example,ch02-cw5b)) $(eval $(call generic-program-example,ch02-cw6)) $(eval $(call generic-program-example,ch02-make-clean)) $(eval $(call generic-program-example,ch03-assert-not-null)) $(eval $(call generic-program-example,ch03-debug-trace)) $(eval $(call generic-program-example,ch03-debug-trace-1)) $(eval $(call generic-program-example,ch03-debug-trace-2)) $(eval $(call generic-program-example,ch03-filter-failure)) $(eval $(call generic-program-example,ch03-find-program-1)) $(eval $(call generic-program-example,ch03-find-program-2)) $(eval $(call generic-program-example,ch03-findstring-1)) $(eval $(call generic-program-example,ch03-grep)) $(eval $(call generic-program-example,ch03-include)) $(eval $(call generic-program-example,ch03-invalid-variable)) $(eval $(call generic-program-example,ch03-kill-acroread)) $(eval $(call generic-program-example,ch03-kill-program)) $(eval $(call generic-program-example,ch03- letters )) $(eval $(call generic-program-example,ch03-program-variables-1)) $(eval $(call generic-program-example,ch03-program-variables-2)) $(eval $(call generic-program-example,ch03-program-variables-3)) $(eval $(call generic-program-example,ch03-program-variables-5)) $(eval $(call generic-program-example,ch03-scoping-issue)) $(eval $(call generic-program-example,ch03-shell)) $(eval $(call generic-program-example,ch03-trailing-space)) $(eval $(call generic-program-example,ch04-extent)) $(eval $(call generic-program-example,ch04-for-loop-1)) $(eval $(call generic-program-example,ch04-for-loop-2)) $(eval $(call generic-program-example,ch04-for-loop-3)) $(eval $(call generic-program-example,ch06-simple)) $(eval $(call generic-program-example,ch10-echo-bash)) $(eval $(call generic-program-example,appb-defstruct)) $(eval $(call generic-program-example,appb-arithmetic)) ################################################################# # validate # # Check for 1) unexpanded m4 macros; b) tabs; c) FIXME comments; d) # RM: responses to Andy; e) duplicate m4 macros # validation_checks := $(OUTPUT_DIR)/chk_macros_tabs \ $(OUTPUT_DIR)/chk_fixme \ $(OUTPUT_DIR)/chk_duplicate_macros \ $(OUTPUT_DIR)/chk_orphaned_examples .PHONY: validate-only validate-only: $(OUTPUT_DIR)/validate $(OUTPUT_DIR)/validate: $(validation_checks) $(TOUCH) $@ $(OUTPUT_DIR)/chk_macros_tabs: $(ALL_XML_OUT) # Looking for macros and tabs... $(QUIET)! $(EGREP) --ignore-case \ --line-number \ --regexp='\b(m4_mp_)' \ --regexp='\011' \ $^ $(TOUCH) $@ $(OUTPUT_DIR)/chk_fixme: $(ALL_XML_OUT) # Looking for RM: and FIXME... $(QUIET)$(AWK) \ '/FIXME/ { printf "%s:%s: %s\n", FILENAME, NR, $$0 } \ /^ *RM:/ { \ if ( $$0 !~ /RM: Done/ ) \ printf "%s:%s: %s\n", FILENAME, NR, $$0 \ }' $(subst $(OUTPUT_DIR)/,$(SOURCE_DIR)/,$^) $(TOUCH) $@ $(OUTPUT_DIR)/chk_duplicate_macros: $(SOURCE_DIR)/macros.m4 # Looking for duplicate macros... $(QUIET)! $(EGREP) --only-matching \ "\`[^']+'," $< \ $(SORT) \ uniq -c \ $(AWK) '$$1 > 1 { printf "$<:0: %s\n", $$0 }' \ $(EGREP) "^" $(TOUCH) $@ ALL_EXAMPLES := $(TMP)/all_examples $(OUTPUT_DIR)/chk_orphaned_examples: $(ALL_EXAMPLES) $(DEPENDENCY_FILES) $(QUIET)$(AWK) -F/ '/(EXAMPLESOUTPUT)_DIR/ { print $$3 }' \ $(filter %.d,$^) \ $(SORT) -u \ comm -13 - $(filter-out %.d,$^) $(TOUCH) $@ .INTERMEDIATE: $(ALL_EXAMPLES) $(ALL_EXAMPLES): # Looking for unused examples... $(QUIET) ls -p $(EXAMPLES_DIR) \ $(AWK) '/CVS/ { next } \ /\// { print substr($$0, 1, length - 1) }' > $@ ################################################################# # clean # clean: $(kill-acroread) $(RM) -r $(OUTPUT_DIR) $(RM) $(SOURCE_DIR)/*~ $(SOURCE_DIR)/*.log semantic.cache $(RM) book.pdf ################################################################# # Dependency Management # # Don't read or remake includes if we are doing a clean. # ifneq "$(MAKECMDGOALS)" "clean" -include $(DEPENDENCY_FILES) endif vpath %.xml $(SOURCE_DIR) vpath %.tif $(SOURCE_DIR) vpath %.eps $(SOURCE_DIR) $(OUTPUT_DIR)/%.xml: %.xml $(process-pgm) $(m4-macros) $(call process-includes, $<, $@) $(OUTPUT_DIR)/%.tif: %.tif $(CP) $< $@ $(OUTPUT_DIR)/%.eps: %.eps $(CP) $< $@ $(OUTPUT_DIR)/%.d: %.xml $(make-depend) $(make-depend) $< > $@ ################################################################# # Create Output Directory # # Create the output directory if necessary. # DOCBOOK_IMAGES := $(OUTPUT_DIR)/release/images DRAFT_PNG := /usr/share/docbook-xsl/images/draft.png ifneq "$(MAKECMDGOALS)" "clean" _CREATE_OUTPUT_DIR := \ $(shell \ $(MKDIR) $(DOCBOOK_IMAGES) & \ $(CP) $(DRAFT_PNG) $(DOCBOOK_IMAGES); \ if ! [[ $(foreach d, \ $(notdir \ $(wildcard $(EXAMPLES_DIR)/ch*)), \ -e $(OUTPUT_DIR)/$d &) -e . ]]; \ then \ echo Linking examples... > /dev/stderr; \ $(LNDIR) $(BOOK_DIR)/$(EXAMPLES_DIR) $(BOOK_DIR)/$(OUTPUT_DIR); \ fi) endif }' \ $(EGREP) "^" $(TOUCH) $@ ALL_EXAMPLES := $(TMP)/all_examples $(OUTPUT_DIR)/chk_orphaned_examples: $(ALL_EXAMPLES) $(DEPENDENCY_FILES) $(QUIET)$(AWK) -F/ '/(EXAMPLESOUTPUT)_DIR/ { print $ }' \ $(filter %.d,$^) \ $(SORT) -u \ comm -13 - $(filter-out %.d,$^) $(TOUCH) $@ .INTERMEDIATE: $(ALL_EXAMPLES) $(ALL_EXAMPLES): # Looking for unused examples... $(QUIET) ls -p $(EXAMPLES_DIR) \ $(AWK) '/CVS/ { next } \ /\// { print substr($ # Build the book! # # The primary targets in this file are: # # show_pdf Generate the pdf and start a viewer # pdf Generate the pdf # print Print the pdf # show_html Generate the html and start a viewer # html Generate the html # xml Generate the xml # release Make a release tarball # clean Clean up generated files # BOOK_DIR := /test/book SOURCE_DIR := text OUTPUT_DIR := out EXAMPLES_DIR := examples QUIET = @ SHELL = bash AWK := awk CP := cp EGREP := egrep HTML_VIEWER := cygstart KILL := /bin/kill M4 := m4 MV := mv PDF_VIEWER := cygstart RM := rm -f MKDIR := mkdir -p LNDIR := lndir SED := sed SORT := sort TOUCH := touch XMLTO := xmlto XMLTO_FLAGS = -o $(OUTPUT_DIR) $(XML_VERBOSE) process-pgm := bin/process-includes make-depend := bin/make-depend m4-macros := text/macros.m4 # $(call process-includes, input-file, output-file) # Remove tabs, expand macros, and process include directives. define process-includes expand $1 \ $(M4) --prefix-builtins --include=text $(m4-macros) - \ $(process-pgm) > $2 endef # $(call file-exists, file-name) # Return non-null if a file exists. file-exists = $(wildcard $1) # $(call maybe-mkdir, directory-name-opt) # Create a directory if it doesn't exist. # If directory-name-opt is omitted use $@ for the directory-name. maybe-mkdir = $(if $(call file-exists, \ $(if $1,$1,$(dir $@))),, \ $(MKDIR) $(if $1,$1,$(dir $@))) # $(kill-acroread) # Terminate the acrobat reader. define kill-acroread $(QUIET) ps -W \ $(AWK) 'BEGIN { FIELDWIDTHS = "9 47 100" } \ /AcroRd32/ { \ print "Killing " $$3; \ system( "$(KILL) -f " $$1 ) \ }' endef # $(call source-to-output, file-name) # Transform a source tree reference to an output tree reference. define source-to-output $(subst $(SOURCE_DIR),$(OUTPUT_DIR),$1) endef # $(call run-script-example, script- name , output-file) # Run an example makefile. define run-script-example ( cd $(dir $1); \ $(notdir $1) 2>&1 \ if $(EGREP) --silent '\$$\(MAKE\)' [mM]akefile; \ then \ $(SED) -e 's/^++*/$$/'; \ else \ $(SED) -e 's/^++*/$$/' \ -e '/ing directory /d' \ -e 's/\[[0-9]\]//'; \ fi ) \ > $(TMP)/out.$$$$ & \ $(MV) $(TMP)/out.$$$$ $2 endef # $(call generic-program-example,example-directory) # Create the rules to build a generic example. define generic-program-example $(eval $1_dir := $(OUTPUT_DIR)/$1) $(eval $1_make_out := $($1_dir)/make.out) $(eval $1_run_out := $($1_dir)/run.out) $(eval $1_clean := $($1_dir)/clean) $(eval $1_run_make := $($1_dir)/run-make) $(eval $1_run_run := $($1_dir)/run-run) $(eval $1_sources := $(filter-out %/CVS, $(wildcard $(EXAMPLES_DIR)/$1/*))) $($1_run_out): $($1_make_out) $($1_run_run) $$(call run-script-example, $($1_run_run), $$@) $($1_make_out): $($1_clean) $($1_run_make) $$(call run-script-example, $($1_run_make), $$@) $($1_clean): $($1_sources) Makefile $(RM) -r $($1_dir) $(MKDIR) $($1_dir) $(LNDIR) -silent ../../$(EXAMPLES_DIR)/$1 $($1_dir) $(TOUCH) $$@ $($1_run_make): printf "#! /bin/bash -x\ nmake \n" > $$@ endef # Book output formats. BOOK_XML_OUT := $(OUTPUT_DIR)/book.xml BOOK_HTML_OUT := $(subst xml,html,$(BOOK_XML_OUT)) BOOK_FO_OUT := $(subst xml,fo,$(BOOK_XML_OUT)) BOOK_PDF_OUT := $(subst xml,pdf,$(BOOK_XML_OUT)) ALL_XML_SRC := $(wildcard $(SOURCE_DIR)/*.xml) ALL_XML_OUT := $(call source-to-output,$(ALL_XML_SRC)) DEPENDENCY_FILES := $(call source-to-output,$(subst .xml,.d,$(ALL_XML_SRC))) # xml/html/pdf - Produce the desired output format for the book. .PHONY: xml html pdf xml: $(OUTPUT_DIR)/validate html: $(BOOK_HTML_OUT) pdf: $(BOOK_PDF_OUT) # show_pdf - Generate a pdf file and display it. .PHONY: show_pdf show_html print show_pdf: $(BOOK_PDF_OUT) $(kill-acroread) $(PDF_VIEWER) $(BOOK_PDF_OUT) # show_html - Generate an html file and display it. show_html: $(BOOK_HTML_OUT) $(HTML_VIEWER) $(BOOK_HTML_OUT) # print - Print specified pages from the book. print: $(BOOK_FO_OUT) $(kill-acroread) java -Dstart=15 -Dend=15 $(FOP) $< -print > /dev/null # $(BOOK_PDF_OUT) - Generate the pdf file. $(BOOK_PDF_OUT): $(BOOK_FO_OUT) Makefile # $(BOOK_HTML_OUT) - Generate the html file. $(BOOK_HTML_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_FO_OUT) - Generate the fo intermediate output file. .INTERMEDIATE: $(BOOK_FO_OUT) $(BOOK_FO_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # $(BOOK_XML_OUT) - Process all the xml input files. $(BOOK_XML_OUT): Makefile ################################################################# # FOP Support # FOP := org.apache.fop.apps.Fop # DEBUG_FOP - Define this to see fop processor output. ifndef DEBUG_FOP FOP_FLAGS := -q FOP_OUTPUT := $(SED) -e '/not implemented/d' \ -e '/relative-align/d' \ -e '/xsl-footnote-separator/d' endif # CLASSPATH - Compute the appropriate CLASSPATH for fop. export CLASSPATH CLASSPATH = $(patsubst %;,%, \ $(subst ; ,;, \ $(addprefix c:/usr/xslt-process-2.2/java/, \ $(addsuffix .jar;, \ xalan \ xercesImpl \ batik \ fop \ jimi-1.0 \ avalon-framework-cvs-20020315)))) # %.pdf - Pattern rule to produce pdf output from fo input. %.pdf: %.fo $(kill-acroread) java -Xmx128M $(FOP) $(FOP_FLAGS) $< $@ $(FOP_OUTPUT) # %.fo - Pattern rule to produce fo output from xml input. PAPER_SIZE := letter %.fo: %.xml XSLT_FLAGS="--stringparam paper.type $(PAPER_SIZE)" \ $(XMLTO) $(XMLTO_FLAGS) fo $< # %.html - Pattern rule to produce html output from xml input. %.html: %.xml $(XMLTO) $(XMLTO_FLAGS) html-nochunks $< # fop_help - Display fop processor help text. .PHONY: fop_help fop_help: -java org.apache.fop.apps.Fop -help -java org.apache.fop.apps.Fop -print help ################################################################# # release - Produce a release of the book. # RELEASE_TAR := mpwm-$(shell date +%F).tar.gz RELEASE_FILES := README Makefile *.pdf bin examples out text . PHONY : release release: $(BOOK_PDF_OUT) ln -sf $(BOOK_PDF_OUT) . tar --create \ --gzip \ --file=$(RELEASE_TAR) \ --exclude=CVS \ --exclude=semantic.cache \ --exclude=*~ \ $(RELEASE_FILES) ls -l $(RELEASE_TAR) ################################################################# # Rules for Chapter 1 examples. # # Here are all the example directories. EXAMPLES := \ ch01-bogus-tab \ ch01-cw1 \ ch01-hello \ ch01-cw2 \ ch01-cw2a \ ch02-cw3 \ ch02-cw4 \ ch02-cw4a \ ch02-cw5 \ ch02-cw5a \ ch02-cw5b \ ch02-cw6 \ ch02-make-clean \ ch03-assert-not-null \ ch03-debug-trace \ ch03-debug-trace-1 \ ch03-debug-trace-2 \ ch03-filter-failure \ ch03-find-program-1 \ ch03-find-program-2 \ ch03-findstring-1 \ ch03-grep \ ch03-include \ ch03-invalid-variable \ ch03-kill-acroread \ ch03-kill-program \ ch03-letters \ ch03-program-variables-1 \ ch03-program-variables-2 \ ch03-program-variables-3 \ ch03-program- variables -5 \ ch03-scoping-issue \ ch03-shell \ ch03-trailing-space \ ch04-extent \ ch04-for-loop-1 \ ch04-for-loop-2 \ ch04-for-loop-3 \ ch06-simple \ appb-defstruct \ appb-arithmetic # I would really like to use this foreach loop, but a bug in 3.80 # generates a fatal error. #$(foreach e,$(EXAMPLES),$(eval $(call generic-program-example,$e))) # Instead I expand the foreach by hand here. $(eval $(call generic-program-example,ch01- bogus -tab)) $(eval $(call generic-program-example,ch01-cw1)) $(eval $(call generic-program-example,ch01-hello)) $(eval $(call generic-program-example,ch01-cw2)) $(eval $(call generic-program-example,ch01-cw2a)) $(eval $(call generic-program-example,ch02-cw3)) $(eval $(call generic-program-example,ch02-cw4)) $(eval $(call generic-program-example,ch02-cw4a)) $(eval $(call generic-program-example,ch02-cw5)) $(eval $(call generic-program-example,ch02-cw5a)) $(eval $(call generic-program-example,ch02-cw5b)) $(eval $(call generic-program-example,ch02-cw6)) $(eval $(call generic-program-example,ch02-make-clean)) $(eval $(call generic-program-example,ch03-assert-not-null)) $(eval $(call generic-program-example,ch03-debug-trace)) $(eval $(call generic-program-example,ch03-debug-trace-1)) $(eval $(call generic-program-example,ch03-debug-trace-2)) $(eval $(call generic-program-example,ch03-filter-failure)) $(eval $(call generic-program-example,ch03-find-program-1)) $(eval $(call generic-program-example,ch03-find-program-2)) $(eval $(call generic-program-example,ch03-findstring-1)) $(eval $(call generic-program-example,ch03-grep)) $(eval $(call generic-program-example,ch03-include)) $(eval $(call generic-program-example,ch03-invalid-variable)) $(eval $(call generic-program-example,ch03-kill-acroread)) $(eval $(call generic-program-example,ch03-kill-program)) $(eval $(call generic-program-example,ch03- letters )) $(eval $(call generic-program-example,ch03-program-variables-1)) $(eval $(call generic-program-example,ch03-program-variables-2)) $(eval $(call generic-program-example,ch03-program-variables-3)) $(eval $(call generic-program-example,ch03-program-variables-5)) $(eval $(call generic-program-example,ch03-scoping-issue)) $(eval $(call generic-program-example,ch03-shell)) $(eval $(call generic-program-example,ch03-trailing-space)) $(eval $(call generic-program-example,ch04-extent)) $(eval $(call generic-program-example,ch04-for-loop-1)) $(eval $(call generic-program-example,ch04-for-loop-2)) $(eval $(call generic-program-example,ch04-for-loop-3)) $(eval $(call generic-program-example,ch06-simple)) $(eval $(call generic-program-example,ch10-echo-bash)) $(eval $(call generic-program-example,appb-defstruct)) $(eval $(call generic-program-example,appb-arithmetic)) ################################################################# # validate # # Check for 1) unexpanded m4 macros; b) tabs; c) FIXME comments; d) # RM: responses to Andy; e) duplicate m4 macros # validation_checks := $(OUTPUT_DIR)/chk_macros_tabs \ $(OUTPUT_DIR)/chk_fixme \ $(OUTPUT_DIR)/chk_duplicate_macros \ $(OUTPUT_DIR)/chk_orphaned_examples .PHONY: validate-only validate-only: $(OUTPUT_DIR)/validate $(OUTPUT_DIR)/validate: $(validation_checks) $(TOUCH) $@ $(OUTPUT_DIR)/chk_macros_tabs: $(ALL_XML_OUT) # Looking for macros and tabs... $(QUIET)! $(EGREP) --ignore-case \ --line-number \ --regexp='\b(m4_mp_)' \ --regexp='\011' \ $^ $(TOUCH) $@ $(OUTPUT_DIR)/chk_fixme: $(ALL_XML_OUT) # Looking for RM: and FIXME... $(QUIET)$(AWK) \ '/FIXME/ { printf "%s:%s: %s\n", FILENAME, NR, $$0 } \ /^ *RM:/ { \ if ( $$0 !~ /RM: Done/ ) \ printf "%s:%s: %s\n", FILENAME, NR, $$0 \ }' $(subst $(OUTPUT_DIR)/,$(SOURCE_DIR)/,$^) $(TOUCH) $@ $(OUTPUT_DIR)/chk_duplicate_macros: $(SOURCE_DIR)/macros.m4 # Looking for duplicate macros... $(QUIET)! $(EGREP) --only-matching \ "\`[^']+'," $< \ $(SORT) \ uniq -c \ $(AWK) '$$1 > 1 { printf "$<:0: %s\n", $$0 }' \ $(EGREP) "^" $(TOUCH) $@ ALL_EXAMPLES := $(TMP)/all_examples $(OUTPUT_DIR)/chk_orphaned_examples: $(ALL_EXAMPLES) $(DEPENDENCY_FILES) $(QUIET)$(AWK) -F/ '/(EXAMPLESOUTPUT)_DIR/ { print $$3 }' \ $(filter %.d,$^) \ $(SORT) -u \ comm -13 - $(filter-out %.d,$^) $(TOUCH) $@ .INTERMEDIATE: $(ALL_EXAMPLES) $(ALL_EXAMPLES): # Looking for unused examples... $(QUIET) ls -p $(EXAMPLES_DIR) \ $(AWK) '/CVS/ { next } \ /\// { print substr($$0, 1, length - 1) }' > $@ ################################################################# # clean # clean: $(kill-acroread) $(RM) -r $(OUTPUT_DIR) $(RM) $(SOURCE_DIR)/*~ $(SOURCE_DIR)/*.log semantic.cache $(RM) book.pdf ################################################################# # Dependency Management # # Don't read or remake includes if we are doing a clean. # ifneq "$(MAKECMDGOALS)" "clean" -include $(DEPENDENCY_FILES) endif vpath %.xml $(SOURCE_DIR) vpath %.tif $(SOURCE_DIR) vpath %.eps $(SOURCE_DIR) $(OUTPUT_DIR)/%.xml: %.xml $(process-pgm) $(m4-macros) $(call process-includes, $<, $@) $(OUTPUT_DIR)/%.tif: %.tif $(CP) $< $@ $(OUTPUT_DIR)/%.eps: %.eps $(CP) $< $@ $(OUTPUT_DIR)/%.d: %.xml $(make-depend) $(make-depend) $< > $@ ################################################################# # Create Output Directory # # Create the output directory if necessary. # DOCBOOK_IMAGES := $(OUTPUT_DIR)/release/images DRAFT_PNG := /usr/share/docbook-xsl/images/draft.png ifneq "$(MAKECMDGOALS)" "clean" _CREATE_OUTPUT_DIR := \ $(shell \ $(MKDIR) $(DOCBOOK_IMAGES) & \ $(CP) $(DRAFT_PNG) $(DOCBOOK_IMAGES); \ if ! [[ $(foreach d, \ $(notdir \ $(wildcard $(EXAMPLES_DIR)/ch*)), \ -e $(OUTPUT_DIR)/$d &) -e . ]]; \ then \ echo Linking examples... > /dev/stderr; \ $(LNDIR) $(BOOK_DIR)/$(EXAMPLES_DIR) $(BOOK_DIR)/$(OUTPUT_DIR); \ fi) endif , 1, length - 1) }' > $@ ################################################################# # clean # clean: $(kill-acroread) $(RM) -r $(OUTPUT_DIR) $(RM) $(SOURCE_DIR)/*~ $(SOURCE_DIR)/*.log semantic.cache $(RM) book.pdf ################################################################# # Dependency Management # # Don't read or remake includes if we are doing a clean. # ifneq "$(MAKECMDGOALS)" "clean" -include $(DEPENDENCY_FILES) endif vpath %.xml $(SOURCE_DIR) vpath %.tif $(SOURCE_DIR) vpath %.eps $(SOURCE_DIR) $(OUTPUT_DIR)/%.xml: %.xml $(process-pgm) $(m4-macros) $(call process-includes, $<, $@) $(OUTPUT_DIR)/%.tif: %.tif $(CP) $< $@ $(OUTPUT_DIR)/%.eps: %.eps $(CP) $< $@ $(OUTPUT_DIR)/%.d: %.xml $(make-depend) $(make-depend) $< > $@ ################################################################# # Create Output Directory # # Create the output directory if necessary. # DOCBOOK_IMAGES := $(OUTPUT_DIR)/release/images DRAFT_PNG := /usr/share/docbook-xsl/images/draft.png ifneq "$(MAKECMDGOALS)" "clean" _CREATE_OUTPUT_DIR := \ $(shell \ $(MKDIR) $(DOCBOOK_IMAGES) & \ $(CP) $(DRAFT_PNG) $(DOCBOOK_IMAGES); \ if ! [[ $(foreach d, \ $(notdir \ $(wildcard $(EXAMPLES_DIR)/ch*)), \ -e $(OUTPUT_DIR)/$d &) -e . ]]; \ then \ echo Linking examples... > /dev/stderr; \ $(LNDIR) $(BOOK_DIR)/$(EXAMPLES_DIR) $(BOOK_DIR)/$(OUTPUT_DIR); \ fi) endif
The makefile is written to run under Cygwin with no serious attempt at portability to Unix. Nevertheless, I believe there are few, if any, incompatibilities with Unix that cannot be resolved by redefining a variable or possibly introducing an additional variable. The global variables section first defines the location of the root directory and the relative locations of the text, examples, and output directories. Each nontrivial program used by the makefile is defined as a variable. 11.1.1 Managing Examples The first task, managing the examples, is the most complex. Each example is stored in its own directory under book/examples/ch n -<title> . Examples consist of a makefile along with any supporting files and directories. To process an example we first create a directory of symbolic links to the output tree and work there so that no artifacts of running the makefile are left in the source tree. Furthermore, most of the examples require setting the current working directory to that of the makefile , in order to generate the expected output. After symlinking the source, we execute a shell script, run-make , to invoke the makefile with the appropriate arguments. If no shell script is present in the source tree, we can generate a default version. The output of the run-make script is saved in make.out . Some examples produce an executable, which must also be run. This is accomplished by running the script run-run and saving its output in the file run.out . Creating the tree of symbolic links is performed by this code at the end of the makefile : ifneq "$(MAKECMDGOALS)" "clean" _CREATE_OUTPUT_DIR := \ $(shell \ ... if ! [[ $(foreach d, \ $(notdir \ $(wildcard $(EXAMPLES_DIR)/ch*)), \ -e $(OUTPUT_DIR)/$d &&) -e . ]]; \ then \ echo Linking examples... > /dev/stderr; \ $(LNDIR) $(BOOK_DIR)/$(EXAMPLES_DIR) $(BOOK_DIR)/$(OUTPUT_DIR); \ fi) endif
The code consists of a single, simple variable assignment wrapped in an ifneq conditional. The conditional is there to prevent make from creating the output directory structure during a make clean . The actual variable is a dummy whose value is never used. However, the shell function on the right-hand side is executed immediately when make reads the makefile . The shell function checks if each example directory exists in the output tree. If any is missing, the lndir command is invoked to update the tree of symbolic links. The test used by the if is worth examining more closely. The test itself consists of one -e test (i.e., does the file exist?) for each example directory. The actual code goes something like this: use wildcard to determine all the examples and strip their directory part with notdir , then for each example directory produce the text -e $(OUTPUT_DIR)/ dir && . Now, concatenate all these pieces, and embed them in a bash [[...]] test. Finally, negate the result. One extra test, -e ., is included to allow the foreach loop to simply add && to every clause. This is sufficient to ensure that new directories are always added to the build when they are discovered . The next step is to create rules that will update the two output files, make.out and run.out . This is done for each example .out file with a user -defined function: # $(call generic-program-example,example-directory) # Create the rules to build a generic example. define generic-program-example $(eval _dir := $(OUTPUT_DIR)/) $(eval _make_out := $(_dir)/make.out) $(eval _run_out := $(_dir)/run.out) $(eval _clean := $(_dir)/clean) $(eval _run_make := $(_dir)/run-make) $(eval _run_run := $(_dir)/run-run) $(eval _sources := $(filter-out %/CVS, $(wildcard $(EXAMPLES_DIR)//*))) $(_run_out): $(_make_out) $(_run_run) $$(call run-script-example, $(_run_run), $$@) $(_make_out): $(_clean) $(_run_make) $$(call run-script-example, $(_run_make), $$@) $(_clean): $(_sources) Makefile $(RM) -r $(_dir) $(MKDIR) $(_dir) $(LNDIR) -silent ../../$(EXAMPLES_DIR)/ $(_dir) $(TOUCH) $$@ $(_run_make): printf "#! /bin/bash -x\nmake\n" > $$@ endef
This function is intended to be invoked once for each example directory: $(eval $(call generic-program-example,ch01-bogus-tab)) $(eval $(call generic-program-example,ch01-cw1)) $(eval $(call generic-program-example,ch01-hello)) $(eval $(call generic-program-example,ch01-cw2))
The variable definitions at the beginning of the function are mostly for convenience and to improve readability. Further improvement comes from performing the assignments inside eval so their value can be used immediately by the macro without extra quoting. The heart of the function is the first two targets: $($1_run_out) and $($1_make_out) . These update the run.out and make.out targets for each example, respectively. The variable names are composed from the example directory name and the indicated suffix, _run_out or _make_out . The first rule says that run.out depends upon make.out and the run-run script. That is, rerun the example program if make has been run or the run-run control script has been updated. The target is updated with the run-script-example function: # $(call run-script-example, script-name, output-file) # Run an example makefile. define run-script-example ( cd $(dir ); \ $(notdir ) 2>&1 \ if $(EGREP) --silent '$$\(MAKE\)' [mM]akefile; \ then \ $(SED) -e 's/^++*/$$/'; \ else \ $(SED) -e 's/^++*/$$/' \ -e '/ing directory /d' \ -e 's/\[[0-9]\]//'; \ fi ) \ > $(TMP)/out.$$$$ && \ $(MV) $(TMP)/out.$$$$ endef
This function requires the path to the script and the output filename. It changes to the script's directory and runs the script, piping both the standard output and error output through a filter to clean them up. [1] [1] The cleaning process gets complex. The run-run and run-make scripts often use bash -x to allow the actual make command line to be echoed . The -x option puts ++ before each command in the output, which the cleaning script transforms into a simple $ representing the shell prompt. However, commands are not the only information to appear in the output. Because make is running the example and eventually starts another make , simple makefile s include extra, unwanted output such as the messages Entering directory . . . and Leaving directory . . . as well as displaying a make level number in messages. For simple makefile s that do not recursively invoke make , we strip this inappropriate output to present the output of make as if it were run from a top-level shell. The make.out target is similar but has an added complication. If new files are added to an example, we would like to detect the situation and rebuild the example. The _CREATE_OUTPUT_DIR code rebuilds symlinks only if a new directory is discovered, not when new files are added. To detect this situation, we drop a timestamp file in each example directory indicating when the last lndir was performed. The $($1_clean) target updates this timestamp file and depends upon the actual source files in the examples directory (not the symlinks in the output directory). If make 's dependency analysis discovers a newer file in the examples directory than the clean timestamp file, the command script will delete the symlinked output directory, recreate it, and drop a new clean timestamp file. This action is also performed when the makefile itself is modified. Finally, the run-make shell script invoked to run the makefile is typically a two-line script. #! /bin/bash -x make
It quickly became tedious to produce these boilerplate scripts, so the $($1_run_make) target was added as a prerequisite to $($1_make_out) to create it. If the prerequisite is missing, the makefile generates it in the output tree. The generic-program-example function, when executed for each example directory, creates all the rules for running examples and preparing the output for inclusion in the XML files. These rules are triggered by computed dependencies included in the makefile . For example, the dependency file for Chapter 1 is: out/ch01.xml: $(EXAMPLES_DIR)/ch01-hello/Makefile out/ch01.xml: $(OUTPUT_DIR)/ch01-hello/make.out out/ch01.xml: $(EXAMPLES_DIR)/ch01-cw1/count_words.c out/ch01.xml: $(EXAMPLES_DIR)/ch01-cw1/lexer.l out/ch01.xml: $(EXAMPLES_DIR)/ch01-cw1/Makefile out/ch01.xml: $(OUTPUT_DIR)/ch01-cw1/make.out out/ch01.xml: $(EXAMPLES_DIR)/ch01-cw2/lexer.l out/ch01.xml: $(OUTPUT_DIR)/ch01-cw2/make.out out/ch01.xml: $(OUTPUT_DIR)/ch01-cw2/run.out out/ch01.xml: $(OUTPUT_DIR)/ch01-bogus-tab/make.out
These dependencies are generated by a simple awk script, imaginatively named make-depend : #! /bin/awk -f function generate_dependency( prereq ) { filename = FILENAME sub( /text/, "out", filename ) print filename ": " prereq } /^ *include-program/ { generate_dependency( "$(EXAMPLES_DIR)/" ) } /^ *mp_program\(/ { match( #! /bin/awk -f function generate_dependency( prereq ) { filename = FILENAME sub( /text/, "out", filename ) print filename ": " prereq } /^ *include-program/ { generate_dependency( "$(EXAMPLES_DIR)/" $2 ) } /^ *mp_program\(/ { match( $0, /\((.*)\)/, names ) generate_dependency( "$(EXAMPLES_DIR)/" names[1] ) } /^ *include-output/ { generate_dependency( "$(OUTPUT_DIR)/" $2 ) } /^ *mp_output\(/ { match( $0, /\((.*)\)/, names ) generate_dependency( "$(OUTPUT_DIR)/" names[1] ) } /graphic fileref/ { match( $0, /"(.*)"/, out_file ) generate_dependency( out_file[1] ); } , /\((.*)\)/, names ) generate_dependency( "$(EXAMPLES_DIR)/" names[1] ) } /^ *include-output/ { generate_dependency( "$(OUTPUT_DIR)/" ) } /^ *mp_output\(/ { match( #! /bin/awk -f function generate_dependency( prereq ) { filename = FILENAME sub( /text/, "out", filename ) print filename ": " prereq } /^ *include-program/ { generate_dependency( "$(EXAMPLES_DIR)/" $2 ) } /^ *mp_program\(/ { match( $0, /\((.*)\)/, names ) generate_dependency( "$(EXAMPLES_DIR)/" names[1] ) } /^ *include-output/ { generate_dependency( "$(OUTPUT_DIR)/" $2 ) } /^ *mp_output\(/ { match( $0, /\((.*)\)/, names ) generate_dependency( "$(OUTPUT_DIR)/" names[1] ) } /graphic fileref/ { match( $0, /"(.*)"/, out_file ) generate_dependency( out_file[1] ); } , /\((.*)\)/, names ) generate_dependency( "$(OUTPUT_DIR)/" names[1] ) } /graphic fileref/ { match( #! /bin/awk -f function generate_dependency( prereq ) { filename = FILENAME sub( /text/, "out", filename ) print filename ": " prereq } /^ *include-program/ { generate_dependency( "$(EXAMPLES_DIR)/" $2 ) } /^ *mp_program\(/ { match( $0, /\((.*)\)/, names ) generate_dependency( "$(EXAMPLES_DIR)/" names[1] ) } /^ *include-output/ { generate_dependency( "$(OUTPUT_DIR)/" $2 ) } /^ *mp_output\(/ { match( $0, /\((.*)\)/, names ) generate_dependency( "$(OUTPUT_DIR)/" names[1] ) } /graphic fileref/ { match( $0, /"(.*)"/, out_file ) generate_dependency( out_file[1] ); } , /"(.*)"/, out_file ) generate_dependency( out_file[1] ); }
The script searches for patterns like: mp_program(ch01-hello/Makefile) mp_output(ch01-hello/make.out)
(The mp_program macro uses the program listing format, while the mp_output macro uses the program output format.) The script generates the dependency from the source filename and the filename parameter. Finally, the generation of dependency files is triggered by a make include statement, in the usual fashion: # $(call source-to-output, file-name) # Transform a source tree reference to an output tree reference. define source-to-output $(subst $(SOURCE_DIR),$(OUTPUT_DIR),) endef . . . ALL_XML_SRC := $(wildcard $(SOURCE_DIR)/*.xml) DEPENDENCY_FILES := $(call source-to-output,$(subst .xml,.d,$(ALL_XML_SRC))) . . . ifneq "$(MAKECMDGOALS)" "clean" -include $(DEPENDENCY_FILES) endif vpath %.xml $(SOURCE_DIR) . . . $(OUTPUT_DIR)/%.d: %.xml $(make-depend) $(make-depend) $< > $@
This completes the code for handling examples. Most of the complexity stems from the desire to include the actual source of the makefile s as well as the actual output from make and the example programs. I suspect there is also a little bit of the "put up or shut up" syndrome here. If I believe make is so great, it should be able to handle this complex task and, by golly, it can. 11.1.2 XML Preprocessing At the risk of branding myself as a philistine for all posterity, I must admit I don't like XML very much. I find it awkward and verbose. So, when I discovered that the manuscript must be written in DocBook, I looked for more traditional tools that would help ease the pain. The m4 macro processor and awk were two tools that helped immensely. There were two problems with DocBook and XML that m4 was perfect for: avoiding the verbose syntax of XML and managing the XML identifiers used in cross-referencing. For instance, to emphasize a word in DocBook, you must write: <emphasis>not</emphasis>
Using m4 , I wrote a simple macro that allowed me to instead write: mp_em(not)
Ahh, that feels better. In addition, I introduced many symbolic formatting styles appropriate for the material, such as mp_variable and mp_target . This allowed me to select a trivial format, such as literal, and change it later to whatever the production department preferred without having to perform a global search and replace. I'm sure the XML aficionados will probably send me boat loads of email telling me how to do this with entities or some such, but remember Unix is about getting the job done now with the tools at hand, and as Larry Wall loves to say, "there's more than one way to do it." Besides, I'm afraid learning too much XML will rot my brain. The second task for m4 was handling the XML identifiers used for cross-referencing. Each chapter, section, example, and table is labeled with an identifier: <sect1 >
References to a chapter must use this identifier. This is clearly an issue from a programming standpoint. The identifiers are complex constants sprinkled throughout the "code." Furthermore, the symbols themselves have no meaning. I have no idea what section 1 of Chapter 7 might have been about. By using m4 , I could avoid duplicating complex literals, and provide a more meaningful name: <sect1 >
Most importantly, if chapters or sections shift, as they did many times, the text could be updated by changing a few constants in a single file. The advantage was most noticeable when sections were renumbered in a chapter. Such an operation might require a half dozen global search and replace operations across all files if I hadn't used symbolic references. Here is an example of several m4 macros [2] : [2] The mp prefix stands for Managing Projects (the book's title), macro processor, or make pretty. Take your pick. m4_define(`mp_tag', `<>`'</>') m4_define(`mp_lit', `mp_tag(literal, `')') m4_define(`mp_cmd', `mp_tag(command,`')') m4_define(`mp_target', `mp_lit()') m4_define(`mp_all', `mp_target(all)') m4_define(`mp_bash', `mp_cmd(bash)') m4_define(`mp_ch_examples', `MPWM-CH-11') m4_define(`mp_se_book', `MPWM-CH-11.1') m4_define(`mp_ex_book_makefile',`MPWM-CH-11-EX-1')
The other preprocessing task was to implement an include feature for slurping in the example text previously discussed. This text needed to have its tabs converted to spaces (since O'Reilly's DocBook converter cannot handle tabs and makefile s have lots of tabs!), must be wrapped in a [CDATA[...]] to protect special characters , and finally, has to trim the extra newlines at the beginning and end of examples. I accomplished this with another little awk program called process-includes : #! /usr/bin/awk -f function expand_cdata( dir ) { start_place = match( , "include-" ) if ( start_place > 0 ) { prefix = substr( , 1, start_place - 1 ) } else { print "Bogus include '" #! /usr/bin/awk -f function expand_cdata( dir ) { start_place = match( $1, "include-" ) if ( start_place > 0 ) { prefix = substr( $1, 1, start_place - 1 ) } else { print "Bogus include '" $0 "'" > "/dev/stderr" } end_place = match( $2, "(</(programlistingscreen)>.*)$", tag ) if ( end_place > 0 ) { file = dir substr( $2, 1, end_place - 1 ) } else { print "Bogus include '" $0 "'" > "/dev/stderr" } command = "expand " file printf "%s>&33;&91;CDATA[", prefix tail = 0 previous_line = "" while ( (command getline line) > 0 ) { if ( tail ) print previous_line; tail = 1 previous_line = line } printf "%s&93;&93;&62;%s\n", previous_line, tag[1] close( command ) } /include-program/ { expand_cdata( "examples/" ) next; } /include-output/ { expand_cdata( "out/" ) next; } /<(programlistingscreen)> *$/ { # Find the current indentation. offset = match( $0, "<(programlistingscreen)>" ) # Strip newline from tag. printf $0 # Read the program... tail = 0 previous_line = "" while ( (getline line) > 0 ) { if ( line ~ "</( programlisting screen)>" ) { gsub( /^ */, "", line ) break } if ( tail ) print previous_line tail = 1 previous_line = substr( line, offset + 1 ) } printf "%s%s\n", previous_line, line next } { print } "'" > "/dev/stderr" } end_place = match( , "(</(programlistingscreen)>.*)$", tag ) if ( end_place > 0 ) { file = dir substr( , 1, end_place - 1 ) } else { print "Bogus include '" #! /usr/bin/awk -f function expand_cdata( dir ) { start_place = match( $1, "include-" ) if ( start_place > 0 ) { prefix = substr( $1, 1, start_place - 1 ) } else { print "Bogus include '" $0 "'" > "/dev/stderr" } end_place = match( $2, "(</(programlistingscreen)>.*)$", tag ) if ( end_place > 0 ) { file = dir substr( $2, 1, end_place - 1 ) } else { print "Bogus include '" $0 "'" > "/dev/stderr" } command = "expand " file printf "%s>&33;&91;CDATA[", prefix tail = 0 previous_line = "" while ( (command getline line) > 0 ) { if ( tail ) print previous_line; tail = 1 previous_line = line } printf "%s&93;&93;&62;%s\n", previous_line, tag[1] close( command ) } /include-program/ { expand_cdata( "examples/" ) next; } /include-output/ { expand_cdata( "out/" ) next; } /<(programlistingscreen)> *$/ { # Find the current indentation. offset = match( $0, "<(programlistingscreen)>" ) # Strip newline from tag. printf $0 # Read the program... tail = 0 previous_line = "" while ( (getline line) > 0 ) { if ( line ~ "</( programlisting screen)>" ) { gsub( /^ */, "", line ) break } if ( tail ) print previous_line tail = 1 previous_line = substr( line, offset + 1 ) } printf "%s%s\n", previous_line, line next } { print } "'" > "/dev/stderr" } command = "expand " file printf "%s>&33;&91;CDATA[", prefix tail = 0 previous_line = "" while ( (command getline line) > 0 ) { if ( tail ) print previous_line; tail = 1 previous_line = line } printf "%s&93;&93;&62;%s\n", previous_line, tag[1] close( command ) } /include-program/ { expand_cdata( "examples/" ) next; } /include-output/ { expand_cdata( "out/" ) next; } /<(programlistingscreen)> *$/ { # Find the current indentation. offset = match( #! /usr/bin/awk -f function expand_cdata( dir ) { start_place = match( $1, "include-" ) if ( start_place > 0 ) { prefix = substr( $1, 1, start_place - 1 ) } else { print "Bogus include '" $0 "'" > "/dev/stderr" } end_place = match( $2, "(</(programlistingscreen)>.*)$", tag ) if ( end_place > 0 ) { file = dir substr( $2, 1, end_place - 1 ) } else { print "Bogus include '" $0 "'" > "/dev/stderr" } command = "expand " file printf "%s>&33;&91;CDATA[", prefix tail = 0 previous_line = "" while ( (command getline line) > 0 ) { if ( tail ) print previous_line; tail = 1 previous_line = line } printf "%s&93;&93;&62;%s\n", previous_line, tag[1] close( command ) } /include-program/ { expand_cdata( "examples/" ) next; } /include-output/ { expand_cdata( "out/" ) next; } /<(programlistingscreen)> *$/ { # Find the current indentation. offset = match( $0, "<(programlistingscreen)>" ) # Strip newline from tag. printf $0 # Read the program... tail = 0 previous_line = "" while ( (getline line) > 0 ) { if ( line ~ "</( programlisting screen)>" ) { gsub( /^ */, "", line ) break } if ( tail ) print previous_line tail = 1 previous_line = substr( line, offset + 1 ) } printf "%s%s\n", previous_line, line next } { print } , "<(programlistingscreen)>" ) # Strip newline from tag. printf #! /usr/bin/awk -f function expand_cdata( dir ) { start_place = match( $1, "include-" ) if ( start_place > 0 ) { prefix = substr( $1, 1, start_place - 1 ) } else { print "Bogus include '" $0 "'" > "/dev/stderr" } end_place = match( $2, "(</(programlistingscreen)>.*)$", tag ) if ( end_place > 0 ) { file = dir substr( $2, 1, end_place - 1 ) } else { print "Bogus include '" $0 "'" > "/dev/stderr" } command = "expand " file printf "%s>&33;&91;CDATA[", prefix tail = 0 previous_line = "" while ( (command getline line) > 0 ) { if ( tail ) print previous_line; tail = 1 previous_line = line } printf "%s&93;&93;&62;%s\n", previous_line, tag[1] close( command ) } /include-program/ { expand_cdata( "examples/" ) next; } /include-output/ { expand_cdata( "out/" ) next; } /<(programlistingscreen)> *$/ { # Find the current indentation. offset = match( $0, "<(programlistingscreen)>" ) # Strip newline from tag. printf $0 # Read the program... tail = 0 previous_line = "" while ( (getline line) > 0 ) { if ( line ~ "</( programlisting screen)>" ) { gsub( /^ */, "", line ) break } if ( tail ) print previous_line tail = 1 previous_line = substr( line, offset + 1 ) } printf "%s%s\n", previous_line, line next } { print } # Read the program... tail = 0 previous_line = "" while ( (getline line) > 0 ) { if ( line ~ "</(programlistingscreen)>" ) { gsub( /^ */, "", line ) break } if ( tail ) print previous_line tail = 1 previous_line = substr( line, offset + 1 ) } printf "%s%s\n", previous_line, line next } { print }
In the makefile , we copy the XML files from the source tree to the output tree, transforming tabs, macros, and include files in the process: process-pgm := bin/process-includes m4-macros := text/macros.m4 # $(call process-includes, input-file, output-file) # Remove tabs, expand macros, and process include directives. define process-includes expand \ $(M4) --prefix-builtins --include=text $(m4-macros) - \ $(process-pgm) > endef vpath %.xml $(SOURCE_DIR) $(OUTPUT_DIR)/%.xml: %.xml $(process-pgm) $(m4-macros) $(call process-includes, $<, $@)
The pattern rule indicates how to get an XML file from the source tree into the output tree. It also says that all the output XML files should be regenerated if the macros or the include processor change. 11.1.3 Generating Output So far, nothing we've covered has actually formatted any text or created anything that can be printed or displayed. Obviously, a very important feature if the makefile is to format a book. There were two formats that I was interested in: HTML and PDF. I figured out how to format to HTML first. There's a great little program, xsltproc , and its helper script, xmlto , that I used to do the job. Using these tools, the process was fairly simple: # Book output formats. BOOK_XML_OUT := $(OUTPUT_DIR)/book.xml BOOK_HTML_OUT := $(subst xml,html,$(BOOK_XML_OUT)) ALL_XML_SRC := $(wildcard $(SOURCE_DIR)/*.xml) ALL_XML_OUT := $(call source-to-output,$(ALL_XML_SRC)) # html - Produce the desired output format for the book. .PHONY: html html: $(BOOK_HTML_OUT) # show_html - Generate an html file and display it. .PHONY: show_html show_html: $(BOOK_HTML_OUT) $(HTML_VIEWER) $(BOOK_HTML_OUT) # $(BOOK_HTML_OUT) - Generate the html file. $(BOOK_HTML_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # %.html - Pattern rule to produce html output from xml input. %.html: %.xml $(XMLTO) $(XMLTO_FLAGS) html-nochunks $<
The pattern rule does most of the work of converting an XML file into an HTML file. The book is organized as a single top-level file, book.xml , that includes each chapter. The top-level file is represented by BOOK_XML_OUT . The HTML counterpart is BOOK_HTML_OUT , which is a target. The BOOK_HTML_OUT file has its included XML files a prerequisites. For convenience, there are two phony targets, html and show_html , that create the HTML file and display it in the local browser, respectively. Although easy in principle, generating PDF was considerably more complex. The xsltproc program is able to produce PDF directly, but I was unable to get it to work. All this work was done on Windows with Cygwin and the Cygwin version of xsltproc wanted POSIX paths. The custom version of DocBook I was using and the manuscript itself contained Windows-specific paths. This difference, I believe, gave xsltproc fits that I could not quell. Instead, I chose to use xsltproc to generate XML formatting objects and the Java program FOP (http://xml.apache.org/fop) for generating the PDF. Thus, the code to generate PDF is somewhat longer: # Book output formats. BOOK_XML_OUT := $(OUTPUT_DIR)/book.xml BOOK_FO_OUT := $(subst xml,fo,$(BOOK_XML_OUT)) BOOK_PDF_OUT := $(subst xml,pdf,$(BOOK_XML_OUT)) ALL_XML_SRC := $(wildcard $(SOURCE_DIR)/*.xml) ALL_XML_OUT := $(call source-to-output,$(ALL_XML_SRC)) # pdf - Produce the desired output format for the book. .PHONY: pdf pdf: $(BOOK_PDF_OUT) # show_pdf - Generate a pdf file and display it. .PHONY: show_pdf show_pdf: $(BOOK_PDF_OUT) $(kill-acroread) $(PDF_VIEWER) $(BOOK_PDF_OUT) # $(BOOK_PDF_OUT) - Generate the pdf file. $(BOOK_PDF_OUT): $(BOOK_FO_OUT) Makefile # $(BOOK_FO_OUT) - Generate the fo intermediate output file. .INTERMEDIATE: $(BOOK_FO_OUT) $(BOOK_FO_OUT): $(ALL_XML_OUT) $(OUTPUT_DIR)/validate Makefile # FOP Support FOP := org.apache.fop.apps.Fop # DEBUG_FOP - Define this to see fop processor output. ifndef DEBUG_FOP FOP_FLAGS := -q FOP_OUTPUT := $(SED) -e '/not implemented/d' \ -e '/relative-align/d' \ -e '/xsl-footnote-separator/d' endif # CLASSPATH - Compute the appropriate CLASSPATH for fop. export CLASSPATH CLASSPATH = $(patsubst %;,%, \ $(subst ; ,;, \ $(addprefix c:/usr/xslt-process-2.2/java/, \ $(addsuffix .jar;, \ xalan \ xercesImpl \ batik \ fop \ jimi-1.0 \ avalon-framework-cvs-20020315)))) # %.pdf - Pattern rule to produce pdf output from fo input. %.pdf: %.fo $(kill-acroread) java -Xmx128M $(FOP) $(FOP_FLAGS) $< $@ $(FOP_OUTPUT) # %.fo - Pattern rule to produce fo output from xml input. PAPER_SIZE := letter %.fo: %.xml XSLT_FLAGS="--stringparam paper.type $(PAPER_SIZE)" \ $(XMLTO) $(XMLTO_FLAGS) fo $< # fop_help - Display fop processor help text. .PHONY: fop_help fop_help: -java org.apache.fop.apps.Fop -help -java org.apache.fop.apps.Fop -print help
As you can see, there are now two pattern rules reflecting the two-stage process I used. The .xml to .fo rule invokes xmlto . The .fo to .pdf rule first kills any running Acrobat reader (because the program locks the PDF file, preventing FOP from writing the file), then runs FOP. FOP is a very chatty program, and scrolling through hundreds of lines of pointless warnings got old fast, so I added a simple sed filter, FOP_OUTPUT , to remove the irritating warnings. Occasionally, however, those warnings had some real data in them, so I added a debugging feature, DEBUG_FOP , to disable my filter. Finally, like the HTML version, I added two convenience targets, pdf and show_pdf , to kick the whole thing off. 11.1.4 Validating the Source What with DocBook's allergy to tabs, macro processors, include files and comments from editors, making sure the source text is correct and complete is not easy. To help, I implemented four validation targets that check for various forms of correctness. validation_checks := $(OUTPUT_DIR)/chk_macros_tabs \ $(OUTPUT_DIR)/chk_fixme \ $(OUTPUT_DIR)/chk_duplicate_macros \ $(OUTPUT_DIR)/chk_orphaned_examples .PHONY: validate-only validate-only: $(OUTPUT_DIR)/validate $(OUTPUT_DIR)/validate: $(validation_checks) $(TOUCH) $@
Each target generates a timestamp file, and they are all prerequisites of a top-level timestamp file, validate . $(OUTPUT_DIR)/chk_macros_tabs: $(ALL_XML_OUT) # Looking for macros and tabs... $(QUIET)! $(EGREP) --ignore-case \ --line-number \ --regexp='\b(m4_mp_)' \ --regexp='1' \ $^ $(TOUCH) $@
This first check looks for m4 macros that were not expanded during preprocessing. This indicates either a misspelled macro or a macro that has never been defined. The check also scans for tab characters. Of course, neither of these situations should ever happen, but they did! One interesting bit in the command script is the exclamation point after $(QUIET) . The purpose is to negate the exit status of egrep . That is, make should consider the command a failure if egrep does find one of the patterns. $(OUTPUT_DIR)/chk_fixme: $(ALL_XML_OUT) # Looking for RM: and FIXME... $(QUIET)$(AWK) \ '/FIXME/ { printf "%s:%s: %s\n", FILENAME, NR, $ $(OUTPUT_DIR)/chk_fixme: $(ALL_XML_OUT) # Looking for RM: and FIXME... $(QUIET)$(AWK) \ '/FIXME/ { printf "%s:%s: %s\n", FILENAME, NR, $$0 } \ /^ *RM:/ { \ if ( $$0 !~ /RM: Done/ ) \ printf "%s:%s: %s\n", FILENAME, NR, $$0 \ }' $(subst $(OUTPUT_DIR)/,$(SOURCE_DIR)/,$^) $(TOUCH) $@ } \ /^ *RM:/ { \ if ( $ $(OUTPUT_DIR)/chk_fixme: $(ALL_XML_OUT) # Looking for RM: and FIXME... $(QUIET)$(AWK) \ '/FIXME/ { printf "%s:%s: %s\n", FILENAME, NR, $$0 } \ /^ *RM:/ { \ if ( $$0 !~ /RM: Done/ ) \ printf "%s:%s: %s\n", FILENAME, NR, $$0 \ }' $(subst $(OUTPUT_DIR)/,$(SOURCE_DIR)/,$^) $(TOUCH) $@ !~ /RM: Done/ ) \ printf "%s:%s: %s\n", FILENAME, NR, $ $(OUTPUT_DIR)/chk_fixme: $(ALL_XML_OUT) # Looking for RM: and FIXME... $(QUIET)$(AWK) \ '/FIXME/ { printf "%s:%s: %s\n", FILENAME, NR, $$0 } \ /^ *RM:/ { \ if ( $$0 !~ /RM: Done/ ) \ printf "%s:%s: %s\n", FILENAME, NR, $$0 \ }' $(subst $(OUTPUT_DIR)/,$(SOURCE_DIR)/,$^) $(TOUCH) $@ \ }' $(subst $(OUTPUT_DIR)/,$(SOURCE_DIR)/,$^) $(TOUCH) $@
This check is for unresolved notes to myself. Obviously, any text labeled FIXME should be fixed and the label removed. In addition, any occurrence of RM : that is not followed immediately by Done should be flagged. Notice how the format of the printf function follows the standard format for compiler errors. This way, standard tools that recognize compiler errors will properly process these warnings. $(OUTPUT_DIR)/chk_duplicate_macros: $(SOURCE_DIR)/macros.m4 # Looking for duplicate macros... $(QUIET)! $(EGREP) --only-matching \ "\[^]+'," $< \ $(SORT) \ uniq -c \ $(AWK) '$ > 1 { printf "$>:0: %s\n", $ $(OUTPUT_DIR)/chk_duplicate_macros: $(SOURCE_DIR)/macros.m4 # Looking for duplicate macros... $(QUIET)! $(EGREP) --only-matching \ "\[^]+'," $< \ $(SORT) \ uniq -c \ $(AWK) '$$1 > 1 { printf "$>:0: %s\n", $$0 }' \ $(EGREP) "^" $(TOUCH) $@ }' \ $(EGREP) "^" $(TOUCH) $@
This checks for duplicate macro definitions in the m4 macro file. The m4 processor does not consider redefinition to be an error, so I added a special check. The pipeline goes like this: grab the defined symbol in each macro, sort, count duplicates, filter out all lines with a count of one, then use e grep one last time purely for its exit status. Again, note the negation of the exit status to produce a make error only when something is found. ALL_EXAMPLES := $(TMP)/all_examples $(OUTPUT_DIR)/chk_orphaned_examples: $(ALL_EXAMPLES) $(DEPENDENCY_FILES) $(QUIET)$(AWK) -F/ '/(EXAMPLESOUTPUT)_DIR/ { print $ }' \ $(filter %.d,$^) \ $(SORT) -u \ comm -13 - $(filter-out %.d,$^) $(TOUCH) $@ .INTERMEDIATE: $(ALL_EXAMPLES) $(ALL_EXAMPLES): # Looking for unused examples... $(QUIET) ls -p $(EXAMPLES_DIR) \ $(AWK) '/CVS/ { next } \ /\// { print substr($ ALL_EXAMPLES := $(TMP)/all_examples $(OUTPUT_DIR)/chk_orphaned_examples: $(ALL_EXAMPLES) $(DEPENDENCY_FILES) $(QUIET)$(AWK) -F/ '/(EXAMPLESOUTPUT)_DIR/ { print $$3 }' \ $(filter %.d,$^) \ $(SORT) -u \ comm -13 - $(filter-out %.d,$^) $(TOUCH) $@ .INTERMEDIATE: $(ALL_EXAMPLES) $(ALL_EXAMPLES): # Looking for unused examples... $(QUIET) ls -p $(EXAMPLES_DIR) \ $(AWK) '/CVS/ { next } \ /\// { print substr($$0, 1, length - 1) }' > $@ , 1, length - 1) }' > $@
The final check looks for examples that are not referenced in the text. This target uses a funny trick. It requires two sets of input files: all the example directories, and all the XML dependency files. The prerequisites list is separated into these two sets using filter and filter-out . The list of example directories is generated by using ls -p (this appends a slash to each directory) and scanning for slashes . The pipeline first grabs the XML dependency files from the prerequisite list, outputs the example directories it finds in them, and removes any duplicates. These are the examples actually referenced in the text. This list is fed to comm 's standard input, while the list of all known example directories is fed as the second file. The -13 option indicates that comm should print only lines found in column two (that is, directories that are not referenced from a dependency file). | 