Various fixes for the SGML docs. Consistently use spaces before/after
authorNeil Conway <neilc@samurai.com>
Tue, 15 May 2007 19:13:55 +0000 (19:13 +0000)
committerNeil Conway <neilc@samurai.com>
Tue, 15 May 2007 19:13:55 +0000 (19:13 +0000)
parentheses in syntax descriptions. Consistently use the present tense
when describing the basic purpose of each "DROP" command. Add a few
more hyperlinks.

15 files changed:
doc/src/sgml/catalogs.sgml
doc/src/sgml/ref/alter_index.sgml
doc/src/sgml/ref/analyze.sgml
doc/src/sgml/ref/close.sgml
doc/src/sgml/ref/drop_aggregate.sgml
doc/src/sgml/ref/drop_domain.sgml
doc/src/sgml/ref/drop_language.sgml
doc/src/sgml/ref/drop_sequence.sgml
doc/src/sgml/ref/drop_table.sgml
doc/src/sgml/ref/drop_trigger.sgml
doc/src/sgml/ref/drop_type.sgml
doc/src/sgml/ref/execute.sgml
doc/src/sgml/ref/pg_restore.sgml
doc/src/sgml/ref/prepare.sgml
doc/src/sgml/ref/select.sgml

index 51bc966f10eb6297fc8ef9df1e5f5b4e26b43702..eb787f1f22ffa783afb89750ed455a198d7379f1 100644 (file)
   </indexterm>
 
   <para>
-   The catalog <structname>pg_statistic</structname> stores statistical data
-   about the contents of the database.  Entries are created by
-   <command>ANALYZE</command> and subsequently used by the query planner.
-   There is one entry for each table column that has been analyzed.
-   Note that all the statistical data is inherently approximate,
-   even assuming that it is up-to-date.
+   The catalog <structname>pg_statistic</structname> stores
+   statistical data about the contents of the database.  Entries are
+   created by <xref linkend="sql-analyze" endterm="sql-analyze-title">
+   and subsequently used by the query planner.  There is one entry for
+   each table column that has been analyzed.  Note that all the
+   statistical data is inherently approximate, even assuming that it
+   is up-to-date.
   </para>
 
   <para>
index eb17b6f5bf34a78954925d7d29b5d23c85014a2f..01af87f62b3372a3101428d384f6660ede753674 100644 (file)
@@ -109,7 +109,7 @@ ALTER INDEX <replaceable class="PARAMETER">name</replaceable> RESET ( <replaceab
       <term><replaceable class="PARAMETER">new_name</replaceable></term>
       <listitem>
        <para>
-        New name for the index.
+        The new name for the index.
        </para>
       </listitem>
      </varlistentry>
index 0c642bf7d7aec381c50a0b137df0980f5f854a04..eff02d686ae018ae23f43fa1825a1c8745a90828 100644 (file)
@@ -20,7 +20,7 @@ PostgreSQL documentation
 
  <refsynopsisdiv>
 <synopsis>
-ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<replaceable class="PARAMETER">column</replaceable> [, ...] ) ] ]
+ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ ( <replaceable class="PARAMETER">column</replaceable> [, ...] ) ] ]
 </synopsis>
  </refsynopsisdiv>
 
@@ -29,10 +29,11 @@ ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<rep
 
   <para>
    <command>ANALYZE</command> collects statistics about the contents
-   of tables in the database, and stores the results in the system
-   table <literal>pg_statistic</literal>.  Subsequently, the query
-   planner uses these statistics to help determine the most efficient
-   execution plans for queries.
+   of tables in the database, and stores the results in the <link
+   linkend="catalog-pg-statistic"><structname>pg_statistic</></>
+   system catalog.  Subsequently, the query planner uses these
+   statistics to help determine the most efficient execution plans for
+   queries.
   </para>
 
   <para>
@@ -125,7 +126,7 @@ ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<rep
    will change slightly each time <command>ANALYZE</command> is run,
    even if the actual table contents did not change.  This might result
    in small changes in the planner's estimated costs shown by
