From a9de303d8bf5020ed82e90cec3c8b8b7c3f9bea2 Mon Sep 17 00:00:00 2001 From: Harshavardhana Date: Tue, 20 Nov 2018 17:35:33 -0800 Subject: [PATCH] Update command line docs (#6839) --- cmd/gateway-main.go | 2 +- cmd/gateway/b2/gateway-b2.go | 2 +- cmd/gateway/gcs/gateway-gcs.go | 2 +- cmd/gateway/manta/gateway-manta.go | 2 +- cmd/gateway/nas/gateway-nas.go | 2 +- cmd/gateway/oss/gateway-oss.go | 2 +- cmd/gateway/s3/gateway-s3.go | 2 +- cmd/gateway/sia/gateway-sia.go | 2 +- cmd/server-main.go | 8 ++++---- cmd/update-main.go | 4 ++-- cmd/version-main.go | 2 +- 11 files changed, 15 insertions(+), 15 deletions(-) diff --git a/cmd/gateway-main.go b/cmd/gateway-main.go index a136495ab..5a55dfb88 100644 --- a/cmd/gateway-main.go +++ b/cmd/gateway-main.go @@ -41,7 +41,7 @@ func init() { var ( gatewayCmd = cli.Command{ Name: "gateway", - Usage: "Start object storage gateway.", + Usage: "start object storage gateway", Flags: append(serverFlags, globalFlags...), HideHelpCommand: true, } diff --git a/cmd/gateway/b2/gateway-b2.go b/cmd/gateway/b2/gateway-b2.go index 677608329..529149833 100644 --- a/cmd/gateway/b2/gateway-b2.go +++ b/cmd/gateway/b2/gateway-b2.go @@ -92,7 +92,7 @@ EXAMPLES: ` minio.RegisterGatewayCommand(cli.Command{ Name: b2Backend, - Usage: "Backblaze B2.", + Usage: "Backblaze B2", Action: b2GatewayMain, CustomHelpTemplate: b2GatewayTemplate, HideHelpCommand: true, diff --git a/cmd/gateway/gcs/gateway-gcs.go b/cmd/gateway/gcs/gateway-gcs.go index de3107917..19edc7312 100644 --- a/cmd/gateway/gcs/gateway-gcs.go +++ b/cmd/gateway/gcs/gateway-gcs.go @@ -147,7 +147,7 @@ EXAMPLES: minio.RegisterGatewayCommand(cli.Command{ Name: gcsBackend, - Usage: "Google Cloud Storage.", + Usage: "Google Cloud Storage", Action: gcsGatewayMain, CustomHelpTemplate: gcsGatewayTemplate, HideHelpCommand: true, diff --git a/cmd/gateway/manta/gateway-manta.go b/cmd/gateway/manta/gateway-manta.go index 605b5f41a..4b748c58b 100644 --- a/cmd/gateway/manta/gateway-manta.go +++ b/cmd/gateway/manta/gateway-manta.go @@ -108,7 +108,7 @@ EXAMPLES: minio.RegisterGatewayCommand(cli.Command{ Name: mantaBackend, - Usage: "Manta Object Storage.", + Usage: "Manta Object Storage", Action: mantaGatewayMain, CustomHelpTemplate: mantaGatewayTemplate, HideHelpCommand: true, diff --git a/cmd/gateway/nas/gateway-nas.go b/cmd/gateway/nas/gateway-nas.go index d6c89e73e..2cb794ae1 100644 --- a/cmd/gateway/nas/gateway-nas.go +++ b/cmd/gateway/nas/gateway-nas.go @@ -74,7 +74,7 @@ EXAMPLES: minio.RegisterGatewayCommand(cli.Command{ Name: nasBackend, - Usage: "Network-attached storage (NAS).", + Usage: "Network-attached storage (NAS)", Action: nasGatewayMain, CustomHelpTemplate: nasGatewayTemplate, HideHelpCommand: true, diff --git a/cmd/gateway/oss/gateway-oss.go b/cmd/gateway/oss/gateway-oss.go index 2e595f610..a960a7f28 100644 --- a/cmd/gateway/oss/gateway-oss.go +++ b/cmd/gateway/oss/gateway-oss.go @@ -98,7 +98,7 @@ EXAMPLES: minio.RegisterGatewayCommand(cli.Command{ Name: "oss", - Usage: "Alibaba Cloud (Aliyun) Object Storage Service (OSS).", + Usage: "Alibaba Cloud (Aliyun) Object Storage Service (OSS)", Action: ossGatewayMain, CustomHelpTemplate: ossGatewayTemplate, HideHelpCommand: true, diff --git a/cmd/gateway/s3/gateway-s3.go b/cmd/gateway/s3/gateway-s3.go index 0958fc735..c03971e11 100644 --- a/cmd/gateway/s3/gateway-s3.go +++ b/cmd/gateway/s3/gateway-s3.go @@ -111,7 +111,7 @@ EXAMPLES: minio.RegisterGatewayCommand(cli.Command{ Name: s3Backend, - Usage: "Amazon Simple Storage Service (S3).", + Usage: "Amazon Simple Storage Service (S3)", Action: s3GatewayMain, CustomHelpTemplate: s3GatewayTemplate, HideHelpCommand: true, diff --git a/cmd/gateway/sia/gateway-sia.go b/cmd/gateway/sia/gateway-sia.go index e1b2f0614..6a48580d9 100644 --- a/cmd/gateway/sia/gateway-sia.go +++ b/cmd/gateway/sia/gateway-sia.go @@ -97,7 +97,7 @@ EXAMPLES: minio.RegisterGatewayCommand(cli.Command{ Name: siaBackend, - Usage: "Sia Decentralized Cloud.", + Usage: "Sia Decentralized Cloud", Action: siaGatewayMain, CustomHelpTemplate: siaGatewayTemplate, HideHelpCommand: true, diff --git a/cmd/server-main.go b/cmd/server-main.go index 7080330d7..ad0bc6649 100644 --- a/cmd/server-main.go +++ b/cmd/server-main.go @@ -41,13 +41,13 @@ var serverFlags = []cli.Flag{ cli.StringFlag{ Name: "address", Value: ":" + globalMinioPort, - Usage: "Bind to a specific ADDRESS:PORT, ADDRESS can be an IP or hostname.", + Usage: "bind to a specific ADDRESS:PORT, ADDRESS can be an IP or hostname", }, } var serverCmd = cli.Command{ Name: "server", - Usage: "Start object storage server.", + Usage: "start object storage server", Flags: append(serverFlags, globalFlags...), Action: serverMain, CustomHelpTemplate: `NAME: @@ -112,10 +112,10 @@ EXAMPLES: 4. Start erasure coded minio server on a node with 64 drives. $ {{.HelpName}} /mnt/export{1...64} - 5. Start distributed minio server on an 8 node setup with 8 drives each. Run following command on all the 8 nodes. + 5. Start distributed minio server on an 32 node setup with 32 drives each. Run following command on all the 32 nodes. $ export MINIO_ACCESS_KEY=minio $ export MINIO_SECRET_KEY=miniostorage - $ {{.HelpName}} http://node{1...8}.example.com/mnt/export/{1...8} + $ {{.HelpName}} http://node{1...32}.example.com/mnt/export/{1...32} 6. Start minio server with edge caching enabled. $ export MINIO_CACHE_DRIVES="/mnt/drive1;/mnt/drive2;/mnt/drive3;/mnt/drive4" diff --git a/cmd/update-main.go b/cmd/update-main.go index 08f6b3b54..4d9e77434 100644 --- a/cmd/update-main.go +++ b/cmd/update-main.go @@ -40,12 +40,12 @@ import ( // Check for new software updates. var updateCmd = cli.Command{ Name: "update", - Usage: "Check for a new software update.", + Usage: "update minio to latest release", Action: mainUpdate, Flags: []cli.Flag{ cli.BoolFlag{ Name: "quiet", - Usage: "Disable any update prompt message.", + Usage: "disable any update prompt message", }, }, CustomHelpTemplate: `Name: diff --git a/cmd/version-main.go b/cmd/version-main.go index e73aaf00b..139c1c430 100644 --- a/cmd/version-main.go +++ b/cmd/version-main.go @@ -23,7 +23,7 @@ import ( var versionCmd = cli.Command{ Name: "version", - Usage: "Print version.", + Usage: "print version", Action: mainVersion, CustomHelpTemplate: `NAME: {{.HelpName}} - {{.Usage}}