Skip to content

Commit ebf67f7

Browse files
committed
docs: jtag-debugging: fix ups in English version
1 parent 4ff2750 commit ebf67f7

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

docs/en/api-guides/jtag-debugging/esp32.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575

7676
::
7777

78-
openocd -f board/esp32-wrover-kit-3.3v.cfg -c "init; halt; esp32 appimage_offset 0x210000"
78+
openocd -f board/esp32-wrover-kit-3.3v.cfg -c "init; halt; esp appimage_offset 0x210000"
7979

8080
---
8181

docs/en/api-guides/jtag-debugging/esp32s2.inc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474

7575
::
7676

77-
openocd -f board/esp32s2-kaluga-1.cfg -c "init; halt; esp32 appimage_offset 0x210000"
77+
openocd -f board/esp32s2-kaluga-1.cfg -c "init; halt; esp appimage_offset 0x210000"
7878

7979
---
8080

@@ -105,7 +105,7 @@
105105

106106
.. jtag-pins
107107

108-
.. list-table:: OpenOCD configuration files for ESP32
108+
.. list-table:: ESP32-S2 pins and JTAG signals
109109
:widths: 25 75
110110
:header-rows: 1
111111

docs/en/api-guides/jtag-debugging/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Open a terminal and set it up for using the ESP-IDF as described in the :ref:`se
159159

160160
.. highlight:: none
161161

162-
You should now see similar output (this log is for ESP-WROVER-KIT):
162+
You should now see similar output (this log is for |run-openocd-device-name|):
163163

164164
.. include:: {IDF_TARGET_TOOLCHAIN_NAME}.inc
165165
:start-after: run-openocd-output

docs/en/api-guides/jtag-debugging/tips-and-quirks.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Flash Mappings vs SW Flash Breakpoints
2828

2929
In order to set/clear software breakpoints in flash, OpenOCD needs to know their flash addresses. To accomplish conversion from the {IDF_TARGET_NAME} address space to the flash one, OpenOCD uses mappings of program's code regions resided in flash. Those mappings are kept in the image header which is prepended to program binary data (code and data segments) and is specific to every application image written to the flash. So to support software flash breakpoints OpenOCD should know where application image under debugging is resided in the flash. By default OpenOCD reads partition table at 0x8000 and uses mappings from the first found application image, but there can be the cases when it will not work, e.g. partition table is not at standard flash location or even there can be multiple images: one factory and two OTA and you may want to debbug any of them. To cover all possible debugging scenarios OpenOCD supports special command which can be used to set arbitrary location of application image to debug. The command has the following format:
3030

31-
``esp32 appimage_offset <offset>``
31+
``esp appimage_offset <offset>``
3232

3333
Offset should be in hex format. To reset to the default behaviour you can specify ``-1`` as offset.
3434

@@ -254,7 +254,7 @@ In case you encounter a problem with OpenOCD or GDB programs itself and do not f
254254

255255
1. In issue report provide details of your configuration:
256256

257-
a. JTAG adapter type.
257+
a. JTAG adapter type, and the chip/module being debugged.
258258
b. Release of ESP-IDF used to compile and load application that is being debugged.
259259
c. Details of OS used for debugging.
260260
d. Is OS running natively on a PC or on a virtual machine?

0 commit comments

Comments
 (0)