Skip to content

Commit fe8eaa5

Browse files
robertmhaasrobertmhaas
committed
docs: Merge separate chapters on built-in index AMs into one.
The documentation index is getting very long, which makes it hard to find things. Since these chapters are all very similar in structure and content, merging them is a natural way of reducing the size of the toplevel index. Rather than actually combining all of the SGML into a single file, keep one file per <sect1>, and add a glue file that includes all of them. Discussion: http://postgr.es/m/CA+Tgmob7_uoYuS2=rVwpVXaRwP-UXz+++saYTC-BCZ42QzSNKQ@mail.gmail.com
1 parent 10e3226 commit fe8eaa5

File tree

9 files changed

+100
-91
lines changed

9 files changed

+100
-91
lines changed

‎doc/src/sgml/brin.sgml‎

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

3-
<chapter id="brin">
3+
<sect1 id="brin">
44
<title>BRIN Indexes</title>
55

66
<indexterm>
77
<primary>index</primary>
88
<secondary>BRIN</secondary>
99
</indexterm>
1010

11-
<sect1 id="brin-intro">
11+
<sect2 id="brin-intro">
1212
<title>Introduction</title>
1313

1414
<para>
@@ -64,7 +64,7 @@
6464
be more precise and more data blocks can be skipped during an index scan.
6565
</para>
6666

67-
<sect2 id="brin-operation">
67+
<sect3 id="brin-operation">
6868
<title>Index Maintenance</title>
6969

7070
<para>
@@ -136,10 +136,10 @@ LOG: request for BRIN range summarization for index "brin_wi_idx" page 128 was
136136
See <xref linkend="functions-admin-index"/> for details.
137137
</para>
138138

139-
</sect2>
140-
</sect1>
139+
</sect3>
140+
</sect2>
141141

142-
<sect1 id="brin-builtin-opclasses">
142+
<sect2 id="brin-builtin-opclasses">
143143
<title>Built-in Operator Classes</title>
144144

145145
<para>
@@ -743,7 +743,7 @@ LOG: request for BRIN range summarization for index "brin_wi_idx" page 128 was
743743
</tgroup>
744744
</table>
745745

746-
<sect2 id="brin-builtin-opclasses--parameters">
746+
<sect3 id="brin-builtin-opclasses--parameters">
747747
<title>Operator Class Parameters</title>
748748

749749
<para>
@@ -808,11 +808,11 @@ LOG: request for BRIN range summarization for index "brin_wi_idx" page 128 was
808808
</varlistentry>
809809

810810
</variablelist>
811-
</sect2>
811+
</sect3>
812812

813-
</sect1>
813+
</sect2>
814814

815-
<sect1 id="brin-extensibility">
815+
<sect2 id="brin-extensibility">
816816
<title>Extensibility</title>
817817

818818
<para>
@@ -1340,5 +1340,5 @@ typedef struct BrinOpcInfo
13401340
<literal>float4_minmax_ops</literal> as an example of minmax, and
13411341
<literal>box_inclusion_ops</literal> as an example of inclusion.
13421342
</para>
1343+
</sect2>
13431344
</sect1>
1344-
</chapter>

‎doc/src/sgml/btree.sgml‎

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

3-
<chapter id="btree">
3+
<sect1 id="btree">
44
<title>B-Tree Indexes</title>
55

66
<indexterm>
77
<primary>index</primary>
88
<secondary>B-Tree</secondary>
99
</indexterm>
1010

11-
<sect1 id="btree-intro">
11+
<sect2 id="btree-intro">
1212
<title>Introduction</title>
1313

1414
<para>
@@ -30,9 +30,9 @@
3030
btree <acronym>AM</acronym> make use of them.
3131
</para>
3232

33-
</sect1>
33+
</sect2>
3434

35-
<sect1 id="btree-behavior">
35+
<sect2 id="btree-behavior">
3636
<title>Behavior of B-Tree Operator Classes</title>
3737

3838
<para>
@@ -200,9 +200,9 @@
200200
planner relies on them for optimization purposes.
201201
</para>
202202

203-
</sect1>
203+
</sect2>
204204

205-
<sect1 id="btree-support-funcs">
205+
<sect2 id="btree-support-funcs">
206206
<title>B-Tree Support Functions</title>
207207

