[perl #37100] [PATCH] Pod tests + fixes

This patch adds a new test, t/docs/pod.t, that scans through the parrot
tree and checks the Pod syntax of all files identified by Pod::Find as
containing Pod markup. This is invoked by a new test target named
"doc_tests" which has been added to the "fulltest" target. This patch
also fixes all of the syntax errors currently found by the new test.

MANIFEST | 1 +
charset/gen_tables.pl | 4 ++++
config/gen/makefiles/root.in | 7 ++++++-
docs/pdds/pdd04_datatypes.pod | 4 ----
docs/pdds/pdd09_gc.pod | 4 ++--
lib/Test/More.pm | 3 +++
ops/pic.ops | 4 ++--
t/doc/pod.t | 29 +++++++++++++++++++++++++++++
8 files changed, 47 insertions(+), 9 deletions(-)

Hi,

I have applied the POD syntax fixes of this patch.

't/doc/pod.t' also make a lot of sense. However could you comment on the
relation to t/perl/Parrot_Docs.t ? It looks like it checks the same
things as 'pod.t'.
I wonder whether it is worthwile to maintain Parrot::Docs, when the
needed functionality is already at CPAN.

CU, Bernhard

--
/* Bernhard.S...@gmx.de */

I completely missed the fact that Parrot_Docs.t even existed, DOH!
Although, it looks like there would be no duplication of testing. The
pod.t file I submitted searches through the entire parrot tree and test
the format of the all Pod containing files. While Parrot_Docs.t
contains regression tests for the Parrot::Docs::* collection of modules.

As to whether or not it's worth the effort to maintain the in tree pod
checking modules, I'd say that boils down to: Is Pod::Simple (used by
Test::Pod) as or more rigorous than the checking done by
Parrot::Docs::File. Perhaps Sean Burke can take a look at the code and
comment?

Cheers,

-J

--

Great. Were the make targets left out on purpose?

-J

--

Nevermind. I can see the changes now.

-J

--

Hi,

the changes to 'root.in' show up in Makefile only after 'perl Configure.pl'.

In ticket 37104 you mentioned spell checking with 'aspell'. Did you
encounter words
that were not in the aspell-en 6.0.0 dictionary? If so it could be
worthwile to a special aspell-dictionary to the Parrot distribution and
add a spelling test target.
Also some terms for 'glossary.pod' might crop up.

CU, Bernhard

I did encounter a large number of words that weren't in the aspell-en
dictionary. Unfortunately, I didn't save them out to a separate file.
I've tried to separate the parrot specific words from all the other junk
in my personal words list with this code snippet.

--
open(my $wlist, "$ENV{HOME}/.aspell.en.pws") or die "can't open file: $!";

foreach my $word (<$wlist>) {
chomp $word;
my @matches = File::Find::Rule->file
->grep( qr/\b$word\b/ )
->in( './docs' );
print "$word\n" if scalar @matches;
}

close($wlist) or die "can't close file: $!";
--

The results (sorted) are attached.

A spelling test target is a good idea, I'll throw something together
when I have a chance.

Cheers,

-J

--