Movatterモバイル変換

git-log - Show commit logs

gitlog [<options>] [<revision-range>] [[--]<path>…​]

Shows the commit logs.

List commits that are reachable by following theparent links from thegiven commit(s), but exclude commits that are reachable from the one(s)given with a^ in front of them. The output is given in reversechronological order by default.

You can think of this as a set operation. Commits reachable from any ofthe commits given on the command line form a set, and then commits reachablefrom any of the ones given with^ in front are subtracted from thatset. The remaining commits are what comes out in the command’s output.Various other options and paths parameters can be used to further limit theresult.

Thus, the following command:

means "list all the commits which are reachable fromfoo orbar, butnot frombaz".

A special notation "<commit1>..<commit2>" can be used as ashort-hand for "^<commit1><commit2>". For example, either ofthe following may be used interchangeably:

Another special notation is "<commit1>...<commit2>" which is usefulfor merges. The resulting set of commits is the symmetric differencebetween the two operands. The following two commands are equivalent:

The command takes options applicable to thegit-rev-list[1]command to control what is shown and how, and options applicable tothegit-diff[1] command to control how the changeseach commit introduces are shown.

--follow

Continue listing the history of a file beyond renames(works only for a single file).

--no-decorate

--decorate[=(short|full|auto|no)]

Print out the ref names of any commits that are shown. Possible valuesare:

`short`;; the ref name prefixes `refs/heads/`, `refs/tags/` and`refs/remotes/` are not printed.`full`;; the full ref name (including prefix) is printed.`auto`:: if the output is going to a terminal, the ref namesare shown as if `short` were given, otherwise no ref names areshown.

The option--decorate is short-hand for--decorate=short. Default toconfiguration value oflog.decorate if configured, otherwise,auto.

--decorate-refs=<pattern>

--decorate-refs-exclude=<pattern>

For each candidate reference, do not use it for decoration if itmatches any of the<pattern> parameters given to--decorate-refs-exclude or if it doesn’t match any of the<pattern> parameters given to--decorate-refs.Thelog.excludeDecoration config option allows excluding refs fromthe decorations, but an explicit--decorate-refs pattern willoverride a match inlog.excludeDecoration.

If none of these options or config settings are given, then references areused as decoration if they matchHEAD,refs/heads/,refs/remotes/,refs/stash/, orrefs/tags/.

--clear-decorations

When specified, this option clears all previous--decorate-refsor--decorate-refs-exclude options and relaxes the defaultdecoration filter to include all references. This option isassumed if the config valuelog.initialDecorationSet is set toall.

--source

Print out the ref name given on the command line by which eachcommit was reached.

--[no-]mailmap

--[no-]use-mailmap

Use mailmap file to map author and committer names and emailaddresses to canonical real names and email addresses. Seegit-shortlog[1].

--full-diff

Without this flag,gitlog-p<path>... shows commits thattouch the specified paths, and diffs about the same specifiedpaths. With this, the full diff is shown for commits that touchthe specified paths; this means that "<path>..." limits onlycommits, and doesn’t limit diff for those commits.

Note that this affects all diff-based output types, e.g. thoseproduced by--stat, etc.

--log-size

Include a linelogsize<number> in the output for each commit,where<number> is the length of that commit’s message in bytes.Intended to speed up tools that read log messages fromgitlogoutput by allowing them to allocate space in advance.

-L<start>,<end>:<file>

-L:<funcname>:<file>

Trace the evolution of the line range given by<start>,<end>,or by the function name regex<funcname>, within the<file>. You maynot give any pathspec limiters. This is currently limited toa walk starting from a single revision, i.e., you may onlygive zero or one positive revision arguments, and<start> and<end> (or<funcname>) must exist in the starting revision.You can specify this option more than once. Implies--patch.Patch output can be suppressed using--no-patch, but other diff formats(namely--raw,--numstat,--shortstat,--dirstat,--summary,--name-only,--name-status,--check) are not currently implemented.

<start> and<end> can take one of these forms:

• <number>

  If<start> or<end> is a number, it specifies anabsolute line number (lines count from 1).

• /<regex>/

  This form will use the first line matching the givenPOSIX<regex>. If<start> is a regex, it will search from the end ofthe previous-L range, if any, otherwise from the start of file.If<start> is^/<regex>/, it will search from the start of file.If<end> is a regex, it will search starting at the line given by<start>.

• +<offset> or-<offset>

  This is only valid for<end> and will specify a numberof lines before or after the line given by<start>.

If:<funcname> is given in place of<start> and<end>, it is aregular expression that denotes the range from the first funcname linethat matches<funcname>, up to the next funcname line.:<funcname>searches from the end of the previous-L range, if any, otherwisefrom the start of file.^:<funcname> searches from the start offile. The function names are determined in the same way asgitdiffworks out patch hunk headers (seeDefining a custom hunk-headeringitattributes[5]).

<revision-range>

Show only commits in the specified revision range. When no<revision-range> is specified, it defaults toHEAD (i.e. thewhole history leading to the current commit).origin..HEADspecifies all the commits reachable from the current commit(i.e.HEAD), but not fromorigin. For a complete list ofways to spell<revision-range>, see theSpecifying Rangessection ofgitrevisions[7].

[--]<path>...

Show only commits that are enough to explain how the filesthat match the specified paths came to be. SeeHistorySimplification below for details and other simplificationmodes.

Paths may need to be prefixed with-- to separate them fromoptions or the revision range, when confusion arises.

Commit Limiting

History Simplification

  .-A---M---N---O---P---Q /     /   /   /   /   /I     B   C   D   E   Y \   /   /   /   /   /  `-------------'   X

  .-A---M-----C--N---O---P /     / \  \  \/   /   /I     B   \  R-'`-Z'   / \   /     \/         /  \ /      /\        /   `---X--'  `---Y--'

I---X

  .-A---M--------N---O---P /     / \  \  \/   /   /I     B   \  R-'`--'   / \   /     \/         /  \ /      /\        /   `---X--'  `------'

  .-A---M--. /     /    \I     B      R \   /      /  \ /      /   `---X--'

Commit Ordering

Object Traversal

Commit Formatting

If the commit is a merge, and if the pretty-formatis notoneline,email orraw, an additional line isinserted before theAuthor: line. This line begins with"Merge: " and the hashes of ancestral commits are printed,separated by spaces. Note that the listed commits may notnecessarily be the list of thedirect 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

  <hash> <title-line>

  This is designed to be as compact as possible.

• short

  commit<hash>Author: <author>

  <title-line>

• medium

  commit<hash>Author: <author>Date:   <author-date>

  <title-line>

  <full-commit-message>

• full

  commit<hash>Author: <author>Commit: <committer>

  <title-line>

  <full-commit-message>

• fuller

  commit<hash>Author:     <author>AuthorDate: <author-date>Commit:     <committer>CommitDate: <committer-date>

  <title-line>

  <full-commit-message>

• reference

  <abbrev-hash> (<title-line>, <short-author-date>)

  This format is used to refer to another commit in a commit message andis the same as--pretty='format:%C(auto)%h (%s,%ad). By default,the date is formatted with--date=short unless another--date optionis explicitly specified. As with anyformat: with formatplaceholders, its output is not affected by other options like--decorate and--walk-reflogs.

• email

  From<hash> <date>From: <author>Date: <author-date>Subject: [PATCH] <title-line>

  <full-commit-message>

• mboxrd

  Likeemail, but lines in the commit message starting with "From "(preceded by zero or more ">") are quoted with ">" so they aren’tconfused as starting a new commit.

• raw

  Theraw format shows the entire commit exactly asstored in the commit object. Notably, the hashes aredisplayed in full, regardless of whether--abbrev or--no-abbrev are used, andparents 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. withgitlog--raw. To get full object names in a raw diff format,use--no-abbrev.

