]>
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 | |
39 | mode does only quoting. Nothing else is done to command input. | |
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. | |
5077fa9c | 112 | |
3240240f SB |
113 | -q:: |
114 | --quiet:: | |
b1b35969 CC |
115 | Only meaningful in `--verify` mode. Do not output an error |
116 | message if the first argument is not a valid object name; | |
117 | instead exit with non-zero status silently. | |
56625df7 | 118 | SHA-1s for valid object names are printed to stdout on success. |
b1b35969 | 119 | |
5077fa9c JH |
120 | --sq:: |
121 | Usually the output is made one line per flag and | |
122 | parameter. This option makes output a single line, | |
123 | properly quoted for consumption by shell. Useful when | |
124 | you expect your parameter to contain whitespaces and | |
125 | newlines (e.g. when using pickaxe `-S` with | |
4cacbf67 | 126 | 'git diff-{asterisk}'). In contrast to the `--sq-quote` option, |
50325377 | 127 | the command input is still interpreted as usual. |
5077fa9c | 128 | |
fb87327a AH |
129 | --short[=length]:: |
130 | Same as `--verify` but shortens the object name to a unique | |
131 | prefix with at least `length` characters. The minimum length | |
132 | is 4, the default is the effective value of the `core.abbrev` | |
133 | configuration variable (see linkgit:git-config[1]). | |
134 | ||
5077fa9c | 135 | --not:: |
babfaba2 JF |
136 | When showing object names, prefix them with '{caret}' and |
137 | strip '{caret}' prefix from the object names that already have | |
5077fa9c JH |
138 | one. |
139 | ||
49c63913 JK |
140 | --abbrev-ref[=(strict|loose)]:: |
141 | A non-ambiguous short name of the objects name. | |
142 | The option core.warnAmbiguousRefs is used to select the strict | |
143 | abbreviation mode. | |
144 | ||
5077fa9c | 145 | --symbolic:: |
d5fa1f1a | 146 | Usually the object names are output in SHA-1 form (with |
babfaba2 | 147 | possible '{caret}' prefix); this option makes them output in a |
5077fa9c JH |
148 | form as close to the original input as possible. |
149 | ||
a6d97d49 | 150 | --symbolic-full-name:: |
1c262bb7 | 151 | This is similar to --symbolic, but it omits input that |
a6d97d49 JH |
152 | are not refs (i.e. branch or tag names; or more |
153 | explicitly disambiguating "heads/master" form, when you | |
154 | want to name the "master" branch when there is an | |
155 | unfortunately named tag "master"), and show them as full | |
156 | refnames (e.g. "refs/heads/master"). | |
5077fa9c | 157 | |
49c63913 JK |
158 | Options for Objects |
159 | ~~~~~~~~~~~~~~~~~~~ | |
957d7406 | 160 | |
5077fa9c | 161 | --all:: |
cc1b8d8b | 162 | Show all refs found in `refs/`. |
5077fa9c | 163 | |
b09fe971 | 164 | --branches[=pattern]:: |
b09fe971 | 165 | --tags[=pattern]:: |
b09fe971 | 166 | --remotes[=pattern]:: |
e2b53e58 | 167 | Show all branches, tags, or remote-tracking branches, |
cc1b8d8b JK |
168 | respectively (i.e., refs found in `refs/heads`, |
169 | `refs/tags`, or `refs/remotes`, respectively). | |
e2b53e58 TR |
170 | + |
171 | If a `pattern` is given, only refs matching the given shell glob are | |
172 | shown. If the pattern does not contain a globbing character (`?`, | |
6cf378f0 | 173 | `*`, or `[`), it is turned into a prefix match by appending `/*`. |
e2b53e58 TR |
174 | |
175 | --glob=pattern:: | |
176 | Show all refs matching the shell glob pattern `pattern`. If | |
177 | the pattern does not start with `refs/`, this is automatically | |
178 | prepended. If the pattern does not contain a globbing | |
6cf378f0 JK |
179 | character (`?`, `*`, or `[`), it is turned into a prefix |
180 | match by appending `/*`. | |
a62be77f | 181 | |
9dc01bf0 JH |
182 | --exclude=<glob-pattern>:: |
183 | Do not include refs matching '<glob-pattern>' that the next `--all`, | |
184 | `--branches`, `--tags`, `--remotes`, or `--glob` would otherwise | |
185 | consider. Repetitions of this option accumulate exclusion patterns | |
186 | up to the next `--all`, `--branches`, `--tags`, `--remotes`, or | |
187 | `--glob` option (other options or arguments do not clear | |
f745acb0 | 188 | accumulated patterns). |
9dc01bf0 JH |
189 | + |
190 | The patterns given should not begin with `refs/heads`, `refs/tags`, or | |
191 | `refs/remotes` when applied to `--branches`, `--tags`, or `--remotes`, | |
192 | respectively, and they must begin with `refs/` when applied to `--glob` | |
193 | or `--all`. If a trailing '/{asterisk}' is intended, it must be given | |
194 | explicitly. | |
195 | ||
49c63913 JK |
196 | --disambiguate=<prefix>:: |
197 | Show every object whose name begins with the given prefix. | |
198 | The <prefix> must be at least 4 hexadecimal digits long to | |
199 | avoid listing each and every object in the repository by | |
200 | mistake. | |
7cceca5c | 201 | |
49c63913 JK |
202 | Options for Files |
203 | ~~~~~~~~~~~~~~~~~ | |
7fc9d69f | 204 | |
49c63913 JK |
205 | --local-env-vars:: |
206 | List the GIT_* environment variables that are local to the | |
207 | repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR). | |
208 | Only the names of the variables are listed, not their value, | |
209 | even if they are set. | |
5f94c730 | 210 | |
735d80b3 | 211 | --git-dir:: |
80d868b0 | 212 | Show `$GIT_DIR` if defined. Otherwise show the path to |
d0740ce0 JS |
213 | the .git directory. The path shown, when relative, is |
214 | relative to the current working directory. | |
80d868b0 JN |
215 | + |
216 | If `$GIT_DIR` is not defined and the current directory | |
2de9b711 | 217 | is not detected to lie in a Git repository or work tree |
80d868b0 | 218 | print a message to stderr and exit with nonzero status. |
735d80b3 | 219 | |
a2f5a876 SG |
220 | --absolute-git-dir:: |
221 | Like `--git-dir`, but its output is always the canonicalized | |
222 | absolute path. | |
223 | ||
31e26ebc NTND |
224 | --git-common-dir:: |
225 | Show `$GIT_COMMON_DIR` if defined, else `$GIT_DIR`. | |
226 | ||
c9bf7be2 | 227 | --is-inside-git-dir:: |
4faac246 ML |
228 | When the current working directory is below the repository |
229 | directory print "true", otherwise "false". | |
230 | ||
892c41b9 ML |
231 | --is-inside-work-tree:: |
232 | When the current working directory is inside the work tree of the | |
233 | repository print "true", otherwise "false". | |
234 | ||
493c774e ML |
235 | --is-bare-repository:: |
236 | When the repository is bare print "true", otherwise "false". | |
c9bf7be2 | 237 | |
417abfde ØW |
238 | --is-shallow-repository:: |
239 | When the repository is shallow print "true", otherwise "false". | |
240 | ||
49c63913 JK |
241 | --resolve-git-dir <path>:: |
242 | Check if <path> is a valid repository or a gitfile that | |
243 | points at a valid repository, and print the location of the | |
244 | repository. If <path> is a gitfile then the resolved path | |
245 | to the real repository is printed. | |
94c8ccaa | 246 | |
557bd833 NTND |
247 | --git-path <path>:: |
248 | Resolve "$GIT_DIR/<path>" and takes other path relocation | |
249 | variables such as $GIT_OBJECT_DIRECTORY, | |
250 | $GIT_INDEX_FILE... into account. For example, if | |
251 | $GIT_OBJECT_DIRECTORY is set to /foo/bar then "git rev-parse | |
252 | --git-path objects/abc" returns /foo/bar/abc. | |
253 | ||
49c63913 JK |
254 | --show-cdup:: |
255 | When the command is invoked from a subdirectory, show the | |
256 | path of the top-level directory relative to the current | |
257 | directory (typically a sequence of "../", or an empty string). | |
258 | ||
259 | --show-prefix:: | |
260 | When the command is invoked from a subdirectory, show the | |
261 | path of the current directory relative to the top-level | |
262 | directory. | |
263 | ||
264 | --show-toplevel:: | |
2d92ab32 JK |
265 | Show the absolute path of the top-level directory of the working |
266 | tree. If there is no working tree, report an error. | |
49c63913 | 267 | |
e38c681f | 268 | --show-superproject-working-tree:: |
bf0231c6 SB |
269 | Show the absolute path of the root of the superproject's |
270 | working tree (if exists) that uses the current repository as | |
271 | its submodule. Outputs nothing if the current repository is | |
272 | not used as a submodule by any project. | |
273 | ||
a76295da NTND |
274 | --shared-index-path:: |
275 | Show the path to the shared index file in split index mode, or | |
276 | empty if not in split-index mode. | |
277 | ||
2eabd383 | 278 | --show-object-format[=(storage|input|output)]:: |
279 | Show the object format (hash algorithm) used for the repository | |
280 | for storage inside the `.git` directory, input, or output. For | |
281 | input, multiple algorithms may be printed, space-separated. | |
282 | If not specified, the default is "storage". | |
283 | ||
284 | ||
49c63913 JK |
285 | Other Options |
286 | ~~~~~~~~~~~~~ | |
735d80b3 | 287 | |
3240240f SB |
288 | --since=datestring:: |
289 | --after=datestring:: | |
483bc4f0 | 290 | Parse the date string, and output the corresponding |
0b444cdb | 291 | --max-age= parameter for 'git rev-list'. |
a3114b34 | 292 | |
3240240f SB |
293 | --until=datestring:: |
294 | --before=datestring:: | |
483bc4f0 | 295 | Parse the date string, and output the corresponding |
0b444cdb | 296 | --min-age= parameter for 'git rev-list'. |
a3114b34 | 297 | |
7fc9d69f | 298 | <args>...:: |
5077fa9c | 299 | Flags and parameters to be parsed. |
7fc9d69f JH |
300 | |
301 | ||
5a8f3117 | 302 | include::revisions.txt[] |
be4c7014 | 303 | |
21d47835 PH |
304 | PARSEOPT |
305 | -------- | |
306 | ||
0b444cdb | 307 | In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell |
21d47835 PH |
308 | scripts the same facilities C builtins have. It works as an option normalizer |
309 | (e.g. splits single switches aggregate values), a bit like `getopt(1)` does. | |
310 | ||
311 | It takes on the standard input the specification of the options to parse and | |
ac2e1e63 | 312 | understand, and echoes on the standard output a string suitable for `sh(1)` `eval` |
21d47835 PH |
313 | to replace the arguments with normalized ones. In case of error, it outputs |
314 | usage on the standard error stream, and exits with code 129. | |
315 | ||
ac2e1e63 TR |
316 | Note: Make sure you quote the result when passing it to `eval`. See |
317 | below for an example. | |
318 | ||
21d47835 PH |
319 | Input Format |
320 | ~~~~~~~~~~~~ | |
321 | ||
0b444cdb | 322 | 'git rev-parse --parseopt' input format is fully text based. It has two parts, |
21d47835 | 323 | separated by a line that contains only `--`. The lines before the separator |
9bab5b60 | 324 | (should be one or more) are used for the usage. |
21d47835 PH |
325 | The lines after the separator describe the options. |
326 | ||
327 | Each line of options has this format: | |
328 | ||
329 | ------------ | |
e703d711 | 330 | <opt-spec><flags>*<arg-hint>? SP+ help LF |
21d47835 PH |
331 | ------------ |
332 | ||
e703d711 | 333 | `<opt-spec>`:: |
21d47835 PH |
334 | its format is the short option character, then the long option name |
335 | separated by a comma. Both parts are not required, though at least one | |
2d893dff IB |
336 | is necessary. May not contain any of the `<flags>` characters. |
337 | `h,help`, `dry-run` and `f` are examples of correct `<opt-spec>`. | |
21d47835 | 338 | |
ff962a3f PH |
339 | `<flags>`:: |
340 | `<flags>` are of `*`, `=`, `?` or `!`. | |
341 | * Use `=` if the option takes an argument. | |
342 | ||
f8c87212 NV |
343 | * Use `?` to mean that the option takes an optional argument. You |
344 | probably want to use the `--stuck-long` mode to be able to | |
345 | unambiguously parse the optional argument. | |
ff962a3f PH |
346 | |
347 | * Use `*` to mean that this option should not be listed in the usage | |
348 | generated for the `-h` argument. It's shown for `--help-all` as | |
a5af0e2c | 349 | documented in linkgit:gitcli[7]. |
ff962a3f PH |
350 | |
351 | * Use `!` to not make the corresponding negated long option available. | |
21d47835 | 352 | |
e703d711 JH |
353 | `<arg-hint>`:: |
354 | `<arg-hint>`, if specified, is used as a name of the argument in the | |
355 | help output, for options that take arguments. `<arg-hint>` is | |
356 | terminated by the first whitespace. It is customary to use a | |
357 | dash to separate words in a multi-word argument hint. | |
9bab5b60 | 358 | |
21d47835 PH |
359 | The remainder of the line, after stripping the spaces, is used |
360 | as the help associated to the option. | |
361 | ||
362 | Blank lines are ignored, and lines that don't match this specification are used | |
363 | as option group headers (start the line with a space to create such | |
364 | lines on purpose). | |
365 | ||
366 | Example | |
367 | ~~~~~~~ | |
368 | ||
369 | ------------ | |
370 | OPTS_SPEC="\ | |
de613050 | 371 | some-command [<options>] <args>... |
21d47835 PH |
372 | |
373 | some-command does foo and bar! | |
374 | -- | |
375 | h,help show the help | |
376 | ||
377 | foo some nifty option --foo | |
378 | bar= some cool option --bar with an argument | |
9bab5b60 IB |
379 | baz=arg another cool option --baz with a named argument |
380 | qux?path qux may take a path argument but has meaning by itself | |
21d47835 PH |
381 | |
382 | An option group Header | |
383 | C? option C with an optional argument" | |
384 | ||
ac2e1e63 | 385 | eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)" |
21d47835 PH |
386 | ------------ |
387 | ||
9bab5b60 IB |
388 | |
389 | Usage text | |
390 | ~~~~~~~~~~ | |
391 | ||
392 | When `"$@"` is `-h` or `--help` in the above example, the following | |
393 | usage text would be shown: | |
394 | ||
395 | ------------ | |
de613050 | 396 | usage: some-command [<options>] <args>... |
9bab5b60 IB |
397 | |
398 | some-command does foo and bar! | |
399 | ||
400 | -h, --help show the help | |
401 | --foo some nifty option --foo | |
402 | --bar ... some cool option --bar with an argument | |
a2df5211 | 403 | --baz <arg> another cool option --baz with a named argument |
9bab5b60 IB |
404 | --qux[=<path>] qux may take a path argument but has meaning by itself |
405 | ||
406 | An option group Header | |
407 | -C[...] option C with an optional argument | |
408 | ------------ | |
409 | ||
50325377 CC |
410 | SQ-QUOTE |
411 | -------- | |
412 | ||
0b444cdb | 413 | In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a |
50325377 CC |
414 | single line suitable for `sh(1)` `eval`. This line is made by |
415 | normalizing the arguments following `--sq-quote`. Nothing other than | |
416 | quoting the arguments is done. | |
417 | ||
418 | If you want command input to still be interpreted as usual by | |
0b444cdb | 419 | 'git rev-parse' before the output is shell quoted, see the `--sq` |
50325377 CC |
420 | option. |
421 | ||
422 | Example | |
423 | ~~~~~~~ | |
424 | ||
425 | ------------ | |
426 | $ cat >your-git-script.sh <<\EOF | |
427 | #!/bin/sh | |
428 | args=$(git rev-parse --sq-quote "$@") # quote user-supplied arguments | |
429 | command="git frotz -n24 $args" # and use it inside a handcrafted | |
430 | # command line | |
431 | eval "$command" | |
432 | EOF | |
433 | ||
434 | $ sh your-git-script.sh "a b'c" | |
435 | ------------ | |
436 | ||
824b5dc2 CC |
437 | EXAMPLES |
438 | -------- | |
439 | ||
440 | * Print the object name of the current commit: | |
441 | + | |
442 | ------------ | |
443 | $ git rev-parse --verify HEAD | |
444 | ------------ | |
445 | ||
446 | * Print the commit object name from the revision in the $REV shell variable: | |
447 | + | |
448 | ------------ | |
2db60670 | 449 | $ git rev-parse --verify $REV^{commit} |
824b5dc2 CC |
450 | ------------ |
451 | + | |
452 | This will error out if $REV is empty or not a valid revision. | |
453 | ||
2db60670 | 454 | * Similar to above: |
824b5dc2 CC |
455 | + |
456 | ------------ | |
457 | $ git rev-parse --default master --verify $REV | |
458 | ------------ | |
459 | + | |
460 | but if $REV is empty, the commit object name from master will be printed. | |
461 | ||
7fc9d69f JH |
462 | GIT |
463 | --- | |
9e1f0a85 | 464 | Part of the linkgit:git[1] suite |