Add Git official document to help

[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-rerere.html.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
\r
<article lang="en" id="git-rerere(1)">\r
<articleinfo>\r
    <title>git-rerere(1)</title>\r
        <indexterm>\r
                <primary>git-rerere(1)</primary>\r
        </indexterm>\r
</articleinfo>\r
<simplesect id="_name">\r
<title>NAME</title>\r
<simpara>git-rerere - Reuse recorded resolution of conflicted merges</simpara>\r
</simplesect>\r
<simplesect id="_synopsis">\r
<title>SYNOPSIS</title>\r
<simpara><emphasis>git rerere</emphasis> [<emphasis>clear</emphasis>|<emphasis>diff</emphasis>|<emphasis>status</emphasis>|<emphasis>gc</emphasis>]</simpara>\r
</simplesect>\r
<simplesect id="_description">\r
<title>DESCRIPTION</title>\r
<simpara>In a workflow that employs relatively long lived topic branches,\r
the developer sometimes needs to resolve the same conflict over\r
and over again until the topic branches are done (either merged\r
to the "release" branch, or sent out and accepted upstream).</simpara>\r
<simpara>This command helps this process by recording conflicted\r
automerge results and corresponding hand-resolve results on the\r
initial manual merge, and later by noticing the same automerge\r
results and applying the previously recorded hand resolution.</simpara>\r
<note><simpara>You need to set the configuration variable rerere.enabled to\r
enable this command.</simpara></note>\r
</simplesect>\r
<simplesect id="_commands">\r
<title>COMMANDS</title>\r
<simpara>Normally, <emphasis>git-rerere</emphasis> is run without arguments or user-intervention.\r
However, it has several commands that allow it to interact with\r
its working state.</simpara>\r
<variablelist>\r
<varlistentry>\r
<term>\r
<emphasis>clear</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
This resets the metadata used by rerere if a merge resolution is to be\r
aborted.  Calling <emphasis>git-am [--skip|--abort]</emphasis> or <emphasis>git-rebase [--skip|--abort]</emphasis>\r
will automatically invoke this command.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>diff</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
This displays diffs for the current state of the resolution.  It is\r
useful for tracking what has changed while the user is resolving\r
conflicts.  Additional arguments are passed directly to the system\r
<emphasis>diff</emphasis> command installed in PATH.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>status</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
Like <emphasis>diff</emphasis>, but this only prints the filenames that will be tracked\r
for resolutions.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>gc</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
This command is used to prune records of conflicted merge that\r
occurred long time ago.  By default, conflicts older than 15\r
days that you have not recorded their resolution, and conflicts\r
older than 60 days, are pruned.  These are controlled with\r
<literal>gc.rerereunresolved</literal> and <literal>gc.rerereresolved</literal> configuration\r
variables.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
</simplesect>\r
<simplesect id="_discussion">\r
<title>DISCUSSION</title>\r
<simpara>When your topic branch modifies overlapping area that your\r
master branch (or upstream) touched since your topic branch\r
forked from it, you may want to test it with the latest master,\r
even before your topic branch is ready to be pushed upstream:</simpara>\r
<literallayout>              o---*---o topic\r
             /\r
    o---o---o---*---o---o master</literallayout>\r
<simpara>For such a test, you need to merge master and topic somehow.\r
One way to do it is to pull master into the topic branch:</simpara>\r
<literallayout>        $ git checkout topic\r
        $ git merge master\r
\r
              o---*---o---+ topic\r
             /           /\r
    o---o---o---*---o---o master</literallayout>\r
<simpara>The commits marked with <literal>*</literal> touch the same area in the same\r
file; you need to resolve the conflicts when creating the commit\r
marked with <literal>&#43;</literal>.  Then you can test the result to make sure your\r
work-in-progress still works with what is in the latest master.</simpara>\r
<simpara>After this test merge, there are two ways to continue your work\r
on the topic.  The easiest is to build on top of the test merge\r
commit <literal>&#43;</literal>, and when your work in the topic branch is finally\r
ready, pull the topic branch into master, and/or ask the\r
upstream to pull from you.  By that time, however, the master or\r
the upstream might have been advanced since the test merge <literal>&#43;</literal>,\r
in which case the final commit graph would look like this:</simpara>\r
<literallayout>        $ git checkout topic\r
        $ git merge master\r
        $ ... work on both topic and master branches\r
        $ git checkout master\r
        $ git merge topic\r
\r
              o---*---o---+---o---o topic\r
             /           /         \\r
    o---o---o---*---o---o---o---o---+ master</literallayout>\r
<simpara>When your topic branch is long-lived, however, your topic branch\r
would end up having many such "Merge from master" commits on it,\r
which would unnecessarily clutter the development history.\r
Readers of the Linux kernel mailing list may remember that Linus\r
complained about such too frequent test merges when a subsystem\r
maintainer asked to pull from a branch full of "useless merges".</simpara>\r
<simpara>As an alternative, to keep the topic branch clean of test\r
merges, you could blow away the test merge, and keep building on\r
top of the tip before the test merge:</simpara>\r
<literallayout>        $ git checkout topic\r
        $ git merge master\r
        $ git reset --hard HEAD^ ;# rewind the test merge\r
        $ ... work on both topic and master branches\r
        $ git checkout master\r
        $ git merge topic\r
\r
              o---*---o-------o---o topic\r
             /                     \\r
    o---o---o---*---o---o---o---o---+ master</literallayout>\r
<simpara>This would leave only one merge commit when your topic branch is\r
finally ready and merged into the master branch.  This merge\r
would require you to resolve the conflict, introduced by the\r
commits marked with <literal>*</literal>.  However, often this conflict is the\r
same conflict you resolved when you created the test merge you\r
blew away.  <emphasis>git-rerere</emphasis> command helps you to resolve this final\r
conflicted merge using the information from your earlier hand\r
resolve.</simpara>\r
<simpara>Running the <emphasis>git-rerere</emphasis> command immediately after a conflicted\r
automerge records the conflicted working tree files, with the\r
usual conflict markers <literal>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</literal>, <literal>=======</literal>, and <literal>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</literal> in\r
them.  Later, after you are done resolving the conflicts,\r
running <emphasis>git-rerere</emphasis> again records the resolved state of these\r
files.  Suppose you did this when you created the test merge of\r
master into the topic branch.</simpara>\r
<simpara>Next time, running <emphasis>git-rerere</emphasis> after seeing a conflicted\r
automerge, if the conflict is the same as the earlier one\r
recorded, it is noticed and a three-way merge between the\r
earlier conflicted automerge, the earlier manual resolution, and\r
the current conflicted automerge is performed by the command.\r
If this three-way merge resolves cleanly, the result is written\r
out to your working tree file, so you would not have to manually\r
resolve it.  Note that <emphasis>git-rerere</emphasis> leaves the index file alone,\r
so you still need to do the final sanity checks with <literal>git diff</literal>\r
(or <literal>git diff -c</literal>) and <emphasis>git-add</emphasis> when you are satisfied.</simpara>\r
<simpara>As a convenience measure, <emphasis>git-merge</emphasis> automatically invokes\r
<emphasis>git-rerere</emphasis> when it exits with a failed automerge, which\r
records it if it is a new conflict, or reuses the earlier hand\r
resolve when it is not.  <emphasis>git-commit</emphasis> also invokes <emphasis>git-rerere</emphasis>\r
when recording a merge result.  What this means is that you do\r
not have to do anything special yourself (Note: you still have\r
to set the config variable rerere.enabled to enable this command).</simpara>\r
<simpara>In our example, when you did the test merge, the manual\r
resolution is recorded, and it will be reused when you do the\r
actual merge later with updated master and topic branch, as long\r
as the earlier resolution is still applicable.</simpara>\r
<simpara>The information <emphasis>git-rerere</emphasis> records is also used when running\r
<emphasis>git-rebase</emphasis>.  After blowing away the test merge and continuing\r
development on the topic branch:</simpara>\r
<literallayout>              o---*---o-------o---o topic\r
             /\r
    o---o---o---*---o---o---o---o   master\r
\r
        $ git rebase master topic\r
\r
                                  o---*---o-------o---o topic\r
                                 /\r
    o---o---o---*---o---o---o---o   master</literallayout>\r
<simpara>you could run <literal>git rebase master topic</literal>, to keep yourself\r
up-to-date even before your topic is ready to be sent upstream.\r
This would result in falling back to three-way merge, and it\r
would conflict the same way the test merge you resolved earlier.\r
<emphasis>git-rerere</emphasis> is run by <emphasis>git-rebase</emphasis> to help you resolve this\r
conflict.</simpara>\r
</simplesect>\r
<simplesect id="_author">\r
<title>Author</title>\r
<simpara>Written by Junio C Hamano &lt;<ulink url="mailto:gitster@pobox.com">gitster@pobox.com</ulink>&gt;</simpara>\r
</simplesect>\r
<simplesect id="_git">\r
<title>GIT</title>\r
<simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
</simplesect>\r
</article>\r