summaryrefslogtreecommitdiffstats
path: root/git-describe.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2014-01-17 14:46:49 -0800
committerJunio C Hamano <gitster@pobox.com>2014-01-17 14:46:49 -0800
commit61525f915b47e953b4288a9afcee45e47b352214 (patch)
treef0649f89cc7a77c0296305f4673fc2bc7e0a6d54 /git-describe.html
parentbc8d4783cac3c942fc9e8cf2f3eae4aea8cab5cb (diff)
downloadgit-htmldocs-61525f915b47e953b4288a9afcee45e47b352214.tar.gz
Autogenerated HTML docs for v1.9-rc0
Diffstat (limited to 'git-describe.html')
-rw-r--r--git-describe.html66
1 files changed, 35 insertions, 31 deletions
diff --git a/git-describe.html b/git-describe.html
index 5393a3eb7..af8570ee8 100644
--- a/git-describe.html
+++ b/git-describe.html
@@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.6.8" />
+<meta name="generator" content="AsciiDoc 8.6.6" />
<title>git-describe(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -87,15 +87,11 @@ ul, ol, li > p {
ul > li { color: #aaa; }
ul > li > * { color: black; }
-.monospaced, code, pre {
- font-family: "Courier New", Courier, monospace;
- font-size: inherit;
- color: navy;
+pre {
padding: 0;
margin: 0;
}
-
#author {
color: #527bbd;
font-weight: bold;
@@ -353,7 +349,7 @@ div.colist td img {
margin-bottom: 0.1em;
}
-div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
@@ -411,14 +407,18 @@ span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
-div.unbreakable { page-break-inside: avoid; }
-
/*
* xhtml11 specific
*
* */
+tt {
+ font-family: monospace;
+ font-size: inherit;
+ color: navy;
+}
+
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
@@ -452,6 +452,12 @@ div.tableblock > table[frame="vsides"] {
*
* */
+.monospaced {
+ font-family: monospace;
+ font-size: inherit;
+ color: navy;
+}
+
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
@@ -531,8 +537,6 @@ body.manpage div.sectionbody {
@media print {
body.manpage div#toc { display: none; }
}
-
-
</style>
<script type="text/javascript">
/*<![CDATA[*/
@@ -577,7 +581,7 @@ toc: function (toclevels) {
function tocEntries(el, toclevels) {
var result = new Array;
- var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
+ var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
@@ -606,7 +610,7 @@ toc: function (toclevels) {
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
- if (entry.nodeName.toLowerCase() == 'div'
+ if (entry.nodeName == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
@@ -652,7 +656,7 @@ footnotes: function () {
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
- if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
+ if (entry.nodeName == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
@@ -760,7 +764,7 @@ 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="paragraph"><p>By default (without --all or --tags) <code>git describe</code> 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>
@@ -783,7 +787,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div>
<dd>
<p>
Describe the working tree.
- It means describe HEAD and appends &lt;mark&gt; (<code>-dirty</code> by
+ It means describe HEAD and appends &lt;mark&gt; (<tt>-dirty</tt> by
default) if the working tree is dirty.
</p>
</dd>
@@ -793,7 +797,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div>
<dd>
<p>
Instead of using only the annotated tags, use any ref
- found in <code>refs/</code> namespace. This option enables matching
+ found in <tt>refs/</tt> namespace. This option enables matching
any known branch, remote-tracking branch, or lightweight tag.
</p>
</dd>
@@ -803,7 +807,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div>
<dd>
<p>
Instead of using only the annotated tags, use any tag
- found in <code>refs/tags</code> namespace. This option enables matching
+ found in <tt>refs/tags</tt> namespace. This option enables matching
a lightweight (non-annotated) tag.
</p>
</dd>
@@ -878,7 +882,7 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div>
</dt>
<dd>
<p>
- Only consider tags matching the given <code>glob(7)</code> pattern,
+ Only consider tags matching the given <tt>glob(7)</tt> pattern,
excluding the "refs/tags/" prefix. This can be used to avoid
leaking private tags from the repository.
</p>
@@ -910,8 +914,8 @@ see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div>
<div class="paragraph"><p>With something like git.git current tree, I get:</p></div>
<div class="literalblock">
<div class="content">
-<pre><code>[torvalds@g5 git]$ git describe parent
-v1.0.4-14-g2414721</code></pre>
+<pre><tt>[torvalds@g5 git]$ git describe parent
+v1.0.4-14-g2414721</tt></pre>
</div></div>
<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,
@@ -921,34 +925,34 @@ at the end.</p></div>
<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 <code>2414721b194453f058079d897d13c4e377f92dc6</code>).
+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="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><code>[torvalds@g5 git]$ git describe v1.0.4
-v1.0.4</code></pre>
+<pre><tt>[torvalds@g5 git]$ git describe v1.0.4
+v1.0.4</tt></pre>
</div></div>
<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">
-<pre><code>[torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2
-tags/v1.0.0-21-g975b</code></pre>
+<pre><tt>[torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2
+tags/v1.0.0-21-g975b</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><code>[torvalds@g5 git]$ git describe --all --abbrev=4 HEAD^
-heads/lt/describe-7-g975b</code></pre>
+<pre><tt>[torvalds@g5 git]$ git describe --all --abbrev=4 HEAD^
+heads/lt/describe-7-g975b</tt></pre>
</div></div>
<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><code>[torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2
-tags/v1.0.0</code></pre>
+<pre><tt>[torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2
+tags/v1.0.0</tt></pre>
</div></div>
<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
@@ -974,7 +978,7 @@ commit.</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 commit-ish will be
selected and output. Here fewest commits different is defined as
-the number of commits which would be shown by <code>git log tag..input</code>
+the number of commits which would be shown by <tt>git log tag..input</tt>
will be the smallest number of commits possible.</p></div>
</div>
</div>