Skip to content

Commit 69c7d4f

Browse files
Automated documentation update [skip ci] (#77)
1 parent 00d50c3 commit 69c7d4f

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

src/rust/README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,11 @@ Currently, this feature works on recent versions of Debian- and Ubuntu-based dis
8787
8888
#### rust-analyzer & CodeLLDB
8989
90-
This feature installs the excellent extensions [`rust-lang.rust-analyzer`](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) (language server) and [`vadimcn.vscode-lldb`](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) (native LLDB debugger). [Rust-analyzer](https://github.com/rust-lang/rust-analyzer) is, by default, configured to use [CodeLLDB](https://github.com/vadimcn/codelldb) as its debugger of choice.
90+
This feature installs the excellent extensions [`rust-lang.rust-analyzer`](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) (language server) and [`vadimcn.vscode-lldb`](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) (native LLDB debugger). [rust-analyzer](https://github.com/rust-lang/rust-analyzer) is, by default, configured to use [CodeLLDB](https://github.com/vadimcn/codelldb) as its debugger of choice.
9191
92-
Tp enable pretty symbols in the debugger, you want to add the setting
92+
##### Proper Symbols
93+
94+
To enable proper symbols in the debugger, add the setting
9395
9496
```jsonc
9597
"lldb.launch.preRunCommands": [
@@ -99,6 +101,23 @@ Tp enable pretty symbols in the debugger, you want to add the setting
99101
100102
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).
101103

104+
##### Using a Subdirectory
105+
106+
If your code lives in a separate directory that is not the repository root, set
107+
108+
```jsonc
109+
"lldb.launch.cwd": "${containerWorkspaceFolder}/<SUBDIRECTORY OF YOUR CODE>",
110+
"lldb.launch.relativePathBase": "${containerWorkspaceFolder}/<SUBDIRECTORY OF YOUR CODE>"
111+
```
112+
113+
You should also create a symbolic link for a potential `rust-toolchain.toml` file via
114+
115+
```bash
116+
ln -s "<SUBDIRECTORY OF YOUR CODE>/rust-toolchain.toml" 'rust-toolchain.toml'
117+
```
118+
119+
This is currently required for the [`rust-lang.rust-analyzer`](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) extension to work properly.
120+
102121
#### Niche Scenarios
103122

104123
In case

0 commit comments

Comments
 (0)