From eefad096fd2a817f426faf4b4a6e246cfff6c6fc Mon Sep 17 00:00:00 2001
From: Michail Kargakis <mkargaki@redhat.com>
Date: Wed, 20 Jan 2016 13:47:22 +0100
Subject: [PATCH] oadm: bump prune deployments description/examples

---
 docs/generated/oadm_by_example_content.adoc | 16 +++++++++++++
 pkg/cmd/admin/prune/deployments.go          | 25 ++++++++++++++++-----
 2 files changed, 35 insertions(+), 6 deletions(-)

diff --git a/docs/generated/oadm_by_example_content.adoc b/docs/generated/oadm_by_example_content.adoc
index 3b8d4342195d..3ae88e5f669f 100644
--- a/docs/generated/oadm_by_example_content.adoc
+++ b/docs/generated/oadm_by_example_content.adoc
@@ -346,6 +346,22 @@ Replace cluster SCCs to match the recommended bootstrap policy
 ====
 
 
+== oadm prune deployments
+Remove old completed and failed deployments
+
+====
+
+[options="nowrap"]
+----
+  # Dry run deleting all but the last complete deployment for every deployment config
+  $ oadm prune deployments --keep-complete=1
+
+  # To actually perform the prune operation, the confirm flag must be appended
+  $ oadm prune deployments --keep-complete=1 --confirm
+----
+====
+
+
 == oadm prune images
 Remove unreferenced images
 
diff --git a/pkg/cmd/admin/prune/deployments.go b/pkg/cmd/admin/prune/deployments.go
index 1711b7d890d7..1f60b9f65abb 100644
--- a/pkg/cmd/admin/prune/deployments.go
+++ b/pkg/cmd/admin/prune/deployments.go
@@ -21,10 +21,22 @@ import (
 	deployutil "github.com/openshift/origin/pkg/deploy/util"
 )
 
-const deploymentsLongDesc = `%s %s - Remove older completed and failed deployments`
-
 const PruneDeploymentsRecommendedName = "deployments"
 
+const (
+	deploymentsLongDesc = `Prune old completed and failed deployments
+
+By default, the prune operation performs a dry run making no changes to the deployments.
+A --confirm flag is needed for changes to be effective.
+`
+
+	deploymentsExample = `  # Dry run deleting all but the last complete deployment for every deployment config
+  $ %[1]s %[2]s --keep-complete=1
+
+  # To actually perform the prune operation, the confirm flag must be appended
+  $ %[1]s %[2]s --keep-complete=1 --confirm`
+)
+
 type pruneDeploymentConfig struct {
 	Confirm         bool
 	KeepYoungerThan time.Duration
@@ -42,10 +54,11 @@ func NewCmdPruneDeployments(f *clientcmd.Factory, parentName, name string, out i
 	}
 
 	cmd := &cobra.Command{
-		Use:   name,
-		Short: "Remove completed and failed deployments",
-		Long:  fmt.Sprintf(deploymentsLongDesc, parentName, name),
-
+		Use:        name,
+		Short:      "Remove old completed and failed deployments",
+		Long:       deploymentsLongDesc,
+		Example:    fmt.Sprintf(deploymentsExample, parentName, name),
+		SuggestFor: []string{"deployment", "deployments"},
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) > 0 {
 				glog.Fatalf("No arguments are allowed to this command")