michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: remove old reference to nanokernel in API doc

Browse source 
API comment for k_sem_take included an obsolete note about
porting from the legacy nanokernel interface.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2019-11-20 10:22:45 -08:00 • committed by Anas Nashif
commit 09ac8885c4
1 changed files with 0 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/kernel.h
View file

@ -3375,12 +3375,6 @@ __syscall void k_sem_init(struct k_sem *sem, unsigned int initial_count,
* milliseconds), or one of the special values K_NO_WAIT and * milliseconds), or one of the special values K_NO_WAIT and
* K_FOREVER. * K_FOREVER.
* *
* @note When porting code from the nanokernel legacy API to the new API, be
* careful with the return value of this function. The return value is the
* reverse of the one of nano_sem_take family of APIs: 0 means success, and
* non-zero means failure, while the nano_sem_take family returns 1 for success
* and 0 for failure.
*
* @retval 0 Semaphore taken. * @retval 0 Semaphore taken.
* @retval -EBUSY Returned without waiting. * @retval -EBUSY Returned without waiting.
* @retval -EAGAIN Waiting period timed out. * @retval -EAGAIN Waiting period timed out.