docs(bt/bluedroid): Update migration docs for new version of API for Bluedroid host stack initialization

2023-12-12 15:19:33 +08:00
parent 02cc74a676
commit f188f857e2
4 changed files with 32 additions and 0 deletions
@@ -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.
@@ -6,6 +6,7 @@ Migration from 5.1 to 5.2
 .. toctree::
    :maxdepth: 1

+    bluetooth-classic
    gcc
    peripherals
    protocols