From 182230a0ba865e860ccee978e8c071ab87feb1b7 Mon Sep 17 00:00:00 2001 From: Alvaro Gaona Date: Wed, 16 Oct 2024 02:45:26 -0300 Subject: [PATCH] Fix C++ configuration documentation (#19258) - Update the binary JSON object - Add .clangd configuration file summary ![image](https://github.com/user-attachments/assets/5c4cfd26-3cd8-4d12-96fc-483596c74287) Release Notes: - N/A --- docs/src/languages/cpp.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/docs/src/languages/cpp.md b/docs/src/languages/cpp.md index 8ba2be78e1..127330dd94 100644 --- a/docs/src/languages/cpp.md +++ b/docs/src/languages/cpp.md @@ -17,9 +17,38 @@ To use a binary in a custom location, add the following to your `settings.json`: "clangd": { "binary": { "path": "/path/to/clangd", - "args": [] + "arguments": [] } } } } ``` + +If you want to disable Zed looking for a `clangd` binary, you can set `ignore_system-version` to `true`: + +```json +{ + "lsp": { + "clangd": { + "binary": { + "ignore_system_version": true + } + } + } +} +``` + +## More server configuration + +In the root of your project, it is generally common to create a `.clangd` file to set extra configuration. + +```text +CompileFlags: + Add: + - "--include-directory=/path/to/include" +Diagnostics: + MissingIncludes: Strict + UnusedIncludes: Strict +``` + +For more advanced usage of clangd configuration file, take a look into their [official page](https://clangd.llvm.org/config.html).