Merge pull request #349 from chris-crone/help-cleanup

Capitalise help outputs
docker · Aug 22, 2018 · 643134b · 643134b
2 parents 525d93b + 92b9b8b
commit 643134b
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -235,12 +235,23 @@ We have lots of ideas for making Compose-based applications easier to share and
 
 ```
 $ docker-app
-Build and deploy Docker applications.
 
-Usage:
-  docker-app [command]
+Usage:  docker-app [OPTIONS] COMMAND
 
-Available Commands:
+Docker Application Packages
+
+Options:
+  -D, --debug              Enable debug mode
+  -H, --host list          Daemon socket(s) to connect to
+  -l, --log-level string   Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info")
+      --tls                Use TLS; implied by --tlsverify
+      --tlscacert string   Trust certs signed only by this CA (default "/Users/chris/.docker/ca.pem")
+      --tlscert string     Path to TLS certificate file (default "/Users/chris/.docker/cert.pem")
+      --tlskey string      Path to TLS key file (default "/Users/chris/.docker/key.pem")
+      --tlsverify          Use TLS and verify the remote
+  -v, --version            Print version information
+
+Commands:
   completion  Generates bash completion scripts
   deploy      Deploy or update an application
   fork        Create a fork of an existing application to be modified
@@ -256,9 +267,5 @@ Available Commands:
   validate    Checks the rendered application is syntactically correct
   version     Print version information
 
-Flags:
-      --debug   Enable debug mode
-  -h, --help    help for docker-app
-
-Use "docker-app [command] --help" for more information about a command.
+Run 'docker-app COMMAND --help' for more information on a command.
 ```
diff --git a/cmd/docker-app/deploy.go b/cmd/docker-app/deploy.go
@@ -43,10 +43,10 @@ func deployCmd(dockerCli command.Cli) *cobra.Command {
 	cmd.Flags().StringArrayVarP(&opts.deploySettingsFiles, "settings-files", "f", []string{}, "Override settings files")
 	cmd.Flags().StringArrayVarP(&opts.deployEnv, "set", "s", []string{}, "Override settings values")
 	cmd.Flags().StringVarP(&opts.deployOrchestrator, "orchestrator", "o", "swarm", "Orchestrator to deploy on (swarm, kubernetes)")
-	cmd.Flags().StringVarP(&opts.deployKubeConfig, "kubeconfig", "k", "", "kubeconfig file to use")
-	cmd.Flags().StringVarP(&opts.deployNamespace, "namespace", "n", "default", "namespace to deploy into")
-	cmd.Flags().StringVarP(&opts.deployStackName, "name", "d", "", "stack name (default: app name)")
-	cmd.Flags().BoolVarP(&opts.deploySendRegistryAuth, "with-registry-auth", "", false, "sends registry auth")
+	cmd.Flags().StringVarP(&opts.deployKubeConfig, "kubeconfig", "k", "", "Kubernetes config file to use")
+	cmd.Flags().StringVarP(&opts.deployNamespace, "namespace", "n", "default", "Kubernetes namespace to deploy into")
+	cmd.Flags().StringVarP(&opts.deployStackName, "name", "d", "", "Stack name (default: app name)")
+	cmd.Flags().BoolVarP(&opts.deploySendRegistryAuth, "with-registry-auth", "", false, "Sends registry auth")
 	if internal.Experimental == "on" {
 		cmd.Flags().StringArrayVarP(&opts.deployComposeFiles, "compose-files", "c", []string{}, "Override Compose files")
 	}

diff --git a/cmd/docker-app/push.go b/cmd/docker-app/push.go
@@ -26,7 +26,7 @@ func pushCmd() *cobra.Command {
 			return packager.Push(app, opts.namespace, opts.tag)
 		},
 	}
-	cmd.Flags().StringVar(&opts.namespace, "namespace", "", "namespace to use (default: namespace in metadata)")
-	cmd.Flags().StringVarP(&opts.tag, "tag", "t", "", "tag to use (default: version in metadata)")
+	cmd.Flags().StringVar(&opts.namespace, "namespace", "", "Namespace to use (default: namespace in metadata)")
+	cmd.Flags().StringVarP(&opts.tag, "tag", "t", "", "Tag to use (default: version in metadata)")
 	return cmd
 }
diff --git a/cmd/docker-app/root.go b/cmd/docker-app/root.go
@@ -21,8 +21,8 @@ func newRootCmd(dockerCli *command.DockerCli) *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:          "docker-app",
-		Short:        "Docker App Packages",
-		Long:         `Build and deploy Docker applications.`,
+		Short:        "Docker Application Packages",
+		Long:         `Build and deploy Docker Application Packages.`,
 		SilenceUsage: true,
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 			opts.Common.SetDefaultOptions(flags)
@@ -33,6 +33,7 @@ func newRootCmd(dockerCli *command.DockerCli) *cobra.Command {
 	}
 	cli.SetupRootCommand(cmd)
 	flags = cmd.Flags()
+	flags.BoolP("version", "v", false, "Print version information")
 	opts.Common.InstallFlags(flags)
 	cmd.SetVersionTemplate("docker-app version {{.Version}}\n")
 	addCommands(cmd, dockerCli)

diff --git a/cmd/docker-app/save.go b/cmd/docker-app/save.go
@@ -33,7 +33,7 @@ func saveCmd(dockerCli command.Cli) *cobra.Command {
 			return err
 		},
 	}
-	cmd.Flags().StringVar(&opts.namespace, "namespace", "", "namespace to use (default: namespace in metadata)")
-	cmd.Flags().StringVarP(&opts.tag, "tag", "t", "", "tag to use (default: version in metadata)")
+	cmd.Flags().StringVar(&opts.namespace, "namespace", "", "Namespace to use (default: namespace in metadata)")
+	cmd.Flags().StringVarP(&opts.tag, "tag", "t", "", "Tag to use (default: version in metadata)")
 	return cmd
 }