Skip to content

Commit e86c8b7

Browse files
alvherrealvherre
committed
Describe each contrib module in its SGML section title
The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
1 parent d137cb5 commit e86c8b7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+83
-72
lines changed

‎doc/src/sgml/adminpack.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/adminpack.sgml -->
22

33
<sect1 id="adminpack" xreflabel="adminpack">
4-
<title>adminpack</title>
4+
<title>adminpack &mdash; pgAdmin support toolpack</title>
55

66
<indexterm zone="adminpack">
77
<primary>adminpack</primary>

‎doc/src/sgml/amcheck.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/amcheck.sgml -->
22

33
<sect1 id="amcheck" xreflabel="amcheck">
4-
<title>amcheck</title>
4+
<title>amcheck &mdash; tools to verify table and index consistency</title>
55

66
<indexterm zone="amcheck">
77
<primary>amcheck</primary>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/auth-delay.sgml -->
22

33
<sect1 id="auth-delay" xreflabel="auth_delay">
4-
<title>auth_delay</title>
4+
<title>auth_delay &mdash; pause on authentication failure</title>
55

66
<indexterm zone="auth-delay">
77
<primary>auth_delay</primary>

‎doc/src/sgml/auto-explain.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/auto-explain.sgml -->
22

33
<sect1 id="auto-explain" xreflabel="auto_explain">
4-
<title>auto_explain</title>
4+
<title>auto_explain &mdash; log execution plans of slow queries</title>
55

66
<indexterm zone="auto-explain">
77
<primary>auto_explain</primary>

‎doc/src/sgml/basebackup-to-shell.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/basebackup-to-shell.sgml -->
22

33
<sect1 id="basebackup-to-shell" xreflabel="basebackup_to_shell">
4-
<title>basebackup_to_shell</title>
4+
<title>basebackup_to_shell &mdash; example "shell" pg_basebackup module</title>
55

66
<indexterm zone="basebackup-to-shell">
77
<primary>basebackup_to_shell</primary>

‎doc/src/sgml/basic-archive.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/basic-archive.sgml -->
22

33
<sect1 id="basic-archive" xreflabel="basic_archive">
4-
<title>basic_archive</title>
4+
<title>basic_archive &mdash; an example WAL archive module</title>
55

66
<indexterm zone="basic-archive">
77
<primary>basic_archive</primary>

‎doc/src/sgml/bloom.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/bloom.sgml -->
22

33
<sect1 id="bloom" xreflabel="bloom">
4-
<title>bloom</title>
4+
<title>bloom &mdash; bloom filter index access method</title>
55

66
<indexterm zone="bloom">
77
<primary>bloom</primary>

‎doc/src/sgml/btree-gin.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<!-- doc/src/sgml/btree-gin.sgml -->
22

33
<sect1 id="btree-gin" xreflabel="btree_gin">
4-
<title>btree_gin</title>
4+
<title>btree_gin &mdash; GIN operator classes with B-tree behavior</title>
55

66
<indexterm zone="btree-gin">
77
<primary>btree_gin</primary>
88
</indexterm>
99

1010
<para>
11-
<filename>btree_gin</filename> provides sample GIN operator classes that
11+
<filename>btree_gin</filename> provides GIN operator classes that
1212
implement B-tree equivalent behavior for the data types
1313
<type>int2</type>, <type>int4</type>, <type>int8</type>, <type>float4</type>,
1414
<type>float8</type>, <type>timestamp with time zone</type>,

‎doc/src/sgml/btree-gist.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/btree-gist.sgml -->
22

33
<sect1 id="btree-gist" xreflabel="btree_gist">
4-
<title>btree_gist</title>
4+
<title>btree_gist &mdash; GiST operator classes with B-tree behavior</title>
55

66
<indexterm zone="btree-gist">
77
<primary>btree_gist</primary>

‎doc/src/sgml/citext.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/citext.sgml -->
22

33
<sect1 id="citext" xreflabel="citext">
4-
<title>citext</title>
4+
<title>citext &mdash; a case-insensitive character string type</title>
55

