From 15903a1ed44442a8f6dc2b011e11933d34bf19d7 Mon Sep 17 00:00:00 2001
From: Bruce Momjian <bruce@momjian.us>
Date: Wed, 21 Feb 2001 19:07:04 +0000
Subject: [PATCH] Comment improvements.

---
 src/include/access/htup.h     | 18 +++++++++++-------
 src/include/access/itup.h     |  4 ++--
 src/include/access/nbtree.h   |  8 +++++---
 src/include/storage/bufpage.h |  4 ++--
 4 files changed, 20 insertions(+), 14 deletions(-)

diff --git a/src/include/access/htup.h b/src/include/access/htup.h
index ce7b4a2d87..76306b67bb 100644
--- a/src/include/access/htup.h
+++ b/src/include/access/htup.h
@@ -7,7 +7,7 @@
  * Portions Copyright (c) 1996-2001, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $Id: htup.h,v 1.45 2001/01/24 19:43:19 momjian Exp $
+ * $Id: htup.h,v 1.46 2001/02/21 19:07:04 momjian Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -32,7 +32,9 @@
 #define MaxHeapAttributeNumber	1600	/* 8 * 200 */
 
 /*
- * to avoid wasting space, the attributes should be layed out in such a
+ * This is the on-disk copy of the tuple.
+ * 
+ * To avoid wasting space, the attributes should be layed out in such a
  * way to reduce structure padding.
  */
 typedef struct HeapTupleHeaderData
@@ -51,12 +53,12 @@ typedef struct HeapTupleHeaderData
 
 	uint16		t_infomask;		/* various infos */
 
-	uint8		t_hoff;			/* sizeof tuple header */
+	uint8		t_hoff;			/* sizeof() tuple header */
 
 								/* ^ - 31 bytes - ^ */
 
 	bits8		t_bits[MinHeapTupleBitmapSize / 8];
-	/* bit map of domains */
+	/* bit map of NULLs */
 
 	/* MORE DATA FOLLOWS AT END OF STRUCT */
 } HeapTupleHeaderData;
@@ -174,6 +176,8 @@ typedef struct xl_heap_clean
 #define FirstLowInvalidHeapAttributeNumber		(-8)
 
 /*
+ * This is the in-memory copy of the tuple.
+ *
  * This new HeapTuple for version >= 6.5 and this is why it was changed:
  *
  * 1. t_len moved off on-disk tuple data - ItemIdData is used to get len;
@@ -190,10 +194,10 @@ typedef struct xl_heap_clean
 typedef struct HeapTupleData
 {
 	uint32			t_len;			/* length of *t_data */
-	ItemPointerData t_self;		/* SelfItemPointer */
+	ItemPointerData t_self;			/* SelfItemPointer */
 	Oid				t_tableOid;		/* table the tuple came from */
-	MemoryContext	t_datamcxt;	/* mcxt in which allocated */
-	HeapTupleHeader	t_data;		/* -> tuple header and data */
+	MemoryContext	t_datamcxt;		/* memory context of allocation */
+	HeapTupleHeader	t_data;			/* -> tuple header and data */
 } HeapTupleData;
 
 typedef HeapTupleData *HeapTuple;
diff --git a/src/include/access/itup.h b/src/include/access/itup.h
index 717bcd68ae..7d124ef56f 100644
--- a/src/include/access/itup.h
+++ b/src/include/access/itup.h
@@ -7,7 +7,7 @@
  * Portions Copyright (c) 1996-2001, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $Id: itup.h,v 1.28 2001/01/24 19:43:19 momjian Exp $
+ * $Id: itup.h,v 1.29 2001/02/21 19:07:04 momjian Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -22,7 +22,7 @@
 
 typedef struct IndexTupleData
 {
-	ItemPointerData t_tid;		/* reference TID to base tuple */
+	ItemPointerData t_tid;		/* reference TID to heap tuple */
 
 	/*
 	 * t_info is layed out in the following fashion:
diff --git a/src/include/access/nbtree.h b/src/include/access/nbtree.h
index e8d0950ecc..d87cf0eced 100644
--- a/src/include/access/nbtree.h
+++ b/src/include/access/nbtree.h
@@ -7,7 +7,7 @@
  * Portions Copyright (c) 1996-2001, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $Id: nbtree.h,v 1.51 2001/02/07 23:34:18 vadim Exp $
+ * $Id: nbtree.h,v 1.52 2001/02/21 19:07:04 momjian Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -37,15 +37,17 @@ typedef struct BTPageOpaqueData
 	BlockNumber btpo_parent;
 	uint16		btpo_flags;
 
+} BTPageOpaqueData;
+
+typedef BTPageOpaqueData *BTPageOpaque;
+
 /* Bits defined in btpo_flags */
 #define BTP_LEAF		(1 << 0)	/* It's a leaf page */
 #define BTP_ROOT		(1 << 1)	/* It's the root page (has no parent) */
 #define BTP_FREE		(1 << 2)	/* not currently used... */
 #define BTP_META		(1 << 3)	/* Set in the meta-page only */
 #define	BTP_REORDER		(1 << 4)	/* items must be re-ordered */
-} BTPageOpaqueData;
 
-typedef BTPageOpaqueData *BTPageOpaque;
 
 #define BTREE_METAPAGE	0	/* first page is meta */
 #define BTREE_MAGIC		0x053162
diff --git a/src/include/storage/bufpage.h b/src/include/storage/bufpage.h
index 7eb84e392d..07a5f2447c 100644
--- a/src/include/storage/bufpage.h
+++ b/src/include/storage/bufpage.h
@@ -7,7 +7,7 @@
  * Portions Copyright (c) 1996-2001, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $Id: bufpage.h,v 1.39 2001/01/24 19:43:27 momjian Exp $
+ * $Id: bufpage.h,v 1.40 2001/02/21 19:07:04 momjian Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -23,7 +23,7 @@
 #include "access/xlog.h"
 
 /*
- * a postgres disk page is an abstraction layered on top of a postgres
+ * A postgres disk page is an abstraction layered on top of a postgres
  * disk block (which is simply a unit of i/o, see block.h).
  *
  * specifically, while a disk block can be unformatted, a postgres
-- 
2.40.0