Skip to content

Commit 1d2e0e6

Browse files
author
Neil Conway
committed
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.
1 parent 1b5cd6d commit 1d2e0e6

File tree

6 files changed

+59
-39
lines changed

6 files changed

+59
-39
lines changed

‎doc/src/sgml/datatype.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.161 2005/10/14 11:47:56 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.162 2005/10/15 01:47:11 neilc Exp $
33
-->
44

55
<chapter id="datatype">
@@ -15,10 +15,10 @@ $PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.161 2005/10/14 11:47:56 momjia
1515
</indexterm>
1616

1717
<para>
18-
<productname>PostgreSQL</productname> has a rich set of native data
19-
types available to users.
20-
Users may add new types to <productname>PostgreSQL</productname> using the
21-
<command>CREATE TYPE</command> command.
18+
<productname>PostgreSQL</productname> has a rich set of native data
19+
types available to users. Users may add new types to
20+
<productname>PostgreSQL</productname> using the <xref
21+
linkend="sql-createtype" endterm="sql-createtype-title"> command.
2222
</para>
2323

2424
<para>

‎doc/src/sgml/extend.sgml

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/extend.sgml,v 1.29 2004/12/30 03:13:56 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/extend.sgml,v 1.30 2005/10/15 01:47:11 neilc Exp $
33
-->
44

55
<chapter id="extend">
@@ -131,12 +131,14 @@ $PostgreSQL: pgsql/doc/src/sgml/extend.sgml,v 1.29 2004/12/30 03:13:56 tgl Exp $
131131

132132
<para>
133133
Composite types, or row types, are created whenever the user
134-
creates a table; it's also possible to define a
135-
<quote>stand-alone</> composite type with no associated table. A
136-
composite type is simply a list of base types with associated
137-
field names. A value of a composite type is a row or record of
138-
field values. The user can access the component fields from
139-
<acronym>SQL</> queries.
134+
creates a table. It is also possible to use <xref
135+
linkend="sql-createtype" endterm="sql-createtype-title"> to
136+
define a <quote>stand-alone</> composite type with no associated
137+
table. A composite type is simply a list of types with
138+
associated field names. A value of a composite type is a row or
139+
record of field values. The user can access the component fields
140+
from <acronym>SQL</> queries. Refer to <xref linkend="rowtypes">
141+
for more information on composite types.
140142
</para>
141143
</sect2>
142144

‎doc/src/sgml/installation.sgml

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/installation.sgml,v 1.241 2005/07/20 23:57:46 tgl Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/installation.sgml,v 1.242 2005/10/15 01:47:11 neilc Exp $ -->
22

33
<chapter id="installation">
44
<title><![%standalone-include[<productname>PostgreSQL</>]]>
@@ -94,9 +94,9 @@ su - postgres
9494

9595
<listitem>
9696
<para>
97-
<application>gzip</> is needed to unpack the distribution in the
98-
first place.<![%standalone-include;[ If you are reading this, you probably already got
99-
past that hurdle.]]>
97+
<application>tar</> is required to unpack the source
98+
distribution in the first place, in addition to either
99+
<application>gzip</> or <application>bzip2</>.
100100
</para>
101101
</listitem>
102102

@@ -120,6 +120,21 @@ su - postgres
120120
</para>
121121
</listitem>
122122

123+
<listitem>
124+
<para>
125+
<indexterm>
126+
<primary>zlib</primary>
127+
</indexterm>
128+
129+
The <productname>zlib</productname> compression library will be
130+
used by default. If you don't want to use it then you must
131+
specify the <option>--without-zlib</option> option for
132+
<filename>configure</filename>. Using this option disables
133+
support for compressed archives in <application>pg_dump</> and
134+
<application>pg_restore</>.
135+
</para>
136+
</listitem>
137+
123138
<listitem>
124139
<para>
125140
<indexterm>

‎doc/src/sgml/plpgsql.sgml

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/plpgsql.sgml,v 1.77 2005/10/06 20:51:20 neilc Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/plpgsql.sgml,v 1.78 2005/10/15 01:47:11 neilc Exp $
33
-->
44

55
<chapter id="plpgsql">
@@ -963,16 +963,17 @@ $$ LANGUAGE plpgsql;
963963
</para>
964964

