Skip to content

Commit

Permalink
use 'commit-ish' instead of 'committish'
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
rhansen authored and gitster committed Sep 4, 2013
1 parent bb8040f commit a8a5406
Show file tree
Hide file tree
Showing 23 changed files with 63 additions and 63 deletions.
4 changes: 2 additions & 2 deletions Documentation/config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,8 @@ advice.*::
pushNeedsForce::
Shown when linkgit:git-push[1] rejects an update that
tries to overwrite a remote ref that points at an
object that is not a committish, or make the remote
ref point at an object that is not a committish.
object that is not a commit-ish, or make the remote
ref point at an object that is not a commit-ish.
statusHints::
Show directions on how to proceed from the current
state in the output of linkgit:git-status[1], in
Expand Down
14 changes: 7 additions & 7 deletions Documentation/git-describe.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ git-describe - Show the most recent tag that is reachable from a commit
SYNOPSIS
--------
[verse]
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>...
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <commit-ish>...
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]

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

OPTIONS
-------
<committish>...::
Committish object names to describe.
<commit-ish>...::
Commit-ish object names to describe.

--dirty[=<mark>]::
Describe the working tree.
Expand Down Expand Up @@ -57,7 +57,7 @@ OPTIONS

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

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

If multiple tags were found during the walk then the tag which
has the fewest commits different from the input committish will be
has the fewest commits different from the input commit-ish will be
selected and output. Here fewest commits different is defined as
the number of commits which would be shown by `git log tag..input`
will be the smallest number of commits possible.
Expand Down
26 changes: 13 additions & 13 deletions Documentation/git-fast-import.txt
Original file line number Diff line number Diff line change
Expand Up @@ -380,8 +380,8 @@ change to the project.
('author' (SP <name>)? SP LT <email> GT SP <when> LF)?
'committer' (SP <name>)? SP LT <email> GT SP <when> LF
data
('from' SP <committish> LF)?
('merge' SP <committish> LF)?
('from' SP <commit-ish> LF)?
('merge' SP <commit-ish> LF)?
(filemodify | filedelete | filecopy | filerename | filedeleteall | notemodify)*
LF?
....
Expand Down Expand Up @@ -460,9 +460,9 @@ as the current commit on that branch is automatically assumed to
be the first ancestor of the new commit.

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

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

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

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

`filemodify`
Expand Down Expand Up @@ -677,8 +677,8 @@ paths for a commit are encouraged to do so.
`notemodify`
^^^^^^^^^^^^
Included in a `commit` `<notes_ref>` command to add a new note
annotating a `<committish>` or change this annotation contents.
Internally it is similar to filemodify 100644 on `<committish>`
annotating a `<commit-ish>` or change this annotation contents.
Internally it is similar to filemodify 100644 on `<commit-ish>`
path (maybe split into subdirectories). It's not advised to
use any other commands to write to the `<notes_ref>` tree except
`filedeleteall` to delete all existing notes in this tree.
Expand All @@ -691,7 +691,7 @@ External data format::
commit that is to be annotated.
+
....
'N' SP <dataref> SP <committish> LF
'N' SP <dataref> SP <commit-ish> LF
....
+
Here `<dataref>` can be either a mark reference (`:<idnum>`)
Expand All @@ -704,13 +704,13 @@ Inline data format::
command.
+
....
'N' SP 'inline' SP <committish> LF
'N' SP 'inline' SP <commit-ish> LF
data
....
+
See below for a detailed description of the `data` command.

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

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

....
'tag' SP <name> LF
'from' SP <committish> LF
'from' SP <commit-ish> LF
'tagger' (SP <name>)? SP LT <email> GT SP <when> LF
data
....
Expand Down Expand Up @@ -786,11 +786,11 @@ branch from an existing commit without creating a new commit.

....
'reset' SP <ref> LF
('from' SP <committish> LF)?
('from' SP <commit-ish> LF)?
LF?
....

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

The `LF` after the command is optional (it used to be required).
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-name-rev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ SYNOPSIS
--------
[verse]
'git name-rev' [--tags] [--refs=<pattern>]
( --all | --stdin | <committish>... )
( --all | --stdin | <commit-ish>... )

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-push.txt
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ already exists on the remote side.
--follow-tags::
Push all the refs that would be pushed without this option,
and also push annotated tags in `refs/tags` that are missing
from the remote but are pointing at committish that are
from the remote but are pointing at commit-ish that are
reachable from the refs being pushed.

--receive-pack=<git-receive-pack>::
Expand Down
2 changes: 1 addition & 1 deletion Documentation/gitcli.txt
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ couple of magic command line options:
+
---------------------------------------------
$ git describe -h
usage: git describe [options] <committish>*
usage: git describe [options] <commit-ish>*
or: git describe [options] --dirty

