Hulk did something

[bytom/vapor.git] / vendor / github.com / spf13 / cobra / doc / yaml_docs.md

diff --git a/vendor/github.com/spf13/cobra/doc/yaml_docs.md b/vendor/github.com/spf13/cobra/doc/yaml_docs.md
new file mode 100644 (file)
index 0000000..1a9b7c6
--- /dev/null
+++ b/vendor/github.com/spf13/cobra/doc/yaml_docs.md
@@ -0,0 +1,112 @@
+# Generating Yaml Docs For Your Own cobra.Command
+
+Generating yaml files from a cobra command is incredibly easy. An example is as follows:
+
+```go
+package main
+
+import (
+       "log"
+
+       "github.com/spf13/cobra"
+       "github.com/spf13/cobra/doc"
+)
+
+func main() {
+       cmd := &cobra.Command{
+               Use:   "test",
+               Short: "my test program",
+       }
+       err := doc.GenYamlTree(cmd, "/tmp")
+       if err != nil {
+               log.Fatal(err)
+       }
+}
+```
+
+That will get you a Yaml document `/tmp/test.yaml`
+
+## Generate yaml docs for the entire command tree
+
+This program can actually generate docs for the kubectl command in the kubernetes project
+
+```go
+package main
+
+import (
+       "io/ioutil"
+       "log"
+       "os"
+
+       "k8s.io/kubernetes/pkg/kubectl/cmd"
+       cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
+
+       "github.com/spf13/cobra/doc"
+)
+
+func main() {
+       kubectl := cmd.NewKubectlCommand(cmdutil.NewFactory(nil), os.Stdin, ioutil.Discard, ioutil.Discard)
+       err := doc.GenYamlTree(kubectl, "./")
+       if err != nil {
+               log.Fatal(err)
+       }
+}
+```
+
+This will generate a whole series of files, one for each command in the tree, in the directory specified (in this case "./")
+
+## Generate yaml docs for a single command
+
+You may wish to have more control over the output, or only generate for a single command, instead of the entire command tree. If this is the case you may prefer to `GenYaml` instead of `GenYamlTree`
+
+```go
+       out := new(bytes.Buffer)
+       doc.GenYaml(cmd, out)
+```
+
+This will write the yaml doc for ONLY "cmd" into the out, buffer.
+
+## Customize the output
+
+Both `GenYaml` and `GenYamlTree` have alternate versions with callbacks to get some control of the output:
+
+```go
+func GenYamlTreeCustom(cmd *Command, dir string, filePrepender, linkHandler func(string) string) error {
+       //...
+}
+```
+
+```go
+func GenYamlCustom(cmd *Command, out *bytes.Buffer, linkHandler func(string) string) error {
+       //...
+}
+```
+
+The `filePrepender` will prepend the return value given the full filepath to the rendered Yaml file. A common use case is to add front matter to use the generated documentation with [Hugo](http://gohugo.io/):
+
+```go
+const fmTemplate = `---
+date: %s
+title: "%s"
+slug: %s
+url: %s
+---
+`
+
+filePrepender := func(filename string) string {
+       now := time.Now().Format(time.RFC3339)
+       name := filepath.Base(filename)
+       base := strings.TrimSuffix(name, path.Ext(name))
+       url := "/commands/" + strings.ToLower(base) + "/"
+       return fmt.Sprintf(fmTemplate, now, strings.Replace(base, "_", " ", -1), base, url)
+}
+```
+
+The `linkHandler` can be used to customize the rendered internal links to the commands, given a filename:
+
+```go
+linkHandler := func(name string) string {
+       base := strings.TrimSuffix(name, path.Ext(name))
+       return "/commands/" + strings.ToLower(base) + "/"
+}
+```