-   <command>EXPLAIN</command>. In rare situations, this
+   <xref linkend="sql-explain" endterm="sql-explain-title">. In rare situations, this
    non-determinism will cause the query optimizer to choose a
    different query plan between runs of <command>ANALYZE</command>. To
    avoid this, raise the amount of statistics collected by
index 1a7144cdd9485a4a7efbfcb6aa4eb2dbc8ecbc38..e7fc2d9eeb7669419ac6f56ea67f54612691d3c5 100644 (file)
@@ -88,8 +88,8 @@ CLOSE { <replaceable class="PARAMETER">name</replaceable> | ALL }
   </para>
 
   <para>
-   You can see all available cursors by querying the
-   <structname>pg_cursors</structname> system view.
+   You can see all available cursors by querying the <link
+   linkend="view-pg-cursors"><structname>pg_cursors</></> system view.
   </para>
  </refsect1>
 
index d63e08e26f182c2e16f843212ba202c384949482..abb6c184e9a80322585356411271ec5a2030e6a7 100644 (file)
@@ -28,7 +28,7 @@ DROP AGGREGATE [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> (
   <title>Description</title>
 
   <para>
-   <command>DROP AGGREGATE</command> will delete an existing
+   <command>DROP AGGREGATE</command> removes an existing
    aggregate function. To execute this command the current
    user must be the owner of the aggregate function.
   </para>
index 50a3915a5f825222bc9c168feb472b61816f2a6c..401cf3fbbd361476f7881e8333b624a1122175f0 100644 (file)
@@ -20,7 +20,7 @@ PostgreSQL documentation
 
  <refsynopsisdiv>
 <synopsis>
-DROP DOMAIN [IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [, ...]  [ CASCADE | RESTRICT ]
+DROP DOMAIN [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
 </synopsis>
  </refsynopsisdiv>
 
@@ -28,8 +28,8 @@ DROP DOMAIN [IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [, ..
   <title>Description</title>
 
   <para>
-   <command>DROP DOMAIN</command> will remove a domain.  Only the
-   owner of a domain can remove it.
+   <command>DROP DOMAIN</command> removes a domain.  Only the owner of
+   a domain can remove it.
   </para>
  </refsect1>
 
index cb7592e9bc8ed6bb30e365092d7b242f436d3400..4653f62adfbdedcefac5ccf4ef7dcd25dbe8077b 100644 (file)
@@ -28,11 +28,9 @@ DROP [ PROCEDURAL ] LANGUAGE [ IF EXISTS ] <replaceable class="PARAMETER">name</
   <title>Description</title>
 
   <para>
-   <command>DROP LANGUAGE</command> will remove the definition
-   of the previously registered procedural language called
-   <replaceable class="parameter">name</replaceable>.
-   You must be superuser or owner of the language to
-   use <command>DROP LANGUAGE</command>.
+   <command>DROP LANGUAGE</command> removes the definition of a
+   previously registered procedural language.  You must be a superuser
+   or the owner of the language to use <command>DROP LANGUAGE</>.
   </para>
  </refsect1>
   
index 3ea07c116871bbf8f263f051165a6e907ac5f43d..56f8821e3ee68990a21c443fa6c3a564171b49cb 100644 (file)
@@ -28,7 +28,8 @@ DROP SEQUENCE [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [,
   <title>Description</title>
 
   <para>
-   <command>DROP SEQUENCE</command> removes sequence number generators.
+   <command>DROP SEQUENCE</command> removes sequence number
+   generators. A sequence can only be dropped by its owner or a superuser.
   </para>
  </refsect1>
   
index ffc98410374a4756cf5a773ddb950837b702648b..56e7e84f771faa3bac779c77c209f0e4832596e8 100644 (file)
@@ -29,7 +29,7 @@ DROP TABLE [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [, ..
 
   <para>
    <command>DROP TABLE</command> removes tables from the database.
-   Only its owner can destroy a table.  To empty a table of rows
+   Only its owner can drop a table.  To empty a table of rows
    without destroying the table, use <xref linkend="sql-delete"
    endterm="sql-delete-title"> or <xref linkend="sql-truncate"
    endterm="sql-truncate-title">.
index 95ea2131a5acfbac75396aac0ca19a85246ba6e9..5eb725a4698f72e2aed218a02678f3a7ec1f1783 100644 (file)
@@ -28,7 +28,7 @@ DROP TRIGGER [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> ON
   <title>Description</title>
 
   <para>
-   <command>DROP TRIGGER</command> will remove an existing
+   <command>DROP TRIGGER</command> removes an existing
    trigger definition. To execute this command, the current
    user must be the owner of the table for which the trigger is defined.
   </para>
index 23c4817be1a0609a51af457c17afa626832fae50..3d89b21b8c4e19044e7913905307feb5e686797b 100644 (file)
@@ -28,7 +28,7 @@ DROP TYPE [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [, ...
   <title>Description</title>
 
   <para>
-   <command>DROP TYPE</command> will remove a user-defined data type.
+   <command>DROP TYPE</command> removes a user-defined data type.
    Only the owner of a type can remove it.
   </para>
  </refsect1>
index 474e96c26e699e1d3bb7ab5a13382318024d80e3..fcb55e9e3de55fc9085ef3279d3735f2f3a76769 100644 (file)
@@ -25,7 +25,7 @@ PostgreSQL documentation
 
  <refsynopsisdiv>
 <synopsis>
-EXECUTE <replaceable class="PARAMETER">name</replaceable> [ (<replaceable class="PARAMETER">parameter</replaceable> [, ...] ) ]
+EXECUTE <replaceable class="PARAMETER">name</replaceable> [ ( <replaceable class="PARAMETER">parameter</replaceable> [, ...] ) ]
 </synopsis>
  </refsynopsisdiv>
 
index 02d9b2505d9cfc6e2891159df0460dff811a643e..4fa352d6822635fd364f5dd8c086b3f99113e587 100644 (file)
@@ -11,7 +11,8 @@
   <refname>pg_restore</refname>
 
   <refpurpose>
-   restore a <productname>PostgreSQL</productname> database from an archive file created by pg_dump
+   restore a <productname>PostgreSQL</productname> database from an
+   archive file created by <application>pg_dump</application>
   </refpurpose>
  </refnamediv>
 
index 7604d69504017aa6e982bd779e1d75f42e9224aa..3304232b65deab131b347fe069f8d555544ffcf9 100644 (file)
@@ -25,7 +25,7 @@ PostgreSQL documentation
 
  <refsynopsisdiv>
 <synopsis>
-PREPARE <replaceable class="PARAMETER">name</replaceable> [ (<replaceable class="PARAMETER">datatype</replaceable> [, ...] ) ] AS <replaceable class="PARAMETER">statement</replaceable>
+PREPARE <replaceable class="PARAMETER">name</replaceable> [ ( <replaceable class="PARAMETER">datatype</replaceable> [, ...] ) ] AS <replaceable class="PARAMETER">statement</replaceable>
 </synopsis>
  </refsynopsisdiv>
 
index 94147a029492a98c78621c0ffa603d1d71b335ed..cfd32e80caef2be3df7f876c7a7fdfdcaaf6e489 100644 (file)
@@ -354,7 +354,7 @@ where <replaceable class="parameter">from_item</replaceable> can be one of:
      </varlistentry>
      
      <varlistentry>
-      <term><literal>USING (<replaceable class="parameter">join_column</replaceable> [, ...])</literal></term>
+      <term><literal>USING ( <replaceable class="parameter">join_column</replaceable> [, ...] )</literal></term>
       <listitem>
        <para>
         A clause of the form <literal>USING ( a, b, ... )</literal> is