README/C-comment: document GiST's NSN value

diff --git a/src/backend/access/gist/README b/src/backend/access/gist/README
index fffdfff6e17a0ade10138eea9dc74536b9df4c3e..8ca0cf78cc97f497fa3baf9e8aded7b17100dc28 100644 (file)
--- a/src/backend/access/gist/README
+++ b/src/backend/access/gist/README
@@ -92,10 +92,10 @@ index child page to be split between the time we make a queue entry for it
 (while visiting its parent page) and the time we actually reach and scan
 the child page.  To avoid missing the entries that were moved to the right
 sibling, we detect whether a split has occurred by comparing the child
-page's NSN to the LSN that the parent had when visited.  If it did, the
-sibling page is immediately added to the front of the queue, ensuring that
-its items will be scanned in the same order as if they were still on the
-original child page.
+page's NSN (node sequence number, a special-purpose LSN) to the LSN that
+the parent had when visited.  If it did, the sibling page is immediately
+added to the front of the queue, ensuring that its items will be scanned
+in the same order as if they were still on the original child page.
 
 As is usual in Postgres, the search algorithm only guarantees to find index
 entries that existed before the scan started; index entries added during

diff --git a/src/include/access/gist.h b/src/include/access/gist.h
index 00c6b4f2bb93e12247ec29178313ccd4e3a0be46..aa5f1763dd0a6ec69da65fd66fcda7bc8a942680 100644 (file)
--- a/src/include/access/gist.h
+++ b/src/include/access/gist.h
@@ -51,6 +51,7 @@
 #define F_HAS_GARBAGE      (1 << 4)    /* some tuples on the page are dead,
                                         * but not deleted yet */
 
+/* NSN - node sequence number, a special-purpose LSN */
 typedef XLogRecPtr GistNSN;
 
 /*