refactor(freertos/task_snapshot): Deprecate task_snapshot.h

This commit deprecates the `#include "freertos/task_snapshot.h" include path:

- Adds compatibility header with compile time warning
- Removes hints related to `task_snapshot.h`
- Adds entry to migration guide

components/freertos/esp_additions/include/freertos/task_snapshot.h

@@ -0,0 +1,9 @@
+/*
+ * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#pragma once
+
+#warning freertos/task_snapshot.h header is no longer used, and will be removed in future versions.
+#include "esp_private/freertos_debug.h"

docs/en/migration-guides/release-5.x/5.2/index.rst

@@ -8,4 +8,5 @@ Migration from 5.1 to 5.2
 
     peripherals
     protocols
+    system
     wifi

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

@@ -0,0 +1,14 @@
+System
+======
+
+:link_to_translation:`zh_CN:[中文]`
+
+FreeRTOS
+--------
+
+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.

docs/zh_CN/migration-guides/release-5.x/5.2/index.rst

@@ -8,4 +8,5 @@
 
     peripherals
     protocols
+    system
     wifi

docs/zh_CN/migration-guides/release-5.x/5.2/system.rst

@@ -0,0 +1 @@
+.. include:: ../../../../en/migration-guides/release-5.x/5.2/system.rst

tools/idf_py_actions/hints.yml

@@ -137,14 +137,6 @@
     re: "error: implicit declaration of function '(eTaskStateGet|pcTaskGetTaskName|pcTimerGetTimerName|pcQueueGetQueueName|vTaskGetTaskInfo|xTaskGetIdleRunTimeCounter)'"
     hint: "You are maybe using pre FreeRTOS V8.0.0 APIs. The backward compatibility of such APIs is no longer enabled by default. Please turn on CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY explicitly to use such APIs."
     match_to_output: True
--
-    re: "error: unknown type name 'TaskSnapshot_t'"
-    hint: "The header file task_snapshot.h is no longer included as part of freertos/task.h. Users need to include freertos/task_snapshot.h explicitly."
-    match_to_output: True
--
-    re: "error: implicit declaration of function '(pxTaskGetNext|vTaskGetSnapshot|uxTaskGetSnapshotAll)'"
-    hint: "The header file task_snapshot.h is no longer included as part of freertos/task.h. Users need to include freertos/task_snapshot.h explicitly."
-    match_to_output: True
 -
     re: "error: implicit declaration of function '(portENTER_CRITICAL_NESTED|portEXIT_CRITICAL_NESTED|vPortCPUInitializeMutex|vPortCPUAcquireMutex|vPortCPUAcquireMutexTimeout|vPortCPUReleaseMutex)'"
     hint: "The header file portmacro_deprecated.h has been removed. Users should refer the migration guide for alternative functions."

tools/test_idf_py/error_output.yml

@@ -46,9 +46,6 @@
 "error: invalid use of incomplete typedef 'esp_tls_t'\n":
     "HINT: The struct 'esp_tls_t' has now been made private - its elements can be only be accessed/modified through respective getter/setter functions. Please refer to the migration guide for more information."
 
-"error: unknown type name 'TaskSnapshot_t'\n":
-    'HINT: The header file task_snapshot.h is no longer included as part of freertos/task.h. Users need to include freertos/task_snapshot.h explicitly.'
-
 "Failed to resolve component 'component'\n":
     "HINT: The component component could not be found. This could be because: component name was misspelled, the component was not added to the build, the component has been moved to the IDF component manager or has been removed and refactored into some other component.\nPlease look out for component in 'https://components.espressif.com' and add using 'idf.py add-dependency' command.\nRefer to the migration guide for more details about moved components.\nRefer to the build-system guide for more details about how components are found and included in the build."