.\" Automatically generated by Pod::Man 2.27 (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::OurPkgVersion 3pm" .TH Dist::Zilla::Plugin::OurPkgVersion 3pm "2013-12-16" "perl v5.18.2" "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::OurPkgVersion \- no line insertion and does Package version with our .SH "VERSION" .IX Header "VERSION" version 0.005001 .SH "SYNOPSIS" .IX Header "SYNOPSIS" in dist.ini .PP .Vb 1 \& [OurPkgVersion] .Ve .PP in your modules .PP .Vb 1 \& # VERSION .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module was created as an alternative to Dist::Zilla::Plugin::PkgVersion and uses some code from that module. This module is designed to use a the more readable format \f(CW\*(C`our $VERSION = $version;\*(C'\fR as well as not change then number of lines of code in your files, which will keep your repository more in sync with your \s-1CPAN\s0 release. It also allows you slightly more freedom in how you specify your version. .SS "\s-1EXAMPLES\s0" .IX Subsection "EXAMPLES" in dist.ini .PP .Vb 3 \& ... \& version = 0.01; \& [OurPkgVersion] .Ve .PP in lib/My/Module.pm .PP .Vb 3 \& package My::Module; \& # VERSION \& ... .Ve .PP output lib/My/Module.pm .PP .Vb 3 \& package My::Module; \& our $VERSION = \*(Aq0.01\*(Aq; # VERSION \& ... .Ve .PP please note that whitespace before the comment is significant so .PP .Vb 5 \& package My::Module; \& BEGIN { \& # VERSION \& } \& ... .Ve .PP becomes .PP .Vb 5 \& package My::Module; \& BEGIN { \& our $VERSION = \*(Aq0.01\*(Aq; # VERSION \& } \& ... .Ve .PP while .PP .Vb 5 \& package My::Module; \& BEGIN { \& # VERSION \& } \& ... .Ve .PP becomes .PP .Vb 5 \& package My::Module; \& BEGIN { \& our $VERSION = \*(Aq0.01\*(Aq; # VERSION \& } \& ... .Ve .PP you can also add additional comments to your comment .PP .Vb 3 \& ... \& # VERSION: generated by DZP::OurPkgVersion \& ... .Ve .PP becomes .PP .Vb 3 \& ... \& our $VERSION = \*(Aq0.1.0\*(Aq; # VERSION: generated by DZP::OurPkgVersion \& ... .Ve .PP Also note, the package line is not in any way significant, it will insert the \&\f(CW\*(C`our $VERSION\*(C'\fR line anywhere in the file before \f(CW\*(C`# VERSION\*(C'\fR as many times as you've written \f(CW\*(C`# VERSION\*(C'\fR regardless of whether or not inserting it there is a good idea. OurPkgVersion will not insert a version unless you have \f(CW\*(C`# VERSION\*(C'\fR so it is a bit more work. .PP If you make a trial release, the comment will be altered to say so: .PP .Vb 1 \& # VERSION .Ve .PP becomes .PP .Vb 1 \& our $VERSION = \*(Aq0.01\*(Aq; # TRIAL VERSION .Ve .SH "METHODS" .IX Header "METHODS" .IP "munge_files" 4 .IX Item "munge_files" Override the default provided by Dist::Zilla::Role::FileMunger to limit the number of files to search to only be modules and executables. .IP "munge_file" 4 .IX Item "munge_file" tells which files to munge, see Dist::Zilla::Role::FileMunger .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests on the bugtracker website https://github.com/xenoterracide/dist\-zilla\-plugin\-ourpkgversion/issues .PP 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. .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .IP "\(bu" 4 Alexandr Ciornii .IP "\(bu" 4 Alexei Znamensky .IP "\(bu" 4 Christian Walde .IP "\(bu" 4 Christopher J. Madsen .IP "\(bu" 4 David Golden .SH "AUTHOR" .IX Header "AUTHOR" Caleb Cushing .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2013 by Caleb Cushing. .PP This is free software, licensed under: .PP .Vb 1 \& The Artistic License 2.0 (GPL Compatible) .Ve