diff options
author | Junio C Hamano <gitster@pobox.com> | 2017-12-28 15:20:52 -0800 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2017-12-28 15:20:52 -0800 |
commit | 68e72b77e38cd977e75ab3e6e439a98a1d80e5d8 (patch) | |
tree | cd4002833c27711c19ca04f5baae1177179dcc94 /git-describe.html | |
parent | 0f1291dcb49cd80bdb333eecb5f978a6a5ac3818 (diff) | |
download | git-htmldocs-68e72b77e38cd977e75ab3e6e439a98a1d80e5d8.tar.gz |
Autogenerated HTML docs for v2.16.0-rc0
Diffstat (limited to 'git-describe.html')
-rw-r--r-- | git-describe.html | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/git-describe.html b/git-describe.html index 6ed2fe6af..d1476c342 100644 --- a/git-describe.html +++ b/git-describe.html @@ -739,7 +739,7 @@ git-describe(1) Manual Page <h2>NAME</h2>
<div class="sectionbody">
<p>git-describe -
- Describe a commit using the most recent tag reachable from it
+ Give an object a human readable name based on an available ref
</p>
</div>
</div>
@@ -749,7 +749,8 @@ git-describe(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>git describe</em> [--all] [--tags] [--contains] [--abbrev=<n>] [<commit-ish>…]
-<em>git describe</em> [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]</pre>
+<em>git describe</em> [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]
+<em>git describe</em> <blob></pre>
<div class="attribution">
</div></div>
</div>
@@ -765,6 +766,11 @@ abbreviated object name of the most recent commit.</p></div> <div class="paragraph"><p>By default (without --all or --tags) <code>git describe</code> only shows
annotated tags. For more information about creating annotated tags
see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div>
+<div class="paragraph"><p>If the given object refers to a blob, it will be described
+as <code><commit-ish>:<path></code>, such that the blob can be found
+at <code><path></code> in the <code><commit-ish></code>, which itself describes the
+first commit in which this blob occurs in a reverse revision walk
+from HEAD.</p></div>
</div>
</div>
<div class="sect1">
@@ -1010,6 +1016,15 @@ will be the smallest number of commits possible.</p></div> </div>
</div>
<div class="sect1">
+<h2 id="_bugs">BUGS</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Tree objects as well as tag objects not pointing at commits, cannot be described.
+When describing blobs, the lightweight tags pointing at blobs are ignored,
+but the blob is still described as <committ-ish>:<path> despite the lightweight
+tag being favorable.</p></div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
@@ -1019,7 +1034,7 @@ will be the smallest number of commits possible.</p></div> <div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-09-29 13:22:11 JST
+Last updated 2017-12-28 15:18:28 PST
</div>
</div>
</body>
|