66
<indexterm zone="citext">
77
<primary>citext</primary>

‎doc/src/sgml/contrib-spi.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/contrib-spi.sgml -->
22

33
<sect1 id="contrib-spi" xreflabel="spi">
4-
<title>spi</title>
4+
<title>spi &mdash; Server Programming Interface features/examples</title>
55

66
<indexterm zone="contrib-spi">
77
<primary>SPI</primary>

‎doc/src/sgml/contrib.sgml

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
11
<!-- doc/src/sgml/contrib.sgml -->
22

33
<appendix id="contrib">
4-
<title>Additional Supplied Modules</title>
4+
<title>Additional Supplied Modules and Extensions</title>
55

66
<para>
7-
This appendix and the next one contain information regarding the modules that
8-
can be found in the <literal>contrib</literal> directory of the
7+
This appendix and the next one contain information on the
8+
optional components
9+
found in the <literal>contrib</literal> directory of the
910
<productname>PostgreSQL</productname> distribution.
1011
These include porting tools, analysis utilities,
11-
and plug-in features that are not part of the core PostgreSQL system,
12-
mainly because they address a limited audience or are too experimental
12+
and plug-in features that are not part of the core PostgreSQL system.
13+
They are separate mainly
14+
because they address a limited audience or are too experimental
1315
to be part of the main source tree. This does not preclude their
1416
usefulness.
1517
</para>
1618

1719
<para>
18-
This appendix covers extensions and other server plug-in modules found in
20+
This appendix covers extensions and other server plug-in module
21+
libraries found in
1922
<literal>contrib</literal>. <xref linkend="contrib-prog"/> covers utility
2023
programs.
2124
</para>
2225

2326
<para>
24-
When building from the source distribution, these components are not built
27+
When building from the source distribution, these optional
28+
components are not built
2529
automatically, unless you build the "world" target
2630
(see <xref linkend="build"/>).
2731
You can build and install all of them by running:
@@ -46,53 +50,54 @@
4650

4751
<para>
4852
If you are using a pre-packaged version of <productname>PostgreSQL</productname>,
49-
these modules are typically made available as a separate subpackage,
53+
these components are typically made available as a separate subpackage,
5054
such as <literal>postgresql-contrib</literal>.
5155
</para>
5256

5357
<para>
54-
Many modules supply new user-defined functions, operators, or types.
55-
To make use of one of these modules, after you have installed the code
58+
Many components supply new user-defined functions, operators, or types,
59+
packaged as <firstterm>extensions</firstterm>.
60+
To make use of one of these extensions, after you have installed the code
5661
you need to register the new SQL objects in the database system.
5762
This is done by executing
5863
a <xref linkend="sql-createextension"/> command. In a fresh database,
5964
you can simply do
6065

6166
<programlisting>
62-
CREATE EXTENSION <replaceable>module_name</replaceable>;
67+
CREATE EXTENSION <replaceable>extension_name</replaceable>;
6368
</programlisting>
6469

6570
This command registers the new SQL objects in the current database only,
66-
so you need to run it in each database that you want
67-
the module's facilities to be available in. Alternatively, run it in
71+
so you need to run it in every database in which you want
72+
the extension's facilities to be available. Alternatively, run it in
6873
database <literal>template1</literal> so that the extension will be copied into
6974
subsequently-created databases by default.
7075
</para>
7176

7277
<para>
73-
For all these modules, <command>CREATE EXTENSION</command> must be run
74-
by a database superuser, unless the module is
75-
considered <quote>trusted</quote>, in which case it can be run by any
78+
For all extensions, the <command>CREATE EXTENSION</command> command must be
79+
run by a database superuser, unless the extension is
80+
considered <quote>trusted</quote>. Trusted extensions can be run by any
7681
user who has <literal>CREATE</literal> privilege on the current
77-
database. Modules that are trusted are identified as such in the
78-
sections that follow. Generally, trusted modules are ones that cannot
82+
database. Extensions that are trusted are identified as such in the
83+
sections that follow. Generally, trusted extensions are ones that cannot
7984
provide access to outside-the-database functionality.
8085
</para>
8186

