Doc: move info for btree opclass implementors into main documentation.
authorTom Lane <[email protected]>
Tue, 6 Feb 2018 18:52:27 +0000 (13:52 -0500)
committerTom Lane <[email protected]>
Tue, 6 Feb 2018 18:52:27 +0000 (13:52 -0500)
commit3785f7eee3d98bc0a7ac2576aac9c0be974217d4
treed979431708b4de1ca9ca23558f3171f88145036e
parentf069c91a5793ff6b7884120de748b2005ee7756f
Doc: move info for btree opclass implementors into main documentation.

Up to now, useful info for writing a new btree opclass has been buried
in the backend's nbtree/README file.  Let's move it into the SGML docs,
in preparation for extending it with info about "in_range" functions
in the upcoming window RANGE patch.

To do this, I chose to create a new chapter for btree indexes in Part VII
(Internals), parallel to the chapters that exist for the newer index AMs.
This is a pretty short chapter as-is.  At some point somebody might care
to flesh it out with more detail about btree internals, but that is
beyond the scope of my ambition for today.

Discussion: https://postgr.es/m/23141.1517874668@sss.pgh.pa.us
doc/src/sgml/btree.sgml [new file with mode: 0644]
doc/src/sgml/filelist.sgml
doc/src/sgml/postgres.sgml
doc/src/sgml/xindex.sgml
src/backend/access/nbtree/README