diff options
| author | Heinrich Schuchardt | 2019-07-27 20:21:06 +0200 |
|---|---|---|
| committer | Tom Rini | 2019-08-07 15:31:02 -0400 |
| commit | b236f8c086b38a3e43bd57ed3364ab691d47c73f (patch) | |
| tree | 34587feb1722a9fcfed99e900cd6792292b1b231 /include/log.h | |
| parent | 102b0b11195ffe421f352d510c15fd6bb0e7c8f3 (diff) | |
log: document the assign() macro
Provide a concise description of the assert() macro. Point out that the
tested expression is always executed, irrespective of the value of _DEBUG.
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'include/log.h')
| -rw-r--r-- | include/log.h | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/include/log.h b/include/log.h index 7566ba7f2db..6d15e955d7e 100644 --- a/include/log.h +++ b/include/log.h @@ -183,6 +183,18 @@ int _log(enum log_category_t cat, enum log_level_t level, const char *file, */ void __assert_fail(const char *assertion, const char *file, unsigned int line, const char *function); + +/** + * assert() - assert expression is true + * + * If the expression x evaluates to false and _DEBUG evaluates to true, a panic + * message is written and the system stalls. The value of _DEBUG is set to true + * if DEBUG is defined before including common.h. + * + * The expression x is always executed irrespective of the value of _DEBUG. + * + * @x: expression to test + */ #define assert(x) \ ({ if (!(x) && _DEBUG) \ __assert_fail(#x, __FILE__, __LINE__, __func__); }) |