blob: 6825ae27c450225a7d6e0948797a606c32bbbe0d [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231git-rev-parse(1)
2================
3
4NAME
5----
Junio C Hamano01078922006-03-10 00:31:476git-rev-parse - Pick out and massage parameters
Junio C Hamano1a4e8412005-12-27 08:17:237
8
9SYNOPSIS
10--------
Junio C Hamanofce7c7e2008-07-02 03:06:3811'git rev-parse' [ --option ] <args>...
Junio C Hamano1a4e8412005-12-27 08:17:2312
13DESCRIPTION
14-----------
15
Junio C Hamano341071d2006-06-04 07:24:4816Many git porcelainish commands take mixture of flags
Junio C Hamano1a4e8412005-12-27 08:17:2317(i.e. parameters that begin with a dash '-') and parameters
Junio C Hamanofce7c7e2008-07-02 03:06:3818meant for the underlying `git-rev-list` command they use internally
19and flags and parameters for the other commands they use
Junio C Hamano1a4e8412005-12-27 08:17:2320downstream of `git-rev-list`. This command is used to
21distinguish between them.
22
23
24OPTIONS
25-------
Junio C Hamanoe1258662007-11-19 05:03:1926--parseopt::
27Use `git-rev-parse` in option parsing mode (see PARSEOPT section below).
28
29--keep-dash-dash::
30Only meaningful in `--parseopt` mode. Tells the option parser to echo
31out the first `--` met instead of skipping it.
32
Junio C Hamano1a4e8412005-12-27 08:17:2333--revs-only::
34Do not output flags and parameters not meant for
35`git-rev-list` command.
36
37--no-revs::
38Do not output flags and parameters meant for
39`git-rev-list` command.
40
41--flags::
42Do not output non-flag parameters.
43
44--no-flags::
45Do not output flag parameters.
46
47--default <arg>::
48If there is no parameter given by the user, use `<arg>`
49instead.
50
51--verify::
52The parameter given must be usable as a single, valid
53object name. Otherwise barf and abort.
54
Junio C Hamanoeb415992008-06-08 22:49:4755-q::
56--quiet::
Junio C Hamano9ab87672008-04-28 08:40:2957Only meaningful in `--verify` mode. Do not output an error
58message if the first argument is not a valid object name;
59instead exit with non-zero status silently.
60
Junio C Hamano1a4e8412005-12-27 08:17:2361--sq::
62Usually the output is made one line per flag and
63parameter. This option makes output a single line,
64properly quoted for consumption by shell. Useful when
65you expect your parameter to contain whitespaces and
66newlines (e.g. when using pickaxe `-S` with
67`git-diff-\*`).
68
69--not::
70When showing object names, prefix them with '{caret}' and
71strip '{caret}' prefix from the object names that already have
72one.
73
74--symbolic::
75Usually the object names are output in SHA1 form (with
76possible '{caret}' prefix); this option makes them output in a
77form as close to the original input as possible.
78
Junio C Hamano35738e82008-01-07 07:55:4679--symbolic-full-name::
80This is similar to \--symbolic, but it omits input that
81are not refs (i.e. branch or tag names; or more
82explicitly disambiguating "heads/master" form, when you
83want to name the "master" branch when there is an
84unfortunately named tag "master"), and show them as full
85refnames (e.g. "refs/heads/master").
Junio C Hamano1a4e8412005-12-27 08:17:2386
87--all::
88Show all refs found in `$GIT_DIR/refs`.
89
Junio C Hamano6959c6c2006-05-17 10:34:1190--branches::
91Show branch refs found in `$GIT_DIR/refs/heads`.
92
93--tags::
94Show tag refs found in `$GIT_DIR/refs/tags`.
95
96--remotes::
97Show tag refs found in `$GIT_DIR/refs/remotes`.
98
Junio C Hamano1a4e8412005-12-27 08:17:2399--show-prefix::
100When the command is invoked from a subdirectory, show the
101path of the current directory relative to the top-level
102directory.
103
104--show-cdup::
105When the command is invoked from a subdirectory, show the
106path of the top-level directory relative to the current
107directory (typically a sequence of "../", or an empty string).
108
Junio C Hamanoe246e3b2006-02-19 08:45:18109--git-dir::
110Show `$GIT_DIR` if defined else show the path to the .git directory.
111
Junio C Hamanoee695f22007-06-21 00:35:36112--is-inside-git-dir::
Junio C Hamanod526ba92007-07-02 00:17:42113When the current working directory is below the repository
114directory print "true", otherwise "false".
115
116--is-inside-work-tree::
117When the current working directory is inside the work tree of the
118repository print "true", otherwise "false".
119
120--is-bare-repository::
121When the repository is bare print "true", otherwise "false".
Junio C Hamanoee695f22007-06-21 00:35:36122
Junio C Hamanoeb415992008-06-08 22:49:47123--short::
124--short=number::
Junio C Hamanoe246e3b2006-02-19 08:45:18125Instead of outputting the full SHA1 values of object names try to
Junio C Hamano341071d2006-06-04 07:24:48126abbreviate them to a shorter unique name. When no length is specified
Junio C Hamanoe246e3b2006-02-19 08:45:181277 is used. The minimum length is 4.
128
Junio C Hamanoeb415992008-06-08 22:49:47129--since=datestring::
130--after=datestring::
Junio C Hamanofce7c7e2008-07-02 03:06:38131Parse the date string, and output the corresponding
132--max-age= parameter for `git-rev-list`.
Junio C Hamano1a4e8412005-12-27 08:17:23133
Junio C Hamanoeb415992008-06-08 22:49:47134--until=datestring::
135--before=datestring::
Junio C Hamanofce7c7e2008-07-02 03:06:38136Parse the date string, and output the corresponding
137--min-age= parameter for `git-rev-list`.
Junio C Hamano1a4e8412005-12-27 08:17:23138
139<args>...::
140Flags and parameters to be parsed.
141
142
143SPECIFYING REVISIONS
144--------------------
145
146A revision parameter typically, but not necessarily, names a
147commit object. They use what is called an 'extended SHA1'
Junio C Hamanofbe00522006-10-19 05:58:48148syntax. Here are various ways to spell object names. The
149ones listed near the end of this list are to name trees and
150blobs contained in a commit.
Junio C Hamano1a4e8412005-12-27 08:17:23151
152* The full SHA1 object name (40-byte hexadecimal string), or
153 a substring of such that is unique within the repository.
154 E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
155 name the same commit object if there are no other object in
156 your repository whose object name starts with dae86e.
157
Junio C Hamanofbe00522006-10-19 05:58:48158* An output from `git-describe`; i.e. a closest tag, followed by a
Junio C Hamano29f14312006-10-26 08:47:29159 dash, a `g`, and an abbreviated object name.
Junio C Hamanofbe00522006-10-19 05:58:48160
Junio C Hamano1a4e8412005-12-27 08:17:23161* A symbolic ref name. E.g. 'master' typically means the commit
162 object referenced by $GIT_DIR/refs/heads/master. If you
163 happen to have both heads/master and tags/master, you can
164 explicitly say 'heads/master' to tell git which one you mean.
Junio C Hamano29f14312006-10-26 08:47:29165 When ambiguous, a `<name>` is disambiguated by taking the
166 first match in the following rules:
Junio C Hamano1a4e8412005-12-27 08:17:23167
Junio C Hamano29f14312006-10-26 08:47:29168 . if `$GIT_DIR/<name>` exists, that is what you mean (this is usually
169 useful only for `HEAD`, `FETCH_HEAD` and `MERGE_HEAD`);
170
171 . otherwise, `$GIT_DIR/refs/<name>` if exists;
172
173 . otherwise, `$GIT_DIR/refs/tags/<name>` if exists;
174
175 . otherwise, `$GIT_DIR/refs/heads/<name>` if exists;
176
177 . otherwise, `$GIT_DIR/refs/remotes/<name>` if exists;
178
179 . otherwise, `$GIT_DIR/refs/remotes/<name>/HEAD` if exists.
180
181* A ref followed by the suffix '@' with a date specification
182 enclosed in a brace
Junio C Hamano341071d2006-06-04 07:24:48183 pair (e.g. '\{yesterday\}', '\{1 month 2 weeks 3 days 1 hour 1
184 second ago\}' or '\{1979-02-26 18:30:00\}') to specify the value
185 of the ref at a prior point in time. This suffix may only be
186 used immediately following a ref name and the ref must have an
Junio C Hamanobb8e9962008-06-30 09:05:08187 existing log ($GIT_DIR/logs/<ref>). Note that this looks up the state
188 of your *local* ref at a given time; e.g., what was in your local
189 `master` branch last week. If you want to look at commits made during
190 certain times, see `--since` and `--until`.
Junio C Hamano341071d2006-06-04 07:24:48191
Junio C Hamano2d47c622007-01-18 06:24:10192* A ref followed by the suffix '@' with an ordinal specification
193 enclosed in a brace pair (e.g. '\{1\}', '\{15\}') to specify
194 the n-th prior value of that ref. For example 'master@\{1\}'
195 is the immediate prior value of 'master' while 'master@\{5\}'
196 is the 5th prior value of 'master'. This suffix may only be used
197 immediately following a ref name and the ref must have an existing
198 log ($GIT_DIR/logs/<ref>).
199
Junio C Hamano39381a72007-02-02 07:35:15200* You can use the '@' construct with an empty ref part to get at a
201 reflog of the current branch. For example, if you are on the
202 branch 'blabla', then '@\{1\}' means the same as 'blabla@\{1\}'.
203
Junio C Hamano1a4e8412005-12-27 08:17:23204* A suffix '{caret}' to a revision parameter means the first parent of
205 that commit object. '{caret}<n>' means the <n>th parent (i.e.
206 'rev{caret}'
207 is equivalent to 'rev{caret}1'). As a special rule,
208 'rev{caret}0' means the commit itself and is used when 'rev' is the
209 object name of a tag object that refers to a commit object.
210
Junio C Hamanod97409f2006-10-03 08:41:56211* A suffix '{tilde}<n>' to a revision parameter means the commit
Junio C Hamano1a4e8412005-12-27 08:17:23212 object that is the <n>th generation grand-parent of the named
213 commit object, following only the first parent. I.e. rev~3 is
Junio C Hamano29f14312006-10-26 08:47:29214 equivalent to rev{caret}{caret}{caret} which is equivalent to
215 rev{caret}1{caret}1{caret}1. See below for a illustration of
216 the usage of this form.
Junio C Hamano1a4e8412005-12-27 08:17:23217
218* A suffix '{caret}' followed by an object type name enclosed in
219 brace pair (e.g. `v0.99.8{caret}\{commit\}`) means the object
220 could be a tag, and dereference the tag recursively until an
221 object of that type is found or the object cannot be
222 dereferenced anymore (in which case, barf). `rev{caret}0`
223 introduced earlier is a short-hand for `rev{caret}\{commit\}`.
224
225* A suffix '{caret}' followed by an empty brace pair
226 (e.g. `v0.99.8{caret}\{\}`) means the object could be a tag,
227 and dereference the tag recursively until a non-tag object is
228 found.
229
Junio C Hamano6ac2f142007-03-01 01:24:56230* A colon, followed by a slash, followed by a text: this names
231 a commit whose commit message starts with the specified text.
232 This name returns the youngest matching commit which is
233 reachable from any ref. If the commit message starts with a
234 '!', you have to repeat that; the special sequence ':/!',
235 followed by something else than '!' is reserved for now.
236
Junio C Hamanofbe00522006-10-19 05:58:48237* A suffix ':' followed by a path; this names the blob or tree
238 at the given path in the tree-ish object named by the part
239 before the colon.
240
241* A colon, optionally followed by a stage number (0 to 3) and a
242 colon, followed by a path; this names a blob object in the
243 index at the given path. Missing stage number (and the colon
Junio C Hamano1f511962008-01-30 08:28:52244 that follows it) names a stage 0 entry. During a merge, stage
Junio C Hamanocae86272007-08-21 02:20:49245 1 is the common ancestor, stage 2 is the target branch's version
246 (typically the current branch), and stage 3 is the version from
247 the branch being merged.
Junio C Hamanofbe00522006-10-19 05:58:48248
Junio C Hamano1c95e9d2008-02-01 10:52:44249Here is an illustration, by Jon Loeliger. Both commit nodes B
250and C are parents of commit node A. Parent commits are ordered
Junio C Hamano1a4e8412005-12-27 08:17:23251left-to-right.
252
Junio C Hamano137273f2008-05-27 07:44:33253........................................
254G H I J
255 \ / \ /
256 D E F
257 \ | / \
258 \ | / |
259 \|/ |
260 B C
261 \ /
262 \ /
263 A
264........................................
Junio C Hamano1a4e8412005-12-27 08:17:23265
266 A = = A^0
267 B = A^ = A^1 = A~1
268 C = A^2 = A^2
269 D = A^^ = A^1^1 = A~2
270 E = B^2 = A^^2
271 F = B^3 = A^^3
272 G = A^^^ = A^1^1^1 = A~3
273 H = D^2 = B^^2 = A^^^2 = A~2^2
274 I = F^ = B^3^ = A^^3^
275 J = F^2 = B^3^2 = A^^3^2
276
277
Junio C Hamano872c5682006-07-07 06:05:40278SPECIFYING RANGES
279-----------------
280
281History traversing commands such as `git-log` operate on a set
282of commits, not just a single commit. To these commands,
283specifying a single revision with the notation described in the
284previous section means the set of commits reachable from that
285commit, following the commit ancestry chain.
286
287To exclude commits reachable from a commit, a prefix `{caret}`
288notation is used. E.g. "`{caret}r1 r2`" means commits reachable
289from `r2` but exclude the ones reachable from `r1`.
290
291This set operation appears so often that there is a shorthand
292for it. "`r1..r2`" is equivalent to "`{caret}r1 r2`". It is
293the difference of two sets (subtract the set of commits
294reachable from `r1` from the set of commits reachable from
295`r2`).
296
297A similar notation "`r1\...r2`" is called symmetric difference
298of `r1` and `r2` and is defined as
Junio C Hamanofce7c7e2008-07-02 03:06:38299"`r1 r2 --not $(git merge-base --all r1 r2)`".
Junio C Hamanoea5dae62007-05-10 23:25:08300It is the set of commits that are reachable from either one of
Junio C Hamano872c5682006-07-07 06:05:40301`r1` or `r2` but not from both.
302
Junio C Hamano0d3c8152006-11-08 01:33:41303Two other shorthands for naming a set that is formed by a commit
304and its parent commits exists. `r1{caret}@` notation means all
305parents of `r1`. `r1{caret}!` includes commit `r1` but excludes
306its all parents.
307
Junio C Hamano1f511962008-01-30 08:28:52308Here are a handful of examples:
Junio C Hamano872c5682006-07-07 06:05:40309
Junio C Hamano3aa81822007-03-30 08:52:26310 D G H D
311 D F G H I J D F
312 ^G D H D
313 ^D B E I J F B
314 B...C G H D E B C
315 ^D B C E I J F B C
316 C^@ I J F
317 F^! D G H D F
Junio C Hamano872c5682006-07-07 06:05:40318
Junio C Hamanoe1258662007-11-19 05:03:19319PARSEOPT
320--------
321
322In `--parseopt` mode, `git-rev-parse` helps massaging options to bring to shell
323scripts the same facilities C builtins have. It works as an option normalizer
324(e.g. splits single switches aggregate values), a bit like `getopt(1)` does.
325
326It takes on the standard input the specification of the options to parse and
327understand, and echoes on the standard output a line suitable for `sh(1)` `eval`
328to replace the arguments with normalized ones. In case of error, it outputs
329usage on the standard error stream, and exits with code 129.
330
331Input Format
332~~~~~~~~~~~~
333
334`git-rev-parse --parseopt` input format is fully text based. It has two parts,
335separated by a line that contains only `--`. The lines before the separator
336(should be more than one) are used for the usage.
337The lines after the separator describe the options.
338
339Each line of options has this format:
340
341------------
Junio C Hamanobb343172008-03-09 10:39:09342<opt_spec><flags>* SP+ help LF
Junio C Hamanoe1258662007-11-19 05:03:19343------------
344
345`<opt_spec>`::
346its format is the short option character, then the long option name
347separated by a comma. Both parts are not required, though at least one
348is necessary. `h,help`, `dry-run` and `f` are all three correct
349`<opt_spec>`.
350
Junio C Hamanobb343172008-03-09 10:39:09351`<flags>`::
352`<flags>` are of `*`, `=`, `?` or `!`.
353* Use `=` if the option takes an argument.
354
355* Use `?` to mean that the option is optional (though its use is discouraged).
356
357* Use `*` to mean that this option should not be listed in the usage
358 generated for the `-h` argument. It's shown for `--help-all` as
Junio C Hamano2fbcd212008-05-14 22:26:07359 documented in linkgit:gitcli[7].
Junio C Hamanobb343172008-03-09 10:39:09360
361* Use `!` to not make the corresponding negated long option available.
Junio C Hamanoe1258662007-11-19 05:03:19362
363The remainder of the line, after stripping the spaces, is used
364as the help associated to the option.
365
366Blank lines are ignored, and lines that don't match this specification are used
367as option group headers (start the line with a space to create such
368lines on purpose).
369
370Example
371~~~~~~~
372
373------------
374OPTS_SPEC="\
375some-command [options] <args>...
376
377some-command does foo and bar!
378--
379h,help show the help
380
381foo some nifty option --foo
382bar= some cool option --bar with an argument
383
384 An option group Header
385C? option C with an optional argument"
386
Junio C Hamanofce7c7e2008-07-02 03:06:38387eval `echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?`
Junio C Hamanoe1258662007-11-19 05:03:19388------------
389
Junio C Hamanofeeb1be2008-05-22 00:53:35390EXAMPLES
391--------
392
393* Print the object name of the current commit:
394+
395------------
396$ git rev-parse --verify HEAD
397------------
398
399* Print the commit object name from the revision in the $REV shell variable:
400+
401------------
402$ git rev-parse --verify $REV
403------------
404+
405This will error out if $REV is empty or not a valid revision.
406
407* Same as above:
408+
409------------
410$ git rev-parse --default master --verify $REV
411------------
412+
413but if $REV is empty, the commit object name from master will be printed.
414
Junio C Hamanoe1258662007-11-19 05:03:19415
Junio C Hamano1a4e8412005-12-27 08:17:23416Author
417------
Junio C Hamanoe1258662007-11-19 05:03:19418Written by Linus Torvalds <torvalds@osdl.org> .
419Junio C Hamano <junkio@cox.net> and Pierre Habouzit <madcoder@debian.org>
Junio C Hamano1a4e8412005-12-27 08:17:23420
421Documentation
422--------------
423Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
424
425GIT
426---
Junio C Hamanof7c042d2008-06-06 22:50:53427Part of the linkgit:git[1] suite