opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-06-27 21:50:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup descriptions and help information

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

Closes: #1167
Approved by: baude
This commit is contained in:
Daniel J Walsh
2018-07-26 16:10:46 -04:00
committed by Atomic Bot
parent c142409598
commit f9152d075a
23 changed files with 58 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/podman/build.go
View File

@ -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,

4
cmd/podman/common.go
View File

@ -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 (

2
cmd/podman/container.go
View File

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

2
cmd/podman/create.go
View File

@ -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,

2
cmd/podman/image.go
View File

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

2
cmd/podman/images.go
View File

@ -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,

2
cmd/podman/info.go
View File

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

2
cmd/podman/load.go
View File

@ -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,

2
cmd/podman/login.go
View File

@ -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,

2
cmd/podman/logout.go
View File

@ -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,

21
cmd/podman/pod.go
View File

@ -5,18 +5,11 @@ 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.
`
podCommand = cli.Command{
Name: "pod",
Usage: "Manage pods",
Description: podDescription,
UseShortOptionHandling: true,
Subcommands: []cli.Command{
podSubCommands = []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,
}
)

2
cmd/podman/pod_create.go
View File

@ -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,

2
cmd/podman/pod_kill.go
View File

@ -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{

2
cmd/podman/pod_restart.go
View File

@ -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.`

12
cmd/podman/pod_rm.go
View File

@ -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.
A pod with containers will not be removed without --force.
If --force is specified, all containers will be stopped, then removed.`),
Usage: "Remove one or more pods",
Description: podRmDescription,
Flags: podRmFlags,
Action: podRmCmd,

2
cmd/podman/pod_start.go
View File

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

2
cmd/podman/pod_stop.go
View File

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

10
cmd/podman/pull.go
View File

@ -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,

2
cmd/podman/push.go
View File

@ -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,

9
cmd/podman/rm.go
View File

@ -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.
This does not remove images. Running containers will not be removed without the -f option.`),
Usage: "Remove one or more containers",
Description: rmDescription,
Flags: rmFlags,
Action: rmCmd,

4
cmd/podman/rmi.go
View File

@ -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 [...]",

2
cmd/podman/run.go
View File

@ -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,

2
cmd/podman/search.go
View File

@ -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,