Skip to content

Commit 7345025

Browse files
santhoshe447Santhosh Kumar EllendulaSanthosh Kumar Ellendula
authored
[lldb-dap] Updated README.md for newly added attach properties. (#99926)
Added "gdb-remote-port" and "gdb-remote-hostname" attach properties usage in README.md and updated package.json version to 0.2.3 This was missed in PR #91570 --------- Co-authored-by: Santhosh Kumar Ellendula <[email protected]> Co-authored-by: Santhosh Kumar Ellendula <[email protected]>
1 parent f083764 commit 7345025

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

lldb/tools/lldb-dap/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,20 @@ locally on port `2345`.
157157
}
158158
```
159159

160+
You can also use the `gdb-remote-port` parameter to send an attach request
161+
to a debug server running on the current machine,
162+
instead of using the custom command `attachCommands`.
163+
164+
```javascript
165+
{
166+
"name": "Local Debug Server",
167+
"type": "lldb-dap",
168+
"request": "attach",
169+
"program": "/tmp/a.out",
170+
"gdb-remote-port": 2345,
171+
}
172+
```
173+
160174
#### Connect to a Debug Server on Another Machine
161175

162176
This connects to a debug server running on another machine with hostname
@@ -173,6 +187,23 @@ port `5678` of that other machine.
173187
}
174188
```
175189

190+
You can also use the `gdb-remote-hostname` and `gdb-remote-port` parameters
191+
to send an attach request to a debug server running on a different machine,
192+
instead of custom command `attachCommands`.
193+
The default hostname being used `localhost`.
194+
195+
196+
```javascript
197+
{
198+
"name": "Local Debug Server",
199+
"type": "lldb-dap",
200+
"request": "attach",
201+
"program": "/tmp/a.out",
202+
"gdb-remote-port": 5678,
203+
"gdb-remote-hostname": "hostname",
204+
}
205+
```
206+
176207
## Custom debugger commands
177208

178209
The `lldb-dap` tool includes additional custom commands to support the Debug

lldb/tools/lldb-dap/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "lldb-dap",
33
"displayName": "LLDB DAP",
4-
"version": "0.2.2",
4+
"version": "0.2.3",
55
"publisher": "llvm-vs-code-extensions",
66
"homepage": "https://lldb.llvm.org",
77
"description": "LLDB debugging from VSCode",
@@ -353,7 +353,7 @@
353353
"number",
354354
"string"
355355
],
356-
"description": "TCP/IP port to attach to. Specifying both pid and port is an error."
356+
"description": "TCP/IP port to attach to a remote system. Specifying both pid and port is an error."
357357
},
358358
"gdb-remote-hostname": {
359359
"type": "string",

0 commit comments

Comments
 (0)