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/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/inspect.go')
-rw-r--r-- | cmd/podman/inspect.go | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/cmd/podman/inspect.go b/cmd/podman/inspect.go index 1c93a03e1..0af96088f 100644 --- a/cmd/podman/inspect.go +++ b/cmd/podman/inspect.go @@ -24,8 +24,10 @@ const ( var ( inspectCommand cliconfig.InspectValues - inspectDescription = "This displays the low-level information on containers and images identified 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 will return container JSON for unspecified type." - _inspectCommand = &cobra.Command{ + inspectDescription = `This displays the low-level information on containers and images identified by name or ID. + + If given a name that matches both a container and an image, this command inspects the container. By default, this will render all results in a JSON array.` + _inspectCommand = &cobra.Command{ Use: "inspect [flags] CONTAINER | IMAGE", Short: "Display the configuration of a container or image", Long: inspectDescription, @@ -42,6 +44,7 @@ var ( func init() { inspectCommand.Command = _inspectCommand + inspectCommand.SetHelpTemplate(HelpTemplate()) inspectCommand.SetUsageTemplate(UsageTemplate()) flags := inspectCommand.Flags() flags.StringVarP(&inspectCommand.TypeObject, "type", "t", inspectAll, "Return JSON for specified type, (e.g image, container or task)") |