From 195524efa85a01c2e53944dd3bceacb4e3d24ddb Mon Sep 17 00:00:00 2001 From: Chip Weinberger Date: Fri, 18 Aug 2023 00:24:02 -0700 Subject: [PATCH] docs(jtag-debugging): Add links to gdbstub for convenience Closes https://github.com/espressif/esp-idf/pull/12097 --- docs/en/api-guides/jtag-debugging/index.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/en/api-guides/jtag-debugging/index.rst b/docs/en/api-guides/jtag-debugging/index.rst index 9922131185..d022eb39ef 100644 --- a/docs/en/api-guides/jtag-debugging/index.rst +++ b/docs/en/api-guides/jtag-debugging/index.rst @@ -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:`IDF Monitor <../../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.