From 7b15c4f7ae95e2e855cb783871906fa7bf364c4c Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Thu, 17 Oct 2019 19:36:55 +0300 Subject: WIP: move to xtasks --- docs/dev/architecture.md | 14 ++++---------- docs/user/README.md | 6 +++--- 2 files changed, 7 insertions(+), 13 deletions(-) (limited to 'docs') diff --git a/docs/dev/architecture.md b/docs/dev/architecture.md index 1ffabc6ef..28f2a37e5 100644 --- a/docs/dev/architecture.md +++ b/docs/dev/architecture.md @@ -45,21 +45,15 @@ can be quickly updated for small modifications. Some of the components of this repository are generated through automatic processes. These are outlined below: -- `gen-syntax`: The kinds of tokens that are reused in several places, so a generator - is used. We use tera templates to generate the files listed below, based on +- `cargo xtask codegen`: The kinds of tokens that are reused in several places, so a generator + is used. We use `quote!` macro to generate the files listed below, based on the grammar described in [grammar.ron]: - - [ast/generated.rs][ast generated] in `ra_syntax` based on - [ast/generated.tera.rs][ast source] - - [syntax_kind/generated.rs][syntax_kind generated] in `ra_syntax` based on - [syntax_kind/generated.tera.rs][syntax_kind source] + - [ast/generated.rs][ast generated] + - [syntax_kind/generated.rs][syntax_kind generated] -[tera]: https://tera.netlify.com/ [grammar.ron]: ../../crates/ra_syntax/src/grammar.ron [ast generated]: ../../crates/ra_syntax/src/ast/generated.rs -[ast source]: ../../crates/ra_syntax/src/ast/generated.rs.tera [syntax_kind generated]: ../../crates/ra_parser/src/syntax_kind/generated.rs -[syntax_kind source]: ../../crates/ra_parser/src/syntax_kind/generated.rs.tera - ## Code Walk-Through diff --git a/docs/user/README.md b/docs/user/README.md index 5b7502132..f45c0d7d1 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-ra --server`, which is a shorthand for `cargo +install lsp server, use `cargo xtask install --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-ra +$ cargo xtask install ``` The automatic installation is expected to *just work* for common cases, if it @@ -58,7 +58,7 @@ Beyond basic LSP features, there are some extension commands which you can invoke via Ctrl+Shift+P or bind to a shortcut. See [./features.md](./features.md) for details. -For updates, pull the latest changes from the master branch, run `cargo install-ra` again, and **restart** VS Code instance. +For updates, pull the latest changes from the master branch, run `cargo xtask install` again, and **restart** VS Code instance. See [microsoft/vscode#72308](https://github.com/microsoft/vscode/issues/72308) for why a full restart is needed. ### Settings -- cgit v1.2.3