Autogenerated HTML docs for 58e3fb40f7ca1c28f9105c15166884f80bb22e55
authorJunio C Hamano <junio@hera.kernel.org>
Wed, 28 Dec 2005 02:33:00 +0000 (18:33 -0800)
committerJunio C Hamano <junio@hera.kernel.org>
Wed, 28 Dec 2005 02:33:00 +0000 (18:33 -0800)
git-describe.html [new file with mode: 0644]
git-describe.txt [new file with mode: 0644]
git.html
git.txt

diff --git a/git-describe.html b/git-describe.html
new file mode 100644 (file)
index 0000000..3335d4c
--- /dev/null
@@ -0,0 +1,374 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
+<head>\r
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
+<meta name="generator" content="AsciiDoc 7.0.1" />\r
+<style type="text/css">\r
+/* Debug borders */\r
+p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
+/*\r
+  border: 1px solid red;\r
+*/\r
+}\r
+\r
+body {\r
+  margin: 1em 5% 1em 5%;\r
+}\r
+\r
+a { color: blue; }\r
+a:visited { color: fuchsia; }\r
+\r
+em {\r
+  font-style: italic;\r
+}\r
+\r
+strong {\r
+  font-weight: bold;\r
+}\r
+\r
+tt {\r
+  color: navy;\r
+}\r
+\r
+h1, h2, h3, h4, h5, h6 {\r
+  color: #527bbd;\r
+  font-family: sans-serif;\r
+  margin-top: 1.2em;\r
+  margin-bottom: 0.5em;\r
+  line-height: 1.3;\r
+}\r
+\r
+h1 {\r
+  border-bottom: 2px solid silver;\r
+}\r
+h2 {\r
+  border-bottom: 2px solid silver;\r
+  padding-top: 0.5em;\r
+}\r
+\r
+div.sectionbody {\r
+  font-family: serif;\r
+  margin-left: 0;\r
+}\r
+\r
+hr {\r
+  border: 1px solid silver;\r
+}\r
+\r
+p {\r
+  margin-top: 0.5em;\r
+  margin-bottom: 0.5em;\r
+}\r
+\r
+pre {\r
+  padding: 0;\r
+  margin: 0;\r
+}\r
+\r
+span#author {\r
+  color: #527bbd;\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  font-size: 1.2em;\r
+}\r
+span#email {\r
+}\r
+span#revision {\r
+  font-family: sans-serif;\r
+}\r
+\r
+div#footer {\r
+  font-family: sans-serif;\r
+  font-size: small;\r
+  border-top: 2px solid silver;\r
+  padding-top: 0.5em;\r
+  margin-top: 4.0em;\r
+}\r
+div#footer-text {\r
+  float: left;\r
+  padding-bottom: 0.5em;\r
+}\r
+div#footer-badges {\r
+  float: right;\r
+  padding-bottom: 0.5em;\r
+}\r
+\r
+div#preamble,\r
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
+div.admonitionblock {\r
+  margin-right: 10%;\r
+  margin-top: 1.5em;\r
+  margin-bottom: 1.5em;\r
+}\r
+div.admonitionblock {\r
+  margin-top: 2.5em;\r
+  margin-bottom: 2.5em;\r
+}\r
+\r
+div.content { /* Block element content. */\r
+  padding: 0;\r
+}\r
+\r
+/* Block element titles. */\r
+div.title, caption.title {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  text-align: left;\r
+  margin-top: 1.0em;\r
+  margin-bottom: 0.5em;\r
+}\r
+div.title + * {\r
+  margin-top: 0;\r
+}\r
+\r
+td div.title:first-child {\r
+  margin-top: 0.0em;\r
+}\r
+div.content div.title:first-child {\r
+  margin-top: 0.0em;\r
+}\r
+div.content + div.title {\r
+  margin-top: 0.0em;\r
+}\r
+\r
+div.sidebarblock > div.content {\r
+  background: #ffffee;\r
+  border: 1px solid silver;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.listingblock > div.content {\r
+  border: 1px solid silver;\r
+  background: #f4f4f4;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.quoteblock > div.content {\r
+  padding-left: 2.0em;\r
+}\r
+div.quoteblock .attribution {\r
+  text-align: right;\r
+}\r
+\r
+div.admonitionblock .icon {\r
+  vertical-align: top;\r
+  font-size: 1.1em;\r
+  font-weight: bold;\r
+  text-decoration: underline;\r
+  color: #527bbd;\r
+  padding-right: 0.5em;\r
+}\r
+div.admonitionblock td.content {\r
+  padding-left: 0.5em;\r
+  border-left: 2px solid silver;\r
+}\r
+\r
+div.exampleblock > div.content {\r
+  border-left: 2px solid silver;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.verseblock div.content {\r
+  white-space: pre;\r
+}\r
+\r
+div.imageblock div.content { padding-left: 0; }\r
+div.imageblock img { border: 1px solid silver; }\r
+span.image img { border-style: none; }\r
+\r
+dl {\r
+  margin-top: 0.8em;\r
+  margin-bottom: 0.8em;\r
+}\r
+dt {\r
+  margin-top: 0.5em;\r
+  margin-bottom: 0;\r
+  font-style: italic;\r
+}\r
+dd > *:first-child {\r
+  margin-top: 0;\r
+}\r
+\r
+ul, ol {\r
+    list-style-position: outside;\r
+}\r
+ol.olist2 {\r
+  list-style-type: lower-alpha;\r
+}\r
+\r
+div.tableblock > table {\r
+  border-color: #527bbd;\r
+  border-width: 3px;\r
+}\r
+thead {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+}\r
+tfoot {\r
+  font-weight: bold;\r
+}\r
+\r
+div.hlist {\r
+  margin-top: 0.8em;\r
+  margin-bottom: 0.8em;\r
+}\r
+td.hlist1 {\r
+  vertical-align: top;\r
+  font-style: italic;\r
+  padding-right: 0.8em;\r
+}\r
+td.hlist2 {\r
+  vertical-align: top;\r
+}\r
+\r
+@media print {\r
+  div#footer-badges { display: none; }\r
+}\r
+include::./stylesheets/xhtml11-manpage.css[]\r
+/* Workarounds for IE6's broken and incomplete CSS2. */\r
+\r
+div.sidebar-content {\r
+  background: #ffffee;\r
+  border: 1px solid silver;\r
+  padding: 0.5em;\r
+}\r
+div.sidebar-title, div.image-title {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  margin-top: 0.0em;\r
+  margin-bottom: 0.5em;\r
+}\r
+\r
+div.listingblock div.content {\r
+  border: 1px solid silver;\r
+  background: #f4f4f4;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.quoteblock-content {\r
+  padding-left: 2.0em;\r
+}\r
+\r
+div.exampleblock-content {\r
+  border-left: 2px solid silver;\r
+  padding-left: 0.5em;\r
+}\r
+</style>\r
+<title>git-describe(1)</title>\r
+</head>\r
+<body>\r
+<div id="header">\r
+<h1>\r
+git-describe(1) Manual Page\r
+</h1>\r
+<h2>NAME</h2>\r
+<div class="sectionbody">\r
+<p>git-describe -\r
+   Show the most recent tag that is reachable from a commit.\r
+</p>\r
+</div>\r
+</div>\r
+<h2>SYNOPSIS</h2>\r
+<div class="sectionbody">\r
+<p><em>git-describe</em> [--all] [--tags] [--abbrev=&lt;n&gt;] &lt;committish&gt;&#8230;</p>\r
+</div>\r
+<h2>DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<p>The command finds the most recent tag that is reachable from a\r
+commit, and if the commit itself is pointed at by the tag, shows\r
+the tag.  Otherwise, it suffixes the tag name with abbreviated\r
+object name of the commit.</p>\r
+</div>\r
+<h2>OPTIONS</h2>\r
+<div class="sectionbody">\r
+<dl>\r
+<dt>\r
+&lt;committish&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        The object name of the comittish.\r
+</p>\r
+</dd>\r
+<dt>\r
+--all\r
+</dt>\r
+<dd>\r
+<p>\r
+        Instead of using only the annotated tags, use any ref\r
+        found in <tt>.git/refs/</tt>.\r
+</p>\r
+</dd>\r
+<dt>\r
+--tags\r
+</dt>\r
+<dd>\r
+<p>\r
+        Instead of using only the annotated tags, use any tag\r
+        found in <tt>.git/refs/tags</tt>.\r
+</p>\r
+</dd>\r
+<dt>\r
+--abbrev=&lt;n&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Instead of using the default 8 hexadecimal digits as the\r
+        abbreviated object name, use &lt;n&gt; digits.\r
+</p>\r
+</dd>\r
+</dl>\r
+</div>\r
+<h2>EXAMPLES</h2>\r
+<div class="sectionbody">\r
+<p>With something like git.git current tree, I get:</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>[torvalds@g5 git]$ git-describe parent\r
+v1.0.4-g2414721b</tt></pre>\r
+</div></div>\r
+<p>i.e. the current head of my "parent" branch is based on v1.0.4,\r
+but since it has a few commits on top of that, it has added the\r
+git hash of the thing to the end: "-g" + 8-char shorthand for\r
+the commit <tt>2414721b194453f058079d897d13c4e377f92dc6</tt>.</p>\r
+<p>Doing a "git-describe" on a tag-name will just show the tag name:</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>[torvalds@g5 git]$ git-describe v1.0.4\r
+v1.0.4</tt></pre>\r
+</div></div>\r
+<p>With --all, the command can use branch heads as references, so\r
+the output shows the reference path as well:</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>[torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2\r
+tags/v1.0.0-g975b</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>[torvalds@g5 git]$ git describe --all HEAD^\r
+heads/lt/describe-g975b</tt></pre>\r
+</div></div>\r
+</div>\r
+<h2>Author</h2>\r
+<div class="sectionbody">\r
+<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;, but somewhat\r
+butchered by Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
+</div>\r
+<h2>Documentation</h2>\r
+<div class="sectionbody">\r
+<p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
+</div>\r
+<h2>GIT</h2>\r
+<div class="sectionbody">\r
+<p>Part of the <a href="git.html">git(7)</a> suite</p>\r
+</div>\r
+<div id="footer">\r
+<div id="footer-text">\r
+Last updated 27-Dec-2005 18:31:52 PDT\r
+</div>\r
+</div>\r
+</body>\r
+</html>\r
diff --git a/git-describe.txt b/git-describe.txt
new file mode 100644 (file)
index 0000000..0efe82a
--- /dev/null
@@ -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
+
index d8176ef..3ab3547 100644 (file)
--- a/git.html
+++ b/git.html
@@ -489,6 +489,14 @@ SCMs layered over git.</p>
 </p>\r
 </dd>\r
 <dt>\r
+<a href="git-describe.html">git-describe(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show the most recent tag that is reachable from a commit.\r
+</p>\r
+</dd>\r
+<dt>\r
 <a href="git-diff-index.html">git-diff-index(1)</a>\r
 </dt>\r
 <dd>\r
@@ -2014,7 +2022,7 @@ contributors on the git-list &lt;git@vger.kernel.org&gt;.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 27-Dec-2005 00:16:59 PDT\r
+Last updated 27-Dec-2005 18:31:54 PDT\r
 </div>\r
 </div>\r
 </body>\r
diff --git a/git.txt b/git.txt
index 5f068c2..90c5bfa 100644 (file)
--- 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.