965965
<para>
966-
In the case of <function>logfunc1</function>, the
967-
<productname>PostgreSQL</productname> main parser knows when
968-
preparing the plan for the <command>INSERT</command>, that the string
969-
<literal>'now'</literal> should be interpreted as
970-
<type>timestamp</type> because the target column of <classname>logtable</classname>
971-
is of that type. Thus, it will make a constant from it at this
972-
time and this constant value is then used in all invocations of
973-
<function>logfunc1</function> during the lifetime of the
974-
session. Needless to say that this isn't what the
975-
programmer wanted.
966+
In the case of <function>logfunc1</function>, the
967+
<productname>PostgreSQL</productname> main parser knows when
968+
preparing the plan for the <command>INSERT</command> that the
969+
string <literal>'now'</literal> should be interpreted as
970+
<type>timestamp</type> because the target column of
971+
<classname>logtable</classname> is of that type. Thus,
972+
<literal>'now'</literal> will be converted to a constant when the
973+
<command>INSERT</command> is planned, and then used in all
974+
invocations of <function>logfunc1</function> during the lifetime
975+
of the session. Needless to say, this isn't what the programmer
976+
wanted.
976977
</para>
977978

978979
<para>
@@ -985,7 +986,7 @@ $$ LANGUAGE plpgsql;
985986
<application>PL/pgSQL</application> interpreter casts this
986987
string to the <type>timestamp</type> type by calling the
987988
<function>text_out</function> and <function>timestamp_in</function>
988-
functions for the conversion. So, the computed time stamp is updated
989+
functions for the conversion. So, the computed timestamp is updated
989990
on each execution as the programmer expects.
990991
</para>
991992

@@ -1452,8 +1453,8 @@ GET DIAGNOSTICS integer_var = ROW_COUNT;
14521453
</itemizedlist>
14531454

14541455
<literal>FOUND</literal> is a local variable within each
1455-
<application>PL/pgSQL</application> function; so any changes
1456-
to it affect only the current function.
1456+
<application>PL/pgSQL</application> function; any changes to it
1457+
affect only the current function.
14571458
</para>
14581459

14591460
</sect2>

‎doc/src/sgml/ref/prepare.sgml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/prepare.sgml,v 1.15 2004/10/29 19:40:33 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/prepare.sgml,v 1.16 2005/10/15 01:47:12 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -63,7 +63,8 @@ PREPARE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable c
6363
also means that a single prepared statement cannot be used by
6464
multiple simultaneous database clients; however, each client can create
6565
their own prepared statement to use. The prepared statement can be
66-
manually cleaned up using the <command>DEALLOCATE</> command.
66+
manually cleaned up using the <xref linkend="sql-deallocate"
67+
endterm="sql-deallocate-title"> command.
6768
</para>
6869

6970
<para>

‎doc/src/sgml/xfunc.sgml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/xfunc.sgml,v 1.105 2005/10/14 20:48:18 adunstan Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/xfunc.sgml,v 1.106 2005/10/15 01:47:12 neilc Exp $
33
-->
44

55
<sect1 id="xfunc">
@@ -881,9 +881,9 @@ CREATE FUNCTION test(int, int) RETURNS int
881881
Every function has a <firstterm>volatility</> classification, with
882882
the possibilities being <literal>VOLATILE</>, <literal>STABLE</>, or
883883
<literal>IMMUTABLE</>. <literal>VOLATILE</> is the default if the
884-
<command>CREATE FUNCTION</command> command does not specify a category.
885-
The volatility category is a promise to the optimizer about the behavior
886-
of the function:
884+
<xref linkend="sql-createfunction" endterm="sql-createfunction-title">
885+
command does not specify a category. The volatility category is a
886+
promise to the optimizer about the behavior of the function:
887887

888888
<itemizedlist>
889889
<listitem>
@@ -1180,8 +1180,9 @@ CREATE FUNCTION square_root(double precision) RETURNS double precision
11801180
file is retained in memory. Future calls in the same session to
11811181
the function(s) in that file will only incur the small overhead of
11821182
a symbol table lookup. If you need to force a reload of an object
1183-
file, for example after recompiling it, use the <command>LOAD</>
1184-
command or begin a fresh session.
1183+
file, for example after recompiling it, use the <xref
1184+
linkend="sql-load" endterm="sql-load-title"> command or begin a
1185+
fresh session.
11851186
</para>
11861187

11871188
<para>
@@ -1652,7 +1653,7 @@ CREATE FUNCTION copytext(text) RETURNS text
16521653
LANGUAGE C STRICT;
16531654

16541655
CREATE FUNCTION concat_text(text, text) RETURNS text
1655-
AS '<replaceable>DIRECTORY</replaceable>/funcs', 'concat_text',
1656+
AS '<replaceable>DIRECTORY</replaceable>/funcs', 'concat_text'
16561657
LANGUAGE C STRICT;
16571658
</programlisting>
16581659
</para>

0 commit comments

Comments
 (0)