about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorVictor Song <vms2@rice.edu>2023-09-29 03:49:37 -0500
committerVictor Song <vms2@rice.edu>2023-10-09 02:15:05 -0500
commitaeef7b644b135c80c2fc7a28954d97194df7fabc (patch)
tree79d2733bd93d1b37e92d6cb26d5a16f1dd848757 /docs
parent7e9b25bff75a24bd85521ca54fa9d01edd35ad1d (diff)
downloadrust-aeef7b644b135c80c2fc7a28954d97194df7fabc.tar.gz
rust-aeef7b644b135c80c2fc7a28954d97194df7fabc.zip
Add config option to use `rust-analyzer` specific target dir
Adds a Rust Analyzer configuration option to set a custom
target directory for builds. This is a workaround for Rust Analyzer
blocking debug builds while running `cargo check`. This change
should close #6007
Diffstat (limited to 'docs')
-rw-r--r--docs/user/generated_config.adoc9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc
index dec7a507574..f7ae6afe386 100644
--- a/docs/user/generated_config.adoc
+++ b/docs/user/generated_config.adoc
@@ -757,6 +757,15 @@ Command to be executed instead of 'cargo' for runnables.
 Additional arguments to be passed to cargo for runnables such as
 tests or binaries. For example, it may be `--release`.
 --
+[[rust-analyzer.rust.analyzerTargetDir]]rust-analyzer.rust.analyzerTargetDir (default: `null`)::
++
+--
+Optional path to a rust-analyzer specific target directory.
+This is useful to prevent rust-analyzer's `cargo check` from blocking builds.
+
+Set to `true` to use a subdirectory of the existing target directory or
+set to a path to use that path.
+--
 [[rust-analyzer.rustc.source]]rust-analyzer.rustc.source (default: `null`)::
 +
 --