Eclipse debug instructions: Save GDB Hardware Debugging with project (IDFGH-321) (IEP-1495)

[twelve12pm]

By default Eclipse saves debug configurations in its workspace directory, not in the project directory, so this file does not get committed into version control. Since it is a minor pain to set up GDB Hardware Debugging, I recommend to improve instructions as follows:

In instructions of how to debug in Eclipse using OpenOCD and GDB Hardware Debugging, here:

https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/jtag-debugging/using-debugger.html#jtag-debugging-using-debugger-eclipse

Before step 12, while still in the Debug Configurations setup dialog, go to the last tab ("Common") and select the radio button for "Shared file." This is because Eclipse by default chooses "Local file" which places the debug configuration in the Eclipse workspace directory. By choosing "Shared file" the file will be placed in the project directory, allowing it to be committed into version control.

[github-actions]

Hi @twelve12pm! This is an automated response.
If you don’t find the answer helpful, please check the ESP32 IDE forum (https://www.esp32.com/viewforum.php?f=40) or GitHub issues (https://github.com/espressif/idf-eclipse-plugin/issues) to see if the issue has already been discussed.

---

Based on the knowledge sources provided, I can see that the documentation for debugging ESP32 devices using Eclipse is consistent across different ESP chip variants (ESP32, ESP32-S3, ESP32-C3, etc.).

The current documentation describes a 12-step process for configuring GDB Hardware Debugging in Eclipse, but it doesn't mention saving the debug configuration to a shared file that can be committed to version control.

Your suggestion to improve the documentation by adding instructions to save the debug configuration as a shared file is valid. This would indeed help teams share debugging configurations through version control rather than having them stored only in individual Eclipse workspace directories.

However, I don't see specific information in the provided knowledge sources about the "Common" tab in the Debug Configurations dialog or the option to save as a "Shared file" versus a "Local file." While this is likely a standard Eclipse feature, I can't confirm the exact steps based solely on the Espressif documentation provided.

For the most accurate guidance, I recommend submitting this suggestion through Espressif's official channels for documentation improvements, such as their GitHub repository for ESP-IDF documentation.

The current debugging documentation for various ESP32 variants can be found at:

• ESP32 JTAG Debugging Using Debugger
• ESP32-S3 JTAG Debugging Using Debugger
• ESP32-C3 JTAG Debugging Using Debugger

Your suggestion would be a valuable addition to these guides.

[AndriiFilippov]

Closing as this is no longer relevant.