PostgreSQL. That file also lists supported operating systems and
hardware platforms and contains information regarding any other
software packages that are required to build or run the PostgreSQL
-system. Changes between all PostgreSQL releases are recorded in the
-file HISTORY. Copyright and license information can be found in the
+system. Copyright and license information can be found in the
file COPYRIGHT. A comprehensive documentation set is included in this
distribution; it can be read as described in the installation
instructions.
(This file does not appear in release tarballs.)
-In a release or snapshot tarball of PostgreSQL, documentation files named
-INSTALL and HISTORY will appear in this directory. However, these files are
-not stored in git and so will not be present if you are using a git checkout.
-If you are using git, you can view the most recent install instructions at:
+In a release or snapshot tarball of PostgreSQL, a documentation file named
+INSTALL will appear in this directory. However, this file is not stored in
+git and so will not be present if you are using a git checkout.
+
+If you are using a git checkout, you can view the most recent installation
+instructions at:
http://www.postgresql.org/docs/devel/static/installation.html
-and the current release notes at:
- http://www.postgresql.org/docs/devel/static/release.html
Users compiling from git will also need compatible versions of Bison, Flex,
and Perl, as discussed in the install documentation. These programs are not
ICONV = iconv
LYNX = lynx
-# The release notes may contain non-ASCII characters (for contribut or
-# 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 current ly built on FreeBSD, which has limited
+# The documentation may contain non-ASCII characters (mostly f or
+# 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 historical ly 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/ $@
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 '
- echo ''; \
- echo ' ]>'; \
- cat $< ) >tempfile_regress_README.sgml
- $(JADE.text) -V nochunks tempfile_regress_README.sgml > $@
- rm tempfile_regress_README.sgml
-
##
## XSLT processing
# 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
Plain Text Files
- Several files are distributed as plain text, for reading during
- the installation process. The INSTALL 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 INSTALL file
corresponds to , with some minor
changes to account for the different context. To recreate the
file, change to the directory doc/src/sgml
- and enter gmake INSTALL . This will create
- a file INSTALL.html that can be saved as text
- with
Netscape Navigator and put into
- the place of the existing file.
-
Netscape seems to offer the best
- quality for
HTML to text conversions (over
+ and enter gmake INSTALL .
- The file HISTORY can be created similarly,
- using the command gmake HISTORY . For the
- file src/test/regress/README the command is
- gmake regress_README .
+ In the past, the release notes and regression testing instructions
+ were also distributed as plain text, but this practice has been
+ discontinued.
+++ /dev/null
-#! /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
-# 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 "\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 ()
- {
-
- # Recursively expand sub-files of the release notes
- if (m/^&(release-.*);$/)
- {
- process_file($1 . ".sgml");
- next;
- }
-
- # Remove tags, which might span multiple lines
- while (m/
- {
- if (s/]*>//)
- {
- next;
- }
-
- # incomplete tag, so slurp another line
- $_ .= ;
- }
-
- # Remove too
- s|||g;
-
- print;
- }
- close(FILE);
-}
wrap long lines
-For new features, add links to the documentation sections. Use
-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 .
+For new features, add links to the documentation sections.
-->
--- /dev/null
+Documentation concerning how to run these regression tests and interpret
+the results can be found in the PostgreSQL manual, in the chapter
+"Regression Tests".
o update doc/src/sgml/release.sgml
o run spellchecker on result
o add SGML markup
- o check if 'gmake HISTORY.html' works for
* Update timezone data to match latest zic database and new
Windows releases, if any (see src/timezone/README)
projects / postgresql.git / commitdiff