Skip to content

Commit 0db3cb2

Browse files
peterepetere
committed
* doc/src/sgml/regress.sgml: Update for new driver script.
* doc/src/sgml/installation.sgml: ditto. * src/test/regress/README: Regenerate. * doc/src/sgml/docguide.sgml: Explain how it was done. Explain how INSTALL and HISTORY are (now) generated. * doc/src/sgml/Makefile: Implement HISTORY generation to be analoguous to INSTALL.
1 parent f7b89ac commit 0db3cb2

File tree

5 files changed

+598
-780
lines changed

5 files changed

+598
-780
lines changed

‎doc/src/sgml/Makefile‎

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
#
99
#
1010
# IDENTIFICATION
11-
# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.23 2000/10/10 22:01:50 momjian Exp $
11+
# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.24 2000/10/17 15:26:39 petere Exp $
1212
#
1313
#----------------------------------------------------------------------------
1414

@@ -201,21 +201,30 @@ distclean:
201201
cp -p ../graphics/$@ .
202202

203203

204-
# Generation of the INSTALL text file. Not fully automated, but better
205-
# than nothing.
206-
.PHONY: INSTALL
207-
INSTALL: INSTALL.html
204+
#
205+
# Semi-automatic generation of some text files.
206+
#
207+
208+
INSTALL HISTORY: % : %.html
208209
@echo "|";\
209210
echo "| You should now take \`$<', save it as a text file in Netscape,";\
210-
echo "| and put it in place of the existing \`INSTALL' file.";\
211+
echo "| and put it in place of the existing \`$@' file.";\
211212
echo "|"
212-
@rm -f tempfile.html tempfile.sgml
213213

214-
INSTALL.html: tempfile.html
215-
sed -e 's/Chapter 1. *//g' < $< > $@
216214

217-
tempfile.html: tempfile.sgml
218-
jade -d $(HDSL) -V nochunks -t sgml $< > $@
215+
INSTALL.html HISTORY.html: %.html : tempfile_%.html
216+
sed 's/Chapter 1. *//g' $< >$@
217+
218+
tempfile_INSTALL.html tempfile_HISTORY.html: tempfile_%.html : tempfile_%.sgml
219+
jade -d $(HDSL) -V nochunks -t sgml $< >$@
220+
221+
222+
tempfile_INSTALL.sgml: standalone-install.sgml installation.sgml
223+
cat $+ >$@
224+
225+
tempfile_HISTORY.sgml: release.sgml
226+
( echo '<!doctype chapter PUBLIC "-//OASIS//DTD DocBook V3.1//EN">'; \
227+
cat $< ) >$@
228+
219229

220-
tempfile.sgml: standalone-install.sgml installation.sgml
221-
cat $+ > $@
230+
.INTERMEDIATE: tempfile_INSTALL.html tempfile_HISTORY.html tempfile_INSTALL.sgml tempfile_HISTORY.sgml

‎doc/src/sgml/docguide.sgml‎

Lines changed: 130 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.27 2000/09/29 20:21:33 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.28 2000/10/17 15:26:40 petere Exp $
33
Documentation Guide
44
Thomas Lockhart
55
-->
@@ -83,7 +83,7 @@ Thomas Lockhart
8383
</row>
8484
<row>
8585
<entry>./INSTALL</entry>
86-
<entry>Installation instructions (text from sgml->rtf->text)</entry>
86+
<entry>Installation instructions</entry>
8787
</row>
8888
<row>
8989
<entry>./README</entry>
@@ -848,6 +848,7 @@ End:
848848
</sect2>
849849
</sect1>
850850

851+
851852
<sect1 id="doc-build">
852853
<title>Building Documentation</title>
853854

@@ -911,9 +912,8 @@ PSTYLE= /home/lockhart/SGML/db143.d/docbook/print
911912
% make install
912913
</programlisting>
913914
</para>
914-
</sect1>
915915

916-
<sect1 id="doc-manpages">
916+
<sect2 id="doc-manpages">
917917
<title>Manpages</title>
918918

919919
<para>
@@ -966,9 +966,9 @@ $ make man
966966
</para>
967967
</step>
968968
</procedure>
969-
</sect1>
969+
</sect2>
970970

971-
<sect1 id="doc-hardcopy">
971+
<sect2 id="doc-hardcopy">
972972
<title>Hardcopy Generation for v7.0</title>
973973

974974
<para>
@@ -995,99 +995,6 @@ $ make man
995995
</para>
996996
-->
997997