• format:<format-string>

  Theformat:<format-string> format allows you to specify which informationyou want to show. It works a little bit like printf format,with the notable exception that you get a newline with%ninstead of\n.

  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 agoThe title was >>t4119: test autocomputing -p<n> for traditional diff input.<<

  The placeholders are:

  • Placeholders that expand to a single literal character:

    %n

    newline

    %%

    a raw%

    %x00

    %x followed by two hexadecimal digits is replaced with abyte with the hexadecimal digits' value (we will call this"literal formatting code" in the rest of this document).

  • Placeholders that affect formatting of later placeholders:

    %Cred

    switch color to red

    %Cgreen

    switch color to green

    %Cblue

    switch color to blue

    %Creset

    reset color

    %C(<spec>)

    color specification, as described under Values in the"CONFIGURATION FILE" section ofgit-config[1]. Bydefault, colors are shown only when enabled for log output(bycolor.diff,color.ui, or--color, and respectingtheauto settings of the former if we are going to aterminal).%C(auto,<spec>) is accepted as a historicalsynonym for the default (e.g.,%C(auto,red)). Specifying%C(always,<spec>) 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.

    %m

    left (<), right (>) or boundary (-) mark

    %w([<w>[,<i1>[,<i2>]]])

    switch line wrapping, like the-w option ofgit-shortlog[1].

    %<(<n>[,(trunc|ltrunc|mtrunc)])

    make the next placeholder take atleast N column widths, padding spaces onthe right if necessary. Optionallytruncate (with ellipsis..) at the left (ltrunc)..ft,the middle (mtrunc)mi..le, or the end(trunc)rig.., if the output is longer than<n> columns.Note 1: that truncatingonly works correctly with<n> >= 2.Note 2: spaces around the<n> and<m> (see below)values are optional.Note 3: Emojis and other wide characterswill take two display columns, which mayover-run column boundaries.Note 4: decomposed character combining marksmay be misplaced at padding boundaries.

    %<|(<m>)

    make the next placeholder take at least until<m> thdisplay column, padding spaces on the right if necessary.Use negative<m> values for column positions measuredfrom the right hand edge of the terminal window.

    %>(<n>)

    %>|(<m>)

    similar to%<(<n>),%<|(<m>) respectively,but padding spaces on the left

    %>>(<n>)

    %>>|(<m>)

    similar to%>(<n>),%>|(<m>)respectively, except that if the nextplaceholder takes more spaces than given andthere are spaces on its left, use thosespaces

    %><(<n>)

    %><|(<m>)

    similar to%<(<n>),%<|(<m>)respectively, but padding both sides(i.e. the text is centered)

  • Placeholders that expand to information extracted from the commit:

    %H

    commit hash

    %h

    abbreviated commit hash

    %T

    tree hash

    %t

    abbreviated tree hash

    %P

    parent hashes

    %p

    abbreviated parent hashes

    %an

    author name

    %aN

    author name (respecting .mailmap, seegit-shortlog[1]orgit-blame[1])

    %ae

    author email

    %aE

    author email (respecting .mailmap, seegit-shortlog[1]orgit-blame[1])

    %al

    author email local-part (the part before the@ sign)

    %aL

    author local-part (see%al) respecting .mailmap, seegit-shortlog[1] orgit-blame[1])

    %ad

    author date (format respects --date= option)

    %aD

    author date, RFC2822 style

    %ar

    author date, relative

    %at

    author date, UNIX timestamp

    %ai

    author date, ISO 8601-like format

    %aI

    author date, strict ISO 8601 format

    %as

    author date, short format (YYYY-MM-DD)

    %ah

    author date, human style (like the--date=human option ofgit-rev-list[1])

    %cn

    committer name

    %cN

    committer name (respecting .mailmap, seegit-shortlog[1] orgit-blame[1])

    %ce

    committer email

    %cE

    committer email (respecting .mailmap, seegit-shortlog[1] orgit-blame[1])

    %cl

    committer email local-part (the part before the@ sign)

    %cL

    committer local-part (see%cl) respecting .mailmap, seegit-shortlog[1] orgit-blame[1])

    %cd

    committer date (format respects --date= option)

    %cD

    committer date, RFC2822 style

    %cr

    committer date, relative

    %ct

    committer date, UNIX timestamp

    %ci

    committer date, ISO 8601-like format

    %cI

    committer date, strict ISO 8601 format

    %cs

    committer date, short format (YYYY-MM-DD)

    %ch

    committer date, human style (like the--date=human option ofgit-rev-list[1])

    %d

    ref names, like the --decorate option ofgit-log[1]

    %D

    ref names without the " (", ")" wrapping.

    %(decorate[:<option>,...])

    ref names with custom decorations. Thedecorate string may be followed by acolon and zero or more comma-separated options. Option values may containliteral formatting codes. These must be used for commas (%x2C) and closingparentheses (%x29), due to their role in the option syntax.

    • prefix=<value>: Shown before the list of ref names. Defaults to " (".

    • suffix=<value>: Shown after the list of ref names. Defaults to ")".

    • separator=<value>: Shown between ref names. Defaults to ", ".

    • pointer=<value>: Shown between HEAD and the branch it points to, if any.Defaults to " → ".

    • tag=<value>: Shown before tag names. Defaults to "tag: ".

  For example, to produce decorations with no wrappingor tag annotations, and spaces as separators:

  %(decorate:prefix=,suffix=,tag=,separator= )

  %(describe[:<option>,...])

  human-readable name, likegit-describe[1]; empty string forundescribable commits. Thedescribe string may be followed by a colon andzero or more comma-separated options. Descriptions can be inconsistent whentags are added or removed at the same time.

  • tags[=<bool-value>]: Instead of only considering annotated tags,consider lightweight tags as well.

  • abbrev=<number>: Instead of using the default number of hexadecimal digits(which will vary according to the number of objects in the repository with adefault of 7) of the abbreviated object name, use <number> digits, or as manydigits as needed to form a unique object name.

  • match=<pattern>: Only consider tags matching the givenglob(7)<pattern>, excluding therefs/tags/ prefix.

  • exclude=<pattern>: Do not consider tags matching the givenglob(7)<pattern>, excluding therefs/tags/ prefix.

  %S

  ref name given on the command line by which the commit was reached(likegitlog--source), only works withgitlog

  %e

  encoding

  %s

  subject

  %f

  sanitized subject line, suitable for a filename

  %b

  body

  %B

  raw body (unwrapped subject and body)

  %N

  commit notes

  %GG

  raw verification message from GPG for a signed commit

  %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

  %GS

  show the name of the signer for a signed commit

  %GK

  show the key used to sign a signed commit

  %GF

  show the fingerprint of the key used to sign a signed commit

  %GP

  show the fingerprint of the primary key whose subkey was usedto sign a signed commit

  %GT

  show the trust level for the key used to sign a signed commit

  %gD

  reflog selector, e.g.,refs/stash@{1} orrefs/stash@{2minutesago}; the format follows the rules described for the-g option. The portion before the@ is the refname asgiven on the command line (sogitlog-grefs/heads/masterwould yieldrefs/heads/master@{0}).

  %gd

  shortened reflog selector; same as%gD, but the refnameportion is shortened for human readability (sorefs/heads/master becomes justmaster).

  %gn

  reflog identity name

  %gN

  reflog identity name (respecting .mailmap, seegit-shortlog[1] orgit-blame[1])

  %ge

  reflog identity email

  %gE

  reflog identity email (respecting .mailmap, seegit-shortlog[1] orgit-blame[1])

  %gs

  reflog subject

  %(trailers[:<option>,...])

  display the trailers of the body as interpreted bygit-interpret-trailers[1]. Thetrailers string may be followed bya colon and zero or more comma-separated options. If any option is providedmultiple times, the last occurrence wins.

  • key=<key>: only show trailers with specified <key>. Matching is donecase-insensitively and trailing colon is optional. If option isgiven multiple times trailer lines matching any of the keys areshown. This option automatically enables theonly option so thatnon-trailer lines in the trailer block are hidden. If that is notdesired it can be disabled withonly=false. E.g.,%(trailers:key=Reviewed-by) shows trailer lines with keyReviewed-by.

  • only[=<bool>]: select whether non-trailer lines from the trailerblock should be included.

  • separator=<sep>: specify the separator inserted between trailerlines. Defaults to a line feed character. The string <sep> may containthe literal formatting codes described above. To use comma asseparator one must use%x2C as it would otherwise be parsed asnext option. E.g.,%(trailers:key=Ticket,separator=%x2C )shows all trailer lines whose key is "Ticket" separated by a commaand a space.

  • unfold[=<bool>]: make it behave as if interpret-trailer’s--unfoldoption was given. E.g.,%(trailers:only,unfold=true) unfolds and shows all trailer lines.

  • keyonly[=<bool>]: only show the key part of the trailer.

  • valueonly[=<bool>]: only show the value part of the trailer.

  • key_value_separator=<sep>: specify the separator inserted betweenthe key and value of each trailer. Defaults to ": ". Otherwise itshares the same semantics asseparator=<sep> above.

