git-clone: check out "master" by default.
[git/gitweb.git] / Documentation / git-rev-parse.txt
blobe2d94ff3357f4d931f2c64a5d9070c342a52c1de
1 git-rev-parse(1)
2 ================
4 NAME
5 ----
6 git-rev-parse - Pick out and massage parameters.
9 SYNOPSIS
10 --------
11 'git-rev-parse' [ --option ] <args>...
13 DESCRIPTION
14 -----------
16 Many git Porcelainish commands take mixture of flags
17 (i.e. parameters that begin with a dash '-') and parameters
18 meant for underlying `git-rev-list` command they use internally
19 and flags and parameters for other commands they use as the
20 downstream of `git-rev-list`.  This command is used to
21 distinguish between them.
24 OPTIONS
25 -------
26 --revs-only::
27         Do not output flags and parameters not meant for
28         `git-rev-list` command.
30 --no-revs::
31         Do not output flags and parameters meant for
32         `git-rev-list` command.
34 --flags::
35         Do not output non-flag parameters.
37 --no-flags::
38         Do not output flag parameters.
40 --default <arg>::
41         If there is no parameter given by the user, use `<arg>`
42         instead.
44 --verify::
45         The parameter given must be usable as a single, valid
46         object name.  Otherwise barf and abort.
48 --sq::
49         Usually the output is made one line per flag and
50         parameter.  This option makes output a single line,
51         properly quoted for consumption by shell.  Useful when
52         you expect your parameter to contain whitespaces and
53         newlines (e.g. when using pickaxe `-S` with
54         `git-diff-\*`).
56 --not::
57         When showing object names, prefix them with '^' and
58         strip '^' prefix from the object names that already have
59         one.
61 --symbolic::
62         Usually the object names are output in SHA1 form (with
63         possible '^' prefix); this option makes them output in a
64         form as close to the original input as possible.
67 --all::
68         Show all refs found in `$GIT_DIR/refs`.
70 --show-prefix::
71         When the command is invoked from a directory show the
72         path of the current directory relative to the top-level
73         directory.
75 <args>...::
76         Flags and parameters to be parsed.
79 SPECIFYING REVISIONS
80 --------------------
82 A revision parameter typically names a commit object.  They use
83 what is called an 'extended SHA1' syntax.
85 * The full SHA1 object name (40-byte hexadecimal string), or
86   a substring of such that is unique within the repository.
87   E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
88   name the same commit object if there are no other object in
89   your repository whose object name starts with dae86e.
91 * A symbolic ref name.  E.g. 'master' typically means the commit
92   object referenced by $GIT_DIR/refs/heads/master.  If you
93   happen to have both heads/master and tags/master, you can
94   explicitly say 'heads/master' to tell GIT which one you mean.
96 * A suffix '^' to a revision parameter means the first parent of
97   that commit object.  '^<n>' means the <n>th parent (i.e.
98   'rev^'
99   is equivalent to 'rev^1').  As a special rule,
100   'rev^0' means the commit itself and is used when 'rev' is the
101   object name of a tag object that refers to a commit object.
103 * A suffix '~<n>' to a revision parameter means the commit
104   object that is the <n>th generation grand-parent of the named
105   commit object, following only the first parent.  I.e. rev~3 is
106   equivalent to rev^^^ which is equivalent to rev^1^1^1.
108 'git-rev-parse' also accepts a prefix '^' to revision parameter,
109 which is passed to 'git-rev-list'.  Two revision parameters
110 concatenated with '..' is a short-hand for writing a range
111 between them.  I.e. 'r1..r2' is equivalent to saying '^r1 r2'
114 Author
115 ------
116 Written by Linus Torvalds <torvalds@osdl.org> and
117 Junio C Hamano <junkio@cox.net>
119 Documentation
120 --------------
121 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
125 Part of the gitlink:git[7] suite