From 60b4454f50ae7c8d91efd249f829e4032fe8da4b Mon Sep 17 00:00:00 2001 From: Halimao <1065621723@qq.com> Date: Tue, 16 Jan 2024 15:46:20 +0800 Subject: [PATCH] chore(confix): update ` config` subcommand description (#19047) (cherry picked from commit 753ac5d8507fcb06c086e5e7dc0288244d1ddfcb) --- tools/confix/cmd/home.go | 2 +- tools/confix/cmd/mutate.go | 4 ++-- tools/confix/cmd/view.go | 1 + 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/tools/confix/cmd/home.go b/tools/confix/cmd/home.go index 5b40cac42351..1210303a1cc4 100644 --- a/tools/confix/cmd/home.go +++ b/tools/confix/cmd/home.go @@ -9,7 +9,7 @@ import ( func HomeCommand() *cobra.Command { return &cobra.Command{ Use: "home", - Short: "Outputs the folder used as the binary home. No home directory is set when using the tool standalone.", + Short: "Outputs the folder used as the binary home. No home directory is set when using the `confix` tool standalone.", Long: `Outputs the folder used as the binary home. In order to change the home directory path, set the $APPD_HOME environment variable, or use the "--home" flag.`, Args: cobra.NoArgs, Run: func(cmd *cobra.Command, args []string) { diff --git a/tools/confix/cmd/mutate.go b/tools/confix/cmd/mutate.go index 0f3c030d385b..6d42b3c6e35f 100644 --- a/tools/confix/cmd/mutate.go +++ b/tools/confix/cmd/mutate.go @@ -21,7 +21,7 @@ func SetCommand() *cobra.Command { cmd := &cobra.Command{ Use: "set [config] [key] [value]", Short: "Set an application config value", - Long: "Set an application config value. The [config] argument must be the path of the file when using the tool standalone, otherwise it must be the name of the config file without the .toml extension.", + Long: "Set an application config value. The [config] argument must be the path of the file when using the `confix` tool standalone, otherwise it must be the name of the config file without the .toml extension.", Args: cobra.ExactArgs(3), RunE: func(cmd *cobra.Command, args []string) error { filename, inputValue := args[0], args[2] @@ -88,7 +88,7 @@ func GetCommand() *cobra.Command { cmd := &cobra.Command{ Use: "get [config] [key]", Short: "Get an application config value", - Long: "Get an application config value. The [config] argument must be the path of the file when using the too standalone, otherwise it must be the name of the config file without the .toml extension.", + Long: "Get an application config value. The [config] argument must be the path of the file when using the `confix` tool standalone, otherwise it must be the name of the config file without the .toml extension.", Args: cobra.ExactArgs(2), RunE: func(cmd *cobra.Command, args []string) error { filename, key := args[0], args[1] diff --git a/tools/confix/cmd/view.go b/tools/confix/cmd/view.go index bab2116c0453..26c3b6a16fdd 100644 --- a/tools/confix/cmd/view.go +++ b/tools/confix/cmd/view.go @@ -17,6 +17,7 @@ func ViewCommand() *cobra.Command { cmd := &cobra.Command{ Use: "view [config]", Short: "View the config file", + Long: "View the config file. The [config] argument must be the path of the file when using the `confix` tool standalone, otherwise it must be the name of the config file without the .toml extension.", Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { filename := args[0]