espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-05 13:44:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docs/fix_some_broken_links' into 'master'

Browse Source 
docs: Fix some broken links to OpenOCD Debugging

Closes DOC-11273

See merge request espressif/esp-idf!40541
This commit is contained in:
Omar Chebib
2025-07-14 14:14:03 +08:00
parent c7561dc4cc ecb21d35ba
commit 54065dda3c
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/en/api-guides/jtag-debugging/using-debugger.rst
View File

@@ -23,20 +23,20 @@ Eclipse
Eclipse is an integrated development environment (IDE) that provides a powerful set of tools for developing and debugging software applications. For ESP-IDF applications, `IDF Eclipse plugin <https://github.com/espressif/idf-eclipse-plugin>`_ provides two ways of debugging:
1. `ESP-IDF GDB OpenOCD Debugging <https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/OpenOCD%20Debugging.md#esp-idf-gdb-openocd-debugging>`_
1. `ESP-IDF GDB OpenOCD Debugging <https://docs.espressif.com/projects/espressif-ide/en/latest/openocddebugging.html>`_
2. GDB Hardware Debugging
By default, Eclipse supports OpenOCD Debugging via the GDB Hardware Debugging plugin, which requires starting the OpenOCD server from the command line and configuring the GDB client from Eclipse to start with the debugging. This approach can be time-consuming and error-prone.
To make the debugging process easier, the IDF Eclipse plugin has a customized ESP-IDF GDB OpenOCD Debugging functionality. This functionality supports configuring the OpenOCD server and GDB client from within Eclipse. All the required configuration parameters will be pre-filled by the plugin, and you can start debugging with just a click of a button.
Therefore, it is recommended to use the `ESP-IDF GDB OpenOCD Debugging <https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/OpenOCD%20Debugging.md#esp-idf-gdb-openocd-debugging>`_ via the IDF Eclipse plugin.
Therefore, it is recommended to use the `ESP-IDF GDB OpenOCD Debugging <https://docs.espressif.com/projects/espressif-ide/en/latest/openocddebugging.html>`_ via the IDF Eclipse plugin.
**GDB Hardware Debugging**
.. note::
This approach is recommended only if you are unable to debug using `ESP-IDF GDB OpenOCD Debugging <https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/OpenOCD%20Debugging.md#esp-idf-gdb-openocd-debugging>`_ for some reason.
This approach is recommended only if you are unable to debug using `ESP-IDF GDB OpenOCD Debugging <https://docs.espressif.com/projects/espressif-ide/en/latest/openocddebugging.html>`_ for some reason.
To install the ``GDB Hardware Debugging`` plugin, open Eclipse and select ``Help`` > ``Install`` New Software.

6
docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst
View File

@@ -23,20 +23,20 @@
作为一款集成开发环境 (IDE)，Eclipse 提供了一套强大的工具，用于开发和调试软件应用程序。对于 ESP-IDF 应用程序，`IDF Eclipse 插件 <https://github.com/espressif/idf-eclipse-plugin>`_ 提供了两种调试方式:
1. `ESP-IDF GDB OpenOCD 调试 <https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/OpenOCD%20Debugging.md#esp-idf-gdb-openocd-debugging>`_
1. `ESP-IDF GDB OpenOCD 调试 <https://docs.espressif.com/projects/espressif-ide/en/latest/openocddebugging.html>`_
2. GDB 硬件调试
默认情况下，Eclipse 通过 GDB 硬件调试插件支持 OpenOCD 调试。该调试方式需要从命令行启动 OpenOCD 服务器，并在 Eclipse 中配置 GDB 客户端，整个过程耗时且容易出错。
为了使调试过程更加容易，`IDF Eclipse 插件 <https://github.com/espressif/idf-eclipse-plugin>`_ 提供了定制的 ESP-IDF GDB OpenOCD 调试功能，支持在 Eclipse 内部配置好 OpenOCD 服务器和 GDB 客户端。该插件已经设置好所有必需的配置参数，点击一个按钮即可开始调试。
因此，建议通过 `IDF Eclipse 插件 <https://github.com/espressif/idf-eclipse-plugin>`_ 进行 `ESP-IDF GDB OpenOCD 调试 <https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/OpenOCD%20Debugging.md#esp-idf-gdb-openocd-debugging>`__。
因此，建议通过 `IDF Eclipse 插件 <https://github.com/espressif/idf-eclipse-plugin>`_ 进行 `ESP-IDF GDB OpenOCD 调试 <https://docs.espressif.com/projects/espressif-ide/en/latest/openocddebugging.html>`__。
**GDB 硬件调试**
.. note::
只有在无法使用 `ESP-IDF GDB OpenOCD 调试 <https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/OpenOCD%20Debugging.md#esp-idf-gdb-openocd-debugging>`_ 的情况下，才建议使用 GDB 硬件调试。
只有在无法使用 `ESP-IDF GDB OpenOCD 调试 <https://docs.espressif.com/projects/espressif-ide/en/latest/openocddebugging.html>`_ 的情况下，才建议使用 GDB 硬件调试。
首先，打开 Eclipse，选择 ``Help`` > ``Install New Software`` 来安装 ``GDB Hardware Debugging`` 插件。