diff options
Diffstat (limited to 'doc/src/sgml/Makefile')
| -rw-r--r-- | doc/src/sgml/Makefile | 317 |
1 files changed, 317 insertions, 0 deletions
diff --git a/doc/src/sgml/Makefile b/doc/src/sgml/Makefile new file mode 100644 index 0000000..16fff83 --- /dev/null +++ b/doc/src/sgml/Makefile @@ -0,0 +1,317 @@ +#---------------------------------------------------------------------------- +# +# PostgreSQL documentation makefile +# +# doc/src/sgml/Makefile +# +#---------------------------------------------------------------------------- + +# 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 Git-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: + +# We don't need the tree-wide headers or install support here. +NO_GENERATED_HEADERS=yes +NO_TEMP_INSTALL=yes + +subdir = doc/src/sgml +top_builddir = ../../.. +include $(top_builddir)/src/Makefile.global + + +all: html man + +distprep: html distprep-man + + +ifndef DBTOEPUB +DBTOEPUB = $(missing) dbtoepub +endif + +ifndef FOP +FOP = $(missing) fop +endif + +XMLINCLUDE = --path . + +ifdef XMLLINT +XMLLINT := $(XMLLINT) --nonet +else +XMLLINT = $(missing) xmllint +endif + +ifdef XSLTPROC +XSLTPROC := $(XSLTPROC) --nonet +else +XSLTPROC = $(missing) xsltproc +endif + +override XSLTPROCFLAGS += --stringparam pg.version '$(VERSION)' + + +GENERATED_SGML = version.sgml \ + features-supported.sgml features-unsupported.sgml errcodes-table.sgml \ + keywords-table.sgml + +ALLSGML := $(wildcard $(srcdir)/*.sgml $(srcdir)/ref/*.sgml) $(GENERATED_SGML) + +ALL_IMAGES := $(wildcard $(srcdir)/images/*.svg) + + +## +## Man pages +## + +man distprep-man: man-stamp + +man-stamp: stylesheet-man.xsl postgres.sgml $(ALLSGML) + $(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^) + $(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(XSLTPROC_MAN_FLAGS) $(wordlist 1,2,$^) + touch $@ + + +## +## common files +## + +# Technically, this should depend on Makefile.global, but then +# version.sgml would need to be rebuilt after every configure run, +# even in distribution tarballs. So this is cheating a bit, but it +# will achieve the goal of updating the version number when it +# changes. +version.sgml: $(top_srcdir)/configure + { \ + echo "<!ENTITY version \"$(VERSION)\">"; \ + echo "<!ENTITY majorversion \"$(MAJORVERSION)\">"; \ + } > $@ + +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 $^ > $@ + +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 $^ > $@ + +errcodes-table.sgml: $(top_srcdir)/src/backend/utils/errcodes.txt generate-errcodes-table.pl + $(PERL) $(srcdir)/generate-errcodes-table.pl $< > $@ + +keywords-table.sgml: $(top_srcdir)/src/include/parser/kwlist.h $(wildcard $(srcdir)/keywords/sql*.txt) generate-keywords-table.pl + $(PERL) $(srcdir)/generate-keywords-table.pl $(srcdir) > $@ + + +## +## Generation of some text files. +## + +ICONV = iconv +PANDOC = pandoc + +INSTALL: % : %.html + $(PANDOC) -t plain -o $@.tmp $< + $(ICONV) -f utf8 -t us-ascii//TRANSLIT $@.tmp > $@ + rm $@.tmp + +INSTALL.html: %.html : stylesheet-text.xsl %.xml + $(XMLLINT) --noout --valid $*.xml + $(XSLTPROC) $(XSLTPROCFLAGS) $(XSLTPROC_HTML_FLAGS) $^ >$@ + +INSTALL.xml: standalone-profile.xsl standalone-install.xml postgres.sgml $(ALLSGML) + $(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) --xinclude $(wordlist 1,2,$^) >$@ + + +## +## HTML +## + +ifeq ($(STYLE),website) +XSLTPROC_HTML_FLAGS += --param website.stylesheet 1 +endif + +html: html-stamp + +html-stamp: stylesheet.xsl postgres.sgml $(ALLSGML) $(ALL_IMAGES) + $(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^) + $(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(XSLTPROC_HTML_FLAGS) $(wordlist 1,2,$^) + cp $(ALL_IMAGES) html/ + cp $(srcdir)/stylesheet.css html/ + touch $@ + +htmlhelp: htmlhelp-stamp + +htmlhelp-stamp: stylesheet-hh.xsl postgres.sgml $(ALLSGML) $(ALL_IMAGES) + $(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^) + $(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(wordlist 1,2,$^) + cp $(ALL_IMAGES) htmlhelp/ + cp $(srcdir)/stylesheet.css htmlhelp/ + touch $@ + +# single-page HTML +postgres.html: stylesheet-html-nochunk.xsl postgres.sgml $(ALLSGML) $(ALL_IMAGES) + $(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^) + $(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(XSLTPROC_HTML_FLAGS) -o $@ $(wordlist 1,2,$^) + +# single-page text +postgres.txt: postgres.html + $(PANDOC) -t plain -o $@ $< + + +## +## Print +## + +postgres.pdf: + $(error Invalid target; use postgres-A4.pdf or postgres-US.pdf as targets) + +XSLTPROC_FO_FLAGS += --stringparam img.src.path '$(srcdir)/' + +%-A4.fo: stylesheet-fo.xsl %.sgml $(ALLSGML) + $(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^) + $(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(XSLTPROC_FO_FLAGS) --stringparam paper.type A4 -o $@ $(wordlist 1,2,$^) + +%-US.fo: stylesheet-fo.xsl %.sgml $(ALLSGML) + $(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^) + $(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(XSLTPROC_FO_FLAGS) --stringparam paper.type USletter -o $@ $(wordlist 1,2,$^) + +%.pdf: %.fo $(ALL_IMAGES) + $(FOP) -fo $< -pdf $@ + + +## +## EPUB +## + +epub: postgres.epub +postgres.epub: postgres.sgml $(ALLSGML) $(ALL_IMAGES) + $(XMLLINT) --noout --valid $< + $(DBTOEPUB) -o $@ $< + + +## +## Experimental Texinfo targets +## + +DB2X_TEXIXML = db2x_texixml +DB2X_XSLTPROC = db2x_xsltproc +MAKEINFO = makeinfo + +%.texixml: %.sgml $(ALLSGML) + $(XMLLINT) --noout --valid $< + $(DB2X_XSLTPROC) -s texi -g output-file=$(basename $@) $< -o $@ + +%.texi: %.texixml + $(DB2X_TEXIXML) --encoding=utf-8 $< --to-stdout > $@ + +%.info: %.texi + $(MAKEINFO) --enable-encoding --no-split --no-validate $< -o $@ + + +## +## Check +## + +# Quick syntax check without style processing +check: postgres.sgml $(ALLSGML) check-tabs + $(XMLLINT) $(XMLINCLUDE) --noout --valid $< + + +## +## Install +## + +install: install-html install-man + +installdirs: + $(MKDIR_P) '$(DESTDIR)$(htmldir)'/html $(addprefix '$(DESTDIR)$(mandir)'/man, 1 3 $(sqlmansectnum)) + +# If the install used a man directory shared with other applications, this will remove all files. +uninstall: + rm -f '$(DESTDIR)$(htmldir)/html/'* $(addprefix '$(DESTDIR)$(mandir)'/man, 1/* 3/* $(sqlmansectnum)/*) + + +## Install html + +install-html: html installdirs + cp -R $(call vpathsearch,html) '$(DESTDIR)$(htmldir)' + + +## Install man + +install-man: man installdirs + +sqlmansect ?= 7 +sqlmansectnum = $(shell expr X'$(sqlmansect)' : X'\([0-9]\)') + +# Before we install the man pages, we massage the section numbers to +# follow the local conventions. +# +ifeq ($(sqlmansectnum),7) +install-man: + cp -R $(foreach dir,man1 man3 man7,$(call vpathsearch,$(dir))) '$(DESTDIR)$(mandir)' + +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' + +man: fixed-man-stamp + +fixed-man-stamp: man-stamp + @$(MKDIR_P) $(addprefix fixedman/,man1 man3 man$(sqlmansectnum)) + for file in $(call vpathsearch,man1)/*.1; do $(fix_sqlmansectnum) $$file >fixedman/man1/`basename $$file` || exit; done + for file in $(call vpathsearch,man3)/*.3; do $(fix_sqlmansectnum) $$file >fixedman/man3/`basename $$file` || exit; done + for file in $(call vpathsearch,man7)/*.7; do $(fix_sqlmansectnum) $$file >fixedman/man$(sqlmansectnum)/`basename $$file | sed s/\.7$$/.$(sqlmansect)/` || exit; done + +install-man: + cp -R $(foreach dir,man1 man3 man$(sqlmansectnum),fixedman/$(dir)) '$(DESTDIR)$(mandir)' + +clean: clean-man +.PHONY: clean-man +clean-man: + rm -rf fixedman/ fixed-man-stamp + +endif # sqlmansectnum != 7 + +# tabs are harmless, but it is best to avoid them in SGML files +check-tabs: + @( ! grep ' ' $(wildcard $(srcdir)/*.sgml $(srcdir)/ref/*.sgml $(srcdir)/*.xsl) ) || (echo "Tabs appear in SGML/XML files" 1>&2; exit 1) + +## +## Clean +## + +# This allows removing some files from the distribution tarballs while +# keeping the dependencies satisfied. +.SECONDARY: $(GENERATED_SGML) +.SECONDARY: INSTALL.html INSTALL.xml +.SECONDARY: postgres-A4.fo postgres-US.fo + +clean: +# text --- these are shipped, but not in this directory + rm -f INSTALL + rm -f INSTALL.html INSTALL.xml +# single-page output + rm -f postgres.html postgres.txt +# print + rm -f *.fo *.pdf +# generated SGML files + rm -f $(GENERATED_SGML) +# HTML Help + rm -rf htmlhelp/ htmlhelp-stamp +# EPUB + rm -f postgres.epub +# Texinfo + rm -f *.texixml *.texi *.info db2texi.refs + +distclean: clean + +maintainer-clean: distclean +# HTML + rm -fr html/ html-stamp +# man + rm -rf man1/ man3/ man7/ man-stamp |