cmd: update dlv dap --help (#2299)

Co-authored-by: Polina Sokolova <polinasok@users.noreply.github.com>
This commit is contained in:
polinasok 2021-01-13 04:10:15 -08:00 committed by GitHub
parent a224f17374
commit 1b2357092c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 14 deletions

@ -7,12 +7,16 @@
[EXPERIMENTAL] Starts a TCP server communicating via Debug Adaptor Protocol (DAP).
The server supports debugging of a precompiled binary akin to 'dlv exec' via a launch request.
It does not yet support support specification of program arguments.
It does not yet support launch requests with 'debug' and 'test' modes that require compilation.
It does not yet support attach requests to debug a running process like with 'dlv attach'.
It does not yet support asynchronous request-response communication.
The server does not accept multiple client connections.
The server is headless and requires a DAP client like vscode to connect and request a binary
to be launched or process to be attached to. The following modes are supported:
- launch + exec (executes precompiled binary, like 'dlv exec')
- launch + debug (builds and launches, like 'dlv debug')
- launch + test (builds and tests, like 'dlv test')
- attach + local (attaches to a running process, like 'dlv attach')
The server does not yet support asynchronous request-response communication, so features
like pausing or setting breakpoints while the program is running are not yet available.
The server does not accept multiple client connections (--accept-multiclient),
a feature that is often relied on to enable --continue with remote debugging.
```
dlv dap

@ -177,12 +177,16 @@ option to let the process continue or kill it.
Short: "[EXPERIMENTAL] Starts a TCP server communicating via Debug Adaptor Protocol (DAP).",
Long: `[EXPERIMENTAL] Starts a TCP server communicating via Debug Adaptor Protocol (DAP).
The server supports debugging of a precompiled binary akin to 'dlv exec' via a launch request.
It does not yet support support specification of program arguments.
It does not yet support launch requests with 'debug' and 'test' modes that require compilation.
It does not yet support attach requests to debug a running process like with 'dlv attach'.
It does not yet support asynchronous request-response communication.
The server does not accept multiple client connections.`,
The server is headless and requires a DAP client like vscode to connect and request a binary
to be launched or process to be attached to. The following modes are supported:
- launch + exec (executes precompiled binary, like 'dlv exec')
- launch + debug (builds and launches, like 'dlv debug')
- launch + test (builds and tests, like 'dlv test')
- attach + local (attaches to a running process, like 'dlv attach')
The server does not yet support asynchronous request-response communication, so features
like pausing or setting breakpoints while the program is running are not yet available.
The server does not accept multiple client connections (--accept-multiclient),
a feature that is often relied on to enable --continue with remote debugging.`,
Run: dapCmd,
}
rootCommand.AddCommand(dapCommand)
@ -403,10 +407,10 @@ func dapCmd(cmd *cobra.Command, args []string) {
defer logflags.Close()
if headless {
fmt.Fprintf(os.Stderr, "Warning: headless mode not supported with dap\n")
fmt.Fprintf(os.Stderr, "Warning: dap mode is always headless\n")
}
if acceptMulti {
fmt.Fprintf(os.Stderr, "Warning: accept multiclient mode not supported with dap\n")
fmt.Fprintf(os.Stderr, "Warning: accept-multiclient mode not supported with dap\n")
}
if initFile != "" {
fmt.Fprint(os.Stderr, "Warning: init file ignored with dap\n")