updated git doc

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

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
\r
<article lang="en" id="git-stash(1)">\r
<articleinfo>\r
    <title>git-stash(1)</title>\r
<indexterm>\r
<primary>git-stash(1)</primary>\r
</indexterm>\r
</articleinfo>\r
<simplesect id="_name">\r
<title>NAME</title>\r
<simpara>git-stash - Stash the changes in a dirty working directory away</simpara>\r
</simplesect>\r
<simplesect id="_synopsis">\r
<title>SYNOPSIS</title>\r
<blockquote>\r
<literallayout><emphasis>git stash</emphasis> list [&lt;options&gt;]\r
<emphasis>git stash</emphasis> show [&lt;stash&gt;]\r
<emphasis>git stash</emphasis> drop [-q|--quiet] [&lt;stash&gt;]\r
<emphasis>git stash</emphasis> ( pop | apply ) [--index] [-q|--quiet] [&lt;stash&gt;]\r
<emphasis>git stash</emphasis> branch &lt;branchname&gt; [&lt;stash&gt;]\r
<emphasis>git stash</emphasis> [save [--patch] [-k|--[no-]keep-index] [-q|--quiet]\r
             [-u|--include-untracked] [-a|--all] [&lt;message&gt;]]\r
<emphasis>git stash</emphasis> clear\r
<emphasis>git stash</emphasis> create</literallayout>\r
</blockquote>\r
</simplesect>\r
<simplesect id="_description">\r
<title>DESCRIPTION</title>\r
<simpara>Use <emphasis>git stash</emphasis> when you want to record the current state of the\r
working directory and the index, but want to go back to a clean\r
working directory.  The command saves your local modifications away\r
and reverts the working directory to match the <emphasis>HEAD</emphasis> commit.</simpara>\r
<simpara>The modifications stashed away by this command can be listed with\r
<emphasis>git stash list</emphasis>, inspected with <emphasis>git stash show</emphasis>, and restored\r
(potentially on top of a different commit) with <emphasis>git stash apply</emphasis>.\r
Calling <emphasis>git stash</emphasis> without any arguments is equivalent to <emphasis>git stash save</emphasis>.\r
A stash is by default listed as "WIP on <emphasis>branchname</emphasis> &#8230;", but\r
you can give a more descriptive message on the command line when\r
you create one.</simpara>\r
<simpara>The latest stash you created is stored in <emphasis>refs/stash</emphasis>; older\r
stashes are found in the reflog of this reference and can be named using\r
the usual reflog syntax (e.g. <emphasis>stash@{0}</emphasis> is the most recently\r
created stash, <emphasis>stash@{1}</emphasis> is the one before it, <emphasis>stash@{2.hours.ago}</emphasis>\r
is also possible).</simpara>\r
</simplesect>\r
<simplesect id="_options">\r
<title>OPTIONS</title>\r
<variablelist>\r
<varlistentry>\r
<term>\r
save [-p|--patch] [--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [&lt;message&gt;]\r
</term>\r
<listitem>\r
<simpara>\r
        Save your local modifications to a new <emphasis>stash</emphasis>, and run <emphasis>git reset\r
        --hard</emphasis> to revert them.  The &lt;message&gt; part is optional and gives\r
        the description along with the stashed state.  For quickly making\r
        a snapshot, you can omit <emphasis>both</emphasis> "save" and &lt;message&gt;, but giving\r
        only &lt;message&gt; does not trigger this action to prevent a misspelled\r
        subcommand from making an unwanted stash.\r
</simpara>\r
<simpara>If the <emphasis>--keep-index</emphasis> option is used, all changes already added to the\r
index are left intact.</simpara>\r
<simpara>If the <emphasis>--include-untracked</emphasis> option is used, all untracked files are also\r
stashed and then cleaned up with <emphasis>git clean</emphasis>, leaving the working directory\r
in a very clean state. If the <emphasis>--all</emphasis> option is used instead then the\r
ignored files are stashed and cleaned in addition to the untracked files.</simpara>\r
<simpara>With <emphasis>--patch</emphasis>, you can interactively select hunks from the diff\r
between HEAD and the working tree to be stashed.  The stash entry is\r
constructed such that its index state is the same as the index state\r
of your repository, and its worktree contains only the changes you\r
selected interactively.  The selected changes are then rolled back\r
from your worktree. See the Interactive Mode section of\r
<xref linkend="git-add(1)" /> to learn how to operate the <emphasis>--patch</emphasis> mode.</simpara>\r
<simpara>The <emphasis>--patch</emphasis> option implies <emphasis>--keep-index</emphasis>.  You can use\r
<emphasis>--no-keep-index</emphasis> to override this.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
list [&lt;options&gt;]\r
</term>\r
<listitem>\r
<simpara>\r
        List the stashes that you currently have.  Each <emphasis>stash</emphasis> is listed\r
        with its name (e.g. <emphasis>stash@{0}</emphasis> is the latest stash, <emphasis>stash@{1}</emphasis> is\r
        the one before, etc.), the name of the branch that was current when the\r
        stash was made, and a short description of the commit the stash was\r
        based on.\r
</simpara>\r
<screen>stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation\r
stash@{1}: On master: 9cc0589... Add git-stash</screen>\r
<simpara>The command takes options applicable to the <emphasis>git log</emphasis>\r
command to control what is shown and how. See <xref linkend="git-log(1)" />.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
show [&lt;stash&gt;]\r
</term>\r
<listitem>\r
<simpara>\r
        Show the changes recorded in the stash as a diff between the\r
        stashed state and its original parent. When no <emphasis>&lt;stash&gt;</emphasis> is given,\r
        shows the latest one. By default, the command shows the diffstat, but\r
        it will accept any format known to <emphasis>git diff</emphasis> (e.g., <emphasis>git stash show\r
        -p stash@{1}</emphasis> to view the second most recent stash in patch form).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pop [--index] [-q|--quiet] [&lt;stash&gt;]\r
</term>\r
<listitem>\r
<simpara>\r
        Remove a single stashed state from the stash list and apply it\r
        on top of the current working tree state, i.e., do the inverse\r
        operation of <emphasis>git stash save</emphasis>. The working directory must\r
        match the index.\r
</simpara>\r
<simpara>Applying the state can fail with conflicts; in this case, it is not\r
removed from the stash list. You need to resolve the conflicts by hand\r
and call <emphasis>git stash drop</emphasis> manually afterwards.</simpara>\r
<simpara>If the <emphasis>--index</emphasis> option is used, then tries to reinstate not only the working\r
tree's changes, but also the index's ones. However, this can fail, when you\r
have conflicts (which are stored in the index, where you therefore can no\r
longer apply the changes as they were originally).</simpara>\r
<simpara>When no <emphasis>&lt;stash&gt;</emphasis> is given, <emphasis>stash@{0}</emphasis> is assumed, otherwise <emphasis>&lt;stash&gt;</emphasis> must\r
be a reference of the form <emphasis>stash@{&lt;revision&gt;}</emphasis>.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
apply [--index] [-q|--quiet] [&lt;stash&gt;]\r
</term>\r
<listitem>\r
<simpara>\r
        Like <emphasis>pop</emphasis>, but do not remove the state from the stash list. Unlike <emphasis>pop</emphasis>,\r
        <emphasis>&lt;stash&gt;</emphasis> may be any commit that looks like a commit created by\r
        <emphasis>stash save</emphasis> or <emphasis>stash create</emphasis>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
branch &lt;branchname&gt; [&lt;stash&gt;]\r
</term>\r
<listitem>\r
<simpara>\r
        Creates and checks out a new branch named <emphasis>&lt;branchname&gt;</emphasis> starting from\r
        the commit at which the <emphasis>&lt;stash&gt;</emphasis> was originally created, applies the\r
        changes recorded in <emphasis>&lt;stash&gt;</emphasis> to the new working tree and index.\r
        If that succeeds, and <emphasis>&lt;stash&gt;</emphasis> is a reference of the form\r
        <emphasis>stash@{&lt;revision&gt;}</emphasis>, it then drops the <emphasis>&lt;stash&gt;</emphasis>. When no <emphasis>&lt;stash&gt;</emphasis>\r
        is given, applies the latest one.\r
</simpara>\r
<simpara>This is useful if the branch on which you ran <emphasis>git stash save</emphasis> has\r
changed enough that <emphasis>git stash apply</emphasis> fails due to conflicts. Since\r
the stash is applied on top of the commit that was HEAD at the time\r
<emphasis>git stash</emphasis> was run, it restores the originally stashed state with\r
no conflicts.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
clear\r
</term>\r
<listitem>\r
<simpara>\r
        Remove all the stashed states. Note that those states will then\r
        be subject to pruning, and may be impossible to recover (see\r
        <emphasis>Examples</emphasis> below for a possible strategy).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
drop [-q|--quiet] [&lt;stash&gt;]\r
</term>\r
<listitem>\r
<simpara>\r
        Remove a single stashed state from the stash list. When no <emphasis>&lt;stash&gt;</emphasis>\r
        is given, it removes the latest one. i.e. <emphasis>stash@{0}</emphasis>, otherwise\r
        <emphasis>&lt;stash&gt;</emphasis> must a valid stash log reference of the form\r
        <emphasis>stash@{&lt;revision&gt;}</emphasis>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
create\r
</term>\r
<listitem>\r
<simpara>\r
        Create a stash (which is a regular commit object) and return its\r
        object name, without storing it anywhere in the ref namespace.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
</simplesect>\r
<simplesect id="_discussion">\r
<title>DISCUSSION</title>\r
<simpara>A stash is represented as a commit whose tree records the state of the\r
working directory, and its first parent is the commit at <emphasis>HEAD</emphasis> when\r
the stash was created.  The tree of the second parent records the\r
state of the index when the stash is made, and it is made a child of\r
the <emphasis>HEAD</emphasis> commit.  The ancestry graph looks like this:</simpara>\r
<literallayout class="monospaced">       .----W\r
      /    /\r
-----H----I</literallayout>\r
<simpara>where <emphasis>H</emphasis> is the <emphasis>HEAD</emphasis> commit, <emphasis>I</emphasis> is a commit that records the state\r
of the index, and <emphasis>W</emphasis> is a commit that records the state of the working\r
tree.</simpara>\r
</simplesect>\r
<simplesect id="_examples">\r
<title>EXAMPLES</title>\r
<variablelist>\r
<varlistentry>\r
<term>\r
Pulling into a dirty tree\r
</term>\r
<listitem>\r
<simpara>\r
When you are in the middle of something, you learn that there are\r
upstream changes that are possibly relevant to what you are\r
doing.  When your local changes do not conflict with the changes in\r
the upstream, a simple <emphasis>git pull</emphasis> will let you move forward.\r
</simpara>\r
<simpara>However, there are cases in which your local changes do conflict with\r
the upstream changes, and <emphasis>git pull</emphasis> refuses to overwrite your\r
changes.  In such a case, you can stash your changes away,\r
perform a pull, and then unstash, like this:</simpara>\r
<screen>$ git pull\r
 ...\r
file foobar not up to date, cannot merge.\r
$ git stash\r
$ git pull\r
$ git stash pop</screen>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
Interrupted workflow\r
</term>\r
<listitem>\r
<simpara>\r
When you are in the middle of something, your boss comes in and\r
demands that you fix something immediately.  Traditionally, you would\r
make a commit to a temporary branch to store your changes away, and\r
return to your original branch to make the emergency fix, like this:\r
</simpara>\r
<screen># ... hack hack hack ...\r
$ git checkout -b my_wip\r
$ git commit -a -m "WIP"\r
$ git checkout master\r
$ edit emergency fix\r
$ git commit -a -m "Fix in a hurry"\r
$ git checkout my_wip\r
$ git reset --soft HEAD^\r
# ... continue hacking ...</screen>\r
<simpara>You can use <emphasis>git stash</emphasis> to simplify the above, like this:</simpara>\r
<screen># ... hack hack hack ...\r
$ git stash\r
$ edit emergency fix\r
$ git commit -a -m "Fix in a hurry"\r
$ git stash pop\r
# ... continue hacking ...</screen>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
Testing partial commits\r
</term>\r
<listitem>\r
<simpara>\r
You can use <emphasis>git stash save --keep-index</emphasis> when you want to make two or\r
more commits out of the changes in the work tree, and you want to test\r
each change before committing:\r
</simpara>\r
<screen># ... hack hack hack ...\r
$ git add --patch foo            # add just first part to the index\r
$ git stash save --keep-index    # save all other changes to the stash\r
$ edit/build/test first part\r
$ git commit -m 'First part'     # commit fully tested change\r
$ git stash pop                  # prepare to work on all other changes\r
# ... repeat above five steps until one commit remains ...\r
$ edit/build/test remaining parts\r
$ git commit foo -m 'Remaining parts'</screen>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
Recovering stashes that were cleared/dropped erroneously\r
</term>\r
<listitem>\r
<simpara>\r
If you mistakenly drop or clear stashes, they cannot be recovered\r
through the normal safety mechanisms.  However, you can try the\r
following incantation to get a list of stashes that are still in your\r
repository, but not reachable any more:\r
</simpara>\r
<screen>git fsck --unreachable |\r
grep commit | cut -d\  -f3 |\r
xargs git log --merges --no-walk --grep=WIP</screen>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
</simplesect>\r
<simplesect id="_see_also">\r
<title>SEE ALSO</title>\r
<simpara><xref linkend="git-checkout(1)" />,\r
<xref linkend="git-commit(1)" />,\r
<xref linkend="git-reflog(1)" />,\r
<xref linkend="git-reset(1)" /></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