From 024f3fa52fc4bab319e92de0a405e45fee45ace3 Mon Sep 17 00:00:00 2001
From: Neil Conway <neilc@samurai.com>
Date: Sun, 11 Jan 2004 05:46:58 +0000
Subject: [PATCH] Minor documentation improvements.
---
doc/src/sgml/backup.sgml | 6 +++---
doc/src/sgml/installation.sgml | 10 +++++-----
doc/src/sgml/perform.sgml | 10 +++++-----
doc/src/sgml/ref/begin.sgml | 9 +++++----
doc/src/sgml/ref/create_schema.sgml | 12 ++++++------
doc/src/sgml/ref/start_transaction.sgml | 8 ++++----
6 files changed, 28 insertions(+), 27 deletions(-)
diff --git a/doc/src/sgml/backup.sgml b/doc/src/sgml/backup.sgml
index 0d8d840e755..e6ac6d27846 100644
--- a/doc/src/sgml/backup.sgml
+++ b/doc/src/sgml/backup.sgml
@@ -1,5 +1,5 @@
<!--
-$PostgreSQL: pgsql/doc/src/sgml/backup.sgml,v 2.32 2003/11/29 19:51:36 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/backup.sgml,v 2.33 2004/01/11 05:46:58 neilc Exp $
-->
<chapter id="backup">
<title>Backup and Restore</title>
@@ -104,7 +104,7 @@ psql <replaceable class="parameter">dbname</replaceable> < <replaceable class
</synopsis>
where <replaceable class="parameter">infile</replaceable> is what
you used as <replaceable class="parameter">outfile</replaceable>
- for the <command>pg_dump</> command. The database <replaceable
+ for the <application>pg_dump</> command. The database <replaceable
class="parameter">dbname</replaceable> will not be created by this
command, you must create it yourself from <literal>template0</> before executing
<application>psql</> (e.g., with <literal>createdb -T template0
@@ -163,7 +163,7 @@ pg_dump -h <replaceable>host1</> <replaceable>dbname</> | psql -h <replaceable>h
</sect2>
<sect2 id="backup-dump-all">
- <title>Using <command>pg_dumpall</></title>
+ <title>Using <application>pg_dumpall</></title>
<para>
The above mechanism is cumbersome and inappropriate when backing
diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml
index ec54cb7377d..1fc151abeb8 100644
--- a/doc/src/sgml/installation.sgml
+++ b/doc/src/sgml/installation.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/installation.sgml,v 1.191 2004/01/04 16:43:52 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/installation.sgml,v 1.192 2004/01/11 05:46:58 neilc Exp $ -->
<chapter id="installation">
<title><![%standalone-include[<productname>PostgreSQL</>]]>
@@ -391,11 +391,11 @@ JAVACMD=$JAVA_HOME/bin/java
</screen>
If you need to preserve OIDs (such as when using them as
foreign keys), then use the <option>-o</option> option when running
- <command>pg_dumpall</>.
+ <application>pg_dumpall</>.
</para>
<para>
- <command>pg_dumpall</command> does not
+ <application>pg_dumpall</application> does not
save large objects. Check
<![%standalone-include[the documentation]]>
<![%standalone-ignore[<xref linkend="backup-dump-caveats">]]>
@@ -403,9 +403,9 @@ JAVACMD=$JAVA_HOME/bin/java
</para>
<para>
- To make the backup, you can use the <command>pg_dumpall</command>
+ To make the backup, you can use the <application>pg_dumpall</application>
command from the version you are currently running. For best
- results, however, try to use the <command>pg_dumpall</command>
+ results, however, try to use the <application>pg_dumpall</application>
command from <productname>PostgreSQL</productname> &version;,
since this version contains bug fixes and improvements over older
versions. While this advice might seem idiosyncratic since you
diff --git a/doc/src/sgml/perform.sgml b/doc/src/sgml/perform.sgml
index 6606c2e69ad..923612c290c 100644
--- a/doc/src/sgml/perform.sgml
+++ b/doc/src/sgml/perform.sgml
@@ -1,5 +1,5 @@
<!--
-$PostgreSQL: pgsql/doc/src/sgml/perform.sgml,v 1.39 2003/12/14 00:10:32 neilc Exp $
+$PostgreSQL: pgsql/doc/src/sgml/perform.sgml,v 1.40 2004/01/11 05:46:58 neilc Exp $
-->
<chapter id="performance-tips">
@@ -623,9 +623,9 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse;
<title>Populating a Database</title>
<para>
- One may need to do a large number of table insertions when first
- populating a database. Here are some tips and techniques for making that as
- efficient as possible.
+ One may need to insert a large amount of data when first populating
+ a database. This section contains some suggestions on how to make
+ this process as efficient as possible.
</para>
<sect2 id="disable-autocommit">
@@ -643,7 +643,7 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse;
make sure the library does it when you want it done.)
If you allow each insertion to be committed separately,
<productname>PostgreSQL</productname> is doing a lot of work for each
- row added.
+ row that is added.
An additional benefit of doing all insertions in one transaction
is that if the insertion of one row were to fail then the
insertion of all rows inserted up to that point would be rolled
diff --git a/doc/src/sgml/ref/begin.sgml b/doc/src/sgml/ref/begin.sgml
index 03fcbf97f27..07dce40be7b 100644
--- a/doc/src/sgml/ref/begin.sgml
+++ b/doc/src/sgml/ref/begin.sgml
@@ -1,5 +1,5 @@
<!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/begin.sgml,v 1.28 2004/01/10 02:21:08 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/begin.sgml,v 1.29 2004/01/11 05:46:58 neilc Exp $
PostgreSQL documentation
-->
@@ -76,9 +76,9 @@ BEGIN [ WORK | TRANSACTION ]
</variablelist>
<para>
- See under <xref linkend="sql-set-transaction"
- endterm="sql-set-transaction-title"> about the meaning of the
- other parameters.
+ Refer to <xref linkend="sql-set-transaction"
+ endterm="sql-set-transaction-title"> for information on the meaning
+ of the other parameters to this statement.
</para>
</refsect1>
@@ -142,6 +142,7 @@ BEGIN;
<title>See Also</title>
<simplelist type="inline">
+ <member><xref linkend="sql-start-transaction" endterm="sql-start-transaction-title"></member>
<member><xref linkend="sql-commit" endterm="sql-commit-title"></member>
<member><xref linkend="sql-rollback" endterm="sql-rollback-title"></member>
</simplelist>
diff --git a/doc/src/sgml/ref/create_schema.sgml b/doc/src/sgml/ref/create_schema.sgml
index 4c0f61ad95a..807f358d1f9 100644
--- a/doc/src/sgml/ref/create_schema.sgml
+++ b/doc/src/sgml/ref/create_schema.sgml
@@ -1,5 +1,5 @@
<!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/create_schema.sgml,v 1.10 2004/01/11 04:58:17 neilc Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/create_schema.sgml,v 1.11 2004/01/11 05:46:58 neilc Exp $
PostgreSQL documentation
-->
@@ -101,9 +101,9 @@ CREATE SCHEMA AUTHORIZATION <replaceable class="parameter">username</replaceable
<title>Notes</title>
<para>
- To create a schema, the invoking user must have <literal>CREATE</>
- privilege for the current database. (Of course, superusers bypass
- this check.)
+ To create a schema, the invoking user must have the
+ <literal>CREATE</> privilege for the current database. (Of course,
+ superusers bypass this check.)
</para>
</refsect1>
@@ -162,8 +162,8 @@ CREATE VIEW hollywood.winners AS
SCHEMA</command> may appear in any order. The present
<productname>PostgreSQL</productname> implementation does not
handle all cases of forward references in subcommands; it may
- sometimes be necessary to reorder the subcommands to avoid forward
- references.
+ sometimes be necessary to reorder the subcommands in order to avoid
+ forward references.
</para>
<para>
diff --git a/doc/src/sgml/ref/start_transaction.sgml b/doc/src/sgml/ref/start_transaction.sgml
index 98881920bae..5cecbf75565 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.10 2004/01/10 02:21:08 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/start_transaction.sgml,v 1.11 2004/01/11 05:46:58 neilc Exp $
PostgreSQL documentation
-->
@@ -42,9 +42,9 @@ START TRANSACTION
<title>Parameters</title>
<para>
- See under <xref linkend="sql-set-transaction"
- endterm="sql-set-transaction-title"> about the meaning of the
- parameters.
+ Refer to <xref linkend="sql-set-transaction"
+ endterm="sql-set-transaction-title"> for information on the meaning
+ of the parameters to this statement.
</para>
</refsect1>
--
GitLab