Fix incorrect IndexOptInfo header comment

david-rowley · david-rowley · commit ea36c2f6a981 · 2025-11-24T17:02:24.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
@@ -796,9 +796,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
`@@ -796,9 +796,10 @@ typedef struct RelOptInfo`
`796`	`796`	`* IndexOptInfo`
`797`	`797`	`* Per-index information for planning/optimization`
`798`	`798`	`*`
`799`		`- * indexkeys[], indexcollations[] each have ncolumns entries.`
`800`		`- * opfamily[], and opcintype[] each have nkeycolumns entries. They do`
`801`		`- * not contain any information about included attributes.`
	`799`	`+ * indexkeys[] and canreturn[] each have ncolumns entries.`
	`800`	`+ *`
	`801`	`+ * indexcollations[], opfamily[], and opcintype[] each have nkeycolumns`
	`802`	`+ * entries. These don't contain any information about INCLUDE columns.`
`802`	`803`	`*`
`803`	`804`	`* sortopfamily[], reverse_sort[], and nulls_first[] have`
`804`	`805`	`* nkeycolumns entries, if the index is ordered; but if it is unordered,`