Skip to content

Commit

Permalink
contrib/cmd/hiveutil/awstagdeprovision: Add long description
Browse files Browse the repository at this point in the history
Explaining how multiple tag values interact.

Also fix the usage instructions to show that one KEY=VALUE argument is
required and more are optional, as documented in the SYNOPSIS section
of [1].

[1]: http://man7.org/linux/man-pages/man7/man-pages.7.html#DESCRIPTION
  • Loading branch information
wking committed Oct 19, 2018
1 parent 8de157d commit 6e7bacc
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions contrib/cmd/hiveutil/awstagdeprovision.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ func NewDeprovisionAWSWithTagsCommand() *cobra.Command {
opt := &awstagdeprovision.ClusterUninstaller{}
opt.Filters = awstagdeprovision.AWSFilter{}
cmd := &cobra.Command{
Use: "aws-tag-deprovision key=value",
Short: "Deprovision AWS assets (as created by openshift-installer) with a given tag",
Use: "aws-tag-deprovision KEY=VALUE ...",
Short: "Deprovision AWS assets (as created by openshift-installer) with the given tag(s)",
Long: "Deprovision AWS assets (as created by openshift-installer) with the given tag(s). A resource matches the filter if all of the key/value pairs are in its tags.",
Run: func(cmd *cobra.Command, args []string) {
if err := completeAWSUninstaller(opt, args); err != nil {
log.WithError(err).Error("Cannot complete command")
Expand Down

0 comments on commit 6e7bacc

Please sign in to comment.