Skip to content

Commit

Permalink
Update README since Gazelle changes were merged
Browse files Browse the repository at this point in the history
  • Loading branch information
cpsauer authored Feb 14, 2023
1 parent d3afb5d commit d7a2830
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,9 @@ 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:
### If you're using Gazelle v0.29 or older:

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.
Please upgrade or add `# gazelle:exclude external` to the BUILD file in your workspace root. Gazelle had some problematic symlink handling in those versions that we fixed for them with a PR. (Conversely, if, at the time you're reading this, Gazelle v0.29 (January 2023) is so old that few would be using it, please file a quick PR to remove this section.)

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

Expand Down

0 comments on commit d7a2830

Please sign in to comment.