The boolean options accept an optional value[=<bool-value>]. Thevalues taken by--type=boolgit-config[1], likeyes andoff,are all accepted. Giving a boolean option without=<value> isequivalent to giving it with=true.

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:

  Thetformat: format works exactly likeformat:, 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/'4da45be7134973 -- NO NEWLINE$ git log -2 --pretty=tformat:%h 4da45bef \  | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'4da45be7134973

  In addition, any unrecognized string that has a% in it is interpretedas if it hastformat: in front of it. For example, these two areequivalent:

  $ git log -2 --pretty=tformat:%h 4da45bef$ git log -2 --pretty=%h 4da45bef

By default,gitlog does not generate any diff output. The optionsbelow can be used to show the changes made by each commit.

Note that unless one of--diff-merges variants (including short-m,-c,--cc, and--dd options) is explicitly given, merge commitswill not show a diff, even if a diff format like--patch isselected, nor will they match search options like-S. The exceptionis when--first-parent is in use, in which casefirst-parent isthe default format for merge commits.

-p

-u

--patch

Generate patch (seeGenerating patch text with -p).

-s

--no-patch

Suppress all output from the diff machinery. Useful forcommands likegitshow that show the patch by default tosquelch their output, or to cancel the effect of options like--patch,--stat earlier on the command line in an alias.

-m

Show diffs for merge commits in the default format. This issimilar to--diff-merges=on, except-m willproduce no output unless-p is given as well.

-c

Produce combined diff output for merge commits.Shortcut for--diff-merges=combined-p.

--cc

Produce dense combined diff output for merge commits.Shortcut for--diff-merges=dense-combined-p.

--dd

Produce diff with respect to first parent for both merge andregular commits.Shortcut for--diff-merges=first-parent-p.

--remerge-diff

Produce remerge-diff output for merge commits.Shortcut for--diff-merges=remerge-p.

--no-diff-merges

Synonym for--diff-merges=off.

--diff-merges=<format>

Specify diff format to be used for merge commits. Default is`off` unless--first-parent is in use, inwhich casefirst-parent is the default.

The following formats are supported:

off

none

Disable output of diffs for merge commits. Useful to overrideimplied value.

on

m

Make diff output for merge commits to be shown in the defaultformat. The default format can be changed usinglog.diffMerges configuration variable, whose default valueisseparate.

first-parent

1

Show full diff with respect to first parent. This is the sameformat as--patch produces for non-merge commits.

separate

Show full diff with respect to each of parents.Separate log entry and diff is generated for each parent.

combined

c

Show differences from each of the parents to the mergeresult simultaneously instead of showing pairwise diff betweena parent and the result one at a time. Furthermore, it listsonly files which were modified from all parents.

dense-combined

cc

Further compress output produced by--diff-merges=combinedby omitting uninteresting hunks whose contents in the parentshave only two variants and the merge result picks one of themwithout modification.

remerge

r

Remerge two-parent merge commits to create a temporary treeobject—​potentially containing files with conflict markersand such. A diff is then shown between that temporary treeand the actual merge commit.

The output emitted when this option is used is subject to change, andso is its interaction with other options (unless explicitlydocumented).

--combined-all-paths

Cause combined diffs (used for merge commits) tolist the name of the file from all parents. It thus only haseffect when--diff-merges=[dense-]combined is in use, andis likely only useful if filename changes are detected (i.e.when either rename or copy detection have been requested).

-U<n>

--unified=<n>

Generate diffs with<n> lines of context instead ofthe usual three.Implies--patch.

--output=<file>

Output to a specific file instead of stdout.

--output-indicator-new=<char>

--output-indicator-old=<char>

--output-indicator-context=<char>

Specify the character used to indicate new, old or contextlines in the generated patch. Normally they are+,- and' ' respectively.

--raw

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.

--patch-with-raw

Synonym for-p--raw.

-t

Show the tree objects in the diff output.

--indent-heuristic

Enable the heuristic that shifts diff hunk boundaries to make patcheseasier to read. This is the default.

--no-indent-heuristic

Disable the indent heuristic.

--minimal

Spend extra time to make sure the smallest possiblediff is produced.

--patience

Generate a diff using the "patience diff" algorithm.

--histogram

