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/pod_inspect.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/pod_inspect.go')
| -rw-r--r-- | cmd/podman/pod_inspect.go | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/cmd/podman/pod_inspect.go b/cmd/podman/pod_inspect.go index 8b2747af0..79ffe2e6f 100644 --- a/cmd/podman/pod_inspect.go +++ b/cmd/podman/pod_inspect.go @@ -12,8 +12,11 @@ import ( var ( podInspectCommand cliconfig.PodInspectValues - podInspectDescription = "Display the configuration for a pod by name or id" - _podInspectCommand = &cobra.Command{ + podInspectDescription = `Display the configuration for a pod by name or id + + By default, this will render all results in a JSON array. If the container and image have the same name, this command returns the container JSON.` + + _podInspectCommand = &cobra.Command{ Use: "inspect [flags] POD", Short: "Displays a pod configuration", Long: podInspectDescription, @@ -28,6 +31,7 @@ var ( func init() { podInspectCommand.Command = _podInspectCommand + podInspectCommand.SetHelpTemplate(HelpTemplate()) podInspectCommand.SetUsageTemplate(UsageTemplate()) flags := podInspectCommand.Flags() flags.BoolVarP(&podInspectCommand.Latest, "latest", "l", false, "Act on the latest container podman is aware of") |