summaryrefslogtreecommitdiff
path: root/cmd/podman/pod_kill.go
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2019-03-06 17:10:20 -0500
committerDaniel J Walsh <dwalsh@redhat.com>2019-03-07 13:46:59 -0500
commit9a39c60e46d927489efa0ef5d4ece7c76fceceb7 (patch)
tree980c7dec92a361532a18c601f3fb34767e99b0f4 /cmd/podman/pod_kill.go
parent1b253cf73a360557196213684cec63b37407ed7c (diff)
downloadpodman-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_kill.go')
-rw-r--r--cmd/podman/pod_kill.go7
1 files changed, 5 insertions, 2 deletions
diff --git a/cmd/podman/pod_kill.go b/cmd/podman/pod_kill.go
index 70d86d186..ebd7db762 100644
--- a/cmd/podman/pod_kill.go
+++ b/cmd/podman/pod_kill.go
@@ -14,8 +14,10 @@ import (
var (
podKillCommand cliconfig.PodKillValues
- podKillDescription = "The main process of each container inside the specified pod will be sent SIGKILL, or any signal specified with option --signal."
- _podKillCommand = &cobra.Command{
+ podKillDescription = `Signals are sent to the main process of each container inside the specified pod.
+
+ The default signal is SIGKILL, or any signal specified with option --signal.`
+ _podKillCommand = &cobra.Command{
Use: "kill [flags] POD [POD...]",
Short: "Send the specified signal or SIGKILL to containers in pod",
Long: podKillDescription,
@@ -35,6 +37,7 @@ var (
func init() {
podKillCommand.Command = _podKillCommand
+ podKillCommand.SetHelpTemplate(HelpTemplate())
podKillCommand.SetUsageTemplate(UsageTemplate())
flags := podKillCommand.Flags()
flags.BoolVarP(&podKillCommand.All, "all", "a", false, "Kill all containers in all pods")