aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDJMcNab <[email protected]>2019-01-29 17:02:06 +0000
committerDJMcNab <[email protected]>2019-01-29 17:02:06 +0000
commitb42b7450a207d2387114d454fb18a4479300bbf2 (patch)
tree1543ce44f535b625e89af9604861c447f0b935ed
parent48d2acb297459fb06cbb49bdce2eccb4c2591714 (diff)
Add `cargo jinstall-lsp` as a shorthand to include jemalloc support
-rw-r--r--.cargo/config2
-rw-r--r--ARCHITECTURE.md8
2 files changed, 6 insertions, 4 deletions
diff --git a/.cargo/config b/.cargo/config
index 3fba0f71d..b12f407e6 100644
--- a/.cargo/config
+++ b/.cargo/config
@@ -5,6 +5,8 @@ gen-syntax = "run --package tools --bin tools -- gen-syntax"
5gen-tests = "run --package tools --bin tools -- gen-tests" 5gen-tests = "run --package tools --bin tools -- gen-tests"
6# Installs ra_lsp_server 6# Installs ra_lsp_server
7install-lsp = "install --path crates/ra_lsp_server --force" 7install-lsp = "install --path crates/ra_lsp_server --force"
8# Installs ra_lsp_server with the jemalloc feature
9jinstall-lsp = "install --path crates/ra_lsp_server --force --features jemalloc"
8# Installs the visual studio code extension 10# Installs the visual studio code extension
9install-code = "run --package tools --bin tools -- install-code" 11install-code = "run --package tools --bin tools -- install-code"
10# Formats the full repository or installs the git hook to do it automatically. 12# Formats the full repository or installs the git hook to do it automatically.
diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md
index cb8f01f78..8602de56d 100644
--- a/ARCHITECTURE.md
+++ b/ARCHITECTURE.md
@@ -178,7 +178,7 @@ VS Code plugin
178 178
179To try out VS Code extensions, run `cargo install-code`. This installs both the 179To try out VS Code extensions, run `cargo install-code`. This installs both the
180`ra_lsp_server` binary and the VS Code extension. To install only the binary, use 180`ra_lsp_server` binary and the VS Code extension. To install only the binary, use
181`cargo install --path crates/ra_lsp_server --force` 181`cargo install-lsp` (shorthand for `cargo install --path crates/ra_lsp_server --force`)
182 182
183To see logs from the language server, set `RUST_LOG=info` env variable. To see 183To see logs from the language server, set `RUST_LOG=info` env variable. To see
184all communication between the server and the client, use 184all communication between the server and the client, use
@@ -186,12 +186,12 @@ all communication between the server and the client, use
186 186
187There's `rust-analyzer: status` command which prints common high-level debug 187There's `rust-analyzer: status` command which prints common high-level debug
188info. In particular, it prints info about memory usage of various data 188info. In particular, it prints info about memory usage of various data
189structures, and, if compiled with jemalloc support (`cargo install --features 189structures, and, if compiled with jemalloc support (`cargo jinstall-lsp` or
190jemalloc`), the summary statistic about the heap. 190`cargo install --path crates/ra_lsp_server --force --features jemalloc`), includes
191 statistic about the heap.
191 192
192To run tests, just `cargo test`. 193To run tests, just `cargo test`.
193 194
194To work on the VS Code extension, launch code inside `editors/code` and use `F5` to 195To work on the VS Code extension, launch code inside `editors/code` and use `F5` to
195launch/debug. To automatically apply formatter and linter suggestions, use `npm 196launch/debug. To automatically apply formatter and linter suggestions, use `npm
196run fix`. 197run fix`.
197