998-
<sect2>
999-
<title>Text Hardcopy</title>
1000-
1001-
<para>
1002-
<filename>INSTALL</filename> and <filename>HISTORY</filename> are
1003-
updated for each release. For historical reasons, these files are
1004-
in plain text, but are derived from the newer
1005-
<acronym>SGML</acronym> sources.
1006-
</para>
1007-
1008-
<procedure>
1009-
<title>Plain Text Generation</title>
1010-
1011-
<para>
1012-
Both <filename>INSTALL</filename> and
1013-
<filename>HISTORY</filename> are generated from existing
1014-
<acronym>SGML</acronym> sources. They are extracted from the same
1015-
intermediate <acronym>RTF</acronym> file.
1016-
</para>
1017-
1018-
<step performance="required">
1019-
<para>
1020-
Generate <acronym>RTF</acronym> by typing:
1021-
<programlisting>
1022-
% cd doc/src/sgml
1023-
% make installation.rtf
1024-
</programlisting>
1025-
</para>
1026-
</step>
1027-
1028-
<step performance="required">
1029-
<para>
1030-
Import <filename>installation.rtf</filename> into
1031-
<productname>Applix Words</productname>.
1032-
</para>
1033-
</step>
1034-
1035-
<step performance="required">
1036-
<para>
1037-
Set the page width and margins.
1038-
</para>
1039-
1040-
<substeps>
1041-
<step performance="required">
1042-
<para>
1043-
Adjust the page width in File.PageSetup to 10 inches.
1044-
</para>
1045-
</step>
1046-
1047-
<step performance="required">
1048-
<para>
1049-
Select all text.
1050-
Adjust the right margin using the ruler to 9.5 inches. This
1051-
will give a maximum column width of 79 characters, within the
1052-
80 columns upper limit goal.
1053-
</para>
1054-
</step>
1055-
</substeps>
1056-
</step>
1057-
1058-
<step performance="required">
1059-
<para>
1060-
Lop off the parts of the document which are not needed.
1061-
</para>
1062-
1063-
<para>
1064-
For <filename>INSTALL</filename>, remove all release notes from
1065-
the end of the text, except for those from the current release.
1066-
For <filename>HISTORY</filename>, remove all text up to the
1067-
release notes, preserving and modifying the title and ToC.
1068-
</para>
1069-
</step>
1070-
1071-
<step performance="required">
1072-
<para>
1073-
Export the result as "ASCII Layout".
1074-
</para>
1075-
</step>
1076-
1077-
<step performance="required">
1078-
<para>
1079-
Using emacs or vi, clean up the tabular information in
1080-
<filename>INSTALL</filename>. Remove the "mailto"
1081-
<acronym>URLs</acronym> for the porting contributors to shrink
1082-
the column heights.
1083-
</para>
1084-
</step>
1085-
</procedure>
1086-
</sect2>
1087-
1088-
<sect2>
1089-
<title>Postscript Hardcopy</title>
1090-
1091998
<para>
1092999
Several areas are addressed while generating Postscript
10931000
hardcopy, including RTF repair, ToC generation, and page break
@@ -1321,10 +1228,134 @@ exit
13211228
</para>
13221229
</step>
13231230
</procedure>
1231+
</sect2>
1232+
1233+
<sect2>
1234+
<title>Plain Text Files</title>
1235+
1236+
<para>
1237+
Several files are distributed as plain text, for reading during
1238+
the installation process. The <filename>INSTALL</filename> file
1239+
corresponds to the chapter in the <citetitle>Administrator's
1240+
Guide</citetitle>, with some minor changes to account for the
1241+
different context. To recreate the file, change to the directory
1242+
<filename>doc/src/sgml</filename> and enter <userinput>gmake
1243+
INSTALL</userinput>. This will create a file
1244+
<filename>INSTALL.html</filename> that can be saved as text with
1245+
<productname>Netscape Navigator</productname> and put into the
1246+
place of the existing file. <productname>Netscape</productname>
1247+
seems to offer the best quality for <acronym>HTML</acronym> to
1248+
text conversions (over <application>lynx</application> and
1249+
<application>w3m</application>).
1250+
</para>
1251+
1252+
<para>
1253+
The file <filename>HISTORY</filename> can be created similarly,
1254+
using the command <userinput>gmake HISTORY</userinput>. The table
1255+
of contents should be removed manually from the resulting text
1256+
file.
1257+
</para>
1258+
1259+
<para>
1260+
Since it does not change very often, the generation of the file
1261+
<filename>src/test/regress/README</filename> is not fully
1262+
automated. After building the <acronym>HTML</acronym> version of
1263+
the <citetitle>Administrator's Guide</citetitle>, convert the
1264+
resulting files <filename>regress.htm</filename> and
1265+
<filename>regress-platform.htm</filename> to text, using
1266+
<productname>Netscape</productname>. Then paste the text files
1267+
together and edit them to taste (e.g., remove the navigation
1268+
bars, remove the references to other chapters).
1269+
</para>
1270+
1271+
<!--
1272+
* This is how you can create text files via RTF and ApplixWare,
1273+
* for historical reference.
1274+
1275+
<procedure>
1276+
<title>Plain Text Generation</title>
1277+
1278+
<para>
1279+
Both <filename>INSTALL</filename> and
1280+
<filename>HISTORY</filename> are generated from existing
1281+
<acronym>SGML</acronym> sources. They are extracted from the same
1282+
intermediate <acronym>RTF</acronym> file.
1283+
</para>
1284+
1285+
<step performance="required">
1286+
<para>
1287+
Generate <acronym>RTF</acronym> by typing:
1288+
<programlisting>
1289+
% cd doc/src/sgml
1290+
% make installation.rtf
1291+
</programlisting>
1292+
</para>
1293+
</step>
1294+
1295+
<step performance="required">
1296+
<para>
1297+
Import <filename>installation.rtf</filename> into
1298+
<productname>Applix Words</productname>.
1299+
</para>
1300+
</step>
1301+
1302+
<step performance="required">
1303+
<para>
1304+
Set the page width and margins.
1305+
</para>
1306+
1307+
<substeps>
1308+
<step performance="required">
1309+
<para>
1310+
Adjust the page width in File.PageSetup to 10 inches.
1311+
</para>
1312+
</step>
1313+
1314+
<step performance="required">
1315+
<para>
1316+
Select all text.
1317+
Adjust the right margin using the ruler to 9.5 inches. This
1318+
will give a maximum column width of 79 characters, within the
1319+
80 columns upper limit goal.
1320+
</para>
1321+
</step>
1322+
</substeps>
1323+
</step>
1324+
1325+
<step performance="required">
1326+
<para>
1327+
Lop off the parts of the document which are not needed.
1328+
</para>
1329+
1330+
<para>
1331+
For <filename>INSTALL</filename>, remove all release notes from
1332+
the end of the text, except for those from the current release.
1333+
For <filename>HISTORY</filename>, remove all text up to the
1334+
release notes, preserving and modifying the title and ToC.
1335+
</para>
1336+
</step>
1337+
1338+
<step performance="required">
1339+
<para>
1340+
Export the result as "ASCII Layout".
1341+
</para>
1342+
</step>
1343+
1344+
<step performance="required">
1345+
<para>
1346+
Using emacs or vi, clean up the tabular information in
1347+
<filename>INSTALL</filename>. Remove the "mailto"
1348+
<acronym>URLs</acronym> for the porting contributors to shrink
1349+
the column heights.
1350+
</para>
1351+
</step>
1352+
</procedure>
1353+
-->
13241354

