David Cermak
3b5c3d6521
idf.py: debug targets for easier execution of openocd, gdb, gdbui
...
Support for execution of asynchronous target, such as openocd, which
by default runs in the background, but if it's the only target idf.py
outputs the openocd in the console waiting for termination by user.
Supports also blocking commands gdb and gdbtui to start a debugging
session in an active console.
Supports running gdbgui running a UI debugging session in a browser
window, using the active console for other commands, such as openocd
or monitor.
Supports combining the debug targets in one action list, such as
idf.py openocd gdbgui monitor
2020-04-07 17:37:48 +02:00
Angus Gratton
4358f3b573
doc: Add warnings about using JTAG debugging with hardware security features
...
This is related to the following issues but is not a fix, just documentation of a workaround until we can
improve the support:
https://github.com/espressif/esp-idf/issues/4878
https://github.com/espressif/esp-idf/issues/4734
2020-04-01 17:36:08 +11:00
Angus Gratton
52d888a68b
docs: Fix broken URLs & permanent redirects
2020-03-23 18:11:23 +11:00
Marius Vikhammer
9b56892bfe
doc: fix broken .. only:: in JTAG guide
...
Added note about .. only:: limitations to guide
2020-03-03 15:30:37 +08:00
Marius Vikhammer
268816649c
Replace all TRM urls will generic template variable and remove duplicate sections
...
All references to TRM had the section duplicated for both targets using .. only:: , replaced these with a generic template url
2020-02-07 16:37:45 +11:00
Marius Vikhammer
1a90470f02
doc: Split HW-Reference into seperate files/folders for different chips
2020-02-07 16:37:44 +11:00
Marius Vikhammer
d56ea52ea1
doc: EN doc update and fixed warnings
2020-02-07 16:37:43 +11:00
Marius Vikhammer
9352899d69
doc: Update English pages with generic target name
2020-02-07 16:37:43 +11:00
Angus Gratton
9399f04da0
docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs
2020-02-07 16:37:43 +11:00
Hao Ning
8070746530
add updates to some files in api guides
...
modified errors in making html
add modifications based on the first review
modified grammar problems of the original text
2019-12-05 15:12:12 +08:00
Anton Maklakov
def05480b8
docs: Fix up some OpenOCD cmdline-s
2019-11-26 19:44:22 +08:00
Ivan Grokhotkov
8ff801766a
Merge branch 'docs/update_oocd_config_on_cmd_line' into 'master'
...
Updates OpenOCD configuration file names in documentation
See merge request espressif/esp-idf!6226
2019-11-22 05:32:35 +08:00
Kirill Chalov
1d06b6b07e
Add information on compatibility issue between JTAG and AT firmware.
2019-11-20 15:01:56 +08:00
Alexey Gerenkov
1626f827d3
docs: Updates OpenOCD configuration file names
2019-11-18 13:33:32 +03:00
suda-morris
7237e6fab7
docs: jtag-debugging: update translation
2019-08-20 14:49:48 +02:00
Ivan Grokhotkov
209fdc1e05
docs: jtag-debugging: update for IDF Tools installation method
...
- rely on OPENOCD_SCRIPTS variable in all cases, remove -s flags
- replace installation section with a reference to the Getting Started
guides
- add Windows-specific commands in a few cases
2019-08-20 14:49:48 +02:00
Angus Gratton
05ac8cfb6d
docs: Update description for Eclipse+Cmake support not ready yet
2019-07-09 14:32:26 +10:00
Angus Gratton
222146845c
docs: Make CMake build system default, mark GNU Make as legacy option
...
All `-cmake` suffixes are removed
Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-07-09 14:32:26 +10:00
Wang Fang
b24341a664
Merge make-related documents:
...
1. Moved get-started files, 7 documents in total, from get-started-cmake folder to hw-reference folder;
2. Deleted get-started files, 7 documents in total, in get-started folder;
3. Updated links in get-started-cmake/index.rst and in get-started/index.rst;
4. Modified descriptions for build system in these files.
2019-07-04 13:16:18 +08:00
Stefan Venz
82ba58db22
Fix reference in jtag debugging section
...
Merges https://github.com/espressif/esp-idf/pull/3617
Signed-off-by: Stefan Venz <stefan.venz@protonmail.com>
2019-07-02 17:49:49 +08:00
Andrey Gramakov
f59c3e7e3e
Updated building-openocd-windows.rst instruction
2019-06-11 09:00:31 +03:00
Andrey Gramakov
a50fc4f015
Final formulation of the sentence in a Command Line chapter
2019-04-11 09:27:52 +03:00
Andrey Gramakov
c3324d5645
Added some words about a non-obvious point at the Command Line section
2019-04-11 09:27:51 +03:00
Kirill Chalov
a1c39e4a53
Doc/review get st wrover kit
2019-03-26 16:12:42 +08:00
Kirill Chalov
49cca9288f
Update IDF getting started sections for make and cmake as well as IDF monitor…
2019-03-14 00:10:26 +08:00
zhuying
5b938199ab
doc(esp-idf) | JTAG debugging EN update
2019-01-30 11:34:04 +08:00
morris
7ffd0f95d2
doc/jtag_debug: translation of jtag debugging
...
translate JTAG Debugging to zh_CN
2019-01-30 11:34:04 +08:00
Alexey Gerenkov
3dcc0ae908
docs: Adds watchpoints limit configuration to example gdbinit
...
Closes https://github.com/espressif/esp-idf/issues/2335
2018-12-20 06:09:23 +00:00
Stephen Bird
bb4936b4d5
Add missing dependency.
...
Merges https://github.com/espressif/esp-idf/pull/2781
2018-12-10 19:12:46 +01:00
Angus Gratton
0798251355
windows: Add Python dependencies, openocd, and ULP to installer
2018-10-18 09:56:16 +11:00
Angus Gratton
8721173109
doc: Replace :envvar: config links with :ref:
2018-09-19 17:27:48 +10:00
Angus Gratton
a9c4ed7139
Merge branch 'master' into feature/cmake
2018-08-30 18:51:01 +08:00
Alexey Gerenkov
ac07c23e37
docs: Adds description of OpenOCD command to configure custom app image location
2018-08-27 14:08:36 +03:00
Angus Gratton
ff2404a272
Merge branch 'master' into feature/cmake
2018-08-16 17:14:17 +10:00
Alexey Gerenkov
821fe3dc5a
esp32: Adds SW flash breakpoints description
2018-07-26 13:56:45 +03:00
krzychb
b101e118f2
Renamed ESP-WROOM-32 to ESP32-WROOM-32/D/U including links to data sheets, reflected upcoming ESP32-SOLO-1 as one of options for ESP32-DevKitC, provided updated schematics and notes on C15.
2018-06-26 18:08:47 +02:00
Angus Gratton
59ab2136e8
Merge branch 'doc/kconfig_item' into 'master'
...
doc: fix the level inconsistent issue in Kconfig document
See merge request idf/esp-idf!2460
2018-06-14 12:51:50 +08:00
Ivan Grokhotkov
f47af6185d
docs/jtag: use ‘flushregs’ instead of ‘x $a1=0” in gdbinit
...
The old command caused was incorrect (x is “examine”, not “execute”)
and caused GDB register update only by chance. This replaces it with
“flushregs” command which purpose is exactly that — force GDB to
fetch registers from the remote.
2018-06-08 11:45:46 +08:00
michael
3ba8461928
doc: fix the level inconsistent issue in Kconfig document
2018-06-05 10:36:18 +00:00
Angus Gratton
6b9784cc45
Merge branch 'master' into feature/cmake_update
2018-05-31 14:46:23 +10:00
krzychb
d19dbea059
Fixed git command
2018-05-15 22:36:34 +02:00
Wenderson Oliveira
6722a78684
Fix git command. Merges https://github.com/espressif/esp-idf/pull/1943
2018-05-15 22:34:01 +02:00
Angus Gratton
c7f19e76d7
docs: Move main docs to cover CMake
...
Add "GNU Make build system" doc with "cheat sheet" for moving to new system
2018-05-07 18:45:49 +08:00
Ivan Grokhotkov
bcc5bad7b5
docs: update download links for OpenOCD
...
Point to the latest release on Github, which can now be produced by CI.
Ref. https://github.com/espressif/openocd-esp32/issues/30
Ref. https://github.com/espressif/openocd-esp32/issues/18
2018-04-18 20:58:04 +08:00
John
f32abada86
Update building-openocd-linux.rst. Merges https://github.com/espressif/esp-idf/pull/1714
...
replace - for -- in line 16 to make it run
2018-03-18 20:02:54 +01:00
krzychb
40bc387bae
Restored back original 'zh_CN' version files and updated links between versions
2018-03-13 21:57:08 +01:00
krzychb
097adc3a33
Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available
2018-03-13 21:57:08 +01:00