package.json: update debug configuration
Remove `remote` mode and `remotePath` from the launch properties.
Deprecate `remotePath` in favor of substitutePath.
Change-Id: I750b2283a32e61a316ee358a1cfcd38e32262e74
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/328491
Trust: Hyang-Ah Hana Kim <hyangah@gmail.com>
Trust: Suzy Mueller <suzmue@golang.org>
Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com>
TryBot-Result: kokoro <noreply+kokoro@google.com>
Reviewed-by: Suzy Mueller <suzmue@golang.org>
diff --git a/docs/settings.md b/docs/settings.md
index bfbcf57..0922d7a 100644
--- a/docs/settings.md
+++ b/docs/settings.md
@@ -146,7 +146,7 @@
| `debugAdapter` | Select which debug adapter to use by default. This is also used for choosing which debug adapter to use when no launch.json is present and with codelenses. <br/> Allowed Options: `legacy`, `dlv-dap` <br/> Default: `"legacy"` |
| `dlvLoadConfig` | LoadConfig describes to delve, how to load values from target's memory. Ignored by 'dlv-dap'. <br/> Default: ``` { <pre>"followPointers" : true,<br/>"maxArrayValues" : 64,<br/>"maxStringLen" : 64,<br/>"maxStructFields" : -1,<br/>"maxVariableRecurse" : 1,</pre>} ``` |
| `showGlobalVariables` | Boolean value to indicate whether global package variables should be shown in the variables pane or not. <br/> Default: `false` |
-| `substitutePath` | An array of mappings from a local path to the remote path that is used by the debuggee. The debug adapter will replace the local path with the remote path in all of the calls. Overriden by remotePath. |
+| `substitutePath` | An array of mappings from a local path to the remote path that is used by the debuggee. The debug adapter will replace the local path with the remote path in all of the calls. Overriden by `remotePath` (in attach request). |
Default:
```
diff --git a/package.json b/package.json
index b6c0bd9..c25e862 100644
--- a/package.json
+++ b/package.json
@@ -537,23 +537,22 @@
"legacy",
"dlv-dap"
],
- "description": "Select which debug adapter to use with this launch configuration",
+ "description": "Select which debug adapter to use with this launch configuration.",
"default": "legacy"
},
"program": {
"type": "string",
- "description": "Path to the program folder (or any file within that folder) when in 'debug' or 'test' mode, and to the pre-built binary file to debug in 'exec' mode.",
+ "description": "Path to the program folder (or any go file within that folder) when in `debug` or `test` mode, and to the pre-built binary file to debug in `exec` mode. If it is not an absolute path, the extension interpretes it as a workspace relative path.",
"default": "${workspaceFolder}"
},
"mode": {
"enum": [
"auto",
"debug",
- "remote",
"test",
"exec"
],
- "description": "One of 'auto', 'debug', 'remote', 'test', 'exec'.",
+ "description": "One of `auto`, `debug`, `test`, `exec`. In `auto` mode, the extension will choose either `debug` or `test` depending on active editor window.",
"default": "auto"
},
"stopOnEntry": {
@@ -576,7 +575,7 @@
},
"cwd": {
"type": "string",
- "description": "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 it is omitted or empty.",
+ "description": "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.",
"default": ""
},
"env": {
@@ -591,17 +590,17 @@
"properties": {
"from": {
"type": "string",
- "description": "The absolute local path to be replaced when passing paths to the debugger",
+ "description": "The absolute local path to be replaced when passing paths to the debugger.",
"default": ""
},
"to": {
"type": "string",
- "description": "The absolute remote path to be replaced when passing paths back to the client",
+ "description": "The absolute remote path to be replaced when passing paths back to the client.",
"default": ""
}
}
},
- "description": "An array of mappings from a local path to the remote path that is used by the debuggee. The debug adapter will replace the local path with the remote path in all of the calls. Overriden by remotePath.",
+ "description": "An array of mappings from a local path (editor) to the remote path (debugee). This setting is useful when working in a file system with symbolic links, running remote debugging, or debugging an executable compiled externally. The debug adapter will replace the local path with the remote path in all of the calls.",
"default": []
},
"buildFlags": {
@@ -617,19 +616,14 @@
},
"default": []
},
- "remotePath": {
- "type": "string",
- "description": "Absolute path to the file being debugged on the remote machine in case of remote debugging. If specified, becomes the first entry in substitutePath.",
- "default": ""
- },
"port": {
"type": "number",
- "description": "The port that the delve debugger will be listening on.",
+ "description": "The port that the delve debugger will be listening on. In `dlv-dap` mode, the extension will look for a delve DAP server running on the specified host:port so users are responsible for starting the server.",
"default": 2345
},
"host": {
"type": "string",
- "description": "The host name of the machine the delve debugger will be listening on.",
+ "description": "The host name of the machine the delve debugger will be listening on. In `dlv-dap` mode, the extension will look for a delve DAP server running on the specified host:port so users are responsible for starting the server.",
"default": "127.0.0.1"
},
"trace": {
@@ -643,7 +637,7 @@
"error"
],
"default": "error",
- "description": "Various levels of the debug console & 'Go Debug' output channel. When using the `legacy` debug adapter, the logs will also be written to a file if it is set to a value other than `error`."
+ "description": "Various levels of logging shown in the debug console & 'Go Debug' output channel. When using the `legacy` debug adapter, the logs will also be written to a file if it is set to a value other than `error`."
},
"envFile": {
"type": [
@@ -663,11 +657,11 @@
"native",
"lldb"
],
- "description": "Backend used by delve. Only available in delve version 0.12.2 and above."
+ "description": "Backend used by delve. Maps to `dlv`'s `--backend` flag."
},
"output": {
"type": "string",
- "description": "Output path for the binary of delve",
+ "description": "Output path for the binary of the debugee.",
"default": "debug"
},
"logOutput": {
@@ -685,38 +679,38 @@
},
"logDest": {
"type": "string",
- "description": "dlv's `--log-dest` flag. See `dlv log` for details. Number argument is not allowed. Supported only on Linux and Mac OS in dlv-dap mode."
+ "description": "dlv's `--log-dest` flag. See `dlv log` for details. Number argument is not allowed. Supported only in `dlv-dap` mode, and on Linux and Mac OS."
},
"dlvLoadConfig": {
"type": "object",
"properties": {
"followPointers": {
"type": "boolean",
- "description": "FollowPointers requests pointers to be automatically dereferenced",
+ "description": "FollowPointers requests pointers to be automatically dereferenced.",
"default": true
},
"maxVariableRecurse": {
"type": "number",
- "description": "MaxVariableRecurse is how far to recurse when evaluating nested types",
+ "description": "MaxVariableRecurse is how far to recurse when evaluating nested types.",
"default": 1
},
"maxStringLen": {
"type": "number",
- "description": "MaxStringLen is the maximum number of bytes read from a string",
+ "description": "MaxStringLen is the maximum number of bytes read from a string.",
"default": 64
},
"maxArrayValues": {
"type": "number",
- "description": "MaxArrayValues is the maximum number of elements read from an array, a slice or a map",
+ "description": "MaxArrayValues is the maximum number of elements read from an array, a slice or a map.",
"default": 64
},
"maxStructFields": {
"type": "number",
- "description": "MaxStructFields is the maximum number of fields read from a struct, -1 will read all fields",
+ "description": "MaxStructFields is the maximum number of fields read from a struct, -1 will read all fields.",
"default": -1
}
},
- "description": "LoadConfig describes to delve, how to load values from target's memory. Ignored by 'dlv-dap'",
+ "description": "LoadConfig describes to delve, how to load values from target's memory. Not applicable when using `dlv-dap` mode.",
"default": {
"followPointers": true,
"maxVariableRecurse": 1,
@@ -731,12 +725,12 @@
1,
2
],
- "description": "Delve Api Version to use. Default value is 2. Maps to dlv's `--api-version` flag.",
+ "description": "Delve Api Version to use. Default value is 2. Maps to dlv's `--api-version` flag. Not applicable when using `dlv-dap` mode.",
"default": 2
},
"stackTraceDepth": {
"type": "number",
- "description": "Maximum depth of stack trace collected from Delve",
+ "description": "Maximum depth of stack trace collected from Delve.",
"default": 50
},
"showGlobalVariables": {
@@ -754,7 +748,7 @@
"legacy",
"dlv-dap"
],
- "description": "Select which debug adapter to use with this launch configuration",
+ "description": "Select which debug adapter to use with this launch configuration.",
"default": "legacy"
},
"processId": {
@@ -764,26 +758,25 @@
"${command:pickProcess}",
"${command:pickGoProcess}"
],
- "description": "Use process picker to select a process to attach, or Process ID as integer.",
- "default": "${command:pickProcess}"
+ "description": "Use process picker to select a process to attach, or Process ID as integer."
},
{
"type": "string",
- "description": "Attach to a process by name. If more than one process matches the name, use the process picker to select a aprocess.",
- "default": ""
+ "description": "Attach to a process by name. If more than one process matches the name, use the process picker to select a process."
},
{
"type": "number",
- "description": "The ID of the process to be debugged."
+ "description": "The numeric ID of the process to be debugged. If 0, use the process picker to select a process."
}
- ]
+ ],
+ "default": 0
},
"mode": {
"enum": [
"local",
"remote"
],
- "description": "Indicates local or remote debugging. Local maps to the dlv 'attach' command, remote maps to 'connect'.",
+ "description": "Indicates local or remote debugging. Local maps to the `dlv attach` command, remote maps to `connect`. `remote` is not supported in `dlv-dap` mode currently. Use `host` and `port` instead.",
"default": "local"
},
"stopOnEntry": {
@@ -811,17 +804,18 @@
},
"remotePath": {
"type": "string",
- "description": "If remote debugging, the path to the source code on the remote machine, if different from the local machine. If specified, becomes the first entry in substitutePath.",
+ "description": "The path to the source code on the remote machine, when the remote path is different from the local machine. If specified, becomes the first entry in substitutePath.",
+ "markdownDeprecationMessage": "Use `substitutePath` instead.",
"default": ""
},
"port": {
"type": "number",
- "description": "The port that the delve debugger will be listening on.",
+ "description": "The port that the delve debugger will be listening on. In `dlv-dap` mode, the extension will look for a delve DAP server running on the specified host:port so users are responsible for starting the server.",
"default": 2345
},
"host": {
"type": "string",
- "description": "The host name of the machine the delve debugger will be listening on.",
+ "description": "The host name of the machine the delve debugger will be listening on. In `dlv-dap` mode, the extension will look for a delve DAP server running on the specified host:port so users are responsible for starting the server.",
"default": "127.0.0.1"
},
"substitutePath": {
@@ -831,28 +825,31 @@
"properties": {
"from": {
"type": "string",
- "description": "The absolute local path to be replaced when passing paths to the debugger",
+ "description": "The absolute local path to be replaced when passing paths to the debugger.",
"default": ""
},
"to": {
"type": "string",
- "description": "The absolute remote path to be replaced when passing paths back to the client",
+ "description": "The absolute remote path to be replaced when passing paths back to the client.",
"default": ""
}
}
},
- "description": "An array of mappings from a local path to the remote path that is used by the debuggee. The debug adapter will replace the local path with the remote path in all of the calls.",
+ "description": "An array of mappings from a local path (editor) to the remote path (debugee). This setting is useful when working in a file system with symbolic links, running remote debugging, or debugging an executable compiled externally. The debug adapter will replace the local path with the remote path in all of the calls. Overriden by `remotePath`.",
"default": []
},
"trace": {
"type": "string",
"enum": [
- "log",
"verbose",
+ "trace",
+ "log",
+ "info",
+ "warn",
"error"
],
"default": "error",
- "description": "Various levels of logging shown in the debug console. When set to 'log' or 'verbose', the logs will also be written to a file."
+ "description": "Various levels of logging shown in the debug console & 'Go Debug' output channel. When using the `legacy` debug adapter, the logs will also be written to a file if it is set to a value other than `error`."
},
"backend": {
"type": "string",
@@ -861,7 +858,7 @@
"native",
"lldb"
],
- "description": "Backend used by delve. Only available in delve version 0.12.2 and above. Maps to dlv's `--backend` flag."
+ "description": "Backend used by delve. Maps to `dlv`'s `--backend` flag."
},
"logOutput": {
"type": "string",
@@ -878,7 +875,7 @@
},
"logDest": {
"type": "string",
- "description": "dlv's `--log-dest` flag. See `dlv log` for details. Number argument is not allowed. Supported only on Linux and Mac OS in dlv-dap mode."
+ "description": "dlv's `--log-dest` flag. See `dlv log` for details. Number argument is not allowed. Supported only in `dlv-dap` mode and on Linux and Mac OS."
},
"dlvLoadConfig": {
"type": "object",
@@ -909,7 +906,7 @@
"default": -1
}
},
- "description": "LoadConfig describes to delve, how to load values from target's memory. Ignored by 'dlv-dap'.",
+ "description": "LoadConfig describes to delve, how to load values from target's memory. Not applicable when using `dlv-dap` mode.",
"default": {
"followPointers": true,
"maxVariableRecurse": 1,
@@ -924,12 +921,12 @@
1,
2
],
- "description": "Delve Api Version to use. Default value is 2.",
+ "description": "Delve Api Version to use. Default value is 2. Not applicable when using `dlv-dap` mode.",
"default": 2
},
"stackTraceDepth": {
"type": "number",
- "description": "Maximum depth of stack trace collected from Delve",
+ "description": "Maximum depth of stack trace collected from Delve.",
"default": 50
},
"showGlobalVariables": {
@@ -1768,7 +1765,7 @@
}
}
},
- "description": "An array of mappings from a local path to the remote path that is used by the debuggee. The debug adapter will replace the local path with the remote path in all of the calls. Overriden by remotePath.",
+ "description": "An array of mappings from a local path to the remote path that is used by the debuggee. The debug adapter will replace the local path with the remote path in all of the calls. Overriden by `remotePath` (in attach request).",
"default": []
}
},
