blob: 0d2cdcde556662d9d858dc282a9fced469814337 [file] [log] [blame]
Junio C Hamano7fc9d692005-08-23 01:49:47 -07001git-rev-parse(1)
2================
3
4NAME
5----
Fredrik Kuivinen7bd7f282006-03-09 17:24:50 +01006git-rev-parse - Pick out and massage parameters
Junio C Hamano7fc9d692005-08-23 01:49:47 -07007
8
9SYNOPSIS
10--------
Martin von Zweigbergk7791a1d2011-07-01 22:38:26 -040011[verse]
Jonathan Niederb1889c32008-06-30 01:09:04 -050012'git rev-parse' [ --option ] <args>...
Junio C Hamano7fc9d692005-08-23 01:49:47 -070013
14DESCRIPTION
15-----------
Junio C Hamano5077fa92005-09-07 14:08:38 -070016
Thomas Ackermann2de9b712013-01-21 20:17:53 +010017Many Git porcelainish commands take mixture of flags
Junio C Hamano5077fa92005-09-07 14:08:38 -070018(i.e. parameters that begin with a dash '-') and parameters
Thomas Rast0b444cd2010-01-10 00:33:00 +010019meant for the underlying 'git rev-list' command they use internally
Jonathan Nieder483bc4f2008-06-30 13:56:34 -050020and flags and parameters for the other commands they use
Thomas Rast0b444cd2010-01-10 00:33:00 +010021downstream of 'git rev-list'. This command is used to
Junio C Hamano5077fa92005-09-07 14:08:38 -070022distinguish between them.
Junio C Hamano7fc9d692005-08-23 01:49:47 -070023
24
25OPTIONS
26-------
John Keeping49c63912013-07-21 13:49:27 +010027
28Operation Modes
29~~~~~~~~~~~~~~~
30
31Each of these options must appear first on the command line.
32
Pierre Habouzit21d47832007-11-04 11:30:53 +010033--parseopt::
Thomas Rast0b444cd2010-01-10 00:33:00 +010034 Use 'git rev-parse' in option parsing mode (see PARSEOPT section below).
Pierre Habouzit21d47832007-11-04 11:30:53 +010035
John Keeping49c63912013-07-21 13:49:27 +010036--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
41Options for --parseopt
42~~~~~~~~~~~~~~~~~~~~~~
43
Uwe Kleine-König2163e3f72009-04-28 22:29:24 +020044--keep-dashdash::
Pierre Habouzit21d47832007-11-04 11:30:53 +010045 Only meaningful in `--parseopt` mode. Tells the option parser to echo
46 out the first `--` met instead of skipping it.
47
Uwe Kleine-König6e0800e2009-06-14 01:58:43 +020048--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
Ralf Wildenhues6a5d0b02010-01-31 14:24:39 +010051 that take options themselves.
Uwe Kleine-König6e0800e2009-06-14 01:58:43 +020052
Nicolas Vigierf8c87212013-10-31 12:08:29 +010053--stuck-long::
54 Only meaningful in `--parseopt` mode. Output the options in their
55 long form if available, and with their arguments stuck.
56
John Keeping49c63912013-07-21 13:49:27 +010057Options for Filtering
58~~~~~~~~~~~~~~~~~~~~~
Christian Couder50325372009-04-25 06:55:26 +020059
Junio C Hamano5077fa92005-09-07 14:08:38 -070060--revs-only::
61 Do not output flags and parameters not meant for
Thomas Rast0b444cd2010-01-10 00:33:00 +010062 'git rev-list' command.
Junio C Hamano5077fa92005-09-07 14:08:38 -070063
64--no-revs::
65 Do not output flags and parameters meant for
Thomas Rast0b444cd2010-01-10 00:33:00 +010066 'git rev-list' command.
Junio C Hamano5077fa92005-09-07 14:08:38 -070067
68--flags::
69 Do not output non-flag parameters.
70
71--no-flags::
72 Do not output flag parameters.
73
John Keeping49c63912013-07-21 13:49:27 +010074Options for Output
75~~~~~~~~~~~~~~~~~~
76
Junio C Hamano5077fa92005-09-07 14:08:38 -070077--default <arg>::
78 If there is no parameter given by the user, use `<arg>`
79 instead.
80
John Keeping12b9d322013-06-16 15:18:17 +010081--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+
87This can be used to convert arguments to a command run in a subdirectory
88so that they can still be used after moving to the top-level of the
89repository. For example:
90+
91----
92prefix=$(git rev-parse --show-prefix)
93cd "$(git rev-parse --show-toplevel)"
94eval "set -- $(git rev-parse --sq --prefix "$prefix" "$@")"
95----
96
Junio C Hamano5077fa92005-09-07 14:08:38 -070097--verify::
Michael Haggerty2db60672013-03-30 07:44:25 +010098 Verify that exactly one parameter is provided, and that it
99 can be turned into a raw 20-byte SHA-1 that can be used to
100 access the object database. If so, emit it to the standard
101 output; otherwise, error out.
102+
103If you want to make sure that the output actually names an object in
104your object database and/or can be used as a specific type of object
Ondřej Bílka17b83d72013-07-22 23:02:23 +0200105you require, you can add "^{type}" peeling operator to the parameter.
Michael Haggerty2db60672013-03-30 07:44:25 +0100106For example, `git rev-parse "$VAR^{commit}"` will make sure `$VAR`
107names an existing object that is a commit-ish (i.e. a commit, or an
108annotated tag that points at a commit). To make sure that `$VAR`
109names an existing object of any type, `git rev-parse "$VAR^{object}"`
110can be used.
Junio C Hamano5077fa92005-09-07 14:08:38 -0700111
Stephan Beyer32402402008-06-08 03:36:09 +0200112-q::
113--quiet::
Christian Couderb1b35962008-04-26 13:57:23 +0200114 Only meaningful in `--verify` mode. Do not output an error
115 message if the first argument is not a valid object name;
116 instead exit with non-zero status silently.
117
Junio C Hamano5077fa92005-09-07 14:08:38 -0700118--sq::
119 Usually the output is made one line per flag and
120 parameter. This option makes output a single line,
121 properly quoted for consumption by shell. Useful when
122 you expect your parameter to contain whitespaces and
123 newlines (e.g. when using pickaxe `-S` with
Jonathan Nieder4cacbf62010-08-20 05:35:03 -0500124 'git diff-{asterisk}'). In contrast to the `--sq-quote` option,
Christian Couder50325372009-04-25 06:55:26 +0200125 the command input is still interpreted as usual.
Junio C Hamano5077fa92005-09-07 14:08:38 -0700126
127--not::
Jonas Fonsecababfaba2005-10-05 16:56:31 -0700128 When showing object names, prefix them with '{caret}' and
129 strip '{caret}' prefix from the object names that already have
Junio C Hamano5077fa92005-09-07 14:08:38 -0700130 one.
131
John Keeping49c63912013-07-21 13:49:27 +0100132--abbrev-ref[=(strict|loose)]::
133 A non-ambiguous short name of the objects name.
134 The option core.warnAmbiguousRefs is used to select the strict
135 abbreviation mode.
136
137--short::
138--short=number::
139 Instead of outputting the full SHA-1 values of object names try to
140 abbreviate them to a shorter unique name. When no length is specified
141 7 is used. The minimum length is 4.
142
Junio C Hamano5077fa92005-09-07 14:08:38 -0700143--symbolic::
Thomas Ackermannd5fa1f12013-04-15 19:49:04 +0200144 Usually the object names are output in SHA-1 form (with
Jonas Fonsecababfaba2005-10-05 16:56:31 -0700145 possible '{caret}' prefix); this option makes them output in a
Junio C Hamano5077fa92005-09-07 14:08:38 -0700146 form as close to the original input as possible.
147
Junio C Hamanoa6d97d42008-01-05 12:09:55 -0800148--symbolic-full-name::
149 This is similar to \--symbolic, but it omits input that
150 are not refs (i.e. branch or tag names; or more
151 explicitly disambiguating "heads/master" form, when you
152 want to name the "master" branch when there is an
153 unfortunately named tag "master"), and show them as full
154 refnames (e.g. "refs/heads/master").
Junio C Hamano5077fa92005-09-07 14:08:38 -0700155
John Keeping49c63912013-07-21 13:49:27 +0100156Options for Objects
157~~~~~~~~~~~~~~~~~~~
Junio C Hamano957d7402012-07-03 14:21:59 -0700158
Junio C Hamano5077fa92005-09-07 14:08:38 -0700159--all::
Jeff Kingcc1b8d82010-02-17 20:16:20 -0500160 Show all refs found in `refs/`.
Junio C Hamano5077fa92005-09-07 14:08:38 -0700161
Ilari Liusvaarab09fe972010-01-20 11:48:26 +0200162--branches[=pattern]::
Ilari Liusvaarab09fe972010-01-20 11:48:26 +0200163--tags[=pattern]::
Ilari Liusvaarab09fe972010-01-20 11:48:26 +0200164--remotes[=pattern]::
Thomas Raste2b53e52010-01-22 01:21:38 +0100165 Show all branches, tags, or remote-tracking branches,
Jeff Kingcc1b8d82010-02-17 20:16:20 -0500166 respectively (i.e., refs found in `refs/heads`,
167 `refs/tags`, or `refs/remotes`, respectively).
Thomas Raste2b53e52010-01-22 01:21:38 +0100168+
169If a `pattern` is given, only refs matching the given shell glob are
170shown. If the pattern does not contain a globbing character (`?`,
Jeff King6cf378f2012-04-26 04:51:57 -0400171`*`, or `[`), it is turned into a prefix match by appending `/*`.
Seana62be772006-05-13 21:43:00 -0400172
Thomas Raste2b53e52010-01-22 01:21:38 +0100173--glob=pattern::
174 Show all refs matching the shell glob pattern `pattern`. If
175 the pattern does not start with `refs/`, this is automatically
176 prepended. If the pattern does not contain a globbing
Jeff King6cf378f2012-04-26 04:51:57 -0400177 character (`?`, `*`, or `[`), it is turned into a prefix
178 match by appending `/*`.
Seana62be772006-05-13 21:43:00 -0400179
Junio C Hamano9dc01bf2013-11-01 12:13:01 -0700180--exclude=<glob-pattern>::
181 Do not include refs matching '<glob-pattern>' that the next `--all`,
182 `--branches`, `--tags`, `--remotes`, or `--glob` would otherwise
183 consider. Repetitions of this option accumulate exclusion patterns
184 up to the next `--all`, `--branches`, `--tags`, `--remotes`, or
185 `--glob` option (other options or arguments do not clear
186 accumlated patterns).
187+
188The patterns given should not begin with `refs/heads`, `refs/tags`, or
189`refs/remotes` when applied to `--branches`, `--tags`, or `--remotes`,
190respectively, and they must begin with `refs/` when applied to `--glob`
191or `--all`. If a trailing '/{asterisk}' is intended, it must be given
192explicitly.
193
John Keeping49c63912013-07-21 13:49:27 +0100194--disambiguate=<prefix>::
195 Show every object whose name begins with the given prefix.
196 The <prefix> must be at least 4 hexadecimal digits long to
197 avoid listing each and every object in the repository by
198 mistake.
Steven Drake7cceca52010-01-12 11:33:48 +1300199
John Keeping49c63912013-07-21 13:49:27 +0100200Options for Files
201~~~~~~~~~~~~~~~~~
Junio C Hamano7fc9d692005-08-23 01:49:47 -0700202
John Keeping49c63912013-07-21 13:49:27 +0100203--local-env-vars::
204 List the GIT_* environment variables that are local to the
205 repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
206 Only the names of the variables are listed, not their value,
207 even if they are set.
Junio C Hamano5f94c732005-12-22 22:35:38 -0800208
Jonas Fonseca735d80b2006-02-18 02:11:36 +0100209--git-dir::
Jonathan Nieder80d868b2010-11-26 22:32:31 +0700210 Show `$GIT_DIR` if defined. Otherwise show the path to
Jon Seymourd0740ce2012-05-18 19:23:24 +1000211 the .git directory. The path shown, when relative, is
212 relative to the current working directory.
Jonathan Nieder80d868b2010-11-26 22:32:31 +0700213+
214If `$GIT_DIR` is not defined and the current directory
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100215is not detected to lie in a Git repository or work tree
Jonathan Nieder80d868b2010-11-26 22:32:31 +0700216print a message to stderr and exit with nonzero status.
Jonas Fonseca735d80b2006-02-18 02:11:36 +0100217
Jakub Narebskic9bf7be2007-06-16 21:03:44 +0200218--is-inside-git-dir::
Matthias Lederhofer4faac242007-06-03 16:46:04 +0200219 When the current working directory is below the repository
220 directory print "true", otherwise "false".
221
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200222--is-inside-work-tree::
223 When the current working directory is inside the work tree of the
224 repository print "true", otherwise "false".
225
Matthias Lederhofer493c7742007-06-03 16:46:36 +0200226--is-bare-repository::
227 When the repository is bare print "true", otherwise "false".
Jakub Narebskic9bf7be2007-06-16 21:03:44 +0200228
John Keeping49c63912013-07-21 13:49:27 +0100229--resolve-git-dir <path>::
230 Check if <path> is a valid repository or a gitfile that
231 points at a valid repository, and print the location of the
232 repository. If <path> is a gitfile then the resolved path
233 to the real repository is printed.
Giuseppe Bilotta94c8cca2010-02-25 00:34:15 +0100234
John Keeping49c63912013-07-21 13:49:27 +0100235--show-cdup::
236 When the command is invoked from a subdirectory, show the
237 path of the top-level directory relative to the current
238 directory (typically a sequence of "../", or an empty string).
239
240--show-prefix::
241 When the command is invoked from a subdirectory, show the
242 path of the current directory relative to the top-level
243 directory.
244
245--show-toplevel::
246 Show the absolute path of the top-level directory.
247
248Other Options
249~~~~~~~~~~~~~
Jonas Fonseca735d80b2006-02-18 02:11:36 +0100250
Stephan Beyer32402402008-06-08 03:36:09 +0200251--since=datestring::
252--after=datestring::
Jonathan Nieder483bc4f2008-06-30 13:56:34 -0500253 Parse the date string, and output the corresponding
Thomas Rast0b444cd2010-01-10 00:33:00 +0100254 --max-age= parameter for 'git rev-list'.
Junio C Hamanoa3114b32005-11-02 23:41:25 -0800255
Stephan Beyer32402402008-06-08 03:36:09 +0200256--until=datestring::
257--before=datestring::
Jonathan Nieder483bc4f2008-06-30 13:56:34 -0500258 Parse the date string, and output the corresponding
Thomas Rast0b444cd2010-01-10 00:33:00 +0100259 --min-age= parameter for 'git rev-list'.
Junio C Hamanoa3114b32005-11-02 23:41:25 -0800260
Junio C Hamano7fc9d692005-08-23 01:49:47 -0700261<args>...::
Junio C Hamano5077fa92005-09-07 14:08:38 -0700262 Flags and parameters to be parsed.
Junio C Hamano7fc9d692005-08-23 01:49:47 -0700263
264
Michael J Gruber5a8f3112010-07-05 18:11:39 +0200265include::revisions.txt[]
Junio C Hamanobe4c7012006-07-06 22:37:51 -0700266
Pierre Habouzit21d47832007-11-04 11:30:53 +0100267PARSEOPT
268--------
269
Thomas Rast0b444cd2010-01-10 00:33:00 +0100270In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell
Pierre Habouzit21d47832007-11-04 11:30:53 +0100271scripts the same facilities C builtins have. It works as an option normalizer
272(e.g. splits single switches aggregate values), a bit like `getopt(1)` does.
273
274It takes on the standard input the specification of the options to parse and
Thomas Rastac2e1e62010-07-30 17:01:50 +0200275understand, and echoes on the standard output a string suitable for `sh(1)` `eval`
Pierre Habouzit21d47832007-11-04 11:30:53 +0100276to replace the arguments with normalized ones. In case of error, it outputs
277usage on the standard error stream, and exits with code 129.
278
Thomas Rastac2e1e62010-07-30 17:01:50 +0200279Note: Make sure you quote the result when passing it to `eval`. See
280below for an example.
281
Pierre Habouzit21d47832007-11-04 11:30:53 +0100282Input Format
283~~~~~~~~~~~~
284
Thomas Rast0b444cd2010-01-10 00:33:00 +0100285'git rev-parse --parseopt' input format is fully text based. It has two parts,
Pierre Habouzit21d47832007-11-04 11:30:53 +0100286separated by a line that contains only `--`. The lines before the separator
287(should be more than one) are used for the usage.
288The lines after the separator describe the options.
289
290Each line of options has this format:
291
292------------
Pierre Habouzitff962a32008-03-02 09:21:38 +0100293<opt_spec><flags>* SP+ help LF
Pierre Habouzit21d47832007-11-04 11:30:53 +0100294------------
295
296`<opt_spec>`::
297 its format is the short option character, then the long option name
298 separated by a comma. Both parts are not required, though at least one
299 is necessary. `h,help`, `dry-run` and `f` are all three correct
300 `<opt_spec>`.
301
Pierre Habouzitff962a32008-03-02 09:21:38 +0100302`<flags>`::
303 `<flags>` are of `*`, `=`, `?` or `!`.
304 * Use `=` if the option takes an argument.
305
Nicolas Vigierf8c87212013-10-31 12:08:29 +0100306 * Use `?` to mean that the option takes an optional argument. You
307 probably want to use the `--stuck-long` mode to be able to
308 unambiguously parse the optional argument.
Pierre Habouzitff962a32008-03-02 09:21:38 +0100309
310 * Use `*` to mean that this option should not be listed in the usage
311 generated for the `-h` argument. It's shown for `--help-all` as
Christian Coudera5af0e22008-05-02 05:30:47 +0200312 documented in linkgit:gitcli[7].
Pierre Habouzitff962a32008-03-02 09:21:38 +0100313
314 * Use `!` to not make the corresponding negated long option available.
Pierre Habouzit21d47832007-11-04 11:30:53 +0100315
316The remainder of the line, after stripping the spaces, is used
317as the help associated to the option.
318
319Blank lines are ignored, and lines that don't match this specification are used
320as option group headers (start the line with a space to create such
321lines on purpose).
322
323Example
324~~~~~~~
325
326------------
327OPTS_SPEC="\
328some-command [options] <args>...
329
330some-command does foo and bar!
331--
332h,help show the help
333
334foo some nifty option --foo
335bar= some cool option --bar with an argument
336
337 An option group Header
338C? option C with an optional argument"
339
Thomas Rastac2e1e62010-07-30 17:01:50 +0200340eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"
Pierre Habouzit21d47832007-11-04 11:30:53 +0100341------------
342
Christian Couder50325372009-04-25 06:55:26 +0200343SQ-QUOTE
344--------
345
Thomas Rast0b444cd2010-01-10 00:33:00 +0100346In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a
Christian Couder50325372009-04-25 06:55:26 +0200347single line suitable for `sh(1)` `eval`. This line is made by
348normalizing the arguments following `--sq-quote`. Nothing other than
349quoting the arguments is done.
350
351If you want command input to still be interpreted as usual by
Thomas Rast0b444cd2010-01-10 00:33:00 +0100352'git rev-parse' before the output is shell quoted, see the `--sq`
Christian Couder50325372009-04-25 06:55:26 +0200353option.
354
355Example
356~~~~~~~
357
358------------
359$ cat >your-git-script.sh <<\EOF
360#!/bin/sh
361args=$(git rev-parse --sq-quote "$@") # quote user-supplied arguments
362command="git frotz -n24 $args" # and use it inside a handcrafted
363 # command line
364eval "$command"
365EOF
366
367$ sh your-git-script.sh "a b'c"
368------------
369
Christian Couder824b5dc2008-05-13 06:51:41 +0200370EXAMPLES
371--------
372
373* Print the object name of the current commit:
374+
375------------
376$ git rev-parse --verify HEAD
377------------
378
379* Print the commit object name from the revision in the $REV shell variable:
380+
381------------
Michael Haggerty2db60672013-03-30 07:44:25 +0100382$ git rev-parse --verify $REV^{commit}
Christian Couder824b5dc2008-05-13 06:51:41 +0200383------------
384+
385This will error out if $REV is empty or not a valid revision.
386
Michael Haggerty2db60672013-03-30 07:44:25 +0100387* Similar to above:
Christian Couder824b5dc2008-05-13 06:51:41 +0200388+
389------------
390$ git rev-parse --default master --verify $REV
391------------
392+
393but if $REV is empty, the commit object name from master will be printed.
394
Junio C Hamano7fc9d692005-08-23 01:49:47 -0700395GIT
396---
Christian Couder9e1f0a82008-06-06 09:07:32 +0200397Part of the linkgit:git[1] suite