table of contents
other versions
- jessie 1:2.1.4-2.1+deb8u6
- jessie-backports 1:2.11.0-3~bpo8+1
- stretch 1:2.11.0-3+deb9u4
- testing 1:2.20.1-2
- stretch-backports 1:2.20.1-1~bpo9+1
- unstable 1:2.20.1-2
- experimental 1:2.21.0+next.20190320-1
GIT-DESCRIBE(1) | Git Manual | GIT-DESCRIBE(1) |
NAME¶
git-describe - Show the most recent tag that is reachable from a commitSYNOPSIS¶
git describe [--all] [--tags] [--contains] [--abbrev=<n>] <commit-ish>... git describe [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]
DESCRIPTION¶
The command finds the most recent tag that is reachable from a commit. If the tag points to the commit, then only the tag is shown. Otherwise, it suffixes the tag name with the number of additional commits on top of the tagged object and the abbreviated object name of the most recent commit. By default (without --all or --tags) git describe only shows annotated tags. For more information about creating annotated tags see the -a and -s options to git-tag(1).OPTIONS¶
<commit-ish>...Commit-ish object names to describe.
--dirty[=<mark>]
Describe the working tree. It means describe HEAD and
appends <mark> (-dirty by default) if the working tree is dirty.
--all
Instead of using only the annotated tags, use any ref
found in refs/ namespace. This option enables matching any known branch,
remote-tracking branch, or lightweight tag.
--tags
Instead of using only the annotated tags, use any tag
found in refs/tags namespace. This option enables matching a lightweight
(non-annotated) tag.
--contains
Instead of finding the tag that predates the commit, find
the tag that comes after the commit, and thus contains it. Automatically
implies --tags.
--abbrev=<n>
Instead of using the default 7 hexadecimal digits as the
abbreviated object name, use <n> digits, or as many digits as needed to
form a unique object name. An <n> of 0 will suppress long format, only
showing the closest tag.
--candidates=<n>
Instead of considering only the 10 most recent tags as
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.
--exact-match
Only output exact matches (a tag directly references the
supplied commit). This is a synonym for --candidates=0.
--debug
Verbosely display information about the searching
strategy being employed to standard error. The tag name will still be printed
to standard out.
--long
Always output the long format (the tag, the number of
commits and the abbreviated commit name) even when it matches a tag. This is
useful when you want to see parts of the commit object name in
"describe" output, even when the commit in question happens to be a
tagged version. Instead of just emitting the tag name, it will describe such a
commit as v1.2-0-gdeadbee (0th commit since tag v1.2 that points at object
deadbee....).
--match <pattern>
Only consider tags matching the given glob(7) pattern,
excluding the "refs/tags/" prefix. This can be used to avoid leaking
private tags from the repository.
--always
Show uniquely abbreviated commit object as
fallback.
--first-parent
Follow only the first parent commit upon seeing a merge
commit. This is useful when you wish to not match tags on branches merged in
the history of the target commit.
EXAMPLES¶
With something like git.git current tree, I get:[torvalds@g5 git]$ git describe parent v1.0.4-14-g2414721
[torvalds@g5 git]$ git describe v1.0.4 v1.0.4
[torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2 tags/v1.0.0-21-g975b
[torvalds@g5 git]$ git describe --all --abbrev=4 HEAD^ heads/lt/describe-7-g975b
[torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2 tags/v1.0.0
SEARCH STRATEGY¶
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 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 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 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.GIT¶
Part of the git(1) suite05/28/2018 | Git 2.1.4 |