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 Note that if you are verifying a name from an untrusted source, it
93 is wise to use --end-of-options so that the name argument is not
94 mistaken for another option.
95 -q, --quiet
97 Only meaningful in --verify mode. Do not output an error message if
98 the first argument is not a valid object name; instead exit with
99 non-zero status silently. SHA-1s for valid object names are printed
100 to stdout on success.
101 --sq
103 Usually the output is made one line per flag and parameter. This
104 option makes output a single line, properly quoted for consumption
105 by shell. Useful when you expect your parameter to contain
106 whitespaces and newlines (e.g. when using pickaxe -S with git
107 diff-*). In contrast to the --sq-quote option, the command input is
108 still interpreted as usual.
109 --short[=length]
111 Same as --verify but shortens the object name to a unique prefix
112 with at least length characters. The minimum length is 4, the
113 default is the effective value of the core.abbrev configuration
114 variable (see git-config(1)).
115 --not
117 When showing object names, prefix them with ^ and strip ^ prefix
118 from the object names that already have one.
119 --abbrev-ref[=(strict|loose)]
121 A non-ambiguous short name of the objects name. The option
122 core.warnAmbiguousRefs is used to select the strict abbreviation
123 mode.
124 --symbolic
126 Usually the object names are output in SHA-1 form (with possible ^
127 prefix); this option makes them output in a form as close to the
128 original input as possible.
129 --symbolic-full-name
131 This is similar to --symbolic, but it omits input that are not refs
132 (i.e. branch or tag names; or more explicitly disambiguating
133 "heads/master" form, when you want to name the "master" branch when
134 there is an unfortunately named tag "master"), and show them as
135 full refnames (e.g. "refs/heads/master").
136 Options for Objects
138 --all
139 Show all refs found in refs/.
140 --branches[=pattern], --tags[=pattern], --remotes[=pattern]
142 Show all branches, tags, or remote-tracking branches, respectively
143 (i.e., refs found in refs/heads, refs/tags, or refs/remotes,
144 respectively).
145 If a pattern is given, only refs matching the given shell glob are
147 shown. If the pattern does not contain a globbing character (?, *,
148 or [), it is turned into a prefix match by appending /*.
149 --glob=pattern
151 Show all refs matching the shell glob pattern pattern. If the
152 pattern does not start with refs/, this is automatically prepended.
153 If the pattern does not contain a globbing character (?, *, or [),
154 it is turned into a prefix match by appending /*.
155 --exclude=<glob-pattern>
157 Do not include refs matching <glob-pattern> that the next --all,
158 --branches, --tags, --remotes, or --glob would otherwise consider.
159 Repetitions of this option accumulate exclusion patterns up to the
160 next --all, --branches, --tags, --remotes, or --glob option (other
161 options or arguments do not clear accumulated patterns).
162 The patterns given should not begin with refs/heads, refs/tags, or
164 refs/remotes when applied to --branches, --tags, or --remotes,
165 respectively, and they must begin with refs/ when applied to --glob
166 or --all. If a trailing /* is intended, it must be given
167 explicitly.
168 --disambiguate=<prefix>
170 Show every object whose name begins with the given prefix. The
171 <prefix> must be at least 4 hexadecimal digits long to avoid
172 listing each and every object in the repository by mistake.
173 Options for Files
175 --local-env-vars
176 List the GIT_* environment variables that are local to the
177 repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
178 Only the names of the variables are listed, not their value, even
179 if they are set.
180 --git-dir
182 Show $GIT_DIR if defined. Otherwise show the path to the .git
183 directory. The path shown, when relative, is relative to the
184 current working directory.
185 If $GIT_DIR is not defined and the current directory is not
187 detected to lie in a Git repository or work tree print a message to
188 stderr and exit with nonzero status.
189 --absolute-git-dir
191 Like --git-dir, but its output is always the canonicalized absolute
192 path.
193 --git-common-dir
195 Show $GIT_COMMON_DIR if defined, else $GIT_DIR.
196 --is-inside-git-dir
198 When the current working directory is below the repository
199 directory print "true", otherwise "false".
200 --is-inside-work-tree
202 When the current working directory is inside the work tree of the
203 repository print "true", otherwise "false".
204 --is-bare-repository
206 When the repository is bare print "true", otherwise "false".
207 --is-shallow-repository
209 When the repository is shallow print "true", otherwise "false".
210 --resolve-git-dir <path>
212 Check if <path> is a valid repository or a gitfile that points at a
213 valid repository, and print the location of the repository. If
214 <path> is a gitfile then the resolved path to the real repository
215 is printed.
216 --git-path <path>
218 Resolve "$GIT_DIR/<path>" and takes other path relocation variables
219 such as $GIT_OBJECT_DIRECTORY, $GIT_INDEX_FILE... into account. For
220 example, if $GIT_OBJECT_DIRECTORY is set to /foo/bar then "git
221 rev-parse --git-path objects/abc" returns /foo/bar/abc.
222 --show-cdup
224 When the command is invoked from a subdirectory, show the path of
225 the top-level directory relative to the current directory
226 (typically a sequence of "../", or an empty string).
227 --show-prefix
229 When the command is invoked from a subdirectory, show the path of
230 the current directory relative to the top-level directory.
231 --show-toplevel
233 Show the absolute path of the top-level directory of the working
234 tree. If there is no working tree, report an error.
235 --show-superproject-working-tree
237 Show the absolute path of the root of the superproject’s working
238 tree (if exists) that uses the current repository as its submodule.
239 Outputs nothing if the current repository is not used as a
240 submodule by any project.
241 --shared-index-path
243 Show the path to the shared index file in split index mode, or
244 empty if not in split-index mode.
245 --show-object-format[=(storage|input|output)]
247 Show the object format (hash algorithm) used for the repository for
248 storage inside the .git directory, input, or output. For input,
249 multiple algorithms may be printed, space-separated. If not
250 specified, the default is "storage".
251 Other Options
253 --since=datestring, --after=datestring
254 Parse the date string, and output the corresponding --max-age=
255 parameter for git rev-list.
256 --until=datestring, --before=datestring
258 Parse the date string, and output the corresponding --min-age=
259 parameter for git rev-list.
260 <args>...
262 Flags and parameters to be parsed.
263
265 A revision parameter <rev> typically, but not necessarily, names a
266 commit object. It uses what is called an extended SHA-1 syntax. Here
267 are various ways to spell object names. The ones listed near the end of
268 this list name trees and blobs contained in a commit.
269 Note
271 This document shows the "raw" syntax as seen by git. The shell and
272 other UIs might require additional quoting to protect special
273 characters and to avoid word splitting.
274 <sha1>, e.g. dae86e1950b1277e545cee180551750029cfe735, dae86e
276 The full SHA-1 object name (40-byte hexadecimal string), or a
277 leading substring that is unique within the repository. E.g.
278 dae86e1950b1277e545cee180551750029cfe735 and dae86e both name the
279 same commit object if there is no other object in your repository
280 whose object name starts with dae86e.
281 <describeOutput>, e.g. v1.7.4.2-679-g3bee7fb
283 Output from git describe; i.e. a closest tag, optionally followed
284 by a dash and a number of commits, followed by a dash, a g, and an
285 abbreviated object name.
286 <refname>, e.g. master, heads/master, refs/heads/master
288 A symbolic ref name. E.g. master typically means the commit object
289 referenced by refs/heads/master. If you happen to have both
290 heads/master and tags/master, you can explicitly say heads/master
291 to tell Git which one you mean. When ambiguous, a <refname> is
292 disambiguated by taking the first match in the following rules:
293 1. If $GIT_DIR/<refname> exists, that is what you mean (this is
295 usually useful only for HEAD, FETCH_HEAD, ORIG_HEAD, MERGE_HEAD
296 and CHERRY_PICK_HEAD);
297 2. otherwise, refs/<refname> if it exists;
299 3. otherwise, refs/tags/<refname> if it exists;
301 4. otherwise, refs/heads/<refname> if it exists;
303 5. otherwise, refs/remotes/<refname> if it exists;
305 6. otherwise, refs/remotes/<refname>/HEAD if it exists.
307 HEAD names the commit on which you based the changes in the
309 working tree. FETCH_HEAD records the branch which you fetched
310 from a remote repository with your last git fetch invocation.
311 ORIG_HEAD is created by commands that move your HEAD in a
312 drastic way, to record the position of the HEAD before their
313 operation, so that you can easily change the tip of the branch
314 back to the state before you ran them. MERGE_HEAD records the
315 commit(s) which you are merging into your branch when you run
316 git merge. CHERRY_PICK_HEAD records the commit which you are
317 cherry-picking when you run git cherry-pick.
318 Note that any of the refs/* cases above may come either from
320 the $GIT_DIR/refs directory or from the $GIT_DIR/packed-refs
321 file. While the ref name encoding is unspecified, UTF-8 is
322 preferred as some output processing may assume ref names in
323 UTF-8.
324 @
326 @ alone is a shortcut for HEAD.
327 [<refname>]@{<date>}, e.g. master@{yesterday}, HEAD@{5 minutes ago}
329 A ref followed by the suffix @ with a date specification enclosed
330 in a brace pair (e.g. {yesterday}, {1 month 2 weeks 3 days 1 hour
331 1 second ago} or {1979-02-26 18:30:00}) specifies the value of the
332 ref at a prior point in time. This suffix may only be used
333 immediately following a ref name and the ref must have an existing
334 log ($GIT_DIR/logs/<ref>). Note that this looks up the state of
335 your local ref at a given time; e.g., what was in your local master
336 branch last week. If you want to look at commits made during
337 certain times, see --since and --until.
338 <refname>@{<n>}, e.g. master@{1}
340 A ref followed by the suffix @ with an ordinal specification
341 enclosed in a brace pair (e.g. {1}, {15}) specifies the n-th prior
342 value of that ref. For example master@{1} is the immediate prior
343 value of master while master@{5} is the 5th prior value of master.
344 This suffix may only be used immediately following a ref name and
345 the ref must have an existing log ($GIT_DIR/logs/<refname>).
346 @{<n>}, e.g. @{1}
348 You can use the @ construct with an empty ref part to get at a
349 reflog entry of the current branch. For example, if you are on
350 branch blabla then @{1} means the same as blabla@{1}.
351 @{-<n>}, e.g. @{-1}
353 The construct @{-<n>} means the <n>th branch/commit checked out
354 before the current one.
355 [<branchname>]@{upstream}, e.g. master@{upstream}, @{u}
357 The suffix @{upstream} to a branchname (short form
358 <branchname>@{u}) refers to the branch that the branch specified by
359 branchname is set to build on top of (configured with
360 branch.<name>.remote and branch.<name>.merge). A missing branchname
361 defaults to the current one. These suffixes are also accepted when
362 spelled in uppercase, and they mean the same thing no matter the
363 case.
364 [<branchname>]@{push}, e.g. master@{push}, @{push}
366 The suffix @{push} reports the branch "where we would push to" if
367 git push were run while branchname was checked out (or the current
368 HEAD if no branchname is specified). Since our push destination is
369 in a remote repository, of course, we report the local tracking
370 branch that corresponds to that branch (i.e., something in
371 refs/remotes/).
372 Here’s an example to make it more clear:
374 $ git config push.default current
376 $ git config remote.pushdefault myfork
377 $ git switch -c mybranch origin/master
378 $ git rev-parse --symbolic-full-name @{upstream}
380 refs/remotes/origin/master
381 $ git rev-parse --symbolic-full-name @{push}
383 refs/remotes/myfork/mybranch
384 Note in the example that we set up a triangular workflow, where we
386 pull from one location and push to another. In a non-triangular
387 workflow, @{push} is the same as @{upstream}, and there is no need
388 for it.
389 This suffix is also accepted when spelled in uppercase, and means
391 the same thing no matter the case.
392 <rev>^[<n>], e.g. HEAD^, v1.5.1^0
394 A suffix ^ to a revision parameter means the first parent of that
395 commit object. ^<n> means the <n>th parent (i.e. <rev>^ is
396 equivalent to <rev>^1). As a special rule, <rev>^0 means the commit
397 itself and is used when <rev> is the object name of a tag object
398 that refers to a commit object.
399 <rev>~[<n>], e.g. HEAD~, master~3
401 A suffix ~ to a revision parameter means the first parent of that
402 commit object. A suffix ~<n> to a revision parameter means the
403 commit object that is the <n>th generation ancestor of the named
404 commit object, following only the first parents. I.e. <rev>~3 is
405 equivalent to <rev>^^^ which is equivalent to <rev>^1^1^1. See
406 below for an illustration of the usage of this form.
407 <rev>^{<type>}, e.g. v0.99.8^{commit}
409 A suffix ^ followed by an object type name enclosed in brace pair
410 means dereference the object at <rev> recursively until an object
411 of type <type> is found or the object cannot be dereferenced
412 anymore (in which case, barf). For example, if <rev> is a
413 commit-ish, <rev>^{commit} describes the corresponding commit
414 object. Similarly, if <rev> is a tree-ish, <rev>^{tree} describes
415 the corresponding tree object. <rev>^0 is a short-hand for
416 <rev>^{commit}.
417 <rev>^{object} can be used to make sure <rev> names an object that
419 exists, without requiring <rev> to be a tag, and without
420 dereferencing <rev>; because a tag is already an object, it does
421 not have to be dereferenced even once to get to an object.
422 <rev>^{tag} can be used to ensure that <rev> identifies an existing
424 tag object.
425 <rev>^{}, e.g. v0.99.8^{}
427 A suffix ^ followed by an empty brace pair means the object could
428 be a tag, and dereference the tag recursively until a non-tag
429 object is found.
430 <rev>^{/<text>}, e.g. HEAD^{/fix nasty bug}
432 A suffix ^ to a revision parameter, followed by a brace pair that
433 contains a text led by a slash, is the same as the :/fix nasty bug
434 syntax below except that it returns the youngest matching commit
435 which is reachable from the <rev> before ^.
436 :/<text>, e.g. :/fix nasty bug
438 A colon, followed by a slash, followed by a text, names a commit
439 whose commit message matches the specified regular expression. This
440 name returns the youngest matching commit which is reachable from
441 any ref, including HEAD. The regular expression can match any part
442 of the commit message. To match messages starting with a string,
443 one can use e.g. :/^foo. The special sequence :/! is reserved for
444 modifiers to what is matched. :/!-foo performs a negative match,
445 while :/!!foo matches a literal ! character, followed by foo. Any
446 other sequence beginning with :/! is reserved for now. Depending
447 on the given text, the shell’s word splitting rules might require
448 additional quoting.
449 <rev>:<path>, e.g. HEAD:README, master:./README
451 A suffix : followed by a path names the blob or tree at the given
452 path in the tree-ish object named by the part before the colon. A
453 path starting with ./ or ../ is relative to the current working
454 directory. The given path will be converted to be relative to the
455 working tree’s root directory. This is most useful to address a
456 blob or tree from a commit or tree that has the same tree structure
457 as the working tree.
458 :[<n>:]<path>, e.g. :0:README, :README
460 A colon, optionally followed by a stage number (0 to 3) and a
461 colon, followed by a path, names a blob object in the index at the
462 given path. A missing stage number (and the colon that follows it)
463 names a stage 0 entry. During a merge, stage 1 is the common
464 ancestor, stage 2 is the target branch’s version (typically the
465 current branch), and stage 3 is the version from the branch which
466 is being merged.
467 Here is an illustration, by Jon Loeliger. Both commit nodes B and C are
469 parents of commit node A. Parent commits are ordered left-to-right.
470 G H I J
472 \ / \ /
473 D E F
474 \ | / \
475 \ | / |
476 \|/ |
477 B C
478 \ /
479 \ /
480 A
481 A = = A^0
483 B = A^ = A^1 = A~1
484 C = = A^2
485 D = A^^ = A^1^1 = A~2
486 E = B^2 = A^^2
487 F = B^3 = A^^3
488 G = A^^^ = A^1^1^1 = A~3
489 H = D^2 = B^^2 = A^^^2 = A~2^2
490 I = F^ = B^3^ = A^^3^
491 J = F^2 = B^3^2 = A^^3^2
492
494 History traversing commands such as git log operate on a set of
495 commits, not just a single commit.
496 For these commands, specifying a single revision, using the notation
498 described in the previous section, means the set of commits reachable
499 from the given commit.
500 Specifying several revisions means the set of commits reachable from
502 any of the given commits.
503 A commit’s reachable set is the commit itself and the commits in its
505 ancestry chain.
506 Commit Exclusions
508 ^<rev> (caret) Notation
509 To exclude commits reachable from a commit, a prefix ^ notation is
510 used. E.g. ^r1 r2 means commits reachable from r2 but exclude the
511 ones reachable from r1 (i.e. r1 and its ancestors).
512 Dotted Range Notations
514 The .. (two-dot) Range Notation
515 The ^r1 r2 set operation appears so often that there is a shorthand
516 for it. When you have two commits r1 and r2 (named according to the
517 syntax explained in SPECIFYING REVISIONS above), you can ask for
518 commits that are reachable from r2 excluding those that are
519 reachable from r1 by ^r1 r2 and it can be written as r1..r2.
520 The ... (three-dot) Symmetric Difference Notation
522 A similar notation r1...r2 is called symmetric difference of r1 and
523 r2 and is defined as r1 r2 --not $(git merge-base --all r1 r2). It
524 is the set of commits that are reachable from either one of r1
525 (left side) or r2 (right side) but not from both.
526 In these two shorthand notations, you can omit one end and let it
528 default to HEAD. For example, origin.. is a shorthand for origin..HEAD
529 and asks "What did I do since I forked from the origin branch?"
530 Similarly, ..origin is a shorthand for HEAD..origin and asks "What did
531 the origin do since I forked from them?" Note that .. would mean
532 HEAD..HEAD which is an empty range that is both reachable and
533 unreachable from HEAD.
534 Other <rev>^ Parent Shorthand Notations
536 Three other shorthands exist, particularly useful for merge commits,
537 for naming a set that is formed by a commit and its parent commits.
538 The r1^@ notation means all parents of r1.
540 The r1^! notation includes commit r1 but excludes all of its parents.
542 By itself, this notation denotes the single commit r1.
543 The <rev>^-[<n>] notation includes <rev> but excludes the <n>th parent
545 (i.e. a shorthand for <rev>^<n>..<rev>), with <n> = 1 if not given.
546 This is typically useful for merge commits where you can just pass
547 <commit>^- to get all the commits in the branch that was merged in
548 merge commit <commit> (including <commit> itself).
549 While <rev>^<n> was about specifying a single commit parent, these
551 three notations also consider its parents. For example you can say
552 HEAD^2^@, however you cannot say HEAD^@^2.
553
555 <rev>
556 Include commits that are reachable from <rev> (i.e. <rev> and its
557 ancestors).
558 ^<rev>
560 Exclude commits that are reachable from <rev> (i.e. <rev> and its
561 ancestors).
562 <rev1>..<rev2>
564 Include commits that are reachable from <rev2> but exclude those
565 that are reachable from <rev1>. When either <rev1> or <rev2> is
566 omitted, it defaults to HEAD.
567 <rev1>...<rev2>
569 Include commits that are reachable from either <rev1> or <rev2> but
570 exclude those that are reachable from both. When either <rev1> or
571 <rev2> is omitted, it defaults to HEAD.
572 <rev>^@, e.g. HEAD^@
574 A suffix ^ followed by an at sign is the same as listing all
575 parents of <rev> (meaning, include anything reachable from its
576 parents, but not the commit itself).
577 <rev>^!, e.g. HEAD^!
579 A suffix ^ followed by an exclamation mark is the same as giving
580 commit <rev> and then all its parents prefixed with ^ to exclude
581 them (and their ancestors).
582 <rev>^-<n>, e.g. HEAD^-, HEAD^-2
584 Equivalent to <rev>^<n>..<rev>, with <n> = 1 if not given.
585 Here are a handful of examples using the Loeliger illustration above,
587 with each step in the notation’s expansion and selection carefully
588 spelt out:
589 Args Expanded arguments Selected commits
591 D G H D
592 D F G H I J D F
593 ^G D H D
594 ^D B E I J F B
595 ^D B C E I J F B C
596 C I J F C
597 B..C = ^B C C
598 B...C = B ^F C G H D E B C
599 B^- = B^..B
600 = ^B^1 B E I J F B
601 C^@ = C^1
602 = F I J F
603 B^@ = B^1 B^2 B^3
604 = D E F D G H E F I J
605 C^! = C ^C^@
606 = C ^C^1
607 = C ^F C
608 B^! = B ^B^@
609 = B ^B^1 ^B^2 ^B^3
610 = B ^D ^E ^F B
611 F^! D = F ^I ^J D G H D F
612
614 In --parseopt mode, git rev-parse helps massaging options to bring to
615 shell scripts the same facilities C builtins have. It works as an
616 option normalizer (e.g. splits single switches aggregate values), a bit
617 like getopt(1) does.
618 It takes on the standard input the specification of the options to
620 parse and understand, and echoes on the standard output a string
621 suitable for sh(1) eval to replace the arguments with normalized ones.
622 In case of error, it outputs usage on the standard error stream, and
623 exits with code 129.
624 Note: Make sure you quote the result when passing it to eval. See below
626 for an example.
627 Input Format
629 git rev-parse --parseopt input format is fully text based. It has two
630 parts, separated by a line that contains only --. The lines before the
631 separator (should be one or more) are used for the usage. The lines
632 after the separator describe the options.
633 Each line of options has this format:
635 <opt-spec><flags>*<arg-hint>? SP+ help LF
637 <opt-spec>
639 its format is the short option character, then the long option name
640 separated by a comma. Both parts are not required, though at least
641 one is necessary. May not contain any of the <flags> characters.
642 h,help, dry-run and f are examples of correct <opt-spec>.
643 <flags>
645 <flags> are of *, =, ? or !.
646 · Use = if the option takes an argument.
648 · Use ? to mean that the option takes an optional argument. You
650 probably want to use the --stuck-long mode to be able to
651 unambiguously parse the optional argument.
652 · Use * to mean that this option should not be listed in the
654 usage generated for the -h argument. It’s shown for --help-all
655 as documented in gitcli(7).
656 · Use ! to not make the corresponding negated long option
658 available.
659 <arg-hint>
661 <arg-hint>, if specified, is used as a name of the argument in the
662 help output, for options that take arguments. <arg-hint> is
663 terminated by the first whitespace. It is customary to use a dash
664 to separate words in a multi-word argument hint.
665 The remainder of the line, after stripping the spaces, is used as the
667 help associated to the option.
668 Blank lines are ignored, and lines that don’t match this specification
670 are used as option group headers (start the line with a space to create
671 such lines on purpose).
672 Example
674 OPTS_SPEC="\
675 some-command [<options>] <args>...
676 some-command does foo and bar!
678 --
679 h,help show the help
680 foo some nifty option --foo
682 bar= some cool option --bar with an argument
683 baz=arg another cool option --baz with a named argument
684 qux?path qux may take a path argument but has meaning by itself
685 An option group Header
687 C? option C with an optional argument"
688 eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"
690 Usage text
692 When "$@" is -h or --help in the above example, the following usage
693 text would be shown:
694 usage: some-command [<options>] <args>...
696 some-command does foo and bar!
698 -h, --help show the help
700 --foo some nifty option --foo
701 --bar ... some cool option --bar with an argument
702 --baz <arg> another cool option --baz with a named argument
703 --qux[=<path>] qux may take a path argument but has meaning by itself
704 An option group Header
706 -C[...] option C with an optional argument
707
709 In --sq-quote mode, git rev-parse echoes on the standard output a
710 single line suitable for sh(1) eval. This line is made by normalizing
711 the arguments following --sq-quote. Nothing other than quoting the
712 arguments is done.
713 If you want command input to still be interpreted as usual by git
715 rev-parse before the output is shell quoted, see the --sq option.
716 Example
718 $ cat >your-git-script.sh <<\EOF
719 #!/bin/sh
720 args=$(git rev-parse --sq-quote "$@") # quote user-supplied arguments
721 command="git frotz -n24 $args" # and use it inside a handcrafted
722 # command line
723 eval "$command"
724 EOF
725 $ sh your-git-script.sh "a b'c"
727
729 · Print the object name of the current commit:
730 $ git rev-parse --verify HEAD
732 · Print the commit object name from the revision in the $REV shell
734 variable:
735 $ git rev-parse --verify --end-of-options $REV^{commit}
737 This will error out if $REV is empty or not a valid revision.
739 · Similar to above:
741 $ git rev-parse --default master --verify --end-of-options $REV
743 but if $REV is empty, the commit object name from master will be
745 printed.
746
748 Part of the git(1) suite
749Git 2.30.2 2021-03-08 GIT-REV-PARSE(1)