doc: Add notes that vTaskStartScheduler() is called during startup

Closes https://github.com/espressif/esp-idf/issues/1457
This commit is contained in:
Angus Gratton
2021-03-12 11:55:05 +11:00
parent 492b061cbc
commit 37acd13cdd
3 changed files with 11 additions and 1 deletions

View File

@@ -1203,6 +1203,10 @@ BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume ) PRIVILEGED_FUNCTION;
/**
* Starts the real time kernel tick processing.
*
* NOTE: In ESP-IDF the scheduler is started automatically during
* application startup, vTaskStartScheduler() should not be called from
* ESP-IDF applications.
*
* After calling the kernel has control over which tasks are executed and when.
*
* See the demo application file main.c for an example of creating