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

docs: formatting fix in idf.py debugging section

Browse Source
This commit is contained in:
Ivan Grokhotkov
2020-07-03 18:00:36 +02:00
parent b513dd11ce
commit cfbd2566c1
1 changed files with 36 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2,9 +2,11 @@ Using Debugger
-------------- --------------
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`zh_CN:[中文]`
This section covers configuration and running debugger from :ref:`jtag-debugging-using-debugger-eclipse` This section covers configuration and running debugger using several methods:
or from :ref:`jtag-debugging-using-debugger-command-line` or using :ref:`jtag-debugging-with-idf-py`.
It is recommended to first check if debugger works from :ref:`jtag-debugging-using-debugger-command-line` and then move to using Eclipse. * from :ref:`jtag-debugging-using-debugger-eclipse`
* from :ref:`jtag-debugging-using-debugger-command-line`
* using :ref:`jtag-debugging-with-idf-py`.
.. _jtag-debugging-using-debugger-eclipse: .. _jtag-debugging-using-debugger-eclipse:
@@ -12,6 +14,10 @@ It is recommended to first check if debugger works from :ref:`jtag-debugging-usi
Eclipse Eclipse
^^^^^^^ ^^^^^^^
.. note::
It is recommended to first check if debugger works using :ref:`jtag-debugging-with-idf-py` or from :ref:`jtag-debugging-using-debugger-command-line` and then move to using Eclipse.
Debugging functionality is provided out of box in standard Eclipse installation. Another option is to use pluggins like "GDB Hardware Debugging" plugin. We have found this plugin quite convenient and decided to use throughout this guide. Debugging functionality is provided out of box in standard Eclipse installation. Another option is to use pluggins like "GDB Hardware Debugging" plugin. We have found this plugin quite convenient and decided to use throughout this guide.
To begin with, install "GDB Hardware Debugging" plugin by opening Eclipse and going to `Help` > `Install` New Software. To begin with, install "GDB Hardware Debugging" plugin by opening Eclipse and going to `Help` > `Install` New Software.
@@ -193,8 +199,8 @@ If you are not quite sure how to use GDB, check :ref:`jtag-debugging-examples-co
.. _jtag-debugging-with-idf-py: .. _jtag-debugging-with-idf-py:
Using idf.py debug targets idf.py debug targets
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
It is also possible to execute the described debugging tools conveniently from ``idf.py``. These commands are supported: It is also possible to execute the described debugging tools conveniently from ``idf.py``. These commands are supported:
@@ -205,9 +211,13 @@ It uses default script directory defined as ``OPENOCD_SCRIPTS`` environmental va
from an Export script (``export.sh`` or ``export.bat``). It is possible to override the script location from an Export script (``export.sh`` or ``export.bat``). It is possible to override the script location
using command line argument ``--openocd-scripts``. using command line argument ``--openocd-scripts``.
.. include:: {IDF_TARGET_TOOLCHAIN_NAME}.inc
:start-after: idf-py-openocd-default-cfg
:end-before: ---
As for the JTAG configuration of the current board, please use the environmental variable ``OPENOCD_COMMANDS`` As for the JTAG configuration of the current board, please use the environmental variable ``OPENOCD_COMMANDS``
or ``--openocd-commands`` command line argument. If none of the above is defined, or ``--openocd-commands`` command line argument. If none of the above is defined,
OpenOCD is started with ``-f board/esp32-wrover-kit-3.3v.cfg`` board definition. OpenOCD is started with |idf-py-def-cfg| board definition.
2. ``idf.py gdb`` 2. ``idf.py gdb``
@@ -230,13 +240,10 @@ It is possible to combine these debugging actions on a single command line allow
setup of blocking and non-blocking actions in one step. ``idf.py`` implements a simple logic to move the background setup of blocking and non-blocking actions in one step. ``idf.py`` implements a simple logic to move the background
actions (such as openocd) to the beginning and the interactive ones (such as gdb, monitor) to the end of the action list. actions (such as openocd) to the beginning and the interactive ones (such as gdb, monitor) to the end of the action list.
An example of a very useful combination is An example of a very useful combination is::
::
idf.py openocd gdbgui monitor idf.py openocd gdbgui monitor
.. highlight:: none
The above command runs OpenOCD in the background, starts `gdbgui <https://www.gdbgui.com>`_ to open a browser window The above command runs OpenOCD in the background, starts `gdbgui <https://www.gdbgui.com>`_ to open a browser window
with active debugger frontend and opens a serial monitor in the active console. with active debugger frontend and opens a serial monitor in the active console.