diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 3 | ||||
-rw-r--r-- | docs/dev/lsp-extensions.md | 28 | ||||
-rw-r--r-- | docs/user/generated_config.adoc | 4 | ||||
-rw-r--r-- | docs/user/manual.adoc | 14 |
4 files changed, 46 insertions, 3 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 | |||
226 | If it fails because of something that needs to be fixed, remove the release tag (if needed), fix the problem, then start over. | 226 | If it fails because of something that needs to be fixed, remove the release tag (if needed), fix the problem, then start over. |
227 | Make sure to remove the new changelog post created when running `cargo xtask release` a second time. | 227 | Make sure to remove the new changelog post created when running `cargo xtask release` a second time. |
228 | 228 | ||
229 | We release "nightly" every night automatically and promote the latest nightly to "stable" manually, every week. | ||
230 | We don't do "patch" releases, unless something truly egregious comes up. | ||
231 | |||
229 | # Permissions | 232 | # Permissions |
230 | 233 | ||
231 | There are three sets of people with extra permissions: | 234 | There are three sets of people with extra permissions: |
diff --git a/docs/dev/lsp-extensions.md b/docs/dev/lsp-extensions.md index 694fafcd5..8a6f9f06e 100644 --- a/docs/dev/lsp-extensions.md +++ b/docs/dev/lsp-extensions.md | |||
@@ -1,5 +1,5 @@ | |||
1 | <!--- | 1 | <!--- |
2 | lsp_ext.rs hash: 4dfa8d7035f4aee7 | 2 | lsp_ext.rs hash: e8a7502bd2b2c2f5 |
3 | 3 | ||
4 | If you need to change the above hash to make the test pass, please check if you | 4 | If you need to change the above hash to make the test pass, please check if you |
5 | need to adjust this doc as well and ping this issue: | 5 | need to adjust this doc as well and ping this issue: |
@@ -595,3 +595,29 @@ interface TestInfo { | |||
595 | runnable: Runnable; | 595 | runnable: Runnable; |
596 | } | 596 | } |
597 | ``` | 597 | ``` |
598 | |||
599 | ## Hover Actions | ||
600 | |||
601 | **Issue:** https://github.com/rust-analyzer/rust-analyzer/issues/6823 | ||
602 | |||
603 | This request is sent from client to server to move item under cursor or selection in some direction. | ||
604 | |||
605 | **Method:** `experimental/moveItemUp` | ||
606 | **Method:** `experimental/moveItemDown` | ||
607 | |||
608 | **Request:** `MoveItemParams` | ||
609 | |||
610 | **Response:** `TextDocumentEdit | null` | ||
611 | |||
612 | ```typescript | ||
613 | export interface MoveItemParams { | ||
614 | textDocument: lc.TextDocumentIdentifier, | ||
615 | range: lc.Range, | ||
616 | direction: Direction | ||
617 | } | ||
618 | |||
619 | export const enum Direction { | ||
620 | Up = "Up", | ||
621 | Down = "Down" | ||
622 | } | ||
623 | ``` | ||
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index c2521289c..871c65add 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc | |||
@@ -206,10 +206,10 @@ Use markdown syntax for links in hover. | |||
206 | -- | 206 | -- |
207 | Whether to show inlay type hints for method chains. | 207 | Whether to show inlay type hints for method chains. |
208 | -- | 208 | -- |
209 | [[rust-analyzer.inlayHints.maxLength]]rust-analyzer.inlayHints.maxLength (default: `null`):: | 209 | [[rust-analyzer.inlayHints.maxLength]]rust-analyzer.inlayHints.maxLength (default: `25`):: |
210 | + | 210 | + |
211 | -- | 211 | -- |
212 | Maximum length for inlay hints. Default is unlimited. | 212 | Maximum length for inlay hints. Set to null to have an unlimited length. |
213 | -- | 213 | -- |
214 | [[rust-analyzer.inlayHints.parameterHints]]rust-analyzer.inlayHints.parameterHints (default: `true`):: | 214 | [[rust-analyzer.inlayHints.parameterHints]]rust-analyzer.inlayHints.parameterHints (default: `true`):: |
215 | + | 215 | + |
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index dba2197de..8656dd1da 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc | |||
@@ -516,6 +516,20 @@ See https://github.com/rust-analyzer/rust-project.json-example for a small examp | |||
516 | 516 | ||
517 | You can set `RA_LOG` environmental variable to `rust_analyzer=info` to inspect how rust-analyzer handles config and project loading. | 517 | You can set `RA_LOG` environmental variable to `rust_analyzer=info` to inspect how rust-analyzer handles config and project loading. |
518 | 518 | ||
519 | == Security | ||
520 | |||
521 | At the moment, rust-analyzer assumes that all code is trusted. | ||
522 | Here 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 | |||
529 | rust-analyzer itself doesn't access the network. | ||
530 | The VS Code plugin doesn't access the network unless the nightly channel is selected in the settings. | ||
531 | In that case, the plugin uses the GitHub API to check for and download updates. | ||
532 | |||
519 | == Features | 533 | == Features |
520 | 534 | ||
521 | include::./generated_features.adoc[] | 535 | include::./generated_features.adoc[] |