espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-09 15:44:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: hints are supported for gdbui and openocd

Browse Source 
Hints should be now working for gdbui and openocd. They are not
produced via RunTool(), but the hints are used directly.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
This commit is contained in:
Frantisek Hrbata
2023-02-01 15:41:30 +01:00
parent dc580bdc97
commit 4b5e56e08c
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-guides/tools/idf-py.rst
View File

@@ -146,7 +146,7 @@ or partition table as applicable.
Hints on how to resolve errors Hints on how to resolve errors
============================== ==============================
``idf.py`` will try to suggest hints on how to resolve errors. It works with a database of hints stored in :idf_file:`tools/idf_py_actions/hints.yml` and the hints will be printed if a match is found for the given error. The monitor, menuconfig, gdb and openocd targets are not supported at the moment by automatic hints on resolving errors. ``idf.py`` will try to suggest hints on how to resolve errors. It works with a database of hints stored in :idf_file:`tools/idf_py_actions/hints.yml` and the hints will be printed if a match is found for the given error. The monitor and menuconfig targets are not supported at the moment by automatic hints on resolving errors.
The ``--no-hints`` argument of ``idf.py`` can be used to turn the hints off in case they are not desired. The ``--no-hints`` argument of ``idf.py`` can be used to turn the hints off in case they are not desired.