unpack-trees.c: assume submodules are clean during check-out
[gitweb.git] / Documentation / git-stash.txt
index b7d263d6501d023ab1fff6016de5c0a4ed8dd80c..17121ade56c317d974d537fa3aa3c2b5f116e502 100644 (file)
@@ -8,12 +8,13 @@ git-stash - Stash the changes in a dirty working directory away
 SYNOPSIS
 --------
 [verse]
-'git-stash' (save | list | show [<stash>] | apply [<stash>] | clear)
+'git-stash' (list | show [<stash>] | apply [<stash>] | clear)
+'git-stash' [save] [message...]
 
 DESCRIPTION
 -----------
 
-Use 'git-stash save' when you want to record the current state of the
+Use 'git-stash' when you want to record the current state of the
 working directory and the index, but want to go back to a clean
 working directory.  The command saves your local modifications away
 and reverts the working directory to match the `HEAD` commit.
@@ -22,7 +23,9 @@ The modifications stashed away by this command can be listed with
 `git-stash list`, inspected with `git-stash show`, and restored
 (potentially on top of a different commit) with `git-stash apply`.
 Calling git-stash without any arguments is equivalent to `git-stash
-list`.
+save`.  A stash is by default listed as "WIP on 'branchname' ...", but
+you can give a more descriptive message on the command line when
+you create one.
 
 The latest stash you created is stored in `$GIT_DIR/refs/stash`; older
 stashes are found in the reflog of this reference and can be named using
@@ -36,7 +39,8 @@ OPTIONS
 save::
 
        Save your local modifications to a new 'stash', and run `git-reset
-       --hard` to revert them.
+       --hard` to revert them.  This is the default action when no
+       subcommand is given.
 
 list::
 
@@ -47,8 +51,8 @@ list::
        based on.
 +
 ----------------------------------------------------------------
-stash@{0}: submit: 6ebd0e2... Add git-stash
-stash@{1}: master: 9cc0589... Merge branch 'master' of gfi
+stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
+stash@{1}: On master: 9cc0589... Add git-stash
 ----------------------------------------------------------------
 
 show [<stash>]::
@@ -84,7 +88,7 @@ the `HEAD` commit.  The ancestry graph looks like this:
 
             .----W
            /    /
-     ...--H----I
+     -----H----I
 
 where `H` is the `HEAD` commit, `I` is a commit that records the state
 of the index, and `W` is a commit that records the state of the working