From 159e3d86292cfec2a2828f9f69ac7a6cb1be242d Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Wed, 26 Jan 2011 09:22:21 -0500 Subject: [PATCH] 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. --- doc/src/sgml/contrib-spi.sgml | 2 +- doc/src/sgml/datatype.sgml | 6 +++--- doc/src/sgml/dblink.sgml | 2 +- doc/src/sgml/diskusage.sgml | 3 +-- doc/src/sgml/high-availability.sgml | 8 ++++---- doc/src/sgml/installation.sgml | 10 +++++----- doc/src/sgml/lo.sgml | 2 +- doc/src/sgml/queries.sgml | 5 +++-- doc/src/sgml/recovery-config.sgml | 5 ++--- doc/src/sgml/ref/create_opclass.sgml | 4 ++-- doc/src/sgml/runtime.sgml | 5 ++--- doc/src/sgml/spi.sgml | 4 ++-- doc/src/sgml/storage.sgml | 4 ++-- doc/src/sgml/textsearch.sgml | 19 +++++++++---------- doc/src/sgml/trigger.sgml | 2 +- doc/src/sgml/tsearch2.sgml | 20 ++++++++++---------- doc/src/sgml/vacuumlo.sgml | 2 +- doc/src/sgml/wal.sgml | 8 ++++---- doc/src/sgml/xfunc.sgml | 5 +++-- 19 files changed, 57 insertions(+), 59 deletions(-) diff --git a/doc/src/sgml/contrib-spi.sgml b/doc/src/sgml/contrib-spi.sgml index a8761f61b7..a11858edd9 100644 --- a/doc/src/sgml/contrib-spi.sgml +++ b/doc/src/sgml/contrib-spi.sgml @@ -9,7 +9,7 @@ - The contrib/spi module provides several workable examples + The spi module provides several workable examples of using SPI and triggers. While these functions are of some value in their own right, they are even more useful as examples to modify for your own purposes. The functions are general enough to be used diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml index f994eac45b..cdebbe230d 100644 --- a/doc/src/sgml/datatype.sgml +++ b/doc/src/sgml/datatype.sgml @@ -3917,9 +3917,9 @@ a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11 PostgreSQL provides storage and comparison functions for UUIDs, but the core database does not include any function for generating UUIDs, because no single algorithm is well - suited for every application. The contrib module - contrib/uuid-ossp provides functions that implement - several standard algorithms. + suited for every application. The module + provides functions that implement several standard algorithms. Alternatively, UUIDs could be generated by client applications or other libraries invoked through a server-side function. diff --git a/doc/src/sgml/dblink.sgml b/doc/src/sgml/dblink.sgml index 0e9cd22026..295544e54e 100644 --- a/doc/src/sgml/dblink.sgml +++ b/doc/src/sgml/dblink.sgml @@ -303,7 +303,7 @@ SELECT dblink_disconnect('myconn'); - + dblink 3 diff --git a/doc/src/sgml/diskusage.sgml b/doc/src/sgml/diskusage.sgml index 0f390f3d35..50440c2a17 100644 --- a/doc/src/sgml/diskusage.sgml +++ b/doc/src/sgml/diskusage.sgml @@ -31,10 +31,9 @@ You can monitor disk space in three ways: using the SQL functions listed in , - using the tools in contrib/oid2name, or + using the module, or using manual inspection of the system catalogs. The SQL functions are the easiest to use and are generally recommended. - contrib/oid2name is described in . The remainder of this section shows how to do it by inspection of the system catalogs. diff --git a/doc/src/sgml/high-availability.sgml b/doc/src/sgml/high-availability.sgml index d8841228e1..717347cc99 100644 --- a/doc/src/sgml/high-availability.sgml +++ b/doc/src/sgml/high-availability.sgml @@ -966,8 +966,8 @@ primary_conninfo = 'host=192.168.1.50 port=5432 user=foo password=foopass' sections is to use a restore_command that polls the archive location. This was the only option available in versions 8.4 and below. In this setup, set standby_mode off, because you are implementing - the polling required for standby operation yourself. See - contrib/pg_standby () for a reference + the polling required for standby operation yourself. See the + module for a reference implementation of this. @@ -1027,7 +1027,7 @@ if (!triggered) A working example of a waiting restore_command is provided - as a contrib module named pg_standby. It + in the module. It should be used as a reference on how to correctly implement the logic described above. It can also be extended as needed to support specific configurations and environments. @@ -1542,7 +1542,7 @@ if (!triggered) primary server and keep a query active for as long as needed to run queries on the standby. This prevents VACUUM from removing recently-dead rows and so cleanup conflicts do not occur. - This could be done using contrib/dblink and + This could be done using and pg_sleep(), or via other mechanisms. If you do this, you should note that this will delay cleanup of dead rows on the primary, which may result in undesirable table bloat. However, the cleanup diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml index a480a8dfd9..b64493c346 100644 --- a/doc/src/sgml/installation.sgml +++ b/doc/src/sgml/installation.sgml @@ -1007,8 +1007,8 @@ su - postgres Use the OSSP UUID - library when building contrib/uuid-ossp. - The library provides functions to generate + library when building the + module. The library provides functions to generate UUIDs.UUID @@ -1041,9 +1041,9 @@ su - postgres - Use libxslt when building contrib/xml2. - contrib/xml2 relies on this library to perform - XSL transformations of XML. + Use libxslt when building the + module. xml2 relies on this library + to perform XSL transformations of XML. diff --git a/doc/src/sgml/lo.sgml b/doc/src/sgml/lo.sgml index ab43a53263..33124f9920 100644 --- a/doc/src/sgml/lo.sgml +++ b/doc/src/sgml/lo.sgml @@ -99,7 +99,7 @@ CREATE TRIGGER t_raster BEFORE UPDATE OR DELETE ON image If you already have, or suspect you have, orphaned large objects, see the - contrib/vacuumlo module () to help + module to help you clean them up. It's a good idea to run vacuumlo occasionally as a back-stop to the lo_manage trigger. diff --git a/doc/src/sgml/queries.sgml b/doc/src/sgml/queries.sgml index 693fce531f..b0c32777bb 100644 --- a/doc/src/sgml/queries.sgml +++ b/doc/src/sgml/queries.sgml @@ -686,8 +686,9 @@ SELECT * AS t1(proname name, prosrc text) WHERE proname LIKE 'bytea%'; - The dblink function executes a remote query (see - contrib/dblink). It is declared to return + The function + (part of the module>) executes + a remote query. It is declared to return record since it might be used for any kind of query. The actual column set must be specified in the calling query so that the parser knows, for example, what * should diff --git a/doc/src/sgml/recovery-config.sgml b/doc/src/sgml/recovery-config.sgml index bd9dfd177a..68fe04998d 100644 --- a/doc/src/sgml/recovery-config.sgml +++ b/doc/src/sgml/recovery-config.sgml @@ -92,9 +92,8 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows may be safely removed. This information can be used to truncate the archive to just the minimum required to support restart from the current restore. - The pg_archivecleanup utility provided in - contrib (see ) serves as a - convenient target for archive_cleanup_command in typical + The module + is often used in archive_cleanup_command for single-standby configurations, for example: archive_cleanup_command = 'pg_archivecleanup /mnt/server/archivedir %r' Note however that if multiple standby servers are restoring from the diff --git a/doc/src/sgml/ref/create_opclass.sgml b/doc/src/sgml/ref/create_opclass.sgml index eff585405c..158740b667 100644 --- a/doc/src/sgml/ref/create_opclass.sgml +++ b/doc/src/sgml/ref/create_opclass.sgml @@ -276,8 +276,8 @@ CREATE OPERATOR CLASS name [ DEFAUL The following example command defines a GiST index operator class - for the data type _int4 (array of int4). See - contrib/intarray/ for the complete example. + for the data type _int4 (array of int4). See the + module for the complete example. diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml index 9b92bec220..0059868ca1 100644 --- a/doc/src/sgml/runtime.sgml +++ b/doc/src/sgml/runtime.sgml @@ -1502,9 +1502,8 @@ $ kill -INT `head -1 /usr/local/pgsql/data/postmaster.pid` - The contrib function library - pgcrypto - allows certain fields to be stored encrypted. + The module allows certain fields to be + stored encrypted. This is useful if only some of the data is sensitive. The client supplies the decryption key and the data is decrypted on the server and then sent to the client. diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml index 1ca930846a..bb11680eee 100644 --- a/doc/src/sgml/spi.sgml +++ b/doc/src/sgml/spi.sgml @@ -3939,8 +3939,8 @@ INSERT INTO a SELECT * FROM a; using SPI_exec and returns the number of rows that were processed by the command. You can find more complex examples for SPI in the source tree in - src/test/regress/regress.c and in - contrib/spi. + src/test/regress/regress.c and in the + module. diff --git a/doc/src/sgml/storage.sgml b/doc/src/sgml/storage.sgml index ad9fba2d0f..d8e3686f7d 100644 --- a/doc/src/sgml/storage.sgml +++ b/doc/src/sgml/storage.sgml @@ -455,8 +455,8 @@ at the root. See src/backend/storage/freespace/README for more details on how the FSM is structured, and how it's updated and searched. -The contrib/pg_freespacemap module can be used to examine the -information stored in free space maps (see ). +The module +can be used to examine the information stored in free space maps. diff --git a/doc/src/sgml/textsearch.sgml b/doc/src/sgml/textsearch.sgml index b3e4b8e9af..1beebd21ee 100644 --- a/doc/src/sgml/textsearch.sgml +++ b/doc/src/sgml/textsearch.sgml @@ -2132,9 +2132,7 @@ ALTER TEXT SEARCH CONFIGURATION astro_en end where it'd be useless. Filtering dictionaries are useful to partially normalize words to simplify the task of later dictionaries. For example, a filtering dictionary could be used to remove accents from accented - letters, as is done by the - contrib/unaccent - extension module. + letters, as is done by the module. @@ -3367,8 +3365,8 @@ CREATE INDEX name ON table allows the implementation of very fast searches with online update. Partitioning can be done at the database level using table inheritance, or by distributing documents over - servers and collecting search results using the contrib/dblink - extension module. The latter is possible because ranking functions use + servers and collecting search results using the + module. The latter is possible because ranking functions use only local information. @@ -3616,8 +3614,9 @@ Parser: "pg_catalog.default" Migration from Pre-8.3 Text Search - Applications that used the contrib/tsearch2 add-on module - for text searching will need some adjustments to work with the + Applications that use the + module for text searching will need some adjustments to work + with the built-in features: @@ -3628,7 +3627,7 @@ Parser: "pg_catalog.default" argument lists, and all of them are now in the pg_catalog schema, whereas in a previous installation they would have been in public or another non-system schema. There is a new - version of contrib/tsearch2 (see ) + version of tsearch2 that provides a compatibility layer to solve most problems in this area. @@ -3636,11 +3635,11 @@ Parser: "pg_catalog.default" - The old contrib/tsearch2 functions and other objects + The old tsearch2 functions and other objects must be suppressed when loading pg_dump output from a pre-8.3 database. While many of them won't load anyway, a few will and then cause problems. One simple way to deal with this - is to load the new contrib/tsearch2 module before restoring + is to load the new tsearch2 module before restoring the dump; then it will block the old objects from being loaded. diff --git a/doc/src/sgml/trigger.sgml b/doc/src/sgml/trigger.sgml index 38979cdaed..78ba87b8b4 100644 --- a/doc/src/sgml/trigger.sgml +++ b/doc/src/sgml/trigger.sgml @@ -832,7 +832,7 @@ DELETE 2 There are more complex examples in src/test/regress/regress.c and - in contrib/spi. + in . diff --git a/doc/src/sgml/tsearch2.sgml b/doc/src/sgml/tsearch2.sgml index 3f4f559dc0..c66459fbba 100644 --- a/doc/src/sgml/tsearch2.sgml +++ b/doc/src/sgml/tsearch2.sgml @@ -8,9 +8,9 @@ - The tsearch2 module provides backwards-compatible + The tsearch2 module provides backwards-compatible text search functionality for applications that used - contrib/tsearch2 before text searching was integrated + tsearch2 before text searching was integrated into core PostgreSQL in release 8.3. @@ -19,7 +19,7 @@ Although the built-in text search features were based on - contrib/tsearch2 and are largely similar to it, + tsearch2 and are largely similar to it, there are numerous small differences that will create portability issues for existing applications: @@ -38,7 +38,7 @@ The built-in text search data types and functions all exist within the system schema pg_catalog. In an installation using - contrib/tsearch2, these objects would usually have been in + tsearch2, these objects would usually have been in the public schema, though some users chose to place them in a separate schema of their own. Explicitly schema-qualified references to the objects will therefore fail in either case. @@ -86,7 +86,7 @@ Text search configuration information has been moved into core system catalogs that are noticeably different from the tables used - by contrib/tsearch2. Any applications that examined + by tsearch2. Any applications that examined or modified those tables will need adjustment. @@ -98,7 +98,7 @@ catalogs using the new text search configuration SQL commands. The replacement tsearch2 module offers a little bit of support for this by making it possible to load an old set - of contrib/tsearch2 configuration tables into + of tsearch2 configuration tables into PostgreSQL 8.3. (Without the module, it is not possible to load the configuration data because values in the regprocedure columns cannot be resolved to functions.) @@ -132,7 +132,7 @@ The recommended way to update a pre-8.3 installation that uses - contrib/tsearch2 is: + tsearch2 is: @@ -150,7 +150,7 @@ the replacement tsearch2 module into each database that will use text search. This must be done before loading the dump data! If your old installation - had the contrib/tsearch2 objects in a schema other + had the tsearch2 objects in a schema other than public, be sure to adjust the tsearch2 installation script so that the replacement objects are created in that same schema. @@ -160,7 +160,7 @@ Load the dump data. There will be quite a few errors reported - due to failure to recreate the original contrib/tsearch2 + due to failure to recreate the original tsearch2 objects. These errors can be ignored, but this means you cannot restore the dump in a single transaction (eg, you cannot use pg_restore's -1 switch). @@ -169,7 +169,7 @@ - Examine the contents of the restored contrib/tsearch2 + Examine the contents of the restored tsearch2 configuration tables (pg_ts_cfg and so on), and create equivalent built-in text search configurations as needed. You may drop the old configuration tables once you've extracted diff --git a/doc/src/sgml/vacuumlo.sgml b/doc/src/sgml/vacuumlo.sgml index 65f55f03c9..fbb6815a44 100644 --- a/doc/src/sgml/vacuumlo.sgml +++ b/doc/src/sgml/vacuumlo.sgml @@ -17,7 +17,7 @@ If you use this, you may also be interested in the lo_manage - trigger in contrib/lo (see ). + trigger in the module. lo_manage is useful to try to avoid creating orphaned LOs in the first place. diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index e7a5a91826..96d4916e0e 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -129,8 +129,8 @@ file systems behave suboptimally when combined with battery-backup unit (BBU) disk controllers. In such setups, the synchronize command forces all data from the controller cache to the disks, - eliminating much of the benefit of the BBU. You can run the utility - contrib/pg_test_fsync in the PostgreSQL source tree to see + eliminating much of the benefit of the BBU. You can run the + module to see if you are affected. If you are affected, the performance benefits of the BBU can be regained by turning off write barriers in the file system or reconfiguring the disk controller, if that is @@ -571,8 +571,8 @@ the exception of fsync_writethrough, which can sometimes force a flush of the disk cache even when other options do not do so. However, it's quite platform-specific which one will be the fastest; - you can test option speeds using the utility contrib/pg_test_fsync - in the PostgreSQL source tree. + you can test option speeds using the module. Note that this parameter is irrelevant if fsync has been turned off. diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index e79c1f2923..25e577331a 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -3231,8 +3231,9 @@ CREATE OR REPLACE FUNCTION retcomposite(IN integer, IN integer, - The directory contrib/tablefunc in the source - distribution contains more examples of set-returning functions. + The directory contrib/tablefunc + module in the source distribution contains more examples of + set-returning functions. -- 2.40.0