Skip to content

docs: move "rls" and "rust-analysis" to separate section "previous…" #3591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 18, 2023
Merged

docs: move "rls" and "rust-analysis" to separate section "previous…" #3591

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions doc/user-guide/src/concepts/components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,15 @@ toolchains. The following is an overview of the different components:
doc --help` for more options.
* `rust-analyzer` — [rust-analyzer] is a language server that provides support
for editors and IDEs.
* `rls` — [RLS] is a language server that is deprecated and has been replaced
by rust-analyzer.
* `clippy` — [Clippy] is a lint tool that provides extra checks for common
mistakes and stylistic choices.
* `miri` — [Miri] is an experimental Rust interpreter, which can be used for
checking for undefined-behavior.
* `rust-src` — This is a local copy of the source code of the Rust standard
library. This can be used by some tools, such as [RLS], to provide
library. This can be used by some tools, such as [rust-analyzer], to provide
auto-completion for functions within the standard library; [Miri] which is a
Rust interpreter; and Cargo's experimental [build-std] feature, which allows
you to rebuild the standard library locally.
* `rust-analysis` — Metadata about the standard library, used by tools like
[RLS].
* `rust-mingw` — This contains a linker and platform libraries for building on
the `x86_64-pc-windows-gnu` platform.
* `llvm-tools-preview` — This is an experimental component which contains a
Expand All @@ -63,6 +59,14 @@ toolchains. The following is an overview of the different components:
will not need this; it is only needed for development *of* tools that link
to the compiler, such as making modifications to [Clippy].

### Previous components

These components have been deprecated and are not published in new Rust releases.

* `rls` — [RLS] is a language server that is deprecated and has been replaced
by rust-analyzer.
* `rust-analysis` — Metadata about the standard library, used by [RLS].

## Component availability

Not all components are available for all toolchains. Especially on the nightly
Expand Down