Clarify nbtree posting list update desc issue.

petergeoghegan · petergeoghegan · commit 26e65ebdb295 · 2023-04-10T17:55:23.000-07:00
Per complaint from Melanie Plageman. Follow-up to commit 5d6728e. Reported-By: Melanie Plageman <melanieplageman@gmail.com> Discussion: https://postgr.es/m/20230411002315.oyaicmcqrq2hb3ek@liskov
diff --git a/src/backend/access/rmgrdesc/nbtdesc.c b/src/backend/access/rmgrdesc/nbtdesc.c
@@ -223,6 +223,11 @@ delvacuum_desc(StringInfo buf, char *block_data,
 		Assert(OffsetNumberIsValid(off));
 		Assert(updates->ndeletedtids > 0);
 
+		/*
+		 * "ptid" is the symbol name used when building each xl_btree_update's
+		 * array of offsets into a posting list tuple's ItemPointerData array.
+		 * xl_btree_update describes a subset of the existing TIDs to delete.
+		 */
 		appendStringInfo(buf, "{ off: %u, nptids: %u, ptids: [",
 						 off, updates->ndeletedtids);
 		for (int p = 0; p < updates->ndeletedtids; p++)