Generate a diff using the "histogram diff" algorithm.

--anchored=<text>

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<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.

minimal

Spend extra time to make sure the smallest possible diff isproduced.

patience

Use "patience diff" algorithm when generating patches.

histogram

This algorithm extends the patience algorithm to "supportlow-occurrence common elements".

For instance, if you configured thediff.algorithm variable to anon-default value and want to use the default one, then youhave to use--diff-algorithm=default option.

--stat[=<width>[,<name-width>[,<count>]]]

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 or by settingdiff.statNameWidth=<name-width>. The width of the graph part can belimited by using--stat-graph-width=<graph-width> or by settingdiff.statGraphWidth=<graph-width>. Using--stat or--stat-graph-width affects all commands generating a stat graph,while settingdiff.statNameWidth ordiff.statGraphWidthdoes not affectgitformat-patch.By giving a third parameter<count>, you can limit the output tothe first<count> lines, followed by... if there 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+lif 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.

--numstat

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 saying00.

--shortstat

Output only the last line of the--stat format containing totalnumber of modified files, as well as number of added and deletedlines.

-X [<param>,...]

--dirstat[=<param>,...]

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 (seegit-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.

lines

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--dirstatbehavior 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.

files

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.

cumulative

Count changes in a child directory for the parent directory as well.Note that when usingcumulative, the sum of the percentagesreported may exceed 100%. The default (non-cumulative) behavior canbe specified with thenoncumulative parameter.

<limit>

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.

--dirstat-by-file[=<param>,...]

Synonym for--dirstat=files,<param>,....

--summary

Output a condensed summary of extended header informationsuch as creations, renames and mode changes.

--patch-with-stat

Synonym for-p--stat.

-z

Separate the commits withNULs instead of newlines.

Also, when--raw or--numstat has been given, do not mungepathnames and useNULs as output field terminators.

Without this option, pathnames with "unusual" characters are quoted asexplained for the configuration variablecore.quotePath (seegit-config[1]).

--name-only

Show only the name of each changed file in the post-image tree.The file names are often encoded in UTF-8.For more information see the discussion about encoding in thegit-log[1]manual page.

--name-status

Show only the name(s) and status of each changed file. See the descriptionof the--diff-filter option on what the status letters mean.Just like--name-only the file names are often encoded in UTF-8.

--submodule[=<format>]

Specify how differences in submodules are shown. When specifying--submodule=short theshort 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, thelogformat is used. This format lists the commits in the range likegit-submodule[1]summary does. When--submodule=diffis specified, thediff format is used. This format shows aninline diff of the changes in the submodule contents between thecommit range. Defaults todiff.submodule or theshort formatif the config option is unset.

--color[=<when>]

Show colored diff.--color (i.e. without=<when>) is the same as--color=always.<when> can be one ofalways,never, orauto.

--no-color

Turn off colored diff.It is the same as--color=never.

--color-moved[=<mode>]

Moved lines of code are colored differently.The<mode> defaults tono if the option is not givenand tozebra if the option with no mode is given.The mode must be one of:

no

Moved lines are not highlighted.

default

Is a synonym forzebra. This may change to a more sensible modein the future.

plain

Any line that is added in one location and was removedin another location will be colored withcolor.diff.newMoved.Similarlycolor.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

Blocks of moved text of at least 20 alphanumeric charactersare detected greedily. The detected blocks arepainted using either thecolor.diff.(old|new)Moved color.Adjacent blocks cannot be told apart.

zebra

Blocks of moved text are detected as inblocks mode. The blocksare painted using either thecolor.diff.(old|new)Moved color orcolor.diff.(old|new)MovedAlternative. The change betweenthe two colors indicates that a new block was detected.

dimmed-zebra

Similar tozebra, 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.

--color-moved-ws=<mode>,...

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-space-at-eol

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 ignores differenceseven if one line has whitespace where the other line has none.

allow-indentation-change

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.

--word-diff[=<mode>]

By default, words are delimited by whitespace; see--word-diff-regex below. The<mode> defaults toplain, andmust be one of:

color

Highlight changed words using only colors. Implies--color.

plain

Show words as[-removed-] and{added}. Makes noattempts to escape the delimiters if they appear in the input,so the output may be ambiguous.

porcelain

Use a special line-based format intended for scriptconsumption. Added/removed/unchanged runs are printed in theusual unified diff format, starting with a+/-/` `character at the beginning of the line and extending to theend of the line. Newlines in the input are represented by atilde~ on a line of its own.

none

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=<regex>

Use<regex> 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<regex> is considered a word. Anything between these matches isconsidered whitespace and ignored(!) for the purposes of findingdifferences. You may want to append|[^[: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] orgit-config[1]. Giving it explicitlyoverrides any diff driver or configuration setting. Diff driversoverride configuration settings.

--color-words[=<regex>]

Equivalent to--word-diff=color plus (if a regex wasspecified)--word-diff-regex=<regex>.

--no-renames

Turn off rename detection, even when the configurationfile gives the default to do so.

--[no-]rename-empty

Whether to use empty blobs as rename source.

--check

Warn if changes introduce conflict markers or whitespace errors.What are considered whitespace errors is controlled bycore.whitespaceconfiguration. 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.

--ws-error-highlight=<kind>

Highlight whitespace errors in thecontext,old ornewlines 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.

--full-index

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.

--binary

In addition to--full-index, output a binary diff thatcan be applied withgit-apply.Implies--patch.

--abbrev[=<n>]

Instead of showing the full 40-byte hexadecimal objectname in diff-raw format output and diff-tree headerlines, show the shortest prefix that is at least<n>hexdigits long that uniquely refers the object.In diff-patch output format,--full-index takes higherprecedence, i.e. if--full-index is specified, full blobnames will be shown regardless of--abbrev.Non default number of digits can be specified with--abbrev=<n>.

-B[<n>][/<m>]

--break-rewrites[=[<n>][/<m>]]

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[<n>]

--find-renames[=<n>]

If generating diffs, detect and report renames for each commit.For following files across renames while traversing history, see--follow.If<n> 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%.

-C[<n>]

--find-copies[=<n>]

Detect copies as well as renames. See also--find-copies-harder.If<n> is specified, it has the same meaning as for-M<n>.

--find-copies-harder

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.

-D

--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 orgitapply; 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<num>

The-M and-C options involve some preliminary steps thatcan detect subsets of renames/copies cheaply, followed by anexhaustive fallback portion that compares all remainingunpaired destinations to all relevant sources. (For renames,only remaining unpaired sources are relevant; for copies, alloriginal sources are relevant.) For N sources anddestinations, this exhaustive check is O(N^2). This optionprevents the exhaustive portion of rename/copy detection fromrunning if the number of source/destination files involvedexceeds the specified number. Defaults todiff.renameLimit.Note that a value of 0 is treated as unlimited.

--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]

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, copied andrenamed entries cannot appear if detection for those types is disabled.

-S<string>

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.

-G<regex>

Look for differences whose patch text contains added/removedlines that match<regex>.

To illustrate the difference between-S<regex>--pickaxe-regex and-G<regex>, consider a commit with the following diff in the samefile:

+    return frotz(nitfol, two->ptr, 1, 0);...-    hit = frotz(nitfol, mf2.ptr, 1, 0);

Whilegit log -G"frotz\(nitfol" will show this commit,git log-S"frotz\(nitfol" --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 thepickaxe entry ingitdiffcore[7] for moreinformation.

--find-object=<object-id>

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<string>.

--pickaxe-regex

Treat the<string> given to-S as an extended POSIX regularexpression to match.

-O<orderfile>

Control the order in which files appear in the output.This overrides thediff.orderFile configuration variable(seegit-config[1]). To canceldiff.orderFile,use-O/dev/null.

The output order is determined by the order of glob patterns in<orderfile>.All files with pathnames that match the first pattern are outputfirst, all files with pathnames that match the second pattern (but notthe first) are output next, and so on.All files with pathnames that do not match any pattern are outputlast, as if there was an implicit match-all pattern at the end of thefile.If multiple pathnames have the same rank (they match the same patternbut no earlier patterns), their output order relative to each other isthe normal order.

<orderfile> is parsed as follows:

• 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 theFNM_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".

--skip-to=<file>

--rotate-to=<file>

Discard the files before the named<file> from the output(i.e.skip to), or move them to the end of the output(i.e.rotate to). These options were invented primarily for the useof thegitdifftool command, and may not be very usefulotherwise.

-R

Swap two inputs; that is, show differences from index oron-disk file to tree contents.

--relative[=<path>]

--no-relative

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<path> as an argument.--no-relative can be used to countermand bothdiff.relative configoption and previous--relative.

-a

--text

Treat all files as text.

--ignore-cr-at-eol

Ignore carriage-return at the end of line when doing a comparison.

--ignore-space-at-eol

Ignore changes in whitespace at EOL.

-b

--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.

-w

--ignore-all-space

Ignore whitespace when comparing lines. This ignoresdifferences even if one line has whitespace where the otherline has none.

--ignore-blank-lines

Ignore changes whose lines are all blank.

-I<regex>

--ignore-matching-lines=<regex>

Ignore changes whose all lines match<regex>. This option maybe specified more than once.

--inter-hunk-context=<number>

Show the context between diff hunks, up to the specified<number>of lines, thereby fusing hunks that are close to each other.Defaults todiff.interHunkContext or 0 if the config optionis unset.

-W

--function-context

Show whole function as context lines for each change.The function names are determined in the same way asgitdiff works out patch hunk headers (see "Defining acustom hunk-header" ingitattributes[5]).

--ext-diff

Allow an external diff helper to be executed. If you set anexternal diff driver withgitattributes[5], you needto use this option withgit-log[1] and friends.

--no-ext-diff

Disallow external diff drivers.

--textconv

--no-textconv

Allow (or disallow) external text conversion filters to be runwhen comparing binary files. Seegitattributes[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 forgit-diff[1] andgit-log[1], but not forgit-format-patch[1] ordiff plumbing commands.

--ignore-submodules[=(none|untracked|dirty|all)]

Ignore changes to submodules in the diff generation.all is the default.Usingnone will consider the submodule modified when it either containsuntracked or modified files or itsHEAD differs from the commit recordedin the superproject and can be used to override any settings of theignore option ingit-config[1] orgitmodules[5]. Whenuntracked is used submodules are not considered dirty when they onlycontain untracked content (but they are still scanned for modifiedcontent). Usingdirty 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). Usingall hides all changes to submodules.

--src-prefix=<prefix>

Show the given source<prefix> instead of "a/".

--dst-prefix=<prefix>

Show the given destination<prefix> instead of "b/".

--no-prefix

Do not show any source or destination prefix.

--default-prefix

Use the default source and destination prefixes ("a/" and "b/").This overrides configuration variables such asdiff.noprefix,diff.srcPrefix,diff.dstPrefix, anddiff.mnemonicPrefix(seegit-config[1]).

--line-prefix=<prefix>

Prepend an additional<prefix> to every line of output.

--ita-invisible-in-index

By default entries added bygitadd-N appear as an existingempty file ingitdiff and a new file ingitdiff--cached.This option makes the entry appear as a new file ingitdiffand non-existent ingitdiff--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].

