Skip to content

Commit 72bea7b

Browse files
authored
Merge pull request #2230 from LeSeulArtichaut/discourage-complete
Change README.md to discourage the use of `complete`
2 parents 2291721 + 5e00aaa commit 72bea7b

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,12 @@ default (`rustc`, `rust-std`, `cargo`, and `rust-docs`) plus `rustfmt` and
7878
`clippy`. This profile will be used by `rustup` by default, and it's the one
7979
recommended for general use.
8080
* The **complete** profile includes all the components available through
81-
`rustup`, including `miri` and IDE integration tools (`rls` and `rust-analysis`).
81+
`rustup`. This should never be used, as it includes *every* component ever included
82+
in the metadata and thus will almost always fail. If you are looking for a way
83+
to install devtools such as `miri` or IDE integration tools (`rls`, `rust-analysis`),
84+
you should use the `default` profile and install the needed additional components
85+
manually, either by using `rustup component add` or by using `-c` when installing
86+
the toolchain.
8287

8388
To change the `rustup` profile you can use the `rustup set profile` command. For
8489
example, to select the minimal profile you can use:

0 commit comments

Comments
 (0)