about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorLukas Wirth <lukastw97@gmail.com>2024-01-13 17:22:39 +0100
committerLukas Wirth <lukastw97@gmail.com>2024-01-15 09:59:32 +0100
commitc7eb52dd7b2a8222d4a09934bacc1b2b07deafb0 (patch)
tree135da1dad4d8be040af35b89f1d3418fb4e6748b /docs
parent9d8889cdfcc3aa0302353fc988ed21ff9bc9925c (diff)
internal: Add unstable config for loading the sysroot sources via `cargo metadata`
Diffstat (limited to 'docs')
-rw-r--r--docs/user/generated_config.adoc10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc
index ecc90abff13..1a2791954e6 100644
--- a/docs/user/generated_config.adoc
+++ b/docs/user/generated_config.adoc
@@ -121,6 +121,16 @@ Unsetting this disables sysroot loading.
 
 This option does not take effect until rust-analyzer is restarted.
 --
+[[rust-analyzer.cargo.sysrootQueryMetadata]]rust-analyzer.cargo.sysrootQueryMetadata (default: `false`)::
++
+--
+Whether to run cargo metadata on the sysroot library allowing rust-analyzer to analyze
+third-party dependencies of the standard libraries.
+
+This will cause `cargo` to create a lockfile in your sysroot directory. rust-analyzer
+will attempt to clean up afterwards, but nevertheless requires the location to be
+writable to.
+--
 [[rust-analyzer.cargo.sysrootSrc]]rust-analyzer.cargo.sysrootSrc (default: `null`)::
 +
 --