Merge branch 'tg/deprecate-stash-save'
"git stash save" has been deprecated in favour of "git stash push". * tg/deprecate-stash-save: stash: remove now superfluos help for "stash push" stash: mark "git stash save" deprecated in the man page stash: replace "git stash save" with "git stash push" in the documentation
This commit is contained in:
commit
40f1293530
@ -13,8 +13,6 @@ SYNOPSIS
|
||||
'git stash' drop [-q|--quiet] [<stash>]
|
||||
'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
|
||||
'git stash' branch <branchname> [<stash>]
|
||||
'git stash' save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
|
||||
[-u|--include-untracked] [-a|--all] [<message>]
|
||||
'git stash' [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
|
||||
[-u|--include-untracked] [-a|--all] [-m|--message <message>]]
|
||||
[--] [<pathspec>...]]
|
||||
@ -33,7 +31,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.
|
||||
@ -48,7 +46,6 @@ stash index (e.g. the integer `n` is equivalent to `stash@{n}`).
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
|
||||
push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<pathspec>...]::
|
||||
|
||||
Save your local modifications to a new 'stash entry' and roll them
|
||||
@ -87,6 +84,12 @@ linkgit:git-add[1] to learn how to operate the `--patch` mode.
|
||||
The `--patch` option implies `--keep-index`. You can use
|
||||
`--no-keep-index` to override this.
|
||||
|
||||
save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
|
||||
|
||||
This option is deprecated in favour of 'git stash push'. It
|
||||
differs from "stash push" in that it cannot take pathspecs,
|
||||
and any non-option arguments form the message.
|
||||
|
||||
list [<options>]::
|
||||
|
||||
List the stash entries that you currently have. Each 'stash entry' is
|
||||
@ -118,7 +121,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 +140,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 +151,7 @@ branch <branchname> [<stash>]::
|
||||
`stash@{<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 +258,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
|
||||
|
13
git-stash.sh
13
git-stash.sh
@ -260,18 +260,7 @@ push_stash () {
|
||||
;;
|
||||
-*)
|
||||
option="$1"
|
||||
# TRANSLATORS: $option is an invalid option, like
|
||||
# `--blah-blah'. The 7 spaces at the beginning of the
|
||||
# second line correspond to "error: ". So you should line
|
||||
# up the second line with however many characters the
|
||||
# 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'"
|
||||
eval_gettextln "error: unknown option for 'stash push': \$option"
|
||||
usage
|
||||
;;
|
||||
*)
|
||||
|
Loading…
Reference in New Issue
Block a user