.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "VCS::Lite::Delta 3pm" .TH VCS::Lite::Delta 3pm "2018-04-02" "perl v5.26.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" VCS::Lite::Delta \- VCS::Lite differences .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use VCS::Lite; \& \& # diff \& \& my $lit = VCS::Lite\->new(\*(Aq/home/me/foo1.txt\*(Aq); \& my $lit2 = VCS::Lite\->new(\*(Aq/home/me/foo2.txt\*(Aq); \& my $difftxt = $lit\->delta($lit2)\->diff; \& print OUTFILE $difftxt; \& \& # patch \& \& my $delt = VCS::Lite::Delta\->new(\*(Aq/home/me/patch.diff\*(Aq); \& my $lit3 = $lit\->patch($delt); \& print OUTFILE $lit3\->text; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides a Delta class for the differencing functionality of VCS::Lite .SH "API" .IX Header "API" .SS "new" .IX Subsection "new" The underlying object of VCS::Lite::Delta is an array of difference chunks (hunks) such as that returned by Algorithm::Diff. .PP The constructor takes the following forms: .PP .Vb 4 \& my $delt = VCS::Lite::Delta\->new( \*(Aq/my/file.diff\*(Aq,$sep); # File name \& my $delt = VCS::Lite::Delta\->new( \e*FILE,$sep); # File handle \& my $delt = VCS::Lite::Delta\->new( \e$string,$sep); # String as scalar ref \& my $delt = VCS::Lite::Delta\->new( \e@foo, $id1, $id2) # Array ref .Ve .PP \&\f(CW$sep\fR here is a regexp by which to split strings into tokens. The default is to use the natural perl mechanism of $/ (which is emulated when not reading from a file). The arrayref form is assuming an array of hunks such as the output from Algorithm::Diff::diff. .PP The other forms assume the input is the text form of a diff listing, either in diff format, or in unified format. The input is parsed, and errors are reported. .SS "diff" .IX Subsection "diff" .Vb 1 \& print OUTFILE $delt\->diff .Ve .PP This generates a standard diff format, for example: .PP 4c4 < Now wherefore stopp'st thou me? \&\-\-\- > Now wherefore stoppest thou me? .SS "udiff" .IX Subsection "udiff" .Vb 1 \& print OUTFILE $delt\->udiff .Ve .PP This generates a unified diff (like diff \-u) similar to the form in which patches are submitted. .SS "id" .IX Subsection "id" .Vb 2 \& my ($id1,$id2) = $delt\->id; \& $delt2\->id(\*(Aqfoo.pl@@1\*(Aq,\*(Aqfoo.pl@@3\*(Aq) .Ve .PP The \fIid\fR method allows get and set of the names associated with the two elements being diffed. The id is set for delta objects returned by VCS::Lite\->diff, to the element IDs of the VCS::Lite objects being diffed. .PP Diff format omits the file names, hence the IDs will not be populated by new. This is not the case with diff \-u format, which includes the file names which are passed in and available as IDs. .SS "hunks" .IX Subsection "hunks" .Vb 1 \& my @hunklist = $delt\->hunks .Ve .PP A hunk is a technical term for a section of input containing a difference. Each hunk is an arrayref, containing the block of lines. Each line is itself an arrayref, for example: .PP .Vb 4 \& [ \& [ \*(Aq+\*(Aq, 9, \*(Aquse Acme::Foo;\*(Aq], \& [ \*(Aq\-\*(Aq, 9, \*(Aquse Acme::Bar;\*(Aq], \& ] .Ve .PP See the documentation on Algorithm::Diff for more details of this structure. .SH "SEE ALSO" .IX Header "SEE ALSO" Algorithm::Diff. .SH "BUGS, PATCHES & FIXES" .IX Header "BUGS, PATCHES & FIXES" There are no known bugs at the time of this release. However, if you spot a bug or are experiencing difficulties that are not explained within the \s-1POD\s0 documentation, please send an email to barbie@cpan.org or submit a bug to the \&\s-1RT\s0 system (see link below). However, it would help greatly if you are able to pinpoint problems or even supply a patch. .PP http://rt.cpan.org/Public/Dist/Display.html?Name=VCS\-Lite .PP Fixes are dependent upon their severity and my availability. Should a fix not be forthcoming, please feel free to (politely) remind me. .SH "AUTHOR" .IX Header "AUTHOR" .Vb 2 \& Original Author: Ivor Williams (RIP) 2002\-2009 \& Current Maintainer: Barbie 2009\-2015 .Ve .SH "COPYRIGHT" .IX Header "COPYRIGHT" .Vb 2 \& Copyright (c) Ivor Williams, 2002\-2006 \& Copyright (c) Barbie, 2009\-2015 .Ve .SH "LICENCE" .IX Header "LICENCE" This distribution is free software; you can redistribute it and/or modify it under the Artistic Licence v2.