Skip to content

Commit 657f646

Browse files
committed
Add debuginfod launch option documentation for C/C++ debugging
Document the new `debuginfod` configuration option in launch.json that controls GDB's debuginfod behavior. This option was added to MIEngine to prevent GDB hangs when debuginfod servers are unreachable
1 parent 781be72 commit 657f646

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

docs/cpp/launch-json-reference.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,25 @@ For information about attaching to a remote process, such as debugging a process
232232

233233
If provided, this explicitly controls hardware breakpoint behavior for remote targets. If `require` is set to true, always use hardware breakpoints. Default value is `false`. `limit` is an optional limit on the number of available hardware breakpoints to use which is only enforced when `require` is true and `limit` is greater than 0. Defaults value is 0. Example: ```"hardwareBreakpoints": { require: true, limit: 6 }```.
234234

235+
### debuginfod
236+
237+
Controls GDB's [debuginfod](https://sourceware.org/elfutils/Debuginfod.html) behavior for downloading debug symbols from debuginfod servers. This is useful on Linux systems where debuginfod is configured (such as Ubuntu, Fedora, or Arch Linux).
238+
239+
- **enabled**: If `true` (default), GDB's debuginfod support is enabled, allowing it to download debug symbols automatically. Set to `false` to prevent GDB from contacting debuginfod servers, which can be useful if the debuginfod server is unreachable and causing GDB to hang on launch.
240+
- **timeout**: The timeout in seconds for debuginfod server requests. Default is `30`. Set to `0` to use GDB/libdebuginfod defaults with no override.
241+
242+
**Example:**
243+
244+
```json
245+
{
246+
...
247+
"debuginfod": {
248+
"enabled": true,
249+
"timeout": 10
250+
}
251+
}
252+
```
253+
235254
## Additional properties
236255

237256
### processId

0 commit comments

Comments
 (0)