Skip to content

Commit a8a5406

Browse files
rhansengitster
authored andcommitted
use 'commit-ish' instead of 'committish'
Replace 'committish' in documentation and comments with 'commit-ish' to match gitglossary(7) and to be consistent with 'tree-ish'. The only remaining instances of 'committish' are: * variable, function, and macro names * "(also committish)" in the definition of commit-ish in gitglossary[7] Signed-off-by: Richard Hansen <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent bb8040f commit a8a5406

23 files changed

+63
-63
lines changed

Documentation/config.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,8 @@ advice.*::
170170
pushNeedsForce::
171171
Shown when linkgit:git-push[1] rejects an update that
172172
tries to overwrite a remote ref that points at an
173-
object that is not a committish, or make the remote
174-
ref point at an object that is not a committish.
173+
object that is not a commit-ish, or make the remote
174+
ref point at an object that is not a commit-ish.
175175
statusHints::
176176
Show directions on how to proceed from the current
177177
state in the output of linkgit:git-status[1], in

Documentation/git-describe.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-describe - Show the most recent tag that is reachable from a commit
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>...
12+
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <commit-ish>...
1313
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]
1414

1515
DESCRIPTION
@@ -26,8 +26,8 @@ see the -a and -s options to linkgit:git-tag[1].
2626

2727
OPTIONS
2828
-------
29-
<committish>...::
30-
Committish object names to describe.
29+
<commit-ish>...::
30+
Commit-ish object names to describe.
3131

3232
--dirty[=<mark>]::
3333
Describe the working tree.
@@ -57,7 +57,7 @@ OPTIONS
5757

5858
--candidates=<n>::
5959
Instead of considering only the 10 most recent tags as
60-
candidates to describe the input committish consider
60+
candidates to describe the input commit-ish consider
6161
up to <n> candidates. Increasing <n> above 10 will take
6262
slightly longer but may produce a more accurate result.
6363
An <n> of 0 will cause only exact matches to be output.
@@ -145,7 +145,7 @@ be sufficient to disambiguate these commits.
145145
SEARCH STRATEGY
146146
---------------
147147

148-
For each committish supplied, 'git describe' will first look for
148+
For each commit-ish supplied, 'git describe' will first look for
149149
a tag which tags exactly that commit. Annotated tags will always
150150
be preferred over lightweight tags, and tags with newer dates will
151151
always be preferred over tags with older dates. If an exact match
@@ -154,12 +154,12 @@ is found, its name will be output and searching will stop.
154154
If an exact match was not found, 'git describe' will walk back
155155
through the commit history to locate an ancestor commit which
156156
has been tagged. The ancestor's tag will be output along with an
157-
abbreviation of the input committish's SHA-1. If '--first-parent' was
157+
abbreviation of the input commit-ish's SHA-1. If '--first-parent' was
158158
specified then the walk will only consider the first parent of each
159159
commit.
160160

161161
If multiple tags were found during the walk then the tag which
162-
has the fewest commits different from the input committish will be
162+
has the fewest commits different from the input commit-ish will be
163163
selected and output. Here fewest commits different is defined as
164164
the number of commits which would be shown by `git log tag..input`
165165
will be the smallest number of commits possible.

Documentation/git-fast-import.txt

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -380,8 +380,8 @@ change to the project.
380380
('author' (SP <name>)? SP LT <email> GT SP <when> LF)?
381381
'committer' (SP <name>)? SP LT <email> GT SP <when> LF
382382
data
383-
('from' SP <committish> LF)?
384-
('merge' SP <committish> LF)?
383+
('from' SP <commit-ish> LF)?
384+
('merge' SP <commit-ish> LF)?
385385
(filemodify | filedelete | filecopy | filerename | filedeleteall | notemodify)*
386386
LF?
387387
....
@@ -460,9 +460,9 @@ as the current commit on that branch is automatically assumed to
460460
be the first ancestor of the new commit.
461461

462462
As `LF` is not valid in a Git refname or SHA-1 expression, no
463-
quoting or escaping syntax is supported within `<committish>`.
463+
quoting or escaping syntax is supported within `<commit-ish>`.
464464

465-
Here `<committish>` is any of the following:
465+
Here `<commit-ish>` is any of the following:
466466

467467
* The name of an existing branch already in fast-import's internal branch
468468
table. If fast-import doesn't know the name, it's treated as a SHA-1
@@ -509,7 +509,7 @@ additional ancestors (forming a 16-way merge). For this reason
509509
it is suggested that frontends do not use more than 15 `merge`
510510
commands per commit; 16, if starting a new, empty branch.
511511

512-
Here `<committish>` is any of the commit specification expressions
512+
Here `<commit-ish>` is any of the commit specification expressions
513513
also accepted by `from` (see above).
514514

