summaryrefslogtreecommitdiff
path: root/Documentation/user-manual.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2007-08-03 22:22:59 (GMT)
committerJ. Bruce Fields <bfields@pig.linuxdev.us.dell.com>2007-08-05 21:45:47 (GMT)
commit7a7cc594ca294a58b6d7ae5aa50a65378538e875 (patch)
treefc1432be2807f75dcffc45629f1729a94e3fe342 /Documentation/user-manual.txt
parent0eb4f7cdf85273c88feb95c677a808cee9cfd859 (diff)
downloadgit-7a7cc594ca294a58b6d7ae5aa50a65378538e875.zip
git-7a7cc594ca294a58b6d7ae5aa50a65378538e875.tar.gz
git-7a7cc594ca294a58b6d7ae5aa50a65378538e875.tar.bz2
user-manual: mention git stash
Mention the git-stash command as a way to temporarily set aside work in progress. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
Diffstat (limited to 'Documentation/user-manual.txt')
-rw-r--r--Documentation/user-manual.txt32
1 files changed, 32 insertions, 0 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index c0820e9..9efe85c 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -1484,6 +1484,38 @@ $ git show HEAD^:path/to/file
which will display the given version of the file.
+[[interrupted-work]]
+Temporarily setting aside work in progress
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+While you are in the middle of working on something complicated, you
+find an unrelated but obvious and trivial bug. You would like to fix it
+before continuing. You can use gitlink:git-stash[1] to save the current
+state of your work, and after fixing the bug (or, optionally after doing
+so on a different branch and then coming back), unstash the
+work-in-progress changes.
+
+------------------------------------------------
+$ git stash "work in progress for foo feature"
+------------------------------------------------
+
+This command will save your changes away to the `stash`, and
+reset your working tree and the index to match the tip of your
+current branch. Then you can make your fix as usual.
+
+------------------------------------------------
+... edit and test ...
+$ git commit -a -m "blorpl: typofix"
+------------------------------------------------
+
+After that, you can go back to what you were working on with
+`git stash apply`:
+
+------------------------------------------------
+$ git stash apply
+------------------------------------------------
+
+
[[ensuring-good-performance]]
Ensuring good performance
-------------------------