Search code examples
algorithmdiffvcdiff

How does a 'diff' algorithm work, e.g. in VCDIFF and DiffMerge?


I've been looking like crazy for an explanation of a diff algorithm that works and is efficient.

The closest I got is this link to RFC 3284 (from several Eric Sink blog posts), which describes in perfectly understandable terms the data format in which the diff results are stored. However, it has no mention whatsoever as to how a program would reach these results while doing a diff.

I'm trying to research this out of personal curiosity, because I'm sure there must be tradeoffs when implementing a diff algorithm, which are pretty clear sometimes when you look at diffs and wonder "why did the diff program chose this as a change instead of that?"...

Where can I find a description of an efficient algorithm that'd end up outputting VCDIFF?
By the way, if you happen to find a description of the actual algorithm used by SourceGear's DiffMerge, that'd be even better.

Note: longest common subsequence doesn't seem to be the algorithm used by VCDIFF. It looks like they're doing something smarter, given the data format they use.


Solution

  • An O(ND) Difference Algorithm and its Variations (1986, Eugene W. Myers) is a fantastic paper and you may want to start there. It includes pseudo-code and a nice visualization of the graph traversals involved in doing the diff.

    Section 4 of the paper introduces some refinements to the algorithm that make it very effective.

    Successfully implementing this will leave you with a very useful tool in your toolbox (and probably some excellent experience as well).

    Generating the output format you need can sometimes be tricky, but if you have understanding of the algorithm internals, then you should be able to output anything you need. You can also introduce heuristics to affect the output and make certain tradeoffs.

    Here is a page that includes a bit of documentation, full source code, and examples of a diff algorithm using the techniques in the aforementioned algorithm.

    The source code appears to follow the basic algorithm closely and is easy to read.

    There's also a bit on preparing the input, which you may find useful. There's a huge difference in output when you are diffing by character or token (word).