515515
`filemodify`
@@ -677,8 +677,8 @@ paths for a commit are encouraged to do so.
677677
`notemodify`
678678
^^^^^^^^^^^^
679679
Included in a `commit` `<notes_ref>` command to add a new note
680-
annotating a `<committish>` or change this annotation contents.
681-
Internally it is similar to filemodify 100644 on `<committish>`
680+
annotating a `<commit-ish>` or change this annotation contents.
681+
Internally it is similar to filemodify 100644 on `<commit-ish>`
682682
path (maybe split into subdirectories). It's not advised to
683683
use any other commands to write to the `<notes_ref>` tree except
684684
`filedeleteall` to delete all existing notes in this tree.
@@ -691,7 +691,7 @@ External data format::
691691
commit that is to be annotated.
692692
+
693693
....
694-
'N' SP <dataref> SP <committish> LF
694+
'N' SP <dataref> SP <commit-ish> LF
695695
....
696696
+
697697
Here `<dataref>` can be either a mark reference (`:<idnum>`)
@@ -704,13 +704,13 @@ Inline data format::
704704
command.
705705
+
706706
....
707-
'N' SP 'inline' SP <committish> LF
707+
'N' SP 'inline' SP <commit-ish> LF
708708
data
709709
....
710710
+
711711
See below for a detailed description of the `data` command.
712712

713-
In both formats `<committish>` is any of the commit specification
713+
In both formats `<commit-ish>` is any of the commit specification
714714
expressions also accepted by `from` (see above).
715715

716716
`mark`
@@ -741,7 +741,7 @@ lightweight (non-annotated) tags see the `reset` command below.
741741

742742
....
743743
'tag' SP <name> LF
744-
'from' SP <committish> LF
744+
'from' SP <commit-ish> LF
745745
'tagger' (SP <name>)? SP LT <email> GT SP <when> LF
746746
data
747747
....
@@ -786,11 +786,11 @@ branch from an existing commit without creating a new commit.
786786

787787
....
788788
'reset' SP <ref> LF
789-
('from' SP <committish> LF)?
789+
('from' SP <commit-ish> LF)?
790790
LF?
791791
....
792792

793-
For a detailed description of `<ref>` and `<committish>` see above
793+
For a detailed description of `<ref>` and `<commit-ish>` see above
794794
under `commit` and `from`.
795795

796796
The `LF` after the command is optional (it used to be required).

Documentation/git-name-rev.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ SYNOPSIS
1010
--------
1111
[verse]
1212
'git name-rev' [--tags] [--refs=<pattern>]
13-
( --all | --stdin | <committish>... )
13+
( --all | --stdin | <commit-ish>... )
1414

1515
DESCRIPTION
1616
-----------

Documentation/git-push.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ already exists on the remote side.
120120
--follow-tags::
121121
Push all the refs that would be pushed without this option,
122122
and also push annotated tags in `refs/tags` that are missing
123-
from the remote but are pointing at committish that are
123+
from the remote but are pointing at commit-ish that are
124124
reachable from the refs being pushed.
125125

126126
--receive-pack=<git-receive-pack>::

Documentation/gitcli.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ couple of magic command line options:
106106
+
107107
---------------------------------------------
108108
$ git describe -h
109-
usage: git describe [options] <committish>*
109+
usage: git describe [options] <commit-ish>*
110110
or: git describe [options] --dirty
111111

112112
--contains find the tag that comes after the commit

Documentation/howto/revert-branch-rebase.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ $ git pull . master
154154
Packing 0 objects
155155
Unpacking 0 objects
156156

157-
* committish: e3a693c... refs/heads/master from .
157+
* commit-ish: e3a693c... refs/heads/master from .
158158
Trying to merge e3a693c... into 8c1f5f0... using 10d781b...
159159
Committed merge 7fb9b7262a1d1e0a47bbfdcbbcf50ce0635d3f8f
160160
cache.h | 8 ++++----

builtin/describe.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
#define MAX_TAGS (FLAG_BITS - 1)
1414

1515
static const char * const describe_usage[] = {
16-
N_("git describe [options] <committish>*"),
16+
N_("git describe [options] <commit-ish>*"),
1717
N_("git describe [options] --dirty"),
1818
NULL
1919
};
@@ -486,7 +486,7 @@ int cmd_describe(int argc, const char **argv, const char *prefix)
486486
}
487487
describe("HEAD", 1);
488488
} else if (dirty) {
489-
die(_("--dirty is incompatible with committishes"));
489+
die(_("--dirty is incompatible with commit-ishes"));
490490
} else {
491491
while (argc-- > 0) {
492492
describe(*argv++, argc == 0);

builtin/merge.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1193,7 +1193,7 @@ int cmd_merge(int argc, const char **argv, const char *prefix)
11931193
* This could be traditional "merge <msg> HEAD <commit>..." and
11941194
* the way we can tell it is to see if the second token is HEAD,
11951195
* but some people might have misused the interface and used a
1196-
* committish that is the same as HEAD there instead.
1196+
* commit-ish that is the same as HEAD there instead.
11971197
* Traditional format never would have "-m" so it is an
11981198
* additional safety measure to check for it.
11991199
*/

contrib/examples/git-merge.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ fi
263263

264264
# This could be traditional "merge <msg> HEAD <commit>..." and the
265265
# way we can tell it is to see if the second token is HEAD, but some
266-
# people might have misused the interface and used a committish that
266+
# people might have misused the interface and used a commit-ish that
267267
# is the same as HEAD there instead. Traditional format never would
268268
# have "-m" so it is an additional safety measure to check for it.
269269

0 commit comments

Comments
 (0)