diff options
author | Daniel J Walsh <dwalsh@redhat.com> | 2019-03-06 17:10:20 -0500 |
---|---|---|
committer | Daniel J Walsh <dwalsh@redhat.com> | 2019-03-07 13:46:59 -0500 |
commit | 9a39c60e46d927489efa0ef5d4ece7c76fceceb7 (patch) | |
tree | 980c7dec92a361532a18c601f3fb34767e99b0f4 /cmd/podman/generate_kube.go | |
parent | 1b253cf73a360557196213684cec63b37407ed7c (diff) | |
download | podman-9a39c60e46d927489efa0ef5d4ece7c76fceceb7.tar.gz podman-9a39c60e46d927489efa0ef5d4ece7c76fceceb7.tar.bz2 podman-9a39c60e46d927489efa0ef5d4ece7c76fceceb7.zip |
Fix help commands to show short and long description.
Cleanup lots of help information to look good when displayed.
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'cmd/podman/generate_kube.go')
-rw-r--r-- | cmd/podman/generate_kube.go | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/cmd/podman/generate_kube.go b/cmd/podman/generate_kube.go index fa2872b77..e3db14af3 100644 --- a/cmd/podman/generate_kube.go +++ b/cmd/podman/generate_kube.go @@ -15,10 +15,12 @@ import ( var ( containerKubeCommand cliconfig.GenerateKubeValues - containerKubeDescription = "Generate Kubernetes Pod YAML" - _containerKubeCommand = &cobra.Command{ + containerKubeDescription = `Command generates Kubernetes Pod YAML (v1 specification) from a podman container or pod. + + Whether the input is for a container or pod, Podman will always generate the specification as a Pod. The input may be in the form of a pod or container name or ID.` + _containerKubeCommand = &cobra.Command{ Use: "kube [flags] CONTAINER | POD", - Short: "Generate Kubernetes pod YAML for a container or pod", + Short: "Generate Kubernetes pod YAML from a container or pod", Long: containerKubeDescription, RunE: func(cmd *cobra.Command, args []string) error { containerKubeCommand.InputArgs = args @@ -33,6 +35,7 @@ var ( func init() { containerKubeCommand.Command = _containerKubeCommand + containerKubeCommand.SetHelpTemplate(HelpTemplate()) containerKubeCommand.SetUsageTemplate(UsageTemplate()) flags := containerKubeCommand.Flags() flags.BoolVarP(&containerKubeCommand.Service, "service", "s", false, "Generate YAML for kubernetes service object") |