aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/README.md3
-rw-r--r--docs/user/manual.adoc20
2 files changed, 19 insertions, 4 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md
index b91013f13..57162a47d 100644
--- a/docs/dev/README.md
+++ b/docs/dev/README.md
@@ -226,6 +226,9 @@ If the GitHub Actions release fails because of a transient problem like a timeou
226If it fails because of something that needs to be fixed, remove the release tag (if needed), fix the problem, then start over. 226If it fails because of something that needs to be fixed, remove the release tag (if needed), fix the problem, then start over.
227Make sure to remove the new changelog post created when running `cargo xtask release` a second time. 227Make sure to remove the new changelog post created when running `cargo xtask release` a second time.
228 228
229We release "nightly" every night automatically and promote the latest nightly to "stable" manually, every week.
230We don't do "patch" releases, unless something truly egregious comes up.
231
229# Permissions 232# Permissions
230 233
231There are three sets of people with extra permissions: 234There are three sets of people with extra permissions:
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc
index f4c37353c..8656dd1da 100644
--- a/docs/user/manual.adoc
+++ b/docs/user/manual.adoc
@@ -384,11 +384,9 @@ If the LSP binary is not available, GNOME Builder can install it when opening a
384 384
385=== Eclipse IDE 385=== Eclipse IDE
386 386
387Prerequisites: You have installed the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>.
388
389Support for Rust development in the Eclipse IDE is provided by link:https://github.com/eclipse/corrosion[Eclipse Corrosion]. 387Support for Rust development in the Eclipse IDE is provided by link:https://github.com/eclipse/corrosion[Eclipse Corrosion].
390While it currently uses RLS as default, you can successfully configure it so the IDE will use `rust-analyzer` instead. 388If available in PATH or in some standard location, `rust-analyzer` is detected and powers editing of Rust files without further configuration.
391To do so, with an Eclipse IDE where Corrosion is installed, just go to __Window > Preferences > Rust__ and edit the __Path to Rust Language Server__ entry to reference the path to `rust-analyzer`. 389If `rust-analyzer` is not detected, Corrosion will prompt you for configuration of your Rust toolchain and language server with a link to the __Window > Preferences > Rust__ preference page; from here a button allows to download and configure `rust-analyzer`, but you can also reference another installation.
392You'll need to close and reopen all .rs and Cargo files, or to restart the IDE, for this change to take effect. 390You'll need to close and reopen all .rs and Cargo files, or to restart the IDE, for this change to take effect.
393 391
394== Configuration 392== Configuration
@@ -518,6 +516,20 @@ See https://github.com/rust-analyzer/rust-project.json-example for a small examp
518 516
519You can set `RA_LOG` environmental variable to `rust_analyzer=info` to inspect how rust-analyzer handles config and project loading. 517You can set `RA_LOG` environmental variable to `rust_analyzer=info` to inspect how rust-analyzer handles config and project loading.
520 518
519== Security
520
521At the moment, rust-analyzer assumes that all code is trusted.
522Here is a **non-exhaustive** list of ways to make rust-analyzer execute arbitrary code:
523
524* proc macros and build scripts are executed by default
525* `.cargo/config` can override `rustc` with an arbitrary executable
526* VS Code plugin reads configuration from project directory, and that can be used to override paths to various executables, like `rustfmt` or `rust-analyzer` itself.
527* rust-analyzer's syntax trees library uses a lot of `unsafe` and hasn't been properly audited for memory safety.
528
529rust-analyzer itself doesn't access the network.
530The VS Code plugin doesn't access the network unless the nightly channel is selected in the settings.
531In that case, the plugin uses the GitHub API to check for and download updates.
532
521== Features 533== Features
522 534
523include::./generated_features.adoc[] 535include::./generated_features.adoc[]