Skip to content

Commit c29d7f0

Browse files
peterepetere
committed
Use DocBook XSL stylesheets for man page building
This switches the man page building process to use the DocBook XSL stylesheet toolchain. The previous targets for Docbook2X are removed. configure has been updated to look for the new tools. The Documentation appendix contains the new build instructions. There are also a few isolated tweaks in the documentation to improve places that came out strangely in the man pages.
1 parent b173211 commit c29d7f0

File tree

10 files changed

+264
-183
lines changed

10 files changed

+264
-183
lines changed

‎config/docbook.m4‎

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# $PostgreSQL: pgsql/config/docbook.m4,v 1.10 2008/11/26 11:26:54 petere Exp $
1+
# $PostgreSQL: pgsql/config/docbook.m4,v 1.11 2009/08/04 22:04:37 petere Exp $
22

33
# PGAC_PROG_JADE
44
# --------------
@@ -97,32 +97,3 @@ if test -n "$DOCBOOKSTYLE"; then
9797
else
9898
AC_PATH_PROGS(COLLATEINDEX, collateindex.pl)
9999
fi])# PGAC_PATH_COLLATEINDEX
100-
101-
102-
# PGAC_PATH_DOCBOOK2MAN
103-
# ---------------------
104-
# Find docbook2man program from the docbook2X package. Upstream calls
105-
# this program docbook2man, but there is also a different docbook2man
106-
# out there from the docbook-utils package. Thus, the program we want
107-
# is called docbook2x-man on Debian and db2x_docbook2man on Fedora.
108-
#
109-
# (Consider rewriting this macro using AC_PATH_PROGS_FEATURE_CHECK
110-
# when switching to Autoconf 2.62+.)
111-
AC_DEFUN([PGAC_PATH_DOCBOOK2MAN],
112-
[AC_CACHE_CHECK([for docbook2man], [ac_cv_path_DOCBOOK2MAN],
113-
[if test -z "$DOCBOOK2MAN"; then
114-
_AS_PATH_WALK([],
115-
[for ac_prog in docbook2x-man db2x_docbook2man docbook2man; do
116-
ac_path="$as_dir/$ac_prog"
117-
AS_EXECUTABLE_P(["$ac_path"]) || continue
118-
if "$ac_path" --version 2>/dev/null | $GREP docbook2x >/dev/null 2>&1; then
119-
ac_cv_path_DOCBOOK2MAN=$ac_path
120-
break
121-
fi
122-
done])
123-
else
124-
ac_cv_path_DOCBOOK2MAN=$DOCBOOK2MAN
125-
fi])
126-
DOCBOOK2MAN=$ac_cv_path_DOCBOOK2MAN
127-
AC_SUBST(DOCBOOK2MAN)
128-
])# PGAC_PATH_DOCBOOK2MAN

‎configure‎

Lines changed: 41 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -642,8 +642,8 @@ ac_includes_default="\
642642

643643
ac_subst_vars='LTLIBOBJS
644644
vpath_build
645-
DOCBOOK2MAN
646-
SGMLSPL
645+
OSX
646+
XSLTPROC
647647
COLLATEINDEX
648648
DOCBOOKSTYLE
649649
have_docbook
@@ -28028,17 +28028,17 @@ fi
2802828028
done
2802928029

2803028030
fi
28031-
for ac_prog in sgmlspl
28031+
for ac_prog in xsltproc
2803228032
do
2803328033
# Extract the first word of "$ac_prog", so it can be a program name with args.
2803428034
set dummy $ac_prog; ac_word=$2
2803528035
{ $as_echo "$as_me:$LINENO: checking for $ac_word" >&5
2803628036
$as_echo_n "checking for $ac_word... " >&6; }
28037-
if test "${ac_cv_prog_SGMLSPL+set}" = set; then
28037+
if test "${ac_cv_prog_XSLTPROC+set}" = set; then
2803828038
$as_echo_n "(cached) " >&6
2803928039
else
28040-
if test -n "$SGMLSPL"; then
28041-
ac_cv_prog_SGMLSPL="$SGMLSPL" # Let the user override the test.
28040+
if test -n "$XSLTPROC"; then
28041+
ac_cv_prog_XSLTPROC="$XSLTPROC" # Let the user override the test.
2804228042
else
2804328043
as_save_IFS=$IFS; IFS=$PATH_SEPARATOR
2804428044
for as_dir in $PATH
@@ -28047,7 +28047,7 @@ do
2804728047
test -z "$as_dir" && as_dir=.
2804828048
for ac_exec_ext in '' $ac_executable_extensions; do
2804928049
if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then
28050-
ac_cv_prog_SGMLSPL="$ac_prog"
28050+
ac_cv_prog_XSLTPROC="$ac_prog"
2805128051
$as_echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5
2805228052
break 2
2805328053
fi
@@ -28057,49 +28057,60 @@ IFS=$as_save_IFS
2805728057

2805828058
fi
2805928059
fi
28060-
SGMLSPL=$ac_cv_prog_SGMLSPL
28061-
if test -n "$SGMLSPL"; then
28062-
{ $as_echo "$as_me:$LINENO: result: $SGMLSPL" >&5
28063-
$as_echo "$SGMLSPL" >&6; }
28060+
XSLTPROC=$ac_cv_prog_XSLTPROC
28061+
if test -n "$XSLTPROC"; then
28062+
{ $as_echo "$as_me:$LINENO: result: $XSLTPROC" >&5
28063+
$as_echo "$XSLTPROC" >&6; }
2806428064
else
2806528065
{ $as_echo "$as_me:$LINENO: result: no" >&5
2806628066
$as_echo "no" >&6; }
2806728067
fi
2806828068

2806928069

28070-
test -n "$SGMLSPL" && break
28070+
test -n "$XSLTPROC" && break
2807128071
done
2807228072

28073-
{ $as_echo "$as_me:$LINENO: checking for docbook2man" >&5
28074-
$as_echo_n "checking for docbook2man... " >&6; }
28075-
if test "${ac_cv_path_DOCBOOK2MAN+set}" = set; then
28073+
for ac_prog in osx sgml2xml sx
28074+
do
28075+
# Extract the first word of "$ac_prog", so it can be a program name with args.
28076+
set dummy $ac_prog; ac_word=$2
28077+
{ $as_echo "$as_me:$LINENO: checking for $ac_word" >&5
28078+
$as_echo_n "checking for $ac_word... " >&6; }
28079+
if test "${ac_cv_prog_OSX+set}" = set; then
2807628080
$as_echo_n "(cached) " >&6
2807728081
else
28078-
if test -z "$DOCBOOK2MAN"; then
28079-
as_save_IFS=$IFS; IFS=$PATH_SEPARATOR
28082+
if test -n "$OSX"; then
28083+
ac_cv_prog_OSX="$OSX" # Let the user override the test.
28084+
else
28085+
as_save_IFS=$IFS; IFS=$PATH_SEPARATOR
2808028086
for as_dir in $PATH
2808128087
do
2808228088
IFS=$as_save_IFS
2808328089
test -z "$as_dir" && as_dir=.
28084-
for ac_prog in docbook2x-man db2x_docbook2man docbook2man; do
28085-
ac_path="$as_dir/$ac_prog"
28086-
{ test -f "$ac_path" && $as_test_x "$ac_path"; } || continue
28087-
if "$ac_path" --version 2>/dev/null | $GREP docbook2x >/dev/null 2>&1; then
28088-
ac_cv_path_DOCBOOK2MAN=$ac_path
28089-
break
28090-
fi
28091-
done
28090+
for ac_exec_ext in '' $ac_executable_extensions; do
28091+
if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then
28092+
ac_cv_prog_OSX="$ac_prog"
28093+
$as_echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5
28094+
break 2
28095+
fi
28096+
done
2809228097
done
2809328098
IFS=$as_save_IFS
2809428099

