Documentation/git-rev-parse.txt

   1 git-rev-parse(1)
   2 ================
   3
   4 NAME
   5 ----
   6 git-rev-parse - Pick out and massage parameters
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git rev-parse' [<options>] <args>...
  13
  14 DESCRIPTION
  15 -----------
  16
  17 Many Git porcelainish commands take a mixture of flags
  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
  22 distinguish between them.
  23
  24
  25 OPTIONS
  26 -------
  27
  28 Operation Modes
  29 ~~~~~~~~~~~~~~~
  30
  31 Each of these options must appear first on the command line.
  32
  33 --parseopt::
  34         Use 'git rev-parse' in option parsing mode (see PARSEOPT section below).
  35
  36 --sq-quote::
  37         Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE
  38         section below). In contrast to the `--sq` option below, this
  39         mode only does quoting. Nothing else is done to command input.
  40
  41 Options for --parseopt
  42 ~~~~~~~~~~~~~~~~~~~~~~
  43
  44 --keep-dashdash::
  45         Only meaningful in `--parseopt` mode. Tells the option parser to echo
  46         out the first `--` met instead of skipping it.
  47
  48 --stop-at-non-option::
  49         Only meaningful in `--parseopt` mode.  Lets the option parser stop at
  50         the first non-option argument.  This can be used to parse sub-commands
  51         that take options themselves.
  52
  53 --stuck-long::
  54         Only meaningful in `--parseopt` mode. Output the options in their
  55         long form if available, and with their arguments stuck.
  56
  57 Options for Filtering
  58 ~~~~~~~~~~~~~~~~~~~~~
  59
  60 --revs-only::
  61         Do not output flags and parameters not meant for
  62         'git rev-list' command.
  63
  64 --no-revs::
  65         Do not output flags and parameters meant for
  66         'git rev-list' command.
  67
  68 --flags::
  69         Do not output non-flag parameters.
  70
  71 --no-flags::
  72         Do not output flag parameters.
  73
  74 Options for Output
  75 ~~~~~~~~~~~~~~~~~~
  76
  77 --default <arg>::
  78         If there is no parameter given by the user, use `<arg>`
  79         instead.
  80
  81 --prefix <arg>::
  82         Behave as if 'git rev-parse' was invoked from the `<arg>`
  83         subdirectory of the working tree.  Any relative filenames are
  84         resolved as if they are prefixed by `<arg>` and will be printed
  85         in that form.
  86 +
  87 This can be used to convert arguments to a command run in a subdirectory
  88 so that they can still be used after moving to the top-level of the
  89 repository.  For example:
  90 +
  91 ----
  92 prefix=$(git rev-parse --show-prefix)
  93 cd "$(git rev-parse --show-toplevel)"
  94 # rev-parse provides the -- needed for 'set'
  95 eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")"
  96 ----
  97
  98 --verify::
  99         Verify that exactly one parameter is provided, and that it
 100         can be turned into a raw 20-byte SHA-1 that can be used to
 101         access the object database. If so, emit it to the standard
 102         output; otherwise, error out.
 103 +
 104 If you want to make sure that the output actually names an object in
 105 your object database and/or can be used as a specific type of object
 106 you require, you can add the `^{type}` peeling operator to the parameter.
 107 For example, `git rev-parse "$VAR^{commit}"` will make sure `$VAR`
 108 names an existing object that is a commit-ish (i.e. a commit, or an
 109 annotated tag that points at a commit).  To make sure that `$VAR`
 110 names an existing object of any type, `git rev-parse "$VAR^{object}"`
 111 can be used.
 112 +
 113 Note that if you are verifying a name from an untrusted source, it is
 114 wise to use `--end-of-options` so that the name argument is not mistaken
 115 for another option.
 116
 117 -q::
 118 --quiet::
 119         Only meaningful in `--verify` mode. Do not output an error
 120         message if the first argument is not a valid object name;
 121         instead exit with non-zero status silently.
 122         SHA-1s for valid object names are printed to stdout on success.
 123
 124 --sq::
 125         Usually the output is made one line per flag and
 126         parameter.  This option makes output a single line,
 127         properly quoted for consumption by shell.  Useful when
 128         you expect your parameter to contain whitespaces and
 129         newlines (e.g. when using pickaxe `-S` with
 130         'git diff-{asterisk}'). In contrast to the `--sq-quote` option,
 131         the command input is still interpreted as usual.
 132
 133 --short[=length]::
 134         Same as `--verify` but shortens the object name to a unique
 135         prefix with at least `length` characters. The minimum length
 136         is 4, the default is the effective value of the `core.abbrev`
 137         configuration variable (see linkgit:git-config[1]).
 138
 139 --not::
 140         When showing object names, prefix them with '{caret}' and
 141         strip '{caret}' prefix from the object names that already have
 142         one.
 143
 144 --abbrev-ref[=(strict|loose)]::
 145         A non-ambiguous short name of the objects name.
 146         The option core.warnAmbiguousRefs is used to select the strict
 147         abbreviation mode.
 148
 149 --symbolic::
 150         Usually the object names are output in SHA-1 form (with
 151         possible '{caret}' prefix); this option makes them output in a
 152         form as close to the original input as possible.
 153
 154 --symbolic-full-name::
 155         This is similar to --symbolic, but it omits input that
 156         are not refs (i.e. branch or tag names; or more
 157         explicitly disambiguating "heads/master" form, when you
 158         want to name the "master" branch when there is an
 159         unfortunately named tag "master"), and shows them as full
 160         refnames (e.g. "refs/heads/master").
 161
 162 Options for Objects
 163 ~~~~~~~~~~~~~~~~~~~
 164
 165 --all::
 166         Show all refs found in `refs/`.
 167
 168 --branches[=pattern]::
 169 --tags[=pattern]::
 170 --remotes[=pattern]::
 171         Show all branches, tags, or remote-tracking branches,
 172         respectively (i.e., refs found in `refs/heads`,
 173         `refs/tags`, or `refs/remotes`, respectively).
 174 +
 175 If a `pattern` is given, only refs matching the given shell glob are
 176 shown.  If the pattern does not contain a globbing character (`?`,
 177 `*`, or `[`), it is turned into a prefix match by appending `/*`.
 178
 179 --glob=pattern::
 180         Show all refs matching the shell glob pattern `pattern`. If
 181         the pattern does not start with `refs/`, this is automatically
 182         prepended.  If the pattern does not contain a globbing
 183         character (`?`, `*`, or `[`), it is turned into a prefix
 184         match by appending `/*`.
 185
 186 --exclude=<glob-pattern>::
 187         Do not include refs matching '<glob-pattern>' that the next `--all`,
 188         `--branches`, `--tags`, `--remotes`, or `--glob` would otherwise
 189         consider. Repetitions of this option accumulate exclusion patterns
 190         up to the next `--all`, `--branches`, `--tags`, `--remotes`, or
 191         `--glob` option (other options or arguments do not clear
 192         accumulated patterns).
 193 +
 194 The patterns given should not begin with `refs/heads`, `refs/tags`, or
 195 `refs/remotes` when applied to `--branches`, `--tags`, or `--remotes`,
 196 respectively, and they must begin with `refs/` when applied to `--glob`
 197 or `--all`. If a trailing '/{asterisk}' is intended, it must be given
 198 explicitly.
 199
 200 --exclude-hidden=[fetch|receive|uploadpack]::
 201         Do not include refs that would be hidden by `git-fetch`,
 202         `git-receive-pack` or `git-upload-pack` by consulting the appropriate
 203         `fetch.hideRefs`, `receive.hideRefs` or `uploadpack.hideRefs`
 204         configuration along with `transfer.hideRefs` (see
 205         linkgit:git-config[1]). This option affects the next pseudo-ref option
 206         `--all` or `--glob` and is cleared after processing them.
 207
 208 --disambiguate=<prefix>::
 209         Show every object whose name begins with the given prefix.
 210         The <prefix> must be at least 4 hexadecimal digits long to
 211         avoid listing each and every object in the repository by
 212         mistake.
 213
 214 Options for Files
 215 ~~~~~~~~~~~~~~~~~
 216
 217 --local-env-vars::
 218         List the GIT_* environment variables that are local to the
 219         repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
 220         Only the names of the variables are listed, not their value,
 221         even if they are set.
 222
 223 --path-format=(absolute|relative)::
 224         Controls the behavior of certain other options. If specified as absolute, the
 225         paths printed by those options will be absolute and canonical. If specified as
 226         relative, the paths will be relative to the current working directory if that
 227         is possible.  The default is option specific.
 228 +
 229 This option may be specified multiple times and affects only the arguments that
 230 follow it on the command line, either to the end of the command line or the next
 231 instance of this option.
 232
 233 The following options are modified by `--path-format`:
 234
 235 --git-dir::
 236         Show `$GIT_DIR` if defined. Otherwise show the path to
 237         the .git directory. The path shown, when relative, is
 238         relative to the current working directory.
 239 +
 240 If `$GIT_DIR` is not defined and the current directory
 241 is not detected to lie in a Git repository or work tree
 242 print a message to stderr and exit with nonzero status.
 243
 244 --git-common-dir::
 245         Show `$GIT_COMMON_DIR` if defined, else `$GIT_DIR`.
 246
 247 --resolve-git-dir <path>::
 248         Check if <path> is a valid repository or a gitfile that
 249         points at a valid repository, and print the location of the
 250         repository.  If <path> is a gitfile then the resolved path
 251         to the real repository is printed.
 252
 253 --git-path <path>::
 254         Resolve "$GIT_DIR/<path>" and takes other path relocation
 255         variables such as $GIT_OBJECT_DIRECTORY,
 256         $GIT_INDEX_FILE... into account. For example, if
 257         $GIT_OBJECT_DIRECTORY is set to /foo/bar then "git rev-parse
 258         --git-path objects/abc" returns /foo/bar/abc.
 259
 260 --show-toplevel::
 261         Show the (by default, absolute) path of the top-level directory
 262         of the working tree. If there is no working tree, report an error.
 263
 264 --show-superproject-working-tree::
 265         Show the absolute path of the root of the superproject's
 266         working tree (if exists) that uses the current repository as
 267         its submodule.  Outputs nothing if the current repository is
 268         not used as a submodule by any project.
 269
 270 --shared-index-path::
 271         Show the path to the shared index file in split index mode, or
 272         empty if not in split-index mode.
 273
 274 The following options are unaffected by `--path-format`:
 275
 276 --absolute-git-dir::
 277         Like `--git-dir`, but its output is always the canonicalized
 278         absolute path.
 279
 280 --is-inside-git-dir::
 281         When the current working directory is below the repository
 282         directory print "true", otherwise "false".
 283
 284 --is-inside-work-tree::
 285         When the current working directory is inside the work tree of the
 286         repository print "true", otherwise "false".
 287
 288 --is-bare-repository::
 289         When the repository is bare print "true", otherwise "false".
 290
 291 --is-shallow-repository::
 292         When the repository is shallow print "true", otherwise "false".
 293
 294 --show-cdup::
 295         When the command is invoked from a subdirectory, show the
 296         path of the top-level directory relative to the current
 297         directory (typically a sequence of "../", or an empty string).
 298
 299 --show-prefix::
 300         When the command is invoked from a subdirectory, show the
 301         path of the current directory relative to the top-level
 302         directory.
 303
 304 --show-object-format[=(storage|input|output)]::
 305         Show the object format (hash algorithm) used for the repository
 306         for storage inside the `.git` directory, input, or output. For
 307         input, multiple algorithms may be printed, space-separated.
 308         If not specified, the default is "storage".
 309
 310 --show-ref-format::
 311         Show the reference storage format used for the repository.
 312
 313
 314 Other Options
 315 ~~~~~~~~~~~~~
 316
 317 --since=datestring::
 318 --after=datestring::
 319         Parse the date string, and output the corresponding
 320         --max-age= parameter for 'git rev-list'.
 321
 322 --until=datestring::
 323 --before=datestring::
 324         Parse the date string, and output the corresponding
 325         --min-age= parameter for 'git rev-list'.
 326
 327 <args>...::
 328         Flags and parameters to be parsed.
 329
 330
 331 include::revisions.txt[]
 332
 333 PARSEOPT
 334 --------
 335
 336 In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell
 337 scripts the same facilities C builtins have. It works as an option normalizer
 338 (e.g. splits single switches aggregate values), a bit like `getopt(1)` does.
 339
 340 It takes on the standard input the specification of the options to parse and
 341 understand, and echoes on the standard output a string suitable for `sh(1)` `eval`
 342 to replace the arguments with normalized ones.  In case of error, it outputs
 343 usage on the standard error stream, and exits with code 129.
 344
 345 Note: Make sure you quote the result when passing it to `eval`.  See
 346 below for an example.
 347
 348 Input Format
 349 ~~~~~~~~~~~~
 350
 351 'git rev-parse --parseopt' input format is fully text based. It has two parts,
 352 separated by a line that contains only `--`. The lines before the separator
 353 (should be one or more) are used for the usage.
 354 The lines after the separator describe the options.
 355
 356 Each line of options has this format:
 357
 358 ------------
 359 <opt-spec><flags>*<arg-hint>? SP+ help LF
 360 ------------
 361
 362 `<opt-spec>`::
 363         its format is the short option character, then the long option name
 364         separated by a comma. Both parts are not required, though at least one
 365         is necessary. May not contain any of the `<flags>` characters.
 366         `h,help`, `dry-run` and `f` are examples of correct `<opt-spec>`.
 367
 368 `<flags>`::
 369         `<flags>` are of `*`, `=`, `?` or `!`.
 370         * Use `=` if the option takes an argument.
 371
 372         * Use `?` to mean that the option takes an optional argument. You
 373           probably want to use the `--stuck-long` mode to be able to
 374           unambiguously parse the optional argument.
 375
 376         * Use `*` to mean that this option should not be listed in the usage
 377           generated for the `-h` argument. It's shown for `--help-all` as
 378           documented in linkgit:gitcli[7].
 379
 380         * Use `!` to not make the corresponding negated long option available.
 381
 382 `<arg-hint>`::
 383         `<arg-hint>`, if specified, is used as a name of the argument in the
 384         help output, for options that take arguments. `<arg-hint>` is
 385         terminated by the first whitespace.  It is customary to use a
 386         dash to separate words in a multi-word argument hint.
 387
 388 The remainder of the line, after stripping the spaces, is used
 389 as the help associated with the option.
 390
 391 Blank lines are ignored, and lines that don't match this specification are used
 392 as option group headers (start the line with a space to create such
 393 lines on purpose).
 394
 395 Example
 396 ~~~~~~~
 397
 398 ------------
 399 OPTS_SPEC="\
 400 some-command [<options>] <args>...
 401
 402 some-command does foo and bar!
 403 --
 404 h,help!   show the help
 405
 406 foo       some nifty option --foo
 407 bar=      some cool option --bar with an argument
 408 baz=arg   another cool option --baz with a named argument
 409 qux?path  qux may take a path argument but has meaning by itself
 410
 411   An option group Header
 412 C?        option C with an optional argument"
 413
 414 eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"
 415 ------------
 416
 417
 418 Usage text
 419 ~~~~~~~~~~
 420
 421 When `"$@"` is `-h` or `--help` in the above example, the following
 422 usage text would be shown:
 423
 424 ------------
 425 usage: some-command [<options>] <args>...
 426
 427     some-command does foo and bar!
 428
 429     -h, --help            show the help
 430     --[no-]foo            some nifty option --foo
 431     --[no-]bar ...        some cool option --bar with an argument
 432     --[no-]baz <arg>      another cool option --baz with a named argument
 433     --[no-]qux[=<path>]   qux may take a path argument but has meaning by itself
 434
 435 An option group Header
 436     -C[...]               option C with an optional argument
 437 ------------
 438
 439 SQ-QUOTE
 440 --------
 441
 442 In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a
 443 single line suitable for `sh(1)` `eval`. This line is made by
 444 normalizing the arguments following `--sq-quote`. Nothing other than
 445 quoting the arguments is done.
 446
 447 If you want command input to still be interpreted as usual by
 448 'git rev-parse' before the output is shell quoted, see the `--sq`
 449 option.
 450
 451 Example
 452 ~~~~~~~
 453
 454 ------------
 455 $ cat >your-git-script.sh <<\EOF
 456 #!/bin/sh
 457 args=$(git rev-parse --sq-quote "$@")   # quote user-supplied arguments
 458 command="git frotz -n24 $args"          # and use it inside a handcrafted
 459                                         # command line
 460 eval "$command"
 461 EOF
 462
 463 $ sh your-git-script.sh "a b'c"
 464 ------------
 465
 466 EXAMPLES
 467 --------
 468
 469 * Print the object name of the current commit:
 470 +
 471 ------------
 472 $ git rev-parse --verify HEAD
 473 ------------
 474
 475 * Print the commit object name from the revision in the $REV shell variable:
 476 +
 477 ------------
 478 $ git rev-parse --verify --end-of-options $REV^{commit}
 479 ------------
 480 +
 481 This will error out if $REV is empty or not a valid revision.
 482
 483 * Similar to above:
 484 +
 485 ------------
 486 $ git rev-parse --default master --verify --end-of-options $REV
 487 ------------
 488 +
 489 but if $REV is empty, the commit object name from master will be printed.
 490
 491 GIT
 492 ---
 493 Part of the linkgit:git[1] suite