Explorar o código

docs(idf-clang-tidy): Mention the need for a clang based toolchain

Closes https://github.com/espressif/clang-tidy-runner/issues/32
radim.karnis %!s(int64=2) %!d(string=hai) anos
pai
achega
0349f471af

+ 2 - 0
docs/en/api-guides/tools/idf-clang-tidy.rst

@@ -10,6 +10,8 @@ The IDF Clang Tidy is a tool that uses `clang-tidy <https://clang.llvm.org/extra
 
    This functionality and the toolchain it relies on are still under development. There may be breaking changes before a final release.
 
+   Only clang based toolchain is currently supported. It has to be activated by setting ``IDF_TOOLCHAIN=clang`` in the environment or in CMake cache before configuring the project.
+
 .. only:: CONFIG_IDF_TARGET_ARCH_RISCV
 
    .. warning::

+ 2 - 0
docs/zh_CN/api-guides/tools/idf-clang-tidy.rst

@@ -10,6 +10,8 @@ IDF clang-tidy 是使用 `clang-tidy <https://clang.llvm.org/extra/clang-tidy/>`
 
    IDF clang-tidy 的功能及其依赖的工具链尚在开发中,最终版本发布前可能有重大变更。
 
+   目前仅支持基于 clang 的工具链。在配置项目前,必须在环境变量或 CMake 缓存中设置 ``IDF_TOOLCHAIN=clang`` 进行激活。
+
 .. only:: CONFIG_IDF_TARGET_ARCH_RISCV
 
    .. warning::