.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" 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 turned on, 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Dist::Zilla::Plugin::Test::ReportPrereqs 3pm" .TH Dist::Zilla::Plugin::Test::ReportPrereqs 3pm "2014-08-13" "perl v5.20.0" "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" Dist::Zilla::Plugin::Test::ReportPrereqs \- Report on prerequisite versions during automated testing .SH "VERSION" .IX Header "VERSION" version 0.019 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 4 \& # in dist.ini \& [Test::ReportPrereqs] \& include = Acme::FYI \& exclude = Acme::Dont::Care .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This Dist::Zilla plugin adds a \fIt/00\-report\-prereqs.t\fR test file and an accompanying \&\fIt/00\-report\-prereqs.dd\fR data file. It reports the version of all modules listed in the distribution metadata prerequisites (including 'recommends', 'suggests', etc.). However, any 'develop' prereqs are not reported (unless they show up in another category). .PP If a \fI\s-1MYMETA\s0.json\fR file exists and CPAN::Meta is installed on the testing machine, \fI\s-1MYMETA\s0.json\fR will be examined for prerequisites in addition, as it would include any dynamic prerequisites not set in the distribution metadata. .PP Versions are reported based on the result of \f(CW\*(C`parse_version\*(C'\fR from ExtUtils::MakeMaker, which means prerequisite modules are not actually loaded (which avoids various edge cases with certain modules). Parse errors are reported as \*(L"undef\*(R". If a module is not installed, \*(L"missing\*(R" is reported instead of a version string. .PP Additionally, if CPAN::Meta is installed, unfulfilled required prerequisites are reported after the list of all versions based on either \fI\s-1MYMETA\s0\fR (preferably) or \fI\s-1META\s0\fR (fallback). .SH "CONFIGURATION" .IX Header "CONFIGURATION" .SS "include" .IX Subsection "include" An \f(CW\*(C`include\*(C'\fR attribute can be specified (multiple times) to add modules to the report. This can be useful if there is a module in the dependency chain that is problematic but is not directly required by this project. These modules will be listed in an \*(L"Other Modules\*(R" section at the end of the report. .SS "exclude" .IX Subsection "exclude" An \f(CW\*(C`exclude\*(C'\fR attribute can be specified (multiple times) to remove modules from the report (if you had a reason to do so). .SS "verify_prereqs" .IX Subsection "verify_prereqs" When set, installed versions of all 'requires' prerequisites are verified against those specified. Defaults to true, but requires CPAN::Meta to be installed. .SH "SEE ALSO" .IX Header "SEE ALSO" Other Dist::Zilla::Plugins do similar things in slightly different ways that didn't suit my style and needs. .IP "\(bu" 4 Dist::Zilla::Plugin::Test::PrereqsFromMeta \*(-- requires prereqs to be satisfied .IP "\(bu" 4 Dist::Zilla::Plugin::Test::ReportVersions \*(-- bundles a copy of YAML::Tiny, reads prereqs only from \s-1META\s0.yml, and attempts to load them with \f(CW\*(C`require\*(C'\fR .IP "\(bu" 4 Dist::Zilla::Plugin::ReportVersions::Tiny \*(-- static list only, loads modules with \f(CW\*(C`require\*(C'\fR .SH "SUPPORT" .IX Header "SUPPORT" .SS "Bugs / Feature Requests" .IX Subsection "Bugs / Feature Requests" Please report any bugs or feature requests through the issue tracker at . You will be notified automatically of any progress on your issue. .SS "Source Code" .IX Subsection "Source Code" This is open source software. The code repository is available for public review and contribution under the terms of the license. .PP .PP .Vb 1 \& git clone https://github.com/dagolden/Dist\-Zilla\-Plugin\-Test\-ReportPrereqs.git .Ve .SH "AUTHOR" .IX Header "AUTHOR" David Golden .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .IP "\(bu" 4 Brendan Byrd .IP "\(bu" 4 Karen Etheridge .IP "\(bu" 4 Kent Fredric .IP "\(bu" 4 Randy Stauner .IP "\(bu" 4 Yanick Champoux .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2012 by David Golden. .PP This is free software, licensed under: .PP .Vb 1 \& The Apache License, Version 2.0, January 2004 .Ve