Commit Graph

100 Commits

Author SHA1 Message Date
Zhang Shuxian
f699058964 docs: Update CN translation for tools setup 2025-06-23 12:48:39 +02:00
renpeiying
f5a28000fa docs: Update CN for idf-monitor.rst 2025-05-12 22:07:50 +08:00
Alexey Gerenkov
e7423ebbcc feat(tools): Add standalone Clang libraries to tools.json 2025-04-14 17:10:55 +03:00
renpeiying
0d3dcf396f docs: Update CN translation 2025-04-02 19:18:12 +08:00
renpeiying
2aee9ac12c docs: Add translation for api-guides/tools/diag_tool 2025-03-04 16:44:35 +08:00
Frantisek Hrbata
e66405232c docs: add idf.py diag documentation to api-guides
Add the initial documentation for the idf.py diagnostic tool, detailing
how it can be used to gather information for troubleshooting issues
related to the ESP-IDF project.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2025-02-22 09:02:20 +01:00
Roland Dobai
a2c399c098 Merge branch 'feat/add_idf_path_setting_info' into 'master'
feat(tools): Add info message to install/export scripts about IDF_PATH being set/change.

Closes IDF-9355

See merge request espressif/esp-idf!34748
2024-11-25 17:20:55 +08:00
Roland Dobai
4110d14825 Merge branch 'feat/document_idf_version_txt_file' into 'master'
docs(tools): Mention idf_version.txt in documentation

Closes IDF-11630

See merge request espressif/esp-idf!34717
2024-11-25 17:19:10 +08:00
renpeiying
5182c8031e docs: Update CN translation for idf-tools.rst 2024-11-25 15:56:16 +08:00
Roland Dobai
7fcbdb9c2e Merge branch 'docs/sbom_tool' into 'master'
docs(sbom): add basic description about SBOM for ESP-IDF projects

Closes IDF-11485

See merge request espressif/esp-idf!34853
2024-11-14 17:28:11 +08:00
renpeiying
e4b8712bbc docs: Update CN translation for idf-tools.rst 2024-11-14 16:09:24 +08:00
Frantisek Hrbata
4e9362a1cb docs(sbom): add basic description about SBOM for ESP-IDF projects
Add a basic description and usage overview of the esp-idf-sbom tool. A
more detailed description is already available on the GitHub pages,
which this documentation refers to.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2024-11-13 15:45:19 +01:00
Frantisek Hrbata
a4acbd2758 feat: Drop Python 3.8 support
Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2024-11-12 17:02:26 +08:00
Aditya Patwardhan
6930dff98d Merge branch 'feature/add_option_to_provide_flash_file_for_qemu' into 'master'
feat(tools): Added option to specify flash image in "idf.py qemu"

See merge request espressif/esp-idf!34031
2024-10-24 02:22:43 +08:00
renpeiying
46770a50a6 docs: standardize the names of bootloaders in esp-idf 2024-10-23 11:29:24 +08:00
renpeiying
53b57e21fb docs: Update CN translation for qemu.rst 2024-10-21 18:48:02 +08:00
Mahavir Jain
27bcb047b4 Merge branch 'feature/qemu_doc_guide_updates' into 'master'
docs: misc updates to qemu guide, now enabled for ESP32-S3

See merge request espressif/esp-idf!33854
2024-10-08 12:45:23 +08:00
Peter Dragun
7d8231c0c1 Merge branch 'move_monitor_config_docs' into 'master'
docs: Move monitor configuration documentation to its own repository

See merge request espressif/esp-idf!33284
2024-10-07 22:14:53 +08:00
renpeiying
757fa4d72c docs: Update Chinese translation for docs 2024-09-29 11:35:45 +08:00
Mahavir Jain
d78439a572 docs: enable qemu doc guide for ESP32-S3 2024-09-27 13:34:00 +05:30
Peter Dragun
31dc7b6f07 docs: Move monitor configuration documentation to its own repository 2024-09-18 12:30:36 +02:00
Roland Dobai
58d10a089c docs(tools): Fix clang-tidy documentation about RISC-V being supported 2024-09-16 12:12:43 +02:00
Marek Fiala
88527faff8 feat(tools): Added Windows shells support + refactoring 2024-09-05 10:13:04 +02:00
Ivan Grokhotkov
0773caf283 Merge branch 'feature/idf_py_efuse_qemu' into 'master'
feat(idf.py): support efuse-related commands in QEMU

Closes QEMU-193

See merge request espressif/esp-idf!29809
2024-08-21 16:13:54 +08:00
Linda
4fc4f7053b docs: update application examples for build_system 2024-08-16 17:59:11 +08:00
Ivan Grokhotkov
7b228ce8ab feat(idf.py): allow running idf.py efuse-* commands with QEMU 2024-08-15 16:57:08 +02:00
shenmengjing
df8009fb95 docs: Consistent naming convention in CN translation 2024-07-24 17:20:30 +08:00
Frantisek Hrbata
b88eb1c1e5 docs: move and update idf.py size sub-commands documentation
The documentation for the IDF Size tool has been relocated from the
performance section to the tools section and updated to reflect the
current refactored version of esp-idf-size.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2024-06-27 13:22:29 +02:00
shenmengjing
5a2836c6bb docs: Edit the CN Translation for idf-py 2024-05-15 15:28:24 +08:00
shenmengjing
60cd5933d6 docs: Edit the CN Translation and EN Source 2024-05-10 15:30:16 +08:00
shenmengjing
a89e354f9d docs: Update the CN Translation for idf-py and spiffs 2024-05-08 17:15:06 +08:00
shenmengjing
4e0c5d3e8e docs: Provide translation for ecdsa.rst and qemu.rst 2024-04-18 14:58:39 +08:00
Frantisek Hrbata
6554cac7dc docs(docker): add note about group ID when host device is added to container
Closes https://github.com/espressif/esp-idf/issues/13373

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2024-03-20 11:15:36 +01:00
daiziyan
bd811d6682 docs: add CN translation for idf-monitor 2024-01-31 09:35:44 +01:00
Harshit Malpani
18947904bc docs: Add documentation for idf.py read-otadata 2024-01-12 18:58:14 +05:30
Shang Zhou
c1e3440352 docs: Update CN translation for idf-py.rst and linux-macos-setup.rst 2023-12-15 11:50:38 +00:00
daiziyan
17dfe49416 docs: provide CN trans for idf-monitor 2023-12-07 10:06:36 +01:00
daiziyan
e85feafa0f docs: add CN trans for idf-docker-image.rst 2023-12-05 14:52:14 +01:00
Ivan Grokhotkov
71153c7dbb feat(tools): add 'idf.py qemu' extension
This extension allows running programs in QEMU similar to running
them on a real chip:

- 'idf.py qemu' — builds and runs the program in QEMU. User gets
  a QEMU instance launched, and can work with it as a normal QEMU
  instance.
- 'idf.py qemu monitor' — same, but QEMU is launched in the
  background, and idf_monitor runs in the foreground, showing QEMU
  output. Compared to only running 'idf.py qemu' this enables, for
  example, automatic backtrace decoding.
- 'idf.py qemu gdb' — launches QEMU in the background and opens an
  interactive GDB prompt, connecting it to QEMU.
- 'idf.py qemu --gdb monitor' and 'idf.py gdb' in another shell:
  launches QEMU in the background, keeps it suspended until GDB is
  connected, and opens idf_monitor. GDB can be used in another shell
  to debug the application.
2023-12-03 07:45:19 +01:00
mofeifei
43bfffd85e docs: update cn trans idf-docker-image 2023-11-30 12:18:40 +01:00
Shang Zhou
a0edece25a docs: Update CN translation for api-guides/tools/idf-monitor.rst 2023-11-16 09:20:48 +01:00
Roland Dobai
6f50b02a3a fix(tools): Remove idf.py dependencies from documentation
Those dependencies are always satisfied because:
- ESP-IDF supports Python 3.8+ at this moment,
- click version is checked and ensured by the install scripts.
2023-11-13 14:33:54 +01:00
radim.karnis
0349f471af docs(idf-clang-tidy): Mention the need for a clang based toolchain
Closes https://github.com/espressif/clang-tidy-runner/issues/32
2023-10-30 11:10:11 +08:00
Peter Dragun
aa9f81cfc6 Merge branch 'feat/monitor-config' into 'master'
docs(tools/idf-monitor): add info about custom keystrokes

See merge request espressif/esp-idf!26129
2023-10-12 16:02:34 +08:00
renpeiying
c744d3d5fd docs: Update Chinese translation for idf-monitor 2023-10-10 12:07:36 +08:00
Anton Maklakov
02802ea20a feat(tools): Add QEMU 8.0.0_20230522 to tools.json
Process wildcards in the install and download lists of idf_tools
    Fix the install and download handlers to get common behaviour
2023-10-10 09:59:38 +07:00
Alexey Lapshin
98199d50d6 change(tools): update gcc toolchain version to 13.2.0
Add Kconfig option to supress new gcc warnings
Update docs with migration guide
2023-10-09 12:13:00 +04:00
Fu Hanxi
4dbe541f80 ci: replace internal clang-tidy runner with the pypi project 2023-09-27 10:25:49 +02:00
Roland Dobai
5f74dd2bb3 Merge branch 'docs/docker_image_flashing' into 'master'
docs(docker): Update Using Remote Serial Port chapter

Closes IDFGH-10856

See merge request espressif/esp-idf!25778
2023-09-07 18:05:48 +08:00
Cai Xin Ying
2fac98d2e0 docs:update format issues for files under api-guides 2023-09-07 15:26:05 +08:00