From c680c8bc35ddf82b2e14b4523fb04d61029f0684 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Tue, 27 Dec 2005 18:33:26 -0800 Subject: [PATCH] Autogenerated man pages for 58e3fb40f7ca1c28f9105c15166884f80bb22e55 --- man1/git-describe.1 | 99 +++++++++++++++++++++++++++++++++++++++++++++ man7/git.7 | 4 ++ 2 files changed, 103 insertions(+) create mode 100755 man1/git-describe.1 diff --git a/man1/git-describe.1 b/man1/git-describe.1 new file mode 100755 index 000000000..92227772d --- /dev/null +++ b/man1/git-describe.1 @@ -0,0 +1,99 @@ +.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "GIT-DESCRIBE" 1 "" "" "" +.SH NAME +git-describe \- Show the most recent tag that is reachable from a commit. +.SH "SYNOPSIS" + + +git\-describe [\-\-all] [\-\-tags] [\-\-abbrev=] ... + +.SH "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\&. + +.SH "OPTIONS" + +.TP + +The object name of the comittish\&. + +.TP +\-\-all +Instead of using only the annotated tags, use any ref found in \&.git/refs/\&. + +.TP +\-\-tags +Instead of using only the annotated tags, use any tag found in \&.git/refs/tags\&. + +.TP +\-\-abbrev= +Instead of using the default 8 hexadecimal digits as the abbreviated object name, use digits\&. + +.SH "EXAMPLES" + + +With something like git\&.git current tree, I get: + +.nf +[torvalds@g5 git]$ git\-describe parent +v1\&.0\&.4\-g2414721b +.fi + + +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: + +.nf +[torvalds@g5 git]$ git\-describe v1\&.0\&.4 +v1\&.0\&.4 +.fi + + +With \-\-all, the command can use branch heads as references, so the output shows the reference path as well: + +.nf +[torvalds@g5 git]$ git describe \-\-all \-\-abbrev=4 v1\&.0\&.5^2 +tags/v1\&.0\&.0\-g975b +.fi + +.nf +[torvalds@g5 git]$ git describe \-\-all HEAD^ +heads/lt/describe\-g975b +.fi + +.SH "AUTHOR" + + +Written by Linus Torvalds , but somewhat butchered by Junio C Hamano + +.SH "DOCUMENTATION" + + +Documentation by David Greaves, Junio C Hamano and the git\-list \&. + +.SH "GIT" + + +Part of the \fBgit\fR(7) suite + diff --git a/man7/git.7 b/man7/git.7 index ffe94658b..b035e4b08 100755 --- a/man7/git.7 +++ b/man7/git.7 @@ -145,6 +145,10 @@ Creates a tree from the index\&. \fBgit\-cat\-file\fR(1) Provide content or type/size information for repository objects\&. +.TP +\fBgit\-describe\fR(1) +Show the most recent tag that is reachable from a commit\&. + .TP \fBgit\-diff\-index\fR(1) Compares content and mode of blobs between the index and repository\&. -- 2.26.2