Skip to content

Commit

Permalink
Add configuration documentation to README
Browse files Browse the repository at this point in the history
  • Loading branch information
sim642 committed Nov 23, 2024
1 parent f43f5cb commit 97ab409
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,22 @@ This requires VSCode OCaml Platform 1.13 or newer.

> PS. Since the integration into VSCode OCaml Platform, the old "Ocamlearlybird" VSCode extension is deprecated.
## Configuration

| Field | Type | Default value | Description |
| ----- | ---- | ------- | ----------- |
| `program` | `string` | _(required)_ | The path of debuggee program. |
| `arguments` | `string[]` | `[]` | The command-line arguments for the debuggee program. |
| `cwd` | `string` | | The working directory for debuggee program. |
| `env` | `{[var: string]: string}` | `{}` | Environment variables passed to the debuggee program. |
| `stopOnEntry` | `boolean` | `false` | Automatically stop after launch. |
| `console` | `'internalConsole' \|`<br>`'integratedTerminal' \|`<br>` 'externalTerminal'` | `internalConsole` | Where to launch the debug target: internal console, integrated terminal, or external terminal. |
| `followForkMode` | `'forkChild' \| 'forkParent'` | `forkParent` | Set which process the debugger follows on fork. |
| `source_dirs` | `string[]` | `[]` | The path to search sources. |
| `onlyDebugGlob` | `string` | `true` | Only debug sources which match `onlyDebugGlob`. |
| `yieldSteps` | `number` | `4096` | Max steps to execute in batch. Debugger can not response other requests when executing steps in batch. |
| `_debugLog` | `string` | | File to Log debug messages. |

## Troubleshooting

### Breakpoints not hit with `(lang dune 3.0)` and above
Expand Down

0 comments on commit 97ab409

Please sign in to comment.