From: Neil Conway <neilc@samurai.com>
Date: Tue, 23 Mar 2004 13:21:41 +0000 (+0000)
Subject: Minor SGML improvements.
X-Git-Tag: REL8_0_0BETA1~933
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=446b5476e531cb92778073903341ff5ec8d3044b;p=postgresql

Minor SGML improvements.
---

diff --git a/doc/src/sgml/ref/alter_domain.sgml b/doc/src/sgml/ref/alter_domain.sgml
index 6b84902fe1..7ecee65021 100644
--- a/doc/src/sgml/ref/alter_domain.sgml
+++ b/doc/src/sgml/ref/alter_domain.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/alter_domain.sgml,v 1.11 2003/11/29 19:51:38 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/alter_domain.sgml,v 1.12 2004/03/23 13:21:41 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -139,7 +139,7 @@ ALTER DOMAIN <replaceable class="PARAMETER">name</replaceable>
      </varlistentry>
 
      <varlistentry>
-      <term>CASCADE</term>
+      <term><literal>CASCADE</literal></term>
       <listitem>
        <para>
         Automatically drop objects that depend on the constraint.
@@ -148,7 +148,7 @@ ALTER DOMAIN <replaceable class="PARAMETER">name</replaceable>
      </varlistentry>
 
      <varlistentry>
-      <term>RESTRICT</term>
+      <term><literal>RESTRICT</literal></term>
       <listitem>
        <para>
         Refuse to drop the constraint if there are any dependent
@@ -174,11 +174,11 @@ ALTER DOMAIN <replaceable class="PARAMETER">name</replaceable>
   <title>Examples</title>
 
   <para>
-   To add a NOT NULL constraint to a domain:
+   To add a <literal>NOT NULL</literal> constraint to a domain:
    <programlisting>
 ALTER DOMAIN zipcode SET NOT NULL;
    </programlisting>
-   To remove a NOT NULL constraint from a domain:
+   To remove a <literal>NOT NULL</literal> constraint from a domain:
    <programlisting>
 ALTER DOMAIN zipcode DROP NOT NULL;
    </programlisting>
diff --git a/doc/src/sgml/ref/cluster.sgml b/doc/src/sgml/ref/cluster.sgml
index 9fd5cab253..ff375e01f9 100644
--- a/doc/src/sgml/ref/cluster.sgml
+++ b/doc/src/sgml/ref/cluster.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/cluster.sgml,v 1.31 2003/11/29 19:51:38 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/cluster.sgml,v 1.32 2004/03/23 13:21:41 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -129,9 +129,10 @@ CLUSTER
    </para>
 
    <para>
-    Because the planner records statistics about the ordering of tables, it
-    is advisable to run <command>ANALYZE</command> on the newly clustered
-    table.  Otherwise, the planner may make poor choices of query plans.
+    Because the planner records statistics about the ordering of
+    tables, it is advisable to run <xref linkend="sql-analyze"
+    endterm="sql-analyze-title"> on the newly clustered table.
+    Otherwise, the planner may make poor choices of query plans.
    </para>
 
    <para>
@@ -175,7 +176,7 @@ CLUSTER emp_ind ON emp;
   </para>
 
   <para>
-   Cluster the <literal>employees</literal> relation using the same
+   Cluster the <literal>employees</literal> table using the same
    index that was used before:
 <programlisting>
 CLUSTER emp;
diff --git a/doc/src/sgml/ref/truncate.sgml b/doc/src/sgml/ref/truncate.sgml
index 667a6df2bb..8bd220f77a 100644
--- a/doc/src/sgml/ref/truncate.sgml
+++ b/doc/src/sgml/ref/truncate.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/truncate.sgml,v 1.16 2003/11/29 19:51:39 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/truncate.sgml,v 1.17 2004/03/23 13:21:41 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -60,8 +60,8 @@ TRUNCATE [ TABLE ] <replaceable class="PARAMETER">name</replaceable>
   </para>
 
   <para>
-   <command>TRUNCATE</> will not run any user-defined ON DELETE triggers
-   that might exist for the table.
+   <command>TRUNCATE</> will not run any user-defined <literal>ON
+   DELETE</literal> triggers that might exist for the table.
   </para>
  </refsect1>
 
diff --git a/doc/src/sgml/ref/vacuum.sgml b/doc/src/sgml/ref/vacuum.sgml
index 5cee5f991f..930ce7e3ba 100644
--- a/doc/src/sgml/ref/vacuum.sgml
+++ b/doc/src/sgml/ref/vacuum.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/vacuum.sgml,v 1.34 2003/11/29 19:51:39 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/vacuum.sgml,v 1.35 2004/03/23 13:21:41 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -64,14 +64,14 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] ANALYZE [ <replaceable class="PARAMETER">
   </para>
 
   <para>
-   <command>FREEZE</command> is a special-purpose option that
+   <literal>FREEZE</literal> is a special-purpose option that
    causes tuples to be marked <quote>frozen</quote> as soon as possible,
    rather than waiting until they are quite old.  If this is done when there
    are no other open transactions in the same database, then it is guaranteed
    that all tuples in the database are <quote>frozen</> and will not be
    subject to transaction ID wraparound problems, no matter how long the
    database is left unvacuumed.
-   <command>FREEZE</command> is not recommended for routine use.  Its only
+   <literal>FREEZE</literal> is not recommended for routine use.  Its only
    intended usage is in connection with preparation of user-defined template
    databases, or other databases that are completely read-only and will not
    receive routine maintenance <command>VACUUM</> operations.