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 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) (limited to 'docs/dev') 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 -- cgit v1.2.3 From 5376c769f0cb6076c4862e728af042bb563a5051 Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Thu, 17 Oct 2019 23:01:53 +0300 Subject: rename tools -> xtask --- docs/dev/README.md | 10 +++++----- docs/dev/architecture.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) (limited to 'docs/dev') diff --git a/docs/dev/README.md b/docs/dev/README.md index 5e18e4ffe..e5a7ea5f6 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md @@ -65,8 +65,8 @@ integrating with editors. Currently, it contains plugins for VS Code (in 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-ra`. +We have some automation infra in Rust in the `xtask` package. It contains +stuff like formatting checking, code generation and powers `cargo xtask install`. 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 F5 should work (thanks, [@andrew-w-ross](https://github.com/andrew-w-ross)!). -I often just install development version with `cargo install-ra --server --jemalloc` and +I often just install development version with `cargo xtask install --server --jemalloc` and restart the host VS Code. See [./debugging.md](./debugging.md) for how to attach to rust-analyzer with @@ -116,7 +116,7 @@ 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 broken locally before opening a Pull Request. -To install **only** the VS Code extension, use `cargo install-ra --client-code`. +To install **only** the VS Code extension, use `cargo xtask install --client-code`. # Logging @@ -153,7 +153,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 install-ra --server --jemalloc`. + There's an alias for this: `cargo xtask install --server --jemalloc`. * `Rust Analyzer: Syntax Tree` shows syntax tree of the current file/selection. diff --git a/docs/dev/architecture.md b/docs/dev/architecture.md index 28f2a37e5..5ec5352e7 100644 --- a/docs/dev/architecture.md +++ b/docs/dev/architecture.md @@ -71,7 +71,7 @@ Rust syntax tree structure and parser. See This is the thing that turns a flat list of events into a tree (see `EventProcessor`) - `ast` provides a type safe API on top of the raw `rowan` tree. - `grammar.ron` RON description of the grammar, which is used to - generate `syntax_kinds` and `ast` modules, using `cargo gen-syntax` command. + generate `syntax_kinds` and `ast` modules, using `cargo xtask codegen` command. - `algo`: generic tree algorithms, including `walk` for O(1) stack space tree traversal (this is cool). -- cgit v1.2.3