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_stats.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_stats.go')
-rw-r--r-- | cmd/podman/pod_stats.go | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/cmd/podman/pod_stats.go b/cmd/podman/pod_stats.go index 2761ce9cc..7dbd84525 100644 --- a/cmd/podman/pod_stats.go +++ b/cmd/podman/pod_stats.go @@ -22,10 +22,11 @@ import ( var ( podStatsCommand cliconfig.PodStatsValues - podStatsDescription = "Display a live stream of resource usage statistics for the containers in or more pods" - _podStatsCommand = &cobra.Command{ + podStatsDescription = `For each specified pod this command will display percentage of CPU, memory, network I/O, block I/O and PIDs for containers in one the pods.` + + _podStatsCommand = &cobra.Command{ Use: "stats [flags] POD [POD...]", - Short: "Display percentage of CPU, memory, network I/O, block I/O and PIDs for containers in one or more pods", + Short: "Display a live stream of resource usage statistics for the containers in one or more pods", Long: podStatsDescription, RunE: func(cmd *cobra.Command, args []string) error { podStatsCommand.InputArgs = args @@ -40,6 +41,7 @@ var ( func init() { podStatsCommand.Command = _podStatsCommand + podStatsCommand.SetHelpTemplate(HelpTemplate()) podStatsCommand.SetUsageTemplate(UsageTemplate()) flags := podStatsCommand.Flags() flags.BoolVarP(&podStatsCommand.All, "all", "a", false, "Provide stats for all running pods") |