The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
App-progpatcher-0.002
River stage one • 1 direct dependent • 1 total dependent
/ App::progpatcher

NAME

App::progpatcher - Apply a set of patches to your programs

VERSION

This document describes version 0.002 of App::progpatcher (from Perl distribution App-progpatcher), released on 2017-07-03.

SYNOPSIS

See progpatcher CLI.

DESCRIPTION

FUNCTIONS

progpatcher

Usage:

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

Apply a set of patches to your programs.

This is like pmpatcher except for programs. You might have a set of patches that you want to apply on programs in the PATH. For example, currently as of this writing I have this on my patches directory:

 prog-cpanm.20161127-only_use_uri_from_mirror_where_we_found_module.patch

These patches might be pending for merge upstream, or are of private nature so might never be merged, or of any other nature. Applying patches is a lightweight alternative to creating a fork for each of these programs.

This utility helps you making the process of applying these patches more convenient. Basically this utility just locates all the target modules and feeds all of these patches to the patch program.

To use this utility, first of all you need to gather all your program patches in a single directory (see patches_dir option). Also, you need to make sure that all patches you want to use match this name pattern:

 prog-<PROGRAM-NAME>.<TOPIC>.patch

This directory can be the same as the one you use for pmpatcher, since pmpatcher uses another prefix.

Then, to apply all the patches, you just call:

 % progpatcher --patches-dir ~/patches

(Or, you might also want to put patches_dir=/path/to/patches into ~/progpatcher.conf to save you from having to type the option repeatedly.)

Example result:

 % progpatcher
 +--------------------------------------------------------------------------+--------+---------+
 | item_id                                                                  | status | message |
 +--------------------------------------------------------------------------+--------+---------+
 | prog-cpanm.20161127-only_use_uri_from_mirror_where_we_found_module.patch | 200    | Applied |
 +--------------------------------------------------------------------------+--------+---------+

If you try to run it again, you might get:

 % progpatcher
 +--------------------------------------------------------------------------+--------+-----------------+
 | item_id                                                                  | status | message         |
 +--------------------------------------------------------------------------+--------+-----------------+
 | prog-cpanm.20161127-only_use_uri_from_mirror_where_we_found_module.patch | 304    | Already applied |
 +--------------------------------------------------------------------------+--------+-----------------+

There's also a --dry-run and a -R (--reverse) option, just like patch.

This function is not exported.

This function supports dry-run operation.

Arguments ('*' denotes required arguments):

  • patches_dir* => str

  • reverse => bool

Special arguments:

  • -dry_run => bool

    Pass -dry_run=>1 to enable simulation mode.

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/App-progpatcher.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-progpatcher.

BUGS

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

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.

SEE ALSO

pmpatcher.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 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.