From cd2a875459b06c5f6e27c5eacbed6497b6249781 Mon Sep 17 00:00:00 2001 From: Jason Biegel Date: Thu, 16 Feb 2017 14:05:48 -0500 Subject: [PATCH] Add flag support documentation (#740) --- Documentation/usage/dlv.md | 12 ++++++++---- Documentation/usage/dlv_attach.md | 7 ++++--- Documentation/usage/dlv_connect.md | 7 ++++--- Documentation/usage/dlv_debug.md | 9 +++++---- Documentation/usage/dlv_exec.md | 7 ++++--- Documentation/usage/dlv_run.md | 7 ++++--- Documentation/usage/dlv_test.md | 7 ++++--- Documentation/usage/dlv_trace.md | 7 ++++--- Documentation/usage/dlv_version.md | 7 ++++--- cmd/dlv/cmds/commands.go | 5 ++++- 10 files changed, 45 insertions(+), 30 deletions(-) diff --git a/Documentation/usage/dlv.md b/Documentation/usage/dlv.md index 8fd4ab95..729c9794 100644 --- a/Documentation/usage/dlv.md +++ b/Documentation/usage/dlv.md @@ -12,27 +12,31 @@ evaluating variables, and providing information of thread / goroutine state, CPU The goal of this tool is to provide a simple yet powerful interface for debugging Go programs. +Pass flags to the program you are debugging using `--`, for example: + +`dlv exec ./hello -- server --config conf/config.toml` ### Options ``` - --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate - --api-version=1: Selects API version when headless + --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate. + --api-version=1: Selects API version when headless. --build-flags="": Build flags, to be passed to the compiler. --headless[=false]: Run debug server only, in headless mode. --init="": Init file, executed by the terminal client. -l, --listen="localhost:0": Debugging server listen address. --log[=false]: Enable debugging server logging. + --wd=".": Working directory for running the program. ``` ### SEE ALSO * [dlv attach](dlv_attach.md) - Attach to running process and begin debugging. * [dlv connect](dlv_connect.md) - Connect to a headless debug server. -* [dlv debug](dlv_debug.md) - Compile and begin debugging main package in current directory, or the package specified +* [dlv debug](dlv_debug.md) - Compile and begin debugging main package in current directory, or the package specified. * [dlv exec](dlv_exec.md) - Execute a precompiled binary, and begin a debug session. * [dlv run](dlv_run.md) - Deprecated command. Use 'debug' instead. * [dlv test](dlv_test.md) - Compile test binary and begin debugging program. * [dlv trace](dlv_trace.md) - Compile and begin tracing program. * [dlv version](dlv_version.md) - Prints version. -###### Auto generated by spf13/cobra on 20-May-2016 +###### Auto generated by spf13/cobra on 15-Feb-2017 diff --git a/Documentation/usage/dlv_attach.md b/Documentation/usage/dlv_attach.md index df7faae6..4edc75f1 100644 --- a/Documentation/usage/dlv_attach.md +++ b/Documentation/usage/dlv_attach.md @@ -19,16 +19,17 @@ dlv attach pid ### Options inherited from parent commands ``` - --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate - --api-version=1: Selects API version when headless + --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate. + --api-version=1: Selects API version when headless. --build-flags="": Build flags, to be passed to the compiler. --headless[=false]: Run debug server only, in headless mode. --init="": Init file, executed by the terminal client. -l, --listen="localhost:0": Debugging server listen address. --log[=false]: Enable debugging server logging. + --wd=".": Working directory for running the program. ``` ### SEE ALSO * [dlv](dlv.md) - Delve is a debugger for the Go programming language. -###### Auto generated by spf13/cobra on 20-May-2016 +###### Auto generated by spf13/cobra on 15-Feb-2017 diff --git a/Documentation/usage/dlv_connect.md b/Documentation/usage/dlv_connect.md index 45a688ce..7132f49f 100644 --- a/Documentation/usage/dlv_connect.md +++ b/Documentation/usage/dlv_connect.md @@ -14,16 +14,17 @@ dlv connect addr ### Options inherited from parent commands ``` - --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate - --api-version=1: Selects API version when headless + --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate. + --api-version=1: Selects API version when headless. --build-flags="": Build flags, to be passed to the compiler. --headless[=false]: Run debug server only, in headless mode. --init="": Init file, executed by the terminal client. -l, --listen="localhost:0": Debugging server listen address. --log[=false]: Enable debugging server logging. + --wd=".": Working directory for running the program. ``` ### SEE ALSO * [dlv](dlv.md) - Delve is a debugger for the Go programming language. -###### Auto generated by spf13/cobra on 20-May-2016 +###### Auto generated by spf13/cobra on 15-Feb-2017 diff --git a/Documentation/usage/dlv_debug.md b/Documentation/usage/dlv_debug.md index 27624fa1..b3214086 100644 --- a/Documentation/usage/dlv_debug.md +++ b/Documentation/usage/dlv_debug.md @@ -1,6 +1,6 @@ ## dlv debug -Compile and begin debugging main package in current directory, or the package specified +Compile and begin debugging main package in current directory, or the package specified. ### Synopsis @@ -19,16 +19,17 @@ dlv debug [package] ### Options inherited from parent commands ``` - --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate - --api-version=1: Selects API version when headless + --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate. + --api-version=1: Selects API version when headless. --build-flags="": Build flags, to be passed to the compiler. --headless[=false]: Run debug server only, in headless mode. --init="": Init file, executed by the terminal client. -l, --listen="localhost:0": Debugging server listen address. --log[=false]: Enable debugging server logging. + --wd=".": Working directory for running the program. ``` ### SEE ALSO * [dlv](dlv.md) - Delve is a debugger for the Go programming language. -###### Auto generated by spf13/cobra on 20-May-2016 +###### Auto generated by spf13/cobra on 15-Feb-2017 diff --git a/Documentation/usage/dlv_exec.md b/Documentation/usage/dlv_exec.md index e5f33b3b..448d7223 100644 --- a/Documentation/usage/dlv_exec.md +++ b/Documentation/usage/dlv_exec.md @@ -19,16 +19,17 @@ dlv exec [./path/to/binary] ### Options inherited from parent commands ``` - --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate - --api-version=1: Selects API version when headless + --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate. + --api-version=1: Selects API version when headless. --build-flags="": Build flags, to be passed to the compiler. --headless[=false]: Run debug server only, in headless mode. --init="": Init file, executed by the terminal client. -l, --listen="localhost:0": Debugging server listen address. --log[=false]: Enable debugging server logging. + --wd=".": Working directory for running the program. ``` ### SEE ALSO * [dlv](dlv.md) - Delve is a debugger for the Go programming language. -###### Auto generated by spf13/cobra on 20-May-2016 +###### Auto generated by spf13/cobra on 15-Feb-2017 diff --git a/Documentation/usage/dlv_run.md b/Documentation/usage/dlv_run.md index 9581f9fc..12d225f6 100644 --- a/Documentation/usage/dlv_run.md +++ b/Documentation/usage/dlv_run.md @@ -14,16 +14,17 @@ dlv run ### Options inherited from parent commands ``` - --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate - --api-version=1: Selects API version when headless + --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate. + --api-version=1: Selects API version when headless. --build-flags="": Build flags, to be passed to the compiler. --headless[=false]: Run debug server only, in headless mode. --init="": Init file, executed by the terminal client. -l, --listen="localhost:0": Debugging server listen address. --log[=false]: Enable debugging server logging. + --wd=".": Working directory for running the program. ``` ### SEE ALSO * [dlv](dlv.md) - Delve is a debugger for the Go programming language. -###### Auto generated by spf13/cobra on 20-May-2016 +###### Auto generated by spf13/cobra on 15-Feb-2017 diff --git a/Documentation/usage/dlv_test.md b/Documentation/usage/dlv_test.md index feefc742..8cd2c301 100644 --- a/Documentation/usage/dlv_test.md +++ b/Documentation/usage/dlv_test.md @@ -19,16 +19,17 @@ dlv test [package] ### Options inherited from parent commands ``` - --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate - --api-version=1: Selects API version when headless + --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate. + --api-version=1: Selects API version when headless. --build-flags="": Build flags, to be passed to the compiler. --headless[=false]: Run debug server only, in headless mode. --init="": Init file, executed by the terminal client. -l, --listen="localhost:0": Debugging server listen address. --log[=false]: Enable debugging server logging. + --wd=".": Working directory for running the program. ``` ### SEE ALSO * [dlv](dlv.md) - Delve is a debugger for the Go programming language. -###### Auto generated by spf13/cobra on 20-May-2016 +###### Auto generated by spf13/cobra on 15-Feb-2017 diff --git a/Documentation/usage/dlv_trace.md b/Documentation/usage/dlv_trace.md index 337d3150..e33dc59f 100644 --- a/Documentation/usage/dlv_trace.md +++ b/Documentation/usage/dlv_trace.md @@ -26,16 +26,17 @@ dlv trace [package] regexp ### Options inherited from parent commands ``` - --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate - --api-version=1: Selects API version when headless + --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate. + --api-version=1: Selects API version when headless. --build-flags="": Build flags, to be passed to the compiler. --headless[=false]: Run debug server only, in headless mode. --init="": Init file, executed by the terminal client. -l, --listen="localhost:0": Debugging server listen address. --log[=false]: Enable debugging server logging. + --wd=".": Working directory for running the program. ``` ### SEE ALSO * [dlv](dlv.md) - Delve is a debugger for the Go programming language. -###### Auto generated by spf13/cobra on 20-May-2016 +###### Auto generated by spf13/cobra on 15-Feb-2017 diff --git a/Documentation/usage/dlv_version.md b/Documentation/usage/dlv_version.md index 33637d67..bdd64033 100644 --- a/Documentation/usage/dlv_version.md +++ b/Documentation/usage/dlv_version.md @@ -14,16 +14,17 @@ dlv version ### Options inherited from parent commands ``` - --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate - --api-version=1: Selects API version when headless + --accept-multiclient[=false]: Allows a headless server to accept multiple client connections. Note that the server API is not reentrant and clients will have to coordinate. + --api-version=1: Selects API version when headless. --build-flags="": Build flags, to be passed to the compiler. --headless[=false]: Run debug server only, in headless mode. --init="": Init file, executed by the terminal client. -l, --listen="localhost:0": Debugging server listen address. --log[=false]: Enable debugging server logging. + --wd=".": Working directory for running the program. ``` ### SEE ALSO * [dlv](dlv.md) - Delve is a debugger for the Go programming language. -###### Auto generated by spf13/cobra on 20-May-2016 +###### Auto generated by spf13/cobra on 15-Feb-2017 diff --git a/cmd/dlv/cmds/commands.go b/cmd/dlv/cmds/commands.go index ae8d757f..4da8b50b 100644 --- a/cmd/dlv/cmds/commands.go +++ b/cmd/dlv/cmds/commands.go @@ -62,7 +62,10 @@ Delve enables you to interact with your program by controlling the execution of evaluating variables, and providing information of thread / goroutine state, CPU register state and more. The goal of this tool is to provide a simple yet powerful interface for debugging Go programs. -` + +Pass flags to the program you are debugging using ` + "`--`" + `, for example: + +` + "`dlv exec ./hello -- server --config conf/config.toml`" // New returns an initialized command tree. func New() *cobra.Command { -- GitLab