threads / patch / 34351

patchdiff-options: document default similarity index

Subject: [PATCH] diff-options: document default similarity index

## tl;dr

3 messages between Jul 5, 2013 and Jul 5, 2013. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Fraser Tweedale· Jul 5, 2013, 08:42 UTC · lore

The default similarity index of 50% is documented in gitdiffcore(7) but it is worth also mentioning it in the description of the -M/--find-renames option.

Signed-off-by: Fraser Tweedale <frase@frase.id.au>
---
 Documentation/diff-options.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to Documentation/diff-options.txt +1 −1

diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index a85288f..d6e4db4 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -333,7 +333,7 @@ endif::git-log[]
 	a fraction, with a decimal point before it.  I.e., `-M5` becomes
 	0.5, and is thus the same as `-M50%`.  Similarly, `-M05` is
 	the same as `-M5%`.  To limit detection to exact renames, use
-	`-M100%`.
+	`-M100%`.  The default similarity index is 50%.
 
 -C[<n>]::
 --find-copies[=<n>]::

-- 
1.8.3.1

Junio C Hamano· Jul 5, 2013, 09:00 UTC · re: Fraser Tweedale · lore

Re: [PATCH] diff-options: document default similarity index

Fraser Tweedale <frase@frase.id.au> writes:

> The default similarity index of 50% is documented in gitdiffcore(7)
> but it is worth also mentioning it in the description of the
> -M/--find-renames option.

Is it?  I am not sure if it is worth it.

Fraser Tweedale· Jul 5, 2013, 10:00 UTC · re: Junio C Hamano · lore

Re: [PATCH] diff-options: document default similarity index

On Fri, Jul 05, 2013 at 02:00:40AM -0700, Junio C Hamano wrote:

Show 7 quoted lines

> Fraser Tweedale <frase@frase.id.au> writes:
> 
> > The default similarity index of 50% is documented in gitdiffcore(7)
> > but it is worth also mentioning it in the description of the
> > -M/--find-renames option.
> 
> Is it?  I am not sure if it is worth it.

The -M description goes on at some length to explain how to specify a particular value. Surely a brief mention of the default value is also warranted, especially since the pointer to gitdiffcore(7) for a more detailed explanation of the options appears quite a way below.