From: Neil Conway <neilc@samurai.com>
Date: Mon, 20 Sep 2004 00:04:19 +0000 (+0000)
Subject: Minor documentation cleanup and improvement.
X-Git-Tag: REL9_0_0~11861
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=f6279e9ed7b439f52ff50209e86cd034e49bff97;p=pg-rex%2Fsyncrep.git

Minor documentation cleanup and improvement.
---

diff --git a/doc/src/sgml/ref/create_operator.sgml b/doc/src/sgml/ref/create_operator.sgml
index 029d1af0d9..278fe3f3a0 100644
--- a/doc/src/sgml/ref/create_operator.sgml
+++ b/doc/src/sgml/ref/create_operator.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.42 2004/06/25 21:55:50 tgl Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.43 2004/09/20 00:04:19 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -262,9 +262,11 @@ COMMUTATOR = OPERATOR(myschema.===) ,
   </para>
 
   <para>
-   Use <command>DROP OPERATOR</command> to delete user-defined
-   operators from a database.  Use <command>ALTER OPERATOR</command>
-   to modify operators in a database.
+   Use <xref linkend="sql-dropoperator"
+   endterm="sql-dropoperator-title"> to delete user-defined operators
+   from a database.  Use <xref linkend="sql-alteroperator"
+   endterm="sql-alteroperator-title"> to modify operators in a
+   database.
   </para>
  </refsect1>
   
diff --git a/doc/src/sgml/ref/deallocate.sgml b/doc/src/sgml/ref/deallocate.sgml
index 82f0639f54..a0d943f4ad 100644
--- a/doc/src/sgml/ref/deallocate.sgml
+++ b/doc/src/sgml/ref/deallocate.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/deallocate.sgml,v 1.5 2003/11/29 19:51:38 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/deallocate.sgml,v 1.6 2004/09/20 00:04:19 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -71,6 +71,15 @@ DEALLOCATE [ PREPARE ] <replaceable class="parameter">plan_name</replaceable>
    statement, but it is only for use in embedded SQL.
   </para>
  </refsect1>
+
+ <refsect1>
+  <title>See Also</title>
+
+  <simplelist type="inline">
+   <member><xref linkend="sql-execute" endterm="sql-execute-title"></member>
+   <member><xref linkend="sql-prepare" endterm="sql-prepare-title"></member>
+  </simplelist>
+ </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/doc/src/sgml/ref/drop_trigger.sgml b/doc/src/sgml/ref/drop_trigger.sgml
index b2bbaa03f4..bfcad66ae8 100644
--- a/doc/src/sgml/ref/drop_trigger.sgml
+++ b/doc/src/sgml/ref/drop_trigger.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/drop_trigger.sgml,v 1.18 2003/11/29 19:51:38 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/drop_trigger.sgml,v 1.19 2004/09/20 00:04:19 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -51,8 +51,8 @@ DROP TRIGGER <replaceable class="PARAMETER">name</replaceable> ON <replaceable c
     <term><replaceable class="PARAMETER">table</replaceable></term>
     <listitem>
      <para>
-      The name (optionally schema-qualified) of a table for which the
-      trigger is defined.
+      The name (optionally schema-qualified) of the table for which
+      the trigger is defined.
      </para>
     </listitem>
    </varlistentry>
diff --git a/doc/src/sgml/ref/execute.sgml b/doc/src/sgml/ref/execute.sgml
index a7312adc65..1c59ec81bb 100644
--- a/doc/src/sgml/ref/execute.sgml
+++ b/doc/src/sgml/ref/execute.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/execute.sgml,v 1.10 2004/04/22 11:46:22 tgl Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/execute.sgml,v 1.11 2004/09/20 00:04:19 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -105,6 +105,15 @@ EXECUTE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable c
    syntax.
   </para>
  </refsect1>
+
+ <refsect1>
+  <title>See Also</title>
+
+  <simplelist type="inline">
+   <member><xref linkend="sql-deallocate" endterm="sql-deallocate-title"></member>
+   <member><xref linkend="sql-prepare" endterm="sql-prepare-title"></member>
+  </simplelist>
+ </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml
index 0e22d34213..d7255dc87f 100644
--- a/doc/src/sgml/ref/postmaster.sgml
+++ b/doc/src/sgml/ref/postmaster.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.51 2004/07/11 00:18:41 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.52 2004/09/20 00:04:19 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -84,7 +84,7 @@ PostgreSQL documentation
    point to a directory containing only configuration files:
    <filename>postgresql.conf</>, <filename>pg_hba.conf</>, and
    <filename>pg_ident.conf</>. You can then set
-   <filename>postgresql.conf</>'s <varname>pgdata</> to point to the
+   <filename>postgresql.conf</>'s <varname>pgdata</> variable to point to the
    data directory. You can also point just to the server configuration file
    like <filename>postgresql.conf</> and set its variables to point to the
    other configuration files and the data directory.
@@ -164,8 +164,8 @@ PostgreSQL documentation
       <term><option>-F</option></term>
       <listitem>
        <para>
-        Disables <function>fsync</function> calls for performance
-        improvement, at the risk of data corruption in event of a
+        Disables <function>fsync</function> calls for improved
+        performance, at the risk of data corruption in the event of a
         system crash.  Specifying this option is equivalent to
         disabling the <xref linkend="guc-fsync"> configuration
         parameter. Read the detailed documentation before using this!
diff --git a/doc/src/sgml/ref/prepare.sgml b/doc/src/sgml/ref/prepare.sgml
index 6a77048c3e..cd18a36561 100644
--- a/doc/src/sgml/ref/prepare.sgml
+++ b/doc/src/sgml/ref/prepare.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/prepare.sgml,v 1.12 2004/04/19 23:36:48 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/prepare.sgml,v 1.13 2004/09/20 00:04:19 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -129,7 +129,8 @@ PREPARE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable c
    when planning prepared statements with parameters, the chosen plan
    may be suboptimal. To examine the query plan
    <productname>PostgreSQL</productname> has chosen for a prepared
-   statement, use <command>EXPLAIN EXECUTE</command>.
+   statement, use <xref linkend="sql-explain"
+   endterm="sql-explain-title">.
   </para>
 
   <para>
@@ -173,6 +174,15 @@ EXECUTE usrrptplan(1, current_date);
    syntax.
   </para>
  </refsect1>
+
+ <refsect1>
+  <title>See Also</title>
+
+  <simplelist type="inline">
+   <member><xref linkend="sql-deallocate" endterm="sql-deallocate-title"></member>
+   <member><xref linkend="sql-execute" endterm="sql-execute-title"></member>
+  </simplelist>
+ </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/doc/src/sgml/ref/rollback_to.sgml b/doc/src/sgml/ref/rollback_to.sgml
index 63c295f590..f96baec398 100644
--- a/doc/src/sgml/ref/rollback_to.sgml
+++ b/doc/src/sgml/ref/rollback_to.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/rollback_to.sgml,v 1.3 2004/08/24 00:06:51 neilc Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/rollback_to.sgml,v 1.4 2004/09/20 00:04:19 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -146,9 +146,9 @@ COMMIT;
   <simplelist type="inline">
    <member><xref linkend="sql-begin" endterm="sql-begin-title"></member>
    <member><xref linkend="sql-commit" endterm="sql-commit-title"></member>
-   <member><xref linkend="sql-savepoint" endterm="sql-savepoint-title"></member>
    <member><xref linkend="sql-release-savepoint" endterm="sql-release-savepoint-title"></member>
    <member><xref linkend="sql-rollback" endterm="sql-rollback-title"></member>
+   <member><xref linkend="sql-savepoint" endterm="sql-savepoint-title"></member>
   </simplelist>
  </refsect1>
 </refentry>
