feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

change(xtensa): Add migration guide for depreacted include paths

Browse Source
This commit is contained in:
Darian Leung
2023-12-05 18:03:25 +08:00
parent b85e6d3dd8
commit a75cf3effd
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/en/migration-guides/release-5.x/5.2/system.rst
View File

@@ -11,4 +11,13 @@ Task Snapshot
The Task Snapshot API has been made private due to a lack of a practical way for the API to be used from user code (the scheduler must be halted before the API can be called). The Task Snapshot API has been made private due to a lack of a practical way for the API to be used from user code (the scheduler must be halted before the API can be called).
As a result, the ``#include "freertos/task_snapshot.h"`` include path has been deprecated. .. only:: CONFIG_IDF_TARGET_ARCH_XTENSA
Xtensa
------
A number of legacy include paths for Xtensa headers have been deprecated:
- ``#include "freertos/xtensa_api.h"`` is deprecated, please use ``#include "xtensa_api.h"`` instead.
- ``#include "freertos/xtensa_context.h"`` is deprecated, please use ``#include "xtensa_context.h"`` instead.
- ``#include "freertos/xtensa_timer.h"`` is deprecated, please use ``#include "xtensa_timer.h"`` instead.