summaryrefslogtreecommitdiffstats
path: root/git-describe.html
diff options
context:
space:
mode:
authorJunio C Hamano <junio@hera.kernel.org>2007-01-28 10:29:21 +0000
committerJunio C Hamano <junio@hera.kernel.org>2007-01-28 10:29:21 +0000
commita890c4fca84a2a5c7835fe6432ede3e7c4e5426b (patch)
treead9b28547465ff5d9f18592e8c1288bcb6a70153 /git-describe.html
parent42b7867a76b70bb30e825bc111b7468bc3c43fa0 (diff)
downloadgit-htmldocs-a890c4fca84a2a5c7835fe6432ede3e7c4e5426b.tar.gz
Autogenerated HTML docs for v1.5.0-rc2-61-g1b60
Diffstat (limited to 'git-describe.html')
-rw-r--r--git-describe.html33
1 files changed, 23 insertions, 10 deletions
diff --git a/git-describe.html b/git-describe.html
index 536fbbbe6..3ea1ff508 100644
--- a/git-describe.html
+++ b/git-describe.html
@@ -278,8 +278,8 @@ git-describe(1) Manual Page
<div class="sectionbody">
<p>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.</p>
+the tag. Otherwise, it suffixes the tag name with the number of
+additional commits and the abbreviated object name of the commit.</p>
</div>
<h2>OPTIONS</h2>
<div class="sectionbody">
@@ -348,12 +348,17 @@ object name of the commit.</p>
<div class="literalblock">
<div class="content">
<pre><tt>[torvalds@g5 git]$ git-describe parent
-v1.0.4-g2414721b</tt></pre>
+v1.0.4-14-g2414721</tt></pre>
</div></div>
<p>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 <tt>2414721b194453f058079d897d13c4e377f92dc6</tt>.</p>
+but since it has a handful commits on top of that,
+describe has added the number of additional commits ("14") and
+an abbreviated object name for the commit itself ("2414721")
+at the end.</p>
+<p>The number of additional commits is the number
+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 <tt>2414721b194453f058079d897d13c4e377f92dc6</tt>).</p>
<p>Doing a "git-describe" on a tag-name will just show the tag name:</p>
<div class="literalblock">
<div class="content">
@@ -365,12 +370,19 @@ the output shows the reference path as well:</p>
<div class="literalblock">
<div class="content">
<pre><tt>[torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2
-tags/v1.0.0-g975b</tt></pre>
+tags/v1.0.0-21-g975b</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>[torvalds@g5 git]$ git describe --all HEAD^
-heads/lt/describe-g975b</tt></pre>
+heads/lt/describe-7-g975b</tt></pre>
+</div></div>
+<p>With --abbrev set to 0, the command can be used to find the
+closest tagname without any suffix:</p>
+<div class="literalblock">
+<div class="content">
+<pre><tt>[torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2
+tags/v1.0.0</tt></pre>
</div></div>
</div>
<h2>SEARCH STRATEGY</h2>
@@ -393,7 +405,8 @@ will be the smallest number of commits possible.</p>
<h2>Author</h2>
<div class="sectionbody">
<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;, but somewhat
-butchered by Junio C Hamano &lt;junkio@cox.net&gt;</p>
+butchered by Junio C Hamano &lt;junkio@cox.net&gt;. Later significantly
+updated by Shawn Pearce &lt;spearce@spearce.org&gt;.</p>
</div>
<h2>Documentation</h2>
<div class="sectionbody">
@@ -405,7 +418,7 @@ butchered by Junio C Hamano &lt;junkio@cox.net&gt;</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 15-Jan-2007 06:12:30 UTC
+Last updated 28-Jan-2007 10:29:05 UTC
</div>
</div>
</body>