/ 
App-pmpatcher-0.06
River stage one • 1 direct dependent • 1 total dependent
/ pmpatcher

NAME

pmpatcher - Apply a set of module patches on your Perl installation

VERSION

This document describes version 0.06 of pmpatcher (from Perl distribution App-pmpatcher), released on 2017-07-07.

SYNOPSIS

Usage:

% pmpatcher [options]

DESCRIPTION

You might have a set of patches that you want to apply on Perl modules on all your Perl installation. For example, currently as of this writing I have this on my patches directory:

pm-OrePAN-Archive-0.08-support_no_index_file.patch
pm-Pod-Elemental-PerlMunger-0.200002-DATA_encoding_fix.patch

These patches might be pending merge by the module maintainer, or are of private nature so might never be merged, or of any other nature. Applying module patches to an installation is a lightweight alternative to creating a fork for each of these modules.

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 module patches in a single directory (see patches_dir option). Also, you need to make sure that all your *.patch files match this name pattern:

pm-<MODULE-NAME-DASH-SEPARATED>-<VERSION>-<TOPIC>.patch

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

% pmpatcher --patches-dir ~/patches

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

Example result:

% pmpatcher
+--------------------------------------------------------------+--------+---------+
| item_id                                                      | status | message |
+--------------------------------------------------------------+--------+---------+
| pm-OrePAN-Archive-0.08-support_no_index_file.patch           | 200    | Applied |
| pm-Pod-Elemental-PerlMunger-0.200002-DATA_encoding_fix.patch | 200    | Applied |
+--------------------------------------------------------------+--------+---------+

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

% pmpatcher
+--------------------------------------------------------------+--------+-----------------+
| item_id                                                      | status | message         |
+--------------------------------------------------------------+--------+-----------------+
| pm-OrePAN-Archive-0.08-support_no_index_file.patch           | 304    | Already applied |
| pm-Pod-Elemental-PerlMunger-0.200002-DATA_encoding_fix.patch | 304    | Already applied |
+--------------------------------------------------------------+--------+-----------------+

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

OPTIONS

* marks required options.

Main options

--patches-dir=s*
--reverse, -R

Configuration options

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--no-config

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]

Other options

--dry-run

Run in simulation mode (also via DRY_RUN=1).

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C pmpatcher pmpatcher

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immediately have tab completion.

tcsh

To activate tcsh completion for this script, put:

complete pmpatcher 'p/*/`pmpatcher`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/pmpatcher.conf, ~/pmpatcher.conf, or /etc/pmpatcher.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

format (see --format)
log_level (see --log-level)
naked_res (see --naked-res)
patches_dir (see --patches-dir)
reverse (see --reverse)

ENVIRONMENT

PMPATCHER_OPT => str

Specify additional command-line options.

FILES

~/.config/pmpatcher.conf

~/pmpatcher.conf

/etc/pmpatcher.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-pmpatcher.

SOURCE

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

BUGS

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

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

progpatcher.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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