From f1ee4f551d6bce26207f0fa44e199360f6e5e712 Mon Sep 17 00:00:00 2001
From: Rahul Tank <rahul.tank@espressif.com>
Date: Fri, 9 Dec 2022 15:13:54 +0530
Subject: [PATCH] Nimble: Update documentation to include distinction between
upstream mesh example and ESP-BLE-MESH
---
components/bt/host/nimble/Kconfig.in | 5 ++++-
examples/bluetooth/nimble/blemesh/README.md | 5 +++++
2 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/components/bt/host/nimble/Kconfig.in b/components/bt/host/nimble/Kconfig.in
index a3a23e1574d4..6c67c700780a 100644
--- a/components/bt/host/nimble/Kconfig.in
+++ b/components/bt/host/nimble/Kconfig.in
@@ -314,7 +314,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
index 9449324bbe14..604906480b66 100644
--- 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.