6 git-rev-parse - Pick out and massage parameters
11 'git rev-parse' [ --option ] <args>...
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.
27 Use 'git rev-parse' in option parsing mode (see PARSEOPT section below).
30 Only meaningful in `--parseopt` mode. Tells the option parser to echo
31 out the first `--` met instead of skipping it.
33 --stop-at-non-option::
34 Only meaningful in `--parseopt` mode. Lets the option parser stop at
35 the first non-option argument. This can be used to parse sub-commands
36 that take options themselves.
39 Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE
40 section below). In contrast to the `--sq` option below, this
41 mode does only quoting. Nothing else is done to command input.
44 Do not output flags and parameters not meant for
45 'git rev-list' command.
48 Do not output flags and parameters meant for
49 'git rev-list' command.
52 Do not output non-flag parameters.
55 Do not output flag parameters.
58 If there is no parameter given by the user, use `<arg>`
62 The parameter given must be usable as a single, valid
63 object name. Otherwise barf and abort.
67 Only meaningful in `--verify` mode. Do not output an error
68 message if the first argument is not a valid object name;
69 instead exit with non-zero status silently.
72 Usually the output is made one line per flag and
73 parameter. This option makes output a single line,
74 properly quoted for consumption by shell. Useful when
75 you expect your parameter to contain whitespaces and
76 newlines (e.g. when using pickaxe `-S` with
77 'git diff-\*'). In contrast to the `--sq-quote` option,
78 the command input is still interpreted as usual.
81 When showing object names, prefix them with '{caret}' and
82 strip '{caret}' prefix from the object names that already have
86 Usually the object names are output in SHA1 form (with
87 possible '{caret}' prefix); this option makes them output in a
88 form as close to the original input as possible.
90 --symbolic-full-name::
91 This is similar to \--symbolic, but it omits input that
92 are not refs (i.e. branch or tag names; or more
93 explicitly disambiguating "heads/master" form, when you
94 want to name the "master" branch when there is an
95 unfortunately named tag "master"), and show them as full
96 refnames (e.g. "refs/heads/master").
98 --abbrev-ref[={strict|loose}]::
99 A non-ambiguous short name of the objects name.
100 The option core.warnAmbiguousRefs is used to select the strict
104 Show all refs found in `refs/`.
106 --branches[=pattern]::
108 --remotes[=pattern]::
109 Show all branches, tags, or remote-tracking branches,
110 respectively (i.e., refs found in `refs/heads`,
111 `refs/tags`, or `refs/remotes`, respectively).
113 If a `pattern` is given, only refs matching the given shell glob are
114 shown. If the pattern does not contain a globbing character (`?`,
115 `\*`, or `[`), it is turned into a prefix match by appending `/\*`.
118 Show all refs matching the shell glob pattern `pattern`. If
119 the pattern does not start with `refs/`, this is automatically
120 prepended. If the pattern does not contain a globbing
121 character (`?`, `\*`, or `[`), it is turned into a prefix
122 match by appending `/\*`.
125 Show the absolute path of the top-level directory.
128 When the command is invoked from a subdirectory, show the
129 path of the current directory relative to the top-level
133 When the command is invoked from a subdirectory, show the
134 path of the top-level directory relative to the current
135 directory (typically a sequence of "../", or an empty string).
138 Show `$GIT_DIR` if defined else show the path to the .git directory.
140 --is-inside-git-dir::
141 When the current working directory is below the repository
142 directory print "true", otherwise "false".
144 --is-inside-work-tree::
145 When the current working directory is inside the work tree of the
146 repository print "true", otherwise "false".
148 --is-bare-repository::
149 When the repository is bare print "true", otherwise "false".
152 List the GIT_* environment variables that are local to the
153 repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
154 Only the names of the variables are listed, not their value,
155 even if they are set.
159 Instead of outputting the full SHA1 values of object names try to
160 abbreviate them to a shorter unique name. When no length is specified
161 7 is used. The minimum length is 4.
165 Parse the date string, and output the corresponding
166 --max-age= parameter for 'git rev-list'.
169 --before=datestring::
170 Parse the date string, and output the corresponding
171 --min-age= parameter for 'git rev-list'.
174 Flags and parameters to be parsed.
180 A revision parameter typically, but not necessarily, names a
181 commit object. They use what is called an 'extended SHA1'
182 syntax. Here are various ways to spell object names. The
183 ones listed near the end of this list are to name trees and
184 blobs contained in a commit.
186 * The full SHA1 object name (40-byte hexadecimal string), or
187 a substring of such that is unique within the repository.
188 E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
189 name the same commit object if there are no other object in
190 your repository whose object name starts with dae86e.
192 * An output from 'git describe'; i.e. a closest tag, optionally
193 followed by a dash and a number of commits, followed by a dash, a
194 `g`, and an abbreviated object name.
196 * A symbolic ref name. E.g. 'master' typically means the commit
197 object referenced by refs/heads/master. If you
198 happen to have both heads/master and tags/master, you can
199 explicitly say 'heads/master' to tell git which one you mean.
200 When ambiguous, a `<name>` is disambiguated by taking the
201 first match in the following rules:
203 . if `$GIT_DIR/<name>` exists, that is what you mean (this is usually
204 useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD` and `MERGE_HEAD`);
206 . otherwise, `refs/<name>` if exists;
208 . otherwise, `refs/tags/<name>` if exists;
210 . otherwise, `refs/heads/<name>` if exists;
212 . otherwise, `refs/remotes/<name>` if exists;
214 . otherwise, `refs/remotes/<name>/HEAD` if exists.
216 HEAD names the commit your changes in the working tree is based on.
217 FETCH_HEAD records the branch you fetched from a remote repository
218 with your last 'git fetch' invocation.
219 ORIG_HEAD is created by commands that moves your HEAD in a drastic
220 way, to record the position of the HEAD before their operation, so that
221 you can change the tip of the branch back to the state before you ran
223 MERGE_HEAD records the commit(s) you are merging into your branch
224 when you run 'git merge'.
226 Note that any of the `refs/*` cases above may come either from
227 the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file.
229 * A ref followed by the suffix '@' with a date specification
231 pair (e.g. '\{yesterday\}', '\{1 month 2 weeks 3 days 1 hour 1
232 second ago\}' or '\{1979-02-26 18:30:00\}') to specify the value
233 of the ref at a prior point in time. This suffix may only be
234 used immediately following a ref name and the ref must have an
235 existing log ($GIT_DIR/logs/<ref>). Note that this looks up the state
236 of your *local* ref at a given time; e.g., what was in your local
237 `master` branch last week. If you want to look at commits made during
238 certain times, see `--since` and `--until`.
240 * A ref followed by the suffix '@' with an ordinal specification
241 enclosed in a brace pair (e.g. '\{1\}', '\{15\}') to specify
242 the n-th prior value of that ref. For example 'master@\{1\}'
243 is the immediate prior value of 'master' while 'master@\{5\}'
244 is the 5th prior value of 'master'. This suffix may only be used
245 immediately following a ref name and the ref must have an existing
246 log ($GIT_DIR/logs/<ref>).
248 * You can use the '@' construct with an empty ref part to get at a
249 reflog of the current branch. For example, if you are on the
250 branch 'blabla', then '@\{1\}' means the same as 'blabla@\{1\}'.
252 * The special construct '@\{-<n>\}' means the <n>th branch checked out
253 before the current one.
255 * The suffix '@\{upstream\}' to a ref (short form 'ref@\{u\}') refers to
256 the branch the ref is set to build on top of. Missing ref defaults
257 to the current branch.
259 * A suffix '{caret}' to a revision parameter means the first parent of
260 that commit object. '{caret}<n>' means the <n>th parent (i.e.
262 is equivalent to 'rev{caret}1'). As a special rule,
263 'rev{caret}0' means the commit itself and is used when 'rev' is the
264 object name of a tag object that refers to a commit object.
266 * A suffix '{tilde}<n>' to a revision parameter means the commit
267 object that is the <n>th generation grand-parent of the named
268 commit object, following only the first parent. I.e. rev~3 is
269 equivalent to rev{caret}{caret}{caret} which is equivalent to
270 rev{caret}1{caret}1{caret}1. See below for a illustration of
271 the usage of this form.
273 * A suffix '{caret}' followed by an object type name enclosed in
274 brace pair (e.g. `v0.99.8{caret}\{commit\}`) means the object
275 could be a tag, and dereference the tag recursively until an
276 object of that type is found or the object cannot be
277 dereferenced anymore (in which case, barf). `rev{caret}0`
278 introduced earlier is a short-hand for `rev{caret}\{commit\}`.
280 * A suffix '{caret}' followed by an empty brace pair
281 (e.g. `v0.99.8{caret}\{\}`) means the object could be a tag,
282 and dereference the tag recursively until a non-tag object is
285 * A colon, followed by a slash, followed by a text: this names
286 a commit whose commit message starts with the specified text.
287 This name returns the youngest matching commit which is
288 reachable from any ref. If the commit message starts with a
289 '!', you have to repeat that; the special sequence ':/!',
290 followed by something else than '!' is reserved for now.
292 * A suffix ':' followed by a path; this names the blob or tree
293 at the given path in the tree-ish object named by the part
294 before the colon. ":path" (with an empty part before the colon)
295 is a special case of the syntax described next: content
296 recorded in the index at the given path.
298 * A colon, optionally followed by a stage number (0 to 3) and a
299 colon, followed by a path; this names a blob object in the
300 index at the given path. Missing stage number (and the colon
301 that follows it) names a stage 0 entry. During a merge, stage
302 1 is the common ancestor, stage 2 is the target branch's version
303 (typically the current branch), and stage 3 is the version from
304 the branch being merged.
306 Here is an illustration, by Jon Loeliger. Both commit nodes B
307 and C are parents of commit node A. Parent commits are ordered
310 ........................................
321 ........................................
326 D = A^^ = A^1^1 = A~2
329 G = A^^^ = A^1^1^1 = A~3
330 H = D^2 = B^^2 = A^^^2 = A~2^2
331 I = F^ = B^3^ = A^^3^
332 J = F^2 = B^3^2 = A^^3^2
338 History traversing commands such as 'git log' operate on a set
339 of commits, not just a single commit. To these commands,
340 specifying a single revision with the notation described in the
341 previous section means the set of commits reachable from that
342 commit, following the commit ancestry chain.
344 To exclude commits reachable from a commit, a prefix `{caret}`
345 notation is used. E.g. `{caret}r1 r2` means commits reachable
346 from `r2` but exclude the ones reachable from `r1`.
348 This set operation appears so often that there is a shorthand
349 for it. When you have two commits `r1` and `r2` (named according
350 to the syntax explained in SPECIFYING REVISIONS above), you can ask
351 for commits that are reachable from r2 excluding those that are reachable
352 from r1 by `{caret}r1 r2` and it can be written as `r1..r2`.
354 A similar notation `r1\...r2` is called symmetric difference
355 of `r1` and `r2` and is defined as
356 `r1 r2 --not $(git merge-base --all r1 r2)`.
357 It is the set of commits that are reachable from either one of
358 `r1` or `r2` but not from both.
360 Two other shorthands for naming a set that is formed by a commit
361 and its parent commits exist. The `r1{caret}@` notation means all
362 parents of `r1`. `r1{caret}!` includes commit `r1` but excludes
365 Here are a handful of examples:
379 In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell
380 scripts the same facilities C builtins have. It works as an option normalizer
381 (e.g. splits single switches aggregate values), a bit like `getopt(1)` does.
383 It takes on the standard input the specification of the options to parse and
384 understand, and echoes on the standard output a line suitable for `sh(1)` `eval`
385 to replace the arguments with normalized ones. In case of error, it outputs
386 usage on the standard error stream, and exits with code 129.
391 'git rev-parse --parseopt' input format is fully text based. It has two parts,
392 separated by a line that contains only `--`. The lines before the separator
393 (should be more than one) are used for the usage.
394 The lines after the separator describe the options.
396 Each line of options has this format:
399 <opt_spec><flags>* SP+ help LF
403 its format is the short option character, then the long option name
404 separated by a comma. Both parts are not required, though at least one
405 is necessary. `h,help`, `dry-run` and `f` are all three correct
409 `<flags>` are of `*`, `=`, `?` or `!`.
410 * Use `=` if the option takes an argument.
412 * Use `?` to mean that the option is optional (though its use is discouraged).
414 * Use `*` to mean that this option should not be listed in the usage
415 generated for the `-h` argument. It's shown for `--help-all` as
416 documented in linkgit:gitcli[7].
418 * Use `!` to not make the corresponding negated long option available.
420 The remainder of the line, after stripping the spaces, is used
421 as the help associated to the option.
423 Blank lines are ignored, and lines that don't match this specification are used
424 as option group headers (start the line with a space to create such
432 some-command [options] <args>...
434 some-command does foo and bar!
438 foo some nifty option --foo
439 bar= some cool option --bar with an argument
441 An option group Header
442 C? option C with an optional argument"
444 eval `echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?`
450 In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a
451 single line suitable for `sh(1)` `eval`. This line is made by
452 normalizing the arguments following `--sq-quote`. Nothing other than
453 quoting the arguments is done.
455 If you want command input to still be interpreted as usual by
456 'git rev-parse' before the output is shell quoted, see the `--sq`
463 $ cat >your-git-script.sh <<\EOF
465 args=$(git rev-parse --sq-quote "$@") # quote user-supplied arguments
466 command="git frotz -n24 $args" # and use it inside a handcrafted
471 $ sh your-git-script.sh "a b'c"
477 * Print the object name of the current commit:
480 $ git rev-parse --verify HEAD
483 * Print the commit object name from the revision in the $REV shell variable:
486 $ git rev-parse --verify $REV
489 This will error out if $REV is empty or not a valid revision.
494 $ git rev-parse --default master --verify $REV
497 but if $REV is empty, the commit object name from master will be printed.
502 Written by Linus Torvalds <torvalds@osdl.org> .
503 Junio C Hamano <gitster@pobox.com> and Pierre Habouzit <madcoder@debian.org>
507 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
511 Part of the linkgit:git[1] suite