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

docs(idf.py): clarify clang-tidy setup

Browse Source
This commit is contained in:
Anton Maklakov
2022-06-30 13:37:26 +07:00
parent 55dda77b98
commit 0bbfff4382
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-clang-tidy.rst
View File

@@ -27,7 +27,7 @@ If you have never run this tool before, take the following steps to get this too
This toolchain is still under development. After the final release, you don't have to install them manually. This toolchain is still under development. After the final release, you don't have to install them manually.
#. Get file from the `llvm repository <https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/clang-tidy/tool/run-clang-tidy.py>`_ and add the folder of this script to the ``$PATH``. Or you could pass an optional argument ``--run-clang-tidy-py`` later when you call ``idf.py clang-check``. #. Get file from the `llvm repository <https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/clang-tidy/tool/run-clang-tidy.py>`_ and add the folder of this script to the ``$PATH``. Or you could pass an optional argument ``--run-clang-tidy-py`` later when you call ``idf.py clang-check``. Please don't forget to make the script executable.
.. note:: .. note::