summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNeil Conway2005-10-15 01:47:12 +0000
committerNeil Conway2005-10-15 01:47:12 +0000
commit37c7077587050970ead6a766a263ff4e9101a9fe (patch)
tree52157b4896da06297b099e8b6a87c2add2c30b1d
parent11c62b428a05ee72d8e98a6dff4b8eb5b8341ba6 (diff)
Merge some user-submitted suggestions for improvement into the
documentation. Mostly add some <xref>s, fix a few typos, and document that zlib is required in the installation docs.
-rw-r--r--doc/src/sgml/datatype.sgml8
-rw-r--r--doc/src/sgml/extend.sgml14
-rw-r--r--doc/src/sgml/installation.sgml21
-rw-r--r--doc/src/sgml/plpgsql.sgml27
-rw-r--r--doc/src/sgml/ref/prepare.sgml3
-rw-r--r--doc/src/sgml/xfunc.sgml13
6 files changed, 53 insertions, 33 deletions
diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml
index 44b7160a29..ed4971203f 100644
--- a/doc/src/sgml/datatype.sgml
+++ b/doc/src/sgml/datatype.sgml
@@ -15,10 +15,10 @@ $PostgreSQL$
</indexterm>
<para>
- <productname>PostgreSQL</productname> has a rich set of native data
- types available to users.
- Users may add new types to <productname>PostgreSQL</productname> using the
- <command>CREATE TYPE</command> command.
+ <productname>PostgreSQL</productname> has a rich set of native data
+ types available to users. Users may add new types to
+ <productname>PostgreSQL</productname> using the <xref
+ linkend="sql-createtype" endterm="sql-createtype-title"> command.
</para>
<para>
diff --git a/doc/src/sgml/extend.sgml b/doc/src/sgml/extend.sgml
index 1279abff6c..ec5314d1c3 100644
--- a/doc/src/sgml/extend.sgml
+++ b/doc/src/sgml/extend.sgml
@@ -131,12 +131,14 @@ $PostgreSQL$
<para>
Composite types, or row types, are created whenever the user
- creates a table; it's also possible to define a
- <quote>stand-alone</> composite type with no associated table. A
- composite type is simply a list of base types with associated
- field names. A value of a composite type is a row or record of
- field values. The user can access the component fields from
- <acronym>SQL</> queries.
+ creates a table. It is also possible to use <xref
+ linkend="sql-createtype" endterm="sql-createtype-title"> to
+ define a <quote>stand-alone</> composite type with no associated
+ table. A composite type is simply a list of types with
+ associated field names. A value of a composite type is a row or
+ record of field values. The user can access the component fields
+ from <acronym>SQL</> queries. Refer to <xref linkend="rowtypes">
+ for more information on composite types.
</para>
</sect2>
diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml
index 03e527c1e7..c2078cec5b 100644
--- a/doc/src/sgml/installation.sgml
+++ b/doc/src/sgml/installation.sgml
@@ -94,9 +94,9 @@ su - postgres
<listitem>
<para>
- <application>gzip</> is needed to unpack the distribution in the
- first place.<![%standalone-include;[ If you are reading this, you probably already got
- past that hurdle.]]>
+ <application>tar</> is required to unpack the source
+ distribution in the first place, in addition to either
+ <application>gzip</> or <application>bzip2</>.
</para>
</listitem>
@@ -123,6 +123,21 @@ su - postgres
<listitem>
<para>
<indexterm>
+ <primary>zlib</primary>
+ </indexterm>
+
+ The <productname>zlib</productname> compression library will be
+ used by default. If you don't want to use it then you must
+ specify the <option>--without-zlib</option> option for
+ <filename>configure</filename>. Using this option disables
+ support for compressed archives in <application>pg_dump</> and
+ <application>pg_restore</>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
<primary>installation</primary>
<secondary>on Windows</secondary>
</indexterm>
diff --git a/doc/src/sgml/plpgsql.sgml b/doc/src/sgml/plpgsql.sgml
index 727e885bb1..5fc56dd1bb 100644
--- a/doc/src/sgml/plpgsql.sgml
+++ b/doc/src/sgml/plpgsql.sgml
@@ -963,16 +963,17 @@ $$ LANGUAGE plpgsql;
</para>
<para>
- In the case of <function>logfunc1</function>, the
- <productname>PostgreSQL</productname> main parser knows when
- preparing the plan for the <command>INSERT</command>, that the string
- <literal>'now'</literal> should be interpreted as
- <type>timestamp</type> because the target column of <classname>logtable</classname>
- is of that type. Thus, it will make a constant from it at this
- time and this constant value is then used in all invocations of
- <function>logfunc1</function> during the lifetime of the
- session. Needless to say that this isn't what the
- programmer wanted.
+ In the case of <function>logfunc1</function>, the
+ <productname>PostgreSQL</productname> main parser knows when
+ preparing the plan for the <command>INSERT</command> that the
+ string <literal>'now'</literal> should be interpreted as
+ <type>timestamp</type> because the target column of
+ <classname>logtable</classname> is of that type. Thus,
+ <literal>'now'</literal> will be converted to a constant when the
+ <command>INSERT</command> is planned, and then used in all
+ invocations of <function>logfunc1</function> during the lifetime
+ of the session. Needless to say, this isn't what the programmer
+ wanted.
</para>
<para>
@@ -985,7 +986,7 @@ $$ LANGUAGE plpgsql;
<application>PL/pgSQL</application> interpreter casts this
string to the <type>timestamp</type> type by calling the
<function>text_out</function> and <function>timestamp_in</function>
- functions for the conversion. So, the computed time stamp is updated
+ functions for the conversion. So, the computed timestamp is updated
on each execution as the programmer expects.
</para>
@@ -1452,8 +1453,8 @@ GET DIAGNOSTICS integer_var = ROW_COUNT;
</itemizedlist>
<literal>FOUND</literal> is a local variable within each
- <application>PL/pgSQL</application> function; so any changes
- to it affect only the current function.
+ <application>PL/pgSQL</application> function; any changes to it
+ affect only the current function.
</para>
</sect2>
diff --git a/doc/src/sgml/ref/prepare.sgml b/doc/src/sgml/ref/prepare.sgml
index c87721cce8..594fff28f3 100644
--- a/doc/src/sgml/ref/prepare.sgml
+++ b/doc/src/sgml/ref/prepare.sgml
@@ -63,7 +63,8 @@ PREPARE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable c
also means that a single prepared statement cannot be used by
multiple simultaneous database clients; however, each client can create
their own prepared statement to use. The prepared statement can be
- manually cleaned up using the <command>DEALLOCATE</> command.
+ manually cleaned up using the <xref linkend="sql-deallocate"
+ endterm="sql-deallocate-title"> command.
</para>
<para>
diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml
index 003a402a2e..38feb3ae00 100644
--- a/doc/src/sgml/xfunc.sgml
+++ b/doc/src/sgml/xfunc.sgml
@@ -881,9 +881,9 @@ CREATE FUNCTION test(int, int) RETURNS int
Every function has a <firstterm>volatility</> classification, with
the possibilities being <literal>VOLATILE</>, <literal>STABLE</>, or
<literal>IMMUTABLE</>. <literal>VOLATILE</> is the default if the
- <command>CREATE FUNCTION</command> command does not specify a category.
- The volatility category is a promise to the optimizer about the behavior
- of the function:
+ <xref linkend="sql-createfunction" endterm="sql-createfunction-title">
+ command does not specify a category. The volatility category is a
+ promise to the optimizer about the behavior of the function:
<itemizedlist>
<listitem>
@@ -1180,8 +1180,9 @@ CREATE FUNCTION square_root(double precision) RETURNS double precision
file is retained in memory. Future calls in the same session to
the function(s) in that file will only incur the small overhead of
a symbol table lookup. If you need to force a reload of an object
- file, for example after recompiling it, use the <command>LOAD</>
- command or begin a fresh session.
+ file, for example after recompiling it, use the <xref
+ linkend="sql-load" endterm="sql-load-title"> command or begin a
+ fresh session.
</para>
<para>
@@ -1652,7 +1653,7 @@ CREATE FUNCTION copytext(text) RETURNS text
LANGUAGE C STRICT;
CREATE FUNCTION concat_text(text, text) RETURNS text
- AS '<replaceable>DIRECTORY</replaceable>/funcs', 'concat_text',
+ AS '<replaceable>DIRECTORY</replaceable>/funcs', 'concat_text'
LANGUAGE C STRICT;
</programlisting>
</para>