--contains find the tag that comes after the commit
Expand Down
2 changes: 1 addition & 1 deletion Documentation/howto/revert-branch-rebase.txt
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ $ git pull . master
Packing 0 objects
Unpacking 0 objects

* committish: e3a693c... refs/heads/master from .
* commit-ish: e3a693c... refs/heads/master from .
Trying to merge e3a693c... into 8c1f5f0... using 10d781b...
Committed merge 7fb9b7262a1d1e0a47bbfdcbbcf50ce0635d3f8f
cache.h | 8 ++++----
Expand Down
4 changes: 2 additions & 2 deletions builtin/describe.c
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
#define MAX_TAGS (FLAG_BITS - 1)

static const char * const describe_usage[] = {
N_("git describe [options] <committish>*"),
N_("git describe [options] <commit-ish>*"),
N_("git describe [options] --dirty"),
NULL
};
Expand Down Expand Up @@ -486,7 +486,7 @@ int cmd_describe(int argc, const char **argv, const char *prefix)
}
describe("HEAD", 1);
} else if (dirty) {
die(_("--dirty is incompatible with committishes"));
die(_("--dirty is incompatible with commit-ishes"));
} else {
while (argc-- > 0) {
describe(*argv++, argc == 0);
Expand Down
2 changes: 1 addition & 1 deletion builtin/merge.c
Original file line number Diff line number Diff line change
Expand Up @@ -1193,7 +1193,7 @@ int cmd_merge(int argc, const char **argv, const char *prefix)
* This could be traditional "merge <msg> HEAD <commit>..." and
* the way we can tell it is to see if the second token is HEAD,
* but some people might have misused the interface and used a
* committish that is the same as HEAD there instead.
* commit-ish that is the same as HEAD there instead.
* Traditional format never would have "-m" so it is an
* additional safety measure to check for it.
*/
Expand Down
2 changes: 1 addition & 1 deletion contrib/examples/git-merge.sh
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ fi

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

Expand Down
16 changes: 8 additions & 8 deletions fast-import.c
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Format of STDIN stream:
('author' (sp name)? sp '<' email '>' sp when lf)?
'committer' (sp name)? sp '<' email '>' sp when lf
commit_msg
('from' sp committish lf)?
('merge' sp committish lf)*
('from' sp commit-ish lf)?
('merge' sp commit-ish lf)*
(file_change | ls)*
lf?;
commit_msg ::= data;
Expand All @@ -43,18 +43,18 @@ Format of STDIN stream:
file_obm ::= 'M' sp mode sp (hexsha1 | idnum) sp path_str lf;
file_inm ::= 'M' sp mode sp 'inline' sp path_str lf
data;
note_obm ::= 'N' sp (hexsha1 | idnum) sp committish lf;
note_inm ::= 'N' sp 'inline' sp committish lf
note_obm ::= 'N' sp (hexsha1 | idnum) sp commit-ish lf;
note_inm ::= 'N' sp 'inline' sp commit-ish lf
data;
new_tag ::= 'tag' sp tag_str lf
'from' sp committish lf
'from' sp commit-ish lf
('tagger' (sp name)? sp '<' email '>' sp when lf)?
tag_msg;
tag_msg ::= data;
reset_branch ::= 'reset' sp ref_str lf
('from' sp committish lf)?
('from' sp commit-ish lf)?
lf?;
checkpoint ::= 'checkpoint' lf
Expand Down Expand Up @@ -93,7 +93,7 @@ Format of STDIN stream:
# stream formatting is: \, " and LF. Otherwise these values
# are UTF8.
#
committish ::= (ref_str | hexsha1 | sha1exp_str | idnum);
commit-ish ::= (ref_str | hexsha1 | sha1exp_str | idnum);
ref_str ::= ref;
sha1exp_str ::= sha1exp;
tag_str ::= tag;
Expand Down Expand Up @@ -2478,7 +2478,7 @@ static void note_change_n(struct branch *b, unsigned char *old_fanout)
assert(*p == ' ');
p++; /* skip space */

/* <committish> */
/* <commit-ish> */
s = lookup_branch(p);
if (s) {
if (is_null_sha1(s->sha1))
Expand Down
2 changes: 1 addition & 1 deletion po/da.po
Original file line number Diff line number Diff line change
Expand Up @@ -1674,7 +1674,7 @@ msgid "No names found, cannot describe anything."
msgstr ""

#: builtin/describe.c:482
msgid "--dirty is incompatible with committishes"
msgid "--dirty is incompatible with commit-ishes"
msgstr ""

#: builtin/diff.c:77
Expand Down
6 changes: 3 additions & 3 deletions po/de.po
Original file line number Diff line number Diff line change
Expand Up @@ -4684,8 +4684,8 @@ msgid "print sizes in human readable format"
msgstr "gibt Größenangaben in menschenlesbaren Format aus"

#: builtin/describe.c:16
msgid "git describe [options] <committish>*"
msgstr "git describe [Optionen] <committish>*"
msgid "git describe [options] <commit-ish>*"
msgstr "git describe [Optionen] <commit-ish>*"

#: builtin/describe.c:17
msgid "git describe [options] --dirty"
Expand Down Expand Up @@ -4822,7 +4822,7 @@ msgid "No names found, cannot describe anything."
msgstr "Keine Namen gefunden, kann nichts beschreiben."

#: builtin/describe.c:489
msgid "--dirty is incompatible with committishes"
msgid "--dirty is incompatible with commit-ishes"
msgstr "Die Option --dirty kann nicht mit Commits verwendet werden."

#: builtin/diff.c:79
Expand Down
4 changes: 2 additions & 2 deletions po/fr.po
Original file line number Diff line number Diff line change
Expand Up @@ -4222,7 +4222,7 @@ msgid "print sizes in human readable format"
msgstr ""

#: builtin/describe.c:15
msgid "git describe [options] <committish>*"
msgid "git describe [options] <commit-ish>*"
msgstr ""

#: builtin/describe.c:16
Expand Down Expand Up @@ -4348,7 +4348,7 @@ msgid "No names found, cannot describe anything."
msgstr ""

#: builtin/describe.c:481
msgid "--dirty is incompatible with committishes"
msgid "--dirty is incompatible with commit-ishes"
msgstr ""

#: builtin/diff.c:79
Expand Down
4 changes: 2 additions & 2 deletions po/git.pot
Original file line number Diff line number Diff line change
Expand Up @@ -4335,7 +4335,7 @@ msgid "print sizes in human readable format"
msgstr ""

#: builtin/describe.c:16
msgid "git describe [options] <committish>*"
msgid "git describe [options] <commit-ish>*"
msgstr ""

#: builtin/describe.c:17
Expand Down Expand Up @@ -4465,7 +4465,7 @@ msgid "No names found, cannot describe anything."
msgstr ""

#: builtin/describe.c:489
msgid "--dirty is incompatible with committishes"
msgid "--dirty is incompatible with commit-ishes"
msgstr ""

#: builtin/diff.c:79
Expand Down
2 changes: 1 addition & 1 deletion po/it.po
Original file line number Diff line number Diff line change
Expand Up @@ -2476,7 +2476,7 @@ msgid "No names found, cannot describe anything."
msgstr ""

#: builtin/describe.c:482
msgid "--dirty is incompatible with committishes"
msgid "--dirty is incompatible with commit-ishes"
msgstr ""

#: builtin/diff.c:77
Expand Down
2 changes: 1 addition & 1 deletion po/nl.po
Original file line number Diff line number Diff line change
Expand Up @@ -1669,7 +1669,7 @@ msgid "No names found, cannot describe anything."
msgstr ""

#: builtin/describe.c:482
msgid "--dirty is incompatible with committishes"
msgid "--dirty is incompatible with commit-ishes"
msgstr ""

#: builtin/diff.c:77
Expand Down
2 changes: 1 addition & 1 deletion po/pt_PT.po
Original file line number Diff line number Diff line change
Expand Up @@ -2312,7 +2312,7 @@ msgid "No names found, cannot describe anything."
msgstr "Nenhum nome encontrado, não descreve nada."

#: builtin/describe.c:482
msgid "--dirty is incompatible with committishes"
msgid "--dirty is incompatible with commit-ishes"
msgstr ""

#: builtin/diff.c:77
Expand Down
6 changes: 3 additions & 3 deletions po/sv.po
Original file line number Diff line number Diff line change
Expand Up @@ -4560,7 +4560,7 @@ msgid "print sizes in human readable format"
msgstr "skriv storlekar i människoläsbart format"

#: builtin/describe.c:16
msgid "git describe [options] <committish>*"
msgid "git describe [options] <commit-ish>*"
msgstr "git describe [flaggor] <incheckning-igt>*"

#: builtin/describe.c:17
Expand Down Expand Up @@ -4696,8 +4696,8 @@ msgid "No names found, cannot describe anything."
msgstr "Inga namn hittades, kan inte beskriva något."

#: builtin/describe.c:489
msgid "--dirty is incompatible with committishes"
msgstr "--dirty är inkompatibelt med \"committish\"-värden"
msgid "--dirty is incompatible with commit-ishes"
msgstr "--dirty är inkompatibelt med \"commit-ish\"-värden"

#: builtin/diff.c:79
#, c-format
Expand Down
Loading

0 comments on commit a8a5406

Please sign in to comment.