summaryrefslogtreecommitdiff
path: root/cmd/podman
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2018-07-26 16:10:46 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2018-07-27 02:17:29 +0000
commitf9152d075a3175ad62f77b3166c3cb0df2c310f2 (patch)
treeb097946e3ff4f53138eba68e8983f453e8298213 /cmd/podman
parentc1424095983992f56ffa50e79c0139cef8893f6d (diff)
downloadpodman-f9152d075a3175ad62f77b3166c3cb0df2c310f2.tar.gz
podman-f9152d075a3175ad62f77b3166c3cb0df2c310f2.tar.bz2
podman-f9152d075a3175ad62f77b3166c3cb0df2c310f2.zip
Cleanup descriptions and help information
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #1167 Approved by: baude
Diffstat (limited to 'cmd/podman')
-rw-r--r--cmd/podman/build.go2
-rw-r--r--cmd/podman/common.go4
-rw-r--r--cmd/podman/container.go2
-rw-r--r--cmd/podman/create.go2
-rw-r--r--cmd/podman/image.go2
-rw-r--r--cmd/podman/images.go2
-rw-r--r--cmd/podman/info.go2
-rw-r--r--cmd/podman/load.go2
-rw-r--r--cmd/podman/login.go2
-rw-r--r--cmd/podman/logout.go2
-rw-r--r--cmd/podman/pod.go25
-rw-r--r--cmd/podman/pod_create.go2
-rw-r--r--cmd/podman/pod_kill.go2
-rw-r--r--cmd/podman/pod_restart.go2
-rw-r--r--cmd/podman/pod_rm.go16
-rw-r--r--cmd/podman/pod_start.go2
-rw-r--r--cmd/podman/pod_stop.go2
-rw-r--r--cmd/podman/pull.go10
-rw-r--r--cmd/podman/push.go2
-rw-r--r--cmd/podman/rm.go13
-rw-r--r--cmd/podman/rmi.go4
-rw-r--r--cmd/podman/run.go2
-rw-r--r--cmd/podman/search.go2
23 files changed, 58 insertions, 48 deletions
diff --git a/cmd/podman/build.go b/cmd/podman/build.go
index f966ff32f..ab39003bc 100644
--- a/cmd/podman/build.go
+++ b/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,
diff --git a/cmd/podman/common.go b/cmd/podman/common.go
index ef7463773..93fa9653a 100644
--- a/cmd/podman/common.go
+++ b/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 (
diff --git a/cmd/podman/container.go b/cmd/podman/container.go
index e0684a3fd..36f706258 100644
--- a/cmd/podman/container.go
+++ b/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,
diff --git a/cmd/podman/create.go b/cmd/podman/create.go
index c7982d551..92ce249e0 100644
--- a/cmd/podman/create.go
+++ b/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,
diff --git a/cmd/podman/image.go b/cmd/podman/image.go
index 5deea5c74..9a07d0a0c 100644
--- a/cmd/podman/image.go
+++ b/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,
diff --git a/cmd/podman/images.go b/cmd/podman/images.go
index 092326b1f..364c8a91c 100644
--- a/cmd/podman/images.go
+++ b/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,
diff --git a/cmd/podman/info.go b/cmd/podman/info.go
index d9bbebcdf..f03d23c5b 100644
--- a/cmd/podman/info.go
+++ b/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,
diff --git a/cmd/podman/load.go b/cmd/podman/load.go
index ab3cc29b8..565b09184 100644
--- a/cmd/podman/load.go
+++ b/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,
diff --git a/cmd/podman/login.go b/cmd/podman/login.go
index a3eb60ea4..113760318 100644
--- a/cmd/podman/login.go
+++ b/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,
diff --git a/cmd/podman/logout.go b/cmd/podman/logout.go
index 25f5aca10..c06c69073 100644
--- a/cmd/podman/logout.go
+++ b/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,
diff --git a/cmd/podman/pod.go b/cmd/podman/pod.go
index 277b16932..65bc9efda 100644
--- a/cmd/podman/pod.go
+++ b/cmd/podman/pod.go
@@ -5,25 +5,24 @@ import (
)
var (
- podDescription = `
- podman pod
+ podDescription = `Manage container pods.
- 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.
`
+ podSubCommands = []cli.Command{
+ podCreateCommand,
+ podKillCommand,
+ podPsCommand,
+ podRestartCommand,
+ podRmCommand,
+ podStartCommand,
+ podStopCommand,
+ }
podCommand = cli.Command{
Name: "pod",
Usage: "Manage pods",
Description: podDescription,
UseShortOptionHandling: true,
- Subcommands: []cli.Command{
- podCreateCommand,
- podKillCommand,
- podPsCommand,
- podRestartCommand,
- podRmCommand,
- podStartCommand,
- podStopCommand,
- },
+ Subcommands: podSubCommands,
}
)
diff --git a/cmd/podman/pod_create.go b/cmd/podman/pod_create.go
index f86faa409..c14496f5a 100644
--- a/cmd/podman/pod_create.go
+++ b/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,
diff --git a/cmd/podman/pod_kill.go b/cmd/podman/pod_kill.go
index e233c76b1..43924f8a0 100644
--- a/cmd/podman/pod_kill.go
+++ b/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{
diff --git a/cmd/podman/pod_restart.go b/cmd/podman/pod_restart.go
index cd0081c8c..a4b121009 100644
--- a/cmd/podman/pod_restart.go
+++ b/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.`
diff --git a/cmd/podman/pod_rm.go b/cmd/podman/pod_rm.go
index 8b4c09cfe..362e23368 100644
--- a/cmd/podman/pod_rm.go
+++ b/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"
- 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.
- A pod with containers will not be removed without --force.
- If --force is specified, all containers will be stopped, then removed.`),
+ 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: "Remove one or more pods",
Description: podRmDescription,
Flags: podRmFlags,
Action: podRmCmd,
diff --git a/cmd/podman/pod_start.go b/cmd/podman/pod_start.go
index 75681a747..0ca695a21 100644
--- a/cmd/podman/pod_start.go
+++ b/cmd/podman/pod_start.go
@@ -16,7 +16,7 @@ var (
Name: "all, a",
Usage: "start all running pods",
},
- LatestFlag,
+ LatestPodFlag,
}
podStartDescription = `
podman pod start
diff --git a/cmd/podman/pod_stop.go b/cmd/podman/pod_stop.go
index 57ef458f1..85904ebf3 100644
--- a/cmd/podman/pod_stop.go
+++ b/cmd/podman/pod_stop.go
@@ -16,7 +16,7 @@ var (
Name: "all, a",
Usage: "stop all running pods",
},
- LatestFlag,
+ LatestPodFlag,
}
podStopDescription = `
podman pod stop
diff --git a/cmd/podman/pull.go b/cmd/podman/pull.go
index a1e99fce2..431c1e0ed 100644
--- a/cmd/podman/pull.go
+++ b/cmd/podman/pull.go
@@ -44,12 +44,14 @@ var (
},
}
- pullDescription = "Pulls an image from a registry and stores it locally.\n" +
- "An image can be pulled using its tag or digest. If a tag is not\n" +
- "specified, the image with the 'latest' tag (if it exists) is pulled."
+ pullDescription = `
+Pulls an image from a registry and stores it locally.
+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,
diff --git a/cmd/podman/push.go b/cmd/podman/push.go
index caec080de..74882adb2 100644
--- a/cmd/podman/push.go
+++ b/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,
diff --git a/cmd/podman/rm.go b/cmd/podman/rm.go
index 9fc65cb4d..c0ec7d9f6 100644
--- a/cmd/podman/rm.go
+++ b/cmd/podman/rm.go
@@ -22,11 +22,14 @@ var (
},
LatestFlag,
}
- rmDescription = "Remove one or more containers"
- 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.
- This does not remove images. Running containers will not be removed without the -f option.`),
+ 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: "Remove one or more containers",
Description: rmDescription,
Flags: rmFlags,
Action: rmCmd,
diff --git a/cmd/podman/rmi.go b/cmd/podman/rmi.go
index f3e1a8e36..95e98a038 100644
--- a/cmd/podman/rmi.go
+++ b/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 [...]",
diff --git a/cmd/podman/run.go b/cmd/podman/run.go
index b126c9e73..efc7f2dd0 100644
--- a/cmd/podman/run.go
+++ b/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,
diff --git a/cmd/podman/search.go b/cmd/podman/search.go
index 15dc1df11..b165411ee 100644
--- a/cmd/podman/search.go
+++ b/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,