table of contents
other versions
- wheezy 1:1.7.10.4-1+wheezy3
- wheezy-backports 1:1.9.1-1~bpo70+2
- jessie 1:2.1.4-2.1+deb8u2
- jessie-backports 1:2.11.0-3~bpo8+1
- testing 1:2.11.0-3
- unstable 1:2.11.0-4
- experimental 1:2.13.1+next.20170610-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>] <committish>... 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.OPTIONS¶
<committish>...Committish 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 .git/refs/. 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 .git/refs/tags. 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 committish 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 pattern
(can be used to avoid leaking private tags made from the repository).
--always
Show uniquely abbreviated commit object as
fallback.
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 committish 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.GIT¶
Part of the git(1) suite03/19/2016 | Git 1.7.10.4 |