From a75ee43ce9ae8596191074a04c8f8394b6d5e66b Mon Sep 17 00:00:00 2001
From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Fri, 12 Sep 2003 23:04:46 +0000
Subject: [PATCH] Mop-up for error-message updates in documentation.
---
doc/src/sgml/ref/analyze.sgml | 12 ++++++-
doc/src/sgml/ref/clusterdb.sgml | 28 ++++++++++------
doc/src/sgml/ref/create_language.sgml | 4 +--
doc/src/sgml/ref/createdb.sgml | 30 ++++++++++-------
doc/src/sgml/ref/createuser.sgml | 28 ++++++++++------
doc/src/sgml/ref/dropdb.sgml | 30 ++++++++++-------
doc/src/sgml/ref/dropuser.sgml | 28 ++++++++++------
doc/src/sgml/ref/listen.sgml | 6 ++--
doc/src/sgml/ref/notify.sgml | 4 +--
doc/src/sgml/ref/unlisten.sgml | 8 ++---
doc/src/sgml/ref/vacuumdb.sgml | 48 ++++++++++++++++-----------
11 files changed, 139 insertions(+), 87 deletions(-)
diff --git a/doc/src/sgml/ref/analyze.sgml b/doc/src/sgml/ref/analyze.sgml
index cf472d4a0ef..0010efa106b 100644
--- a/doc/src/sgml/ref/analyze.sgml
+++ b/doc/src/sgml/ref/analyze.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.15 2003/09/11 17:31:45 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.16 2003/09/12 23:04:45 tgl Exp $
PostgreSQL documentation
-->
@@ -77,6 +77,16 @@ ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<rep
</variablelist>
</refsect1>
+ <refsect1>
+ <title>Outputs</title>
+
+ <para>
+ When <literal>VERBOSE</> is specified, <command>ANALYZE</> emits
+ progress messages to indicate which table is currently being
+ processed. Various statistics about the tables are printed as well.
+ </para>
+ </refsect1>
+
<refsect1>
<title>Notes</title>
diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml
index 7be6d0959da..7c9f524fac7 100644
--- a/doc/src/sgml/ref/clusterdb.sgml
+++ b/doc/src/sgml/ref/clusterdb.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.14 2003/09/12 00:12:47 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.15 2003/09/12 23:04:45 tgl Exp $
PostgreSQL documentation
-->
@@ -51,16 +51,6 @@ PostgreSQL documentation
this utility and via other methods for accessing the server.
</para>
- <para>
- In case of difficulty, see <xref linkend="SQL-CLUSTER"
- endterm="sql-cluster-title"> and <xref linkend="APP-PSQL"> for
- discussions of potential problems and error messages.
- The database server must be running at the
- targeted host. Also, any default connection settings and environment
- variables used by the <application>libpq</application> front-end
- library will apply.
- </para>
-
</refsect1>
@@ -203,6 +193,22 @@ PostgreSQL documentation
</refsect1>
+ <refsect1>
+ <title>Diagnostics</title>
+
+ <para>
+ In case of difficulty, see <xref linkend="SQL-CLUSTER"
+ endterm="sql-cluster-title"> and <xref linkend="APP-PSQL"> for
+ discussions of potential problems and error messages.
+ The database server must be running at the
+ targeted host. Also, any default connection settings and environment
+ variables used by the <application>libpq</application> front-end
+ library will apply.
+ </para>
+
+ </refsect1>
+
+
<refsect1>
<title>Examples</title>
diff --git a/doc/src/sgml/ref/create_language.sgml b/doc/src/sgml/ref/create_language.sgml
index 45834255bb8..1629ba77e47 100644
--- a/doc/src/sgml/ref/create_language.sgml
+++ b/doc/src/sgml/ref/create_language.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.35 2003/09/09 18:28:52 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.36 2003/09/12 23:04:45 tgl Exp $
PostgreSQL documentation
-->
@@ -139,7 +139,7 @@ CREATE [ TRUSTED ] [ PROCEDURAL ] LANGUAGE <replaceable class="parameter">langna
for syntactical correctness, but it can also look at other
properties of the function, for example if the language cannot
handle certain argument types. To signal an error, the
- validator function should use the <function>elog()</function>
+ validator function should use the <function>ereport()</function>
function. The return value of the function is ignored.
</para>
</listitem>
diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml
index 1c7e0ec4af8..a70e9630398 100644
--- a/doc/src/sgml/ref/createdb.sgml
+++ b/doc/src/sgml/ref/createdb.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.35 2003/09/12 00:12:47 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.36 2003/09/12 23:04:45 tgl Exp $
PostgreSQL documentation
-->
@@ -53,16 +53,6 @@ PostgreSQL documentation
this utility and via other methods for accessing the server.
</para>
- <para>
- In case of difficulty, see <xref linkend="SQL-CREATEDATABASE"
- endterm="sql-createdatabase-title"> and <xref linkend="APP-PSQL"> for
- discussions of potential problems and error messages.
- The database server must be running at the
- targeted host. Also, any default connection settings and environment
- variables used by the <application>libpq</application> front-end
- library will apply.
- </para>
-
</refsect1>
@@ -252,7 +242,23 @@ PostgreSQL documentation
</refsect1>
- <refsect1 id="R1-APP-CREATEDB-2">
+ <refsect1>
+ <title>Diagnostics</title>
+
+ <para>
+ In case of difficulty, see <xref linkend="SQL-CREATEDATABASE"
+ endterm="sql-createdatabase-title"> and <xref linkend="APP-PSQL"> for
+ discussions of potential problems and error messages.
+ The database server must be running at the
+ targeted host. Also, any default connection settings and environment
+ variables used by the <application>libpq</application> front-end
+ library will apply.
+ </para>
+
+ </refsect1>
+
+
+ <refsect1>
<title>Examples</title>
<para>
diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml
index 484f7fbe11f..15459db9ce8 100644
--- a/doc/src/sgml/ref/createuser.sgml
+++ b/doc/src/sgml/ref/createuser.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.37 2003/09/12 00:12:47 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.38 2003/09/12 23:04:46 tgl Exp $
PostgreSQL documentation
-->
@@ -54,16 +54,6 @@ PostgreSQL documentation
this utility and via other methods for accessing the server.
</para>
- <para>
- In case of difficulty, see <xref linkend="SQL-CREATEUSER"
- endterm="sql-createuser-title"> and <xref linkend="APP-PSQL"> for
- discussions of potential problems and error messages.
- The database server must be running at the
- targeted host. Also, any default connection settings and environment
- variables used by the <application>libpq</application> front-end
- library will apply.
- </para>
-
</refsect1>
@@ -276,6 +266,22 @@ PostgreSQL documentation
</refsect1>
+ <refsect1>
+ <title>Diagnostics</title>
+
+ <para>
+ In case of difficulty, see <xref linkend="SQL-CREATEUSER"
+ endterm="sql-createuser-title"> and <xref linkend="APP-PSQL"> for
+ discussions of potential problems and error messages.
+ The database server must be running at the
+ targeted host. Also, any default connection settings and environment
+ variables used by the <application>libpq</application> front-end
+ library will apply.
+ </para>
+
+ </refsect1>
+
+
<refsect1>
<title>Examples</title>
diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml
index e1c28fe2931..6a6733abc2c 100644
--- a/doc/src/sgml/ref/dropdb.sgml
+++ b/doc/src/sgml/ref/dropdb.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.24 2003/09/12 00:12:47 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.25 2003/09/12 23:04:46 tgl Exp $
PostgreSQL documentation
-->
@@ -46,16 +46,6 @@ PostgreSQL documentation
this utility and via other methods for accessing the server.
</para>
- <para>
- In case of difficulty, see <xref linkend="SQL-DROPDATABASE"
- endterm="sql-dropdatabase-title"> and <xref linkend="APP-PSQL"> for
- discussions of potential problems and error messages.
- The database server must be running at the
- targeted host. Also, any default connection settings and environment
- variables used by the <application>libpq</application> front-end
- library will apply.
- </para>
-
</refsect1>
@@ -181,7 +171,23 @@ PostgreSQL documentation
</refsect1>
- <refsect1 id="R1-APP-DROPDB-2">
+ <refsect1>
+ <title>Diagnostics</title>
+
+ <para>
+ In case of difficulty, see <xref linkend="SQL-DROPDATABASE"
+ endterm="sql-dropdatabase-title"> and <xref linkend="APP-PSQL"> for
+ discussions of potential problems and error messages.
+ The database server must be running at the
+ targeted host. Also, any default connection settings and environment
+ variables used by the <application>libpq</application> front-end
+ library will apply.
+ </para>
+
+ </refsect1>
+
+
+ <refsect1>
<title>Examples</title>
<para>
diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml
index 5c26050db96..dab715313bb 100644
--- a/doc/src/sgml/ref/dropuser.sgml
+++ b/doc/src/sgml/ref/dropuser.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.29 2003/09/12 00:12:47 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.30 2003/09/12 23:04:46 tgl Exp $
PostgreSQL documentation
-->
@@ -48,16 +48,6 @@ PostgreSQL documentation
this utility and via other methods for accessing the server.
</para>
- <para>
- In case of difficulty, see <xref linkend="SQL-DROPUSER"
- endterm="sql-dropuser-title"> and <xref linkend="APP-PSQL"> for
- discussions of potential problems and error messages.
- The database server must be running at the
- targeted host. Also, any default connection settings and environment
- variables used by the <application>libpq</application> front-end
- library will apply.
- </para>
-
</refsect1>
@@ -185,6 +175,22 @@ PostgreSQL documentation
</refsect1>
+ <refsect1>
+ <title>Diagnostics</title>
+
+ <para>
+ In case of difficulty, see <xref linkend="SQL-DROPUSER"
+ endterm="sql-dropuser-title"> and <xref linkend="APP-PSQL"> for
+ discussions of potential problems and error messages.
+ The database server must be running at the
+ targeted host. Also, any default connection settings and environment
+ variables used by the <application>libpq</application> front-end
+ library will apply.
+ </para>
+
+ </refsect1>
+
+
<refsect1>
<title>Examples</title>
diff --git a/doc/src/sgml/ref/listen.sgml b/doc/src/sgml/ref/listen.sgml
index 8029b5ed036..75861fa6115 100644
--- a/doc/src/sgml/ref/listen.sgml
+++ b/doc/src/sgml/ref/listen.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/listen.sgml,v 1.18 2003/09/12 00:12:47 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/listen.sgml,v 1.19 2003/09/12 23:04:46 tgl Exp $
PostgreSQL documentation
-->
@@ -92,7 +92,9 @@ LISTEN <replaceable class="PARAMETER">name</replaceable>
<title>Examples</title>
<para>
- Configure and execute a listen/notify sequence from <application>psql</application>:
+ Configure and execute a listen/notify sequence from
+ <application>psql</application>:
+
<programlisting>
LISTEN virtual;
NOTIFY virtual;
diff --git a/doc/src/sgml/ref/notify.sgml b/doc/src/sgml/ref/notify.sgml
index dde512d3e3d..b16265956ee 100644
--- a/doc/src/sgml/ref/notify.sgml
+++ b/doc/src/sgml/ref/notify.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/notify.sgml,v 1.22 2003/09/09 18:28:53 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/notify.sgml,v 1.23 2003/09/12 23:04:46 tgl Exp $
PostgreSQL documentation
-->
@@ -143,7 +143,7 @@ NOTIFY <replaceable class="PARAMETER">name</replaceable>
<programlisting>
LISTEN virtual;
NOTIFY virtual;
-Asynchronous NOTIFY 'virtual' from backend with pid '8448' received.
+Asynchronous notification "virtual" received from server process with PID 8448.
</programlisting>
</para>
</refsect1>
diff --git a/doc/src/sgml/ref/unlisten.sgml b/doc/src/sgml/ref/unlisten.sgml
index 175bcf045c1..0444d8f7c1c 100644
--- a/doc/src/sgml/ref/unlisten.sgml
+++ b/doc/src/sgml/ref/unlisten.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/unlisten.sgml,v 1.23 2003/09/09 18:28:53 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/unlisten.sgml,v 1.24 2003/09/12 23:04:46 tgl Exp $
PostgreSQL documentation
-->
@@ -93,13 +93,13 @@ UNLISTEN { <replaceable class="PARAMETER">name</replaceable> | * }
<programlisting>
LISTEN virtual;
NOTIFY virtual;
-Asynchronous NOTIFY 'virtual' from backend with pid '8448' received
+Asynchronous notification "virtual" received from server process with PID 8448.
</programlisting>
</para>
<para>
- Once <command>UNLISTEN</> has been executed, further <command>NOTIFY</> commands will be
- ignored:
+ Once <command>UNLISTEN</> has been executed, further <command>NOTIFY</>
+ commands will be ignored:
<programlisting>
UNLISTEN virtual;
diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml
index 63d7b4d3ee4..ea669913f02 100644
--- a/doc/src/sgml/ref/vacuumdb.sgml
+++ b/doc/src/sgml/ref/vacuumdb.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.32 2003/09/12 00:12:47 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.33 2003/09/12 23:04:46 tgl Exp $
PostgreSQL documentation
-->
@@ -58,24 +58,6 @@ PostgreSQL documentation
this utility and via other methods for accessing the server.
</para>
- <para>
- In case of difficulty, see <xref linkend="SQL-VACUUM"
- endterm="sql-vacuum-title"> and <xref linkend="APP-PSQL"> for
- discussions of potential problems and error messages.
- The database server must be running at the
- targeted host. Also, any default connection settings and environment
- variables used by the <application>libpq</application> front-end
- library will apply.
- </para>
-
- <para>
- <application>vacuumdb</application> might need to connect several
- times to the <productname>PostgreSQL</productname> server, asking
- for a password each time. It is convenient to have a
- <filename>$HOME/.pgpass</> file in such cases. See <xref
- linkend="libpq-pgpass"> for more information.
- </para>
-
</refsect1>
@@ -256,6 +238,34 @@ PostgreSQL documentation
</refsect1>
+ <refsect1>
+ <title>Diagnostics</title>
+
+ <para>
+ In case of difficulty, see <xref linkend="SQL-VACUUM"
+ endterm="sql-vacuum-title"> and <xref linkend="APP-PSQL"> for
+ discussions of potential problems and error messages.
+ The database server must be running at the
+ targeted host. Also, any default connection settings and environment
+ variables used by the <application>libpq</application> front-end
+ library will apply.
+ </para>
+
+ </refsect1>
+
+
+ <refsect1>
+ <title>Notes</title>
+
+ <para>
+ <application>vacuumdb</application> might need to connect several
+ times to the <productname>PostgreSQL</productname> server, asking
+ for a password each time. It is convenient to have a
+ <filename>$HOME/.pgpass</> file in such cases. See <xref
+ linkend="libpq-pgpass"> for more information.
+ </para>
+ </refsect1>
+
<refsect1>
<title>Examples</title>
--
GitLab