]>
Commit | Line | Data |
---|---|---|
7fc9d69f JH |
1 | git-rev-parse(1) |
2 | ================ | |
3 | ||
4 | NAME | |
5 | ---- | |
7bd7f280 | 6 | git-rev-parse - Pick out and massage parameters |
7fc9d69f JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
7791a1d9 | 11 | [verse] |
de613050 | 12 | 'git rev-parse' [<options>] <args>... |
7fc9d69f JH |
13 | |
14 | DESCRIPTION | |
15 | ----------- | |
5077fa9c | 16 | |
2de9b711 | 17 | Many Git porcelainish commands take mixture of flags |
5077fa9c | 18 | (i.e. parameters that begin with a dash '-') and parameters |
0b444cdb | 19 | meant for the underlying 'git rev-list' command they use internally |
483bc4f0 | 20 | and flags and parameters for the other commands they use |
0b444cdb | 21 | downstream of 'git rev-list'. This command is used to |
5077fa9c | 22 | distinguish between them. |
7fc9d69f JH |
23 | |
24 | ||
25 | OPTIONS | |
26 | ------- | |
49c63913 JK |
27 | |
28 | Operation Modes | |
29 | ~~~~~~~~~~~~~~~ | |
30 | ||
31 | Each of these options must appear first on the command line. | |
32 | ||
21d47835 | 33 | --parseopt:: |
0b444cdb | 34 | Use 'git rev-parse' in option parsing mode (see PARSEOPT section below). |
21d47835 | 35 | |
49c63913 JK |
36 | --sq-quote:: |
37 | Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE | |
38 | section below). In contrast to the `--sq` option below, this | |
cf6cac20 | 39 | mode only does quoting. Nothing else is done to command input. |
49c63913 JK |
40 | |
41 | Options for --parseopt | |
42 | ~~~~~~~~~~~~~~~~~~~~~~ | |
43 | ||
2163e3f7 | 44 | --keep-dashdash:: |
21d47835 PH |
45 | Only meaningful in `--parseopt` mode. Tells the option parser to echo |
46 | out the first `--` met instead of skipping it. | |
47 | ||
6e0800ef UKK |
48 | --stop-at-non-option:: |
49 | Only meaningful in `--parseopt` mode. Lets the option parser stop at | |
50 | the first non-option argument. This can be used to parse sub-commands | |
6a5d0b0a | 51 | that take options themselves. |
6e0800ef | 52 | |
f8c87212 NV |
53 | --stuck-long:: |
54 | Only meaningful in `--parseopt` mode. Output the options in their | |
55 | long form if available, and with their arguments stuck. | |
56 | ||
49c63913 JK |
57 | Options for Filtering |
58 | ~~~~~~~~~~~~~~~~~~~~~ | |
50325377 | 59 | |
5077fa9c JH |
60 | --revs-only:: |
61 | Do not output flags and parameters not meant for | |
0b444cdb | 62 | 'git rev-list' command. |
5077fa9c JH |
63 | |
64 | --no-revs:: | |
65 | Do not output flags and parameters meant for | |
0b444cdb | 66 | 'git rev-list' command. |
5077fa9c JH |
67 | |
68 | --flags:: | |
69 | Do not output non-flag parameters. | |
70 | ||
71 | --no-flags:: | |
72 | Do not output flag parameters. | |
73 | ||
49c63913 JK |
74 | Options for Output |
75 | ~~~~~~~~~~~~~~~~~~ | |
76 | ||
5077fa9c JH |
77 | --default <arg>:: |
78 | If there is no parameter given by the user, use `<arg>` | |
79 | instead. | |
80 | ||
12b9d327 JK |
81 | --prefix <arg>:: |
82 | Behave as if 'git rev-parse' was invoked from the `<arg>` | |
83 | subdirectory of the working tree. Any relative filenames are | |
84 | resolved as if they are prefixed by `<arg>` and will be printed | |
85 | in that form. | |
86 | + | |
87 | This can be used to convert arguments to a command run in a subdirectory | |
88 | so that they can still be used after moving to the top-level of the | |
89 | repository. For example: | |
90 | + | |
91 | ---- | |
92 | prefix=$(git rev-parse --show-prefix) | |
93 | cd "$(git rev-parse --show-toplevel)" | |
11873b43 RH |
94 | # rev-parse provides the -- needed for 'set' |
95 | eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")" | |
12b9d327 JK |
96 | ---- |
97 | ||
5077fa9c | 98 | --verify:: |
2db60670 MH |
99 | Verify that exactly one parameter is provided, and that it |
100 | can be turned into a raw 20-byte SHA-1 that can be used to | |
101 | access the object database. If so, emit it to the standard | |
102 | output; otherwise, error out. | |
103 | + | |
104 | If you want to make sure that the output actually names an object in | |
105 | your object database and/or can be used as a specific type of object | |
b50bfb8f | 106 | you require, you can add the `^{type}` peeling operator to the parameter. |
2db60670 MH |
107 | For example, `git rev-parse "$VAR^{commit}"` will make sure `$VAR` |
108 | names an existing object that is a commit-ish (i.e. a commit, or an | |
109 | annotated tag that points at a commit). To make sure that `$VAR` | |
110 | names an existing object of any type, `git rev-parse "$VAR^{object}"` | |
111 | can be used. | |
3a1f91cf JK |
112 | + |
113 | Note that if you are verifying a name from an untrusted source, it is | |
114 | wise to use `--end-of-options` so that the name argument is not mistaken | |
115 | for another option. | |
5077fa9c | 116 | |
3240240f SB |
117 | -q:: |
118 | --quiet:: | |
b1b35969 CC |
119 | Only meaningful in `--verify` mode. Do not output an error |
120 | message if the first argument is not a valid object name; | |
121 | instead exit with non-zero status silently. | |
56625df7 | 122 | SHA-1s for valid object names are printed to stdout on success. |
b1b35969 | 123 | |
5077fa9c JH |
124 | --sq:: |
125 | Usually the output is made one line per flag and | |
126 | parameter. This option makes output a single line, | |
127 | properly quoted for consumption by shell. Useful when | |
128 | you expect your parameter to contain whitespaces and | |
129 | newlines (e.g. when using pickaxe `-S` with | |
4cacbf67 | 130 | 'git diff-{asterisk}'). In contrast to the `--sq-quote` option, |
50325377 | 131 | the command input is still interpreted as usual. |
5077fa9c | 132 | |
fb87327a AH |
133 | --short[=length]:: |
134 | Same as `--verify` but shortens the object name to a unique | |
135 | prefix with at least `length` characters. The minimum length | |
136 | is 4, the default is the effective value of the `core.abbrev` | |
137 | configuration variable (see linkgit:git-config[1]). | |
138 | ||
5077fa9c | 139 | --not:: |
babfaba2 JF |
140 | When showing object names, prefix them with '{caret}' and |
141 | strip '{caret}' prefix from the object names that already have | |
5077fa9c JH |
142 | one. |
143 | ||
49c63913 JK |
144 | --abbrev-ref[=(strict|loose)]:: |
145 | A non-ambiguous short name of the objects name. | |
146 | The option core.warnAmbiguousRefs is used to select the strict | |
147 | abbreviation mode. | |
148 | ||
5077fa9c | 149 | --symbolic:: |
d5fa1f1a | 150 | Usually the object names are output in SHA-1 form (with |
babfaba2 | 151 | possible '{caret}' prefix); this option makes them output in a |
5077fa9c JH |
152 | form as close to the original input as possible. |
153 | ||
a6d97d49 | 154 | --symbolic-full-name:: |
1c262bb7 | 155 | This is similar to --symbolic, but it omits input that |
a6d97d49 JH |
156 | are not refs (i.e. branch or tag names; or more |
157 | explicitly disambiguating "heads/master" form, when you | |
158 | want to name the "master" branch when there is an | |
159 | unfortunately named tag "master"), and show them as full | |
160 | refnames (e.g. "refs/heads/master"). | |
5077fa9c | 161 | |
49c63913 JK |
162 | Options for Objects |
163 | ~~~~~~~~~~~~~~~~~~~ | |
957d7406 | 164 | |
5077fa9c | 165 | --all:: |
cc1b8d8b | 166 | Show all refs found in `refs/`. |
5077fa9c | 167 | |
b09fe971 | 168 | --branches[=pattern]:: |
b09fe971 | 169 | --tags[=pattern]:: |
b09fe971 | 170 | --remotes[=pattern]:: |
e2b53e58 | 171 | Show all branches, tags, or remote-tracking branches, |
cc1b8d8b JK |
172 | respectively (i.e., refs found in `refs/heads`, |
173 | `refs/tags`, or `refs/remotes`, respectively). | |
e2b53e58 TR |
174 | + |
175 | If a `pattern` is given, only refs matching the given shell glob are | |
176 | shown. If the pattern does not contain a globbing character (`?`, | |
6cf378f0 | 177 | `*`, or `[`), it is turned into a prefix match by appending `/*`. |
e2b53e58 TR |
178 | |
179 | --glob=pattern:: | |
180 | Show all refs matching the shell glob pattern `pattern`. If | |
181 | the pattern does not start with `refs/`, this is automatically | |
182 | prepended. If the pattern does not contain a globbing | |
6cf378f0 JK |
183 | character (`?`, `*`, or `[`), it is turned into a prefix |
184 | match by appending `/*`. | |
a62be77f | 185 | |
9dc01bf0 JH |
186 | --exclude=<glob-pattern>:: |
187 | Do not include refs matching '<glob-pattern>' that the next `--all`, | |
188 | `--branches`, `--tags`, `--remotes`, or `--glob` would otherwise | |
189 | consider. Repetitions of this option accumulate exclusion patterns | |
190 | up to the next `--all`, `--branches`, `--tags`, `--remotes`, or | |
191 | `--glob` option (other options or arguments do not clear | |
f745acb0 | 192 | accumulated patterns). |
9dc01bf0 JH |
193 | + |
194 | The patterns given should not begin with `refs/heads`, `refs/tags`, or | |
195 | `refs/remotes` when applied to `--branches`, `--tags`, or `--remotes`, | |
196 | respectively, and they must begin with `refs/` when applied to `--glob` | |
197 | or `--all`. If a trailing '/{asterisk}' is intended, it must be given | |
198 | explicitly. | |
199 | ||
c6ce27ab EW |
200 | --exclude-hidden=[fetch|receive|uploadpack]:: |
201 | Do not include refs that would be hidden by `git-fetch`, | |
202 | `git-receive-pack` or `git-upload-pack` by consulting the appropriate | |
203 | `fetch.hideRefs`, `receive.hideRefs` or `uploadpack.hideRefs` | |
204 | configuration along with `transfer.hideRefs` (see | |
5ff36c9b PS |
205 | linkgit:git-config[1]). This option affects the next pseudo-ref option |
206 | `--all` or `--glob` and is cleared after processing them. | |
207 | ||
49c63913 JK |
208 | --disambiguate=<prefix>:: |
209 | Show every object whose name begins with the given prefix. | |
210 | The <prefix> must be at least 4 hexadecimal digits long to | |
211 | avoid listing each and every object in the repository by | |
212 | mistake. | |
7cceca5c | 213 | |
49c63913 JK |
214 | Options for Files |
215 | ~~~~~~~~~~~~~~~~~ | |
7fc9d69f | 216 | |
49c63913 JK |
217 | --local-env-vars:: |
218 | List the GIT_* environment variables that are local to the | |
219 | repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR). | |
220 | Only the names of the variables are listed, not their value, | |
221 | even if they are set. | |
5f94c730 | 222 | |
fac60b89 | 223 | --path-format=(absolute|relative):: |
224 | Controls the behavior of certain other options. If specified as absolute, the | |
225 | paths printed by those options will be absolute and canonical. If specified as | |
226 | relative, the paths will be relative to the current working directory if that | |
227 | is possible. The default is option specific. | |
228 | + | |
229 | This option may be specified multiple times and affects only the arguments that | |
230 | follow it on the command line, either to the end of the command line or the next | |
231 | instance of this option. | |
232 | ||
233 | The following options are modified by `--path-format`: | |
234 | ||
735d80b3 | 235 | --git-dir:: |
80d868b0 | 236 | Show `$GIT_DIR` if defined. Otherwise show the path to |
d0740ce0 JS |
237 | the .git directory. The path shown, when relative, is |
238 | relative to the current working directory. | |
80d868b0 JN |
239 | + |
240 | If `$GIT_DIR` is not defined and the current directory | |
2de9b711 | 241 | is not detected to lie in a Git repository or work tree |
80d868b0 | 242 | print a message to stderr and exit with nonzero status. |
735d80b3 | 243 | |
31e26ebc NTND |
244 | --git-common-dir:: |
245 | Show `$GIT_COMMON_DIR` if defined, else `$GIT_DIR`. | |
246 | ||
49c63913 JK |
247 | --resolve-git-dir <path>:: |
248 | Check if <path> is a valid repository or a gitfile that | |
249 | points at a valid repository, and print the location of the | |
250 | repository. If <path> is a gitfile then the resolved path | |
251 | to the real repository is printed. | |
94c8ccaa | 252 | |
557bd833 NTND |
253 | --git-path <path>:: |
254 | Resolve "$GIT_DIR/<path>" and takes other path relocation | |
255 | variables such as $GIT_OBJECT_DIRECTORY, | |
256 | $GIT_INDEX_FILE... into account. For example, if | |
257 | $GIT_OBJECT_DIRECTORY is set to /foo/bar then "git rev-parse | |
258 | --git-path objects/abc" returns /foo/bar/abc. | |
259 | ||
49c63913 | 260 | --show-toplevel:: |
fac60b89 | 261 | Show the (by default, absolute) path of the top-level directory |
262 | of the working tree. If there is no working tree, report an error. | |
49c63913 | 263 | |
e38c681f | 264 | --show-superproject-working-tree:: |
bf0231c6 SB |
265 | Show the absolute path of the root of the superproject's |
266 | working tree (if exists) that uses the current repository as | |
267 | its submodule. Outputs nothing if the current repository is | |
268 | not used as a submodule by any project. | |
269 | ||
a76295da NTND |
270 | --shared-index-path:: |
271 | Show the path to the shared index file in split index mode, or | |
272 | empty if not in split-index mode. | |
273 | ||
fac60b89 | 274 | The following options are unaffected by `--path-format`: |
275 | ||
276 | --absolute-git-dir:: | |
277 | Like `--git-dir`, but its output is always the canonicalized | |
278 | absolute path. | |
279 | ||
280 | --is-inside-git-dir:: | |
281 | When the current working directory is below the repository | |
282 | directory print "true", otherwise "false". | |
283 | ||
284 | --is-inside-work-tree:: | |
285 | When the current working directory is inside the work tree of the | |
286 | repository print "true", otherwise "false". | |
287 | ||
288 | --is-bare-repository:: | |
289 | When the repository is bare print "true", otherwise "false". | |
290 | ||
291 | --is-shallow-repository:: | |
292 | When the repository is shallow print "true", otherwise "false". | |
293 | ||
294 | --show-cdup:: | |
295 | When the command is invoked from a subdirectory, show the | |
296 | path of the top-level directory relative to the current | |
297 | directory (typically a sequence of "../", or an empty string). | |
298 | ||
299 | --show-prefix:: | |
300 | When the command is invoked from a subdirectory, show the | |
301 | path of the current directory relative to the top-level | |
302 | directory. | |
303 | ||
2eabd383 | 304 | --show-object-format[=(storage|input|output)]:: |
305 | Show the object format (hash algorithm) used for the repository | |
306 | for storage inside the `.git` directory, input, or output. For | |
307 | input, multiple algorithms may be printed, space-separated. | |
308 | If not specified, the default is "storage". | |
309 | ||
310 | ||
49c63913 JK |
311 | Other Options |
312 | ~~~~~~~~~~~~~ | |
735d80b3 | 313 | |
3240240f SB |
314 | --since=datestring:: |
315 | --after=datestring:: | |
483bc4f0 | 316 | Parse the date string, and output the corresponding |
0b444cdb | 317 | --max-age= parameter for 'git rev-list'. |
a3114b34 | 318 | |
3240240f SB |
319 | --until=datestring:: |
320 | --before=datestring:: | |
483bc4f0 | 321 | Parse the date string, and output the corresponding |
0b444cdb | 322 | --min-age= parameter for 'git rev-list'. |
a3114b34 | 323 | |
7fc9d69f | 324 | <args>...:: |
5077fa9c | 325 | Flags and parameters to be parsed. |
7fc9d69f JH |
326 | |
327 | ||
5a8f3117 | 328 | include::revisions.txt[] |
be4c7014 | 329 | |
21d47835 PH |
330 | PARSEOPT |
331 | -------- | |
332 | ||
0b444cdb | 333 | In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell |
21d47835 PH |
334 | scripts the same facilities C builtins have. It works as an option normalizer |
335 | (e.g. splits single switches aggregate values), a bit like `getopt(1)` does. | |
336 | ||
337 | It takes on the standard input the specification of the options to parse and | |
ac2e1e63 | 338 | understand, and echoes on the standard output a string suitable for `sh(1)` `eval` |
21d47835 PH |
339 | to replace the arguments with normalized ones. In case of error, it outputs |
340 | usage on the standard error stream, and exits with code 129. | |
341 | ||
ac2e1e63 TR |
342 | Note: Make sure you quote the result when passing it to `eval`. See |
343 | below for an example. | |
344 | ||
21d47835 PH |
345 | Input Format |
346 | ~~~~~~~~~~~~ | |
347 | ||
0b444cdb | 348 | 'git rev-parse --parseopt' input format is fully text based. It has two parts, |
21d47835 | 349 | separated by a line that contains only `--`. The lines before the separator |
9bab5b60 | 350 | (should be one or more) are used for the usage. |
21d47835 PH |
351 | The lines after the separator describe the options. |
352 | ||
353 | Each line of options has this format: | |
354 | ||
355 | ------------ | |
e703d711 | 356 | <opt-spec><flags>*<arg-hint>? SP+ help LF |
21d47835 PH |
357 | ------------ |
358 | ||
e703d711 | 359 | `<opt-spec>`:: |
21d47835 PH |
360 | its format is the short option character, then the long option name |
361 | separated by a comma. Both parts are not required, though at least one | |
2d893dff IB |
362 | is necessary. May not contain any of the `<flags>` characters. |
363 | `h,help`, `dry-run` and `f` are examples of correct `<opt-spec>`. | |
21d47835 | 364 | |
ff962a3f PH |
365 | `<flags>`:: |
366 | `<flags>` are of `*`, `=`, `?` or `!`. | |
367 | * Use `=` if the option takes an argument. | |
368 | ||
f8c87212 NV |
369 | * Use `?` to mean that the option takes an optional argument. You |
370 | probably want to use the `--stuck-long` mode to be able to | |
371 | unambiguously parse the optional argument. | |
ff962a3f PH |
372 | |
373 | * Use `*` to mean that this option should not be listed in the usage | |
374 | generated for the `-h` argument. It's shown for `--help-all` as | |
a5af0e2c | 375 | documented in linkgit:gitcli[7]. |
ff962a3f PH |
376 | |
377 | * Use `!` to not make the corresponding negated long option available. | |
21d47835 | 378 | |
e703d711 JH |
379 | `<arg-hint>`:: |
380 | `<arg-hint>`, if specified, is used as a name of the argument in the | |
381 | help output, for options that take arguments. `<arg-hint>` is | |
382 | terminated by the first whitespace. It is customary to use a | |
383 | dash to separate words in a multi-word argument hint. | |
9bab5b60 | 384 | |
21d47835 PH |
385 | The remainder of the line, after stripping the spaces, is used |
386 | as the help associated to the option. | |
387 | ||
388 | Blank lines are ignored, and lines that don't match this specification are used | |
389 | as option group headers (start the line with a space to create such | |
390 | lines on purpose). | |
391 | ||
392 | Example | |
393 | ~~~~~~~ | |
394 | ||
395 | ------------ | |
396 | OPTS_SPEC="\ | |
de613050 | 397 | some-command [<options>] <args>... |
21d47835 PH |
398 | |
399 | some-command does foo and bar! | |
400 | -- | |
aa43619b | 401 | h,help! show the help |
21d47835 PH |
402 | |
403 | foo some nifty option --foo | |
404 | bar= some cool option --bar with an argument | |
9bab5b60 IB |
405 | baz=arg another cool option --baz with a named argument |
406 | qux?path qux may take a path argument but has meaning by itself | |
21d47835 PH |
407 | |
408 | An option group Header | |
409 | C? option C with an optional argument" | |
410 | ||
ac2e1e63 | 411 | eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)" |
21d47835 PH |
412 | ------------ |
413 | ||
9bab5b60 IB |
414 | |
415 | Usage text | |
416 | ~~~~~~~~~~ | |
417 | ||
418 | When `"$@"` is `-h` or `--help` in the above example, the following | |
419 | usage text would be shown: | |
420 | ||
421 | ------------ | |
de613050 | 422 | usage: some-command [<options>] <args>... |
9bab5b60 IB |
423 | |
424 | some-command does foo and bar! | |
425 | ||
426 | -h, --help show the help | |
e8e5d294 RS |
427 | --[no-]foo some nifty option --foo |
428 | --[no-]bar ... some cool option --bar with an argument | |
429 | --[no-]baz <arg> another cool option --baz with a named argument | |
430 | --[no-]qux[=<path>] qux may take a path argument but has meaning by itself | |
9bab5b60 IB |
431 | |
432 | An option group Header | |
433 | -C[...] option C with an optional argument | |
434 | ------------ | |
435 | ||
50325377 CC |
436 | SQ-QUOTE |
437 | -------- | |
438 | ||
0b444cdb | 439 | In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a |
50325377 CC |
440 | single line suitable for `sh(1)` `eval`. This line is made by |
441 | normalizing the arguments following `--sq-quote`. Nothing other than | |
442 | quoting the arguments is done. | |
443 | ||
444 | If you want command input to still be interpreted as usual by | |
0b444cdb | 445 | 'git rev-parse' before the output is shell quoted, see the `--sq` |
50325377 CC |
446 | option. |
447 | ||
448 | Example | |
449 | ~~~~~~~ | |
450 | ||
451 | ------------ | |
452 | $ cat >your-git-script.sh <<\EOF | |
453 | #!/bin/sh | |
454 | args=$(git rev-parse --sq-quote "$@") # quote user-supplied arguments | |
455 | command="git frotz -n24 $args" # and use it inside a handcrafted | |
456 | # command line | |
457 | eval "$command" | |
458 | EOF | |
459 | ||
460 | $ sh your-git-script.sh "a b'c" | |
461 | ------------ | |
462 | ||
824b5dc2 CC |
463 | EXAMPLES |
464 | -------- | |
465 | ||
466 | * Print the object name of the current commit: | |
467 | + | |
468 | ------------ | |
469 | $ git rev-parse --verify HEAD | |
470 | ------------ | |
471 | ||
472 | * Print the commit object name from the revision in the $REV shell variable: | |
473 | + | |
474 | ------------ | |
3a1f91cf | 475 | $ git rev-parse --verify --end-of-options $REV^{commit} |
824b5dc2 CC |
476 | ------------ |
477 | + | |
478 | This will error out if $REV is empty or not a valid revision. | |
479 | ||
2db60670 | 480 | * Similar to above: |
824b5dc2 CC |
481 | + |
482 | ------------ | |
3a1f91cf | 483 | $ git rev-parse --default master --verify --end-of-options $REV |
824b5dc2 CC |
484 | ------------ |
485 | + | |
486 | but if $REV is empty, the commit object name from master will be printed. | |
487 | ||
7fc9d69f JH |
488 | GIT |
489 | --- | |
9e1f0a85 | 490 | Part of the linkgit:git[1] suite |