Skip to content

Commit 222560a

Browse files
committed
docs: Add SoC conditional flag for Bluetooth Classic in migration guides
1 parent 47a659c commit 222560a

File tree

18 files changed

+60
-30
lines changed

18 files changed

+60
-30
lines changed

docs/conf_common.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
'api-reference/bluetooth/bt_vhci.rst',
2626
'api-reference/bluetooth/controller_vhci.rst',
2727
'api-reference/bluetooth/index.rst',
28+
'migration-guides/release-5.x/5.4/bt_common.rst',
2829
]
2930

3031
BLE_DOCS = [
@@ -74,6 +75,10 @@
7475
'api-reference/bluetooth/esp_spp.rst',
7576
'api-reference/bluetooth/esp_gap_bt.rst',
7677
'migration-guides/release-5.x/5.0/bluetooth-classic.rst',
78+
'migration-guides/release-5.x/5.2/bluetooth-classic.rst',
79+
'migration-guides/release-5.x/5.3/bluetooth-classic.rst',
80+
'migration-guides/release-5.x/5.4/bluetooth-classic.rst',
81+
'migration-guides/release-6.x/6.0/bluetooth-classic.rst',
7782
]
7883

7984
BLUFI_DOCS = ['api-guides/ble/blufi.rst', 'api-reference/bluetooth/esp_blufi.rst']
@@ -90,6 +95,8 @@
9095
'api-reference/provisioning/provisioning.rst',
9196
'api-reference/provisioning/wifi_provisioning.rst',
9297
'migration-guides/release-5.x/5.2/wifi.rst',
98+
'migration-guides/release-5.x/5.4/wifi.rst',
99+
'migration-guides/release-5.x/5.5/wifi.rst',
93100
]
94101

95102
IEEE802154_DOCS = ['migration-guides/release-5.x/5.1/ieee802154.rst', 'migration-guides/release-5.x/5.2/ieee802154.rst']

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ Migration from 5.1 to 5.2
1313
storage
1414
system
1515
:SOC_WIFI_SUPPORTED: wifi
16-
bluetooth-classic
16+
:SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Migration from 5.2 to 5.3
66
.. toctree::
77
:maxdepth: 1
88

9-
bluetooth-classic
9+
:SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic
1010
gcc
1111
peripherals
1212
protocols

docs/en/migration-guides/release-5.x/5.4/bluetooth-classic.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,3 @@ Bluedroid
1212
- :component_file:`/bt/host/bluedroid/api/include/api/esp_sdp_api.h`
1313

1414
- 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.
15-
16-
Bluetooth Common APIs
17-
---------------------
18-
19-
.. include:: ./bt_common.rst

docs/en/migration-guides/release-5.x/5.4/bt_common.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
1+
Bluetooth Common
2+
====================
3+
4+
:link_to_translation:`zh_CN:[中文]`
5+
6+
The following Bluetooth Common header declarations have been moved:
7+
18
.. only:: esp32
29

310
- :component_file:`/bt/include/esp32/include/esp_bt.h`
411

12+
- 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.
13+
514
.. only:: esp32c3 or esp32s3
615

716
- :component_file:`/bt/include/esp32c3/include/esp_bt.h`

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Migration from 5.3 to 5.4
88

99
gcc
1010
system
11-
bluetooth-classic
11+
:SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic
12+
:SOC_BT_SUPPORTED: bt_common
1213
storage
13-
wifi
14+
:SOC_WIFI_SUPPORTED: wifi
1415
protocols

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Migration from 5.4 to 5.5
1010
system
1111
peripherals
1212
protocols
13-
wifi
13+
:SOC_WIFI_SUPPORTED: wifi

docs/en/migration-guides/release-6.x/6.0/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Migration from 5.5 to 6.0
66
.. toctree::
77
:maxdepth: 1
88

9-
bluetooth-classic
9+
:SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic
1010
build-system
1111
peripherals
1212
provisioning

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
storage
1414
system
1515
:SOC_WIFI_SUPPORTED: wifi
16-
bluetooth-classic
16+
:SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
.. toctree::
77
:maxdepth: 1
88

9-
bluetooth-classic
9+
:SOC_BT_CLASSIC_SUPPORTED: bluetooth-classic
1010
gcc
1111
peripherals
1212
protocols

0 commit comments

Comments
 (0)