Skip to content

Commit

Permalink
kernel: update k_work_schedule_for_queue() docstring
Browse files Browse the repository at this point in the history
This commit updates the missing retval from the underlying call of
`submit_to_queue_locked()` when the work was running and has been queued
to the queue that was running it.

Signed-off-by: Paulo Santos <pauloroberto.santos@edge.ufal.br>
  • Loading branch information
wkhadgar authored and nashif committed Jun 14, 2024
1 parent 644f6b6 commit 1db7caa
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions include/zephyr/kernel.h
Original file line number Diff line number Diff line change
Expand Up @@ -3632,6 +3632,8 @@ static inline k_ticks_t k_work_delayable_remaining_get(
*
* @retval 0 if work was already scheduled or submitted.
* @retval 1 if work has been scheduled.
* @retval 2 if @p delay is @c K_NO_WAIT and work
* was running and has been queued to the queue that was running it.
* @retval -EBUSY if @p delay is @c K_NO_WAIT and
* k_work_submit_to_queue() fails with this code.
* @retval -EINVAL if @p delay is @c K_NO_WAIT and
Expand Down

0 comments on commit 1db7caa

Please sign in to comment.