1SPECIFYING REVISIONS 2-------------------- 3 4A revision parameter '<rev>' typically, but not necessarily, names a 5commit object. It uses what is called an 'extended SHA-1' 6syntax. Here are various ways to spell object names. The 7ones listed near the end of this list name trees and 8blobs contained in a commit. 9 10'<sha1>', e.g. 'dae86e1950b1277e545cee180551750029cfe735', 'dae86e':: 11 The full SHA-1 object name (40-byte hexadecimal string), or 12 a leading substring that is unique within the repository. 13 E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both 14 name the same commit object if there is no other object in 15 your repository whose object name starts with dae86e. 16 17'<describeOutput>', e.g. 'v1.7.4.2-679-g3bee7fb':: 18 Output from `git describe`; i.e. a closest tag, optionally 19 followed by a dash and a number of commits, followed by a dash, a 20 'g', and an abbreviated object name. 21 22'<refname>', e.g. 'master', 'heads/master', 'refs/heads/master':: 23 A symbolic ref name. E.g. 'master' typically means the commit 24 object referenced by 'refs/heads/master'. If you 25 happen to have both 'heads/master' and 'tags/master', you can 26 explicitly say 'heads/master' to tell Git which one you mean. 27 When ambiguous, a '<refname>' is disambiguated by taking the 28 first match in the following rules: 29 30 . If '$GIT_DIR/<refname>' exists, that is what you mean (this is usually 31 useful only for 'HEAD', 'FETCH_HEAD', 'ORIG_HEAD', 'MERGE_HEAD' 32 and 'CHERRY_PICK_HEAD'); 33 34 . otherwise, 'refs/<refname>' if it exists; 35 36 . otherwise, 'refs/tags/<refname>' if it exists; 37 38 . otherwise, 'refs/heads/<refname>' if it exists; 39 40 . otherwise, 'refs/remotes/<refname>' if it exists; 41 42 . otherwise, 'refs/remotes/<refname>/HEAD' if it exists. 43+ 44'HEAD' names the commit on which you based the changes in the working tree. 45'FETCH_HEAD' records the branch which you fetched from a remote repository 46with your last `git fetch` invocation. 47'ORIG_HEAD' is created by commands that move your 'HEAD' in a drastic 48way, to record the position of the 'HEAD' before their operation, so that 49you can easily change the tip of the branch back to the state before you ran 50them. 51'MERGE_HEAD' records the commit(s) which you are merging into your branch 52when you run `git merge`. 53'CHERRY_PICK_HEAD' records the commit which you are cherry-picking 54when you run `git cherry-pick`. 55+ 56Note that any of the 'refs/*' cases above may come either from 57the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file. 58While the ref name encoding is unspecified, UTF-8 is preferred as 59some output processing may assume ref names in UTF-8. 60 61'<refname>@\{<date>\}', e.g. 'master@\{yesterday\}', 'HEAD@\{5 minutes ago\}':: 62 A ref followed by the suffix '@' with a date specification 63 enclosed in a brace 64 pair (e.g. '\{yesterday\}', '\{1 month 2 weeks 3 days 1 hour 1 65 second ago\}' or '\{1979-02-26 18:30:00\}') specifies the value 66 of the ref at a prior point in time. This suffix may only be 67 used immediately following a ref name and the ref must have an 68 existing log ('$GIT_DIR/logs/<ref>'). Note that this looks up the state 69 of your *local* ref at a given time; e.g., what was in your local 70 'master' branch last week. If you want to look at commits made during 71 certain times, see '--since' and '--until'. 72 73'<refname>@\{<n>\}', e.g. 'master@\{1\}':: 74 A ref followed by the suffix '@' with an ordinal specification 75 enclosed in a brace pair (e.g. '\{1\}', '\{15\}') specifies 76 the n-th prior value of that ref. For example 'master@\{1\}' 77 is the immediate prior value of 'master' while 'master@\{5\}' 78 is the 5th prior value of 'master'. This suffix may only be used 79 immediately following a ref name and the ref must have an existing 80 log ('$GIT_DIR/logs/<refname>'). 81 82'@\{<n>\}', e.g. '@\{1\}':: 83 You can use the '@' construct with an empty ref part to get at a 84 reflog entry of the current branch. For example, if you are on 85 branch 'blabla' then '@\{1\}' means the same as 'blabla@\{1\}'. 86 87'@\{-<n>\}', e.g. '@\{-1\}':: 88 The construct '@\{-<n>\}' means the <n>th branch checked out 89 before the current one. 90 91'<branchname>@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}':: 92 The suffix '@\{upstream\}' to a branchname (short form '<branchname>@\{u\}') 93 refers to the branch that the branch specified by branchname is set to build on 94 top of. A missing branchname defaults to the current one. 95 96'<rev>{caret}', e.g. 'HEAD{caret}, v1.5.1{caret}0':: 97 A suffix '{caret}' to a revision parameter means the first parent of 98 that commit object. '{caret}<n>' means the <n>th parent (i.e. 99 '<rev>{caret}' 100 is equivalent to '<rev>{caret}1'). As a special rule, 101 '<rev>{caret}0' means the commit itself and is used when '<rev>' is the 102 object name of a tag object that refers to a commit object. 103 104'<rev>{tilde}<n>', e.g. 'master{tilde}3':: 105 A suffix '{tilde}<n>' to a revision parameter means the commit 106 object that is the <n>th generation ancestor of the named 107 commit object, following only the first parents. I.e. '<rev>{tilde}3' is 108 equivalent to '<rev>{caret}{caret}{caret}' which is equivalent to 109 '<rev>{caret}1{caret}1{caret}1'. See below for an illustration of 110 the usage of this form. 111 112'<rev>{caret}\{<type>\}', e.g. 'v0.99.8{caret}\{commit\}':: 113 A suffix '{caret}' followed by an object type name enclosed in 114 brace pair means the object 115 could be a tag, and dereference the tag recursively until an 116 object of that type is found or the object cannot be 117 dereferenced anymore (in which case, barf). '<rev>{caret}0' 118 is a short-hand for '<rev>{caret}\{commit\}'. 119+ 120'rev{caret}\{object\}' can be used to make sure 'rev' names an 121object that exists, without requiring 'rev' to be a tag, and 122without dereferencing 'rev'; because a tag is already an object, 123it does not have to be dereferenced even once to get to an object. 124 125'<rev>{caret}\{\}', e.g. 'v0.99.8{caret}\{\}':: 126 A suffix '{caret}' followed by an empty brace pair 127 means the object could be a tag, 128 and dereference the tag recursively until a non-tag object is 129 found. 130 131'<rev>{caret}\{/<text>\}', e.g. 'HEAD^{/fix nasty bug}':: 132 A suffix '{caret}' to a revision parameter, followed by a brace 133 pair that contains a text led by a slash, 134 is the same as the ':/fix nasty bug' syntax below except that 135 it returns the youngest matching commit which is reachable from 136 the '<rev>' before '{caret}'. 137 138':/<text>', e.g. ':/fix nasty bug':: 139 A colon, followed by a slash, followed by a text, names 140 a commit whose commit message matches the specified regular expression. 141 This name returns the youngest matching commit which is 142 reachable from any ref. If the commit message starts with a 143 '!' you have to repeat that; the special sequence ':/!', 144 followed by something else than '!', is reserved for now. 145 The regular expression can match any part of the commit message. To 146 match messages starting with a string, one can use e.g. ':/^foo'. 147 148'<rev>:<path>', e.g. 'HEAD:README', ':README', 'master:./README':: 149 A suffix ':' followed by a path names the blob or tree 150 at the given path in the tree-ish object named by the part 151 before the colon. 152 ':path' (with an empty part before the colon) 153 is a special case of the syntax described next: content 154 recorded in the index at the given path. 155 A path starting with './' or '../' is relative to the current working directory. 156 The given path will be converted to be relative to the working tree's root directory. 157 This is most useful to address a blob or tree from a commit or tree that has 158 the same tree structure as the working tree. 159 160':<n>:<path>', e.g. ':0:README', ':README':: 161 A colon, optionally followed by a stage number (0 to 3) and a 162 colon, followed by a path, names a blob object in the 163 index at the given path. A missing stage number (and the colon 164 that follows it) names a stage 0 entry. During a merge, stage 165 1 is the common ancestor, stage 2 is the target branch's version 166 (typically the current branch), and stage 3 is the version from 167 the branch which is being merged. 168 169Here is an illustration, by Jon Loeliger. Both commit nodes B 170and C are parents of commit node A. Parent commits are ordered 171left-to-right. 172 173........................................ 174G H I J 175 \ / \ / 176 D E F 177 \ | / \ 178 \ | / | 179 \|/ | 180 B C 181 \ / 182 \ / 183 A 184........................................ 185 186 A = = A^0 187 B = A^ = A^1 = A~1 188 C = A^2 = A^2 189 D = A^^ = A^1^1 = A~2 190 E = B^2 = A^^2 191 F = B^3 = A^^3 192 G = A^^^ = A^1^1^1 = A~3 193 H = D^2 = B^^2 = A^^^2 = A~2^2 194 I = F^ = B^3^ = A^^3^ 195 J = F^2 = B^3^2 = A^^3^2 196 197 198SPECIFYING RANGES 199----------------- 200 201History traversing commands such as `git log` operate on a set 202of commits, not just a single commit. To these commands, 203specifying a single revision with the notation described in the 204previous section means the set of commits reachable from that 205commit, following the commit ancestry chain. 206 207To exclude commits reachable from a commit, a prefix '{caret}' 208notation is used. E.g. '{caret}r1 r2' means commits reachable 209from 'r2' but exclude the ones reachable from 'r1'. 210 211This set operation appears so often that there is a shorthand 212for it. When you have two commits 'r1' and 'r2' (named according 213to the syntax explained in SPECIFYING REVISIONS above), you can ask 214for commits that are reachable from r2 excluding those that are reachable 215from r1 by '{caret}r1 r2' and it can be written as 'r1..r2'. 216 217A similar notation 'r1\...r2' is called symmetric difference 218of 'r1' and 'r2' and is defined as 219'r1 r2 --not $(git merge-base --all r1 r2)'. 220It is the set of commits that are reachable from either one of 221'r1' or 'r2' but not from both. 222 223In these two shorthands, you can omit one end and let it default to HEAD. 224For example, 'origin..' is a shorthand for 'origin..HEAD' and asks "What 225did I do since I forked from the origin branch?" Similarly, '..origin' 226is a shorthand for 'HEAD..origin' and asks "What did the origin do since 227I forked from them?" Note that '..' would mean 'HEAD..HEAD' which is an 228empty range that is both reachable and unreachable from HEAD. 229 230Two other shorthands for naming a set that is formed by a commit 231and its parent commits exist. The 'r1{caret}@' notation means all 232parents of 'r1'. 'r1{caret}!' includes commit 'r1' but excludes 233all of its parents. 234 235To summarize: 236 237'<rev>':: 238 Include commits that are reachable from (i.e. ancestors of) 239 <rev>. 240 241'{caret}<rev>':: 242 Exclude commits that are reachable from (i.e. ancestors of) 243 <rev>. 244 245'<rev1>..<rev2>':: 246 Include commits that are reachable from <rev2> but exclude 247 those that are reachable from <rev1>. When either <rev1> or 248 <rev2> is omitted, it defaults to 'HEAD'. 249 250'<rev1>\...<rev2>':: 251 Include commits that are reachable from either <rev1> or 252 <rev2> but exclude those that are reachable from both. When 253 either <rev1> or <rev2> is omitted, it defaults to 'HEAD'. 254 255'<rev>{caret}@', e.g. 'HEAD{caret}@':: 256 A suffix '{caret}' followed by an at sign is the same as listing 257 all parents of '<rev>' (meaning, include anything reachable from 258 its parents, but not the commit itself). 259 260'<rev>{caret}!', e.g. 'HEAD{caret}!':: 261 A suffix '{caret}' followed by an exclamation mark is the same 262 as giving commit '<rev>' and then all its parents prefixed with 263 '{caret}' to exclude them (and their ancestors). 264 265Here are a handful of examples: 266 267 D G H D 268 D F G H I J D F 269 ^G D H D 270 ^D B E I J F B 271 B..C C 272 B...C G H D E B C 273 ^D B C E I J F B C 274 C I J F C 275 C^@ I J F 276 C^! C 277 F^! D G H D F