Re: [PATCHv3 1/2] git-rebase.txt: "--onto" option updated

From: Junio C Hamano <gitster@pobox.com>
Date: Jun 8, 2012, 17:07 UTC
Message-ID: <7vipf1d96k.fsf@alter.siamese.dyndns.org>
In-Reply-To: <1339167235-2009-1-git-send-email-Lucien.Kong@ensimag.imag.fr>

Lucien Kong <Lucien.Kong@ensimag.imag.fr> writes:

Show 20 quoted lines

> The description of the option "--onto" is changed to be consistent
> with the format of the other options.
> ...
>  OPTIONS
>  -------
> -<newbase>::
> -	Starting point at which to create the new commits. If the
> -	--onto option is not specified, the starting point is
> -	<upstream>.  May be any valid commit, and not just an
> -	existing branch name.
> +--onto <newbase>::
> +	With this option, git rebase takes all commits from <branch>,
> +	that are not in <upstream>, and transplants them on top of
> +	<newbase>. <newbase is the starting point at which to create
> +	the new commits. If the --onto option is not specified, the
> +	starting point is <upstream>.  May be any valid commit, and
> +	not just an existing branch name.
>  +
>  As a special case, you may use "A\...B" as a shortcut for the
>  merge base of A and B if there is exactly one merge base. You can

This is doing two unrelated things in a single patch, isn't it?

I would imagine that a patch that is about "to be consistent with the format" would be a one-liner

	-<newbase>::
        +--onto <newbase>::

without anything else. The change this patch makes to the explanation is much larger, but that is not justified in the proposed commit log message.

Besides, I find the new explanatory text much harder to understand than the original one.