path: root/Documentation/git-describe.txt
diff options
authorJunio C Hamano <>2005-12-28 00:10:56 (GMT)
committerJunio C Hamano <>2005-12-28 01:57:28 (GMT)
commitc06818e20a88f58294de0a948a437c7c32c382fe (patch)
treefa7caccdbc79336125ee9ab8e1d502c5acf5d271 /Documentation/git-describe.txt
parent64deb858b0c71f485d186e91cd00cf8b6ec64087 (diff)
git-describe: documentation.
Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-describe.txt')
1 files changed, 79 insertions, 0 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
new file mode 100644
index 0000000..0efe82a
--- /dev/null
+++ b/Documentation/git-describe.txt
@@ -0,0 +1,79 @@
+git-describe - Show the most recent tag that is reachable from a commit.
+'git-describe' [--all] [--tags] [--abbrev=<n>] <committish>...
+The command finds the most recent tag that is reachable from a
+commit, and if the commit itself is pointed at by the tag, shows
+the tag. Otherwise, it suffixes the tag name with abbreviated
+object name of the commit.
+ The object name of the comittish.
+ Instead of using only the annotated tags, use any ref
+ found in `.git/refs/`.
+ Instead of using only the annotated tags, use any tag
+ found in `.git/refs/tags`.
+ Instead of using the default 8 hexadecimal digits as the
+ abbreviated object name, use <n> digits.
+With something like git.git current tree, I get:
+ [torvalds@g5 git]$ git-describe parent
+ v1.0.4-g2414721b
+i.e. the current head of my "parent" branch is based on v1.0.4,
+but since it has a few commits on top of that, it has added the
+git hash of the thing to the end: "-g" + 8-char shorthand for
+the commit `2414721b194453f058079d897d13c4e377f92dc6`.
+Doing a "git-describe" on a tag-name will just show the tag name:
+ [torvalds@g5 git]$ git-describe v1.0.4
+ v1.0.4
+With --all, the command can use branch heads as references, so
+the output shows the reference path as well:
+ [torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2
+ tags/v1.0.0-g975b
+ [torvalds@g5 git]$ git describe --all HEAD^
+ heads/lt/describe-g975b
+Written by Linus Torvalds <>, but somewhat
+butchered by Junio C Hamano <>
+Documentation by David Greaves, Junio C Hamano and the git-list <>.
+Part of the gitlink:git[7] suite