git-rev-parse.txt 13 KB
Newer Older
1 2 3 4 5
git-rev-parse(1)
================

NAME
----
6
git-rev-parse - Pick out and massage parameters
7 8 9 10


SYNOPSIS
--------
11
[verse]
12
'git rev-parse' [ --option ] <args>...
13 14 15

DESCRIPTION
-----------
Junio C Hamano's avatar
Junio C Hamano committed
16

17
Many Git porcelainish commands take mixture of flags
Junio C Hamano's avatar
Junio C Hamano committed
18
(i.e. parameters that begin with a dash '-') and parameters
19
meant for the underlying 'git rev-list' command they use internally
20
and flags and parameters for the other commands they use
21
downstream of 'git rev-list'.  This command is used to
Junio C Hamano's avatar
Junio C Hamano committed
22
distinguish between them.
23 24 25 26


OPTIONS
-------
27 28 29 30 31 32

Operation Modes
~~~~~~~~~~~~~~~

Each of these options must appear first on the command line.

33
--parseopt::
34
	Use 'git rev-parse' in option parsing mode (see PARSEOPT section below).
35

36 37 38 39 40 41 42 43
--sq-quote::
	Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE
	section below). In contrast to the `--sq` option below, this
	mode does only quoting. Nothing else is done to command input.

Options for --parseopt
~~~~~~~~~~~~~~~~~~~~~~

44
--keep-dashdash::
45 46 47
	Only meaningful in `--parseopt` mode. Tells the option parser to echo
	out the first `--` met instead of skipping it.

48 49 50
--stop-at-non-option::
	Only meaningful in `--parseopt` mode.  Lets the option parser stop at
	the first non-option argument.  This can be used to parse sub-commands
51
	that take options themselves.
52

53 54 55 56
--stuck-long::
	Only meaningful in `--parseopt` mode. Output the options in their
	long form if available, and with their arguments stuck.

57 58
Options for Filtering
~~~~~~~~~~~~~~~~~~~~~
59

Junio C Hamano's avatar
Junio C Hamano committed
60 61
--revs-only::
	Do not output flags and parameters not meant for
62
	'git rev-list' command.
Junio C Hamano's avatar
Junio C Hamano committed
63 64 65

--no-revs::
	Do not output flags and parameters meant for
66
	'git rev-list' command.
Junio C Hamano's avatar
Junio C Hamano committed
67 68 69 70 71 72 73

--flags::
	Do not output non-flag parameters.

--no-flags::
	Do not output flag parameters.

74 75 76
Options for Output
~~~~~~~~~~~~~~~~~~

Junio C Hamano's avatar
Junio C Hamano committed
77 78 79 80
--default <arg>::
	If there is no parameter given by the user, use `<arg>`
	instead.

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
--prefix <arg>::
	Behave as if 'git rev-parse' was invoked from the `<arg>`
	subdirectory of the working tree.  Any relative filenames are
	resolved as if they are prefixed by `<arg>` and will be printed
	in that form.
+
This can be used to convert arguments to a command run in a subdirectory
so that they can still be used after moving to the top-level of the
repository.  For example:
+
----
prefix=$(git rev-parse --show-prefix)
cd "$(git rev-parse --show-toplevel)"
eval "set -- $(git rev-parse --sq --prefix "$prefix" "[email protected]")"
----

Junio C Hamano's avatar
Junio C Hamano committed
97
--verify::
98 99 100 101 102 103 104
	Verify that exactly one parameter is provided, and that it
	can be turned into a raw 20-byte SHA-1 that can be used to
	access the object database. If so, emit it to the standard
	output; otherwise, error out.
+
If you want to make sure that the output actually names an object in
your object database and/or can be used as a specific type of object
105
you require, you can add "\^{type}" peeling operator to the parameter.
106 107 108 109 110
For example, `git rev-parse "$VAR^{commit}"` will make sure `$VAR`
names an existing object that is a commit-ish (i.e. a commit, or an
annotated tag that points at a commit).  To make sure that `$VAR`
names an existing object of any type, `git rev-parse "$VAR^{object}"`
can be used.
Junio C Hamano's avatar
Junio C Hamano committed
111

112 113
-q::
--quiet::
114 115 116
	Only meaningful in `--verify` mode. Do not output an error
	message if the first argument is not a valid object name;
	instead exit with non-zero status silently.
117
	SHA-1s for valid object names are printed to stdout on success.
118

Junio C Hamano's avatar
Junio C Hamano committed
119 120 121 122 123 124
--sq::
	Usually the output is made one line per flag and
	parameter.  This option makes output a single line,
	properly quoted for consumption by shell.  Useful when
	you expect your parameter to contain whitespaces and
	newlines (e.g. when using pickaxe `-S` with
125
	'git diff-{asterisk}'). In contrast to the `--sq-quote` option,
126
	the command input is still interpreted as usual.
Junio C Hamano's avatar
Junio C Hamano committed
127 128

--not::
129 130
	When showing object names, prefix them with '{caret}' and
	strip '{caret}' prefix from the object names that already have
Junio C Hamano's avatar
Junio C Hamano committed
131 132
	one.

