Re: [PATCH] read-tree.txt: clarify --reset and worktree changes

From: Duy Nguyen <pclouds@gmail.com>
Date: Apr 1, 2019, 12:02 UTC
Message-ID: <CACsJy8B1Bp6=H_pKTfaZtucxod-SK3X+gb6zMJfmxBy8ep0PPA@mail.gmail.com>
In-Reply-To: <xmqqmulauhmv.fsf@gitster-ct.c.googlers.com>

On Mon, Apr 1, 2019 at 5:47 PM Junio C Hamano <gitster@pobox.com> wrote:

Show 20 quoted lines

>
> Nguyễn Thái Ngọc Duy  <pclouds@gmail.com> writes:
>
> > diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
> > index 5c70bc2878..12a25bc954 100644
> > --- a/Documentation/git-read-tree.txt
> > +++ b/Documentation/git-read-tree.txt
> > @@ -38,8 +38,9 @@ OPTIONS
> >       started.
> >
> >  --reset::
> > -        Same as -m, except that unmerged entries are discarded
> > -        instead of failing.
> > +     Same as -m, except that unmerged entries are discarded
> > +     instead of failing. If `-u` is used, updates leading to loss
> > +     of local changes will not abort the operation.
>
> "git add $file" makes a local change to the index at path $file",
> and reverting that local change is what "read-tree --reset"
> primarily does.

That sounds more like "reset $file" than "read-tree --reset" actually, which works on a full tree instead of a path.

Show 5 quoted lines

> The difference cased by presence or lack of "-u" is only about the
> working tree files, so s/local/working tree/ perhaps?
>
> I'd also phrase s/If `-u` is used/When used with `-u`/ if I were
> writing this.

Updated. v2 coming.

Show 6 quoted lines

>
> Thanks.
>
> >
> >  -u::
> >       After a successful merge, update the files in the work

-- 
Duy