diff options
| author | Junio C Hamano <junio@hera.kernel.org> | 2008-07-02 03:06:38 +0000 |
|---|---|---|
| committer | Junio C Hamano <junio@hera.kernel.org> | 2008-07-02 03:06:38 +0000 |
| commit | fce7c7e1549d1a2a2b0faf5952378236eed4d468 (patch) | |
| tree | ffce2ae419b52786a0e567f4fddaadd89016f62c /git-describe.txt | |
| parent | bb8e996adf4293a0b624fe77e95e12ae8d1faed9 (diff) | |
| download | git-htmldocs-fce7c7e1549d1a2a2b0faf5952378236eed4d468.tar.gz | |
Autogenerated HTML docs for v1.5.6.1-156-ge903b
Diffstat (limited to 'git-describe.txt')
| -rw-r--r-- | git-describe.txt | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/git-describe.txt b/git-describe.txt index 9f6f48318..51a0cc044 100644 --- a/git-describe.txt +++ b/git-describe.txt @@ -8,7 +8,7 @@ git-describe - Show the most recent tag that is reachable from a commit SYNOPSIS -------- -'git-describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>... +'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>... DESCRIPTION ----------- @@ -78,7 +78,7 @@ EXAMPLES With something like git.git current tree, I get: - [torvalds@g5 git]$ git-describe parent + [torvalds@g5 git]$ git describe parent v1.0.4-14-g2414721 i.e. the current head of my "parent" branch is based on v1.0.4, @@ -92,9 +92,9 @@ of commits which would be displayed by "git log v1.0.4..parent". The hash suffix is "-g" + 7-char abbreviation for the tip commit of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`). -Doing a "git-describe" on a tag-name will just show the tag name: +Doing a `git-describe` on a tag-name will just show the tag name: - [torvalds@g5 git]$ git-describe v1.0.4 + [torvalds@g5 git]$ git describe v1.0.4 v1.0.4 With --all, the command can use branch heads as references, so @@ -115,13 +115,13 @@ closest tagname without any suffix: SEARCH STRATEGY --------------- -For each committish supplied "git describe" will first look for +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. -If an exact match was not found "git describe" will walk back +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 committish's SHA1. @@ -129,7 +129,7 @@ abbreviation of the input committish's SHA1. If multiple tags were found during the walk then the tag which has the fewest commits different from the input committish 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" +the number of commits which would be shown by `git log tag..input` will be the smallest number of commits possible. |