Fix incorrect IndexOptInfo header comment

david-rowley · david-rowley · commit 07d1dc3aebe4 · 2025-11-24T17:00:01.000+13:00
The comment incorrectly indicated that indexcollations[] stored collations for both key columns and INCLUDE columns, but in reality it only has elements for the key columns. canreturn[] didn't get a mention, so add that while we're here. Author: Junwang Zhao <zhjwpku@gmail.com> Reviewed-by: David Rowley <dgrowleyml@gmail.com> Discussion: https://postgr.es/m/CAEG8a3LwbZgMKOQ9CmZarX5DEipKivdHp5PZMOO-riL0w%3DL%3D4A%40mail.gmail.com Backpatch-through: 14
diff --git a/src/include/nodes/pathnodes.h b/src/include/nodes/pathnodes.h
@@ -1216,9 +1216,10 @@ typedef struct RelAggInfo
  * IndexOptInfo
  *		Per-index information for planning/optimization
  *
- *		indexkeys[], indexcollations[] each have ncolumns entries.
- *		opfamily[], and opcintype[]	each have nkeycolumns entries. They do
- *		not contain any information about included attributes.
+ *		indexkeys[] and canreturn[] each have ncolumns entries.
+ *
+ *		indexcollations[], opfamily[], and opcintype[] each have nkeycolumns
+ *		entries.  These don't contain any information about INCLUDE columns.
  *
  *		sortopfamily[], reverse_sort[], and nulls_first[] have
  *		nkeycolumns entries, if the index is ordered; but if it is unordered,

Original file line number	Diff line number	Diff line change
`@@ -1216,9 +1216,10 @@ typedef struct RelAggInfo`
`1216`	`1216`	`* IndexOptInfo`
`1217`	`1217`	`* Per-index information for planning/optimization`
`1218`	`1218`	`*`
`1219`		`- * indexkeys[], indexcollations[] each have ncolumns entries.`
`1220`		`- * opfamily[], and opcintype[] each have nkeycolumns entries. They do`
`1221`		`- * not contain any information about included attributes.`
	`1219`	`+ * indexkeys[] and canreturn[] each have ncolumns entries.`
	`1220`	`+ *`
	`1221`	`+ * indexcollations[], opfamily[], and opcintype[] each have nkeycolumns`
	`1222`	`+ * entries. These don't contain any information about INCLUDE columns.`
`1222`	`1223`	`*`
`1223`	`1224`	`* sortopfamily[], reverse_sort[], and nulls_first[] have`
`1224`	`1225`	`* nkeycolumns entries, if the index is ordered; but if it is unordered,`