diff options
| author | Peter Eisentraut <peter_e@gmx.net> | 2018-10-25 00:47:59 +0100 |
|---|---|---|
| committer | Peter Eisentraut <peter_e@gmx.net> | 2018-10-25 01:02:46 +0100 |
| commit | f2898de98a5407a8b78f49866ef4931813505ca2 (patch) | |
| tree | ebb945dc2fbbb01a759ed60261006eb2a0094093 /src/include/c.h | |
| parent | 4beea5508e80a65a90f3fa857ea34ec71b9d6db2 (diff) | |
| download | postgresql-f2898de98a5407a8b78f49866ef4931813505ca2.tar.gz | |
Improve unconstify() documentation
Refer to expression instead of variable when appropriate.
Discussion: https://www.postgresql.org/message-id/08adbe4e-38f8-2c73-55f0-591392371687%402ndquadrant.com
Diffstat (limited to 'src/include/c.h')
| -rw-r--r-- | src/include/c.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/include/c.h b/src/include/c.h index 4a757bc8ea..08c554aaa5 100644 --- a/src/include/c.h +++ b/src/include/c.h @@ -1122,14 +1122,14 @@ typedef union PGAlignedXLogBlock #endif /* - * Macro that allows to cast constness away from a variable, but doesn't + * Macro that allows to cast constness away from an expression, but doesn't * allow changing the underlying type. Enforcement of the latter * currently only works for gcc like compilers. * - * Please note IT IS NOT SAFE to cast constness away if the variable will ever + * Please note IT IS NOT SAFE to cast constness away if the result will ever * be modified (it would be undefined behaviour). Doing so anyway can cause * compiler misoptimizations or runtime crashes (modifying readonly memory). - * It is only safe to use when the the variable will not be modified, but API + * It is only safe to use when the the result will not be modified, but API * design or language restrictions prevent you from declaring that * (e.g. because a function returns both const and non-const variables). * @@ -1137,13 +1137,13 @@ typedef union PGAlignedXLogBlock * be nice, but not trivial, to improve that). */ #if defined(HAVE__BUILTIN_TYPES_COMPATIBLE_P) -#define unconstify(underlying_type, var) \ - (StaticAssertExpr(__builtin_types_compatible_p(__typeof(var), const underlying_type), \ +#define unconstify(underlying_type, expr) \ + (StaticAssertExpr(__builtin_types_compatible_p(__typeof(expr), const underlying_type), \ "wrong cast"), \ - (underlying_type) (var)) + (underlying_type) (expr)) #else -#define unconstify(underlying_type, var) \ - ((underlying_type) (var)) +#define unconstify(underlying_type, expr) \ + ((underlying_type) (expr)) #endif /* ---------------------------------------------------------------- |