Update documentation of prvGetExpectedIdleTime

Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com>
This commit is contained in:
Gaurav Aggarwal 2024-05-17 11:08:15 +00:00
parent 0801c91bc6
commit e8a98c9cb3

View file

@ -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