From c15b1693f6b54a49f8b30dc6e24ae42c3a378190 Mon Sep 17 00:00:00 2001 From: Joakim Andersson Date: Wed, 16 Jun 2021 09:53:04 +0200 Subject: [PATCH] Bluetooth: host: Document settings_load is required to finalize init Document that calling settings_load is required when the application is not creating and managing the identities of the stack itself. The application will not be able to use all features of the stack before the identities have been loaded. Signed-off-by: Joakim Andersson --- include/bluetooth/bluetooth.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/include/bluetooth/bluetooth.h b/include/bluetooth/bluetooth.h index 263a1e59a0e..73f9040f8ab 100644 --- a/include/bluetooth/bluetooth.h +++ b/include/bluetooth/bluetooth.h @@ -130,6 +130,11 @@ typedef void (*bt_ready_cb_t)(int err); * Enable Bluetooth. Must be the called before any calls that * require communication with the local Bluetooth hardware. * + * When @option{CONFIG_BT_SETTINGS} has been enabled and the application is not + * managing identities of the stack itself then the application must call + * @ref settings_load() before the stack is fully enabled. + * See @ref bt_id_create() for more information. + * * @param cb Callback to notify completion or NULL to perform the * enabling synchronously. *