Skip to content

Commit be2b660

Browse files
bmomjianbmomjian
committed
This patch includes a lot of minor cleanups to the SGML documentation,
including: - replacing all the appropriate usages of <citetitle>PostgreSQL ...</citetitle> with &cite-user;, &cite-admin;, and so on - fix an omission in the EXECUTE documentation - add some more text to the EXPLAIN documentation - improve the PL/PgSQL RETURN NEXT documentation (more work to do here) - minor markup fixes Neil Conway
1 parent 2042daf commit be2b660

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+560
-472
lines changed

‎doc/src/sgml/arch-dev.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/arch-dev.sgml,v 2.16 2001/11/21 05:53:40 thomas Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/arch-dev.sgml,v 2.17 2003/01/19 00:13:28 momjian Exp $
33
-->
44

55
<chapter id="overview">
@@ -478,8 +478,8 @@ current context are performed.
478478

479479
<para>
480480
For information on the syntax and creation of rules in the
481-
<productname>PostgreSQL</productname> system refer to
482-
<citetitle>The PostgreSQL User's Guide</citetitle>.
481+
<productname>PostgreSQL</productname> system refer to the
482+
&cite-user;.
483483
</para>
484484

485485
<sect2>

‎doc/src/sgml/catalogs.sgml

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!--
22
Documentation of the system catalogs, directed toward PostgreSQL developers
3-
$Header: /cvsroot/pgsql/doc/src/sgml/catalogs.sgml,v 2.64 2002/12/17 17:41:30 momjian Exp $
3+
$Header: /cvsroot/pgsql/doc/src/sgml/catalogs.sgml,v 2.65 2003/01/19 00:13:28 momjian Exp $
44
-->
55

66
<chapter id="catalogs">
@@ -288,9 +288,9 @@
288288

289289
<para>
290290
New aggregate functions are registered with the <command>CREATE
291-
AGGREGATE</command> command. See the <citetitle>Programmer's
292-
Guide</citetitle> for more information about writing aggregate
293-
functions and the meaning of the transition functions, etc.
291+
AGGREGATE</command> command. See the &cite-programmer; for more
292+
information about writing aggregate functions and the meaning of
293+
the transition functions, etc.
294294
</para>
295295

296296
</sect1>
@@ -1446,8 +1446,8 @@
14461446
The <structname>pg_database</structname> catalog stores information
14471447
about the available databases. Databases are created with the
14481448
<command>CREATE DATABASE</command> command. Consult the
1449-
<citetitle>Administrator's Guide</citetitle> for details about the
1450-
meaning of some of the parameters.
1449+
&cite-admin; for details about the meaning of some of the
1450+
parameters.
14511451
</para>
14521452

14531453
<para>
@@ -1791,8 +1791,8 @@
17911791
<para>
17921792
This catalog defines groups and stores what users belong to what
17931793
groups. Groups are created with the <command>CREATE
1794-
GROUP</command> command. Consult the <citetitle>Administrator's
1795-
Guide</citetitle> for information about user permission management.
1794+
GROUP</command> command. Consult the &cite-admin; for information
1795+
about user permission management.
17961796
</para>
17971797

17981798
<para>
@@ -2022,8 +2022,7 @@
20222022
<structname>pg_language</structname> registers call interfaces or
20232023
languages in which you can write functions or stored procedures.
20242024
See under <command>CREATE LANGUAGE</command> and in the
2025-
<citetitle>Programmer's Guide</citetitle> for more information
2026-
about language handlers.
2025+
&cite-programmer; for more information about language handlers.
20272026
</para>
20282027

20292028
<table>
@@ -2298,8 +2297,7 @@
22982297
</para>
22992298

23002299
<para>
2301-
Operator classes are described at length in the
2302-
<citetitle>Programmer's Guide</citetitle>.
2300+
Operator classes are described at length in the &cite-programmer;.
23032301
</para>
23042302

23052303
<table>
@@ -2387,9 +2385,8 @@
23872385
<title>pg_operator</title>
23882386

23892387
<para>
2390-
See <command>CREATE OPERATOR</command> and the
2391-
<citetitle>Programmer's Guide</citetitle> for details on these
2392-
operator parameters.
2388+
See <command>CREATE OPERATOR</command> and the &cite-programmer;
2389+
for details on these operator parameters.
23932390
</para>
23942391

