diff options
| author | Junio C Hamano <junio@kernel.org> | 2010-11-25 03:16:07 +0000 |
|---|---|---|
| committer | Junio C Hamano <junio@kernel.org> | 2010-11-25 03:16:07 +0000 |
| commit | 97bcb48c6f2fa3ff8c49372fb6057ebd66b78537 (patch) | |
| tree | 24f01a439c32da8e521ee57f3a738e99f3f86e0d /git-describe.html | |
| parent | 982eb11dc5ca975628029adef95a96309ae25294 (diff) | |
| download | git-htmldocs-97bcb48c6f2fa3ff8c49372fb6057ebd66b78537.tar.gz | |
Autogenerated HTML docs for v1.7.3.2-343-g7d43d
Diffstat (limited to 'git-describe.html')
| -rw-r--r-- | git-describe.html | 226 |
1 files changed, 161 insertions, 65 deletions
diff --git a/git-describe.html b/git-describe.html index bae7a24fb..04e51e2cf 100644 --- a/git-describe.html +++ b/git-describe.html @@ -3,7 +3,8 @@ <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 8.2.5" />
+<meta name="generator" content="AsciiDoc 8.4.5" />
+<title>git-describe(1)</title>
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
@@ -26,10 +27,12 @@ a:visited { em {
font-style: italic;
+ color: navy;
}
strong {
font-weight: bold;
+ color: #083194;
}
tt {
@@ -71,6 +74,10 @@ p { margin-bottom: 0.5em;
}
+ul, ol, li > p {
+ margin-top: 0;
+}
+
pre {
padding: 0;
margin: 0;
@@ -84,7 +91,7 @@ span#author { }
span#email {
}
-span#revision {
+span#revnumber, span#revdate, span#revremark {
font-family: sans-serif;
}
@@ -104,11 +111,13 @@ div#footer-badges { padding-bottom: 0.5em;
}
-div#preamble,
+div#preamble {
+ margin-top: 1.5em;
+ margin-bottom: 1.5em;
+}
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;
}
@@ -123,6 +132,7 @@ div.content { /* Block element content. */ /* Block element titles. */
div.title, caption.title {
+ color: #527bbd;
font-family: sans-serif;
font-weight: bold;
text-align: left;
@@ -149,22 +159,33 @@ div.sidebarblock > div.content { padding: 0.5em;
}
-div.listingblock {
- margin-right: 0%;
-}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
-div.quoteblock > div.content {
+div.quoteblock {
padding-left: 2.0em;
+ margin-right: 10%;
}
-
-div.attribution {
+div.quoteblock > div.attribution {
+ padding-top: 0.5em;
text-align: right;
}
+
+div.verseblock {
+ padding-left: 2.0em;
+ margin-right: 10%;
+}
+div.verseblock > div.content {
+ white-space: pre;
+}
+div.verseblock > div.attribution {
+ padding-top: 0.75em;
+ text-align: left;
+}
+/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
@@ -187,13 +208,9 @@ div.exampleblock > div.content { 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; }
+a.image:visited { color: white; }
dl {
margin-top: 0.8em;
@@ -202,18 +219,38 @@ dl { dt {
margin-top: 0.5em;
margin-bottom: 0;
- font-style: italic;
+ font-style: normal;
+ color: navy;
}
dd > *:first-child {
- margin-top: 0;
+ margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
-div.olist2 ol {
+ol.arabic {
+ list-style-type: decimal;
+}
+ol.loweralpha {
list-style-type: lower-alpha;
}
+ol.upperalpha {
+ list-style-type: upper-alpha;
+}
+ol.lowerroman {
+ list-style-type: lower-roman;
+}
+ol.upperroman {
+ list-style-type: upper-roman;
+}
+
+div.compact ul, div.compact ol,
+div.compact p, div.compact p,
+div.compact div, div.compact div {
+ margin-top: 0.1em;
+ margin-bottom: 0.1em;
+}
div.tableblock > table {
border: 3px solid #527bbd;
@@ -225,22 +262,53 @@ thead { tfoot {
font-weight: bold;
}
+td > div.verse {
+ white-space: pre;
+}
+p.table {
+ margin-top: 0;
+}
+/* Because the table frame attribute is overriden by CSS in most browsers. */
+div.tableblock > table[frame="void"] {
+ border-style: none;
+}
+div.tableblock > table[frame="hsides"] {
+ border-left-style: none;
+ border-right-style: none;
+}
+div.tableblock > table[frame="vsides"] {
+ border-top-style: none;
+ border-bottom-style: none;
+}
+
-div.hlist {
+div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
-div.hlist td {
- padding-bottom: 5px;
+div.hdlist tr {
+ padding-bottom: 15px;
}
-td.hlist1 {
+dt.hdlist1.strong, td.hdlist1.strong {
+ font-weight: bold;
+}
+td.hdlist1 {
vertical-align: top;
- font-style: italic;
+ font-style: normal;
padding-right: 0.8em;
+ color: navy;
}
-td.hlist2 {
+td.hdlist2 {
vertical-align: top;
}
+div.hdlist.compact tr {
+ margin: 0;
+ padding-bottom: 0;
+}
+
+.comment {
+ background: yellow;
+}
@media print {
div#footer-badges { display: none; }
@@ -271,7 +339,24 @@ div.toclevel4 { margin-left: 6em;
font-size: 0.9em;
}
-include1::./stylesheets/xhtml11-manpage.css[]
+/* Overrides for manpage documents */
+h1 {
+ padding-top: 0.5em;
+ padding-bottom: 0.5em;
+ border-top: 2px solid silver;
+ border-bottom: 2px solid silver;
+}
+h2 {
+ border-style: none;
+}
+div.sectionbody {
+ margin-left: 5%;
+}
+
+@media print {
+ div#toc { display: none; }
+}
+
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
@@ -280,6 +365,7 @@ div.sidebar-content { padding: 0.5em;
}
div.sidebar-title, div.image-title {
+ color: #527bbd;
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
@@ -292,8 +378,17 @@ div.listingblock div.content { padding: 0.5em;
}
-div.quoteblock-content {
- padding-left: 2.0em;
+div.quoteblock-attribution {
+ padding-top: 0.5em;
+ text-align: right;
+}
+
+div.verseblock-content {
+ white-space: pre;
+}
+div.verseblock-attribution {
+ padding-top: 0.75em;
+ text-align: left;
}
div.exampleblock-content {
@@ -304,7 +399,6 @@ div.exampleblock-content { /* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
-<title>git-describe(1)</title>
</head>
<body>
<div id="header">
@@ -318,27 +412,29 @@ git-describe(1) Manual Page </p>
</div>
</div>
-<h2>SYNOPSIS</h2>
+<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<div class="content"><em>git describe</em> [--all] [--tags] [--contains] [--abbrev=<n>] <committish>…
-<em>git describe</em> [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]</div></div>
+<div class="verseblock-content"><em>git describe</em> [--all] [--tags] [--contains] [--abbrev=<n>] <committish>…
+<em>git describe</em> [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]</div>
+<div class="verseblock-attribution">
+</div></div>
</div>
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="para"><p>The command finds the most recent tag that is reachable from a
+<div class="paragraph"><p>The command finds the most recent tag that is reachable from a
commit. If the tag points to the commit, then only the tag is
shown. Otherwise, it suffixes the tag name with the number of
additional commits on top of the tagged object and the
abbreviated object name of the most recent commit.</p></div>
-<div class="para"><p>By default (without --all or --tags) <tt>git describe</tt> only shows
+<div class="paragraph"><p>By default (without --all or --tags) <tt>git describe</tt> 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>
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
-<div class="vlist"><dl>
-<dt>
+<div class="dlist"><dl>
+<dt class="hdlist1">
<committish>…
</dt>
<dd>
@@ -346,7 +442,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div> Committish object names to describe.
</p>
</dd>
-<dt>
+<dt class="hdlist1">
--dirty[=<mark>]
</dt>
<dd>
@@ -356,17 +452,17 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div> default) if the working tree is dirty.
</p>
</dd>
-<dt>
+<dt class="hdlist1">
--all
</dt>
<dd>
<p>
Instead of using only the annotated tags, use any ref
found in <tt>.git/refs/</tt>. This option enables matching
- any known branch, remote branch, or lightweight tag.
+ any known branch, remote-tracking branch, or lightweight tag.
</p>
</dd>
-<dt>
+<dt class="hdlist1">
--tags
</dt>
<dd>
@@ -376,7 +472,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div> a lightweight (non-annotated) tag.
</p>
</dd>
-<dt>
+<dt class="hdlist1">
--contains
</dt>
<dd>
@@ -386,7 +482,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div> Automatically implies --tags.
</p>
</dd>
-<dt>
+<dt class="hdlist1">
--abbrev=<n>
</dt>
<dd>
@@ -397,7 +493,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div> will suppress long format, only showing the closest tag.
</p>
</dd>
-<dt>
+<dt class="hdlist1">
--candidates=<n>
</dt>
<dd>
@@ -409,7 +505,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div> An <n> of 0 will cause only exact matches to be output.
</p>
</dd>
-<dt>
+<dt class="hdlist1">
--exact-match
</dt>
<dd>
@@ -418,7 +514,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div> supplied commit). This is a synonym for --candidates=0.
</p>
</dd>
-<dt>
+<dt class="hdlist1">
--debug
</dt>
<dd>
@@ -428,7 +524,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div> be printed to standard out.
</p>
</dd>
-<dt>
+<dt class="hdlist1">
--long
</dt>
<dd>
@@ -442,7 +538,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div> that points at object deadbee….).
</p>
</dd>
-<dt>
+<dt class="hdlist1">
--match <pattern>
</dt>
<dd>
@@ -451,7 +547,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div> leaking private tags made from the repository).
</p>
</dd>
-<dt>
+<dt class="hdlist1">
--always
</dt>
<dd>
@@ -463,31 +559,31 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div> </div>
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
-<div class="para"><p>With something like git.git current tree, I get:</p></div>
+<div class="paragraph"><p>With something like git.git current tree, I get:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>[torvalds@g5 git]$ git describe parent
v1.0.4-14-g2414721</tt></pre>
</div></div>
-<div class="para"><p>i.e. the current head of my "parent" branch is based on v1.0.4,
+<div class="paragraph"><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,
describe has added the number of additional commits ("14") and
an abbreviated object name for the commit itself ("2414721")
at the end.</p></div>
-<div class="para"><p>The number of additional commits is the number
+<div class="paragraph"><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>).
The "g" prefix stands for "git" and is used to allow describing the version of
a software depending on the SCM the software is managed with. This is useful
in an environment where people may use different SCMs.</p></div>
-<div class="para"><p>Doing a <em>git describe</em> on a tag-name will just show the tag name:</p></div>
+<div class="paragraph"><p>Doing a <em>git describe</em> on a tag-name will just show the tag name:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>[torvalds@g5 git]$ git describe v1.0.4
v1.0.4</tt></pre>
</div></div>
-<div class="para"><p>With --all, the command can use branch heads as references, so
+<div class="paragraph"><p>With --all, the command can use branch heads as references, so
the output shows the reference path as well:</p></div>
<div class="literalblock">
<div class="content">
@@ -499,14 +595,14 @@ tags/v1.0.0-21-g975b</tt></pre> <pre><tt>[torvalds@g5 git]$ git describe --all --abbrev=4 HEAD^
heads/lt/describe-7-g975b</tt></pre>
</div></div>
-<div class="para"><p>With --abbrev set to 0, the command can be used to find the
+<div class="paragraph"><p>With --abbrev set to 0, the command can be used to find the
closest tagname without any suffix:</p></div>
<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 class="para"><p>Note that the suffix you get if you type these commands today may be
+<div class="paragraph"><p>Note that the suffix you get if you type these commands today may be
longer than what Linus saw above when he ran these commands, as your
git repository may have new commits whose object names begin with
975b that did not exist back then, and "-g975b" suffix alone may not
@@ -514,16 +610,16 @@ be sufficient to disambiguate these commits.</p></div> </div>
<h2 id="_search_strategy">SEARCH STRATEGY</h2>
<div class="sectionbody">
-<div class="para"><p>For each committish supplied, <em>git describe</em> will first look for
+<div class="paragraph"><p>For each committish supplied, <em>git describe</em> 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.</p></div>
-<div class="para"><p>If an exact match was not found, <em>git describe</em> will walk back
+<div class="paragraph"><p>If an exact match was not found, <em>git describe</em> 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.</p></div>
-<div class="para"><p>If multiple tags were found during the walk then the tag which
+has been tagged. The ancestor’s tag will be output along with an
+abbreviation of the input committish’s SHA1.</p></div>
+<div class="paragraph"><p>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 <tt>git log tag..input</tt>
@@ -531,21 +627,21 @@ will be the smallest number of commits possible.</p></div> </div>
<h2 id="_author">Author</h2>
<div class="sectionbody">
-<div class="para"><p>Written by Linus Torvalds <torvalds@osdl.org>, but somewhat
-butchered by Junio C Hamano <gitster@pobox.com>. Later significantly
-updated by Shawn Pearce <spearce@spearce.org>.</p></div>
+<div class="paragraph"><p>Written by Linus Torvalds <<a href="mailto:torvalds@osdl.org">torvalds@osdl.org</a>>, but somewhat
+butchered by Junio C Hamano <<a href="mailto:gitster@pobox.com">gitster@pobox.com</a>>. Later significantly
+updated by Shawn Pearce <<a href="mailto:spearce@spearce.org">spearce@spearce.org</a>>.</p></div>
</div>
<h2 id="_documentation">Documentation</h2>
<div class="sectionbody">
-<div class="para"><p>Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.</p></div>
+<div class="paragraph"><p>Documentation by David Greaves, Junio C Hamano and the git-list <<a href="mailto:git@vger.kernel.org">git@vger.kernel.org</a>>.</p></div>
</div>
<h2 id="_git">GIT</h2>
<div class="sectionbody">
-<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
+<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2010-09-18 23:56:39 UTC
+Last updated 2010-11-25 03:13:41 UTC
</div>
</div>
</body>
|