Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit80ec228

Browse files
author
Neil Conway
committed
Refer to GUC variables using <xref> tags rather than <varname> tags,
where appropriate. Add "id" and "xreflabel" tags to the descriptionsof the GUC variables to facilitate this. Also make a few minor docscleanups.
1 parent8567bb2 commit80ec228

21 files changed

+344
-303
lines changed

‎doc/src/sgml/backup.sgml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/backup.sgml,v 2.37 2004/02/17 23:56:07 neilc Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/backup.sgml,v 2.38 2004/03/09 16:57:46 neilc Exp $
33
-->
44
<chapter id="backup">
55
<title>Backup and Restore</title>
@@ -156,8 +156,8 @@ pg_dump -h <replaceable>host1</> <replaceable>dbname</> | psql -h <replaceable>h
156156
<tip>
157157
<para>
158158
Restore performance can be improved by increasing the
159-
configuration parameter <varname>maintenance_work_mem</varname>
160-
(see <xreflinkend="runtime-config-resource-memory">).
159+
configuration parameter <xref
160+
linkend="guc-maintenance-work-mem">.
161161
</para>
162162
</tip>
163163
</sect2>

‎doc/src/sgml/charset.sgml‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/charset.sgml,v 2.42 2003/12/30 23:36:19 tgl Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/charset.sgml,v 2.43 2004/03/09 16:57:46 neilc Exp $ -->
22

33
<chapter id="charset">
44
<title>Localization</>
@@ -795,23 +795,23 @@ RESET client_encoding;
795795

796796
<listitem>
797797
<para>
798-
Using <envar>PGCLIENTENCODING</envar>.
799-
800-
Ifenvironment variable <envar>PGCLIENTENCODING</envar>isdefined
801-
in the client's environment, that client encodingisautomatically
802-
selected when a connection to the server is made. (This can subsequently
803-
be overridden using any of the other methods mentioned above.)
798+
Using <envar>PGCLIENTENCODING</envar>. If environment variable
799+
<envar>PGCLIENTENCODING</envar> is defined in the client's
800+
environment, that client encodingisautomatically selected
801+
when a connection to the serverismade. (This can
802+
subsequently be overridden using any of the other methods
803+
mentioned above.)
804804
</para>
805805
</listitem>
806806

807807
<listitem>
808808
<para>
809-
Using the configuration variable <varname>client_encoding</varname>.
810-
811-
If the<varname>client_encoding</> variablein <filename>postgresql.conf</>is set, that
812-
client encoding is automatically selected when a connection to the
813-
server is made. (This can subsequently be overridden using any of the
814-
other methods mentioned above.)
809+
Using the configuration variable <xref
810+
linkend="guc-client-encoding">. If the
811+
<varname>client_encoding</> variable is set, that client
812+
encoding is automatically selected when a connection to the
813+
server is made. (This can subsequently be overridden using any
814+
of theother methods mentioned above.)
815815
</para>
816816
</listitem>
817817

‎doc/src/sgml/client-auth.sgml‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/client-auth.sgml,v 1.63 2004/01/26 05:35:15 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/client-auth.sgml,v 1.64 2004/03/09 16:57:46 neilc Exp $
33
-->
44

