aboutsummaryrefslogtreecommitdiff
path: root/ARCHITECTURE.md
diff options
context:
space:
mode:
Diffstat (limited to 'ARCHITECTURE.md')
-rw-r--r--ARCHITECTURE.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md
index b497cc5d7..1efd1e054 100644
--- a/ARCHITECTURE.md
+++ b/ARCHITECTURE.md
@@ -10,7 +10,7 @@ in the right place!
10Some of the components of this repository are generated through automatic 10Some of the components of this repository are generated through automatic
11processes. These are outlined below: 11processes. These are outlined below:
12 12
13- `gen-kinds`: The kinds of tokens are reused in several places, so a generator 13- `gen-syntax`: The kinds of tokens are reused in several places, so a generator
14 is used. We use tera templates to generate the files listed below, based on 14 is used. We use tera templates to generate the files listed below, based on
15 the grammar described in [grammar.ron]: 15 the grammar described in [grammar.ron]:
16 - [ast/generated.rs][ast generated] in `ra_syntax` based on 16 - [ast/generated.rs][ast generated] in `ra_syntax` based on
@@ -43,7 +43,7 @@ notes.
43 This is the thing that turns a flat list of events into a tree (see `EventProcessor`) 43 This is the thing that turns a flat list of events into a tree (see `EventProcessor`)
44- `ast` a type safe API on top of the raw `rowan` tree. 44- `ast` a type safe API on top of the raw `rowan` tree.
45- `grammar.ron` RON description of the grammar, which is used to 45- `grammar.ron` RON description of the grammar, which is used to
46 generate `syntax_kinds` and `ast` modules, using `cargo gen-kinds` command. 46 generate `syntax_kinds` and `ast` modules, using `cargo gen-syntax` command.
47- `algo`: generic tree algorithms, including `walk` for O(1) stack 47- `algo`: generic tree algorithms, including `walk` for O(1) stack
48 space tree traversal (this is cool) and `visit` for type-driven 48 space tree traversal (this is cool) and `visit` for type-driven
49 visiting the nodes (this is double plus cool, if you understand how 49 visiting the nodes (this is double plus cool, if you understand how
@@ -106,7 +106,7 @@ A CLI interface to rust-analyzer.
106 106
107Custom Cargo tasks used to develop rust-analyzer: 107Custom Cargo tasks used to develop rust-analyzer:
108 108
109- `cargo gen-kinds` -- generate `ast` and `syntax_kinds` 109- `cargo gen-syntax` -- generate `ast` and `syntax_kinds`
110- `cargo gen-tests` -- collect inline tests from grammar 110- `cargo gen-tests` -- collect inline tests from grammar
111- `cargo install-code` -- build and install VS Code extension and server 111- `cargo install-code` -- build and install VS Code extension and server
112 112