diff options
| author | Junio C Hamano <gitster@pobox.com> | 2013-09-17 14:34:00 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-09-17 14:34:00 -0700 |
| commit | e6f28d0b6c239f15760194c8b12afdaa1a7bdd34 (patch) | |
| tree | b782d1e78feb1a9f17131581d754b0e29abaa0b8 /git-describe.txt | |
| parent | 0e0e0d2656a57fd3628bb6dbdaf0096684ed24a9 (diff) | |
| download | git-htmldocs-e6f28d0b6c239f15760194c8b12afdaa1a7bdd34.tar.gz | |
Autogenerated HTML docs for v1.8.4-357-g8d83
Diffstat (limited to 'git-describe.txt')
| -rw-r--r-- | git-describe.txt | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/git-describe.txt b/git-describe.txt index 9439cd6d5..d20ca402a 100644 --- a/git-describe.txt +++ b/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=<n>] <committish>... +'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <commit-ish>... 'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>] DESCRIPTION @@ -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. @@ -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. @@ -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. |