jimzah/openafs
1
0
Fork 0
mirror of https://git.openafs.org/openafs.git synced 2025-01-19 07:20:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
1cc8feb6fc
openafs/doc/xml/QuickStartUnix/Makefile.in

60 lines
1.7 KiB
Makefile
Raw Normal View History

docbook-quickguide-makefile-20061201 Add some comments to the makefile, set up dependencies to build the index automatically, remove a bunch of unnecessary @-signs in front of commands, and add a clean target.
2006-12-02 02:22:34 +00:00
# Makefile to build the AFS QuickStart guide for Unix.
#
# This makefile assumes that various utilities are available on the system.
doc-xml-build-20090518 LICENSE MIT Standardize the UNIX Makefiles for all of the DocBook guides. Remove the rest of the generated files and switch to xsltproc and dblatex for the document generation in all cases. Fix a few DocBook errors by removing the contents of the <index> tag and removing the unknown <pubsnumber> tag in the <revision> field.
2009-05-19 05:58:53 +01:00
# On Debian lenny, installing the packages:
docbook-quickguide-makefile-20061201 Add some comments to the makefile, set up dependencies to build the index automatically, remove a bunch of unnecessary @-signs in front of commands, and add a clean target.
2006-12-02 02:22:34 +00:00
#
doc-xml-build-20090518 LICENSE MIT Standardize the UNIX Makefiles for all of the DocBook guides. Remove the rest of the generated files and switch to xsltproc and dblatex for the document generation in all cases. Fix a few DocBook errors by removing the contents of the <index> tag and removing the unknown <pubsnumber> tag in the <revision> field.
2009-05-19 05:58:53 +01:00
# dblatex
doc-quick-start-unix-build-20090518 LICENSE MIT Use dblatex to build PDF documentation instead of docbook2html and xsltproc to build HTML instead of docbook2html. Remove all the index generation logic, since dblatex and xsltproc handle that automatically. Remove the contents of the <index> tag in the source, since neither program requires there be anything in there. Remove the style sheets and configuration that were used for docbook2*.
2009-05-19 05:27:36 +01:00
# docbook-xsl
docbook-quickguide-makefile-20061201 Add some comments to the makefile, set up dependencies to build the index automatically, remove a bunch of unnecessary @-signs in front of commands, and add a clean target.
2006-12-02 02:22:34 +00:00
# libxml2-utils
doc-quick-start-unix-build-20090518 LICENSE MIT Use dblatex to build PDF documentation instead of docbook2html and xsltproc to build HTML instead of docbook2html. Remove all the index generation logic, since dblatex and xsltproc handle that automatically. Remove the contents of the <index> tag in the source, since neither program requires there be anything in there. Remove the style sheets and configuration that were used for docbook2*.
2009-05-19 05:27:36 +01:00
# xsltproc
docbook-quickguide-makefile-20061201 Add some comments to the makefile, set up dependencies to build the index automatically, remove a bunch of unnecessary @-signs in front of commands, and add a clean target.
2006-12-02 02:22:34 +00:00
#
doc-xml-build-20090518 LICENSE MIT Standardize the UNIX Makefiles for all of the DocBook guides. Remove the rest of the generated files and switch to xsltproc and dblatex for the document generation in all cases. Fix a few DocBook errors by removing the contents of the <index> tag and removing the unknown <pubsnumber> tag in the <revision> field.
2009-05-19 05:58:53 +01:00
# gave me all the utilities needed.
doc-quick-start-unix-build-20090518 LICENSE MIT Use dblatex to build PDF documentation instead of docbook2html and xsltproc to build HTML instead of docbook2html. Remove all the index generation logic, since dblatex and xsltproc handle that automatically. Remove the contents of the <index> tag in the source, since neither program requires there be anything in there. Remove the style sheets and configuration that were used for docbook2*.
2009-05-19 05:27:36 +01:00
#
doc-xml-build-20090518 LICENSE MIT Standardize the UNIX Makefiles for all of the DocBook guides. Remove the rest of the generated files and switch to xsltproc and dblatex for the document generation in all cases. Fix a few DocBook errors by removing the contents of the <index> tag and removing the unknown <pubsnumber> tag in the <revision> field.
2009-05-19 05:58:53 +01:00
# HTML_XSL is specific to Debian and will need to be modified on other
# systems until we have a better mechanism for finding the correct path.
docbook-quickguide-makefile-20061201 Add some comments to the makefile, set up dependencies to build the index automatically, remove a bunch of unnecessary @-signs in front of commands, and add a clean target.
2006-12-02 02:22:34 +00:00
doc: fix dependencies index.html might not be built if you are building anything other than the html/chunk.xsl but in general this is better than before. Change-Id: I2e1b98c8a3fce65cb702274d5e276989031e338b Reviewed-on: http://gerrit.openafs.org/4822 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2011-06-08 14:42:47 +01:00
BOOK = auqbg000
doc: epub and mobi support .epub is generated using dbtoepub which is still considered alpha software apparently and installed in a non-standard place. for now, use the docbook stylesheet location to find it. .mobi is generated using kindlegen from the .epub in order to have a real toc. there is some preprocessing with a custom stylesheet to make things "look right". see mobi-fixup.xsl.in Change-Id: Ice92e701e2f921e70c0f98683b5e9ab44a347e3b Reviewed-on: http://gerrit.openafs.org/4887 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org>
2011-06-08 15:44:21 +01:00
all: $(BOOK).pdf index.html $(BOOK).epub $(BOOK).mobi
xml-doc-building-glue-20090527 LICENSE IPL10 FIXES 124804 add configure switches for building docs. generate version files needed.
2009-05-27 21:44:24 +01:00
include @TOP_OBJDIR@/src/config/Makefile.config
doc: fix dependencies index.html might not be built if you are building anything other than the html/chunk.xsl but in general this is better than before. Change-Id: I2e1b98c8a3fce65cb702274d5e276989031e338b Reviewed-on: http://gerrit.openafs.org/4822 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2011-06-08 14:42:47 +01:00
VERSION=version
xml-doc-building-glue-20090527 LICENSE IPL10 FIXES 124804 add configure switches for building docs. generate version files needed.
2009-05-27 21:44:24 +01:00
include @TOP_OBJDIR@/src/config/Makefile.version
doc: prefer fop to generate pdf from docbook It would seem xsltproc -> fop -> pdf is the "modern" way to generate pdf from docbook now. The hard part is finding the stylesheets. This should work for fedora, sles and debian. Additionally, it brings some consistency--xsltproc for all the conversions. You can still override via configure options if you prefer something else. Change-Id: Id779e9473a6759daddc9a61be714109b27da980e Reviewed-on: http://gerrit.openafs.org/4821 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2011-06-08 14:40:17 +01:00
SRCS = $(BOOK).xml auqbg003.xml auqbg004.xml auqbg005.xml auqbg006.xml \
doc: fix dependencies index.html might not be built if you are building anything other than the html/chunk.xsl but in general this is better than before. Change-Id: I2e1b98c8a3fce65cb702274d5e276989031e338b Reviewed-on: http://gerrit.openafs.org/4822 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2011-06-08 14:42:47 +01:00
auqbg007.xml auqbg008.xml appendix.xml appendix_dafs.xml \
$(VERSION).xml
xml-doc-building-glue-20090527 LICENSE IPL10 FIXES 124804 add configure switches for building docs. generate version files needed.
2009-05-27 21:44:24 +01:00
HTML_XSL = @HTML_XSL@
doc: prefer fop to generate pdf from docbook It would seem xsltproc -> fop -> pdf is the "modern" way to generate pdf from docbook now. The hard part is finding the stylesheets. This should work for fedora, sles and debian. Additionally, it brings some consistency--xsltproc for all the conversions. You can still override via configure options if you prefer something else. Change-Id: Id779e9473a6759daddc9a61be714109b27da980e Reviewed-on: http://gerrit.openafs.org/4821 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2011-06-08 14:40:17 +01:00
DOCBOOK_STYLESHEETS = @DOCBOOK_STYLESHEETS@
xml-doc-building-glue-20090527 LICENSE IPL10 FIXES 124804 add configure switches for building docs. generate version files needed.
2009-05-27 21:44:24 +01:00
XSLTPROC = @XSLTPROC@
doc: let configure find the XML tools if possible configure should attempt to find the XML tools we need to process the documentation. if it can't, it should provide a safe default. still allow the user to override via command line. Change-Id: Ifaf3a5b090e93858c3d3c88363760c508030db90 Change-Id: Ib9558c37b04a4533e91b172a2a62039e4ed06d6f Reviewed-on: http://gerrit.openafs.org/4766 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Simon Wilkinson <sxw@inf.ed.ac.uk> Reviewed-by: Derrick Brashear <shadow@dementia.org>
2011-06-03 00:00:47 +01:00
DOCBOOK2PDF = @DOCBOOK2PDF@
doc: epub and mobi support .epub is generated using dbtoepub which is still considered alpha software apparently and installed in a non-standard place. for now, use the docbook stylesheet location to find it. .mobi is generated using kindlegen from the .epub in order to have a real toc. there is some preprocessing with a custom stylesheet to make things "look right". see mobi-fixup.xsl.in Change-Id: Ice92e701e2f921e70c0f98683b5e9ab44a347e3b Reviewed-on: http://gerrit.openafs.org/4887 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org>
2011-06-08 15:44:21 +01:00
DBTOEPUB = $(DOCBOOK_STYLESHEETS)/epub/bin/dbtoepub
xml-docbook-documentation-first-pass-20060915 needs more massaging to make it fit the tree, but, get it here first
2006-09-16 02:13:22 +01:00
doc: fix dependencies index.html might not be built if you are building anything other than the html/chunk.xsl but in general this is better than before. Change-Id: I2e1b98c8a3fce65cb702274d5e276989031e338b Reviewed-on: http://gerrit.openafs.org/4822 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2011-06-08 14:42:47 +01:00
index.html: $(SRCS)
xml-doc-building-glue-20090527 LICENSE IPL10 FIXES 124804 add configure switches for building docs. generate version files needed.
2009-05-27 21:44:24 +01:00
$(XSLTPROC) --param navig.graphics 1 \
doc: prefer fop to generate pdf from docbook It would seem xsltproc -> fop -> pdf is the "modern" way to generate pdf from docbook now. The hard part is finding the stylesheets. This should work for fedora, sles and debian. Additionally, it brings some consistency--xsltproc for all the conversions. You can still override via configure options if you prefer something else. Change-Id: Id779e9473a6759daddc9a61be714109b27da980e Reviewed-on: http://gerrit.openafs.org/4821 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2011-06-08 14:40:17 +01:00
--stringparam navig.graphics.path ../ $(DOCBOOK_STYLESHEETS)/$(HTML_XSL) $(BOOK).xml
xml-docbook-documentation-first-pass-20060915 needs more massaging to make it fit the tree, but, get it here first
2006-09-16 02:13:22 +01:00
doc: fix dependencies index.html might not be built if you are building anything other than the html/chunk.xsl but in general this is better than before. Change-Id: I2e1b98c8a3fce65cb702274d5e276989031e338b Reviewed-on: http://gerrit.openafs.org/4822 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2011-06-08 14:42:47 +01:00
$(BOOK).pdf: $(SRCS)
doc: prefer fop to generate pdf from docbook It would seem xsltproc -> fop -> pdf is the "modern" way to generate pdf from docbook now. The hard part is finding the stylesheets. This should work for fedora, sles and debian. Additionally, it brings some consistency--xsltproc for all the conversions. You can still override via configure options if you prefer something else. Change-Id: Id779e9473a6759daddc9a61be714109b27da980e Reviewed-on: http://gerrit.openafs.org/4821 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2011-06-08 14:40:17 +01:00
if test "x$(DOCBOOK2PDF)" = "xfop"; then \
$(XSLTPROC) $(DOCBOOK_STYLESHEETS)/fo/docbook.xsl $(BOOK).xml > $(BOOK).fo; \
$(DOCBOOK2PDF) $(BOOK).fo $(BOOK).pdf; \
else \
$(DOCBOOK2PDF) $(BOOK).xml; \
fi
xml-docbook-documentation-first-pass-20060915 needs more massaging to make it fit the tree, but, get it here first
2006-09-16 02:13:22 +01:00
doc: epub and mobi support .epub is generated using dbtoepub which is still considered alpha software apparently and installed in a non-standard place. for now, use the docbook stylesheet location to find it. .mobi is generated using kindlegen from the .epub in order to have a real toc. there is some preprocessing with a custom stylesheet to make things "look right". see mobi-fixup.xsl.in Change-Id: Ice92e701e2f921e70c0f98683b5e9ab44a347e3b Reviewed-on: http://gerrit.openafs.org/4887 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org>
2011-06-08 15:44:21 +01:00
$(BOOK).epub: $(SRCS)
if test -x "$(DBTOEPUB)" ; then \
$(DBTOEPUB) -s $(TOP_SRCDIR)/../doc/xml/mobi-fixup.xsl $(BOOK).xml; \
fi
$(BOOK).mobi: $(BOOK).epub
Don't fail to build documentation if kindlegen doesn't exist Check for kindlegen in configure and do nothing in the MOBI build rule if the binary didn't exist. This is still a bit of a hack since the rule will run with every invocation of make. The target needs to be made conditional. But at least this way make all in the documentation directory doesn't fail. Change-Id: I57f158929b3907678b9848a60edb9765136f7dbb Reviewed-on: http://gerrit.openafs.org/5090 Reviewed-by: Derrick Brashear <shadow@dementix.org> Tested-by: Derrick Brashear <shadow@dementix.org>
2011-07-25 00:20:05 +01:00
if test -n "$(KINDLEGEN)" && test -x "$(DBTOEPUB)" ; then \
kindlegen $(BOOK).epub -o $(BOOK).mobi; \
fi
doc: epub and mobi support .epub is generated using dbtoepub which is still considered alpha software apparently and installed in a non-standard place. for now, use the docbook stylesheet location to find it. .mobi is generated using kindlegen from the .epub in order to have a real toc. there is some preprocessing with a custom stylesheet to make things "look right". see mobi-fixup.xsl.in Change-Id: Ice92e701e2f921e70c0f98683b5e9ab44a347e3b Reviewed-on: http://gerrit.openafs.org/4887 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org>
2011-06-08 15:44:21 +01:00
xml-docbook-documentation-first-pass-20060915 needs more massaging to make it fit the tree, but, get it here first
2006-09-16 02:13:22 +01:00
check:
doc: prefer fop to generate pdf from docbook It would seem xsltproc -> fop -> pdf is the "modern" way to generate pdf from docbook now. The hard part is finding the stylesheets. This should work for fedora, sles and debian. Additionally, it brings some consistency--xsltproc for all the conversions. You can still override via configure options if you prefer something else. Change-Id: Id779e9473a6759daddc9a61be714109b27da980e Reviewed-on: http://gerrit.openafs.org/4821 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2011-06-08 14:40:17 +01:00
xmllint --noout --valid $(BOOK).xml
docbook-quickguide-makefile-20061201 Add some comments to the makefile, set up dependencies to build the index automatically, remove a bunch of unnecessary @-signs in front of commands, and add a clean target.
2006-12-02 02:22:34 +00:00
clean:
Clean and ignore additional build files for DocBook documentation Depending on what generation method is used for the DocBook documentation, additional build files may be created. One of those (*.aux) will cause the build to break if one switches from docbook2pdf to dblatex without deleting it. Update make clean and .gitignore to remove and ignore these additional files. Change-Id: I13cc8a3526bd7bc7c4c65cd7d2cd78b094398faa Reviewed-on: http://gerrit.openafs.org/5089 Tested-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Derrick Brashear <shadow@dementia.org>
2011-07-25 00:00:35 +01:00
rm -f *.aux *.epub *.fo *.html *.log *.mobi *.out *.pdf
Reference in New Issue Copy Permalink