Skip to content

Commit 79ba540

Browse files
author
Neil Conway
committed
Various fixes for the SGML docs. Consistently use spaces before/after
parentheses in syntax descriptions. Consistently use the present tense when describing the basic purpose of each "DROP" command. Add a few more hyperlinks.
1 parent 178214d commit 79ba540

15 files changed

+49
-47
lines changed

‎doc/src/sgml/catalogs.sgml

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/catalogs.sgml,v 2.151 2007/05/11 17:57:11 tgl Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/catalogs.sgml,v 2.152 2007/05/15 19:13:54 neilc Exp $ -->
22
<!--
33
Documentation of the system catalogs, directed toward PostgreSQL developers
44
-->
@@ -3984,12 +3984,13 @@
39843984
</indexterm>
39853985

39863986
<para>
3987-
The catalog <structname>pg_statistic</structname> stores statistical data
3988-
about the contents of the database. Entries are created by
3989-
<command>ANALYZE</command> and subsequently used by the query planner.
3990-
There is one entry for each table column that has been analyzed.
3991-
Note that all the statistical data is inherently approximate,
3992-
even assuming that it is up-to-date.
3987+
The catalog <structname>pg_statistic</structname> stores
3988+
statistical data about the contents of the database. Entries are
3989+
created by <xref linkend="sql-analyze" endterm="sql-analyze-title">
3990+
and subsequently used by the query planner. There is one entry for
3991+
each table column that has been analyzed. Note that all the
3992+
statistical data is inherently approximate, even assuming that it
3993+
is up-to-date.
39933994
</para>
39943995

39953996
<para>

‎doc/src/sgml/ref/alter_index.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_index.sgml,v 1.12 2007/01/31 23:26:02 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_index.sgml,v 1.13 2007/05/15 19:13:54 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -109,7 +109,7 @@ ALTER INDEX <replaceable class="PARAMETER">name</replaceable> RESET ( <replaceab
109109
<term><replaceable class="PARAMETER">new_name</replaceable></term>
110110
<listitem>
111111
<para>
112-
New name for the index.
112+
The new name for the index.
113113
</para>
114114
</listitem>
115115
</varlistentry>

‎doc/src/sgml/ref/analyze.sgml

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/analyze.sgml,v 1.21 2007/01/31 23:26:02 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/analyze.sgml,v 1.22 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -20,7 +20,7 @@ PostgreSQL documentation
2020

2121
<refsynopsisdiv>
2222
<synopsis>
23-
ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<replaceable class="PARAMETER">column</replaceable> [, ...] ) ] ]
23+
ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ ( <replaceable class="PARAMETER">column</replaceable> [, ...] ) ] ]
2424
</synopsis>
2525
</refsynopsisdiv>
2626

@@ -29,10 +29,11 @@ ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<rep
2929

3030
<para>
3131
<command>ANALYZE</command> collects statistics about the contents
32-
of tables in the database, and stores the results in the system
33-
table <literal>pg_statistic</literal>. Subsequently, the query
34-
planner uses these statistics to help determine the most efficient
35-
execution plans for queries.
32+
of tables in the database, and stores the results in the <link
33+
linkend="catalog-pg-statistic"><structname>pg_statistic</></>
34+
system catalog. Subsequently, the query planner uses these
35+
statistics to help determine the most efficient execution plans for
36+
queries.
3637
</para>
3738

3839
<para>
@@ -125,7 +126,7 @@ ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<rep
125126
will change slightly each time <command>ANALYZE</command> is run,
126127
even if the actual table contents did not change. This might result
127128
in small changes in the planner's estimated costs shown by
128-
<command>EXPLAIN</command>. In rare situations, this
129+
<xref linkend="sql-explain" endterm="sql-explain-title">. In rare situations, this
129130
non-determinism will cause the query optimizer to choose a
130131
different query plan between runs of <command>ANALYZE</command>. To
131132
avoid this, raise the amount of statistics collected by

