| blob | 80b59c0716efee3ae502ce9138e01b4f21e18537 |
1 '\" t
2 .\" Title: git-rev-parse
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 2024-02-15
6 .\" Manual: Git Manual
7 .\" Source: Git 2.44.0.rc1.17.g3e0d3cd5c7
8 .\" Language: English
9 .\"
10 .TH "GIT\-REV\-PARSE" "1" "2024\-02\-15" "Git 2\&.44\&.0\&.rc1\&.17\&.g3" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-rev-parse \- Pick out and massage parameters
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit rev\-parse\fR [<options>] <args>\&...
36 .fi
37 .sp
38 .SH "DESCRIPTION"
39 .sp
40 Many Git porcelainish commands take a mixture of flags (i\&.e\&. parameters that begin with a dash \fI\-\fR) and parameters meant for the underlying \fIgit rev\-list\fR command they use internally and flags and parameters for the other commands they use downstream of \fIgit rev\-list\fR\&. This command is used to distinguish between them\&.
41 .SH "OPTIONS"
42 .SS "Operation Modes"
43 .sp
44 Each of these options must appear first on the command line\&.
45 .PP
46 \-\-parseopt
47 .RS 4
48 Use
49 \fIgit rev\-parse\fR
50 in option parsing mode (see PARSEOPT section below)\&.
51 .RE
52 .PP
53 \-\-sq\-quote
54 .RS 4
55 Use
56 \fIgit rev\-parse\fR
57 in shell quoting mode (see SQ\-QUOTE section below)\&. In contrast to the
58 \fB\-\-sq\fR
59 option below, this mode only does quoting\&. Nothing else is done to command input\&.
60 .RE
61 .SS "Options for \-\-parseopt"
62 .PP
63 \-\-keep\-dashdash
64 .RS 4
65 Only meaningful in
66 \fB\-\-parseopt\fR
67 mode\&. Tells the option parser to echo out the first
68 \fB\-\-\fR
69 met instead of skipping it\&.
70 .RE
71 .PP
72 \-\-stop\-at\-non\-option
73 .RS 4
74 Only meaningful in
75 \fB\-\-parseopt\fR
76 mode\&. Lets the option parser stop at the first non\-option argument\&. This can be used to parse sub\-commands that take options themselves\&.
77 .RE
78 .PP
79 \-\-stuck\-long
80 .RS 4
81 Only meaningful in
82 \fB\-\-parseopt\fR
83 mode\&. Output the options in their long form if available, and with their arguments stuck\&.
84 .RE
85 .SS "Options for Filtering"
86 .PP
87 \-\-revs\-only
88 .RS 4
89 Do not output flags and parameters not meant for
90 \fIgit rev\-list\fR
91 command\&.
92 .RE
93 .PP
94 \-\-no\-revs
95 .RS 4
96 Do not output flags and parameters meant for
97 \fIgit rev\-list\fR
98 command\&.
99 .RE
100 .PP
101 \-\-flags
102 .RS 4
103 Do not output non\-flag parameters\&.
104 .RE
105 .PP
106 \-\-no\-flags
107 .RS 4
108 Do not output flag parameters\&.
109 .RE
110 .SS "Options for Output"
111 .PP
112 \-\-default <arg>
113 .RS 4
114 If there is no parameter given by the user, use
115 \fB<arg>\fR
116 instead\&.
117 .RE
118 .PP
119 \-\-prefix <arg>
120 .RS 4
121 Behave as if
122 \fIgit rev\-parse\fR
123 was invoked from the
124 \fB<arg>\fR
125 subdirectory of the working tree\&. Any relative filenames are resolved as if they are prefixed by
126 \fB<arg>\fR
127 and will be printed in that form\&.
128 .sp
129 This can be used to convert arguments to a command run in a subdirectory so that they can still be used after moving to the top\-level of the repository\&. For example:
130 .sp
131 .if n \{\
132 .RS 4
133 .\}
134 .nf
135 prefix=$(git rev\-parse \-\-show\-prefix)
136 cd "$(git rev\-parse \-\-show\-toplevel)"
137 # rev\-parse provides the \-\- needed for \*(Aqset\*(Aq
138 eval "set $(git rev\-parse \-\-sq \-\-prefix "$prefix" \-\- "$@")"
139 .fi
140 .if n \{\
141 .RE
142 .\}
143 .sp
144 .RE
145 .PP
146 \-\-verify
147 .RS 4
148 Verify that exactly one parameter is provided, and that it can be turned into a raw 20\-byte SHA\-1 that can be used to access the object database\&. If so, emit it to the standard output; otherwise, error out\&.
149 .sp
150 If you want to make sure that the output actually names an object in your object database and/or can be used as a specific type of object you require, you can add the
151 \fB^{type}\fR
152 peeling operator to the parameter\&. For example,
153 \fBgit rev\-parse "$VAR^{commit}"\fR
154 will make sure
155 \fB$VAR\fR
156 names an existing object that is a commit\-ish (i\&.e\&. a commit, or an annotated tag that points at a commit)\&. To make sure that
157 \fB$VAR\fR
158 names an existing object of any type,
159 \fBgit rev\-parse "$VAR^{object}"\fR
160 can be used\&.
161 .sp
162 Note that if you are verifying a name from an untrusted source, it is wise to use
163 \fB\-\-end\-of\-options\fR
164 so that the name argument is not mistaken for another option\&.
165 .RE
166 .PP
167 \-q, \-\-quiet
168 .RS 4
169 Only meaningful in
170 \fB\-\-verify\fR
171 mode\&. Do not output an error message if the first argument is not a valid object name; instead exit with non\-zero status silently\&. SHA\-1s for valid object names are printed to stdout on success\&.
172 .RE
173 .PP
174 \-\-sq
175 .RS 4
176 Usually the output is made one line per flag and parameter\&. This option makes output a single line, properly quoted for consumption by shell\&. Useful when you expect your parameter to contain whitespaces and newlines (e\&.g\&. when using pickaxe
177 \fB\-S\fR
178 with
179 \fIgit diff\-*\fR)\&. In contrast to the
180 \fB\-\-sq\-quote\fR
181 option, the command input is still interpreted as usual\&.
182 .RE
183 .PP
184 \-\-short[=length]
185 .RS 4
186 Same as
187 \fB\-\-verify\fR
188 but shortens the object name to a unique prefix with at least
189 \fBlength\fR
190 characters\&. The minimum length is 4, the default is the effective value of the
191 \fBcore\&.abbrev\fR
192 configuration variable (see
193 \fBgit-config\fR(1))\&.
194 .RE
195 .PP
196 \-\-not
197 .RS 4
198 When showing object names, prefix them with
199 \fI^\fR
200 and strip
201 \fI^\fR
202 prefix from the object names that already have one\&.
203 .RE
204 .PP
205 \-\-abbrev\-ref[=(strict|loose)]
206 .RS 4
207 A non\-ambiguous short name of the objects name\&. The option core\&.warnAmbiguousRefs is used to select the strict abbreviation mode\&.
208 .RE
209 .PP
210 \-\-symbolic
211 .RS 4
212 Usually the object names are output in SHA\-1 form (with possible
213 \fI^\fR
214 prefix); this option makes them output in a form as close to the original input as possible\&.
215 .RE
216 .PP
217 \-\-symbolic\-full\-name
218 .RS 4
219 This is similar to \-\-symbolic, but it omits input that are not refs (i\&.e\&. branch or tag names; or more explicitly disambiguating "heads/master" form, when you want to name the "master" branch when there is an unfortunately named tag "master"), and shows them as full refnames (e\&.g\&. "refs/heads/master")\&.
220 .RE
221 .SS "Options for Objects"
222 .PP
223 \-\-all
224 .RS 4
225 Show all refs found in
226 \fBrefs/\fR\&.
227 .RE
228 .PP
229 \-\-branches[=pattern], \-\-tags[=pattern], \-\-remotes[=pattern]
230 .RS 4
231 Show all branches, tags, or remote\-tracking branches, respectively (i\&.e\&., refs found in
232 \fBrefs/heads\fR,
233 \fBrefs/tags\fR, or
234 \fBrefs/remotes\fR, respectively)\&.
235 .sp
236 If a
237 \fBpattern\fR
238 is given, only refs matching the given shell glob are shown\&. If the pattern does not contain a globbing character (\fB?\fR,
239 \fB*\fR, or
240 \fB[\fR), it is turned into a prefix match by appending
241 \fB/*\fR\&.
242 .RE
243 .PP
244 \-\-glob=pattern
245 .RS 4
246 Show all refs matching the shell glob pattern
247 \fBpattern\fR\&. If the pattern does not start with
248 \fBrefs/\fR, this is automatically prepended\&. If the pattern does not contain a globbing character (\fB?\fR,
249 \fB*\fR, or
250 \fB[\fR), it is turned into a prefix match by appending
251 \fB/*\fR\&.
252 .RE
253 .PP
254 \-\-exclude=<glob\-pattern>
255 .RS 4
256 Do not include refs matching
257 \fI<glob\-pattern>\fR
258 that the next
259 \fB\-\-all\fR,
260 \fB\-\-branches\fR,
261 \fB\-\-tags\fR,
262 \fB\-\-remotes\fR, or
263 \fB\-\-glob\fR
264 would otherwise consider\&. Repetitions of this option accumulate exclusion patterns up to the next
265 \fB\-\-all\fR,
266 \fB\-\-branches\fR,
267 \fB\-\-tags\fR,
268 \fB\-\-remotes\fR, or
269 \fB\-\-glob\fR
270 option (other options or arguments do not clear accumulated patterns)\&.
271 .sp
272 The patterns given should not begin with
273 \fBrefs/heads\fR,
274 \fBrefs/tags\fR, or
275 \fBrefs/remotes\fR
276 when applied to
277 \fB\-\-branches\fR,
278 \fB\-\-tags\fR, or
279 \fB\-\-remotes\fR, respectively, and they must begin with
280 \fBrefs/\fR
281 when applied to
282 \fB\-\-glob\fR
283 or
284 \fB\-\-all\fR\&. If a trailing
285 \fI/*\fR
286 is intended, it must be given explicitly\&.
287 .RE
288 .PP
289 \-\-exclude\-hidden=[fetch|receive|uploadpack]
290 .RS 4
291 Do not include refs that would be hidden by
292 \fBgit\-fetch\fR,
293 \fBgit\-receive\-pack\fR
294 or
295 \fBgit\-upload\-pack\fR
296 by consulting the appropriate
297 \fBfetch\&.hideRefs\fR,
298 \fBreceive\&.hideRefs\fR
299 or
300 \fBuploadpack\&.hideRefs\fR
301 configuration along with
302 \fBtransfer\&.hideRefs\fR
303 (see
304 \fBgit-config\fR(1))\&. This option affects the next pseudo\-ref option
305 \fB\-\-all\fR
306 or
307 \fB\-\-glob\fR
308 and is cleared after processing them\&.
309 .RE
310 .PP
311 \-\-disambiguate=<prefix>
312 .RS 4
313 Show every object whose name begins with the given prefix\&. The <prefix> must be at least 4 hexadecimal digits long to avoid listing each and every object in the repository by mistake\&.
314 .RE
315 .SS "Options for Files"
316 .PP
317 \-\-local\-env\-vars
318 .RS 4
319 List the GIT_* environment variables that are local to the repository (e\&.g\&. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR)\&. Only the names of the variables are listed, not their value, even if they are set\&.
320 .RE
321 .PP
322 \-\-path\-format=(absolute|relative)
323 .RS 4
324 Controls the behavior of certain other options\&. If specified as absolute, the paths printed by those options will be absolute and canonical\&. If specified as relative, the paths will be relative to the current working directory if that is possible\&. The default is option specific\&.
325 .sp
326 This option may be specified multiple times and affects only the arguments that follow it on the command line, either to the end of the command line or the next instance of this option\&.
327 .RE
328 .sp
329 The following options are modified by \fB\-\-path\-format\fR:
330 .PP
331 \-\-git\-dir
332 .RS 4
333 Show
334 \fB$GIT_DIR\fR
335 if defined\&. Otherwise show the path to the \&.git directory\&. The path shown, when relative, is relative to the current working directory\&.
336 .sp
337 If
338 \fB$GIT_DIR\fR
339 is not defined and the current directory is not detected to lie in a Git repository or work tree print a message to stderr and exit with nonzero status\&.
340 .RE
341 .PP
342 \-\-git\-common\-dir
343 .RS 4
344 Show
345 \fB$GIT_COMMON_DIR\fR
346 if defined, else
347 \fB$GIT_DIR\fR\&.
348 .RE
349 .PP
350 \-\-resolve\-git\-dir <path>
351 .RS 4
352 Check if <path> is a valid repository or a gitfile that points at a valid repository, and print the location of the repository\&. If <path> is a gitfile then the resolved path to the real repository is printed\&.
353 .RE
354 .PP
355 \-\-git\-path <path>
356 .RS 4
357 Resolve "$GIT_DIR/<path>" and takes other path relocation variables such as $GIT_OBJECT_DIRECTORY, $GIT_INDEX_FILE\&... into account\&. For example, if $GIT_OBJECT_DIRECTORY is set to /foo/bar then "git rev\-parse \-\-git\-path objects/abc" returns /foo/bar/abc\&.
358 .RE
359 .PP
360 \-\-show\-toplevel
361 .RS 4
362 Show the (by default, absolute) path of the top\-level directory of the working tree\&. If there is no working tree, report an error\&.
363 .RE
364 .PP
365 \-\-show\-superproject\-working\-tree
366 .RS 4
367 Show the absolute path of the root of the superproject\(cqs working tree (if exists) that uses the current repository as its submodule\&. Outputs nothing if the current repository is not used as a submodule by any project\&.
368 .RE
369 .PP
370 \-\-shared\-index\-path
371 .RS 4
372 Show the path to the shared index file in split index mode, or empty if not in split\-index mode\&.
373 .RE
374 .sp
375 The following options are unaffected by \fB\-\-path\-format\fR:
376 .PP
377 \-\-absolute\-git\-dir
378 .RS 4
379 Like
380 \fB\-\-git\-dir\fR, but its output is always the canonicalized absolute path\&.
381 .RE
382 .PP
383 \-\-is\-inside\-git\-dir
384 .RS 4
385 When the current working directory is below the repository directory print "true", otherwise "false"\&.
386 .RE
387 .PP
388 \-\-is\-inside\-work\-tree
389 .RS 4
390 When the current working directory is inside the work tree of the repository print "true", otherwise "false"\&.
391 .RE
392 .PP
393 \-\-is\-bare\-repository
394 .RS 4
395 When the repository is bare print "true", otherwise "false"\&.
396 .RE
397 .PP
398 \-\-is\-shallow\-repository
399 .RS 4
400 When the repository is shallow print "true", otherwise "false"\&.
401 .RE
402 .PP
403 \-\-show\-cdup
404 .RS 4
405 When the command is invoked from a subdirectory, show the path of the top\-level directory relative to the current directory (typically a sequence of "\&.\&./", or an empty string)\&.
406 .RE
407 .PP
408 \-\-show\-prefix
409 .RS 4
410 When the command is invoked from a subdirectory, show the path of the current directory relative to the top\-level directory\&.
411 .RE
412 .PP
413 \-\-show\-object\-format[=(storage|input|output)]
414 .RS 4
415 Show the object format (hash algorithm) used for the repository for storage inside the
416 \fB\&.git\fR
417 directory, input, or output\&. For input, multiple algorithms may be printed, space\-separated\&. If not specified, the default is "storage"\&.
418 .RE
419 .PP
420 \-\-show\-ref\-format
421 .RS 4
422 Show the reference storage format used for the repository\&.
423 .RE
424 .SS "Other Options"
425 .PP
426 \-\-since=datestring, \-\-after=datestring
427 .RS 4
428 Parse the date string, and output the corresponding \-\-max\-age= parameter for
429 \fIgit rev\-list\fR\&.
430 .RE
431 .PP
432 \-\-until=datestring, \-\-before=datestring
433 .RS 4
434 Parse the date string, and output the corresponding \-\-min\-age= parameter for
435 \fIgit rev\-list\fR\&.
436 .RE
437 .PP
438 <args>\&...
439 .RS 4
440 Flags and parameters to be parsed\&.
441 .RE
442 .SH "SPECIFYING REVISIONS"
443 .sp
444 A revision parameter \fI<rev>\fR typically, but not necessarily, names a commit object\&. It uses what is called an \fIextended SHA\-1\fR syntax\&. Here are various ways to spell object names\&. The ones listed near the end of this list name trees and blobs contained in a commit\&.
445 .if n \{\
446 .sp
447 .\}
448 .RS 4
449 .it 1 an-trap
450 .nr an-no-space-flag 1
451 .nr an-break-flag 1
452 .br
453 .ps +1
454 \fBNote\fR
455 .ps -1
456 .br
457 .sp
458 This document shows the "raw" syntax as seen by git\&. The shell and other UIs might require additional quoting to protect special characters and to avoid word splitting\&.
459 .sp .5v
460 .RE
461 .PP
462 \fI<sha1>\fR, e\&.g\&. \fIdae86e1950b1277e545cee180551750029cfe735\fR, \fIdae86e\fR
463 .RS 4
464 The full SHA\-1 object name (40\-byte hexadecimal string), or a leading substring that is unique within the repository\&. E\&.g\&. dae86e1950b1277e545cee180551750029cfe735 and dae86e both name the same commit object if there is no other object in your repository whose object name starts with dae86e\&.
465 .RE
466 .PP
467 \fI<describeOutput>\fR, e\&.g\&. \fIv1\&.7\&.4\&.2\-679\-g3bee7fb\fR
468 .RS 4
469 Output from
470 \fBgit describe\fR; i\&.e\&. a closest tag, optionally followed by a dash and a number of commits, followed by a dash, a
471 \fIg\fR, and an abbreviated object name\&.
472 .RE
473 .PP
474 \fI<refname>\fR, e\&.g\&. \fImaster\fR, \fIheads/master\fR, \fIrefs/heads/master\fR
475 .RS 4
476 A symbolic ref name\&. E\&.g\&.
477 \fImaster\fR
478 typically means the commit object referenced by
479 \fIrefs/heads/master\fR\&. If you happen to have both
480 \fIheads/master\fR
481 and
482 \fItags/master\fR, you can explicitly say
483 \fIheads/master\fR
484 to tell Git which one you mean\&. When ambiguous, a
485 \fI<refname>\fR
486 is disambiguated by taking the first match in the following rules:
487 .sp
488 .RS 4
489 .ie n \{\
490 \h'-04' 1.\h'+01'\c
491 .\}
492 .el \{\
493 .sp -1
494 .IP " 1." 4.2
495 .\}
496 If
497 \fI$GIT_DIR/<refname>\fR
498 exists, that is what you mean (this is usually useful only for
499 \fBHEAD\fR,
500 \fBFETCH_HEAD\fR,
501 \fBORIG_HEAD\fR,
502 \fBMERGE_HEAD\fR,
503 \fBREBASE_HEAD\fR,
504 \fBREVERT_HEAD\fR,
505 \fBCHERRY_PICK_HEAD\fR,
506 \fBBISECT_HEAD\fR
507 and
508 \fBAUTO_MERGE\fR);
509 .RE
510 .sp
511 .RS 4
512 .ie n \{\
513 \h'-04' 2.\h'+01'\c
514 .\}
515 .el \{\
516 .sp -1
517 .IP " 2." 4.2
518 .\}
519 otherwise,
520 \fIrefs/<refname>\fR
521 if it exists;
522 .RE
523 .sp
524 .RS 4
525 .ie n \{\
526 \h'-04' 3.\h'+01'\c
527 .\}
528 .el \{\
529 .sp -1
530 .IP " 3." 4.2
531 .\}
532 otherwise,
533 \fIrefs/tags/<refname>\fR
534 if it exists;
535 .RE
536 .sp
537 .RS 4
538 .ie n \{\
539 \h'-04' 4.\h'+01'\c
540 .\}
541 .el \{\
542 .sp -1
543 .IP " 4." 4.2
544 .\}
545 otherwise,
546 \fIrefs/heads/<refname>\fR
547 if it exists;
548 .RE
549 .sp
550 .RS 4
551 .ie n \{\
552 \h'-04' 5.\h'+01'\c
553 .\}
554 .el \{\
555 .sp -1
556 .IP " 5." 4.2
557 .\}
558 otherwise,
559 \fIrefs/remotes/<refname>\fR
560 if it exists;
561 .RE
562 .sp
563 .RS 4
564 .ie n \{\
565 \h'-04' 6.\h'+01'\c
566 .\}
567 .el \{\
568 .sp -1
569 .IP " 6." 4.2
570 .\}
571 otherwise,
572 \fIrefs/remotes/<refname>/HEAD\fR
573 if it exists\&.
574 .RE
575 .PP
576 \fBHEAD\fR
577 .RS 4
578 names the commit on which you based the changes in the working tree\&.
579 .RE
580 .PP
581 \fBFETCH_HEAD\fR
582 .RS 4
583 records the branch which you fetched from a remote repository with your last
584 \fBgit fetch\fR
585 invocation\&.
586 .RE
587 .PP
588 \fBORIG_HEAD\fR
589 .RS 4
590 is created by commands that move your
591 \fBHEAD\fR
592 in a drastic way (\fBgit am\fR,
593 \fBgit merge\fR,
594 \fBgit rebase\fR,
595 \fBgit reset\fR), to record the position of the
596 \fBHEAD\fR
597 before their operation, so that you can easily change the tip of the branch back to the state before you ran them\&.
598 .RE
599 .PP
600 \fBMERGE_HEAD\fR
601 .RS 4
602 records the commit(s) which you are merging into your branch when you run
603 \fBgit merge\fR\&.
604 .RE
605 .PP
606 \fBREBASE_HEAD\fR
607 .RS 4
608 during a rebase, records the commit at which the operation is currently stopped, either because of conflicts or an
609 \fBedit\fR
610 command in an interactive rebase\&.
611 .RE
612 .PP
613 \fBREVERT_HEAD\fR
614 .RS 4
615 records the commit which you are reverting when you run
616 \fBgit revert\fR\&.
617 .RE
618 .PP
619 \fBCHERRY_PICK_HEAD\fR
620 .RS 4
621 records the commit which you are cherry\-picking when you run
622 \fBgit cherry\-pick\fR\&.
623 .RE
624 .PP
625 \fBBISECT_HEAD\fR
626 .RS 4
627 records the current commit to be tested when you run
628 \fBgit bisect \-\-no\-checkout\fR\&.
629 .RE
630 .PP
631 \fBAUTO_MERGE\fR
632 .RS 4
633 records a tree object corresponding to the state the
634 \fIort\fR
635 merge strategy wrote to the working tree when a merge operation resulted in conflicts\&.
636 .RE
637 .sp
638 Note that any of the
639 \fIrefs/*\fR
640 cases above may come either from the
641 \fB$GIT_DIR/refs\fR
642 directory or from the
643 \fB$GIT_DIR/packed\-refs\fR
644 file\&. While the ref name encoding is unspecified, UTF\-8 is preferred as some output processing may assume ref names in UTF\-8\&.
645 .RE
646 .PP
647 \fI@\fR
648 .RS 4
649 \fI@\fR
650 alone is a shortcut for
651 \fBHEAD\fR\&.
652 .RE
653 .PP
654 \fI[<refname>]@{<date>}\fR, e\&.g\&. \fImaster@{yesterday}\fR, \fIHEAD@{5 minutes ago}\fR
655 .RS 4
656 A ref followed by the suffix
657 \fI@\fR
658 with a date specification enclosed in a brace pair (e\&.g\&.
659 \fI{yesterday}\fR,
660 \fI{1 month 2 weeks 3 days 1 hour 1 second ago}\fR
661 or
662 \fI{1979\-02\-26 18:30:00}\fR) specifies the value of the ref at a prior point in time\&. This suffix may only be used immediately following a ref name and the ref must have an existing log (\fI$GIT_DIR/logs/<ref>\fR)\&. Note that this looks up the state of your
663 \fBlocal\fR
664 ref at a given time; e\&.g\&., what was in your local
665 \fImaster\fR
666 branch last week\&. If you want to look at commits made during certain times, see
667 \fB\-\-since\fR
668 and
669 \fB\-\-until\fR\&.
670 .RE
671 .PP
672 \fI<refname>@{<n>}\fR, e\&.g\&. \fImaster@{1}\fR
673 .RS 4
674 A ref followed by the suffix
675 \fI@\fR
676 with an ordinal specification enclosed in a brace pair (e\&.g\&.
677 \fI{1}\fR,
678 \fI{15}\fR) specifies the n\-th prior value of that ref\&. For example
679 \fImaster@{1}\fR
680 is the immediate prior value of
681 \fImaster\fR
682 while
683 \fImaster@{5}\fR
684 is the 5th prior value of
685 \fImaster\fR\&. This suffix may only be used immediately following a ref name and the ref must have an existing log (\fI$GIT_DIR/logs/<refname>\fR)\&.
686 .RE
687 .PP
688 \fI@{<n>}\fR, e\&.g\&. \fI@{1}\fR
689 .RS 4
690 You can use the
691 \fI@\fR
692 construct with an empty ref part to get at a reflog entry of the current branch\&. For example, if you are on branch
693 \fIblabla\fR
694 then
695 \fI@{1}\fR
696 means the same as
697 \fIblabla@{1}\fR\&.
698 .RE
699 .PP
700 \fI@{\-<n>}\fR, e\&.g\&. \fI@{\-1}\fR
701 .RS 4
702 The construct
703 \fI@{\-<n>}\fR
704 means the <n>th branch/commit checked out before the current one\&.
705 .RE
706 .PP
707 \fI[<branchname>]@{upstream}\fR, e\&.g\&. \fImaster@{upstream}\fR, \fI@{u}\fR
708 .RS 4
709 A branch B may be set up to build on top of a branch X (configured with
710 \fBbranch\&.<name>\&.merge\fR) at a remote R (configured with the branch X taken from remote R, typically found at
711 \fBrefs/remotes/R/X\fR\&.
712 .RE
713 .PP
714 \fI[<branchname>]@{push}\fR, e\&.g\&. \fImaster@{push}\fR, \fI@{push}\fR
715 .RS 4
716 The suffix
717 \fI@{push}\fR
718 reports the branch "where we would push to" if
719 \fBgit push\fR
720 were run while
721 \fBbranchname\fR
722 was checked out (or the current
723 \fBHEAD\fR
724 if no branchname is specified)\&. Like for
725 \fI@{upstream}\fR, we report the remote\-tracking branch that corresponds to that branch at the remote\&.
726 .sp
727 Here\(cqs an example to make it more clear:
728 .sp
729 .if n \{\
730 .RS 4
731 .\}
732 .nf
733 $ git config push\&.default current
734 $ git config remote\&.pushdefault myfork
735 $ git switch \-c mybranch origin/master
737 $ git rev\-parse \-\-symbolic\-full\-name @{upstream}
738 refs/remotes/origin/master
740 $ git rev\-parse \-\-symbolic\-full\-name @{push}
741 refs/remotes/myfork/mybranch
742 .fi
743 .if n \{\
744 .RE
745 .\}
746 .sp
747 Note in the example that we set up a triangular workflow, where we pull from one location and push to another\&. In a non\-triangular workflow,
748 \fI@{push}\fR
749 is the same as
750 \fI@{upstream}\fR, and there is no need for it\&.
751 .sp
752 This suffix is also accepted when spelled in uppercase, and means the same thing no matter the case\&.
753 .RE
754 .PP
755 \fI<rev>^[<n>]\fR, e\&.g\&. \fIHEAD^, v1\&.5\&.1^0\fR
756 .RS 4
757 A suffix
758 \fI^\fR
759 to a revision parameter means the first parent of that commit object\&.
760 \fI^<n>\fR
761 means the <n>th parent (i\&.e\&.
762 \fI<rev>^\fR
763 is equivalent to
764 \fI<rev>^1\fR)\&. As a special rule,
765 \fI<rev>^0\fR
766 means the commit itself and is used when
767 \fI<rev>\fR
768 is the object name of a tag object that refers to a commit object\&.
769 .RE
770 .PP
771 \fI<rev>~[<n>]\fR, e\&.g\&. \fIHEAD~, master~3\fR
772 .RS 4
773 A suffix
774 \fI~\fR
775 to a revision parameter means the first parent of that commit object\&. A suffix
776 \fI~<n>\fR
777 to a revision parameter means the commit object that is the <n>th generation ancestor of the named commit object, following only the first parents\&. I\&.e\&.
778 \fI<rev>~3\fR
779 is equivalent to
780 \fI<rev>^^^\fR
781 which is equivalent to
782 \fI<rev>^1^1^1\fR\&. See below for an illustration of the usage of this form\&.
783 .RE
784 .PP
785 \fI<rev>^{<type>}\fR, e\&.g\&. \fIv0\&.99\&.8^{commit}\fR
786 .RS 4
787 A suffix
788 \fI^\fR
789 followed by an object type name enclosed in brace pair means dereference the object at
790 \fI<rev>\fR
791 recursively until an object of type
792 \fI<type>\fR
793 is found or the object cannot be dereferenced anymore (in which case, barf)\&. For example, if
794 \fI<rev>\fR
795 is a commit\-ish,
796 \fI<rev>^{commit}\fR
797 describes the corresponding commit object\&. Similarly, if
798 \fI<rev>\fR
799 is a tree\-ish,
800 \fI<rev>^{tree}\fR
801 describes the corresponding tree object\&.
802 \fI<rev>^0\fR
803 is a short\-hand for
804 \fI<rev>^{commit}\fR\&.
805 .sp
806 \fI<rev>^{object}\fR
807 can be used to make sure
808 \fI<rev>\fR
809 names an object that exists, without requiring
810 \fI<rev>\fR
811 to be a tag, and without dereferencing
812 \fI<rev>\fR; because a tag is already an object, it does not have to be dereferenced even once to get to an object\&.
813 .sp
814 \fI<rev>^{tag}\fR
815 can be used to ensure that
816 \fI<rev>\fR
817 identifies an existing tag object\&.
818 .RE
819 .PP
820 \fI<rev>^{}\fR, e\&.g\&. \fIv0\&.99\&.8^{}\fR
821 .RS 4
822 A suffix
823 \fI^\fR
824 followed by an empty brace pair means the object could be a tag, and dereference the tag recursively until a non\-tag object is found\&.
825 .RE
826 .PP
827 \fI<rev>^{/<text>}\fR, e\&.g\&. \fIHEAD^{/fix nasty bug}\fR
828 .RS 4
829 A suffix
830 \fI^\fR
831 to a revision parameter, followed by a brace pair that contains a text led by a slash, is the same as the
832 \fI:/fix nasty bug\fR
833 syntax below except that it returns the youngest matching commit which is reachable from the
834 \fI<rev>\fR
835 before
836 \fI^\fR\&.
837 .RE
838 .PP
839 \fI:/<text>\fR, e\&.g\&. \fI:/fix nasty bug\fR
840 .RS 4
841 A colon, followed by a slash, followed by a text, names a commit whose commit message matches the specified regular expression\&. This name returns the youngest matching commit which is reachable from any ref, including HEAD\&. The regular expression can match any part of the commit message\&. To match messages starting with a string, one can use e\&.g\&.
842 \fI:/^foo\fR\&. The special sequence
843 \fI:/!\fR
844 is reserved for modifiers to what is matched\&.
845 \fI:/!\-foo\fR
846 performs a negative match, while
847 \fI:/!!foo\fR
848 matches a literal
849 \fI!\fR
850 character, followed by
851 \fIfoo\fR\&. Any other sequence beginning with
852 \fI:/!\fR
853 is reserved for now\&. Depending on the given text, the shell\(cqs word splitting rules might require additional quoting\&.
854 .RE
855 .PP
856 \fI<rev>:<path>\fR, e\&.g\&. \fIHEAD:README\fR, \fImaster:\&./README\fR
857 .RS 4
858 A suffix
859 \fI:\fR
860 followed by a path names the blob or tree at the given path in the tree\-ish object named by the part before the colon\&. A path starting with
861 \fI\&./\fR
862 or
863 \fI\&.\&./\fR
864 is relative to the current working directory\&. The given path will be converted to be relative to the working tree\(cqs root directory\&. This is most useful to address a blob or tree from a commit or tree that has the same tree structure as the working tree\&.
865 .RE
866 .PP
867 \fI:[<n>:]<path>\fR, e\&.g\&. \fI:0:README\fR, \fI:README\fR
868 .RS 4
869 A colon, optionally followed by a stage number (0 to 3) and a colon, followed by a path, names a blob object in the index at the given path\&. A missing stage number (and the colon that follows it) names a stage 0 entry\&. During a merge, stage 1 is the common ancestor, stage 2 is the target branch\(cqs version (typically the current branch), and stage 3 is the version from the branch which is being merged\&.
870 .RE
871 .sp
872 Here is an illustration, by Jon Loeliger\&. Both commit nodes B and C are parents of commit node A\&. Parent commits are ordered left\-to\-right\&.
873 .sp
874 .if n \{\
875 .RS 4
876 .\}
877 .nf
878 G H I J
879 \e / \e /
880 D E F
881 \e | / \e
882 \e | / |
883 \e|/ |
884 B C
885 \e /
886 \e /
887 A
888 .fi
889 .if n \{\
890 .RE
891 .\}
892 .sp
893 .if n \{\
894 .RS 4
895 .\}
896 .nf
897 A = = A^0
898 B = A^ = A^1 = A~1
899 C = = A^2
900 D = A^^ = A^1^1 = A~2
901 E = B^2 = A^^2
902 F = B^3 = A^^3
903 G = A^^^ = A^1^1^1 = A~3
904 H = D^2 = B^^2 = A^^^2 = A~2^2
905 I = F^ = B^3^ = A^^3^
906 J = F^2 = B^3^2 = A^^3^2
907 .fi
908 .if n \{\
909 .RE
910 .\}
911 .SH "SPECIFYING RANGES"
912 .sp
913 History traversing commands such as \fBgit log\fR operate on a set of commits, not just a single commit\&.
914 .sp
915 For these commands, specifying a single revision, using the notation described in the previous section, means the set of commits \fBreachable\fR from the given commit\&.
916 .sp
917 Specifying several revisions means the set of commits reachable from any of the given commits\&.
918 .sp
919 A commit\(cqs reachable set is the commit itself and the commits in its ancestry chain\&.
920 .sp
921 There are several notations to specify a set of connected commits (called a "revision range"), illustrated below\&.
922 .SS "Commit Exclusions"
923 .PP
924 \fI^<rev>\fR (caret) Notation
925 .RS 4
926 To exclude commits reachable from a commit, a prefix
927 \fI^\fR
928 notation is used\&. E\&.g\&.
929 \fI^r1 r2\fR
930 means commits reachable from
931 \fIr2\fR
932 but exclude the ones reachable from
933 \fIr1\fR
934 (i\&.e\&.
935 \fIr1\fR
936 and its ancestors)\&.
937 .RE
938 .SS "Dotted Range Notations"
939 .PP
940 The \fI\&.\&.\fR (two\-dot) Range Notation
941 .RS 4
942 The
943 \fI^r1 r2\fR
944 set operation appears so often that there is a shorthand for it\&. When you have two commits
945 \fIr1\fR
946 and
947 \fIr2\fR
948 (named according to the syntax explained in SPECIFYING REVISIONS above), you can ask for commits that are reachable from r2 excluding those that are reachable from r1 by
949 \fI^r1 r2\fR
950 and it can be written as
951 \fIr1\&.\&.r2\fR\&.
952 .RE
953 .PP
954 The \fI\&.\&.\&.\fR (three\-dot) Symmetric Difference Notation
955 .RS 4
956 A similar notation
957 \fIr1\&.\&.\&.r2\fR
958 is called symmetric difference of
959 \fIr1\fR
960 and
961 \fIr2\fR
962 and is defined as
963 \fIr1 r2 \-\-not $(git merge\-base \-\-all r1 r2)\fR\&. It is the set of commits that are reachable from either one of
964 \fIr1\fR
965 (left side) or
966 \fIr2\fR
967 (right side) but not from both\&.
968 .RE
969 .sp
970 In these two shorthand notations, you can omit one end and let it default to HEAD\&. For example, \fIorigin\&.\&.\fR is a shorthand for \fIorigin\&.\&.HEAD\fR and asks "What did I do since I forked from the origin branch?" Similarly, \fI\&.\&.origin\fR is a shorthand for \fIHEAD\&.\&.origin\fR and asks "What did the origin do since I forked from them?" Note that \fI\&.\&.\fR would mean \fIHEAD\&.\&.HEAD\fR which is an empty range that is both reachable and unreachable from HEAD\&.
971 .sp
972 Commands that are specifically designed to take two distinct ranges (e\&.g\&. "git range\-diff R1 R2" to compare two ranges) do exist, but they are exceptions\&. Unless otherwise noted, all "git" commands that operate on a set of commits work on a single revision range\&. In other words, writing two "two\-dot range notation" next to each other, e\&.g\&.
973 .sp
974 .if n \{\
975 .RS 4
976 .\}
977 .nf
978 $ git log A\&.\&.B C\&.\&.D
979 .fi
980 .if n \{\
981 .RE
982 .\}
983 .sp
984 does \fBnot\fR specify two revision ranges for most commands\&. Instead it will name a single connected set of commits, i\&.e\&. those that are reachable from either B or D but are reachable from neither A or C\&. In a linear history like this:
985 .sp
986 .if n \{\
987 .RS 4
988 .\}
989 .nf
990 \-\-\-A\-\-\-B\-\-\-o\-\-\-o\-\-\-C\-\-\-D
991 .fi
992 .if n \{\
993 .RE
994 .\}
995 .sp
996 because A and B are reachable from C, the revision range specified by these two dotted ranges is a single commit D\&.
997 .SS "Other <rev>^ Parent Shorthand Notations"
998 .sp
999 Three other shorthands exist, particularly useful for merge commits, for naming a set that is formed by a commit and its parent commits\&.
1000 .sp
1001 The \fIr1^@\fR notation means all parents of \fIr1\fR\&.
1002 .sp
1003 The \fIr1^!\fR notation includes commit \fIr1\fR but excludes all of its parents\&. By itself, this notation denotes the single commit \fIr1\fR\&.
1004 .sp
1005 The \fI<rev>^\-[<n>]\fR notation includes \fI<rev>\fR but excludes the <n>th parent (i\&.e\&. a shorthand for \fI<rev>^<n>\&.\&.<rev>\fR), with \fI<n>\fR = 1 if not given\&. This is typically useful for merge commits where you can just pass \fI<commit>^\-\fR to get all the commits in the branch that was merged in merge commit \fI<commit>\fR (including \fI<commit>\fR itself)\&.
1006 .sp
1007 While \fI<rev>^<n>\fR was about specifying a single commit parent, these three notations also consider its parents\&. For example you can say \fIHEAD^2^@\fR, however you cannot say \fIHEAD^@^2\fR\&.
1008 .SH "REVISION RANGE SUMMARY"
1009 .PP
1010 \fI<rev>\fR
1011 .RS 4
1012 Include commits that are reachable from <rev> (i\&.e\&. <rev> and its ancestors)\&.
1013 .RE
1014 .PP
1015 \fI^<rev>\fR
1016 .RS 4
1017 Exclude commits that are reachable from <rev> (i\&.e\&. <rev> and its ancestors)\&.
1018 .RE
1019 .PP
1020 \fI<rev1>\&.\&.<rev2>\fR
1021 .RS 4
1022 Include commits that are reachable from <rev2> but exclude those that are reachable from <rev1>\&. When either <rev1> or <rev2> is omitted, it defaults to
1023 \fBHEAD\fR\&.
1024 .RE
1025 .PP
1026 \fI<rev1>\&.\&.\&.<rev2>\fR
1027 .RS 4
1028 Include commits that are reachable from either <rev1> or <rev2> but exclude those that are reachable from both\&. When either <rev1> or <rev2> is omitted, it defaults to
1029 \fBHEAD\fR\&.
1030 .RE
1031 .PP
1032 \fI<rev>^@\fR, e\&.g\&. \fIHEAD^@\fR
1033 .RS 4
1034 A suffix
1035 \fI^\fR
1036 followed by an at sign is the same as listing all parents of
1037 \fI<rev>\fR
1038 (meaning, include anything reachable from its parents, but not the commit itself)\&.
1039 .RE
1040 .PP
1041 \fI<rev>^!\fR, e\&.g\&. \fIHEAD^!\fR
1042 .RS 4
1043 A suffix
1044 \fI^\fR
1045 followed by an exclamation mark is the same as giving commit
1046 \fI<rev>\fR
1047 and all its parents prefixed with
1048 \fI^\fR
1049 to exclude them (and their ancestors)\&.
1050 .RE
1051 .PP
1052 \fI<rev>^\-<n>\fR, e\&.g\&. \fIHEAD^\-, HEAD^\-2\fR
1053 .RS 4
1054 Equivalent to
1055 \fI<rev>^<n>\&.\&.<rev>\fR, with
1056 \fI<n>\fR
1057 = 1 if not given\&.
1058 .RE
1059 .sp
1060 Here are a handful of examples using the Loeliger illustration above, with each step in the notation\(cqs expansion and selection carefully spelt out:
1061 .sp
1062 .if n \{\
1063 .RS 4
1064 .\}
1065 .nf
1066 Args Expanded arguments Selected commits
1067 D G H D
1068 D F G H I J D F
1069 ^G D H D
1070 ^D B E I J F B
1071 ^D B C E I J F B C
1072 C I J F C
1073 B\&.\&.C = ^B C C
1074 B\&.\&.\&.C = B ^F C G H D E B C
1075 B^\- = B^\&.\&.B
1076 = ^B^1 B E I J F B
1077 C^@ = C^1
1078 = F I J F
1079 B^@ = B^1 B^2 B^3
1080 = D E F D G H E F I J
1081 C^! = C ^C^@
1082 = C ^C^1
1083 = C ^F C
1084 B^! = B ^B^@
1085 = B ^B^1 ^B^2 ^B^3
1086 = B ^D ^E ^F B
1087 F^! D = F ^I ^J D G H D F
1088 .fi
1089 .if n \{\
1090 .RE
1091 .\}
1092 .SH "PARSEOPT"
1093 .sp
1094 In \fB\-\-parseopt\fR mode, \fIgit rev\-parse\fR helps massaging options to bring to shell scripts the same facilities C builtins have\&. It works as an option normalizer (e\&.g\&. splits single switches aggregate values), a bit like \fBgetopt(1)\fR does\&.
1095 .sp
1096 It takes on the standard input the specification of the options to parse and understand, and echoes on the standard output a string suitable for \fBsh(1)\fR \fBeval\fR to replace the arguments with normalized ones\&. In case of error, it outputs usage on the standard error stream, and exits with code 129\&.
1097 .sp
1098 Note: Make sure you quote the result when passing it to \fBeval\fR\&. See below for an example\&.
1099 .SS "Input Format"
1100 .sp
1101 \fIgit rev\-parse \-\-parseopt\fR input format is fully text based\&. It has two parts, separated by a line that contains only \fB\-\-\fR\&. The lines before the separator (should be one or more) are used for the usage\&. The lines after the separator describe the options\&.
1102 .sp
1103 Each line of options has this format:
1104 .sp
1105 .if n \{\
1106 .RS 4
1107 .\}
1108 .nf
1109 <opt\-spec><flags>*<arg\-hint>? SP+ help LF
1110 .fi
1111 .if n \{\
1112 .RE
1113 .\}
1114 .sp
1116 .PP
1117 \fB<opt\-spec>\fR
1118 .RS 4
1119 its format is the short option character, then the long option name separated by a comma\&. Both parts are not required, though at least one is necessary\&. May not contain any of the
1120 \fB<flags>\fR
1121 characters\&.
1122 \fBh,help\fR,
1123 \fBdry\-run\fR
1124 and
1125 \fBf\fR
1126 are examples of correct
1127 \fB<opt\-spec>\fR\&.
1128 .RE
1129 .PP
1130 \fB<flags>\fR
1131 .RS 4
1132 \fB<flags>\fR
1133 are of
1134 \fB*\fR,
1135 \fB=\fR,
1136 \fB?\fR
1137 or
1138 \fB!\fR\&.
1139 .sp
1140 .RS 4
1141 .ie n \{\
1142 \h'-04'\(bu\h'+03'\c
1143 .\}
1144 .el \{\
1145 .sp -1
1146 .IP \(bu 2.3
1147 .\}
1148 Use
1149 \fB=\fR
1150 if the option takes an argument\&.
1151 .RE
1152 .sp
1153 .RS 4
1154 .ie n \{\
1155 \h'-04'\(bu\h'+03'\c
1156 .\}
1157 .el \{\
1158 .sp -1
1159 .IP \(bu 2.3
1160 .\}
1161 Use
1162 \fB?\fR
1163 to mean that the option takes an optional argument\&. You probably want to use the
1164 \fB\-\-stuck\-long\fR
1165 mode to be able to unambiguously parse the optional argument\&.
1166 .RE
1167 .sp
1168 .RS 4
1169 .ie n \{\
1170 \h'-04'\(bu\h'+03'\c
1171 .\}
1172 .el \{\
1173 .sp -1
1174 .IP \(bu 2.3
1175 .\}
1176 Use
1177 \fB*\fR
1178 to mean that this option should not be listed in the usage generated for the
1179 \fB\-h\fR
1180 argument\&. It\(cqs shown for
1181 \fB\-\-help\-all\fR
1182 as documented in
1183 \fBgitcli\fR(7)\&.
1184 .RE
1185 .sp
1186 .RS 4
1187 .ie n \{\
1188 \h'-04'\(bu\h'+03'\c
1189 .\}
1190 .el \{\
1191 .sp -1
1192 .IP \(bu 2.3
1193 .\}
1194 Use
1195 \fB!\fR
1196 to not make the corresponding negated long option available\&.
1197 .RE
1198 .RE
1199 .PP
1200 \fB<arg\-hint>\fR
1201 .RS 4
1202 \fB<arg\-hint>\fR, if specified, is used as a name of the argument in the help output, for options that take arguments\&.
1203 \fB<arg\-hint>\fR
1204 is terminated by the first whitespace\&. It is customary to use a dash to separate words in a multi\-word argument hint\&.
1205 .RE
1206 .sp
1207 The remainder of the line, after stripping the spaces, is used as the help associated with the option\&.
1208 .sp
1209 Blank lines are ignored, and lines that don\(cqt match this specification are used as option group headers (start the line with a space to create such lines on purpose)\&.
1210 .SS "Example"
1211 .sp
1212 .if n \{\
1213 .RS 4
1214 .\}
1215 .nf
1216 OPTS_SPEC="\e
1217 some\-command [<options>] <args>\&.\&.\&.
1219 some\-command does foo and bar!
1220 \-\-
1221 h,help! show the help
1223 foo some nifty option \-\-foo
1224 bar= some cool option \-\-bar with an argument
1225 baz=arg another cool option \-\-baz with a named argument
1226 qux?path qux may take a path argument but has meaning by itself
1228 An option group Header
1229 C? option C with an optional argument"
1231 eval "$(echo "$OPTS_SPEC" | git rev\-parse \-\-parseopt \-\- "$@" || echo exit $?)"
1232 .fi
1233 .if n \{\
1234 .RE
1235 .\}
1236 .sp
1237 .SS "Usage text"
1238 .sp
1239 When \fB"$@"\fR is \fB\-h\fR or \fB\-\-help\fR in the above example, the following usage text would be shown:
1240 .sp
1241 .if n \{\
1242 .RS 4
1243 .\}
1244 .nf
1245 usage: some\-command [<options>] <args>\&.\&.\&.
1247 some\-command does foo and bar!
1249 \-h, \-\-help show the help
1250 \-\-[no\-]foo some nifty option \-\-foo
1251 \-\-[no\-]bar \&.\&.\&. some cool option \-\-bar with an argument
1252 \-\-[no\-]baz <arg> another cool option \-\-baz with a named argument
1253 \-\-[no\-]qux[=<path>] qux may take a path argument but has meaning by itself
1255 An option group Header
1256 \-C[\&.\&.\&.] option C with an optional argument
1257 .fi
1258 .if n \{\
1259 .RE
1260 .\}
1261 .sp
1262 .SH "SQ\-QUOTE"
1263 .sp
1264 In \fB\-\-sq\-quote\fR mode, \fIgit rev\-parse\fR echoes on the standard output a single line suitable for \fBsh(1)\fR \fBeval\fR\&. This line is made by normalizing the arguments following \fB\-\-sq\-quote\fR\&. Nothing other than quoting the arguments is done\&.
1265 .sp
1266 If you want command input to still be interpreted as usual by \fIgit rev\-parse\fR before the output is shell quoted, see the \fB\-\-sq\fR option\&.
1267 .SS "Example"
1268 .sp
1269 .if n \{\
1270 .RS 4
1271 .\}
1272 .nf
1273 $ cat >your\-git\-script\&.sh <<\eEOF
1274 #!/bin/sh
1275 args=$(git rev\-parse \-\-sq\-quote "$@") # quote user\-supplied arguments
1276 command="git frotz \-n24 $args" # and use it inside a handcrafted
1277 # command line
1278 eval "$command"
1279 EOF
1281 $ sh your\-git\-script\&.sh "a b\*(Aqc"
1282 .fi
1283 .if n \{\
1284 .RE
1285 .\}
1286 .sp
1287 .SH "EXAMPLES"
1288 .sp
1289 .RS 4
1290 .ie n \{\
1291 \h'-04'\(bu\h'+03'\c
1292 .\}
1293 .el \{\
1294 .sp -1
1295 .IP \(bu 2.3
1296 .\}
1297 Print the object name of the current commit:
1298 .sp
1299 .if n \{\
1300 .RS 4
1301 .\}
1302 .nf
1303 $ git rev\-parse \-\-verify HEAD
1304 .fi
1305 .if n \{\
1306 .RE
1307 .\}
1308 .sp
1309 .RE
1310 .sp
1311 .RS 4
1312 .ie n \{\
1313 \h'-04'\(bu\h'+03'\c
1314 .\}
1315 .el \{\
1316 .sp -1
1317 .IP \(bu 2.3
1318 .\}
1319 Print the commit object name from the revision in the $REV shell variable:
1320 .sp
1321 .if n \{\
1322 .RS 4
1323 .\}
1324 .nf
1325 $ git rev\-parse \-\-verify \-\-end\-of\-options $REV^{commit}
1326 .fi
1327 .if n \{\
1328 .RE
1329 .\}
1330 .sp
1331 This will error out if $REV is empty or not a valid revision\&.
1332 .RE
1333 .sp
1334 .RS 4
1335 .ie n \{\
1336 \h'-04'\(bu\h'+03'\c
1337 .\}
1338 .el \{\
1339 .sp -1
1340 .IP \(bu 2.3
1341 .\}
1342 Similar to above:
1343 .sp
1344 .if n \{\
1345 .RS 4
1346 .\}
1347 .nf
1348 $ git rev\-parse \-\-default master \-\-verify \-\-end\-of\-options $REV
1349 .fi
1350 .if n \{\
1351 .RE
1352 .\}
1353 .sp
1354 but if $REV is empty, the commit object name from master will be printed\&.
1355 .RE
1356 .SH "GIT"
1357 .sp
1358 Part of the \fBgit\fR(1) suite