From fd58ed2f74a532ad6cd87b15b11a448d3748061e Mon Sep 17 00:00:00 2001 From: Jakob Hasse Date: Tue, 26 Jan 2021 17:22:06 +0800 Subject: [PATCH] [doc/freertos]: fixed doc of pxTaskGetStackStart() Closes IDF-1668 --- components/freertos/include/freertos/task.h | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/components/freertos/include/freertos/task.h b/components/freertos/include/freertos/task.h index 469383707c..78cdc8ff69 100644 --- a/components/freertos/include/freertos/task.h +++ b/components/freertos/include/freertos/task.h @@ -1499,9 +1499,7 @@ configSTACK_DEPTH_TYPE uxTaskGetStackHighWaterMark2( TaskHandle_t xTask ) PRIVIL * INCLUDE_pxTaskGetStackStart must be set to 1 in FreeRTOSConfig.h for * this function to be available. * - * Returns the highest stack memory address on architectures where the stack grows down - * from high memory, and the lowest memory address on architectures where the - * stack grows up from low memory. + * Returns the lowest stack memory address, regardless of whether the stack grows up or down. * * @param xTask Handle of the task associated with the stack returned. * Set xTask to NULL to return the stack of the calling task.