Просмотр исходного кода

docs: add migration guide note about `vTaskGetSnapshot` signature

Mahavir Jain 3 лет назад
Родитель
Сommit
2a30a1012d
1 измененных файлов с 1 добавлено и 0 удалено
  1. 1 0
      docs/en/migration-guides/freertos.rst

+ 1 - 0
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 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
 ----------------
 ----------------