github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-06 18:54:06 +00:00
Code Issues Projects Releases Wiki Activity

kubectl: improve docstring on deprecatedCmd

Browse Source
This commit is contained in:
Alexander Campbell 2017-05-19 07:42:15 -07:00
parent 9e7f29c3fb
commit b3fc6556e4
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
pkg/kubectl/cmd/cmd.go
View File

@ -391,8 +391,9 @@ func printDeprecationWarning(command, alias string) {
glog.Warningf("%s is DEPRECATED and will be removed in a future version. Use %s instead.", alias, command)
}
// Create a constructor for a command that redirects to another command, but
// first prints a deprecation message.
// deprecatedCmd is intended to be used to create a "wrapper" command around an
// existing command. The wrapper works the same but prints a deprecation
// message before running.
func deprecatedCmd(deprecatedVersion string, cmd *cobra.Command) *cobra.Command {
// Have to be careful here because Cobra automatically extracts the name
// of the command from the .Use field.