X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-stash.txt;h=f50c24ce9aa1c1d2937f3eb8ee27b349a6f0a3ba;hb=e25d5f9c82ef6a676de616bd28751cdfbcd53b15;hp=05f40cff6cbaa9d8a08176a5a601b7e43d17e5bf;hpb=941fd1c041204f30279c175ca9b7252ffcb52ba2;p=git.git diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 05f40cff6..f50c24ce9 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -8,8 +8,8 @@ git-stash - Stash the changes in a dirty working directory away SYNOPSIS -------- [verse] -'git-stash' (list | show [] | apply [] | clear) -'git-stash' [save] [message...] +'git-stash' (list | show [] | apply [] | clear | drop []) +'git-stash' [save []] DESCRIPTION ----------- @@ -36,13 +36,14 @@ is also possible). OPTIONS ------- -save:: +save []:: 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. + subcommand is given. The part is optional and gives + the description along with the stashed state. -list:: +list []:: List the stashes that you currently have. Each 'stash' is listed with its name (e.g. `stash@\{0}` is the latest stash, `stash@\{1}` is @@ -54,16 +55,19 @@ list:: 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. show []:: - Show the changes recorded in the stash as a diff between the the + Show the changes recorded in the stash as a diff between the stashed state and its original parent. When no `` 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 -p stash@\{1}` to view the second most recent stash in patch form). -apply []:: +apply [--index] []:: Restore the changes recorded in the stash on top of the current working tree state. When no `` is given, applies the latest @@ -71,11 +75,21 @@ apply []:: + This operation can fail with conflicts; you need to resolve them by hand in the working tree. ++ +If the `--index` option is used, then tries to reinstate not only the working +tree's changes, but also the index's ones. However, this can fail, when you +have conflicts (which are stored in the index, where you therefore can no +longer apply the changes as they were originally). clear:: Remove all the stashed states. Note that those states will then be subject to pruning, and may be difficult or impossible to recover. +drop []:: + + Remove a single stashed state from the stash list. When no `` + is given, it removes the latest one. i.e. `stash@\{0}` + DISCUSSION ---------- @@ -151,10 +165,10 @@ $ git stash apply SEE ALSO -------- -gitlink:git-checkout[1], -gitlink:git-commit[1], -gitlink:git-reflog[1], -gitlink:git-reset[1] +linkgit:git-checkout[1], +linkgit:git-commit[1], +linkgit:git-reflog[1], +linkgit:git-reset[1] AUTHOR ------ @@ -162,4 +176,4 @@ Written by Nanako Shiraishi GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite