diff options
Diffstat (limited to 'doc/src/sgml')
| -rw-r--r-- | doc/src/sgml/.gitignore | 4 | ||||
| -rw-r--r-- | doc/src/sgml/Makefile | 33 | ||||
| -rw-r--r-- | doc/src/sgml/docguide.sgml | 21 | ||||
| -rw-r--r-- | doc/src/sgml/generate_history.pl | 65 | ||||
| -rw-r--r-- | doc/src/sgml/release.sgml | 5 | ||||
| -rw-r--r-- | doc/src/sgml/standalone-install.sgml | 16 |
6 files changed, 19 insertions, 125 deletions
diff --git a/doc/src/sgml/.gitignore b/doc/src/sgml/.gitignore index e1b84b490fe..2f0329c15f9 100644 --- a/doc/src/sgml/.gitignore +++ b/doc/src/sgml/.gitignore @@ -6,9 +6,7 @@ /man7/ /man-stamp # Other popular build targets -/HISTORY /INSTALL -/regress_README /postgres-US.pdf /postgres-A4.pdf /postgres.html @@ -22,9 +20,7 @@ /HTML.index # Assorted byproducts from building the above /postgres.xml -/HISTORY.html /INSTALL.html -/regress_README.html /postgres-US.aux /postgres-US.log /postgres-US.out diff --git a/doc/src/sgml/Makefile b/doc/src/sgml/Makefile index a6a6ef39622..304b3627e0b 100644 --- a/doc/src/sgml/Makefile +++ b/doc/src/sgml/Makefile @@ -215,33 +215,20 @@ JADE.text = $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -i ICONV = iconv LYNX = lynx -# The release notes may contain non-ASCII characters (for contributor -# names), which lynx converts to the encoding determined by the -# current locale. The get output that is deterministic and easily -# readable by everyone, we make lynx produce LATIN1 and then convert -# that to ASCII with transliteration for the non-ASCII characters. -# Official releases are currently built on FreeBSD, which has limited +# The documentation may contain non-ASCII characters (mostly for +# contributor names), which lynx converts to the encoding determined +# by the current locale. To get text output that is deterministic and +# easily readable by everyone, we make lynx produce LATIN1 and then +# convert that to ASCII with transliteration for the non-ASCII characters. +# Official releases were historically built on FreeBSD, which has limited # locale support and is very picky about locale name spelling. The # below has been finely tuned to run on FreeBSD and Linux/glibc. -INSTALL HISTORY regress_README: % : %.html +INSTALL: % : %.html $(PERL) -p -e 's/<H(1|2)$$/<H\1 align=center/g' $< | LC_ALL=en_US.ISO8859-1 $(LYNX) -force_html -dump -nolist -stdin | $(ICONV) -f latin1 -t us-ascii//TRANSLIT > $@ 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 @@ -393,13 +380,13 @@ check-tabs: # This allows removing some files from the distribution tarballs while # keeping the dependencies satisfied. .SECONDARY: postgres.xml $(GENERATED_SGML) HTML.index -.SECONDARY: INSTALL.html HISTORY.html regress_README.html +.SECONDARY: INSTALL.html .SECONDARY: %-A4.tex-ps %-US.tex-ps %-A4.tex-pdf %-US.tex-pdf clean: # text --- these are shipped, but not in this directory - rm -f INSTALL HISTORY regress_README - rm -f INSTALL.html HISTORY.html regress_README.html + rm -f INSTALL + rm -f INSTALL.html # single-page output rm -f postgres.html postgres.txt # print diff --git a/doc/src/sgml/docguide.sgml b/doc/src/sgml/docguide.sgml index c9c9862564f..3cc1d60c498 100644 --- a/doc/src/sgml/docguide.sgml +++ b/doc/src/sgml/docguide.sgml @@ -942,26 +942,19 @@ save_size.pdfjadetex = 15000 <title>Plain Text Files</title> <para> - Several files are distributed as plain text, for reading during - the installation process. The <filename>INSTALL</filename> file + The installation instructions are also distributed as plain text, + in case they are needed in a situation where better reading tools + are not available. The <filename>INSTALL</filename> file corresponds to <xref linkend="installation">, with some minor changes to account for the different context. To recreate the file, change to the directory <filename>doc/src/sgml</filename> - and enter <userinput>gmake INSTALL</userinput>. This will create - a file <filename>INSTALL.html</filename> that can be saved as text - with <productname>Netscape Navigator</productname> and put into - the place of the existing file. - <productname>Netscape</productname> seems to offer the best - quality for <acronym>HTML</acronym> to text conversions (over - <application>lynx</application> and - <application>w3m</application>). + and enter <userinput>gmake INSTALL</userinput>. </para> <para> - The file <filename>HISTORY</filename> can be created similarly, - using the command <userinput>gmake HISTORY</userinput>. For the - file <filename>src/test/regress/README</filename> the command is - <userinput>gmake regress_README</userinput>. + In the past, the release notes and regression testing instructions + were also distributed as plain text, but this practice has been + discontinued. </para> </sect2> diff --git a/doc/src/sgml/generate_history.pl b/doc/src/sgml/generate_history.pl deleted file mode 100644 index 1d90c676c73..00000000000 --- a/doc/src/sgml/generate_history.pl +++ /dev/null @@ -1,65 +0,0 @@ -#! /usr/bin/perl -w - -# generate_history.pl -- flatten release notes for use as HISTORY file -# -# Usage: generate_history.pl srcdir release.sgml >output.sgml -# -# The main point of this script is to strip out <link> references, which -# generally point into the rest of the documentation and so can't be used -# in a standalone build of the release notes. To make sure this is done -# everywhere, we have to fold in the sub-files of the release notes. -# -# doc/src/sgml/generate_history.pl - -use strict; - -my $srcdir = shift; -die "$0: missing required argument: srcdir\n" if !defined($srcdir); -my $infile = shift; -die "$0: missing required argument: inputfile\n" if !defined($infile); - -# Emit DOCTYPE header so that the output is a self-contained SGML document -print "<!DOCTYPE appendix PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\">\n"; - -process_file($infile); - -exit 0; - -sub process_file -{ - my $filename = shift; - - local *FILE; # need a local filehandle so we can recurse - - my $f = $srcdir . '/' . $filename; - open(FILE, $f) || die "could not read $f: $!\n"; - - while (<FILE>) - { - - # Recursively expand sub-files of the release notes - if (m/^&(release-.*);$/) - { - process_file($1 . ".sgml"); - next; - } - - # Remove <link ...> tags, which might span multiple lines - while (m/<link/) - { - if (s/<link\s+linkend[^>]*>//) - { - next; - } - - # incomplete tag, so slurp another line - $_ .= <FILE>; - } - - # Remove </link> too - s|</link>||g; - - print; - } - close(FILE); -} diff --git a/doc/src/sgml/release.sgml b/doc/src/sgml/release.sgml index 0980c6eb5f6..8cfd57d9f19 100644 --- a/doc/src/sgml/release.sgml +++ b/doc/src/sgml/release.sgml @@ -34,9 +34,7 @@ non-ASCII characters find using grep -P '[\x80-\xFF]' wrap long lines -For new features, add links to the documentation sections. Use </link> -not just </> so that generate_history.pl can remove it, so HISTORY.html -can be created without links to the main documentation. Don't use <xref>. +For new features, add links to the documentation sections. --> @@ -71,7 +69,6 @@ can be created without links to the main documentation. Don't use <xref>. <!-- To add a new major-release series, add an entry here and in filelist.sgml. - Follow the naming convention, or you'll confuse generate_history.pl. The reason for splitting the release notes this way is so that appropriate subsets can easily be copied into back branches. diff --git a/doc/src/sgml/standalone-install.sgml b/doc/src/sgml/standalone-install.sgml index c94b397a9d8..1942f9dc4c9 100644 --- a/doc/src/sgml/standalone-install.sgml +++ b/doc/src/sgml/standalone-install.sgml @@ -2,21 +2,7 @@ <!-- This file helps in generating the INSTALL text file that lives in the -top level directory of the distribution. The exact process is like -this: - -1. Paste together with installation.sgml - -2. Process with jade to HTML (use -V nochunks) - -3. Remove "Chapter 1" heading - -4. Save as text file in Netscape - -5. Put in place of old INSTALL file - -Running 'make INSTALL' in the doc/src/sgml directory will do 1 through -3 for you. +top level directory of the distribution. --> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ |