make command help display consistent

Signed-off-by: Allen Sun <shlallen1990@gmail.com>
This commit is contained in:
Allen Sun 2017-09-22 15:29:09 +08:00
parent 709d34f882
commit d5b027c94b
14 changed files with 35 additions and 37 deletions

View File

@ -12,7 +12,7 @@ import (
var containersDeleteCommand = cli.Command{ var containersDeleteCommand = cli.Command{
Name: "delete", Name: "delete",
Usage: "deletes one or more existing containers", Usage: "delete one or more existing containers",
ArgsUsage: "CONTAINER [CONTAINER, ...]", ArgsUsage: "CONTAINER [CONTAINER, ...]",
Aliases: []string{"del", "rm"}, Aliases: []string{"del", "rm"},
Flags: []cli.Flag{ Flags: []cli.Flag{

View File

@ -22,7 +22,7 @@ import (
var ( var (
contentCommand = cli.Command{ contentCommand = cli.Command{
Name: "content", Name: "content",
Usage: "content management", Usage: "manage content",
Subcommands: cli.Commands{ Subcommands: cli.Commands{
listContentCommand, listContentCommand,
ingestContentCommand, ingestContentCommand,
@ -220,7 +220,7 @@ var (
labelContentCommand = cli.Command{ labelContentCommand = cli.Command{
Name: "label", Name: "label",
Usage: "adds labels to content", Usage: "add labels to content",
ArgsUsage: "[flags] <digest> [<label>=<value> ...]", ArgsUsage: "[flags] <digest> [<label>=<value> ...]",
Description: `Labels blobs in the content store`, Description: `Labels blobs in the content store`,
Flags: []cli.Flag{}, Flags: []cli.Flag{},

View File

@ -12,24 +12,23 @@ import (
) )
var imagesExportCommand = cli.Command{ var imagesExportCommand = cli.Command{
Name: "export", Name: "export",
Usage: "export an image", Usage: "export an image",
ArgsUsage: "[flags] <out> <image>", ArgsUsage: "[flags] <out> <image>",
Description: `Export an image to a tar stream Description: `Export an image to a tar stream.`,
`,
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.StringFlag{ cli.StringFlag{
Name: "oci-ref-name", Name: "oci-ref-name",
Value: "", Value: "",
Usage: "Override org.opencontainers.image.ref.name annotation", Usage: "override org.opencontainers.image.ref.name annotation",
}, },
cli.StringFlag{ cli.StringFlag{
Name: "manifest", Name: "manifest",
Usage: "Digest of manifest", Usage: "digest of manifest",
}, },
cli.StringFlag{ cli.StringFlag{
Name: "manifest-type", Name: "manifest-type",
Usage: "Media type of manifest digest", Usage: "media type of manifest digest",
Value: ocispec.MediaTypeImageManifest, Value: ocispec.MediaTypeImageManifest,
}, },
}, },

View File

@ -18,7 +18,7 @@ import (
var imageCommand = cli.Command{ var imageCommand = cli.Command{
Name: "images", Name: "images",
Usage: "image management", Usage: "manage images",
Subcommands: cli.Commands{ Subcommands: cli.Commands{
imagesListCommand, imagesListCommand,
imageRemoveCommand, imageRemoveCommand,
@ -105,7 +105,7 @@ var imagesListCommand = cli.Command{
var imagesSetLabelsCommand = cli.Command{ var imagesSetLabelsCommand = cli.Command{
Name: "label", Name: "label",
Usage: "Set and clear labels for an image.", Usage: "set and clear labels for an image.",
ArgsUsage: "[flags] <name> [<key>=<value>, ...]", ArgsUsage: "[flags] <name> [<key>=<value>, ...]",
Description: "Set and clear labels for an image.", Description: "Set and clear labels for an image.",
Flags: []cli.Flag{}, Flags: []cli.Flag{},

View File

@ -11,11 +11,10 @@ import (
) )
var imagesImportCommand = cli.Command{ var imagesImportCommand = cli.Command{
Name: "import", Name: "import",
Usage: "import an image", Usage: "import an image",
ArgsUsage: "[flags] <ref> <in>", ArgsUsage: "[flags] <ref> <in>",
Description: `Import an image from a tar stream Description: `Import an image from a tar stream.`,
`,
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.StringFlag{ cli.StringFlag{
Name: "ref-object", Name: "ref-object",

View File

@ -10,7 +10,7 @@ import (
var containersSetLabelsCommand = cli.Command{ var containersSetLabelsCommand = cli.Command{
Name: "label", Name: "label",
Usage: "Set and clear labels for a container.", Usage: "set and clear labels for a container.",
ArgsUsage: "[flags] <name> [<key>=<value>, ...]", ArgsUsage: "[flags] <name> [<key>=<value>, ...]",
Description: "Set and clear labels for a container.", Description: "Set and clear labels for a container.",
Flags: []cli.Flag{}, Flags: []cli.Flag{},

View File

@ -27,7 +27,7 @@ var namespacesCommand = cli.Command{
var namespacesCreateCommand = cli.Command{ var namespacesCreateCommand = cli.Command{
Name: "create", Name: "create",
Usage: "Create a new namespace.", Usage: "create a new namespace.",
ArgsUsage: "[flags] <name> [<key>=<value]", ArgsUsage: "[flags] <name> [<key>=<value]",
Description: "Create a new namespace. It must be unique.", Description: "Create a new namespace. It must be unique.",
Action: func(clicontext *cli.Context) error { Action: func(clicontext *cli.Context) error {
@ -55,7 +55,7 @@ var namespacesCreateCommand = cli.Command{
var namespacesSetLabelsCommand = cli.Command{ var namespacesSetLabelsCommand = cli.Command{
Name: "label", Name: "label",
Usage: "Set and clear labels for a namespace.", Usage: "set and clear labels for a namespace.",
ArgsUsage: "[flags] <name> [<key>=<value>, ...]", ArgsUsage: "[flags] <name> [<key>=<value>, ...]",
Description: "Set and clear labels for a namespace.", Description: "Set and clear labels for a namespace.",
Flags: []cli.Flag{}, Flags: []cli.Flag{},
@ -87,7 +87,7 @@ var namespacesSetLabelsCommand = cli.Command{
var namespacesListCommand = cli.Command{ var namespacesListCommand = cli.Command{
Name: "list", Name: "list",
Aliases: []string{"ls"}, Aliases: []string{"ls"},
Usage: "List namespaces.", Usage: "list namespaces.",
ArgsUsage: "[flags]", ArgsUsage: "[flags]",
Description: "List namespaces.", Description: "List namespaces.",
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -146,7 +146,7 @@ var namespacesListCommand = cli.Command{
var namespacesRemoveCommand = cli.Command{ var namespacesRemoveCommand = cli.Command{
Name: "remove", Name: "remove",
Aliases: []string{"rm"}, Aliases: []string{"rm"},
Usage: "Remove one or more namespaces", Usage: "remove one or more namespaces",
ArgsUsage: "[flags] <name> [<name>, ...]", ArgsUsage: "[flags] <name> [<name>, ...]",
Description: "Remove one or more namespaces. For now, the namespace must be empty.", Description: "Remove one or more namespaces. For now, the namespace must be empty.",
Action: func(clicontext *cli.Context) error { Action: func(clicontext *cli.Context) error {

View File

@ -19,7 +19,7 @@ type pprofDialer struct {
var pprofCommand = cli.Command{ var pprofCommand = cli.Command{
Name: "pprof", Name: "pprof",
Usage: "provides golang pprof outputs for containerd", Usage: "provide golang pprof outputs for containerd",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.StringFlag{ cli.StringFlag{
Name: "debug-socket, d", Name: "debug-socket, d",
@ -87,7 +87,7 @@ var pprofProfileCommand = cli.Command{
var pprofTraceCommand = cli.Command{ var pprofTraceCommand = cli.Command{
Name: "trace", Name: "trace",
Usage: "collects execution trace", Usage: "collect execution trace",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.DurationFlag{ cli.DurationFlag{
Name: "seconds,s", Name: "seconds,s",

View File

@ -39,10 +39,10 @@ var pushCommand = cli.Command{
`, `,
Flags: append(registryFlags, cli.StringFlag{ Flags: append(registryFlags, cli.StringFlag{
Name: "manifest", Name: "manifest",
Usage: "Digest of manifest", Usage: "digest of manifest",
}, cli.StringFlag{ }, cli.StringFlag{
Name: "manifest-type", Name: "manifest-type",
Usage: "Media type of manifest digest", Usage: "media type of manifest digest",
Value: ocispec.MediaTypeImageManifest, Value: ocispec.MediaTypeImageManifest,
}), }),
Action: func(clicontext *cli.Context) error { Action: func(clicontext *cli.Context) error {

View File

@ -12,7 +12,7 @@ import (
var pushObjectCommand = cli.Command{ var pushObjectCommand = cli.Command{
Name: "push-object", Name: "push-object",
Usage: "pushes an object to a remote", Usage: "push an object to a remote",
ArgsUsage: "[flags] <remote> <object> <type>", ArgsUsage: "[flags] <remote> <object> <type>",
Description: `Push objects by identifier to a remote.`, Description: `Push objects by identifier to a remote.`,
Flags: registryFlags, Flags: registryFlags,

View File

@ -11,7 +11,7 @@ import (
var rootfsCommand = cli.Command{ var rootfsCommand = cli.Command{
Name: "rootfs", Name: "rootfs",
Usage: "rootfs setups a rootfs", Usage: "setup a rootfs",
Subcommands: []cli.Command{ Subcommands: []cli.Command{
rootfsUnpackCommand, rootfsUnpackCommand,
}, },

View File

@ -21,7 +21,7 @@ import (
func init() { func init() {
runCommand.Flags = append(runCommand.Flags, cli.BoolFlag{ runCommand.Flags = append(runCommand.Flags, cli.BoolFlag{
Name: "rootfs", Name: "rootfs",
Usage: "Use custom rootfs that is not managed by containerd snapshotter.", Usage: "use custom rootfs that is not managed by containerd snapshotter.",
}) })
} }

View File

@ -34,7 +34,7 @@ var snapshotCommand = cli.Command{
var listSnapshotCommand = cli.Command{ var listSnapshotCommand = cli.Command{
Name: "list", Name: "list",
Aliases: []string{"ls"}, Aliases: []string{"ls"},
Usage: "List snapshots", Usage: "list snapshots",
Action: func(clicontext *cli.Context) error { Action: func(clicontext *cli.Context) error {
ctx, cancel := appContext(clicontext) ctx, cancel := appContext(clicontext)
defer cancel() defer cancel()
@ -63,7 +63,7 @@ var listSnapshotCommand = cli.Command{
var usageSnapshotCommand = cli.Command{ var usageSnapshotCommand = cli.Command{
Name: "usage", Name: "usage",
Usage: "Usage snapshots", Usage: "usage snapshots",
ArgsUsage: "[flags] [<key>, ...]", ArgsUsage: "[flags] [<key>, ...]",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
@ -281,7 +281,7 @@ var commitSnapshotCommand = cli.Command{
var treeSnapshotCommand = cli.Command{ var treeSnapshotCommand = cli.Command{
Name: "tree", Name: "tree",
Usage: "Display tree view of snapshot branches", Usage: "display tree view of snapshot branches",
Action: func(clicontext *cli.Context) error { Action: func(clicontext *cli.Context) error {
ctx, cancel := appContext(clicontext) ctx, cancel := appContext(clicontext)
defer cancel() defer cancel()

View File

@ -52,7 +52,7 @@ var (
snapshotterFlags = []cli.Flag{ snapshotterFlags = []cli.Flag{
cli.StringFlag{ cli.StringFlag{
Name: "snapshotter", Name: "snapshotter",
Usage: "Snapshotter name. Empty value stands for the daemon default value.", Usage: "snapshotter name. Empty value stands for the daemon default value.",
Value: containerd.DefaultSnapshotter, Value: containerd.DefaultSnapshotter,
}, },
} }
@ -60,11 +60,11 @@ var (
registryFlags = []cli.Flag{ registryFlags = []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
Name: "skip-verify,k", Name: "skip-verify,k",
Usage: "Skip SSL certificate validation", Usage: "skip SSL certificate validation",
}, },
cli.BoolFlag{ cli.BoolFlag{
Name: "plain-http", Name: "plain-http",
Usage: "Allow connections using plain HTTP", Usage: "allow connections using plain HTTP",
}, },
cli.StringFlag{ cli.StringFlag{
Name: "user,u", Name: "user,u",
@ -72,7 +72,7 @@ var (
}, },
cli.StringFlag{ cli.StringFlag{
Name: "refresh", Name: "refresh",
Usage: "Refresh token for authorization server", Usage: "refresh token for authorization server",
}, },
} }
) )