diff options
author | Florian Diebold <[email protected]> | 2020-02-08 15:02:37 +0000 |
---|---|---|
committer | Florian Diebold <[email protected]> | 2020-02-08 15:15:58 +0000 |
commit | 134cc70097f2386bf3af6a15e3c29de9c317ed24 (patch) | |
tree | c012a1fb7f7e97a34ff65559c15413a179a59e60 /docs | |
parent | c27ec6908793e3b1706d683dc2c2d367ac8fc061 (diff) |
Docs cleanups
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 12 | ||||
-rw-r--r-- | docs/user/README.md | 18 |
2 files changed, 12 insertions, 18 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index d30727786..732e4bdd3 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -43,7 +43,7 @@ https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0 | |||
43 | 43 | ||
44 | We use GitHub Actions for CI. Most of the things, including formatting, are checked by | 44 | We use GitHub Actions for CI. Most of the things, including formatting, are checked by |
45 | `cargo test` so, if `cargo test` passes locally, that's a good sign that CI will | 45 | `cargo test` so, if `cargo test` passes locally, that's a good sign that CI will |
46 | be green as well. The only exception is that long-running by default a skipped locally. | 46 | be green as well. The only exception is that some long-running tests are skipped locally by default. |
47 | Use `env RUN_SLOW_TESTS=1 cargo test` to run the full suite. | 47 | Use `env RUN_SLOW_TESTS=1 cargo test` to run the full suite. |
48 | 48 | ||
49 | We use bors-ng to enforce the [not rocket science](https://graydon2.dreamwidth.org/1597.html) rule. | 49 | We use bors-ng to enforce the [not rocket science](https://graydon2.dreamwidth.org/1597.html) rule. |
@@ -54,9 +54,9 @@ You can run `cargo xtask install-pre-commit-hook` to install git-hook to run rus | |||
54 | 54 | ||
55 | All Rust code lives in the `crates` top-level directory, and is organized as a | 55 | All Rust code lives in the `crates` top-level directory, and is organized as a |
56 | single Cargo workspace. The `editors` top-level directory contains code for | 56 | single Cargo workspace. The `editors` top-level directory contains code for |
57 | integrating with editors. Currently, it contains plugins for VS Code (in | 57 | integrating with editors. Currently, it contains the plugin for VS Code (in |
58 | typescript) and Emacs (in elisp). The `docs` top-level directory contains both | 58 | typescript). The `docs` top-level directory contains both developer and user |
59 | developer and user documentation. | 59 | documentation. |
60 | 60 | ||
61 | We have some automation infra in Rust in the `xtask` package. It contains | 61 | We have some automation infra in Rust in the `xtask` package. It contains |
62 | stuff like formatting checking, code generation and powers `cargo xtask install`. | 62 | stuff like formatting checking, code generation and powers `cargo xtask install`. |
@@ -107,8 +107,8 @@ If I need to fix something simultaneously in the server and in the client, I | |||
107 | feel even more sad. I don't have a specific workflow for this case. | 107 | feel even more sad. I don't have a specific workflow for this case. |
108 | 108 | ||
109 | Additionally, I use `cargo run --release -p ra_cli -- analysis-stats | 109 | Additionally, I use `cargo run --release -p ra_cli -- analysis-stats |
110 | path/to/some/rust/crate` to run a batch analysis. This is primaraly useful for | 110 | path/to/some/rust/crate` to run a batch analysis. This is primarily useful for |
111 | performance optimiations, or for bug minimization. | 111 | performance optimizations, or for bug minimization. |
112 | 112 | ||
113 | # Logging | 113 | # Logging |
114 | 114 | ||
diff --git a/docs/user/README.md b/docs/user/README.md index 18867cd11..da99a063c 100644 --- a/docs/user/README.md +++ b/docs/user/README.md | |||
@@ -5,8 +5,7 @@ install lsp server, clone the repository and then run `cargo xtask install | |||
5 | ./crates/ra_lsp_server`). This will produce a binary named `ra_lsp_server` which | 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 | you should be able to use it with any LSP-compatible editor. We use custom |
7 | 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 |
8 | 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. |
9 | and Emacs. | ||
10 | 9 | ||
11 | ``` | 10 | ``` |
12 | $ git clone [email protected]:rust-analyzer/rust-analyzer && cd rust-analyzer | 11 | $ git clone [email protected]:rust-analyzer/rust-analyzer && cd rust-analyzer |
@@ -130,17 +129,12 @@ host. | |||
130 | 129 | ||
131 | ## Emacs | 130 | ## Emacs |
132 | 131 | ||
133 | Prerequisites: | 132 | * install recent version of `emacs-lsp` package by following the instructions [here][emacs-lsp] |
134 | 133 | * set `lsp-rust-server` to `'rust-analyzer` | |
135 | `emacs-lsp`, `dash` and `ht` packages. | 134 | * run `lsp` in a Rust buffer |
136 | 135 | * (Optionally) bind commands like `lsp-rust-analyzer-join-lines`, `lsp-extend-selection` and `lsp-rust-analyzer-expand-macro` to keys | |
137 | Installation: | ||
138 | 136 | ||
139 | * add | 137 | [emacs-lsp]: https://github.com/emacs-lsp/lsp-mode |
140 | [rust-analyzer.el](../../editors/emacs/rust-analyzer.el) | ||
141 | to load path and require it in `init.el` | ||
142 | * run `lsp` in a rust buffer | ||
143 | * (Optionally) bind commands like `rust-analyzer-join-lines`, `rust-analyzer-extend-selection` and `rust-analyzer-expand-macro` to keys, and enable `rust-analyzer-inlay-hints-mode` to get inline type hints | ||
144 | 138 | ||
145 | 139 | ||
146 | ## Vim and NeoVim (coc-rust-analyzer) | 140 | ## Vim and NeoVim (coc-rust-analyzer) |