error: machine/endian.h file not found while running clang-tidy against hello-world example (IDFGH-10703)
#36
Comments
github-actions
bot
changed the title
machine/endian.h file not found while running clang-tidy against hello-world examplemachine/endian.h file not found while running clang-tidy against hello-world example (IDFGH-10703)
|
This error indicates that system-provided clang-tidy is being used, not the one which comes with esp-clang. Could you please try this without installing clang-tidy from apt, and use The following works in one of our CI workflows: (you can omit the SARIF related parts) |
|
Thanks for the fast answer. It was very helpful. SolutionI was able to make my example work. There was 2 error:
Following is the diff to make the script work: # Prerequisites
apt update && apt install -y clang-tidy
pip install -U pyclang
idf_tools.py install esp-clang
+ . ${IDF_PATH}/export.sh
# Change path to the hello world example project
cd /opt/esp/idf/examples/get-started/hello_world/
# Initialize the project
- idf.py set-target esp32
+ IDF_TOOLCHAIN=clang idf.py set-target esp32
# Run clang-tidy (find an error)
- idf.py clang-check --run-clang-tidy-py=/usr/lib/llvm-10/share/clang/run-clang-tidy.py
+ IDF_TOOLCHAIN=clang idf.py clang-check --run-clang-tidy-py=run-clang-tidy
# Run build (work fine)
idf.py buildPossible improvementsHere is a short list of possible actions to avoid others to run into this issue:
|
|
Thanks for the feedback and suggestions. I think we keep the documentation as is for now but we might improve it in the near future. |
espressif-bot
added
Status: Done
Resolution: Won't Do
and removed
Status: Opened
labels
While using esp-idf release/v5.1 and it's hello-world example project, running
idf.py clang-checkon it returns the following error.stdout
warning.txt
clang-tidydid not found librarymachine/endian.h. Looking at similar github issue IDFGH-5084 it seems thatWhile looking for a solution I found that using master branch version of
pyclangandrun-clang-tidy.pydid not fix the issue and is also present in idf release/v5.0How to reproduce
For better repeatability I used
espressif/idf:release-v5.1docker image. You can run it iteractively with the following commanddocker run -it --rm espressif/idf:release-v5.1 bash. Once inside the docker container run the following commands:The text was updated successfully, but these errors were encountered: