diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2015-02-11 13:44:19 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2015-02-11 13:44:20 -0800 |
| commit | bb831db6774aaa733199360dc7af6f3ce375fc20 (patch) | |
| tree | 4d4befdb8dfc6b9ddafec4550a6e44aaacd89dd9 /Documentation | |
| parent | Merge branch 'jc/pretty-format-doc' (diff) | |
| parent | standardize usage info string format (diff) | |
| download | tgif-bb831db6774aaa733199360dc7af6f3ce375fc20.tar.xz | |
Merge branch 'ah/usage-strings'
* ah/usage-strings:
standardize usage info string format
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/CodingGuidelines | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 578d07c034..49089de5c0 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -446,6 +446,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>.) @@ -462,12 +466,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>.) |