kernel: clarify documentation for k_work_reschedule_for_queue

asemjonovs · carlescufi · commit d86e357a476c · 2023-01-04T10:36:00.000+01:00
k_work_reschedule_for_queue can handle work items in any state,
even idle.

Signed-off-by: Al Semjonovs &lt;asemjonovs@google.com&gt;
diff --git a/include/zephyr/kernel.h b/include/zephyr/kernel.h
@@ -3499,9 +3499,9 @@ extern int k_work_schedule(struct k_work_delayable *dwork,
 /** @brief Reschedule a work item to a queue after a delay.
  *
  * Unlike k_work_schedule_for_queue() this function can change the deadline of
- * a scheduled work item, and will schedule a work item that isn't idle
- * (e.g. is submitted or running).  This function does not affect ("unsubmit")
- * a work item that has been submitted to a queue.
+ * a scheduled work item, and will schedule a work item that is in any state
+ * (e.g. is idle, submitted, or running).  This function does not affect
+ * ("unsubmit") a work item that has been submitted to a queue.
  *
  * @funcprops \isr_ok
  *

Original file line number	Diff line number	Diff line change
`@@ -3499,9 +3499,9 @@ extern int k_work_schedule(struct k_work_delayable *dwork,`
`3499`	`3499`	`/** @brief Reschedule a work item to a queue after a delay.`
`3500`	`3500`	`*`
`3501`	`3501`	`* Unlike k_work_schedule_for_queue() this function can change the deadline of`
`3502`		`- * a scheduled work item, and will schedule a work item that isn't idle`
`3503`		`- * (e.g. is submitted or running). This function does not affect ("unsubmit")`
`3504`		`- * a work item that has been submitted to a queue.`
	`3502`	`+ * a scheduled work item, and will schedule a work item that is in any state`
	`3503`	`+ * (e.g. is idle, submitted, or running). This function does not affect`
	`3504`	`+ * ("unsubmit") a work item that has been submitted to a queue.`
`3505`	`3505`	`*`
`3506`	`3506`	`* @funcprops \isr_ok`
`3507`	`3507`	`*`