diff options
author | Neil Conway <neilc@samurai.com> | 2003-12-14 00:05:29 +0000 |
---|---|---|
committer | Neil Conway <neilc@samurai.com> | 2003-12-14 00:05:29 +0000 |
commit | e24018728cdc1b59c11d8a010c197d73d448799a (patch) | |
tree | 7dcdcd9b74ce3ebf90a93c651588d62dec3019f9 | |
parent | 7fb5a9992cf2edbcf6ee58be6c712555b0737d68 (diff) | |
download | postgresql-e24018728cdc1b59c11d8a010c197d73d448799a.tar.gz postgresql-e24018728cdc1b59c11d8a010c197d73d448799a.zip |
This patch makes some SGML markup more consistent and makes a small
improvement to the SSL auth docs.
-rw-r--r-- | doc/src/sgml/problems.sgml | 45 | ||||
-rw-r--r-- | doc/src/sgml/ref/lock.sgml | 28 |
2 files changed, 44 insertions, 29 deletions
diff --git a/doc/src/sgml/problems.sgml b/doc/src/sgml/problems.sgml index 3e31e559e41..02492a1febe 100644 --- a/doc/src/sgml/problems.sgml +++ b/doc/src/sgml/problems.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.16 2003/11/29 19:51:37 pgsql Exp $ +$PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.17 2003/12/14 00:05:29 neilc Exp $ --> <sect1 id="bug-reporting"> @@ -18,7 +18,7 @@ $PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.16 2003/11/29 19:51:37 pgsql E <para> The following suggestions are intended to assist you in forming bug reports that can be handled in an effective fashion. No one is required to follow - them but it tends to be to everyone's advantage. + them but doing so tends to be to everyone's advantage. </para> <para> @@ -204,17 +204,19 @@ $PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.16 2003/11/29 19:51:37 pgsql E <listitem> <para> - Any command line options and other start-up options, including concerned - environment variables or configuration files that you changed from the - default. Again, be exact. If you are using a prepackaged - distribution that starts the database server at boot time, you should try - to find out how that is done. + Any command line options and other start-up options, including + any relevant environment variables or configuration files that + you changed from the default. Again, please provide exact + information. If you are using a prepackaged distribution that + starts the database server at boot time, you should try to find + out how that is done. </para> </listitem> <listitem> <para> - Anything you did at all differently from the installation instructions. + Anything you did at all differently from the installation + instructions. </para> </listitem> @@ -234,9 +236,14 @@ $PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.16 2003/11/29 19:51:37 pgsql E </para> <para> - If your version is older than &version; we will almost certainly tell - you to upgrade. There are tons - of bug fixes in each new release, that is why we make new releases. + If your version is older than &version; we will almost certainly + tell you to upgrade. There are many bug fixes and improvements + in each new release, so it is quite possible that a bug you have + encountered in an older release of <productname>PostgreSQL</> + has already been fixed. We can only provide limited support for + sites using older releases of PostgreSQL; if you require more + than we can provide, consider acquiring a commercial support + contract. </para> <para> </para> @@ -244,12 +251,14 @@ $PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.16 2003/11/29 19:51:37 pgsql E <listitem> <para> - Platform information. This includes the kernel name and version, C library, - processor, memory information. In most cases it is sufficient to report - the vendor and version, but do not assume everyone knows what exactly - <quote>Debian</quote> contains or that everyone runs on Pentiums. If - you have installation problems then information about compilers, make, - etc. is also necessary. + Platform information. This includes the kernel name and version, + C library, processor, memory information, and so on. In most + cases it is sufficient to report the vendor and version, but do + not assume everyone knows what exactly <quote>Debian</quote> + contains or that everyone runs on Pentiums. If you have + installation problems then information about the toolchain on + your machine (compiler, <application>make</application>, and so + on) is also necessary. </para> </listitem> </itemizedlist> @@ -269,7 +278,7 @@ $PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.16 2003/11/29 19:51:37 pgsql E </para> <para> - When writing a bug report, please choose non-confusing terminology. + When writing a bug report, please avoid confusing terminology. The software package in total is called <quote>PostgreSQL</quote>, sometimes <quote>Postgres</quote> for short. If you are specifically talking about the backend server, mention that, do not diff --git a/doc/src/sgml/ref/lock.sgml b/doc/src/sgml/ref/lock.sgml index d1a322633e0..e78ee548fc5 100644 --- a/doc/src/sgml/ref/lock.sgml +++ b/doc/src/sgml/ref/lock.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/lock.sgml,v 1.39 2003/11/29 19:51:39 pgsql Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/lock.sgml,v 1.40 2003/12/14 00:05:29 neilc Exp $ PostgreSQL documentation --> @@ -108,9 +108,10 @@ where <replaceable class="PARAMETER">lockmode</replaceable> is one of: </para> <para> - The command <literal>LOCK a, b;</> is equivalent to - <literal>LOCK a; LOCK b;</>. The tables are locked one-by-one in - the order specified in the <command>LOCK</command> command. + The command <literal>LOCK TABLE a, b;</> is equivalent to + <literal>LOCK TABLE a; LOCK TABLE b;</>. The tables are locked + one-by-one in the order specified in the <command>LOCK + TABLE</command> command. </para> </listitem> </varlistentry> @@ -136,17 +137,18 @@ where <replaceable class="PARAMETER">lockmode</replaceable> is one of: <title>Notes</title> <para> - <literal>LOCK ... IN ACCESS SHARE MODE</> requires <literal>SELECT</> + <literal>LOCK TABLE ... IN ACCESS SHARE MODE</> requires <literal>SELECT</> privileges on the target table. All other forms of <command>LOCK</> require <literal>UPDATE</> and/or <literal>DELETE</> privileges. </para> <para> - <command>LOCK</command> is useful only inside a transaction block - (<command>BEGIN</>/<command>COMMIT</> pair), since the lock is dropped - as soon as the transaction ends. A <command>LOCK</> command appearing - outside any transaction block forms a self-contained transaction, so the - lock will be dropped as soon as it is obtained. + <command>LOCK TABLE</command> is useful only inside a transaction + block (<command>BEGIN</>/<command>COMMIT</> pair), since the lock + is dropped as soon as the transaction ends. A <command>LOCK + TABLE</> command appearing outside any transaction block forms a + self-contained transaction, so the lock will be dropped as soon as + it is obtained. </para> <para> @@ -157,7 +159,11 @@ where <replaceable class="PARAMETER">lockmode</replaceable> is one of: <literal>ROW EXCLUSIVE</> mode is a sharable table lock. Keep in mind that all the lock modes have identical semantics so far as <command>LOCK TABLE</> is concerned, differing only in the rules - about which modes conflict with which. + about which modes conflict with which. For information on how to + acquire an actual row-level lock, see <xref linkend="locking-rows"> + and the <xref linkend="sql-for-update" + endterm="sql-for-update-title"> in the <command>SELECT</command> + reference documentation. </para> </refsect1> |