Define indirection macros MBEDTLS_CHECK_RETURN_xxx
Define macros MBEDTLS_CHECK_RETURN_CRITICAL, MBEDTLS_CHECK_RETURN_TYPICAL and MBEDTLS_CHECK_RETURN_OPTIONAL so that we can indicate on a function-by-function basis whether checking the function's return value is almost always necessary (CRITICAL), typically necessary in portable applications but unnecessary in some reasonable cases (TYPICAL), or typically unnecessary (OPTIONAL). Update the documentation of MBEDTLS_CHECK_RETURN accordingly. This is split between the user documentation (Doxygen, in config.h) and the internal documentation (non-Doxygen, in platform_util.h, of minor importance since the macro isn't meant to be used directly). Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
parent
ea59237370
commit
463adf4536
2 changed files with 60 additions and 13 deletions
|
@ -258,13 +258,16 @@
|
|||
|
||||
/** \def MBEDTLS_CHECK_RETURN
|
||||
*
|
||||
* This macro appearing at the beginning of the declaration of a function
|
||||
* indicates that its return value should be checked.
|
||||
* This macro is used at the beginning of the declaration of a function
|
||||
* to indicate that its return value should be checked. It should
|
||||
* instruct the compiler to emit a warning or an error if the function
|
||||
* is called without checking its return value.
|
||||
*
|
||||
* Default implementation resides in platform_util.h.
|
||||
* You can override default implementation by defining your own.
|
||||
* Custom implementation can be empty, which will disable checking
|
||||
* of functions' return values.
|
||||
* There is a default implementation for popular compilers in platform_util.h.
|
||||
* You can override the default implementation by defining your own here.
|
||||
*
|
||||
* If the implementation here is empty, this will effectively disable the
|
||||
* checking of functions' return values.
|
||||
*/
|
||||
//#define MBEDTLS_CHECK_RETURN
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue