Remove the version tags from the manpages
[git/git.git] / Documentation / git-rev-parse.txt
CommitLineData
7fc9d69f
JH
1git-rev-parse(1)
2================
3
4NAME
5----
5077fa9c 6git-rev-parse - Pick out and massage parameters.
7fc9d69f
JH
7
8
9SYNOPSIS
10--------
11'git-rev-parse' [ --option ] <args>...
12
13DESCRIPTION
14-----------
5077fa9c
JH
15
16Many git Porcelainish commands take mixture of flags
17(i.e. parameters that begin with a dash '-') and parameters
18meant for underlying `git-rev-list` command they use internally
19and flags and parameters for other commands they use as the
20downstream of `git-rev-list`. This command is used to
21distinguish between them.
7fc9d69f
JH
22
23
24OPTIONS
25-------
5077fa9c
JH
26--revs-only::
27 Do not output flags and parameters not meant for
28 `git-rev-list` command.
29
30--no-revs::
31 Do not output flags and parameters meant for
32 `git-rev-list` command.
33
34--flags::
35 Do not output non-flag parameters.
36
37--no-flags::
38 Do not output flag parameters.
39
40--default <arg>::
41 If there is no parameter given by the user, use `<arg>`
42 instead.
43
44--verify::
45 The parameter given must be usable as a single, valid
46 object name. Otherwise barf and abort.
47
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-\*`).
55
56--not::
babfaba2
JF
57 When showing object names, prefix them with '{caret}' and
58 strip '{caret}' prefix from the object names that already have
5077fa9c
JH
59 one.
60
61--symbolic::
62 Usually the object names are output in SHA1 form (with
babfaba2 63 possible '{caret}' prefix); this option makes them output in a
5077fa9c
JH
64 form as close to the original input as possible.
65
66
67--all::
68 Show all refs found in `$GIT_DIR/refs`.
69
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.
7fc9d69f
JH
74
75<args>...::
5077fa9c 76 Flags and parameters to be parsed.
7fc9d69f
JH
77
78
3a45f625
JH
79SPECIFYING REVISIONS
80--------------------
81
82A revision parameter typically names a commit object. They use
83what is called an 'extended SHA1' syntax.
84
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.
90
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.
95
babfaba2
JF
96* A suffix '{caret}' to a revision parameter means the first parent of
97 that commit object. '{caret}<n>' means the <n>th parent (i.e.
98 'rev{caret}'
99 is equivalent to 'rev{caret}1'). As a special rule,
100 'rev{caret}0' means the commit itself and is used when 'rev' is the
3a45f625
JH
101 object name of a tag object that refers to a commit object.
102
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
babfaba2
JF
106 equivalent to rev{caret}{caret}{caret} which is equivalent to\
107 rev{caret}1{caret}1{caret}1.
3a45f625 108
babfaba2 109'git-rev-parse' also accepts a prefix '{caret}' to revision parameter,
3a45f625
JH
110which is passed to 'git-rev-list'. Two revision parameters
111concatenated with '..' is a short-hand for writing a range
babfaba2 112between them. I.e. 'r1..r2' is equivalent to saying '{caret}r1 r2'
3a45f625
JH
113
114
7fc9d69f
JH
115Author
116------
5077fa9c
JH
117Written by Linus Torvalds <torvalds@osdl.org> and
118Junio C Hamano <junkio@cox.net>
7fc9d69f
JH
119
120Documentation
121--------------
122Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
123
124GIT
125---
a7154e91 126Part of the gitlink:git[7] suite
7fc9d69f 127