perlancar > File-Patch-Undoable > File::Patch::Undoable

Download:
File-Patch-Undoable-0.05.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.05   Source  

NAME ^

File::Patch::Undoable - Patch a file, with undo support

VERSION ^

This document describes version 0.05 of File::Patch::Undoable (from Perl distribution File-Patch-Undoable), released on 2015-08-17.

FAQ ^

Why use the patch program? Why not use a Perl module like Text::Patch?

The patch program has many nice features that Text::Patch lacks, e.g. applying reverse patch (needed to check fixed state and to undo), autodetection of patch type, ignoring whitespace and fuzz factor, etc.

KNOWN ISSUES ^

SEE ALSO ^

Rinci::Transaction

Text::Patch, PatchReader, Text::Patch::Rred

FUNCTIONS ^

patch(%args) -> [status, msg, result, meta]

{en_US Patch a file, with undo support}.

{en_US On do, will patch file with the supplied patch. On undo, will apply the reverse of the patch.

Note: Symlink is currently not permitted (except for the patch file). Patching is currently done with the patch program.

Unfixable state: file does not exist or not a regular file (directory and symlink included), patch file does not exist or not a regular file (but symlink allowed).

Fixed state: file exists, patch file exists, and patch has been applied.

Fixable state: file exists, patch file exists, and patch has not been applied. }

This function is idempotent (repeated invocations with same arguments has the same effect as single invocation). This function supports transactions.

Arguments ('*' denotes required arguments):

Special arguments:

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

HOMEPAGE ^

Please visit the project's homepage at https://metacpan.org/release/File-Patch-Undoable.

SOURCE ^

Source repository is at https://github.com/sharyanto/perl-File-Patch-Undoable.

BUGS ^

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=File-Patch-Undoable

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR ^

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2015 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: