Merge branch 'doc/refer_gdbstub_indebug_section' into 'master'

docs(jtag-debugging): Add links to gdbstub for convenience

Closes IDFGH-10898

See merge request espressif/esp-idf!25751
This commit is contained in:
Alexey Gerenkov 2023-10-04 17:09:12 +08:00
commit acc04fc2cf
2 changed files with 18 additions and 2 deletions

View File

@ -3,7 +3,15 @@ JTAG Debugging
:link_to_translation:`zh_CN:[中文]`
This document provides a guide to installing OpenOCD for {IDF_TARGET_NAME} and debugging using GDB. The document is structured as follows:
This document provides a guide to installing OpenOCD for {IDF_TARGET_NAME} and debugging using GDB.
.. note::
You can also debug your {IDF_TARGET_NAME} without needing to setup JTAG or OpenOCD by using ``idf.py monitor``. See: :doc:`../../api-guides/tools/idf-monitor` and :ref:`CONFIG_ESP_SYSTEM_GDBSTUB_RUNTIME`.
.. highlight:: none
The document is structured as follows:
:ref:`jtag-debugging-introduction`
Introduction to the purpose of this guide.

View File

@ -3,7 +3,15 @@ JTAG 调试
:link_to_translation:`en:[English]`
本文将介绍如何安装 {IDF_TARGET_NAME} 的 OpenOCD 调试环境,以及如何使用 GDB 来调试 {IDF_TARGET_NAME} 的应用程序。本文结构如下:
本文将介绍如何安装 {IDF_TARGET_NAME} 的 OpenOCD 调试环境,以及如何使用 GDB 来调试 {IDF_TARGET_NAME} 的应用程序。
.. note::
也可以使用 ``idf.py monitor`` 来调试 {IDF_TARGET_NAME},免于设置 JTAG 或 OpenOCD。请参阅 :doc:`../../api-guides/tools/idf-monitor`:ref:`CONFIG_ESP_SYSTEM_GDBSTUB_RUNTIME`
.. highlight:: none
本文档结构如下:
:ref:`jtag-debugging-introduction`
介绍本指南主旨。