From 6cbb18e570b89401e6e63fd89a719b87ab362ece Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lauren=C8=9Biu=20Nicola?= Date: Mon, 14 Jun 2021 17:44:26 +0300 Subject: Code: automatically update the LSP server Most LSP extensions seem to do the same thing, and this is causing some confusion for users who don't notice the update prompt before Code hides it. --- PRIVACY.md | 2 +- editors/code/package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/PRIVACY.md b/PRIVACY.md index 27e39ca60..11ea040fb 100644 --- a/PRIVACY.md +++ b/PRIVACY.md @@ -6,7 +6,7 @@ The LSP server performs no network access in itself, but runs `cargo metadata` w ## Visual Studio Code extension -The Code extension connects to GitHub to download updated LSP binaries and, if the nightly channel is selected, to perform update checks. +The Code extension automatically connects to GitHub to download updated LSP binaries and, if the nightly channel is selected, to perform update checks. ## Other editor plugins diff --git a/editors/code/package.json b/editors/code/package.json index 0f3ed48a0..1b85c39bd 100644 --- a/editors/code/package.json +++ b/editors/code/package.json @@ -313,7 +313,7 @@ }, "rust-analyzer.updates.askBeforeDownload": { "type": "boolean", - "default": true, + "default": false, "description": "Whether to ask for permission before downloading any files from the Internet." }, "rust-analyzer.server.path": { -- cgit v1.2.3 From 76202234a9639adfdb23392f551d839a47f384c9 Mon Sep 17 00:00:00 2001 From: Kevin Svetlitski Date: Mon, 14 Jun 2021 16:41:34 -0500 Subject: Document installation via Homebrew; Add gitignore entry for asciidoctor output --- docs/user/.gitignore | 1 + docs/user/manual.adoc | 9 +++++++++ 2 files changed, 10 insertions(+) create mode 100644 docs/user/.gitignore diff --git a/docs/user/.gitignore b/docs/user/.gitignore new file mode 100644 index 000000000..c32b1bcec --- /dev/null +++ b/docs/user/.gitignore @@ -0,0 +1 @@ +manual.html diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index 9a8d76700..26b8abe33 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc @@ -201,6 +201,15 @@ $ eselect repository enable guru && emaint sync -r guru $ emerge rust-analyzer-bin ---- +=== macOS + +The `rust-analyzer` binary can be installed via https://brew.sh/[Homebrew]. + +[source,bash] +---- +$ brew install rust-analyzer +---- + === Emacs Note this excellent https://robert.kra.hn/posts/2021-02-07_rust-with-emacs/[guide] from https://github.com/rksm[@rksm]. -- cgit v1.2.3 From cbf53ba2514a0a19ba8fc45348e0e6610cb88859 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lauren=C8=9Biu=20Nicola?= Date: Tue, 15 Jun 2021 20:05:16 +0300 Subject: Consolidate the privacy notes --- PRIVACY.md | 18 +----------------- README.md | 4 ++++ docs/user/manual.adoc | 11 ++++++++--- 3 files changed, 13 insertions(+), 20 deletions(-) diff --git a/PRIVACY.md b/PRIVACY.md index 11ea040fb..718fbed12 100644 --- a/PRIVACY.md +++ b/PRIVACY.md @@ -1,17 +1 @@ -# Privacy Notes - -## LSP server binary - -The LSP server performs no network access in itself, but runs `cargo metadata` which will update or download the crate registry and the source code of the project dependencies. - -## Visual Studio Code extension - -The Code extension automatically connects to GitHub to download updated LSP binaries and, if the nightly channel is selected, to perform update checks. - -## Other editor plugins - -Any other editor plugins that integrate with `rust-analyzer` are not under the control of the `rust-analyzer` developers. For any privacy concerns, you should check with their respective developers. - -## Others - -If `cargo check` is enabled (the default), any build scripts or procedural macros used by the project or its dependencies will be executed. This is also the case when `cargo check` is disabled, but build script or procedural macro support is enabled in `rust-analyzer` (on by default). +See the [Privacy](https://rust-analyzer.github.io/manual.html#security) section of the user manual. diff --git a/README.md b/README.md index 5fbc03964..e01542416 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,10 @@ If you want to **use** rust-analyzer's language server with your editor of choice, check [the manual](https://rust-analyzer.github.io/manual.html) folder. It also contains some tips & tricks to help you be more productive when using rust-analyzer. +## Security and Privacy + +See the corresponding sections of [the manual](https://rust-analyzer.github.io/manual.html#security). + ## Communication For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum: diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index 9a8d76700..d5f8dbb1d 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc @@ -609,9 +609,14 @@ Here is a **non-exhaustive** list of ways to make rust-analyzer execute arbitrar * 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. * rust-analyzer's syntax trees library uses a lot of `unsafe` and hasn't been properly audited for memory safety. -rust-analyzer itself doesn't access the network. -The VS Code plugin doesn't access the network unless the nightly channel is selected in the settings. -In that case, the plugin uses the GitHub API to check for and download updates. +== Privacy + +The LSP server performs no network access in itself, but runs `cargo metadata` which will update or download the crate registry and the source code of the project dependencies. +If enabled (the default), build scripts and procedural macros can do anything. + +The Code extension automatically connects to GitHub to download updated LSP binaries and, if the nightly channel is selected, to perform update checks using the GitHub API. For `rust-analyzer` developers, using `cargo xtask release` uses the same API to put together the release notes. + +Any other editor plugins are not under the control of the `rust-analyzer` developers. For any privacy concerns, you should check with their respective developers. == Features -- cgit v1.2.3 From 78668f76a084ac3612808db9d54d6f175145af98 Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Tue, 15 Jun 2021 23:40:07 +0300 Subject: Update docs/user/manual.adoc --- docs/user/manual.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index 26b8abe33..e28263c59 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc @@ -201,7 +201,7 @@ $ eselect repository enable guru && emaint sync -r guru $ emerge rust-analyzer-bin ---- -=== macOS +==== macOS The `rust-analyzer` binary can be installed via https://brew.sh/[Homebrew]. -- cgit v1.2.3