Skip to content

Commit

Permalink
docs(jtag-debugging): add links to gdbstub for convenience
Browse files Browse the repository at this point in the history
  • Loading branch information
chipweinberger committed Aug 18, 2023
1 parent 968ce2e commit 6eb63c7
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/en/api-guides/jtag-debugging/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,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 ESP32 without needing to setup JTAG or OpenOCD by using ``idf.py monitor``. See: :doc:`IDF Monitor <../../api-guides/tools/idf-monitor.html>` 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.
Expand Down

0 comments on commit 6eb63c7

Please sign in to comment.