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' [ --option ] <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 eval "set -- $(git rev-parse --sq --prefix "$prefix" "$@")"
  95 ----
  96
  97 --verify::
  98         Verify that exactly one parameter is provided, and that it
  99         can be turned into a raw 20-byte SHA-1 that can be used to
 100         access the object database. If so, emit it to the standard
 101         output; otherwise, error out.
 102 +
 103 If you want to make sure that the output actually names an object in
 104 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 For example, `git rev-parse "$VAR^{commit}"` will make sure `$VAR`
 107 names an existing object that is a commit-ish (i.e. a commit, or an
 108 annotated tag that points at a commit).  To make sure that `$VAR`
 109 names an existing object of any type, `git rev-parse "$VAR^{object}"`
 110 can be used.
 111
 112 -q::
 113 --quiet::
 114         Only meaningful in `--verify` mode. Do not output an error
 115         message if the first argument is not a valid object name;
 116         instead exit with non-zero status silently.
 117
 118 --sq::
 119         Usually the output is made one line per flag and
 120         parameter.  This option makes output a single line,
 121         properly quoted for consumption by shell.  Useful when
 122         you expect your parameter to contain whitespaces and
 123         newlines (e.g. when using pickaxe `-S` with
 124         'git diff-{asterisk}'). In contrast to the `--sq-quote` option,
 125         the command input is still interpreted as usual.
 126
 127 --not::
 128         When showing object names, prefix them with '{caret}' and
 129         strip '{caret}' prefix from the object names that already have
 130         one.
 131
 132 --abbrev-ref[=(strict|loose)]::
 133         A non-ambiguous short name of the objects name.
 134         The option core.warnAmbiguousRefs is used to select the strict
 135         abbreviation mode.
 136
 137 --short::
 138 --short=number::
 139         Instead of outputting the full SHA-1 values of object names try to
 140         abbreviate them to a shorter unique name. When no length is specified
 141         7 is used. The minimum length is 4.
 142
 143 --symbolic::
 144         Usually the object names are output in SHA-1 form (with
 145         possible '{caret}' prefix); this option makes them output in a
 146         form as close to the original input as possible.
 147
 148 --symbolic-full-name::
 149         This is similar to \--symbolic, but it omits input that
 150         are not refs (i.e. branch or tag names; or more
 151         explicitly disambiguating "heads/master" form, when you
 152         want to name the "master" branch when there is an
 153         unfortunately named tag "master"), and show them as full
 154         refnames (e.g. "refs/heads/master").
 155
 156 Options for Objects
 157 ~~~~~~~~~~~~~~~~~~~
 158
 159 --all::
 160         Show all refs found in `refs/`.
 161
 162 --branches[=pattern]::
 163 --tags[=pattern]::
 164 --remotes[=pattern]::
 165         Show all branches, tags, or remote-tracking branches,
 166         respectively (i.e., refs found in `refs/heads`,
 167         `refs/tags`, or `refs/remotes`, respectively).
 168 +
 169 If a `pattern` is given, only refs matching the given shell glob are
 170 shown.  If the pattern does not contain a globbing character (`?`,
 171 `*`, or `[`), it is turned into a prefix match by appending `/*`.
 172
 173 --glob=pattern::
 174         Show all refs matching the shell glob pattern `pattern`. If
 175         the pattern does not start with `refs/`, this is automatically
 176         prepended.  If the pattern does not contain a globbing
 177         character (`?`, `*`, or `[`), it is turned into a prefix
 178         match by appending `/*`.
 179
 180 --disambiguate=<prefix>::
 181         Show every object whose name begins with the given prefix.
 182         The <prefix> must be at least 4 hexadecimal digits long to
 183         avoid listing each and every object in the repository by
 184         mistake.
 185
 186 Options for Files
 187 ~~~~~~~~~~~~~~~~~
 188
 189 --local-env-vars::
 190         List the GIT_* environment variables that are local to the
 191         repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
 192         Only the names of the variables are listed, not their value,
 193         even if they are set.
 194
 195 --git-dir::
 196         Show `$GIT_DIR` if defined. Otherwise show the path to
 197         the .git directory. The path shown, when relative, is
 198         relative to the current working directory.
 199 +
 200 If `$GIT_DIR` is not defined and the current directory
 201 is not detected to lie in a Git repository or work tree
 202 print a message to stderr and exit with nonzero status.
 203
 204 --is-inside-git-dir::
 205         When the current working directory is below the repository
 206         directory print "true", otherwise "false".
 207
 208 --is-inside-work-tree::
 209         When the current working directory is inside the work tree of the
 210         repository print "true", otherwise "false".
 211
 212 --is-bare-repository::
 213         When the repository is bare print "true", otherwise "false".
 214
 215 --resolve-git-dir <path>::
 216         Check if <path> is a valid repository or a gitfile that
 217         points at a valid repository, and print the location of the
 218         repository.  If <path> is a gitfile then the resolved path
 219         to the real repository is printed.
 220
 221 --show-cdup::
 222         When the command is invoked from a subdirectory, show the
 223         path of the top-level directory relative to the current
 224         directory (typically a sequence of "../", or an empty string).
 225
 226 --show-prefix::
 227         When the command is invoked from a subdirectory, show the
 228         path of the current directory relative to the top-level
 229         directory.
 230
 231 --show-toplevel::
 232         Show the absolute path of the top-level directory.
 233
 234 Other Options
 235 ~~~~~~~~~~~~~
 236
 237 --since=datestring::
 238 --after=datestring::
 239         Parse the date string, and output the corresponding
 240         --max-age= parameter for 'git rev-list'.
 241
 242 --until=datestring::
 243 --before=datestring::
 244         Parse the date string, and output the corresponding
 245         --min-age= parameter for 'git rev-list'.
 246
 247 <args>...::
 248         Flags and parameters to be parsed.
 249
 250
 251 include::revisions.txt[]
 252
 253 PARSEOPT
 254 --------
 255
 256 In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell
 257 scripts the same facilities C builtins have. It works as an option normalizer
 258 (e.g. splits single switches aggregate values), a bit like `getopt(1)` does.
 259
 260 It takes on the standard input the specification of the options to parse and
 261 understand, and echoes on the standard output a string suitable for `sh(1)` `eval`
 262 to replace the arguments with normalized ones.  In case of error, it outputs
 263 usage on the standard error stream, and exits with code 129.
 264
 265 Note: Make sure you quote the result when passing it to `eval`.  See
 266 below for an example.
 267
 268 Input Format
 269 ~~~~~~~~~~~~
 270
 271 'git rev-parse --parseopt' input format is fully text based. It has two parts,
 272 separated by a line that contains only `--`. The lines before the separator
 273 (should be more than one) are used for the usage.
 274 The lines after the separator describe the options.
 275
 276 Each line of options has this format:
 277
 278 ------------
 279 <opt_spec><flags>* SP+ help LF
 280 ------------
 281
 282 `<opt_spec>`::
 283         its format is the short option character, then the long option name
 284         separated by a comma. Both parts are not required, though at least one
 285         is necessary. `h,help`, `dry-run` and `f` are all three correct
 286         `<opt_spec>`.
 287
 288 `<flags>`::
 289         `<flags>` are of `*`, `=`, `?` or `!`.
 290         * Use `=` if the option takes an argument.
 291
 292         * Use `?` to mean that the option takes an optional argument. You
 293           probably want to use the `--stuck-long` mode to be able to
 294           unambiguously parse the optional argument.
 295
 296         * Use `*` to mean that this option should not be listed in the usage
 297           generated for the `-h` argument. It's shown for `--help-all` as
 298           documented in linkgit:gitcli[7].
 299
 300         * Use `!` to not make the corresponding negated long option available.
 301
 302 The remainder of the line, after stripping the spaces, is used
 303 as the help associated to the option.
 304
 305 Blank lines are ignored, and lines that don't match this specification are used
 306 as option group headers (start the line with a space to create such
 307 lines on purpose).
 308
 309 Example
 310 ~~~~~~~
 311
 312 ------------
 313 OPTS_SPEC="\
 314 some-command [options] <args>...
 315
 316 some-command does foo and bar!
 317 --
 318 h,help    show the help
 319
 320 foo       some nifty option --foo
 321 bar=      some cool option --bar with an argument
 322
 323   An option group Header
 324 C?        option C with an optional argument"
 325
 326 eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"
 327 ------------
 328
 329 SQ-QUOTE
 330 --------
 331
 332 In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a
 333 single line suitable for `sh(1)` `eval`. This line is made by
 334 normalizing the arguments following `--sq-quote`. Nothing other than
 335 quoting the arguments is done.
 336
 337 If you want command input to still be interpreted as usual by
 338 'git rev-parse' before the output is shell quoted, see the `--sq`
 339 option.
 340
 341 Example
 342 ~~~~~~~
 343
 344 ------------
 345 $ cat >your-git-script.sh <<\EOF
 346 #!/bin/sh
 347 args=$(git rev-parse --sq-quote "$@")   # quote user-supplied arguments
 348 command="git frotz -n24 $args"          # and use it inside a handcrafted
 349                                         # command line
 350 eval "$command"
 351 EOF
 352
 353 $ sh your-git-script.sh "a b'c"
 354 ------------
 355
 356 EXAMPLES
 357 --------
 358
 359 * Print the object name of the current commit:
 360 +
 361 ------------
 362 $ git rev-parse --verify HEAD
 363 ------------
 364
 365 * Print the commit object name from the revision in the $REV shell variable:
 366 +
 367 ------------
 368 $ git rev-parse --verify $REV^{commit}
 369 ------------
 370 +
 371 This will error out if $REV is empty or not a valid revision.
 372
 373 * Similar to above:
 374 +
 375 ------------
 376 $ git rev-parse --default master --verify $REV
 377 ------------
 378 +
 379 but if $REV is empty, the commit object name from master will be printed.
 380
 381 GIT
 382 ---
 383 Part of the linkgit:git[1] suite