8287
<para>
83-
Many modules allow you to install their objects in a schema of your
88+
Many extensions allow you to install their objects in a schema of your
8489
choice. To do that, add <literal>SCHEMA
8590
<replaceable>schema_name</replaceable></literal> to the <command>CREATE EXTENSION</command>
8691
command. By default, the objects will be placed in your current creation
8792
target schema, which in turn defaults to <literal>public</literal>.
8893
</para>
8994

9095
<para>
91-
Note, however, that some of these modules are not <quote>extensions</quote>
96+
Note, however, that some of these components are not <quote>extensions</quote>
9297
in this sense, but are loaded into the server in some other way, for instance
9398
by way of
9499
<xref linkend="guc-shared-preload-libraries"/>. See the documentation of each
95-
module for details.
100+
component for details.
96101
</para>
97102

98103
&adminpack;

‎doc/src/sgml/cube.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/cube.sgml -->
22

33
<sect1 id="cube" xreflabel="cube">
4-
<title>cube</title>
4+
<title>cube &mdash; a multi-dimensional cube data type</title>
55

66
<indexterm zone="cube">
77
<primary>cube (extension)</primary>

‎doc/src/sgml/dblink.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/dblink.sgml -->
22

33
<sect1 id="dblink" xreflabel="dblink">
4-
<title>dblink</title>
4+
<title>dblink &mdash; connect to other PostgreSQL databases</title>
55

66
<indexterm zone="dblink">
77
<primary>dblink</primary>

‎doc/src/sgml/dict-int.sgml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
<!-- doc/src/sgml/dict-int.sgml -->
22

33
<sect1 id="dict-int" xreflabel="dict_int">
4-
<title>dict_int</title>
4+
<title>dict_int &mdash;
5+
example full-text search dictionary for integers</title>
56

67
<indexterm zone="dict-int">
78
<primary>dict_int</primary>

‎doc/src/sgml/dict-xsyn.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/dict-xsyn.sgml -->
22

33
<sect1 id="dict-xsyn" xreflabel="dict_xsyn">
4-
<title>dict_xsyn</title>
4+
<title>dict_xsyn &mdash; example synonym full-text search dictionary</title>
55

66
<indexterm zone="dict-xsyn">
77
<primary>dict_xsyn</primary>

‎doc/src/sgml/earthdistance.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/earthdistance.sgml -->
22

33
<sect1 id="earthdistance" xreflabel="earthdistance">
4-
<title>earthdistance</title>
4+
<title>earthdistance &mdash; calculate great-circle distances</title>
55

66
<indexterm zone="earthdistance">
77
<primary>earthdistance</primary>

‎doc/src/sgml/file-fdw.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/file-fdw.sgml -->
22

33
<sect1 id="file-fdw" xreflabel="file_fdw">
4-
<title>file_fdw</title>
4+
<title>file_fdw &mdash; access data files in the server's file system</title>
55

66
<indexterm zone="file-fdw">
77
<primary>file_fdw</primary>

‎doc/src/sgml/fuzzystrmatch.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/fuzzystrmatch.sgml -->
22

33
<sect1 id="fuzzystrmatch" xreflabel="fuzzystrmatch">
4-
<title>fuzzystrmatch</title>
4+
<title>fuzzystrmatch &mdash; determine string similarities and distance</title>
55

66
<indexterm zone="fuzzystrmatch">
77
<primary>fuzzystrmatch</primary>

‎doc/src/sgml/hstore.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/hstore.sgml -->
22

33
<sect1 id="hstore" xreflabel="hstore">
4-
<title>hstore</title>
4+
<title>hstore &mdash; hstore key/value datatype</title>
55

66
<indexterm zone="hstore">
77
<primary>hstore</primary>

‎doc/src/sgml/intagg.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/intagg.sgml -->
22

33
<sect1 id="intagg" xreflabel="intagg">
4-
<title>intagg</title>
4+
<title>intagg &mdash; integer aggregator and enumerator</title>
55

