Merge branch 'doc/fix_pxTaskGetStackStart' into 'master'

[doc/freertos]: fixed doc of pxTaskGetStackStart()

Closes IDF-1668

See merge request espressif/esp-idf!12159
pull/7261/head
Ivan Grokhotkov 2021-02-02 07:09:00 +08:00
commit 458308786b
1 zmienionych plików z 1 dodań i 3 usunięć

Wyświetl plik

@ -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.