Merge commit 'refs/top-bases/girocco' into girocco
[git/repo.git] / Documentation / git-rev-parse.txt
blob2921da320d2b84df4d15ec2745e6d94093dd6907
1 git-rev-parse(1)
2 ================
4 NAME
5 ----
6 git-rev-parse - Pick out and massage parameters
9 SYNOPSIS
10 --------
11 'git rev-parse' [ --option ] <args>...
13 DESCRIPTION
14 -----------
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.
24 OPTIONS
25 -------
26 --parseopt::
27         Use 'git-rev-parse' in option parsing mode (see PARSEOPT section below).
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.
33 --revs-only::
34         Do not output flags and parameters not meant for
35         'git-rev-list' command.
37 --no-revs::
38         Do not output flags and parameters meant for
39         'git-rev-list' command.
41 --flags::
42         Do not output non-flag parameters.
44 --no-flags::
45         Do not output flag parameters.
47 --default <arg>::
48         If there is no parameter given by the user, use `<arg>`
49         instead.
51 --verify::
52         The parameter given must be usable as a single, valid
53         object name.  Otherwise barf and abort.
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.
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-\*').
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.
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.
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").
87 --all::
88         Show all refs found in `$GIT_DIR/refs`.
90 --branches::
91         Show branch refs found in `$GIT_DIR/refs/heads`.
93 --tags::
94         Show tag refs found in `$GIT_DIR/refs/tags`.
96 --remotes::
97         Show tag refs found in `$GIT_DIR/refs/remotes`.
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.
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).
109 --git-dir::
110         Show `$GIT_DIR` if defined else show the path to the .git directory.
112 --is-inside-git-dir::
113         When the current working directory is below the repository
114         directory print "true", otherwise "false".
116 --is-inside-work-tree::
117         When the current working directory is inside the work tree of the
118         repository print "true", otherwise "false".
120 --is-bare-repository::
121         When the repository is bare print "true", otherwise "false".
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.
129 --since=datestring::
130 --after=datestring::
131         Parse the date string, and output the corresponding
132         --max-age= parameter for 'git-rev-list'.
134 --until=datestring::
135 --before=datestring::
136         Parse the date string, and output the corresponding
137         --min-age= parameter for 'git-rev-list'.
139 <args>...::
140         Flags and parameters to be parsed.
143 SPECIFYING REVISIONS
144 --------------------
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.
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.
158 * An output from 'git-describe'; i.e. a closest tag, optionally
159   followed by a dash and a number of commits, followed by a dash, a
160   `g`, and an abbreviated object name.
162 * A symbolic ref name.  E.g. 'master' typically means the commit
163   object referenced by $GIT_DIR/refs/heads/master.  If you
164   happen to have both heads/master and tags/master, you can
165   explicitly say 'heads/master' to tell git which one you mean.
166   When ambiguous, a `<name>` is disambiguated by taking the
167   first match in the following rules:
169   . if `$GIT_DIR/<name>` exists, that is what you mean (this is usually
170     useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD` and `MERGE_HEAD`);
172   . otherwise, `$GIT_DIR/refs/<name>` if exists;
174   . otherwise, `$GIT_DIR/refs/tags/<name>` if exists;
176   . otherwise, `$GIT_DIR/refs/heads/<name>` if exists;
178   . otherwise, `$GIT_DIR/refs/remotes/<name>` if exists;
180   . otherwise, `$GIT_DIR/refs/remotes/<name>/HEAD` if exists.
182 HEAD names the commit your changes in the working tree is based on.
183 FETCH_HEAD records the branch you fetched from a remote repository
184 with your last 'git-fetch' invocation.
185 ORIG_HEAD is created by commands that moves your HEAD in a drastic
186 way, to record the position of the HEAD before their operation, so that
187 you can change the tip of the branch back to the state before you ran
188 them easily.
189 MERGE_HEAD records the commit(s) you are merging into your branch
190 when you run 'git-merge'.
192 * A ref followed by the suffix '@' with a date specification
193   enclosed in a brace
194   pair (e.g. '\{yesterday\}', '\{1 month 2 weeks 3 days 1 hour 1
195   second ago\}' or '\{1979-02-26 18:30:00\}') to specify the value
196   of the ref at a prior point in time.  This suffix may only be
197   used immediately following a ref name and the ref must have an
198   existing log ($GIT_DIR/logs/<ref>). Note that this looks up the state
199   of your *local* ref at a given time; e.g., what was in your local
200   `master` branch last week. If you want to look at commits made during
201   certain times, see `--since` and `--until`.
203 * A ref followed by the suffix '@' with an ordinal specification
204   enclosed in a brace pair (e.g. '\{1\}', '\{15\}') to specify
205   the n-th prior value of that ref.  For example 'master@\{1\}'
206   is the immediate prior value of 'master' while 'master@\{5\}'
207   is the 5th prior value of 'master'. This suffix may only be used
208   immediately following a ref name and the ref must have an existing
209   log ($GIT_DIR/logs/<ref>).
211 * You can use the '@' construct with an empty ref part to get at a
212   reflog of the current branch. For example, if you are on the
213   branch 'blabla', then '@\{1\}' means the same as 'blabla@\{1\}'.
215 * A suffix '{caret}' to a revision parameter means the first parent of
216   that commit object.  '{caret}<n>' means the <n>th parent (i.e.
217   'rev{caret}'
218   is equivalent to 'rev{caret}1').  As a special rule,
219   'rev{caret}0' means the commit itself and is used when 'rev' is the
220   object name of a tag object that refers to a commit object.
222 * A suffix '{tilde}<n>' to a revision parameter means the commit
223   object that is the <n>th generation grand-parent of the named
224   commit object, following only the first parent.  I.e. rev~3 is
225   equivalent to rev{caret}{caret}{caret} which is equivalent to
226   rev{caret}1{caret}1{caret}1.  See below for a illustration of
227   the usage of this form.
229 * A suffix '{caret}' followed by an object type name enclosed in
230   brace pair (e.g. `v0.99.8{caret}\{commit\}`) means the object
231   could be a tag, and dereference the tag recursively until an
232   object of that type is found or the object cannot be
233   dereferenced anymore (in which case, barf).  `rev{caret}0`
234   introduced earlier is a short-hand for `rev{caret}\{commit\}`.
236 * A suffix '{caret}' followed by an empty brace pair
237   (e.g. `v0.99.8{caret}\{\}`) means the object could be a tag,
238   and dereference the tag recursively until a non-tag object is
239   found.
241 * A colon, followed by a slash, followed by a text: this names
242   a commit whose commit message starts with the specified text.
243   This name returns the youngest matching commit which is
244   reachable from any ref.  If the commit message starts with a
245   '!', you have to repeat that;  the special sequence ':/!',
246   followed by something else than '!' is reserved for now.
248 * A suffix ':' followed by a path; this names the blob or tree
249   at the given path in the tree-ish object named by the part
250   before the colon.
252 * A colon, optionally followed by a stage number (0 to 3) and a
253   colon, followed by a path; this names a blob object in the
254   index at the given path.  Missing stage number (and the colon
255   that follows it) names a stage 0 entry. During a merge, stage
256   1 is the common ancestor, stage 2 is the target branch's version
257   (typically the current branch), and stage 3 is the version from
258   the branch being merged.
260 Here is an illustration, by Jon Loeliger.  Both commit nodes B
261 and C are parents of commit node A.  Parent commits are ordered
262 left-to-right.
264 ........................................
265 G   H   I   J
266  \ /     \ /
267   D   E   F
268    \  |  / \
269     \ | /   |
270      \|/    |
271       B     C
272        \   /
273         \ /
274          A
275 ........................................
277     A =      = A^0
278     B = A^   = A^1     = A~1
279     C = A^2  = A^2
280     D = A^^  = A^1^1   = A~2
281     E = B^2  = A^^2
282     F = B^3  = A^^3
283     G = A^^^ = A^1^1^1 = A~3
284     H = D^2  = B^^2    = A^^^2  = A~2^2
285     I = F^   = B^3^    = A^^3^
286     J = F^2  = B^3^2   = A^^3^2
289 SPECIFYING RANGES
290 -----------------
292 History traversing commands such as 'git-log' operate on a set
293 of commits, not just a single commit.  To these commands,
294 specifying a single revision with the notation described in the
295 previous section means the set of commits reachable from that
296 commit, following the commit ancestry chain.
298 To exclude commits reachable from a commit, a prefix `{caret}`
299 notation is used.  E.g. "`{caret}r1 r2`" means commits reachable
300 from `r2` but exclude the ones reachable from `r1`.
302 This set operation appears so often that there is a shorthand
303 for it.  When you have two commits `r1` and `r2` (named according
304 to the syntax explained in SPECIFYING REVISIONS above), you can ask
305 for commits that are reachable from r2 excluding those that are reachable
306 from r1 by "`{caret}r1 r2`" and it can be written as "`r1..r2`".
308 A similar notation "`r1\...r2`" is called symmetric difference
309 of `r1` and `r2` and is defined as
310 "`r1 r2 --not $(git merge-base --all r1 r2)`".
311 It is the set of commits that are reachable from either one of
312 `r1` or `r2` but not from both.
314 Two other shorthands for naming a set that is formed by a commit
315 and its parent commits exist.  The `r1{caret}@` notation means all
316 parents of `r1`.  `r1{caret}!` includes commit `r1` but excludes
317 all of its parents.
319 Here are a handful of examples:
321    D                G H D
322    D F              G H I J D F
323    ^G D             H D
324    ^D B             E I J F B
325    B...C            G H D E B C
326    ^D B C           E I J F B C
327    C^@              I J F
328    F^! D            G H D F
330 PARSEOPT
331 --------
333 In `--parseopt` mode, 'git-rev-parse' helps massaging options to bring to shell
334 scripts the same facilities C builtins have. It works as an option normalizer
335 (e.g. splits single switches aggregate values), a bit like `getopt(1)` does.
337 It takes on the standard input the specification of the options to parse and
338 understand, and echoes on the standard output a line suitable for `sh(1)` `eval`
339 to replace the arguments with normalized ones.  In case of error, it outputs
340 usage on the standard error stream, and exits with code 129.
342 Input Format
343 ~~~~~~~~~~~~
345 'git-rev-parse --parseopt' input format is fully text based. It has two parts,
346 separated by a line that contains only `--`. The lines before the separator
347 (should be more than one) are used for the usage.
348 The lines after the separator describe the options.
350 Each line of options has this format:
352 ------------
353 <opt_spec><flags>* SP+ help LF
354 ------------
356 `<opt_spec>`::
357         its format is the short option character, then the long option name
358         separated by a comma. Both parts are not required, though at least one
359         is necessary. `h,help`, `dry-run` and `f` are all three correct
360         `<opt_spec>`.
362 `<flags>`::
363         `<flags>` are of `*`, `=`, `?` or `!`.
364         * Use `=` if the option takes an argument.
366         * Use `?` to mean that the option is optional (though its use is discouraged).
368         * Use `*` to mean that this option should not be listed in the usage
369           generated for the `-h` argument. It's shown for `--help-all` as
370           documented in linkgit:gitcli[7].
372         * Use `!` to not make the corresponding negated long option available.
374 The remainder of the line, after stripping the spaces, is used
375 as the help associated to the option.
377 Blank lines are ignored, and lines that don't match this specification are used
378 as option group headers (start the line with a space to create such
379 lines on purpose).
381 Example
382 ~~~~~~~
384 ------------
385 OPTS_SPEC="\
386 some-command [options] <args>...
388 some-command does foo and bar!
390 h,help    show the help
392 foo       some nifty option --foo
393 bar=      some cool option --bar with an argument
395   An option group Header
396 C?        option C with an optional argument"
398 eval `echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?`
399 ------------
401 EXAMPLES
402 --------
404 * Print the object name of the current commit:
406 ------------
407 $ git rev-parse --verify HEAD
408 ------------
410 * Print the commit object name from the revision in the $REV shell variable:
412 ------------
413 $ git rev-parse --verify $REV
414 ------------
416 This will error out if $REV is empty or not a valid revision.
418 * Same as above:
420 ------------
421 $ git rev-parse --default master --verify $REV
422 ------------
424 but if $REV is empty, the commit object name from master will be printed.
427 Author
428 ------
429 Written by Linus Torvalds <torvalds@osdl.org> .
430 Junio C Hamano <gitster@pobox.com> and Pierre Habouzit <madcoder@debian.org>
432 Documentation
433 --------------
434 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
438 Part of the linkgit:git[1] suite