66
<indexterm zone="intagg">
77
<primary>intagg</primary>

‎doc/src/sgml/intarray.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/intarray.sgml -->
22

33
<sect1 id="intarray" xreflabel="intarray">
4-
<title>intarray</title>
4+
<title>intarray &mdash; manipulate arrays of integers</title>
55

66
<indexterm zone="intarray">
77
<primary>intarray</primary>

‎doc/src/sgml/isn.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/isn.sgml -->
22

33
<sect1 id="isn" xreflabel="isn">
4-
<title>isn</title>
4+
<title>isn &mdash; data types for international standard numbers (ISBN, EAN, UPC, etc.)</title>
55

66
<indexterm zone="isn">
77
<primary>isn</primary>

‎doc/src/sgml/lo.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/lo.sgml -->
22

33
<sect1 id="lo" xreflabel="lo">
4-
<title>lo</title>
4+
<title>lo &mdash; manage large objects</title>
55

66
<indexterm zone="lo">
77
<primary>lo</primary>

‎doc/src/sgml/ltree.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/ltree.sgml -->
22

33
<sect1 id="ltree" xreflabel="ltree">
4-
<title>ltree</title>
4+
<title>ltree &mdash; hierarchical tree-like data type</title>
55

66
<indexterm zone="ltree">
77
<primary>ltree</primary>

‎doc/src/sgml/oldsnapshot.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/oldsnapshot.sgml -->
22

33
<sect1 id="oldsnapshot" xreflabel="old_snapshot">
4-
<title>old_snapshot</title>
4+
<title>old_snapshot &mdash; inspect <literal>old_snapshot_threshold</literal> state</title>
55

66
<indexterm zone="oldsnapshot">
77
<primary>old_snapshot</primary>

‎doc/src/sgml/pageinspect.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/pageinspect.sgml -->
22

33
<sect1 id="pageinspect" xreflabel="pageinspect">
4-
<title>pageinspect</title>
4+
<title>pageinspect &mdash; low-level inspection of database pages</title>
55

66
<indexterm zone="pageinspect">
77
<primary>pageinspect</primary>

‎doc/src/sgml/passwordcheck.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/passwordcheck.sgml -->
22

33
<sect1 id="passwordcheck" xreflabel="passwordcheck">
4-
<title>passwordcheck</title>
4+
<title>passwordcheck &mdash; verify password strength</title>
55

66
<indexterm zone="passwordcheck">
77
<primary>passwordcheck</primary>

‎doc/src/sgml/pgbuffercache.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/pgbuffercache.sgml -->
22

33
<sect1 id="pgbuffercache" xreflabel="pg_buffercache">
4-
<title>pg_buffercache</title>
4+
<title>pg_buffercache &mdash; inspect Postgres buffer cache state</title>
55

66
<indexterm zone="pgbuffercache">
77
<primary>pg_buffercache</primary>

‎doc/src/sgml/pgcrypto.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/pgcrypto.sgml -->
22

33
<sect1 id="pgcrypto" xreflabel="pgcrypto">
4-
<title>pgcrypto</title>
4+
<title>pgcrypto &mdash; cryptographic functions</title>
55

66
<indexterm zone="pgcrypto">
77
<primary>pgcrypto</primary>

‎doc/src/sgml/pgfreespacemap.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/pgfreespacemap.sgml -->
22

33
<sect1 id="pgfreespacemap" xreflabel="pg_freespacemap">
4-
<title>pg_freespacemap</title>
4+
<title>pg_freespacemap &mdash; examine the free space map</title>
55

66
<indexterm zone="pgfreespacemap">
77
<primary>pg_freespacemap</primary>

‎doc/src/sgml/pgprewarm.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- doc/src/sgml/pgprewarm.sgml -->
22

33
<sect1 id="pgprewarm" xreflabel="pg_prewarm">
4-
<title>pg_prewarm</title>
4+
<title>pg_prewarm &mdash; preload relation data into buffer caches</title>
55

66
<indexterm zone="pgprewarm">
77
<primary>pg_prewarm</primary>

0 commit comments

Comments
 (0)