esp-idf/docs/en/migration-guides/freertos.rst

Migrate FreeRTOS to ESP-IDF 5.0
==================================

Legacy API and Data Types
-------------------------

Previously, the `configENABLE_BACKWARD_COMPATIBILITY` option was set by default, thus allowed pre FreeRTOS v8.0.0 function names and data types to be used. The `configENABLE_BACKWARD_COMPATIBILITY` is now disabled by default, thus legacy FreeRTOS names/types are no longer supportd by default. Users should either:

- Update their code to remove usage of legacy FreeRTOS names/types
- Enable the :ref:`CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY` to explicitly allow the usage of legacy names/types

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.


FreeRTOS Asserts
----------------
Previously FreeRTOS asserts were configured separately from the rest of the system using the `FREERTOS_ASSERT` kconfig option. This option has now been removed and the configuration is now done through `COMPILER_OPTIMIZATION_ASSERTION_LEVEL`.
freertos: remove FREERTOS_ASSERT option Freertos asserts are now configured the same way as all other asserts in IDF, i.e. by configuring COMPILER_OPTIMIZATION_ASSERTION_LEVEL. 2021-12-28 04:54:31 +00:00			`Migrate FreeRTOS to ESP-IDF 5.0`
			`==================================`

freertos: Remove legacy data types This commit removes the usage of all legacy FreeRTOS data types that are exposed via configENABLE_BACKWARD_COMPATIBILITY. Legacy types can still be used by enabling CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY. 2022-02-08 09:39:38 +00:00			`Legacy API and Data Types`
			`-------------------------`

minor typo fix 2022-03-16 17:59:04 +00:00			Previously, the `configENABLE_BACKWARD_COMPATIBILITY` option was set by default, thus allowed pre FreeRTOS v8.0.0 function names and data types to be used. The `configENABLE_BACKWARD_COMPATIBILITY` is now disabled by default, thus legacy FreeRTOS names/types are no longer supportd by default. Users should either:
freertos: Remove legacy data types This commit removes the usage of all legacy FreeRTOS data types that are exposed via configENABLE_BACKWARD_COMPATIBILITY. Legacy types can still be used by enabling CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY. 2022-02-08 09:39:38 +00:00
			`- Update their code to remove usage of legacy FreeRTOS names/types`
			- Enable the :ref:`CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY` to explicitly allow the usage of legacy names/types

freertos: remove FREERTOS_ASSERT option Freertos asserts are now configured the same way as all other asserts in IDF, i.e. by configuring COMPILER_OPTIMIZATION_ASSERTION_LEVEL. 2021-12-28 04:54:31 +00:00			`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.


			`FreeRTOS Asserts`
			`----------------`
			Previously FreeRTOS asserts were configured separately from the rest of the system using the `FREERTOS_ASSERT` kconfig option. This option has now been removed and the configuration is now done through `COMPILER_OPTIMIZATION_ASSERTION_LEVEL`.