Copy-editing for GiST README.

diff --git a/src/backend/access/gist/README b/src/backend/access/gist/README
index 86fb575bfc0d572f3bc3470bd0ab416e3698a483..b47c5d330aaba71a45295af09eb7d5f3f382b357 100644 (file)
--- a/src/backend/access/gist/README
+++ b/src/backend/access/gist/README
@@ -1,15 +1,19 @@
-$PostgreSQL: pgsql/src/backend/access/gist/README,v 1.1 2005/09/15 16:39:15 teodor Exp $
+$PostgreSQL: pgsql/src/backend/access/gist/README,v 1.2 2005/09/15 17:44:27 neilc Exp $
 
 This directory contains an implementation of GiST indexing for Postgres.
 
-GiST is stands for Generalized Search Tree. It was introduced in seminal paper
-"Generalized Search Trees for Database Systems", 1995,Joseph M. Hellerstein,
-Jeffrey F. Naughton,Avi Pfeffer (http://www.sai.msu.su/~megera/postgres/gist/papers/gist.ps) and implemented by J. Hellerstein and P.Aoki in early version of 
-PostgreSQL ( more details is available from The GiST Indexing Project at 
-Berkeley at http://gist.cs.berkeley.edu/). As an "university" project it had a 
-limited number of features and was in rare use. 
+GiST stands for Generalized Search Tree. It was introduced in the seminal paper
+"Generalized Search Trees for Database Systems", 1995, Joseph M. Hellerstein,
+Jeffrey F. Naughton, Avi Pfeffer:
 
-Current implementation of GiST supports:
+    http://www.sai.msu.su/~megera/postgres/gist/papers/gist.ps
+
+and implemented by J. Hellerstein and P. Aoki in an early version of
+PostgreSQL (more details are available from The GiST Indexing Project
+at Berkeley at http://gist.cs.berkeley.edu/). As a "university"
+project it had a limited number of features and was in rare use.
+
+The current implementation of GiST supports:
 
   * Variable length keys
   * Composite keys (multi-key)
@@ -17,34 +21,37 @@ Current implementation of GiST supports:
   * Concurrency
   * Recovery support via WAL logging
 
-Concurrence algoritms implemented in PostgreSQL were developed following paper 
-"Access Methods for Next-Generation Database Systems" by Marcel Kornaker (http://www.sai.msu.su/~megera/postgres/gist/papers/concurrency/access-methods-for-next-generation.pdf.gz).
+The support for concurrency implemented in PostgreSQL was developed based on the paper "Access Methods for Next-Generation Database Systems" by Marcel Kornaker:
 
-Original algorithms were modified by following reasons:
+    http://www.sai.msu.su/~megera/postgres/gist/papers/concurrency/access-methods-for-next-generation.pdf.gz
 
-* They should be adapted to PostgreSQL conventions. For example, SEARCH 
+The original algorithms were modified in several ways:
+
+* They should be adapted to PostgreSQL conventions. For example, the SEARCH 
   algorithm was considerably changed, because in PostgreSQL function search 
   should return one tuple (next), not all tuples at once. Also, it should 
   release page locks between calls.
-* since we added support of variable length keys, it's not possible to guarantee
+* Since we added support for variable length keys, it's not possible to guarantee
   enough free space for all keys on pages after splitting. User defined function
   picksplit doesn't have information about size of tuples (each tuple may 
   contain several keys as in multicolumn index while picksplit could work with 
-  only one key ) and pages.
-* We modified original INSERT algorithm for perfomance reason. In particularly,
-  it's single-pass algorithm.
-* Since the paper were theoretical, some details were omited and we have to find
-  out ourself how to solve some specific problems.
+  only one key) and pages.
+* We modified original INSERT algorithm for performance reason. In particular,
+  it is now a single-pass algorithm.
+* Since the papers were theoretical, some details were omitted and we
+  have to find out ourself how to solve some specific problems.
 
-Because of above reasons, we have to revised interaction of GiST core and 
-PostgreSQL WAL system. Moreover, we encountered (and solved) a problem of 
-uncompleted insertions when recovering after crash, which was not touched in 
-the paper.
+Because of the above reasons, we have to revised interaction of GiST
+core and PostgreSQL WAL system. Moreover, we encountered (and solved)
+a problem of uncompleted insertions when recovering after crash, which
+was not touched in the paper.
 
 SEARCH ALGORITHM
-Function gettuple finds tuple, which satisfy search predicate. It store their 
-state and returns next tuple under subsequent calls. Stack contains page, 
-its LSN and LSN of parent page and currentposition is saved between calls.
+
+Function gettuple finds a tuple which satisfies the search
+predicate. It store their state and returns next tuple under
+subsequent calls. Stack contains page, its LSN and LSN of parent page
+and currentposition is saved between calls.
 
 gettuple(search-pred)
        if ( firsttime )
@@ -90,8 +97,8 @@ Penalty is used for choosing a subtree to insert; method PickSplit is used for
 the node splitting algorithm; method Union is used for propagating changes 
 upward to maintain the tree properties.
 
-NOTICE: We modified original INSERT algorithm for perfomance reason. In 
-particularly, it's single-pass algorithm.
+NOTICE: We modified original INSERT algorithm for performance reason. In 
+particularly, it is now a single-pass algorithm.
 
 Function findLeaf is used to identify subtree for insertion. Page, in which 
 insertion is proceeded, is locked as well as its parent page. Functions