[ESP32] Fix the installation guide around gdbgui for macOS (#26723)

adding gdbgui to wordlist
project-chip · Jan 16, 2024 · 1548794 · 1548794
1 parent f6310e7
commit 1548794
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/.github/.wordlist.txt b/.github/.wordlist.txt
@@ -564,6 +564,7 @@ FW
 gbl
 gcloud
 GDB
+gdbgui
 gdbserver
 GeneralCommissioning
 GeneralDiagnostics

diff --git a/docs/guides/esp32/setup_idf_chip.md b/docs/guides/esp32/setup_idf_chip.md
@@ -73,9 +73,12 @@ For MacOS, `gdbgui` python package will not be installed using `bootstrap.sh`
 script as it is restricted only for x64 Linux platforms. It is restricted
 because, building wheels for `gevent` (dependency of `gdbgui`) fails on MacOS.
 
-Please run the below commands after every bootstrapping.
+For ARM-based Mac, no further installation steps are necessary if Python3
+version is greater than or equal to 3.11.
 
-Workaround is to install `gdbgui` wheels as binary:
+If Python3 version is less than 3.11 or you are using x86(Intel-based) Mac then
+please run the below commands after every bootstrapping to install gdbgui wheels
+as binary
 
 ```
 python3 -m pip install -c scripts/setup/constraints.txt --no-cache --prefer-binary gdbgui==0.13.2.0
-Original file line number
+Diff line change
@@ Expand Up / @@ -564,6 +564,7 @@ FW @@
     gbl
     gcloud
     GDB
+    gdbgui
     gdbserver
     GeneralCommissioning
     GeneralDiagnostics
@@ Expand Down @@