diff options
| author | Tom Lane <tgl@sss.pgh.pa.us> | 2014-02-10 20:48:04 -0500 |
|---|---|---|
| committer | Tom Lane <tgl@sss.pgh.pa.us> | 2014-02-10 20:48:04 -0500 |
| commit | 2895415205d86cc7ab55acab5f90fd70a7c68f3c (patch) | |
| tree | a27852acace1392b24f993978b787235abbe79ee /README.git | |
| parent | d699ba41349e4ef397222a7223606fa03f4c4870 (diff) | |
| download | postgresql-2895415205d86cc7ab55acab5f90fd70a7c68f3c.tar.gz | |
Don't generate plain-text HISTORY and src/test/regress/README anymore.
Providing this information as plain text was doubtless worth the trouble
ten years ago, but it seems likely that hardly anyone reads it in this
format anymore. And the effort required to maintain these files (in the
form of extra-complex markup rules in the relevant parts of the SGML
documentation) is significant. So, let's stop doing that and rely solely
on the other documentation formats.
Per discussion, the plain-text INSTALL instructions might still be worth
their keep, so we continue to generate that file.
Rather than remove HISTORY and src/test/regress/README from distribution
tarballs entirely, replace them with simple stub files that tell the reader
where to find the relevant documentation. This is mainly to avoid possibly
breaking packaging recipes that expect these files to exist.
Back-patch to all supported branches, because simplifying the markup
requirements for release notes won't help much unless we do it in all
branches.
Diffstat (limited to 'README.git')
| -rw-r--r-- | README.git | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/README.git b/README.git index d5378b4573..0bf2b56cb3 100644 --- a/README.git +++ b/README.git @@ -1,12 +1,12 @@ (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 |