docs: improve the clangd documentation inline with 3.0.0 release #935
Conversation
WalkthroughThe functionality in Espressif-IDE 3.0.0 and higher has been significantly enhanced to support the latest C/C++ standards using the Eclipse CDT-LSP. This update introduces a new LSP-based C/C++ Editor powered by clangd, replacing the standard CDT Editor/Indexer to align with newer language standards and compiler versions for ESP-IDF development. Changes
Poem
Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
|
||
| ## Prerequisites | ||
| 1. Install the latest version of [Espressif-IDE](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/Espressif-IDE.md#downloads) | ||
| 2. Install the latest version of Eclipse CDT-LSP and it's dependencies using [Update Site](https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/) | ||
| * You need to have Espressif-IDE 3.0.0 (and higher) to have access to the LSP powered C/C++ editor. |
There was a problem hiding this comment.
Ensure there are no trailing spaces.
- * You need to have Espressif-IDE 3.0.0 (and higher) to have access to the LSP powered C/C++ editor.
+ * You need to have Espressif-IDE 3.0.0 (and higher) to have access to the LSP powered C/C++ editor.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * You need to have Espressif-IDE 3.0.0 (and higher) to have access to the LSP powered C/C++ editor. | |
| * You need to have Espressif-IDE 3.0.0 (and higher) to have access to the LSP powered C/C++ editor. |
| 1. Install the latest version of [Espressif-IDE](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/Espressif-IDE.md#downloads) | ||
| 2. Install the latest version of Eclipse CDT-LSP and it's dependencies using [Update Site](https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/) | ||
| * You need to have Espressif-IDE 3.0.0 (and higher) to have access to the LSP powered C/C++ editor. | ||
| * If you are updating Eclipse CDT or Espressif-IDE via the update site, you need to select the ESP-IDF Eclipse Plugin and its dependencies, as shown below: | ||
|
|
||
|  |
There was a problem hiding this comment.
Add alternate text to the image for accessibility.
- 
+ Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
|  | |
|  |
| Remove: [-fno-tree-switch-conversion, -fstrict-volatile-bitfields] | ||
| CompilationDatabase: build | ||
| Remove: [-m*, -f*] | ||
| ``` |
There was a problem hiding this comment.
Ensure there are no trailing spaces.
- Remove: [-m*, -f*]
+ Remove: [-m*, -f*] Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ``` |
Description
Improve the clangd documentation inline with 3.0.0 release
Fixes # (IEP-XXX)
Type of change
How has this been tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Test Configuration:
Dependent components impacted by this PR:
Checklist
Summary by CodeRabbit