Marius Vikhammer
bdfda351bd
build docs: enable building of S3 docs
...
* Added suport for building esp32s3 docs
* Fixed all related warnings
* Activated building of S3 docs for build HTML fast CI job
2021-06-09 09:30:36 +08:00
Krzysztof Budzynski
93334ea73a
Merge branch 'docs/update_CN_trans_startup_debugging-example' into 'master'
...
docs:update CN translation for startup and debugging-example
See merge request espressif/esp-idf!13791
2021-06-08 07:09:27 +00:00
daiziyan
bb6a02ae53
docs:update CN translation for startup and debugging-example
2021-06-08 11:18:27 +08:00
Krzysztof Budzynski
c07f21a467
Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master'
...
remove modules and boards section
Closes DOC-45 and DOC-355
See merge request espressif/esp-idf!12846
2021-05-31 11:12:51 +00:00
Hao Ning
fc0eba4101
remove modules and boards section
...
doc: add redirections
docs: rebase master and add redirect links
docs: delete invalid links labeled in modules-and-boards
docs:installed pre-commit config
docs:retry
docs: separate links of modules and boards
docs: removed original files and added one more redirection
docs:deleted invalid links in jtag-debugging
docs:replaced old links in jtag-debugging
docs:fixd pipeline failures
2021-05-31 16:19:15 +08:00
Roland Dobai
c68781c269
docs: Generate JTAG debugging guide based on feature instead of chip
...
It is better to check feature SOC_USB_SERIAL_JTAG_SUPPORTED which will
support other chip targets beside ESP32-C3.
2021-05-11 11:01:53 +02:00
Roland Dobai
826e9674d8
docs: Suggest how to use JTAG for ESP32-C3 on Windows
2021-05-11 11:01:53 +02:00
Krzysztof Budzynski
58424ccebf
Merge branch 'bugfix/doc_jtag_c3' into 'master'
...
docs: Update JTAG debugging guides for ESP32-C3
Closes IDF-2133
See merge request espressif/esp-idf!13102
2021-04-22 11:58:34 +00:00
Roland Dobai
a2cf1a7d38
docs: Update JTAG debugging guides for ESP32-C3
2021-04-13 12:48:50 +02:00
Eli
9ec19163ed
docs: jtag debugging: add macOS 10.15 FTDI details
...
Merges https://github.com/espressif/esp-idf/pull/5949
2021-04-12 09:15:08 +02:00
Wang Fang
c303333f52
docs: Correct uart default pin names and provid more information about ESP-Prog board
2021-03-29 14:04:13 +08:00
Dai Zi Yan
85a016dbf6
api-guides: updated CN translation for unit-tests, jtag-debugging/index, and jtag-debugging/using-debugger
2021-03-15 13:01:15 +08:00
Marius Vikhammer
548fd02d10
docs: initial update of programming guide for C3
...
Updates "front page" content, get-started, and api-guides with C3 content
Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
daiziyan
3d2d0e2247
update CN translation for ulp-risc-v partition-table tips-and-quirks and idf-monitor for api-guides
2021-01-28 19:42:54 +08:00
kirill.chalov
f634c59289
Add hypertargets to all TRM references
2021-01-26 05:51:52 +00:00
Marius Vikhammer
da947d736f
Docs: Add C3 support to build_docs
2020-12-28 12:25:03 +08:00
morris
e6a94e982c
docs: translate idf.py debug target
2020-07-24 15:59:11 +02:00
Ivan Grokhotkov
ebf67f7972
docs: jtag-debugging: fix ups in English version
2020-07-24 15:58:59 +02:00
Ivan Grokhotkov
962ea8b9f2
docs: repurpose WROVER-KIT debugging guide for Kaluga-1
2020-07-24 15:54:47 +02:00
Ivan Grokhotkov
1b661c31d5
docs: minor typos in JTAG debugging section
2020-07-24 15:54:47 +02:00
Ivan Grokhotkov
a421ea8d42
docs: formatting fix in idf.py debugging section
2020-07-24 15:54:47 +02:00
Ivan Grokhotkov
d9b6ee1d46
docs: move target-specific parts of JTAG guide into include files
...
{esp32,esp32s2}.inc files contain most of the bits and code snippets
which are different between targets. These bits are included from the
rest of the source files.
Also included is an update to the section about OpenOCD configuration
variables and files. This section wasn't updated when some of the
files and variables got renamed.
2020-07-24 15:54:47 +02:00
Alexey Gerenkov
b441df7cf1
docs: Fixes OpenOCD debug level option
2020-05-07 16:02:13 +03:00
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