From 9eb39cef05eb0f7f650ed46bc39f2de40e78000e Mon Sep 17 00:00:00 2001 From: Shayne Holmes Date: Mon, 11 Sep 2017 09:32:44 -0700 Subject: [PATCH] Capitalize short help commands Unify existing Cobra help command, and git-help's style. --- cmd/restic/cmd_autocomplete.go | 2 +- cmd/restic/cmd_backup.go | 2 +- cmd/restic/cmd_cat.go | 2 +- cmd/restic/cmd_check.go | 2 +- cmd/restic/cmd_dump.go | 2 +- cmd/restic/cmd_find.go | 2 +- cmd/restic/cmd_forget.go | 2 +- cmd/restic/cmd_init.go | 2 +- cmd/restic/cmd_key.go | 2 +- cmd/restic/cmd_list.go | 2 +- cmd/restic/cmd_ls.go | 2 +- cmd/restic/cmd_manpage.go | 2 +- cmd/restic/cmd_migrate.go | 2 +- cmd/restic/cmd_mount.go | 2 +- cmd/restic/cmd_options.go | 2 +- cmd/restic/cmd_prune.go | 2 +- cmd/restic/cmd_rebuild_index.go | 2 +- cmd/restic/cmd_restore.go | 2 +- cmd/restic/cmd_snapshots.go | 2 +- cmd/restic/cmd_tag.go | 2 +- cmd/restic/cmd_unlock.go | 2 +- cmd/restic/cmd_version.go | 2 +- cmd/restic/main.go | 2 +- doc/manual.rst | 34 ++++++++++++++++----------------- 24 files changed, 40 insertions(+), 40 deletions(-) diff --git a/cmd/restic/cmd_autocomplete.go b/cmd/restic/cmd_autocomplete.go index 420b4e1b9..52a229c12 100644 --- a/cmd/restic/cmd_autocomplete.go +++ b/cmd/restic/cmd_autocomplete.go @@ -8,7 +8,7 @@ var autocompleteTarget string var cmdAutocomplete = &cobra.Command{ Use: "autocomplete", - Short: "generate shell autocompletion script", + Short: "Generate shell autocompletion script", Long: `The "autocomplete" command generates a shell autocompletion script. NOTE: The current version supports Bash only. diff --git a/cmd/restic/cmd_backup.go b/cmd/restic/cmd_backup.go index dbf8cb423..8d71e0d10 100644 --- a/cmd/restic/cmd_backup.go +++ b/cmd/restic/cmd_backup.go @@ -21,7 +21,7 @@ import ( var cmdBackup = &cobra.Command{ Use: "backup [flags] FILE/DIR [FILE/DIR] ...", - Short: "create a new backup of files and/or directories", + Short: "Create a new backup of files and/or directories", Long: ` The "backup" command creates a new snapshot and saves the files and directories given as the arguments. diff --git a/cmd/restic/cmd_cat.go b/cmd/restic/cmd_cat.go index 33a559b35..8926f11a5 100644 --- a/cmd/restic/cmd_cat.go +++ b/cmd/restic/cmd_cat.go @@ -16,7 +16,7 @@ import ( var cmdCat = &cobra.Command{ Use: "cat [flags] [pack|blob|snapshot|index|key|masterkey|config|lock] ID", - Short: "print internal objects to stdout", + Short: "Print internal objects to stdout", Long: ` The "cat" command is used to print internal objects to stdout. `, diff --git a/cmd/restic/cmd_check.go b/cmd/restic/cmd_check.go index b59d55a42..b64429a0e 100644 --- a/cmd/restic/cmd_check.go +++ b/cmd/restic/cmd_check.go @@ -15,7 +15,7 @@ import ( var cmdCheck = &cobra.Command{ Use: "check [flags]", - Short: "check the repository for errors", + Short: "Check the repository for errors", Long: ` The "check" command tests the repository for errors and reports any errors it finds. It can also be used to read all data and therefore simulate a restore. diff --git a/cmd/restic/cmd_dump.go b/cmd/restic/cmd_dump.go index 038d87d9c..215de8dad 100644 --- a/cmd/restic/cmd_dump.go +++ b/cmd/restic/cmd_dump.go @@ -21,7 +21,7 @@ import ( var cmdDump = &cobra.Command{ Use: "dump [indexes|snapshots|trees|all|packs]", - Short: "dump data structures", + Short: "Dump data structures", Long: ` The "dump" command dumps data structures from the repository as JSON objects. It is used for debugging purposes only.`, diff --git a/cmd/restic/cmd_find.go b/cmd/restic/cmd_find.go index 2eb8be112..16e631ef9 100644 --- a/cmd/restic/cmd_find.go +++ b/cmd/restic/cmd_find.go @@ -16,7 +16,7 @@ import ( var cmdFind = &cobra.Command{ Use: "find [flags] PATTERN", - Short: "find a file or directory", + Short: "Find a file or directory", Long: ` The "find" command searches for files or directories in snapshots stored in the repo. `, diff --git a/cmd/restic/cmd_forget.go b/cmd/restic/cmd_forget.go index 479366f4c..85cad063c 100644 --- a/cmd/restic/cmd_forget.go +++ b/cmd/restic/cmd_forget.go @@ -13,7 +13,7 @@ import ( var cmdForget = &cobra.Command{ Use: "forget [flags] [snapshot ID] [...]", - Short: "remove snapshots from the repository", + Short: "Remove snapshots from the repository", Long: ` The "forget" command removes snapshots according to a policy. Please note that this command really only deletes the snapshot object in the repository, which diff --git a/cmd/restic/cmd_init.go b/cmd/restic/cmd_init.go index cc4dae3ae..d4bcd9a0e 100644 --- a/cmd/restic/cmd_init.go +++ b/cmd/restic/cmd_init.go @@ -11,7 +11,7 @@ import ( var cmdInit = &cobra.Command{ Use: "init", - Short: "initialize a new repository", + Short: "Initialize a new repository", Long: ` The "init" command initializes a new repository. `, diff --git a/cmd/restic/cmd_key.go b/cmd/restic/cmd_key.go index 168ed82d3..1fbbd0f3f 100644 --- a/cmd/restic/cmd_key.go +++ b/cmd/restic/cmd_key.go @@ -13,7 +13,7 @@ import ( var cmdKey = &cobra.Command{ Use: "key [list|add|remove|passwd] [ID]", - Short: "manage keys (passwords)", + Short: "Manage keys (passwords)", Long: ` The "key" command manages keys (passwords) for accessing the repository. `, diff --git a/cmd/restic/cmd_list.go b/cmd/restic/cmd_list.go index 5bdde1d81..ea8fb3876 100644 --- a/cmd/restic/cmd_list.go +++ b/cmd/restic/cmd_list.go @@ -13,7 +13,7 @@ import ( var cmdList = &cobra.Command{ Use: "list [blobs|packs|index|snapshots|keys|locks]", - Short: "list objects in the repository", + Short: "List objects in the repository", Long: ` The "list" command allows listing objects in the repository based on type. `, diff --git a/cmd/restic/cmd_ls.go b/cmd/restic/cmd_ls.go index da538bc7d..7ea0759a5 100644 --- a/cmd/restic/cmd_ls.go +++ b/cmd/restic/cmd_ls.go @@ -13,7 +13,7 @@ import ( var cmdLs = &cobra.Command{ Use: "ls [flags] [snapshot-ID ...]", - Short: "list files in a snapshot", + Short: "List files in a snapshot", Long: ` The "ls" command allows listing files and directories in a snapshot. diff --git a/cmd/restic/cmd_manpage.go b/cmd/restic/cmd_manpage.go index 46822a662..1d39f4242 100644 --- a/cmd/restic/cmd_manpage.go +++ b/cmd/restic/cmd_manpage.go @@ -11,7 +11,7 @@ import ( var cmdManpage = &cobra.Command{ Use: "manpage [command]", - Short: "generate manual pages", + Short: "Generate manual pages", Long: ` The "manpage" command generates a manual page for a single command. It can also be used to write all manual pages to a directory. If the output directory is diff --git a/cmd/restic/cmd_migrate.go b/cmd/restic/cmd_migrate.go index a4032775f..d5738595e 100644 --- a/cmd/restic/cmd_migrate.go +++ b/cmd/restic/cmd_migrate.go @@ -9,7 +9,7 @@ import ( var cmdMigrate = &cobra.Command{ Use: "migrate [name]", - Short: "apply migrations", + Short: "Apply migrations", Long: ` The "migrate" command applies migrations to a repository. When no migration name is explicitly given, a list of migrations that can be applied is printed. diff --git a/cmd/restic/cmd_mount.go b/cmd/restic/cmd_mount.go index 76f2e5915..8f24fdcc9 100644 --- a/cmd/restic/cmd_mount.go +++ b/cmd/restic/cmd_mount.go @@ -22,7 +22,7 @@ import ( var cmdMount = &cobra.Command{ Use: "mount [flags] mountpoint", - Short: "mount the repository", + Short: "Mount the repository", Long: ` The "mount" command mounts the repository via fuse to a directory. This is a read-only mount. diff --git a/cmd/restic/cmd_options.go b/cmd/restic/cmd_options.go index d30002a92..6edcbebec 100644 --- a/cmd/restic/cmd_options.go +++ b/cmd/restic/cmd_options.go @@ -10,7 +10,7 @@ import ( var optionsCmd = &cobra.Command{ Use: "options", - Short: "print list of extended options", + Short: "Print list of extended options", Long: ` The "options" command prints a list of extended options. `, diff --git a/cmd/restic/cmd_prune.go b/cmd/restic/cmd_prune.go index ea60fd451..c50b3413e 100644 --- a/cmd/restic/cmd_prune.go +++ b/cmd/restic/cmd_prune.go @@ -15,7 +15,7 @@ import ( var cmdPrune = &cobra.Command{ Use: "prune [flags]", - Short: "remove unneeded data from the repository", + Short: "Remove unneeded data from the repository", Long: ` The "prune" command checks the repository and removes data that is not referenced and therefore not needed any more. diff --git a/cmd/restic/cmd_rebuild_index.go b/cmd/restic/cmd_rebuild_index.go index 2f194b93a..92cbf3360 100644 --- a/cmd/restic/cmd_rebuild_index.go +++ b/cmd/restic/cmd_rebuild_index.go @@ -11,7 +11,7 @@ import ( var cmdRebuildIndex = &cobra.Command{ Use: "rebuild-index [flags]", - Short: "build a new index file", + Short: "Build a new index file", Long: ` The "rebuild-index" command creates a new index based on the pack files in the repository. diff --git a/cmd/restic/cmd_restore.go b/cmd/restic/cmd_restore.go index ae54ec457..11eb13a23 100644 --- a/cmd/restic/cmd_restore.go +++ b/cmd/restic/cmd_restore.go @@ -11,7 +11,7 @@ import ( var cmdRestore = &cobra.Command{ Use: "restore [flags] snapshotID", - Short: "extract the data from a snapshot", + Short: "Extract the data from a snapshot", Long: ` The "restore" command extracts the data from a snapshot from the repository to a directory. diff --git a/cmd/restic/cmd_snapshots.go b/cmd/restic/cmd_snapshots.go index 6e14a9bec..29795e1d1 100644 --- a/cmd/restic/cmd_snapshots.go +++ b/cmd/restic/cmd_snapshots.go @@ -13,7 +13,7 @@ import ( var cmdSnapshots = &cobra.Command{ Use: "snapshots [snapshotID ...]", - Short: "list all snapshots", + Short: "List all snapshots", Long: ` The "snapshots" command lists all snapshots stored in the repository. `, diff --git a/cmd/restic/cmd_tag.go b/cmd/restic/cmd_tag.go index b8c328b61..2c70399e5 100644 --- a/cmd/restic/cmd_tag.go +++ b/cmd/restic/cmd_tag.go @@ -13,7 +13,7 @@ import ( var cmdTag = &cobra.Command{ Use: "tag [flags] [snapshot-ID ...]", - Short: "modify tags on snapshots", + Short: "Modify tags on snapshots", Long: ` The "tag" command allows you to modify tags on exiting snapshots. diff --git a/cmd/restic/cmd_unlock.go b/cmd/restic/cmd_unlock.go index 0b306c37c..5297b0e4e 100644 --- a/cmd/restic/cmd_unlock.go +++ b/cmd/restic/cmd_unlock.go @@ -9,7 +9,7 @@ import ( var unlockCmd = &cobra.Command{ Use: "unlock", - Short: "remove locks other processes created", + Short: "Remove locks other processes created", Long: ` The "unlock" command removes stale locks that have been created by other restic processes. `, diff --git a/cmd/restic/cmd_version.go b/cmd/restic/cmd_version.go index 85b8c9e9f..669c356be 100644 --- a/cmd/restic/cmd_version.go +++ b/cmd/restic/cmd_version.go @@ -9,7 +9,7 @@ import ( var versionCmd = &cobra.Command{ Use: "version", - Short: "print version information", + Short: "Print version information", Long: ` The "version" command prints detailed information about the build environment and the version of this software. diff --git a/cmd/restic/main.go b/cmd/restic/main.go index 602928447..d1f9c5547 100644 --- a/cmd/restic/main.go +++ b/cmd/restic/main.go @@ -20,7 +20,7 @@ import ( // cmdRoot is the base command when no other command has been specified. var cmdRoot = &cobra.Command{ Use: "restic", - Short: "backup and restore files", + Short: "Backup and restore files", Long: ` restic is a backup program which allows saving multiple revisions of files and directories in an encrypted repository stored on different backends. diff --git a/doc/manual.rst b/doc/manual.rst index a974d957b..239468d89 100644 --- a/doc/manual.rst +++ b/doc/manual.rst @@ -16,23 +16,23 @@ Usage help is available: restic [command] Available Commands: - autocomplete generate shell autocompletion script - backup create a new backup of files and/or directories - cat print internal objects to stdout - check check the repository for errors - find find a file or directory - forget remove snapshots from the repository - init initialize a new repository - key manage keys (passwords) - list list items in the repository - ls list files in a snapshot - mount mount the repository - prune remove unneeded data from the repository - rebuild-index build a new index file - restore extract the data from a snapshot - snapshots list all snapshots - tag modify tags on snapshots - unlock remove locks other processes created + autocomplete Generate shell autocompletion script + backup Create a new backup of files and/or directories + cat Print internal objects to stdout + check Check the repository for errors + find Find a file or directory + forget Remove snapshots from the repository + init Initialize a new repository + key Manage keys (passwords) + list List items in the repository + ls List files in a snapshot + mount Mount the repository + prune Remove unneeded data from the repository + rebuild-index Build a new index file + restore Extract the data from a snapshot + snapshots List all snapshots + tag Modify tags on snapshots + unlock Remove locks other processes created version Print version information Flags: