diff --git a/docs/conf_common.py b/docs/conf_common.py index 375afaae54..c530326f22 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -22,7 +22,8 @@ BT_DOCS = ['api-reference/bluetooth/esp_bt_defs.rst', 'api-reference/bluetooth/bt_common.rst', 'api-reference/bluetooth/bt_vhci.rst', 'api-reference/bluetooth/controller_vhci.rst', - 'api-reference/bluetooth/index.rst'] + 'api-reference/bluetooth/index.rst', + 'migration-guides/release-5.x/5.4/bt_common.rst',] BLE_DOCS = ['api-guides/ble/index.rst', 'api-guides/ble/overview.rst', @@ -63,7 +64,10 @@ CLASSIC_BT_DOCS = ['api-guides/classic-bt/index.rst', 'api-reference/bluetooth/esp_hf_ag.rst', 'api-reference/bluetooth/esp_spp.rst', 'api-reference/bluetooth/esp_gap_bt.rst', - 'migration-guides/release-5.x/5.0/bluetooth-classic.rst'] + 'migration-guides/release-5.x/5.0/bluetooth-classic.rst', + 'migration-guides/release-5.x/5.2/bluetooth-classic.rst', + 'migration-guides/release-5.x/5.3/bluetooth-classic.rst', + 'migration-guides/release-5.x/5.4/bluetooth-classic.rst',] BLUFI_DOCS = ['api-guides/ble/blufi.rst', 'api-reference/bluetooth/esp_blufi.rst'] @@ -78,7 +82,8 @@ WIFI_DOCS = ['api-guides/low-power-mode/low-power-mode-wifi.rst', 'api-reference/network/esp_dpp.rst', 'api-reference/provisioning/provisioning.rst', 'api-reference/provisioning/wifi_provisioning.rst', - 'migration-guides/release-5.x/5.2/wifi.rst'] + 'migration-guides/release-5.x/5.2/wifi.rst', + 'migration-guides/release-5.x/5.4/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/migration-guides/release-5.x/5.2/index.rst b/docs/en/migration-guides/release-5.x/5.2/index.rst index e21d8018e6..41c7ca8656 100644 --- a/docs/en/migration-guides/release-5.x/5.2/index.rst +++ b/docs/en/migration-guides/release-5.x/5.2/index.rst @@ -13,4 +13,4 @@ Migration from 5.1 to 5.2 storage system :SOC_WIFI_SUPPORTED: wifi - bluetooth-classic + :SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic diff --git a/docs/en/migration-guides/release-5.x/5.3/index.rst b/docs/en/migration-guides/release-5.x/5.3/index.rst index 06147ed12a..2ba6fe6b67 100644 --- a/docs/en/migration-guides/release-5.x/5.3/index.rst +++ b/docs/en/migration-guides/release-5.x/5.3/index.rst @@ -6,7 +6,7 @@ Migration from 5.2 to 5.3 .. toctree:: :maxdepth: 1 - bluetooth-classic + :SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic gcc peripherals protocols diff --git a/docs/en/migration-guides/release-5.x/5.4/bluetooth-classic.rst b/docs/en/migration-guides/release-5.x/5.4/bluetooth-classic.rst index 281c56ffe4..df2202b973 100644 --- a/docs/en/migration-guides/release-5.x/5.4/bluetooth-classic.rst +++ b/docs/en/migration-guides/release-5.x/5.4/bluetooth-classic.rst @@ -12,8 +12,3 @@ Bluedroid - :component_file:`/bt/host/bluedroid/api/include/api/esp_sdp_api.h` - Field ``user2_ptr_len`` and ``user2_ptr`` is deprecated in structure ``esp_bluetooth_sdp_hdr_overlay_t``, since they are not used in SDP record creation or searching. - -Bluetooth Common APIs ---------------------- - -.. include:: ./bt_common.rst diff --git a/docs/en/migration-guides/release-5.x/5.4/bt_common.rst b/docs/en/migration-guides/release-5.x/5.4/bt_common.rst index 32d4e17537..2fbc235b1d 100644 --- a/docs/en/migration-guides/release-5.x/5.4/bt_common.rst +++ b/docs/en/migration-guides/release-5.x/5.4/bt_common.rst @@ -1,7 +1,16 @@ +Bluetooth Common +==================== + +:link_to_translation:`zh_CN:[中文]` + +The following Bluetooth Common header declarations have been moved: + .. only:: esp32 - :component_file:`/bt/include/esp32/include/esp_bt.h` + - Move the declarations of ``esp_wifi_bt_power_domain_on`` and ``esp_wifi_bt_power_domain_off`` from ``esp_bt.h`` to ``esp_phy_init.h``, since they belong to component ``esp_phy`` and are not expected to be used by customer. + .. only:: esp32c3 or esp32s3 - :component_file:`/bt/include/esp32c3/include/esp_bt.h` diff --git a/docs/en/migration-guides/release-5.x/5.4/index.rst b/docs/en/migration-guides/release-5.x/5.4/index.rst index f6b85cb5e7..ac8860ab3c 100644 --- a/docs/en/migration-guides/release-5.x/5.4/index.rst +++ b/docs/en/migration-guides/release-5.x/5.4/index.rst @@ -8,6 +8,7 @@ Migration from 5.3 to 5.4 gcc system - bluetooth-classic + :SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic + :SOC_BT_SUPPORTED: bt_common storage - wifi + :SOC_WIFI_SUPPORTED: wifi diff --git a/docs/zh_CN/migration-guides/release-5.x/5.2/index.rst b/docs/zh_CN/migration-guides/release-5.x/5.2/index.rst index 0647016290..5452f3fb32 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.2/index.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.2/index.rst @@ -13,4 +13,4 @@ storage system :SOC_WIFI_SUPPORTED: wifi - bluetooth-classic + :SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic diff --git a/docs/zh_CN/migration-guides/release-5.x/5.3/index.rst b/docs/zh_CN/migration-guides/release-5.x/5.3/index.rst index 03d9124347..6baca58e16 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.3/index.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.3/index.rst @@ -6,7 +6,7 @@ .. toctree:: :maxdepth: 1 - bluetooth-classic + :SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic gcc peripherals protocols diff --git a/docs/zh_CN/migration-guides/release-5.x/5.4/bluetooth-classic.rst b/docs/zh_CN/migration-guides/release-5.x/5.4/bluetooth-classic.rst index 1caabf7608..6249c0bd29 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.4/bluetooth-classic.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.4/bluetooth-classic.rst @@ -12,8 +12,3 @@ Bluedroid - :component_file:`/bt/host/bluedroid/api/include/api/esp_sdp_api.h` - 结构体 ``esp_bluetooth_sdp_hdr_overlay_t`` 中的字段 ``user2_ptr_len`` 和 ``user2_ptr`` 被弃用，因为 SDP 的 API 或者事件中不会用到该字段。 - -Bluetooth Common APIs ---------------------- - -.. include:: ./bt_common.rst diff --git a/docs/zh_CN/migration-guides/release-5.x/5.4/bt_common.rst b/docs/zh_CN/migration-guides/release-5.x/5.4/bt_common.rst index bf0584646a..457931f3a1 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.4/bt_common.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.4/bt_common.rst @@ -1,7 +1,16 @@ +蓝牙通用 +=================== + +:link_to_translation:`en:[English]` + +以下属于蓝牙通用的头文件声明已移动： + .. only:: esp32 - :component_file:`/bt/include/esp32/include/esp_bt.h` + - 将 ``esp_wifi_bt_power_domain_on`` 和 ``esp_wifi_bt_power_domain_off`` 的声明从 ``esp_bt.h`` 移至 ``esp_phy_init.h`` ， 因为它们属于组件 ``esp_phy`` 并且不希望被客户使用。 + .. only:: esp32c3 or esp32s3 - :component_file:`/bt/include/esp32c3/include/esp_bt.h` diff --git a/docs/zh_CN/migration-guides/release-5.x/5.4/index.rst b/docs/zh_CN/migration-guides/release-5.x/5.4/index.rst index e2256533e9..8ddefc4ab1 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.4/index.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.4/index.rst @@ -8,6 +8,7 @@ gcc system - bluetooth-classic + :SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic + :SOC_BT_SUPPORTED: bt_common storage - wifi + :SOC_WIFI_SUPPORTED: wifi