Skip to content

Commit d7a2830

Browse files
authored
Update README since Gazelle changes were merged
bazel-contrib/bazel-gazelle#1384
1 parent d3afb5d commit d7a2830

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,9 @@ Adding `exclude_external_sources = True` and `exclude_headers = "external"` can
139139

140140
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.
141141

142-
### If you're using Gazelle:
142+
### If you're using Gazelle v0.29 or older:
143143

144-
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.
144+
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.)
145145

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

0 commit comments

Comments
 (0)