Skip to content

Commit 0337c7f

Browse files
author
Pierre-Noel Bouteville
committed
update comment as suggested by Gaurav-Aggarwal-AWS
1 parent 7066ccc commit 0337c7f

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

tasks.c

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2065,11 +2065,12 @@ void vTaskStartScheduler( void )
20652065
/* Setting up the timer tick is hardware specific and thus in the
20662066
* portable interface. */
20672067
xPortStartScheduler();
2068-
/* if just above call of xPortStartScheduler not return pdFALSE
2069-
* Should not reach here as if the scheduler is running the
2070-
* function will not return.
2071-
* otherwise
2072-
* Should only reach here if a task calls xTaskEndScheduler(). */
2068+
/* In most cases, xPortStartScheduler() will not return. If it
2069+
* returns pdTRUE then there was not enough heap memory available
2070+
* to create either the Idle or the Timer task. If it returned
2071+
* pdFALSE, then the application called xTaskEndScheduler().
2072+
* Most ports don't implement xTaskEndScheduler() as there is
2073+
* nothing to return to. */
20732074
}
20742075
else
20752076
{

0 commit comments

Comments
 (0)