diff --git a/cmd/config/internal/commands/cmddeletesetter.go b/cmd/config/internal/commands/cmddeletesetter.go index 19fc9253a..5607046f2 100644 --- a/cmd/config/internal/commands/cmddeletesetter.go +++ b/cmd/config/internal/commands/cmddeletesetter.go @@ -6,6 +6,7 @@ package commands import ( "github.com/spf13/cobra" "sigs.k8s.io/kustomize/cmd/config/ext" + "sigs.k8s.io/kustomize/cmd/config/internal/generateddocs/commands" "sigs.k8s.io/kustomize/kyaml/openapi" "sigs.k8s.io/kustomize/kyaml/setters2/settersutil" ) @@ -16,9 +17,9 @@ func NewDeleteSetterRunner(parent string) *DeleteSetterRunner { c := &cobra.Command{ Use: "delete-setter DIR NAME", Args: cobra.MinimumNArgs(2), - Short: "delete values on Resources fields.", - Long: "", - Example: "", + Short: commands.DeleteSetterShort, + Long: commands.DeleteSetterLong, + Example: commands.DeleteSetterExamples, PreRunE: r.preRunE, RunE: r.runE, } diff --git a/cmd/config/internal/generateddocs/commands/docs.go b/cmd/config/internal/generateddocs/commands/docs.go index fb567dbff..bcad51a38 100644 --- a/cmd/config/internal/generateddocs/commands/docs.go +++ b/cmd/config/internal/generateddocs/commands/docs.go @@ -89,6 +89,22 @@ var CreateSetterExamples = ` kustomize cfg create-setter DIR/ image-tag v1.0.1 --type "string" \ --field image --description "current stable release"` +var DeleteSetterShort = `[Alpha] Delete a custom setter of a resource field` +var DeleteSetterLong = ` +Delete a custom setter of a Resource field by inlining OpenAPI as comments. + + DIR + + A directory containing Resource configuration. + + NAME + + The name of the setter to delete. +` +var DeleteSetterExamples = ` + # delete a setter for port fields + kustomize cfg delete-setter DIR/ port` + var FmtShort = `[Alpha] Format yaml configuration files.` var FmtLong = ` [Alpha] Format yaml configuration files.