Cleanup descriptions and help information

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #1167
Approved by: baude

cmd/podman/build.go

@@ -20,7 +20,7 @@ var (
 		"or more Dockerfiles and a specified build context directory."
 	buildCommand = cli.Command{
 		Name:           "build",
-		Usage:          "build an image using instructions from Dockerfiles",
+		Usage:          "Build an image using instructions from Dockerfiles",
 		Description:    buildDescription,
 		Flags:          append(buildahcli.BudFlags, buildahcli.FromAndBudFlags...),
 		Action:         buildCmd,

cmd/podman/common.go

@@ -19,6 +19,10 @@ var (
 		Name:  "latest, l",
 		Usage: "act on the latest container podman is aware of",
 	}
+	LatestPodFlag = cli.BoolFlag{
+		Name:  "latest, l",
+		Usage: "act on the latest pod podman is aware of",
+	}
 )
 
 const (

cmd/podman/container.go

@@ -38,7 +38,7 @@ var (
 	containerDescription = "Manage containers"
 	containerCommand     = cli.Command{
 		Name:                   "container",
-		Usage:                  "container COMMAND",
+		Usage:                  "Manage Containers",
 		Description:            containerDescription,
 		ArgsUsage:              "",
 		Subcommands:            subCommands,

cmd/podman/create.go

@@ -43,7 +43,7 @@ var createDescription = "Creates a new container from the given image or" +
 
 var createCommand = cli.Command{
 	Name:                   "create",
-	Usage:                  "create but do not start a container",
+	Usage:                  "Create but do not start a container",
 	Description:            createDescription,
 	Flags:                  createFlags,
 	Action:                 createCmd,

cmd/podman/image.go

@@ -23,7 +23,7 @@ var (
 	imageDescription = "Manage images"
 	imageCommand     = cli.Command{
 		Name:                   "image",
-		Usage:                  "image COMMAND",
+		Usage:                  "Manage images",
 		Description:            imageDescription,
 		ArgsUsage:              "",
 		Subcommands:            imageSubCommands,

cmd/podman/images.go

@@ -122,7 +122,7 @@ var (
 	imagesDescription = "lists locally stored images."
 	imagesCommand     = cli.Command{
 		Name:                   "images",
-		Usage:                  "list images in local storage",
+		Usage:                  "List images in local storage",
 		Description:            imagesDescription,
 		Flags:                  imagesFlags,
 		Action:                 imagesCmd,

cmd/podman/info.go

@@ -11,7 +11,7 @@ import (
 )
 
 var (
-	infoDescription = "display system information"
+	infoDescription = "Display podman system information"
 	infoCommand     = cli.Command{
 		Name:        "info",
 		Usage:       infoDescription,

cmd/podman/load.go

@@ -32,7 +32,7 @@ var (
 	loadDescription = "Loads the image from docker-archive stored on the local machine."
 	loadCommand     = cli.Command{
 		Name:        "load",
-		Usage:       "load an image from docker archive",
+		Usage:       "Load an image from docker archive",
 		Description: loadDescription,
 		Flags:       loadFlags,
 		Action:      loadCmd,

cmd/podman/login.go

@@ -41,7 +41,7 @@ var (
 	loginDescription = "Login to a container registry on a specified server."
 	loginCommand     = cli.Command{
 		Name:        "login",
-		Usage:       "login to a container registry",
+		Usage:       "Login to a container registry",
 		Description: loginDescription,
 		Flags:       loginFlags,
 		Action:      loginCmd,

cmd/podman/logout.go

@@ -23,7 +23,7 @@ var (
 	logoutDescription = "Remove the cached username and password for the registry."
 	logoutCommand     = cli.Command{
 		Name:        "logout",
-		Usage:       "logout of a container registry",
+		Usage:       "Logout of a container registry",
 		Description: logoutDescription,
 		Flags:       logoutFlags,
 		Action:      logoutCmd,

cmd/podman/pod.go

@@ -5,18 +5,11 @@ import (
 )
 
 var (
-	podDescription = `
+	podDescription = `Manage container pods.
-   podman pod
 
-   Manage container pods.
+Pods are a group of one or more containers sharing the same network, pid and ipc namespaces.
-   Pods are a group of one or more containers sharing the same network, pid and ipc namespaces.
 `
-	podCommand = cli.Command{
+	podSubCommands = []cli.Command{
-		Name:                   "pod",
-		Usage:                  "Manage pods",
-		Description:            podDescription,
-		UseShortOptionHandling: true,
-		Subcommands: []cli.Command{
 		podCreateCommand,
 		podKillCommand,
 		podPsCommand,
@@ -24,6 +17,12 @@ var (
 		podRmCommand,
 		podStartCommand,
 		podStopCommand,
-		},
+	}
+	podCommand = cli.Command{
+		Name:                   "pod",
+		Usage:                  "Manage pods",
+		Description:            podDescription,
+		UseShortOptionHandling: true,
+		Subcommands:            podSubCommands,
 	}
 )

cmd/podman/pod_create.go

@@ -41,7 +41,7 @@ var podCreateFlags = []cli.Flag{
 
 var podCreateCommand = cli.Command{
 	Name:                   "create",
-	Usage:                  "create a new empty pod",
+	Usage:                  "Create a new empty pod",
 	Description:            podCreateDescription,
 	Flags:                  podCreateFlags,
 	Action:                 podCreateCmd,

cmd/podman/pod_kill.go

@@ -23,7 +23,7 @@ var (
 			Usage: "Signal to send to the containers in the pod",
 			Value: "KILL",
 		},
-		LatestFlag,
+		LatestPodFlag,
 	}
 	podKillDescription = "The main process of each container inside the specified pod will be sent SIGKILL, or any signal specified with option --signal."
 	podKillCommand     = cli.Command{

cmd/podman/pod_restart.go

@@ -16,7 +16,7 @@ var (
 			Name:  "all, a",
 			Usage: "restart all pods",
 		},
-		LatestFlag,
+		LatestPodFlag,
 	}
 	podRestartDescription = `Restarts one or more pods. The pod ID or name can be used.`
 

cmd/podman/pod_rm.go

@@ -20,14 +20,16 @@ var (
 			Name:  "force, f",
 			Usage: "Force removal of a running pod by first stopping all containers, then removing all containers in the pod.  The default is false",
 		},
-		LatestFlag,
+		LatestPodFlag,
 	}
-	podRmDescription = "Remove one or more pods"
+	podRmDescription = fmt.Sprintf(`
+podman rm will remove one or more pods from the host. The pod name or ID can
+be used.  A pod with containers will not be removed without --force.
+If --force is specified, all containers will be stopped, then removed.
+`)
 	podRmCommand = cli.Command{
 		Name:                   "rm",
-		Usage: fmt.Sprintf(`podman rm will remove one or more pods from the host. The pod name or ID can be used.
+		Usage:                  "Remove one or more pods",
-                            A pod with containers will not be removed without --force.
-                            If --force is specified, all containers will be stopped, then removed.`),
 		Description:            podRmDescription,
 		Flags:                  podRmFlags,
 		Action:                 podRmCmd,

cmd/podman/pod_start.go

@@ -16,7 +16,7 @@ var (
 			Name:  "all, a",
 			Usage: "start all running pods",
 		},
-		LatestFlag,
+		LatestPodFlag,
 	}
 	podStartDescription = `
    podman pod start

cmd/podman/pod_stop.go

@@ -16,7 +16,7 @@ var (
 			Name:  "all, a",
 			Usage: "stop all running pods",
 		},
-		LatestFlag,
+		LatestPodFlag,
 	}
 	podStopDescription = `
    podman pod stop

cmd/podman/pull.go

@@ -44,12 +44,14 @@ var (
 		},
 	}
 
-	pullDescription = "Pulls an image from a registry and stores it locally.\n" +
+	pullDescription = `
-		"An image can be pulled using its tag or digest. If a tag is not\n" +
+Pulls an image from a registry and stores it locally.
-		"specified, the image with the 'latest' tag (if it exists) is pulled."
+An image can be pulled using its tag or digest. If a tag is not
+specified, the image with the 'latest' tag (if it exists) is pulled
+`
 	pullCommand = cli.Command{
 		Name:        "pull",
-		Usage:       "pull an image from a registry",
+		Usage:       "Pull an image from a registry",
 		Description: pullDescription,
 		Flags:       pullFlags,
 		Action:      pullCmd,

cmd/podman/push.go

@@ -68,7 +68,7 @@ var (
 
 	pushCommand = cli.Command{
 		Name:        "push",
-		Usage:       "push an image to a specified destination",
+		Usage:       "Push an image to a specified destination",
 		Description: pushDescription,
 		Flags:       pushFlags,
 		Action:      pushCmd,

cmd/podman/rm.go

@@ -22,11 +22,14 @@ var (
 		},
 		LatestFlag,
 	}
-	rmDescription = "Remove one or more containers"
+	rmDescription = fmt.Sprintf(`
+Podman rm will remove one or more containers from the host.
+The container name or ID can be used. This does not remove images.
+Running containers will not be removed without the -f option.
+`)
 	rmCommand = cli.Command{
 		Name:                   "rm",
-		Usage: fmt.Sprintf(`podman rm will remove one or more containers from the host.  The container name or ID can be used.
+		Usage:                  "Remove one or more containers",
-							This does not remove images.  Running containers will not be removed without the -f option.`),
 		Description:            rmDescription,
 		Flags:                  rmFlags,
 		Action:                 rmCmd,

cmd/podman/rmi.go

@@ -12,7 +12,7 @@ import (
 )
 
 var (
-	rmiDescription = "removes one or more locally stored images."
+	rmiDescription = "Removes one or more locally stored images."
 	rmiFlags       = []cli.Flag{
 		cli.BoolFlag{
 			Name:  "all, a",
@@ -25,7 +25,7 @@ var (
 	}
 	rmiCommand = cli.Command{
 		Name:        "rmi",
-		Usage:       "removes one or more images from local storage",
+		Usage:       "Removes one or more images from local storage",
 		Description: rmiDescription,
 		Action:      rmiCmd,
 		ArgsUsage:   "IMAGE-NAME-OR-ID [...]",

cmd/podman/run.go

@@ -29,7 +29,7 @@ var runFlags []cli.Flag = append(createFlags, cli.BoolTFlag{
 
 var runCommand = cli.Command{
 	Name:                   "run",
-	Usage:                  "run a command in a new container",
+	Usage:                  "Run a command in a new container",
 	Description:            runDescription,
 	Flags:                  runFlags,
 	Action:                 runCmd,

cmd/podman/search.go

@@ -54,7 +54,7 @@ var (
 	Can limit the number of results, and filter the output based on certain conditions.`
 	searchCommand = cli.Command{
 		Name:        "search",
-		Usage:       "search registry for image",
+		Usage:       "Search registry for image",
 		Description: searchDescription,
 		Flags:       searchFlags,
 		Action:      searchCmd,