standardize usage info string format

This patch puts the usage info strings that were not already in docopt-
like format into docopt-like format, which will be a litle easier for
end users and a lot easier for translators. Changes include:

- Placing angle brackets around fill-in-the-blank parameters
- Putting dashes in multiword parameter names
- Adding spaces to [-f|--foobar] to make [-f | --foobar]
- Replacing <foobar>* with [<foobar>...]

Signed-off-by: Alex Henrie <alexhenrie24@gmail.com>
Reviewed-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Alex Henrie
2015-01-13 00:44:47 -07:00
committed by Junio C Hamano
parent addfb21a94
commit 9c9b4f2f8b
64 changed files with 109 additions and 105 deletions

View File

@ -441,6 +441,10 @@ Writing Documentation:
--sort=<key>
--abbrev[=<n>]
If a placeholder has multiple words, they are separated by dashes:
<new-branch-name>
--template=<template-directory>
Possibility of multiple occurrences is indicated by three dots:
<file>...
(One or more of <file>.)
@ -457,12 +461,12 @@ Writing Documentation:
(Zero or more of <patch>. Note that the dots are inside, not
outside the brackets.)
Multiple alternatives are indicated with vertical bar:
Multiple alternatives are indicated with vertical bars:
[-q | --quiet]
[--utf8 | --no-utf8]
Parentheses are used for grouping:
[(<rev>|<range>)...]
[(<rev> | <range>)...]
(Any number of either <rev> or <range>. Parens are needed to make
it clear that "..." pertains to both <rev> and <range>.)