Runninggit-diff[1],git-log[1],git-show[1],git-diff-index[1],git-diff-tree[1], orgit-diff-files[1]with the-p option produces patch text.You can customize the creation of patch text via theGIT_EXTERNAL_DIFF and theGIT_DIFF_OPTS environment variables(seegit[1]), and thediff attribute (seegitattributes[5]).

What the-p option produces is slightly different from the traditionaldiff format:

1. It is preceded by a "git diff" header that looks like this:

   diff --git a/file1 b/file2

   Thea/ andb/ filenames are the same unless rename/copy isinvolved. Especially, even for a creation or a deletion,/dev/null isnot used in place of thea/ orb/ filenames.

   When a rename/copy is involved,file1 andfile2 show thename of the source file of the rename/copy and the name ofthe file that the rename/copy produces, respectively.

2. It is followed by one or more extended header lines:

   oldmode<mode>newmode<mode>deletedfilemode<mode>newfilemode<mode>copyfrom<path>copyto<path>renamefrom<path>renameto<path>similarityindex<number>dissimilarityindex<number>index<hash>..<hash><mode>

   File modes<mode> are printed as 6-digit octal numbers including the file typeand file permission bits.

   Path names in extended headers do not include thea/ andb/ 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 blob object names before and after the change.The<mode> is included if the file mode does not change; otherwise,separate lines indicate the old and the new mode.

