8000 Describe each contrib module in its SGML section title · postgrespro/postgres@e86c8b7 · GitHub
[go: up one dir, main page]
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>

0 commit comments

Comments
 (0)
0