espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-03 20:54:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

freertos: clarify statement on task function not returning

Browse Source 
Mentioned in https://www.esp32.com/viewtopic.php?f=2&t=18220.
This commit is contained in:
Ivan Grokhotkov
2020-12-01 22:22:52 +01:00
parent 8da22b9878
commit 8bf1c2565f
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
components/freertos/include/freertos/task.h
View File

@@ -249,7 +249,8 @@ is used in assert() statements. */
* in SMP system. * in SMP system.
* *
* @param pvTaskCode Pointer to the task entry function. Tasks * @param pvTaskCode Pointer to the task entry function. Tasks
* must be implemented to never return (i.e. continuous loop). * must be implemented to never return (i.e. continuous loop), or should be
* terminated using vTaskDelete function.
* *
* @param pcName A descriptive name for the task. This is mainly used to * @param pcName A descriptive name for the task. This is mainly used to
* facilitate debugging. Max length defined by configMAX_TASK_NAME_LEN - default * facilitate debugging. Max length defined by configMAX_TASK_NAME_LEN - default
@@ -314,7 +315,8 @@ is used in assert() statements. */
* xTaskCreateRestricted(). * xTaskCreateRestricted().
* *
* @param pvTaskCode Pointer to the task entry function. Tasks * @param pvTaskCode Pointer to the task entry function. Tasks
* must be implemented to never return (i.e. continuous loop). * must be implemented to never return (i.e. continuous loop), or should be
* terminated using vTaskDelete function.
* *
* @param pcName A descriptive name for the task. This is mainly used to * @param pcName A descriptive name for the task. This is mainly used to
* facilitate debugging. Max length defined by configMAX_TASK_NAME_LEN - default * facilitate debugging. Max length defined by configMAX_TASK_NAME_LEN - default
@@ -400,7 +402,8 @@ is used in assert() statements. */
* task affinity in an SMP system. * task affinity in an SMP system.
* *
* @param pvTaskCode Pointer to the task entry function. Tasks * @param pvTaskCode Pointer to the task entry function. Tasks
* must be implemented to never return (i.e. continuous loop). * must be implemented to never return (i.e. continuous loop), or should be
* terminated using vTaskDelete function.
* *
* @param pcName A descriptive name for the task. This is mainly used to * @param pcName A descriptive name for the task. This is mainly used to
* facilitate debugging. The maximum length of the string is defined by * facilitate debugging. The maximum length of the string is defined by
@@ -460,7 +463,8 @@ is used in assert() statements. */
* using any dynamic memory allocation. * using any dynamic memory allocation.
* *
* @param pvTaskCode Pointer to the task entry function. Tasks * @param pvTaskCode Pointer to the task entry function. Tasks
* must be implemented to never return (i.e. continuous loop). * must be implemented to never return (i.e. continuous loop), or should be
* terminated using vTaskDelete function.
* *
* @param pcName A descriptive name for the task. This is mainly used to * @param pcName A descriptive name for the task. This is mainly used to
* facilitate debugging. The maximum length of the string is defined by * facilitate debugging. The maximum length of the string is defined by