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 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 does only 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 show 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=[receive|uploadpack]::
 201         Do not include refs that would be hidden by `git-receive-pack` or
 202         `git-upload-pack` by consulting the appropriate `receive.hideRefs` or
 203         `uploadpack.hideRefs` configuration along with `transfer.hideRefs` (see
 204         linkgit:git-config[1]). This option affects the next pseudo-ref option
 205         `--all` or `--glob` and is cleared after processing them.
 206
 207 --disambiguate=<prefix>::
 208         Show every object whose name begins with the given prefix.
 209         The <prefix> must be at least 4 hexadecimal digits long to
 210         avoid listing each and every object in the repository by
 211         mistake.
 212
 213 Options for Files
 214 ~~~~~~~~~~~~~~~~~
 215
 216 --local-env-vars::
 217         List the GIT_* environment variables that are local to the
 218         repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
 219         Only the names of the variables are listed, not their value,
 220         even if they are set.
 221
 222 --path-format=(absolute|relative)::
 223         Controls the behavior of certain other options. If specified as absolute, the
 224         paths printed by those options will be absolute and canonical. If specified as
 225         relative, the paths will be relative to the current working directory if that
 226         is possible.  The default is option specific.
 227 +
 228 This option may be specified multiple times and affects only the arguments that
 229 follow it on the command line, either to the end of the command line or the next
 230 instance of this option.
 231
 232 The following options are modified by `--path-format`:
 233
 234 --git-dir::
 235         Show `$GIT_DIR` if defined. Otherwise show the path to
 236         the .git directory. The path shown, when relative, is
 237         relative to the current working directory.
 238 +
 239 If `$GIT_DIR` is not defined and the current directory
 240 is not detected to lie in a Git repository or work tree
 241 print a message to stderr and exit with nonzero status.
 242
 243 --git-common-dir::
 244         Show `$GIT_COMMON_DIR` if defined, else `$GIT_DIR`.
 245
 246 --resolve-git-dir <path>::
 247         Check if <path> is a valid repository or a gitfile that
 248         points at a valid repository, and print the location of the
 249         repository.  If <path> is a gitfile then the resolved path
 250         to the real repository is printed.
 251
 252 --git-path <path>::
 253         Resolve "$GIT_DIR/<path>" and takes other path relocation
 254         variables such as $GIT_OBJECT_DIRECTORY,
 255         $GIT_INDEX_FILE... into account. For example, if
 256         $GIT_OBJECT_DIRECTORY is set to /foo/bar then "git rev-parse
 257         --git-path objects/abc" returns /foo/bar/abc.
 258
 259 --show-toplevel::
 260         Show the (by default, absolute) path of the top-level directory
 261         of the working tree. If there is no working tree, report an error.
 262
 263 --show-superproject-working-tree::
 264         Show the absolute path of the root of the superproject's
 265         working tree (if exists) that uses the current repository as
 266         its submodule.  Outputs nothing if the current repository is
 267         not used as a submodule by any project.
 268
 269 --shared-index-path::
 270         Show the path to the shared index file in split index mode, or
 271         empty if not in split-index mode.
 272
 273 The following options are unaffected by `--path-format`:
 274
 275 --absolute-git-dir::
 276         Like `--git-dir`, but its output is always the canonicalized
 277         absolute path.
 278
 279 --is-inside-git-dir::
 280         When the current working directory is below the repository
 281         directory print "true", otherwise "false".
 282
 283 --is-inside-work-tree::
 284         When the current working directory is inside the work tree of the
 285         repository print "true", otherwise "false".
 286
 287 --is-bare-repository::
 288         When the repository is bare print "true", otherwise "false".
 289
 290 --is-shallow-repository::
 291         When the repository is shallow print "true", otherwise "false".
 292
 293 --show-cdup::
 294         When the command is invoked from a subdirectory, show the
 295         path of the top-level directory relative to the current
 296         directory (typically a sequence of "../", or an empty string).
 297
 298 --show-prefix::
 299         When the command is invoked from a subdirectory, show the
 300         path of the current directory relative to the top-level
 301         directory.
 302
 303 --show-object-format[=(storage|input|output)]::
 304         Show the object format (hash algorithm) used for the repository
 305         for storage inside the `.git` directory, input, or output. For
 306         input, multiple algorithms may be printed, space-separated.
 307         If not specified, the default is "storage".
 308
 309
 310 Other Options
 311 ~~~~~~~~~~~~~
 312
 313 --since=datestring::
 314 --after=datestring::
 315         Parse the date string, and output the corresponding
 316         --max-age= parameter for 'git rev-list'.
 317
 318 --until=datestring::
 319 --before=datestring::
 320         Parse the date string, and output the corresponding
 321         --min-age= parameter for 'git rev-list'.
 322
 323 <args>...::
 324         Flags and parameters to be parsed.
 325
 326
 327 include::revisions.txt[]
 328
 329 PARSEOPT
 330 --------
 331
 332 In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell
 333 scripts the same facilities C builtins have. It works as an option normalizer
 334 (e.g. splits single switches aggregate values), a bit like `getopt(1)` does.
 335
 336 It takes on the standard input the specification of the options to parse and
 337 understand, and echoes on the standard output a string suitable for `sh(1)` `eval`
 338 to replace the arguments with normalized ones.  In case of error, it outputs
 339 usage on the standard error stream, and exits with code 129.
 340
 341 Note: Make sure you quote the result when passing it to `eval`.  See
 342 below for an example.
 343
 344 Input Format
 345 ~~~~~~~~~~~~
 346
 347 'git rev-parse --parseopt' input format is fully text based. It has two parts,
 348 separated by a line that contains only `--`. The lines before the separator
 349 (should be one or more) are used for the usage.
 350 The lines after the separator describe the options.
 351
 352 Each line of options has this format:
 353
 354 ------------
 355 <opt-spec><flags>*<arg-hint>? SP+ help LF
 356 ------------
 357
 358 `<opt-spec>`::
 359         its format is the short option character, then the long option name
 360         separated by a comma. Both parts are not required, though at least one
 361         is necessary. May not contain any of the `<flags>` characters.
 362         `h,help`, `dry-run` and `f` are examples of correct `<opt-spec>`.
 363
 364 `<flags>`::
 365         `<flags>` are of `*`, `=`, `?` or `!`.
 366         * Use `=` if the option takes an argument.
 367
 368         * Use `?` to mean that the option takes an optional argument. You
 369           probably want to use the `--stuck-long` mode to be able to
 370           unambiguously parse the optional argument.
 371
 372         * Use `*` to mean that this option should not be listed in the usage
 373           generated for the `-h` argument. It's shown for `--help-all` as
 374           documented in linkgit:gitcli[7].
 375
 376         * Use `!` to not make the corresponding negated long option available.
 377
 378 `<arg-hint>`::
 379         `<arg-hint>`, if specified, is used as a name of the argument in the
 380         help output, for options that take arguments. `<arg-hint>` is
 381         terminated by the first whitespace.  It is customary to use a
 382         dash to separate words in a multi-word argument hint.
 383
 384 The remainder of the line, after stripping the spaces, is used
 385 as the help associated to the option.
 386
 387 Blank lines are ignored, and lines that don't match this specification are used
 388 as option group headers (start the line with a space to create such
 389 lines on purpose).
 390
 391 Example
 392 ~~~~~~~
 393
 394 ------------
 395 OPTS_SPEC="\
 396 some-command [<options>] <args>...
 397
 398 some-command does foo and bar!
 399 --
 400 h,help    show the help
 401
 402 foo       some nifty option --foo
 403 bar=      some cool option --bar with an argument
 404 baz=arg   another cool option --baz with a named argument
 405 qux?path  qux may take a path argument but has meaning by itself
 406
 407   An option group Header
 408 C?        option C with an optional argument"
 409
 410 eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"
 411 ------------
 412
 413
 414 Usage text
 415 ~~~~~~~~~~
 416
 417 When `"$@"` is `-h` or `--help` in the above example, the following
 418 usage text would be shown:
 419
 420 ------------
 421 usage: some-command [<options>] <args>...
 422
 423     some-command does foo and bar!
 424
 425     -h, --help            show the help
 426     --foo                 some nifty option --foo
 427     --bar ...             some cool option --bar with an argument
 428     --baz <arg>           another cool option --baz with a named argument
 429     --qux[=<path>]        qux may take a path argument but has meaning by itself
 430
 431 An option group Header
 432     -C[...]               option C with an optional argument
 433 ------------
 434
 435 SQ-QUOTE
 436 --------
 437
 438 In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a
 439 single line suitable for `sh(1)` `eval`. This line is made by
 440 normalizing the arguments following `--sq-quote`. Nothing other than
 441 quoting the arguments is done.
 442
 443 If you want command input to still be interpreted as usual by
 444 'git rev-parse' before the output is shell quoted, see the `--sq`
 445 option.
 446
 447 Example
 448 ~~~~~~~
 449
 450 ------------
 451 $ cat >your-git-script.sh <<\EOF
 452 #!/bin/sh
 453 args=$(git rev-parse --sq-quote "$@")   # quote user-supplied arguments
 454 command="git frotz -n24 $args"          # and use it inside a handcrafted
 455                                         # command line
 456 eval "$command"
 457 EOF
 458
 459 $ sh your-git-script.sh "a b'c"
 460 ------------
 461
 462 EXAMPLES
 463 --------
 464
 465 * Print the object name of the current commit:
 466 +
 467 ------------
 468 $ git rev-parse --verify HEAD
 469 ------------
 470
 471 * Print the commit object name from the revision in the $REV shell variable:
 472 +
 473 ------------
 474 $ git rev-parse --verify --end-of-options $REV^{commit}
 475 ------------
 476 +
 477 This will error out if $REV is empty or not a valid revision.
 478
 479 * Similar to above:
 480 +
 481 ------------
 482 $ git rev-parse --default master --verify --end-of-options $REV
 483 ------------
 484 +
 485 but if $REV is empty, the commit object name from master will be printed.
 486
 487 GIT
 488 ---
 489 Part of the linkgit:git[1] suite