28095-
else
28096-
ac_cv_path_DOCBOOK2MAN=$DOCBOOK2MAN
2809728100
fi
2809828101
fi
28099-
{ $as_echo "$as_me:$LINENO: result: $ac_cv_path_DOCBOOK2MAN" >&5
28100-
$as_echo "$ac_cv_path_DOCBOOK2MAN" >&6; }
28101-
DOCBOOK2MAN=$ac_cv_path_DOCBOOK2MAN
28102+
OSX=$ac_cv_prog_OSX
28103+
if test -n "$OSX"; then
28104+
{ $as_echo "$as_me:$LINENO: result: $OSX" >&5
28105+
$as_echo "$OSX" >&6; }
28106+
else
28107+
{ $as_echo "$as_me:$LINENO: result: no" >&5
28108+
$as_echo "no" >&6; }
28109+
fi
28110+
2810228111

28112+
test -n "$OSX" && break
28113+
done
2810328114

2810428115

2810528116
# Thread testing

‎configure.in‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
dnl Process this file with autoconf to produce a configure script.
2-
dnl $PostgreSQL: pgsql/configure.in,v 1.607 2009/07/24 15:03:07 tgl Exp $
2+
dnl $PostgreSQL: pgsql/configure.in,v 1.608 2009/08/04 22:04:36 petere Exp $
33
dnl
44
dnl Developers, please strive to achieve this order:
55
dnl
@@ -1731,8 +1731,8 @@ PGAC_PROG_JADE
17311731
PGAC_CHECK_DOCBOOK(4.2)
17321732
PGAC_PATH_DOCBOOK_STYLESHEETS
17331733
PGAC_PATH_COLLATEINDEX
1734-
AC_CHECK_PROGS(SGMLSPL, sgmlspl)
1735-
PGAC_PATH_DOCBOOK2MAN
1734+
AC_CHECK_PROGS(XSLTPROC, xsltproc)
1735+
AC_CHECK_PROGS(OSX, [osx sgml2xml sx])
17361736

17371737
# Thread testing
17381738

‎doc/src/sgml/Makefile‎

Lines changed: 15 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33
# PostgreSQL documentation makefile
44
#
5-
# $PostgreSQL: pgsql/doc/src/sgml/Makefile,v 1.119 2009/07/20 18:34:58 petere Exp $
5+
# $PostgreSQL: pgsql/doc/src/sgml/Makefile,v 1.120 2009/08/04 22:04:37 petere Exp $
66
#
77
#----------------------------------------------------------------------------
88

@@ -33,17 +33,15 @@ ifndef NSGMLS
3333
NSGMLS = nsgmls
3434
endif
3535

36-
ifndef SGMLSPL
37-
SGMLSPL = sgmlspl
36+
ifndef OSX
37+
OSX = osx
3838
endif
3939

40-
ifndef DOCBOOK2MAN
41-
DOCBOOK2MAN = docbook2man_is_missing
40+
ifndef XSLTPROC
41+
XSLTPROC = xsltproc
4242
endif
4343

44-
# docbook2man generates man pages from docbook refentry source code.
45-
D2MSCRIPT= $(D2MDIR)/docbook2man-spec.pl
46-
D2MLINKS = $(D2MDIR)/docbook2man-spec_makelinks
44+
override XSLTPROCFLAGS += --stringparam pg.version '$(VERSION)'
4745

4846

4947
GENERATED_SGML = bookindex.sgml version.sgml \
@@ -70,25 +68,14 @@ override SPFLAGS += -wall -wno-unused-param -wno-empty -wfully-tagged
7068
## Man pages
7169
##
7270

73-
.PHONY: html man draft clean
71+
.PHONY: man
7472

75-
DEFAULTSECTION = l
73+
man: man-stamp
7674

77-
fix_man_xrefs = $(PERL) -npi -e 's{\[XRef to GUC-([A-Z0-9-]*)\]}{($$l = $$1) =~ tr/A-Z-/a-z_/, $$l}ge || s{\[XRef to [A-Z0-9-]*\]}{in the documentation}g'
78-
lowercase = tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz'
79-
80-
man: postgres.sgml $(ALLSGML)
81-
$(NSGMLS) $(NSGMLS_FLAGS) $(SGMLINCLUDE) $< | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`"
82-
# One more time, to resolve cross-references
83-
$(NSGMLS) $(NSGMLS_FLAGS) $(SGMLINCLUDE) $< | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`"
84-
$(fix_man_xrefs) *.1 *.7
85-
$(mkinstalldirs) man1 man7
86-
$(D2MLINKS) < manpage.links
87-
mv *.1 man1/
88-
mv *.7 man7/
89-
rm *.$(DEFAULTSECTION)
90-
# manpage.links doesn't handle lowercase, needs fixups
91-
cd man7 && for file in `awk '{ print $$2 }' ../manpage.links`; do $(lowercase) <$$file >`echo $$file | $(lowercase)` && rm $$file || exit; done
75+
man-stamp: stylesheet-man.xsl postgres.xml
76+
$(XSLTPROC) $(XSLTPROCFLAGS) $^
77+
rm man1/SPI* man1/dblink*
78+
touch $@
9279

9380

9481
##
@@ -97,6 +84,8 @@ man: postgres.sgml $(ALLSGML)
9784

9885
all: html
9986

87+
.PHONY: html draft
88+
10089
JADE.html.call = $(JADE) $(JADEFLAGS) $(SPFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t sgml -i output-html
10190

10291
# The draft target creates HTML output in draft mode, without index (for faster build).
@@ -222,18 +211,13 @@ regress_README.html: regress.sgml
222211
## XSLT processing
223212
##
224213

225-
OSX = osx # (may be called sx or sgml2xml on some systems)
226-
XSLTPROC = xsltproc
227-
228214
postgres.xml: postgres.sgml $(ALMOSTALLSGML)
229215
$(OSX) -D. -x lower $< | \
230216
$(PERL) -p -e 's/\[(amp|copy|egrave|gt|lt|mdash|nbsp|ouml|pi|quot|uuml) *\]/\&\1;/g;' \
231217
-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;' \
232218
>$@
233219
# ' hello Emacs
234220

235-
override XSLTPROCFLAGS += --stringparam pg.version '$(VERSION)'
236-
237221
xslthtml: stylesheet.xsl postgres.xml
238222
$(XSLTPROC) $(XSLTPROCFLAGS) $^
239223

@@ -268,18 +252,6 @@ MAKEINFO = makeinfo
268252
.SUFFIXES:
269253

270254

271-
##
272-
## Experimental man page building through docbook2x
273-
##
274-
275-
manx: postgres.xml stylesheet-man.xsl
276-
$(DOCBOOK2MAN) --solinks -s $(srcdir)/stylesheet-man.xsl --string-param default-manpage-section=$(DEFAULTSECTION) $<
277-
$(mkinstalldirs) man1 man7
278-
mv *.1 man1/
279-
mv *.7 man7/
280-
rm *.$(DEFAULTSECTION)
281-
282-
283255
##
284256
## Check
285257
##
@@ -297,7 +269,7 @@ clean distclean maintainer-clean:
297269
# HTML
298270
rm -f *.html html-stamp
299271
# man
300-
rm -rf *.1 *.7 *.$(DEFAULTSECTION) man1 man7 manpage.refs manpage.links manpage.log
272+
rm -rf man1 man7 man-stamp
301273
# print
302274
rm -f *.rtf *.tex-ps *.tex-pdf *.dvi *.aux *.log *.ps *.pdf *.out *.fot
303275
# index

0 commit comments

Comments
 (0)