mirror of https://github.com/postgres/postgres
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.pull/6/head
Tom Lane
12 years ago
parent
d699ba4134
commit
2895415205
@ -0,0 +1,6 @@ |
||||
Release notes for all versions of PostgreSQL can be found on-line at |
||||
http://www.postgresql.org/docs/devel/static/release.html |
||||
|
||||
In a distribution file set, release notes for the current version can be |
||||
found prebuilt under doc/src/sgml/html/. Visit the index.html file with |
||||
an HTML browser, then consult the "Release Notes" appendix. |
||||
@ -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); |
||||
} |
||||
@ -0,0 +1,3 @@ |
||||
Documentation concerning how to run these regression tests and interpret |
||||
the results can be found in the PostgreSQL manual, in the chapter |
||||
"Regression Tests". |
||||
Loading…
Reference in new issue