From a8a5406ab32fccabf8ed08001d50b5373e18ff1a Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Wed, 4 Sep 2013 15:04:31 -0400 Subject: 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 Signed-off-by: Junio C Hamano diff --git a/Documentation/config.txt b/Documentation/config.txt index ec57a15..1ccec22 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -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 diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index 9439cd6..d20ca40 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -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=] ... +'git describe' [--all] [--tags] [--contains] [--abbrev=] ... 'git describe' [--all] [--tags] [--contains] [--abbrev=] --dirty[=] DESCRIPTION @@ -26,8 +26,8 @@ see the -a and -s options to linkgit:git-tag[1]. OPTIONS ------- -...:: - Committish object names to describe. +...:: + Commit-ish object names to describe. --dirty[=]:: Describe the working tree. @@ -57,7 +57,7 @@ OPTIONS --candidates=:: 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 candidates. Increasing above 10 will take slightly longer but may produce a more accurate result. An of 0 will cause only exact matches to be output. @@ -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 @@ -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. diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index bf1a02a..bba3ec9 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -380,8 +380,8 @@ change to the project. ('author' (SP )? SP LT GT SP LF)? 'committer' (SP )? SP LT GT SP LF data - ('from' SP LF)? - ('merge' SP LF)? + ('from' SP LF)? + ('merge' SP LF)? (filemodify | filedelete | filecopy | filerename | filedeleteall | notemodify)* LF? .... @@ -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 ``. +quoting or escaping syntax is supported within ``. -Here `` is any of the following: +Here `` 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 @@ -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 `` is any of the commit specification expressions +Here `` is any of the commit specification expressions also accepted by `from` (see above). `filemodify` @@ -677,8 +677,8 @@ paths for a commit are encouraged to do so. `notemodify` ^^^^^^^^^^^^ Included in a `commit` `` command to add a new note -annotating a `` or change this annotation contents. -Internally it is similar to filemodify 100644 on `` +annotating a `` or change this annotation contents. +Internally it is similar to filemodify 100644 on `` path (maybe split into subdirectories). It's not advised to use any other commands to write to the `` tree except `filedeleteall` to delete all existing notes in this tree. @@ -691,7 +691,7 @@ External data format:: commit that is to be annotated. + .... - 'N' SP SP LF + 'N' SP SP LF .... + Here `` can be either a mark reference (`:`) @@ -704,13 +704,13 @@ Inline data format:: command. + .... - 'N' SP 'inline' SP LF + 'N' SP 'inline' SP LF data .... + See below for a detailed description of the `data` command. -In both formats `` is any of the commit specification +In both formats `` is any of the commit specification expressions also accepted by `from` (see above). `mark` @@ -741,7 +741,7 @@ lightweight (non-annotated) tags see the `reset` command below. .... 'tag' SP LF - 'from' SP LF + 'from' SP LF 'tagger' (SP )? SP LT GT SP LF data .... @@ -786,11 +786,11 @@ branch from an existing commit without creating a new commit. .... 'reset' SP LF - ('from' SP LF)? + ('from' SP LF)? LF? .... -For a detailed description of `` and `` see above +For a detailed description of `` and `` see above under `commit` and `from`. The `LF` after the command is optional (it used to be required). diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt index 15b00e0..ca28fb8 100644 --- a/Documentation/git-name-rev.txt +++ b/Documentation/git-name-rev.txt @@ -10,7 +10,7 @@ SYNOPSIS -------- [verse] 'git name-rev' [--tags] [--refs=] - ( --all | --stdin | ... ) + ( --all | --stdin | ... ) DESCRIPTION ----------- diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index f7dfe48..a5c6f7d 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -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=:: diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index 9ac5088..7d54b77 100644 --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt @@ -106,7 +106,7 @@ couple of magic command line options: + --------------------------------------------- $ git describe -h -usage: git describe [options] * +usage: git describe [options] * or: git describe [options] --dirty --contains find the tag that comes after the commit diff --git a/Documentation/howto/revert-branch-rebase.txt b/Documentation/howto/revert-branch-rebase.txt index 0d5419e..85f69db 100644 --- a/Documentation/howto/revert-branch-rebase.txt +++ b/Documentation/howto/revert-branch-rebase.txt @@ -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 ++++---- diff --git a/builtin/describe.c b/builtin/describe.c index 7d73722..121a535 100644 --- a/builtin/describe.c +++ b/builtin/describe.c @@ -13,7 +13,7 @@ #define MAX_TAGS (FLAG_BITS - 1) static const char * const describe_usage[] = { - N_("git describe [options] *"), + N_("git describe [options] *"), N_("git describe [options] --dirty"), NULL }; @@ -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); diff --git a/builtin/merge.c b/builtin/merge.c index 34a6166..9a2c58a 100644 --- a/builtin/merge.c +++ b/builtin/merge.c @@ -1193,7 +1193,7 @@ int cmd_merge(int argc, const char **argv, const char *prefix) * This could be traditional "merge HEAD ..." 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. */ diff --git a/contrib/examples/git-merge.sh b/contrib/examples/git-merge.sh index 7b922c3..a5e42a9 100755 --- a/contrib/examples/git-merge.sh +++ b/contrib/examples/git-merge.sh @@ -263,7 +263,7 @@ fi # This could be traditional "merge HEAD ..." 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. diff --git a/fast-import.c b/fast-import.c index 019be11..f5babae 100644 --- a/fast-import.c +++ b/fast-import.c @@ -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; @@ -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 @@ -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; @@ -2478,7 +2478,7 @@ static void note_change_n(struct branch *b, unsigned char *old_fanout) assert(*p == ' '); p++; /* skip space */ - /* */ + /* */ s = lookup_branch(p); if (s) { if (is_null_sha1(s->sha1)) diff --git a/po/da.po b/po/da.po index 20a88ea..898b18d 100644 --- a/po/da.po +++ b/po/da.po @@ -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 diff --git a/po/de.po b/po/de.po index 11dde11..da3b0f5 100644 --- a/po/de.po +++ b/po/de.po @@ -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] *" -msgstr "git describe [Optionen] *" +msgid "git describe [options] *" +msgstr "git describe [Optionen] *" #: builtin/describe.c:17 msgid "git describe [options] --dirty" @@ -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 diff --git a/po/fr.po b/po/fr.po index fa98cfe..1363976 100644 --- a/po/fr.po +++ b/po/fr.po @@ -4222,7 +4222,7 @@ msgid "print sizes in human readable format" msgstr "" #: builtin/describe.c:15 -msgid "git describe [options] *" +msgid "git describe [options] *" msgstr "" #: builtin/describe.c:16 @@ -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 diff --git a/po/git.pot b/po/git.pot index cf1e446..c91e197 100644 --- a/po/git.pot +++ b/po/git.pot @@ -4335,7 +4335,7 @@ msgid "print sizes in human readable format" msgstr "" #: builtin/describe.c:16 -msgid "git describe [options] *" +msgid "git describe [options] *" msgstr "" #: builtin/describe.c:17 @@ -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 diff --git a/po/it.po b/po/it.po index fe61f1a..9080219 100644 --- a/po/it.po +++ b/po/it.po @@ -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 diff --git a/po/nl.po b/po/nl.po index e1399e2..ad31c66 100644 --- a/po/nl.po +++ b/po/nl.po @@ -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 diff --git a/po/pt_PT.po b/po/pt_PT.po index 517ec29..689ad1b 100644 --- a/po/pt_PT.po +++ b/po/pt_PT.po @@ -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 diff --git a/po/sv.po b/po/sv.po index 12dfca9..dcf579b 100644 --- a/po/sv.po +++ b/po/sv.po @@ -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] *" +msgid "git describe [options] *" msgstr "git describe [flaggor] *" #: builtin/describe.c:17 @@ -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 diff --git a/po/vi.po b/po/vi.po index dd2d2a7..11b4912 100644 --- a/po/vi.po +++ b/po/vi.po @@ -4663,8 +4663,8 @@ msgid "print sizes in human readable format" msgstr "hiển thị kích cỡ theo định dạng dành cho người đọc" #: builtin/describe.c:16 -msgid "git describe [options] *" -msgstr "git describe [các-tùy-chọn] *" +msgid "git describe [options] *" +msgstr "git describe [các-tùy-chọn] *" #: builtin/describe.c:17 msgid "git describe [options] --dirty" @@ -4799,7 +4799,7 @@ msgid "No names found, cannot describe anything." msgstr "Không tìm thấy các tên, không thể mô tả gì cả." #: builtin/describe.c:489 -msgid "--dirty is incompatible with committishes" +msgid "--dirty is incompatible with commit-ishes" msgstr "--dirty là xung khắc với các tùy chọn dành cho chuyển giao (commit)" #: builtin/diff.c:79 diff --git a/po/zh_CN.po b/po/zh_CN.po index b7b46f1..1a042af 100644 --- a/po/zh_CN.po +++ b/po/zh_CN.po @@ -4562,7 +4562,7 @@ msgid "print sizes in human readable format" msgstr "以用户可读的格式显示大小" #: builtin/describe.c:16 -msgid "git describe [options] *" +msgid "git describe [options] *" msgstr "git describe [选项] <提交号>*" #: builtin/describe.c:17 @@ -4698,7 +4698,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 "--dirty 不能与提交同时使用" #: builtin/diff.c:79 diff --git a/sha1_name.c b/sha1_name.c index 65ad066..ad79d7b 100644 --- a/sha1_name.c +++ b/sha1_name.c @@ -1130,13 +1130,13 @@ int get_sha1(const char *name, unsigned char *sha1) } /* - * Many callers know that the user meant to name a committish by + * Many callers know that the user meant to name a commit-ish by * syntactical positions where the object name appears. Calling this * function allows the machinery to disambiguate shorter-than-unique - * abbreviated object names between committish and others. + * abbreviated object names between commit-ish and others. * * Note that this does NOT error out when the named object is not a - * committish. It is merely to give a hint to the disambiguation + * commit-ish. It is merely to give a hint to the disambiguation * machinery. */ int get_sha1_committish(const char *name, unsigned char *sha1) diff --git a/t/t9300-fast-import.sh b/t/t9300-fast-import.sh index ac6f3b6..a74b9cf 100755 --- a/t/t9300-fast-import.sh +++ b/t/t9300-fast-import.sh @@ -2815,14 +2815,14 @@ test_expect_success 'S: notemodify with garbage after sha1 dataref must fail' ' ' # -# notemodify, mark in committish +# notemodify, mark in commit-ish # -test_expect_success 'S: notemodify with garbarge after mark committish must fail' ' +test_expect_success 'S: notemodify with garbarge after mark commit-ish must fail' ' test_must_fail git fast-import --import-marks=marks <<-EOF 2>err && commit refs/heads/Snotes committer $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL> $GIT_COMMITTER_DATE data <