OpenOCD: Update doc

NatashaLi-ESPRESSIF · Aug 19, 2020 · f8d039a · f8d039a
1 parent 4c26c84
commit f8d039a
Show file tree

Hide file tree

Showing 10 changed files with 36 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -172,11 +172,12 @@ CMake editor preferences can be controlled using `Eclipse > Preferences > CMakeE
 
 <a name="debugging"></a>
 # Debugging the Project
-Please refer to <a href ="https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/jtag-debugging/index.html" > JTAG Debugging guide</a>
+## GDB Hardware Debugging
+Please refer to <a href ="https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/jtag-debugging/index.html" > GDB Hardware Debugging guide</a>
 
-Predefined debug launch configuration files can be found  <a href ="https://github.com/espressif/idf-eclipse-plugin/tree/master/resources/Debugging%20Launch%20Configurations" > here</a>. These can be used for reference.
+## GDB OpenOCD Debugging
+Please refer to this <a href="https://github.com/espressif/idf-eclipse-plugin/tree/master/docs/OpenOCD%20Debugging.md">GDB OpenOCD Debugging</a>
 
-Please refer to [Importing Debug Launch Configuration](#customizeLaunchConfig) section for importing the existing configuration files into Eclipse. Make sure to modify the debug launch configuraton project specific settings after importing.
 
 <a name="sizeanalysiseditor"></a>
 # ESP-IDF Application Size Analysis

diff --git a/docs/OpenOCD Debugging.md b/docs/OpenOCD Debugging.md
@@ -0,0 +1,32 @@
+## ESP-IDF GDB OpenOCD Debugging
+In ESP-IDF GDB OpenOCD Debugging, both GDB server and GDB client both will be initiated by Eclipse, so no need to run anything from the command line.
+
+Before you get started, please make sure you've already installed `Embedded C/C++ OpenOCD Debugging` plugin while updating the IDF Eclipse Plugin.
+
+![](images/OpenOCDDebug_1.png)
+
+# Create a new debug configuration
+Please follow the below steps to create a new debug configuration.
+* Right-click on the project
+* `Debug As > Debug Configurations...` This will launch a debug configuration window
+* On the left Panel, choose `ESP-IDF GDB OpenOCD Debugging`
+* Right Click and create `New Configuration` This will create a new debug configuration for your project
+
+Please navigate through each tab and configure project specific settings. 
+> **NOTE:**  Most of the settings are auto-configured by the plugin.
+
+![](images/OpenOCDDebug_4.png)
+
+![](images/OpenOCDDebug_5.png)
+
+![](images/OpenOCDDebug_6.png)
+
+> **NOTE:**  Update the OpenOCD Config options based on the esp board you've choosen. Please check this here https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#id1
+
+![](images/OpenOCDDebug_7.png)
+
+
+# Preferences for OpenOCD Configuration
+OpenOCD path is auto-configured based on the `OPENOCD_SCRIPTS` path defined in the CDT Build environment variables.
+
+![](images/OpenOCDDebug_2.png)
diff --git a/docs/images/OpenOCDDebug_1.png b/docs/images/OpenOCDDebug_1.png
diff --git a/docs/images/OpenOCDDebug_2.png b/docs/images/OpenOCDDebug_2.png
diff --git a/docs/images/OpenOCDDebug_3.png b/docs/images/OpenOCDDebug_3.png
diff --git a/docs/images/OpenOCDDebug_4.png b/docs/images/OpenOCDDebug_4.png
diff --git a/docs/images/OpenOCDDebug_5.png b/docs/images/OpenOCDDebug_5.png
diff --git a/docs/images/OpenOCDDebug_6.png b/docs/images/OpenOCDDebug_6.png
diff --git a/docs/images/OpenOCDDebug_7.png b/docs/images/OpenOCDDebug_7.png
diff --git a/docs/images/OpenOCDDebug_8.png b/docs/images/OpenOCDDebug_8.png