Skip to content

Commit b1889c3

Browse files
Jonathan Niedergitster
Jonathan Nieder
authored and
gitster
committed
Documentation: be consistent about "git-" versus "git "
Since the git-* commands are not installed in $(bindir), using "git-command <parameters>" in examples in the documentation is not a good idea. On the other hand, it is nice to be able to refer to each command using one hyphenated word. (There is no escaping it, anyway: man page names cannot have spaces in them.) This patch retains the dash in naming an operation, command, program, process, or action. Complete command lines that can be entered at a shell (i.e., without options omitted) are made to use the dashless form. The changes consist only of replacing some spaces with hyphens and vice versa. After a "s/ /-/g", the unpatched and patched versions are identical. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 46e56e8 commit b1889c3

File tree

131 files changed

+462
-462
lines changed

Some content is hidden

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

131 files changed

+462
-462
lines changed

‎Documentation/git-add.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-add - Add file contents to the index
88
SYNOPSIS
99
--------
1010
[verse]
11-
'git-add' [-n] [-v] [--force | -f] [--interactive | -i] [--patch | -p]
11+
'git add' [-n] [-v] [--force | -f] [--interactive | -i] [--patch | -p]
1212
[--update | -u] [--refresh] [--ignore-errors] [--]
1313
<filepattern>...
1414

‎Documentation/git-am.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ git-am - Apply a series of patches from a mailbox
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git-am' [--signoff] [--keep] [--utf8 | --no-utf8]
12+
'git am' [--signoff] [--keep] [--utf8 | --no-utf8]
1313
[--3way] [--interactive] [--binary]
1414
[--whitespace=<option>] [-C<n>] [-p<n>]
1515
<mbox>|<Maildir>...
16-
'git-am' [--skip | --resolved]
16+
'git am' [--skip | --resolved]
1717

1818
DESCRIPTION
1919
-----------

‎Documentation/git-annotate.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ git-annotate - Annotate file lines with commit info
77

88
SYNOPSIS
99
--------
10-
git-annotate [options] file [revision]
10+
git annotate [options] file [revision]
1111

1212
DESCRIPTION
1313
-----------

‎Documentation/git-apply.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-apply - Apply a patch on a git index file and a working tree
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git-apply' [--stat] [--numstat] [--summary] [--check] [--index]
12+
'git apply' [--stat] [--numstat] [--summary] [--check] [--index]
1313
[--apply] [--no-add] [--build-fake-ancestor <file>] [-R | --reverse]
1414
[--allow-binary-replacement | --binary] [--reject] [-z]
1515
[-pNUM] [-CNUM] [--inaccurate-eof] [--recount] [--cached]

‎Documentation/git-archimport.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-archimport - Import an Arch repository into git
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git-archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir]
12+
'git archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir]
1313
<archive/branch>[:<git-branch>] ...
1414

1515
DESCRIPTION

‎Documentation/git-archive.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-archive - Create an archive of files from a named tree
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git-archive' --format=<fmt> [--list] [--prefix=<prefix>/] [<extra>]
12+
'git archive' --format=<fmt> [--list] [--prefix=<prefix>/] [<extra>]
1313
[--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
1414
[path...]
1515

‎Documentation/git-bisect.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ on the subcommand:
2626
git bisect log
2727
git bisect run <cmd>...
2828

29-
This command uses 'git-rev-list --bisect' option to help drive the
29+
This command uses 'git rev-list --bisect' option to help drive the
3030
binary search process to find which change introduced a bug, given an
3131
old "good" commit object name and a later "bad" commit object name.
3232

‎Documentation/git-blame.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-blame - Show what revision and author last modified each line of a file
88
SYNOPSIS
99
--------
1010
[verse]
11-
'git-blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-p] [-w] [--incremental] [-L n,m]
11+
'git blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-p] [-w] [--incremental] [-L n,m]
1212
[-S <revs-file>] [-M] [-C] [-C] [--since=<date>]
1313
[<rev> | --contents <file>] [--] <file>
1414

‎Documentation/git-branch.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ git-branch - List, create, or delete branches
88
SYNOPSIS
99
--------
1010
[verse]
11-
'git-branch' [--color | --no-color] [-r | -a] [--merged | --no-merged]
11+
'git branch' [--color | --no-color] [-r | -a] [--merged | --no-merged]
1212
[-v [--abbrev=<length> | --no-abbrev]]
1313
[--contains <commit>]
14-
'git-branch' [--track | --no-track] [-l] [-f] <branchname> [<start-point>]
15-
'git-branch' (-m | -M) [<oldbranch>] <newbranch>
16-
'git-branch' (-d | -D) [-r] <branchname>...
14+
'git branch' [--track | --no-track] [-l] [-f] <branchname> [<start-point>]
15+
'git branch' (-m | -M) [<oldbranch>] <newbranch>
16+
'git branch' (-d | -D) [-r] <branchname>...
1717

1818
DESCRIPTION
1919
-----------

‎Documentation/git-bundle.txt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ git-bundle - Move objects and refs by archive
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git-bundle' create <file> <git-rev-list args>
13-
'git-bundle' verify <file>
14-
'git-bundle' list-heads <file> [refname...]
15-
'git-bundle' unbundle <file> [refname...]
12+
'git bundle' create <file> <git-rev-list args>
13+
'git bundle' verify <file>
14+
'git bundle' list-heads <file> [refname...]
15+
'git bundle' unbundle <file> [refname...]
1616

1717
DESCRIPTION
1818
-----------
@@ -116,7 +116,7 @@ We set a tag in R1 (lastR2bundle) after the previous such transport,
116116
and move it afterwards to help build the bundle.
117117

118118
------------
119-
$ git-bundle create mybundle master ^lastR2bundle
119+
$ git bundle create mybundle master ^lastR2bundle
120120
$ git tag -f lastR2bundle master
121121
------------
122122

@@ -141,8 +141,8 @@ $ git bundle create mybundle master -n 10
141141
Then you move mybundle from A to B, and in R2 on B:
142142

143143
------------
144-
$ git-bundle verify mybundle
145-
$ git-fetch mybundle master:localRef
144+
$ git bundle verify mybundle
145+
$ git fetch mybundle master:localRef
146146
------------
147147

148148
With something like this in the config in R2:

0 commit comments

Comments
 (0)