3. Pathnames with "unusual" characters are quoted as explained forthe configuration variablecore.quotePath (seegit-config[1]).

4. All thefile1 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/brename from arename to bdiff --git a/b b/arename from brename to a

5. Hunk headers mention the name of the function to which the hunkapplies. See "Defining a custom hunk-header" ingitattributes[5] for details of how to tailor this tospecific languages.

Any diff-generating command can take the-c or--cc option toproduce acombined diff when showing a merge. This is the defaultformat when showing merges withgit-diff[1] orgit-show[1]. Note also that you can give suitable--diff-merges option to any of these commands to force generation ofdiffs in a specific format.

A "combined diff" format looks like this:

1. It is preceded by a "git diff" header, that looks likethis (when the-c option is used):

   diff --combined file

   or like this (when the--cc option is used):

   diff --cc file

2. 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>newfilemode<mode>deletedfilemode<mode>,<mode>

   Themode<mode>,<mode>..<mode> line appears only if at least one ofthe <mode> is different from the rest. Extended headers withinformation about detected content movement (renames andcopying detection) are designed to work with the diff of two<tree-ish> and are not used by combined diff format.

3. It is followed by a two-line from-file/to-file header:

   --- a/file+++ b/file

   Similar to the two-line header for the traditionalunified 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 an 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.

4. Chunk header format is modified to prevent people fromaccidentally feeding it topatch-p1. Combined diff formatwas created for review of merge commit changes, and was notmeant to be applied. The change is similar to the change in theextendedindex 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 traditionalunified 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 bygitdiff-tree-c, it compares the parents of amerge commit with the merge result (i.e. file1..fileN are theparents). When shown bygitdiff-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").

gitlog--no-merges

Show the whole commit history, but skip any merges

gitlogv2.6.12..include/scsidrivers/scsi

Show all commits since versionv2.6.12 that changed any filein theinclude/scsi ordrivers/scsi subdirectories

gitlog--since="2weeksago"--gitk

Show the changes during the last two weeks to the filegitk.The-- is necessary to avoid confusion with thebranch namedgitk

gitlog--name-statusrelease..test

Show the commits that are in the "test" branch but not yetin the "release" branch, along with the list of pathseach commit modifies.

gitlog--followbuiltin/rev-list.c

Shows the commits that changedbuiltin/rev-list.c, includingthose commits that occurred before the file was given itspresent name.

gitlog--branches--not--remotes=origin

Shows all commits that are in any of local branches but not inany of remote-tracking branches fororigin (what you have thatorigin doesn’t).

gitlogmaster--not--remotes=*/master

Shows all commits that are in local master but not in any remoterepository master branches.

gitlog-p-m--first-parent

Shows the history including change diffs, but only from the“main branch” perspective, skipping commits that come from mergedbranches, and showing full diffs of changes introduced by the merges.This makes sense only when following a strict policy of merging alltopic branches when staying on a single integration branch.

gitlog-L/intmain/',/^}/:main.c

Shows how the functionmain() in the filemain.c evolvedover time.

gitlog-3

