Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit2895415

Browse files
committed
Don't generate plain-text HISTORY and src/test/regress/README anymore.
Providing this information as plain text was doubtless worth the troubleten years ago, but it seems likely that hardly anyone reads it in thisformat anymore. And the effort required to maintain these files (in theform of extra-complex markup rules in the relevant parts of the SGMLdocumentation) is significant. So, let's stop doing that and rely solelyon the other documentation formats.Per discussion, the plain-text INSTALL instructions might still be worththeir keep, so we continue to generate that file.Rather than remove HISTORY and src/test/regress/README from distributiontarballs entirely, replace them with simple stub files that tell the readerwhere to find the relevant documentation. This is mainly to avoid possiblybreaking packaging recipes that expect these files to exist.Back-patch to all supported branches, because simplifying the markuprequirements for release notes won't help much unless we do it in allbranches.
1 parentd699ba4 commit2895415

File tree

12 files changed

+36
-137
lines changed

12 files changed

+36
-137
lines changed

‎GNUmakefile.in‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,8 @@ distdir:
103103
fi || exit; \
104104
done
105105
$(MAKE) -C $(distdir) distprep
106-
$(MAKE) -C $(distdir)/doc/src/sgml/ HISTORY INSTALL regress_README
107-
cp $(distdir)/doc/src/sgml/HISTORY $(distdir)/
106+
$(MAKE) -C $(distdir)/doc/src/sgml/ INSTALL
108107
cp $(distdir)/doc/src/sgml/INSTALL $(distdir)/
109-
cp $(distdir)/doc/src/sgml/regress_README $(distdir)/src/test/regress/README
110108
$(MAKE) -C $(distdir) distclean
111109
rm -f $(distdir)/README.git
112110

‎HISTORY‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Release notes for all versions of PostgreSQL can be found on-line at
2+
http://www.postgresql.org/docs/devel/static/release.html
3+
4+
In a distribution file set, release notes for the current version can be
5+
found prebuilt under doc/src/sgml/html/. Visit the index.html file with
6+
an HTML browser, then consult the "Release Notes" appendix.

‎README‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ See the file INSTALL for instructions on how to build and install
1717
PostgreSQL. That file also lists supported operating systems and
1818
hardware platforms and contains information regarding any other
1919
software packages that are required to build or run the PostgreSQL
20-
system. Changes between all PostgreSQL releases are recorded in the
21-
file HISTORY. Copyright and license information can be found in the
20+
system. Copyright and license information can be found in the
2221
file COPYRIGHT. A comprehensive documentation set is included in this
2322
distribution; it can be read as described in the installation
2423
instructions.

‎README.git‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
(This file does not appear in release tarballs.)
22

3-
In a release or snapshot tarball of PostgreSQL, documentation files named
4-
INSTALL and HISTORY will appear in this directory. However, these files are
5-
not stored in git and so will not be present if you are using a git checkout.
6-
If you are using git, you can view the most recent install instructions at:
3+
In a release or snapshot tarball of PostgreSQL, a documentation file named
4+
INSTALL will appear in this directory. However, this file is not stored in
5+
git and so will not be present if you are using a git checkout.
6+
7+
If you are using a git checkout, you can view the most recent installation
8+
instructions at:
79
http://www.postgresql.org/docs/devel/static/installation.html
8-
and the current release notes at:
9-
http://www.postgresql.org/docs/devel/static/release.html
1010

1111
Users compiling from git will also need compatible versions of Bison, Flex,
1212
and Perl, as discussed in the install documentation. These programs are not

‎doc/src/sgml/.gitignore‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
/man7/
77
/man-stamp
88
# Other popular build targets
9-
/HISTORY
109
/INSTALL
11-
/regress_README
1210
/postgres-US.pdf
1311
/postgres-A4.pdf
1412
/postgres.html
@@ -22,9 +20,7 @@
2220
/HTML.index
2321
# Assorted byproducts from building the above
2422
/postgres.xml
25-
/HISTORY.html
2623
/INSTALL.html
27-
/regress_README.html
2824
/postgres-US.aux
2925
/postgres-US.log
3026
/postgres-US.out

‎doc/src/sgml/Makefile‎

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -215,33 +215,20 @@ JADE.text = $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -i
215215
ICONV = iconv
216216
LYNX = lynx
217217

