Fix incorrect IndexOptInfo header comment

david-rowley · david-rowley · commit 14cdab029287 · 2025-11-24T17:01:34.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
@@ -1054,9 +1054,10 @@ typedef struct RelOptInfo
  * 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
`@@ -1054,9 +1054,10 @@ typedef struct RelOptInfo`
`1054`	`1054`	`* IndexOptInfo`
`1055`	`1055`	`* Per-index information for planning/optimization`
`1056`	`1056`	`*`
`1057`		`- * indexkeys[], indexcollations[] each have ncolumns entries.`
`1058`		`- * opfamily[], and opcintype[] each have nkeycolumns entries. They do`
`1059`		`- * not contain any information about included attributes.`
	`1057`	`+ * indexkeys[] and canreturn[] each have ncolumns entries.`
	`1058`	`+ *`
	`1059`	`+ * indexcollations[], opfamily[], and opcintype[] each have nkeycolumns`
	`1060`	`+ * entries. These don't contain any information about INCLUDE columns.`
`1060`	`1061`	`*`
`1061`	`1062`	`* sortopfamily[], reverse_sort[], and nulls_first[] have`
`1062`	`1063`	`* nkeycolumns entries, if the index is ordered; but if it is unordered,`