blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-09 09:09:10 -04:00
Code Issues Projects Releases Wiki Activity

fix(hints): improve suggestion for missing header file

Browse Source 
Currently, we are only suggesting that the header file is likely not
part of the component's INCLUDE_DIRS. However, the header file may be
missing also because of the configuration settings. For instance, the
component might be disabled in sdkconfig, or the feature that supplies
the header might not be enabled. Enhance the hint message to address
this scenario as well.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
This commit is contained in:
Frantisek Hrbata 2024-12-17 10:56:26 +01:00
parent 04429da460
commit 0c2843a071
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
tools/idf_py_actions/hint_modules/component_requirements.py
View File

@ -144,7 +144,9 @@ def generate_hint(output: str) -> Optional[str]:
candidates = ', '.join(candidate_component_include_dirs)
return (f'Missing "{missing_header}" file name found in the following component(s): {candidates}. '
f'Maybe one of the components needs to add the missing header directory to INCLUDE_DIRS '
f'of idf_component_register call in CMakeLists.txt.')
f'of idf_component_register call in CMakeLists.txt. Another possibility may be that the '
f'component or its feature is not enabled in the configuration. Use "idf.py menuconfig" '
f'to check if the required options are enabled.')
# The missing header not found anywhere, nothing much we can do here.
return None