Commit cda1bd6c authored by Neil Conway's avatar Neil Conway

Various minor improvements to the SGML documentation: fix some incorrect

SGML markup, add a "deprecated features" section to the 8.0 release
notes, untabify release.sgml and runtime.sgml, and make some other
minor improvements.
parent 4dbb880d
<!-- $PostgreSQL: pgsql/doc/src/sgml/errcodes.sgml,v 1.7 2004/07/31 23:04:54 tgl Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/errcodes.sgml,v 1.8 2004/08/24 00:06:50 neilc Exp $ -->
<appendix id="errcodes-appendix">
<title><productname>PostgreSQL</productname> Error Codes</title>
......@@ -1133,7 +1133,7 @@
<row>
<entry>Class 58</entry>
<entry>System Error (errors external to PostgreSQL itself)</entry>
<entry>System Error (errors external to <productname>PostgreSQL</> itself)</entry>
</row>
<row>
......
<!--
$PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.18 2004/03/09 16:57:46 neilc Exp $
$PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.19 2004/08/24 00:06:50 neilc Exp $
-->
<sect1 id="bug-reporting">
......@@ -11,8 +11,7 @@ $PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.18 2004/03/09 16:57:46 neilc E
<productname>PostgreSQL</productname> more reliable because even the utmost
care cannot guarantee that every part of
<productname>PostgreSQL</productname>
will work on every
platform under every circumstance.
will work on every platform under every circumstance.
</para>
<para>
......@@ -241,9 +240,9 @@ $PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.18 2004/03/09 16:57:46 neilc E
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.
sites using older releases of <productname>PostgreSQL</>; if you
require more than we can provide, consider acquiring a
commercial support contract.
</para>
<para>
</para>
......
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_index.sgml,v 1.3 2004/08/21 16:16:04 tgl Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_index.sgml,v 1.4 2004/08/24 00:06:51 neilc Exp $
PostgreSQL documentation
-->
......@@ -167,7 +167,8 @@ ALTER INDEX distributors SET TABLESPACE fasttablespace;
<title>Compatibility</title>
<para>
<literal>ALTER INDEX</> is a PostgreSQL extension.
<command>ALTER INDEX</> is a <productname>PostgreSQL</productname>
extension.
</para>
</refsect1>
</refentry>
......
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_sequence.sgml,v 1.7 2003/11/29 19:51:38 pgsql Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_sequence.sgml,v 1.8 2004/08/24 00:06:51 neilc Exp $
PostgreSQL documentation
-->
......@@ -14,7 +14,7 @@ PostgreSQL documentation
ALTER SEQUENCE
</refname>
<refpurpose>
alter the definition of a sequence generator
change the definition of a sequence generator
</refpurpose>
</refnamediv>
......
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.22 2004/08/04 21:33:42 tgl Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.23 2004/08/24 00:06:51 neilc Exp $
PostgreSQL documentation
-->
......@@ -11,7 +11,7 @@ PostgreSQL documentation
<refnamediv>
<refname>CREATE TABLE AS</refname>
<refpurpose>create a new table from the results of a query</refpurpose>
<refpurpose>define a new table from the results of a query</refpurpose>
</refnamediv>
<indexterm zone="sql-createtableas">
......
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/create_tablespace.sgml,v 1.3 2004/08/02 04:25:37 tgl Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/create_tablespace.sgml,v 1.4 2004/08/24 00:06:51 neilc Exp $
PostgreSQL documentation
-->
......@@ -34,8 +34,8 @@ CREATE TABLESPACE <replaceable class="parameter">tablespacename</replaceable> [
</para>
<para>
A tablespace allows superusers to define an alternative location on the
file system where the data files representing database objects
A tablespace allows superusers to define an alternative location on
the file system where the data files containing database objects
(such as tables and indexes) may reside.
</para>
......
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.120 2004/08/14 23:49:07 tgl Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.121 2004/08/24 00:06:51 neilc Exp $
PostgreSQL documentation
-->
......@@ -771,7 +771,7 @@ testdb=>
<listitem>
<para>
Shows the copyright and distribution terms of
<application>PostgreSQL</application>.
<productname>PostgreSQL</productname>.
</para>
</listitem>
</varlistentry>
......
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/release_savepoint.sgml,v 1.1 2004/08/12 19:12:21 tgl Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/release_savepoint.sgml,v 1.2 2004/08/24 00:06:51 neilc Exp $
PostgreSQL documentation
-->
......@@ -77,7 +77,7 @@ RELEASE [ SAVEPOINT ] <replaceable>savepoint_name</replaceable>
<para>
It is not possible to release a savepoint when the transaction is in
aborted state.
an aborted state.
</para>
<para>
......@@ -108,9 +108,11 @@ COMMIT;
<title>Compatibility</title>
<para>
The SQL2003 standard specifies that the keyword SAVEPOINT is mandatory.
<productname>PostgreSQL</productname> allows the SAVEPOINT keyword to be
omitted. Otherwise, this command is fully conforming.
The SQL2003 standard specifies that the keyword
<literal>SAVEPOINT</literal> is mandatory.
<productname>PostgreSQL</productname> allows the
<literal>SAVEPOINT</literal> keyword to be omitted. Otherwise, this
command is fully conforming.
</para>
</refsect1>
......
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/rollback_to.sgml,v 1.2 2004/08/12 19:12:21 tgl Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/rollback_to.sgml,v 1.3 2004/08/24 00:06:51 neilc Exp $
PostgreSQL documentation
-->
......@@ -128,13 +128,15 @@ COMMIT;
<title>Compatibility</title>
<para>
The SQL2003 standard specifies that the keyword SAVEPOINT is mandatory.
<productname>PostgreSQL</productname> and <productname>Oracle</productname>
allow the SAVEPOINT keyword to be omitted. SQL2003 allows only
WORK, not TRANSACTION, as a noise word after ROLLBACK. Also, SQL2003
has an optional clause AND [ NO ] CHAIN which is not currently supported
by <productname>PostgreSQL</productname>. Otherwise, this command is
fully conforming.
The SQL2003 standard specifies that the keyword
<literal>SAVEPOINT</> is mandatory. <productname>PostgreSQL</> and
<productname>Oracle</> allow the <literal>SAVEPOINT</literal>
keyword to be omitted. SQL2003 allows only <literal>WORK</>, not
<literal>TRANSACTION</>, as a noise word after
<literal>ROLLBACK</>. Also, SQL2003 has an optional clause
<literal>AND [ NO ] CHAIN</> which is not currently supported by
<productname>PostgreSQL</>. Otherwise, this command is fully
conforming.
</para>
</refsect1>
......
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/select_into.sgml,v 1.29 2004/08/04 21:33:42 tgl Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/select_into.sgml,v 1.30 2004/08/24 00:06:51 neilc Exp $
PostgreSQL documentation
-->
......@@ -11,7 +11,7 @@ PostgreSQL documentation
<refnamediv>
<refname>SELECT INTO</refname>
<refpurpose>create a new table from the results of a query</refpurpose>
<refpurpose>define a new table from the results of a query</refpurpose>
</refnamediv>
<indexterm zone="sql-selectinto">
......
This diff is collapsed.
<!--
$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.278 2004/08/16 02:12:29 tgl Exp $
$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.279 2004/08/24 00:06:50 neilc Exp $
-->
<Chapter Id="runtime">
......@@ -1206,17 +1206,16 @@ SET ENABLE_SEQSCAN TO OFF;
<listitem>
<para>
Specifies the delay between activity rounds for the
background writer. In each round the writer issues writes for some
number of dirty buffers (controllable by the following parameters).
The selected buffers will always be the
least recently used ones among the currently dirty buffers.
It then sleeps for <varname>bgwriter_delay</varname> milliseconds,
and repeats.
Note that on many systems, the effective resolution
of sleep delays is 10 milliseconds; setting
<varname>bgwriter_delay</varname> to a value that is
not a multiple of 10 may have the same results as setting it
to the next higher multiple of 10.
background writer. In each round the writer issues writes
for some number of dirty buffers (controllable by the
following parameters). The selected buffers will always be
the least recently used ones among the currently dirty
buffers. It then sleeps for <varname>bgwriter_delay</>
milliseconds, and repeats. The default value is 200. Note
that on many systems, the effective resolution of sleep
delays is 10 milliseconds; setting <varname>bgwriter_delay</>
to a value that is not a multiple of 10 may have the same
results as setting it to the next higher multiple of 10.
This option can only be set at server start or in the
<filename>postgresql.conf</filename> file.
</para>
......@@ -1227,10 +1226,10 @@ SET ENABLE_SEQSCAN TO OFF;
<term><varname>bgwriter_percent</varname> (<type>integer</type>)</term>
<listitem>
<para>
In each round, no more than this percentage of the currently dirty
buffers will be written (rounding up any fraction to the next whole
number of buffers).
This option can only be set at server start or in the
In each round, no more than this percentage of the currently
dirty buffers will be written (rounding up any fraction to
the next whole number of buffers). The default value is
1. This option can only be set at server start or in the
<filename>postgresql.conf</filename> file.
</para>
</listitem>
......@@ -1240,8 +1239,9 @@ SET ENABLE_SEQSCAN TO OFF;
<term><varname>bgwriter_maxpages</varname> (<type>integer</type>)</term>
<listitem>
<para>
In each round, no more than this many dirty buffers will be written.
This option can only be set at server start or in the
In each round, no more than this many dirty buffers will be
written. The default value is 100. This option can only be
set at server start or in the
<filename>postgresql.conf</filename> file.
</para>
</listitem>
......@@ -1250,9 +1250,10 @@ SET ENABLE_SEQSCAN TO OFF;
<para>
Smaller values of <varname>bgwriter_percent</varname> and
<varname>bgwriter_maxpages</varname> reduce the extra I/O load caused by
the background writer, but leave more work to be done at checkpoint
time. To reduce load spikes at checkpoints, increase the values.
<varname>bgwriter_maxpages</varname> reduce the extra I/O load
caused by the background writer, but leave more work to be done
at checkpoint time. To reduce load spikes at checkpoints,
increase the values.
</para>
</sect3>
......
<!--
$PostgreSQL: pgsql/doc/src/sgml/xfunc.sgml,v 1.85 2004/07/30 12:26:39 petere Exp $
$PostgreSQL: pgsql/doc/src/sgml/xfunc.sgml,v 1.86 2004/08/24 00:06:50 neilc Exp $
-->
<sect1 id="xfunc">
......@@ -1618,17 +1618,18 @@ concat_text(PG_FUNCTION_ARGS)
</indexterm>
<para>
If you are thinking about distributing your PostgreSQL extension
modules, setting up a portable build system for them can be fairly
difficult. Therefore the PostgreSQL installation provides a build
If you are thinking about distributing your
<productname>PostgreSQL</> extension modules, setting up a
portable build system for them can be fairly difficult. Therefore
the <productname>PostgreSQL</> installation provides a build
infrastructure for extensions, called <acronym>PGXS</acronym>, so
that simple extension modules can be built simply against an
already installed server. Note that this infrastructure is not
intended to be a universal build system framework that can be used
to build all software interfacing to PostgreSQL; it simply
automates common build rules for simple server extension modules.
For more complicated packages, you need to write your own build
system.
to build all software interfacing to <productname>PostgreSQL</>;
it simply automates common build rules for simple server extension
modules. For more complicated packages, you need to write your
own build system.
</para>
<para>
......@@ -1807,14 +1808,13 @@ include $(PGXS)
<title>Composite-Type Arguments in C-Language Functions</title>
<para>
Composite types do not have a fixed layout like C
structures. Instances of a composite type may contain
null fields. In addition, composite types that are
part of an inheritance hierarchy may have different
fields than other members of the same inheritance hierarchy.
Therefore, <productname>PostgreSQL</productname> provides
a function interface for accessing fields of composite types
from C.
Composite types do not have a fixed layout like C structures.
Instances of a composite type may contain null fields. In
addition, composite types that are part of an inheritance
hierarchy may have different fields than other members of the
same inheritance hierarchy. Therefore,
<productname>PostgreSQL</productname> provides a function
interface for accessing fields of composite types from C.
</para>
<para>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment