From 83e18bd3bd8f3abea820d4a9b7190beb13cb94f0 Mon Sep 17 00:00:00 2001 From: Darian Leung Date: Tue, 5 Dec 2023 18:03:25 +0800 Subject: [PATCH] change(xtensa): Add migration guide for depreacted include paths --- docs/en/migration-guides/release-5.x/5.2/system.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/en/migration-guides/release-5.x/5.2/system.rst b/docs/en/migration-guides/release-5.x/5.2/system.rst index 1cf76ae4be..916ad605f3 100644 --- a/docs/en/migration-guides/release-5.x/5.2/system.rst +++ b/docs/en/migration-guides/release-5.x/5.2/system.rst @@ -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). -As a result, the ``#include "freertos/task_snapshot.h"`` include path has been deprecated. \ No newline at end of file +.. 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.