Skip to content

Commit 2a5b6a7

Browse files
bmomjianbmomjian
committed
This patch fixes a few missed GUC variables that were still upper case,
makes a few more small improvements to runtime.sgml, and makes some SGML conventions more consistent. Neil Conway
1 parent 3d48045 commit 2a5b6a7

32 files changed

+336
-295
lines changed

‎doc/src/sgml/docguide.sgml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.44 2003/06/06 14:17:08 petere Exp $ -->
1+
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.45 2003/09/11 21:42:19 momjian Exp $ -->
22

33
<appendix id="docguide">
44
<title>Documentation</title>
@@ -497,8 +497,9 @@ CATALOG "docbook-dsssl--1.<replaceable>xx</>/catalog
497497
<para>
498498
Before you can build the documentation you need to run the
499499
<filename>configure</filename> script as you would when building
500-
the PostgreSQL programs themselves. Check the output near the end
501-
of the run, it should look something like this:
500+
the <productname>PostgreSQL</productname> programs themselves.
501+
Check the output near the end of the run, it should look something
502+
like this:
502503
<screen>
503504
<computeroutput>
504505
checking for onsgmls... onsgmls
@@ -640,7 +641,7 @@ gmake man.tar.gz
640641
<title>Print Output via <acronym>RTF</acronym></title>
641642

642643
<para>
643-
You can also create a printable version of the PostgreSQL
644+
You can also create a printable version of the <productname>PostgreSQL</productname>
644645
documentation by converting it to <acronym>RTF</acronym> and
645646
applying minor formatting corrections using an office suite.
646647
Depending on the capabilities of the particular office suite, you
@@ -651,7 +652,7 @@ gmake man.tar.gz
651652

652653
<note>
653654
<para>
654-
It appears that current versions of the PostgreSQL documentation
655+
It appears that current versions of the <productname>PostgreSQL</productname> documentation
655656
trigger some bug in or exceed the size limit of OpenJade. If the
656657
build process of the <acronym>RTF</acronym> version hangs for a
657658
long time and the output file still has size 0, then you may have

‎doc/src/sgml/ecpg.sgml

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.50 2003/09/09 10:54:44 meskes Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.51 2003/09/11 21:42:19 momjian Exp $
33
-->
44

55
<chapter id="ecpg">
@@ -1153,10 +1153,11 @@ struct
11531153
condition. A successful state is indicated by the code
11541154
<literal>00000</literal>. Further information about the codes can
11551155
be found XXX. The <literal>SQLSTATE</literal> codes are for the
1156-
most part defined in the SQL standard. The PostgreSQL server
1157-
natively supports <literal>SQLSTATE</literal> error codes;
1158-
therefore a high degree of consistency can be achieved by using
1159-
this error code scheme throughout all applications.
1156+
most part defined in the SQL standard. The
1157+
<productname>PostgreSQL</productname> server natively supports
1158+
<literal>SQLSTATE</literal> error codes; therefore a high degree
1159+
of consistency can be achieved by using this error code scheme
1160+
throughout all applications.
11601161
</para>
11611162

11621163
<para>
@@ -1168,11 +1169,11 @@ struct
11681169
affected zero rows, and no specific negative values. Therefore,
11691170
this scheme can only achieve poor portability and does not have a
11701171
hierarchical code assignment. Historically, the embedded SQL
1171-
processor for PostgreSQL has assigned some specific
1172-
<literal>SQLCODE</literal> values for its use, which are listed
1173-
below with their numeric value and their symbolic name. Remember
1174-
that these are not portable to other SQL implementations. To
1175-
simplify the porting of applications to the
1172+
processor for <productname>PostgreSQL</productname> has assigned
1173+
some specific <literal>SQLCODE</literal> values for its use, which
1174+
are listed below with their numeric value and their symbolic name.
1175+
Remember that these are not portable to other SQL implementations.
1176+
To simplify the porting of applications to the
11761177
<literal>SQLSTATE</literal> scheme, the corresponding
11771178
<literal>SQLSTATE</literal> is also listed. There is, however, no
11781179
one-to-one or one-to-many mapping between the two schemes (indeed
@@ -1291,9 +1292,10 @@ struct
12911292
<term>-208 (<symbol>ECPG_EMPTY</symbol>)</term>
12921293
<listitem>
12931294
<para>
1294-
The statement sent to the PostgreSQL server was empty. (This
1295-
cannot normally happen in an embedded SQL program, so it may
1296-
point to an internal error.) (SQLSTATE YE002)
1295+
The statement sent to the <productname>PostgreSQL</productname>
1296+
server was empty. (This cannot normally happen in an embedded
1297+
SQL program, so it may point to an internal error.) (SQLSTATE
1298+
YE002)
12971299
</para>
12981300
</listitem>
12991301
</varlistentry>

‎doc/src/sgml/extend.sgml

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.24 2003/08/31 17:32:18 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.25 2003/09/11 21:42:19 momjian Exp $
33
-->
44

55
<chapter id="extend">
@@ -69,14 +69,16 @@ $Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.24 2003/08/31 17:32:18 pete
6969
</para>
7070

7171
<para>
72-
The PostgreSQL server can moreover incorporate user-written code into
73-
itself through dynamic loading. That is, the user can
74-
specify an object code file (e.g., a shared library) that implements a new type or function,
75-
and <productname>PostgreSQL</productname> will load it as required. Code written
76-
in <acronym>SQL</acronym> is even more trivial to add to the server.
77-
This ability to modify its operation <quote>on the fly</quote> makes
78-
<productname>PostgreSQL</productname> uniquely suited for rapid prototyping of new
79-
applications and storage structures.
72+
The <productname>PostgreSQL</productname> server can moreover
73+
incorporate user-written code into itself through dynamic loading.
74+
That is, the user can specify an object code file (e.g., a shared
75+
library) that implements a new type or function, and
76+
<productname>PostgreSQL</productname> will load it as required.
77+
Code written in <acronym>SQL</acronym> is even more trivial to add
78+
to the server. This ability to modify its operation <quote>on the
79+
fly</quote> makes <productname>PostgreSQL</productname> uniquely
80+
suited for rapid prototyping of new applications and storage
81+
structures.
8082
</para>
8183
</sect1>
8284

‎doc/src/sgml/features.sgml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/features.sgml,v 2.18 2003/03/13 01:30:28 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/features.sgml,v 2.19 2003/09/11 21:42:19 momjian Exp $
33
-->
44

55
<appendix id="features">
@@ -63,11 +63,12 @@ $Header: /cvsroot/pgsql/doc/src/sgml/features.sgml,v 2.18 2003/03/13 01:30:28 pe
6363
In the following two sections, we provide a list of those features
6464
that <productname>PostgreSQL</productname> supports, followed by a
6565
list of the features defined in SQL99 which are not yet supported in
66-
PostgreSQL. Both of these lists are approximate: There may be minor
67-
details that are nonconforming for a feature that is listed as
68-
supported, and large parts of an unsupported feature may in fact be
69-
implemented. The main body of the documentation always contains the
70-
most accurate information about what does and does not work.
66+
<productname>PostgreSQL</productname>. Both of these lists are
67+
approximate: There may be minor details that are nonconforming for a
68+
feature that is listed as supported, and large parts of an
69+
unsupported feature may in fact be implemented. The main body of
70+
the documentation always contains the most accurate information
71+
about what does and does not work.
7172
</para>
7273

7374
<note>

‎doc/src/sgml/history.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/history.sgml,v 1.21 2003/09/08 23:02:28 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/history.sgml,v 1.22 2003/09/11 21:42:19 momjian Exp $
33
-->
44

55
<sect1 id="history">
@@ -206,8 +206,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/history.sgml,v 1.21 2003/09/08 23:02:28 pet
206206
</para>
207207

208208
<para>
209-
Details about what has happened in PostgreSQL since then can be
210-
found in <xref linkend="release">.
209+
Details about what has happened in <productname>PostgreSQL</> since
210+
then can be found in <xref linkend="release">.
211211
</para>
212212
</sect2>
213213
</sect1>

‎doc/src/sgml/indices.sgml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/indices.sgml,v 1.43 2003/08/31 17:32:19 petere Exp $ -->
1+
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/indices.sgml,v 1.44 2003/09/11 21:42:19 momjian Exp $ -->
22

33
<chapter id="indexes">
44
<title id="indexes-title">Indexes</title>
@@ -194,11 +194,11 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable>
194194
</synopsis>
195195
<note>
196196
<para>
197-
Testing has shown PostgreSQL's hash indexes to be similar or slower
198-
than B-tree indexes, and the index size and build time for hash
199-
indexes is much worse. Hash indexes also suffer poor performance
200-
under high concurrency. For these reasons, hash index use is
201-
presently discouraged.
197+
Testing has shown <productname>PostgreSQL</productname>'s hash
198+
indexes to be similar or slower than B-tree indexes, and the
199+
index size and build time for hash indexes is much worse. Hash
200+
indexes also suffer poor performance under high concurrency. For
201+
these reasons, hash index use is presently discouraged.
202202
</para>
203203
</note>
204204
</para>

0 commit comments

Comments
 (0)