.\" 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 "Test::Fixme 3pm"
.TH Test::Fixme 3pm "2014-10-08" "perl v5.20.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::Fixme \- Check code for FIXMEs.
.SH "VERSION"
.IX Header "VERSION"
version 0.14
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& # In a test script like \*(Aqt/test\-fixme.t\*(Aq
\& use Test::Fixme;
\& run_tests();
\& 
\& # You can also tailor the behaviour.
\& use Test::Fixme;
\& run_tests( where    => \*(Aqlib\*(Aq,      # where to find files to check
\&            match    => \*(AqTODO\*(Aq,     # what to check for
\&            skip_all => $ENV{SKIP}  # should all tests be skipped
\& );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
When coding it is common to come up against problems that need to be
addressed but that are not a big deal at the moment. What generally
happens is that the coder adds comments like:
.PP
.Vb 1
\& # FIXME \- what about windows that are bigger than the screen?
\&
\& # FIXME \- add checking of user privileges here.
.Ve
.PP
Test::Fixme allows you to add a test file that ensures that none of
these get forgotten in the module.
.SH "METHODS"
.IX Header "METHODS"
.SS "run_tests"
.IX Subsection "run_tests"
By default run_tests will search for '\s-1FIXME\s0' in all the files it can
find in the project. You can change these defaults by using 'where' or
\&'match' as follows:
.PP
.Vb 3
\& run_tests( where => \*(Aqlib\*(Aq, # just check the modules.
\&            match => \*(AqTODO\*(Aq # look for things that are not done yet.
\& );
.Ve
.IP "where" 4
.IX Item "where"
Specifies where to search for files.  This can be a scalar containing a
single directory name, or it can be a list reference containing multiple
directory names.
.IP "match" 4
.IX Item "match"
Expression to search for within the files.  This may be a simple
string, or a qr//\-quoted regular expression.  For example:
.Sp
.Vb 1
\& match => qr/[T]ODO|[F]IXME|[B]UG/,
.Ve
.IP "filename_match" 4
.IX Item "filename_match"
Expression to filter file names.  This should be a qr//\-quoted regular
expression.  For example:
.Sp
.Vb 1
\& match => qr/\e.(:pm|pl)$/,
.Ve
.Sp
would only match .pm and .pl files under your specified directory.
.IP "manifest" 4
.IX Item "manifest"
Specifies the name of your \s-1MANIFEST\s0 file which will be used as the list
of files to test instead of \fIwhere\fR or \fIfilename_match\fR.
.Sp
.Vb 1
\& manifest => \*(AqMANIFEST\*(Aq,
.Ve
.IP "warn" 4
.IX Item "warn"
Do not fail when a \s-1FIXME\s0 or other pattern is matched.  Tests that would
have been failures will still issue a diagnostic that will be viewed
when you run \f(CW\*(C`prove\*(C'\fR without \f(CW\*(C`\-v\*(C'\fR, \f(CW\*(C`make test\*(C'\fR or \f(CW\*(C`./Build test\*(C'\fR.
.SH "HINTS"
.IX Header "HINTS"
If you want to match something other than '\s-1FIXME\s0' then you may find
that the test file itself is being caught. Try doing this:
.PP
.Vb 1
\& run_tests( match => \*(AqTO\*(Aq.\*(AqDO\*(Aq );
.Ve
.PP
You may also wish to suppress the tests \- try this:
.PP
.Vb 2
\& use Test::Fixme;
\& run_tests( skip_all => $ENV{SKIP_TEST_FIXME} );
.Ve
.PP
You can only run run_tests once per file. Please use several test
files if you want to run several different tests.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Devel::FIXME
.SH "ACKNOWLEDGMENTS"
.IX Header "ACKNOWLEDGMENTS"
Dave O'Neill added support for 'filename_match' and also being able to pass a
list of several directories in the 'where' argument. Many thanks.
.SH "AUTHOR"
.IX Header "AUTHOR"
original author: Edmund von der Burg
.PP
current maintainer: Graham Ollis <plicease@cpan.org>
.PP
contributors:
.PP
Dave O'Neill
.PP
gregor herrmann <gregoa@debian.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2014 by Edmund von der Burg <evdb@ecclestoad.co.uk>, Graham Ollis <plicease@cpan.org>.
.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.