Bug 116113 - [Doc] fuzz factor description wrong/inconsistent with actual patch definition
Summary: [Doc] fuzz factor description wrong/inconsistent with actual patch definition
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Compare (show other bugs)
Version: 3.1   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 3.4 RC4   Edit
Assignee: Tomasz Zarna CLA
QA Contact:
URL:
Whiteboard: hasPatch
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2005-11-12 11:37 EST by Joseph P. Skudlarek CLA
Modified: 2008-06-16 09:32 EDT (History)
3 users (show)

See Also:

Attachments
Updated "Working with patches" section (2.00 KB, patch)
2008-06-03 10:17 EDT, Tomasz Zarna CLA 		no flags Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Joseph P. Skudlarek CLA 2005-11-12 11:37:51 EST 
fuzz factor description wrong/inconsistent with actual patch definition

The Workbench User Guide, in the "Working with Patches" section, states

# Adjust the 'Maximum fuzz factor' (patch terminology). This factor
   determines how far from its original line a hunk is allowed to
   match. The default is two. So if a hunk does not match at the line
   given in the patch file, the Resource Patcher tries to match the hunk
   'fuzz' number of lines before or after the position.

The fuzz factor specified and used by patch is actually a very different
beast; but given how (poorly) it is documented, the confusion is
understandable.

What the Workbench User Guide describes is actually the patch "offset"
value -- how far away from the nominal location the match was found --
and patch can easily use rather large offsets.  The fuzz factor is how
many lines from the top and bottom of the context will be ignored when
locating a match.
Comment 1 Michael Valenta CLA 2005-11-13 22:04:42 EST 
Thanks. We'll update the doc before 3.2 ships.
Comment 2 Michael Valenta CLA 2006-05-25 16:30:17 EDT 
Fixed
Comment 3 Tomasz Zarna CLA 2007-10-20 08:55:45 EDT 
The description from the Workbench User Guide still uses term of "location" which is inadequate to how the fuzz factor actually works. Moreover, as pointed in bug 131574, comment 7, "Maximum fuzz factor" is no longer a proper name for the field on the Apply Patch wizard.
Comment 4 Martin Oberhuber CLA 2008-02-28 14:34:44 EST 
I assume that this has been reopened... would it make sense to update the target milestone to avoid confusion?
Comment 5 Tomasz Zarna CLA 2008-02-29 05:35:17 EST 
(In reply to comment #4)
> would it make sense to update the target milestone to avoid confusion?

Sorry, my fault.
Comment 6 Tomasz Zarna CLA 2008-06-03 10:17:53 EDT 
Created attachment 103314 [details]
Updated "Working with patches" section
Comment 7 Tomasz Zarna CLA 2008-06-05 13:49:16 EDT 
Applied to CVS HEAD with some minor modifications.
Comment 8 Szymon Brandys CLA 2008-06-16 09:32:43 EDT 
Verified in I20080613-2000.