208208
<para>
@@ -585,9 +585,9 @@ options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns
585585
</varlistentry>
586586
</variablelist>
587587

588-
</sect1>
588+
</sect2>
589589

590-
<sect1 id="btree-implementation">
590+
<sect2 id="btree-implementation">
591591
<title>Implementation</title>
592592

593593
<para>
@@ -597,7 +597,7 @@ options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns
597597
distribution for a much more detailed, internals-focused description
598598
of the B-Tree implementation.
599599
</para>
600-
<sect2 id="btree-structure">
600+
<sect3 id="btree-structure">
601601
<title>B-Tree Structure</title>
602602
<para>
603603
<productname>PostgreSQL</productname> B-Tree indexes are
@@ -627,9 +627,9 @@ options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns
627627
the tree structure by creating a new root page that is one level
628628
above the original root page.
629629
</para>
630-
</sect2>
630+
</sect3>
631631

632-
<sect2 id="btree-deletion">
632+
<sect3 id="btree-deletion">
633633
<title>Bottom-up Index Deletion</title>
634634
<para>
635635
B-Tree indexes are not directly aware that under MVCC, there might
@@ -731,9 +731,9 @@ options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns
731731
two logical rows whose lifetimes span the same
732732
<command>VACUUM</command> cycle).
733733
</para>
734-
</sect2>
734+
</sect3>
735735

736-
<sect2 id="btree-deduplication">
736+
<sect3 id="btree-deduplication">
737737
<title>Deduplication</title>
738738
<para>
739739
A duplicate is a leaf page tuple (a tuple that points to a table
@@ -908,7 +908,7 @@ options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns
908908
</itemizedlist>
909909
</para>
910910

911-
</sect2>
912-
</sect1>
911+
</sect3>
912+
</sect2>
913913

914-
</chapter>
914+
</sect1>

‎doc/src/sgml/filelist.sgml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@
8585
<!ENTITY catalogs SYSTEM "catalogs.sgml">
8686
<!ENTITY system-views SYSTEM "system-views.sgml">
8787
<!ENTITY geqo SYSTEM "geqo.sgml">
88+
<!ENTITY indextypes SYSTEM "indextypes.sgml">
8889
<!ENTITY btree SYSTEM "btree.sgml">
8990
<!ENTITY gist SYSTEM "gist.sgml">
9091
<!ENTITY spgist SYSTEM "spgist.sgml">

‎doc/src/sgml/gin.sgml‎

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

3-
<chapter id="gin">
3+
<sect1 id="gin">
44
<title>GIN Indexes</title>
55

66
<indexterm>
77
<primary>index</primary>
88
<secondary>GIN</secondary>
99
</indexterm>
1010

11-
<sect1 id="gin-intro">
11+
<sect2 id="gin-intro">
1212
<title>Introduction</title>
1313

1414
<para>
@@ -60,9 +60,9 @@
6060
information about <acronym>GIN</acronym> on their
6161
<ulink url="http://www.sai.msu.su/~megera/wiki/Gin">website</ulink>.
6262
</para>
63-
</sect1>
63+
</sect2>
6464

65-
<sect1 id="gin-builtin-opclasses">
65+
<sect2 id="gin-builtin-opclasses">
6666
<title>Built-in Operator Classes</title>
6767

6868
<para>
@@ -140,9 +140,9 @@
140140
See <xref linkend="json-indexing"/> for details.
141141
</para>
142142

143-
</sect1>
143+
</sect2>
144144

145-
<sect1 id="gin-extensibility">
145+
<sect2 id="gin-extensibility">
146146
<title>Extensibility</title>
147147

148148
<para>
@@ -458,9 +458,9 @@
458458
though the actual type might be something else depending on the operator.
459459
</para>
460460

461-
</sect1>
461+
</sect2>
462462

463-
<sect1 id="gin-implementation">
463+
<sect2 id="gin-implementation">
464464
<title>Implementation</title>
465465

466466
<para>
@@ -497,7 +497,7 @@
497497
</mediaobject>
498498
</figure>
499499

500-
<sect2 id="gin-fast-update">
500+
<sect3 id="gin-fast-update">
501501
<title>GIN Fast Update Technique</title>
502502

503503
<para>
@@ -535,9 +535,9 @@
535535
<acronym>GIN</acronym> index. See <xref linkend="sql-createindex"/>
536536
for details.
537537
</para>
538-
</sect2>
538+
</sect3>
539539

540-
<sect2 id="gin-partial-match">
540+
<sect3 id="gin-partial-match">
541541
<title>Partial Match Algorithm</title>
542542

543543
<para>
@@ -554,11 +554,11 @@
554554
to be searched, or greater than zero if the index key is past the range
555555
that could match.
556556
</para>
557-
</sect2>
557+
</sect3>
558558

559-
</sect1>
559+
</sect2>
560560

561-
<sect1 id="gin-tips">
561+
<sect2 id="gin-tips">
562562
<title>GIN Tips and Tricks</title>
563563

564564
<variablelist>
@@ -653,9 +653,9 @@
653653
</varlistentry>
654654
</variablelist>
655655

656-
</sect1>
656+
</sect2>
657657

658-
<sect1 id="gin-limit">
658+
<sect2 id="gin-limit">
659659
<title>Limitations</title>
660660

661661
<para>
@@ -667,9 +667,9 @@
667667
however that null key values contained within a non-null composite item
668668
or query value are supported.
669669
</para>
670-
</sect1>
670+
</sect2>
671671

672-
<sect1 id="gin-examples">
672+
<sect2 id="gin-examples">
673673
<title>Examples</title>
674674

675675
<para>
@@ -709,6 +709,6 @@
709709
</varlistentry>
710710
</variablelist>
711711
</para>
712-
</sect1>
712+
</sect2>
713713

714-
</chapter>
714+
</sect1>

‎doc/src/sgml/gist.sgml‎

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

3-
<chapter id="gist">
3+
<sect1 id="gist">
44
<title>GiST Indexes</title>
55

66
<indexterm>
77
<primary>index</primary>
88
<secondary>GiST</secondary>
99
</indexterm>
1010

11-
<sect1 id="gist-intro">
11+
<sect2 id="gist-intro">
1212
<title>Introduction</title>
1313

1414
<para>
@@ -38,9 +38,9 @@
3838
<ulink url="http://www.sai.msu.su/~megera/postgres/gist/">web site</ulink>.
3939
</para>
4040

41-
</sect1>
41+
</sect2>
4242

43-
<sect1 id="gist-builtin-opclasses">
43+
<sect2 id="gist-builtin-opclasses">
4444
<title>Built-in Operator Classes</title>
4545

4646
<para>
@@ -222,9 +222,9 @@ CREATE INDEX ON my_table USING GIST (my_inet_column inet_ops);
222222
</programlisting>
223223
</para>
224224

225-
</sect1>
225+
</sect2>
226226

227-
<sect1 id="gist-extensibility">
227+
<sect2 id="gist-extensibility">
228228
<title>Extensibility</title>
229229

230230
<para>
@@ -1260,12 +1260,12 @@ my_stratnum(PG_FUNCTION_ARGS)
12601260
will accumulate for the duration of the operation.
12611261
</para>
12621262

1263-
</sect1>
1263+
</sect2>
12641264

1265-
<sect1 id="gist-implementation">
1265+
<sect2 id="gist-implementation">
12661266
<title>Implementation</title>
12671267

1268-
<sect2 id="gist-buffering-build">
1268+
<sect3 id="gist-buffering-build">
12691269
<title>GiST Index Build Methods</title>
12701270

12711271
<para>
@@ -1314,10 +1314,10 @@ my_stratnum(PG_FUNCTION_ARGS)
13141314
is ordered.
13151315
</para>
13161316

1317-
</sect2>
1318-
</sect1>
1317+
</sect3>
1318+
</sect2>
13191319

1320-
<sect1 id="gist-examples">
1320+
<sect2 id="gist-examples">
13211321
<title>Examples</title>
13221322

13231323
<para>
@@ -1382,6 +1382,6 @@ my_stratnum(PG_FUNCTION_ARGS)
13821382
</variablelist>
13831383
</para>
13841384

1385-
</sect1>
1385+
</sect2>
13861386

1387-
</chapter>
1387+
</sect1>

0 commit comments

Comments
 (0)