From: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Date: Fri, 30 Jul 2010 15:23:19 GMT
Subject: Re: [RFC/PATCH] Document -B<n>[/<m>], -M<n> and -C<n> variants of -B, -M and -C
Message-ID: <vpqmxt93sew.fsf@bauges.imag.fr>
In-Reply-To: <7vk4oeuv4b.fsf@alter.siamese.dyndns.org>

Junio C Hamano <gitster@pobox.com> writes:

> Matthieu Moy <Matthieu.Moy@imag.fr> writes:
>
>> I'm not really happy with my description of -Bn/m, which I essentially
>> took from eeaa46031479 (Junio, Jun 3 2005, diff: Update -B
>> heuristics). Someone with better understanding of how it works can
>> probably propose something better.
>
> Your explanation for '<n>' being the same across -B/-M/-C is reasonable.
> Explanation of '<m>' might want to clarify why it counts only the deletion
> and to mention that "100-similarity != dissimilarity", but as the end-user
> level documentation, these probably are unnecessary.

The thing is: I don't know the anwser myself, so I'm not in a position
do write such documentation :-(.

>> +-B[<n>]::
>> +-B<n>/<m>::
>>  	Break complete rewrite changes into pairs of delete and create.
>> +	If `n` is specified, it gives the threshold (as a percentage
>> +	of changed lines) above which a change is considered as
>> +	complete rewrite.  For example, `-B90%` means git will detect a
>> +	rewrite if more than 90% of the lines have been modified. ...
>
> I am fine with the use of word "lines" if it is clear that we are giving a
> simplified explanation (white lie) to the readers, but the (dis)similarity
> numbers don't have much to do with "lines".

Likewise, I didn't write "lines" as a white lie, but because of my
ignorance ... hence my request for help.

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/