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

pull/13114/head
Darian Leung 2023-12-05 18:03:25 +08:00
rodzic 105f6dd22c
commit 83e18bd3bd
1 zmienionych plików z 10 dodań i 1 usunięć

Wyświetl plik

@ -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.