diff --git a/doc/src/sgml/ref/savepoint.sgml b/doc/src/sgml/ref/savepoint.sgml
index 69f5dfb4e2..acc02b2497 100644
--- a/doc/src/sgml/ref/savepoint.sgml
+++ b/doc/src/sgml/ref/savepoint.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/savepoint.sgml,v 1.2 2004/08/12 19:12:21 tgl Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/savepoint.sgml,v 1.3 2004/09/20 00:04:19 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -126,10 +126,10 @@ COMMIT;
 
   <simplelist type="inline">
    <member><xref linkend="sql-begin" endterm="sql-begin-title"></member>
+   <member><xref linkend="sql-commit" endterm="sql-commit-title"></member>
+   <member><xref linkend="sql-release-savepoint" endterm="sql-release-savepoint-title"></member>
    <member><xref linkend="sql-rollback" endterm="sql-rollback-title"></member>
    <member><xref linkend="sql-rollback-to" endterm="sql-rollback-to-title"></member>
-   <member><xref linkend="sql-release-savepoint" endterm="sql-release-savepoint-title"></member>
-   <member><xref linkend="sql-commit" endterm="sql-commit-title"></member>
   </simplelist>
  </refsect1>
 </refentry>
diff --git a/doc/src/sgml/ref/set_transaction.sgml b/doc/src/sgml/ref/set_transaction.sgml
index d57792ee3d..df66ca2bb7 100644
--- a/doc/src/sgml/ref/set_transaction.sgml
+++ b/doc/src/sgml/ref/set_transaction.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/set_transaction.sgml,v 1.21 2004/08/14 22:17:08 tgl Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/set_transaction.sgml,v 1.22 2004/09/20 00:04:19 neilc Exp $ -->
 <refentry id="SQL-SET-TRANSACTION">
  <refmeta>
   <refentrytitle id="SQL-SET-TRANSACTION-TITLE">SET TRANSACTION</refentrytitle>
@@ -30,13 +30,13 @@ where <replaceable class="parameter">transaction_mode</replaceable> is one of:
   <title>Description</title>
 
   <para>
-   The <command>SET TRANSACTION</command> command sets the transaction
+   The <command>SET TRANSACTION</command> command sets the
    characteristics of the current transaction. It has no effect on any
    subsequent transactions.  <command>SET SESSION
    CHARACTERISTICS</command> sets the default transaction
    characteristics for subsequent transactions of a session.  These
-   defaults can be overridden by <command>SET TRANSACTION</command> for an
-   individual transaction.
+   defaults can be overridden by <command>SET TRANSACTION</command>
+   for an individual transaction.
   </para>
 
   <para>
diff --git a/doc/src/sgml/ref/start_transaction.sgml b/doc/src/sgml/ref/start_transaction.sgml
index 823bd99195..3d85572dd2 100644
--- a/doc/src/sgml/ref/start_transaction.sgml
+++ b/doc/src/sgml/ref/start_transaction.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/start_transaction.sgml,v 1.13 2004/08/12 21:00:23 tgl Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/start_transaction.sgml,v 1.14 2004/09/20 00:04:19 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -85,8 +85,8 @@ where <replaceable class="parameter">transaction_mode</replaceable> is one of:
    <member><xref linkend="sql-begin" endterm="sql-begin-title"></member>
    <member><xref linkend="sql-commit" endterm="sql-commit-title"></member>
    <member><xref linkend="sql-rollback" endterm="sql-rollback-title"></member>
-   <member><xref linkend="sql-set-transaction" endterm="sql-set-transaction-title"></member>
    <member><xref linkend="sql-savepoint" endterm="sql-savepoint-title"></member>
+   <member><xref linkend="sql-set-transaction" endterm="sql-set-transaction-title"></member>
   </simplelist>
  </refsect1>
 </refentry>