diff options
| author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2020-05-20 20:04:02 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2020-05-20 20:04:02 +0100 |
| commit | 3dfc461f1e44ee7cebee672cac02d56ba5523f67 (patch) | |
| tree | 1a2d882cfc31196a4c9f261c725e58c49da27452 /docs | |
| parent | 2711454e40c8e6ade56f7cf071e0bb0029d96171 (diff) | |
| parent | d58d6412d837a9f6475e04c74709d78f52c9ff6a (diff) | |
Merge #4536
4536: Fix names of launch configuration in dev docs r=kjeremy a=kuy
Follows renaming of launch configurations in https://github.com/rust-analyzer/rust-analyzer/commit/80a42a0628f7655c3299fbf4c5a15e31990b35d3
Co-authored-by: Yuki Kodama <[email protected]>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/README.md | 4 | ||||
| -rw-r--r-- | docs/dev/debugging.md | 6 |
2 files changed, 5 insertions, 5 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index a20ead0b6..65cc9fc12 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
| @@ -74,7 +74,7 @@ relevant test and execute it (VS Code includes an action for running a single | |||
| 74 | test). | 74 | test). |
| 75 | 75 | ||
| 76 | However, launching a VS Code instance with locally build language server is | 76 | However, launching a VS Code instance with locally build language server is |
| 77 | possible. There's **"Run Extension (Dev Server)"** launch configuration for this. | 77 | possible. There's **"Run Extension (Debug Build)"** launch configuration for this. |
| 78 | 78 | ||
| 79 | In general, I use one of the following workflows for fixing bugs and | 79 | In general, I use one of the following workflows for fixing bugs and |
| 80 | implementing features. | 80 | implementing features. |
| @@ -86,7 +86,7 @@ then just do printf-driven development/debugging. As a sanity check after I'm | |||
| 86 | done, I use `cargo xtask install --server` and **Reload Window** action in VS | 86 | done, I use `cargo xtask install --server` and **Reload Window** action in VS |
| 87 | Code to sanity check that the thing works as I expect. | 87 | Code to sanity check that the thing works as I expect. |
| 88 | 88 | ||
| 89 | If the problem concerns only the VS Code extension, I use **Run Extension** | 89 | If the problem concerns only the VS Code extension, I use **Run Installed Extension** |
| 90 | launch configuration from `launch.json`. Notably, this uses the usual | 90 | launch configuration from `launch.json`. Notably, this uses the usual |
| 91 | `rust-analyzer` binary from `PATH`. For this it is important to have the following | 91 | `rust-analyzer` binary from `PATH`. For this it is important to have the following |
| 92 | in `setting.json` file: | 92 | in `setting.json` file: |
diff --git a/docs/dev/debugging.md b/docs/dev/debugging.md index 1aa392935..59a83f7d7 100644 --- a/docs/dev/debugging.md +++ b/docs/dev/debugging.md | |||
| @@ -22,8 +22,8 @@ where **only** the `rust-analyzer` extension being debugged is enabled. | |||
| 22 | 22 | ||
| 23 | ## Debug TypeScript VSCode extension | 23 | ## Debug TypeScript VSCode extension |
| 24 | 24 | ||
| 25 | - `Run Extension` - runs the extension with the globally installed `rust-analyzer` binary. | 25 | - `Run Installed Extension` - runs the extension with the globally installed `rust-analyzer` binary. |
| 26 | - `Run Extension (Dev Server)` - runs extension with the locally built LSP server (`target/debug/rust-analyzer`). | 26 | - `Run Extension (Debug Build)` - runs extension with the locally built LSP server (`target/debug/rust-analyzer`). |
| 27 | 27 | ||
| 28 | TypeScript debugging is configured to watch your source edits and recompile. | 28 | TypeScript debugging is configured to watch your source edits and recompile. |
| 29 | To apply changes to an already running debug process, press <kbd>Ctrl+Shift+P</kbd> and run the following command in your `[Extension Development Host]` | 29 | To apply changes to an already running debug process, press <kbd>Ctrl+Shift+P</kbd> and run the following command in your `[Extension Development Host]` |
| @@ -47,7 +47,7 @@ To apply changes to an already running debug process, press <kbd>Ctrl+Shift+P</k | |||
| 47 | debug = 2 | 47 | debug = 2 |
| 48 | ``` | 48 | ``` |
| 49 | 49 | ||
| 50 | - Select `Run Extension (Dev Server)` to run your locally built `target/debug/rust-analyzer`. | 50 | - Select `Run Extension (Debug Build)` to run your locally built `target/debug/rust-analyzer`. |
| 51 | 51 | ||
| 52 | - In the original VSCode window once again select the `Attach To Server` debug configuration. | 52 | - In the original VSCode window once again select the `Attach To Server` debug configuration. |
| 53 | 53 | ||