[lib] using Pod::Checker to check pod #1053

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
2 participants
Contributor

paultcochrane commented Mar 8, 2014

Pod::Simple was missing many warnings and errors and thus has been replaced
by Pod::Checker. This is sensible, since the advice given by the
pod_syntax.t test when errors occur is that one should use podchecker to
investigate errors in detail, thus we should be using Pod::Checker
internally to begin with.

My only issue with this patch is that I've added a dependency on Capture::Tiny in order to ignore the output from Pod::Checker; I hope this is OK.

Comments welcome.

@paultcochrane paultcochrane [lib] using Pod::Checker to check pod
Pod::Simple was missing many warnings and errors and thus has been replaced
by Pod::Checker.  This is sensible, since the advice given by the
`pod_syntax.t` test when errors occur is that one should use `podchecker` to
investigate errors in detail, thus we should be using Pod::Checker
internally to begin with.
4cbcfb0
Member

rurban commented Mar 8, 2014

thanks. need to check.
I did the same also in private but stumbled over the wrong podchecker warning with L<|>

podchecker docs/*.pod docs/*/*.pod
*** WARNING: node 'pdd19_pir.pod/Parameter Passing and Getting Flags' contains non-escaped | or / at line 72 in file docs/compiler_faq.pod
*** WARNING: node 'pdds/pdd20_lexical_vars.pod/Nested Subroutines Have Outies; the ":outer" attribute' contains non-escaped | or / at line 261 in file docs/compiler_faq.pod
*** WARNING: node 'pdds/pdd20_lexical_vars.pod' contains non-escaped | or / at line 312 in file docs/compiler_faq.pod
*** WARNING: node 'build/pmc2c.pl' contains non-escaped | or / at line 677 in file docs/compiler_faq.pod
*** WARNING: node 'dynpmc/Makefile' contains non-escaped | or / at line 680 in file docs/compiler_faq.pod
docs/compiler_faq.pod pod syntax OK.
docs/configuration.pod pod syntax OK.
docs/debug.pod pod syntax OK.
docs/debugger.pod pod syntax OK.
docs/embed.pod pod syntax OK.
docs/embed_new.pod pod syntax OK.
docs/extend.pod pod syntax OK.
*** WARNING: node 'pdds/pdd19_pir.pod' contains non-escaped | or / at line 38 in file docs/faq.pod
...

@rurban rurban pushed a commit that referenced this pull request Mar 8, 2014

Reini Urban [docs] fix most podchecker issues
at least the valid ones. podchecker warns about valid
L<name|link> tags.

See podchecker docs/*.pod docs/*/*.pod (not the book)
See also GH #1053 to use Pod::Checker in the test and
GH #1054 to relax the fill-column: 100 coda to allow 78
also, to write valid pod.
8e19822
Member

rurban commented Mar 8, 2014

This gave me

# You should use podchecker to check the 51 failed files.
# compilers/imcc/api.c
# compilers/pct/src/PCT/Grammar.pir
# compilers/pge/PGE/Exp.pir
# compilers/pge/PGE/Perl6Regex.pir
# compilers/tge/tgc.pir
# docs/dev/pcc_state.pod
# docs/project/release_manager_guide.pod
# examples/c/nanoparrot.c
# examples/nci/QtHelloWorld.pir
# examples/pir/coop_threads.pir
# examples/threads/matrix_part.winxed
# lib/IO/CaptureOutput.pm
# lib/Parrot/Configure/Step.pm
# lib/Parrot/Distribution.pm
# lib/Parrot/Docs/Text2HTML.pm
# lib/Parrot/Vtable.pm
# runtime/parrot/library/OpenGL/Math.pir
# runtime/parrot/library/PGE/Perl6Grammar.pir
# runtime/parrot/library/Range.pir
# src/alarm.c
# src/dynpmc/rational.pmc
# src/gc/gc_gms.c
# src/gc/gc_ms.c
# src/gc/string_gc.c
# src/interp/inter_cb.c
# src/io/userhandle.c
# src/ops/io.ops
# src/platform/generic/misc.c
# src/platform/win32/misc.c
# src/pmc.c
# src/pmc/filehandle.pmc
# src/pmc/handle.pmc
# src/pmc/key.pmc
# src/pmc/opcode.pmc
# src/pmc/packfilebytecodesegment.pmc
# src/pmc/packfileopmap.pmc
# src/pmc/pmclist.pmc
# src/pmc/proxy.pmc
# src/pmc/stringbuilder.pmc
# src/runcore/trace.c
# src/scheduler.c
# src/string/encoding.c
# src/string/encoding/ascii.c
# src/string/encoding/binary.c
# src/string/encoding/latin1.c
# src/string/encoding/null.c
# src/string/encoding/shared.c
# t/op/spawnw.t
# t/pmc/namespace.t
# tools/dev/create_language.pl
# tools/dev/mk_language_shell.in

@rurban rurban pushed a commit that referenced this pull request Mar 8, 2014

Reini Urban [docs] fix all podchecker issues [GH #1053]
to skip:
tools/dev/create_language.pl
tools/dev/mk_language_shell.in
lib/IO/CaptureOutput.pm

to ignore | warning:
docs/project/release_manager_guide.pod
af695a1

rurban referenced this pull request Mar 9, 2014

Closed

Fix pod errors #1055

Member

rurban commented Mar 10, 2014

Done with 83e4449
See GH #1055

rurban closed this Mar 10, 2014

paultcochrane deleted the paultcochrane:ptc/check_with_pod_checker branch Mar 16, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment