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

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 1, 2019, 10:47 UTC
Message-ID: <xmqqmulauhmv.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20190326120939.31657-1-pclouds@gmail.com>

Nguyễn Thái Ngọc Duy  <pclouds@gmail.com> writes:

Show 13 quoted lines

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

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.

Thanks.

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