23952392
<table>
@@ -2559,8 +2556,8 @@
25592556
<para>
25602557
This catalog stores information about functions (or procedures).
25612558
The description of <command>CREATE FUNCTION</command> and the
2562-
<citetitle>Programmer's Guide</citetitle> contain more information
2563-
about the meaning of some fields.
2559+
&cite-programmer; contain more information about the meaning of
2560+
some fields.
25642561
</para>
25652562

25662563
<para>
@@ -2832,8 +2829,8 @@
28322829
</para>
28332830

28342831
<para>
2835-
The <citetitle>Administrator's Guide</citetitle> contains detailed
2836-
information about user and permission management.
2832+
The &cite-admin; contains detailed information about user and
2833+
permission management.
28372834
</para>
28382835

28392836
<para>

‎doc/src/sgml/charset.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/charset.sgml,v 2.30 2002/11/15 03:11:15 momjian Exp $ -->
1+
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/charset.sgml,v 2.31 2003/01/19 00:13:28 momjian Exp $ -->
22

33
<chapter id="charset">
44
<title>Localization</>
@@ -309,8 +309,8 @@ perl: warning: Falling back to the standard locale ("C").
309309
<productname>PostgreSQL</> speak their preferred language well.
310310
If messages in your language is currently not available or fully
311311
translated, your assistance would be appreciated. If you want to
312-
help, refer to the <citetitle>Developer's Guide</> or write to the
313-
developers' mailing list.
312+
help, refer to the &cite-developer; or write to the developers'
313+
mailing list.
314314
</para>
315315
</sect2>
316316
</sect1>

‎doc/src/sgml/client-auth.sgml

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/client-auth.sgml,v 1.43 2003/01/06 03:18:26 momjian Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/client-auth.sgml,v 1.44 2003/01/19 00:13:28 momjian Exp $
33
-->
44

55
<chapter id="client-authentication">
@@ -110,8 +110,7 @@ hostssl <replaceable>database</replaceable> <replaceable>user</replaceable> <
110110
This record matches connection attempts using TCP/IP networks.
111111
Note that TCP/IP connections are disabled unless the server is
112112
started with the <option>-i</option> option or the
113-
<literal>tcpip_socket</> <filename>postgresql.conf</>
114-
configuration parameter is enabled.
113+
<varname>tcpip_socket</> configuration parameter is enabled.
115114
</para>
116115
</listitem>
117116
</varlistentry>
@@ -129,9 +128,8 @@ hostssl <replaceable>database</replaceable> <replaceable>user</replaceable> <
129128
<para>
130129
To be able make use of this option the server must be built
131130
with SSL support enabled. Furthermore, SSL must be enabled by
132-
enabling the option <literal>ssl</literal> in
133-
<filename>postgresql.conf</filename> (see <xref
134-
linkend="runtime-config">).
131+
enabling the <varname>ssl</varname> configuration parameter
132+
(see <xref linkend="runtime-config"> for more information).
135133
</para>
136134
</listitem>
137135
</varlistentry>
@@ -191,8 +189,8 @@ hostssl <replaceable>database</replaceable> <replaceable>user</replaceable> <
191189
must be zero for the record to match. (Of course IP addresses
192190
can be spoofed but this consideration is beyond the scope of
193191
<productname>PostgreSQL</productname>.) If you machine supports
194-
IPv6, the default <filename>pg_hba.conf</> will have an IPv6
195-
entry for <literal>localhost</>. You can add your own IPv6
192+
IPv6, the default <filename>pg_hba.conf</> file will have an
193+
IPv6 entry for <literal>localhost</>. You can add your own IPv6
196194
entries to the file. IPv6 entries are used only for IPv6
197195
connections.
198196
</para>
@@ -486,17 +484,18 @@ local db1,db2,@demodbs all md5
486484
</para>
487485

