387 lines
11 KiB
Makefile
387 lines
11 KiB
Makefile
#----------------------------------------------------------------------------
|
|
#
|
|
# PostgreSQL documentation makefile
|
|
#
|
|
# $PostgreSQL: pgsql/doc/src/sgml/Makefile,v 1.122 2009/08/09 22:47:59 petere Exp $
|
|
#
|
|
#----------------------------------------------------------------------------
|
|
|
|
# This makefile is for building and installing the documentation.
|
|
# When a release tarball is created, the documentation files are
|
|
# prepared using the distprep target. In CVS-based trees these files
|
|
# don't exist, unless explicitly built, so we skip the installation in
|
|
# that case.
|
|
|
|
|
|
# Make "html" the default target, since that is what most people tend
|
|
# to want to use.
|
|
html:
|
|
|
|
subdir = doc/src/sgml
|
|
top_builddir = ../../..
|
|
include $(top_builddir)/src/Makefile.global
|
|
|
|
|
|
distprep: html man
|
|
|
|
|
|
ifndef COLLATEINDEX
|
|
COLLATEINDEX = $(DOCBOOKSTYLE)/bin/collateindex.pl
|
|
endif
|
|
|
|
ifndef JADE
|
|
JADE = jade
|
|
endif
|
|
SGMLINCLUDE = -D $(srcdir)
|
|
|
|
ifndef NSGMLS
|
|
NSGMLS = nsgmls
|
|
endif
|
|
|
|
ifndef OSX
|
|
OSX = osx
|
|
endif
|
|
|
|
ifndef XSLTPROC
|
|
XSLTPROC = xsltproc
|
|
endif
|
|
|
|
override XSLTPROCFLAGS += --stringparam pg.version '$(VERSION)'
|
|
|
|
|
|
GENERATED_SGML = bookindex.sgml version.sgml \
|
|
features-supported.sgml features-unsupported.sgml
|
|
|
|
ALLSGML := $(wildcard $(srcdir)/*.sgml $(srcdir)/ref/*.sgml) $(GENERATED_SGML)
|
|
|
|
# Sometimes we don't want this one.
|
|
ALMOSTALLSGML := $(filter-out %bookindex.sgml,$(ALLSGML))
|
|
|
|
ifdef DOCBOOKSTYLE
|
|
CATALOG = -c $(DOCBOOKSTYLE)/catalog
|
|
endif
|
|
|
|
# Enable some extra warnings
|
|
# -wfully-tagged needed to throw a warning on missing tags
|
|
# for older tool chains, 2007-08-31
|
|
# Note: try "make SPFLAGS=-wxml" to catch a lot of other dubious constructs,
|
|
# in particular < and & that haven't been made into entities. It's far too
|
|
# noisy to turn on by default, unfortunately.
|
|
override SPFLAGS += -wall -wno-unused-param -wno-empty -wfully-tagged
|
|
|
|
##
|
|
## Man pages
|
|
##
|
|
|
|
man: man-stamp
|
|
|
|
ifeq ($(vpath_build),yes)
|
|
XSLTPROC_MAN_FLAGS = --stringparam man.output.base.dir '$(srcdir)/'
|
|
endif
|
|
|
|
$(srcdir)/man-stamp: stylesheet-man.xsl postgres.xml
|
|
$(XSLTPROC) $(XSLTPROCFLAGS) $(XSLTPROC_MAN_FLAGS) $^
|
|
rm $(srcdir)/man1/dblink*
|
|
touch $@
|
|
|
|
|
|
##
|
|
## HTML
|
|
##
|
|
|
|
.PHONY: draft
|
|
|
|
JADE.html.call = $(JADE) $(JADEFLAGS) $(SPFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t sgml -i output-html
|
|
ifeq ($(vpath_build),yes)
|
|
# This only works with openjade, not with the older jade.
|
|
JADE.html.call += -V '(define %output-dir% "$(srcdir)/html")'
|
|
endif
|
|
|
|
# The draft target creates HTML output in draft mode, without index (for faster build).
|
|
draft: postgres.sgml $(ALMOSTALLSGML) stylesheet.dsl
|
|
$(mkinstalldirs) $(srcdir)/html
|
|
$(JADE.html.call) -V draft-mode $<
|
|
cp $(srcdir)/stylesheet.css $(srcdir)/html/
|
|
|
|
html: html-stamp
|
|
|
|
$(srcdir)/html-stamp: postgres.sgml $(ALLSGML) stylesheet.dsl
|
|
$(mkinstalldirs) $(srcdir)/html
|
|
$(JADE.html.call) -i include-index $<
|
|
cp $(srcdir)/stylesheet.css $(srcdir)/html/
|
|
touch $@
|
|
|
|
$(srcdir)/HTML.index: postgres.sgml $(ALMOSTALLSGML) stylesheet.dsl
|
|
@$(mkinstalldirs) $(srcdir)/html
|
|
$(JADE.html.call) -V html-index $<
|
|
|
|
$(srcdir)/bookindex.sgml: HTML.index
|
|
LC_ALL=C $(PERL) $(COLLATEINDEX) -f -g -i 'bookindex' -o $@ $<
|
|
|
|
$(srcdir)/version.sgml: $(top_builddir)/src/Makefile.global
|
|
{ \
|
|
echo "<!entity version \"$(VERSION)\">"; \
|
|
echo "<!entity majorversion \"$(MAJORVERSION)\">"; \
|
|
} >$@
|
|
|
|
$(srcdir)/features-supported.sgml: $(top_srcdir)/src/backend/catalog/sql_feature_packages.txt $(top_srcdir)/src/backend/catalog/sql_features.txt
|
|
$(PERL) $(srcdir)/mk_feature_tables.pl YES $^ > $@
|
|
|
|
$(srcdir)/features-unsupported.sgml: $(top_srcdir)/src/backend/catalog/sql_feature_packages.txt $(top_srcdir)/src/backend/catalog/sql_features.txt
|
|
$(PERL) $(srcdir)/mk_feature_tables.pl NO $^ > $@
|
|
|
|
|
|
##
|
|
## Print
|
|
##
|
|
|
|
|
|
# RTF to allow minor editing for hardcopy
|
|
%.rtf: %.sgml $(ALLSGML) html
|
|
$(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t rtf -V rtf-backend -i output-print -i include-index postgres.sgml
|
|
|
|
# TeX
|
|
# Regular TeX and pdfTeX have slightly differing requirements, so we
|
|
# need to distinguish the path we're taking.
|
|
|
|
JADE.tex.call = $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d $(srcdir)/stylesheet.dsl -t tex -V tex-backend -i output-print -i include-index
|
|
|
|
%-A4.tex-ps: %.sgml $(ALLSGML) html
|
|
$(JADE.tex.call) -V texdvi-output -V '%paper-type%'=A4 -o $@ $<
|
|
|
|
%-US.tex-ps: %.sgml $(ALLSGML) html
|
|
$(JADE.tex.call) -V texdvi-output -V '%paper-type%'=USletter -o $@ $<
|
|
|
|
%-A4.tex-pdf: %.sgml $(ALLSGML) html
|
|
$(JADE.tex.call) -V texpdf-output -V '%paper-type%'=A4 -o $@ $<
|
|
|
|
%-US.tex-pdf: %.sgml $(ALLSGML) html
|
|
$(JADE.tex.call) -V texpdf-output -V '%paper-type%'=USletter -o $@ $<
|
|
|
|
%.dvi: %.tex-ps
|
|
@rm -f $*.aux $*.log
|
|
# multiple runs are necessary to create proper intra-document links
|
|
jadetex $<
|
|
jadetex $<
|
|
jadetex $<
|
|
|
|
# PostScript from TeX
|
|
postgres.ps:
|
|
$(error Invalid target; use postgres-A4.ps or postgres-US.ps as targets)
|
|
|
|
%.ps: %.dvi
|
|
dvips -o $@ $<
|
|
|
|
postgres.pdf:
|
|
$(error Invalid target; use postgres-A4.pdf or postgres-US.pdf as targets)
|
|
|
|
%.pdf: %.tex-pdf
|
|
@rm -f $*.aux $*.log $*.out
|
|
# multiple runs are necessary to create proper intra-document links
|
|
pdfjadetex $<
|
|
pdfjadetex $<
|
|
pdfjadetex $<
|
|
|
|
.PRECIOUS: %-A4.tex-ps %-US.tex-ps %-A4.tex-pdf %-US.tex-pdf
|
|
|
|
# Cancel built-in suffix rules, interfering with PS building
|
|
.SUFFIXES:
|
|
|
|
|
|
# This generates an XML version of the flow-object tree. It's useful
|
|
# for debugging DSSSL code, and possibly to interface to some other
|
|
# tools that can make use of this.
|
|
%.fot: %.sgml $(ALLSGML) html
|
|
$(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t fot -i output-print -i include-index -o $@ $<
|
|
|
|
|
|
##
|
|
## Semi-automatic generation of some text files.
|
|
##
|
|
|
|
JADE.text = $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -i output-text -t sgml
|
|
LYNX = lynx
|
|
|
|
INSTALL HISTORY regress_README: % : %.html
|
|
$(PERL) -p -e 's/<H(1|2)$$/<H\1 align=center/g' $< | $(LYNX) -force_html -dump -nolist -stdin >$@
|
|
|
|
INSTALL.html: standalone-install.sgml installation.sgml version.sgml
|
|
$(JADE.text) -V nochunks standalone-install.sgml installation.sgml >$@
|
|
|
|
HISTORY.html: generate_history.pl $(wildcard $(srcdir)/release*.sgml)
|
|
$(PERL) $< "$(srcdir)" release.sgml >tempfile_HISTORY.sgml
|
|
$(JADE.text) -V nochunks tempfile_HISTORY.sgml >$@
|
|
rm tempfile_HISTORY.sgml
|
|
|
|
regress_README.html: regress.sgml
|
|
( echo '<!doctype chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN" ['; \
|
|
echo '<!entity % standalone-ignore "IGNORE">'; \
|
|
echo '<!entity % standalone-include "INCLUDE"> ]>'; \
|
|
cat $< ) >tempfile_regress_README.sgml
|
|
$(JADE.text) -V nochunks tempfile_regress_README.sgml >$@
|
|
rm tempfile_regress_README.sgml
|
|
|
|
|
|
##
|
|
## XSLT processing
|
|
##
|
|
|
|
# This allows removing postgres.xml in the distribution tarballs while
|
|
# keeping the dependencies satisfied.
|
|
.SECONDARY: postgres.xml
|
|
|
|
postgres.xml: postgres.sgml $(ALMOSTALLSGML)
|
|
$(OSX) -D. -x lower $< | \
|
|
$(PERL) -p -e 's/\[(amp|copy|egrave|gt|lt|mdash|nbsp|ouml|pi|quot|uuml) *\]/\&\1;/g;' \
|
|
-e '$$_ .= qq{<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\n} if $$. == 1;' \
|
|
>$@
|
|
# ' hello Emacs
|
|
|
|
ifeq ($(vpath_build),yes)
|
|
XSLTPROC_HTML_FLAGS = --stringparam base.dir '$(srcdir)/html'
|
|
endif
|
|
|
|
xslthtml: stylesheet.xsl postgres.xml
|
|
$(XSLTPROC) $(XSLTPROCFLAGS) $(XSLTPROC_HTML_FLAGS) $^
|
|
|
|
htmlhelp: stylesheet-hh.xsl postgres.xml
|
|
$(XSLTPROC) $(XSLTPROCFLAGS) $^
|
|
|
|
%-A4.fo: stylesheet-fo.xsl %.xml
|
|
$(XSLTPROC) $(XSLTPROCFLAGS) --stringparam paper.type A4 -o $@ $^
|
|
|
|
%-US.fo: stylesheet-fo.xsl %.xml
|
|
$(XSLTPROC) $(XSLTPROCFLAGS) --stringparam paper.type USletter -o $@ $^
|
|
|
|
|
|
##
|
|
## Experimental Texinfo targets
|
|
##
|
|
|
|
DB2X_TEXIXML = db2x_texixml
|
|
DB2X_XSLTPROC = db2x_xsltproc
|
|
MAKEINFO = makeinfo
|
|
|
|
%.texixml: %.xml
|
|
$(DB2X_XSLTPROC) -s texi -g output-file=$(basename $@) $< -o $@
|
|
|
|
%.texi: %.texixml
|
|
$(DB2X_TEXIXML) --encoding=iso-8859-1//TRANSLIT $< --to-stdout >$@
|
|
|
|
%.info: %.texi
|
|
$(MAKEINFO) --enable-encoding --no-split --no-validate $< -o $@
|
|
|
|
|
|
##
|
|
## Check
|
|
##
|
|
|
|
# Quick syntax check without style processing
|
|
check: postgres.sgml $(ALMOSTALLSGML)
|
|
$(NSGMLS) $(SPFLAGS) $(SGMLINCLUDE) -s $<
|
|
|
|
|
|
##
|
|
## Install
|
|
##
|
|
|
|
found_html = $(wildcard $(srcdir)/html-stamp)
|
|
|
|
ifneq ($(wildcard $(srcdir)/man-stamp),)
|
|
# SCO OpenServer's man system is sufficiently different to not bother.
|
|
ifneq ($(PORTNAME), sco)
|
|
found_man = yes
|
|
endif
|
|
endif
|
|
|
|
install: $(if $(found_html),install-html) $(if $(found_man),install-man)
|
|
|
|
installdirs:
|
|
$(mkinstalldirs) '$(DESTDIR)$(htmldir)'/html $(addprefix '$(DESTDIR)$(mandir)'/man, 1 3 $(sqlmansectnum))
|
|
|
|
uninstall:
|
|
rm -f '$(DESTDIR)$(htmldir)/html/'* $(addprefix '$(DESTDIR)$(mandir)'/man, 1/* 3/* $(sqlmansectnum)/*)
|
|
|
|
|
|
## Install html
|
|
|
|
install-html: html installdirs
|
|
cp -R $(srcdir)/html '$(DESTDIR)$(htmldir)'
|
|
|
|
|
|
## Install man
|
|
|
|
sqlmansect ?= 7
|
|
sqlmansectnum = $(shell expr X'$(sqlmansect)' : X'\([0-9]\)')
|
|
|
|
define install-man-func
|
|
for file in $(1); do \
|
|
$(INSTALL_DATA) $$file $(DESTDIR)$(mandir)/`echo $$file | sed 's,^$(2),,'` || exit; \
|
|
done
|
|
endef
|
|
|
|
# Before we install the man pages, we massage the section numbers to
|
|
# follow the local conventions.
|
|
#
|
|
ifeq ($(sqlmansectnum),7)
|
|
install-man:
|
|
$(call install-man-func,$(addprefix $(srcdir)/,man1/*.1 man3/*.3 man$(sqlmansectnum)/*.$(sqlmansect)),$(srcdir)/)
|
|
|
|
else # sqlmansectnum != 7
|
|
fix_sqlmansectnum = sed -e '/^\.TH/s/"7"/"$(sqlmansect)"/' \
|
|
-e 's/\\fR(7)/\\fR($(sqlmansectnum))/g' \
|
|
-e '1s/^\.so man7/.so man$(sqlmansectnum)/g;1s/^\(\.so.*\)\.7$$/\1.$(sqlmansect)/g'
|
|
|
|
nonsql_manpage_files := $(wildcard $(srcdir)/man1/*.1 $(srcdir)/man3/*.3)
|
|
sql_manpage_files := $(wildcard $(srcdir)/man7/*.7)
|
|
|
|
fixed_nonsql_manpage_files = $(patsubst $(srcdir)/%,fixedman/%,$(nonsql_manpage_files))
|
|
fixed_sql_manpage_files = $(patsubst $(srcdir)/man7/%.7,fixedman/man$(sqlmansectnum)/%.$(sqlmansect),$(sql_manpage_files))
|
|
|
|
fixed_manpage_files = $(fixed_nonsql_manpage_files) $(fixed_sql_manpage_files)
|
|
|
|
all: all-man
|
|
all-man: $(fixed_manpage_files)
|
|
|
|
$(fixed_nonsql_manpage_files): fixedman/%: %
|
|
@$(mkinstalldirs) $(dir $@)
|
|
$(fix_sqlmansectnum) $< >$@
|
|
|
|
$(fixed_sql_manpage_files): fixedman/man$(sqlmansectnum)/%.$(sqlmansect): man7/%.7
|
|
@$(mkinstalldirs) $(dir $@)
|
|
$(fix_sqlmansectnum) $< >$@
|
|
|
|
install-man: all-man
|
|
$(call install-man-func,$(fixed_manpage_files),fixedman/)
|
|
|
|
clean: clean-man
|
|
.PHONY: clean-man
|
|
clean-man:
|
|
rm -rf fixedman/
|
|
|
|
endif # sqlmansectnum != 7
|
|
|
|
|
|
##
|
|
## Clean
|
|
##
|
|
|
|
distclean:
|
|
rm -f postgres.xml
|
|
|
|
maintainer-clean: distclean
|
|
# HTML
|
|
rm -rf $(addprefix $(srcdir)/,html/ html-stamp)
|
|
# man
|
|
rm -rf $(addprefix $(srcdir)/,man1/ man3/ man7/ man-stamp)
|
|
# print
|
|
rm -f $(addprefix $(srcdir)/,*.rtf *.tex-ps *.tex-pdf *.dvi *.aux *.log *.ps *.pdf *.out *.fot)
|
|
# index
|
|
rm -f $(addprefix $(srcdir)/,HTML.index $(GENERATED_SGML))
|
|
# text
|
|
rm -f $(addprefix $(srcdir)/,INSTALL HISTORY regress_README)
|
|
# XSLT
|
|
rm -f $(addprefix $(srcdir)/,htmlhelp.hhp toc.hhc index.hhk *.fo)
|
|
# Texinfo
|
|
rm -f $(addprefix $(srcdir)/,*.texixml *.texi *.info db2texi.refs)
|