diff options
| author | Aleksey Kladov <aleksey.kladov@gmail.com> | 2019-07-27 14:35:18 +0300 |
|---|---|---|
| committer | Aleksey Kladov <aleksey.kladov@gmail.com> | 2019-07-27 14:35:18 +0300 |
| commit | ecb1327fed1ece4083aa09255dbd927c5df304ef (patch) | |
| tree | c6a49bf13df5cd5529f9145391c7922ef17eb3a7 /docs | |
| parent | d23a7558702bcffd9c551bea444475f4a76ba201 (diff) | |
| download | rust-ecb1327fed1ece4083aa09255dbd927c5df304ef.tar.gz rust-ecb1327fed1ece4083aa09255dbd927c5df304ef.zip | |
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 0a148ed3239..74c58d4afeb 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 developer and user documentation. We have some automation infra in Rust in the `crates/tool` package. It contains -stuff like formatting checking, code generation and powers `cargo install-code`. +stuff like formatting checking, code generation and powers `cargo install-ra`. The latter syntax is achieved with the help of cargo aliases (see `.cargo` directory). @@ -84,7 +84,7 @@ However, launching a VS Code instance with locally build language server is possible. There's even a VS Code task for this, so just <kbd>F5</kbd> should work (thanks, [@andrew-w-ross](https://github.com/andrew-w-ross)!). -I often just install development version with `cargo jinstall-lsp` and +I often just install development version with `cargo install-ra --server --jemalloc` and restart the host VS Code. See [./debugging.md](./debugging.md) for how to attach to rust-analyzer with @@ -110,7 +110,7 @@ ways: 2. Run `npm test` from the command line. Although this is initiated from the command line it is not headless; it will also launch a temporary instance of - VS Code. + VS Code. Due to the requirements of running the tests inside VS Code they are **not run 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: $ cargo install --path crates/ra_lsp_server --force --features jemalloc ``` - There's an alias for this: `cargo jinstall-lsp`. + There's an alias for this: `cargo install-ra --server --jemalloc`. * `Rust Analyzer: Syntax Tree` shows syntax tree of the current file/selection. diff --git a/docs/user/README.md b/docs/user/README.md index 8a576784928..122388a4270 100644 --- a/docs/user/README.md +++ b/docs/user/README.md @@ -1,6 +1,6 @@ The main interface to rust-analyzer is the [LSP](https://microsoft.github.io/language-server-protocol/) implementation. To -install lsp server, use `cargo install-lsp`, which is a shorthand for `cargo +install lsp server, use `cargo install-ra --server`, which is a shorthand for `cargo install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you should be able to use it with any LSP-compatible editor. We use custom extensions to LSP, so special client-side support is required to take full @@ -33,7 +33,7 @@ following commands: ``` $ git clone https://github.com/rust-analyzer/rust-analyzer.git --depth 1 $ cd rust-analyzer -$ cargo install-code +$ cargo install-ra ``` The automatic installation is expected to *just work* for common cases, if it |