On Thu, Aug 21, 2003 at 10:36:55PM +0300, Jarkko Hietaniemi wrote:
> Anyone up for some pod cleanup for the maint @ 20803 snapshot?
> First do 'make all' and then
>
> ./perl -Ilib pod/podchecker pod/*.pod
>
> and see whether the moanings are fixworthy. If not, please fix
> also podchecker :-)
I have made the obvious fixes to reduce the warnings and syntax errors from
podchecker.
After the attached patches, the following warnings remain:
445 instances of
*** WARNING: multiple occurrence of link target '...' at line -
in file ...
These warnings are correct. e.g., in perl561delta.pod, there are two
occurrences of C<< =item SDBM_File >>. I'm not sure what should be done
about these.
1 instance of
*** WARNING: =item type mismatch ('definition' vs. 'number') at line 336
in file pod/perldiag.pod
3 instances of
*** WARNING: =item type mismatch ('definition' vs. 'number') at line ...
in file pod/perltoc.pod
These warnings are more or less correct also. They occur with POD such as
=item ASCII
=item 13 variant characters
The second item is parsed as a numeric label followed by the text of the
item. Perhaps podchecker should skip this warning when the first type is
'definition'?
2 instances of
*** WARNING: previous =item has no contents at line ... in file pod/perltoc.pod
These are a result of the questionable type mismatch.
19 instances of
*** WARNING: (section) in '...(...)' deprecated at line ... in file ...
I don't know whether these warnings are correct that L<manpage(section)>,
(e.g. L<flock(3)>), is deprecated. If not, the warning can be removed. If
so, what is the replacement syntax?
26 instances of
*** WARNING: empty section in previous paragraph at line ...
in file pod/perltodo.pod
These warnings are correct; there are several =head# entries in
perltodo.pod. They should probably be filled in by the appropriate
persons.
Ronald
Attachment: podcleanup.patch Attachment: lib_pod.patch