Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
environment variables. See gitlink:git-commit-tree[1].
+user.signingkey::
+ If gitlink:git-tag[1] is not selecting the key you want it to
+ automatically when creating a signed tag, you can override the
+ default selection with this variable. This option is passed
+ unchanged to gpg's --local-user parameter, so you may specify a key
+ using any method that gpg supports.
+
whatchanged.difftree::
The default gitlink:git-diff-tree[1] arguments to be used
for gitlink:git-whatchanged[1].
Turn off rename detection, even when the configuration
file gives the default to do so.
+--check::
+ Warn if changes introduce trailing whitespace
+ or an indent that uses a space before a tab.
+
--full-index::
Instead of the first handful characters, show full
object name of pre- and post-image blob on the "index"
<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
+the tag. Otherwise, it suffixes the tag name with the number of\r
+additional commits and the abbreviated object name of the commit.</p>\r
</div>\r
<h2>OPTIONS</h2>\r
<div class="sectionbody">\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
+v1.0.4-14-g2414721</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
+but since it has a handful commits on top of that,\r
+describe has added the number of additional commits ("14") and\r
+an abbreviated object name for the commit itself ("2414721")\r
+at the end.</p>\r
+<p>The number of additional commits is the number\r
+of commits which would be displayed by "git log v1.0.4..parent".\r
+The hash suffix is "-g" + 7-char abbreviation for the tip commit\r
+of parent (which was <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
<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
+tags/v1.0.0-21-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
+heads/lt/describe-7-g975b</tt></pre>\r
+</div></div>\r
+<p>With --abbrev set to 0, the command can be used to find the\r
+closest tagname without any suffix:</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>[torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2\r
+tags/v1.0.0</tt></pre>\r
</div></div>\r
</div>\r
<h2>SEARCH STRATEGY</h2>\r
<h2>Author</h2>\r
<div class="sectionbody">\r
<p>Written by Linus Torvalds <torvalds@osdl.org>, but somewhat\r
-butchered by Junio C Hamano <junkio@cox.net></p>\r
+butchered by Junio C Hamano <junkio@cox.net>. Later significantly\r
+updated by Shawn Pearce <spearce@spearce.org>.</p>\r
</div>\r
<h2>Documentation</h2>\r
<div class="sectionbody">\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 15-Jan-2007 06:12:30 UTC\r
+Last updated 28-Jan-2007 10:29:05 UTC\r
</div>\r
</div>\r
</body>\r
-----------
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.
+the tag. Otherwise, it suffixes the tag name with the number of
+additional commits and the abbreviated object name of the commit.
OPTIONS
With something like git.git current tree, I get:
[torvalds@g5 git]$ git-describe parent
- v1.0.4-g2414721b
+ v1.0.4-14-g2414721
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`.
+but since it has a handful 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.
+
+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 `2414721b194453f058079d897d13c4e377f92dc6`).
Doing a "git-describe" on a tag-name will just show the tag name:
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
+ tags/v1.0.0-21-g975b
[torvalds@g5 git]$ git describe --all HEAD^
- heads/lt/describe-g975b
+ heads/lt/describe-7-g975b
+
+With --abbrev set to 0, the command can be used to find the
+closest tagname without any suffix:
+
+ [torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2
+ tags/v1.0.0
SEARCH STRATEGY
---------------
Author
------
Written by Linus Torvalds <torvalds@osdl.org>, but somewhat
-butchered by Junio C Hamano <junkio@cox.net>
+butchered by Junio C Hamano <junkio@cox.net>. Later significantly
+updated by Shawn Pearce <spearce@spearce.org>.
Documentation
--------------
</p>\r
</dd>\r
<dt>\r
+--check\r
+</dt>\r
+<dd>\r
+<p>\r
+ Warn if changes introduce trailing whitespace\r
+ or an indent that uses a space before a tab.\r
+</p>\r
+</dd>\r
+<dt>\r
--full-index\r
</dt>\r
<dd>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 26-Dec-2006 09:11:30 UTC\r
+Last updated 28-Jan-2007 10:29:05 UTC\r
</div>\r
</div>\r
</body>\r
</p>\r
</dd>\r
<dt>\r
+--check\r
+</dt>\r
+<dd>\r
+<p>\r
+ Warn if changes introduce trailing whitespace\r
+ or an indent that uses a space before a tab.\r
+</p>\r
+</dd>\r
+<dt>\r
--full-index\r
</dt>\r
<dd>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 26-Dec-2006 09:11:31 UTC\r
+Last updated 28-Jan-2007 10:29:06 UTC\r
</div>\r
</div>\r
</body>\r
</p>\r
</dd>\r
<dt>\r
+--check\r
+</dt>\r
+<dd>\r
+<p>\r
+ Warn if changes introduce trailing whitespace\r
+ or an indent that uses a space before a tab.\r
+</p>\r
+</dd>\r
+<dt>\r
--full-index\r
</dt>\r
<dd>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 19-Jan-2007 00:37:17 UTC\r
+Last updated 28-Jan-2007 10:29:07 UTC\r
</div>\r
</div>\r
</body>\r
</p>\r
</dd>\r
<dt>\r
+--check\r
+</dt>\r
+<dd>\r
+<p>\r
+ Warn if changes introduce trailing whitespace\r
+ or an indent that uses a space before a tab.\r
+</p>\r
+</dd>\r
+<dt>\r
--full-index\r
</dt>\r
<dd>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 31-Dec-2006 01:19:02 UTC\r
+Last updated 28-Jan-2007 10:29:07 UTC\r
</div>\r
</div>\r
</body>\r
</p>\r
</dd>\r
<dt>\r
+--check\r
+</dt>\r
+<dd>\r
+<p>\r
+ Warn if changes introduce trailing whitespace\r
+ or an indent that uses a space before a tab.\r
+</p>\r
+</dd>\r
+<dt>\r
--full-index\r
</dt>\r
<dd>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 18-Jan-2007 06:23:58 UTC\r
+Last updated 28-Jan-2007 10:29:09 UTC\r
</div>\r
</div>\r
</body>\r
</p>\r
</dd>\r
<dt>\r
+user.signingkey\r
+</dt>\r
+<dd>\r
+<p>\r
+ If <a href="git-tag.html">git-tag(1)</a> is not selecting the key you want it to\r
+ automatically when creating a signed tag, you can override the\r
+ default selection with this variable. This option is passed\r
+ unchanged to gpg's --local-user parameter, so you may specify a key\r
+ using any method that gpg supports.\r
+</p>\r
+</dd>\r
+<dt>\r
whatchanged.difftree\r
</dt>\r
<dd>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 25-Jan-2007 07:59:39 UTC\r
+Last updated 28-Jan-2007 10:29:09 UTC\r
</div>\r
</div>\r
</body>\r
</dd>\r
</dl>\r
</div>\r
+<h2>CONFIGURATION</h2>\r
+<div class="sectionbody">\r
+<p>By default, git-tag in sign-with-default mode (-s) will use your\r
+committer identity (of the form "Your Name <your@email.address>") to\r
+find a key. If you want to use a different default key, you can specify\r
+it in the repository configuration as follows:</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>signingkey = <gpg-key-id></tt></pre>\r
+</div></div>\r
+</div>\r
<h2>Author</h2>\r
<div class="sectionbody">\r
<p>Written by Linus Torvalds <torvalds@osdl.org>,\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 21-Jan-2007 08:57:04 UTC\r
+Last updated 28-Jan-2007 10:29:11 UTC\r
</div>\r
</div>\r
</body>\r
Take the tag message from the given file. Use '-' to
read the message from the standard input.
+CONFIGURATION
+-------------
+By default, git-tag in sign-with-default mode (-s) will use your
+committer identity (of the form "Your Name <your@email.address>") to
+find a key. If you want to use a different default key, you can specify
+it in the repository configuration as follows:
+
+[user]
+ signingkey = <gpg-key-id>
+
Author
------
Written by Linus Torvalds <torvalds@osdl.org>,
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 26-Jan-2007 09:44:41 UTC\r
+Last updated 28-Jan-2007 10:29:11 UTC\r
</div>\r
</div>\r
</body>\r