https://github.com/hoytech/vcdiff-openvcdiff

open-vcdiff backend for Vcdiff
https://github.com/hoytech/vcdiff-openvcdiff

Last synced: 9 months ago
JSON representation

open-vcdiff backend for Vcdiff

• Host: GitHub
• URL: https://github.com/hoytech/vcdiff-openvcdiff
• Owner: hoytech
• Created: 2013-06-06T19:41:11.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2013-06-22T04:29:56.000Z (almost 13 years ago)
• Last Synced: 2025-01-25T05:42:48.408Z (over 1 year ago)
• Language: Perl
• Size: 180 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.pod
  • Changelog: Changes

Awesome Lists containing this project

README

          
=head1 NAME

Vcdiff::OpenVcdiff - open-vcdiff backend for Vcdiff

=head1 SYNOPSIS

    use Vcdiff::OpenVcdiff;

    my $delta = Vcdiff::OpenVcdiff::diff($source, $target);

    my $target2 = Vcdiff::OpenVcdiff::patch($source, $delta);

    ## $target2 eq $target

This module is a backend to the L module and isn't usually used directly.

=head1 DESCRIPTION

This module uses L which is a module that configures, builds, and installs Google's L library.

The alien package installs the C binary for your convenience but this module uses the C and C shared libraries so that the diffing computation is done in-process instead of forking processes.

=head1 PROS

=over

=item *

Apache licensed

=item *

open-vcdiff has a really cool feature that lets you re-use "hashed dictionaries" for multiple diff operations (but this module doesn't expose that yet).

=back

=head1 CONS

=over

=item *

Even with the streaming API C has a hard upper-limit of 2G file sizes and the default (which this module hasn't changed) is 64M so be warned.

=item *

If the source argument is a file handle, L will try to C the entire file into memory with L. As well as adding a dependency, this means that source files must be able to fit in your address space. Because of the file size limitation described above, this shouldn't be an issue. See the "STREAMING API" section of L for more details.

=item *

The L dependency takes a long time to compile compared to L although it's not a completely fair comparison because the alien module also runs open-vcdiff's test-suite (which is good).

=item *

The library writes to standard error in the event of errors and I don't believe there is any way to silence these messages.

=back

=head1 SEE ALSO

L

L

L

L

=head1 AUTHOR

Doug Hoyte, C<<  >>

=head1 COPYRIGHT & LICENSE

Copyright 2013 Doug Hoyte.

This module is licensed under the same terms as perl itself.

=cut