Doc: Fix ID naming
[TortoiseGit.git] / doc / source / en / TortoiseGit / tgit_dug / dug_stash.xml
bloba2d92f01f4abb42c1b915a585734ca7a08e98ee1
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE sect1 SYSTEM "../../../dtd/dblite.dtd">\r
3 <sect1 id="tgit-dug-stash">\r
4         <?dbhh topicname="HIDD_STASH"?>\r
5         <title>Stash Changes</title>\r
6         <indexterm>\r
7                 <primary>stash</primary>\r
8         </indexterm>\r
9         <para>\r
10                 When you want to record the current state of the working directory and the index,\r
11                 but want to go back to a clean working directory,\r
12                 <action>right click</action> on a folder to pop up the context menu and then select\r
13                 the command\r
14                 <menuchoice>\r
15                         <guimenu>TortoiseGit</guimenu>\r
16                         <guimenuitem>Stash Save</guimenuitem>\r
17                 </menuchoice>\r
18                 A dialog will pop up where you can optionally enter a message for this state:\r
19                 <figure id="tgit-dug-stash-dia-1">\r
20                         <title>Stash save dialog</title>\r
21                         <graphic fileref="../images/stash.png"/>\r
22                 </figure>\r
23                 You can also select <guilabel>include untracked</guilabel>, to stash untracked files away, too.\r
24                 To stash all files away, including ignored files in addition to the untracked files, select <guilabel>--all</guilabel>.\r
25         </para>\r
26         <para>\r
27                 When TortoiseGit detects that a stashed changes exist, the context menu will be extended:\r
28                 <figure id="tgit-dug-stash-dia-2">\r
29                         <title>(un)stash options</title>\r
30                         <graphic fileref="../images/ContextMenuStash.png"/>\r
31                 </figure>\r
32                 The stash is implemented as a stack. <guimenuitem>Stash Apply</guimenuitem> will apply the changes of the latest stash\r
33                 to your working tree. <guimenuitem>Stash Pop</guimenuitem> does the same, but will remove the latest stash from the stack\r
34                 after applying it. <guimenuitem>Stash Save</guimenuitem> is still possible and will stash the current changes of the working\r
35                 copy to the top of the stack. <guimenuitem>Stash List</guimenuitem> provides an overview of all the whole stash stack. You\r
36                 can also remove and view the stashed changes there (similarly to the <xref linkend="tgit-dug-showlog"/> and <xref linkend="tgit-dug-reflog"/>).\r
37         </para>\r
38         <para>\r
39                 You can find more information at <xref linkend="git-stash(1)"/>\r
40         </para>\r
41 </sect1>\r