PenaDevops/delve
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
c3a4d726e2
delve/Documentation/usage/dlv_debug.md

47 lines
1.9 KiB
Markdown
Raw Normal View History

docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
## dlv debug
Add flag support documentation (#740)
2017-02-16 19:05:48 +00:00
Compile and begin debugging main package in current directory, or the package specified.
docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
### Synopsis
dlv/cmds: Improve subcommand help output
2016-05-20 17:51:23 +00:00
Compiles your program with optimizations disabled, starts and attaches to it.
By default, with no arguments, Delve will compile the 'main' package in the
current directory, and begin to debug it. Alternatively you can specify a
package name and Delve will compile that package instead, and begin a new debug
session.
docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
```
dlv debug [package]
```
Documentation: update usage docs (#1095)
2018-01-25 19:54:00 +00:00
### Options
```
cmd/dlv: add --continue to continue process on launch/attach (#1585) * Add --continue to continue process on launch/attach * Add small test of --continue * regenerate usage docs * minor cleanup * Use similar approach to `trace` and connect and detach using a client instance * back out previous attempt * regen usage doc * fix up continue test * fix TestContinue to properly test --continue * back out unnecessary changes * update faq
2019-07-19 17:59:38 +00:00
--continue Continue the debugged process on start.
cmd/dlv: Change name for binary dlv auto compiles Prevent conflicts by choosing a name that is extremely unlikely to conflict with any actual package a user may have in their code. Fixes #580
2019-05-31 17:26:19 +00:00
--output string Output path for the binary. (default "./__debug_bin")
Documentation: update usage docs (#1095)
2018-01-25 19:54:00 +00:00
```
docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
### Options inherited from parent commands
```
Documentation,cmd/dlv: tidy up --help output (#1649) * scripts: use relative path in gen-cli-docs.go Makes gen-cli-docs.go work outside GOPATH. * Documentation,cmd/dlv: tidy up --help output The description of --log-dest, --log-output and --backend is very verbose and messes up the output of --help, move it to two "additional help" subcommands.
2019-08-01 23:28:38 +00:00
--accept-multiclient Allows a headless server to accept multiple client connections.
proc/gdbserial: mozilla rr support (#804) Implements #727
2017-05-05 22:17:52 +00:00
--api-version int Selects API version when headless. (default 1)
Documentation,cmd/dlv: tidy up --help output (#1649) * scripts: use relative path in gen-cli-docs.go Makes gen-cli-docs.go work outside GOPATH. * Documentation,cmd/dlv: tidy up --help output The description of --log-dest, --log-output and --backend is very verbose and messes up the output of --help, move it to two "additional help" subcommands.
2019-08-01 23:28:38 +00:00
--backend string Backend selection (see 'dlv help backend'). (default "default")
proc/gdbserial: mozilla rr support (#804) Implements #727
2017-05-05 22:17:52 +00:00
--build-flags string Build flags, to be passed to the compiler.
cmd/dlv: add Go version check (#1533) Before doing anything check that the version of Go is compatible with the current version of Delve. This will improve the error message in the case that another change as disruptive as Go1.11 dwarf compression, happens.
2019-04-26 17:24:21 +00:00
--check-go-version Checks that the version of Go in use is compatible with Delve. (default true)
proc/gdbserial: mozilla rr support (#804) Implements #727
2017-05-05 22:17:52 +00:00
--headless Run debug server only, in headless mode.
--init string Init file, executed by the terminal client.
*: Add .cirrus.yml for FreeBSD testing (#1639) * *: Add .cirrus.yml for FreeBSD testing * *: run go mod tidy * service/test: prefer 127.0.0.1 over localhost * dwarf/line: fix TestDebugLinePrologueParser * vendor: rerun go mod vendor
2019-07-30 15:38:25 +00:00
-l, --listen string Debugging server listen address. (default "127.0.0.1:0")
cmd/dlv: Revert 4e177b, use new flag name for debug logging options Previously to 4e177bb99acc511897f9cdbfc6cbc50d92ae4725 it was possible to use --log without arguments to enable logging, this commit reenables that use case. The new functionality of the --log flag moved to a new flag name --logx. Fixes #1188
2018-04-19 08:43:23 +00:00
--log Enable debugging server logging.
Documentation,cmd/dlv: tidy up --help output (#1649) * scripts: use relative path in gen-cli-docs.go Makes gen-cli-docs.go work outside GOPATH. * Documentation,cmd/dlv: tidy up --help output The description of --log-dest, --log-output and --backend is very verbose and messes up the output of --help, move it to two "additional help" subcommands.
2019-08-01 23:28:38 +00:00
--log-dest string Writes logs to the specified file or file descriptor (see 'dlv help log').
--log-output string Comma separated list of components that should produce debug output (see 'dlv help log')
cmd/dlv: Fix same-user check and add flag to disable it (#1839) * service: also search IPv6 connections when checking user When checking if the user is allowed to connect to this Delve instance also search IPv6 connections even though the local address is IPv4. Fixes #1835 * cmd: add flag to disable same-user check Fixes #1835
2020-02-11 17:06:29 +00:00
--only-same-user Only connections from the same user that started this instance of Delve are allowed to connect. (default true)
proc/gdbserial: mozilla rr support (#804) Implements #727
2017-05-05 22:17:52 +00:00
--wd string Working directory for running the program. (default ".")
docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
```
### SEE ALSO
* [dlv](dlv.md) - Delve is a debugger for the Go programming language.
Reference in New Issue Copy Permalink