From aadab96c9d68938bdb90688af02b675dbbb7742d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lauren=C8=9Biu=20Nicola?= Date: Mon, 17 Feb 2020 22:05:48 +0200 Subject: [PATCH 1/2] Fix RA_PROFILE typo in docs --- docs/dev/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dev/README.md b/docs/dev/README.md index 991deaf902..c834a3ff88 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md @@ -157,7 +157,7 @@ There's also two VS Code commands which might be of interest: # Profiling -We have a built-in hierarchical profiler, you can enable it by using `RA_PROF` env-var: +We have a built-in hierarchical profiler, you can enable it by using `RA_PROFILE` env-var: ``` RA_PROFILE=* // dump everything @@ -165,7 +165,7 @@ RA_PROFILE=foo|bar|baz // enabled only selected entries RA_PROFILE=*@3>10 // dump everything, up to depth 3, if it takes more than 10 ms ``` -In particular, I have `export RA_PROFILE='*>10' in my shell profile. +In particular, I have `export RA_PROFILE='*>10'` in my shell profile. To measure time for from-scratch analysis, use something like this: From b6b8fd9525099a54fa2065d55609808636bb5673 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lauren=C8=9Biu=20Nicola?= Date: Mon, 17 Feb 2020 22:07:24 +0200 Subject: [PATCH 2/2] Replace ra_cli mentions --- crates/ra_lsp_server/src/args.rs | 14 +++++++------- crates/ra_prof/src/lib.rs | 4 ++-- docs/dev/README.md | 8 ++++---- docs/dev/architecture.md | 4 ---- 4 files changed, 13 insertions(+), 17 deletions(-) diff --git a/crates/ra_lsp_server/src/args.rs b/crates/ra_lsp_server/src/args.rs index 89e2139cec..3890fe13a3 100644 --- a/crates/ra_lsp_server/src/args.rs +++ b/crates/ra_lsp_server/src/args.rs @@ -74,7 +74,7 @@ impl Args { ra-cli-parse USAGE: - ra_cli parse [FLAGS] + ra_lsp_server parse [FLAGS] FLAGS: -h, --help Prints help inforamtion @@ -94,7 +94,7 @@ FLAGS: ra-cli-symbols USAGE: - ra_cli highlight [FLAGS] + ra_lsp_server highlight [FLAGS] FLAGS: -h, --help Prints help inforamtion" @@ -113,7 +113,7 @@ FLAGS: ra-cli-highlight USAGE: - ra_cli highlight [FLAGS] + ra_lsp_server highlight [FLAGS] FLAGS: -h, --help Prints help information @@ -133,7 +133,7 @@ FLAGS: ra-cli-analysis-stats USAGE: - ra_cli analysis-stats [FLAGS] [OPTIONS] [PATH] + ra_lsp_server analysis-stats [FLAGS] [OPTIONS] [PATH] FLAGS: -h, --help Prints help information @@ -168,10 +168,10 @@ ARGS: if matches.contains(["-h", "--help"]) { eprintln!( "\ -ra_cli-analysis-bench +ra_lsp_server-analysis-bench USAGE: - ra_cli analysis-bench [FLAGS] [OPTIONS] [PATH] + ra_lsp_server analysis-bench [FLAGS] [OPTIONS] [PATH] FLAGS: -h, --help Prints help information @@ -207,7 +207,7 @@ ARGS: ra-cli USAGE: - ra_cli + ra_lsp_server FLAGS: -h, --help Prints help information diff --git a/crates/ra_prof/src/lib.rs b/crates/ra_prof/src/lib.rs index c0bfbc2ee1..7ff8db58a8 100644 --- a/crates/ra_prof/src/lib.rs +++ b/crates/ra_prof/src/lib.rs @@ -351,13 +351,13 @@ impl Drop for Scope { /// 2. Build with `cpu_profiler` feature. /// 3. Tun the code, the *raw* output would be in the `./out.profile` file. /// 4. Install pprof for visualization (https://github.com/google/pprof). -/// 5. Use something like `pprof -svg target/release/ra_cli ./out.profile` to see the results. +/// 5. Use something like `pprof -svg target/release/ra_lsp_server ./out.profile` to see the results. /// /// For example, here's how I run profiling on NixOS: /// /// ```bash /// $ nix-shell -p gperftools --run \ -/// 'cargo run --release -p ra_cli -- parse < ~/projects/rustbench/parser.rs > /dev/null' +/// 'cargo run --release -p ra_lsp_server -- parse < ~/projects/rustbench/parser.rs > /dev/null' /// ``` #[derive(Debug)] pub struct CpuProfiler { diff --git a/docs/dev/README.md b/docs/dev/README.md index c834a3ff88..ba24524f23 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md @@ -113,7 +113,7 @@ communication, and `print!` would break it. If I need to fix something simultaneously in the server and in the client, I feel even more sad. I don't have a specific workflow for this case. -Additionally, I use `cargo run --release -p ra_cli -- analysis-stats +Additionally, I use `cargo run --release -p ra_lsp_server -- analysis-stats path/to/some/rust/crate` to run a batch analysis. This is primarily useful for performance optimizations, or for bug minimization. @@ -170,12 +170,12 @@ In particular, I have `export RA_PROFILE='*>10'` in my shell profile. To measure time for from-scratch analysis, use something like this: ``` -$ cargo run --release -p ra_cli -- analysis-stats ../chalk/ +$ cargo run --release -p ra_lsp_server -- analysis-stats ../chalk/ ``` For measuring time of incremental analysis, use either of these: ``` -$ cargo run --release -p ra_cli -- analysis-bench ../chalk/ --highlight ../chalk/chalk-engine/src/logic.rs -$ cargo run --release -p ra_cli -- analysis-bench ../chalk/ --complete ../chalk/chalk-engine/src/logic.rs:94:0 +$ cargo run --release -p ra_lsp_server -- analysis-bench ../chalk/ --highlight ../chalk/chalk-engine/src/logic.rs +$ cargo run --release -p ra_lsp_server -- analysis-bench ../chalk/ --complete ../chalk/chalk-engine/src/logic.rs:94:0 ``` diff --git a/docs/dev/architecture.md b/docs/dev/architecture.md index 9675ed0b6e..41c3909f7d 100644 --- a/docs/dev/architecture.md +++ b/docs/dev/architecture.md @@ -147,10 +147,6 @@ different from data on disk. This is more or less the single really platform-dependent component, so it lives in a separate repository and has an extensive cross-platform CI testing. -### `crates/ra_cli` - -A CLI interface to rust-analyzer, mainly for testing. - ## Testing Infrastructure Rust Analyzer has three interesting [systems