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