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

Commite1e7642

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 parentfe8a6f5 commite1e7642

File tree

12 files changed

+30
-124
lines changed

12 files changed

+30
-124
lines changed

‎GNUmakefile.in

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,8 @@ distdir:
117117
fi || exit; \
118118
done
119119
$(MAKE) -C $(distdir) distprep
120-
$(MAKE) -C $(distdir)/doc/src/sgml/ HISTORY INSTALL regress_README
121-
cp $(distdir)/doc/src/sgml/HISTORY $(distdir)/
120+
$(MAKE) -C $(distdir)/doc/src/sgml/ INSTALL
122121
cp $(distdir)/doc/src/sgml/INSTALL $(distdir)/
123-
cp $(distdir)/doc/src/sgml/regress_README $(distdir)/src/test/regress/README
124122
$(MAKE) -C $(distdir) distclean
125123
rm -f $(distdir)/README.git
126124

‎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
@@ -21,9 +19,7 @@
2119
/HTML.index
2220
# Assorted byproducts from building the above
2321
/postgres.xml
24-
/HISTORY.html
2522
/INSTALL.html
26-
/regress_README.html
2723
/postgres-US.aux
2824
/postgres-US.log
2925
/postgres-US.out

‎doc/src/sgml/Makefile

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -206,25 +206,12 @@ postgres.pdf:
206206
JADE.text =$(JADE)$(JADEFLAGS)$(SGMLINCLUDE)$(CATALOG) -d stylesheet.dsl -i output-text -t sgml
207207
LYNX = lynx
208208

209-
INSTALLHISTORYregress_README:% :%.html
209+
INSTALL:% :%.html
210210
$(PERL) -p -e's/<H(1|2)$$/<H\1 align=center/g'$<|$(LYNX) -force_html -dump -nolist -stdin>$@
211211

212212
INSTALL.html: standalone-install.sgml installation.sgml version.sgml
213213
$(JADE.text) -V nochunks standalone-install.sgml installation.sgml>$@
214214

215-
HISTORY.html: generate_history.pl$(wildcard$(srcdir)/release*.sgml)
216-
$(PERL)$<"$(srcdir)" release.sgml>tempfile_HISTORY.sgml
217-
$(JADE.text) -V nochunks tempfile_HISTORY.sgml>$@
218-
rm tempfile_HISTORY.sgml
219-
220-
regress_README.html: regress.sgml
221-
(echo'<!doctype chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN" ['; \
222-
echo'<!entity % standalone-ignore "IGNORE">';\
223-
echo'<!entity % standalone-include "INCLUDE"> ]>';\
224-
cat$< )>tempfile_regress_README.sgml
225-
$(JADE.text) -V nochunks tempfile_regress_README.sgml>$@
226-
rm tempfile_regress_README.sgml
227-
228215

229216
##
230217
## XSLT processing
@@ -352,13 +339,13 @@ check-tabs:
352339
# This allows removing some files from the distribution tarballs while
353340
# keeping the dependencies satisfied.
354341
.SECONDARY: postgres.xml$(GENERATED_SGML) HTML.index
355-
.SECONDARY: INSTALL.html HISTORY.html regress_README.html
342+
.SECONDARY: INSTALL.html
356343
.SECONDARY:%-A4.tex-ps%-US.tex-ps%-A4.tex-pdf%-US.tex-pdf
357344

358345
clean:
359346
# text --- these are shipped, but not in this directory
360-
rm -f INSTALL HISTORY regress_README
361-
rm -f INSTALL.html HISTORY.html regress_README.html
347+
rm -f INSTALL
348+
rm -f INSTALL.html
362349
# single-page output
363350
rm -f postgres.html postgres.txt
364351
# print

‎doc/src/sgml/docguide.sgml

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

916916
<para>
917-
Several files are distributed as plain text, for reading during
918-
the installation process. The <filename>INSTALL</filename> file
917+
The installation instructions are also distributed as plain text,
918+
in case they are needed in a situation where better reading tools
919+
are not available. The <filename>INSTALL</filename> file
919920
corresponds to <xref linkend="installation">, with some minor
920921
changes to account for the different context. To recreate the
921922
file, change to the directory <filename>doc/src/sgml</filename>
922-
and enter <userinput>gmake INSTALL</userinput>. This will create
923-
a file <filename>INSTALL.html</filename> that can be saved as text
924-
with <productname>Netscape Navigator</productname> and put into
925-
the place of the existing file.
926-
<productname>Netscape</productname> seems to offer the best
927-
quality for <acronym>HTML</acronym> to text conversions (over
928-
<application>lynx</application> and
929-
<application>w3m</application>).
923+
and enter <userinput>gmake INSTALL</userinput>.
930924
</para>
931925

932926
<para>
933-
The file <filename>HISTORY</filename> can be created similarly,
934-
using the command <userinput>gmake HISTORY</userinput>. For the
935-
file <filename>src/test/regress/README</filename> the command is
936-
<userinput>gmake regress_README</userinput>.
927+
In the past, the release notes and regression testing instructions
928+
were also distributed as plain text, but this practice has been
929+
discontinued.
937930
</para>
938931
</sect2>
939932

‎doc/src/sgml/generate_history.pl

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

‎doc/src/sgml/release.sgml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ non-ASCII characters convert to HTML4 entity (&) escapes
2828

2929
wrap long lines
3030

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

3533
-->
3634

@@ -65,7 +63,6 @@ can be created without links to the main documentation. Don't use <xref>.
6563

6664
<!--
6765
To add a new major-release series, add an entry here and in filelist.sgml.
68-
Follow the naming convention, or you'll confuse generate_history.pl.
6966

7067
The reason for splitting the release notes this way is so that appropriate
7168
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" [

‎src/test/regress/README

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Documentation concerning how to run these regression tests and interpret
2+
the results can be found in the PostgreSQL manual, in the chapter
3+
"Regression Tests".

‎src/tools/RELEASE_CHANGES

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ For All Releases (major, minor, beta, RC)
1010
o update doc/src/sgml/release.sgml
1111
o run spellchecker on result
1212
o add SGML markup
13-
o check if 'gmake HISTORY.html' works for <link>s
1413

1514
* Update timezone data to match latest zic database and new
1615
Windows releases, if any (see src/timezone/README)

0 commit comments

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