[#1] Fix naming in FrostFS CLI help output

Signed-off-by: Alex Vanin <a.vanin@yadro.com>
pull/38/head
Alexey Vanin 2023-01-27 13:44:39 +03:00 committed by fyrchik
parent 406ff1360f
commit d31d8c5335
18 changed files with 35 additions and 35 deletions

View File

@ -21,8 +21,8 @@ const (
var accountingBalanceCmd = &cobra.Command{ var accountingBalanceCmd = &cobra.Command{
Use: "balance", Use: "balance",
Short: "Get internal balance of NeoFS account", Short: "Get internal balance of FrostFS account",
Long: `Get internal balance of NeoFS account`, Long: `Get internal balance of FrostFS account`,
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
var idUser user.ID var idUser user.ID

View File

@ -33,7 +33,7 @@ var (
var createContainerCmd = &cobra.Command{ var createContainerCmd = &cobra.Command{
Use: "create", Use: "create",
Short: "Create new container", 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.`, It will be stored in sidechain when inner ring will accepts it.`,
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
placementPolicy, err := parseContainerPolicy(cmd, containerPolicy) placementPolicy, err := parseContainerPolicy(cmd, containerPolicy)

View File

@ -19,8 +19,8 @@ const (
var healthCheckCmd = &cobra.Command{ var healthCheckCmd = &cobra.Command{
Use: "healthcheck", Use: "healthcheck",
Short: "Health check of the NeoFS node", Short: "Health check of the FrostFS node",
Long: "Health check of the NeoFS node. Checks storage node by default, use --ir flag to work with Inner Ring.", Long: "Health check of the FrostFS node. Checks storage node by default, use --ir flag to work with Inner Ring.",
Run: healthCheck, Run: healthCheck,
} }

View File

@ -21,8 +21,8 @@ const (
var setNetmapStatusCmd = &cobra.Command{ var setNetmapStatusCmd = &cobra.Command{
Use: "set-status", Use: "set-status",
Short: "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 NeoFS network map", Long: "Set status of the storage node in FrostFS network map",
Run: setNetmapStatus, Run: setNetmapStatus,
} }

View File

@ -14,8 +14,8 @@ import (
var netInfoCmd = &cobra.Command{ var netInfoCmd = &cobra.Command{
Use: "netinfo", Use: "netinfo",
Short: "Get information about NeoFS network", Short: "Get information about FrostFS network",
Long: "Get information about NeoFS network", Long: "Get information about FrostFS network",
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
p := key.GetOrGenerate(cmd) p := key.GetOrGenerate(cmd)
cli := internalclient.GetSDKClientByFlag(cmd, p, commonflags.RPC) cli := internalclient.GetSDKClientByFlag(cmd, p, commonflags.RPC)

View File

@ -15,8 +15,8 @@ import (
var objectDelCmd = &cobra.Command{ var objectDelCmd = &cobra.Command{
Use: "delete", Use: "delete",
Aliases: []string{"del"}, Aliases: []string{"del"},
Short: "Delete object from NeoFS", Short: "Delete object from FrostFS",
Long: "Delete object from NeoFS", Long: "Delete object from FrostFS",
Run: deleteObject, Run: deleteObject,
} }

View File

@ -19,8 +19,8 @@ import (
var objectGetCmd = &cobra.Command{ var objectGetCmd = &cobra.Command{
Use: "get", Use: "get",
Short: "Get object from NeoFS", Short: "Get object from FrostFS",
Long: "Get object from NeoFS", Long: "Get object from FrostFS",
Run: getObject, Run: getObject,
} }
@ -115,7 +115,7 @@ func getObject(cmd *cobra.Command, _ []string) {
if binary { if binary {
objToStore := res.Header() 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()) objToStore.SetPayload(payloadBuffer.Bytes())
objBytes, err := objToStore.Marshal() objBytes, err := objToStore.Marshal()
common.ExitOnErr(cmd, "", err) common.ExitOnErr(cmd, "", err)

View File

@ -31,8 +31,8 @@ var putExpiredOn uint64
var objectPutCmd = &cobra.Command{ var objectPutCmd = &cobra.Command{
Use: "put", Use: "put",
Short: "Put object to NeoFS", Short: "Put object to FrostFS",
Long: "Put object to NeoFS", Long: "Put object to FrostFS",
Run: putObject, Run: putObject,
} }
@ -82,7 +82,7 @@ func putObject(cmd *cobra.Command, _ []string) {
buf, err := os.ReadFile(filename) buf, err := os.ReadFile(filename)
common.ExitOnErr(cmd, "unable to read given file: %w", err) common.ExitOnErr(cmd, "unable to read given file: %w", err)
objTemp := object.New() 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)) common.ExitOnErr(cmd, "can't unmarshal object from given file: %w", objTemp.Unmarshal(buf))
payloadReader = bytes.NewReader(objTemp.Payload()) payloadReader = bytes.NewReader(objTemp.Payload())
cnr, _ = objTemp.ContainerID() cnr, _ = objTemp.ContainerID()

View File

@ -36,10 +36,10 @@ var (
// rootCmd represents the base command when called without any subcommands. // rootCmd represents the base command when called without any subcommands.
var rootCmd = &cobra.Command{ var rootCmd = &cobra.Command{
Use: "frostfs-cli", Use: "frostfs-cli",
Short: "Command Line Tool to work with NeoFS", Short: "Command Line Tool to work with FrostFS",
Long: `NeoFS CLI provides all basic interactions with NeoFS and it's services. 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 of frostfs-api and some useful utilities for compiling ACL rules from JSON
notation, managing container access through protocol gates, querying network map notation, managing container access through protocol gates, querying network map
and much more!`, and much more!`,
@ -70,7 +70,7 @@ func init() {
// Cobra also supports local flags, which will only run // Cobra also supports local flags, which will only run
// when this action is called directly. // 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(acl.Cmd)
rootCmd.AddCommand(bearerCli.Cmd) rootCmd.AddCommand(bearerCli.Cmd)

View File

@ -13,8 +13,8 @@ import (
var sgDelCmd = &cobra.Command{ var sgDelCmd = &cobra.Command{
Use: "delete", Use: "delete",
Short: "Delete storage group from NeoFS", Short: "Delete storage group from FrostFS",
Long: "Delete storage group from NeoFS", Long: "Delete storage group from FrostFS",
Run: delSG, Run: delSG,
} }

View File

@ -18,8 +18,8 @@ var sgID string
var sgGetCmd = &cobra.Command{ var sgGetCmd = &cobra.Command{
Use: "get", Use: "get",
Short: "Get storage group from NeoFS", Short: "Get storage group from FrostFS",
Long: "Get storage group from NeoFS", Long: "Get storage group from FrostFS",
Run: getSG, Run: getSG,
} }

View File

@ -13,8 +13,8 @@ import (
var sgListCmd = &cobra.Command{ var sgListCmd = &cobra.Command{
Use: "list", Use: "list",
Short: "List storage groups in NeoFS container", Short: "List storage groups in FrostFS container",
Long: "List storage groups in NeoFS container", Long: "List storage groups in FrostFS container",
Run: listSG, Run: listSG,
} }

View File

@ -26,8 +26,8 @@ var sgMembers []string
var sgPutCmd = &cobra.Command{ var sgPutCmd = &cobra.Command{
Use: "put", Use: "put",
Short: "Put storage group to NeoFS", Short: "Put storage group to FrostFS",
Long: "Put storage group to NeoFS", Long: "Put storage group to FrostFS",
Run: putSG, Run: putSG,
} }

View File

@ -4,7 +4,7 @@ import "github.com/spf13/cobra"
var convertCmd = &cobra.Command{ var convertCmd = &cobra.Command{
Use: "convert", Use: "convert",
Short: "Convert representation of NeoFS structures", Short: "Convert representation of FrostFS structures",
} }
func initConvertCmd() { func initConvertCmd() {

View File

@ -7,7 +7,7 @@ import (
// locode section. // locode section.
var locodeCmd = &cobra.Command{ var locodeCmd = &cobra.Command{
Use: "locode", Use: "locode",
Short: "Working with NeoFS UN/LOCODE database", Short: "Working with FrostFS UN/LOCODE database",
} }
func initLocodeCmd() { func initLocodeCmd() {

View File

@ -34,7 +34,7 @@ var (
locodeGenerateCmd = &cobra.Command{ locodeGenerateCmd = &cobra.Command{
Use: "generate", Use: "generate",
Short: "Generate UN/LOCODE database for NeoFS", Short: "Generate UN/LOCODE database for FrostFS",
Run: func(cmd *cobra.Command, _ []string) { Run: func(cmd *cobra.Command, _ []string) {
locodeDB := csvlocode.New( locodeDB := csvlocode.New(
csvlocode.Prm{ csvlocode.Prm{

View File

@ -18,7 +18,7 @@ var (
locodeInfoCmd = &cobra.Command{ locodeInfoCmd = &cobra.Command{
Use: "info", 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) { Run: func(cmd *cobra.Command, _ []string) {
targetDB := locodebolt.New(locodebolt.Prm{ targetDB := locodebolt.New(locodebolt.Prm{
Path: locodeInfoDBPath, Path: locodeInfoDBPath,
@ -48,7 +48,7 @@ var (
func initUtilLocodeInfoCmd() { func initUtilLocodeInfoCmd() {
flags := locodeInfoCmd.Flags() 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) _ = locodeInfoCmd.MarkFlagRequired(locodeInfoDBFlag)
flags.StringVar(&locodeInfoCode, locodeInfoCodeFlag, "", "UN/LOCODE") flags.StringVar(&locodeInfoCode, locodeInfoCodeFlag, "", "UN/LOCODE")

View File

@ -11,7 +11,7 @@ const (
var signCmd = &cobra.Command{ var signCmd = &cobra.Command{
Use: "sign", Use: "sign",
Short: "Sign NeoFS structure", Short: "Sign FrostFS structure",
} }
func initSignCmd() { func initSignCmd() {