488486
<para>
489-
<literal>trust</> authentication is appropriate and very convenient
490-
for local connections on a single-user workstation. It is usually
491-
<emphasis>not</> appropriate by itself on a multiuser machine.
492-
However, you may be able to use <literal>trust</> even on a multiuser
493-
machine, if you restrict access to the postmaster's socket file using
494-
file-system permissions. To do this, set the parameter
487+
<literal>trust</> authentication is appropriate and very
488+
convenient for local connections on a single-user workstation. It
489+
is usually <emphasis>not</> appropriate by itself on a multiuser
490+
machine. However, you may be able to use <literal>trust</> even
491+
on a multiuser machine, if you restrict access to the postmaster's
492+
socket file using file-system permissions. To do this, set the
495493
<varname>unix_socket_permissions</varname> (and possibly
496-
<varname>unix_socket_group</varname>) in <filename>postgresql.conf</>,
497-
as described in <xref linkend="runtime-config-general">. Or you could
498-
set <varname>unix_socket_directory</varname> to place the socket file
499-
in a suitably restricted directory.
494+
<varname>unix_socket_group</varname>) configuration parameters as
495+
described in <xref linkend="runtime-config-general">. Or you
496+
could set the <varname>unix_socket_directory</varname>
497+
configuration parameter to place the socket file in a suitably
498+
restricted directory.
500499
</para>
501500

502501
<para>

‎doc/src/sgml/dfunc.sgml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/dfunc.sgml,v 1.22 2002/09/21 18:32:52 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/dfunc.sgml,v 1.23 2003/01/19 00:13:28 momjian Exp $
33
-->
44

55
<sect2 id="dfunc">
@@ -318,9 +318,8 @@ ld <other flags> -H512 -T512 -o foo.so -e _nostart \e
318318
-bI:.../lib/postgres.exp -bE:foo.exp foo.o \e
319319
-lm -lc 2>/dev/null
320320
.fi
321-
You should look at the <citetitle>PostgreSQL User's Manual</>
322-
for an explanation of this
323-
procedure.
321+
You should look at the &cite-user; for an explanation of
322+
this procedure.
324323

325324
-->
326325

‎doc/src/sgml/ecpg.sgml

Lines changed: 2 additions & 2 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.40 2002/11/15 03:11:16 momjian Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.41 2003/01/19 00:13:28 momjian Exp $
33
-->
44

55
<chapter id="ecpg">
@@ -879,7 +879,7 @@ ECPG = ecpg
879879
FETCH <optional><replaceable>direction</></> <optional><replaceable>amount</></> IN|FROM <replaceable>cursor</replaceable>
880880
</synopsis>
881881
<indexterm><primary>Oracle</></>
882-
<application>Oracle</application>, however, does not use the
882+
<productname>Oracle</productname>, however, does not use the
883883
keywords <literal>IN</literal> or <literal>FROM</literal>. This
884884
feature cannot be added since it would create parsing conflicts.
885885
</para>

‎doc/src/sgml/extend.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/extend.sgml,v 1.18 2002/11/03 01:31:32 momjian Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.19 2003/01/19 00:13:28 momjian Exp $
33
-->
44

55
<chapter id="extend">
@@ -214,8 +214,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.18 2002/11/03 01:31:32 momj
214214
</mediaobject>
215215
</figure>
216216

