[lldb-dap] Document stopOnEntry when attaching. (#172927)

We have always supported it but it was undocumented. It shows a warning
unknown key when added in vscode attach configuration.
This commit is contained in:
Ebuka Ezike 2025-12-19 11:16:51 +00:00 committed by GitHub
parent 556eb902ce
commit d07f237cde
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 0 deletions

View File

@ -276,6 +276,7 @@ the following `lldb-dap` specific key/value pairs:
| **program** | string | | Path to the executable to attach to. This value is optional but can help to resolve breakpoints prior the attaching to the program.
| **pid** | number | | The process id of the process you wish to attach to. If **pid** is omitted, the debugger will attempt to attach to the program by finding a process whose file name matches the file name from **program**. Setting this value to `${command:pickMyProcess}` will allow interactive process selection in the IDE.
| **waitFor** | boolean | | Wait for the process to launch.
| **stopOnEntry** | boolean | | Whether to stop program immediately after attaching.
| **attachCommands** | [string] | | LLDB commands that will be executed after **preRunCommands** which take place of the code that normally does the attach. The commands can create a new target and attach or launch it however desired. This allows custom launch and attach configurations. Core files can use `target create --core /path/to/core` to attach to core files.
### Configuring `lldb-dap` defaults

View File

@ -727,6 +727,11 @@
"description": "If set to true, then wait for the process to launch by looking for a process with a basename that matches `program`. No process ID needs to be specified when using this flag.",
"default": true
},
"stopOnEntry": {
"type": "boolean",
"description": "Automatically stop after attach.",
"default": false
},
"sourcePath": {
"type": "string",
"description": "Specify a source path to remap \"./\" to allow full paths to be used when setting breakpoints in binaries that have relative source paths."