diff options
| author |  Junio C Hamano <junkio@cox.net> | 2005-12-27 16:10:56 -0800 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2005-12-27 17:57:28 -0800 |
| commit | c06818e20a88f58294de0a948a437c7c32c382fe (patch) | |
| tree | fa7caccdbc79336125ee9ab8e1d502c5acf5d271 | |
| parent | git-describe: still prefer annotated tag under --all and --tags (diff) | |
| download | tgif-c06818e20a88f58294de0a948a437c7c32c382fe.tar.xz | |
git-describe: documentation.
Signed-off-by: Junio C Hamano <junkio@cox.net>
| -rw-r--r-- | Documentation/git-describe.txt | 79 | ||||
| -rw-r--r-- | Documentation/git.txt | 3 |
2 files changed, 82 insertions, 0 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt new file mode 100644 index 0000000000..0efe82ae1e --- /dev/null +++ b/Documentation/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=<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 gitlink:git[7] suite + diff --git a/Documentation/git.txt b/Documentation/git.txt index 5f068c2a1a..90c5bfaf64 100644 --- a/Documentation/git.txt +++ b/Documentation/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. |