Skip to content

Commit 61689b8

Browse files
Automated documentation update [skip ci] (#111)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 63d9305 commit 61689b8

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

src/lang-rust/README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,50 @@ Work efficiently and effortlessly with Rust
2424

2525
- `rust-lang.rust-analyzer`
2626
- `tamasfe.even-better-toml`
27-
- `vadimcn.vscode-lldb@1.11.7`
27+
- `vadimcn.vscode-lldb@1.11.8`
2828

29+
## Notes
30+
31+
### Extensions
32+
33+
| Areas | Extension |
34+
| :-------------------- | :-------- |
35+
| Rust Language Server | [`rust-lang.rust-analyzer`](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) |
36+
| TOML Language Support | [`tamasfe.even-better-toml`](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml) |
37+
| Debugger | [`vadimcn.vscode-lldb`](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) |
38+
39+
### Debugger
40+
41+
`rust-analyzer` is configured to use `vadimcn.vscode-lldb` as its debugger.
42+
43+
#### Pretty Printing
44+
45+
To enable pretty printing in the debugger, add the setting
46+
47+
```jsonc
48+
"lldb.launch.preRunCommands": [
49+
"command script import ${containerEnv:DEV_CONTAINER_FEATURE_GHCR_IO_GEORGLAUTERBACH_LANG_RUST_LLDB_PRETTIFIER}"
50+
]
51+
```
52+
53+
to the `devcontainer.json`'s IDE-specific settings (example shown is for VS Code). The symbol definitions are copied from [`cmrschwarz/rust-prettifier-for-lldb`](https://github.com/cmrschwarz/rust-prettifier-for-lldb).
54+
55+
### Using a Subdirectory for Your Rust Code
56+
57+
If your code lives in a separate directory that is not the repository root, set
58+
59+
```jsonc
60+
"lldb.launch.cwd": "${containerWorkspaceFolder}/<SUBDIRECTORY OF YOUR CODE>",
61+
"lldb.launch.relativePathBase": "${containerWorkspaceFolder}/<SUBDIRECTORY OF YOUR CODE>"
62+
```
63+
64+
You should also create a symbolic link for a potential `rust-toolchain.toml` file via
65+
66+
```bash
67+
ln -s "<SUBDIRECTORY OF YOUR CODE>/rust-toolchain.toml" 'rust-toolchain.toml'
68+
```
69+
70+
This is currently required for the [`rust-lang.rust-analyzer`](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) extension to work properly.
2971

3072

3173
---

0 commit comments

Comments
 (0)