summaryrefslogtreecommitdiffstats
path: root/git-describe.html
diff options
context:
space:
mode:
authorJunio C Hamano <junio@hera.kernel.org>2005-12-27 18:33:00 -0800
committerJunio C Hamano <junio@hera.kernel.org>2005-12-27 18:33:00 -0800
commitab0087622a692f2980ae9f169beb4459f36bf230 (patch)
tree0f6624da2f7bd0bf8981d9f87023e8aecc21093a /git-describe.html
parent1a4e841b439ba014b365999c3a6b9e2be3740bd8 (diff)
downloadgit-htmldocs-ab0087622a692f2980ae9f169beb4459f36bf230.tar.gz
Autogenerated HTML docs for 58e3fb40f7ca1c28f9105c15166884f80bb22e55
Diffstat (limited to 'git-describe.html')
-rw-r--r--git-describe.html374
1 files changed, 374 insertions, 0 deletions
diff --git a/git-describe.html b/git-describe.html
new file mode 100644
index 000000000..3335d4c93
--- /dev/null
+++ b/git-describe.html
@@ -0,0 +1,374 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 7.0.1" />
+<style type="text/css">
+/* Debug borders */
+p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
+/*
+ border: 1px solid red;
+*/
+}
+
+body {
+ margin: 1em 5% 1em 5%;
+}
+
+a { color: blue; }
+a:visited { color: fuchsia; }
+
+em {
+ font-style: italic;
+}
+
+strong {
+ font-weight: bold;
+}
+
+tt {
+ color: navy;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ color: #527bbd;
+ font-family: sans-serif;
+ margin-top: 1.2em;
+ margin-bottom: 0.5em;
+ line-height: 1.3;
+}
+
+h1 {
+ border-bottom: 2px solid silver;
+}
+h2 {
+ border-bottom: 2px solid silver;
+ padding-top: 0.5em;
+}
+
+div.sectionbody {
+ font-family: serif;
+ margin-left: 0;
+}
+
+hr {
+ border: 1px solid silver;
+}
+
+p {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+pre {
+ padding: 0;
+ margin: 0;
+}
+
+span#author {
+ color: #527bbd;
+ font-family: sans-serif;
+ font-weight: bold;
+ font-size: 1.2em;
+}
+span#email {
+}
+span#revision {
+ font-family: sans-serif;
+}
+
+div#footer {
+ font-family: sans-serif;
+ font-size: small;
+ border-top: 2px solid silver;
+ padding-top: 0.5em;
+ margin-top: 4.0em;
+}
+div#footer-text {
+ float: left;
+ padding-bottom: 0.5em;
+}
+div#footer-badges {
+ float: right;
+ padding-bottom: 0.5em;
+}
+
+div#preamble,
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
+div.admonitionblock {
+ margin-right: 10%;
+ margin-top: 1.5em;
+ margin-bottom: 1.5em;
+}
+div.admonitionblock {
+ margin-top: 2.5em;
+ margin-bottom: 2.5em;
+}
+
+div.content { /* Block element content. */
+ padding: 0;
+}
+
+/* Block element titles. */
+div.title, caption.title {
+ font-family: sans-serif;
+ font-weight: bold;
+ text-align: left;
+ margin-top: 1.0em;
+ margin-bottom: 0.5em;
+}
+div.title + * {
+ margin-top: 0;
+}
+
+td div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content + div.title {
+ margin-top: 0.0em;
+}
+
+div.sidebarblock > div.content {
+ background: #ffffee;
+ border: 1px solid silver;
+ padding: 0.5em;
+}
+
+div.listingblock > div.content {
+ border: 1px solid silver;
+ background: #f4f4f4;
+ padding: 0.5em;
+}
+
+div.quoteblock > div.content {
+ padding-left: 2.0em;
+}
+div.quoteblock .attribution {
+ text-align: right;
+}
+
+div.admonitionblock .icon {
+ vertical-align: top;
+ font-size: 1.1em;
+ font-weight: bold;
+ text-decoration: underline;
+ color: #527bbd;
+ padding-right: 0.5em;
+}
+div.admonitionblock td.content {
+ padding-left: 0.5em;
+ border-left: 2px solid silver;
+}
+
+div.exampleblock > div.content {
+ border-left: 2px solid silver;
+ padding: 0.5em;
+}
+
+div.verseblock div.content {
+ white-space: pre;
+}
+
+div.imageblock div.content { padding-left: 0; }
+div.imageblock img { border: 1px solid silver; }
+span.image img { border-style: none; }
+
+dl {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+dt {
+ margin-top: 0.5em;
+ margin-bottom: 0;
+ font-style: italic;
+}
+dd > *:first-child {
+ margin-top: 0;
+}
+
+ul, ol {
+ list-style-position: outside;
+}
+ol.olist2 {
+ list-style-type: lower-alpha;
+}
+
+div.tableblock > table {
+ border-color: #527bbd;
+ border-width: 3px;
+}
+thead {
+ font-family: sans-serif;
+ font-weight: bold;
+}
+tfoot {
+ font-weight: bold;
+}
+
+div.hlist {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+td.hlist1 {
+ vertical-align: top;
+ font-style: italic;
+ padding-right: 0.8em;
+}
+td.hlist2 {
+ vertical-align: top;
+}
+
+@media print {
+ div#footer-badges { display: none; }
+}
+include::./stylesheets/xhtml11-manpage.css[]
+/* Workarounds for IE6's broken and incomplete CSS2. */
+
+div.sidebar-content {
+ background: #ffffee;
+ border: 1px solid silver;
+ padding: 0.5em;
+}
+div.sidebar-title, div.image-title {
+ font-family: sans-serif;
+ font-weight: bold;
+ margin-top: 0.0em;
+ margin-bottom: 0.5em;
+}
+
+div.listingblock div.content {
+ border: 1px solid silver;
+ background: #f4f4f4;
+ padding: 0.5em;
+}
+
+div.quoteblock-content {
+ padding-left: 2.0em;
+}
+
+div.exampleblock-content {
+ border-left: 2px solid silver;
+ padding-left: 0.5em;
+}
+</style>
+<title>git-describe(1)</title>
+</head>
+<body>
+<div id="header">
+<h1>
+git-describe(1) Manual Page
+</h1>
+<h2>NAME</h2>
+<div class="sectionbody">
+<p>git-describe -
+ Show the most recent tag that is reachable from a commit.
+</p>
+</div>
+</div>
+<h2>SYNOPSIS</h2>
+<div class="sectionbody">
+<p><em>git-describe</em> [--all] [--tags] [--abbrev=&lt;n&gt;] &lt;committish&gt;&#8230;</p>
+</div>
+<h2>DESCRIPTION</h2>
+<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>
+</div>
+<h2>OPTIONS</h2>
+<div class="sectionbody">
+<dl>
+<dt>
+&lt;committish&gt;
+</dt>
+<dd>
+<p>
+ The object name of the comittish.
+</p>
+</dd>
+<dt>
+--all
+</dt>
+<dd>
+<p>
+ Instead of using only the annotated tags, use any ref
+ found in <tt>.git/refs/</tt>.
+</p>
+</dd>
+<dt>
+--tags
+</dt>
+<dd>
+<p>
+ Instead of using only the annotated tags, use any tag
+ found in <tt>.git/refs/tags</tt>.
+</p>
+</dd>
+<dt>
+--abbrev=&lt;n&gt;
+</dt>
+<dd>
+<p>
+ Instead of using the default 8 hexadecimal digits as the
+ abbreviated object name, use &lt;n&gt; digits.
+</p>
+</dd>
+</dl>
+</div>
+<h2>EXAMPLES</h2>
+<div class="sectionbody">
+<p>With something like git.git current tree, I get:</p>
+<div class="literalblock">
+<div class="content">
+<pre><tt>[torvalds@g5 git]$ git-describe parent
+v1.0.4-g2414721b</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>
+<p>Doing a "git-describe" on a tag-name will just show the tag name:</p>
+<div class="literalblock">
+<div class="content">
+<pre><tt>[torvalds@g5 git]$ git-describe v1.0.4
+v1.0.4</tt></pre>
+</div></div>
+<p>With --all, the command can use branch heads as references, so
+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>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><tt>[torvalds@g5 git]$ git describe --all HEAD^
+heads/lt/describe-g975b</tt></pre>
+</div></div>
+</div>
+<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>
+</div>
+<h2>Documentation</h2>
+<div class="sectionbody">
+<p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
+</div>
+<h2>GIT</h2>
+<div class="sectionbody">
+<p>Part of the <a href="git.html">git(7)</a> suite</p>
+</div>
+<div id="footer">
+<div id="footer-text">
+Last updated 27-Dec-2005 18:31:52 PDT
+</div>
+</div>
+</body>
+</html>