Skip to content

Commit 159e3d8

Browse files
committed
Update contrib documention mentions to point to actual documentation
sections, rather than just calling it "/contrib/module_name". Also update pg_test_fsync build instructions now that it is in /contrib.
1 parent e84730a commit 159e3d8

19 files changed

+57
-59
lines changed

doc/src/sgml/contrib-spi.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</indexterm>
1010

1111
<para>
12-
The <filename>contrib/spi</> module provides several workable examples
12+
The <application>spi</> module provides several workable examples
1313
of using SPI and triggers. While these functions are of some value in
1414
their own right, they are even more useful as examples to modify for
1515
your own purposes. The functions are general enough to be used

doc/src/sgml/datatype.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3917,9 +3917,9 @@ a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11
39173917
<productname>PostgreSQL</productname> provides storage and comparison
39183918
functions for UUIDs, but the core database does not include any
39193919
function for generating UUIDs, because no single algorithm is well
3920-
suited for every application. The contrib module
3921-
<filename>contrib/uuid-ossp</filename> provides functions that implement
3922-
several standard algorithms.
3920+
suited for every application. The <xref
3921+
linkend="uuid-ossp"> module
3922+
provides functions that implement several standard algorithms.
39233923
Alternatively, UUIDs could be generated by client applications or
39243924
other libraries invoked through a server-side function.
39253925
</para>

doc/src/sgml/dblink.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ SELECT dblink_disconnect('myconn');
303303
</refsect1>
304304
</refentry>
305305

306-
<refentry id="CONTRIB-DBLINK">
306+
<refentry id="CONTRIB-DBLINK-FUNCTION">
307307
<refmeta>
308308
<refentrytitle>dblink</refentrytitle>
309309
<manvolnum>3</manvolnum>

doc/src/sgml/diskusage.sgml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,9 @@
3131
<para>
3232
You can monitor disk space in three ways:
3333
using the SQL functions listed in <xref linkend="functions-admin-dbsize">,
34-
using the tools in <filename>contrib/oid2name</>, or
34+
using the <xref linkend="oid2name"> module, or
3535
using manual inspection of the system catalogs.
3636
The SQL functions are the easiest to use and are generally recommended.
37-
<filename>contrib/oid2name</> is described in <xref linkend="oid2name">.
3837
The remainder of this section shows how to do it by inspection of the
3938
system catalogs.
4039
</para>

doc/src/sgml/high-availability.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -966,8 +966,8 @@ primary_conninfo = 'host=192.168.1.50 port=5432 user=foo password=foopass'
966966
sections is to use a <varname>restore_command</> that polls the archive location.
967967
This was the only option available in versions 8.4 and below. In this
968968
setup, set <varname>standby_mode</> off, because you are implementing
969-
the polling required for standby operation yourself. See
970-
contrib/pg_standby (<xref linkend="pgstandby">) for a reference
969+
the polling required for standby operation yourself. See the
970+
<xref linkend="pgstandby"> module for a reference
971971
implementation of this.
972972
</para>
973973

@@ -1027,7 +1027,7 @@ if (!triggered)
10271027

10281028
<para>
10291029
A working example of a waiting <varname>restore_command</> is provided
1030-
as a <filename>contrib</> module named <application>pg_standby</>. It
1030+
in the <xref linkend="pgstandby"> module. It
10311031
should be used as a reference on how to correctly implement the logic
10321032
described above. It can also be extended as needed to support specific
10331033
configurations and environments.
@@ -1542,7 +1542,7 @@ if (!triggered)
15421542
primary server and keep a query active for as long as needed to
15431543
run queries on the standby. This prevents <command>VACUUM</> from removing
15441544
recently-dead rows and so cleanup conflicts do not occur.
1545-
This could be done using <filename>contrib/dblink</> and
1545+
This could be done using <xref linkend="dblink"> and
15461546
<function>pg_sleep()</>, or via other mechanisms. If you do this, you
15471547
should note that this will delay cleanup of dead rows on the primary,
15481548
which may result in undesirable table bloat. However, the cleanup

doc/src/sgml/installation.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1007,8 +1007,8 @@ su - postgres
10071007
<listitem>
10081008
<para>
10091009
Use the <ulink url="http://www.ossp.org/pkg/lib/uuid/">OSSP UUID
1010-
library</ulink> when building <filename>contrib/uuid-ossp</>.
1011-
The library provides functions to generate
1010+
library</ulink> when building the <xref linkend="uuid-ossp">
1011+
module. The library provides functions to generate
10121012
UUIDs.<indexterm><primary>UUID</primary></indexterm>
10131013
</para>
10141014
</listitem>
@@ -1041,9 +1041,9 @@ su - postgres
10411041
<term><option>--with-libxslt</option></term>
10421042
<listitem>
10431043
<para>
1044-
Use libxslt when building <filename>contrib/xml2</>.
1045-
<filename>contrib/xml2</> relies on this library to perform
1046-
XSL transformations of XML.
1044+
Use libxslt when building the <xref linkend="xml2">
1045+
module. <application>xml2</> relies on this library
1046+
to perform XSL transformations of XML.
10471047
</para>
10481048
</listitem>
10491049
</varlistentry>

