c412dcdc4f
Go 1.19 also formats doc comments according to the new godoc syntax. Some of our comments, especially unexported symbols did not conform to the godoc syntax and therefore are mangled by 'go fmt'. This PR runs 'go fmt' from go1.19 on everything and manually fixes the problems. See also: https://github.com/golang/proposal/blob/master/design/51082-godocfmt.md
39 lines
907 B
Go
39 lines
907 B
Go
//go:build ignore
|
|
// +build ignore
|
|
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"log"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/go-delve/delve/cmd/dlv/cmds"
|
|
"github.com/spf13/cobra/doc"
|
|
)
|
|
|
|
const defaultUsageDir = "./Documentation/usage"
|
|
|
|
func main() {
|
|
usageDir := defaultUsageDir
|
|
if len(os.Args) > 1 {
|
|
usageDir = os.Args[1]
|
|
}
|
|
root := cmds.New(true)
|
|
doc.GenMarkdownTree(root, usageDir)
|
|
// GenMarkdownTree ignores additional help topic commands, so we have to do this manually
|
|
for _, cmd := range root.Commands() {
|
|
if cmd.Run == nil {
|
|
doc.GenMarkdownTree(cmd, usageDir)
|
|
}
|
|
}
|
|
fh, err := os.OpenFile(filepath.Join(usageDir, "dlv.md"), os.O_APPEND|os.O_WRONLY, 0)
|
|
if err != nil {
|
|
log.Fatalf("appending to dlv.md: %v", err)
|
|
}
|
|
defer fh.Close()
|
|
fmt.Fprintln(fh, "* [dlv log](dlv_log.md)\t - Help about logging flags")
|
|
fmt.Fprintln(fh, "* [dlv backend](dlv_backend.md)\t - Help about the `--backend` flag")
|
|
}
|