‎doc/src/sgml/ref/close.sgml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/close.sgml,v 1.25 2007/04/12 06:53:45 neilc Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/close.sgml,v 1.26 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -88,8 +88,8 @@ CLOSE { <replaceable class="PARAMETER">name</replaceable> | ALL }
8888
</para>
8989

9090
<para>
91-
You can see all available cursors by querying the
92-
<structname>pg_cursors</structname> system view.
91+
You can see all available cursors by querying the <link
92+
linkend="view-pg-cursors"><structname>pg_cursors</></> system view.
9393
</para>
9494
</refsect1>
9595

‎doc/src/sgml/ref/drop_aggregate.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.30 2006/09/16 00:30:18 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.31 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -28,7 +28,7 @@ DROP AGGREGATE [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> (
2828
<title>Description</title>
2929

3030
<para>
31-
<command>DROP AGGREGATE</command> will delete an existing
31+
<command>DROP AGGREGATE</command> removes an existing
3232
aggregate function. To execute this command the current
3333
user must be the owner of the aggregate function.
3434
</para>

‎doc/src/sgml/ref/drop_domain.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_domain.sgml,v 1.17 2006/09/16 00:30:18 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_domain.sgml,v 1.18 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -20,16 +20,16 @@ PostgreSQL documentation
2020

2121
<refsynopsisdiv>
2222
<synopsis>
23-
DROP DOMAIN [IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
23+
DROP DOMAIN [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
2424
</synopsis>
2525
</refsynopsisdiv>
2626

2727
<refsect1>
2828
<title>Description</title>
2929

3030
<para>
31-
<command>DROP DOMAIN</command> will remove a domain. Only the
32-
owner of a domain can remove it.
31+
<command>DROP DOMAIN</command> removes a domain. Only the owner of
32+
a domain can remove it.
3333
</para>
3434
</refsect1>
3535

‎doc/src/sgml/ref/drop_language.sgml

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_language.sgml,v 1.25 2007/03/26 16:58:38 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_language.sgml,v 1.26 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -28,11 +28,9 @@ DROP [ PROCEDURAL ] LANGUAGE [ IF EXISTS ] <replaceable class="PARAMETER">name</
2828
<title>Description</title>
2929

3030
<para>
31-
<command>DROP LANGUAGE</command> will remove the definition
32-
of the previously registered procedural language called
33-
<replaceable class="parameter">name</replaceable>.
34-
You must be superuser or owner of the language to
35-
use <command>DROP LANGUAGE</command>.
31+
<command>DROP LANGUAGE</command> removes the definition of a
32+
previously registered procedural language. You must be a superuser
33+
or the owner of the language to use <command>DROP LANGUAGE</>.
3634
</para>
3735
</refsect1>
3836

‎doc/src/sgml/ref/drop_sequence.sgml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_sequence.sgml,v 1.26 2006/09/16 00:30:18 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_sequence.sgml,v 1.27 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -28,7 +28,8 @@ DROP SEQUENCE [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [,
2828
<title>Description</title>
2929

3030
<para>
31-
<command>DROP SEQUENCE</command> removes sequence number generators.
31+
<command>DROP SEQUENCE</command> removes sequence number
32+
generators. A sequence can only be dropped by its owner or a superuser.
3233
</para>
3334
</refsect1>
3435

‎doc/src/sgml/ref/drop_table.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_table.sgml,v 1.26 2007/01/31 23:26:03 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_table.sgml,v 1.27 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -29,7 +29,7 @@ DROP TABLE [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [, ..
2929

3030
<para>
3131
<command>DROP TABLE</command> removes tables from the database.
32-
Only its owner can destroy a table. To empty a table of rows
32+
Only its owner can drop a table. To empty a table of rows
3333
without destroying the table, use <xref linkend="sql-delete"
3434
endterm="sql-delete-title"> or <xref linkend="sql-truncate"
3535
endterm="sql-truncate-title">.

‎doc/src/sgml/ref/drop_trigger.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_trigger.sgml,v 1.21 2006/09/16 00:30:18 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_trigger.sgml,v 1.22 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -28,7 +28,7 @@ DROP TRIGGER [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> ON
2828
<title>Description</title>
2929

3030
<para>
31-
<command>DROP TRIGGER</command> will remove an existing
31+
<command>DROP TRIGGER</command> removes an existing
3232
trigger definition. To execute this command, the current
3333
user must be the owner of the table for which the trigger is defined.
3434
</para>

‎doc/src/sgml/ref/drop_type.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_type.sgml,v 1.29 2006/10/23 18:10:32 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_type.sgml,v 1.30 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -28,7 +28,7 @@ DROP TYPE [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [, ...
2828
<title>Description</title>
2929

3030
<para>
31-
<command>DROP TYPE</command> will remove a user-defined data type.
31+
<command>DROP TYPE</command> removes a user-defined data type.
3232
Only the owner of a type can remove it.
3333
</para>
3434
</refsect1>

‎doc/src/sgml/ref/execute.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/execute.sgml,v 1.14 2006/09/16 00:30:18 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/execute.sgml,v 1.15 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -25,7 +25,7 @@ PostgreSQL documentation
2525

2626
<refsynopsisdiv>
2727
<synopsis>
28-
EXECUTE <replaceable class="PARAMETER">name</replaceable> [ (<replaceable class="PARAMETER">parameter</replaceable> [, ...] ) ]
28+
EXECUTE <replaceable class="PARAMETER">name</replaceable> [ ( <replaceable class="PARAMETER">parameter</replaceable> [, ...] ) ]
2929
</synopsis>
3030
</refsynopsisdiv>
3131

‎doc/src/sgml/ref/pg_restore.sgml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.70 2007/03/26 17:23:37 tgl Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.71 2007/05/15 19:13:55 neilc Exp $ -->
22

33
<refentry id="APP-PGRESTORE">
44
<refmeta>
@@ -11,7 +11,8 @@
1111
<refname>pg_restore</refname>
1212

1313
<refpurpose>
14-
restore a <productname>PostgreSQL</productname> database from an archive file created by pg_dump
14+
restore a <productname>PostgreSQL</productname> database from an
15+
archive file created by <application>pg_dump</application>
1516
</refpurpose>
1617
</refnamediv>
1718

‎doc/src/sgml/ref/prepare.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/prepare.sgml,v 1.22 2007/01/31 23:26:04 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/prepare.sgml,v 1.23 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -25,7 +25,7 @@ PostgreSQL documentation
2525

2626
<refsynopsisdiv>
2727
<synopsis>
28-
PREPARE <replaceable class="PARAMETER">name</replaceable> [ (<replaceable class="PARAMETER">datatype</replaceable> [, ...] ) ] AS <replaceable class="PARAMETER">statement</replaceable>
28+
PREPARE <replaceable class="PARAMETER">name</replaceable> [ ( <replaceable class="PARAMETER">datatype</replaceable> [, ...] ) ] AS <replaceable class="PARAMETER">statement</replaceable>
2929
</synopsis>
3030
</refsynopsisdiv>
3131

‎doc/src/sgml/ref/select.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/select.sgml,v 1.99 2007/02/01 19:10:25 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/select.sgml,v 1.100 2007/05/15 19:13:55 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -354,7 +354,7 @@ where <replaceable class="parameter">from_item</replaceable> can be one of:
354354
</varlistentry>
355355

356356
<varlistentry>
357-
<term><literal>USING (<replaceable class="parameter">join_column</replaceable> [, ...])</literal></term>
357+
<term><literal>USING ( <replaceable class="parameter">join_column</replaceable> [, ...] )</literal></term>
358358
<listitem>
359359
<para>
360360
A clause of the form <literal>USING ( a, b, ... )</literal> is

0 commit comments

Comments
 (0)