218-
# Therelease notesmay contain non-ASCII characters (for contributor
219-
# names), which lynx converts to the encoding determined by the
220-
# current locale.The get output that is deterministic and easily
221-
# readable by everyone, we make lynx produce LATIN1 and then convert
222-
# that to ASCII with transliteration for the non-ASCII characters.
223-
# Official releasesare currently built on FreeBSD, which has limited
218+
# Thedocumentationmay contain non-ASCII characters (mostly for
219+
#contributornames), which lynx converts to the encoding determined
220+
#by thecurrent locale.To gettextoutput that is deterministic and
221+
#easilyreadable by everyone, we make lynx produce LATIN1 and then
222+
#convertthat to ASCII with transliteration for the non-ASCII characters.
223+
# Official releaseswere historically built on FreeBSD, which has limited
224224
# locale support and is very picky about locale name spelling. The
225225
# below has been finely tuned to run on FreeBSD and Linux/glibc.
226-
INSTALLHISTORYregress_README:% :%.html
226+
INSTALL:% :%.html
227227
$(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>$@
228228

229229
INSTALL.html: standalone-install.sgml installation.sgml version.sgml
230230
$(JADE.text) -V nochunks standalone-install.sgml installation.sgml>$@
231231

232-
HISTORY.html: generate_history.pl$(wildcard$(srcdir)/release*.sgml)
233-
$(PERL)$<"$(srcdir)" release.sgml>tempfile_HISTORY.sgml
234-
$(JADE.text) -V nochunks tempfile_HISTORY.sgml>$@
235-
rm tempfile_HISTORY.sgml
236-
237-
regress_README.html: regress.sgml
238-
(echo'<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN" ['; \
239-
echo'<!ENTITY % standalone-ignore "IGNORE">';\
240-
echo'<!ENTITY % standalone-include "INCLUDE"> ]>';\
241-
cat$< )>tempfile_regress_README.sgml
242-
$(JADE.text) -V nochunks tempfile_regress_README.sgml>$@
243-
rm tempfile_regress_README.sgml
244-
245232

246233
##
247234
## XSLT processing
@@ -393,13 +380,13 @@ check-tabs:
393380
# This allows removing some files from the distribution tarballs while
394381
# keeping the dependencies satisfied.
395382
.SECONDARY: postgres.xml$(GENERATED_SGML) HTML.index
396-
.SECONDARY: INSTALL.html HISTORY.html regress_README.html
383+
.SECONDARY: INSTALL.html
397384
.SECONDARY:%-A4.tex-ps%-US.tex-ps%-A4.tex-pdf%-US.tex-pdf
398385

399386
clean:
400387
# text --- these are shipped, but not in this directory
401-
rm -f INSTALL HISTORY regress_README
402-
rm -f INSTALL.html HISTORY.html regress_README.html
388+
rm -f INSTALL
389+
rm -f INSTALL.html
403390
# single-page output
404391
rm -f postgres.html postgres.txt
405392
# print

‎doc/src/sgml/docguide.sgml‎

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -942,26 +942,19 @@ save_size.pdfjadetex = 15000
942942
<title>Plain Text Files</title>
943943

944944
<para>
945-
Several files are distributed as plain text, for reading during
946-
the installation process. The <filename>INSTALL</filename> file
945+
The installation instructions are also distributed as plain text,
946+
in case they are needed in a situation where better reading tools
947+
are not available. The <filename>INSTALL</filename> file
947948
corresponds to <xref linkend="installation">, with some minor
948949
changes to account for the different context. To recreate the
949950
file, change to the directory <filename>doc/src/sgml</filename>
950-
and enter <userinput>gmake INSTALL</userinput>. This will create
951-
a file <filename>INSTALL.html</filename> that can be saved as text
952-
with <productname>Netscape Navigator</productname> and put into
953-
the place of the existing file.
954-
<productname>Netscape</productname> seems to offer the best
955-
quality for <acronym>HTML</acronym> to text conversions (over
956-
<application>lynx</application> and
957-
<application>w3m</application>).
951+
and enter <userinput>gmake INSTALL</userinput>.
958952
</para>
959953

960954
<para>
961-
The file <filename>HISTORY</filename> can be created similarly,
962-
using the command <userinput>gmake HISTORY</userinput>. For the
963-
file <filename>src/test/regress/README</filename> the command is
964-
<userinput>gmake regress_README</userinput>.
955+
In the past, the release notes and regression testing instructions
956+
were also distributed as plain text, but this practice has been
957+
discontinued.
965958
</para>
966959
</sect2>
967960

‎doc/src/sgml/generate_history.pl‎

Lines changed: 0 additions & 65 deletions
This file was deleted.

‎doc/src/sgml/release.sgml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@ non-ASCII characters find using grep -P '[\x80-\xFF]'
3434

3535
wrap long lines
3636

37-
For new features, add links to the documentation sections. Use </link>
38-
not just </> so that generate_history.pl can remove it, so HISTORY.html
39-
can be created without links to the main documentation. Don't use <xref>.
37+
For new features, add links to the documentation sections.
4038

4139
-->
4240

@@ -71,7 +69,6 @@ can be created without links to the main documentation. Don't use <xref>.
7169

7270
<!--
7371
To add a new major-release series, add an entry here and in filelist.sgml.
74-
Follow the naming convention, or you'll confuse generate_history.pl.
7572

7673
The reason for splitting the release notes this way is so that appropriate
7774
subsets can easily be copied into back branches.

‎doc/src/sgml/standalone-install.sgml‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,7 @@
22

33
<!--
44
This file helps in generating the INSTALL text file that lives in the
5-
top level directory of the distribution. The exact process is like
6-
this:
7-
8-
1. Paste together with installation.sgml
9-
10-
2. Process with jade to HTML (use -V nochunks)
11-
12-
3. Remove "Chapter 1" heading
13-
14-
4. Save as text file in Netscape
15-
16-
5. Put in place of old INSTALL file
17-
18-
Running 'make INSTALL' in the doc/src/sgml directory will do 1 through
19-
3 for you.
5+
top level directory of the distribution.
206
-->
217

228
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp