neels has submitted this change. ( https://gerrit.osmocom.org/c/libosmocore/+/30353 )
Change subject: osmo_tdef_get(): clarify API doc on val_if_not_present ...................................................................... osmo_tdef_get(): clarify API doc on val_if_not_present Change-Id: I2301aad86d6d165a3b51c6849bcd8fe02972e0a3 --- M src/tdef.c 1 file changed, 3 insertions(+), 1 deletion(-) Approvals: pespin: Looks good to me, but someone else must approve fixeria: Looks good to me, approved Jenkins Builder: Verified diff --git a/src/tdef.c b/src/tdef.c index 7741a44..abbe581 100644 --- a/src/tdef.c +++ b/src/tdef.c @@ -200,8 +200,10 @@ * \param[in] tdefs Array of timer definitions, last entry must be fully zero initialized. * \param[in] T Timer number to get the value for. * \param[in] as_unit Return timeout value in this unit. - * \param[in] val_if_not_present Fallback value to return if no timeout is defined. + * \param[in] val_if_not_present Fallback value to return if no timeout is defined; if this is a negative number, a + * missing T timer definition aborts the program via OSMO_ASSERT(). * \return Timeout value in the unit given by as_unit, rounded up if necessary, or val_if_not_present. + * If val_if_not_present is negative and no T timer is defined, trigger OSMO_ASSERT() and do not return. */ unsigned long osmo_tdef_get(const struct osmo_tdef *tdefs, int T, enum osmo_tdef_unit as_unit, long val_if_not_present) { -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/30353 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: I2301aad86d6d165a3b51c6849bcd8fe02972e0a3 Gerrit-Change-Number: 30353 Gerrit-PatchSet: 1 Gerrit-Owner: neels <nhofm...@sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanits...@sysmocom.de> Gerrit-Reviewer: neels <nhofm...@sysmocom.de> Gerrit-Reviewer: pespin <pes...@sysmocom.de> Gerrit-MessageType: merged