Merge pull request #12724 from juanvallejo/jvallejo/oc-help-output-improvements

Merged by openshift-bot

Author: OpenShift Bot

docs/man/man1/oc-scale.1

@@ -21,6 +21,9 @@ Scale also allows users to specify one or more preconditions for the scale actio
 .PP
 Note that scaling a deployment configuration with no deployments will update the desired replicas in the configuration template.
 
+.PP
+Supported resources: ["deployment" "replicaset" "replicationcontroller" "job" "deploymentconfig"]
+
 
 .SH OPTIONS
 .PP

docs/man/man1/openshift-cli-scale.1

@@ -21,6 +21,9 @@ Scale also allows users to specify one or more preconditions for the scale actio
 .PP
 Note that scaling a deployment configuration with no deployments will update the desired replicas in the configuration template.
 
+.PP
+Supported resources: ["deployment" "replicaset" "replicationcontroller" "job" "deploymentconfig"]
+
 
 .SH OPTIONS
 .PP

pkg/cmd/cli/cmd/process.go

@@ -61,7 +61,7 @@ var (
 // NewCmdProcess implements the OpenShift cli process command
 func NewCmdProcess(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "process (TEMPLATE | -f FILENAME) [-v=KEY=VALUE]",
+		Use:     "process (TEMPLATE | -f FILENAME) [-p=KEY=VALUE]",
 		Short:   "Process a template into list of resources",
 		Long:    processLong,
 		Example: fmt.Sprintf(processExample, fullName),

pkg/cmd/cli/cmd/wrappers.go

@@ -341,7 +341,10 @@ var (
 		scale is sent to the server.
 
 		Note that scaling a deployment configuration with no deployments will update the
-		desired replicas in the configuration template.`)
+		desired replicas in the configuration template.
+
+		Supported resources:
+		%q`)
 
 	scaleExample = templates.Examples(`
 		# Scale replication controller named 'foo' to 3.
@@ -358,10 +361,10 @@ var (
 // NewCmdScale is a wrapper for the Kubernetes cli scale command
 func NewCmdScale(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command {
 	cmd := kcmd.NewCmdScale(f, out)
+	cmd.ValidArgs = append(cmd.ValidArgs, "deploymentconfig")
 	cmd.Short = "Change the number of pods in a deployment"
-	cmd.Long = scaleLong
+	cmd.Long = fmt.Sprintf(scaleLong, cmd.ValidArgs)
 	cmd.Example = fmt.Sprintf(scaleExample, fullName)
-	cmd.ValidArgs = append(cmd.ValidArgs, "deploymentconfig")
 	return cmd
 }
 

pkg/cmd/cli/describe/helpers.go

@@ -65,7 +65,12 @@ func formatEnv(env api.EnvVar) string {
 }
 
 func formatString(out *tabwriter.Writer, label string, v interface{}) {
-	fmt.Fprintf(out, fmt.Sprintf("%s:\t%s\n", label, toString(v)))
+	labelVals := strings.Split(toString(v), "\n")
+
+	fmt.Fprintf(out, fmt.Sprintf("%s:", label))
+	for _, lval := range labelVals {
+		fmt.Fprintf(out, fmt.Sprintf("\t%s\n", lval))
+	}
 }
 
 func formatTime(out *tabwriter.Writer, label string, t time.Time) {

pkg/generate/app/cmd/template.go

@@ -45,6 +45,14 @@ func TransformTemplate(tpl *templateapi.Template, client client.TemplateConfigsN
 	return result, nil
 }
 
+func formatString(out io.Writer, tab, s string) {
+	labelVals := strings.Split(s, "\n")
+
+	for _, lval := range labelVals {
+		fmt.Fprintf(out, fmt.Sprintf("%s%s\n", tab, lval))
+	}
+}
+
 // DescribeGeneratedTemplate writes a description of the provided template to out.
 func DescribeGeneratedTemplate(out io.Writer, input string, result *templateapi.Template, baseNamespace string) {
 	qualifiedName := localOrRemoteName(result.ObjectMeta, baseNamespace)
@@ -64,13 +72,14 @@ func DescribeGeneratedTemplate(out io.Writer, input string, result *templateapi.
 		fmt.Fprintf(out, "     %s\n", name)
 		fmt.Fprintf(out, "     ---------\n")
 		if len(description) > 0 {
-			fmt.Fprintf(out, "     %s\n", description)
+			formatString(out, "     ", description)
 			fmt.Fprintln(out)
 		}
 		if len(message) > 0 {
-			fmt.Fprintf(out, "     %s\n", message)
+			formatString(out, "     ", message)
 			fmt.Fprintln(out)
 		}
+		fmt.Fprintln(out)
 	}
 
 	if warnings := result.Annotations[app.GenerationWarningAnnotation]; len(warnings) > 0 {