From 17f7fd5ba697155f51750449113a58aa684779c7 Mon Sep 17 00:00:00 2001 From: Jack Date: Sat, 27 Sep 2025 12:03:53 +0800 Subject: [PATCH] fix migration guide build error --- docs/conf_common.py | 1 + docs/en/api-reference/network/esp_now.rst | 2 +- docs/en/migration-guides/release-6.x/6.0/index.rst | 1 + docs/en/migration-guides/release-6.x/6.0/wifi.rst | 6 +++--- docs/zh_CN/migration-guides/release-6.x/6.0/index.rst | 1 + docs/zh_CN/migration-guides/release-6.x/6.0/wifi.rst | 8 ++++---- 6 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/conf_common.py b/docs/conf_common.py index f338981356..33c14f2f3b 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -95,6 +95,7 @@ WIFI_DOCS = [ 'migration-guides/release-5.x/5.2/wifi.rst', 'migration-guides/release-5.x/5.4/wifi.rst', 'migration-guides/release-5.x/5.5/wifi.rst', + 'migration-guides/release-6.x/6.0/wifi.rst', ] IEEE802154_DOCS = ['migration-guides/release-5.x/5.1/ieee802154.rst', 'migration-guides/release-5.x/5.2/ieee802154.rst'] diff --git a/docs/en/api-reference/network/esp_now.rst b/docs/en/api-reference/network/esp_now.rst index 178c799d28..fd617c9217 100644 --- a/docs/en/api-reference/network/esp_now.rst +++ b/docs/en/api-reference/network/esp_now.rst @@ -128,7 +128,7 @@ Instead, post the necessary data to a queue and handle it from a lower priority Config ESP-NOW Rate ------------------- -Call :cpp:func:`esp_now_set_peer_rate_config()` to configure ESP-NOW rate of each peer. Make sure that the peer is added before configuring the rate. This API should be called after :cpp:func:`esp_wifi_start()` and :cpp_func:`esp_now_add_peer()`. +Call :cpp:func:`esp_now_set_peer_rate_config()` to configure ESP-NOW rate of each peer. Make sure that the peer is added before configuring the rate. This API should be called after :cpp:func:`esp_wifi_start()` and :cpp:func:`esp_now_add_peer()`. Config ESP-NOW Power-saving Parameter -------------------------------------------- diff --git a/docs/en/migration-guides/release-6.x/6.0/index.rst b/docs/en/migration-guides/release-6.x/6.0/index.rst index d3bdeb8ffb..949216e30e 100644 --- a/docs/en/migration-guides/release-6.x/6.0/index.rst +++ b/docs/en/migration-guides/release-6.x/6.0/index.rst @@ -12,6 +12,7 @@ Migration from 5.5 to 6.0 peripherals provisioning protocols + :SOC_WIFI_SUPPORTED: wifi security tools storage diff --git a/docs/en/migration-guides/release-6.x/6.0/wifi.rst b/docs/en/migration-guides/release-6.x/6.0/wifi.rst index 5700543b54..129eaf2c67 100644 --- a/docs/en/migration-guides/release-6.x/6.0/wifi.rst +++ b/docs/en/migration-guides/release-6.x/6.0/wifi.rst @@ -19,13 +19,13 @@ The following functions and types have been removed. - **ESP-NOW:** The function ``esp_wifi_config_espnow_rate`` has been removed. Use ``esp_now_set_peer_rate_config`` instead. Removed Variables, Macros and Enum Values -------------------------------- +----------------------------------------- - **Authentication Modes:** The authentication modes ``WIFI_AUTH_WPA3_EXT_PSK`` and ``WIFI_AUTH_WPA3_EXT_PSK_MIXED_MODE`` have been removed. Use ``WIFI_AUTH_WPA3_PSK`` instead. - **Neighbor Report Event:** In the ``wifi_event_neighbor_report_t`` structure, the ``report`` field has been removed. Please use the ``n_report`` field instead, which is a flexible array member. -- **Wi-Fi Interface:** The header file :project_file:`components/esp_wifi/include/esp_interface.h` has been removed. The ``wifi_interface_t`` enum is now defined in :project_file:`components/esp_wifi/include/esp_wifi_types_generic.h`. The enum values (e.g. ``WIFI_IF_STA``, ``WIFI_IF_AP``) are no longer defined based on ``ESP_IF_WIFI_STA``, ``ESP_IF_WIFI_AP``, etc. +- **Wi-Fi Interface:** The header file ``components/esp_wifi/include/esp_interface.h`` has been removed. The ``wifi_interface_t`` enum is now defined in :project_file:`components/esp_wifi/include/esp_wifi_types_generic.h`. The enum values (e.g. ``WIFI_IF_STA``, ``WIFI_IF_AP``) are no longer defined based on ``ESP_IF_WIFI_STA``, ``ESP_IF_WIFI_AP``, etc. - **Wi-Fi Interface Macros:** The macros ``ESP_IF_WIFI_STA`` and ``ESP_IF_WIFI_AP`` have been removed. Please use the enum values ``WIFI_IF_STA`` and ``WIFI_IF_AP`` directly. @@ -38,7 +38,7 @@ Removed Variables, Macros and Enum Values - **FTM:** Field ``use_get_report_api`` from structure ``wifi_ftm_initiator_cfg_t`` and field ``ftm_report_data`` from structure ``wifi_event_ftm_report_t`` has been removed. Please use ``esp_wifi_ftm_get_report`` to fetch raw FTM report data instead. Modified Functions and Types ---------------------------- +---------------------------- The following Wi-Fi functions have been modified. diff --git a/docs/zh_CN/migration-guides/release-6.x/6.0/index.rst b/docs/zh_CN/migration-guides/release-6.x/6.0/index.rst index 28a7207af2..5a4c89082e 100644 --- a/docs/zh_CN/migration-guides/release-6.x/6.0/index.rst +++ b/docs/zh_CN/migration-guides/release-6.x/6.0/index.rst @@ -12,6 +12,7 @@ peripherals provisioning protocols + :SOC_WIFI_SUPPORTED: wifi security tools storage diff --git a/docs/zh_CN/migration-guides/release-6.x/6.0/wifi.rst b/docs/zh_CN/migration-guides/release-6.x/6.0/wifi.rst index a0215a985d..797a38bb2d 100644 --- a/docs/zh_CN/migration-guides/release-6.x/6.0/wifi.rst +++ b/docs/zh_CN/migration-guides/release-6.x/6.0/wifi.rst @@ -4,7 +4,7 @@ Wi-Fi 本文档概述了 v6.0 版本中与 Wi-Fi 相关的重大更改。 已移除的函数和类型 -------------------- +------------------ 以下函数和类型已被移除。 @@ -19,13 +19,13 @@ Wi-Fi - **ESP-NOW：** 函数 ``esp_wifi_config_espnow_rate`` 已被移除。请改用 ``esp_now_set_peer_rate_config``。 已移除的变量、宏和枚举值 ---------------------------- +------------------------ - **认证模式：** 认证模式 ``WIFI_AUTH_WPA3_EXT_PSK`` 和 ``WIFI_AUTH_WPA3_EXT_PSK_MIXED_MODE`` 已被移除。请改用 ``WIFI_AUTH_WPA3_PSK``。 - **邻居报告事件：** 在 ``wifi_event_neighbor_report_t`` 结构体中，``report`` 字段已被移除。请改用 ``n_report`` 字段，它是一个灵活的数组成员。 -- **Wi-Fi 接口：** 头文件 :project_file:`components/esp_wifi/include/esp_interface.h` 已被移除。``wifi_interface_t`` 枚举现在定义在 :project_file:`components/esp_wifi/include/esp_wifi_types_generic.h` 中。枚举值（例如 ``WIFI_IF_STA``、``WIFI_IF_AP``）不再基于 ``ESP_IF_WIFI_STA``、``ESP_IF_WIFI_AP`` 等定义。 +- **Wi-Fi 接口：** 头文件 ``components/esp_wifi/include/esp_interface.h`` 已被移除。``wifi_interface_t`` 枚举现在定义在 :project_file:`components/esp_wifi/include/esp_wifi_types_generic.h` 中。枚举值（例如 ``WIFI_IF_STA``、``WIFI_IF_AP``）不再基于 ``ESP_IF_WIFI_STA``、``ESP_IF_WIFI_AP`` 等定义。 - **Wi-Fi 接口宏：** 宏 ``ESP_IF_WIFI_STA`` 和 ``ESP_IF_WIFI_AP`` 已被移除。请直接使用枚举值 ``WIFI_IF_STA`` 和 ``WIFI_IF_AP``。 @@ -38,7 +38,7 @@ Wi-Fi - **FTM：** 结构体 ``wifi_ftm_initiator_cfg_t`` 中的字段 ``use_get_report_api`` 和结构体 ``wifi_event_ftm_report_t`` 中的字段 ``ftm_report_data`` 已被移除。请改用 ``esp_wifi_ftm_get_report`` 获取原始 FTM 报告数据。 已修改的函数和类型 -------------------- +------------------ 以下 Wi-Fi 函数已修改。