Make generated man pages more easy to read with items
Allow Cobra to output a more list items friendly format, this make reading of the documentation more easily using information from manpages.
This commit is contained in:
parent
5cc224e44a
commit
a065ada46a
2 changed files with 12 additions and 16 deletions
|
@ -21,11 +21,11 @@ The "diff" command shows differences from the first to the second snapshot. The
|
||||||
first characters in each line display what has happened to a particular file or
|
first characters in each line display what has happened to a particular file or
|
||||||
directory:
|
directory:
|
||||||
|
|
||||||
+ The item was added
|
* + The item was added
|
||||||
- The item was removed
|
* - The item was removed
|
||||||
U The metadata (access mode, timestamps, ...) for the item was updated
|
* U The metadata (access mode, timestamps, ...) for the item was updated
|
||||||
M The file's content was modified
|
* M The file's content was modified
|
||||||
T The type was changed, e.g. a file was made a symlink
|
* T The type was changed, e.g. a file was made a symlink
|
||||||
`,
|
`,
|
||||||
DisableAutoGenTag: true,
|
DisableAutoGenTag: true,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
|
|
@ -30,17 +30,13 @@ to calculate.
|
||||||
|
|
||||||
The modes are:
|
The modes are:
|
||||||
|
|
||||||
restore-size: (default) Counts the size of the restored files.
|
* restore-size: (default) Counts the size of the restored files.
|
||||||
|
* files-by-contents: Counts total size of files, where a file is
|
||||||
files-by-contents: Counts total size of files, where a file is
|
considered unique if it has unique contents.
|
||||||
considered unique if it has unique contents.
|
* raw-data: Counts the size of blobs in the repository, regardless of
|
||||||
|
how many files reference them.
|
||||||
raw-data: Counts the size of blobs in the repository, regardless
|
* blobs-per-file: A combination of files-by-contents and raw-data.
|
||||||
of how many files reference them.
|
* Refer to the online manual for more details about each mode.
|
||||||
|
|
||||||
blobs-per-file: A combination of files-by-contents and raw-data.
|
|
||||||
|
|
||||||
Refer to the online manual for more details about each mode.
|
|
||||||
`,
|
`,
|
||||||
DisableAutoGenTag: true,
|
DisableAutoGenTag: true,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
|
Loading…
Reference in a new issue