diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 5 | ||||
-rw-r--r-- | docs/user/README.md | 15 |
2 files changed, 12 insertions, 8 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index 0f64d7e5f..2f6215d6b 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -124,9 +124,8 @@ Logging is done by both rust-analyzer and VS Code, so it might be tricky to | |||
124 | figure out where logs go. | 124 | figure out where logs go. |
125 | 125 | ||
126 | Inside rust-analyzer, we use the standard `log` crate for logging, and | 126 | Inside rust-analyzer, we use the standard `log` crate for logging, and |
127 | `flexi_logger` for logging frotend. By default, log goes to stderr (the same as | 127 | `env_logger` for logging frontend. By default, log goes to stderr, but the |
128 | with `env_logger`), but the stderr itself is processed by VS Code. To mirror | 128 | stderr itself is processed by VS Code. |
129 | logs to a `./log` directory, set `RA_LOG_DIR=1` environmental variable. | ||
130 | 129 | ||
131 | To see stderr in the running VS Code instance, go to the "Output" tab of the | 130 | To see stderr in the running VS Code instance, go to the "Output" tab of the |
132 | panel and select `rust-analyzer`. This shows `eprintln!` as well. Note that | 131 | panel and select `rust-analyzer`. This shows `eprintln!` as well. Note that |
diff --git a/docs/user/README.md b/docs/user/README.md index 913ecea18..adacead52 100644 --- a/docs/user/README.md +++ b/docs/user/README.md | |||
@@ -1,14 +1,19 @@ | |||
1 | The main interface to rust-analyzer is the | 1 | The main interface to rust-analyzer is the |
2 | [LSP](https://microsoft.github.io/language-server-protocol/) implementation. To | 2 | [LSP](https://microsoft.github.io/language-server-protocol/) implementation. To |
3 | install lsp server, use `cargo xtask install --server`, which is a shorthand for `cargo | 3 | install lsp server, clone the repository and then run `cargo xtask install |
4 | install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you | 4 | --server` (which is shorthand for `cargo install --path |
5 | should be able to use it with any LSP-compatible editor. We use custom | 5 | ./crates/ra_lsp_server`). This will produce a binary named `ra_lsp_server` which |
6 | you should be able to use it with any LSP-compatible editor. We use custom | ||
6 | extensions to LSP, so special client-side support is required to take full | 7 | extensions to LSP, so special client-side support is required to take full |
7 | advantage of rust-analyzer. This repository contains support code for VS Code | 8 | advantage of rust-analyzer. This repository contains support code for VS Code |
8 | and Emacs. | 9 | and Emacs. |
9 | 10 | ||
10 | Rust Analyzer needs sources of rust standard library to work, so you might need | 11 | ``` |
11 | to execute | 12 | $ git clone [email protected]:rust-analyzer/rust-analyzer && cd rust-analyzer |
13 | $ cargo xtask install --server | ||
14 | ``` | ||
15 | Rust Analyzer needs sources of rust standard library to work, so | ||
16 | you might also need to execute | ||
12 | 17 | ||
13 | ``` | 18 | ``` |
14 | $ rustup component add rust-src | 19 | $ rustup component add rust-src |