1GIT-REV-PARSE(1) Git Manual GIT-REV-PARSE(1)
2
6 git-rev-parse - Pick out and massage parameters
7
9 git rev-parse [<options>] <args>...
10
12 Many Git porcelainish commands take mixture of flags (i.e. parameters
13 that begin with a dash -) and parameters meant for the underlying git
14 rev-list command they use internally and flags and parameters for the
15 other commands they use downstream of git rev-list. This command is
16 used to distinguish between them.
17
19 Operation Modes
20 Each of these options must appear first on the command line.
21 --parseopt
23 Use git rev-parse in option parsing mode (see PARSEOPT section
24 below).
25 --sq-quote
27 Use git rev-parse in shell quoting mode (see SQ-QUOTE section
28 below). In contrast to the --sq option below, this mode does only
29 quoting. Nothing else is done to command input.
30 Options for --parseopt
32 --keep-dashdash
33 Only meaningful in --parseopt mode. Tells the option parser to echo
34 out the first -- met instead of skipping it.
35 --stop-at-non-option
37 Only meaningful in --parseopt mode. Lets the option parser stop at
38 the first non-option argument. This can be used to parse
39 sub-commands that take options themselves.
40 --stuck-long
42 Only meaningful in --parseopt mode. Output the options in their
43 long form if available, and with their arguments stuck.
44 Options for Filtering
46 --revs-only
47 Do not output flags and parameters not meant for git rev-list
48 command.
49 --no-revs
51 Do not output flags and parameters meant for git rev-list command.
52 --flags
54 Do not output non-flag parameters.
55 --no-flags
57 Do not output flag parameters.
58 Options for Output
60 --default <arg>
61 If there is no parameter given by the user, use <arg> instead.
62 --prefix <arg>
64 Behave as if git rev-parse was invoked from the <arg> subdirectory
65 of the working tree. Any relative filenames are resolved as if they
66 are prefixed by <arg> and will be printed in that form.
67 This can be used to convert arguments to a command run in a
69 subdirectory so that they can still be used after moving to the
70 top-level of the repository. For example:
71 prefix=$(git rev-parse --show-prefix)
73 cd "$(git rev-parse --show-toplevel)"
74 # rev-parse provides the -- needed for 'set'
75 eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")"
76 --verify
78 Verify that exactly one parameter is provided, and that it can be
79 turned into a raw 20-byte SHA-1 that can be used to access the
80 object database. If so, emit it to the standard output; otherwise,
81 error out.
82 If you want to make sure that the output actually names an object
84 in your object database and/or can be used as a specific type of
85 object you require, you can add the ^{type} peeling operator to the
86 parameter. For example, git rev-parse "$VAR^{commit}" will make
87 sure $VAR names an existing object that is a commit-ish (i.e. a
88 commit, or an annotated tag that points at a commit). To make sure
89 that $VAR names an existing object of any type, git rev-parse
90 "$VAR^{object}" can be used.
91 -q, --quiet
93 Only meaningful in --verify mode. Do not output an error message if
94 the first argument is not a valid object name; instead exit with
95 non-zero status silently. SHA-1s for valid object names are printed
96 to stdout on success.
97 --sq
99 Usually the output is made one line per flag and parameter. This
100 option makes output a single line, properly quoted for consumption
101 by shell. Useful when you expect your parameter to contain
102 whitespaces and newlines (e.g. when using pickaxe -S with git
103 diff-*). In contrast to the --sq-quote option, the command input is
104 still interpreted as usual.
105 --short[=length]
107 Same as --verify but shortens the object name to a unique prefix
108 with at least length characters. The minimum length is 4, the
109 default is the effective value of the core.abbrev configuration
110 variable (see git-config(1)).
111 --not
113 When showing object names, prefix them with ^ and strip ^ prefix
114 from the object names that already have one.
115 --abbrev-ref[=(strict|loose)]
117 A non-ambiguous short name of the objects name. The option
118 core.warnAmbiguousRefs is used to select the strict abbreviation
119 mode.
120 --symbolic
122 Usually the object names are output in SHA-1 form (with possible ^
123 prefix); this option makes them output in a form as close to the
124 original input as possible.
125 --symbolic-full-name
127 This is similar to --symbolic, but it omits input that are not refs
128 (i.e. branch or tag names; or more explicitly disambiguating
129 "heads/master" form, when you want to name the "master" branch when
130 there is an unfortunately named tag "master"), and show them as
131 full refnames (e.g. "refs/heads/master").
132 Options for Objects
134 --all
135 Show all refs found in refs/.
136 --branches[=pattern], --tags[=pattern], --remotes[=pattern]
138 Show all branches, tags, or remote-tracking branches, respectively
139 (i.e., refs found in refs/heads, refs/tags, or refs/remotes,
140 respectively).
141 If a pattern is given, only refs matching the given shell glob are
143 shown. If the pattern does not contain a globbing character (?, *,
144 or [), it is turned into a prefix match by appending /*.
145 --glob=pattern
147 Show all refs matching the shell glob pattern pattern. If the
148 pattern does not start with refs/, this is automatically prepended.
149 If the pattern does not contain a globbing character (?, *, or [),
150 it is turned into a prefix match by appending /*.
151 --exclude=<glob-pattern>
153 Do not include refs matching <glob-pattern> that the next --all,
154 --branches, --tags, --remotes, or --glob would otherwise consider.
155 Repetitions of this option accumulate exclusion patterns up to the
156 next --all, --branches, --tags, --remotes, or --glob option (other
157 options or arguments do not clear accumulated patterns).
158 The patterns given should not begin with refs/heads, refs/tags, or
160 refs/remotes when applied to --branches, --tags, or --remotes,
161 respectively, and they must begin with refs/ when applied to --glob
162 or --all. If a trailing /* is intended, it must be given
163 explicitly.
164 --disambiguate=<prefix>
166 Show every object whose name begins with the given prefix. The
167 <prefix> must be at least 4 hexadecimal digits long to avoid
168 listing each and every object in the repository by mistake.
169 Options for Files
171 --local-env-vars
172 List the GIT_* environment variables that are local to the
173 repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
174 Only the names of the variables are listed, not their value, even
175 if they are set.
176 --git-dir
178 Show $GIT_DIR if defined. Otherwise show the path to the .git
179 directory. The path shown, when relative, is relative to the
180 current working directory.
181 If $GIT_DIR is not defined and the current directory is not
183 detected to lie in a Git repository or work tree print a message to
184 stderr and exit with nonzero status.
185 --absolute-git-dir
187 Like --git-dir, but its output is always the canonicalized absolute
188 path.
189 --git-common-dir
191 Show $GIT_COMMON_DIR if defined, else $GIT_DIR.
192 --is-inside-git-dir
194 When the current working directory is below the repository
195 directory print "true", otherwise "false".
196 --is-inside-work-tree
198 When the current working directory is inside the work tree of the
199 repository print "true", otherwise "false".
200 --is-bare-repository
202 When the repository is bare print "true", otherwise "false".
203 --is-shallow-repository
205 When the repository is shallow print "true", otherwise "false".
206 --resolve-git-dir <path>
208 Check if <path> is a valid repository or a gitfile that points at a
209 valid repository, and print the location of the repository. If
210 <path> is a gitfile then the resolved path to the real repository
211 is printed.
212 --git-path <path>
214 Resolve "$GIT_DIR/<path>" and takes other path relocation variables
215 such as $GIT_OBJECT_DIRECTORY, $GIT_INDEX_FILE... into account. For
216 example, if $GIT_OBJECT_DIRECTORY is set to /foo/bar then "git
217 rev-parse --git-path objects/abc" returns /foo/bar/abc.
218 --show-cdup
220 When the command is invoked from a subdirectory, show the path of
221 the top-level directory relative to the current directory
222 (typically a sequence of "../", or an empty string).
223 --show-prefix
225 When the command is invoked from a subdirectory, show the path of
226 the current directory relative to the top-level directory.
227 --show-toplevel
229 Show the absolute path of the top-level directory of the working
230 tree. If there is no working tree, report an error.
231 --show-superproject-working-tree
233 Show the absolute path of the root of the superproject’s working
234 tree (if exists) that uses the current repository as its submodule.
235 Outputs nothing if the current repository is not used as a
236 submodule by any project.
237 --shared-index-path
239 Show the path to the shared index file in split index mode, or
240 empty if not in split-index mode.
241 --show-object-format[=(storage|input|output)]
243 Show the object format (hash algorithm) used for the repository for
244 storage inside the .git directory, input, or output. For input,
245 multiple algorithms may be printed, space-separated. If not
246 specified, the default is "storage".
247 Other Options
249 --since=datestring, --after=datestring
250 Parse the date string, and output the corresponding --max-age=
251 parameter for git rev-list.
252 --until=datestring, --before=datestring
254 Parse the date string, and output the corresponding --min-age=
255 parameter for git rev-list.
256 <args>...
258 Flags and parameters to be parsed.
259
261 A revision parameter <rev> typically, but not necessarily, names a
262 commit object. It uses what is called an extended SHA-1 syntax. Here
263 are various ways to spell object names. The ones listed near the end of
264 this list name trees and blobs contained in a commit.
265 Note
267 This document shows the "raw" syntax as seen by git. The shell and
268 other UIs might require additional quoting to protect special
269 characters and to avoid word splitting.
270 <sha1>, e.g. dae86e1950b1277e545cee180551750029cfe735, dae86e
272 The full SHA-1 object name (40-byte hexadecimal string), or a
273 leading substring that is unique within the repository. E.g.
274 dae86e1950b1277e545cee180551750029cfe735 and dae86e both name the
275 same commit object if there is no other object in your repository
276 whose object name starts with dae86e.
277 <describeOutput>, e.g. v1.7.4.2-679-g3bee7fb
279 Output from git describe; i.e. a closest tag, optionally followed
280 by a dash and a number of commits, followed by a dash, a g, and an
281 abbreviated object name.
282 <refname>, e.g. master, heads/master, refs/heads/master
284 A symbolic ref name. E.g. master typically means the commit object
285 referenced by refs/heads/master. If you happen to have both
286 heads/master and tags/master, you can explicitly say heads/master
287 to tell Git which one you mean. When ambiguous, a <refname> is
288 disambiguated by taking the first match in the following rules:
289 1. If $GIT_DIR/<refname> exists, that is what you mean (this is
291 usually useful only for HEAD, FETCH_HEAD, ORIG_HEAD, MERGE_HEAD
292 and CHERRY_PICK_HEAD);
293 2. otherwise, refs/<refname> if it exists;
295 3. otherwise, refs/tags/<refname> if it exists;
297 4. otherwise, refs/heads/<refname> if it exists;
299 5. otherwise, refs/remotes/<refname> if it exists;
301 6. otherwise, refs/remotes/<refname>/HEAD if it exists.
303 HEAD names the commit on which you based the changes in the
305 working tree. FETCH_HEAD records the branch which you fetched
306 from a remote repository with your last git fetch invocation.
307 ORIG_HEAD is created by commands that move your HEAD in a
308 drastic way, to record the position of the HEAD before their
309 operation, so that you can easily change the tip of the branch
310 back to the state before you ran them. MERGE_HEAD records the
311 commit(s) which you are merging into your branch when you run
312 git merge. CHERRY_PICK_HEAD records the commit which you are
313 cherry-picking when you run git cherry-pick.
314 Note that any of the refs/* cases above may come either from
316 the $GIT_DIR/refs directory or from the $GIT_DIR/packed-refs
317 file. While the ref name encoding is unspecified, UTF-8 is
318 preferred as some output processing may assume ref names in
319 UTF-8.
320 @
322 @ alone is a shortcut for HEAD.
323 [<refname>]@{<date>}, e.g. master@{yesterday}, HEAD@{5 minutes ago}
325 A ref followed by the suffix @ with a date specification enclosed
326 in a brace pair (e.g. {yesterday}, {1 month 2 weeks 3 days 1 hour
327 1 second ago} or {1979-02-26 18:30:00}) specifies the value of the
328 ref at a prior point in time. This suffix may only be used
329 immediately following a ref name and the ref must have an existing
330 log ($GIT_DIR/logs/<ref>). Note that this looks up the state of
331 your local ref at a given time; e.g., what was in your local master
332 branch last week. If you want to look at commits made during
333 certain times, see --since and --until.
334 <refname>@{<n>}, e.g. master@{1}
336 A ref followed by the suffix @ with an ordinal specification
337 enclosed in a brace pair (e.g. {1}, {15}) specifies the n-th prior
338 value of that ref. For example master@{1} is the immediate prior
339 value of master while master@{5} is the 5th prior value of master.
340 This suffix may only be used immediately following a ref name and
341 the ref must have an existing log ($GIT_DIR/logs/<refname>).
342 @{<n>}, e.g. @{1}
344 You can use the @ construct with an empty ref part to get at a
345 reflog entry of the current branch. For example, if you are on
346 branch blabla then @{1} means the same as blabla@{1}.
347 @{-<n>}, e.g. @{-1}
349 The construct @{-<n>} means the <n>th branch/commit checked out
350 before the current one.
351 [<branchname>]@{upstream}, e.g. master@{upstream}, @{u}
353 The suffix @{upstream} to a branchname (short form
354 <branchname>@{u}) refers to the branch that the branch specified by
355 branchname is set to build on top of (configured with
356 branch.<name>.remote and branch.<name>.merge). A missing branchname
357 defaults to the current one. These suffixes are also accepted when
358 spelled in uppercase, and they mean the same thing no matter the
359 case.
360 [<branchname>]@{push}, e.g. master@{push}, @{push}
362 The suffix @{push} reports the branch "where we would push to" if
363 git push were run while branchname was checked out (or the current
364 HEAD if no branchname is specified). Since our push destination is
365 in a remote repository, of course, we report the local tracking
366 branch that corresponds to that branch (i.e., something in
367 refs/remotes/).
368 Here’s an example to make it more clear:
370 $ git config push.default current
372 $ git config remote.pushdefault myfork
373 $ git switch -c mybranch origin/master
374 $ git rev-parse --symbolic-full-name @{upstream}
376 refs/remotes/origin/master
377 $ git rev-parse --symbolic-full-name @{push}
379 refs/remotes/myfork/mybranch
380 Note in the example that we set up a triangular workflow, where we
382 pull from one location and push to another. In a non-triangular
383 workflow, @{push} is the same as @{upstream}, and there is no need
384 for it.
385 This suffix is also accepted when spelled in uppercase, and means
387 the same thing no matter the case.
388 <rev>^[<n>], e.g. HEAD^, v1.5.1^0
390 A suffix ^ to a revision parameter means the first parent of that
391 commit object. ^<n> means the <n>th parent (i.e. <rev>^ is
392 equivalent to <rev>^1). As a special rule, <rev>^0 means the commit
393 itself and is used when <rev> is the object name of a tag object
394 that refers to a commit object.
395 <rev>~[<n>], e.g. HEAD~, master~3
397 A suffix ~ to a revision parameter means the first parent of that
398 commit object. A suffix ~<n> to a revision parameter means the
399 commit object that is the <n>th generation ancestor of the named
400 commit object, following only the first parents. I.e. <rev>~3 is
401 equivalent to <rev>^^^ which is equivalent to <rev>^1^1^1. See
402 below for an illustration of the usage of this form.
403 <rev>^{<type>}, e.g. v0.99.8^{commit}
405 A suffix ^ followed by an object type name enclosed in brace pair
406 means dereference the object at <rev> recursively until an object
407 of type <type> is found or the object cannot be dereferenced
408 anymore (in which case, barf). For example, if <rev> is a
409 commit-ish, <rev>^{commit} describes the corresponding commit
410 object. Similarly, if <rev> is a tree-ish, <rev>^{tree} describes
411 the corresponding tree object. <rev>^0 is a short-hand for
412 <rev>^{commit}.
413 <rev>^{object} can be used to make sure <rev> names an object that
415 exists, without requiring <rev> to be a tag, and without
416 dereferencing <rev>; because a tag is already an object, it does
417 not have to be dereferenced even once to get to an object.
418 <rev>^{tag} can be used to ensure that <rev> identifies an existing
420 tag object.
421 <rev>^{}, e.g. v0.99.8^{}
423 A suffix ^ followed by an empty brace pair means the object could
424 be a tag, and dereference the tag recursively until a non-tag
425 object is found.
426 <rev>^{/<text>}, e.g. HEAD^{/fix nasty bug}
428 A suffix ^ to a revision parameter, followed by a brace pair that
429 contains a text led by a slash, is the same as the :/fix nasty bug
430 syntax below except that it returns the youngest matching commit
431 which is reachable from the <rev> before ^.
432 :/<text>, e.g. :/fix nasty bug
434 A colon, followed by a slash, followed by a text, names a commit
435 whose commit message matches the specified regular expression. This
436 name returns the youngest matching commit which is reachable from
437 any ref, including HEAD. The regular expression can match any part
438 of the commit message. To match messages starting with a string,
439 one can use e.g. :/^foo. The special sequence :/! is reserved for
440 modifiers to what is matched. :/!-foo performs a negative match,
441 while :/!!foo matches a literal ! character, followed by foo. Any
442 other sequence beginning with :/! is reserved for now. Depending
443 on the given text, the shell’s word splitting rules might require
444 additional quoting.
445 <rev>:<path>, e.g. HEAD:README, master:./README
447 A suffix : followed by a path names the blob or tree at the given
448 path in the tree-ish object named by the part before the colon. A
449 path starting with ./ or ../ is relative to the current working
450 directory. The given path will be converted to be relative to the
451 working tree’s root directory. This is most useful to address a
452 blob or tree from a commit or tree that has the same tree structure
453 as the working tree.
454 :[<n>:]<path>, e.g. :0:README, :README
456 A colon, optionally followed by a stage number (0 to 3) and a
457 colon, followed by a path, names a blob object in the index at the
458 given path. A missing stage number (and the colon that follows it)
459 names a stage 0 entry. During a merge, stage 1 is the common
460 ancestor, stage 2 is the target branch’s version (typically the
461 current branch), and stage 3 is the version from the branch which
462 is being merged.
463 Here is an illustration, by Jon Loeliger. Both commit nodes B and C are
465 parents of commit node A. Parent commits are ordered left-to-right.
466 G H I J
468 \ / \ /
469 D E F
470 \ | / \
471 \ | / |
472 \|/ |
473 B C
474 \ /
475 \ /
476 A
477 A = = A^0
479 B = A^ = A^1 = A~1
480 C = A^2 = A^2
481 D = A^^ = A^1^1 = A~2
482 E = B^2 = A^^2
483 F = B^3 = A^^3
484 G = A^^^ = A^1^1^1 = A~3
485 H = D^2 = B^^2 = A^^^2 = A~2^2
486 I = F^ = B^3^ = A^^3^
487 J = F^2 = B^3^2 = A^^3^2
488
490 History traversing commands such as git log operate on a set of
491 commits, not just a single commit.
492 For these commands, specifying a single revision, using the notation
494 described in the previous section, means the set of commits reachable
495 from the given commit.
496 A commit’s reachable set is the commit itself and the commits in its
498 ancestry chain.
499 Commit Exclusions
501 ^<rev> (caret) Notation
502 To exclude commits reachable from a commit, a prefix ^ notation is
503 used. E.g. ^r1 r2 means commits reachable from r2 but exclude the
504 ones reachable from r1 (i.e. r1 and its ancestors).
505 Dotted Range Notations
507 The .. (two-dot) Range Notation
508 The ^r1 r2 set operation appears so often that there is a shorthand
509 for it. When you have two commits r1 and r2 (named according to the
510 syntax explained in SPECIFYING REVISIONS above), you can ask for
511 commits that are reachable from r2 excluding those that are
512 reachable from r1 by ^r1 r2 and it can be written as r1..r2.
513 The ... (three-dot) Symmetric Difference Notation
515 A similar notation r1...r2 is called symmetric difference of r1 and
516 r2 and is defined as r1 r2 --not $(git merge-base --all r1 r2). It
517 is the set of commits that are reachable from either one of r1
518 (left side) or r2 (right side) but not from both.
519 In these two shorthand notations, you can omit one end and let it
521 default to HEAD. For example, origin.. is a shorthand for origin..HEAD
522 and asks "What did I do since I forked from the origin branch?"
523 Similarly, ..origin is a shorthand for HEAD..origin and asks "What did
524 the origin do since I forked from them?" Note that .. would mean
525 HEAD..HEAD which is an empty range that is both reachable and
526 unreachable from HEAD.
527 Other <rev>^ Parent Shorthand Notations
529 Three other shorthands exist, particularly useful for merge commits,
530 for naming a set that is formed by a commit and its parent commits.
531 The r1^@ notation means all parents of r1.
533 The r1^! notation includes commit r1 but excludes all of its parents.
535 By itself, this notation denotes the single commit r1.
536 The <rev>^-[<n>] notation includes <rev> but excludes the <n>th parent
538 (i.e. a shorthand for <rev>^<n>..<rev>), with <n> = 1 if not given.
539 This is typically useful for merge commits where you can just pass
540 <commit>^- to get all the commits in the branch that was merged in
541 merge commit <commit> (including <commit> itself).
542 While <rev>^<n> was about specifying a single commit parent, these
544 three notations also consider its parents. For example you can say
545 HEAD^2^@, however you cannot say HEAD^@^2.
546
548 <rev>
549 Include commits that are reachable from <rev> (i.e. <rev> and its
550 ancestors).
551 ^<rev>
553 Exclude commits that are reachable from <rev> (i.e. <rev> and its
554 ancestors).
555 <rev1>..<rev2>
557 Include commits that are reachable from <rev2> but exclude those
558 that are reachable from <rev1>. When either <rev1> or <rev2> is
559 omitted, it defaults to HEAD.
560 <rev1>...<rev2>
562 Include commits that are reachable from either <rev1> or <rev2> but
563 exclude those that are reachable from both. When either <rev1> or
564 <rev2> is omitted, it defaults to HEAD.
565 <rev>^@, e.g. HEAD^@
567 A suffix ^ followed by an at sign is the same as listing all
568 parents of <rev> (meaning, include anything reachable from its
569 parents, but not the commit itself).
570 <rev>^!, e.g. HEAD^!
572 A suffix ^ followed by an exclamation mark is the same as giving
573 commit <rev> and then all its parents prefixed with ^ to exclude
574 them (and their ancestors).
575 <rev>^-<n>, e.g. HEAD^-, HEAD^-2
577 Equivalent to <rev>^<n>..<rev>, with <n> = 1 if not given.
578 Here are a handful of examples using the Loeliger illustration above,
580 with each step in the notation’s expansion and selection carefully
581 spelt out:
582 Args Expanded arguments Selected commits
584 D G H D
585 D F G H I J D F
586 ^G D H D
587 ^D B E I J F B
588 ^D B C E I J F B C
589 C I J F C
590 B..C = ^B C C
591 B...C = B ^F C G H D E B C
592 B^- = B^..B
593 = ^B^1 B E I J F B
594 C^@ = C^1
595 = F I J F
596 B^@ = B^1 B^2 B^3
597 = D E F D G H E F I J
598 C^! = C ^C^@
599 = C ^C^1
600 = C ^F C
601 B^! = B ^B^@
602 = B ^B^1 ^B^2 ^B^3
603 = B ^D ^E ^F B
604 F^! D = F ^I ^J D G H D F
605
607 In --parseopt mode, git rev-parse helps massaging options to bring to
608 shell scripts the same facilities C builtins have. It works as an
609 option normalizer (e.g. splits single switches aggregate values), a bit
610 like getopt(1) does.
611 It takes on the standard input the specification of the options to
613 parse and understand, and echoes on the standard output a string
614 suitable for sh(1) eval to replace the arguments with normalized ones.
615 In case of error, it outputs usage on the standard error stream, and
616 exits with code 129.
617 Note: Make sure you quote the result when passing it to eval. See below
619 for an example.
620 Input Format
622 git rev-parse --parseopt input format is fully text based. It has two
623 parts, separated by a line that contains only --. The lines before the
624 separator (should be one or more) are used for the usage. The lines
625 after the separator describe the options.
626 Each line of options has this format:
628 <opt-spec><flags>*<arg-hint>? SP+ help LF
630 <opt-spec>
632 its format is the short option character, then the long option name
633 separated by a comma. Both parts are not required, though at least
634 one is necessary. May not contain any of the <flags> characters.
635 h,help, dry-run and f are examples of correct <opt-spec>.
636 <flags>
638 <flags> are of *, =, ? or !.
639 · Use = if the option takes an argument.
641 · Use ? to mean that the option takes an optional argument. You
643 probably want to use the --stuck-long mode to be able to
644 unambiguously parse the optional argument.
645 · Use * to mean that this option should not be listed in the
647 usage generated for the -h argument. It’s shown for --help-all
648 as documented in gitcli(7).
649 · Use ! to not make the corresponding negated long option
651 available.
652 <arg-hint>
654 <arg-hint>, if specified, is used as a name of the argument in the
655 help output, for options that take arguments. <arg-hint> is
656 terminated by the first whitespace. It is customary to use a dash
657 to separate words in a multi-word argument hint.
658 The remainder of the line, after stripping the spaces, is used as the
660 help associated to the option.
661 Blank lines are ignored, and lines that don’t match this specification
663 are used as option group headers (start the line with a space to create
664 such lines on purpose).
665 Example
667 OPTS_SPEC="\
668 some-command [<options>] <args>...
669 some-command does foo and bar!
671 --
672 h,help show the help
673 foo some nifty option --foo
675 bar= some cool option --bar with an argument
676 baz=arg another cool option --baz with a named argument
677 qux?path qux may take a path argument but has meaning by itself
678 An option group Header
680 C? option C with an optional argument"
681 eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"
683 Usage text
685 When "$@" is -h or --help in the above example, the following usage
686 text would be shown:
687 usage: some-command [<options>] <args>...
689 some-command does foo and bar!
691 -h, --help show the help
693 --foo some nifty option --foo
694 --bar ... some cool option --bar with an argument
695 --baz <arg> another cool option --baz with a named argument
696 --qux[=<path>] qux may take a path argument but has meaning by itself
697 An option group Header
699 -C[...] option C with an optional argument
700
702 In --sq-quote mode, git rev-parse echoes on the standard output a
703 single line suitable for sh(1) eval. This line is made by normalizing
704 the arguments following --sq-quote. Nothing other than quoting the
705 arguments is done.
706 If you want command input to still be interpreted as usual by git
708 rev-parse before the output is shell quoted, see the --sq option.
709 Example
711 $ cat >your-git-script.sh <<\EOF
712 #!/bin/sh
713 args=$(git rev-parse --sq-quote "$@") # quote user-supplied arguments
714 command="git frotz -n24 $args" # and use it inside a handcrafted
715 # command line
716 eval "$command"
717 EOF
718 $ sh your-git-script.sh "a b'c"
720
722 · Print the object name of the current commit:
723 $ git rev-parse --verify HEAD
725 · Print the commit object name from the revision in the $REV shell
727 variable:
728 $ git rev-parse --verify $REV^{commit}
730 This will error out if $REV is empty or not a valid revision.
732 · Similar to above:
734 $ git rev-parse --default master --verify $REV
736 but if $REV is empty, the commit object name from master will be
738 printed.
739
741 Part of the git(1) suite
742Git 2.26.2 2020-04-20 GIT-REV-PARSE(1)