133 134 135 136 137 138 139 140 141 142 143
--abbrev-ref[=(strict|loose)]::
	A non-ambiguous short name of the objects name.
	The option core.warnAmbiguousRefs is used to select the strict
	abbreviation mode.

--short::
--short=number::
	Instead of outputting the full SHA-1 values of object names try to
	abbreviate them to a shorter unique name. When no length is specified
	7 is used. The minimum length is 4.

Junio C Hamano's avatar
Junio C Hamano committed
144
--symbolic::
145
	Usually the object names are output in SHA-1 form (with
146
	possible '{caret}' prefix); this option makes them output in a
Junio C Hamano's avatar
Junio C Hamano committed
147 148
	form as close to the original input as possible.

149 150 151 152 153 154 155
--symbolic-full-name::
	This is similar to \--symbolic, but it omits input that
	are not refs (i.e. branch or tag names; or more
	explicitly disambiguating "heads/master" form, when you
	want to name the "master" branch when there is an
	unfortunately named tag "master"), and show them as full
	refnames (e.g. "refs/heads/master").
Junio C Hamano's avatar
Junio C Hamano committed
156

157 158
Options for Objects
~~~~~~~~~~~~~~~~~~~
159

Junio C Hamano's avatar
Junio C Hamano committed
160
--all::
161
	Show all refs found in `refs/`.
Junio C Hamano's avatar
Junio C Hamano committed
162

163 164 165
--branches[=pattern]::
--tags[=pattern]::
--remotes[=pattern]::
166
	Show all branches, tags, or remote-tracking branches,
167 168
	respectively (i.e., refs found in `refs/heads`,
	`refs/tags`, or `refs/remotes`, respectively).
169 170 171
+
If a `pattern` is given, only refs matching the given shell glob are
shown.  If the pattern does not contain a globbing character (`?`,
172
`*`, or `[`), it is turned into a prefix match by appending `/*`.
173 174 175 176 177

--glob=pattern::
	Show all refs matching the shell glob pattern `pattern`. If
	the pattern does not start with `refs/`, this is automatically
	prepended.  If the pattern does not contain a globbing
178 179
	character (`?`, `*`, or `[`), it is turned into a prefix
	match by appending `/*`.
180

181 182 183 184 185 186
--exclude=<glob-pattern>::
	Do not include refs matching '<glob-pattern>' that the next `--all`,
	`--branches`, `--tags`, `--remotes`, or `--glob` would otherwise
	consider. Repetitions of this option accumulate exclusion patterns
	up to the next `--all`, `--branches`, `--tags`, `--remotes`, or
	`--glob` option (other options or arguments do not clear
Thomas Ackermann's avatar
Thomas Ackermann committed
187
	accumulated patterns).
188 189 190 191 192 193 194
+
The patterns given should not begin with `refs/heads`, `refs/tags`, or
`refs/remotes` when applied to `--branches`, `--tags`, or `--remotes`,
respectively, and they must begin with `refs/` when applied to `--glob`
or `--all`. If a trailing '/{asterisk}' is intended, it must be given
explicitly.

195 196 197 198 199
--disambiguate=<prefix>::
	Show every object whose name begins with the given prefix.
	The <prefix> must be at least 4 hexadecimal digits long to
	avoid listing each and every object in the repository by
	mistake.
200

201 202
Options for Files
~~~~~~~~~~~~~~~~~
203

204 205 206 207 208
--local-env-vars::
	List the GIT_* environment variables that are local to the
	repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
	Only the names of the variables are listed, not their value,
	even if they are set.
Junio C Hamano's avatar
Junio C Hamano committed
209

210
--git-dir::
211
	Show `$GIT_DIR` if defined. Otherwise show the path to
212 213
	the .git directory. The path shown, when relative, is
	relative to the current working directory.
214 215
+
If `$GIT_DIR` is not defined and the current directory
216
is not detected to lie in a Git repository or work tree
217
print a message to stderr and exit with nonzero status.
218

219
--is-inside-git-dir::
220 221 222
	When the current working directory is below the repository
	directory print "true", otherwise "false".

223 224 225 226
--is-inside-work-tree::
	When the current working directory is inside the work tree of the
	repository print "true", otherwise "false".

227 228
--is-bare-repository::
	When the repository is bare print "true", otherwise "false".
229

230 231 232 233 234
--resolve-git-dir <path>::
	Check if <path> is a valid repository or a gitfile that
	points at a valid repository, and print the location of the
	repository.  If <path> is a gitfile then the resolved path
	to the real repository is printed.
235

236 237 238 239 240 241 242 243 244 245 246 247 248
--show-cdup::
	When the command is invoked from a subdirectory, show the
	path of the top-level directory relative to the current
	directory (typically a sequence of "../", or an empty string).

--show-prefix::
	When the command is invoked from a subdirectory, show the
	path of the current directory relative to the top-level
	directory.

--show-toplevel::
	Show the absolute path of the top-level directory.

249 250 251 252
--shared-index-path::
	Show the path to the shared index file in split index mode, or
	empty if not in split-index mode.

253 254
Other Options
~~~~~~~~~~~~~
255

256 257
--since=datestring::
--after=datestring::
258
	Parse the date string, and output the corresponding
259
	--max-age= parameter for 'git rev-list'.
260

261 262
--until=datestring::
--before=datestring::
263
	Parse the date string, and output the corresponding
264
	--min-age= parameter for 'git rev-list'.
265

266
<args>...::
Junio C Hamano's avatar
Junio C Hamano committed
267
	Flags and parameters to be parsed.
268 269


270
include::revisions.txt[]
271

272 273 274
PARSEOPT
--------

275
In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell
276 277 278 279
scripts the same facilities C builtins have. It works as an option normalizer
(e.g. splits single switches aggregate values), a bit like `getopt(1)` does.

It takes on the standard input the specification of the options to parse and
280
understand, and echoes on the standard output a string suitable for `sh(1)` `eval`
281 282 283
to replace the arguments with normalized ones.  In case of error, it outputs
usage on the standard error stream, and exits with code 129.

284 285 286
Note: Make sure you quote the result when passing it to `eval`.  See
below for an example.

287 288 289
Input Format
~~~~~~~~~~~~

290
'git rev-parse --parseopt' input format is fully text based. It has two parts,
291
separated by a line that contains only `--`. The lines before the separator
292
(should be one or more) are used for the usage.
293 294 295 296 297
The lines after the separator describe the options.

Each line of options has this format:

------------
298
<opt-spec><flags>*<arg-hint>? SP+ help LF
299 300
------------

301
`<opt-spec>`::
302 303 304
	its format is the short option character, then the long option name
	separated by a comma. Both parts are not required, though at least one
	is necessary. `h,help`, `dry-run` and `f` are all three correct
305
	`<opt-spec>`.
306

307 308 309 310
`<flags>`::
	`<flags>` are of `*`, `=`, `?` or `!`.
	* Use `=` if the option takes an argument.

311 312 313
	* Use `?` to mean that the option takes an optional argument. You
	  probably want to use the `--stuck-long` mode to be able to
	  unambiguously parse the optional argument.
314 315 316

	* Use `*` to mean that this option should not be listed in the usage
	  generated for the `-h` argument. It's shown for `--help-all` as
317
	  documented in linkgit:gitcli[7].
318 319

	* Use `!` to not make the corresponding negated long option available.
320

321 322 323 324 325
`<arg-hint>`::
	`<arg-hint>`, if specified, is used as a name of the argument in the
	help output, for options that take arguments. `<arg-hint>` is
	terminated by the first whitespace.  It is customary to use a
	dash to separate words in a multi-word argument hint.
326

327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
The remainder of the line, after stripping the spaces, is used
as the help associated to the option.

Blank lines are ignored, and lines that don't match this specification are used
as option group headers (start the line with a space to create such
lines on purpose).

Example
~~~~~~~

------------
OPTS_SPEC="\
some-command [options] <args>...

some-command does foo and bar!
--
h,help    show the help

foo       some nifty option --foo
bar=      some cool option --bar with an argument
347 348
baz=arg   another cool option --baz with a named argument
qux?path  qux may take a path argument but has meaning by itself
349 350 351 352

  An option group Header
C?        option C with an optional argument"

353
eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "[email protected]" || echo exit $?)"
354 355
------------

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370

Usage text
~~~~~~~~~~

When `"[email protected]"` is `-h` or `--help` in the above example, the following
usage text would be shown:

------------
usage: some-command [options] <args>...

    some-command does foo and bar!

    -h, --help            show the help
    --foo                 some nifty option --foo
    --bar ...             some cool option --bar with an argument
371
    --baz <arg>           another cool option --baz with a named argument
372 373 374 375 376 377
    --qux[=<path>]        qux may take a path argument but has meaning by itself

An option group Header
    -C[...]               option C with an optional argument
------------

378 379 380
SQ-QUOTE
--------

381
In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a
382 383 384 385 386
single line suitable for `sh(1)` `eval`. This line is made by
normalizing the arguments following `--sq-quote`. Nothing other than
quoting the arguments is done.

If you want command input to still be interpreted as usual by
387
'git rev-parse' before the output is shell quoted, see the `--sq`
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
option.

Example
~~~~~~~

------------
$ cat >your-git-script.sh <<\EOF
#!/bin/sh
args=$(git rev-parse --sq-quote "[email protected]")   # quote user-supplied arguments
command="git frotz -n24 $args"          # and use it inside a handcrafted
					# command line
eval "$command"
EOF

$ sh your-git-script.sh "a b'c"
------------

405 406 407 408 409 410 411 412 413 414 415 416
EXAMPLES
--------

* Print the object name of the current commit:
+
------------
$ git rev-parse --verify HEAD
------------

* Print the commit object name from the revision in the $REV shell variable:
+
------------
417
$ git rev-parse --verify $REV^{commit}
418 419 420 421
------------
+
This will error out if $REV is empty or not a valid revision.

422
* Similar to above:
423 424 425 426 427 428 429
+
------------
$ git rev-parse --default master --verify $REV
------------
+
but if $REV is empty, the commit object name from master will be printed.

430 431
GIT
---
432
Part of the linkgit:git[1] suite