Skip to content

Commit

Permalink
Add gazelle workaround note
Browse files Browse the repository at this point in the history
  • Loading branch information
cpsauer committed Nov 30, 2022
1 parent 288db03 commit f4546f1
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,10 @@ Adding `exclude_external_sources = True` and `exclude_headers = "external"` can

For now, we'd suggest continuing on to set up `clangd` (below). Thereafter, if you your project proves to be large enough that it stretches the capacity of `clangd` and/or this tool to index quickly, take a look at the docs at the top of [`refresh_compile_commands.bzl`](./refresh_compile_commands.bzl) for instructions on how to tune those flags and others.

### If you're using Gazelle:

Please add `# gazelle:exclude external` to the BUILD file in your workspace root--just until https://github.com/bazelbuild/bazel-gazelle/pull/1384 is resolved. They have an issue we fixed for them; follow (and 👍) [that PR](https://github.com/bazelbuild/bazel-gazelle/pull/1384), so you know when you can remove this workaround.

## Editor Setup — for autocomplete based on `compile_commands.json`


Expand Down

0 comments on commit f4546f1

Please sign in to comment.