55
<chapter id="client-authentication">
@@ -113,8 +113,8 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable>
113113
<para>
114114
This record matches connection attempts made using TCP/IP.
115115
Note that TCP/IP connections are disabled unless the server is
116-
started with the <option>-i</option> option or the
117-
<varname>tcpip_socket</> configuration parameter is
116+
started with the <option>-i</option> option or the <xref
117+
linkend="guc-tcpip-socket"> configuration parameter is
118118
enabled. <literal>host</literal> records match either
119119
<acronym>SSL</acronym> or non-<acronym>SSL</acronym> connection
120120
attempts.
@@ -134,8 +134,8 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable>
134134
<para>
135135
To make use of this option the server must be built with
136136
<acronym>SSL</acronym> support enabled. Furthermore,
137-
<acronym>SSL</acronym> must be enabled by setting the
138-
<varname>ssl</varname> configuration parameter (see <xref
137+
<acronym>SSL</acronym> must be enabled by setting the <xref
138+
linkend="guc-ssl"> configuration parameter (see <xref
139139
linkend="ssl-tcp"> for more information).
140140
</para>
141141
</listitem>
@@ -677,14 +677,14 @@ local db1,db2,@demodbs all md5
677677
</para>
678678

679679
<para>
680-
Make sure that your server key file is readable (and preferably only
681-
readable) by the <productname>PostgreSQL</productname> server
682-
account. (See also <xref linkend="postgres-user">). The location of the
683-
key file is specifiedwith the <varname>krb_server_keyfile</> run-time
684-
configuration parameter. (See also <xref
685-
linkend="runtime-config">.) The default is <filename>/etc/srvtab</>
686-
if you are using Kerberos 4 and
687-
<filename>FILE:/usr/local/pgsql/etc/krb5.keytab</> (or whichever
680+
Make sure that your server key file is readable (and preferably
681+
onlyreadable) by the <productname>PostgreSQL</productname> server
682+
account. (See also <xref linkend="postgres-user">). The location
683+
of thekey file is specifiedby the <xref
684+
linkend="guc-krb-server-keyfile"> run-time configuration
685+
parameter. (See also <xreflinkend="runtime-config">.) The default
686+
is <filename>/etc/srvtab</>if you are using Kerberos 4 and
687+
<filename>/usr/local/pgsql/etc/krb5.keytab</> (or whichever
688688
directory was specified as <varname>sysconfdir</> at build time)
689689
with Kerberos 5.
690690
</para>

‎doc/src/sgml/datatype.sgml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.142 2004/02/01 06:55:07 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.143 2004/03/09 16:57:46 neilc Exp $
33
-->
44

55
<chapter id="datatype">
@@ -1409,7 +1409,7 @@ SELECT b, char_length(b) FROM test2;
14091409
traditional <productname>POSTGRES</productname>, and others.
14101410
For some formats, ordering of month, day, and year in date input is
14111411
ambiguous and there is support for specifying the expected
1412-
ordering of these fields. Set the <varname>datestyle</> parameter
1412+
ordering of these fields. Set the <xref linkend="guc-datestyle"> parameter
14131413
to <literal>MDY</> to select month-day-year interpretation,
14141414
<literal>DMY</> to select day-month-year interpretation, or
14151415
<literal>YMD</> to select year-month-day interpretation.
@@ -1720,7 +1720,7 @@ January 8 04:05:06 1999 PST
17201720
time zone specified is converted to UTC using the appropriate offset
17211721
for that time zone. If no time zone is stated in the input string,
17221722
then it is assumed to be in the time zone indicated by the system's
1723-
<varname>timezone</> parameter, and is converted to UTC using the
1723+
<xref linkend="guc-timezone"> parameter, and is converted to UTC using the
17241724
offset for the <varname>timezone</> zone.
17251725
</para>
17261726

@@ -1993,8 +1993,8 @@ January 8 04:05:06 1999 PST
19931993

19941994
<para>
19951995
The date/time styles can be selected by the user using the
1996-
<command>SET datestyle</command> command, the
1997-
<varname>datestyle</varname> parameter in the
1996+
<command>SET datestyle</command> command, the <xref
1997+
linkend="guc-datestyle"> parameter in the
19981998
<filename>postgresql.conf</filename> configuration file, or the
19991999
<envar>PGDATESTYLE</envar> environment variable on the server or
20002000
client. The formatting function <function>to_char</function>
@@ -2092,8 +2092,8 @@ January 8 04:05:06 1999 PST
20922092

20932093
<listitem>
20942094
<para>
2095-
The <varname>timezone</varname> configuration parameter can be
2096-
set in the file <filename>postgresql.conf</>.
2095+
The <xref linkend="guc-timezone"> configuration parameter can
2096+
beset in the file <filename>postgresql.conf</>.
20972097
</para>
20982098
</listitem>
20992099

@@ -2929,7 +2929,7 @@ SELECT * FROM test;
29292929
<productname>PostgreSQL</productname> as primary keys for various
29302930
system tables. An OID system column is also added to user-created
29312931
tables, unless <literal>WITHOUT OIDS</literal> is specified when
2932-
the table is created, or the <varname>default_with_oids</varname>
2932+
the table is created, or the <xref linkend="guc-default-with-oids">
29332933
configuration variable is set to false. Type <type>oid</>
29342934
represents an object identifier. There are also several alias
29352935
types for <type>oid</>: <type>regproc</>, <type>regprocedure</>,

‎doc/src/sgml/func.sgml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.192 2004/03/07 01:01:44 neilc Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.193 2004/03/09 16:57:46 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -311,7 +311,7 @@ PostgreSQL documentation
311311
returns true if <replaceable>expression</replaceable> evaluates to
312312
the null value. It is highly recommended that these applications
313313
be modified to comply with the SQL standard. However, if that
314-
cannot be done the <varname>transform_null_equals</varname>
314+
cannot be done the <xref linkend="guc-transform-null-equals">
315315
configuration variable is available. If it is enabled,
316316
<productname>PostgreSQL</productname> will convert <literal>x =
317317
NULL</literal> clauses to <literal>x IS NULL</literal>. This was
@@ -2715,12 +2715,12 @@ substring('foobar' from 'o(.)b') <lineannotation>o</lineannotation>
27152715

27162716
<note>
27172717
<para>
2718-
The form of regular expressions accepted by <productname>PostgreSQL</>
2719-
can be chosen by setting the <varname>regex_flavor</> run-time parameter
2720-
(described in <xreflinkend="runtime-config">). The usual setting is
2721-
<literal>advanced</>, but one might choose <literal>extended</> for
2722-
maximum backwards compatibility with pre-7.4 releases of
2723-
<productname>PostgreSQL</>.
2718+
The form of regular expressions accepted by
2719+
<productname>PostgreSQL</>can be chosen by setting the <xref
2720+
linkend="guc-regex-flavor"> run-time parameter. The usual
2721+
setting is<literal>advanced</>, but one might choose
2722+
<literal>extended</> formaximum backwards compatibility with
2723+
pre-7.4 releases of<productname>PostgreSQL</>.
27242724
</para>
27252725
</note>
27262726

‎doc/src/sgml/perform.sgml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/perform.sgml,v 1.41 2004/02/03 17:34:02 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/perform.sgml,v 1.42 2004/03/09 16:57:46 neilc Exp $
33
-->
44

55
<chapter id="performance-tips">
@@ -508,7 +508,7 @@ SELECT * FROM a, b, c WHERE a.id = b.id AND b.ref = c.id;
508508
<productname>PostgreSQL</productname> planner will switch from exhaustive
509509
search to a <firstterm>genetic</firstterm> probabilistic search
510510
through a limited number of possibilities. (The switch-over threshold is
511-
set by the <varname>geqo_threshold</varname> run-time
511+
set by the <xref linkend="guc-geqo-threshold"> run-time
512512
parameter.)
513513
The genetic search takes less time, but it won't
514514
necessarily find the best possible plan.
@@ -549,7 +549,7 @@ SELECT * FROM a JOIN (b JOIN c ON (b.ref = c.id)) ON (a.id = b.id);
549549

550550
<para>
551551
To force the planner to follow the <literal>JOIN</> order for inner joins,
552-
set the <varname>join_collapse_limit</> run-time parameter to 1.
552+
set the <xref linkend="guc-join-collapse-limit"> run-time parameter to 1.
553553
(Other possible values are discussed below.)
554554
</para>
555555

@@ -599,8 +599,8 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse;
599599
problem replacing two separate three-way join problems. Because of the
600600
exponential growth of the number of possibilities, this makes a big
601601
difference. The planner tries to avoid getting stuck in huge join search
602-
problems by not collapsing a subquery if more than
603-
<varname>from_collapse_limit</> <literal>FROM</> items would result in the parent
602+
problems by not collapsing a subquery if more than <xref linkend="guc-from-collapse-limit">
603+
<literal>FROM</> items would result in the parent
604604
query. You can trade off planning time against quality of plan by
605605
adjusting this run-time parameter up or down.
606606
</para>
@@ -688,11 +688,11 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse;
688688
<title>Increase <varname>maintenance_work_mem</varname></title>
689689

690690
<para>
691-
Temporarily increasing the <varname>maintenance_work_mem</varname>
691+
Temporarily increasing the <xref linkend="guc-maintenance-work-mem">
692692
configuration variable when restoring large amounts of data can
693693
lead to improved performance. This is because when a B-tree index
694694
is created from scratch, the existing content of the table needs
695-
to be sorted. Allowing the merge sort to use more memory
695+
to be sorted. Allowing theexternalmerge sort to use more memory
696696
means that fewer merge passes will be required. A larger setting for
697697
<varname>maintenance_work_mem</varname> may also speed up validation
698698
of foreign-key constraints.

‎doc/src/sgml/problems.sgml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.17 2003/12/14 00:05:29 neilc Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.18 2004/03/09 16:57:46 neilc Exp $
33
-->
44

55
<sect1 id="bug-reporting">
@@ -173,7 +173,7 @@ $PostgreSQL: pgsql/doc/src/sgml/problems.sgml,v 2.17 2003/12/14 00:05:29 neilc E
173173
form of the message. In <application>psql</>, say <literal>\set
174174
VERBOSITY verbose</> beforehand. If you are extracting the message
175175
from the server log, set the run-time parameter
176-
<varname>log_error_verbosity</> to <literal>verbose</> so that all
176+
<xref linkend="guc-log-error-verbosity"> to <literal>verbose</> so that all
177177
details are logged.
178178
</para>
179179
</note>

‎doc/src/sgml/protocol.sgml‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/protocol.sgml,v 1.49 2003/12/14 00:10:32 neilc Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/protocol.sgml,v 1.50 2004/03/09 16:57:46 neilc Exp $ -->
22

33
<chapter id="protocol">
44
<title>Frontend/Backend Protocol</title>
@@ -390,12 +390,13 @@
390390
<ListItem>
391391
<Para>
392392
This message informs the frontend about the current (initial)
393-
setting of backend parameters, such as <varname>client_encoding</>
394-
or <varname>DateStyle</>. The frontend may ignore this message,
395-
or record the settings for its future use; see
396-
<xref linkend="protocol-async"> for more detail.
397-
The frontend should not respond to this message, but should
398-
continue listening for a ReadyForQuery message.
393+
setting of backend parameters, such as <xref
394+
linkend="guc-client-encoding"> or <xref linkend="guc-datestyle">.
395+
The frontend may ignore this message, or record the settings
396+
for its future use; see <xref linkend="protocol-async"> for
397+
more details. The frontend should not respond to this
398+
message, but should continue listening for a ReadyForQuery
399+
message.
399400
</Para>
400401
</ListItem>
401402
</VarListEntry>

‎doc/src/sgml/ref/alter_table.sgml‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.65 2004/03/01 17:58:39 neilc Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.66 2004/03/09 16:57:47 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -123,6 +123,11 @@ ALTER TABLE <replaceable class="PARAMETER">name</replaceable>
123123
</varlistentry>
124124

125125
<varlistentry>
126+
<indexterm>
127+
<primary>TOAST</primary>
128+
<secondary>per-column storage settings</secondary>
129+
</indexterm>
130+
126131
<term><literal>SET STORAGE</literal></term>
127132
<listitem>
128133
<para>
@@ -240,7 +245,7 @@ ALTER TABLE <replaceable class="PARAMETER">name</replaceable>
240245
to be altered, but in the current version, this is the default
241246
behavior. (In releases before 7.1, <literal>ONLY</> was the
242247
default behavior. The default can be altered by changing the
243-
configuration parameter <varname>sql_inheritance</varname>.)
248+
configuration parameter <xref linkend="guc-sql-inheritance">.)
244249
</para>
245250
</listitem>
246251
</varlistentry>

‎doc/src/sgml/ref/analyze.sgml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/analyze.sgml,v 1.18 2003/12/14 00:15:03 neilc Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/analyze.sgml,v 1.19 2004/03/09 16:57:47 neilc Exp $
33
PostgreSQL documentation
44
-->
55

@@ -134,7 +134,7 @@ ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<rep
134134

135135
<para>
136136
The extent of analysis can be controlled by adjusting the
137-
<varname>default_statistics_target</varname> parameter variable, or
137+
<xref linkend="guc-default-statistics-target"> configuration variable, or
138138
on a column-by-column basis by setting the per-column statistics
139139
target with <command>ALTER TABLE ... ALTER COLUMN ... SET
140140
STATISTICS</command> (see <xref linkend="sql-altertable"

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp