develooper Front page | perl.perl5.porters | Postings from February 2016

"no documentation in Foo.pm" install warnings

Thread Next
From:
Dave Mitchell
Date:
February 16, 2016 10:19
Subject:
"no documentation in Foo.pm" install warnings
Message ID:
20160216101930.GC1747@iabyn.com
currently blead's 'make install' sends about 80 of the following to
stderr:

    no documentation in lib/Archive/Tar/Constant.pm
    no documentation in lib/CPAN/Author.pm
    no documentation in lib/CPAN/Bundle.pm
    ...

Since my goal is to make stderr empty during a blead build run, this makes
me unhappy.

This warning is generated by ./installman, which AFAKT is only used to
install man pages when installing blead, not when later installing CPAN
modules, so they don't get this warning.

So, is this a real warning: i.e. is it in some way bad that we're
installing modules that don't have any pod in them - if so then presumably
we should raise tickets with all affected modules asking that they add
pod.

Personally I think it's perfectly legal for a .pm file not to contain pod,
and that we shouldn't be checking for this. I.e. we should simply delete
this line from installman:

	    warn "no documentation in $mod\n" unless $opts{silent};

Other options might be to send the warning to stdout rather than stderr,
or maintain a whitelist of module filenames which we know are ok not to
contain pod. I don't like either of these options very much.


-- 
Diplomacy is telling someone to go to hell in such a way that they'll
look forward to the trip

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