deprecate git stash save? (was: Re: [PATCH 2/3] http-push: fix construction of hex value from path)
RFC 1/1 deprecate git stash save? (was: Re: [PATCH 2/3] http-push: fix construction of hex value from path)
Quoted 3 lines · Junio C Hamano
I do not object with such a well designed deprecation plan for any other features, if there are other "favourite" ones people would want to deprecate and eventually remove, by the way.
Since you were asking :) With the introduction of 'git stash push', my hope was always that we could eventually get rid of 'git stash save' and only keep one interface around.
As there still many references to it around on the internet, it probably requires a bit of a longer deprecation plan. What do you think about the following:
- Change docs/man pages to use 'git stash push' everywhere instead of 'git stash save'.
- Mention the deprecation in the release notes and in the man page.
- Print a warning when 'git stash save' is used.
- Eventually get rid of it (maybe something for 3.0?)
The steps above would all occur sequentially with a few releases between each of them.
A patch for the first step below. I think that even makes sense if we don't want to follow through with the deprecation.
--- >8 ---
Subject: [PATCH] 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.
--- Documentation/git-stash.txt | 12 ++++++------ Documentation/gitworkflows.txt | 2 +- Documentation/user-manual.txt | 2 +- git-stash.sh | 10 +++++----- 4 files changed, 13 insertions(+), 13 deletions(-)
Documentation/git-stash.txt +6 -6
@@ -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>]:: `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 +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
Documentation/gitworkflows.txt +1 -1
@@ -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].
Documentation/user-manual.txt +1 -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 "work in progress for foo feature" ------------------------------------------------ This command will save your changes away to the `stash`, and
git-stash.sh +5 -5
@@ -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 -- '--blah-blah' + eval_gettextln "error: unknown option for 'stash push': \$option + To provide a message, use git stash push -- '\$option'" usage ;; *)
Signature · 1 line
2.14.1.480.gb18f417b89
[PATCH 2/1] mention git stash push first in the man page
Because 'stash push' and 'stash save' are so closely related they share one section in the man page. Currently 'stash save' comes first, as that was the command that people were historically using. However this makes the newer, more feature rich git stash push very easy to overlook. Change the order to give the newer interface for creating a stash the more prominent position.
--- Documentation/git-stash.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-stash.txt +1 -1
@@ -48,8 +48,8 @@ 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 [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]:: Save your local modifications to a new 'stash entry' and roll them back to HEAD (in the working tree and in the index).
Signature · 1 line
2.14.1.480.gb18f417b89
Re: [RFC] deprecate git stash save?
In reply to Thomas GummererQuoted 5 lines · Thomas Gummerer
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.
With devil's advocate hat on, because the primary point of "stash" being "clear the desk quickly", I do not necessarily agree that "more feature rich" is a plus and something we should nudge newbies towards.
Re: [RFC] deprecate git stash save?
Quoted 8 lines · Junio C Hamano
Quoted 5 lines · Thomas Gummerer
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.
Quoted 4 lines
With devil's advocate hat on, because the primary point of "stash" being "clear the desk quickly", I do not necessarily agree that "more feature rich" is a plus and something we should nudge newbies towards.
I do not particulary view "feature richness" is the primary benefit of 'push' that makes it shine. 'save' has a quirk in the command line option syntax, but 'push' corrects it, and that is why we want to move users towards the latter.
IOW, I do not object to the agenda; it is just I found the justification used to push the agenda forward was flawed.
Thanks.
Re: [RFC] deprecate git stash save?
Quoted 15 lines · Junio C Hamano
Quoted 8 lines · Junio C Hamano
Quoted 5 lines · Thomas Gummerer
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.
Quoted 4 lines
With devil's advocate hat on, because the primary point of "stash" being "clear the desk quickly", I do not necessarily agree that "more feature rich" is a plus and something we should nudge newbies towards.
Quoted 4 lines
I do not particulary view "feature richness" is the primary benefit of 'push' that makes it shine. 'save' has a quirk in the command line option syntax, but 'push' corrects it, and that is why we want to move users towards the latter.
I agree it's not the primary benefit (hence why it's in braces :)), but I at least some users will eventually want the features 'git stash push' has to offer, and it's better if they don't have to re-train their fingers at that point.
But yeah, fixing the quirky command line interface is definitely the stronger reason for deprecating it.
Quoted 2 lines
IOW, I do not object to the agenda; it is just I found the justification used to push the agenda forward was flawed.
I'm happy as long as we agree on the agenda here. Any opinions about the patches themselves? Would you prefer me to resend with an updated description?
Quoted 1 line
Thanks.
Quoted 8 lines · Thomas Gummerer
Since you were asking :) With the introduction of 'git stash push', my hope was always that we could eventually get rid of 'git stash save' and only keep one interface around.
As there still many references to it around on the internet, it probably requires a bit of a longer deprecation plan. What do you think about the following:
Quoted 8 lines
- Change docs/man pages to use 'git stash push' everywhere instead of 'git stash save'.
- Mention the deprecation in the release notes and in the man page.
- Print a warning when 'git stash save' is used.
- Eventually get rid of it (maybe something for 3.0?)The steps above would all occur sequentially with a few releases between each of them.
That sounds like a pretty good plan.
Quoted 2 lines
A patch for the first step below. I think that even makes sense if we don't want to follow through with the deprecation.
Agreed. The patch mostly looks good, except:
Documentation/user-manual.txt so on a different branch and then coming back), unstash the · line 1560
Quoted 11 lines
Documentation/user-manual.txt +1
-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 "work in progress for foo feature" ------------------------------------------------
This needs "-m", doesn't it?
Quoted 10 lines
Documentation/user-manual.txt +0
-0This command will save your changes away to the `stash`, andgit-stash.sh +0
-0@@ -267,11 +267,11 @@ push_stash () { # translation of "error: " takes in your language. E.g. in # English this is: #
git-stash.sh push_stash () { · line 274
Quoted 10 lines
git-stash.sh +5
-5- # $ 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 -- '--blah-blah' + eval_gettextln "error: unknown option for 'stash push': \$option + To provide a message, use git stash push -- '\$option'"
And here, too?
-Peff
Re: [PATCH 2/1] mention git stash push first in the man page
In reply to Thomas GummererQuoted 6 lines · Thomas Gummerer
Because 'stash push' and 'stash save' are so closely related they share one section in the man page. Currently 'stash save' comes first, as that was the command that people were historically using. However this makes the newer, more feature rich git stash push very easy to overlook. Change the order to give the newer interface for creating a stash the more prominent position.
Seems reasonable, though if we are deprecating "save" should we demote it from being in the synopsis entirely?
-Peff
Re: [PATCH 2/1] mention git stash push first in the man page
Quoted 11 lines · Jeff King
Quoted 6 lines · Thomas Gummerer
Because 'stash push' and 'stash save' are so closely related they share one section in the man page. Currently 'stash save' comes first, as that was the command that people were historically using. However this makes the newer, more feature rich git stash push very easy to overlook. Change the order to give the newer interface for creating a stash the more prominent position.
Seems reasonable, though if we are deprecating "save" should we demote it from being in the synopsis entirely?
I saw that as a next step, with the "official" deprecation of "save". I thought we might want to advertise "push" a bit more before actually officially deprecating "save" and sending the deprecation notice out in the release notes.
OTOH, dropping it from the synopsis in the man page probably wouldn't cause much issue, as "push" directly replaces it, and is easily visible. Not sure how slow we want to take the deprecation?
Quoted 1 line
-Peff
Quoted 19 lines · Jeff King
Quoted 8 lines · Thomas Gummerer
Since you were asking :) With the introduction of 'git stash push', my hope was always that we could eventually get rid of 'git stash save' and only keep one interface around.
As there still many references to it around on the internet, it probably requires a bit of a longer deprecation plan. What do you think about the following:
Quoted 8 lines
- Change docs/man pages to use 'git stash push' everywhere instead of 'git stash save'.
- Mention the deprecation in the release notes and in the man page.
- Print a warning when 'git stash save' is used.
- Eventually get rid of it (maybe something for 3.0?)The steps above would all occur sequentially with a few releases between each of them.
Quoted 6 lines
That sounds like a pretty good plan.
Quoted 2 lines
A patch for the first step below. I think that even makes sense if we don't want to follow through with the deprecation.
Agreed. The patch mostly looks good, except:
Thanks for the review.
Quoted 7 lines
Quoted 7 lines
Documentation/user-manual.txt +0
-0@@ -1556,7 +1556,7 @@ so on a different branch and then coming back), unstash the work-in-progress changes.
Quoted 6 lines
Documentation/user-manual.txt so on a different branch and then coming back), unstash the · line 1560
Quoted 4 lines
Documentation/user-manual.txt +1
-1------------------------------------------------ -$ git stash save "work in progress for foo feature" +$ git stash push "work in progress for foo feature" ------------------------------------------------This needs "-m", doesn't it?
Yeah, this definitely needs "-m". Will change.
Quoted 14 lines
Quoted 14 lines
Documentation/user-manual.txt +0
-0This command will save your changes away to the `stash`, andgit-stash.sh +0
-4@@ -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
Quoted 8 lines
git-stash.sh push_stash () { · line 274
Quoted 6 lines
git-stash.sh +5
-1- 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 -- '--blah-blah' + eval_gettextln "error: unknown option for 'stash push': \$option + To provide a message, use git stash push -- '\$option'"And here, too?
Indeed, thanks for catching these. Will change and re-roll the patches.
Quoted 1 line
-Peff
Re: [PATCH 2/1] mention git stash push first in the man page
In reply to Thomas GummererQuoted 7 lines · Thomas Gummerer
Quoted 2 lines
Seems reasonable, though if we are deprecating "save" should we demote it from being in the synopsis entirely?
I saw that as a next step, with the "official" deprecation of "save". I thought we might want to advertise "push" a bit more before actually officially deprecating "save" and sending the deprecation notice out in the release notes.
Right, my thinking was that it would still be documented in the manpage, just lower down. And that would probably say something like "save is a historical synonym for push, except that it differs in these ways...".
Quoted 3 lines
OTOH, dropping it from the synopsis in the man page probably wouldn't cause much issue, as "push" directly replaces it, and is easily visible. Not sure how slow we want to take the deprecation?
I don't think there's any reason to go slow in marking something as deprecated. It's the part where we follow up and remove or change the feature that must take a while.
-Peff
Re: [PATCH 2/1] mention git stash push first in the man page
Quoted 14 lines · Jeff King
Quoted 7 lines · Thomas Gummerer
Quoted 2 lines
Seems reasonable, though if we are deprecating "save" should we demote it from being in the synopsis entirely?
I saw that as a next step, with the "official" deprecation of "save". I thought we might want to advertise "push" a bit more before actually officially deprecating "save" and sending the deprecation notice out in the release notes.
Right, my thinking was that it would still be documented in the manpage, just lower down. And that would probably say something like "save is a historical synonym for push, except that it differs in these ways...".
Quoted 7 lines
Quoted 3 lines
OTOH, dropping it from the synopsis in the man page probably wouldn't cause much issue, as "push" directly replaces it, and is easily visible. Not sure how slow we want to take the deprecation?
I don't think there's any reason to go slow in marking something as deprecated. It's the part where we follow up and remove or change the feature that must take a while.
Makes sense, let me drop it from the synopsis then.
Thanks!
Quoted 1 line
-Peff
PATCH v2 1/2 replace git stash save with git stash push in the documentation
In reply to Thomas Gummerergit 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.
--- Documentation/git-stash.txt | 12 ++++++------ Documentation/gitworkflows.txt | 2 +- Documentation/user-manual.txt | 2 +- git-stash.sh | 10 +++++----- 4 files changed, 13 insertions(+), 13 deletions(-)
Documentation/git-stash.txt +6 -6
@@ -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>]:: `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 +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
Documentation/gitworkflows.txt +1 -1
@@ -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].
Documentation/user-manual.txt +1 -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
git-stash.sh +5 -5
@@ -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 -- '--blah-blah' + eval_gettextln "error: unknown option for 'stash push': \$option + To provide a message, use git stash push -m '\$option'" usage ;; *)
Signature · 1 line
2.15.0.rc1.65.g660fb3dfa8
PATCH v2 2/2 mark git stash push deprecated in the man page
'git stash push' fixes a historical wart in the interface of 'git stash save'. As 'git stash push' has all functionality of 'git stash save', with a nicer, more consistent user interface deprecate 'git stash save'. To do this, remove it from the synopsis of the man page, and move it to a separate section, stating that it is deprecated.
--- Documentation/git-stash.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
Documentation/git-stash.txt +4 -3
@@ -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>...]]
@@ -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,10 @@ 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'. + list [<options>]:: List the stash entries that you currently have. Each 'stash entry' is
Signature · 1 line
2.15.0.rc1.65.g660fb3dfa8
Re: [PATCH 2/1] mention git stash push first in the man page
In reply to Thomas GummererQuoted 19 lines · Thomas Gummerer
Quoted 18 lines · Jeff King
Quoted 7 lines · Thomas Gummerer
Quoted 2 lines
Seems reasonable, though if we are deprecating "save" should we demote it from being in the synopsis entirely?
I saw that as a next step, with the "official" deprecation of "save". I thought we might want to advertise "push" a bit more before actually officially deprecating "save" and sending the deprecation notice out in the release notes.
Right, my thinking was that it would still be documented in the manpage, just lower down. And that would probably say something like "save is a historical synonym for push, except that it differs in these ways...".
Quoted 3 lines
OTOH, dropping it from the synopsis in the man page probably wouldn't cause much issue, as "push" directly replaces it, and is easily visible. Not sure how slow we want to take the deprecation?
Quoted 5 lines
Quoted 3 lines
I don't think there's any reason to go slow in marking something as deprecated. It's the part where we follow up and remove or change the feature that must take a while.
Makes sense, let me drop it from the synopsis then.
what, exactly, is the oft-referred-to issue with how "git stash
save" works that is being addressed with the new syntax of "git stash push"?
rday
Signature · 7 lines
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================Re: [PATCH 2/1] mention git stash push first in the man page
Quoted 9 lines · Robert P. J. Day
Quoted 5 lines
Quoted 3 lines
I don't think there's any reason to go slow in marking something as deprecated. It's the part where we follow up and remove or change the feature that must take a while.
Makes sense, let me drop it from the synopsis then.
what, exactly, is the oft-referred-to issue with how "git stash
save" works that is being addressed with the new syntax of "git stash push"?
"stash save" soaks up all arguments as the stash message, so it's not possible to specify pathspecs. "push" uses "-m <msg>" for the stash message, and can accept pathspecs.
-Peff
Re: [PATCH v2 1/2] replace git stash save with git stash push in the documentation
In reply to Thomas GummererQuoted 8 lines · Thomas Gummerer
git-stash.sh +0
-0@@ -267,11 +267,11 @@ push_stash () { # translation of "error: " takes in your language. E.g. in # English this is: #
git-stash.sh push_stash () { · line 274
Quoted 10 lines
git-stash.sh +5
-5- # $ 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 -- '--blah-blah' + eval_gettextln "error: unknown option for 'stash push': \$option + To provide a message, use git stash push -m '\$option'"
The user message is fixed here, but doesn't the message for translators need the same treatment? I guess it's just talking about the spacing, so it doesn't need to be completely accurate. But it probably makes sense to update it at the same time.
As an aside, I do kind of wonder if the right advice for "push" is different than for "save" here. I.e., should it say "to provide a pathspec that starts with --, use push -- --blah-blah". I'm not sure it matters that much. Second-guessing what a user meant seems likely to go wrong (e.g., "--icnlude-untracked" would trigger this message, which is just silly). But that's largely orthogonal to what you're doing here.
-Peff
Re: [PATCH v2 2/2] mark git stash push deprecated in the man page
In reply to Thomas GummererQuoted 5 lines · Thomas Gummerer
'git stash push' fixes a historical wart in the interface of 'git stash save'. As 'git stash push' has all functionality of 'git stash save', with a nicer, more consistent user interface deprecate 'git stash save'. To do this, remove it from the synopsis of the man page, and move it to a separate section, stating that it is deprecated.
This looks fine.
Documentation/git-stash.txt linkgit:git-add[1] to learn how to operate the `--patch` mode. · line 90
Quoted 8 lines
Documentation/git-stash.txt +4
-0@@ -87,6 +84,10 @@ 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'. +
We could possibly go into more detail, like:
It differs from "stash push" in that it cannot take pathspecs, and any non-option arguments form the message.
or something. Since we don't want people to use it, it probably doesn't matter much. I just wondered if people would peer at the (long) synopsis line trying to figure out how it's different.
-Peff
Re: [PATCH 2/1] mention git stash push first in the man page
In reply to Jeff KingQuoted 8 lines · Jeff King
Quoted 6 lines · Robert P. J. Day
Quoted 5 lines
Quoted 3 lines
I don't think there's any reason to go slow in marking something as deprecated. It's the part where we follow up and remove or change the feature that must take a while.
Makes sense, let me drop it from the synopsis then.
Quoted 7 lines
Quoted 3 lines
what, exactly, is the oft-referred-to issue with how "git stash
save" works that is being addressed with the new syntax of "git stash push"?"stash save" soaks up all arguments as the stash message, so it's not possible to specify pathspecs. "push" uses "-m <msg>" for the stash message, and can accept pathspecs.
ah, i knew that, yeah, that's the ticket. :-)
rday
Signature · 7 lines
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================Re: [PATCH v2 1/2] replace git stash save with git stash push in the documentation
In reply to Jeff KingQuoted 17 lines · Jeff King
Quoted 15 lines · Thomas Gummerer
git-stash.sh +2
-5@@ -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
Quoted 8 lines
git-stash.sh push_stash () { · line 274
Quoted 3 lines
git-stash.sh +3
-0+ # To provide a message, use git stash push -- '--blah-blah' + eval_gettextln "error: unknown option for 'stash push': \$option + To provide a message, use git stash push -m '\$option'"The user message is fixed here, but doesn't the message for translators need the same treatment? I guess it's just talking about the spacing, so it doesn't need to be completely accurate. But it probably makes sense to update it at the same time.
Yeah, I was completely blind here, that should definitely have been updated as well. Thanks for catching.
Quoted 6 lines
As an aside, I do kind of wonder if the right advice for "push" is different than for "save" here. I.e., should it say "to provide a pathspec that starts with --, use push -- --blah-blah". I'm not sure it matters that much. Second-guessing what a user meant seems likely to go wrong (e.g., "--icnlude-untracked" would trigger this message, which is just silly). But that's largely orthogonal to what you're doing here.
The best advice for it might indeed be different for "save" and "push". The slight weirdness we have here is that both "save" and "push" are using the same option parsing.
Now that we're deprecating "save", I don't think it's worth the effort to try to get rid of this weirdness.
I think using "--" to distinguish the the pathspec from the command line options is a common enough pattern that we don't need to give advice to the users. I feel like that second line was mostly there because of the weirdness in the user interface for "stash save". Maybe we should just get rid of that part alltogether?
Quoted 1 line
-Peff
Re: [PATCH v2 2/2] mark git stash push deprecated in the man page
In reply to Jeff KingQuoted 21 lines · Jeff King
Quoted 5 lines · Thomas Gummerer
'git stash push' fixes a historical wart in the interface of 'git stash save'. As 'git stash push' has all functionality of 'git stash save', with a nicer, more consistent user interface deprecate 'git stash save'. To do this, remove it from the synopsis of the man page, and move it to a separate section, stating that it is deprecated.
This looks fine.
Documentation/git-stash.txt linkgit:git-add[1] to learn how to operate the `--patch` mode. · line 90
Quoted 8 lines
Documentation/git-stash.txt +4
-0@@ -87,6 +84,10 @@ 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'. +We could possibly go into more detail, like:
Quoted 6 lines
It differs from "stash push" in that it cannot take pathspecs, and any non-option arguments form the message.
or something. Since we don't want people to use it, it probably doesn't matter much. I just wondered if people would peer at the (long) synopsis line trying to figure out how it's different.
Yeah, feels like it could potentially help somebody. I'll add that, thanks!
Quoted 1 line
-Peff
v3 cover deprecate git stash save
In reply to Thomas GummererThanks Peff for the review of the previous rounds.
In addition to addressing the review comments, this round adds another patch getting rid of the extra help with an unknown option to git stash push.
Interdiff below:
Documentation/git-stash.txt +3 -1
@@ -86,7 +86,9 @@ The `--patch` option implies `--keep-index`. You can use 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'. + 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>]::
git-stash.sh +1 -12
@@ -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 push --blah-blah 2>&1 | head -n 2 - # error: unknown option for 'stash push': --blah-blah - # To provide a message, use git stash push -- '--blah-blah' - eval_gettextln "error: unknown option for 'stash push': \$option - To provide a message, use git stash push -m '\$option'" + eval_gettextln "error: unknown option for 'stash push': \$option" usage ;; *)
Thomas Gummerer (3):
replace git stash save with git stash push in the documentation mark git stash push deprecated in the man page
stash: remove now superfluos help for "stash push"
Documentation/git-stash.txt | 21 ++++++++++++--------- Documentation/gitworkflows.txt | 2 +- Documentation/user-manual.txt | 2 +- git-stash.sh | 13 +------------ 4 files changed, 15 insertions(+), 23 deletions(-)
Signature · 1 line
2.15.0.rc0.2.g8fac3e73c8.dirty
PATCH v3 1/3 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.
--- Documentation/git-stash.txt | 12 ++++++------ Documentation/gitworkflows.txt | 2 +- Documentation/user-manual.txt | 2 +- git-stash.sh | 10 +++++----- 4 files changed, 13 insertions(+), 13 deletions(-)
Documentation/git-stash.txt +6 -6
@@ -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>]:: `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 +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
Documentation/gitworkflows.txt +1 -1
@@ -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].
Documentation/user-manual.txt +1 -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
git-stash.sh +5 -5
@@ -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 ;; *)
Signature · 1 line
2.15.0.rc0.2.g8fac3e73c8.dirty
PATCH v3 2/3 mark git stash push deprecated in the man page
In reply to Thomas Gummerer'git stash push' fixes a historical wart in the interface of 'git stash save'. As 'git stash push' has all functionality of 'git stash save', with a nicer, more consistent user interface deprecate 'git stash save'. To do this, remove it from the synopsis of the man page, and move it to a separate section, stating that it is deprecated.
--- Documentation/git-stash.txt | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
Documentation/git-stash.txt +6 -3
@@ -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>...]]
@@ -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
Signature · 1 line
2.15.0.rc0.2.g8fac3e73c8.dirty
PATCH v3 3/3 stash: remove now superfluos help for "stash push"
In reply to Thomas GummererWith the 'git stash save' interface, it was easily possible for users to try to add a message which would start with "-", which 'git stash save' would interpret as a command line argument, and fail. For this case we added some extra help on how to create a stash with a message starting with "-".
For 'stash push', messages are passed with the -m flag, avoiding this potential pitfall. Now only pathspecs starting with "-" would have to be distinguished from command line parameters by using
"-- --<pathspec>". This is fairly common in the git command line interface, and we don't try to guess what the users wanted in the other cases.
Because this way of passing pathspecs is quite common in other git commands, and we don't provide any extra help there, do the same in the error message for 'git stash push'.
--- git-stash.sh | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-)
git-stash.sh +1 -12
@@ -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 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'" + eval_gettextln "error: unknown option for 'stash push': \$option" usage ;; *)
Signature · 1 line
2.15.0.rc0.2.g8fac3e73c8.dirty
Re: [PATCH v3 0/3] deprecate git stash save
In reply to Thomas GummererQuoted 5 lines · Thomas Gummerer
Thanks Peff for the review of the previous rounds.
In addition to addressing the review comments, this round adds another patch getting rid of the extra help with an unknown option to git stash push.
Yeah, the reasoning in the commit message of patch 3 makes sense to me.
Quoted 4 lines
Thomas Gummerer (3):
replace git stash save with git stash push in the documentation mark git stash push deprecated in the man page
stash: remove now superfluos help for "stash push"
The whole thing looks good. Thanks!
-Peff
Re: [PATCH v3 0/3] deprecate git stash save
In reply to Thomas GummererQuoted 1 line · Thomas Gummerer
Interdiff below:
Thanks. Looks much more polished.
Documentation/git-stash.txt The `--patch` option implies `--keep-index`. You can use · line 91
Quoted 13 lines
Documentation/git-stash.txt +3
-1@@ -86,7 +86,9 @@ The `--patch` option implies `--keep-index`. You can use 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'. + 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.
Every time I saw this line, I misread s/form/from/ and got confused.
I know the below is what the above wants the readers to eventually [*1*] know:
'git stash save' cannot take pathspecs (nor it can be enhanced with new options in the future) because any non-option argument to it is treated as the message and has been deprecated. 'git stash push' supersedes 'git stash save'; it corrects the command line syntax by requiring '-m' before the message.
but I feel that the text in your patch still does not read clearly enough. But it may only be me.
Thanks.
[Footnote]
*1* By "eventually" what I mean is that it may not be necessarily a good idea to lay it out all to the reader here at this point in the document---they may not care why a subcommand is being deprecated, but for those who want to know, we need to write it down somewhere.
Re: [PATCH v3 0/3] deprecate git stash save
In reply to Thomas GummererOverall the result looks reasonable and get us closer to the ideal world where nobody recalls "stash save" has ever existed ;-)
Will queue; thanks.
Re: [PATCH v3 0/3] deprecate git stash save
In reply to Junio C HamanoQuoted 7 lines · Junio C Hamano
Documentation/git-stash.txt The `--patch` option implies `--keep-index`. You can use · line 91
Quoted 4 lines
Documentation/git-stash.txt +3
-1- This option is deprecated in favour of 'git stash push'. + 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.Every time I saw this line, I misread s/form/from/ and got confused.
We could reverse the order:
...and the message is taken from any non-option arguments.
-Peff
Re: [PATCH v3 0/3] deprecate git stash save
Quoted 10 lines · Jeff King
Quoted 7 lines · Junio C Hamano
Documentation/git-stash.txt The `--patch` option implies `--keep-index`. You can use · line 91
Quoted 4 lines
Documentation/git-stash.txt +3
-1- This option is deprecated in favour of 'git stash push'. + 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.Every time I saw this line, I misread s/form/from/ and got confused.
Quoted 3 lines
We could reverse the order:
...and the message is taken from any non-option arguments.
Yeah, that makes it slightly less confusing. Or "any non-option arguments become the message", perhaps? I dunno.
Let's queue the version as posted; perhaps somebody new comes and says it is confusing in three months, at which time we may be able to come up with a better phrasing with a fresh mind ;-)
Re: [PATCH v3 0/3] deprecate git stash save
In reply to Junio C HamanoQuoted 15 lines · Junio C Hamano
Quoted 1 line · Thomas Gummerer
Interdiff below:
Thanks. Looks much more polished.
Quoted 9 lines
Documentation/git-stash.txt +0
-0@@ -86,7 +86,9 @@ The `--patch` option implies `--keep-index`. You can use save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
Quoted 7 lines
Documentation/git-stash.txt The `--patch` option implies `--keep-index`. You can use · line 91
Quoted 4 lines
Documentation/git-stash.txt +3
-1- This option is deprecated in favour of 'git stash push'. + 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.Every time I saw this line, I misread s/form/from/ and got confused.
"constitute"?
rday
Signature · 7 lines
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================