diff options
author | Austin Ziegler <austin@zieglers.ca> | 2014-05-06 00:08:02 -0400 |
---|---|---|
committer | Austin Ziegler <austin@zieglers.ca> | 2017-01-18 18:16:14 -0500 |
commit | 06ee20e929656d41c301f61fd447105c3840e410 (patch) | |
tree | 7325cd8e3279b71e5bc18302112e47cad3000a40 /README.rdoc | |
parent | 32727d6d0beb48672a1ee2d4a5c20bb81f7e301d (diff) | |
download | diff-lcs-06ee20e929656d41c301f61fd447105c3840e410.tar.gz |
diff-lcs 1.3
- Updated testing and gem infrastructure.
- Cleaning up documentation.
- Modernizing specs.
- Silence Ruby 2.4 Fixnum deprecation warnings. Fixes #36, #38.
- Ensure test dependencies are loaded. Fixes #33, #34 so that specs can be run
independently.
- Fix issue #1 with incorrect intuition of patch direction. Tentative fix, but
the failure cases pass now.
Diffstat (limited to 'README.rdoc')
-rw-r--r-- | README.rdoc | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/README.rdoc b/README.rdoc index fecf267..7a3350a 100644 --- a/README.rdoc +++ b/README.rdoc @@ -4,8 +4,8 @@ home :: https://github.com/halostatue/diff-lcs code :: https://github.com/halostatue/diff-lcs bugs :: https://github.com/halostatue/diff-lcs/issues rdoc :: http://rubydoc.info/github/halostatue/diff-lcs -continuous integration :: {<img src="https://travis-ci.org/halostatue/diff-lcs.png" />}[https://travis-ci.org/halostatue/diff-lcs] -test coverage :: {<img src="https://coveralls.io/repos/halostatue/diff-lcs/badge.png" alt="Coverage Status" />}[https://coveralls.io/r/halostatue/diff-lcs] +continuous integration :: {<img src="https://travis-ci.org/halostatue/diff-lcs.svg" />}[https://travis-ci.org/halostatue/diff-lcs] +test coverage :: {<img src="https://coveralls.io/repos/halostatue/diff-lcs/badge.svg" alt="Coverage Status" />}[https://coveralls.io/r/halostatue/diff-lcs] == Description @@ -13,14 +13,10 @@ Diff::LCS computes the difference between two Enumerable sequences using the McIlroy-Hunt longest common subsequence (LCS) algorithm. It includes utilities to create a simple HTML diff output format and a standard diff-like tool. -This is release 1.2.4, fixing a bug introduced after diff-lcs 1.1.3 that did -not properly prune common sequences at the beginning of a comparison set. -Thanks to Paul Kunysch for fixing this issue. - -Coincident with the release of diff-lcs 1.2.3, we reported an issue with -Rubinius in 1.9 mode -({rubinius/rubinius#2268}[https://github.com/rubinius/rubinius/issues/2268]). -We are happy to report that this issue has been resolved. +This is release 1.3, providing a tentative fix to a long-standing issue related +to incorrect detection of a patch direction. Also modernizes the gem +infrastructure, testing infrastructure, and provides a warning-free experience +to Ruby 2.4 users. == Synopsis @@ -71,12 +67,17 @@ or Array will perform best. Diff::LCS is a port of Perl's Algorithm::Diff that uses the McIlroy-Hunt longest common subsequence (LCS) algorithm to compute intelligent differences between two sequenced enumerable containers. The implementation is based on -Mario I. Wolczko's {Smalltalk version 1.2}[ftp://st.cs.uiuc.edu/pub/Smalltalk/MANCHESTER/manchester/4.0/diff.st] +Mario I. Wolczko's +{Smalltalk version 1.2}[ftp://st.cs.uiuc.edu/pub/Smalltalk/MANCHESTER/manchester/4.0/diff.st] (1993) and Ned Konz's Perl version {Algorithm::Diff 1.15}[http://search.cpan.org/~nedkonz/Algorithm-Diff-1.15/]. +Diff::LCS#sdiff and Diff::LCS#traverse_balanced were originally written for the +Perl version by Mike Schilli. -This library is called Diff::LCS because of an early version of Algorithm::Diff -which was restrictively licensed. +The algorithm is described in <em>A Fast Algorithm for Computing Longest Common +Subsequences</em>, CACM, vol.20, no.5, pp.350-353, May 1977, with a few minor +improvements to improve the speed. A simplified description of the algorithm, +originally written for the Perl version, was written by Mark-Jason Dominus. :include: Contributing.rdoc |