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

Commite2b73f4

Browse files
committed
Stop generating plain-text INSTALL instructions.
Up to now, our distribution tarballs have included a plain-text formof the installation.sgml chapter. The rationale for that was that arecipient might not have either ready internet access or HTML-viewingtools; a theory that seems downright quaint today. Maintaining theability to generate this file is not without cost, because it putsspecial requirements on installation.sgml that are often overlooked.Moreover, we are moving in the direction of making our distributiontarballs be pure git snapshots for traceability/reproducibilityreasons; including generated files doesn't fit into that plan.Hence, let's just drop INSTALL and remove the infrastructure forgenerating it. The top-level README will now recommend visitingour website to see the installation instructions. As a usefulside-effect, we can get rid of README.git which has provokedconfusion.Discussion:https://postgr.es/m/20231220114927.faccqqprmuyrzdip@alap3.anarazel.deDiscussion:https://postgr.es/m/e07408d9-e5f2-d9fd-5672-f53354e9305e@eisentraut.org
1 parent8ddf9c1 commite2b73f4

File tree

13 files changed

+32
-421
lines changed

13 files changed

+32
-421
lines changed

‎GNUmakefile.in

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,7 @@ distdir:
109109
|| cp "$(top_srcdir)/$$file" "$(distdir)/$$file"; \
110110
fi || exit; \
111111
done
112-
$(MAKE) -C $(distdir)/doc/src/sgml/ INSTALL
113-
cp $(distdir)/doc/src/sgml/INSTALL $(distdir)/
114112
$(MAKE) -C $(distdir) distclean
115-
rm -f $(distdir)/README.git
116113

117114
distcheck: dist
118115
rm -rf $(dummy)

‎Makefile

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,7 @@ all:
1717

1818
allcheckinstallinstalldirsinstallcheckinstallcheck-paralleluninstallcleandistcleanmaintainer-cleandistdistcheckworldcheck-worldinstall-worldinstallcheck-world:
1919
@if [!-f GNUmakefile ];then\
20-
if [-f INSTALL ];then \
21-
INSTRUCTIONS="INSTALL";\
22-
else\
23-
INSTRUCTIONS="README.git";\
24-
fi;\
25-
echo"You need to run the 'configure' program first. See the file";\
26-
echo"'$$INSTRUCTIONS' for installation instructions, or visit:";\
20+
echo"You need to run the 'configure' program first. Please see";\
2721
echo"<https://www.postgresql.org/docs/devel/installation.html>";\
2822
false;\
2923
fi

‎README

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,13 @@ that supports an extended subset of the SQL standard, including
99
transactions, foreign keys, subqueries, triggers, user-defined types
1010
and functions. This distribution also contains C language bindings.
1111

12-
See the file INSTALL for instructions on how to build and install
13-
PostgreSQL. That file also lists supported operating systems and
14-
hardware platforms and contains information regarding any other
15-
software packages that are required to build or run the PostgreSQL
16-
system. Copyright and license information can be found in the
17-
file COPYRIGHT. A comprehensive documentation set is included in this
18-
distribution; it can be read as described in the installation
19-
instructions.
12+
Copyright and license information can be found in the file COPYRIGHT.
13+
14+
General documentation about this version of PostgreSQL can be found at:
15+
https://www.postgresql.org/docs/devel/
16+
In particular, information about building PostgreSQL from the source
17+
code can be found at:
18+
https://www.postgresql.org/docs/devel/installation.html
2019

2120
The latest version of this software, and related software, may be
2221
obtained at https://www.postgresql.org/download/. For more information

‎README.git

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

‎doc/src/sgml/.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
/man7/
77
/man-stamp
88
# Other popular build targets
9-
/INSTALL
109
/postgres-US.pdf
1110
/postgres-A4.pdf
1211
/postgres.html
@@ -21,7 +20,5 @@
2120
/wait_event_types.sgml
2221
# Assorted byproducts from building the above
2322
/postgres-full.xml
24-
/INSTALL.html
25-
/INSTALL.xml
2623
/postgres-US.fo
2724
/postgres-A4.fo

