Это покрыто git's CodingGuidelines, найденное на их Github. Это дает вкладчикам руководство по стилю, а также описывает, как должны быть написаны варианты помощи. Другие источники, такие как POSIX или BSD, не должны восприниматься как авторитетные, тем более, что они не всегда соответствуют POSIX . Следующий фрагмент находится вблизи нижней части файла:
Placeholders are spelled in lowercase and enclosed in angle brackets:
<file>
--sort=<key>
--abbrev[=<n>]
Optional parts are enclosed in square brackets:
[<extra>]
(Zero or one <extra>.)
--exec-path[=<path>]
(Option with an optional argument. Note that the "=" is inside the
brackets.)
[<patch>...]
(Zero or more of <patch>. Note that the dots are inside, not
outside the brackets.)
Multiple alternatives are indicated with vertical bars:
[-q | --quiet]
[--utf8 | --no-utf8]
Parentheses are used for grouping:
[(<rev> | <range>)...]
(Any number of either <rev> or <range>. Parens are needed to make
it clear that "..." pertains to both <rev> and <range>.)
[(-p <parent>)...]
(Any number of option -p, each with one <parent> argument.)
git remote set-head <name> (-a | -d | <branch>)
(One and only one of "-a", "-d" or "<branch>" _must_ (no square
brackets) be provided.)
And a somewhat more contrived example:
--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]
Here "=" is outside the brackets, because "--diff-filter=" is a
valid usage. "*" has its own pair of brackets, because it can
(optionally) be specified only when one or more of the letters is
also provided.
: Следующий фрагмент находится в верхней части файла:
Как и другие проекты, мы также некоторые рекомендации, чтобы сохранить к коду. Для Git в целом, несколько шероховатые правила:
Самое главное, что мы никогда не говорим «Это в стандарте POSIX, мы будем счастливо игнорировать ваши потребности должны система не соответствовать ей.» Мы живем в реальном мире.
Однако мы часто говорим: «Давайте держаться подальше от этой конструкции, это даже не в POSIX».
Несмотря двух вышеупомянутых правил, мы иногда говорим «Хотя это не в POSIX, это (так удобно | делает код гораздо более читаемых | имеют другие хорошие характеристики) и практически все платформы мы заботиться о поддержке, поэтому давайте использовать его ».
Опять же, мы живем в реальном мире, и это иногда
суждения вызов, решение, основанное больше на реальных ограничениях людей сталкиваются, чем то, что говорит стандартная бумага.
Смысл в том, что, чтобы получить эту версию команды, вы * должны * использовать один из этих двух вариантов, '' --patch' или -p'. – torek
Посмотрите на 'git stash', который также имеет версию, используя круглые скобки. –
Спасибо, @torek. Это звучит разумно. Гит ожидает, что читатели сделают это значение? Я не нашел ссылки на использование круглых скобок в синопсисе команды. – nn0p