aboutsummaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorAleksey Kladov <[email protected]>2019-10-17 21:01:53 +0100
committerAleksey Kladov <[email protected]>2019-10-17 21:14:05 +0100
commit5376c769f0cb6076c4862e728af042bb563a5051 (patch)
tree890a88741ef83c5ca0a57006c1972d0870fd86a4 /docs/dev
parent7b15c4f7ae95e2e855cb783871906fa7bf364c4c (diff)
rename tools -> xtask
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/README.md10
-rw-r--r--docs/dev/architecture.md2
2 files changed, 6 insertions, 6 deletions
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
65typescript) and Emacs (in elisp). The `docs` top-level directory contains both 65typescript) and Emacs (in elisp). The `docs` top-level directory contains both
66developer and user documentation. 66developer and user documentation.
67 67
68We have some automation infra in Rust in the `crates/tool` package. It contains 68We have some automation infra in Rust in the `xtask` package. It contains
69stuff like formatting checking, code generation and powers `cargo install-ra`. 69stuff like formatting checking, code generation and powers `cargo xtask install`.
70The latter syntax is achieved with the help of cargo aliases (see `.cargo` 70The latter syntax is achieved with the help of cargo aliases (see `.cargo`
71directory). 71directory).
72 72
@@ -84,7 +84,7 @@ However, launching a VS Code instance with locally build language server is
84possible. There's even a VS Code task for this, so just <kbd>F5</kbd> should 84possible. There's even a VS Code task for this, so just <kbd>F5</kbd> should
85work (thanks, [@andrew-w-ross](https://github.com/andrew-w-ross)!). 85work (thanks, [@andrew-w-ross](https://github.com/andrew-w-ross)!).
86 86
87I often just install development version with `cargo install-ra --server --jemalloc` and 87I often just install development version with `cargo xtask install --server --jemalloc` and
88restart the host VS Code. 88restart the host VS Code.
89 89
90See [./debugging.md](./debugging.md) for how to attach to rust-analyzer with 90See [./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
116on CI**. When making changes to the extension please ensure the tests are not 116on CI**. When making changes to the extension please ensure the tests are not
117broken locally before opening a Pull Request. 117broken locally before opening a Pull Request.
118 118
119To install **only** the VS Code extension, use `cargo install-ra --client-code`. 119To install **only** the VS Code extension, use `cargo xtask install --client-code`.
120 120
121# Logging 121# Logging
122 122
@@ -153,7 +153,7 @@ There's also two VS Code commands which might be of interest:
153 $ cargo install --path crates/ra_lsp_server --force --features jemalloc 153 $ cargo install --path crates/ra_lsp_server --force --features jemalloc
154 ``` 154 ```
155 155
156 There's an alias for this: `cargo install-ra --server --jemalloc`. 156 There's an alias for this: `cargo xtask install --server --jemalloc`.
157 157
158* `Rust Analyzer: Syntax Tree` shows syntax tree of the current file/selection. 158* `Rust Analyzer: Syntax Tree` shows syntax tree of the current file/selection.
159 159
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
71 This is the thing that turns a flat list of events into a tree (see `EventProcessor`) 71 This is the thing that turns a flat list of events into a tree (see `EventProcessor`)
72- `ast` provides a type safe API on top of the raw `rowan` tree. 72- `ast` provides a type safe API on top of the raw `rowan` tree.
73- `grammar.ron` RON description of the grammar, which is used to 73- `grammar.ron` RON description of the grammar, which is used to
74 generate `syntax_kinds` and `ast` modules, using `cargo gen-syntax` command. 74 generate `syntax_kinds` and `ast` modules, using `cargo xtask codegen` command.
75- `algo`: generic tree algorithms, including `walk` for O(1) stack 75- `algo`: generic tree algorithms, including `walk` for O(1) stack
76 space tree traversal (this is cool). 76 space tree traversal (this is cool).
77 77