JezK
Edit File: CPAN::Meta::Check.3pm
.\" Automatically generated by Pod::Man 4.10 (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 .. .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::Check 3pm" .TH CPAN::Meta::Check 3pm "2016-11-25" "perl v5.28.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" CPAN::Meta::Check \- Verify requirements in a CPAN::Meta object .SH "VERSION" .IX Header "VERSION" version 0.014 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& warn "$_\en" for verify_dependencies($meta, [qw/runtime build test/], \*(Aqrequires\*(Aq); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module verifies if requirements described in a CPAN::Meta object are present. .SH "FUNCTIONS" .IX Header "FUNCTIONS" .ie n .SS "check_requirements($reqs, $type, $incdirs)" .el .SS "check_requirements($reqs, \f(CW$type\fP, \f(CW$incdirs\fP)" .IX Subsection "check_requirements($reqs, $type, $incdirs)" This function checks if all dependencies in \f(CW$reqs\fR (a CPAN::Meta::Requirements object) are met, taking into account that 'conflicts' dependencies have to be checked in reverse. It returns a hash with the modules as keys and any problems as values; the value for a successfully found module will be undef. Modules are searched for in \f(CW@$incdirs\fR, defaulting to \f(CW@INC\fR. .ie n .SS "verify_dependencies($meta, $phases, $types, $incdirs)" .el .SS "verify_dependencies($meta, \f(CW$phases\fP, \f(CW$types\fP, \f(CW$incdirs\fP)" .IX Subsection "verify_dependencies($meta, $phases, $types, $incdirs)" Check all requirements in \f(CW$meta\fR for phases \f(CW$phases\fR and type \f(CW$type\fR. Modules are searched for in \f(CW@$incdirs\fR, defaulting to \f(CW@INC\fR. \f(CW$meta\fR should be a CPAN::Meta::Prereqs or CPAN::Meta object. .ie n .SS "requirements_for($meta, $phases, $types)" .el .SS "requirements_for($meta, \f(CW$phases\fP, \f(CW$types\fP)" .IX Subsection "requirements_for($meta, $phases, $types)" \&\fBThis function is deprecated and may be removed at some point in the future, please use CPAN::Meta::Prereqs\->merged_requirements instead.\fR .PP This function returns a unified CPAN::Meta::Requirements object for all \f(CW$type\fR requirements for \f(CW$phases\fR. \f(CW$phases\fR may be either one (scalar) value or an arrayref of valid values as defined by the CPAN::Meta spec. \f(CW$type\fR must be a relationship as defined by the same spec. \f(CW$meta\fR should be a CPAN::Meta::Prereqs or CPAN::Meta object. .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 Test::CheckDeps .IP "\(bu" 4 CPAN::Meta .SH "AUTHOR" .IX Header "AUTHOR" Leon Timmermans <leont@cpan.org> .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2012 by Leon Timmermans. .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.