Commit db37745e authored by Thomas Gummerer's avatar Thomas Gummerer Committed by Junio C Hamano

stash: replace "git stash save" with "git stash push" in the documentation

"git stash push" is the newer interface for creating a stash.  While we
are still keeping "git stash save" around for the time being, it's better
to point new users of "git stash" to the more modern (and more feature
rich) interface, instead of teaching them the older version that we
might want to phase out in the future.
Signed-off-by: default avatarThomas Gummerer <[email protected]>
Signed-off-by: default avatarJunio C Hamano <[email protected]>
parent 4843cdef
......@@ -33,7 +33,7 @@ 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`.
Calling `git stash` without any arguments is equivalent to `git stash push`.
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.
......@@ -118,7 +118,7 @@ pop [--index] [-q|--quiet] [<stash>]::
Remove a single stashed state from the stash list and apply it
on top of the current working tree state, i.e., do the inverse
operation of `git stash save`. The working directory must
operation of `git stash push`. The working directory must
match the index.
+
Applying the state can fail with conflicts; in this case, it is not
......@@ -137,7 +137,7 @@ apply [--index] [-q|--quiet] [<stash>]::
Like `pop`, but do not remove the state from the stash list. Unlike `pop`,
`<stash>` may be any commit that looks like a commit created by
`stash save` or `stash create`.
`stash push` or `stash create`.
branch <branchname> [<stash>]::
......@@ -148,7 +148,7 @@ branch <branchname> [<stash>]::
`[email protected]{<revision>}`, it then drops the `<stash>`. When no `<stash>`
is given, applies the latest one.
+
This is useful if the branch on which you ran `git stash save` has
This is useful if the branch on which you ran `git stash push` has
changed enough that `git stash apply` fails due to conflicts. Since
the stash entry is applied on top of the commit that was HEAD at the
time `git stash` was run, it restores the originally stashed state
......@@ -255,14 +255,14 @@ $ git stash pop
Testing partial commits::
You can use `git stash save --keep-index` when you want to make two or
You can use `git stash push --keep-index` when you want to make two or
more commits out of the changes in the work tree, and you want to test
each change before committing:
+
----------------------------------------------------------------
# ... hack hack hack ...
$ git add --patch foo # add just first part to the index
$ git stash save --keep-index # save all other changes to the stash
$ git stash push --keep-index # save all other changes to the stash
$ edit/build/test first part
$ git commit -m 'First part' # commit fully tested change
$ git stash pop # prepare to work on all other changes
......
......@@ -40,7 +40,7 @@ beginning. It is always easier to squash a few commits together than
to split one big commit into several. Don't be afraid of making too
small or imperfect steps along the way. You can always go back later
and edit the commits with `git rebase --interactive` before you
publish them. You can use `git stash save --keep-index` to run the
publish them. You can use `git stash push --keep-index` to run the
test suite independent of other uncommitted changes; see the EXAMPLES
section of linkgit:git-stash[1].
......
......@@ -1556,7 +1556,7 @@ so on a different branch and then coming back), unstash the
work-in-progress changes.
------------------------------------------------
$ git stash save "work in progress for foo feature"
$ git stash push -m "work in progress for foo feature"
------------------------------------------------
This command will save your changes away to the `stash`, and
......
......@@ -267,11 +267,11 @@ push_stash () {
# translation of "error: " takes in your language. E.g. in
# English this is:
#
# $ git stash save --blah-blah 2>&1 | head -n 2
# error: unknown option for 'stash save': --blah-blah
# To provide a message, use git stash save -- '--blah-blah'
eval_gettextln "error: unknown option for 'stash save': \$option
To provide a message, use git stash save -- '\$option'"
# $ git stash push --blah-blah 2>&1 | head -n 2
# error: unknown option for 'stash push': --blah-blah
# To provide a message, use git stash push -m '--blah-blah'
eval_gettextln "error: unknown option for 'stash push': \$option
To provide a message, use git stash push -m '\$option'"
usage
;;
*)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment