From c7caea6b30dacd853d7c6482ef295e983ab1a408 Mon Sep 17 00:00:00 2001 From: Matt Jaffee Date: Mon, 6 Mar 2017 16:45:37 -0600 Subject: [PATCH] fix short help strings on commands --- cmd/backup.go | 2 +- cmd/bench.go | 2 +- cmd/check.go | 2 +- cmd/config.go | 2 +- cmd/export.go | 2 +- cmd/import.go | 2 +- cmd/inspect.go | 2 +- cmd/restore.go | 2 +- cmd/root.go | 2 +- cmd/server.go | 2 +- cmd/sort.go | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-) diff --git a/cmd/backup.go b/cmd/backup.go index 883ce7be8..418f6a720 100644 --- a/cmd/backup.go +++ b/cmd/backup.go @@ -16,7 +16,7 @@ var backuper = ctl.NewBackupCommand(os.Stdin, os.Stdout, os.Stderr) var backupCmd = &cobra.Command{ Use: "backup", - Short: "backup - backup data from pilosa", + Short: "Backup data from pilosa.", Long: ` Backs up the database and frame from across the cluster into a single file. `, diff --git a/cmd/bench.go b/cmd/bench.go index 9b3e85399..3e093d68e 100644 --- a/cmd/bench.go +++ b/cmd/bench.go @@ -16,7 +16,7 @@ var bencher = ctl.NewBenchCommand(os.Stdin, os.Stdout, os.Stderr) var benchCmd = &cobra.Command{ Use: "bench", - Short: "bench - benchmark operations", + Short: "Benchmark operations.", Long: ` Executes a benchmark for a given operation against the database. `, diff --git a/cmd/check.go b/cmd/check.go index 541f33cb2..560130187 100644 --- a/cmd/check.go +++ b/cmd/check.go @@ -14,7 +14,7 @@ var checker = ctl.NewCheckCommand(os.Stdin, os.Stdout, os.Stderr) var checkCmd = &cobra.Command{ Use: "check [path2]...", - Short: "check - check a pilosa data file", + Short: "Do a consistency check on a pilosa data file.", Long: ` Performs a consistency check on data files. `, diff --git a/cmd/config.go b/cmd/config.go index 72202ffe3..5fccbfc7d 100644 --- a/cmd/config.go +++ b/cmd/config.go @@ -14,7 +14,7 @@ var conf = ctl.NewConfigCommand(os.Stdin, os.Stdout, os.Stderr) var confCmd = &cobra.Command{ Use: "config", - Short: "config - prints the default configuration", + Short: "Print the default configuration.", Long: `config prints the default configuration to stdout `, Run: func(cmd *cobra.Command, args []string) { diff --git a/cmd/export.go b/cmd/export.go index a5cd0f62d..06a76118d 100644 --- a/cmd/export.go +++ b/cmd/export.go @@ -16,7 +16,7 @@ var exporter = ctl.NewExportCommand(os.Stdin, os.Stdout, os.Stderr) var exportCmd = &cobra.Command{ Use: "export", - Short: "export - export data from pilosa", + Short: "Export data from pilosa.", Long: ` Bulk exports a fragment to a CSV file. If the OUTFILE is not specified then the output is written to STDOUT. diff --git a/cmd/import.go b/cmd/import.go index af1a7fcd5..5f878c431 100644 --- a/cmd/import.go +++ b/cmd/import.go @@ -16,7 +16,7 @@ var importer = ctl.NewImportCommand(os.Stdin, os.Stdout, os.Stderr) var importCmd = &cobra.Command{ Use: "import", - Short: "import - import data to pilosa", + Short: "Bulk load data into pilosa.", Long: `Bulk imports one or more CSV files to a host's database and frame. The bits of the CSV file are grouped by slice for the most efficient import. diff --git a/cmd/inspect.go b/cmd/inspect.go index 56ded3bb7..666c59d5c 100644 --- a/cmd/inspect.go +++ b/cmd/inspect.go @@ -14,7 +14,7 @@ var inspecter = ctl.NewInspectCommand(os.Stdin, os.Stdout, os.Stderr) var inspectCmd = &cobra.Command{ Use: "inspect", - Short: "get stats on pilosa data file", + Short: "Get stats on a pilosa data file.", Long: ` Inspects a data file and provides stats. `, diff --git a/cmd/restore.go b/cmd/restore.go index 44899e4ca..399122ff3 100644 --- a/cmd/restore.go +++ b/cmd/restore.go @@ -16,7 +16,7 @@ var restorer = ctl.NewRestoreCommand(os.Stdin, os.Stdout, os.Stderr) var restoreCmd = &cobra.Command{ Use: "restore", - Short: "restore - restore data to pilosa", + Short: "Restore data to pilosa from a backup file.", Long: ` Restores a frame to the cluster from a backup file. `, diff --git a/cmd/root.go b/cmd/root.go index f7517dc73..139214302 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -9,7 +9,7 @@ var ( var RootCmd = &cobra.Command{ Use: "pilosa", - Short: "pilosa - A Distributed In-memory Binary Bitmap Index", + Short: "Pilosa - A Distributed In-memory Binary Bitmap Index.", // TODO - is documentation actually there? Long: `Pilosa is a fast index to turbocharge your database. diff --git a/cmd/server.go b/cmd/server.go index d31806eea..6603a0989 100644 --- a/cmd/server.go +++ b/cmd/server.go @@ -18,7 +18,7 @@ var serve = server.NewMain() var serveCmd = &cobra.Command{ Use: "server", - Short: "server - run the pilosa server", + Short: "Run Pilosa.", Long: `pilosa server runs Pilosa. It will load existing data from the configured diff --git a/cmd/sort.go b/cmd/sort.go index 4df585629..f9a1d682e 100644 --- a/cmd/sort.go +++ b/cmd/sort.go @@ -14,7 +14,7 @@ var sorter = ctl.NewSortCommand(os.Stdin, os.Stdout, os.Stderr) var sortCmd = &cobra.Command{ Use: "sort ", - Short: "sort - sort import data for optimal import performance", + Short: "Sort import data for optimal import performance.", Long: ` Sorts the import data at PATH into the optimal sort order for importing.