Documentation / revisions.txton commit revisions.txt: mention <rev>~ form (6a12e99)
   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
  10NOTE: This document shows the "raw" syntax as seen by git. The shell
  11and other UIs might require additional quoting to protect special
  12characters and to avoid word splitting.
  13
  14'<sha1>', e.g. 'dae86e1950b1277e545cee180551750029cfe735', 'dae86e'::
  15  The full SHA-1 object name (40-byte hexadecimal string), or
  16  a leading substring that is unique within the repository.
  17  E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
  18  name the same commit object if there is no other object in
  19  your repository whose object name starts with dae86e.
  20
  21'<describeOutput>', e.g. 'v1.7.4.2-679-g3bee7fb'::
  22  Output from `git describe`; i.e. a closest tag, optionally
  23  followed by a dash and a number of commits, followed by a dash, a
  24  'g', and an abbreviated object name.
  25
  26'<refname>', e.g. 'master', 'heads/master', 'refs/heads/master'::
  27  A symbolic ref name.  E.g. 'master' typically means the commit
  28  object referenced by 'refs/heads/master'.  If you
  29  happen to have both 'heads/master' and 'tags/master', you can
  30  explicitly say 'heads/master' to tell Git which one you mean.
  31  When ambiguous, a '<refname>' is disambiguated by taking the
  32  first match in the following rules:
  33
  34  . If '$GIT_DIR/<refname>' exists, that is what you mean (this is usually
  35    useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD`, `MERGE_HEAD`
  36    and `CHERRY_PICK_HEAD`);
  37
  38  . otherwise, 'refs/<refname>' if it exists;
  39
  40  . otherwise, 'refs/tags/<refname>' if it exists;
  41
  42  . otherwise, 'refs/heads/<refname>' if it exists;
  43
  44  . otherwise, 'refs/remotes/<refname>' if it exists;
  45
  46  . otherwise, 'refs/remotes/<refname>/HEAD' if it exists.
  47+
  48`HEAD` names the commit on which you based the changes in the working tree.
  49`FETCH_HEAD` records the branch which you fetched from a remote repository
  50with your last `git fetch` invocation.
  51`ORIG_HEAD` is created by commands that move your `HEAD` in a drastic
  52way, to record the position of the `HEAD` before their operation, so that
  53you can easily change the tip of the branch back to the state before you ran
  54them.
  55`MERGE_HEAD` records the commit(s) which you are merging into your branch
  56when you run `git merge`.
  57`CHERRY_PICK_HEAD` records the commit which you are cherry-picking
  58when you run `git cherry-pick`.
  59+
  60Note that any of the 'refs/*' cases above may come either from
  61the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
  62While the ref name encoding is unspecified, UTF-8 is preferred as
  63some output processing may assume ref names in UTF-8.
  64
  65'@'::
  66  '@' alone is a shortcut for `HEAD`.
  67
  68'[<refname>]@{<date>}', e.g. 'master@\{yesterday\}', 'HEAD@{5 minutes ago}'::
  69  A ref followed by the suffix '@' with a date specification
  70  enclosed in a brace
  71  pair (e.g. '\{yesterday\}', '{1 month 2 weeks 3 days 1 hour 1
  72  second ago}' or '{1979-02-26 18:30:00}') specifies the value
  73  of the ref at a prior point in time.  This suffix may only be
  74  used immediately following a ref name and the ref must have an
  75  existing log ('$GIT_DIR/logs/<ref>'). Note that this looks up the state
  76  of your *local* ref at a given time; e.g., what was in your local
  77  'master' branch last week. If you want to look at commits made during
  78  certain times, see `--since` and `--until`.
  79
  80'<refname>@{<n>}', e.g. 'master@\{1\}'::
  81  A ref followed by the suffix '@' with an ordinal specification
  82  enclosed in a brace pair (e.g. '\{1\}', '\{15\}') specifies
  83  the n-th prior value of that ref.  For example 'master@\{1\}'
  84  is the immediate prior value of 'master' while 'master@\{5\}'
  85  is the 5th prior value of 'master'. This suffix may only be used
  86  immediately following a ref name and the ref must have an existing
  87  log ('$GIT_DIR/logs/<refname>').
  88
  89'@{<n>}', e.g. '@\{1\}'::
  90  You can use the '@' construct with an empty ref part to get at a
  91  reflog entry of the current branch. For example, if you are on
  92  branch 'blabla' then '@\{1\}' means the same as 'blabla@\{1\}'.
  93
  94'@{-<n>}', e.g. '@{-1}'::
  95  The construct '@{-<n>}' means the <n>th branch/commit checked out
  96  before the current one.
  97
  98'[<branchname>]@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
  99  The suffix '@\{upstream\}' to a branchname (short form '<branchname>@\{u\}')
 100  refers to the branch that the branch specified by branchname is set to build on
 101  top of (configured with `branch.<name>.remote` and
 102  `branch.<name>.merge`).  A missing branchname defaults to the
 103  current one. These suffixes are also accepted when spelled in uppercase, and
 104  they mean the same thing no matter the case.
 105
 106'[<branchname>]@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::
 107  The suffix '@\{push}' reports the branch "where we would push to" if
 108  `git push` were run while `branchname` was checked out (or the current
 109  `HEAD` if no branchname is specified). Since our push destination is
 110  in a remote repository, of course, we report the local tracking branch
 111  that corresponds to that branch (i.e., something in 'refs/remotes/').
 112+
 113Here's an example to make it more clear:
 114+
 115------------------------------
 116$ git config push.default current
 117$ git config remote.pushdefault myfork
 118$ git checkout -b mybranch origin/master
 119
 120$ git rev-parse --symbolic-full-name @{upstream}
 121refs/remotes/origin/master
 122
 123$ git rev-parse --symbolic-full-name @{push}
 124refs/remotes/myfork/mybranch
 125------------------------------
 126+
 127Note in the example that we set up a triangular workflow, where we pull
 128from one location and push to another. In a non-triangular workflow,
 129'@\{push}' is the same as '@\{upstream}', and there is no need for it.
 130+
 131This suffix is also accepted when spelled in uppercase, and means the same
 132thing no matter the case.
 133
 134'<rev>{caret}[<n>]', e.g. 'HEAD{caret}, v1.5.1{caret}0'::
 135  A suffix '{caret}' to a revision parameter means the first parent of
 136  that commit object.  '{caret}<n>' means the <n>th parent (i.e.
 137  '<rev>{caret}'
 138  is equivalent to '<rev>{caret}1').  As a special rule,
 139  '<rev>{caret}0' means the commit itself and is used when '<rev>' is the
 140  object name of a tag object that refers to a commit object.
 141
 142'<rev>{tilde}[<n>]', e.g. 'HEAD{tilde}, master{tilde}3'::
 143  A suffix '{tilde}' to a revision parameter means the first parent of
 144  that commit object.
 145  A suffix '{tilde}<n>' to a revision parameter means the commit
 146  object that is the <n>th generation ancestor of the named
 147  commit object, following only the first parents.  I.e. '<rev>{tilde}3' is
 148  equivalent to '<rev>{caret}{caret}{caret}' which is equivalent to
 149  '<rev>{caret}1{caret}1{caret}1'.  See below for an illustration of
 150  the usage of this form.
 151
 152'<rev>{caret}{<type>}', e.g. 'v0.99.8{caret}\{commit\}'::
 153  A suffix '{caret}' followed by an object type name enclosed in
 154  brace pair means dereference the object at '<rev>' recursively until
 155  an object of type '<type>' is found or the object cannot be
 156  dereferenced anymore (in which case, barf).
 157  For example, if '<rev>' is a commit-ish, '<rev>{caret}\{commit\}'
 158  describes the corresponding commit object.
 159  Similarly, if '<rev>' is a tree-ish, '<rev>{caret}\{tree\}'
 160  describes the corresponding tree object.
 161  '<rev>{caret}0'
 162  is a short-hand for '<rev>{caret}\{commit\}'.
 163+
 164'<rev>{caret}\{object\}' can be used to make sure '<rev>' names an
 165object that exists, without requiring '<rev>' to be a tag, and
 166without dereferencing '<rev>'; because a tag is already an object,
 167it does not have to be dereferenced even once to get to an object.
 168+
 169'<rev>{caret}\{tag\}' can be used to ensure that '<rev>' identifies an
 170existing tag object.
 171
 172'<rev>{caret}{}', e.g. 'v0.99.8{caret}{}'::
 173  A suffix '{caret}' followed by an empty brace pair
 174  means the object could be a tag,
 175  and dereference the tag recursively until a non-tag object is
 176  found.
 177
 178'<rev>{caret}{/<text>}', e.g. 'HEAD^{/fix nasty bug}'::
 179  A suffix '{caret}' to a revision parameter, followed by a brace
 180  pair that contains a text led by a slash,
 181  is the same as the ':/fix nasty bug' syntax below except that
 182  it returns the youngest matching commit which is reachable from
 183  the '<rev>' before '{caret}'.
 184
 185':/<text>', e.g. ':/fix nasty bug'::
 186  A colon, followed by a slash, followed by a text, names
 187  a commit whose commit message matches the specified regular expression.
 188  This name returns the youngest matching commit which is
 189  reachable from any ref. The regular expression can match any part of the
 190  commit message. To match messages starting with a string, one can use
 191  e.g. ':/^foo'. The special sequence ':/!' is reserved for modifiers to what
 192  is matched. ':/!-foo' performs a negative match, while ':/!!foo' matches a
 193  literal '!' character, followed by 'foo'. Any other sequence beginning with
 194  ':/!' is reserved for now.
 195  Depending on the given text, the shell's word splitting rules might
 196  require additional quoting.
 197
 198'<rev>:<path>', e.g. 'HEAD:README', ':README', 'master:./README'::
 199  A suffix ':' followed by a path names the blob or tree
 200  at the given path in the tree-ish object named by the part
 201  before the colon.
 202  ':path' (with an empty part before the colon)
 203  is a special case of the syntax described next: content
 204  recorded in the index at the given path.
 205  A path starting with './' or '../' is relative to the current working directory.
 206  The given path will be converted to be relative to the working tree's root directory.
 207  This is most useful to address a blob or tree from a commit or tree that has
 208  the same tree structure as the working tree.
 209
 210':<n>:<path>', e.g. ':0:README', ':README'::
 211  A colon, optionally followed by a stage number (0 to 3) and a
 212  colon, followed by a path, names a blob object in the
 213  index at the given path. A missing stage number (and the colon
 214  that follows it) names a stage 0 entry. During a merge, stage
 215  1 is the common ancestor, stage 2 is the target branch's version
 216  (typically the current branch), and stage 3 is the version from
 217  the branch which is being merged.
 218
 219Here is an illustration, by Jon Loeliger.  Both commit nodes B
 220and C are parents of commit node A.  Parent commits are ordered
 221left-to-right.
 222
 223........................................
 224G   H   I   J
 225 \ /     \ /
 226  D   E   F
 227   \  |  / \
 228    \ | /   |
 229     \|/    |
 230      B     C
 231       \   /
 232        \ /
 233         A
 234........................................
 235
 236    A =      = A^0
 237    B = A^   = A^1     = A~1
 238    C = A^2  = A^2
 239    D = A^^  = A^1^1   = A~2
 240    E = B^2  = A^^2
 241    F = B^3  = A^^3
 242    G = A^^^ = A^1^1^1 = A~3
 243    H = D^2  = B^^2    = A^^^2  = A~2^2
 244    I = F^   = B^3^    = A^^3^
 245    J = F^2  = B^3^2   = A^^3^2
 246
 247
 248SPECIFYING RANGES
 249-----------------
 250
 251History traversing commands such as `git log` operate on a set
 252of commits, not just a single commit.
 253
 254For these commands,
 255specifying a single revision, using the notation described in the
 256previous section, means the set of commits `reachable` from the given
 257commit.
 258
 259A commit's reachable set is the commit itself and the commits in
 260its ancestry chain.
 261
 262
 263Commit Exclusions
 264~~~~~~~~~~~~~~~~~
 265
 266'{caret}<rev>' (caret) Notation::
 267 To exclude commits reachable from a commit, a prefix '{caret}'
 268 notation is used.  E.g. '{caret}r1 r2' means commits reachable
 269 from 'r2' but exclude the ones reachable from 'r1' (i.e. 'r1' and
 270 its ancestors).
 271
 272Dotted Range Notations
 273~~~~~~~~~~~~~~~~~~~~~~
 274
 275The '..' (two-dot) Range Notation::
 276 The '{caret}r1 r2' set operation appears so often that there is a shorthand
 277 for it.  When you have two commits 'r1' and 'r2' (named according
 278 to the syntax explained in SPECIFYING REVISIONS above), you can ask
 279 for commits that are reachable from r2 excluding those that are reachable
 280 from r1 by '{caret}r1 r2' and it can be written as 'r1..r2'.
 281
 282The '...' (three-dot) Symmetric Difference Notation::
 283 A similar notation 'r1\...r2' is called symmetric difference
 284 of 'r1' and 'r2' and is defined as
 285 'r1 r2 --not $(git merge-base --all r1 r2)'.
 286 It is the set of commits that are reachable from either one of
 287 'r1' (left side) or 'r2' (right side) but not from both.
 288
 289In these two shorthand notations, you can omit one end and let it default to HEAD.
 290For example, 'origin..' is a shorthand for 'origin..HEAD' and asks "What
 291did I do since I forked from the origin branch?"  Similarly, '..origin'
 292is a shorthand for 'HEAD..origin' and asks "What did the origin do since
 293I forked from them?"  Note that '..' would mean 'HEAD..HEAD' which is an
 294empty range that is both reachable and unreachable from HEAD.
 295
 296Other <rev>{caret} Parent Shorthand Notations
 297~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 298Three other shorthands exist, particularly useful for merge commits,
 299for naming a set that is formed by a commit and its parent commits.
 300
 301The 'r1{caret}@' notation means all parents of 'r1'.
 302
 303The 'r1{caret}!' notation includes commit 'r1' but excludes all of its parents.
 304By itself, this notation denotes the single commit 'r1'.
 305
 306The '<rev>{caret}-[<n>]' notation includes '<rev>' but excludes the <n>th
 307parent (i.e. a shorthand for '<rev>{caret}<n>..<rev>'), with '<n>' = 1 if
 308not given. This is typically useful for merge commits where you
 309can just pass '<commit>{caret}-' to get all the commits in the branch
 310that was merged in merge commit '<commit>' (including '<commit>'
 311itself).
 312
 313While '<rev>{caret}<n>' was about specifying a single commit parent, these
 314three notations also consider its parents. For example you can say
 315'HEAD{caret}2{caret}@', however you cannot say 'HEAD{caret}@{caret}2'.
 316
 317Revision Range Summary
 318----------------------
 319
 320'<rev>'::
 321        Include commits that are reachable from <rev> (i.e. <rev> and its
 322        ancestors).
 323
 324'{caret}<rev>'::
 325        Exclude commits that are reachable from <rev> (i.e. <rev> and its
 326        ancestors).
 327
 328'<rev1>..<rev2>'::
 329        Include commits that are reachable from <rev2> but exclude
 330        those that are reachable from <rev1>.  When either <rev1> or
 331        <rev2> is omitted, it defaults to `HEAD`.
 332
 333'<rev1>\...<rev2>'::
 334        Include commits that are reachable from either <rev1> or
 335        <rev2> but exclude those that are reachable from both.  When
 336        either <rev1> or <rev2> is omitted, it defaults to `HEAD`.
 337
 338'<rev>{caret}@', e.g. 'HEAD{caret}@'::
 339  A suffix '{caret}' followed by an at sign is the same as listing
 340  all parents of '<rev>' (meaning, include anything reachable from
 341  its parents, but not the commit itself).
 342
 343'<rev>{caret}!', e.g. 'HEAD{caret}!'::
 344  A suffix '{caret}' followed by an exclamation mark is the same
 345  as giving commit '<rev>' and then all its parents prefixed with
 346  '{caret}' to exclude them (and their ancestors).
 347
 348'<rev>{caret}-<n>', e.g. 'HEAD{caret}-, HEAD{caret}-2'::
 349        Equivalent to '<rev>{caret}<n>..<rev>', with '<n>' = 1 if not
 350        given.
 351
 352Here are a handful of examples using the Loeliger illustration above,
 353with each step in the notation's expansion and selection carefully
 354spelt out:
 355
 356....
 357   Args   Expanded arguments    Selected commits
 358   D                            G H D
 359   D F                          G H I J D F
 360   ^G D                         H D
 361   ^D B                         E I J F B
 362   ^D B C                       E I J F B C
 363   C                            I J F C
 364   B..C   = ^B C                C
 365   B...C  = B ^F C              G H D E B C
 366   B^-    = B^..B
 367          = ^B^1 B              E I J F B
 368   C^@    = C^1
 369          = F                   I J F
 370   B^@    = B^1 B^2 B^3
 371          = D E F               D G H E F I J
 372   C^!    = C ^C^@
 373          = C ^C^1
 374          = C ^F                C
 375   B^!    = B ^B^@
 376          = B ^B^1 ^B^2 ^B^3
 377          = B ^D ^E ^F          B
 378   F^! D  = F ^I ^J D           G H D F
 379....