summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlvaro Herrera2019-02-11 18:55:09 +0000
committerAlvaro Herrera2019-02-11 18:56:09 +0000
commitc603b392c32513982439bc466312d3a6b697d53e (patch)
tree3e4f5604fa0c78792ea011970f50b223e5cd997e
parent256fc004afb1eedba10232349c5149c8f41d06a1 (diff)
Fix misleading PG_RE_THROW commentary
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/[email protected]
-rw-r--r--src/include/utils/elog.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/include/utils/elog.h b/src/include/utils/elog.h
index 648eedf5af..7ac37fd270 100644
--- 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