.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "Test::CheckChanges 3pm"
.TH Test::CheckChanges 3pm "2010-03-06" "perl v5.10.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"
Test::CheckChanges \- Check that the Changes file matches the distribution.
.SH "VERSION"
.IX Header "VERSION"
Version 0.14
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Test::CheckChanges;
\& ok_changes();
.Ve
.PP
You can make the test optional with
.PP
.Vb 2
\& use Test::More;
\& eval { require Test::CheckChanges };
\&
\& if ($@) {
\&     plan skip_all => \*(AqTest::CheckChanges required for testing the Changes file\*(Aq;
\& }
\& ok_changes();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module checks that you \fIChanges\fR file has an entry for the current version 
of the \fBModule\fR being tested.
.PP
The version information for the distribution being tested is taken out
of the Build data, or if that is not found, out of the Makefile.
.PP
It then attempts to open, in order, a file with the name \fIChanges\fR or \fI\s-1CHANGES\s0\fR.
.PP
The \fIChanges\fR file is then parsed for version numbers.  If one and only one of the
version numbers matches the test passes.  Otherwise the test fails.
.PP
A message with the current version is printed if the test passes, otherwise
dialog messages are printed to help explain the failure.
.PP
The \fIexamples\fR directory contains examples of the different formats of
\&\fIChanges\fR files that are recognized.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
All functions listed below are exported to the calling namespace.
.SS "ok_changes( )"
.IX Subsection "ok_changes( )"
.RS 4
The ok_changes method takes no arguments and returns no value.
.RE
.SH "CHANGES FILE FORMAT"
.IX Header "CHANGES FILE FORMAT"
Currently this package parses 4 different types of \f(CW\*(C`Changes\*(C'\fR files.
The first is the common, free style, \f(CW\*(C`Changes\*(C'\fR file where the version
is first item on an unindented line:
.PP
.Vb 2
\& 0.01  Fri May  2 15:56:25 EDT 2008
\&       \- more info
.Ve
.PP
The second type of file parsed is the Module::Changes::YAML format changes file.
.PP
The third type of file parsed has the version number proceeded by an * (asterisk).
.PP
.Vb 1
\& Revision history for Perl extension Foo::Bar
\&
\& * 1.00
\&
\& Is this a bug or a feature
.Ve
.PP
The fourth type of file parsed starts the line with the word Version
followed by the version number.
.PP
.Vb 3
\& Version 6.00  17.02.2008
\&  + Oops. Fixed version number. \*(Aq5.10\*(Aq is less than \*(Aq5.9\*(Aq. I thought
\&    CPAN would handle this but apparently not..
.Ve
.PP
There are examples of these Changes file in the \fIexamples\fR directory.
.PP
Create an \s-1RT\s0 if you need a different format file supported.  If it is not horrid, I will add it.
.PP
The Debian style \f(CW\*(C`Changes\*(C'\fR file will likely be the first new format added.
.SH "BUGS"
.IX Header "BUGS"
Please open an \s-1RT\s0 if you find a bug.
.PP
<http://rt.cpan.org/Public/Dist/Display.html?Name=Test\-CheckChanges>
.SH "AUTHOR"
.IX Header "AUTHOR"
\&\*(L"G. Allen Morris \s-1III\s0\*(R" <gam3@gam3.net>
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright (C) 2008\-2010 G. Allen Morris \s-1III\s0, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.