about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorbors[bot] <26634292+bors[bot]@users.noreply.github.com>2020-08-25 17:42:27 +0000
committerGitHub <noreply@github.com>2020-08-25 17:42:27 +0000
commitf647edcb080f50e01762a31eebd9ca94c982c768 (patch)
tree9ca14279d566ffa30e779a3178760d17962b624e /docs
parent91bedefe491af3bf4eeb13bc7716cc419cafe067 (diff)
parent189521a4db6e51e954f118367e07bb1cc6d2f40d (diff)
downloadrust-f647edcb080f50e01762a31eebd9ca94c982c768.tar.gz
rust-f647edcb080f50e01762a31eebd9ca94c982c768.zip
Merge #5884
5884: Add sysroot shortcut to rust-project.json
 r=matklad a=matklad

bors r+
🤖

Co-authored-by: Aleksey Kladov <aleksey.kladov@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/user/manual.adoc16
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc
index bebcee02322..144130b51b3 100644
--- a/docs/user/manual.adoc
+++ b/docs/user/manual.adoc
@@ -273,9 +273,19 @@ However, if you use some other build system, you'll have to describe the structu
 [source,TypeScript]
 ----
 interface JsonProject {
-   /// The set of crates comprising the current project.
-   /// Must include all transitive dependencies as well as sysroot crate (libstd, libcore and such).
-   crates: Crate[];
+    /// Path to the directory with *source code* of sysroot crates.
+    ///
+    /// It should point to the directory where std, core, and friends can be found:
+    /// https://github.com/rust-lang/rust/tree/master/library.
+    ///
+    /// If provided, rust-analyzer automatically adds dependencies on sysroot
+    /// crates. Conversely, if you omit this path, you can specify sysroot
+    /// dependencies yourself and, for example, have several different "sysroots" in
+    /// one graph of crates.
+    sysroot_src?: string;
+    /// The set of crates comprising the current project.
+    /// Must include all transitive dependencies as well as sysroot crate (libstd, libcore and such).
+    crates: Crate[];
 }
 
 interface Crate {