man1/git-describe.1

   1 '\" t
   2 .\"     Title: git-describe
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-08-14
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.0.164.g477ce5ccd6
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-DESCRIBE" "1" "2024-08-14" "Git 2\&.46\&.0\&.164\&.g477ce5" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-describe \- Give an object a human readable name based on an available ref
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit describe\fR [\-\-all] [\-\-tags] [\-\-contains] [\-\-abbrev=<n>] [<commit\-ish>\&...\:]
  36 \fIgit describe\fR [\-\-all] [\-\-tags] [\-\-contains] [\-\-abbrev=<n>] \-\-dirty[=<mark>]
  37 \fIgit describe\fR <blob>
  38 .fi
  39 .SH "DESCRIPTION"
  40 .sp
  41 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\&. The result is a "human\-readable" object name which can also be used to identify the commit to other git commands\&.
  42 .sp
  43 By default (without \-\-all or \-\-tags) \fBgit describe\fR only shows annotated tags\&. For more information about creating annotated tags see the \-a and \-s options to \fBgit-tag\fR(1)\&.
  44 .sp
  45 If the given object refers to a blob, it will be described as \fB<commit\-ish>:<path>\fR, such that the blob can be found at \fB<path>\fR in the \fB<commit\-ish>\fR, which itself describes the first commit in which this blob occurs in a reverse revision walk from HEAD\&.
  46 .SH "OPTIONS"
  47 .PP
  48 <commit\-ish>\&...\:
  49 .RS 4
  50 Commit\-ish object names to describe\&. Defaults to HEAD if omitted\&.
  51 .RE
  52 .PP
  53 \-\-dirty[=<mark>], \-\-broken[=<mark>]
  54 .RS 4
  55 Describe the state of the working tree\&. When the working tree matches HEAD, the output is the same as "git describe HEAD"\&. If the working tree has local modification "\-dirty" is appended to it\&. If a repository is corrupt and Git cannot determine if there is local modification, Git will error out, unless
  56 \(lq\-\-broken\(rq
  57 is given, which appends the suffix "\-broken" instead\&.
  58 .RE
  59 .PP
  60 \-\-all
  61 .RS 4
  62 Instead of using only the annotated tags, use any ref found in
  63 \fBrefs/\fR
  64 namespace\&. This option enables matching any known branch, remote\-tracking branch, or lightweight tag\&.
  65 .RE
  66 .PP
  67 \-\-tags
  68 .RS 4
  69 Instead of using only the annotated tags, use any tag found in
  70 \fBrefs/tags\fR
  71 namespace\&. This option enables matching a lightweight (non\-annotated) tag\&.
  72 .RE
  73 .PP
  74 \-\-contains
  75 .RS 4
  76 Instead of finding the tag that predates the commit, find the tag that comes after the commit, and thus contains it\&. Automatically implies \-\-tags\&.
  77 .RE
  78 .PP
  79 \-\-abbrev=<n>
  80 .RS 4
  81 Instead of using the default number of hexadecimal digits (which will vary according to the number of objects in the repository with a default of 7) of the abbreviated object name, use <n> digits, or as many digits as needed to form a unique object name\&. An <n> of 0 will suppress long format, only showing the closest tag\&.
  82 .RE
  83 .PP
  84 \-\-candidates=<n>
  85 .RS 4
  86 Instead of considering only the 10 most recent tags as candidates to describe the input commit\-ish consider up to <n> candidates\&. Increasing <n> above 10 will take slightly longer but may produce a more accurate result\&. An <n> of 0 will cause only exact matches to be output\&.
  87 .RE
  88 .PP
  89 \-\-exact\-match
  90 .RS 4
  91 Only output exact matches (a tag directly references the supplied commit)\&. This is a synonym for \-\-candidates=0\&.
  92 .RE
  93 .PP
  94 \-\-debug
  95 .RS 4
  96 Verbosely display information about the searching strategy being employed to standard error\&. The tag name will still be printed to standard out\&.
  97 .RE
  98 .PP
  99 \-\-long
 100 .RS 4
 101 Always output the long format (the tag, the number of commits and the abbreviated commit name) even when it matches a tag\&. This is useful when you want to see parts of the commit object name in "describe" output, even when the commit in question happens to be a tagged version\&. Instead of just emitting the tag name, it will describe such a commit as v1\&.2\-0\-gdeadbee (0th commit since tag v1\&.2 that points at object deadbee\&...\:\&.)\&.
 102 .RE
 103 .PP
 104 \-\-match <pattern>
 105 .RS 4
 106 Only consider tags matching the given
 107 \fBglob(7)\fR
 108 pattern, excluding the "refs/tags/" prefix\&. If used with
 109 \fB\-\-all\fR, it also considers local branches and remote\-tracking references matching the pattern, excluding respectively "refs/heads/" and "refs/remotes/" prefix; references of other types are never considered\&. If given multiple times, a list of patterns will be accumulated, and tags matching any of the patterns will be considered\&. Use
 110 \fB\-\-no\-match\fR
 111 to clear and reset the list of patterns\&.
 112 .RE
 113 .PP
 114 \-\-exclude <pattern>
 115 .RS 4
 116 Do not consider tags matching the given
 117 \fBglob(7)\fR
 118 pattern, excluding the "refs/tags/" prefix\&. If used with
 119 \fB\-\-all\fR, it also does not consider local branches and remote\-tracking references matching the pattern, excluding respectively "refs/heads/" and "refs/remotes/" prefix; references of other types are never considered\&. If given multiple times, a list of patterns will be accumulated and tags matching any of the patterns will be excluded\&. When combined with \-\-match a tag will be considered when it matches at least one \-\-match pattern and does not match any of the \-\-exclude patterns\&. Use
 120 \fB\-\-no\-exclude\fR
 121 to clear and reset the list of patterns\&.
 122 .RE
 123 .PP
 124 \-\-always
 125 .RS 4
 126 Show uniquely abbreviated commit object as fallback\&.
 127 .RE
 128 .PP
 129 \-\-first\-parent
 130 .RS 4
 131 Follow only the first parent commit upon seeing a merge commit\&. This is useful when you wish to not match tags on branches merged in the history of the target commit\&.
 132 .RE
 133 .SH "EXAMPLES"
 134 .sp
 135 With something like git\&.git current tree, I get:
 136 .sp
 137 .if n \{\
 138 .RS 4
 139 .\}
 140 .nf
 141 [torvalds@g5 git]$ git describe parent
 142 v1\&.0\&.4\-14\-g2414721
 143 .fi
 144 .if n \{\
 145 .RE
 146 .\}
 147 .sp
 148 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\&.
 149 .sp
 150 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" + an unambiguous abbreviation for the tip commit of parent (which was \fB2414721b194453f058079d897d13c4e377f92dc6\fR)\&. The length of the abbreviation scales as the repository grows, using the approximate number of objects in the repository and a bit of math around the birthday paradox, and defaults to a minimum of 7\&. 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\&.
 151 .sp
 152 Doing a \fIgit describe\fR on a tag\-name will just show the tag name:
 153 .sp
 154 .if n \{\
 155 .RS 4
 156 .\}
 157 .nf
 158 [torvalds@g5 git]$ git describe v1\&.0\&.4
 159 v1\&.0\&.4
 160 .fi
 161 .if n \{\
 162 .RE
 163 .\}
 164 .sp
 165 With \-\-all, the command can use branch heads as references, so the output shows the reference path as well:
 166 .sp
 167 .if n \{\
 168 .RS 4
 169 .\}
 170 .nf
 171 [torvalds@g5 git]$ git describe \-\-all \-\-abbrev=4 v1\&.0\&.5^2
 172 tags/v1\&.0\&.0\-21\-g975b
 173 .fi
 174 .if n \{\
 175 .RE
 176 .\}
 177 .sp
 178 .if n \{\
 179 .RS 4
 180 .\}
 181 .nf
 182 [torvalds@g5 git]$ git describe \-\-all \-\-abbrev=4 HEAD^
 183 heads/lt/describe\-7\-g975b
 184 .fi
 185 .if n \{\
 186 .RE
 187 .\}
 188 .sp
 189 With \-\-abbrev set to 0, the command can be used to find the closest tagname without any suffix:
 190 .sp
 191 .if n \{\
 192 .RS 4
 193 .\}
 194 .nf
 195 [torvalds@g5 git]$ git describe \-\-abbrev=0 v1\&.0\&.5^2
 196 tags/v1\&.0\&.0
 197 .fi
 198 .if n \{\
 199 .RE
 200 .\}
 201 .sp
 202 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 be sufficient to disambiguate these commits\&.
 203 .SH "SEARCH STRATEGY"
 204 .sp
 205 For each commit\-ish supplied, \fIgit describe\fR 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\&.
 206 .sp
 207 If an exact match was not found, \fIgit describe\fR will walk back through the commit history to locate an ancestor commit which has been tagged\&. The ancestor\(cqs tag will be output along with an abbreviation of the input commit\-ish\(cqs SHA\-1\&. If \fB\-\-first\-parent\fR was specified then the walk will only consider the first parent of each commit\&.
 208 .sp
 209 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 \fBgit log tag\&.\&.input\fR will be the smallest number of commits possible\&.
 210 .SH "BUGS"
 211 .sp
 212 Tree objects as well as tag objects not pointing at commits, cannot be described\&. When describing blobs, the lightweight tags pointing at blobs are ignored, but the blob is still described as <commit\-ish>:<path> despite the lightweight tag being favorable\&.
 213 .SH "GIT"
 214 .sp
 215 Part of the \fBgit\fR(1) suite