| blob | 98dc1fa88ccdc7b4d750db7664305799f0e89abe |
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-04-10
6 .\" Manual: Git Manual
7 .\" Source: Git 2.44.0.568.g436d4e5b14
8 .\" Language: English
9 .\"
10 .TH "GIT\-REV\-PARSE" "1" "2024\-04\-10" "Git 2\&.44\&.0\&.568\&.g436d4e" "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>] <arg>\&...
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 .PP
222 \-\-output\-object\-format=(sha1|sha256|storage)
223 .RS 4
224 Allow oids to be input from any object format that the current repository supports\&.
225 .sp
226 .if n \{\
227 .RS 4
228 .\}
229 .nf
230 Specifying "sha1" translates if necessary and returns a sha1 oid\&.
231 .fi
232 .if n \{\
233 .RE
234 .\}
235 .sp
236 .if n \{\
237 .RS 4
238 .\}
239 .nf
240 Specifying "sha256" translates if necessary and returns a sha256 oid\&.
241 .fi
242 .if n \{\
243 .RE
244 .\}
245 .sp
246 .if n \{\
247 .RS 4
248 .\}
249 .nf
250 Specifying "storage" translates if necessary and returns an oid in
251 encoded in the storage hash algorithm\&.
252 .fi
253 .if n \{\
254 .RE
255 .\}
256 .RE
257 .SS "Options for Objects"
258 .PP
259 \-\-all
260 .RS 4
261 Show all refs found in
262 \fBrefs/\fR\&.
263 .RE
264 .PP
265 \-\-branches[=<pattern>], \-\-tags[=<pattern>], \-\-remotes[=<pattern>]
266 .RS 4
267 Show all branches, tags, or remote\-tracking branches, respectively (i\&.e\&., refs found in
268 \fBrefs/heads\fR,
269 \fBrefs/tags\fR, or
270 \fBrefs/remotes\fR, respectively)\&.
271 .sp
272 If a
273 \fBpattern\fR
274 is given, only refs matching the given shell glob are shown\&. If the pattern does not contain a globbing character (\fB?\fR,
275 \fB*\fR, or
276 \fB[\fR), it is turned into a prefix match by appending
277 \fB/*\fR\&.
278 .RE
279 .PP
280 \-\-glob=<pattern>
281 .RS 4
282 Show all refs matching the shell glob pattern
283 \fBpattern\fR\&. If the pattern does not start with
284 \fBrefs/\fR, this is automatically prepended\&. If the pattern does not contain a globbing character (\fB?\fR,
285 \fB*\fR, or
286 \fB[\fR), it is turned into a prefix match by appending
287 \fB/*\fR\&.
288 .RE
289 .PP
290 \-\-exclude=<glob\-pattern>
291 .RS 4
292 Do not include refs matching
293 \fI<glob\-pattern>\fR
294 that the next
295 \fB\-\-all\fR,
296 \fB\-\-branches\fR,
297 \fB\-\-tags\fR,
298 \fB\-\-remotes\fR, or
299 \fB\-\-glob\fR
300 would otherwise consider\&. Repetitions of this option accumulate exclusion patterns up to the next
301 \fB\-\-all\fR,
302 \fB\-\-branches\fR,
303 \fB\-\-tags\fR,
304 \fB\-\-remotes\fR, or
305 \fB\-\-glob\fR
306 option (other options or arguments do not clear accumulated patterns)\&.
307 .sp
308 The patterns given should not begin with
309 \fBrefs/heads\fR,
310 \fBrefs/tags\fR, or
311 \fBrefs/remotes\fR
312 when applied to
313 \fB\-\-branches\fR,
314 \fB\-\-tags\fR, or
315 \fB\-\-remotes\fR, respectively, and they must begin with
316 \fBrefs/\fR
317 when applied to
318 \fB\-\-glob\fR
319 or
320 \fB\-\-all\fR\&. If a trailing
321 \fI/*\fR
322 is intended, it must be given explicitly\&.
323 .RE
324 .PP
325 \-\-exclude\-hidden=(fetch|receive|uploadpack)
326 .RS 4
327 Do not include refs that would be hidden by
328 \fBgit\-fetch\fR,
329 \fBgit\-receive\-pack\fR
330 or
331 \fBgit\-upload\-pack\fR
332 by consulting the appropriate
333 \fBfetch\&.hideRefs\fR,
334 \fBreceive\&.hideRefs\fR
335 or
336 \fBuploadpack\&.hideRefs\fR
337 configuration along with
338 \fBtransfer\&.hideRefs\fR
339 (see
340 \fBgit-config\fR(1))\&. This option affects the next pseudo\-ref option
341 \fB\-\-all\fR
342 or
343 \fB\-\-glob\fR
344 and is cleared after processing them\&.
345 .RE
346 .PP
347 \-\-disambiguate=<prefix>
348 .RS 4
349 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\&.
350 .RE
351 .SS "Options for Files"
352 .PP
353 \-\-local\-env\-vars
354 .RS 4
355 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\&.
356 .RE
357 .PP
358 \-\-path\-format=(absolute|relative)
359 .RS 4
360 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\&.
361 .sp
362 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\&.
363 .RE
364 .sp
365 The following options are modified by \fB\-\-path\-format\fR:
366 .PP
367 \-\-git\-dir
368 .RS 4
369 Show
370 \fB$GIT_DIR\fR
371 if defined\&. Otherwise show the path to the \&.git directory\&. The path shown, when relative, is relative to the current working directory\&.
372 .sp
373 If
374 \fB$GIT_DIR\fR
375 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\&.
376 .RE
377 .PP
378 \-\-git\-common\-dir
379 .RS 4
380 Show
381 \fB$GIT_COMMON_DIR\fR
382 if defined, else
383 \fB$GIT_DIR\fR\&.
384 .RE
385 .PP
386 \-\-resolve\-git\-dir <path>
387 .RS 4
388 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\&.
389 .RE
390 .PP
391 \-\-git\-path <path>
392 .RS 4
393 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\&.
394 .RE
395 .PP
396 \-\-show\-toplevel
397 .RS 4
398 Show the (by default, absolute) path of the top\-level directory of the working tree\&. If there is no working tree, report an error\&.
399 .RE
400 .PP
401 \-\-show\-superproject\-working\-tree
402 .RS 4
403 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\&.
404 .RE
405 .PP
406 \-\-shared\-index\-path
407 .RS 4
408 Show the path to the shared index file in split index mode, or empty if not in split\-index mode\&.
409 .RE
410 .sp
411 The following options are unaffected by \fB\-\-path\-format\fR:
412 .PP
413 \-\-absolute\-git\-dir
414 .RS 4
415 Like
416 \fB\-\-git\-dir\fR, but its output is always the canonicalized absolute path\&.
417 .RE
418 .PP
419 \-\-is\-inside\-git\-dir
420 .RS 4
421 When the current working directory is below the repository directory print "true", otherwise "false"\&.
422 .RE
423 .PP
424 \-\-is\-inside\-work\-tree
425 .RS 4
426 When the current working directory is inside the work tree of the repository print "true", otherwise "false"\&.
427 .RE
428 .PP
429 \-\-is\-bare\-repository
430 .RS 4
431 When the repository is bare print "true", otherwise "false"\&.
432 .RE
433 .PP
434 \-\-is\-shallow\-repository
435 .RS 4
436 When the repository is shallow print "true", otherwise "false"\&.
437 .RE
438 .PP
439 \-\-show\-cdup
440 .RS 4
441 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)\&.
442 .RE
443 .PP
444 \-\-show\-prefix
445 .RS 4
446 When the command is invoked from a subdirectory, show the path of the current directory relative to the top\-level directory\&.
447 .RE
448 .PP
449 \-\-show\-object\-format[=(storage|input|output)]
450 .RS 4
451 Show the object format (hash algorithm) used for the repository for storage inside the
452 \fB\&.git\fR
453 directory, input, or output\&. For input, multiple algorithms may be printed, space\-separated\&. If not specified, the default is "storage"\&.
454 .RE
455 .PP
456 \-\-show\-ref\-format
457 .RS 4
458 Show the reference storage format used for the repository\&.
459 .RE
460 .SS "Other Options"
461 .PP
462 \-\-since=<datestring>, \-\-after=<datestring>
463 .RS 4
464 Parse the date string, and output the corresponding \-\-max\-age= parameter for
465 \fIgit rev\-list\fR\&.
466 .RE
467 .PP
468 \-\-until=<datestring>, \-\-before=<datestring>
469 .RS 4
470 Parse the date string, and output the corresponding \-\-min\-age= parameter for
471 \fIgit rev\-list\fR\&.
472 .RE
473 .PP
474 <arg>\&...
475 .RS 4
476 Flags and parameters to be parsed\&.
477 .RE
478 .SH "SPECIFYING REVISIONS"
479 .sp
480 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\&.
481 .if n \{\
482 .sp
483 .\}
484 .RS 4
485 .it 1 an-trap
486 .nr an-no-space-flag 1
487 .nr an-break-flag 1
488 .br
489 .ps +1
490 \fBNote\fR
491 .ps -1
492 .br
493 .sp
494 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\&.
495 .sp .5v
496 .RE
497 .PP
498 \fI<sha1>\fR, e\&.g\&. \fIdae86e1950b1277e545cee180551750029cfe735\fR, \fIdae86e\fR
499 .RS 4
500 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\&.
501 .RE
502 .PP
503 \fI<describeOutput>\fR, e\&.g\&. \fIv1\&.7\&.4\&.2\-679\-g3bee7fb\fR
504 .RS 4
505 Output from
506 \fBgit describe\fR; i\&.e\&. a closest tag, optionally followed by a dash and a number of commits, followed by a dash, a
507 \fIg\fR, and an abbreviated object name\&.
508 .RE
509 .PP
510 \fI<refname>\fR, e\&.g\&. \fImaster\fR, \fIheads/master\fR, \fIrefs/heads/master\fR
511 .RS 4
512 A symbolic ref name\&. E\&.g\&.
513 \fImaster\fR
514 typically means the commit object referenced by
515 \fIrefs/heads/master\fR\&. If you happen to have both
516 \fIheads/master\fR
517 and
518 \fItags/master\fR, you can explicitly say
519 \fIheads/master\fR
520 to tell Git which one you mean\&. When ambiguous, a
521 \fI<refname>\fR
522 is disambiguated by taking the first match in the following rules:
523 .sp
524 .RS 4
525 .ie n \{\
526 \h'-04' 1.\h'+01'\c
527 .\}
528 .el \{\
529 .sp -1
530 .IP " 1." 4.2
531 .\}
532 If
533 \fI$GIT_DIR/<refname>\fR
534 exists, that is what you mean (this is usually useful only for
535 \fBHEAD\fR,
536 \fBFETCH_HEAD\fR,
537 \fBORIG_HEAD\fR,
538 \fBMERGE_HEAD\fR,
539 \fBREBASE_HEAD\fR,
540 \fBREVERT_HEAD\fR,
541 \fBCHERRY_PICK_HEAD\fR,
542 \fBBISECT_HEAD\fR
543 and
544 \fBAUTO_MERGE\fR);
545 .RE
546 .sp
547 .RS 4
548 .ie n \{\
549 \h'-04' 2.\h'+01'\c
550 .\}
551 .el \{\
552 .sp -1
553 .IP " 2." 4.2
554 .\}
555 otherwise,
556 \fIrefs/<refname>\fR
557 if it exists;
558 .RE
559 .sp
560 .RS 4
561 .ie n \{\
562 \h'-04' 3.\h'+01'\c
563 .\}
564 .el \{\
565 .sp -1
566 .IP " 3." 4.2
567 .\}
568 otherwise,
569 \fIrefs/tags/<refname>\fR
570 if it exists;
571 .RE
572 .sp
573 .RS 4
574 .ie n \{\
575 \h'-04' 4.\h'+01'\c
576 .\}
577 .el \{\
578 .sp -1
579 .IP " 4." 4.2
580 .\}
581 otherwise,
582 \fIrefs/heads/<refname>\fR
583 if it exists;
584 .RE
585 .sp
586 .RS 4
587 .ie n \{\
588 \h'-04' 5.\h'+01'\c
589 .\}
590 .el \{\
591 .sp -1
592 .IP " 5." 4.2
593 .\}
594 otherwise,
595 \fIrefs/remotes/<refname>\fR
596 if it exists;
597 .RE
598 .sp
599 .RS 4
600 .ie n \{\
601 \h'-04' 6.\h'+01'\c
602 .\}
603 .el \{\
604 .sp -1
605 .IP " 6." 4.2
606 .\}
607 otherwise,
608 \fIrefs/remotes/<refname>/HEAD\fR
609 if it exists\&.
610 .RE
611 .PP
612 \fBHEAD\fR
613 .RS 4
614 names the commit on which you based the changes in the working tree\&.
615 .RE
616 .PP
617 \fBFETCH_HEAD\fR
618 .RS 4
619 records the branch which you fetched from a remote repository with your last
620 \fBgit fetch\fR
621 invocation\&.
622 .RE
623 .PP
624 \fBORIG_HEAD\fR
625 .RS 4
626 is created by commands that move your
627 \fBHEAD\fR
628 in a drastic way (\fBgit am\fR,
629 \fBgit merge\fR,
630 \fBgit rebase\fR,
631 \fBgit reset\fR), to record the position of the
632 \fBHEAD\fR
633 before their operation, so that you can easily change the tip of the branch back to the state before you ran them\&.
634 .RE
635 .PP
636 \fBMERGE_HEAD\fR
637 .RS 4
638 records the commit(s) which you are merging into your branch when you run
639 \fBgit merge\fR\&.
640 .RE
641 .PP
642 \fBREBASE_HEAD\fR
643 .RS 4
644 during a rebase, records the commit at which the operation is currently stopped, either because of conflicts or an
645 \fBedit\fR
646 command in an interactive rebase\&.
647 .RE
648 .PP
649 \fBREVERT_HEAD\fR
650 .RS 4
651 records the commit which you are reverting when you run
652 \fBgit revert\fR\&.
653 .RE
654 .PP
655 \fBCHERRY_PICK_HEAD\fR
656 .RS 4
657 records the commit which you are cherry\-picking when you run
658 \fBgit cherry\-pick\fR\&.
659 .RE
660 .PP
661 \fBBISECT_HEAD\fR
662 .RS 4
663 records the current commit to be tested when you run
664 \fBgit bisect \-\-no\-checkout\fR\&.
665 .RE
666 .PP
667 \fBAUTO_MERGE\fR
668 .RS 4
669 records a tree object corresponding to the state the
670 \fIort\fR
671 merge strategy wrote to the working tree when a merge operation resulted in conflicts\&.
672 .RE
673 .sp
674 Note that any of the
675 \fIrefs/*\fR
676 cases above may come either from the
677 \fB$GIT_DIR/refs\fR
678 directory or from the
679 \fB$GIT_DIR/packed\-refs\fR
680 file\&. While the ref name encoding is unspecified, UTF\-8 is preferred as some output processing may assume ref names in UTF\-8\&.
681 .RE
682 .PP
683 \fI@\fR
684 .RS 4
685 \fI@\fR
686 alone is a shortcut for
687 \fBHEAD\fR\&.
688 .RE
689 .PP
690 \fI[<refname>]@{<date>}\fR, e\&.g\&. \fImaster@{yesterday}\fR, \fIHEAD@{5 minutes ago}\fR
691 .RS 4
692 A ref followed by the suffix
693 \fI@\fR
694 with a date specification enclosed in a brace pair (e\&.g\&.
695 \fI{yesterday}\fR,
696 \fI{1 month 2 weeks 3 days 1 hour 1 second ago}\fR
697 or
698 \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
699 \fBlocal\fR
700 ref at a given time; e\&.g\&., what was in your local
701 \fImaster\fR
702 branch last week\&. If you want to look at commits made during certain times, see
703 \fB\-\-since\fR
704 and
705 \fB\-\-until\fR\&.
706 .RE
707 .PP
708 \fI<refname>@{<n>}\fR, e\&.g\&. \fImaster@{1}\fR
709 .RS 4
710 A ref followed by the suffix
711 \fI@\fR
712 with an ordinal specification enclosed in a brace pair (e\&.g\&.
713 \fI{1}\fR,
714 \fI{15}\fR) specifies the n\-th prior value of that ref\&. For example
715 \fImaster@{1}\fR
716 is the immediate prior value of
717 \fImaster\fR
718 while
719 \fImaster@{5}\fR
720 is the 5th prior value of
721 \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)\&.
722 .RE
723 .PP
724 \fI@{<n>}\fR, e\&.g\&. \fI@{1}\fR
725 .RS 4
726 You can use the
727 \fI@\fR
728 construct with an empty ref part to get at a reflog entry of the current branch\&. For example, if you are on branch
729 \fIblabla\fR
730 then
731 \fI@{1}\fR
732 means the same as
733 \fIblabla@{1}\fR\&.
734 .RE
735 .PP
736 \fI@{\-<n>}\fR, e\&.g\&. \fI@{\-1}\fR
737 .RS 4
738 The construct
739 \fI@{\-<n>}\fR
740 means the <n>th branch/commit checked out before the current one\&.
741 .RE
742 .PP
743 \fI[<branchname>]@{upstream}\fR, e\&.g\&. \fImaster@{upstream}\fR, \fI@{u}\fR
744 .RS 4
745 A branch B may be set up to build on top of a branch X (configured with
746 \fBbranch\&.<name>\&.merge\fR) at a remote R (configured with the branch X taken from remote R, typically found at
747 \fBrefs/remotes/R/X\fR\&.
748 .RE
749 .PP
750 \fI[<branchname>]@{push}\fR, e\&.g\&. \fImaster@{push}\fR, \fI@{push}\fR
751 .RS 4
752 The suffix
753 \fI@{push}\fR
754 reports the branch "where we would push to" if
755 \fBgit push\fR
756 were run while
757 \fBbranchname\fR
758 was checked out (or the current
759 \fBHEAD\fR
760 if no branchname is specified)\&. Like for
761 \fI@{upstream}\fR, we report the remote\-tracking branch that corresponds to that branch at the remote\&.
762 .sp
763 Here\(cqs an example to make it more clear:
764 .sp
765 .if n \{\
766 .RS 4
767 .\}
768 .nf
769 $ git config push\&.default current
770 $ git config remote\&.pushdefault myfork
771 $ git switch \-c mybranch origin/master
773 $ git rev\-parse \-\-symbolic\-full\-name @{upstream}
774 refs/remotes/origin/master
776 $ git rev\-parse \-\-symbolic\-full\-name @{push}
777 refs/remotes/myfork/mybranch
778 .fi
779 .if n \{\
780 .RE
781 .\}
782 .sp
783 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,
784 \fI@{push}\fR
785 is the same as
786 \fI@{upstream}\fR, and there is no need for it\&.
787 .sp
788 This suffix is also accepted when spelled in uppercase, and means the same thing no matter the case\&.
789 .RE
790 .PP
791 \fI<rev>^[<n>]\fR, e\&.g\&. \fIHEAD^, v1\&.5\&.1^0\fR
792 .RS 4
793 A suffix
794 \fI^\fR
795 to a revision parameter means the first parent of that commit object\&.
796 \fI^<n>\fR
797 means the <n>th parent (i\&.e\&.
798 \fI<rev>^\fR
799 is equivalent to
800 \fI<rev>^1\fR)\&. As a special rule,
801 \fI<rev>^0\fR
802 means the commit itself and is used when
803 \fI<rev>\fR
804 is the object name of a tag object that refers to a commit object\&.
805 .RE
806 .PP
807 \fI<rev>~[<n>]\fR, e\&.g\&. \fIHEAD~, master~3\fR
808 .RS 4
809 A suffix
810 \fI~\fR
811 to a revision parameter means the first parent of that commit object\&. A suffix
812 \fI~<n>\fR
813 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\&.
814 \fI<rev>~3\fR
815 is equivalent to
816 \fI<rev>^^^\fR
817 which is equivalent to
818 \fI<rev>^1^1^1\fR\&. See below for an illustration of the usage of this form\&.
819 .RE
820 .PP
821 \fI<rev>^{<type>}\fR, e\&.g\&. \fIv0\&.99\&.8^{commit}\fR
822 .RS 4
823 A suffix
824 \fI^\fR
825 followed by an object type name enclosed in brace pair means dereference the object at
826 \fI<rev>\fR
827 recursively until an object of type
828 \fI<type>\fR
829 is found or the object cannot be dereferenced anymore (in which case, barf)\&. For example, if
830 \fI<rev>\fR
831 is a commit\-ish,
832 \fI<rev>^{commit}\fR
833 describes the corresponding commit object\&. Similarly, if
834 \fI<rev>\fR
835 is a tree\-ish,
836 \fI<rev>^{tree}\fR
837 describes the corresponding tree object\&.
838 \fI<rev>^0\fR
839 is a short\-hand for
840 \fI<rev>^{commit}\fR\&.
841 .sp
842 \fI<rev>^{object}\fR
843 can be used to make sure
844 \fI<rev>\fR
845 names an object that exists, without requiring
846 \fI<rev>\fR
847 to be a tag, and without dereferencing
848 \fI<rev>\fR; because a tag is already an object, it does not have to be dereferenced even once to get to an object\&.
849 .sp
850 \fI<rev>^{tag}\fR
851 can be used to ensure that
852 \fI<rev>\fR
853 identifies an existing tag object\&.
854 .RE
855 .PP
856 \fI<rev>^{}\fR, e\&.g\&. \fIv0\&.99\&.8^{}\fR
857 .RS 4
858 A suffix
859 \fI^\fR
860 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\&.
861 .RE
862 .PP
863 \fI<rev>^{/<text>}\fR, e\&.g\&. \fIHEAD^{/fix nasty bug}\fR
864 .RS 4
865 A suffix
866 \fI^\fR
867 to a revision parameter, followed by a brace pair that contains a text led by a slash, is the same as the
868 \fI:/fix nasty bug\fR
869 syntax below except that it returns the youngest matching commit which is reachable from the
870 \fI<rev>\fR
871 before
872 \fI^\fR\&.
873 .RE
874 .PP
875 \fI:/<text>\fR, e\&.g\&. \fI:/fix nasty bug\fR
876 .RS 4
877 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\&.
878 \fI:/^foo\fR\&. The special sequence
879 \fI:/!\fR
880 is reserved for modifiers to what is matched\&.
881 \fI:/!\-foo\fR
882 performs a negative match, while
883 \fI:/!!foo\fR
884 matches a literal
885 \fI!\fR
886 character, followed by
887 \fIfoo\fR\&. Any other sequence beginning with
888 \fI:/!\fR
889 is reserved for now\&. Depending on the given text, the shell\(cqs word splitting rules might require additional quoting\&.
890 .RE
891 .PP
892 \fI<rev>:<path>\fR, e\&.g\&. \fIHEAD:README\fR, \fImaster:\&./README\fR
893 .RS 4
894 A suffix
895 \fI:\fR
896 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
897 \fI\&./\fR
898 or
899 \fI\&.\&./\fR
900 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\&.
901 .RE
902 .PP
903 \fI:[<n>:]<path>\fR, e\&.g\&. \fI:0:README\fR, \fI:README\fR
904 .RS 4
905 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\&.
906 .RE
907 .sp
908 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\&.
909 .sp
910 .if n \{\
911 .RS 4
912 .\}
913 .nf
914 G H I J
915 \e / \e /
916 D E F
917 \e | / \e
918 \e | / |
919 \e|/ |
920 B C
921 \e /
922 \e /
923 A
924 .fi
925 .if n \{\
926 .RE
927 .\}
928 .sp
929 .if n \{\
930 .RS 4
931 .\}
932 .nf
933 A = = A^0
934 B = A^ = A^1 = A~1
935 C = = A^2
936 D = A^^ = A^1^1 = A~2
937 E = B^2 = A^^2
938 F = B^3 = A^^3
939 G = A^^^ = A^1^1^1 = A~3
940 H = D^2 = B^^2 = A^^^2 = A~2^2
941 I = F^ = B^3^ = A^^3^
942 J = F^2 = B^3^2 = A^^3^2
943 .fi
944 .if n \{\
945 .RE
946 .\}
947 .SH "SPECIFYING RANGES"
948 .sp
949 History traversing commands such as \fBgit log\fR operate on a set of commits, not just a single commit\&.
950 .sp
951 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\&.
952 .sp
953 Specifying several revisions means the set of commits reachable from any of the given commits\&.
954 .sp
955 A commit\(cqs reachable set is the commit itself and the commits in its ancestry chain\&.
956 .sp
957 There are several notations to specify a set of connected commits (called a "revision range"), illustrated below\&.
958 .SS "Commit Exclusions"
959 .PP
960 \fI^<rev>\fR (caret) Notation
961 .RS 4
962 To exclude commits reachable from a commit, a prefix
963 \fI^\fR
964 notation is used\&. E\&.g\&.
965 \fI^r1 r2\fR
966 means commits reachable from
967 \fIr2\fR
968 but exclude the ones reachable from
969 \fIr1\fR
970 (i\&.e\&.
971 \fIr1\fR
972 and its ancestors)\&.
973 .RE
974 .SS "Dotted Range Notations"
975 .PP
976 The \fI\&.\&.\fR (two\-dot) Range Notation
977 .RS 4
978 The
979 \fI^r1 r2\fR
980 set operation appears so often that there is a shorthand for it\&. When you have two commits
981 \fIr1\fR
982 and
983 \fIr2\fR
984 (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
985 \fI^r1 r2\fR
986 and it can be written as
987 \fIr1\&.\&.r2\fR\&.
988 .RE
989 .PP
990 The \fI\&.\&.\&.\fR (three\-dot) Symmetric Difference Notation
991 .RS 4
992 A similar notation
993 \fIr1\&.\&.\&.r2\fR
994 is called symmetric difference of
995 \fIr1\fR
996 and
997 \fIr2\fR
998 and is defined as
999 \fIr1 r2 \-\-not $(git merge\-base \-\-all r1 r2)\fR\&. It is the set of commits that are reachable from either one of
1000 \fIr1\fR
1001 (left side) or
1002 \fIr2\fR
1003 (right side) but not from both\&.
1004 .RE
1005 .sp
1006 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\&.
1007 .sp
1008 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\&.
1009 .sp
1010 .if n \{\
1011 .RS 4
1012 .\}
1013 .nf
1014 $ git log A\&.\&.B C\&.\&.D
1015 .fi
1016 .if n \{\
1017 .RE
1018 .\}
1019 .sp
1020 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:
1021 .sp
1022 .if n \{\
1023 .RS 4
1024 .\}
1025 .nf
1026 \-\-\-A\-\-\-B\-\-\-o\-\-\-o\-\-\-C\-\-\-D
1027 .fi
1028 .if n \{\
1029 .RE
1030 .\}
1031 .sp
1032 because A and B are reachable from C, the revision range specified by these two dotted ranges is a single commit D\&.
1033 .SS "Other <rev>^ Parent Shorthand Notations"
1034 .sp
1035 Three other shorthands exist, particularly useful for merge commits, for naming a set that is formed by a commit and its parent commits\&.
1036 .sp
1037 The \fIr1^@\fR notation means all parents of \fIr1\fR\&.
1038 .sp
1039 The \fIr1^!\fR notation includes commit \fIr1\fR but excludes all of its parents\&. By itself, this notation denotes the single commit \fIr1\fR\&.
1040 .sp
1041 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)\&.
1042 .sp
1043 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\&.
1044 .SH "REVISION RANGE SUMMARY"
1045 .PP
1046 \fI<rev>\fR
1047 .RS 4
1048 Include commits that are reachable from <rev> (i\&.e\&. <rev> and its ancestors)\&.
1049 .RE
1050 .PP
1051 \fI^<rev>\fR
1052 .RS 4
1053 Exclude commits that are reachable from <rev> (i\&.e\&. <rev> and its ancestors)\&.
1054 .RE
1055 .PP
1056 \fI<rev1>\&.\&.<rev2>\fR
1057 .RS 4
1058 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
1059 \fBHEAD\fR\&.
1060 .RE
1061 .PP
1062 \fI<rev1>\&.\&.\&.<rev2>\fR
1063 .RS 4
1064 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
1065 \fBHEAD\fR\&.
1066 .RE
1067 .PP
1068 \fI<rev>^@\fR, e\&.g\&. \fIHEAD^@\fR
1069 .RS 4
1070 A suffix
1071 \fI^\fR
1072 followed by an at sign is the same as listing all parents of
1073 \fI<rev>\fR
1074 (meaning, include anything reachable from its parents, but not the commit itself)\&.
1075 .RE
1076 .PP
1077 \fI<rev>^!\fR, e\&.g\&. \fIHEAD^!\fR
1078 .RS 4
1079 A suffix
1080 \fI^\fR
1081 followed by an exclamation mark is the same as giving commit
1082 \fI<rev>\fR
1083 and all its parents prefixed with
1084 \fI^\fR
1085 to exclude them (and their ancestors)\&.
1086 .RE
1087 .PP
1088 \fI<rev>^\-<n>\fR, e\&.g\&. \fIHEAD^\-, HEAD^\-2\fR
1089 .RS 4
1090 Equivalent to
1091 \fI<rev>^<n>\&.\&.<rev>\fR, with
1092 \fI<n>\fR
1093 = 1 if not given\&.
1094 .RE
1095 .sp
1096 Here are a handful of examples using the Loeliger illustration above, with each step in the notation\(cqs expansion and selection carefully spelt out:
1097 .sp
1098 .if n \{\
1099 .RS 4
1100 .\}
1101 .nf
1102 Args Expanded arguments Selected commits
1103 D G H D
1104 D F G H I J D F
1105 ^G D H D
1106 ^D B E I J F B
1107 ^D B C E I J F B C
1108 C I J F C
1109 B\&.\&.C = ^B C C
1110 B\&.\&.\&.C = B ^F C G H D E B C
1111 B^\- = B^\&.\&.B
1112 = ^B^1 B E I J F B
1113 C^@ = C^1
1114 = F I J F
1115 B^@ = B^1 B^2 B^3
1116 = D E F D G H E F I J
1117 C^! = C ^C^@
1118 = C ^C^1
1119 = C ^F C
1120 B^! = B ^B^@
1121 = B ^B^1 ^B^2 ^B^3
1122 = B ^D ^E ^F B
1123 F^! D = F ^I ^J D G H D F
1124 .fi
1125 .if n \{\
1126 .RE
1127 .\}
1128 .SH "PARSEOPT"
1129 .sp
1130 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\&.
1131 .sp
1132 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\&.
1133 .sp
1134 Note: Make sure you quote the result when passing it to \fBeval\fR\&. See below for an example\&.
1135 .SS "Input Format"
1136 .sp
1137 \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\&.
1138 .sp
1139 Each line of options has this format:
1140 .sp
1141 .if n \{\
1142 .RS 4
1143 .\}
1144 .nf
1145 <opt\-spec><flags>*<arg\-hint>? SP+ help LF
1146 .fi
1147 .if n \{\
1148 .RE
1149 .\}
1150 .sp
1152 .PP
1153 \fB<opt\-spec>\fR
1154 .RS 4
1155 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
1156 \fB<flags>\fR
1157 characters\&.
1158 \fBh,help\fR,
1159 \fBdry\-run\fR
1160 and
1161 \fBf\fR
1162 are examples of correct
1163 \fB<opt\-spec>\fR\&.
1164 .RE
1165 .PP
1166 \fB<flags>\fR
1167 .RS 4
1168 \fB<flags>\fR
1169 are of
1170 \fB*\fR,
1171 \fB=\fR,
1172 \fB?\fR
1173 or
1174 \fB!\fR\&.
1175 .sp
1176 .RS 4
1177 .ie n \{\
1178 \h'-04'\(bu\h'+03'\c
1179 .\}
1180 .el \{\
1181 .sp -1
1182 .IP \(bu 2.3
1183 .\}
1184 Use
1185 \fB=\fR
1186 if the option takes an argument\&.
1187 .RE
1188 .sp
1189 .RS 4
1190 .ie n \{\
1191 \h'-04'\(bu\h'+03'\c
1192 .\}
1193 .el \{\
1194 .sp -1
1195 .IP \(bu 2.3
1196 .\}
1197 Use
1198 \fB?\fR
1199 to mean that the option takes an optional argument\&. You probably want to use the
1200 \fB\-\-stuck\-long\fR
1201 mode to be able to unambiguously parse the optional argument\&.
1202 .RE
1203 .sp
1204 .RS 4
1205 .ie n \{\
1206 \h'-04'\(bu\h'+03'\c
1207 .\}
1208 .el \{\
1209 .sp -1
1210 .IP \(bu 2.3
1211 .\}
1212 Use
1213 \fB*\fR
1214 to mean that this option should not be listed in the usage generated for the
1215 \fB\-h\fR
1216 argument\&. It\(cqs shown for
1217 \fB\-\-help\-all\fR
1218 as documented in
1219 \fBgitcli\fR(7)\&.
1220 .RE
1221 .sp
1222 .RS 4
1223 .ie n \{\
1224 \h'-04'\(bu\h'+03'\c
1225 .\}
1226 .el \{\
1227 .sp -1
1228 .IP \(bu 2.3
1229 .\}
1230 Use
1231 \fB!\fR
1232 to not make the corresponding negated long option available\&.
1233 .RE
1234 .RE
1235 .PP
1236 \fB<arg\-hint>\fR
1237 .RS 4
1238 \fB<arg\-hint>\fR, if specified, is used as a name of the argument in the help output, for options that take arguments\&.
1239 \fB<arg\-hint>\fR
1240 is terminated by the first whitespace\&. It is customary to use a dash to separate words in a multi\-word argument hint\&.
1241 .RE
1242 .sp
1243 The remainder of the line, after stripping the spaces, is used as the help associated with the option\&.
1244 .sp
1245 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)\&.
1246 .SS "Example"
1247 .sp
1248 .if n \{\
1249 .RS 4
1250 .\}
1251 .nf
1252 OPTS_SPEC="\e
1253 some\-command [<options>] <args>\&.\&.\&.
1255 some\-command does foo and bar!
1256 \-\-
1257 h,help! show the help
1259 foo some nifty option \-\-foo
1260 bar= some cool option \-\-bar with an argument
1261 baz=arg another cool option \-\-baz with a named argument
1262 qux?path qux may take a path argument but has meaning by itself
1264 An option group Header
1265 C? option C with an optional argument"
1267 eval "$(echo "$OPTS_SPEC" | git rev\-parse \-\-parseopt \-\- "$@" || echo exit $?)"
1268 .fi
1269 .if n \{\
1270 .RE
1271 .\}
1272 .sp
1273 .SS "Usage text"
1274 .sp
1275 When \fB"$@"\fR is \fB\-h\fR or \fB\-\-help\fR in the above example, the following usage text would be shown:
1276 .sp
1277 .if n \{\
1278 .RS 4
1279 .\}
1280 .nf
1281 usage: some\-command [<options>] <args>\&.\&.\&.
1283 some\-command does foo and bar!
1285 \-h, \-\-help show the help
1286 \-\-[no\-]foo some nifty option \-\-foo
1287 \-\-[no\-]bar \&.\&.\&. some cool option \-\-bar with an argument
1288 \-\-[no\-]baz <arg> another cool option \-\-baz with a named argument
1289 \-\-[no\-]qux[=<path>] qux may take a path argument but has meaning by itself
1291 An option group Header
1292 \-C[\&.\&.\&.] option C with an optional argument
1293 .fi
1294 .if n \{\
1295 .RE
1296 .\}
1297 .sp
1298 .SH "SQ\-QUOTE"
1299 .sp
1300 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\&.
1301 .sp
1302 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\&.
1303 .SS "Example"
1304 .sp
1305 .if n \{\
1306 .RS 4
1307 .\}
1308 .nf
1309 $ cat >your\-git\-script\&.sh <<\eEOF
1310 #!/bin/sh
1311 args=$(git rev\-parse \-\-sq\-quote "$@") # quote user\-supplied arguments
1312 command="git frotz \-n24 $args" # and use it inside a handcrafted
1313 # command line
1314 eval "$command"
1315 EOF
1317 $ sh your\-git\-script\&.sh "a b\*(Aqc"
1318 .fi
1319 .if n \{\
1320 .RE
1321 .\}
1322 .sp
1323 .SH "EXAMPLES"
1324 .sp
1325 .RS 4
1326 .ie n \{\
1327 \h'-04'\(bu\h'+03'\c
1328 .\}
1329 .el \{\
1330 .sp -1
1331 .IP \(bu 2.3
1332 .\}
1333 Print the object name of the current commit:
1334 .sp
1335 .if n \{\
1336 .RS 4
1337 .\}
1338 .nf
1339 $ git rev\-parse \-\-verify HEAD
1340 .fi
1341 .if n \{\
1342 .RE
1343 .\}
1344 .sp
1345 .RE
1346 .sp
1347 .RS 4
1348 .ie n \{\
1349 \h'-04'\(bu\h'+03'\c
1350 .\}
1351 .el \{\
1352 .sp -1
1353 .IP \(bu 2.3
1354 .\}
1355 Print the commit object name from the revision in the $REV shell variable:
1356 .sp
1357 .if n \{\
1358 .RS 4
1359 .\}
1360 .nf
1361 $ git rev\-parse \-\-verify \-\-end\-of\-options $REV^{commit}
1362 .fi
1363 .if n \{\
1364 .RE
1365 .\}
1366 .sp
1367 This will error out if $REV is empty or not a valid revision\&.
1368 .RE
1369 .sp
1370 .RS 4
1371 .ie n \{\
1372 \h'-04'\(bu\h'+03'\c
1373 .\}
1374 .el \{\
1375 .sp -1
1376 .IP \(bu 2.3
1377 .\}
1378 Similar to above:
1379 .sp
1380 .if n \{\
1381 .RS 4
1382 .\}
1383 .nf
1384 $ git rev\-parse \-\-default master \-\-verify \-\-end\-of\-options $REV
1385 .fi
1386 .if n \{\
1387 .RE
1388 .\}
1389 .sp
1390 but if $REV is empty, the commit object name from master will be printed\&.
1391 .RE
1392 .SH "GIT"
1393 .sp
1394 Part of the \fBgit\fR(1) suite