Bug 326678 - New option to not use capped algorithm misses documentation
Summary: New option to not use capped algorithm misses documentation
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Compare (show other bugs)
Version: 3.6.2   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.7 M3   Edit
Assignee: Tomasz Zarna CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 327425
  Show dependency tree
 
Reported: 2010-09-30 10:56 EDT by Dani Megert CLA
Modified: 2010-10-26 06:32 EDT (History)
3 users (show)

See Also:


Attachments
patch (1012 bytes, text/plain)
2010-10-06 06:53 EDT, Krzysztof Kazmierczyk CLA
no flags Details
Image219_pref_cv.png (54.12 KB, image/png)
2010-10-06 07:17 EDT, Krzysztof Kazmierczyk CLA
no flags Details
Image219_pref_cv2.png (62.95 KB, image/png)
2010-10-06 07:18 EDT, Krzysztof Kazmierczyk CLA
no flags Details
"Text Compare" tab in classic theme (48.82 KB, image/png)
2010-10-06 08:03 EDT, Tomasz Zarna CLA
no flags Details
mylyn/context/zip (1.84 KB, application/octet-stream)
2010-10-06 08:04 EDT, Tomasz Zarna CLA
no flags Details
more precise description (1.14 KB, patch)
2010-10-06 08:05 EDT, Tomasz Zarna CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Dani Megert CLA 2010-09-30 10:56:07 EDT
I20100928-1200.

New option to not use capped algorithm misses documentation.
Comment 1 Szymon Brandys CLA 2010-10-06 05:35:45 EDT
Tomasz, I think Krzysztof could handle that.
Comment 2 Tomasz Zarna CLA 2010-10-06 05:47:38 EDT
I think we should consider backporting an eventual fix to 3.6.2 as well, shouldn't we?
Comment 3 Szymon Brandys CLA 2010-10-06 06:12:39 EDT
(In reply to comment #2)
> I think we should consider backporting an eventual fix to 3.6.2 as well,
> shouldn't we?

We should.
Comment 4 Krzysztof Kazmierczyk CLA 2010-10-06 06:53:14 EDT
Created attachment 180309 [details]
patch

Here is text patch.
Comment 5 Krzysztof Kazmierczyk CLA 2010-10-06 07:17:26 EDT
Created attachment 180313 [details]
Image219_pref_cv.png

Here is Image219_pref_cv.png which should be copied into images folder in org.eclipse.platform.doc.user.
Comment 6 Krzysztof Kazmierczyk CLA 2010-10-06 07:18:33 EDT
Created attachment 180314 [details]
Image219_pref_cv2.png

Here is Image219_pref_cv2.png which should be copied into images folder in
org.eclipse.platform.doc.user.
Comment 7 Tomasz Zarna CLA 2010-10-06 08:03:59 EDT
Created attachment 180316 [details]
"Text Compare" tab in classic theme
Comment 8 Tomasz Zarna CLA 2010-10-06 08:04:01 EDT
Created attachment 180317 [details]
mylyn/context/zip
Comment 9 Tomasz Zarna CLA 2010-10-06 08:05:50 EDT
Created attachment 180318 [details]
more precise description
Comment 10 Tomasz Zarna CLA 2010-10-06 08:32:13 EDT
Dani, is the description clear enough in your opinion?

"The capping mechanism is used to speed up finding differences in large files. In that case, the result may be inaccurate and contain too many changes. Turn this option on, if you prefer a precise result in favour of possibly longer calculation time."
Comment 11 Dani Megert CLA 2010-10-07 02:25:03 EDT
(In reply to comment #10)
> Dani, is the description clear enough in your opinion?
> 
> "The capping mechanism is used to speed up finding differences in large files.
> In that case, the result may be inaccurate and contain too many changes. Turn
> this option on, if you prefer a precise result in favour of possibly longer
> calculation time."

AFAIK "inaccurate and contain many changes" is wrong: it finds all changes but the displayed region that covers them might be bigger than needed.
Comment 12 Tomasz Zarna CLA 2010-10-09 08:59:15 EDT
(In reply to comment #11)

> AFAIK "inaccurate and contain many changes" is wrong: it finds all changes but
> the displayed region that covers them might be bigger than needed.

Right, what about: "The capping mechanism is used to speed up finding differences in large files. In case where the capping happens the result can either be correct or it can contain too many changes, but it never misses any change. Turn
this option on, if you prefer a precise result in favour of possibly longer
calculation time." ?
Comment 13 Dani Megert CLA 2010-10-11 03:07:52 EDT
Looks good. Minor change:
>either be correct or it can contain too many changes,
either be correct or it can display too many changes,
Comment 14 Tomasz Zarna CLA 2010-10-11 05:21:58 EDT
Done, thanks Dani. The doc has been updated in HEAD. Filed bug 327425 for backporting the same fix to 3.6.x branch.
Comment 15 Dani Megert CLA 2010-10-26 06:32:22 EDT
Verified in I20101025-1800.