aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorPeter Eisentraut <peter_e@gmx.net>2018-02-16 20:29:20 -0500
committerPeter Eisentraut <peter_e@gmx.net>2018-03-16 13:18:05 -0400
commit8d47a908626bf0800dc6a01f4ff2b2bc15cdaf86 (patch)
treefaf0743413d5ad17a441e20b72248d7a0e2eae9e /src
parent877cdf11eaa9cabcb9b1e3c1bef0760fe08efdc3 (diff)
downloadpostgresql-8d47a908626bf0800dc6a01f4ff2b2bc15cdaf86.tar.gz
postgresql-8d47a908626bf0800dc6a01f4ff2b2bc15cdaf86.zip
Update function comments
After a6542a4b6870a019cd952d055d2e7af2da2fe102, some function comments were misplaced. Fix that. Reviewed-by: Alvaro Herrera <alvherre@alvh.no-ip.org>
Diffstat (limited to 'src')
-rw-r--r--src/backend/access/transam/xact.c39
1 files changed, 19 insertions, 20 deletions
diff --git a/src/backend/access/transam/xact.c b/src/backend/access/transam/xact.c
index dbaaf8e0053..df7c8ebea1e 100644
--- a/src/backend/access/transam/xact.c
+++ b/src/backend/access/transam/xact.c
@@ -3190,12 +3190,25 @@ PreventTransactionChain(bool isTopLevel, const char *stmtType)
}
/*
- * These two functions allow for warnings or errors if a command is
- * executed outside of a transaction block.
+ * WarnNoTranactionChain
+ * RequireTransactionChain
+ *
+ * These two functions allow for warnings or errors if a command is executed
+ * outside of a transaction block. This is useful for commands that have no
+ * effects that persist past transaction end (and so calling them outside a
+ * transaction block is presumably an error). DECLARE CURSOR is an example.
+ * While top-level transaction control commands (BEGIN/COMMIT/ABORT) and SET
+ * that have no effect issue warnings, all other no-effect commands generate
+ * errors.
+ *
+ * If we appear to be running inside a user-defined function, we do not
+ * issue anything, since the function could issue more commands that make
+ * use of the current statement's results. Likewise subtransactions.
+ * Thus these are inverses for PreventTransactionChain.
*
- * While top-level transaction control commands (BEGIN/COMMIT/ABORT) and
- * SET that have no effect issue warnings, all other no-effect commands
- * generate errors.
+ * isTopLevel: passed down from ProcessUtility to determine whether we are
+ * inside a function.
+ * stmtType: statement type name, for warning or error messages.
*/
void
WarnNoTransactionChain(bool isTopLevel, const char *stmtType)
@@ -3210,21 +3223,7 @@ RequireTransactionChain(bool isTopLevel, const char *stmtType)
}
/*
- * RequireTransactionChain
- *
- * This routine is to be called by statements that must run inside
- * a transaction block, because they have no effects that persist past
- * transaction end (and so calling them outside a transaction block
- * is presumably an error). DECLARE CURSOR is an example.
- *
- * If we appear to be running inside a user-defined function, we do not
- * issue anything, since the function could issue more commands that make
- * use of the current statement's results. Likewise subtransactions.
- * Thus this is an inverse for PreventTransactionChain.
- *
- * isTopLevel: passed down from ProcessUtility to determine whether we are
- * inside a function.
- * stmtType: statement type name, for warning or error messages.
+ * This is the implementation of the above two.
*/
static void
CheckTransactionChain(bool isTopLevel, bool throwError, const char *stmtType)