* [PATCH] Doc: reference the "stash list" in autostash docs
@ 2020-05-05 13:00 Denton Liu
2020-05-05 18:36 ` Junio C Hamano
0 siblings, 1 reply; 4+ messages in thread
From: Denton Liu @ 2020-05-05 13:00 UTC (permalink / raw)
To: Git Mailing List; +Cc: Junio C Hamano, Phillip Wood
In documentation pertaining to autostash behavior, we refer to the
"stash reflog". This description is too low-level as the reflog refers
to an implementation detail of how the stash works and, for end-users,
they do not need to be aware of this at all.
Change references of "stash reflog" to "stash list", which should be
provide more accessible terminology for end-users.
Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
Notes:
This patch is based on 'dl/merge-autostash-rebase-quit-fix'.
Documentation/git-merge.txt | 4 ++--
Documentation/git-rebase.txt | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index ec06b2f8c2..3819fadac1 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -106,12 +106,12 @@ commit or stash your changes before running 'git merge'.
`MERGE_HEAD` is present unless `MERGE_AUTOSTASH` is also present in
which case 'git merge --abort' applies the stash entry to the worktree
whereas 'git reset --merge' will save the stashed changes in the stash
-reflog.
+list.
--quit::
Forget about the current merge in progress. Leave the index
and the working tree as-is. If `MERGE_AUTOSTASH` is present, the
- stash entry will be saved to the stash reflog.
+ stash entry will be saved to the stash list.
--continue::
After a 'git merge' stops due to conflicts you can conclude the
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 7d0c89a184..fa969d8064 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -257,7 +257,7 @@ See also INCOMPATIBLE OPTIONS below.
Abort the rebase operation but HEAD is not reset back to the
original branch. The index and working tree are also left
unchanged as a result. If a temporary stash entry was created
- using --autostash, it will be saved to the stash reflog.
+ using --autostash, it will be saved to the stash list.
--apply:
Use applying strategies to rebase (calling `git-am`
--
2.26.2.548.gbb00c8a0a9
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] Doc: reference the "stash list" in autostash docs
2020-05-05 13:00 [PATCH] Doc: reference the "stash list" in autostash docs Denton Liu
@ 2020-05-05 18:36 ` Junio C Hamano
2020-05-05 22:59 ` Denton Liu
0 siblings, 1 reply; 4+ messages in thread
From: Junio C Hamano @ 2020-05-05 18:36 UTC (permalink / raw)
To: Denton Liu; +Cc: Git Mailing List, Phillip Wood
Denton Liu <liu.denton@gmail.com> writes:
> In documentation pertaining to autostash behavior, we refer to the
> "stash reflog". This description is too low-level as the reflog refers
> to an implementation detail of how the stash works and, for end-users,
> they do not need to be aware of this at all.
>
> Change references of "stash reflog" to "stash list", which should be
> provide more accessible terminology for end-users.
Sounds like a good thing to do.
>
> Signed-off-by: Denton Liu <liu.denton@gmail.com>
> ---
>
> Notes:
> This patch is based on 'dl/merge-autostash-rebase-quit-fix'.
Thanks. This kind of note is very much appreciated.
> Documentation/git-merge.txt | 4 ++--
> Documentation/git-rebase.txt | 2 +-
> 2 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
> index ec06b2f8c2..3819fadac1 100644
> --- a/Documentation/git-merge.txt
> +++ b/Documentation/git-merge.txt
> @@ -106,12 +106,12 @@ commit or stash your changes before running 'git merge'.
> `MERGE_HEAD` is present unless `MERGE_AUTOSTASH` is also present in
> which case 'git merge --abort' applies the stash entry to the worktree
> whereas 'git reset --merge' will save the stashed changes in the stash
> -reflog.
> +list.
>
> --quit::
> Forget about the current merge in progress. Leave the index
> and the working tree as-is. If `MERGE_AUTOSTASH` is present, the
> - stash entry will be saved to the stash reflog.
> + stash entry will be saved to the stash list.
>
> --continue::
> After a 'git merge' stops due to conflicts you can conclude the
> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
> index 7d0c89a184..fa969d8064 100644
> --- a/Documentation/git-rebase.txt
> +++ b/Documentation/git-rebase.txt
> @@ -257,7 +257,7 @@ See also INCOMPATIBLE OPTIONS below.
> Abort the rebase operation but HEAD is not reset back to the
> original branch. The index and working tree are also left
> unchanged as a result. If a temporary stash entry was created
> - using --autostash, it will be saved to the stash reflog.
> + using --autostash, it will be saved to the stash list.
>
> --apply:
> Use applying strategies to rebase (calling `git-am`
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] Doc: reference the "stash list" in autostash docs
2020-05-05 18:36 ` Junio C Hamano
@ 2020-05-05 22:59 ` Denton Liu
2020-05-06 3:57 ` Junio C Hamano
0 siblings, 1 reply; 4+ messages in thread
From: Denton Liu @ 2020-05-05 22:59 UTC (permalink / raw)
To: Junio C Hamano; +Cc: Git Mailing List, Phillip Wood
Hi Junio,
Sorry, I noticed a typo when reading this patch over.
On Tue, May 05, 2020 at 11:36:22AM -0700, Junio C Hamano wrote:
> Denton Liu <liu.denton@gmail.com> writes:
>
> > In documentation pertaining to autostash behavior, we refer to the
> > "stash reflog". This description is too low-level as the reflog refers
> > to an implementation detail of how the stash works and, for end-users,
> > they do not need to be aware of this at all.
> >
> > Change references of "stash reflog" to "stash list", which should be
s/ be$//
> > provide more accessible terminology for end-users.
Thanks,
Denton
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] Doc: reference the "stash list" in autostash docs
2020-05-05 22:59 ` Denton Liu
@ 2020-05-06 3:57 ` Junio C Hamano
0 siblings, 0 replies; 4+ messages in thread
From: Junio C Hamano @ 2020-05-06 3:57 UTC (permalink / raw)
To: Denton Liu; +Cc: Git Mailing List, Phillip Wood
Denton Liu <liu.denton@gmail.com> writes:
> Hi Junio,
>
> Sorry, I noticed a typo when reading this patch over.
>
> On Tue, May 05, 2020 at 11:36:22AM -0700, Junio C Hamano wrote:
>> Denton Liu <liu.denton@gmail.com> writes:
>>
>> > In documentation pertaining to autostash behavior, we refer to the
>> > "stash reflog". This description is too low-level as the reflog refers
>> > to an implementation detail of how the stash works and, for end-users,
>> > they do not need to be aware of this at all.
>> >
>> > Change references of "stash reflog" to "stash list", which should be
>
> s/ be$//
Amended.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-05-06 3:57 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-05 13:00 [PATCH] Doc: reference the "stash list" in autostash docs Denton Liu
2020-05-05 18:36 ` Junio C Hamano
2020-05-05 22:59 ` Denton Liu
2020-05-06 3:57 ` Junio C Hamano
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).