about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorDamien Elmes <gpg@ankiweb.net>2021-07-19 23:09:29 +1000
committerDamien Elmes <gpg@ankiweb.net>2021-07-19 23:30:00 +1000
commit106ea7ad85de375304bd4205bd7fe62864b7fe46 (patch)
tree7015c74d7a499dfc0bb0a86501209a72b1daf607 /docs
parent64bf67c5aa096eb6a059d6bb8304981ecb90318e (diff)
downloadrust-106ea7ad85de375304bd4205bd7fe62864b7fe46.tar.gz
rust-106ea7ad85de375304bd4205bd7fe62864b7fe46.zip
minor update to excludeDirs doc
I saw reference to globs in #7755, but it doesn't look like they're
actually supported, and I had to dig through the source to discover
that the folders are relative to the workspace root. Further digging
was required to get VS Code from hanging for long periods trying to
watch giant Bazel folders that had already been excluded from Rust
Analyzer. Hopefully this tweak will save others the confusion :-)
Diffstat (limited to 'docs')
-rw-r--r--docs/user/generated_config.adoc4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc
index 86d147ee8bc..35342a81097 100644
--- a/docs/user/generated_config.adoc
+++ b/docs/user/generated_config.adoc
@@ -204,7 +204,9 @@ Controls file watching implementation.
 [[rust-analyzer.files.excludeDirs]]rust-analyzer.files.excludeDirs (default: `[]`)::
 +
 --
-These directories will be ignored by rust-analyzer.
+These directories will be ignored by rust-analyzer. They are
+relative to the workspace root, and globs are not supported. You may
+also need to add the folders to Code's 'watcher exclude'.
 --
 [[rust-analyzer.highlighting.strings]]rust-analyzer.highlighting.strings (default: `true`)::
 +