diff --git a/docs/en/api-guides/tools/idf-clang-tidy.rst b/docs/en/api-guides/tools/idf-clang-tidy.rst index 7d3e7a802d..dab019a6e1 100644 --- a/docs/en/api-guides/tools/idf-clang-tidy.rst +++ b/docs/en/api-guides/tools/idf-clang-tidy.rst @@ -10,6 +10,8 @@ The IDF Clang Tidy is a tool that uses `clang-tidy ` IDF clang-tidy 的功能及其依赖的工具链尚在开发中,最终版本发布前可能有重大变更。 + 目前仅支持基于 clang 的工具链。在配置项目前,必须在环境变量或 CMake 缓存中设置 ``IDF_TOOLCHAIN=clang`` 进行激活。 + .. only:: CONFIG_IDF_TARGET_ARCH_RISCV .. warning::