From b196be7444eca09467ffe0d250ebe8d841620b73 Mon Sep 17 00:00:00 2001 From: Erin Corson Date: Fri, 20 Jan 2017 18:46:22 -0700 Subject: [PATCH] first stab at improving these command descriptions --- cmd/kops/create.go | 2 +- cmd/kops/delete.go | 4 ++-- cmd/kops/describe.go | 2 +- cmd/kops/edit.go | 2 +- cmd/kops/export.go | 2 +- cmd/kops/get.go | 2 +- cmd/kops/import.go | 4 ++-- cmd/kops/rollingupdate.go | 2 +- cmd/kops/secrets.go | 4 ++-- cmd/kops/toolbox.go | 2 +- cmd/kops/update.go | 2 +- cmd/kops/upgrade.go | 2 +- cmd/kops/version.go | 2 +- 13 files changed, 16 insertions(+), 16 deletions(-) diff --git a/cmd/kops/create.go b/cmd/kops/create.go index 7a86de24ee..6259b5ac73 100644 --- a/cmd/kops/create.go +++ b/cmd/kops/create.go @@ -7,7 +7,7 @@ import ( // createCmd represents the create command var createCmd = &cobra.Command{ Use: "create", - Short: "create resources", + Short: "Create a resource by filename or stdin.", Long: `Create resources`, } diff --git a/cmd/kops/delete.go b/cmd/kops/delete.go index df8713bb32..f6d209abad 100644 --- a/cmd/kops/delete.go +++ b/cmd/kops/delete.go @@ -7,8 +7,8 @@ import ( // deleteCmd represents the delete command var deleteCmd = &cobra.Command{ Use: "delete", - Short: "delete clusters", - Long: `Delete clusters`, + Short: "Delete clusters and other resources.", + Long: `Delete resources, such as clusters, instance groups, and secrets.'`, } func init() { diff --git a/cmd/kops/describe.go b/cmd/kops/describe.go index 0adca4a4f4..23520decf5 100644 --- a/cmd/kops/describe.go +++ b/cmd/kops/describe.go @@ -12,7 +12,7 @@ type DescribeCmd struct { var describeCmd = DescribeCmd{ cobraCommand: &cobra.Command{ Use: "describe", - Short: "describe objects", + Short: "Get more information about cloud resources.", }, } diff --git a/cmd/kops/edit.go b/cmd/kops/edit.go index 611c5349a7..869436b3ab 100644 --- a/cmd/kops/edit.go +++ b/cmd/kops/edit.go @@ -7,7 +7,7 @@ import ( // editCmd represents the edit command var editCmd = &cobra.Command{ Use: "edit", - Short: "edit items", + Short: "Edit clusters and other resrouces.", } func init() { diff --git a/cmd/kops/export.go b/cmd/kops/export.go index 44548d29a7..4d7b7e3fae 100644 --- a/cmd/kops/export.go +++ b/cmd/kops/export.go @@ -7,7 +7,7 @@ import ( // exportCmd represents the export command var exportCmd = &cobra.Command{ Use: "export", - Short: "export clusters/kubecfg", + Short: "Exports a kubecfg for target cluster.", Long: `export clusters/kubecfg`, } diff --git a/cmd/kops/get.go b/cmd/kops/get.go index 1fa1018c08..dbc322162d 100644 --- a/cmd/kops/get.go +++ b/cmd/kops/get.go @@ -15,7 +15,7 @@ var getCmd = GetCmd{ cobraCommand: &cobra.Command{ Use: "get", SuggestFor: []string{"list"}, - Short: "list or get objects", + Short: "List all instances of a resource.", Long: `list or get objects`, }, } diff --git a/cmd/kops/import.go b/cmd/kops/import.go index 4e6d11c434..b7488c2488 100644 --- a/cmd/kops/import.go +++ b/cmd/kops/import.go @@ -7,8 +7,8 @@ import ( // importCmd represents the import command var importCmd = &cobra.Command{ Use: "import", - Short: "import clusters", - Long: `import clusters`, + Short: "Import existing resources into the state store.", + Long: `Import existing resources, such as clusters into the state store.`, } func init() { diff --git a/cmd/kops/rollingupdate.go b/cmd/kops/rollingupdate.go index ef7e67908d..d5f424b91b 100644 --- a/cmd/kops/rollingupdate.go +++ b/cmd/kops/rollingupdate.go @@ -12,7 +12,7 @@ type RollingUpdateCmd struct { var rollingUpdateCommand = RollingUpdateCmd{ cobraCommand: &cobra.Command{ Use: "rolling-update", - Short: "rolling update clusters", + Short: "Initiate rolling updates on clusters.", Long: `rolling update clusters`, }, } diff --git a/cmd/kops/secrets.go b/cmd/kops/secrets.go index ca2a4d2bf7..06c2d4abd5 100644 --- a/cmd/kops/secrets.go +++ b/cmd/kops/secrets.go @@ -7,8 +7,8 @@ import ( // secretsCmd represents the secrets command var secretsCmd = &cobra.Command{ Use: "secrets", - Short: "Manage secrets & keys", - Long: `Manage secrets & keys`, + Short: "Manage secrets & keys.", + Long: `Manage secrets & keys.`, } func init() { diff --git a/cmd/kops/toolbox.go b/cmd/kops/toolbox.go index fe6fd0966a..d12b6639b4 100644 --- a/cmd/kops/toolbox.go +++ b/cmd/kops/toolbox.go @@ -7,7 +7,7 @@ import ( // toolboxCmd represents the toolbox command var toolboxCmd = &cobra.Command{ Use: "toolbox", - Short: "Misc infrequently used commands", + Short: "Misc infrequently used commands.", } func init() { diff --git a/cmd/kops/update.go b/cmd/kops/update.go index 79a7191ae6..df1c00748a 100644 --- a/cmd/kops/update.go +++ b/cmd/kops/update.go @@ -7,7 +7,7 @@ import ( // updateCmd represents the create command var updateCmd = &cobra.Command{ Use: "update", - Short: "update clusters", + Short: "Creates or updates cloud resources to match cluster spec.", Long: `Update clusters`, } diff --git a/cmd/kops/upgrade.go b/cmd/kops/upgrade.go index 6c296dfd0a..f99c7e7141 100644 --- a/cmd/kops/upgrade.go +++ b/cmd/kops/upgrade.go @@ -7,7 +7,7 @@ import ( // upgradeCmd represents the upgrade command var upgradeCmd = &cobra.Command{ Use: "upgrade", - Short: "upgrade clusters", + Short: "Automates checking for and applying Kubernetes updates.", Long: `upgrade clusters`, } diff --git a/cmd/kops/version.go b/cmd/kops/version.go index 20924fa8ee..09d8cac463 100644 --- a/cmd/kops/version.go +++ b/cmd/kops/version.go @@ -13,7 +13,7 @@ type VersionCmd struct { var versionCmd = VersionCmd{ cobraCommand: &cobra.Command{ Use: "version", - Short: "Print the client version information", + Short: "Print the client version information.", }, }