esp-idf/docs/en/api-guides/tools/index.rst

Tools
*****

.. toctree::
   :maxdepth: 1

   idf-py
   idf-monitor
   idf-docker-image
   idf-windows-installer
   idf-component-manager
   idf-clang-tidy
   idf-tools
   idf-size
   :esp32 or esp32c3: qemu
docs: add tools section and IDF docker image page 2019-07-17 11:35:28 +02:00			`Tools`
			`*****`

			`.. toctree::`
			`:maxdepth: 1`

docs: Move the documentation about idf.py out from the build system documentation This moves all the documentation relating to using idf.py out of the build system documentation in order to declutter and more logically group the documentation. It is now present in the tools page under IDF Frontend - idf.py. Additionally there has been lots of rewriting and some minor fixes on the way. 2022-04-15 13:03:21 +02:00			`idf-py`
			`idf-monitor`
			`idf-docker-image`
			`idf-windows-installer`
			`idf-component-manager`
			`idf-clang-tidy`
			`idf-tools`
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-12 15:44:24 +02:00			`idf-size`
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-09-18 15:52:27 +02:00			`:esp32 or esp32c3: qemu`