Clean up checks.
[ardour.git] / manual / Makefile
index 4fa647f44ae8dd01a539d527e5b985aec50433de..19085e10198c5ff62d46a31e0936ba9f429ccf42 100644 (file)
@@ -9,6 +9,25 @@ CSSFILE         ?= $(DOCNAME).css
 XSLTPROC ?= xsltproc
 #PWD             = $(shell pwd)
 
+help::
+       @echo " WARNING: The Ardour Scons build script must be run before "
+       @echo " building the manual. "
+       @echo
+       @echo " The Following is a list of supported build targets:"
+       @echo
+       @echo " html:"
+       @echo "     Build HTML version of ardour manual."
+       @echo
+       @echo " test:"
+       @echo "     Validate DocBook XML source."
+       @echo
+       @echo " format:"
+       @echo "     Format DocBook XML source using xmlformat."
+       @echo
+       @echo " clean:"
+       @echo "     Remove temporary files."
+       @echo
+
 # xsltproc -output option gives I/O errors because??, so 
 # just move the html to the output directory
 html:: clean
@@ -26,12 +45,23 @@ html:: clean
 .PHONY : html
 
 test::
+       # validating book
        xmllint --noout --postvalid --xinclude $(XMLFILE)
 
 .PHONY : test
 
+format:: test
+       @for file in `find xml/ -name '*.xml' -type f`; \
+               do xmlformat/xmlformat.pl --in-place --backup .bak \
+               --config-file xmlformat/xmlformat-ardour.conf $$file; \
+               done
+
+.PHONY : format
+
 clean::
        @rm -rf $(OUTDIR)
+       @for file in `find xml/ -name '*.bak' -type f`; do \
+               rm $$file; done
 
 .PHONY : clean