Skip to content

Commit bf0df0b

Browse files
committed
Add documentation into lldb/tools/lldb-dap/README.md
1 parent c2862d6 commit bf0df0b

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

lldb/tools/lldb-dap/README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -275,9 +275,9 @@ User settings can set the default value for the following supported
275275
| **exitCommands** | [string] | `[]` |
276276
| **terminateCommands** | [string] | `[]` |
277277

278-
To adjust your settings, open the Settings editor via the
279-
`File > Preferences > Settings` menu or press `Ctrl+`, on Windows/Linux and
280-
`Cmd+`, on Mac.
278+
To adjust your settings, open the Settings editor
279+
via the `File > Preferences > Settings` menu or press `Ctrl+,` on Windows/Linux,
280+
and the `VS Code > Settings... > Settings` menu or press `Cmd+,` on Mac.
281281

282282
## Debug Console
283283

@@ -372,6 +372,19 @@ for more details on Debug Adapter Protocol events and the VS Code
372372
[debug.onDidReceiveDebugSessionCustomEvent](https://code.visualstudio.com/api/references/vscode-api#debug.onDidReceiveDebugSessionCustomEvent)
373373
API for handling a custom event from an extension.
374374

375+
## Server Mode
376+
377+
lldb-dap supports a server mode that can be enabled via the following user settings.
378+
379+
| Setting | Type | Default | |
380+
| -------------------------- | -------- | :-----: | --------- |
381+
| **Server Mode** | string | `False` | Run lldb-dap in server mode. When enabled, lldb-dap will start a background server that will be reused between debug sessions. This allows caching of debug symbols between sessions and improves launch performance.
382+
| **Connection Timeout** | number | `0` | When running lldb-dap in server mode, the time in seconds to wait for new connections after the server has started and after all clients have disconnected. Each new connection will reset the timeout. When the timeout is reached, the server will be closed and the process will exit. Specifying non-positive values will cause the server to wait for new connections indefinitely.
383+
384+
To adjust your settings, open the Settings editor
385+
via the `File > Preferences > Settings` menu or press `Ctrl+,` on Windows/Linux,
386+
and the `VS Code > Settings... > Settings` menu or press `Cmd+,` on Mac.
387+
375388
## Contributing
376389

377390
`lldb-dap` and `lldb` are developed under the umbrella of the [LLVM project](https://llvm.org/).

0 commit comments

Comments
 (0)