Nimble: Update documentation to include distinction between upstream

mesh example and ESP-BLE-MESH
espressif · Dec 13, 2022 · 71e1c0a · 71e1c0a
1 parent fe18c89
commit 71e1c0a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/components/bt/host/nimble/Kconfig.in b/components/bt/host/nimble/Kconfig.in
@@ -369,7 +369,10 @@ menuconfig BT_NIMBLE_MESH
     depends on BT_NIMBLE_ENABLED
     default n
     help
-        Enable BLE Mesh functionality
+        Enable BLE Mesh example present in upstream mynewt-nimble and not maintained by Espressif.
+
+        IDF maintains ESP-BLE-MESH as the official Mesh solution. Please refer to ESP-BLE-MESH guide at:
+        `https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/esp-ble-mesh/ble-mesh-index.html`
 
 config BT_NIMBLE_MESH_PROXY
     bool "Enable mesh proxy functionality"

diff --git a/examples/bluetooth/nimble/blemesh/README.md b/examples/bluetooth/nimble/blemesh/README.md
@@ -3,6 +3,11 @@
 
 # BLE Mesh example
 
+This example is part of upstream mynewt-nimble implementation and not maintained by Espressif.
+
+IDF maintains ESP-BLE-MESH as the official Mesh solution. Please refer to ESP-BLE-MESH guide at:
+https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/esp-ble-mesh/ble-mesh-index.html
+
 (See the README.md file in the upper level 'examples' directory for more information about examples.)
 
 This example implements Bluetooth Mesh node that supports On/Off and Level models.