mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-05-17 18:25:26 +00:00
Remove dots from short descriptions
This commit is contained in:
@@ -11,7 +11,7 @@ import (
|
||||
func GetCfg(name string) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "cfg",
|
||||
Short: "Commands for reading and writing configuration.",
|
||||
Short: "Commands for reading and writing configuration",
|
||||
}
|
||||
|
||||
cmd.AddCommand(commands.AnnotateCommand(name))
|
||||
|
||||
@@ -11,7 +11,7 @@ import (
|
||||
func GetFn(name string) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "fn",
|
||||
Short: "Commands for running functions against configuration.",
|
||||
Short: "Commands for running functions against configuration",
|
||||
}
|
||||
|
||||
cmd.AddCommand(commands.RunCommand(name))
|
||||
|
||||
@@ -42,7 +42,7 @@ func MakeHelp(pgmName, cmdName string) *Help {
|
||||
fN := konfig.DefaultKustomizationFileName()
|
||||
return &Help{
|
||||
Use: cmdName + " DIR",
|
||||
Short: "Build a kustomization target from a directory or URL.",
|
||||
Short: "Build a kustomization target from a directory or URL",
|
||||
Long: fmt.Sprintf(`Build a set of KRM resources using a '%s' file.
|
||||
The DIR argument must be a path to a directory containing
|
||||
'%s', or a git repository URL with a path suffix
|
||||
|
||||
@@ -204,7 +204,7 @@ func TestHelp(t *testing.T) {
|
||||
if cmd.Use != "bar DIR" {
|
||||
t.Fatalf("Unexpected usage: %s\n", cmd.Use)
|
||||
}
|
||||
if cmd.Short != "Build a kustomization target from a directory or URL." {
|
||||
if cmd.Short != "Build a kustomization target from a directory or URL" {
|
||||
t.Fatalf("Unexpected short help: %s\n", cmd.Short)
|
||||
}
|
||||
if !strings.Contains(cmd.Long, "If DIR is omitted, '.' is assumed.") {
|
||||
|
||||
@@ -24,7 +24,7 @@ func newCmdAddComponent(fSys filesys.FileSystem) *cobra.Command {
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "component",
|
||||
Short: "Add the name of a file containing a component to the kustomization file.",
|
||||
Short: "Add the name of a file containing a component to the kustomization file",
|
||||
Example: `
|
||||
add component {filepath}`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
|
||||
@@ -23,7 +23,7 @@ func newCmdAddGenerator(fSys filesys.FileSystem) *cobra.Command {
|
||||
var o addGeneratorOptions
|
||||
cmd := &cobra.Command{
|
||||
Use: "generator",
|
||||
Short: "Add the name of a file containing a generator configuration to the kustomization file.",
|
||||
Short: "Add the name of a file containing a generator configuration to the kustomization file",
|
||||
Example: `
|
||||
add generator {filepath}`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
|
||||
@@ -24,7 +24,7 @@ func newCmdAddPatch(fSys filesys.FileSystem) *cobra.Command {
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "patch",
|
||||
Short: "Add an item to patches field.",
|
||||
Short: "Add an item to patches field",
|
||||
Long: `This command will add an item to patches field in the kustomization file.
|
||||
Each item may:
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@ func newCmdAddResource(fSys filesys.FileSystem) *cobra.Command {
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "resource",
|
||||
Short: "Add the name of a file containing a resource to the kustomization file.",
|
||||
Short: "Add the name of a file containing a resource to the kustomization file",
|
||||
Example: `
|
||||
add resource {filepath}`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
|
||||
@@ -23,7 +23,7 @@ func newCmdAddTransformer(fSys filesys.FileSystem) *cobra.Command {
|
||||
var o addTransformerOptions
|
||||
cmd := &cobra.Command{
|
||||
Use: "transformer",
|
||||
Short: "Add the name of a file containing a transformer configuration to the kustomization file.",
|
||||
Short: "Add the name of a file containing a transformer configuration to the kustomization file",
|
||||
Example: `
|
||||
add transformer {filepath}`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
|
||||
@@ -17,7 +17,7 @@ func NewCmdAdd(
|
||||
rf *resource.Factory) *cobra.Command {
|
||||
c := &cobra.Command{
|
||||
Use: "add",
|
||||
Short: "Adds an item to the kustomization file.",
|
||||
Short: "Adds an item to the kustomization file",
|
||||
Long: "",
|
||||
Example: `
|
||||
# Adds a secret to the kustomization file
|
||||
|
||||
@@ -20,7 +20,7 @@ func newCmdAddConfigMap(
|
||||
var flags flagsAndArgs
|
||||
cmd := &cobra.Command{
|
||||
Use: "configmap NAME [--behavior={create|merge|replace}] [--from-file=[key=]source] [--from-literal=key1=value1]",
|
||||
Short: "Adds a configmap to the kustomization file.",
|
||||
Short: "Adds a configmap to the kustomization file",
|
||||
Long: "",
|
||||
Example: `
|
||||
# Adds a configmap to the kustomization file (with a specified key)
|
||||
|
||||
@@ -15,7 +15,7 @@ func NewCmdRemove(
|
||||
v ifc.Validator) *cobra.Command {
|
||||
c := &cobra.Command{
|
||||
Use: "remove",
|
||||
Short: "Removes items from the kustomization file.",
|
||||
Short: "Removes items from the kustomization file",
|
||||
Long: "",
|
||||
Example: `
|
||||
# Removes resources from the kustomization file
|
||||
|
||||
@@ -13,7 +13,7 @@ import (
|
||||
func NewCmdSet(fSys filesys.FileSystem, ldr ifc.KvLoader, v ifc.Validator) *cobra.Command {
|
||||
c := &cobra.Command{
|
||||
Use: "set",
|
||||
Short: "Sets the value of different fields in kustomization file.",
|
||||
Short: "Sets the value of different fields in kustomization file",
|
||||
Long: "",
|
||||
Example: `
|
||||
# Sets the nameprefix field
|
||||
|
||||
@@ -21,7 +21,7 @@ func newCmdSetNamePrefix(fSys filesys.FileSystem) *cobra.Command {
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "nameprefix",
|
||||
Short: "Sets the value of the namePrefix field in the kustomization file.",
|
||||
Short: "Sets the value of the namePrefix field in the kustomization file",
|
||||
Example: `
|
||||
The command
|
||||
set nameprefix acme-
|
||||
|
||||
@@ -21,7 +21,7 @@ func newCmdSetNameSuffix(fSys filesys.FileSystem) *cobra.Command {
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "namesuffix",
|
||||
Short: "Sets the value of the nameSuffix field in the kustomization file.",
|
||||
Short: "Sets the value of the nameSuffix field in the kustomization file",
|
||||
Example: `
|
||||
The command
|
||||
set namesuffix -- -acme
|
||||
|
||||
Reference in New Issue
Block a user