Update documentation of prvGetExpectedIdleTime (FreeRTOS#1061)

Signed-off-by: Gaurav Aggarwal <[email protected]>
laroche · May 20, 2024 · 9697f8c · 9697f8c
1 parent 0801c91
commit 9697f8c
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/tasks.c b/tasks.c
@@ -662,7 +662,8 @@ static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait,
 
 /*
  * Return the amount of time, in ticks, that will pass before the kernel will
- * next move a task from the Blocked state to the Running state.
+ * next move a task from the Blocked state to the Running state or before the
+ * tick count overflows (whichever is earlier).
  *
  * This conditional compilation should use inequality to 0, not equality to 1.
  * This is to ensure portSUPPRESS_TICKS_AND_SLEEP() can be called when user