1git-rev-parse(1) 2================ 3 4NAME 5---- 6git-rev-parse - Pick out and massage parameters 7 8 9SYNOPSIS 10-------- 11[verse] 12'git rev-parse' [ --option ] <args>... 13 14DESCRIPTION 15----------- 16 17Many git porcelainish commands take mixture of flags 18(i.e. parameters that begin with a dash '-') and parameters 19meant for the underlying 'git rev-list' command they use internally 20and flags and parameters for the other commands they use 21downstream of 'git rev-list'. This command is used to 22distinguish between them. 23 24 25OPTIONS 26------- 27--parseopt:: 28 Use 'git rev-parse' in option parsing mode (see PARSEOPT section below). 29 30--keep-dashdash:: 31 Only meaningful in `--parseopt` mode. Tells the option parser to echo 32 out the first `--` met instead of skipping it. 33 34--stop-at-non-option:: 35 Only meaningful in `--parseopt` mode. Lets the option parser stop at 36 the first non-option argument. This can be used to parse sub-commands 37 that take options themselves. 38 39--sq-quote:: 40 Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE 41 section below). In contrast to the `--sq` option below, this 42 mode does only quoting. Nothing else is done to command input. 43 44--revs-only:: 45 Do not output flags and parameters not meant for 46 'git rev-list' command. 47 48--no-revs:: 49 Do not output flags and parameters meant for 50 'git rev-list' command. 51 52--flags:: 53 Do not output non-flag parameters. 54 55--no-flags:: 56 Do not output flag parameters. 57 58--default <arg>:: 59 If there is no parameter given by the user, use `<arg>` 60 instead. 61 62--verify:: 63 The parameter given must be usable as a single, valid 64 object name. Otherwise barf and abort. 65 66-q:: 67--quiet:: 68 Only meaningful in `--verify` mode. Do not output an error 69 message if the first argument is not a valid object name; 70 instead exit with non-zero status silently. 71 72--sq:: 73 Usually the output is made one line per flag and 74 parameter. This option makes output a single line, 75 properly quoted for consumption by shell. Useful when 76 you expect your parameter to contain whitespaces and 77 newlines (e.g. when using pickaxe `-S` with 78 'git diff-{asterisk}'). In contrast to the `--sq-quote` option, 79 the command input is still interpreted as usual. 80 81--not:: 82 When showing object names, prefix them with '{caret}' and 83 strip '{caret}' prefix from the object names that already have 84 one. 85 86--symbolic:: 87 Usually the object names are output in SHA1 form (with 88 possible '{caret}' prefix); this option makes them output in a 89 form as close to the original input as possible. 90 91--symbolic-full-name:: 92 This is similar to \--symbolic, but it omits input that 93 are not refs (i.e. branch or tag names; or more 94 explicitly disambiguating "heads/master" form, when you 95 want to name the "master" branch when there is an 96 unfortunately named tag "master"), and show them as full 97 refnames (e.g. "refs/heads/master"). 98 99--abbrev-ref[=(strict|loose)]:: 100 A non-ambiguous short name of the objects name. 101 The option core.warnAmbiguousRefs is used to select the strict 102 abbreviation mode. 103 104--all:: 105 Show all refs found in `refs/`. 106 107--branches[=pattern]:: 108--tags[=pattern]:: 109--remotes[=pattern]:: 110 Show all branches, tags, or remote-tracking branches, 111 respectively (i.e., refs found in `refs/heads`, 112 `refs/tags`, or `refs/remotes`, respectively). 113+ 114If a `pattern` is given, only refs matching the given shell glob are 115shown. If the pattern does not contain a globbing character (`?`, 116`*`, or `[`), it is turned into a prefix match by appending `/*`. 117 118--glob=pattern:: 119 Show all refs matching the shell glob pattern `pattern`. If 120 the pattern does not start with `refs/`, this is automatically 121 prepended. If the pattern does not contain a globbing 122 character (`?`, `*`, or `[`), it is turned into a prefix 123 match by appending `/*`. 124 125--show-toplevel:: 126 Show the absolute path of the top-level directory. 127 128--show-prefix:: 129 When the command is invoked from a subdirectory, show the 130 path of the current directory relative to the top-level 131 directory. 132 133--show-cdup:: 134 When the command is invoked from a subdirectory, show the 135 path of the top-level directory relative to the current 136 directory (typically a sequence of "../", or an empty string). 137 138--git-dir:: 139 Show `$GIT_DIR` if defined. Otherwise show the path to 140 the .git directory, relative to the current directory. 141+ 142If `$GIT_DIR` is not defined and the current directory 143is not detected to lie in a git repository or work tree 144print a message to stderr and exit with nonzero status. 145 146--is-inside-git-dir:: 147 When the current working directory is below the repository 148 directory print "true", otherwise "false". 149 150--is-inside-work-tree:: 151 When the current working directory is inside the work tree of the 152 repository print "true", otherwise "false". 153 154--is-bare-repository:: 155 When the repository is bare print "true", otherwise "false". 156 157--local-env-vars:: 158 List the GIT_* environment variables that are local to the 159 repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR). 160 Only the names of the variables are listed, not their value, 161 even if they are set. 162 163--short:: 164--short=number:: 165 Instead of outputting the full SHA1 values of object names try to 166 abbreviate them to a shorter unique name. When no length is specified 167 7 is used. The minimum length is 4. 168 169--since=datestring:: 170--after=datestring:: 171 Parse the date string, and output the corresponding 172 --max-age= parameter for 'git rev-list'. 173 174--until=datestring:: 175--before=datestring:: 176 Parse the date string, and output the corresponding 177 --min-age= parameter for 'git rev-list'. 178 179<args>...:: 180 Flags and parameters to be parsed. 181 182--resolve-git-dir <path>:: 183 Check if <path> is a valid git-dir or a git-file pointing to a valid 184 git-dir. If <path> is a valid git-dir the resolved path to git-dir will 185 be printed. 186 187include::revisions.txt[] 188 189PARSEOPT 190-------- 191 192In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell 193scripts the same facilities C builtins have. It works as an option normalizer 194(e.g. splits single switches aggregate values), a bit like `getopt(1)` does. 195 196It takes on the standard input the specification of the options to parse and 197understand, and echoes on the standard output a string suitable for `sh(1)` `eval` 198to replace the arguments with normalized ones. In case of error, it outputs 199usage on the standard error stream, and exits with code 129. 200 201Note: Make sure you quote the result when passing it to `eval`. See 202below for an example. 203 204Input Format 205~~~~~~~~~~~~ 206 207'git rev-parse --parseopt' input format is fully text based. It has two parts, 208separated by a line that contains only `--`. The lines before the separator 209(should be more than one) are used for the usage. 210The lines after the separator describe the options. 211 212Each line of options has this format: 213 214------------ 215<opt_spec><flags>* SP+ help LF 216------------ 217 218`<opt_spec>`:: 219 its format is the short option character, then the long option name 220 separated by a comma. Both parts are not required, though at least one 221 is necessary. `h,help`, `dry-run` and `f` are all three correct 222 `<opt_spec>`. 223 224`<flags>`:: 225 `<flags>` are of `*`, `=`, `?` or `!`. 226 * Use `=` if the option takes an argument. 227 228 * Use `?` to mean that the option is optional (though its use is discouraged). 229 230 * Use `*` to mean that this option should not be listed in the usage 231 generated for the `-h` argument. It's shown for `--help-all` as 232 documented in linkgit:gitcli[7]. 233 234 * Use `!` to not make the corresponding negated long option available. 235 236The remainder of the line, after stripping the spaces, is used 237as the help associated to the option. 238 239Blank lines are ignored, and lines that don't match this specification are used 240as option group headers (start the line with a space to create such 241lines on purpose). 242 243Example 244~~~~~~~ 245 246------------ 247OPTS_SPEC="\ 248some-command [options] <args>... 249 250some-command does foo and bar! 251-- 252h,help show the help 253 254foo some nifty option --foo 255bar= some cool option --bar with an argument 256 257 An option group Header 258C? option C with an optional argument" 259 260eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)" 261------------ 262 263SQ-QUOTE 264-------- 265 266In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a 267single line suitable for `sh(1)` `eval`. This line is made by 268normalizing the arguments following `--sq-quote`. Nothing other than 269quoting the arguments is done. 270 271If you want command input to still be interpreted as usual by 272'git rev-parse' before the output is shell quoted, see the `--sq` 273option. 274 275Example 276~~~~~~~ 277 278------------ 279$ cat >your-git-script.sh <<\EOF 280#!/bin/sh 281args=$(git rev-parse --sq-quote "$@") # quote user-supplied arguments 282command="git frotz -n24 $args" # and use it inside a handcrafted 283 # command line 284eval "$command" 285EOF 286 287$ sh your-git-script.sh "a b'c" 288------------ 289 290EXAMPLES 291-------- 292 293* Print the object name of the current commit: 294+ 295------------ 296$ git rev-parse --verify HEAD 297------------ 298 299* Print the commit object name from the revision in the $REV shell variable: 300+ 301------------ 302$ git rev-parse --verify $REV 303------------ 304+ 305This will error out if $REV is empty or not a valid revision. 306 307* Same as above: 308+ 309------------ 310$ git rev-parse --default master --verify $REV 311------------ 312+ 313but if $REV is empty, the commit object name from master will be printed. 314 315GIT 316--- 317Part of the linkgit:git[1] suite