[PATCH 1/1] git-stash.txt: correct "git stash" behavior with no arguments

[PATCH 1/1] git-stash.txt: correct "git stash" behavior with no arguments

[Takahito Ogawa]

"git stash" behavior without any arguments was changed in
1ada5020b ("stash: use stash_push for no verb form", 2017-02-28).
This is equivalent to "git stash push" but document says
"git stash save".

Correct it.

Signed-off-by: Takahito Ogawa <takahito.ogawa@datagrid.co.jp>
---
 Documentation/git-stash.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 00f95fee1..63642c145 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -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.
-- 
2.13.1

[PATCH 1/1] git-stash.txt: correct "git stash" behavior with no arguments

[Takahito Ogawa]

"git stash" behavior without any arguments was changed in
1ada5020b ("stash: use stash_push for no verb form", 2017-02-28).
This is equivalent to "git stash push" but document says
"git stash save".

Correct it.

Signed-off-by: Takahito Ogawa <takahito.ogawa@datagrid.co.jp>
---
 Documentation/git-stash.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 00f95fee1..63642c145 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -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.
-- 
2.13.1

[PATCH 1/1] git-stash.txt: correct "git stash" behavior with no arguments

[Takahito Ogawa]

"git stash" behavior without any arguments was changed in
1ada5020b ("stash: use stash_push for no verb form", 2017-02-28).
This is equivalent to "git stash push" but documents says
"git stash save".

Correct it.

Signed-off-by: Takahito Ogawa <aiueogawa217@gmail.com>
---
 Documentation/git-stash.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 00f95fee1..63642c145 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -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.
-- 
2.13.1

Re: [PATCH 1/1] git-stash.txt: correct "git stash" behavior with no arguments

[Thomas Gummerer]

On 10/12, Takahito Ogawa wrote:
> "git stash" behavior without any arguments was changed in
> 1ada5020b ("stash: use stash_push for no verb form", 2017-02-28).
> This is equivalent to "git stash push" but documents says
> "git stash save".
> 
> Correct it.

Thanks for fixing this!  I recently sent a patch that would advertise
git stash push more in general, which would also fix this occurrence [1], 
but it didn't seem like it got much interest.  However this is
obviously correct, and should definitely be fixed, while the other
places can still mention 'git stash save'.

For what it's worth this is

Reviewed-by: Thomas Gummerer <t.gummerer@gmail.com>


> Signed-off-by: Takahito Ogawa <aiueogawa217@gmail.com>
> ---
>  Documentation/git-stash.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
> index 00f95fee1..63642c145 100644
> --- a/Documentation/git-stash.txt
> +++ b/Documentation/git-stash.txt
> @@ -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.
> -- 
> 2.13.1
> 

Re: [PATCH 1/1] git-stash.txt: correct "git stash" behavior with no arguments

[Thomas Gummerer]

On 10/11, Thomas Gummerer wrote:
> On 10/12, Takahito Ogawa wrote:
> > "git stash" behavior without any arguments was changed in
> > 1ada5020b ("stash: use stash_push for no verb form", 2017-02-28).
> > This is equivalent to "git stash push" but documents says
> > "git stash save".
> > 
> > Correct it.
> 
> Thanks for fixing this!  I recently sent a patch that would advertise
> git stash push more in general, which would also fix this occurrence [1], 
> but it didn't seem like it got much interest.  However this is
> obviously correct, and should definitely be fixed, while the other
> places can still mention 'git stash save'.
> 
> For what it's worth this is
> 
> Reviewed-by: Thomas Gummerer <t.gummerer@gmail.com>

And I forgot to include the link, sorry.  Here it is:

[1]: https://public-inbox.org/git/20171005200049.GF30301@hank/

> 
> > Signed-off-by: Takahito Ogawa <aiueogawa217@gmail.com>
> > ---
> >  Documentation/git-stash.txt | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
> > index 00f95fee1..63642c145 100644
> > --- a/Documentation/git-stash.txt
> > +++ b/Documentation/git-stash.txt
> > @@ -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.
> > -- 
> > 2.13.1
> > 

[PATCH 1/1] git-stash.txt: correct "git stash" behavior with no arguments

[Takahito Ogawa]

"git stash" behavior without any arguments was changed in
1ada5020b ("stash: use stash_push for no verb form", 2017-02-28).
This is equivalent to "git stash push" but documents says
"git stash save".

Correct it.

Reviewed-by: Thomas Gummerer <t.gummerer@gmail.com>
Signed-off-by: Takahito Ogawa <aiueogawa217@gmail.com>
---
 Documentation/git-stash.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 00f95fee1..63642c145 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -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.
-- 
2.13.1

Re: [PATCH 1/1] git-stash.txt: correct "git stash" behavior with no arguments

[Junio C Hamano]

Takahito Ogawa <aiueogawa217@gmail.com> writes:

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

Hmph.  Is there any difference between

	git stash save
	git stash push

without any other argument?  Aren't they equivalent to

	git stash

without any argument, which is what this sentence explains?

Re: [PATCH 1/1] git-stash.txt: correct "git stash" behavior with no arguments

[小川恭史]

As you point,

    git stash

without any argument is equivalent to both of

    git stash save
    git stash push

. The original sentence is correct.

2017-10-12 12:31 GMT+09:00 小川恭史 <aiueogawa217@gmail.com>:
> As you point,
>
>     git stash
>
> without any argument is equivalent to both of
> git stash save and
>
>
> 2017-10-12 9:53 GMT+09:00 Junio C Hamano <gitster@pobox.com>:
>> Takahito Ogawa <aiueogawa217@gmail.com> writes:
>>
>>> @@ -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`.
>>
>> Hmph.  Is there any difference between
>>
>>         git stash save
>>         git stash push
>>
>> without any other argument?  Aren't they equivalent to
>>
>>         git stash
>>
>> without any argument, which is what this sentence explains?
>>
>

Re: [PATCH 1/1] git-stash.txt: correct "git stash" behavior with no arguments

[小川恭史]

As you point,

    git stash

without any argument is equivalent to both of

    git stash save
    git stash push

. The original sentence is correct.

Re: [PATCH 1/1] git-stash.txt: correct "git stash" behavior with no arguments

[Junio C Hamano]

小川恭史 <aiueogawa217@gmail.com> writes:

> As you point,
>
>     git stash
>
> without any argument is equivalent to both of
>
>     git stash save
>     git stash push
>
> . The original sentence is correct.

OK.  

Note that I was merely reacting to "Correct it." in your
justification for the change, which made it sound like 'save' was
incorrect.

As a part of a move to deprecate 'save' and nudge users towards
'push', the change does make sense.  I just wanted to make sure the
change and its motivation are presented with honesty ;-).