Skip to content

Commit

Permalink
package.json: add description of 'console' and 'asRoot'
Browse files Browse the repository at this point in the history
Currently we still clarify that they are "experimental".

Updates #124
Updates #558

Change-Id: I32af4fa0e3cfc73c80bdcdbd22db51c31ccce77c
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/374134
Trust: Hyang-Ah Hana Kim <hyangah@gmail.com>
Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com>
Reviewed-by: Suzy Mueller <suzmue@golang.org>
  • Loading branch information
hyangah committed Jan 5, 2022
1 parent 8d2a31f commit 1fa51bc
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,10 @@ Here is the list of attributes specific to Go debugging.
| Property | Launch | Attach |
| --- | --- | --- |
| `args` | Command line arguments passed to the debugged program.<br/> | <center>_n/a_</center> |
| `asRoot` | (Experimental) Debug with elevated permissions (on Unix). It requires `integrated` or `external` console modes and is ignored in remote debugging.<br/>(Default: `false`)<br/> | (Experimental) Debug with elevated permissions (on Unix). This requires `integrated` or `external` console modes and is ignored in remote debugging.<br/>(Default: `false`)<br/> |
| `backend` | Backend used by delve. Maps to `dlv`'s `--backend` flag.<br/><p>Allowed Values: `"default"`, `"native"`, `"lldb"`, `"rr"`<br/> | <center>_same as Launch_</center>|
| `buildFlags` | Build flags, to be passed to the Go compiler. Maps to dlv's `--build-flags` flag.<br/>(Default: `""`)<br/> | <center>_n/a_</center> |
| `console` | (Experimental) Where to launch the debugger and the debug target: internal console, integrated terminal, or external terminal. It is ignored in remote debugging.<br/><p>Allowed Values: `"internal"`, `"integrated"`, `"external"`<br/>(Default: `internal`)<br/> | (Experimental) Where to launch the debugger: internal console, integrated terminal, or external terminal. This does not affect tty of the running program. It is ignored in remote debugging.<br/><p>Allowed Values: `"internal"`, `"integrated"`, `"external"`<br/>(Default: `internal`)<br/> |
| `coreFilePath` | Path to the core dump file to open. For use on 'core' mode only<br/>(Default: `""`)<br/> | <center>_n/a_</center> |
| `cwd` | Workspace relative or absolute path to the working directory of the program being debugged if a non-empty value is specified. The `program` folder is used as the working directory if `cwd` is omitted or empty.<br/>(Default: `""`)<br/> | Workspace relative or absolute path to the working directory of the program being debugged. Default is the current workspace.<br/>(Default: `"${workspaceFolder}"`)<br/> |
| `debugAdapter` | Select which debug adapter to use with this launch configuration.<br/><p>Allowed Values: `"legacy"`, `"dlv-dap"`<br/>(Default: `dlv-dap`)<br/> | <center>_same as Launch_</center>|
Expand Down
28 changes: 28 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -787,6 +787,20 @@
"type": "boolean",
"default": false,
"description": "Boolean value to indicate whether system goroutines should be hidden from call stack view."
},
"console": {
"default": "internal",
"description": "(Experimental) Where to launch the debugger and the debug target: internal console, integrated terminal, or external terminal. It is ignored in remote debugging.",
"enum": [
"internal",
"integrated",
"external"
]
},
"asRoot": {
"default": false,
"description": "(Experimental) Debug with elevated permissions (on Unix). It requires `integrated` or `external` console modes and is ignored in remote debugging.",
"type": "boolean"
}
}
},
Expand Down Expand Up @@ -994,6 +1008,20 @@
"type": "boolean",
"default": false,
"description": "Boolean value to indicate whether system goroutines should be hidden from call stack view."
},
"console": {
"default": "internal",
"description": "(Experimental) Where to launch the debugger: internal console, integrated terminal, or external terminal. This does not affect tty of the running program. It is ignored in remote debugging.",
"enum": [
"internal",
"integrated",
"external"
]
},
"asRoot": {
"default": false,
"description": "(Experimental) Debug with elevated permissions (on Unix). This requires `integrated` or `external` console modes and is ignored in remote debugging.",
"type": "boolean"
}
}
}
Expand Down

0 comments on commit 1fa51bc

Please sign in to comment.