Fix function-header comments in planner.c

sfrost · sfrost · commit 6b960aae9016 · 2018-03-14T13:51:15.000-04:00
In b563594, a couple of function header comments weren't changed, or weren't changed correctly, to reflect the arguments being passed into the functions. Specifically, get_number_of_groups() had the wrong argument name in the commit and create_grouping_paths() wasn't updated even though the arguments had been changed. The issue with create_grouping_paths() was noticed by Ashutosh Bapat, while I discovered the issue with get_number_of_groups() by looking to see if there were any similar issues from that commit. Discussion: https://postgr.es/m/CAFjFpRcbp4702jcp387PExt3fNCt62QJN8++DQGwBhsW6wRHWA@mail.gmail.com
diff --git a/src/backend/optimizer/plan/planner.c b/src/backend/optimizer/plan/planner.c
@@ -3504,7 +3504,7 @@ standard_qp_callback(PlannerInfo *root, void *extra)
  * Estimate number of groups produced by grouping clauses (1 if not grouping)
  *
  * path_rows: number of output rows from scan/join step
- * gsets: grouping set data, or NULL if not doing grouping sets
+ * gd: grouping sets data including list of grouping sets and their clauses
  *
  * If doing grouping sets, we also annotate the gsets data with the estimates
  * for each set and each individual rollup list, with a view to later
@@ -3659,9 +3659,7 @@ estimate_hashagg_tablesize(Path *path, const AggClauseCosts *agg_costs,
  * input_rel: contains the source-data Paths
  * target: the pathtarget for the result Paths to compute
  * agg_costs: cost info about all aggregates in query (in AGGSPLIT_SIMPLE mode)
- * rollup_lists: list of grouping sets, or NIL if not doing grouping sets
- * rollup_groupclauses: list of grouping clauses for grouping sets,
- *		or NIL if not doing grouping sets
+ * gd: grouping sets data including list of grouping sets and their clauses
  *
  * Note: all Paths in input_rel are expected to return the target computed
  * by make_group_input_target.

Original file line number	Diff line number	Diff line change
`@@ -3504,7 +3504,7 @@ standard_qp_callback(PlannerInfo root, void extra)`
`3504`	`3504`	`* Estimate number of groups produced by grouping clauses (1 if not grouping)`
`3505`	`3505`	`*`
`3506`	`3506`	`* path_rows: number of output rows from scan/join step`
`3507`		`- * gsets: grouping set data, or NULL if not doing grouping sets`
	`3507`	`+ * gd: grouping sets data including list of grouping sets and their clauses`
`3508`	`3508`	`*`
`3509`	`3509`	`* If doing grouping sets, we also annotate the gsets data with the estimates`
`3510`	`3510`	`* for each set and each individual rollup list, with a view to later`
`@@ -3659,9 +3659,7 @@ estimate_hashagg_tablesize(Path path, const AggClauseCosts agg_costs,`
`3659`	`3659`	`* input_rel: contains the source-data Paths`
`3660`	`3660`	`* target: the pathtarget for the result Paths to compute`
`3661`	`3661`	`* agg_costs: cost info about all aggregates in query (in AGGSPLIT_SIMPLE mode)`
`3662`		`- * rollup_lists: list of grouping sets, or NIL if not doing grouping sets`
`3663`		`- * rollup_groupclauses: list of grouping clauses for grouping sets,`
`3664`		`- * or NIL if not doing grouping sets`
	`3662`	`+ * gd: grouping sets data including list of grouping sets and their clauses`
`3665`	`3663`	`*`
`3666`	`3664`	`* Note: all Paths in input_rel are expected to return the target computed`
`3667`	`3665`	`* by make_group_input_target.`