commonlib: compiler.h: Use non-concise comment style

The concise multi-line comment style is for inside function bodies to
save space. Outside of it, use non-concise style.

Change-Id: I34d9ec6984b598a37c438fa3c395b5478207e31d
Signed-off-by: Paul Menzel <pmenzel@molgen.mpg.de>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/65885
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Arthur Heymans <arthur@aheymans.xyz>
This commit is contained in:
Paul Menzel 2022-07-16 09:36:52 +02:00 committed by Arthur Heymans
parent 646802c598
commit 47eb1321c8
1 changed files with 23 additions and 15 deletions

View File

@ -15,19 +15,25 @@
#define __aligned(x) __attribute__((__aligned__(x))) #define __aligned(x) __attribute__((__aligned__(x)))
#endif #endif
/* Because there may be variables/parameters whose name contains "__unused" in /*
header files of libc, namely musl, names consistent with the ones in the * Because there may be variables/parameters whose name contains "__unused" in
Linux kernel may be a better choice. */ * header files of libc, namely musl, names consistent with the ones in the
* Linux kernel may be a better choice.
*/
/* This is used to mark identifiers unused in all conditions, e.g. a parameter /*
completely unused in all code branch, only present to fit an API. */ * This is used to mark identifiers unused in all conditions, e.g. a parameter
* completely unused in all code branch, only present to fit an API.
*/
#ifndef __always_unused #ifndef __always_unused
#define __always_unused __attribute__((__unused__)) #define __always_unused __attribute__((__unused__))
#endif #endif
/* This is used to mark identifiers unused in some conditions, e.g. a parameter /*
only unused in some code branches, a global variable only accessed with code * This is used to mark identifiers unused in some conditions, e.g. a parameter
being conditionally preprocessed, etc. */ * only unused in some code branches, a global variable only accessed with code
* being conditionally preprocessed, etc.
*/
#ifndef __maybe_unused #ifndef __maybe_unused
#define __maybe_unused __attribute__((__unused__)) #define __maybe_unused __attribute__((__unused__))
#endif #endif
@ -52,13 +58,15 @@
#define __fallthrough __attribute__((__fallthrough__)) #define __fallthrough __attribute__((__fallthrough__))
#endif #endif
/* This evaluates to the type of the first expression, unless that is constant /*
in which case it evaluates to the type of the second. This is useful when * This evaluates to the type of the first expression, unless that is constant
assigning macro parameters to temporary variables, because that would * in which case it evaluates to the type of the second. This is useful when
normally circumvent the special loosened type promotion rules for integer * assigning macro parameters to temporary variables, because that would
literals. By using this macro, the promotion can happen at the time the * normally circumvent the special loosened type promotion rules for integer
literal is assigned to the temporary variable. If the literal doesn't fit in * literals. By using this macro, the promotion can happen at the time the
the chosen type, -Werror=overflow will catch it, so this should be safe. */ * literal is assigned to the temporary variable. If the literal doesn't fit in
* the chosen type, -Werror=overflow will catch it, so this should be safe.
*/
#define __TYPEOF_UNLESS_CONST(expr, fallback_expr) __typeof__( \ #define __TYPEOF_UNLESS_CONST(expr, fallback_expr) __typeof__( \
__builtin_choose_expr(__builtin_constant_p(expr), fallback_expr, expr)) __builtin_choose_expr(__builtin_constant_p(expr), fallback_expr, expr))