Skip to content
This repository was archived by the owner on Dec 29, 2022. It is now read-only.

Commit a7d2f3c

Browse files
authored
Merge pull request #689 from joaodelgado/incorrect-defaults-docs
Update documentation on defaults and `unstable_features`
2 parents 4beff21 + 74c5e6f commit a7d2f3c

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,22 +98,20 @@ Currently we accept the following options:
9898
`build_bin`.
9999
* `build_bin` (`String`, defaults to `""`) checks the project as if you passed
100100
`-- bin <build_bin>` argument to cargo. Mutually exclusive with `build_lib`.
101-
* `cfg_test` (`bool`, defaults to `true`) checks the project as if you were
101+
* `cfg_test` (`bool`, defaults to `false`) checks the project as if you were
102102
running `cargo test` rather than `cargo build`. I.e., compiles (but does not
103103
run) test code.
104104
* `unstable_features` (`bool`, defaults to `false`) enables unstable features.
105-
Currently, this includes range formatting and `workspace_mode`,
106-
`analyze_package` options.
105+
Currently no option requires this flag.
107106
* `sysroot` (`String`, defaults to `""`) if the given string is not empty, use
108107
the given path as the sysroot for all rustc invocations instead of trying to
109108
detect the sysroot automatically
110109
* `target` (`String`, defaults to `""`) if the given string is not empty, use
111110
the given target triple for all rustc invocations
112111
* `wait_to_build` (`u64`, defaults to `500`) time in milliseconds between
113112
receiving a change notification and starting build
114-
* `workspace_mode` (`bool`, defaults to `false`) Experimental mode, requires
115-
`unstable_features` turned on. When turned on, RLS will try to scan current
116-
workspace and analyze every package in it.
113+
* `workspace_mode` (`bool`, defaults to `true`) When turned on, RLS will try
114+
to scan current workspace and analyze every package in it.
117115
* `analyze_package` (`String`, defaults to `""`) When `workspace_mode` is
118116
enabled, analysis will be only provided for the specified package (runs as
119117
if `-p <analyze_package>` was passed).

0 commit comments

Comments
 (0)