Documentation/git-rev-parse.txt

   1 git-rev-parse(1)
   2 ================
   3
   4 NAME
   5 ----
   6 git-rev-parse - Pick out and massage parameters
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git rev-parse' [ --option ] <args>...
  12
  13 DESCRIPTION
  14 -----------
  15
  16 Many git porcelainish commands take mixture of flags
  17 (i.e. parameters that begin with a dash '-') and parameters
  18 meant for the underlying 'git-rev-list' command they use internally
  19 and flags and parameters for the other commands they use
  20 downstream of 'git-rev-list'.  This command is used to
  21 distinguish between them.
  22
  23
  24 OPTIONS
  25 -------
  26 --parseopt::
  27         Use 'git-rev-parse' in option parsing mode (see PARSEOPT section below).
  28
  29 --keep-dash-dash::
  30         Only meaningful in `--parseopt` mode. Tells the option parser to echo
  31         out the first `--` met instead of skipping it.
  32
  33 --revs-only::
  34         Do not output flags and parameters not meant for
  35         'git-rev-list' command.
  36
  37 --no-revs::
  38         Do not output flags and parameters meant for
  39         'git-rev-list' command.
  40
  41 --flags::
  42         Do not output non-flag parameters.
  43
  44 --no-flags::
  45         Do not output flag parameters.
  46
  47 --default <arg>::
  48         If there is no parameter given by the user, use `<arg>`
  49         instead.
  50
  51 --verify::
  52         The parameter given must be usable as a single, valid
  53         object name.  Otherwise barf and abort.
  54
  55 -q::
  56 --quiet::
  57         Only meaningful in `--verify` mode. Do not output an error
  58         message if the first argument is not a valid object name;
  59         instead exit with non-zero status silently.
  60
  61 --sq::
  62         Usually the output is made one line per flag and
  63         parameter.  This option makes output a single line,
  64         properly quoted for consumption by shell.  Useful when
  65         you expect your parameter to contain whitespaces and
  66         newlines (e.g. when using pickaxe `-S` with
  67         'git-diff-\*').
  68
  69 --not::
  70         When showing object names, prefix them with '{caret}' and
  71         strip '{caret}' prefix from the object names that already have
  72         one.
  73
  74 --symbolic::
  75         Usually the object names are output in SHA1 form (with
  76         possible '{caret}' prefix); this option makes them output in a
  77         form as close to the original input as possible.
  78
  79 --symbolic-full-name::
  80         This is similar to \--symbolic, but it omits input that
  81         are not refs (i.e. branch or tag names; or more
  82         explicitly disambiguating "heads/master" form, when you
  83         want to name the "master" branch when there is an
  84         unfortunately named tag "master"), and show them as full
  85         refnames (e.g. "refs/heads/master").
  86
  87 --all::
  88         Show all refs found in `$GIT_DIR/refs`.
  89
  90 --branches::
  91         Show branch refs found in `$GIT_DIR/refs/heads`.
  92
  93 --tags::
  94         Show tag refs found in `$GIT_DIR/refs/tags`.
  95
  96 --remotes::
  97         Show tag refs found in `$GIT_DIR/refs/remotes`.
  98
  99 --show-prefix::
 100         When the command is invoked from a subdirectory, show the
 101         path of the current directory relative to the top-level
 102         directory.
 103
 104 --show-cdup::
 105         When the command is invoked from a subdirectory, show the
 106         path of the top-level directory relative to the current
 107         directory (typically a sequence of "../", or an empty string).
 108
 109 --git-dir::
 110         Show `$GIT_DIR` if defined else show the path to the .git directory.
 111
 112 --is-inside-git-dir::
 113         When the current working directory is below the repository
 114         directory print "true", otherwise "false".
 115
 116 --is-inside-work-tree::
 117         When the current working directory is inside the work tree of the
 118         repository print "true", otherwise "false".
 119
 120 --is-bare-repository::
 121         When the repository is bare print "true", otherwise "false".
 122
 123 --short::
 124 --short=number::
 125         Instead of outputting the full SHA1 values of object names try to
 126         abbreviate them to a shorter unique name. When no length is specified
 127         7 is used. The minimum length is 4.
 128
 129 --since=datestring::
 130 --after=datestring::
 131         Parse the date string, and output the corresponding
 132         --max-age= parameter for 'git-rev-list'.
 133
 134 --until=datestring::
 135 --before=datestring::
 136         Parse the date string, and output the corresponding
 137         --min-age= parameter for 'git-rev-list'.
 138
 139 <args>...::
 140         Flags and parameters to be parsed.
 141
 142
 143 SPECIFYING REVISIONS
 144 --------------------
 145
 146 A revision parameter typically, but not necessarily, names a
 147 commit object.  They use what is called an 'extended SHA1'
 148 syntax.  Here are various ways to spell object names.  The
 149 ones listed near the end of this list are to name trees and
 150 blobs contained in a commit.
 151
 152 * The full SHA1 object name (40-byte hexadecimal string), or
 153   a substring of such that is unique within the repository.
 154   E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
 155   name the same commit object if there are no other object in
 156   your repository whose object name starts with dae86e.
 157
 158 * An output from 'git-describe'; i.e. a closest tag, followed by a
 159   dash, a `g`, and an abbreviated object name.
 160
 161 * A symbolic ref name.  E.g. 'master' typically means the commit
 162   object referenced by $GIT_DIR/refs/heads/master.  If you
 163   happen to have both heads/master and tags/master, you can
 164   explicitly say 'heads/master' to tell git which one you mean.
 165   When ambiguous, a `<name>` is disambiguated by taking the
 166   first match in the following rules:
 167
 168   . if `$GIT_DIR/<name>` exists, that is what you mean (this is usually
 169     useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD` and `MERGE_HEAD`);
 170
 171   . otherwise, `$GIT_DIR/refs/<name>` if exists;
 172
 173   . otherwise, `$GIT_DIR/refs/tags/<name>` if exists;
 174
 175   . otherwise, `$GIT_DIR/refs/heads/<name>` if exists;
 176
 177   . otherwise, `$GIT_DIR/refs/remotes/<name>` if exists;
 178
 179   . otherwise, `$GIT_DIR/refs/remotes/<name>/HEAD` if exists.
 180 +
 181 HEAD names the commit your changes in the working tree is based on.
 182 FETCH_HEAD records the branch you fetched from a remote repository
 183 with your last 'git-fetch' invocation.
 184 ORIG_HEAD is created by commands that moves your HEAD in a drastic
 185 way, to record the position of the HEAD before their operation, so that
 186 you can change the tip of the branch back to the state before you ran
 187 them easily.
 188 MERGE_HEAD records the commit(s) you are merging into your branch
 189 when you run 'git-merge'.
 190
 191 * A ref followed by the suffix '@' with a date specification
 192   enclosed in a brace
 193   pair (e.g. '\{yesterday\}', '\{1 month 2 weeks 3 days 1 hour 1
 194   second ago\}' or '\{1979-02-26 18:30:00\}') to specify the value
 195   of the ref at a prior point in time.  This suffix may only be
 196   used immediately following a ref name and the ref must have an
 197   existing log ($GIT_DIR/logs/<ref>). Note that this looks up the state
 198   of your *local* ref at a given time; e.g., what was in your local
 199   `master` branch last week. If you want to look at commits made during
 200   certain times, see `--since` and `--until`.
 201
 202 * A ref followed by the suffix '@' with an ordinal specification
 203   enclosed in a brace pair (e.g. '\{1\}', '\{15\}') to specify
 204   the n-th prior value of that ref.  For example 'master@\{1\}'
 205   is the immediate prior value of 'master' while 'master@\{5\}'
 206   is the 5th prior value of 'master'. This suffix may only be used
 207   immediately following a ref name and the ref must have an existing
 208   log ($GIT_DIR/logs/<ref>).
 209
 210 * You can use the '@' construct with an empty ref part to get at a
 211   reflog of the current branch. For example, if you are on the
 212   branch 'blabla', then '@\{1\}' means the same as 'blabla@\{1\}'.
 213
 214 * A suffix '{caret}' to a revision parameter means the first parent of
 215   that commit object.  '{caret}<n>' means the <n>th parent (i.e.
 216   'rev{caret}'
 217   is equivalent to 'rev{caret}1').  As a special rule,
 218   'rev{caret}0' means the commit itself and is used when 'rev' is the
 219   object name of a tag object that refers to a commit object.
 220
 221 * A suffix '{tilde}<n>' to a revision parameter means the commit
 222   object that is the <n>th generation grand-parent of the named
 223   commit object, following only the first parent.  I.e. rev~3 is
 224   equivalent to rev{caret}{caret}{caret} which is equivalent to
 225   rev{caret}1{caret}1{caret}1.  See below for a illustration of
 226   the usage of this form.
 227
 228 * A suffix '{caret}' followed by an object type name enclosed in
 229   brace pair (e.g. `v0.99.8{caret}\{commit\}`) means the object
 230   could be a tag, and dereference the tag recursively until an
 231   object of that type is found or the object cannot be
 232   dereferenced anymore (in which case, barf).  `rev{caret}0`
 233   introduced earlier is a short-hand for `rev{caret}\{commit\}`.
 234
 235 * A suffix '{caret}' followed by an empty brace pair
 236   (e.g. `v0.99.8{caret}\{\}`) means the object could be a tag,
 237   and dereference the tag recursively until a non-tag object is
 238   found.
 239
 240 * A colon, followed by a slash, followed by a text: this names
 241   a commit whose commit message starts with the specified text.
 242   This name returns the youngest matching commit which is
 243   reachable from any ref.  If the commit message starts with a
 244   '!', you have to repeat that;  the special sequence ':/!',
 245   followed by something else than '!' is reserved for now.
 246
 247 * A suffix ':' followed by a path; this names the blob or tree
 248   at the given path in the tree-ish object named by the part
 249   before the colon.
 250
 251 * A colon, optionally followed by a stage number (0 to 3) and a
 252   colon, followed by a path; this names a blob object in the
 253   index at the given path.  Missing stage number (and the colon
 254   that follows it) names a stage 0 entry. During a merge, stage
 255   1 is the common ancestor, stage 2 is the target branch's version
 256   (typically the current branch), and stage 3 is the version from
 257   the branch being merged.
 258
 259 Here is an illustration, by Jon Loeliger.  Both commit nodes B
 260 and C are parents of commit node A.  Parent commits are ordered
 261 left-to-right.
 262
 263 ........................................
 264 G   H   I   J
 265  \ /     \ /
 266   D   E   F
 267    \  |  / \
 268     \ | /   |
 269      \|/    |
 270       B     C
 271        \   /
 272         \ /
 273          A
 274 ........................................
 275
 276     A =      = A^0
 277     B = A^   = A^1     = A~1
 278     C = A^2  = A^2
 279     D = A^^  = A^1^1   = A~2
 280     E = B^2  = A^^2
 281     F = B^3  = A^^3
 282     G = A^^^ = A^1^1^1 = A~3
 283     H = D^2  = B^^2    = A^^^2  = A~2^2
 284     I = F^   = B^3^    = A^^3^
 285     J = F^2  = B^3^2   = A^^3^2
 286
 287
 288 SPECIFYING RANGES
 289 -----------------
 290
 291 History traversing commands such as 'git-log' operate on a set
 292 of commits, not just a single commit.  To these commands,
 293 specifying a single revision with the notation described in the
 294 previous section means the set of commits reachable from that
 295 commit, following the commit ancestry chain.
 296
 297 To exclude commits reachable from a commit, a prefix `{caret}`
 298 notation is used.  E.g. "`{caret}r1 r2`" means commits reachable
 299 from `r2` but exclude the ones reachable from `r1`.
 300
 301 This set operation appears so often that there is a shorthand
 302 for it.  When you have two commits `r1` and `r2` (named according
 303 to the syntax explained in SPECIFYING REVISIONS above), you can ask
 304 for commits that are reachable from r2 excluding those that are reachable
 305 from r1 by "`{caret}r1 r2`" and it can be written as "`r1..r2`".
 306
 307 A similar notation "`r1\...r2`" is called symmetric difference
 308 of `r1` and `r2` and is defined as
 309 "`r1 r2 --not $(git merge-base --all r1 r2)`".
 310 It is the set of commits that are reachable from either one of
 311 `r1` or `r2` but not from both.
 312
 313 Two other shorthands for naming a set that is formed by a commit
 314 and its parent commits exist.  The `r1{caret}@` notation means all
 315 parents of `r1`.  `r1{caret}!` includes commit `r1` but excludes
 316 all of its parents.
 317
 318 Here are a handful of examples:
 319
 320    D                G H D
 321    D F              G H I J D F
 322    ^G D             H D
 323    ^D B             E I J F B
 324    B...C            G H D E B C
 325    ^D B C           E I J F B C
 326    C^@              I J F
 327    F^! D            G H D F
 328
 329 PARSEOPT
 330 --------
 331
 332 In `--parseopt` mode, 'git-rev-parse' helps massaging options to bring to shell
 333 scripts the same facilities C builtins have. It works as an option normalizer
 334 (e.g. splits single switches aggregate values), a bit like `getopt(1)` does.
 335
 336 It takes on the standard input the specification of the options to parse and
 337 understand, and echoes on the standard output a line suitable for `sh(1)` `eval`
 338 to replace the arguments with normalized ones.  In case of error, it outputs
 339 usage on the standard error stream, and exits with code 129.
 340
 341 Input Format
 342 ~~~~~~~~~~~~
 343
 344 'git-rev-parse --parseopt' input format is fully text based. It has two parts,
 345 separated by a line that contains only `--`. The lines before the separator
 346 (should be more than one) are used for the usage.
 347 The lines after the separator describe the options.
 348
 349 Each line of options has this format:
 350
 351 ------------
 352 <opt_spec><flags>* SP+ help LF
 353 ------------
 354
 355 `<opt_spec>`::
 356         its format is the short option character, then the long option name
 357         separated by a comma. Both parts are not required, though at least one
 358         is necessary. `h,help`, `dry-run` and `f` are all three correct
 359         `<opt_spec>`.
 360
 361 `<flags>`::
 362         `<flags>` are of `*`, `=`, `?` or `!`.
 363         * Use `=` if the option takes an argument.
 364
 365         * Use `?` to mean that the option is optional (though its use is discouraged).
 366
 367         * Use `*` to mean that this option should not be listed in the usage
 368           generated for the `-h` argument. It's shown for `--help-all` as
 369           documented in linkgit:gitcli[7].
 370
 371         * Use `!` to not make the corresponding negated long option available.
 372
 373 The remainder of the line, after stripping the spaces, is used
 374 as the help associated to the option.
 375
 376 Blank lines are ignored, and lines that don't match this specification are used
 377 as option group headers (start the line with a space to create such
 378 lines on purpose).
 379
 380 Example
 381 ~~~~~~~
 382
 383 ------------
 384 OPTS_SPEC="\
 385 some-command [options] <args>...
 386
 387 some-command does foo and bar!
 388 --
 389 h,help    show the help
 390
 391 foo       some nifty option --foo
 392 bar=      some cool option --bar with an argument
 393
 394   An option group Header
 395 C?        option C with an optional argument"
 396
 397 eval `echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?`
 398 ------------
 399
 400 EXAMPLES
 401 --------
 402
 403 * Print the object name of the current commit:
 404 +
 405 ------------
 406 $ git rev-parse --verify HEAD
 407 ------------
 408
 409 * Print the commit object name from the revision in the $REV shell variable:
 410 +
 411 ------------
 412 $ git rev-parse --verify $REV
 413 ------------
 414 +
 415 This will error out if $REV is empty or not a valid revision.
 416
 417 * Same as above:
 418 +
 419 ------------
 420 $ git rev-parse --default master --verify $REV
 421 ------------
 422 +
 423 but if $REV is empty, the commit object name from master will be printed.
 424
 425
 426 Author
 427 ------
 428 Written by Linus Torvalds <torvalds@osdl.org> .
 429 Junio C Hamano <junkio@cox.net> and Pierre Habouzit <madcoder@debian.org>
 430
 431 Documentation
 432 --------------
 433 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 434
 435 GIT
 436 ---
 437 Part of the linkgit:git[1] suite