fix short help strings on commands

This commit is contained in:
Matt Jaffee 2017-03-06 16:45:37 -06:00
parent f463ab9d9b
commit c7caea6b30
11 changed files with 11 additions and 11 deletions

View file

@ -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.
`,

View file

@ -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.
`,

View file

@ -14,7 +14,7 @@ var checker = ctl.NewCheckCommand(os.Stdin, os.Stdout, os.Stderr)
var checkCmd = &cobra.Command{
Use: "check <path> [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.
`,

View file

@ -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) {

View file

@ -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.

View file

@ -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.

View file

@ -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.
`,

View file

@ -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.
`,

View file

@ -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.

View file

@ -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

View file

@ -14,7 +14,7 @@ var sorter = ctl.NewSortCommand(os.Stdin, os.Stdout, os.Stderr)
var sortCmd = &cobra.Command{
Use: "sort <path>",
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.