diff options
Diffstat (limited to 'Documentation/git-stash.txt')
| -rw-r--r-- | Documentation/git-stash.txt | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index baa4f55b48..9b6b911091 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -8,22 +8,22 @@ git-stash - Stash the changes in a dirty working directory away SYNOPSIS -------- [verse] -'git-stash' (list | show [<stash>] | apply [<stash>] | clear | drop [<stash>] | pop [<stash>]) -'git-stash' [save [<message>]] +'git stash' (list | show [<stash>] | apply [<stash>] | clear | drop [<stash>] | pop [<stash>]) +'git stash' [save [<message>]] DESCRIPTION ----------- -Use 'git-stash' 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. 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 -save`. A stash is by default listed as "WIP on 'branchname' ...", but +`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 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. @@ -38,7 +38,7 @@ OPTIONS save [<message>]:: - Save your local modifications to a new 'stash', and run `git-reset + Save your local modifications to a new 'stash', and run `git reset --hard` to revert them. This is the default action when no subcommand is given. The <message> part is optional and gives the description along with the stashed state. @@ -56,15 +56,15 @@ stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation stash@{1}: On master: 9cc0589... Add git-stash ---------------------------------------------------------------- + -The command takes options applicable to the linkgit:git-log[1] -command to control what is shown and how. +The command takes options applicable to the 'git-log' +command to control what is shown and how. See linkgit:git-log[1]. show [<stash>]:: Show the changes recorded in the stash as a diff between the stashed state and its original parent. When no `<stash>` is given, shows the latest one. By default, the command shows the diffstat, but - it will accept any format known to `git-diff` (e.g., `git-stash show + it will accept any format known to 'git-diff' (e.g., `git stash show -p stash@\{1}` to view the second most recent stash in patch form). apply [--index] [<stash>]:: @@ -158,7 +158,7 @@ $ git reset --soft HEAD^ ... continue hacking ... ---------------------------------------------------------------- + -You can use `git-stash` to simplify the above, like this: +You can use 'git-stash' to simplify the above, like this: + ---------------------------------------------------------------- ... hack hack hack ... |