alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: add migration guide note about vTaskGetSnapshot signature

Browse Source
This commit is contained in:
Mahavir Jain 2022-05-10 11:40:47 +05:30
parent 5b817038a0
commit 2a30a1012d
No known key found for this signature in database
GPG Key ID: 99324EF4A00734E0
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/en/migration-guides/freertos.rst
View File

@ -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 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 FreeRTOS Asserts
---------------- ----------------