Limits the number of commits to show to 3.

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 (seegit-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, butnot 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.

1. gitcommit andgitcommit-tree issuea 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 tohavei18n.commitEncoding in.git/config file, like this:

   [i18n]commitEncoding = ISO-8859-1

   Commit objects created with the above setting record the valueofi18n.commitEncoding in theirencoding 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.

2. gitlog,gitshow,gitblame and friends look at theencoding 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.

Seegit-config[1] for core variables andgit-diff[1]for settings related to diff generation.

format.pretty

Default for the--format option. (SeePretty Formats above.)Defaults tomedium.

i18n.logOutputEncoding

Encoding to use when displaying logs. (SeeDiscussion above.)Defaults to the value ofi18n.commitEncoding if set, and UTF-8otherwise.

Everything above this line in this section isn’t included from thegit-config[1] documentation. The content that follows is thesame as what’s found there:

log.abbrevCommit

Iftrue, makegit-log[1],git-show[1], andgit-whatchanged[1]assume--abbrev-commit. You mayoverride this option with--no-abbrev-commit.

log.date

Set the default date-time mode for thelog command.Setting a value for log.date is similar to usinggitlog's--date option. Seegit-log[1] for details.

If the format is set to "auto:foo" and the pager is in use, format"foo" will be used for the date format. Otherwise, "default" willbe used.

log.decorate

Print out the ref names of any commits that are shown by the logcommand. Possible values are:

short

the ref name prefixesrefs/heads/,refs/tags/ andrefs/remotes/ are not printed.

full

the full ref name (including prefix) are printed.

auto

if the output is going to a terminal,the ref names are shown as ifshort were given, otherwise no refnames are shown.

This is the same as the--decorate option of thegitlog.

log.initialDecorationSet

By default,gitlog only shows decorations for certain known refnamespaces. Ifall is specified, then show all refs asdecorations.

log.excludeDecoration

Exclude the specified patterns from the log decorations. This issimilar to the--decorate-refs-exclude command-line option, butthe config option can be overridden by the--decorate-refsoption.

log.diffMerges

Set diff format to be used when--diff-merges=on isspecified, see--diff-merges ingit-log[1] fordetails. Defaults toseparate.

log.follow

Iftrue,gitlog will act as if the--follow option was used whena single <path> is given. This has the same limitations as--follow,i.e. it cannot be used to follow multiple files and does not work wellon non-linear history.

log.graphColors

A list of colors, separated by commas, that can be used to drawhistory lines ingitlog--graph.

log.showRoot

If true, the initial commit will be shown as a big creation event.This is equivalent to a diff against an empty tree.Tools likegit-log[1] orgit-whatchanged[1], whichnormally hide the root commit will now show it. True by default.

log.showSignature

If true, makesgit-log[1],git-show[1], andgit-whatchanged[1] assume--show-signature.

log.mailmap

If true, makesgit-log[1],git-show[1], andgit-whatchanged[1] assume--use-mailmap, otherwiseassume--no-use-mailmap. True by default.

notes.mergeStrategy

Which merge strategy to choose by default when resolving notesconflicts. Must be one ofmanual,ours,theirs,union, orcat_sort_uniq. Defaults tomanual. See the "NOTES MERGE STRATEGIES"section ofgit-notes[1] for more information on each strategy.

This setting can be overridden by passing the--strategy option togit-notes[1].

notes.<name>.mergeStrategy

Which merge strategy to choose when doing a notes merge intorefs/notes/<name>. This overrides the more generalnotes.mergeStrategy. See the "NOTES MERGE STRATEGIES" section ingit-notes[1] for more information on the available strategies.

notes.displayRef

Which ref (or refs, if a glob or specified more than once), inaddition to the default set bycore.notesRef orGIT_NOTES_REF, to read notes from when showing commitmessages with thegitlog family of commands.

This setting can be overridden with theGIT_NOTES_DISPLAY_REFenvironment variable, which must be a colon separated list of refs orglobs.

A warning will be issued for refs that do not exist,but a glob that does not match any refs is silently ignored.

This setting can be disabled by the--no-notes option to thegit-log[1]family of commands, or by the--notes=<ref> option accepted bythose commands.

The effective value ofcore.notesRef (possibly overridden byGIT_NOTES_REF) is also implicitly added to the list of refs to bedisplayed.

notes.rewrite.<command>

When rewriting commits with<command> (currentlyamend orrebase), if this variable isfalse, git will not copynotes from the original to the rewritten commit. Defaults totrue. See alsonotes.rewriteRef below.

This setting can be overridden with theGIT_NOTES_REWRITE_REFenvironment variable, which must be a colon separated list of refs orglobs.

notes.rewriteMode

When copying notes during a rewrite (see thenotes.rewrite.<command> option), determines what to do ifthe target commit already has a note. Must be one ofoverwrite,concatenate,cat_sort_uniq, orignore.Defaults toconcatenate.

This setting can be overridden with theGIT_NOTES_REWRITE_MODEenvironment variable.

notes.rewriteRef

When copying notes during a rewrite, specifies the (fullyqualified) ref whose notes should be copied. May be a glob,in which case notes in all matching refs will be copied. Youmay also specify this configuration several times.

Does not have a default value; you must configure this variable toenable note rewriting. Set it torefs/notes/commits to enablerewriting for the default commit notes.

Can be overridden with theGIT_NOTES_REWRITE_REF environment variable.Seenotes.rewrite.<command> above for a further description of its format.

Part of thegit[1] suite