git-stash: add new 'drop' subcommand

[git.git] / Documentation / git-stash.txt

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 5723bb06f087f62e463b110686b850987103140d..f50c24ce9aa1c1d2937f3eb8ee27b349a6f0a3ba 100644 (file)
--- 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]
 SYNOPSIS
 --------
 [verse]

-'git-stash' (list | show [<stash>] | apply [<stash>] | clear)
-'git-stash' [save] [message...]
+'git-stash' (list | show [<stash>] | apply [<stash>] | clear | drop [<stash>])
+'git-stash' [save [<message>]]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -36,13 +36,14 @@ is also possible).
 OPTIONS
 -------
 
 OPTIONS
 -------
 

-save::
+save [<message>]::

 
        Save your local modifications to a new 'stash', and run `git-reset
        --hard` to revert them.  This is the default action when no
 
        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 <message> part is optional and gives
+       the description along with the stashed state.

 
 

-list::
+list [<options>]::

 
        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
 
        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,10 +55,13 @@ list::
 stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
 stash@{1}: On master: 9cc0589... Add git-stash
 ----------------------------------------------------------------
 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 [<stash>]::
 
 
 show [<stash>]::
 

-       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 `<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
        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


@@ -81,6 +85,11 @@ clear::
        Remove all the stashed states. Note that those states will then
        be subject to pruning, and may be difficult or impossible to recover.
 
        Remove all the stashed states. Note that those states will then
        be subject to pruning, and may be difficult or impossible to recover.
 

+drop [<stash>]::
+
+       Remove a single stashed state from the stash list. When no `<stash>`
+       is given, it removes the latest one. i.e. `stash@\{0}`
+

 
 DISCUSSION
 ----------
 
 DISCUSSION
 ----------


@@ -156,10 +165,10 @@ $ git stash apply
 
 SEE ALSO
 --------
 
 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
 ------
 
 AUTHOR
 ------


@@ -167,4 +176,4 @@ Written by Nanako Shiraishi <nanako3@bluebottle.com>
 
 GIT
 ---
 
 GIT
 ---

-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite