git-describe(1)

From ab0087622a692f2980ae9f169beb4459f36bf230 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Tue, 27 Dec 2005 18:33:00 -0800 Subject: [PATCH] Autogenerated HTML docs for 58e3fb40f7ca1c28f9105c15166884f80bb22e55 --- git-describe.html | 374 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ git-describe.txt | 79 ++++++++++++ git.html | 10 +- git.txt | 3 + 4 files changed, 465 insertions(+), 1 deletion(-) create mode 100644 git-describe.html create mode 100644 git-describe.txt diff --git a/git-describe.html b/git-describe.html new file mode 100644 index 00000000..3335d4c9 --- /dev/null +++ b/git-describe.html @@ -0,0 +1,374 @@ + + + + + + +git-describe(1) + + + +

SYNOPSIS

git-describe [--all] [--tags] [--abbrev=<n>] <committish>…

DESCRIPTION

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.

OPTIONS

+<committish> +: +
+ The object name of the comittish. +
+
+--all +: +
+ Instead of using only the annotated tags, use any ref + found in .git/refs/. +
+
+--tags +: +
+ Instead of using only the annotated tags, use any tag + found in .git/refs/tags. +
+
+--abbrev=<n> +: +
+ Instead of using the default 8 hexadecimal digits as the + abbreviated object name, use <n> digits. +
+

EXAMPLES

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

Author

Written by Linus Torvalds <torvalds@osdl.org>, but somewhat +butchered by Junio C Hamano <junkio@cox.net>

Documentation

Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.

GIT

Part of the git(7) suite

+ + + diff --git a/git-describe.txt b/git-describe.txt new file mode 100644 index 00000000..0efe82ae --- /dev/null +++ b/git-describe.txt @@ -0,0 +1,79 @@ +git-describe(1) +=============== + +NAME +---- +git-describe - Show the most recent tag that is reachable from a commit. + + +SYNOPSIS +-------- +'git-describe' [--all] [--tags] [--abbrev=] ... + +DESCRIPTION +----------- +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. + + +OPTIONS +------- +:: + The object name of the comittish. + +--all:: + Instead of using only the annotated tags, use any ref + found in `.git/refs/`. + +--tags:: + Instead of using only the annotated tags, use any tag + found in `.git/refs/tags`. + +--abbrev=:: + Instead of using the default 8 hexadecimal digits as the + abbreviated object name, use digits. + + +EXAMPLES +-------- + +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 + + +Author +------ +Written by Linus Torvalds , but somewhat +butchered by Junio C Hamano + +Documentation +-------------- +Documentation by David Greaves, Junio C Hamano and the git-list . + +GIT +--- +Part of the gitlink:git[7] suite + diff --git a/git.html b/git.html index d8176efa..3ab35471 100644 --- a/git.html +++ b/git.html @@ -489,6 +489,14 @@ SCMs layered over git.

+git-describe(1) +

+ Show the most recent tag that is reachable from a commit. +

git-diff-index(1)

@@ -2014,7 +2022,7 @@ contributors on the git-list <git@vger.kernel.org>.

diff --git a/git.txt b/git.txt index 5f068c2a..90c5bfaf 100644 --- a/git.txt +++ b/git.txt @@ -139,6 +139,9 @@ Interrogation commands gitlink:git-cat-file[1]:: Provide content or type/size information for repository objects. +gitlink:git-describe[1]:: + Show the most recent tag that is reachable from a commit. + gitlink:git-diff-index[1]:: Compares content and mode of blobs between the index and repository. -- 2.11.0

+git-describe(1) Manual Page +