Google Git
Sign in
chromium / external / gitster / git-htmldocs / e77b015d156771d6b32769e7997c455adf9db4ab / . / git-log.html
blob: 228f483e5b13260bf2a333ef7c2cb786d9da54fb [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 7.0.2" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a { color: blue; }
a:visited { color: fuchsia; }
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1 {
border-bottom: 2px solid silver;
}
h2 {
border-bottom: 2px solid silver;
padding-top: 0.5em;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.2em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.quoteblock .attribution {
text-align: right;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
ol.olist2 {
list-style-type: lower-alpha;
}
div.tableblock > table {
border-color: #527bbd;
border-width: 3px;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
include::./stylesheets/xhtml11-manpage.css[]
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
</style>
<title>git-log(1)</title>
</head>
<body>
<div id="header">
<h1>
git-log(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-log -
Show commit logs
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<p><em>git-log</em> &lt;option&gt;&#8230;</p>
</div>
<h2>DESCRIPTION</h2>
<div class="sectionbody">
<p>Shows the commit logs.</p>
<p>The command takes options applicable to the <a href="git-rev-list.html">git-rev-list(1)</a>
command to control what is shown and how, and options applicable to
the <a href="git-diff-tree.html">git-diff-tree(1)</a> commands to control how the changes
each commit introduces are shown.</p>
<p>This manual page describes only the most frequently used options.</p>
</div>
<h2>OPTIONS</h2>
<div class="sectionbody">
<dl>
<dt>
--pretty[=<em>&lt;format&gt;</em>]
</dt>
<dd>
<p>
Pretty-print the contents of the commit logs in a given format,
where <em>&lt;format&gt;</em> can be one of <em>oneline</em>, <em>short</em>, <em>medium</em>,
<em>full</em>, <em>fuller</em>, <em>email</em>, <em>raw</em> and <em>format:&lt;string&gt;</em>.
When omitted, the format defaults to <em>medium</em>.
</p>
</dd>
<dt>
--abbrev-commit
</dt>
<dd>
<p>
Instead of showing the full 40-byte hexadecimal commit object
name, show only handful hexdigits prefix. Non default number of
digits can be specified with "--abbrev=&lt;n&gt;" (which also modifies
diff output, if it is displayed).
</p>
<p>This should make "--pretty=oneline" a whole lot more readable for
people using 80-column terminals.</p>
</dd>
<dt>
--encoding[=&lt;encoding&gt;]
</dt>
<dd>
<p>
The commit objects record the encoding used for the log message
in their encoding header; this option can be used to tell the
command to re-code the commit log message in the encoding
preferred by the user. For non plumbing commands this
defaults to UTF-8.
</p>
</dd>
</dl>
<dl>
<dt>
-p
</dt>
<dd>
<p>
Generate patch (see section on generating patches).
</p>
</dd>
<dt>
-u
</dt>
<dd>
<p>
Synonym for "-p".
</p>
</dd>
<dt>
-U&lt;n&gt;
</dt>
<dd>
<p>
Shorthand for "--unified=&lt;n&gt;".
</p>
</dd>
<dt>
--unified=&lt;n&gt;
</dt>
<dd>
<p>
Generate diffs with &lt;n&gt; lines of context instead of
the usual three. Implies "-p".
</p>
</dd>
<dt>
--raw
</dt>
<dd>
<p>
Generate the raw format.
</p>
</dd>
<dt>
--patch-with-raw
</dt>
<dd>
<p>
Synonym for "-p --raw".
</p>
</dd>
<dt>
--stat[=width[,name-width]]
</dt>
<dd>
<p>
Generate a diffstat. You can override the default
output width for 80-column terminal by "--stat=width".
The width of the filename part can be controlled by
giving another width to it separated by a comma.
</p>
</dd>
<dt>
--numstat
</dt>
<dd>
<p>
Similar to --stat, but shows number of added and
deleted lines in decimal notation and pathname without
abbreviation, to make it more machine friendly. For
binary files, outputs two <tt>-</tt> instead of saying
<tt>0 0</tt>.
</p>
</dd>
<dt>
--shortstat
</dt>
<dd>
<p>
Output only the last line of the --stat format containing total
number of modified files, as well as number of added and deleted
lines.
</p>
</dd>
<dt>
--summary
</dt>
<dd>
<p>
Output a condensed summary of extended header information
such as creations, renames and mode changes.
</p>
</dd>
<dt>
--patch-with-stat
</dt>
<dd>
<p>
Synonym for "-p --stat".
</p>
</dd>
<dt>
-z
</dt>
<dd>
<p>
NUL-line termination on output. This affects the --raw
output field terminator. Also output from commands such
as "git-log" will be delimited with NUL between commits.
</p>
</dd>
<dt>
--name-only
</dt>
<dd>
<p>
Show only names of changed files.
</p>
</dd>
<dt>
--name-status
</dt>
<dd>
<p>
Show only names and status of changed files.
</p>
</dd>
<dt>
--color
</dt>
<dd>
<p>
Show colored diff.
</p>
</dd>
<dt>
--no-color
</dt>
<dd>
<p>
Turn off colored diff, even when the configuration file
gives the default to color output.
</p>
</dd>
<dt>
--color-words
</dt>
<dd>
<p>
Show colored word diff, i.e. color words which have changed.
</p>
</dd>
<dt>
--no-renames
</dt>
<dd>
<p>
Turn off rename detection, even when the configuration
file gives the default to do so.
</p>
</dd>
<dt>
--check
</dt>
<dd>
<p>
Warn if changes introduce trailing whitespace
or an indent that uses a space before a tab. Exits with
non-zero status if problems are found. Not compatible with
--exit-code.
</p>
</dd>
<dt>
--full-index
</dt>
<dd>
<p>
Instead of the first handful characters, show full
object name of pre- and post-image blob on the "index"
line when generating a patch format output.
</p>
</dd>
<dt>
--binary
</dt>
<dd>
<p>
In addition to --full-index, output "binary diff" that
can be applied with "git apply".
</p>
</dd>
<dt>
--abbrev[=&lt;n&gt;]
</dt>
<dd>
<p>
Instead of showing the full 40-byte hexadecimal object
name in diff-raw format output and diff-tree header
lines, show only handful hexdigits prefix. This is
independent of --full-index option above, which controls
the diff-patch output format. Non default number of
digits can be specified with --abbrev=&lt;n&gt;.
</p>
</dd>
<dt>
-B
</dt>
<dd>
<p>
Break complete rewrite changes into pairs of delete and create.
</p>
</dd>
<dt>
-M
</dt>
<dd>
<p>
Detect renames.
</p>
</dd>
<dt>
-C
</dt>
<dd>
<p>
Detect copies as well as renames. See also <tt>--find-copies-harder</tt>.
</p>
</dd>
<dt>
--diff-filter=[ACDMRTUXB*]
</dt>
<dd>
<p>
Select only files that are Added (<tt>A</tt>), Copied (<tt>C</tt>),
Deleted (<tt>D</tt>), Modified (<tt>M</tt>), Renamed (<tt>R</tt>), have their
type (mode) changed (<tt>T</tt>), are Unmerged (<tt>U</tt>), are
Unknown (<tt>X</tt>), or have had their pairing Broken (<tt>B</tt>).
Any combination of the filter characters may be used.
When <tt>*</tt> (All-or-none) is added to the combination, all
paths are selected if there is any file that matches
other criteria in the comparison; if there is no file
that matches other criteria, nothing is selected.
</p>
</dd>
<dt>
--find-copies-harder
</dt>
<dd>
<p>
For performance reasons, by default, <tt>-C</tt> option finds copies only
if the original file of the copy was modified in the same
changeset. This flag makes the command
inspect unmodified files as candidates for the source of
copy. This is a very expensive operation for large
projects, so use it with caution. Giving more than one
<tt>-C</tt> option has the same effect.
</p>
</dd>
<dt>
-l&lt;num&gt;
</dt>
<dd>
<p>
-M and -C options require O(n^2) processing time where n
is the number of potential rename/copy targets. This
option prevents rename/copy detection from running if
the number of rename/copy targets exceeds the specified
number.
</p>
</dd>
<dt>
-S&lt;string&gt;
</dt>
<dd>
<p>
Look for differences that contain the change in &lt;string&gt;.
</p>
</dd>
<dt>
--pickaxe-all
</dt>
<dd>
<p>
When -S finds a change, show all the changes in that
changeset, not just the files that contain the change
in &lt;string&gt;.
</p>
</dd>
<dt>
--pickaxe-regex
</dt>
<dd>
<p>
Make the &lt;string&gt; not a plain string but an extended POSIX
regex to match.
</p>
</dd>
<dt>
-O&lt;orderfile&gt;
</dt>
<dd>
<p>
Output the patch in the order specified in the
&lt;orderfile&gt;, which has one shell glob pattern per line.
</p>
</dd>
<dt>
-R
</dt>
<dd>
<p>
Swap two inputs; that is, show differences from index or
on-disk file to tree contents.
</p>
</dd>
<dt>
--text
</dt>
<dd>
<p>
Treat all files as text.
</p>
</dd>
<dt>
-a
</dt>
<dd>
<p>
Shorthand for "--text".
</p>
</dd>
<dt>
--ignore-space-at-eol
</dt>
<dd>
<p>
Ignore changes in whitespace at EOL.
</p>
</dd>
<dt>
--ignore-space-change
</dt>
<dd>
<p>
Ignore changes in amount of whitespace. This ignores whitespace
at line end, and considers all other sequences of one or
more whitespace characters to be equivalent.
</p>
</dd>
<dt>
-b
</dt>
<dd>
<p>
Shorthand for "--ignore-space-change".
</p>
</dd>
<dt>
--ignore-all-space
</dt>
<dd>
<p>
Ignore whitespace when comparing lines. This ignores
differences even if one line has whitespace where the other
line has none.
</p>
</dd>
<dt>
-w
</dt>
<dd>
<p>
Shorthand for "--ignore-all-space".
</p>
</dd>
<dt>
--exit-code
</dt>
<dd>
<p>
Make the program exit with codes similar to diff(1).
That is, it exits with 1 if there were differences and
0 means no differences.
</p>
</dd>
<dt>
--quiet
</dt>
<dd>
<p>
Disable all output of the program. Implies --exit-code.
</p>
</dd>
<dt>
--ext-diff
</dt>
<dd>
<p>
Allow an external diff helper to be executed. If you set an
external diff driver with <a href="gitattributes.html">gitattributes(5)</a>, you need
to use this option with <a href="git-log.html">git-log(1)</a> and friends.
</p>
</dd>
<dt>
--no-ext-diff
</dt>
<dd>
<p>
Disallow external diff drivers.
</p>
</dd>
<dt>
--src-prefix=&lt;prefix&gt;
</dt>
<dd>
<p>
Show the given source prefix instead of "a/".
</p>
</dd>
<dt>
--dst-prefix=&lt;prefix&gt;
</dt>
<dd>
<p>
Show the given destination prefix instead of "b/".
</p>
</dd>
<dt>
--no-prefix
</dt>
<dd>
<p>
Do not show any source or destination prefix.
</p>
</dd>
</dl>
<p>For more detailed explanation on these common options, see also
<a href="diffcore.html">diffcore documentation</a>.</p>
<dl>
<dt>
-&lt;n&gt;
</dt>
<dd>
<p>
Limits the number of commits to show.
</p>
</dd>
<dt>
&lt;since&gt;..&lt;until&gt;
</dt>
<dd>
<p>
Show only commits between the named two commits. When
either &lt;since&gt; or &lt;until&gt; is omitted, it defaults to
<tt>HEAD</tt>, i.e. the tip of the current branch.
For a more complete list of ways to spell &lt;since&gt;
and &lt;until&gt;, see "SPECIFYING REVISIONS" section in
<a href="git-rev-parse.html">git-rev-parse(1)</a>.
</p>
</dd>
<dt>
--first-parent
</dt>
<dd>
<p>
Follow only the first parent commit upon seeing a merge
commit. This option can give a better overview when
viewing the evolution of a particular topic branch,
because merges into a topic branch tend to be only about
adjusting to updated upstream from time to time, and
this option allows you to ignore the individual commits
brought in to your history by such a merge.
</p>
</dd>
<dt>
-g, --walk-reflogs
</dt>
<dd>
<p>
Show commits as they were recorded in the reflog. The log contains
a record about how the tip of a reference was changed.
Cannot be combined with --reverse.
See also <a href="git-reflog.html">git-reflog(1)</a>.
</p>
</dd>
<dt>
--decorate
</dt>
<dd>
<p>
Print out the ref names of any commits that are shown.
</p>
</dd>
<dt>
--full-diff
</dt>
<dd>
<p>
Without this flag, "git log -p &lt;paths&gt;&#8230;" shows commits that
touch the specified paths, and diffs about the same specified
paths. With this, the full diff is shown for commits that touch
the specified paths; this means that "&lt;paths&gt;&#8230;" limits only
commits, and doesn't limit diff for those commits.
</p>
</dd>
<dt>
--follow
</dt>
<dd>
<p>
Continue listing the history of a file beyond renames.
</p>
</dd>
<dt>
--log-size
</dt>
<dd>
<p>
Before the log message print out its size in bytes. Intended
mainly for porcelain tools consumption. If git is unable to
produce a valid value size is set to zero.
Note that only message is considered, if also a diff is shown
its size is not included.
</p>
</dd>
<dt>
&lt;paths&gt;&#8230;
</dt>
<dd>
<p>
Show only commits that affect the specified paths.
</p>
</dd>
</dl>
</div>
<h2>PRETTY FORMATS</h2>
<div class="sectionbody">
<p>If the commit is a merge, and if the pretty-format
is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is
inserted before the <em>Author:</em> line. This line begins with
"Merge: " and the sha1s of ancestral commits are printed,
separated by spaces. Note that the listed commits may not
necessarily be the list of the <strong>direct</strong> parent commits if you
have limited your view of history: for example, if you are
only interested in changes related to a certain directory or
file.</p>
<p>Here are some additional details for each format:</p>
<ul>
<li>
<p>
<em>oneline</em>
</p>
<div class="literalblock">
<div class="content">
<pre><tt>&lt;sha1&gt; &lt;title line&gt;</tt></pre>
</div></div>
<p>This is designed to be as compact as possible.</p>
</li>
<li>
<p>
<em>short</em>
</p>
<div class="literalblock">
<div class="content">
<pre><tt>commit &lt;sha1&gt;
Author: &lt;author&gt;</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>&lt;title line&gt;</tt></pre>
</div></div>
</li>
<li>
<p>
<em>medium</em>
</p>
<div class="literalblock">
<div class="content">
<pre><tt>commit &lt;sha1&gt;
Author: &lt;author&gt;
Date: &lt;date&gt;</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>&lt;title line&gt;</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>&lt;full commit message&gt;</tt></pre>
</div></div>
</li>
<li>
<p>
<em>full</em>
</p>
<div class="literalblock">
<div class="content">
<pre><tt>commit &lt;sha1&gt;
Author: &lt;author&gt;
Commit: &lt;committer&gt;</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>&lt;title line&gt;</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>&lt;full commit message&gt;</tt></pre>
</div></div>
</li>
<li>
<p>
<em>fuller</em>
</p>
<div class="literalblock">
<div class="content">
<pre><tt>commit &lt;sha1&gt;
Author: &lt;author&gt;
AuthorDate: &lt;date &amp; time&gt;
Commit: &lt;committer&gt;
CommitDate: &lt;date &amp; time&gt;</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>&lt;title line&gt;</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>&lt;full commit message&gt;</tt></pre>
</div></div>
</li>
<li>
<p>
<em>email</em>
</p>
<div class="literalblock">
<div class="content">
<pre><tt>From &lt;sha1&gt; &lt;date&gt;
From: &lt;author&gt;
Date: &lt;date &amp; time&gt;
Subject: [PATCH] &lt;title line&gt;</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>&lt;full commit message&gt;</tt></pre>
</div></div>
</li>
<li>
<p>
<em>raw</em>
</p>
<p>The <em>raw</em> format shows the entire commit exactly as
stored in the commit object. Notably, the SHA1s are
displayed in full, regardless of whether --abbrev or
--no-abbrev are used, and <em>parents</em> information show the
true parent commits, without taking grafts nor history
simplification into account.</p>
</li>
<li>
<p>
<em>format:</em>
</p>
<p>The <em>format:</em> format allows you to specify which information
you want to show. It works a little bit like printf format,
with the notable exception that you get a newline with <em>%n</em>
instead of <em>\n</em>.</p>
<p>E.g, <em>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;%n"</em>
would show something like this:</p>
<div class="listingblock">
<div class="content">
<pre><tt>The author of fe6e0ee was Junio C Hamano, 23 hours ago
The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;
</tt></pre>
</div></div>
<p>The placeholders are:</p>
<ul>
<li>
<p>
<em>%H</em>: commit hash
</p>
</li>
<li>
<p>
<em>%h</em>: abbreviated commit hash
</p>
</li>
<li>
<p>
<em>%T</em>: tree hash
</p>
</li>
<li>
<p>
<em>%t</em>: abbreviated tree hash
</p>
</li>
<li>
<p>
<em>%P</em>: parent hashes
</p>
</li>
<li>
<p>
<em>%p</em>: abbreviated parent hashes
</p>
</li>
<li>
<p>
<em>%an</em>: author name
</p>
</li>
<li>
<p>
<em>%ae</em>: author email
</p>
</li>
<li>
<p>
<em>%ad</em>: author date
</p>
</li>
<li>
<p>
<em>%aD</em>: author date, RFC2822 style
</p>
</li>
<li>
<p>
<em>%ar</em>: author date, relative
</p>
</li>
<li>
<p>
<em>%at</em>: author date, UNIX timestamp
</p>
</li>
<li>
<p>
<em>%ai</em>: author date, ISO 8601 format
</p>
</li>
<li>
<p>
<em>%cn</em>: committer name
</p>
</li>
<li>
<p>
<em>%ce</em>: committer email
</p>
</li>
<li>
<p>
<em>%cd</em>: committer date
</p>
</li>
<li>
<p>
<em>%cD</em>: committer date, RFC2822 style
</p>
</li>
<li>
<p>
<em>%cr</em>: committer date, relative
</p>
</li>
<li>
<p>
<em>%ct</em>: committer date, UNIX timestamp
</p>
</li>
<li>
<p>
<em>%ci</em>: committer date, ISO 8601 format
</p>
</li>
<li>
<p>
<em>%e</em>: encoding
</p>
</li>
<li>
<p>
<em>%s</em>: subject
</p>
</li>
<li>
<p>
<em>%b</em>: body
</p>
</li>
<li>
<p>
<em>%Cred</em>: switch color to red
</p>
</li>
<li>
<p>
<em>%Cgreen</em>: switch color to green
</p>
</li>
<li>
<p>
<em>%Cblue</em>: switch color to blue
</p>
</li>
<li>
<p>
<em>%Creset</em>: reset color
</p>
</li>
<li>
<p>
<em>%m</em>: left, right or boundary mark
</p>
</li>
<li>
<p>
<em>%n</em>: newline
</p>
</li>
</ul>
</li>
</ul>
</div>
<h2>Generating patches with -p</h2>
<div class="sectionbody">
<p>When "git-diff-index", "git-diff-tree", or "git-diff-files" are run
with a <em>-p</em> option, "git diff" without the <em>--raw</em> option, or
"git log" with the "-p" option, they
do not produce the output described above; instead they produce a
patch file. You can customize the creation of such patches via the
GIT_EXTERNAL_DIFF and the GIT_DIFF_OPTS environment variables.</p>
<p>What the -p option produces is slightly different from the traditional
diff format.</p>
<ol>
<li>
<p>
It is preceded with a "git diff" header, that looks like
this:
</p>
<div class="literalblock">
<div class="content">
<pre><tt>diff --git a/file1 b/file2</tt></pre>
</div></div>
<p>The <tt>a/</tt> and <tt>b/</tt> filenames are the same unless rename/copy is
involved. Especially, even for a creation or a deletion,
<tt>/dev/null</tt> is _not_ used in place of <tt>a/</tt> or <tt>b/</tt> filenames.</p>
<p>When rename/copy is involved, <tt>file1</tt> and <tt>file2</tt> show the
name of the source file of the rename/copy and the name of
the file that rename/copy produces, respectively.</p>
</li>
<li>
<p>
It is followed by one or more extended header lines:
</p>
<div class="literalblock">
<div class="content">
<pre><tt>old mode &lt;mode&gt;
new mode &lt;mode&gt;
deleted file mode &lt;mode&gt;
new file mode &lt;mode&gt;
copy from &lt;path&gt;
copy to &lt;path&gt;
rename from &lt;path&gt;
rename to &lt;path&gt;
similarity index &lt;number&gt;
dissimilarity index &lt;number&gt;
index &lt;hash&gt;..&lt;hash&gt; &lt;mode&gt;</tt></pre>
</div></div>
</li>
<li>
<p>
TAB, LF, double quote and backslash characters in pathnames
are represented as <tt>\t</tt>, <tt>\n</tt>, <tt>\"</tt> and <tt>\\</tt>, respectively.
If there is need for such substitution then the whole
pathname is put in double quotes.
</p>
</li>
</ol>
<p>The similarity index is the percentage of unchanged lines, and
the dissimilarity index is the percentage of changed lines. It
is a rounded down integer, followed by a percent sign. The
similarity index value of 100% is thus reserved for two equal
files, while 100% dissimilarity means that no line from the old
file made it into the new one.</p>
</div>
<h2>combined diff format</h2>
<div class="sectionbody">
<p>"git-diff-tree", "git-diff-files" and "git-diff" can take <em>-c</em> or
<em>--cc</em> option to produce <em>combined diff</em>. For showing a merge commit
with "git log -p", this is the default format.
A <em>combined diff</em> format looks like this:</p>
<div class="listingblock">
<div class="content">
<pre><tt>diff --combined describe.c
index fabadb8,cc95eb0..4866510
--- a/describe.c
+++ b/describe.c
@@@ -98,20 -98,12 +98,20 @@@
return (a_date &gt; 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) &lt; 0)
+ usage(describe_usage);
+ cmit = lookup_commit_reference(sha1);
+ if (!cmit)
+ usage(describe_usage);
+
if (!initialized) {
initialized = 1;
for_each_ref(get_name);</tt></pre>
</div></div>
<ol>
<li>
<p>
It is preceded with a "git diff" header, that looks like
this (when <em>-c</em> option is used):
</p>
<div class="literalblock">
<div class="content">
<pre><tt>diff --combined file</tt></pre>
</div></div>
<p>or like this (when <em>--cc</em> option is used):</p>
<div class="literalblock">
<div class="content">
<pre><tt>diff --c file</tt></pre>
</div></div>
</li>
<li>
<p>
It is followed by one or more extended header lines
(this example shows a merge with two parents):
</p>
<div class="literalblock">
<div class="content">
<pre><tt>index &lt;hash&gt;,&lt;hash&gt;..&lt;hash&gt;
mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;
new file mode &lt;mode&gt;
deleted file mode &lt;mode&gt;,&lt;mode&gt;</tt></pre>
</div></div>
<p>The <tt>mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;</tt> line appears only if at least one of
the &lt;mode&gt; is different from the rest. Extended headers with
information about detected contents movement (renames and
copying detection) are designed to work with diff of two
&lt;tree-ish&gt; and are not used by combined diff format.</p>
</li>
<li>
<p>
It is followed by two-line from-file/to-file header
</p>
<div class="literalblock">
<div class="content">
<pre><tt>--- a/file
+++ b/file</tt></pre>
</div></div>
<p>Similar to two-line header for traditional <em>unified</em> diff
format, <tt>/dev/null</tt> is used to signal created or deleted
files.</p>
</li>
<li>
<p>
Chunk header format is modified to prevent people from
accidentally feeding it to <tt>patch -p1</tt>. Combined diff format
was created for review of merge commit changes, and was not
meant for apply. The change is similar to the change in the
extended <em>index</em> header:
</p>
<div class="literalblock">
<div class="content">
<pre><tt>@@@ &lt;from-file-range&gt; &lt;from-file-range&gt; &lt;to-file-range&gt; @@@</tt></pre>
</div></div>
<p>There are (number of parents + 1) <tt>@</tt> characters in the chunk
header for combined diff format.</p>
</li>
</ol>
<p>Unlike the traditional <em>unified</em> diff format, which shows two
files A and B with a single column that has <tt>-</tt> (minus &#8212;
appears in A but removed in B), <tt>+</tt> (plus &#8212; missing in A but
added to B), or <tt>" "</tt> (space &#8212; unchanged) prefix, this format
compares two or more files file1, file2,&#8230; with one file X, and
shows how X differs from each of fileN. One column for each of
fileN is prepended to the output line to note how X's line is
different from it.</p>
<p>A <tt>-</tt> character in the column N means that the line appears in
fileN but it does not appear in the result. A <tt>+</tt> character
in the column N means that the line appears in the last file,
and fileN does not have that line (in other words, the line was
added, from the point of view of that parent).</p>
<p>In the above example output, the function signature was changed
from both files (hence two <tt>-</tt> removals from both file1 and
file2, plus <tt>++</tt> to mean one line that was added does not appear
in either file1 nor file2). Also two other lines are the same
from file1 but do not appear in file2 (hence prefixed with <tt> +</tt>).</p>
<p>When shown by <tt>git diff-tree -c</tt>, it compares the parents of a
merge commit with the merge result (i.e. file1..fileN are the
parents). When shown by <tt>git diff-files -c</tt>, it compares the
two unresolved merge parents with the working tree file
(i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka
"their version").</p>
</div>
<h2>Examples</h2>
<div class="sectionbody">
<dl>
<dt>
git log --no-merges
</dt>
<dd>
<p>
Show the whole commit history, but skip any merges
</p>
</dd>
<dt>
git log v2.6.12.. include/scsi drivers/scsi
</dt>
<dd>
<p>
Show all commits since version <em>v2.6.12</em> that changed any file
in the include/scsi or drivers/scsi subdirectories
</p>
</dd>
<dt>
git log --since="2 weeks ago" -- gitk
</dt>
<dd>
<p>
Show the changes during the last two weeks to the file <em>gitk</em>.
The "--" is necessary to avoid confusion with the <strong>branch</strong> named
<em>gitk</em>
</p>
</dd>
<dt>
git log --name-status release..test
</dt>
<dd>
<p>
Show the commits that are in the "test" branch but not yet
in the "release" branch, along with the list of paths
each commit modifies.
</p>
</dd>
<dt>
git log --follow builtin-rev-list.c
</dt>
<dd>
<p>
Shows the commits that changed builtin-rev-list.c, including
those commits that occurred before the file was given its
present name.
</p>
</dd>
</dl>
</div>
<h2>Discussion</h2>
<div class="sectionbody">
<p>At the core level, git is character encoding agnostic.</p>
<ul>
<li>
<p>
The pathnames recorded in the index and in the tree objects
are treated as uninterpreted sequences of non-NUL bytes.
What readdir(2) returns are what are recorded and compared
with the data git keeps track of, which in turn are expected
to be what lstat(2) and creat(2) accepts. There is no such
thing as pathname encoding translation.
</p>
</li>
<li>
<p>
The contents of the blob objects are uninterpreted sequence
of bytes. There is no encoding translation at the core
level.
</p>
</li>
<li>
<p>
The commit log messages are uninterpreted sequence of non-NUL
bytes.
</p>
</li>
</ul>
<p>Although we encourage that the commit log messages are encoded
in UTF-8, both the core and git Porcelain are designed not to
force UTF-8 on projects. If all participants of a particular
project find it more convenient to use legacy encodings, git
does not forbid it. However, there are a few things to keep in
mind.</p>
<ol>
<li>
<p>
<tt>git-commit-tree</tt> (hence, <tt>git-commit</tt> which uses it) issues
a warning if the commit log message given to it does not look
like a valid UTF-8 string, unless you explicitly say your
project uses a legacy encoding. The way to say this is to
have i18n.commitencoding in <tt>.git/config</tt> file, like this:
</p>
<div class="listingblock">
<div class="content">
<pre><tt>[i18n]
commitencoding = ISO-8859-1</tt></pre>
</div></div>
<p>Commit objects created with the above setting record the value
of <tt>i18n.commitencoding</tt> in its <tt>encoding</tt> header. This is to
help other people who look at them later. Lack of this header
implies that the commit log message is encoded in UTF-8.</p>
</li>
<li>
<p>
<tt>git-log</tt>, <tt>git-show</tt> and friends looks at the <tt>encoding</tt>
header of a commit object, and tries to re-code the log
message into UTF-8 unless otherwise specified. You can
specify the desired output encoding with
<tt>i18n.logoutputencoding</tt> in <tt>.git/config</tt> file, like this:
</p>
<div class="listingblock">
<div class="content">
<pre><tt>[i18n]
logoutputencoding = ISO-8859-1</tt></pre>
</div></div>
<p>If you do not have this configuration variable, the value of
<tt>i18n.commitencoding</tt> is used instead.</p>
</li>
</ol>
<p>Note that we deliberately chose not to re-code the commit log
message when a commit is made to force UTF-8 at the commit
object level, because re-coding to UTF-8 is not necessarily a
reversible operation.</p>
</div>
<h2>Author</h2>
<div class="sectionbody">
<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>
</div>
<h2>Documentation</h2>
<div class="sectionbody">
<p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
</div>
<h2>GIT</h2>
<div class="sectionbody">
<p>Part of the <a href="git.html">git(7)</a> suite</p>
</div>
<div id="footer">
<div id="footer-text">
Last updated 07-Jan-2008 07:50:27 UTC
</div>
</div>
</body>
</html>