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

Merge branch 'bugfix/doc_freertos_task_stack_bytes' into 'master'

Browse Source 
freertos docs: Specify that uxTaskGetStackHighWaterMark() returns bytes not words

See merge request espressif/esp-idf!12866
This commit is contained in:
Angus Gratton
2021-03-28 22:40:20 +00:00
parent b2a60e0d7c 11e2620acc
commit c4b5974cd0
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1448,8 +1448,8 @@ TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ) PRIVILEGED_FUNCTION; /*
* this function to be available. * this function to be available.
* *
* Returns the high water mark of the stack associated with xTask. That is, * Returns the high water mark of the stack associated with xTask. That is,
* the minimum free stack space there has been (in words, so on a 32 bit machine * the minimum free stack space there has been (in bytes not words, unlike vanilla
* a value of 1 means 4 bytes) since the task started. The smaller the returned * FreeRTOS) since the task started. The smaller the returned
* number the closer the task has come to overflowing its stack. * number the closer the task has come to overflowing its stack.
* *
* uxTaskGetStackHighWaterMark() and uxTaskGetStackHighWaterMark2() are the * uxTaskGetStackHighWaterMark() and uxTaskGetStackHighWaterMark2() are the
@@ -1461,8 +1461,8 @@ TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ) PRIVILEGED_FUNCTION; /*
* @param xTask Handle of the task associated with the stack to be checked. * @param xTask Handle of the task associated with the stack to be checked.
* Set xTask to NULL to check the stack of the calling task. * Set xTask to NULL to check the stack of the calling task.
* *
* @return The smallest amount of free stack space there has been (in words, so * @return The smallest amount of free stack space there has been (in bytes not words,
* actual spaces on the stack rather than bytes) since the task referenced by * unlike vanilla FreeRTOS) since the task referenced by
* xTask was created. * xTask was created.
*/ */
UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask ) PRIVILEGED_FUNCTION; UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;