Fix misleading PG_RE_THROW commentary

alvherre · alvherre · commit c603b392c325 · 2019-02-11T15:56:09.000-03:00
The old verbiage indicated that PG_RE_THROW is optional, which is not really true. This has confused many people, so it seems worth fixing. Discussion: https://postgr.es/m/20190206160958.GA22304@alvherre.pgsql
diff --git a/src/include/utils/elog.h b/src/include/utils/elog.h
@@ -272,8 +272,10 @@ extern PGDLLIMPORT ErrorContextCallback *error_context_stack;
  *		PG_END_TRY();
  *
  * (The braces are not actually necessary, but are recommended so that
- * pgindent will indent the construct nicely.)	The error recovery code
- * can optionally do PG_RE_THROW() to propagate the same error outwards.
+ * pgindent will indent the construct nicely.)  The error recovery code
+ * can either do PG_RE_THROW to propagate the error outwards, or do a
+ * (sub)transaction abort. Failure to do so may leave the system in an
+ * inconsistent state for further processing.
  *
  * Note: while the system will correctly propagate any new ereport(ERROR)
  * occurring in the recovery section, there is a small limit on the number

Original file line number	Diff line number	Diff line change
`@@ -272,8 +272,10 @@ extern PGDLLIMPORT ErrorContextCallback *error_context_stack;`
`272`	`272`	`* PG_END_TRY();`
`273`	`273`	`*`
`274`	`274`	`* (The braces are not actually necessary, but are recommended so that`
`275`		`- * pgindent will indent the construct nicely.) The error recovery code`
`276`		`- * can optionally do PG_RE_THROW() to propagate the same error outwards.`
	`275`	`+ * pgindent will indent the construct nicely.) The error recovery code`
	`276`	`+ * can either do PG_RE_THROW to propagate the error outwards, or do a`
	`277`	`+ * (sub)transaction abort. Failure to do so may leave the system in an`
	`278`	`+ * inconsistent state for further processing.`
`277`	`279`	`*`
`278`	`280`	`* Note: while the system will correctly propagate any new ereport(ERROR)`
`279`	`281`	`* occurring in the recovery section, there is a small limit on the number`