Skip to content

Commit 09ac888

Browse files
dbkindernashif
authored andcommitted
doc: remove old reference to nanokernel in API doc
API comment for k_sem_take included an obsolete note about porting from the legacy nanokernel interface. Signed-off-by: David B. Kinder <[email protected]>
1 parent ddf0b57 commit 09ac888

File tree

1 file changed

+0
-6
lines changed

1 file changed

+0
-6
lines changed

include/kernel.h

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3375,12 +3375,6 @@ __syscall void k_sem_init(struct k_sem *sem, unsigned int initial_count,
33753375
* milliseconds), or one of the special values K_NO_WAIT and
33763376
* K_FOREVER.
33773377
*
3378-
* @note When porting code from the nanokernel legacy API to the new API, be
3379-
* careful with the return value of this function. The return value is the
3380-
* reverse of the one of nano_sem_take family of APIs: 0 means success, and
3381-
* non-zero means failure, while the nano_sem_take family returns 1 for success
3382-
* and 0 for failure.
3383-
*
33843378
* @retval 0 Semaphore taken.
33853379
* @retval -EBUSY Returned without waiting.
33863380
* @retval -EAGAIN Waiting period timed out.

0 commit comments

Comments
 (0)