renpeiying
f5a28000fa
docs: Update CN for idf-monitor.rst
2025-05-12 22:07:50 +08:00
Peter Dragun
9859f5e690
docs(tools/idf-monitor): Add note about autocoloring limitation on multiline logs
...
Closes https://github.com/espressif/esp-idf/issues/15793
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
Peter Dragun
6061a98b33
docs(tools/idf-monitor): add note about CH9102 USB-to-UART bridge issue on Windows
...
Closes https://github.com/espressif/esp-idf-monitor/issues/26
2025-04-02 08:56:57 +02: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
e61653e68e
Merge branch 'contrib/github_pr_14966' into 'master'
...
Tools: Fix a typo in the QEMU documentation (GitHub PR)
Closes IDFGH-14164
See merge request espressif/esp-idf!35355
2024-12-03 02:18:48 +08:00
Jan Tomka
0b67e76715
docs(tools): Fix a typo in the QEMU documentation
2024-12-02 21:48:19 +11: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
Marek Fiala
cad15b50c4
feat(tools): Inform user about IDF_PATH set/change in install/export scripts
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
Marek Fiala
d7d8828824
docs(tools): Mention idf_version.txt and ESP_IDF_VERSION in documentation
2024-11-11 16:08:47 +01:00
renpeiying
53b57e21fb
docs: Update CN translation for qemu.rst
2024-10-21 18:48:02 +08:00
Aditya Patwardhan
a58a07ecfe
feat(tools): Added option to specify flash image in "idf.py qemu"
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
1e94096e16
docs: update qemu guide for efuse commands
...
- add mention of qemu guide in security related chapters
- also added a note about secure boot v2 config in qemu workflow
2024-09-27 13:36:15 +05:30
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
Daniel Paul
658b1de02c
docs: Consistent naming convention for ESP Component Registry
2024-07-23 14:10:34 +08:00
Mahavir Jain
3dc80527ab
feat: add compiler config for not merging const sections
...
Probably GCC-13.x and on-wards uses "-fmerge-constants" to merge
the const section (string/floating-point) across compilation units.
This makes it difficult to properly analyze the size output of rodata
section across libraries, the merged section (big in size) is showed
across a single library.
The config option added here can help to disable this compiler behavior
and help to provide better size analysis. It can be used during
development phase only as it increases rodata section size.
2024-07-15 10:04:55 +05:30
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
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
Roland Dobai
af302c0bee
Merge branch 'feat/add_merged_bin_cmd' into 'master'
...
feat(tools): Add idf.py merge-bin command and cmake target
See merge request espressif/esp-idf!29996
2024-04-22 17:55:36 +08:00
shenmengjing
4e0c5d3e8e
docs: Provide translation for ecdsa.rst and qemu.rst
2024-04-18 14:58:39 +08:00
Jan Beran
0dec6fe65d
feat(tools): Add idf.py merge-bin command and cmake target
2024-04-16 12:49:18 +02:00
Roland Dobai
54fd736bcd
Merge branch 'docs/external_flash' into 'master'
...
docs(idf_py): Describe the option to configure esptool.py with --extra-args
Closes IDFGH-4513
See merge request espressif/esp-idf!29851
2024-04-07 13:50:05 +08:00
Radim Karniš
cb4b433ddc
docs(idf_py): Describe the option to configure esptool.py with --extra-args
...
Closes https://github.com/espressif/esp-idf/issues/6337
2024-03-28 12:09:50 +01:00
Marius Vikhammer
f1e65b8373
docs(misc): fixed typos found with codespell
2024-03-28 11:50:58 +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
Anton Maklakov
686a0e4f0f
docs(qemu): add system dependencies list
2024-03-07 20:37:24 +08:00
Jan Beran
858e3fe5ec
docs(esp-idf-monitor): Add information about ESP_IDF_MONITOR_NO_RESET
2024-01-31 09:35:44 +01:00
kirill.chalov
22a053f1fc
docs(sphinx-lint): Fix issues reported by sphinx-lint before adding it to pre-commit
2024-01-23 15:22:29 +08:00
Harshit Malpani
18947904bc
docs: Add documentation for idf.py read-otadata
2024-01-12 18:58:14 +05:30
Ivan Grokhotkov
3a340b385f
Merge branch 'feature/qemu_lcd' into 'master'
...
feat(qemu): add a CLI option for graphics output
See merge request espressif/esp-idf!27874
2023-12-19 20:07:29 +08:00
Ivan Grokhotkov
d9983c0039
feat(qemu): add a CLI option for graphics output
2023-12-18 11:47:15 +01:00
Shang Zhou
c1e3440352
docs: Update CN translation for idf-py.rst and linux-macos-setup.rst
2023-12-15 11:50:38 +00:00
