diff options
| author | Wilfred Hughes <wilfred@meta.com> | 2023-06-08 14:56:37 -0700 |
|---|---|---|
| committer | Wilfred Hughes <wilfred@meta.com> | 2023-06-08 14:56:37 -0700 |
| commit | 5da14237eb2994a73e8864cf88359bc2308d4864 (patch) | |
| tree | 3d0aee8dd68f3e128ec912cee0718d63e8ce23ba | |
| parent | 9c03aa1ac2e67051db83a85baf3cfee902e4dd84 (diff) | |
| download | rust-5da14237eb2994a73e8864cf88359bc2308d4864.tar.gz rust-5da14237eb2994a73e8864cf88359bc2308d4864.zip | |
Document the sysroot field in JsonProject
rust-analyzer supports both `sysroot` and `sysroot_src` in `rust-project.json`. Document `sysroot` and show example values for both fields.
| -rw-r--r-- | docs/user/manual.adoc | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index 5b9db10b093..98d99bae92a 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc @@ -653,9 +653,28 @@ However, if you use some other build system, you'll have to describe the structu [source,TypeScript] ---- interface JsonProject { + /// Path to the sysroot directory. + /// + /// The sysroot is where rustc looks for the + /// crates that are built-in to rust, such as + /// std. + /// + /// https://doc.rust-lang.org/rustc/command-line-arguments.html#--sysroot-override-the-system-root + /// + /// To see the current value of sysroot, you + /// can query rustc: + /// + /// ``` + /// $ rustc --print sysroot + /// /Users/yourname/.rustup/toolchains/stable-x86_64-apple-darwin + /// ``` + sysroot?: string; /// Path to the directory with *source code* of /// sysroot crates. /// + /// By default, this is `lib/rustlib/src/rust/library` + /// relative to the sysroot. + /// /// It should point to the directory where std, /// core, and friends can be found: /// |
