database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-11-07 19:06:32 +03:00
Code Activity

Don't generate plain-text HISTORY and src/test/regress/README anymore.

Browse Source 
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.
This commit is contained in:
Tom Lane
2014-02-10 20:48:12 -05:00
parent 928aec71c4
commit f1e522696f
12 changed files with 36 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/src/sgml/docguide.sgml
View File

@@ -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>