delve/scripts/gen-usage-docs.go

// +build ignore

package main

import (
	"github.com/derekparker/delve/cmd/dlv/cmds"
	"github.com/spf13/cobra/doc"
)

func main() {
	doc.GenMarkdownTree(cmds.New(true), "./Documentation/usage")
}
vendor: update vendored packages (#791) * pkg/proc: use golang.org/x/arch/x86/x86asm instead of rsc.io/x86/x86asm * pkg/dwarf: migrate to github.com/pkg/profile from github.com/davecheney/profile * scripts: keep script go files from being considered for the build scripts/gen-.go files are scripts for generating documentation files and don't follow the typical Go package layout. Expected usage is like go run scripts/gen-cli-docs.go vendor: update vendored packages There were many changes in delve, and go tool chains since last vendored package update. I just rerun godpes from scratch. $ rm vendor/* $ rm Godeps/Godeps.json $ go list ./... \| grep -v /vendor/ \| grep -v /scripts/ \| go get -u -t $ go get -u github.com/mattn/go-colorable $ go get -u github.com/mattn/go-isatty $ go list ./... \| grep -v /vendor/ \| grep -v /scripts/ \| godeps save 2017-04-17 21:13:00 +00:00			`// +build ignore`

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			`package main`

			`import (`
			`"github.com/derekparker/delve/cmd/dlv/cmds"`
			`"github.com/spf13/cobra/doc"`
			`)`

			`func main() {`
path/to/binary is the required argument (#847 fixed) (#884) * cmd: include replay command in docs even if rr is not installed. * path/to/binary is the required argument Replaces #847 2017-06-20 17:36:07 +00:00			`doc.GenMarkdownTree(cmds.New(true), "./Documentation/usage")`
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			`}`