From 24988df444911bb81f8258910da64397bb00b82f Mon Sep 17 00:00:00 2001 From: bzub Date: Mon, 30 Mar 2020 12:42:37 -0500 Subject: [PATCH] config: update docs to use list-setters. --- cmd/config/docs/commands/list-setters.md | 2 +- cmd/config/docs/commands/set.md | 8 ++++---- cmd/config/internal/generateddocs/commands/docs.go | 10 +++++----- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/cmd/config/docs/commands/list-setters.md b/cmd/config/docs/commands/list-setters.md index 95926141f..734ae48ca 100644 --- a/cmd/config/docs/commands/list-setters.md +++ b/cmd/config/docs/commands/list-setters.md @@ -18,6 +18,6 @@ List setters for Resources. Show setters: - $ config set DIR/ + $ config list-setters DIR/ NAME DESCRIPTION VALUE TYPE COUNT SETBY name-prefix '' PREFIX string 2 diff --git a/cmd/config/docs/commands/set.md b/cmd/config/docs/commands/set.md index e4f604255..bacbfbb3c 100644 --- a/cmd/config/docs/commands/set.md +++ b/cmd/config/docs/commands/set.md @@ -28,8 +28,8 @@ the configuration as comments. Optional. The value to set on the field. -To print the possible setters for the Resources in a directory, run `set` on -a directory -- e.g. `kustomize config set DIR/`. +To print the possible setters for the Resources in a directory, run +`list-setters` on a directory -- e.g. `kustomize config list-setters DIR/`. #### Tips @@ -58,7 +58,7 @@ To create a custom setter for a field see: `kustomize help config create-setter` List setters: Show the possible setters - $ config set DIR/ + $ config list-setters DIR/ NAME DESCRIPTION VALUE TYPE COUNT SETBY name-prefix '' PREFIX string 2 @@ -69,7 +69,7 @@ To create a custom setter for a field see: `kustomize help config create-setter` List setters: Show the new values - $ config set DIR/ + $ config list-setters DIR/ NAME DESCRIPTION VALUE TYPE COUNT SETBY name-prefix 'test environment' test string 2 dev diff --git a/cmd/config/internal/generateddocs/commands/docs.go b/cmd/config/internal/generateddocs/commands/docs.go index 7c500a51d..163399efb 100644 --- a/cmd/config/internal/generateddocs/commands/docs.go +++ b/cmd/config/internal/generateddocs/commands/docs.go @@ -171,7 +171,7 @@ List setters for Resources. var ListSettersExamples = ` Show setters: - $ config set DIR/ + $ config list-setters DIR/ NAME DESCRIPTION VALUE TYPE COUNT SETBY name-prefix '' PREFIX string 2` @@ -289,8 +289,8 @@ the configuration as comments. Optional. The value to set on the field. -To print the possible setters for the Resources in a directory, run ` + "`" + `set` + "`" + ` on -a directory -- e.g. ` + "`" + `kustomize config set DIR/` + "`" + `. +To print the possible setters for the Resources in a directory, run +` + "`" + `list-setters` + "`" + ` on a directory -- e.g. ` + "`" + `kustomize config list-setters DIR/` + "`" + `. #### Tips @@ -318,7 +318,7 @@ var SetExamples = ` List setters: Show the possible setters - $ config set DIR/ + $ config list-setters DIR/ NAME DESCRIPTION VALUE TYPE COUNT SETBY name-prefix '' PREFIX string 2 @@ -329,7 +329,7 @@ var SetExamples = ` List setters: Show the new values - $ config set DIR/ + $ config list-setters DIR/ NAME DESCRIPTION VALUE TYPE COUNT SETBY name-prefix 'test environment' test string 2 dev