Update documentation of prvGetExpectedIdleTime

aggarg · aggarg · commit e8a98c9cb3cf · 2024-05-17T11:08:15.000Z
Signed-off-by: Gaurav Aggarwal &lt;aggarg@amazon.com&gt;
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

Original file line number	Diff line number	Diff line change
`@@ -662,7 +662,8 @@ static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait,`
`662`	`662`
`663`	`663`	`/*`
`664`	`664`	`* Return the amount of time, in ticks, that will pass before the kernel will`
`665`		`- * next move a task from the Blocked state to the Running state.`
	`665`	`+ * next move a task from the Blocked state to the Running state or before the`
	`666`	`+ * tick count overflows (whichever is earlier).`
`666`	`667`	`*`
`667`	`668`	`* This conditional compilation should use inequality to 0, not equality to 1.`
`668`	`669`	`* This is to ensure portSUPPRESS_TICKS_AND_SLEEP() can be called when user`