217-
The <citetitle>Developer's Guide</citetitle> gives a more detailed explanation
218-
of these catalogs and their columns. However,
217+
The &cite-developer; gives a more detailed explanation of these
218+
catalogs and their columns. However,
219219
<xref linkend="EXTEND-CATALOGS">
220220
shows the major entities and their relationships
221221
in the system catalogs. (Columns that do not refer

‎doc/src/sgml/history.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/history.sgml,v 1.19 2002/01/07 02:29:12 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/history.sgml,v 1.20 2003/01/19 00:13:28 momjian Exp $
33
-->
44

55
<sect1 id="history">
6-
<title>A Short History of <productname>PostgreSQL</productname></title>
6+
<title>A Brief History of <productname>PostgreSQL</productname></title>
77

88
<para>
99
The object-relational database management system now known as
@@ -54,7 +54,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/history.sgml,v 1.19 2002/01/07 02:29:12 pet
5454
released in June 1990 with the new rule system.
5555
Version 3 appeared in 1991 and added support for multiple
5656
storage managers, an improved query executor, and a
57-
rewritten rewrite rule system. For the most part, subsequent
57+
rewritten rule system. For the most part, subsequent
5858
releases until <productname>Postgres95</productname> (see below)
5959
focused on portability and reliability.
6060
</para>

‎doc/src/sgml/info.sgml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.17 2002/11/15 03:11:16 momjian Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.18 2003/01/19 00:13:28 momjian Exp $
33
-->
44

55
<sect1 id="resources">
@@ -71,8 +71,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.17 2002/11/15 03:11:16 momjia
7171
Information for <productname>PostgreSQL</productname>
7272
developers. This is intended for those who are contributing to
7373
the <productname>PostgreSQL</productname> project; application
74-
development information appears in the <citetitle>Programmer's
75-
Guide</citetitle>.
74+
development information appears in the &cite-programmer;.
7675
</para>
7776
</listitem>
7877
</varlistentry>
@@ -88,8 +87,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.17 2002/11/15 03:11:16 momjia
8887
<term>man pages</term>
8988
<listitem>
9089
<para>
91-
The <citetitle>Reference Manual</citetitle>'s pages in the
92-
traditional Unix man format. There is no difference in content.
90+
The &cite-reference;'s pages in the traditional Unix man
91+
format. There is no difference in content.
9392
</para>
9493
</listitem>
9594
</varlistentry>

‎doc/src/sgml/installation.sgml

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.127 2002/12/11 22:27:26 momjian Exp $ -->
1+
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.128 2003/01/19 00:13:28 momjian Exp $ -->
22

33
<chapter id="installation">
44
<title><![%standalone-include[<productname>PostgreSQL</>]]>
@@ -656,8 +656,8 @@ JAVACMD=$JAVA_HOME/bin/java
656656
internal header files and the server header files are installed
657657
into private directories under
658658
<varname>includedir</varname>.
659-
See the <citetitle>Programmer's Guide</citetitle> for
660-
information about how to get at the header files for each interface.
659+
See the &cite-programmer; for information about how to get at
660+
the header files for each interface.
661661
Finally, a private subdirectory will also be created, if appropriate,
662662
under <varname>libdir</varname> for dynamically loadable modules.
663663
</para>
@@ -1311,8 +1311,7 @@ export MANPATH
13111311

13121312
<para>
13131313
The following is a quick summary of how to get <productname>PostgreSQL</> up and
1314-
running once installed. The <citetitle>Administrator's Guide</>
1315-
contains more information.
1314+
running once installed. The &cite-admin; contains more information.
13161315
</para>
13171316

13181317
<procedure>
@@ -1418,21 +1417,19 @@ kill `cat /usr/local/pgsql/data/postmaster.pid`
14181417
</para>
14191418

14201419
<para>
1421-
The <citetitle>Tutorial</> should be your first reading if you
1422-
are completely new to <acronym>SQL</> databases.
1423-
If you are familiar with database concepts then you want to
1424-
proceed with the <citetitle>Administrator's Guide</citetitle>,
1425-
which contains information about how to set up the database
1426-
server, database users, and authentication.
1420+
The &cite-tutorial; should be your first reading if you are
1421+
completely new to <acronym>SQL</> databases. If you are
1422+
familiar with database concepts then you want to proceed with
1423+
the &cite-admin;, which contains information about how to set up
1424+
the database server, database users, and authentication.
14271425
</para>
14281426
</listitem>
14291427

14301428
<listitem>
14311429
<para>
14321430
Usually, you will want to modify your computer so that it will
14331431
automatically start the database server whenever it boots. Some
1434-
suggestions for this are in the <citetitle>Administrator's
1435-
Guide</citetitle>.
1432+
suggestions for this are in the &cite-admin;.
14361433
</para>
14371434
</listitem>
14381435

@@ -1441,7 +1438,7 @@ kill `cat /usr/local/pgsql/data/postmaster.pid`
14411438
Run the regression tests against the installed server (using the
14421439
sequential test method). If you didn't run the tests before
14431440
installation, you should definitely do it now. This is also
1444-
explained in the <citetitle>Administrator's Guide</citetitle>.
1441+
explained in the &cite-admin;.
14451442
</para>
14461443
</listitem>
14471444

‎doc/src/sgml/jdbc.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.41 2002/11/15 03:11:16 momjian Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.42 2003/01/19 00:13:28 momjian Exp $
33
-->
44

55
<chapter id="jdbc">
@@ -124,9 +124,9 @@ java Finder
124124
<para>
125125
Also, the client authentication setup in the
126126
<filename>pg_hba.conf</filename> file may need to be configured.
127-
Refer to the <citetitle>Administrator's Guide</citetitle> for
128-
details. The <acronym>JDBC</acronym> Driver supports the trust,
129-
ident, password, md5, and crypt authentication methods.
127+
Refer to the &cite-admin; for details. The
128+
<acronym>JDBC</acronym> Driver supports the trust, ident,
129+
password, md5, and crypt authentication methods.
130130
</para>
131131
</sect2>
132132
</sect1>

0 commit comments

Comments
 (0)