2024-11-262024-04-292024-02-232023-11-202023-08-212023-06-012023-04-172022-12-122022-08-112021-08-162021-03-152020-12-272020-10-192020-06-012020-01-132019-08-162019-06-072018-09-102018-06-212019-12-062019-12-062018-05-222017-09-222017-09-222017-09-222017-07-302017-07-302017-05-052017-05-052015-09-042014-12-172014-12-17Many Git porcelainish commands take a mixture of flags(i.e. parameters that begin with a dash-) and parametersmeant for the underlyinggit rev-list command they use internallyand flags and parameters for the other commands they usedownstream ofgit rev-list. The primary purpose of this commandis to allow calling programs to distinguish between them. There area few other operation modes that have nothing to do with the above"help parse command line options".
Unless otherwise specified, most of the options and operation modesrequire you to run this command inside a git repository or a workingtree that is under the control of a git repository, and will give youa fatal error otherwise.
Each of these options must appear first on the command line.
Usegit rev-parse in option parsing mode (see PARSEOPT section below).The command in this mode can be used outside a repository ora working tree controlled by a repository.
Usegit rev-parse in shell quoting mode (see SQ-QUOTEsection below). In contrast to the--sq option below, thismode only does quoting. Nothing else is done to command input.The command in this mode can be used outside a repository ora working tree controlled by a repository.
Only meaningful in--parseopt mode. Tells the option parser to echoout the first-- met instead of skipping it.
Only meaningful in--parseopt mode. Lets the option parser stop atthe first non-option argument. This can be used to parse sub-commandsthat take options themselves.
Only meaningful in--parseopt mode. Output the options in theirlong form if available, and with their arguments stuck.
If there is no parameter given by the user, use<arg>instead.
Behave as ifgit rev-parse was invoked from the<arg>subdirectory of the working tree. Any relative filenames areresolved as if they are prefixed by<arg> and will be printedin that form.
This can be used to convert arguments to a command run in a subdirectoryso that they can still be used after moving to the top-level of therepository. For example:
prefix=$(git rev-parse --show-prefix)cd "$(git rev-parse --show-toplevel)"# rev-parse provides the -- needed for 'set'eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")"
Verify that exactly one parameter is provided, and that itcan be turned into a raw 20-byte SHA-1 that can be used toaccess the object database. If so, emit it to the standardoutput; otherwise, error out.
If you want to make sure that the output actually names an object inyour object database and/or can be used as a specific type of objectyou require, you can add the^{type} peeling operator to the parameter.For example,gitrev-parse"$VAR^{commit}" will make sure$VARnames an existing object that is a commit-ish (i.e. a commit, or anannotated tag that points at a commit). To make sure that$VARnames an existing object of any type,gitrev-parse"$VAR^{object}"can be used.
Note that if you are verifying a name from an untrusted source, it iswise to use--end-of-options so that the name argument is not mistakenfor another option.
Only meaningful in--verify mode. Do not output an errormessage if the first argument is not a valid object name;instead exit with non-zero status silently.SHA-1s for valid object names are printed to stdout on success.
Usually the output is made one line per flag andparameter. This option makes output a single line,properly quoted for consumption by shell. Useful whenyou expect your parameter to contain whitespaces andnewlines (e.g. when using pickaxe-S withgit diff-*). In contrast to the--sq-quote option,the command input is still interpreted as usual.
Same as--verify but shortens the object name to a uniqueprefix with at leastlength characters. The minimum lengthis 4, the default is the effective value of thecore.abbrevconfiguration variable (seegit-config[1]).
When showing object names, prefix them with^ andstrip^ prefix from the object names that already haveone.
A non-ambiguous short name of the objects name.The option core.warnAmbiguousRefs is used to select the strictabbreviation mode.
Usually the object names are output in SHA-1 form (withpossible^ prefix); this option makes them output in aform as close to the original input as possible.
This is similar to --symbolic, but it omits input thatare not refs (i.e. branch or tag names; or moreexplicitly disambiguating "heads/master" form, when youwant to name the "master" branch when there is anunfortunately named tag "master"), and shows them as fullrefnames (e.g. "refs/heads/master").
Allow oids to be input from any object format that the currentrepository supports.
Specifying "sha1" translates if necessary and returns a sha1 oid.
Specifying "sha256" translates if necessary and returns a sha256 oid.
Specifying "storage" translates if necessary and returns an oid inencoded in the storage hash algorithm.
Show all refs found inrefs/.
Show all branches, tags, or remote-tracking branches,respectively (i.e., refs found inrefs/heads,refs/tags, orrefs/remotes, respectively).
If apattern is given, only refs matching the given shell glob areshown. If the pattern does not contain a globbing character (?,*, or[), it is turned into a prefix match by appending/*.
Show all refs matching the shell glob patternpattern. Ifthe pattern does not start withrefs/, this is automaticallyprepended. If the pattern does not contain a globbingcharacter (?,*, or[), it is turned into a prefixmatch by appending/*.
Do not include refs matching<glob-pattern> that the next--all,--branches,--tags,--remotes, or--glob would otherwiseconsider. Repetitions of this option accumulate exclusion patternsup to the next--all,--branches,--tags,--remotes, or--glob option (other options or arguments do not clearaccumulated patterns).
The patterns given should not begin withrefs/heads,refs/tags, orrefs/remotes when applied to--branches,--tags, or--remotes,respectively, and they must begin withrefs/ when applied to--globor--all. If a trailing/* is intended, it must be givenexplicitly.
Do not include refs that would be hidden bygit-fetch,git-receive-pack orgit-upload-pack by consulting the appropriatefetch.hideRefs,receive.hideRefs oruploadpack.hideRefsconfiguration along withtransfer.hideRefs (seegit-config[1]). This option affects the next pseudo-ref option--all or--glob and is cleared after processing them.
Show every object whose name begins with the given prefix.The <prefix> must be at least 4 hexadecimal digits long toavoid listing each and every object in the repository bymistake.
List the GIT_* environment variables that are local to therepository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).Only the names of the variables are listed, not their value,even if they are set.
Controls the behavior of certain other options. If specified as absolute, thepaths printed by those options will be absolute and canonical. If specified asrelative, the paths will be relative to the current working directory if thatis possible. The default is option specific.
This option may be specified multiple times and affects only the arguments thatfollow it on the command line, either to the end of the command line or the nextinstance of this option.
The following options are modified by--path-format:
Show$GIT_DIR if defined. Otherwise show the path tothe .git directory. The path shown, when relative, isrelative to the current working directory.
If$GIT_DIR is not defined and the current directoryis not detected to lie in a Git repository or work treeprint a message to stderr and exit with nonzero status.
Show$GIT_COMMON_DIR if defined, else$GIT_DIR.
Check if <path> is a valid repository or a gitfile thatpoints at a valid repository, and print the location of therepository. If <path> is a gitfile then the resolved pathto the real repository is printed.
Resolve "$GIT_DIR/<path>" and takes other path relocationvariables such as $GIT_OBJECT_DIRECTORY,$GIT_INDEX_FILE… into account. For example, if$GIT_OBJECT_DIRECTORY is set to /foo/bar then "git rev-parse--git-path objects/abc" returns /foo/bar/abc.
Show the (by default, absolute) path of the top-level directoryof the working tree. If there is no working tree, report an error.
Show the absolute path of the root of the superproject’sworking tree (if exists) that uses the current repository asits submodule. Outputs nothing if the current repository isnot used as a submodule by any project.
Show the path to the shared index file in split index mode, orempty if not in split-index mode.
The following options are unaffected by--path-format:
Like--git-dir, but its output is always the canonicalizedabsolute path.
When the current working directory is below the repositorydirectory print "true", otherwise "false".
When the current working directory is inside the work tree of therepository print "true", otherwise "false".
When the repository is bare print "true", otherwise "false".
When the repository is shallow print "true", otherwise "false".
When the command is invoked from a subdirectory, show thepath of the top-level directory relative to the currentdirectory (typically a sequence of "../", or an empty string).
When the command is invoked from a subdirectory, show thepath of the current directory relative to the top-leveldirectory.
Show the object format (hash algorithm) used for the repositoryfor storage inside the.git directory, input, or output. Forinput, multiple algorithms may be printed, space-separated.If not specified, the default is "storage".
Show the reference storage format used for the repository.
A revision parameter<rev> typically, but not necessarily, names acommit object. It uses what is called anextended SHA-1syntax. Here are various ways to spell object names. Theones listed near the end of this list name trees andblobs contained in a commit.
Note | This document shows the "raw" syntax as seen by git. The shelland other UIs might require additional quoting to protect specialcharacters and to avoid word splitting. |
The full SHA-1 object name (40-byte hexadecimal string), ora leading substring that is unique within the repository.E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e bothname the same commit object if there is no other object inyour repository whose object name starts with dae86e.
Output fromgitdescribe; i.e. a closest tag, optionallyfollowed by a dash and a number of commits, followed by a dash, ag, and an abbreviated object name.
A symbolic ref name. E.g.master typically means the commitobject referenced byrefs/heads/master. If youhappen to have bothheads/master andtags/master, you canexplicitly sayheads/master to tell Git which one you mean.When ambiguous, a<refname> is disambiguated by taking thefirst match in the following rules:
If$GIT_DIR/<refname> exists, that is what you mean (this is usuallyuseful only forHEAD,FETCH_HEAD,ORIG_HEAD,MERGE_HEAD,REBASE_HEAD,REVERT_HEAD,CHERRY_PICK_HEAD,BISECT_HEADandAUTO_MERGE);
otherwise,refs/<refname> if it exists;
otherwise,refs/tags/<refname> if it exists;
otherwise,refs/heads/<refname> if it exists;
otherwise,refs/remotes/<refname> if it exists;
otherwise,refs/remotes/<refname>/HEAD if it exists.
HEADnames the commit on which you based the changes in the working tree.
FETCH_HEADrecords the branch which you fetched from a remote repository withyour lastgitfetch invocation.
ORIG_HEADis created by commands that move yourHEAD in a drastic way (gitam,gitmerge,gitrebase,gitreset), to record the positionof theHEAD before their operation, so that you can easily changethe tip of the branch back to the state before you ran them.
MERGE_HEADrecords the commit(s) which you are merging into your branch when yourungitmerge.
REBASE_HEADduring a rebase, records the commit at which the operation iscurrently stopped, either because of conflicts or anedit command inan interactive rebase.
REVERT_HEADrecords the commit which you are reverting when you rungitrevert.
CHERRY_PICK_HEADrecords the commit which you are cherry-picking when you rungitcherry-pick.
BISECT_HEADrecords the current commit to be tested when you rungitbisect--no-checkout.
AUTO_MERGErecords a tree object corresponding to the state theort merge strategy wrote to the working tree when a merge operationresulted in conflicts.
Note that any of therefs/* cases above may come either fromthe$GIT_DIR/refs directory or from the$GIT_DIR/packed-refs file.While the ref name encoding is unspecified, UTF-8 is preferred assome output processing may assume ref names in UTF-8.
@ alone is a shortcut forHEAD.
A ref followed by the suffix@ with a date specificationenclosed in a bracepair (e.g.{yesterday},{1 month 2 weeks 3 days 1 hour 1second ago} or{1979-02-26 18:30:00}) specifies the valueof the ref at a prior point in time. This suffix may only beused immediately following a ref name and the ref must have anexisting log ($GIT_DIR/logs/<ref>). Note that this looks up the stateof yourlocal ref at a given time; e.g., what was in your localmaster branch last week. If you want to look at commits made duringcertain times, see--since and--until.
A ref followed by the suffix@ with an ordinal specificationenclosed in a brace pair (e.g.{1},{15}) specifiesthe n-th prior value of that ref. For examplemaster@{1}is the immediate prior value ofmaster whilemaster@{5}is the 5th prior value ofmaster. This suffix may only be usedimmediately following a ref name and the ref must have an existinglog ($GIT_DIR/logs/<refname>).
You can use the@ construct with an empty ref part to get at areflog entry of the current branch. For example, if you are onbranchblabla then@{1} means the same asblabla@{1}.
The construct@{-<n>} means the <n>th branch/commit checked outbefore the current one.
A branch B may be set up to build on top of a branch X (configured withbranch.<name>.merge) at a remote R (configured withbranch.<name>.remote). B@{u} refers to the remote-tracking branch forthe branch X taken from remote R, typically found atrefs/remotes/R/X.
The suffix@{push} reports the branch "where we would push to" ifgitpush were run whilebranchname was checked out (or the currentHEAD if no branchname is specified). Like for@{upstream}, we reportthe remote-tracking branch that corresponds to that branch at the remote.
Here’s an example to make it more clear:
$ git config push.default current$ git config remote.pushdefault myfork$ git switch -c mybranch origin/master$ git rev-parse --symbolic-full-name @{upstream}refs/remotes/origin/master$ git rev-parse --symbolic-full-name @{push}refs/remotes/myfork/mybranchNote in the example that we set up a triangular workflow, where we pullfrom one location and push to another. In a non-triangular workflow,@{push} is the same as@{upstream}, and there is no need for it.
This suffix is also accepted when spelled in uppercase, and means the samething no matter the case.
A suffix^ to a revision parameter means the first parent ofthat commit object.^<n> means the <n>th parent (i.e.<rev>^is equivalent to<rev>^1). As a special rule,<rev>^0 means the commit itself and is used when<rev> is theobject name of a tag object that refers to a commit object.
A suffix~ to a revision parameter means the first parent ofthat commit object.A suffix~<n> to a revision parameter means the commitobject that is the <n>th generation ancestor of the namedcommit object, following only the first parents. I.e.<rev>~3 isequivalent to<rev>^^^ which is equivalent to<rev>^1^1^1. See below for an illustration ofthe usage of this form.
A suffix^ followed by an object type name enclosed inbrace pair means dereference the object at<rev> recursively untilan object of type<type> is found or the object cannot bedereferenced anymore (in which case, barf).For example, if<rev> is a commit-ish,<rev>^{commit}describes the corresponding commit object.Similarly, if<rev> is a tree-ish,<rev>^{tree}describes the corresponding tree object.<rev>^0is a short-hand for<rev>^{commit}.
<rev>^{object} can be used to make sure<rev> names anobject that exists, without requiring<rev> to be a tag, andwithout dereferencing<rev>; because a tag is already an object,it does not have to be dereferenced even once to get to an object.
<rev>^{tag} can be used to ensure that<rev> identifies anexisting tag object.
A suffix^ followed by an empty brace pairmeans the object could be a tag,and dereference the tag recursively until a non-tag object isfound.
A suffix^ to a revision parameter, followed by a bracepair that contains a text led by a slash,is the same as the:/fix nasty bug syntax below except thatit returns the youngest matching commit which is reachable fromthe<rev> before^.
A colon, followed by a slash, followed by a text, namesa commit whose commit message matches the specified regular expression.This name returns the youngest matching commit which isreachable from any ref, including HEAD.The regular expression can match any part of thecommit message. To match messages starting with a string, one can usee.g.:/^foo. The special sequence:/! is reserved for modifiers to whatis matched.:/!-foo performs a negative match, while:/!!foo matches aliteral! character, followed byfoo. Any other sequence beginning with:/! is reserved for now.Depending on the given text, the shell’s word splitting rules mightrequire additional quoting.
A suffix: followed by a path names the blob or treeat the given path in the tree-ish object named by the partbefore the colon.A path starting with./ or../ is relative to the current working directory.The given path will be converted to be relative to the working tree’s root directory.This is most useful to address a blob or tree from a commit or tree that hasthe same tree structure as the working tree.
A colon, optionally followed by a stage number (0 to 3) and acolon, followed by a path, names a blob object in theindex at the given path. A missing stage number (and the colonthat follows it) names a stage 0 entry. During a merge, stage1 is the common ancestor, stage 2 is the target branch’s version(typically the current branch), and stage 3 is the version fromthe branch which is being merged.
Here is an illustration, by Jon Loeliger. Both commit nodes Band C are parents of commit node A. Parent commits are orderedleft-to-right.
G H I J \ / \ / D E F \ | / \ \ | / | \|/ | B C \ / \ / A
A = = A^0B = A^ = A^1 = A~1C = = A^2D = A^^ = A^1^1 = A~2E = B^2 = A^^2F = B^3 = A^^3G = A^^^ = A^1^1^1 = A~3H = D^2 = B^^2 = A^^^2 = A~2^2I = F^ = B^3^ = A^^3^J = F^2 = B^3^2 = A^^3^2
History traversing commands such asgitlog operate on a setof commits, not just a single commit.
For these commands,specifying a single revision, using the notation described in theprevious section, means the set of commitsreachable from the givencommit.
Specifying several revisions means the set of commits reachable fromany of the given commits.
A commit’s reachable set is the commit itself and the commits inits ancestry chain.
There are several notations to specify a set of connected commits(called a "revision range"), illustrated below.
The^r1 r2 set operation appears so often that there is a shorthandfor it. When you have two commitsr1 andr2 (named accordingto the syntax explained in SPECIFYING REVISIONS above), you can askfor commits that are reachable from r2 excluding those that are reachablefrom r1 by^r1 r2 and it can be written asr1..r2.
A similar notationr1...r2 is called symmetric differenceofr1 andr2 and is defined asr1 r2 --not $(git merge-base --all r1 r2).It is the set of commits that are reachable from either one ofr1 (left side) orr2 (right side) but not from both.
In these two shorthand notations, you can omit one end and let it default to HEAD.For example,origin.. is a shorthand fororigin..HEAD and asks "Whatdid I do since I forked from the origin branch?" Similarly,..originis a shorthand forHEAD..origin and asks "What did the origin do sinceI forked from them?" Note that.. would meanHEAD..HEAD which is anempty range that is both reachable and unreachable from HEAD.
Commands that are specifically designed to take two distinct ranges(e.g. "git range-diff R1 R2" to compare two ranges) do exist, butthey are exceptions. Unless otherwise noted, all "git" commandsthat operate on a set of commits work on a single revision range.In other words, writing two "two-dot range notation" next to eachother, e.g.
$ git log A..B C..D
doesnot specify two revision ranges for most commands. Insteadit will name a single connected set of commits, i.e. those that arereachable from either B or D but are reachable from neither A or C.In a linear history like this:
---A---B---o---o---C---D
because A and B are reachable from C, the revision range specifiedby these two dotted ranges is a single commit D.
Three other shorthands exist, particularly useful for merge commits,for naming a set that is formed by a commit and its parent commits.
Ther1^@ notation means all parents ofr1.
Ther1^! notation includes commitr1 but excludes all of its parents.By itself, this notation denotes the single commitr1.
The<rev>^-[<n>] notation includes<rev> but excludes the <n>thparent (i.e. a shorthand for<rev>^<n>..<rev>), with<n> = 1 ifnot given. This is typically useful for merge commits where youcan just pass<commit>^- to get all the commits in the branchthat was merged in merge commit<commit> (including<commit>itself).
While<rev>^<n> was about specifying a single commit parent, thesethree notations also consider its parents. For example you can sayHEAD^2^@, however you cannot sayHEAD^@^2.
Include commits that are reachable from <rev> (i.e. <rev> and itsancestors).
Exclude commits that are reachable from <rev> (i.e. <rev> and itsancestors).
Include commits that are reachable from <rev2> but excludethose that are reachable from <rev1>. When either <rev1> or<rev2> is omitted, it defaults toHEAD.
Include commits that are reachable from either <rev1> or<rev2> but exclude those that are reachable from both. Wheneither <rev1> or <rev2> is omitted, it defaults toHEAD.
A suffix^ followed by an at sign is the same as listingall parents of<rev> (meaning, include anything reachable fromits parents, but not the commit itself).
A suffix^ followed by an exclamation mark is the sameas giving commit<rev> and all its parents prefixed with^ to exclude them (and their ancestors).
Equivalent to<rev>^<n>..<rev>, with<n> = 1 if notgiven.
Here are a handful of examples using the Loeliger illustration above,with each step in the notation’s expansion and selection carefullyspelt out:
Args Expanded arguments Selected commits D G H D D F G H I J D F ^G D H D ^D B E I J F B ^D B C E I J F B C C I J F C B..C = ^B C C B...C = B ^F C G H D E B C B^- = B^..B = ^B^1 B E I J F B C^@ = C^1 = F I J F B^@ = B^1 B^2 B^3 = D E F D G H E F I J C^! = C ^C^@ = C ^C^1 = C ^F C B^! = B ^B^@ = B ^B^1 ^B^2 ^B^3 = B ^D ^E ^F B F^! D = F ^I ^J D G H D F
In--parseopt mode,git rev-parse helps massaging options to bring to shellscripts the same facilities C builtins have. It works as an option normalizer(e.g. splits single switches aggregate values), a bit likegetopt(1) does.
It takes on the standard input the specification of the options to parse andunderstand, and echoes on the standard output a string suitable forsh(1)evalto replace the arguments with normalized ones. In case of error, it outputsusage on the standard error stream, and exits with code 129.
Note: Make sure you quote the result when passing it toeval. Seebelow for an example.
git rev-parse --parseopt input format is fully text based. It has two parts,separated by a line that contains only--. The lines before the separator(should be one or more) are used for the usage.The lines after the separator describe the options.
Each line of options has this format:
<opt-spec><flags>*<arg-hint>? SP+ help LF
its format is the short option character, then the long option nameseparated by a comma. Both parts are not required, though at least oneis necessary. May not contain any of the<flags> characters.h,help,dry-run andf are examples of correct<opt-spec>.
<flags> are of*,=,? or!.
Use= if the option takes an argument.
Use? to mean that the option takes an optional argument. Youprobably want to use the--stuck-long mode to be able tounambiguously parse the optional argument.
Use* to mean that this option should not be listed in the usagegenerated for the-h argument. It’s shown for--help-all asdocumented ingitcli[7].
Use! to not make the corresponding negated long option available.
<arg-hint>, if specified, is used as a name of the argument in thehelp output, for options that take arguments.<arg-hint> isterminated by the first whitespace. It is customary to use adash to separate words in a multi-word argument hint.
The remainder of the line, after stripping the spaces, is usedas the help associated with the option.
Blank lines are ignored, and lines that don’t match this specification are usedas option group headers (start the line with a space to create suchlines on purpose).
OPTS_SPEC="\some-command [<options>] <args>...some-command does foo and bar!--h,help! show the helpfoo some nifty option --foobar= some cool option --bar with an argumentbaz=arg another cool option --baz with a named argumentqux?path qux may take a path argument but has meaning by itself An option group HeaderC? option C with an optional argument"eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"
When"$@" is-h or--help in the above example, the followingusage text would be shown:
usage: some-command [<options>] <args>... some-command does foo and bar! -h, --help show the help --[no-]foo some nifty option --foo --[no-]bar ... some cool option --bar with an argument --[no-]baz <arg> another cool option --baz with a named argument --[no-]qux[=<path>] qux may take a path argument but has meaning by itselfAn option group Header -C[...] option C with an optional argument
In--sq-quote mode,git rev-parse echoes on the standard output asingle line suitable forsh(1)eval. This line is made bynormalizing the arguments following--sq-quote. Nothing other thanquoting the arguments is done.
If you want command input to still be interpreted as usual bygit rev-parse before the output is shell quoted, see the--sqoption.
Print the object name of the current commit:
$ git rev-parse --verify HEAD
Print the commit object name from the revision in the $REV shell variable:
$ git rev-parse --verify --end-of-options $REV^{commit}This will error out if $REV is empty or not a valid revision.
Similar to above:
$ git rev-parse --default master --verify --end-of-options $REV
but if $REV is empty, the commit object name from master will be printed.
Part of thegit[1] suite
