diff options
Diffstat (limited to 'upstream/debian-unstable/man3/CPAN::Meta::Merge.3perl')
| -rw-r--r-- | upstream/debian-unstable/man3/CPAN::Meta::Merge.3perl | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/CPAN::Meta::Merge.3perl b/upstream/debian-unstable/man3/CPAN::Meta::Merge.3perl new file mode 100644 index 00000000..5a3d6476 --- /dev/null +++ b/upstream/debian-unstable/man3/CPAN::Meta::Merge.3perl @@ -0,0 +1,145 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" 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 +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. 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 +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "CPAN::Meta::Merge 3perl" +.TH CPAN::Meta::Merge 3perl 2024-01-12 "perl v5.38.2" "Perl Programmers Reference Guide" +.\" 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 +CPAN::Meta::Merge \- Merging CPAN Meta fragments +.SH VERSION +.IX Header "VERSION" +version 2.150010 +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 2 +\& my $merger = CPAN::Meta::Merge\->new(default_version => "2"); +\& my $meta = $merger\->merge($base, @additional); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +.SH METHODS +.IX Header "METHODS" +.SS new +.IX Subsection "new" +This creates a CPAN::Meta::Merge object. It takes one mandatory named +argument, \f(CW\*(C`version\*(C'\fR, declaring the version of the meta-spec that must be +used for the merge. It can optionally take an \f(CW\*(C`extra_mappings\*(C'\fR argument +that allows one to add additional merging functions for specific elements. +.PP +The \f(CW\*(C`extra_mappings\*(C'\fR arguments takes a hash ref with the same type of +structure as described in CPAN::Meta::Spec, except with its values as +one of the defined merge strategies or a code ref +to a merging function. +.PP +.Vb 11 +\& my $merger = CPAN::Meta::Merge\->new( +\& default_version => \*(Aq2\*(Aq, +\& extra_mappings => { +\& \*(Aqoptional_features\*(Aq => \e&custom_merge_function, +\& \*(Aqx_custom\*(Aq => \*(Aqset_addition\*(Aq, +\& \*(Aqx_meta_meta\*(Aq => { +\& name => \*(Aqidentical\*(Aq, +\& tags => \*(Aqset_addition\*(Aq, +\& } +\& } +\& ); +.Ve +.SS merge(@fragments) +.IX Subsection "merge(@fragments)" +Merge all \f(CW@fragments\fR together. It will accept both CPAN::Meta objects and +(possibly incomplete) hashrefs of metadata. +.SH "MERGE STRATEGIES" +.IX Header "MERGE STRATEGIES" +\&\f(CW\*(C`merge\*(C'\fR uses various strategies to combine different elements of the CPAN::Meta objects. The following strategies can be used with the extra_mappings argument of \f(CW\*(C`new\*(C'\fR: +.IP identical 4 +.IX Item "identical" +The elements must be identical +.IP set_addition 4 +.IX Item "set_addition" +The union of two array refs +.Sp +.Vb 1 +\& [ a, b ] U [ a, c] = [ a, b, c ] +.Ve +.IP uniq_map 4 +.IX Item "uniq_map" +Key value pairs from the right hash are merged to the left hash. Key +collisions are only allowed if their values are the same. This merge +function will recurse into nested hash refs following the same merge +rules. +.IP improvise 4 +.IX Item "improvise" +This merge strategy will try to pick the appropriate predefined strategy +based on what element type. Array refs will try to use the +\&\f(CW\*(C`set_addition\*(C'\fR strategy, Hash refs will try to use the \f(CW\*(C`uniq_map\*(C'\fR +strategy, and everything else will try the \f(CW\*(C`identical\*(C'\fR strategy. +.SH AUTHORS +.IX Header "AUTHORS" +.IP \(bu 4 +David Golden <dagolden@cpan.org> +.IP \(bu 4 +Ricardo Signes <rjbs@cpan.org> +.IP \(bu 4 +Adam Kennedy <adamk@cpan.org> +.SH "COPYRIGHT AND LICENSE" +.IX Header "COPYRIGHT AND LICENSE" +This software is copyright (c) 2010 by David Golden, Ricardo Signes, Adam Kennedy and Contributors. +.PP +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. |