Skip to content

Commit bb831db

Browse files
committedFeb 11, 2015
Merge branch 'ah/usage-strings'
* ah/usage-strings: standardize usage info string format
2 parents afa3ccb + 9c9b4f2 commit bb831db

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+108
-104
lines changed
 

‎Documentation/CodingGuidelines

+6-2
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,10 @@ Writing Documentation:
446446
--sort=<key>
447447
--abbrev[=<n>]
448448

449+
If a placeholder has multiple words, they are separated by dashes:
450+
<new-branch-name>
451+
--template=<template-directory>
452+
449453
Possibility of multiple occurrences is indicated by three dots:
450454
<file>...
451455
(One or more of <file>.)
@@ -462,12 +466,12 @@ Writing Documentation:
462466
(Zero or more of <patch>. Note that the dots are inside, not
463467
outside the brackets.)
464468

465-
Multiple alternatives are indicated with vertical bar:
469+
Multiple alternatives are indicated with vertical bars:
466470
[-q | --quiet]
467471
[--utf8 | --no-utf8]
468472

469473
Parentheses are used for grouping:
470-
[(<rev>|<range>)...]
474+
[(<rev> | <range>)...]
471475
(Any number of either <rev> or <range>. Parens are needed to make
472476
it clear that "..." pertains to both <rev> and <range>.)
473477

‎advice.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ void detach_advice(const char *new_name)
105105
"state without impacting any branches by performing another checkout.\n\n"
106106
"If you want to create a new branch to retain commits you create, you may\n"
107107
"do so (now or later) by using -b with the checkout command again. Example:\n\n"
108-
" git checkout -b new_branch_name\n\n";
108+
" git checkout -b <new-branch-name>\n\n";
109109

110110
fprintf(stderr, fmt, new_name);
111111
}

0 commit comments

Comments
 (0)