From af8b7c86f87d845378f09ce6d8a8c3a262b4ffca Mon Sep 17 00:00:00 2001 From: carlory Date: Wed, 13 Jul 2022 13:09:30 +0800 Subject: [PATCH] enable addition of [flags] to the usage line of a command when printing help or generating docs Signed-off-by: carlory --- pkg/karmadactl/describe.go | 9 ++++----- pkg/karmadactl/exec.go | 9 ++++----- pkg/karmadactl/get.go | 9 ++++----- 3 files changed, 12 insertions(+), 15 deletions(-) diff --git a/pkg/karmadactl/describe.go b/pkg/karmadactl/describe.go index 3434ef1f8..f964ac15c 100644 --- a/pkg/karmadactl/describe.go +++ b/pkg/karmadactl/describe.go @@ -33,11 +33,10 @@ func NewCmdDescribe(karmadaConfig KarmadaConfig, parentCommand string) *cobra.Co } cmd := &cobra.Command{ - Use: "describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME) (-C CLUSTER)", - DisableFlagsInUseLine: true, - Short: "Show details of a specific resource or group of resources in a cluster", - SilenceUsage: true, - Example: describeExample(parentCommand), + Use: "describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME) (-C CLUSTER)", + Short: "Show details of a specific resource or group of resources in a cluster", + SilenceUsage: true, + Example: describeExample(parentCommand), RunE: func(cmd *cobra.Command, args []string) error { if err := o.Complete(karmadaConfig, args); err != nil { return err diff --git a/pkg/karmadactl/exec.go b/pkg/karmadactl/exec.go index 624fe9d90..78548fdc1 100644 --- a/pkg/karmadactl/exec.go +++ b/pkg/karmadactl/exec.go @@ -29,11 +29,10 @@ func NewCmdExec(karmadaConfig KarmadaConfig, parentCommand string) *cobra.Comman } cmd := &cobra.Command{ - Use: "exec (POD | TYPE/NAME) [-c CONTAINER] [flags] (-C CLUSTER) -- COMMAND [args...]", - DisableFlagsInUseLine: true, - Short: "Execute a command in a container in a cluster", - Long: "Execute a command in a container in a cluster", - Example: execExample(parentCommand), + Use: "exec (POD | TYPE/NAME) [-c CONTAINER] [flags] (-C CLUSTER) -- COMMAND [args...]", + Short: "Execute a command in a container in a cluster", + Long: "Execute a command in a container in a cluster", + Example: execExample(parentCommand), RunE: func(cmd *cobra.Command, args []string) error { argsLenAtDash := cmd.ArgsLenAtDash() if err := o.Complete(karmadaConfig, cmd, args, argsLenAtDash); err != nil { diff --git a/pkg/karmadactl/get.go b/pkg/karmadactl/get.go index bca4c7fa4..7d49e4669 100644 --- a/pkg/karmadactl/get.go +++ b/pkg/karmadactl/get.go @@ -66,11 +66,10 @@ func NewCmdGet(karmadaConfig KarmadaConfig, parentCommand string) *cobra.Command ioStreams := genericclioptions.IOStreams{In: getIn, Out: getOut, ErrOut: getErr} o := NewCommandGetOptions("karmadactl", ioStreams) cmd := &cobra.Command{ - Use: "get [NAME | -l label | -n namespace] [flags]", - DisableFlagsInUseLine: true, - Short: getShort, - SilenceUsage: true, - Example: getExample(parentCommand), + Use: "get [NAME | -l label | -n namespace] [flags]", + Short: getShort, + SilenceUsage: true, + Example: getExample(parentCommand), RunE: func(cmd *cobra.Command, args []string) error { if err := o.Complete(karmadaConfig); err != nil { return err