‎doc/src/sgml/Makefile

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ ifndef FOP
3636
FOP =$(missing) fop
3737
endif
3838

39+
PANDOC = pandoc
40+
3941
XMLINCLUDE = --path . --path$(srcdir)
4042

4143
ifdefXMLLINT
@@ -113,25 +115,6 @@ wait_event_types.sgml: $(top_srcdir)/src/backend/utils/activity/wait_event_names
113115
targets-meson.sgml: targets-meson.txt$(srcdir)/generate-targets-meson.pl
114116
$(PERL)$(srcdir)/generate-targets-meson.pl$^>$@
115117

116-
##
117-
## Generation of some text files.
118-
##
119-
120-
ICONV = iconv
121-
PANDOC = pandoc
122-
123-
INSTALL:% :%.html
124-
$(PANDOC) -t plain -o$@.tmp$<
125-
$(ICONV) -f utf8 -t us-ascii//TRANSLIT$@.tmp>$@
126-
rm$@.tmp
127-
128-
INSTALL.html:%.html : stylesheet-text.xsl%.xml
129-
$(XMLLINT) --noout --valid$*.xml
130-
$(XSLTPROC)$(XSLTPROCFLAGS)$(XSLTPROC_HTML_FLAGS)$^>$@
131-
132-
INSTALL.xml: standalone-profile.xsl standalone-install.xml postgres-full.xml
133-
$(XSLTPROC)$(XMLINCLUDE)$(XSLTPROCFLAGS) --xinclude$(wordlist 1,2,$^)>$@
134-
135118

136119
##
137120
## HTML
@@ -284,13 +267,9 @@ check-tabs:
284267
# keeping the dependencies satisfied.
285268
.SECONDARY:$(GENERATED_SGML)
286269
.SECONDARY: postgres-full.xml
287-
.SECONDARY: INSTALL.html INSTALL.xml
288270
.SECONDARY: postgres-A4.fo postgres-US.fo
289271

290272
clean:
291-
# text --- these are shipped, but not in this directory
292-
rm -f INSTALL
293-
rm -f INSTALL.html INSTALL.xml
294273
# single-page output
295274
rm -f postgres.html postgres.txt
296275
# print

‎doc/src/sgml/docguide.sgml

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -393,28 +393,6 @@ LOGLEVEL=-Dorg.apache.commons.logging.simplelog.defaultlog=WARN
393393
</para>
394394
</sect2>
395395

396-
<sect2 id="docguide-build-plain-text">
397-
<title>Plain Text Files</title>
398-
399-
<para>
400-
The installation instructions are also distributed as plain text,
401-
in case they are needed in a situation where better reading tools
402-
are not available. The <filename>INSTALL</filename> file
403-
corresponds to <xref linkend="installation"/>, with some minor
404-
changes to account for the different context. To recreate the
405-
file, change to the directory <filename>doc/src/sgml</filename>
406-
and enter <userinput>make INSTALL</userinput>. Building text output
407-
requires <productname>Pandoc</productname> version 1.13 or newer as an
408-
additional build tool.
409-
</para>
410-
411-
<para>
412-
In the past, the release notes and regression testing instructions
413-
were also distributed as plain text, but this practice has been
414-
discontinued.
415-
</para>
416-
</sect2>
417-
418396
<sect2 id="docguide-build-syntax-check">
419397
<title>Syntax Check</title>
420398

‎doc/src/sgml/installation.sgml

Lines changed: 18 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
<!-- doc/src/sgml/installation.sgml -->
2-
<!--
3-
4-
The standalone version has some portions that are different from the version
5-
that is integrated into the full documentation set, in particular as regards
6-
links, so that INSTALL.html can be created without links to the main
7-
documentation. See standalone-profile.xsl for details.
8-
9-
-->
102

113
<chapter id="installation">
124
<title>Installation from Source Code</title>
@@ -15,7 +7,6 @@ documentation. See standalone-profile.xsl for details.
157
<primary>installation</primary>
168
</indexterm>
179

18-
<!-- See also the version of this text in standalone-install.xml -->
1910
<para>
2011
This chapter describes the installation of
2112
<productname>PostgreSQL</productname> using the source code
@@ -942,9 +933,7 @@ build-postgresql:
942933
<listitem>
943934
<para>
944935
Build with support for <productname>LLVM</productname> based
945-
<acronym>JIT</acronym> compilation<phrase
946-
condition="standalone-ignore"> (see <xref
947-
linkend="jit"/>)</phrase>. This
936+
<acronym>JIT</acronym> compilation (see <xref linkend="jit"/>). This
948937
requires the <productname>LLVM</productname> library to be installed.
949938
The minimum required version of <productname>LLVM</productname> is
950939
currently 3.9.
@@ -1085,8 +1074,8 @@ build-postgresql:
10851074
for <application>systemd</application><indexterm><primary>systemd</primary></indexterm>
10861075
service notifications. This improves integration if the server
10871076
is started under <application>systemd</application> but has no impact
1088-
otherwise<phrase condition="standalone-ignore">; see <xref linkend="server-start"/> for more
1089-
information</phrase>. <application>libsystemd</application> and the
1077+
otherwise; see <xref linkend="server-start"/> for more
1078+
information. <application>libsystemd</application> and the
10901079
associated header files need to be installed to use this option.
10911080
</para>
10921081
</listitem>
@@ -1224,9 +1213,8 @@ build-postgresql:
12241213
<para>
12251214
Build without support for the
12261215
<productname>ICU</productname><indexterm><primary>ICU</primary></indexterm>
1227-
library, disabling the use of ICU collation features<phrase
1228-
condition="standalone-ignore"> (see <xref
1229-
linkend="collation"/>)</phrase>.
1216+
library, disabling the use of ICU collation features (see <xref
1217+
linkend="collation"/>).
12301218
</para>
12311219
</listitem>
12321220
</varlistentry>
@@ -1583,7 +1571,7 @@ build-postgresql:
15831571
<para>
15841572
Enable tests using the Perl TAP tools. This requires a Perl
15851573
installation and the Perl module <literal>IPC::Run</literal>.
1586-
<phrase condition="standalone-ignore">See <xref linkend="regress-tap"/> for more information.</phrase>
1574+
See <xref linkend="regress-tap"/> for more information.
15871575
</para>
15881576
</listitem>
15891577
</varlistentry>
@@ -1610,8 +1598,8 @@ build-postgresql:
16101598
code coverage testing instrumentation. When run, they
16111599
generate files in the build directory with code coverage
16121600
metrics.
1613-
<phrase condition="standalone-ignore">See <xref linkend="regress-coverage"/>
1614-
for more information.</phrase> This option is for use only with GCC
1601+
See <xref linkend="regress-coverage"/>
1602+
for more information. This option is for use only with GCC
16151603
and when doing development work.
16161604
</para>
16171605
</listitem>
@@ -1639,8 +1627,7 @@ build-postgresql:
16391627
</indexterm>
16401628
Compiles <productname>PostgreSQL</productname> with support for the
16411629
dynamic tracing tool DTrace.
1642-
<phrase condition="standalone-ignore">See <xref linkend="dynamic-trace"/>
1643-
for more information.</phrase>
1630+
See <xref linkend="dynamic-trace"/> for more information.
16441631
</para>
16451632

16461633
<para>
@@ -2406,9 +2393,8 @@ ninja install
24062393
<para>
24072394
Build with support for the
24082395
<productname>ICU</productname><indexterm><primary>ICU</primary></indexterm>
2409-
library, enabling use of ICU collation features<phrase
2410-
condition="standalone-ignore"> (see <xref
2411-
linkend="collation"/>)</phrase>. Defaults to auto and requires the
2396+
library, enabling use of ICU collation features (see <xref
2397+
linkend="collation"/>). Defaults to auto and requires the
24122398
<productname>ICU4C</productname> package to be installed. The minimum
24132399
required version of <productname>ICU4C</productname> is currently 4.2.
24142400
</para>
@@ -2420,8 +2406,7 @@ ninja install
24202406
<listitem>
24212407
<para>
24222408
Build with support for <productname>LLVM</productname> based
2423-
<acronym>JIT</acronym> compilation<phrase
2424-
condition="standalone-ignore"> (see <xref linkend="jit"/>)</phrase>.
2409+
<acronym>JIT</acronym> compilation (see <xref linkend="jit"/>).
24252410
This requires the <productname>LLVM</productname> library to be
24262411
installed. The minimum required version of
24272412
<productname>LLVM</productname> is currently 3.9. Disabled by
@@ -2546,8 +2531,8 @@ ninja install
25462531
<application>systemd</application><indexterm><primary>systemd</primary></indexterm>
25472532
service notifications. This improves integration if the server is
25482533
started under <application>systemd</application> but has no impact
2549-
otherwise<phrase condition="standalone-ignore">; see <xref
2550-
linkend="server-start"/> for more information</phrase>. Defaults to
2534+
otherwise; see <xref
2535+
linkend="server-start"/> for more information. Defaults to
25512536
auto. <application>libsystemd</application> and the associated header
25522537
files need to be installed to use this option.
25532538
</para>
@@ -3122,8 +3107,7 @@ ninja install
31223107
<para>
31233108
Enable tests using the Perl TAP tools. Defaults to auto and requires
31243109
a Perl installation and the Perl module <literal>IPC::Run</literal>.
3125-
<phrase condition="standalone-ignore">See <xref
3126-
linkend="regress-tap"/> for more information.</phrase>
3110+
See <xref linkend="regress-tap"/> for more information.
31273111
</para>
31283112
</listitem>
31293113
</varlistentry>
@@ -3147,8 +3131,8 @@ ninja install
31473131
code coverage testing instrumentation. When run, they
31483132
generate files in the build directory with code coverage
31493133
metrics.
3150-
<phrase condition="standalone-ignore">See <xref linkend="regress-coverage"/>
3151-
for more information.</phrase> This option is for use only with GCC
3134+
See <xref linkend="regress-coverage"/>
3135+
for more information. This option is for use only with GCC
31523136
and when doing development work.
31533137
</para>
31543138
</listitem>
@@ -3163,8 +3147,7 @@ ninja install
31633147
</indexterm>
31643148
Enabling this compiles <productname>PostgreSQL</productname> with support for the
31653149
dynamic tracing tool DTrace.
3166-
<phrase condition="standalone-ignore">See <xref linkend="dynamic-trace"/>
3167-
for more information.</phrase>
3150+
See <xref linkend="dynamic-trace"/> for more information.
31683151
</para>
31693152

31703153
<para>

‎doc/src/sgml/meson.build

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -182,43 +182,6 @@ if docs_dep.found()
182182
endif
183183

184184

185-
#
186-
# INSTALL in html, text
187-
#
188-
if docs_dep.found()
189-
# Depend on postgres_full_xml, so validity errors are raised in one place,
190-
# and so dependencies don't need to be re-specified.
191-
install_xml=custom_target('INSTALL.xml',
192-
input: ['standalone-profile.xsl','standalone-install.xml'],
193-
output:'INSTALL.xml',
194-
depfile:'INSTALL.xml.d',
195-
depends: postgres_full_xml,
196-
command: [xsltproc,'-o','@OUTPUT@', xsltproc_flags,'--xinclude','@INPUT@'],
197-
build_by_default:false,
198-
)
199-
install_html=custom_target('INSTALL.html',
200-
input: ['stylesheet-text.xsl', install_xml],
201-
output:'INSTALL.html',
202-
depfile:'INSTALL.html.d',
203-
command: [xsltproc,'-o','@OUTPUT@', xsltproc_html_flags,'@INPUT@'],
204-
build_by_default:false,
205-
)
206-
alldocs+= install_html
207-
208-
if pandoc.found()
209-
# XXX: Makefile does an iconv translit here, but unclear why?
210-
install=custom_target('INSTALL',
211-
input: [install_html],
212-
output:'INSTALL',
213-
command: [pandoc,'-t','plain','-o','@OUTPUT@','@INPUT@'],
214-
build_by_default:false,
215-
)
216-
alldocs+= install
217-
endif
218-
219-
endif
220-
221-
222185
#
223186
# Man pages
224187
#

0 commit comments

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