Skip to content

Add BuiltinHeaders to config docs #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 9, 2025
Merged

Add BuiltinHeaders to config docs #124

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4e991b4
Add BuiltinHeaders to config docs
kammce Mar 2, 2025
5a305ad
Add CSS for v21 & note to config key
kammce Mar 8, 2025
a50e677
Fix CSS syntax
HighCommander4 Mar 9, 2025
bff76bf
Clarify cautionary note about `BuiltinHeader: QueryDriver`
HighCommander4 Mar 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,23 @@ flag parsing (clang vs clang-cl), target inference (gcc-arm-noneabi) etc.
If the option matches a glob mentioned in `--query-driver`, then it'll be
invoked for extraction of include paths.

### BuiltinHeaders
{:.v21}

Controls whether Clangd should includes its own built-in headers (like stddef.h), or use the system header found from the query driver.

Valid values are:
- `Clangd`: Use builtin headers from `clangd`.
- `QueryDriver`: Use the headers extracted from the compiler via the
`--query-driver` command line argument. If a query driver is not supplied or
does not match the compiler, then the `Clangd` builtin headers will be the
fallback.

```yaml
CompileFlags:
BuiltinHeaders: QueryDriver
```

## Index

Controls how clangd understands code outside the current file.
Expand Down