13251355
</sect2>
13261356
</sect1>
13271357

1358+
13281359
<sect1 id="doc-toolsets">
13291360
<title>Toolsets</title>
13301361

‎doc/src/sgml/installation.sgml‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.24 2000/10/16 03:25:16 momjian Exp $ -->
1+
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.25 2000/10/17 15:26:40 petere Exp $ -->
22

33
<chapter id="installation">
44
<title><![%flattext-install-include[<productname>PostgreSQL</> ]]>Installation Instructions</title>
@@ -744,20 +744,20 @@ All of PostgreSQL is successfully made. Ready to install.
744744
<para>
745745
If you want to test the newly built server before you install it,
746746
you can run the regression tests at this point. The regression
747-
tests are a test suite to verify that <productname>PostgreSQL</> runs on your machine
748-
in the way the developers expected it to. Type
747+
tests are a test suite to verify that <productname>PostgreSQL</>
748+
runs on your machine in the way the developers expected it
749+
to. Type
749750
<screen>
750-
<userinput>gmake -C src/test/regress all runcheck</userinput>
751-
<!-- XXX How about just `gmake check'? -->
751+
<userinput>gmake check</userinput>
752752
</screen>
753753
It is possible that some tests fail, due to differences in error
754-
message wording or floating point results. The file
755-
<filename>src/test/regress/README</> and
756-
<![%flattext-install-include[the <citetitle>Administrator's Guide</citetitle>]]>
757-
<![%flattext-install-ignore[<xref linkend="regress">]]>
758-
contain detailed
759-
information about interpreting the test results. You can repeat
760-
this test at any later time by issuing the same command.
754+
message wording or floating point results.
755+
<![%flattext-install-include[The file
756+
<filename>src/test/regress/README</> and the
757+
<citetitle>Administrator's Guide</citetitle> contain]]>
758+
<![%flattext-install-ignore[<xref linkend="regress"> contains]]>
759+
detailed information about interpreting the test results. You can
760+
repeat this test at any later time by issuing the same command.
761761
</para>
762762
</step>
763763

0 commit comments

Comments
 (0)