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 underlying `git-rev-list` command they use internally
  19 and flags and parameters for other commands they use as the
  20 downstream of `git-rev-list`.  This command is used to
  21 distinguish between them.
  22
  23
  24 OPTIONS
  25 -------
  26 --revs-only::
  27         Do not output flags and parameters not meant for
  28         `git-rev-list` command.
  29
  30 --no-revs::
  31         Do not output flags and parameters meant for
  32         `git-rev-list` command.
  33
  34 --flags::
  35         Do not output non-flag parameters.
  36
  37 --no-flags::
  38         Do not output flag parameters.
  39
  40 --default <arg>::
  41         If there is no parameter given by the user, use `<arg>`
  42         instead.
  43
  44 --verify::
  45         The parameter given must be usable as a single, valid
  46         object name.  Otherwise barf and abort.
  47
  48 --sq::
  49         Usually the output is made one line per flag and
  50         parameter.  This option makes output a single line,
  51         properly quoted for consumption by shell.  Useful when
  52         you expect your parameter to contain whitespaces and
  53         newlines (e.g. when using pickaxe `-S` with
  54         `git-diff-\*`).
  55
  56 --not::
  57         When showing object names, prefix them with '{caret}' and
  58         strip '{caret}' prefix from the object names that already have
  59         one.
  60
  61 --symbolic::
  62         Usually the object names are output in SHA1 form (with
  63         possible '{caret}' prefix); this option makes them output in a
  64         form as close to the original input as possible.
  65
  66
  67 --all::
  68         Show all refs found in `$GIT_DIR/refs`.
  69
  70 --branches::
  71         Show branch refs found in `$GIT_DIR/refs/heads`.
  72
  73 --tags::
  74         Show tag refs found in `$GIT_DIR/refs/tags`.
  75
  76 --remotes::
  77         Show tag refs found in `$GIT_DIR/refs/remotes`.
  78
  79 --show-prefix::
  80         When the command is invoked from a subdirectory, show the
  81         path of the current directory relative to the top-level
  82         directory.
  83
  84 --show-cdup::
  85         When the command is invoked from a subdirectory, show the
  86         path of the top-level directory relative to the current
  87         directory (typically a sequence of "../", or an empty string).
  88
  89 --git-dir::
  90         Show `$GIT_DIR` if defined else show the path to the .git directory.
  91
  92 --short, --short=number::
  93         Instead of outputting the full SHA1 values of object names try to
  94         abbriviate them to a shorter unique name. When no length is specified
  95         7 is used. The minimum length is 4.
  96
  97 --since=datestring, --after=datestring::
  98         Parses the date string, and outputs corresponding
  99         --max-age= parameter for git-rev-list command.
 100
 101 --until=datestring, --before=datestring::
 102         Parses the date string, and outputs corresponding
 103         --min-age= parameter for git-rev-list command.
 104
 105 <args>...::
 106         Flags and parameters to be parsed.
 107
 108
 109 SPECIFYING REVISIONS
 110 --------------------
 111
 112 A revision parameter typically, but not necessarily, names a
 113 commit object.  They use what is called an 'extended SHA1'
 114 syntax.
 115
 116 * The full SHA1 object name (40-byte hexadecimal string), or
 117   a substring of such that is unique within the repository.
 118   E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
 119   name the same commit object if there are no other object in
 120   your repository whose object name starts with dae86e.
 121
 122 * A symbolic ref name.  E.g. 'master' typically means the commit
 123   object referenced by $GIT_DIR/refs/heads/master.  If you
 124   happen to have both heads/master and tags/master, you can
 125   explicitly say 'heads/master' to tell git which one you mean.
 126
 127 * A suffix '@' followed by a date specification such as 'yesterday'
 128   (24 hours ago) or '1 month 2 weeks 3 days 1 hour 1 second ago'
 129   to specify the value of the ref at a prior point in time.
 130   This suffix may only be used immediately following a ref name
 131   and the ref must have an existing log ($GIT_DIR/logs/<ref>).
 132
 133 * A suffix '{caret}' to a revision parameter means the first parent of
 134   that commit object.  '{caret}<n>' means the <n>th parent (i.e.
 135   'rev{caret}'
 136   is equivalent to 'rev{caret}1').  As a special rule,
 137   'rev{caret}0' means the commit itself and is used when 'rev' is the
 138   object name of a tag object that refers to a commit object.
 139
 140 * A suffix '~<n>' to a revision parameter means the commit
 141   object that is the <n>th generation grand-parent of the named
 142   commit object, following only the first parent.  I.e. rev~3 is
 143   equivalent to rev{caret}{caret}{caret} which is equivalent to\
 144   rev{caret}1{caret}1{caret}1.
 145
 146 * A suffix '{caret}' followed by an object type name enclosed in
 147   brace pair (e.g. `v0.99.8{caret}\{commit\}`) means the object
 148   could be a tag, and dereference the tag recursively until an
 149   object of that type is found or the object cannot be
 150   dereferenced anymore (in which case, barf).  `rev{caret}0`
 151   introduced earlier is a short-hand for `rev{caret}\{commit\}`.
 152
 153 * A suffix '{caret}' followed by an empty brace pair
 154   (e.g. `v0.99.8{caret}\{\}`) means the object could be a tag,
 155   and dereference the tag recursively until a non-tag object is
 156   found.
 157
 158 'git-rev-parse' also accepts a prefix '{caret}' to revision parameter,
 159 which is passed to 'git-rev-list'.  Two revision parameters
 160 concatenated with '..' is a short-hand for writing a range
 161 between them.  I.e. 'r1..r2' is equivalent to saying '{caret}r1 r2'
 162
 163 Here is an illustration, by Jon Loeliger.  Both node B and C are
 164 a commit parents of commit node A.  Parent commits are ordered
 165 left-to-right.
 166
 167     G   H   I   J
 168      \ /     \ /
 169       D   E   F
 170        \  |  /
 171         \ | /
 172          \|/
 173           B     C
 174            \   /
 175             \ /
 176              A
 177
 178     A =      = A^0
 179     B = A^   = A^1     = A~1
 180     C = A^2  = A^2
 181     D = A^^  = A^1^1   = A~2
 182     E = B^2  = A^^2
 183     F = B^3  = A^^3
 184     G = A^^^ = A^1^1^1 = A~3
 185     H = D^2  = B^^2    = A^^^2  = A~2^2
 186     I = F^   = B^3^    = A^^3^
 187     J = F^2  = B^3^2   = A^^3^2
 188
 189
 190 Author
 191 ------
 192 Written by Linus Torvalds <torvalds@osdl.org> and
 193 Junio C Hamano <junkio@cox.net>
 194
 195 Documentation
 196 --------------
 197 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 198
 199 GIT
 200 ---
 201 Part of the gitlink:git[7] suite
 202