From fe11add26227a2c471539a8186177baad4cb65ee Mon Sep 17 00:00:00 2001 From: Darian Leung Date: Tue, 7 Feb 2023 21:54:05 +0800 Subject: [PATCH] freertos: Rename SMP changes document to ESP-IDF FreeRTOS This commit renames "freertos-smp" docuemnt to "freertos_idf". This fits better with the current dual FreeRTOS implementation (i.e., IDF FreeRTOS and Amazon SMP FreeRTOS), both of which are SMP capable. --- docs/en/api-guides/index.rst | 1 - .../freertos-smp.rst => api-reference/system/freertos_idf.rst} | 0 docs/en/api-reference/system/index.rst | 1 + docs/page_redirects.txt | 1 + docs/zh_CN/api-guides/freertos-smp.rst | 1 - docs/zh_CN/api-guides/index.rst | 1 - docs/zh_CN/api-reference/system/freertos_idf.rst | 1 + docs/zh_CN/api-reference/system/index.rst | 1 + 8 files changed, 4 insertions(+), 3 deletions(-) rename docs/en/{api-guides/freertos-smp.rst => api-reference/system/freertos_idf.rst} (100%) delete mode 100644 docs/zh_CN/api-guides/freertos-smp.rst create mode 100644 docs/zh_CN/api-reference/system/freertos_idf.rst diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index ef0891f243..b6eca8e179 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -15,7 +15,6 @@ API Guides :SOC_USB_OTG_SUPPORTED: dfu error-handling :SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index - freertos-smp :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh event-handling fatal-errors diff --git a/docs/en/api-guides/freertos-smp.rst b/docs/en/api-reference/system/freertos_idf.rst similarity index 100% rename from docs/en/api-guides/freertos-smp.rst rename to docs/en/api-reference/system/freertos_idf.rst diff --git a/docs/en/api-reference/system/index.rst b/docs/en/api-reference/system/index.rst index f25867a653..9ba13493bf 100644 --- a/docs/en/api-reference/system/index.rst +++ b/docs/en/api-reference/system/index.rst @@ -16,6 +16,7 @@ System API esp_https_ota esp_event freertos + freertos_idf freertos_additions mem_alloc heap_debug diff --git a/docs/page_redirects.txt b/docs/page_redirects.txt index a1df0df5bb..a606d2d0aa 100644 --- a/docs/page_redirects.txt +++ b/docs/page_redirects.txt @@ -55,6 +55,7 @@ get-started-cmake/get-started-pico-kit hw-reference/esp32/get-started-p get-started-cmake/get-started-pico-kit-v3 hw-reference/esp32/get-started-pico-kit-v3 api-guides/build-system-cmake api-guides/build-system +api-guides/freertos-smp api-reference/system/freertos_idf api-guides/ulp-cmake api-guides/ulp api-guides/unit-tests-cmake api-guides/unit-tests api-guides/ulp_instruction_set api-reference/system/ulp_instruction_set diff --git a/docs/zh_CN/api-guides/freertos-smp.rst b/docs/zh_CN/api-guides/freertos-smp.rst deleted file mode 100644 index 16a4ba2d28..0000000000 --- a/docs/zh_CN/api-guides/freertos-smp.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../en/api-guides/freertos-smp.rst \ No newline at end of file diff --git a/docs/zh_CN/api-guides/index.rst b/docs/zh_CN/api-guides/index.rst index 31c1530961..4279e2df49 100644 --- a/docs/zh_CN/api-guides/index.rst +++ b/docs/zh_CN/api-guides/index.rst @@ -15,7 +15,6 @@ API 指南 :SOC_USB_OTG_SUPPORTED: dfu error-handling :SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index - freertos-smp :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh event-handling fatal-errors diff --git a/docs/zh_CN/api-reference/system/freertos_idf.rst b/docs/zh_CN/api-reference/system/freertos_idf.rst new file mode 100644 index 0000000000..fc7f8db77a --- /dev/null +++ b/docs/zh_CN/api-reference/system/freertos_idf.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/freertos_idf.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/index.rst b/docs/zh_CN/api-reference/system/index.rst index c118b721d4..3a3076cca6 100644 --- a/docs/zh_CN/api-reference/system/index.rst +++ b/docs/zh_CN/api-reference/system/index.rst @@ -16,6 +16,7 @@ System API esp_https_ota esp_event freertos + freertos_idf freertos_additions mem_alloc heap_debug