doc/src/sgml/lo.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ CREATE TRIGGER t_raster BEFORE UPDATE OR DELETE ON image
9999

100100
<para>
101101
If you already have, or suspect you have, orphaned large objects, see the
102-
<filename>contrib/vacuumlo</> module (<xref linkend="vacuumlo">) to help
102+
<xref linkend="vacuumlo"> module to help
103103
you clean them up. It's a good idea to run <application>vacuumlo</>
104104
occasionally as a back-stop to the <function>lo_manage</> trigger.
105105
</para>

doc/src/sgml/queries.sgml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -686,8 +686,9 @@ SELECT *
686686
AS t1(proname name, prosrc text)
687687
WHERE proname LIKE 'bytea%';
688688
</programlisting>
689-
The <literal>dblink</> function executes a remote query (see
690-
<filename>contrib/dblink</>). It is declared to return
689+
The <xref linkend="CONTRIB-DBLINK-FUNCTION"> function
690+
(part of the <xref linkend="dblink"> module>) executes
691+
a remote query. It is declared to return
691692
<type>record</> since it might be used for any kind of query.
692693
The actual column set must be specified in the calling query so
693694
that the parser knows, for example, what <literal>*</> should

doc/src/sgml/recovery-config.sgml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,8 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
9292
may be safely removed.
9393
This information can be used to truncate the archive to just the
9494
minimum required to support restart from the current restore.
95-
The <application>pg_archivecleanup</> utility provided in
96-
<literal>contrib</> (see <xref linkend="pgarchivecleanup">) serves as a
97-
convenient target for <varname>archive_cleanup_command</> in typical
95+
The <xref linkend="pgarchivecleanup"> module
96+
is often used in <varname>archive_cleanup_command</> for
9897
single-standby configurations, for example:
9998
<programlisting> archive_cleanup_command = 'pg_archivecleanup /mnt/server/archivedir %r' </programlisting>
10099
Note however that if multiple standby servers are restoring from the

doc/src/sgml/ref/create_opclass.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,8 +276,8 @@ CREATE OPERATOR CLASS <replaceable class="parameter">name</replaceable> [ DEFAUL
276276

277277
<para>
278278
The following example command defines a GiST index operator class
279-
for the data type <literal>_int4</> (array of <type>int4</type>). See
280-
<filename>contrib/intarray/</> for the complete example.
279+
for the data type <literal>_int4</> (array of <type>int4</type>). See the
280+
<xref linkend="intarray"> module for the complete example.
281281
</para>
282282

283283
<programlisting>

doc/src/sgml/runtime.sgml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1502,9 +1502,8 @@ $ <userinput>kill -INT `head -1 /usr/local/pgsql/data/postmaster.pid`</userinput
15021502

15031503
<listitem>
15041504
<para>
1505-
The <filename>contrib</> function library
1506-
<link linkend="pgcrypto"><function>pgcrypto</function></link>
1507-
allows certain fields to be stored encrypted.
1505+
The <xref linkend="pgcrypto"> module allows certain fields to be
1506+
stored encrypted.
15081507
This is useful if only some of the data is sensitive.
15091508
The client supplies the decryption key and the data is decrypted
15101509
on the server and then sent to the client.

doc/src/sgml/spi.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3939,8 +3939,8 @@ INSERT INTO a SELECT * FROM a;
39393939
using <function>SPI_exec</function> and returns the number of rows
39403940
that were processed by the command. You can find more complex
39413941
examples for SPI in the source tree in
3942-
<filename>src/test/regress/regress.c</filename> and in
3943-
<filename>contrib/spi</filename>.
3942+
<filename>src/test/regress/regress.c</filename> and in the
3943+
<xref linkend="contrib-spi"> module.
39443944
</para>
39453945

39463946
<programlisting>

doc/src/sgml/storage.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -455,8 +455,8 @@ at the root.
455455
<para>
456456
See <filename>src/backend/storage/freespace/README</> for more details on
457457
how the <acronym>FSM</> is structured, and how it's updated and searched.
458-
The <filename>contrib/pg_freespacemap</> module can be used to examine the
459-
information stored in free space maps (see <xref linkend="pgfreespacemap">).
458+
The <xref linkend="pgfreespacemap"> module
459+
can be used to examine the information stored in free space maps.
460460
</para>
461461

462462
</sect1>

doc/src/sgml/textsearch.sgml

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2132,9 +2132,7 @@ ALTER TEXT SEARCH CONFIGURATION astro_en
21322132
end where it'd be useless. Filtering dictionaries are useful to partially
21332133
normalize words to simplify the task of later dictionaries. For example,
21342134
a filtering dictionary could be used to remove accents from accented
2135-
letters, as is done by the
2136-
<link linkend="unaccent"><filename>contrib/unaccent</></link>
2137-
extension module.
2135+
letters, as is done by the <xref linkend="unaccent"> module.
21382136
</para>
21392137

21402138
<sect2 id="textsearch-stopwords">
@@ -3367,8 +3365,8 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable>
33673365
allows the implementation of very fast searches with online update.
33683366
Partitioning can be done at the database level using table inheritance,
33693367
or by distributing documents over
3370-
servers and collecting search results using the <filename>contrib/dblink</>
3371-
extension module. The latter is possible because ranking functions use
3368+
servers and collecting search results using the <xref linkend="dblink">
3369+
module. The latter is possible because ranking functions use
33723370
only local information.
33733371
</para>
33743372

@@ -3616,8 +3614,9 @@ Parser: "pg_catalog.default"
36163614
<title>Migration from Pre-8.3 Text Search</title>
36173615

36183616
<para>
3619-
Applications that used the <filename>contrib/tsearch2</> add-on module
3620-
for text searching will need some adjustments to work with the
3617+
Applications that use the <xref linkend="tsearch2">
3618+
module for text searching will need some adjustments to work
3619+
with the
36213620
built-in features:
36223621
</para>
36233622

@@ -3628,19 +3627,19 @@ Parser: "pg_catalog.default"
36283627
argument lists, and all of them are now in the <literal>pg_catalog</>
36293628
schema, whereas in a previous installation they would have been in
36303629
<literal>public</> or another non-system schema. There is a new
3631-
version of <filename>contrib/tsearch2</> (see <xref linkend="tsearch2">)
3630+
version of <application>tsearch2</>
36323631
that provides a compatibility layer to solve most problems in this
36333632
area.
36343633
</para>
36353634
</listitem>
36363635

36373636
<listitem>
36383637
<para>
3639-
The old <filename>contrib/tsearch2</> functions and other objects
3638+
The old <application>tsearch2</> functions and other objects
36403639
<emphasis>must</> be suppressed when loading <application>pg_dump</>
36413640
output from a pre-8.3 database. While many of them won't load anyway,
36423641
a few will and then cause problems. One simple way to deal with this
3643-
is to load the new <filename>contrib/tsearch2</> module before restoring
3642+
is to load the new <application>tsearch2</> module before restoring
36443643
the dump; then it will block the old objects from being loaded.
36453644
</para>
36463645
</listitem>

doc/src/sgml/trigger.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -832,7 +832,7 @@ DELETE 2
832832
<para>
833833
There are more complex examples in
834834
<filename>src/test/regress/regress.c</filename> and
835-
in <filename>contrib/spi</filename>.
835+
in <xref linkend="contrib-spi">.
836836
</para>
837837
</sect1>
838838
</chapter>

doc/src/sgml/tsearch2.sgml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
</indexterm>
99

1010
<para>
11-
The <literal>tsearch2</literal> module provides backwards-compatible
11+
The <application>tsearch2</> module provides backwards-compatible
1212
text search functionality for applications that used
13-
<filename>contrib/tsearch2</> before text searching was integrated
13+
<application>tsearch2</> before text searching was integrated
1414
into core <productname>PostgreSQL</productname> in release 8.3.
1515
</para>
1616

@@ -19,7 +19,7 @@
1919

2020
<para>
2121
Although the built-in text search features were based on
22-
<filename>contrib/tsearch2</> and are largely similar to it,
22+
<application>tsearch2</> and are largely similar to it,
2323
there are numerous small differences that will create portability
2424
issues for existing applications:
2525
</para>
@@ -38,7 +38,7 @@
3838
<para>
3939
The built-in text search data types and functions all exist within
4040
the system schema <literal>pg_catalog</>. In an installation using
41-
<filename>contrib/tsearch2</>, these objects would usually have been in
41+
<application>tsearch2</>, these objects would usually have been in
4242
the <literal>public</> schema, though some users chose to place them
4343
in a separate schema of their own. Explicitly schema-qualified
4444
references to the objects will therefore fail in either case.
@@ -86,7 +86,7 @@
8686
<para>
8787
Text search configuration information has been moved into core
8888
system catalogs that are noticeably different from the tables used
89-
by <filename>contrib/tsearch2</>. Any applications that examined
89+
by <application>tsearch2</>. Any applications that examined
9090
or modified those tables will need adjustment.
9191
</para>
9292
</listitem>
@@ -98,7 +98,7 @@
9898
catalogs using the new text search configuration SQL commands.
9999
The replacement <literal>tsearch2</literal> module offers a little
100100
bit of support for this by making it possible to load an old set
101-
of <filename>contrib/tsearch2</> configuration tables into
101+
of <application>tsearch2</> configuration tables into
102102
<productname>PostgreSQL</productname> 8.3. (Without the module,
103103
it is not possible to load the configuration data because values in the
104104
<type>regprocedure</> columns cannot be resolved to functions.)
@@ -132,7 +132,7 @@
132132

133133
<para>
134134
The recommended way to update a pre-8.3 installation that uses
135-
<filename>contrib/tsearch2</> is:
135+
<application>tsearch2</> is:
136136
</para>
137137

138138
<procedure>
@@ -150,7 +150,7 @@
150150
the replacement <literal>tsearch2</literal> module into each
151151
database that will use text search. This must be done
152152
<emphasis>before</> loading the dump data! If your old installation
153-
had the <filename>contrib/tsearch2</> objects in a schema other
153+
had the <application>tsearch2</> objects in a schema other
154154
than <literal>public</>, be sure to adjust the
155155
<literal>tsearch2</literal> installation script so that the replacement
156156
objects are created in that same schema.
@@ -160,7 +160,7 @@
160160
<step>
161161
<para>
162162
Load the dump data. There will be quite a few errors reported
163-
due to failure to recreate the original <filename>contrib/tsearch2</>
163+
due to failure to recreate the original <application>tsearch2</>
164164
objects. These errors can be ignored, but this means you cannot
165165
restore the dump in a single transaction (eg, you cannot use
166166
<application>pg_restore</>'s <literal>-1</> switch).
@@ -169,7 +169,7 @@
169169

170170
<step>
171171
<para>
172-
Examine the contents of the restored <filename>contrib/tsearch2</>
172+
Examine the contents of the restored <application>tsearch2</>
173173
configuration tables (<structname>pg_ts_cfg</> and so on), and
174174
create equivalent built-in text search configurations as needed.
175175
You may drop the old configuration tables once you've extracted

doc/src/sgml/vacuumlo.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
<para>
1919
If you use this, you may also be interested in the <function>lo_manage</>
20-
trigger in <filename>contrib/lo</> (see <xref linkend="lo">).
20+
trigger in the <xref linkend="lo"> module.
2121
<function>lo_manage</> is useful to try
2222
to avoid creating orphaned LOs in the first place.
2323
</para>

doc/src/sgml/wal.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@
129129
file systems behave suboptimally when combined with battery-backup unit
130130
(<acronym>BBU</>) disk controllers. In such setups, the synchronize
131131
command forces all data from the controller cache to the disks,
132-
eliminating much of the benefit of the BBU. You can run the utility
133-
<filename>contrib/pg_test_fsync</> in the PostgreSQL source tree to see
132+
eliminating much of the benefit of the BBU. You can run the
133+
<xref linkend="pgtestfsync"> module to see
134134
if you are affected. If you are affected, the performance benefits
135135
of the BBU can be regained by turning off write barriers in
136136
the file system or reconfiguring the disk controller, if that is
@@ -571,8 +571,8 @@
571571
the exception of <literal>fsync_writethrough</>, which can sometimes
572572
force a flush of the disk cache even when other options do not do so.
573573
However, it's quite platform-specific which one will be the fastest;
574-
you can test option speeds using the utility <filename>contrib/pg_test_fsync</>
575-
in the PostgreSQL source tree.
574+
you can test option speeds using the <xref
575+
linkend="pgtestfsync"> module.
576576
Note that this parameter is irrelevant if <varname>fsync</varname>
577577
has been turned off.
578578
</para>

doc/src/sgml/xfunc.sgml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3231,8 +3231,9 @@ CREATE OR REPLACE FUNCTION retcomposite(IN integer, IN integer,
32313231
</para>
32323232

32333233
<para>
3234-
The directory <filename>contrib/tablefunc</> in the source
3235-
distribution contains more examples of set-returning functions.
3234+
The directory <link linkend="tablefunc">contrib/tablefunc</>
3235+
module in the source distribution contains more examples of
3236+
set-returning functions.
32363237
</para>
32373238
</sect2>
32383239

0 commit comments

Comments
 (0)