From 0cca9e860d1fde6f86fbc6a3b5a4f8f9d6e76862 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Wed, 24 Mar 2021 10:49:54 +1100 Subject: [PATCH] freertos docs: Specify that uxTaskGetStackHighWaterMark() returns bytes not words As reported https://esp32.com/viewtopic.php?f=13&t=20043&p=73732 --- components/freertos/include/freertos/task.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/components/freertos/include/freertos/task.h b/components/freertos/include/freertos/task.h index f6a2908a5d..7cc73e250a 100644 --- a/components/freertos/include/freertos/task.h +++ b/components/freertos/include/freertos/task.h @@ -1452,8 +1452,8 @@ TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ) PRIVILEGED_FUNCTION; /* * this function to be available. * * 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 - * a value of 1 means 4 bytes) since the task started. The smaller the returned + * the minimum free stack space there has been (in bytes not words, unlike vanilla + * FreeRTOS) since the task started. The smaller the returned * number the closer the task has come to overflowing its stack. * * uxTaskGetStackHighWaterMark() and uxTaskGetStackHighWaterMark2() are the @@ -1465,8 +1465,8 @@ TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ) PRIVILEGED_FUNCTION; /* * @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. * - * @return The smallest amount of free stack space there has been (in words, so - * actual spaces on the stack rather than bytes) since the task referenced by + * @return The smallest amount of free stack space there has been (in bytes not words, + * unlike vanilla FreeRTOS) since the task referenced by * xTask was created. */ UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;