diff options
| author | Tuomas Taipale <tuomas.taipale@nokia.com> | 2023-05-09 06:30:17 +0000 |
|---|---|---|
| committer | Petri Savolainen <petri.savolainen@nokia.com> | 2023-06-09 11:31:12 +0300 |
| commit | 72efef259341e36a10518d1c5d1c48b787578c5d (patch) | |
| tree | 966bef20e6631e6140f5ed54825259dca1abfb41 /include | |
| parent | 963eb2436a14fa4c834c056954e863f4d9793ef2 (diff) | |
api: init: clarify ODP call usage in abort function
Clarify that no ODP calls should be called in the application-provided
abort function.
Signed-off-by: Tuomas Taipale <tuomas.taipale@nokia.com>
Reviewed-by: Matias Elo <matias.elo@nokia.com>
Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
Diffstat (limited to 'include')
| -rw-r--r-- | include/odp/api/spec/init.h | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/include/odp/api/spec/init.h b/include/odp/api/spec/init.h index 69ca55767..53abc7f89 100644 --- a/include/odp/api/spec/init.h +++ b/include/odp/api/spec/init.h @@ -91,11 +91,12 @@ int odp_override_log(odp_log_level_t level, const char *fmt, ...); * - By overriding the ODP implementation default abort function * odp_override_abort(). * - * @warning The latter option is less portable and GNU linker dependent - * (utilizes function attribute "weak"). If both are defined, the odp_init_t - * function pointer has priority over the override function. + * The latter option is less portable and GNU linker dependent (utilizes function + * attribute "weak"). If both are defined, the odp_init_t function pointer has + * priority over the override function. * - * @warning this function shall not return + * Note that no ODP calls should be called in the abort function and the function + * should not return. */ void odp_override_abort(void) ODP_NORETURN; |