فهرست منبع

freertos: clarify statement on task function not returning

Mentioned in https://www.esp32.com/viewtopic.php?f=2&t=18220.
Ivan Grokhotkov 5 سال پیش
والد
کامیت
8bf1c2565f
1فایلهای تغییر یافته به همراه8 افزوده شده و 4 حذف شده
  1. 8 4
      components/freertos/include/freertos/task.h

+ 8 - 4
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