From 2a30a1012d3a8f85a9b88410bf3d979c7ea8a8d5 Mon Sep 17 00:00:00 2001 From: Mahavir Jain Date: Tue, 10 May 2022 11:40:47 +0530 Subject: [PATCH] docs: add migration guide note about `vTaskGetSnapshot` signature --- docs/en/migration-guides/freertos.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/en/migration-guides/freertos.rst b/docs/en/migration-guides/freertos.rst index 5aab155c47..76829e9ff2 100644 --- a/docs/en/migration-guides/freertos.rst +++ b/docs/en/migration-guides/freertos.rst @@ -14,6 +14,7 @@ Tasks Snapshot The header ``task_snapshot.h`` has been removed from ``freertos/task.h``. ESP-IDF developers should include ``"freertos/task_snapshot.h``` in case they need tasks snapshot API. +The function :cpp:func:`vTaskGetSnapshot` now returns ``BaseType_t``. Return value shall be ``pdTRUE`` on success and ``pdFALSE`` otherwise. FreeRTOS Asserts ----------------