]>
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 | -------- | |
b1889c36 | 11 | 'git rev-parse' [ --option ] <args>... |
7fc9d69f JH |
12 | |
13 | DESCRIPTION | |
14 | ----------- | |
5077fa9c | 15 | |
abda1ef5 | 16 | Many git porcelainish commands take mixture of flags |
5077fa9c | 17 | (i.e. parameters that begin with a dash '-') and parameters |
0b444cdb | 18 | meant for the underlying 'git rev-list' command they use internally |
483bc4f0 | 19 | and flags and parameters for the other commands they use |
0b444cdb | 20 | downstream of 'git rev-list'. This command is used to |
5077fa9c | 21 | distinguish between them. |
7fc9d69f JH |
22 | |
23 | ||
24 | OPTIONS | |
25 | ------- | |
21d47835 | 26 | --parseopt:: |
0b444cdb | 27 | Use 'git rev-parse' in option parsing mode (see PARSEOPT section below). |
21d47835 | 28 | |
2163e3f7 | 29 | --keep-dashdash:: |
21d47835 PH |
30 | Only meaningful in `--parseopt` mode. Tells the option parser to echo |
31 | out the first `--` met instead of skipping it. | |
32 | ||
6e0800ef UKK |
33 | --stop-at-non-option:: |
34 | Only meaningful in `--parseopt` mode. Lets the option parser stop at | |
35 | the first non-option argument. This can be used to parse sub-commands | |
6a5d0b0a | 36 | that take options themselves. |
6e0800ef | 37 | |
50325377 | 38 | --sq-quote:: |
0b444cdb | 39 | Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE |
50325377 CC |
40 | section below). In contrast to the `--sq` option below, this |
41 | mode does only quoting. Nothing else is done to command input. | |
42 | ||
5077fa9c JH |
43 | --revs-only:: |
44 | Do not output flags and parameters not meant for | |
0b444cdb | 45 | 'git rev-list' command. |
5077fa9c JH |
46 | |
47 | --no-revs:: | |
48 | Do not output flags and parameters meant for | |
0b444cdb | 49 | 'git rev-list' command. |
5077fa9c JH |
50 | |
51 | --flags:: | |
52 | Do not output non-flag parameters. | |
53 | ||
54 | --no-flags:: | |
55 | Do not output flag parameters. | |
56 | ||
57 | --default <arg>:: | |
58 | If there is no parameter given by the user, use `<arg>` | |
59 | instead. | |
60 | ||
61 | --verify:: | |
62 | The parameter given must be usable as a single, valid | |
63 | object name. Otherwise barf and abort. | |
64 | ||
3240240f SB |
65 | -q:: |
66 | --quiet:: | |
b1b35969 CC |
67 | Only meaningful in `--verify` mode. Do not output an error |
68 | message if the first argument is not a valid object name; | |
69 | instead exit with non-zero status silently. | |
70 | ||
5077fa9c JH |
71 | --sq:: |
72 | Usually the output is made one line per flag and | |
73 | parameter. This option makes output a single line, | |
74 | properly quoted for consumption by shell. Useful when | |
75 | you expect your parameter to contain whitespaces and | |
76 | newlines (e.g. when using pickaxe `-S` with | |
0b444cdb | 77 | 'git diff-\*'). In contrast to the `--sq-quote` option, |
50325377 | 78 | the command input is still interpreted as usual. |
5077fa9c JH |
79 | |
80 | --not:: | |
babfaba2 JF |
81 | When showing object names, prefix them with '{caret}' and |
82 | strip '{caret}' prefix from the object names that already have | |
5077fa9c JH |
83 | one. |
84 | ||
85 | --symbolic:: | |
86 | Usually the object names are output in SHA1 form (with | |
babfaba2 | 87 | possible '{caret}' prefix); this option makes them output in a |
5077fa9c JH |
88 | form as close to the original input as possible. |
89 | ||
a6d97d49 JH |
90 | --symbolic-full-name:: |
91 | This is similar to \--symbolic, but it omits input that | |
92 | are not refs (i.e. branch or tag names; or more | |
93 | explicitly disambiguating "heads/master" form, when you | |
94 | want to name the "master" branch when there is an | |
95 | unfortunately named tag "master"), and show them as full | |
96 | refnames (e.g. "refs/heads/master"). | |
5077fa9c | 97 | |
a45d3469 BW |
98 | --abbrev-ref[={strict|loose}]:: |
99 | A non-ambiguous short name of the objects name. | |
100 | The option core.warnAmbiguousRefs is used to select the strict | |
101 | abbreviation mode. | |
102 | ||
5077fa9c | 103 | --all:: |
cc1b8d8b | 104 | Show all refs found in `refs/`. |
5077fa9c | 105 | |
b09fe971 | 106 | --branches[=pattern]:: |
b09fe971 | 107 | --tags[=pattern]:: |
b09fe971 | 108 | --remotes[=pattern]:: |
e2b53e58 | 109 | Show all branches, tags, or remote-tracking branches, |
cc1b8d8b JK |
110 | respectively (i.e., refs found in `refs/heads`, |
111 | `refs/tags`, or `refs/remotes`, respectively). | |
e2b53e58 TR |
112 | + |
113 | If a `pattern` is given, only refs matching the given shell glob are | |
114 | shown. If the pattern does not contain a globbing character (`?`, | |
115 | `\*`, or `[`), it is turned into a prefix match by appending `/\*`. | |
116 | ||
117 | --glob=pattern:: | |
118 | Show all refs matching the shell glob pattern `pattern`. If | |
119 | the pattern does not start with `refs/`, this is automatically | |
120 | prepended. If the pattern does not contain a globbing | |
121 | character (`?`, `\*`, or `[`), it is turned into a prefix | |
122 | match by appending `/\*`. | |
a62be77f | 123 | |
7cceca5c SD |
124 | --show-toplevel:: |
125 | Show the absolute path of the top-level directory. | |
126 | ||
5077fa9c | 127 | --show-prefix:: |
5f94c730 | 128 | When the command is invoked from a subdirectory, show the |
5077fa9c JH |
129 | path of the current directory relative to the top-level |
130 | directory. | |
7fc9d69f | 131 | |
5f94c730 JH |
132 | --show-cdup:: |
133 | When the command is invoked from a subdirectory, show the | |
134 | path of the top-level directory relative to the current | |
135 | directory (typically a sequence of "../", or an empty string). | |
136 | ||
735d80b3 JF |
137 | --git-dir:: |
138 | Show `$GIT_DIR` if defined else show the path to the .git directory. | |
139 | ||
c9bf7be2 | 140 | --is-inside-git-dir:: |
4faac246 ML |
141 | When the current working directory is below the repository |
142 | directory print "true", otherwise "false". | |
143 | ||
892c41b9 ML |
144 | --is-inside-work-tree:: |
145 | When the current working directory is inside the work tree of the | |
146 | repository print "true", otherwise "false". | |
147 | ||
493c774e ML |
148 | --is-bare-repository:: |
149 | When the repository is bare print "true", otherwise "false". | |
c9bf7be2 | 150 | |
94c8ccaa GB |
151 | --local-env-vars:: |
152 | List the GIT_* environment variables that are local to the | |
153 | repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR). | |
154 | Only the names of the variables are listed, not their value, | |
155 | even if they are set. | |
156 | ||
3240240f SB |
157 | --short:: |
158 | --short=number:: | |
735d80b3 | 159 | Instead of outputting the full SHA1 values of object names try to |
abda1ef5 | 160 | abbreviate them to a shorter unique name. When no length is specified |
735d80b3 JF |
161 | 7 is used. The minimum length is 4. |
162 | ||
3240240f SB |
163 | --since=datestring:: |
164 | --after=datestring:: | |
483bc4f0 | 165 | Parse the date string, and output the corresponding |
0b444cdb | 166 | --max-age= parameter for 'git rev-list'. |
a3114b34 | 167 | |
3240240f SB |
168 | --until=datestring:: |
169 | --before=datestring:: | |
483bc4f0 | 170 | Parse the date string, and output the corresponding |
0b444cdb | 171 | --min-age= parameter for 'git rev-list'. |
a3114b34 | 172 | |
7fc9d69f | 173 | <args>...:: |
5077fa9c | 174 | Flags and parameters to be parsed. |
7fc9d69f JH |
175 | |
176 | ||
5a8f3117 | 177 | include::revisions.txt[] |
be4c7014 | 178 | |
21d47835 PH |
179 | PARSEOPT |
180 | -------- | |
181 | ||
0b444cdb | 182 | In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell |
21d47835 PH |
183 | scripts the same facilities C builtins have. It works as an option normalizer |
184 | (e.g. splits single switches aggregate values), a bit like `getopt(1)` does. | |
185 | ||
186 | It takes on the standard input the specification of the options to parse and | |
ac2e1e63 | 187 | understand, and echoes on the standard output a string suitable for `sh(1)` `eval` |
21d47835 PH |
188 | to replace the arguments with normalized ones. In case of error, it outputs |
189 | usage on the standard error stream, and exits with code 129. | |
190 | ||
ac2e1e63 TR |
191 | Note: Make sure you quote the result when passing it to `eval`. See |
192 | below for an example. | |
193 | ||
21d47835 PH |
194 | Input Format |
195 | ~~~~~~~~~~~~ | |
196 | ||
0b444cdb | 197 | 'git rev-parse --parseopt' input format is fully text based. It has two parts, |
21d47835 PH |
198 | separated by a line that contains only `--`. The lines before the separator |
199 | (should be more than one) are used for the usage. | |
200 | The lines after the separator describe the options. | |
201 | ||
202 | Each line of options has this format: | |
203 | ||
204 | ------------ | |
ff962a3f | 205 | <opt_spec><flags>* SP+ help LF |
21d47835 PH |
206 | ------------ |
207 | ||
208 | `<opt_spec>`:: | |
209 | its format is the short option character, then the long option name | |
210 | separated by a comma. Both parts are not required, though at least one | |
211 | is necessary. `h,help`, `dry-run` and `f` are all three correct | |
212 | `<opt_spec>`. | |
213 | ||
ff962a3f PH |
214 | `<flags>`:: |
215 | `<flags>` are of `*`, `=`, `?` or `!`. | |
216 | * Use `=` if the option takes an argument. | |
217 | ||
218 | * Use `?` to mean that the option is optional (though its use is discouraged). | |
219 | ||
220 | * Use `*` to mean that this option should not be listed in the usage | |
221 | generated for the `-h` argument. It's shown for `--help-all` as | |
a5af0e2c | 222 | documented in linkgit:gitcli[7]. |
ff962a3f PH |
223 | |
224 | * Use `!` to not make the corresponding negated long option available. | |
21d47835 PH |
225 | |
226 | The remainder of the line, after stripping the spaces, is used | |
227 | as the help associated to the option. | |
228 | ||
229 | Blank lines are ignored, and lines that don't match this specification are used | |
230 | as option group headers (start the line with a space to create such | |
231 | lines on purpose). | |
232 | ||
233 | Example | |
234 | ~~~~~~~ | |
235 | ||
236 | ------------ | |
237 | OPTS_SPEC="\ | |
238 | some-command [options] <args>... | |
239 | ||
240 | some-command does foo and bar! | |
241 | -- | |
242 | h,help show the help | |
243 | ||
244 | foo some nifty option --foo | |
245 | bar= some cool option --bar with an argument | |
246 | ||
247 | An option group Header | |
248 | C? option C with an optional argument" | |
249 | ||
ac2e1e63 | 250 | eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)" |
21d47835 PH |
251 | ------------ |
252 | ||
50325377 CC |
253 | SQ-QUOTE |
254 | -------- | |
255 | ||
0b444cdb | 256 | In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a |
50325377 CC |
257 | single line suitable for `sh(1)` `eval`. This line is made by |
258 | normalizing the arguments following `--sq-quote`. Nothing other than | |
259 | quoting the arguments is done. | |
260 | ||
261 | If you want command input to still be interpreted as usual by | |
0b444cdb | 262 | 'git rev-parse' before the output is shell quoted, see the `--sq` |
50325377 CC |
263 | option. |
264 | ||
265 | Example | |
266 | ~~~~~~~ | |
267 | ||
268 | ------------ | |
269 | $ cat >your-git-script.sh <<\EOF | |
270 | #!/bin/sh | |
271 | args=$(git rev-parse --sq-quote "$@") # quote user-supplied arguments | |
272 | command="git frotz -n24 $args" # and use it inside a handcrafted | |
273 | # command line | |
274 | eval "$command" | |
275 | EOF | |
276 | ||
277 | $ sh your-git-script.sh "a b'c" | |
278 | ------------ | |
279 | ||
824b5dc2 CC |
280 | EXAMPLES |
281 | -------- | |
282 | ||
283 | * Print the object name of the current commit: | |
284 | + | |
285 | ------------ | |
286 | $ git rev-parse --verify HEAD | |
287 | ------------ | |
288 | ||
289 | * Print the commit object name from the revision in the $REV shell variable: | |
290 | + | |
291 | ------------ | |
292 | $ git rev-parse --verify $REV | |
293 | ------------ | |
294 | + | |
295 | This will error out if $REV is empty or not a valid revision. | |
296 | ||
297 | * Same as above: | |
298 | + | |
299 | ------------ | |
300 | $ git rev-parse --default master --verify $REV | |
301 | ------------ | |
302 | + | |
303 | but if $REV is empty, the commit object name from master will be printed. | |
304 | ||
21d47835 | 305 | |
7fc9d69f JH |
306 | Author |
307 | ------ | |
21d47835 | 308 | Written by Linus Torvalds <torvalds@osdl.org> . |
59eb68aa | 309 | Junio C Hamano <gitster@pobox.com> and Pierre Habouzit <madcoder@debian.org> |
7fc9d69f JH |
310 | |
311 | Documentation | |
312 | -------------- | |
313 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. | |
314 | ||
315 | GIT | |
316 | --- | |
9e1f0a85 | 317 | Part of the linkgit:git[1] suite |