Skip to content

Conversation

@Shen7436
Copy link
Collaborator

This PR:

  • Adjusts some format issues and unclear expressions for clangd_cdt_support.rst in the docs/en/additionalfeatures folder based on Espressif Style Guide.
  • Provides CN translation for clangd_cdt_support.rst.
  • TODO: Closes DOC-12880 once merged.

@Shen7436 Shen7436 self-assigned this Nov 25, 2025
@Shen7436 Shen7436 added documentation Improvements or additions to documentation documentation 📝 Solely about the documentation of the project. labels Nov 25, 2025
@coderabbitai
Copy link

coderabbitai bot commented Nov 25, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/translate_clangd_cdt_support

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Shen7436
Copy link
Collaborator Author

Hi @leeebo @April-Yjj PTAL, thx!

Copy link

@leeebo leeebo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Shen7436 LGTM!

@Shen7436 Shen7436 force-pushed the docs/translate_clangd_cdt_support branch from 1f736fd to 2332a36 Compare November 27, 2025 03:50
Copy link

@April-Yjj April-Yjj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Shen7436 Thanks for translation! Overall LGTM


:link_to_translation:`en:[English]`

Espressif-IDE 3.0.0 及更高版本现已内置 `Eclipse CDT-LSP <https://github.com/eclipse-cdt/cdt-lsp/>`_,支持最新的 C/C++ 标准并提供基于 LSP 的 C/C++ 编辑器。该编辑器由 `LLVM <https://clangd.llvm.org/>`_ clangd C/C++ 语言服务器驱动,为 ESP-IDF 开发者提供更强大的功能。

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Espressif-IDE 3.0.0 及更高版本现已内置 `Eclipse CDT-LSP <https://github.com/eclipse-cdt/cdt-lsp/>`_,支持最新的 C/C++ 标准并提供基于 LSP 的 C/C++ 编辑器。该编辑器由 `LLVM <https://clangd.llvm.org/>`_ clangd C/C++ 语言服务器驱动,为 ESP-IDF 开发者提供更强大的功能。
Espressif-IDE 3.0.0 及更高版本现已内置 `Eclipse CDT-LSP <https://github.com/eclipse-cdt/cdt-lsp/>`_,支持最新的 C/C++ 标准并提供基于 LSP 的 C/C++ 编辑器。该编辑器由 `LLVM <https://clangd.llvm.org/>`_ clangd C/C++ 语言服务器提供支持,为 ESP-IDF 开发者提供更强大的功能。


Espressif-IDE 3.0.0 及更高版本现已内置 `Eclipse CDT-LSP <https://github.com/eclipse-cdt/cdt-lsp/>`_,支持最新的 C/C++ 标准并提供基于 LSP 的 C/C++ 编辑器。该编辑器由 `LLVM <https://clangd.llvm.org/>`_ clangd C/C++ 语言服务器驱动,为 ESP-IDF 开发者提供更强大的功能。

