Add a comment noting that heap_copytuple_with_tuple() results in a

HeapTuple that is no longer allocated as a single palloc() block; if
used carelessly, this might result in a subsequent memory leak after
heap_freetuple().

diff --git a/src/backend/access/common/heaptuple.c b/src/backend/access/common/heaptuple.c
index d0f4b3d3825a34bab3d3563a08ff9adbae33c115..608f9c867ae23772387ca9fa5098508727b42fc7 100644 (file)
--- a/src/backend/access/common/heaptuple.c
+++ b/src/backend/access/common/heaptuple.c
@@ -16,7 +16,7 @@
  *
  *
  * IDENTIFICATION
- *       $PostgreSQL: pgsql/src/backend/access/common/heaptuple.c,v 1.111 2006/10/04 00:29:47 momjian Exp $
+ *       $PostgreSQL: pgsql/src/backend/access/common/heaptuple.c,v 1.112 2006/11/23 05:27:18 neilc Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -631,6 +631,9 @@ heap_copytuple(HeapTuple tuple)
  *             heap_copytuple_with_tuple
  *
  *             copy a tuple into a caller-supplied HeapTuple management struct
+ *
+ * Note that after calling this function, the "dest" HeapTuple will not be
+ * allocated as a single palloc() block (unlike with heap_copytuple()).
  * ----------------
  */
 void