From d31d8c5335a221669c42762a15887f9ecbac293e Mon Sep 17 00:00:00 2001 From: Alex Vanin Date: Fri, 27 Jan 2023 13:44:39 +0300 Subject: [PATCH] [#1] Fix naming in FrostFS CLI help output Signed-off-by: Alex Vanin --- cmd/frostfs-cli/modules/accounting/balance.go | 4 ++-- cmd/frostfs-cli/modules/container/create.go | 2 +- cmd/frostfs-cli/modules/control/healthcheck.go | 4 ++-- cmd/frostfs-cli/modules/control/set_netmap_status.go | 4 ++-- cmd/frostfs-cli/modules/netmap/netinfo.go | 4 ++-- cmd/frostfs-cli/modules/object/delete.go | 4 ++-- cmd/frostfs-cli/modules/object/get.go | 6 +++--- cmd/frostfs-cli/modules/object/put.go | 6 +++--- cmd/frostfs-cli/modules/root.go | 8 ++++---- cmd/frostfs-cli/modules/storagegroup/delete.go | 4 ++-- cmd/frostfs-cli/modules/storagegroup/get.go | 4 ++-- cmd/frostfs-cli/modules/storagegroup/list.go | 4 ++-- cmd/frostfs-cli/modules/storagegroup/put.go | 4 ++-- cmd/frostfs-cli/modules/util/convert.go | 2 +- cmd/frostfs-cli/modules/util/locode.go | 2 +- cmd/frostfs-cli/modules/util/locode_generate.go | 2 +- cmd/frostfs-cli/modules/util/locode_info.go | 4 ++-- cmd/frostfs-cli/modules/util/sign.go | 2 +- 18 files changed, 35 insertions(+), 35 deletions(-) diff --git a/cmd/frostfs-cli/modules/accounting/balance.go b/cmd/frostfs-cli/modules/accounting/balance.go index 6bfc87259..b4efdfb17 100644 --- a/cmd/frostfs-cli/modules/accounting/balance.go +++ b/cmd/frostfs-cli/modules/accounting/balance.go @@ -21,8 +21,8 @@ const ( var accountingBalanceCmd = &cobra.Command{ Use: "balance", - Short: "Get internal balance of NeoFS account", - Long: `Get internal balance of NeoFS account`, + Short: "Get internal balance of FrostFS account", + Long: `Get internal balance of FrostFS account`, Run: func(cmd *cobra.Command, args []string) { var idUser user.ID diff --git a/cmd/frostfs-cli/modules/container/create.go b/cmd/frostfs-cli/modules/container/create.go index 91333757a..b4b842912 100644 --- a/cmd/frostfs-cli/modules/container/create.go +++ b/cmd/frostfs-cli/modules/container/create.go @@ -33,7 +33,7 @@ var ( var createContainerCmd = &cobra.Command{ Use: "create", Short: "Create new container", - Long: `Create new container and register it in the NeoFS. + Long: `Create new container and register it in the FrostFS. It will be stored in sidechain when inner ring will accepts it.`, Run: func(cmd *cobra.Command, args []string) { placementPolicy, err := parseContainerPolicy(cmd, containerPolicy) diff --git a/cmd/frostfs-cli/modules/control/healthcheck.go b/cmd/frostfs-cli/modules/control/healthcheck.go index 1183f23c2..92fc9b066 100644 --- a/cmd/frostfs-cli/modules/control/healthcheck.go +++ b/cmd/frostfs-cli/modules/control/healthcheck.go @@ -19,8 +19,8 @@ const ( var healthCheckCmd = &cobra.Command{ Use: "healthcheck", - Short: "Health check of the NeoFS node", - Long: "Health check of the NeoFS node. Checks storage node by default, use --ir flag to work with Inner Ring.", + Short: "Health check of the FrostFS node", + Long: "Health check of the FrostFS node. Checks storage node by default, use --ir flag to work with Inner Ring.", Run: healthCheck, } diff --git a/cmd/frostfs-cli/modules/control/set_netmap_status.go b/cmd/frostfs-cli/modules/control/set_netmap_status.go index 28d784ca3..cb70ddfe6 100644 --- a/cmd/frostfs-cli/modules/control/set_netmap_status.go +++ b/cmd/frostfs-cli/modules/control/set_netmap_status.go @@ -21,8 +21,8 @@ const ( var setNetmapStatusCmd = &cobra.Command{ Use: "set-status", - Short: "Set status of the storage node in NeoFS network map", - Long: "Set status of the storage node in NeoFS network map", + Short: "Set status of the storage node in FrostFS network map", + Long: "Set status of the storage node in FrostFS network map", Run: setNetmapStatus, } diff --git a/cmd/frostfs-cli/modules/netmap/netinfo.go b/cmd/frostfs-cli/modules/netmap/netinfo.go index 87e9f6c84..f55ff3e06 100644 --- a/cmd/frostfs-cli/modules/netmap/netinfo.go +++ b/cmd/frostfs-cli/modules/netmap/netinfo.go @@ -14,8 +14,8 @@ import ( var netInfoCmd = &cobra.Command{ Use: "netinfo", - Short: "Get information about NeoFS network", - Long: "Get information about NeoFS network", + Short: "Get information about FrostFS network", + Long: "Get information about FrostFS network", Run: func(cmd *cobra.Command, args []string) { p := key.GetOrGenerate(cmd) cli := internalclient.GetSDKClientByFlag(cmd, p, commonflags.RPC) diff --git a/cmd/frostfs-cli/modules/object/delete.go b/cmd/frostfs-cli/modules/object/delete.go index e2595a2c6..af5cc84b7 100644 --- a/cmd/frostfs-cli/modules/object/delete.go +++ b/cmd/frostfs-cli/modules/object/delete.go @@ -15,8 +15,8 @@ import ( var objectDelCmd = &cobra.Command{ Use: "delete", Aliases: []string{"del"}, - Short: "Delete object from NeoFS", - Long: "Delete object from NeoFS", + Short: "Delete object from FrostFS", + Long: "Delete object from FrostFS", Run: deleteObject, } diff --git a/cmd/frostfs-cli/modules/object/get.go b/cmd/frostfs-cli/modules/object/get.go index 277fd6a30..0e5c715e0 100644 --- a/cmd/frostfs-cli/modules/object/get.go +++ b/cmd/frostfs-cli/modules/object/get.go @@ -19,8 +19,8 @@ import ( var objectGetCmd = &cobra.Command{ Use: "get", - Short: "Get object from NeoFS", - Long: "Get object from NeoFS", + Short: "Get object from FrostFS", + Long: "Get object from FrostFS", Run: getObject, } @@ -115,7 +115,7 @@ func getObject(cmd *cobra.Command, _ []string) { if binary { objToStore := res.Header() - //TODO(@acid-ant): #1932 Use streams to marshal/unmarshal payload + // TODO(@acid-ant): #1932 Use streams to marshal/unmarshal payload objToStore.SetPayload(payloadBuffer.Bytes()) objBytes, err := objToStore.Marshal() common.ExitOnErr(cmd, "", err) diff --git a/cmd/frostfs-cli/modules/object/put.go b/cmd/frostfs-cli/modules/object/put.go index c769d647f..6ee2bf0da 100644 --- a/cmd/frostfs-cli/modules/object/put.go +++ b/cmd/frostfs-cli/modules/object/put.go @@ -31,8 +31,8 @@ var putExpiredOn uint64 var objectPutCmd = &cobra.Command{ Use: "put", - Short: "Put object to NeoFS", - Long: "Put object to NeoFS", + Short: "Put object to FrostFS", + Long: "Put object to FrostFS", Run: putObject, } @@ -82,7 +82,7 @@ func putObject(cmd *cobra.Command, _ []string) { buf, err := os.ReadFile(filename) common.ExitOnErr(cmd, "unable to read given file: %w", err) objTemp := object.New() - //TODO(@acid-ant): #1932 Use streams to marshal/unmarshal payload + // TODO(@acid-ant): #1932 Use streams to marshal/unmarshal payload common.ExitOnErr(cmd, "can't unmarshal object from given file: %w", objTemp.Unmarshal(buf)) payloadReader = bytes.NewReader(objTemp.Payload()) cnr, _ = objTemp.ContainerID() diff --git a/cmd/frostfs-cli/modules/root.go b/cmd/frostfs-cli/modules/root.go index a54322a89..a7a116a75 100644 --- a/cmd/frostfs-cli/modules/root.go +++ b/cmd/frostfs-cli/modules/root.go @@ -36,10 +36,10 @@ var ( // rootCmd represents the base command when called without any subcommands. var rootCmd = &cobra.Command{ Use: "frostfs-cli", - Short: "Command Line Tool to work with NeoFS", - Long: `NeoFS CLI provides all basic interactions with NeoFS and it's services. + Short: "Command Line Tool to work with FrostFS", + Long: `FrostFS CLI provides all basic interactions with FrostFS and it's services. -It contains commands for interaction with NeoFS nodes using different versions +It contains commands for interaction with FrostFS nodes using different versions of frostfs-api and some useful utilities for compiling ACL rules from JSON notation, managing container access through protocol gates, querying network map and much more!`, @@ -70,7 +70,7 @@ func init() { // Cobra also supports local flags, which will only run // when this action is called directly. - rootCmd.Flags().Bool("version", false, "Application version and NeoFS API compatibility") + rootCmd.Flags().Bool("version", false, "Application version and FrostFS API compatibility") rootCmd.AddCommand(acl.Cmd) rootCmd.AddCommand(bearerCli.Cmd) diff --git a/cmd/frostfs-cli/modules/storagegroup/delete.go b/cmd/frostfs-cli/modules/storagegroup/delete.go index aac98a18e..450be6768 100644 --- a/cmd/frostfs-cli/modules/storagegroup/delete.go +++ b/cmd/frostfs-cli/modules/storagegroup/delete.go @@ -13,8 +13,8 @@ import ( var sgDelCmd = &cobra.Command{ Use: "delete", - Short: "Delete storage group from NeoFS", - Long: "Delete storage group from NeoFS", + Short: "Delete storage group from FrostFS", + Long: "Delete storage group from FrostFS", Run: delSG, } diff --git a/cmd/frostfs-cli/modules/storagegroup/get.go b/cmd/frostfs-cli/modules/storagegroup/get.go index 8693b3162..f874950a9 100644 --- a/cmd/frostfs-cli/modules/storagegroup/get.go +++ b/cmd/frostfs-cli/modules/storagegroup/get.go @@ -18,8 +18,8 @@ var sgID string var sgGetCmd = &cobra.Command{ Use: "get", - Short: "Get storage group from NeoFS", - Long: "Get storage group from NeoFS", + Short: "Get storage group from FrostFS", + Long: "Get storage group from FrostFS", Run: getSG, } diff --git a/cmd/frostfs-cli/modules/storagegroup/list.go b/cmd/frostfs-cli/modules/storagegroup/list.go index 05dde2dae..3171e5bd2 100644 --- a/cmd/frostfs-cli/modules/storagegroup/list.go +++ b/cmd/frostfs-cli/modules/storagegroup/list.go @@ -13,8 +13,8 @@ import ( var sgListCmd = &cobra.Command{ Use: "list", - Short: "List storage groups in NeoFS container", - Long: "List storage groups in NeoFS container", + Short: "List storage groups in FrostFS container", + Long: "List storage groups in FrostFS container", Run: listSG, } diff --git a/cmd/frostfs-cli/modules/storagegroup/put.go b/cmd/frostfs-cli/modules/storagegroup/put.go index fb05bcf73..194479aac 100644 --- a/cmd/frostfs-cli/modules/storagegroup/put.go +++ b/cmd/frostfs-cli/modules/storagegroup/put.go @@ -26,8 +26,8 @@ var sgMembers []string var sgPutCmd = &cobra.Command{ Use: "put", - Short: "Put storage group to NeoFS", - Long: "Put storage group to NeoFS", + Short: "Put storage group to FrostFS", + Long: "Put storage group to FrostFS", Run: putSG, } diff --git a/cmd/frostfs-cli/modules/util/convert.go b/cmd/frostfs-cli/modules/util/convert.go index d1229042a..23a25be07 100644 --- a/cmd/frostfs-cli/modules/util/convert.go +++ b/cmd/frostfs-cli/modules/util/convert.go @@ -4,7 +4,7 @@ import "github.com/spf13/cobra" var convertCmd = &cobra.Command{ Use: "convert", - Short: "Convert representation of NeoFS structures", + Short: "Convert representation of FrostFS structures", } func initConvertCmd() { diff --git a/cmd/frostfs-cli/modules/util/locode.go b/cmd/frostfs-cli/modules/util/locode.go index 1e267eba7..a1f0f4d3f 100644 --- a/cmd/frostfs-cli/modules/util/locode.go +++ b/cmd/frostfs-cli/modules/util/locode.go @@ -7,7 +7,7 @@ import ( // locode section. var locodeCmd = &cobra.Command{ Use: "locode", - Short: "Working with NeoFS UN/LOCODE database", + Short: "Working with FrostFS UN/LOCODE database", } func initLocodeCmd() { diff --git a/cmd/frostfs-cli/modules/util/locode_generate.go b/cmd/frostfs-cli/modules/util/locode_generate.go index e34bcc4b1..e59a87856 100644 --- a/cmd/frostfs-cli/modules/util/locode_generate.go +++ b/cmd/frostfs-cli/modules/util/locode_generate.go @@ -34,7 +34,7 @@ var ( locodeGenerateCmd = &cobra.Command{ Use: "generate", - Short: "Generate UN/LOCODE database for NeoFS", + Short: "Generate UN/LOCODE database for FrostFS", Run: func(cmd *cobra.Command, _ []string) { locodeDB := csvlocode.New( csvlocode.Prm{ diff --git a/cmd/frostfs-cli/modules/util/locode_info.go b/cmd/frostfs-cli/modules/util/locode_info.go index defd12e8a..23d250c2e 100644 --- a/cmd/frostfs-cli/modules/util/locode_info.go +++ b/cmd/frostfs-cli/modules/util/locode_info.go @@ -18,7 +18,7 @@ var ( locodeInfoCmd = &cobra.Command{ Use: "info", - Short: "Print information about UN/LOCODE from NeoFS database", + Short: "Print information about UN/LOCODE from FrostFS database", Run: func(cmd *cobra.Command, _ []string) { targetDB := locodebolt.New(locodebolt.Prm{ Path: locodeInfoDBPath, @@ -48,7 +48,7 @@ var ( func initUtilLocodeInfoCmd() { flags := locodeInfoCmd.Flags() - flags.StringVar(&locodeInfoDBPath, locodeInfoDBFlag, "", "Path to NeoFS UN/LOCODE database") + flags.StringVar(&locodeInfoDBPath, locodeInfoDBFlag, "", "Path to FrostFS UN/LOCODE database") _ = locodeInfoCmd.MarkFlagRequired(locodeInfoDBFlag) flags.StringVar(&locodeInfoCode, locodeInfoCodeFlag, "", "UN/LOCODE") diff --git a/cmd/frostfs-cli/modules/util/sign.go b/cmd/frostfs-cli/modules/util/sign.go index 487d20484..e8cb086e0 100644 --- a/cmd/frostfs-cli/modules/util/sign.go +++ b/cmd/frostfs-cli/modules/util/sign.go @@ -11,7 +11,7 @@ const ( var signCmd = &cobra.Command{ Use: "sign", - Short: "Sign NeoFS structure", + Short: "Sign FrostFS structure", } func initSignCmd() {