From 8bf1c2565f2378ba6776fc5bbcc8f5ff22f3c0a9 Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Tue, 1 Dec 2020 22:22:52 +0100 Subject: [PATCH] freertos: clarify statement on task function not returning Mentioned in https://www.esp32.com/viewtopic.php?f=2&t=18220. --- components/freertos/include/freertos/task.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/components/freertos/include/freertos/task.h b/components/freertos/include/freertos/task.h index 29a4bee27b..0012cc600b 100644 --- a/components/freertos/include/freertos/task.h +++ b/components/freertos/include/freertos/task.h @@ -249,7 +249,8 @@ is used in assert() statements. */ * in SMP system. * * @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 * facilitate debugging. Max length defined by configMAX_TASK_NAME_LEN - default @@ -314,7 +315,8 @@ is used in assert() statements. */ * xTaskCreateRestricted(). * * @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 * 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. * * @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 * 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. * * @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 * facilitate debugging. The maximum length of the string is defined by