Merge branch 'doc/update_bluedroid_init_migration_v5.2' into 'release/v5.2'

doc(bt/bluedroid): Update migration docs for new version of API for Bluedroid host stack initialization[backport 5.2]

See merge request espressif/esp-idf!28600
This commit is contained in:
Wang Meng Yang 2024-02-18 10:01:29 +08:00
commit 3de398b8c4
4 changed files with 32 additions and 0 deletions

View File

@ -0,0 +1,15 @@
Bluetooth Classic
=================
:link_to_translation:`zh_CN:[中文]`
Bluedroid
---------
The following Bluedroid API have been removed:
- :component_file:`bt/host/bluedroid/api/include/api/esp_bt_main.h`
- Remove ``esp_err_t esp_bluedroid_init(void)``
- Bluedroid stack initialization API has been replaced by ``esp_err_t esp_bluedroid_init_with_cfg(esp_bluedroid_config_t *cfg)``. Macro ``BT_BLUEDROID_INIT_CONFIG_DEFAULT()`` provides the default configuration for the initialization. The original function can be deleted directly.

View File

@ -6,6 +6,7 @@ Migration from 5.1 to 5.2
.. toctree::
:maxdepth: 1
bluetooth-classic
gcc
peripherals
protocols

View File

@ -0,0 +1,15 @@
经典蓝牙
=================
:link_to_translation:`en:[English]`
Bluedroid
---------
以下 Bluedroid API 已被移除:
- :component_file:`bt/host/bluedroid/api/include/api/esp_bt_main.h`
- 移除 ``esp_err_t esp_bluedroid_init(void)``
- Bluedroid 协议栈初始化 API 已被替换为 ``esp_err_t esp_bluedroid_init_with_cfg(esp_bluedroid_config_t *cfg)``。宏 ``BT_BLUEDROID_INIT_CONFIG_DEFAULT()`` 用于提供默认的初始化参数。原来的初始化函数可以直接删除。

View File

@ -6,6 +6,7 @@
.. toctree::
:maxdepth: 1
bluetooth-classic
gcc
peripherals
protocols