Capatilize all usage and descriptions

We have no consistancy in out option usages and descritions
on whether or not the first letter should be capatalized.

This patch forces them all to be capatilized.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
This commit is contained in:
Daniel J Walsh 2019-02-04 13:44:16 -05:00
parent 74d984e056
commit 0830bb9035
No known key found for this signature in database
GPG Key ID: A2DF901DABE2C028
39 changed files with 102 additions and 102 deletions

View File

@ -21,7 +21,7 @@ var (
},
cli.BoolTFlag{
Name: "sig-proxy",
Usage: "proxy received signals to the process (default true)",
Usage: "Proxy received signals to the process (default true)",
},
LatestFlag,
}

View File

@ -25,7 +25,7 @@ var (
},
cli.BoolTFlag{
Name: "layers",
Usage: "cache intermediate layers during build. Use BUILDAH_LAYERS environment variable to override. ",
Usage: "Cache intermediate layers during build. Use BUILDAH_LAYERS environment variable to override. ",
},
}
buildDescription = "Builds an OCI or Docker image using instructions from one\n" +

View File

@ -21,19 +21,19 @@ var (
checkpointFlags = []cli.Flag{
cli.BoolFlag{
Name: "keep, k",
Usage: "keep all temporary checkpoint files",
Usage: "Keep all temporary checkpoint files",
},
cli.BoolFlag{
Name: "leave-running, R",
Usage: "leave the container running after writing checkpoint to disk",
Usage: "Leave the container running after writing checkpoint to disk",
},
cli.BoolFlag{
Name: "tcp-established",
Usage: "checkpoint a container with established TCP connections",
Usage: "Checkpoint a container with established TCP connections",
},
cli.BoolFlag{
Name: "all, a",
Usage: "checkpoint all running containers",
Usage: "Checkpoint all running containers",
},
LatestFlag,
}

View File

@ -95,58 +95,58 @@ func getMainAppFlags() []cli.Flag {
return []cli.Flag{
cli.StringFlag{
Name: "cgroup-manager",
Usage: "cgroup manager to use (cgroupfs or systemd, default systemd)",
Usage: "Cgroup manager to use (cgroupfs or systemd, default systemd)",
},
cli.StringFlag{
Name: "cni-config-dir",
Usage: "path of the configuration directory for CNI networks",
Usage: "Path of the configuration directory for CNI networks",
},
cli.StringFlag{
Name: "conmon",
Usage: "path of the conmon binary",
Usage: "Path of the conmon binary",
},
cli.StringFlag{
Name: "default-mounts-file",
Usage: "path to default mounts file",
Usage: "Path to default mounts file",
Hidden: true,
},
cli.StringSliceFlag{
Name: "hooks-dir",
Usage: "set the OCI hooks directory path (may be set multiple times)",
Usage: "Set the OCI hooks directory path (may be set multiple times)",
},
cli.IntFlag{
Name: "max-workers",
Usage: "the maximum number of workers for parallel operations",
Usage: "The maximum number of workers for parallel operations",
Hidden: true,
},
cli.StringFlag{
Name: "namespace",
Usage: "set the libpod namespace, used to create separate views of the containers and pods on the system",
Usage: "Set the libpod namespace, used to create separate views of the containers and pods on the system",
Value: "",
},
cli.StringFlag{
Name: "root",
Usage: "path to the root directory in which data, including images, is stored",
Usage: "Path to the root directory in which data, including images, is stored",
},
cli.StringFlag{
Name: "runroot",
Usage: "path to the 'run directory' where all state information is stored",
Usage: "Path to the 'run directory' where all state information is stored",
},
cli.StringFlag{
Name: "runtime",
Usage: "path to the OCI-compatible binary used to run containers, default is /usr/bin/runc",
Usage: "Path to the OCI-compatible binary used to run containers, default is /usr/bin/runc",
},
cli.StringFlag{
Name: "storage-driver, s",
Usage: "select which storage driver is used to manage storage of images and containers (default is overlay)",
Usage: "Select which storage driver is used to manage storage of images and containers (default is overlay)",
},
cli.StringSliceFlag{
Name: "storage-opt",
Usage: "used to pass an option to the storage driver",
Usage: "Used to pass an option to the storage driver",
},
cli.BoolFlag{
Name: "syslog",
Usage: "output logging information to syslog as well as the console",
Usage: "Output logging information to syslog as well as the console",
},
}
}

View File

@ -22,11 +22,11 @@ var (
stores = make(map[storage.Store]struct{})
LatestFlag = cli.BoolFlag{
Name: "latest, l",
Usage: "act on the latest container podman is aware of",
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",
Usage: "Act on the latest pod podman is aware of",
}
WorkDirFlag = cli.StringFlag{
Name: "workdir, w",
@ -213,7 +213,7 @@ var createFlags = []cli.Flag{
},
cli.StringFlag{
Name: "conmon-pidfile",
Usage: "path to the file that will receive the PID of conmon",
Usage: "Path to the file that will receive the PID of conmon",
},
cli.Uint64Flag{
Name: "cpu-period",

View File

@ -9,10 +9,10 @@ var (
containerKubeCommand,
}
generateDescription = "generate structured data based for a containers and pods"
generateDescription = "Generate structured data based for a containers and pods"
kubeCommand = cli.Command{
Name: "generate",
Usage: "generated structured data",
Usage: "Generate structured data",
Description: generateDescription,
ArgsUsage: "",
Subcommands: generateSubCommands,

View File

@ -17,7 +17,7 @@ var (
containerKubeFlags = []cli.Flag{
cli.BoolFlag{
Name: "service, s",
Usage: "generate YAML for kubernetes service object",
Usage: "Generate YAML for kubernetes service object",
},
}
containerKubeDescription = "Generate Kubernetes Pod YAML"

View File

@ -90,11 +90,11 @@ var (
},
cli.BoolFlag{
Name: "digests",
Usage: "show digests",
Usage: "Show digests",
},
cli.StringSliceFlag{
Name: "filter, f",
Usage: "filter output based on conditions provided (default [])",
Usage: "Filter output based on conditions provided (default [])",
},
cli.StringFlag{
Name: "format",
@ -102,20 +102,20 @@ var (
},
cli.BoolFlag{
Name: "noheading, n",
Usage: "do not print column headings",
Usage: "Do not print column headings",
},
cli.BoolFlag{
Name: "no-trunc, notruncate",
Usage: "do not truncate output",
Usage: "Do not truncate output",
},
cli.BoolFlag{
Name: "quiet, q",
Usage: "display only image IDs",
Usage: "Display only image IDs",
},
cli.StringFlag{
Name: "sort",
Usage: "Sort by created, id, repository, size, or tag",
Value: "created",
Value: "Created",
},
}
@ -133,7 +133,7 @@ var (
lsImagesCommand = cli.Command{
Name: "list",
Aliases: []string{"ls"},
Usage: "list images in local storage",
Usage: "List images in local storage",
Description: imagesDescription,
Flags: imagesFlags,
Action: imagesCmd,

View File

@ -17,7 +17,7 @@ var (
pruneImageFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "remove all unused images, not just dangling ones",
Usage: "Remove all unused images, not just dangling ones",
},
}
pruneImagesCommand = cli.Command{

View File

@ -26,7 +26,7 @@ var (
infoFlags = []cli.Flag{
cli.BoolFlag{
Name: "debug, D",
Usage: "display additional debug information",
Usage: "Display additional debug information",
},
cli.StringFlag{
Name: "format, f",

View File

@ -188,21 +188,21 @@ func main() {
app.Flags = []cli.Flag{
cli.StringFlag{
Name: "config, c",
Usage: "path of a libpod config file detailing container server configuration options",
Usage: "Path of a libpod config file detailing container server configuration options",
Hidden: true,
},
cli.StringFlag{
Name: "cpu-profile",
Usage: "path for the cpu profiling results",
Usage: "Path for the cpu profiling results",
},
cli.StringFlag{
Name: "log-level",
Usage: "log messages above specified level: debug, info, warn, error (default), fatal or panic",
Usage: "Log messages above specified level: debug, info, warn, error (default), fatal or panic",
Value: "error",
},
cli.StringFlag{
Name: "tmpdir",
Usage: "path to the tmp directory",
Usage: "Path to the tmp directory",
},
}

View File

@ -33,7 +33,7 @@ var (
},
cli.BoolFlag{
Name: "notruncate",
Usage: "do not truncate output",
Usage: "Do not truncate output",
},
LatestFlag,
}

View File

@ -15,7 +15,7 @@ var (
pauseFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "pause all running containers",
Usage: "Pause all running containers",
},
}
pauseDescription = `

View File

@ -12,7 +12,7 @@ var (
playDescription = "Play a pod and its containers from a structured file."
playCommand = cli.Command{
Name: "play",
Usage: "play a container or pod",
Usage: "Play a container or pod",
Description: playDescription,
ArgsUsage: "",
Subcommands: playSubCommands,

View File

@ -32,11 +32,11 @@ var (
},
cli.StringFlag{
Name: "cert-dir",
Usage: "`pathname` of a directory containing TLS certificates and keys",
Usage: "`Pathname` of a directory containing TLS certificates and keys",
},
cli.StringFlag{
Name: "creds",
Usage: "`credentials` (USERNAME:PASSWORD) to use for authenticating to a registry",
Usage: "`Credentials` (USERNAME:PASSWORD) to use for authenticating to a registry",
},
cli.BoolFlag{
Name: "quiet, q",
@ -44,11 +44,11 @@ var (
},
cli.StringFlag{
Name: "signature-policy",
Usage: "`pathname` of signature policy file (not usually used)",
Usage: "`Pathname` of signature policy file (not usually used)",
},
cli.BoolTFlag{
Name: "tls-verify",
Usage: "require HTTPS and verify certificates when contacting registries (default: true)",
Usage: "Require HTTPS and verify certificates when contacting registries (default: true)",
},
}
playKubeDescription = "Play a Pod and its containers based on a Kubrernetes YAML"
@ -58,7 +58,7 @@ var (
Description: playKubeDescription,
Action: playKubeYAMLCmd,
Flags: sortFlags(playKubeFlags),
ArgsUsage: "kubernetes YAML file",
ArgsUsage: "Kubernetes YAML file",
UseShortOptionHandling: true,
OnUsageError: usageErrorHandler,
}

View File

@ -14,10 +14,10 @@ var (
podInspectFlags = []cli.Flag{
LatestPodFlag,
}
podInspectDescription = "display the configuration for a pod by name or id"
podInspectDescription = "Display the configuration for a pod by name or id"
podInspectCommand = cli.Command{
Name: "inspect",
Usage: "displays a pod configuration",
Usage: "Displays a pod configuration",
Description: podInspectDescription,
Flags: sortFlags(podInspectFlags),
Action: podInspectCmd,

View File

@ -13,7 +13,7 @@ var (
podPauseFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "pause all running pods",
Usage: "Pause all running pods",
},
LatestPodFlag,
}

View File

@ -13,7 +13,7 @@ var (
podRestartFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "restart all pods",
Usage: "Restart all pods",
},
LatestPodFlag,
}

View File

@ -13,7 +13,7 @@ var (
podStartFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "start all running pods",
Usage: "Start all running pods",
},
LatestPodFlag,
}

View File

@ -19,22 +19,22 @@ var (
podStatsFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "show stats for all pods. Only running pods are shown by default.",
Usage: "Show stats for all pods. Only running pods are shown by default.",
},
cli.BoolFlag{
Name: "no-stream",
Usage: "disable streaming stats and only pull the first result, default setting is false",
Usage: "Disable streaming stats and only pull the first result, default setting is false",
},
cli.BoolFlag{
Name: "no-reset",
Usage: "disable resetting the screen between intervals",
Usage: "Disable resetting the screen between intervals",
},
cli.StringFlag{
Name: "format",
Usage: "pretty-print container statistics to JSON or using a Go template",
Usage: "Pretty-print container statistics to JSON or using a Go template",
}, LatestPodFlag,
}
podStatsDescription = "display a live stream of resource usage statistics for the containers in or more pods"
podStatsDescription = "Display a live stream of resource usage statistics for the containers in or more pods"
podStatsCommand = cli.Command{
Name: "stats",
Usage: "Display percentage of CPU, memory, network I/O, block I/O and PIDs for containers in one or more pods",

View File

@ -12,7 +12,7 @@ var (
podStopFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "stop all running pods",
Usage: "Stop all running pods",
},
LatestPodFlag,
cli.UintFlag{

View File

@ -13,7 +13,7 @@ var (
podUnpauseFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "unpause all paused pods",
Usage: "Unpause all paused pods",
},
LatestPodFlag,
}

View File

@ -15,7 +15,7 @@ var (
portFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "display port information for all containers",
Usage: "Display port information for all containers",
},
LatestFlag,
}

View File

@ -41,7 +41,7 @@ var (
},
cli.BoolTFlag{
Name: "tls-verify",
Usage: "require HTTPS and verify certificates when contacting registries (default: true)",
Usage: "Require HTTPS and verify certificates when contacting registries (default: true)",
},
}

View File

@ -21,40 +21,40 @@ var (
pushFlags = []cli.Flag{
cli.StringFlag{
Name: "signature-policy",
Usage: "`pathname` of signature policy file (not usually used)",
Usage: "`Pathname` of signature policy file (not usually used)",
Hidden: true,
},
cli.StringFlag{
Name: "creds",
Usage: "`credentials` (USERNAME:PASSWORD) to use for authenticating to a registry",
Usage: "`Credentials` (USERNAME:PASSWORD) to use for authenticating to a registry",
},
cli.StringFlag{
Name: "cert-dir",
Usage: "`pathname` of a directory containing TLS certificates and keys",
Usage: "`Pathname` of a directory containing TLS certificates and keys",
},
cli.BoolFlag{
Name: "compress",
Usage: "compress tarball image layers when pushing to a directory using the 'dir' transport. (default is same compression type as source)",
Usage: "Compress tarball image layers when pushing to a directory using the 'dir' transport. (default is same compression type as source)",
},
cli.StringFlag{
Name: "format, f",
Usage: "manifest type (oci, v2s1, or v2s2) to use when pushing an image using the 'dir:' transport (default is manifest type of source)",
Usage: "Manifest type (oci, v2s1, or v2s2) to use when pushing an image using the 'dir:' transport (default is manifest type of source)",
},
cli.BoolTFlag{
Name: "tls-verify",
Usage: "require HTTPS and verify certificates when contacting registries (default: true)",
Usage: "Require HTTPS and verify certificates when contacting registries (default: true)",
},
cli.BoolFlag{
Name: "remove-signatures",
Usage: "discard any pre-existing signatures in the image",
Usage: "Discard any pre-existing signatures in the image",
},
cli.StringFlag{
Name: "sign-by",
Usage: "add a signature at the destination using the specified key",
Usage: "Add a signature at the destination using the specified key",
},
cli.BoolFlag{
Name: "quiet, q",
Usage: "don't output progress information when pushing images",
Usage: "Don't output progress information when pushing images",
},
cli.StringFlag{
Name: "authfile",

View File

@ -17,11 +17,11 @@ var (
restartFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "restart all non-running containers",
Usage: "Restart all non-running containers",
},
cli.BoolFlag{
Name: "running",
Usage: "restart only running containers when --all is used",
Usage: "Restart only running containers when --all is used",
},
cli.UintFlag{
Name: "timeout, time, t",

View File

@ -21,18 +21,18 @@ var (
restoreFlags = []cli.Flag{
cli.BoolFlag{
Name: "keep, k",
Usage: "keep all temporary checkpoint files",
Usage: "Keep all temporary checkpoint files",
},
// restore --all would make more sense if there would be
// dedicated state for container which are checkpointed.
// TODO: add ContainerStateCheckpointed
cli.BoolFlag{
Name: "tcp-established",
Usage: "checkpoint a container with established TCP connections",
Usage: "Checkpoint a container with established TCP connections",
},
cli.BoolFlag{
Name: "all, a",
Usage: "restore all checkpointed containers",
Usage: "Restore all checkpointed containers",
},
LatestFlag,
}

View File

@ -15,11 +15,11 @@ var (
rmiFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "remove all images",
Usage: "Remove all images",
},
cli.BoolFlag{
Name: "force, f",
Usage: "force removal of the image",
Usage: "Force removal of the image",
},
}
rmiCommand = cli.Command{
@ -34,7 +34,7 @@ var (
}
rmImageCommand = cli.Command{
Name: "rm",
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 [...]",

View File

@ -20,7 +20,7 @@ var runDescription = "Runs a command in a new container from the given image"
var runFlags []cli.Flag = append(createFlags, cli.BoolTFlag{
Name: "sig-proxy",
Usage: "proxy received signals to the process (default true)",
Usage: "Proxy received signals to the process (default true)",
})
var runCommand = cli.Command{

View File

@ -24,15 +24,15 @@ var (
},
cli.BoolFlag{
Name: "display",
Usage: "preview the command that the label would run",
Usage: "Preview the command that the label would run",
},
cli.StringFlag{
Name: "cert-dir",
Usage: "`pathname` of a directory containing TLS certificates and keys",
Usage: "`Pathname` of a directory containing TLS certificates and keys",
},
cli.StringFlag{
Name: "creds",
Usage: "`credentials` (USERNAME:PASSWORD) to use for authenticating to a registry",
Usage: "`Credentials` (USERNAME:PASSWORD) to use for authenticating to a registry",
},
cli.StringFlag{
Name: "name",
@ -59,15 +59,15 @@ var (
},
cli.BoolFlag{
Name: "pull, p",
Usage: "pull the image if it does not exist locally prior to executing the label contents",
Usage: "Pull the image if it does not exist locally prior to executing the label contents",
},
cli.StringFlag{
Name: "signature-policy",
Usage: "`pathname` of signature policy file (not usually used)",
Usage: "`Pathname` of signature policy file (not usually used)",
},
cli.BoolTFlag{
Name: "tls-verify",
Usage: "require HTTPS and verify certificates when contacting registries (default: true)",
Usage: "Require HTTPS and verify certificates when contacting registries (default: true)",
},
}

View File

@ -29,7 +29,7 @@ var (
saveFlags = []cli.Flag{
cli.BoolFlag{
Name: "compress",
Usage: "compress tarball image layers when saving to a directory using the 'dir' transport. (default is same compression type as source)",
Usage: "Compress tarball image layers when saving to a directory using the 'dir' transport. (default is same compression type as source)",
},
cli.StringFlag{
Name: "output, o",

View File

@ -30,23 +30,23 @@ var (
},
cli.StringSliceFlag{
Name: "filter, f",
Usage: "filter output based on conditions provided (default [])",
Usage: "Filter output based on conditions provided (default [])",
},
cli.StringFlag{
Name: "format",
Usage: "change the output format to a Go template",
Usage: "Change the output format to a Go template",
},
cli.IntFlag{
Name: "limit",
Usage: "limit the number of results",
Usage: "Limit the number of results",
},
cli.BoolFlag{
Name: "no-trunc",
Usage: "do not truncate the output",
Usage: "Do not truncate the output",
},
cli.BoolTFlag{
Name: "tls-verify",
Usage: "require HTTPS and verify certificates when contacting registries (default: true)",
Usage: "Require HTTPS and verify certificates when contacting registries (default: true)",
},
}
searchDescription = `

View File

@ -29,7 +29,7 @@ var (
},
cli.BoolTFlag{
Name: "sig-proxy",
Usage: "proxy received signals to the process (default true if attaching, false otherwise)",
Usage: "Proxy received signals to the process (default true if attaching, false otherwise)",
},
LatestFlag,
}

View File

@ -31,23 +31,23 @@ var (
statsFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "show all containers. Only running containers are shown by default. The default is false",
Usage: "Show all containers. Only running containers are shown by default. The default is false",
},
cli.BoolFlag{
Name: "no-stream",
Usage: "disable streaming stats and only pull the first result, default setting is false",
Usage: "Disable streaming stats and only pull the first result, default setting is false",
},
cli.StringFlag{
Name: "format",
Usage: "pretty-print container statistics to JSON or using a Go template",
Usage: "Pretty-print container statistics to JSON or using a Go template",
},
cli.BoolFlag{
Name: "no-reset",
Usage: "disable resetting the screen between intervals",
Usage: "Disable resetting the screen between intervals",
}, LatestFlag,
}
statsDescription = "display a live stream of one or more containers' resource usage statistics"
statsDescription = "Display a live stream of one or more containers' resource usage statistics"
statsCommand = cli.Command{
Name: "stats",
Usage: "Display percentage of CPU, memory, network I/O, block I/O and PIDs for one or more containers",

View File

@ -21,7 +21,7 @@ var (
},
cli.BoolFlag{
Name: "all, a",
Usage: "stop all running containers",
Usage: "Stop all running containers",
}, LatestFlag,
}
stopDescription = `

View File

@ -22,7 +22,7 @@ var (
pruneSystemFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "remove all unused data",
Usage: "Remove all unused data",
},
cli.BoolFlag{
Name: "force, f",

View File

@ -15,11 +15,11 @@ var (
umountFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "umount all of the currently mounted containers",
Usage: "Umount all of the currently mounted containers",
},
cli.BoolFlag{
Name: "force, f",
Usage: "force the complete umount all of the currently mounted containers",
Usage: "Force the complete umount all of the currently mounted containers",
},
LatestFlag,
}

View File

@ -15,7 +15,7 @@ var (
unpauseFlags = []cli.Flag{
cli.BoolFlag{
Name: "all, a",
Usage: "unpause all paused containers",
Usage: "Unpause all paused containers",
},
}
unpauseDescription = `

View File

@ -24,7 +24,7 @@ var (
varlinkFlags = []cli.Flag{
cli.IntFlag{
Name: "timeout, t",
Usage: "time until the varlink session expires in milliseconds. Use 0 to disable the timeout.",
Usage: "Time until the varlink session expires in milliseconds. Use 0 to disable the timeout.",
Value: 1000,
},
}