NAME
git-show - Show various types of objects
SYNOPSIS
- git show [<options>] [<object>…]
DESCRIPTION
Shows one or more objects (blobs, trees, tags and commits).
For commits it shows the log message and textual diff. It alsopresents the merge commit in a special format as produced bygit diff-tree —cc.
For tags, it shows the tag message and the referenced objects.
For trees, it shows the names (equivalent to _git ls-tree_with —name-only).
For plain blobs, it shows the plain contents.
The command takes options applicable to the git diff-tree command tocontrol how the changes the commit introduces are shown.
This manual page describes only the most frequently used options.
OPTIONS
PRETTY FORMATS
If the commit is a merge, and if the pretty-formatis not oneline, email or raw, an additional line isinserted before the Author: line. This line begins with"Merge: " and the sha1s of ancestral commits are printed,separated by spaces. Note that the listed commits may notnecessarily be the list of the direct parent commits if youhave limited your view of history: for example, if you areonly interested in changes related to a certain directory orfile.
There are several built-in formats, and you can defineadditional formats by setting a pretty.<name>config option to either another format name, or aformat: string, as described below (seegit-config[1]). Here are the details of thebuilt-in formats:
- oneline
- <sha1> <title line>
This is designed to be as compact as possible.
- short
- commit <sha1>
- Author: <author>
- <title line>
- medium
- commit <sha1>
- Author: <author>
- Date: <author date>
- <title line>
- <full commit message>
- full
- commit <sha1>
- Author: <author>
- Commit: <committer>
- <title line>
- <full commit message>
- fuller
- commit <sha1>
- Author: <author>
- AuthorDate: <author date>
- Commit: <committer>
- CommitDate: <committer date>
- <title line>
- <full commit message>
- From <sha1> <date>
- From: <author>
- Date: <author date>
- Subject: [PATCH] <title line>
- <full commit message>
- raw
The raw format shows the entire commit exactly asstored in the commit object. Notably, the SHA-1s aredisplayed in full, regardless of whether —abbrev or—no-abbrev are used, and parents information show thetrue parent commits, without taking grafts or historysimplification into account. Note that this format affects the waycommits are displayed, but not the way the diff is shown e.g. withgit log —raw
. To get full object names in a raw diff format,use —no-abbrev
.
- format:
The format:
E.g, _format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"_would show something like this:
- The author of fe6e0ee was Junio C Hamano, 23 hours ago
- The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
The placeholders are:
- Placeholders that expand to a single literal character:
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emnem)_%n_
-
newline
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emem)_%%_
-
a raw %
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emx00em)_%x00_
-
print a byte from a hex code
- Placeholders that affect formatting of later placeholders:
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emCredem)_%Cred_
-
switch color to red
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emCgreenem)_%Cgreen_
-
switch color to green
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emCblueem)_%Cblue_
-
switch color to blue
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emCresetem)_%Creset_
-
reset color
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emC82308203em)_%C(…)_
-
color specification, as described under Values in the"CONFIGURATION FILE" section of git-config[1]. Bydefault, colors are shown only when enabled for log output(by color.diff
, color.ui
, or —color
, and respectingthe auto
settings of the former if we are going to aterminal). %C(auto,…)
is accepted as a historicalsynonym for the default (e.g., %C(auto,red)
). Specifying%C(always,…)
will show the colors even when color isnot otherwise enabled (though consider just using—color=always
to enable color for the whole output,including this format and anything else git might color).auto
alone (i.e. %C(auto)
) will turn on auto coloringon the next placeholders until the color is switchedagain.
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emmem)_%m_
-
left (<
), right (>
) or boundary (-
) mark
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emwltwgtlti1gtlti2gtem)_%w([<w>[,<i1>[,<i2>]]])_
-
switch line wrapping, like the -w option ofgit-shortlog[1].
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emltltNgttruncltruncmtruncem)_%<(<n>[,trunc|ltrunc|mtrunc])_
-
make the next placeholder take atleast N columns, padding spaces onthe right if necessary. Optionallytruncate at the beginning (ltrunc),the middle (mtrunc) or the end(trunc) if the output is longer thanN columns. Note that truncatingonly works correctly with N >= 2.
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emltltNgtem)_%<|(<n>)_
-
make the next placeholder take at least until Nthcolumns, padding spaces on the right if necessary
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emgtltNgtememgtltNgtem)_%>(<n>)_, _%>|(<n>)_
-
similar to %<(
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emgtgtltNgtememgtgtltNgtem)_%>>(<n>)_, _%>>|(<n>)_
-
similar to %>(
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emgtltltNgtememgtltltNgtem)_%><(<n>)_, _%><|(<n>)_
-
similar to %<(
- Placeholders that expand to information extracted from the commit:
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emHem)_%H_
-
commit hash
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emhem)_%h_
-
abbreviated commit hash
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emTem)_%T_
-
tree hash
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emtem)_%t_
-
abbreviated tree hash
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emPem)_%P_
-
parent hashes
- [](https://git-scm.com/docs/#Documentation/git-show.txt-empem)_%p_
-
abbreviated parent hashes
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emanem)_%an_
-
author name
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emaNem)_%aN_
-
author name (respecting .mailmap, see git-shortlog[1]or git-blame[1])
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emaeem)_%ae_
-
author email
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emaEem)_%aE_
-
author email (respecting .mailmap, see git-shortlog[1]or git-blame[1])
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emadem)_%ad_
-
author date (format respects —date= option)
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emaDem)_%aD_
-
author date, RFC2822 style
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emarem)_%ar_
-
author date, relative
- [](https://git-scm.com/docs/#Documentation/git-show.txt-ematem)_%at_
-
author date, UNIX timestamp
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emaiem)_%ai_
-
author date, ISO 8601-like format
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emaIem)_%aI_
-
author date, strict ISO 8601 format
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emcnem)_%cn_
-
committer name
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emcNem)_%cN_
-
committer name (respecting .mailmap, seegit-shortlog[1] or git-blame[1])
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emceem)_%ce_
-
committer email
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emcEem)_%cE_
-
committer email (respecting .mailmap, seegit-shortlog[1] or git-blame[1])
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emcdem)_%cd_
-
committer date (format respects —date= option)
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emcDem)_%cD_
-
committer date, RFC2822 style
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emcrem)_%cr_
-
committer date, relative
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emctem)_%ct_
-
committer date, UNIX timestamp
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emciem)_%ci_
-
committer date, ISO 8601-like format
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emcIem)_%cI_
-
committer date, strict ISO 8601 format
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emdem)_%d_
-
ref names, like the —decorate option of git-log[1]
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emDem)_%D_
-
ref names without the " (", ")" wrapping.
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emSem)_%S_
-
ref name given on the command line by which the commit was reached(like git log —source
), only works with git log
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emeem)_%e_
-
encoding
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emsem)_%s_
-
subject
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emfem)_%f_
-
sanitized subject line, suitable for a filename
- [](https://git-scm.com/docs/#Documentation/git-show.txt-embem)_%b_
-
body
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emBem)_%B_
-
raw body (unwrapped subject and body)
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emNem)_%N_
-
commit notes
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emGGem)_%GG_
-
raw verification message from GPG for a signed commit
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emGem)_%G?_
-
show "G" for a good (valid) signature,"B" for a bad signature,"U" for a good signature with unknown validity,"X" for a good signature that has expired,"Y" for a good signature made by an expired key,"R" for a good signature made by a revoked key,"E" if the signature cannot be checked (e.g. missing key)and "N" for no signature
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emGSem)_%GS_
-
show the name of the signer for a signed commit
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emGKem)_%GK_
-
show the key used to sign a signed commit
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emGFem)_%GF_
-
show the fingerprint of the key used to sign a signed commit
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emGPem)_%GP_
-
show the fingerprint of the primary key whose subkey was usedto sign a signed commit
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emgDem)_%gD_
-
reflog selector, e.g., refs/stash@{1}
or refs/stash@{2minutes ago
}; the format follows the rules described for the-g
option. The portion before the @
is the refname asgiven on the command line (so git log -g refs/heads/master
would yield refs/heads/master@{0}
).
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emgdem)_%gd_
-
shortened reflog selector; same as %gD
, but the refnameportion is shortened for human readability (sorefs/heads/master
becomes just master
).
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emgnem)_%gn_
-
reflog identity name
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emgNem)_%gN_
-
reflog identity name (respecting .mailmap, seegit-shortlog[1] or git-blame[1])
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emgeem)_%ge_
-
reflog identity email
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emgEem)_%gE_
-
reflog identity email (respecting .mailmap, seegit-shortlog[1] or git-blame[1])
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emgsem)_%gs_
-
reflog subject
- [](https://git-scm.com/docs/#Documentation/git-show.txt-emtrailersoptionsem)_%(trailers[:options])_
-
display the trailers of the body asinterpreted bygit-interpret-trailers[1]. Thetrailers
string may be followed by a colonand zero or more comma-separated options:
-
key=only
option so thatnon-trailer lines in the trailer block are hidden. If that is notdesired it can be disabled with only=false
. E.g.,%(trailers:key=Reviewed-by)
shows trailer lines with keyReviewed-by
.
-
only[=val]: select whether non-trailer lines from the trailerblock should be included. The only
keyword may optionally befollowed by an equal sign and one of true
, on
, yes
to omit orfalse
, off
, no
to show the non-trailer lines. If option isgiven without value it is enabled. If given multiple times the lastvalue is used.
-
separator=%x2C
as it would otherwise be parsed asnext option. If separator option is given multiple times only thelast one is used. E.g., %(trailers:key=Ticket,separator=%x2C )
shows all trailer lines whose key is "Ticket" separated by a commaand a space.
-
unfold[=val]: make it behave as if interpret-trailer’s —unfold
option was given. In same way as to for only
it can be followedby an equal sign and explicit value. E.g.,%(trailers:only,unfold=true)
unfolds and shows all trailer lines.
-
valueonly[=val]: skip over the key part of the trailer line and onlyshow the value part. Also this optionally allows explicit value.
Note | Some placeholders may depend on other options given to therevision traversal engine. For example, the %g* reflog options willinsert an empty string unless we are traversing reflog entries (e.g., bygit log -g ). The %d and %D placeholders will use the "short"decoration format if —decorate was not already provided on the commandline. |
If you add a +
(plus sign) after % of a placeholder, a line-feedis inserted immediately before the expansion if and only if theplaceholder expands to a non-empty string.
If you add a -
(minus sign) after % of a placeholder, all consecutiveline-feeds immediately preceding the expansion are deleted if and only if theplaceholder expands to an empty string.
If you add a
(space) after % of a placeholder, a spaceis inserted immediately before the expansion if and only if theplaceholder expands to a non-empty string.
- tformat:
The tformat: format works exactly like format:, except that itprovides "terminator" semantics instead of "separator" semantics. Inother words, each commit has the message terminator character (usually anewline) appended, rather than a separator placed between entries.This means that the final entry of a single-line format will be properlyterminated with a new line, just as the "oneline" format does.For example:
- $ git log -2 --pretty=format:%h 4da45bef \
- | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
- 4da45be
- 7134973 -- NO NEWLINE
- $ git log -2 --pretty=tformat:%h 4da45bef \
- | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
- 4da45be
- 7134973
In addition, any unrecognized string that has a %
in it is interpretedas if it has tformat:
in front of it. For example, these two areequivalent:
- $ git log -2 --pretty=tformat:%h 4da45bef
- $ git log -2 --pretty=%h 4da45bef
COMMON DIFF OPTIONS
- -p
- -u
- —patch
Generate patch (see section on generating patches).
- —no-patch
Suppress diff output. Useful for commands like
git show
thatshow the patch by default, or to cancel the effect of—patch
.- —unified=
Generate diffs with
lines of context instead ofthe usual three. Implies —patch
.Implies-p
.Output to a specific file instead of stdout.
- —output-indicator-old=
- —output-indicator-context=
Specify the character used to indicate new, old or contextlines in the generated patch. Normally they are +, - and' ' respectively.
For each commit, show a summary of changes using the raw diffformat. See the "RAW OUTPUT FORMAT" section ofgit-diff[1]. This is different from showing the logitself in raw format, which you can achieve with
—format=raw
.Synonym for
-p —raw
.Enable the heuristic that shifts diff hunk boundaries to make patcheseasier to read. This is the default.
Disable the indent heuristic.
Spend extra time to make sure the smallest possiblediff is produced.
Generate a diff using the "patience diff" algorithm.
Generate a diff using the "histogram diff" algorithm.
- Generate a diff using the "anchored diff" algorithm.
This option may be specified more than once.
If a line exists in both the source and destination, exists only once,and starts with this text, this algorithm attempts to prevent it fromappearing as a deletion or addition in the output. It uses the "patiencediff" algorithm internally.
- —diff-algorithm={patience|minimal|histogram|myers}
- Choose a diff algorithm. The variants are as follows:
default
,myers
The basic greedy diff algorithm. Currently, this is the default.
Spend extra time to make sure the smallest possible diff isproduced.
Use "patience diff" algorithm when generating patches.
- This algorithm extends the patience algorithm to "supportlow-occurrence common elements".
For instance, if you configured the diff.algorithm
variable to anon-default value and want to use the default one, then youhave to use —diff-algorithm=default
option.
- —stat[=
[, [, ]]] - Generate a diffstat. By default, as much space as necessarywill be used for the filename part, and the rest for the graphpart. Maximum width defaults to terminal width, or 80 columnsif not connected to a terminal, and can be overridden by
<width>
. The width of the filename part can be limited bygiving another width<name-width>
after a comma. The widthof the graph part can be limited by using—stat-graph-width=<width>
(affects all commands generatinga stat graph) or by settingdiff.statGraphWidth=<width>
(does not affectgit format-patch
).By giving a third parameter<count>
, you can limit theoutput to the first<count>
lines, followed by…
ifthere are more.
These parameters can also be set individually with —stat-width=<width>
,—stat-name-width=<name-width>
and —stat-count=<count>
.
- —compact-summary
Output a condensed summary of extended header information suchas file creations or deletions ("new" or "gone", optionally "+l"if it’s a symlink) and mode changes ("+x" or "-x" for addingor removing executable bit respectively) in diffstat. Theinformation is put between the filename part and the graphpart. Implies
—stat
.Similar to
—stat
, but shows number of added anddeleted lines in decimal notation and pathname withoutabbreviation, to make it more machine friendly. Forbinary files, outputs two-
instead of saying0 0
.Output only the last line of the
—stat
format containing totalnumber of modified files, as well as number of added and deletedlines.- —dirstat[=
] - Output the distribution of relative amount of changes for eachsub-directory. The behavior of
—dirstat
can be customized bypassing it a comma separated list of parameters.The defaults are controlled by thediff.dirstat
configurationvariable (see git-config[1]).The following parameters are available:
changes
Compute the dirstat numbers by counting the lines that have beenremoved from the source, or added to the destination. This ignoresthe amount of pure code movements within a file. In other words,rearranging lines in a file is not counted as much as other changes.This is the default behavior when no parameter is given.
Compute the dirstat numbers by doing the regular line-based diffanalysis, and summing the removed/added line counts. (For binaryfiles, count 64-byte chunks instead, since binary files have nonatural concept of lines). This is a more expensive
—dirstat
behavior than thechanges
behavior, but it does count rearrangedlines within a file as much as other changes. The resulting outputis consistent with what you get from the other—*stat
options.Compute the dirstat numbers by counting the number of files changed.Each changed file counts equally in the dirstat analysis. This isthe computationally cheapest
—dirstat
behavior, since it doesnot have to look at the file contents at all.Count changes in a child directory for the parent directory as well.Note that when using
cumulative
, the sum of the percentagesreported may exceed 100%. The default (non-cumulative) behavior canbe specified with thenoncumulative
parameter.- An integer parameter specifies a cut-off percent (3% by default).Directories contributing less than this percentage of the changesare not shown in the output.
Example: The following will count changed files, while ignoringdirectories with less than 10% of the total amount of changed files,and accumulating child directory counts in the parent directories:—dirstat=files,10,cumulative
.
- —cumulative
Synonym for —dirstat=cumulative
Synonym for —dirstat=files,param1,param2…
Output a condensed summary of extended header informationsuch as creations, renames and mode changes.
Synonym for
-p —stat
.- Separate the commits with NULs instead of with new newlines.
Also, when —raw
or —numstat
has been given, do not mungepathnames and use NULs as output field terminators.
Without this option, pathnames with "unusual" characters are quoted asexplained for the configuration variable core.quotePath
(seegit-config[1]).
- —name-only
Show only names of changed files.
Show only names and status of changed files. See the descriptionof the
—diff-filter
option on what the status letters mean.Specify how differences in submodules are shown. When specifying
—submodule=short
the short format is used. This format justshows the names of the commits at the beginning and end of the range.When—submodule
or—submodule=log
is specified, the log_format is used. This format lists the commits in the range likegit-submodule[1]summary
does. When—submodule=diff
is specified, the _diff format is used. This format shows aninline diff of the changes in the submodule contents between thecommit range. Defaults todiff.submodule
or the short formatif the config option is unset.Show colored diff.
—color
(i.e. without =) is the same as —color=always
.can be one of always
,never
, orauto
.Turn off colored diff.It is the same as
—color=never
.- Moved lines of code are colored differently.The
defaults to no if the option is not givenand to zebra if the option with no mode is given.The mode must be one of:
- no
Moved lines are not highlighted.
Is a synonym for
zebra
. This may change to a more sensible modein the future.Any line that is added in one location and was removedin another location will be colored with color.diff.newMoved.Similarly color.diff.oldMoved will be used for removed linesthat are added somewhere else in the diff. This mode picks up anymoved line, but it is not very useful in a review to determineif a block of code was moved without permutation.
Blocks of moved text of at least 20 alphanumeric charactersare detected greedily. The detected blocks arepainted using either the color.diff.{old,new}Moved color.Adjacent blocks cannot be told apart.
Blocks of moved text are detected as in blocks mode. The blocksare painted using either the color.diff.{old,new}Moved color orcolor.diff.{old,new}MovedAlternative. The change betweenthe two colors indicates that a new block was detected.
- Similar to zebra, but additional dimming of uninteresting partsof moved code is performed. The bordering lines of two adjacentblocks are considered interesting, the rest is uninteresting.
dimmed_zebra
is a deprecated synonym.
- —no-color-moved
Turn off move detection. This can be used to override configurationsettings. It is the same as
—color-moved=no
.- This configures how whitespace is ignored when performing themove detection for
—color-moved
.These modes can be given as a comma separated list:
- no
Do not ignore whitespace when performing move detection.
Ignore changes in whitespace at EOL.
Ignore changes in amount of whitespace. This ignores whitespaceat line end, and considers all other sequences of one ormore whitespace characters to be equivalent.
Ignore whitespace when comparing lines. This ignores differenceseven if one line has whitespace where the other line has none.
- Initially ignore any whitespace in the move detection, thengroup the moved code blocks only into a block if the change inwhitespace is the same per line. This is incompatible with theother modes.
- —no-color-moved-ws
Do not ignore whitespace when performing move detection. This can beused to override configuration settings. It is the same as
—color-moved-ws=no
.- Show a word diff, using the
to delimit changed words.By default, words are delimited by whitespace; see —word-diff-regex
below. Thedefaults to plain, andmust be one of:
- color
Highlight changed words using only colors. Implies
—color
.Show words as
[-removed-]
and{+added+}
. Makes noattempts to escape the delimiters if they appear in the input,so the output may be ambiguous.Use a special line-based format intended for scriptconsumption. Added/removed/unchanged runs are printed in theusual unified diff format, starting with a
+
/-
/~
on a line of its own.- Disable word diff again.
Note that despite the name of the first mode, color is used tohighlight the changed parts in all modes if enabled.
- —word-diff-regex=
- Use
to decide what a word is, instead of consideringruns of non-whitespace to be a word. Also implies —word-diff
unless it was already enabled.
Every non-overlapping match of the|[^[:space:]]
to your regularexpression to make sure that it matches all non-whitespace characters.A match that contains a newline is silently truncated(!) at thenewline.
For example, —word-diff-regex=.
will treat each character as a wordand, correspondingly, show differences character by character.
The regex can also be set via a diff driver or configuration option, seegitattributes[5] or git-config[1]. Giving it explicitlyoverrides any diff driver or configuration setting. Diff driversoverride configuration settings.
- —color-words[=
] Equivalent to
—word-diff=color
plus (if a regex wasspecified)—word-diff-regex=<regex>
.Turn off rename detection, even when the configurationfile gives the default to do so.
Whether to use empty blobs as rename source.
Warn if changes introduce conflict markers or whitespace errors.What are considered whitespace errors is controlled by
core.whitespace
configuration. By default, trailing whitespaces (includinglines that consist solely of whitespaces) and a space characterthat is immediately followed by a tab character inside theinitial indent of the line are considered whitespace errors.Exits with non-zero status if problems are found. Not compatiblewith —exit-code.Highlight whitespace errors in the
context
,old
ornew
lines of the diff. Multiple values are separated by comma,none
resets previous values,default
reset the list tonew
andall
is a shorthand forold,new,context
. Whenthis option is not given, and the configuration variablediff.wsErrorHighlight
is not set, only whitespace errors innew
lines are highlighted. The whitespace errors are coloredwithcolor.diff.whitespace
.Instead of the first handful of characters, show the fullpre- and post-image blob object names on the "index"line when generating patch format output.
In addition to
—full-index
, output a binary diff thatcan be applied withgit-apply
. Implies—patch
.Instead of showing the full 40-byte hexadecimal objectname in diff-raw format output and diff-tree headerlines, show only a partial prefix. This isindependent of the
—full-index
option above, which controlsthe diff-patch output format. Non default number ofdigits can be specified with—abbrev=<n>
.- —break-rewrites[=[
][/ ]] - Break complete rewrite changes into pairs of delete andcreate. This serves two purposes:
It affects the way a change that amounts to a total rewrite of a filenot as a series of deletion and insertion mixed together with a veryfew lines that happen to match textually as the context, but as asingle deletion of everything old followed by a single insertion ofeverything new, and the number m
controls this aspect of the -Boption (defaults to 60%). -B/70%
specifies that less than 30% of theoriginal should remain in the result for Git to consider it a totalrewrite (i.e. otherwise the resulting patch will be a series ofdeletion and insertion mixed together with context lines).
When used with -M, a totally-rewritten file is also considered as thesource of a rename (usually -M only considers a file that disappearedas the source of a rename), and the number n
controls this aspect ofthe -B option (defaults to 50%). -B20%
specifies that a change withaddition and deletion compared to 20% or more of the file’s size areeligible for being picked up as a possible source of a rename toanother file.
- -M[
] - —find-renames[=
] If generating diffs, detect and report renames for each commit.For following files across renames while traversing history, see
—follow
.Ifn
is specified, it is a threshold on the similarityindex (i.e. amount of addition/deletions compared to thefile’s size). For example,-M90%
means Git should consider adelete/add pair to be a rename if more than 90% of the filehasn’t changed. Without a%
sign, the number is to be read asa fraction, with a decimal point before it. I.e.,-M5
becomes0.5, and is thus the same as-M50%
. Similarly,-M05
isthe same as-M5%
. To limit detection to exact renames, use-M100%
. The default similarity index is 50%.- —find-copies[=
] Detect copies as well as renames. See also
—find-copies-harder
.Ifn
is specified, it has the same meaning as for-M<n>
.For performance reasons, by default,
-C
option finds copies onlyif the original file of the copy was modified in the samechangeset. This flag makes the commandinspect unmodified files as candidates for the source ofcopy. This is a very expensive operation for largeprojects, so use it with caution. Giving more than one-C
option has the same effect.- —irreversible-delete
- Omit the preimage for deletes, i.e. print only the header but notthe diff between the preimage and
/dev/null
. The resulting patchis not meant to be applied withpatch
orgit apply
; this issolely for people who want to just concentrate on reviewing thetext after the change. In addition, the output obviously lacksenough information to apply such a patch in reverse, even manually,hence the name of the option.
When used together with -B
, omit also the preimage in the deletion partof a delete/create pair.
- -l
The
-M
and-C
options require O(n^2) processing time where nis the number of potential rename/copy targets. Thisoption prevents rename/copy detection from running ifthe number of rename/copy targets exceeds the specifiednumber.- Select only files that are Added (
A
), Copied (C
),Deleted (D
), Modified (M
), Renamed (R
), have theirtype (i.e. regular file, symlink, submodule, …) changed (T
),are Unmerged (U
), areUnknown (X
), or have had their pairing Broken (B
).Any combination of the filter characters (including none) can be used.When*
(All-or-none) is added to the combination, allpaths are selected if there is any file that matchesother criteria in the comparison; if there is no filethat matches other criteria, nothing is selected.
Also, these upper-case letters can be downcased to exclude. E.g.—diff-filter=ad
excludes added and deleted paths.
Note that not all diffs can feature all types. For instance, diffsfrom the index to the working tree can never have Added entries(because the set of paths included in the diff is limited by what is inthe index). Similarly, copied and renamed entries cannot appear ifdetection for those types is disabled.
- -S
- Look for differences that change the number of occurrences ofthe specified string (i.e. addition/deletion) in a file.Intended for the scripter’s use.
It is useful when you’re looking for an exact block of code (like astruct), and want to know the history of that block since it firstcame into being: use the feature iteratively to feed the interestingblock in the preimage back into -S
, and keep going until you get thevery first version of the block.
Binary files are searched as well.
To illustrate the difference between -S<regex> —pickaxe-regex
and-G<regex>
, consider a commit with the following diff in the samefile:
- + return !regexec(regexp, two->ptr, 1, ®match, 0);
- ...
- - hit = !regexec(regexp, mf2.ptr, 1, ®match, 0);
While git log -G"regexec(regexp"
will show this commit, git log-S"regexec(regexp" —pickaxe-regex
will not (because the number ofoccurrences of that string did not change).
Unless —text
is supplied patches of binary files without a textconvfilter will be ignored.
See the pickaxe entry in gitdiffcore[7] for moreinformation.
- —find-object=
- Look for differences that change the number of occurrences ofthe specified object. Similar to
-S
, just the argument is differentin that it doesn’t search for a specific string but for a specificobject id.
The object can be a blob or a submodule commit. It implies the -t
option ingit-log
to also find trees.
- —pickaxe-all
When
-S
or-G
finds a change, show all the changes in thatchangeset, not just the files that contain the changein. Treat the
given to -S
as an extended POSIX regularexpression to match.- Control the order in which files appear in the output.This overrides the
diff.orderFile
configuration variable(see git-config[1]). To canceldiff.orderFile
,use-O/dev/null
.
The output order is determined by the order of glob patterns in
Blank lines are ignored, so they can be used as separators forreadability.
Lines starting with a hash ("
#
") are ignored, so they can be usedfor comments. Add a backslash ("\
") to the beginning of thepattern if it starts with a hash.Each other line contains a single pattern.
Patterns have the same syntax and semantics as patterns used forfnmatch(3) without the FNM_PATHNAME flag, except a pathname alsomatches a pattern if removing any number of the final pathnamecomponents matches the pattern. For example, the pattern "foo*bar
"matches "fooasdfbar
" and "foo/bar/baz/asdf
" but not "foobarx
".
- -R
Swap two inputs; that is, show differences from index oron-disk file to tree contents.
When run from a subdirectory of the project, it can betold to exclude changes outside the directory and showpathnames relative to it with this option. When you arenot in a subdirectory (e.g. in a bare repository), youcan name which subdirectory to make the output relativeto by giving a
as an argument. - —text
Treat all files as text.
Ignore carriage-return at the end of line when doing a comparison.
Ignore changes in whitespace at EOL.
- —ignore-space-change
Ignore changes in amount of whitespace. This ignores whitespaceat line end, and considers all other sequences of one ormore whitespace characters to be equivalent.
- —ignore-all-space
Ignore whitespace when comparing lines. This ignoresdifferences even if one line has whitespace where the otherline has none.
Ignore changes whose lines are all blank.
Show the context between diff hunks, up to the specified numberof lines, thereby fusing hunks that are close to each other.Defaults to
diff.interHunkContext
or 0 if the config optionis unset.- —function-context
Show whole surrounding functions of changes.
Allow an external diff helper to be executed. If you set anexternal diff driver with gitattributes[5], you needto use this option with git-log[1] and friends.
Disallow external diff drivers.
- —no-textconv
Allow (or disallow) external text conversion filters to be runwhen comparing binary files. See gitattributes[5] fordetails. Because textconv filters are typically a one-wayconversion, the resulting diff is suitable for humanconsumption, but cannot be applied. For this reason, textconvfilters are enabled by default only for git-diff[1] andgit-log[1], but not for git-format-patch[1] ordiff plumbing commands.
Ignore changes to submodules in the diff generation.
can beeither "none", "untracked", "dirty" or "all", which is the default.Using "none" will consider the submodule modified when it either containsuntracked or modified files or its HEAD differs from the commit recordedin the superproject and can be used to override any settings of theignore option in git-config[1] or gitmodules[5]. When"untracked" is used submodules are not considered dirty when they onlycontain untracked content (but they are still scanned for modifiedcontent). Using "dirty" ignores all changes to the work tree of submodules,only changes to the commits stored in the superproject are shown (this wasthe behavior until 1.7.0). Using "all" hides all changes to submodules. Show the given source prefix instead of "a/".
Show the given destination prefix instead of "b/".
Do not show any source or destination prefix.
Prepend an additional prefix to every line of output.
- By default entries added by "git add -N" appear as an existingempty file in "git diff" and a new file in "git diff —cached".This option makes the entry appear as a new file in "git diff"and non-existent in "git diff —cached". This option could bereverted with
—ita-visible-in-index
. Both options areexperimental and could be removed in future.
For more detailed explanation on these common options, see alsogitdiffcore[7].
Generating patches with -p
When "git-diff-index", "git-diff-tree", or "git-diff-files" are runwith a -p
option, "git diff" without the —raw
option, or"git log" with the "-p" option, theydo not produce the output described above; instead they produce apatch file. You can customize the creation of such patches via theGIT_EXTERNAL_DIFF
and the GIT_DIFF_OPTS
environment variables.
What the -p option produces is slightly different from the traditionaldiff format:
- It is preceded with a "git diff" header that looks like this:
- diff --git a/file1 b/file2
The a/
and b/
filenames are the same unless rename/copy isinvolved. Especially, even for a creation or a deletion,/dev/null
is not used in place of the a/
or b/
filenames.
When rename/copy is involved, file1
and file2
show thename of the source file of the rename/copy and the name ofthe file that rename/copy produces, respectively.
- It is followed by one or more extended header lines:
- old mode <mode>
- new mode <mode>
- deleted file mode <mode>
- new file mode <mode>
- copy from <path>
- copy to <path>
- rename from <path>
- rename to <path>
- similarity index <number>
- dissimilarity index <number>
- index <hash>..<hash> <mode>
File modes are printed as 6-digit octal numbers including the file typeand file permission bits.
Path names in extended headers do not include the a/
and b/
prefixes.
The similarity index is the percentage of unchanged lines, andthe dissimilarity index is the percentage of changed lines. Itis a rounded down integer, followed by a percent sign. Thesimilarity index value of 100% is thus reserved for two equalfiles, while 100% dissimilarity means that no line from the oldfile made it into the new one.
The index line includes the SHA-1 checksum before and after the change.The
Pathnames with "unusual" characters are quoted as explained forthe configuration variable
core.quotePath
(seegit-config[1]).All the
file1
files in the output refer to files before thecommit, and all thefile2
files refer to files after the commit.It is incorrect to apply each change to each file sequentially. Forexample, this patch will swap a and b:
- diff --git a/a b/b
- rename from a
- rename to b
- diff --git a/b b/a
- rename from b
- rename to a
combined diff format
Any diff-generating command can take the -c
or —cc
option toproduce a combined diff when showing a merge. This is the defaultformat when showing merges with git-diff[1] orgit-show[1]. Note also that you can give the -m
option to anyof these commands to force generation of diffs with individual parentsof a merge.
A combined diff format looks like this:
- diff --combined describe.c
- index fabadb8,cc95eb0..4866510
- --- a/describe.c
- +++ b/describe.c
- @@@ -98,20 -98,12 +98,20 @@@
- return (a_date > b_date) ? -1 : (a_date == b_date) ? 0 : 1;
- }
- - static void describe(char *arg)
- -static void describe(struct commit *cmit, int last_one)
- ++static void describe(char *arg, int last_one)
- {
- + unsigned char sha1[20];
- + struct commit *cmit;
- struct commit_list *list;
- static int initialized = 0;
- struct commit_name *n;
- + if (get_sha1(arg, sha1) < 0)
- + usage(describe_usage);
- + cmit = lookup_commit_reference(sha1);
- + if (!cmit)
- + usage(describe_usage);
- +
- if (!initialized) {
- initialized = 1;
- for_each_ref(get_name);
- It is preceded with a "git diff" header, that looks likethis (when
-c
option is used):
- diff --combined file
or like this (when —cc
option is used):
- diff --cc file
- It is followed by one or more extended header lines(this example shows a merge with two parents):
- index <hash>,<hash>..<hash>
- mode <mode>,<mode>..<mode>
- new file mode <mode>
- deleted file mode <mode>,<mode>
The mode <mode>,<mode>..<mode>
line appears only if at least one ofthe
- It is followed by two-line from-file/to-file header
- --- a/file
- +++ b/file
Similar to two-line header for traditional unified diffformat, /dev/null
is used to signal created or deletedfiles.
However, if the —combined-all-paths option is provided, instead of atwo-line from-file/to-file you get a N+1 line from-file/to-file header,where N is the number of parents in the merge commit
- --- a/file
- --- a/file
- --- a/file
- +++ b/file
This extended format can be useful if rename or copy detection isactive, to allow you to see the original name of the file in differentparents.
- Chunk header format is modified to prevent people fromaccidentally feeding it to
patch -p1
. Combined diff formatwas created for review of merge commit changes, and was notmeant for apply. The change is similar to the change in theextended index header:
- @@@ <from-file-range> <from-file-range> <to-file-range> @@@
There are (number of parents + 1) @
characters in the chunkheader for combined diff format.
Unlike the traditional unified diff format, which shows twofiles A and B with a single column that has -
(minus — appears in A but removed in B), +
(plus — missing in A butadded to B), or " "
(space — unchanged) prefix, this formatcompares two or more files file1, file2,… with one file X, andshows how X differs from each of fileN. One column for each offileN is prepended to the output line to note how X’s line isdifferent from it.
A -
character in the column N means that the line appears infileN but it does not appear in the result. A +
characterin the column N means that the line appears in the result,and fileN does not have that line (in other words, the line wasadded, from the point of view of that parent).
In the above example output, the function signature was changedfrom both files (hence two -
removals from both file1 andfile2, plus ++
to mean one line that was added does not appearin either file1 or file2). Also eight other lines are the samefrom file1 but do not appear in file2 (hence prefixed with +
).
When shown by git diff-tree -c
, it compares the parents of amerge commit with the merge result (i.e. file1..fileN are theparents). When shown by git diff-files -c
, it compares thetwo unresolved merge parents with the working tree file(i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka"their version").
EXAMPLES
git show v1.0.0
Shows the tag
v1.0.0
, along with the object the tagspoints at.Shows the tree pointed to by the tag
v1.0.0
.Shows the subject of the commit pointed to by thetag
v1.0.0
.Shows the contents of the file
Documentation/README
asthey were current in the 10th last commit of the branchnext
.- Concatenates the contents of said Makefiles in the headof the branch
master
.
DISCUSSION
Git is to some extent character encoding agnostic.
The contents of the blob objects are uninterpreted sequencesof bytes. There is no encoding translation at the corelevel.
Path names are encoded in UTF-8 normalization form C. Thisapplies to tree objects, the index file, ref names, as well aspath names in command line arguments, environment variablesand config files (
.git/config
(see git-config[1]),gitignore[5], gitattributes[5] andgitmodules[5]).
Note that Git at the core level treats path names simply assequences of non-NUL bytes, there are no path name encodingconversions (except on Mac and Windows). Therefore, usingnon-ASCII path names will mostly work even on platforms and filesystems that use legacy extended ASCII encodings. However,repositories created on such systems will not work properly onUTF-8-based systems (e.g. Linux, Mac, Windows) and vice versa.Additionally, many Git-based tools simply assume path names tobe UTF-8 and will fail to display other encodings correctly.
- Commit log messages are typically encoded in UTF-8, but otherextended ASCII encodings are also supported. This includesISO-8859-x, CP125x and many others, but not UTF-16/32,EBCDIC and CJK multi-byte encodings (GBK, Shift-JIS, Big5,EUC-x, CP9xx etc.).
Although we encourage that the commit log messages are encodedin UTF-8, both the core and Git Porcelain are designed not toforce UTF-8 on projects. If all participants of a particularproject find it more convenient to use legacy encodings, Gitdoes not forbid it. However, there are a few things to keep inmind.
- git commit and git commit-tree issuesa warning if the commit log message given to it does not looklike a valid UTF-8 string, unless you explicitly say yourproject uses a legacy encoding. The way to say this is tohave i18n.commitencoding in
.git/config
file, like this:
- [i18n]
- commitEncoding = ISO-8859-1
Commit objects created with the above setting record the valueof i18n.commitEncoding
in its encoding
header. This is tohelp other people who look at them later. Lack of this headerimplies that the commit log message is encoded in UTF-8.
- git log, git show, git blame and friends look at the
encoding
header of a commit object, and try to re-code thelog message into UTF-8 unless otherwise specified. You canspecify the desired output encoding withi18n.logOutputEncoding
in.git/config
file, like this:
- [i18n]
- logOutputEncoding = ISO-8859-1
If you do not have this configuration variable, the value ofi18n.commitEncoding
is used instead.
Note that we deliberately chose not to re-code the commit logmessage when a commit is made to force UTF-8 at the commitobject level, because re-coding to UTF-8 is not necessarily areversible operation.
GIT
Part of the git[1] suite