From 0ce591d33db5976f97ecd2541f0d6704cdb35550 Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Tue, 20 Apr 2021 10:44:06 +0300 Subject: [PATCH] minor: fix ugly line wrapping in the rendered manual --- docs/user/manual.adoc | 74 ++++++++++++++++++++++++++++--------------- 1 file changed, 48 insertions(+), 26 deletions(-) diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index b86e9177232..54195adb74c 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc @@ -429,24 +429,32 @@ However, if you use some other build system, you'll have to describe the structu [source,TypeScript] ---- interface JsonProject { - /// Path to the directory with *source code* of sysroot crates. + /// Path to the directory with *source code* of + /// sysroot crates. + /// + /// It should point to the directory where std, + /// core, and friends can be found: /// - /// 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. + /// 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). + /// 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 { - /// Optional crate name used for display purposes, without affecting semantics. - /// See the `deps` key for semantically-significant crate names. + /// Optional crate name used for display purposes, + /// without affecting semantics. See the `deps` + /// key for semantically-significant crate names. display_name?: string; /// Path to the root module of the crate. root_module: string; @@ -454,45 +462,59 @@ interface Crate { edition: "2015" | "2018" | "2021"; /// Dependencies deps: Dep[]; - /// Should this crate be treated as a member of current "workspace". + /// Should this crate be treated as a member of + /// current "workspace". /// - /// By default, inferred from the `root_module` (members are the crates which reside - /// inside the directory opened in the editor). + /// By default, inferred from the `root_module` + /// (members are the crates which reside inside + /// the directory opened in the editor). /// - /// Set this to `false` for things like standard library and 3rd party crates to - /// enable performance optimizations (rust-analyzer assumes that non-member crates - /// don't change). + /// Set this to `false` for things like standard + /// library and 3rd party crates to enable + /// performance optimizations (rust-analyzer + /// assumes that non-member crates don't change). is_workspace_member?: boolean; - /// Optionally specify the (super)set of `.rs` files comprising this crate. + /// Optionally specify the (super)set of `.rs` + /// files comprising this crate. /// - /// By default, rust-analyzer assumes that only files under `root_module.parent` can belong to a crate. - /// `include_dirs` are included recursively, unless a subdirectory is in `exclude_dirs`. + /// By default, rust-analyzer assumes that only + /// files under `root_module.parent` can belong + /// to a crate. `include_dirs` are included + /// recursively, unless a subdirectory is in + /// `exclude_dirs`. /// /// Different crates can share the same `source`. /// - /// If two crates share an `.rs` file in common, they *must* have the same `source`. - /// rust-analyzer assumes that files from one source can't refer to files in another source. + /// If two crates share an `.rs` file in common, + /// they *must* have the same `source`. + /// rust-analyzer assumes that files from one + /// source can't refer to files in another source. source?: { include_dirs: string[], exclude_dirs: string[], }, - /// The set of cfgs activated for a given crate, like `["unix", "feature=\"foo\"", "feature=\"bar\""]`. + /// The set of cfgs activated for a given crate, like + /// `["unix", "feature=\"foo\"", "feature=\"bar\""]`. cfg: string[]; /// Target triple for this Crate. /// - /// Used when running `rustc --print cfg` to get target-specific cfgs. + /// Used when running `rustc --print cfg` + /// to get target-specific cfgs. target?: string; - /// Environment variables, used for the `env!` macro + /// Environment variables, used for + /// the `env!` macro env: : { [key: string]: string; }, - /// For proc-macro crates, path to compiles proc-macro (.so file). + /// For proc-macro crates, path to compiled + /// proc-macro (.so file). proc_macro_dylib_path?: string; } interface Dep { /// Index of a crate in the `crates` array. crate: number, - /// Name as should appear in the (implicit) `extern crate name` declaration. + /// Name as should appear in the (implicit) + /// `extern crate name` declaration. name: string, } ----