diff options
author | Aleksey Kladov <[email protected]> | 2019-07-27 12:35:18 +0100 |
---|---|---|
committer | Aleksey Kladov <[email protected]> | 2019-07-27 12:35:18 +0100 |
commit | ecb1327fed1ece4083aa09255dbd927c5df304ef (patch) | |
tree | c6a49bf13df5cd5529f9145391c7922ef17eb3a7 /docs | |
parent | d23a7558702bcffd9c551bea444475f4a76ba201 (diff) |
Overhaul installation process
The new commands are
$ cargo install-ra --client-code
$ cargo install-ra --server --jemalloc
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 8 | ||||
-rw-r--r-- | docs/user/README.md | 4 |
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index 0a148ed32..74c58d4af 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -66,7 +66,7 @@ typescript) and Emacs (in elisp). The `docs` top-level directory contains both | |||
66 | developer and user documentation. | 66 | developer and user documentation. |
67 | 67 | ||
68 | We have some automation infra in Rust in the `crates/tool` package. It contains | 68 | We have some automation infra in Rust in the `crates/tool` package. It contains |
69 | stuff like formatting checking, code generation and powers `cargo install-code`. | 69 | stuff like formatting checking, code generation and powers `cargo install-ra`. |
70 | The latter syntax is achieved with the help of cargo aliases (see `.cargo` | 70 | The latter syntax is achieved with the help of cargo aliases (see `.cargo` |
71 | directory). | 71 | directory). |
72 | 72 | ||
@@ -84,7 +84,7 @@ However, launching a VS Code instance with locally build language server is | |||
84 | possible. There's even a VS Code task for this, so just <kbd>F5</kbd> should | 84 | possible. There's even a VS Code task for this, so just <kbd>F5</kbd> should |
85 | work (thanks, [@andrew-w-ross](https://github.com/andrew-w-ross)!). | 85 | work (thanks, [@andrew-w-ross](https://github.com/andrew-w-ross)!). |
86 | 86 | ||
87 | I often just install development version with `cargo jinstall-lsp` and | 87 | I often just install development version with `cargo install-ra --server --jemalloc` and |
88 | restart the host VS Code. | 88 | restart the host VS Code. |
89 | 89 | ||
90 | See [./debugging.md](./debugging.md) for how to attach to rust-analyzer with | 90 | See [./debugging.md](./debugging.md) for how to attach to rust-analyzer with |
@@ -110,7 +110,7 @@ ways: | |||
110 | 110 | ||
111 | 2. Run `npm test` from the command line. Although this is initiated from the | 111 | 2. Run `npm test` from the command line. Although this is initiated from the |
112 | command line it is not headless; it will also launch a temporary instance of | 112 | command line it is not headless; it will also launch a temporary instance of |
113 | VS Code. | 113 | VS Code. |
114 | 114 | ||
115 | Due to the requirements of running the tests inside VS Code they are **not run | 115 | Due to the requirements of running the tests inside VS Code they are **not run |
116 | on CI**. When making changes to the extension please ensure the tests are not | 116 | on CI**. When making changes to the extension please ensure the tests are not |
@@ -151,7 +151,7 @@ There's also two VS Code commands which might be of interest: | |||
151 | $ cargo install --path crates/ra_lsp_server --force --features jemalloc | 151 | $ cargo install --path crates/ra_lsp_server --force --features jemalloc |
152 | ``` | 152 | ``` |
153 | 153 | ||
154 | There's an alias for this: `cargo jinstall-lsp`. | 154 | There's an alias for this: `cargo install-ra --server --jemalloc`. |
155 | 155 | ||
156 | * `Rust Analyzer: Syntax Tree` shows syntax tree of the current file/selection. | 156 | * `Rust Analyzer: Syntax Tree` shows syntax tree of the current file/selection. |
157 | 157 | ||
diff --git a/docs/user/README.md b/docs/user/README.md index 8a5767849..122388a42 100644 --- a/docs/user/README.md +++ b/docs/user/README.md | |||
@@ -1,6 +1,6 @@ | |||
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 install-lsp`, which is a shorthand for `cargo | 3 | install lsp server, use `cargo install-ra --server`, which is a shorthand for `cargo |
4 | install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you | 4 | install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you |
5 | should be able to use it with any LSP-compatible editor. We use custom | 5 | 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 | 6 | extensions to LSP, so special client-side support is required to take full |
@@ -33,7 +33,7 @@ following commands: | |||
33 | ``` | 33 | ``` |
34 | $ git clone https://github.com/rust-analyzer/rust-analyzer.git --depth 1 | 34 | $ git clone https://github.com/rust-analyzer/rust-analyzer.git --depth 1 |
35 | $ cd rust-analyzer | 35 | $ cd rust-analyzer |
36 | $ cargo install-code | 36 | $ cargo install-ra |
37 | ``` | 37 | ``` |
38 | 38 | ||
39 | The automatic installation is expected to *just work* for common cases, if it | 39 | The automatic installation is expected to *just work* for common cases, if it |