为配合本次功能增强,我们已停止支持标准的 CDT 编辑器/索引器,因为其仅支持至 C++ 14。我们用全新的 LSP 编辑器取而代之,尤其考虑到 ESP-IDF 现已在 v5.0.x 中使用 C++ 20(配合 GCC 11.2),在 v5.1 过渡到 C++ 23(配合 GCC 12.1),并在 v5.2 使用 GCC 13.1 的 C++ 23。

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
为配合本次功能增强,我们已停止支持标准的 CDT 编辑器/索引器,因为其仅支持至 C++ 14。我们用全新的 LSP 编辑器取而代之,尤其考虑到 ESP-IDF 现已在 v5.0.x 中使用 C++ 20(配合 GCC 11.2,在 v5.1 过渡到 C++ 23(配合 GCC 12.1,并在 v5.2 使用 GCC 13.1 的 C++ 23。
为配合此功能提升,已停止对标准 CDT 编辑器/索引器的支持,因为其最多支持 C++ 14。此编辑器已由全新的 LSP 编辑器代替,以适应 ESP-IDF 的语言升级:ESP-IDF 现已在 v5.0.x 中使用 C++ 20 (GCC 11.2),在 v5.1 过渡到 C++ 23 (GCC 12.1),并在 v5.2 使用 C++ 23 (GCC 13.1)

In line with this enhancement, we've discontinued support for the standard CDT Editor/Indexer, as it only offers support for up to C++ 14. This has been replaced with a new LSP editor, especially considering that ESP-IDF now utilizes C++ 20 (with GCC 11.2) in v5.0.x, transitions to C++ 23 (with GCC 12.1) in v5.1, and to C++ 23 with GCC 13.1 in v5.2.
The Espressif-IDE 3.0.0 or later now includes the `Eclipse CDT-LSP <https://github.com/eclipse-cdt/cdt-lsp/>`_, enabling support for the latest C/C++ standards and providing an LSP-based C/C++ Editor. This editor, powered by the `LLVM <https://clangd.llvm.org/>`_ clangd C/C++ language server, offers advanced functionality for ESP-IDF developers.

In line with this enhancement, we have discontinued support for the standard CDT Editor/Indexer, as it only supports up to C++ 14. This has been replaced with a new LSP editor, especially considering that ESP-IDF now utilizes C++ 20 (with GCC 11.2) in v5.0.x, transitions to C++ 23 (with GCC 12.1) in v5.1, and to C++ 23 with GCC 13.1 in v5.2.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In line with this enhancement, we have discontinued support for the standard CDT Editor/Indexer, as it only supports up to C++ 14. This has been replaced with a new LSP editor, especially considering that ESP-IDF now utilizes C++ 20 (with GCC 11.2) in v5.0.x, transitions to C++ 23 (with GCC 12.1) in v5.1, and to C++ 23 with GCC 13.1 in v5.2.
In line with this enhancement, we have discontinued support for the standard CDT Editor/Indexer, as it only supports up to C++ 14. This has been replaced with a new LSP editor, especially considering that ESP-IDF now utilizes C++ 20 (with GCC 11.2) in v5.0.x, transitions to C++ 23 (with GCC 12.1) in v5.1, and to C++ 23 (with GCC 13.1) in v5.2.


为配合本次功能增强,我们已停止支持标准的 CDT 编辑器/索引器,因为其仅支持至 C++ 14。我们用全新的 LSP 编辑器取而代之,尤其考虑到 ESP-IDF 现已在 v5.0.x 中使用 C++ 20(配合 GCC 11.2),在 v5.1 过渡到 C++ 23(配合 GCC 12.1),并在 v5.2 使用 GCC 13.1 的 C++ 23。

基于 LSP 的 C/C++ 编辑器与最新的语言标准和编译器版本保持一致,可极大提升 ESP-IDF 开发者的效率并改进代码质量。

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
基于 LSP 的 C/C++ 编辑器与最新的语言标准和编译器版本保持一致,可极大提升 ESP-IDF 开发者的效率并改进代码质量
基于 LSP 的 C/C++ 编辑器与最新的语言标准和编译器版本保持一致,可极大提升 ESP-IDF 的开发效率,改进代码质量


基于 LSP 的 C/C++ 编辑器与最新的语言标准和编译器版本保持一致,可极大提升 ESP-IDF 开发者的效率并改进代码质量。

关于基于 LSP 的 C/C++ 编辑器功能的更多信息,请参阅 `Eclipse CDT-LSP 文档 <https://github.com/eclipse-cdt/cdt-lsp/>`_。

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
关于基于 LSP 的 C/C++ 编辑器功能的更多信息,请参阅 `Eclipse CDT-LSP 文档 <https://github.com/eclipse-cdt/cdt-lsp/>`_。
关于基于 LSP 的 C/C++ 编辑器功能的更多信息,请参阅 `Eclipse cdt-lsp 仓库 <https://github.com/eclipse-cdt/cdt-lsp/>`_ 文档

The LSP powered C/C++ editor greatly benefits ESP-IDF developers by aligning with the latest language standards and compiler versions, enhancing productivity, and improving code quality.

You can find more details on the LSP based C/C++ Editor features in the `Eclipse CDT-LSP documentation <https://github.com/eclipse-cdt/cdt-lsp/>`_.
You can find more details on the LSP based C/C++ editor features in the `Eclipse CDT-LSP documentation <https://github.com/eclipse-cdt/cdt-lsp/>`_.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can find more details on the LSP based C/C++ editor features in the `Eclipse CDT-LSP documentation <https://github.com/eclipse-cdt/cdt-lsp/>`_.
You can find more details on the LSP based C/C++ editor features in the `Eclipse CDT-LSP repo <https://github.com/eclipse-cdt/cdt-lsp/>`_ documents.


.. image:: ../../../media/clangd/clangd_config.png

创建新项目时,会默认生成一个 ``.clangd`` 配置文件,并带有如下参数。

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

如下参数指的是哪里?没找到

Please follow the steps below to fix it:

1. Download the script for `fix_compile_commands.py <https://github.com/espressif/idf-eclipse-plugin/tree/master/resources/fix_compile_commands/fix_compile_commands.py>`_.
1. Download the script for `fix_compile_commands.py <https://github.com/espressif/idf-eclipse-plugin/tree/master/resources/fix_compile_commands/fix_compile_commands.py>`_.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra “for” here?

Suggested change
1. Download the script for `fix_compile_commands.py <https://github.com/espressif/idf-eclipse-plugin/tree/master/resources/fix_compile_commands/fix_compile_commands.py>`_.
1. Download the script `fix_compile_commands.py <https://github.com/espressif/idf-eclipse-plugin/tree/master/resources/fix_compile_commands/fix_compile_commands.py>`_.

请按以下步骤修复:

1. 下载脚本 `fix_compile_commands.py <https://github.com/espressif/idf-eclipse-plugin/tree/master/resources/fix_compile_commands/fix_compile_commands.py>`_。

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why extra space between number and the text?

Suggested change
1. 下载脚本 `fix_compile_commands.py <https://github.com/espressif/idf-eclipse-plugin/tree/master/resources/fix_compile_commands/fix_compile_commands.py>`_。
1. 下载脚本 `fix_compile_commands.py <https://github.com/espressif/idf-eclipse-plugin/tree/master/resources/fix_compile_commands/fix_compile_commands.py>`_。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation documentation 📝 Solely about the documentation of the project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants