develooper Front page | perl.perl5.porters | Postings from October 2008

[PATCH] checkpods -> podchecker

Thread Next
From:
Alex Vandiver
Date:
October 29, 2008 04:39
Subject:
[PATCH] checkpods -> podchecker
Message ID:
1225254962.26274.20.camel@localhost
Heya,
perltodo says:
        F<pod/checkpods.PL> (and C<make check> in the F<pod/>
        subdirectory) implements a very basic check for pod files, but
        the errors it discovers aren't found by podchecker. Add this
        check to podchecker, get rid of checkpods and have C<make check>
        use podchecker.

I glanced at this, and it seems to be rather straightforard -- the only
errors that checkpods looks for are that there's a blank line before POD
directives, which is already a subset of what podchecker does.  Attached
are a number of patches relevant to fixing this TODO; the first four
apply to perl itself, the last two to Pod::Checker.

1. This changes all occurrences of checkpods to using podchecker
instead.

2. This cleans up various parts of the core POD to pass the now stricter
podchecker.

3. Remove all mention of checkpods, and checkpods itself.

4. Remove the compelted perltodo entry.

5. Indented blank lines in the middle of a verbatim block currently
warn.  As having blank lines in the middle of your example code isn't
uncommon, this patch makes such a circumstance not a warnable offense.

6. Pod::Checker thinks that "64bit" is a number, and warns about its
presence in the middle of a set of =item's with strings.  This patch
backs down the hair-trigger on "numeric" =item detection.

This is also my first foray into generating patches off of the perl git
repository, and into using git in general -- suggestions and nitpicks on
git usage would be appreciated.
 - Alex

Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About