diff options
author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2020-08-25 18:42:27 +0100 |
---|---|---|
committer | GitHub <[email protected]> | 2020-08-25 18:42:27 +0100 |
commit | f647edcb080f50e01762a31eebd9ca94c982c768 (patch) | |
tree | 9ca14279d566ffa30e779a3178760d17962b624e /docs | |
parent | 91bedefe491af3bf4eeb13bc7716cc419cafe067 (diff) | |
parent | 189521a4db6e51e954f118367e07bb1cc6d2f40d (diff) |
Merge #5884
5884: Add sysroot shortcut to rust-project.json
r=matklad a=matklad
bors r+
🤖
Co-authored-by: Aleksey Kladov <[email protected]>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/user/manual.adoc | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index bebcee023..144130b51 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 | |||
273 | [source,TypeScript] | 273 | [source,TypeScript] |
274 | ---- | 274 | ---- |
275 | interface JsonProject { | 275 | interface JsonProject { |
276 | /// The set of crates comprising the current project. | 276 | /// Path to the directory with *source code* of sysroot crates. |
277 | /// Must include all transitive dependencies as well as sysroot crate (libstd, libcore and such). | 277 | /// |
278 | crates: Crate[]; | 278 | /// It should point to the directory where std, core, and friends can be found: |
279 | /// https://github.com/rust-lang/rust/tree/master/library. | ||
280 | /// | ||
281 | /// If provided, rust-analyzer automatically adds dependencies on sysroot | ||
282 | /// crates. Conversely, if you omit this path, you can specify sysroot | ||
283 | /// dependencies yourself and, for example, have several different "sysroots" in | ||
284 | /// one graph of crates. | ||
285 | sysroot_src?: string; | ||
286 | /// The set of crates comprising the current project. | ||
287 | /// Must include all transitive dependencies as well as sysroot crate (libstd, libcore and such). | ||
288 | crates: Crate[]; | ||
279 | } | 289 | } |
280 | 290 | ||
281 | interface Crate { | 291 | interface Crate { |