From b879da0f8636785e611f9240e436a0af523f4c08 Mon Sep 17 00:00:00 2001 From: Karl Williamson Date: Mon, 8 Aug 2011 11:32:48 -0600 Subject: [PATCH] podcheck.t: Change verbatim line length max to 79 Some pagers reserve a column for their own use. This patch has podcheck.t warn if a verbatim line will wrap when such a pager is used in an 80 column terminal window. This effectively restores the situation to what it was before commit 2cd46bfd6d03cd8826c5e968efdd36416191bc8f, but the message is now honest about the situation, i.e., that 79 colummns are effectively the max without a warning. The point of this is to give a number to shoot for, 79, that will work almost always (I believe though that there are pagers that reserve 2 columns in some cases), but of course the data file is continued to be used to silence the warning if it isn't desired to get down to 79. --- t/porting/known_pod_issues.dat | 295 ++++++++++++++++++++++------------------- t/porting/podcheck.t | 13 +- 2 files changed, 163 insertions(+), 145 deletions(-) diff --git a/t/porting/known_pod_issues.dat b/t/porting/known_pod_issues.dat index db818ee..bdd56a1 100644 --- a/t/porting/known_pod_issues.dat +++ b/t/porting/known_pod_issues.dat @@ -136,190 +136,207 @@ dist/bignum/lib/bigint.pm Apparent broken link 1 dist/bignum/lib/bignum.pm Apparent broken link 1 dist/bignum/lib/bigrat.pm Apparent broken link 1 dist/constant/lib/constant.pm Apparent broken link 2 +dist/cwd/lib/file/spec/vms.pm Verbatim line length including indents exceeds 79 by 1 +dist/cwd/lib/file/spec/win32.pm Verbatim line length including indents exceeds 79 by 1 dist/data-dumper/dumper.pm ? Should you be using L<...> instead of 1 -dist/extutils-parsexs/lib/extutils/typemaps/outputmap.pm Verbatim line length including indents exceeds 80 by 1 -dist/extutils-parsexs/lib/perlxs.pod Verbatim line length including indents exceeds 80 by 4 -dist/extutils-parsexs/lib/perlxstut.pod Verbatim line length including indents exceeds 80 by 9 +dist/extutils-parsexs/lib/extutils/typemaps/outputmap.pm Verbatim line length including indents exceeds 79 by 1 +dist/extutils-parsexs/lib/perlxs.pod Verbatim line length including indents exceeds 79 by 4 +dist/extutils-parsexs/lib/perlxstut.pod Verbatim line length including indents exceeds 79 by 10 dist/filter-simple/lib/filter/simple.pm Verbatim paragraph in NAME section 1 -dist/i18n-langtags/lib/i18n/langtags.pm Verbatim line length including indents exceeds 80 by 2 -dist/io/io.pm Verbatim line length including indents exceeds 80 by 1 -dist/io/lib/io/socket/inet.pm Verbatim line length including indents exceeds 80 by 3 +dist/i18n-langtags/lib/i18n/langtags.pm Verbatim line length including indents exceeds 79 by 2 +dist/io/io.pm Verbatim line length including indents exceeds 79 by 1 +dist/io/lib/io/socket/inet.pm Verbatim line length including indents exceeds 79 by 5 dist/locale-maketext/lib/locale/maketext.pod No items in =over / =back list 1 -dist/locale-maketext/lib/locale/maketext.pod Verbatim line length including indents exceeds 80 by 1 +dist/locale-maketext/lib/locale/maketext.pod Verbatim line length including indents exceeds 79 by 1 dist/locale-maketext/lib/locale/maketext/tpj13.pod No items in =over / =back list 3 dist/math-bigint/lib/math/bigfloat.pm Apparent broken link 7 dist/math-bigint/lib/math/bigfloat.pm Apparent internal link is missing its forward slash 6 -dist/math-bigint/lib/math/bigfloat.pm Verbatim line length including indents exceeds 80 by 25 +dist/math-bigint/lib/math/bigfloat.pm Verbatim line length including indents exceeds 79 by 28 dist/math-bigint/lib/math/bigint.pm Apparent broken link 5 dist/math-bigint/lib/math/bigint.pm Apparent internal link is missing its forward slash 7 -dist/math-bigint/lib/math/bigint.pm Verbatim line length including indents exceeds 80 by 109 +dist/math-bigint/lib/math/bigint.pm Verbatim line length including indents exceeds 79 by 122 dist/math-bigint/lib/math/bigint.pm empty section in previous paragraph 1 dist/math-bigint/lib/math/bigint/calcemu.pm Apparent broken link 1 dist/math-bigint/lib/math/bigint/calcemu.pm empty section in previous paragraph 3 dist/math-bigrat/lib/math/bigrat.pm Apparent broken link 3 dist/math-bigrat/lib/math/bigrat.pm Apparent internal link is missing its forward slash 1 -dist/math-bigrat/lib/math/bigrat.pm Verbatim line length including indents exceeds 80 by 5 -dist/module-corelist/lib/module/corelist.pm Verbatim line length including indents exceeds 80 by 4 -dist/net-ping/lib/net/ping.pm Verbatim line length including indents exceeds 80 by 2 -dist/perlfaq/lib/perlfaq4.pod Verbatim line length including indents exceeds 80 by 14 -dist/perlfaq/lib/perlfaq5.pod Verbatim line length including indents exceeds 80 by 32 -dist/perlfaq/lib/perlfaq6.pod Verbatim line length including indents exceeds 80 by 34 -dist/perlfaq/lib/perlfaq7.pod Verbatim line length including indents exceeds 80 by 7 -dist/perlfaq/lib/perlfaq8.pod Verbatim line length including indents exceeds 80 by 20 -dist/perlfaq/lib/perlfaq9.pod Verbatim line length including indents exceeds 80 by 7 +dist/math-bigrat/lib/math/bigrat.pm Verbatim line length including indents exceeds 79 by 7 +dist/module-corelist/blib/script/corelist Verbatim line length including indents exceeds 79 by 1 +dist/module-corelist/lib/module/corelist.pm Verbatim line length including indents exceeds 79 by 4 +dist/net-ping/lib/net/ping.pm Verbatim line length including indents exceeds 79 by 2 +dist/perlfaq/lib/perlfaq2.pod Verbatim line length including indents exceeds 79 by 1 +dist/perlfaq/lib/perlfaq4.pod Verbatim line length including indents exceeds 79 by 16 +dist/perlfaq/lib/perlfaq5.pod Verbatim line length including indents exceeds 79 by 40 +dist/perlfaq/lib/perlfaq6.pod Verbatim line length including indents exceeds 79 by 36 +dist/perlfaq/lib/perlfaq7.pod Verbatim line length including indents exceeds 79 by 7 +dist/perlfaq/lib/perlfaq8.pod Verbatim line length including indents exceeds 79 by 20 +dist/perlfaq/lib/perlfaq9.pod Verbatim line length including indents exceeds 79 by 7 +dist/safe/safe.pm Verbatim line length including indents exceeds 79 by 1 dist/safe/safe.pm empty section in previous paragraph 1 -dist/selfloader/lib/selfloader.pm Verbatim line length including indents exceeds 80 by 10 -dist/storable/storable.pm Verbatim line length including indents exceeds 80 by 3 -dist/term-readline/lib/term/readline.pm Verbatim line length including indents exceeds 80 by 1 -dist/thread-queue/lib/thread/queue.pm Verbatim line length including indents exceeds 80 by 4 -dist/threads/lib/threads.pm Verbatim line length including indents exceeds 80 by 3 -ext/b/b/concise.pm Verbatim line length including indents exceeds 80 by 1 +dist/selfloader/lib/selfloader.pm Verbatim line length including indents exceeds 79 by 14 +dist/storable/storable.pm Verbatim line length including indents exceeds 79 by 4 +dist/term-readline/lib/term/readline.pm Verbatim line length including indents exceeds 79 by 1 +dist/thread-queue/lib/thread/queue.pm Verbatim line length including indents exceeds 79 by 4 +dist/threads/lib/threads.pm Verbatim line length including indents exceeds 79 by 3 +ext/b/b.pm Verbatim line length including indents exceeds 79 by 1 +ext/b/b/concise.pm Verbatim line length including indents exceeds 79 by 1 ext/devel-peek/peek.pm ? Should you be using L<...> instead of 2 -ext/devel-peek/peek.pm Verbatim line length including indents exceeds 80 by 2 -ext/dynaloader/dynaloader.pm Verbatim line length including indents exceeds 80 by 1 -ext/file-glob/glob.pm Verbatim line length including indents exceeds 80 by 12 -ext/hash-util-fieldhash/lib/hash/util/fieldhash.pm Verbatim line length including indents exceeds 80 by 2 -ext/i18n-langinfo/langinfo.pm Verbatim line length including indents exceeds 80 by 1 -ext/opcode/opcode.pm Verbatim line length including indents exceeds 80 by 7 -ext/posix/lib/posix.pod Verbatim line length including indents exceeds 80 by 28 -ext/re/re.pm Verbatim line length including indents exceeds 80 by 6 +ext/devel-peek/peek.pm Verbatim line length including indents exceeds 79 by 2 +ext/dynaloader/dynaloader.pm Verbatim line length including indents exceeds 79 by 1 +ext/file-glob/glob.pm Verbatim line length including indents exceeds 79 by 15 +ext/hash-util-fieldhash/lib/hash/util/fieldhash.pm Verbatim line length including indents exceeds 79 by 2 +ext/i18n-langinfo/langinfo.pm Verbatim line length including indents exceeds 79 by 1 +ext/opcode/opcode.pm Verbatim line length including indents exceeds 79 by 10 +ext/posix/lib/posix.pod Verbatim line length including indents exceeds 79 by 29 +ext/re/re.pm Verbatim line length including indents exceeds 79 by 6 ext/vms-dclsym/dclsym.pm ? Should you be using L<...> instead of 1 -ext/vms-dclsym/dclsym.pm Verbatim line length including indents exceeds 80 by 1 -ext/vms-stdio/stdio.pm Verbatim line length including indents exceeds 80 by 1 -ext/xs-apitest/apitest.pm Verbatim line length including indents exceeds 80 by 1 +ext/vms-dclsym/dclsym.pm Verbatim line length including indents exceeds 79 by 1 +ext/vms-stdio/stdio.pm Verbatim line length including indents exceeds 79 by 1 +ext/xs-apitest/apitest.pm Verbatim line length including indents exceeds 79 by 1 install ? Should you be using F<...> or maybe L<...> instead of 1 -install Verbatim line length including indents exceeds 80 by 8 -installhtml Verbatim line length including indents exceeds 80 by 5 +install Verbatim line length including indents exceeds 79 by 10 +installhtml Verbatim line length including indents exceeds 79 by 5 os2/os2/os2-extattr/extattr.pm ? Should you be using F<...> or maybe L<...> instead of 1 -os2/os2/os2-process/process.pm Verbatim line length including indents exceeds 80 by 20 -os2/os2/os2-rexx/dll/dll.pm Verbatim line length including indents exceeds 80 by 2 -os2/os2/os2-rexx/rexx.pm Verbatim line length including indents exceeds 80 by 1 -pod/perl.pod Verbatim line length including indents exceeds 80 by 7 -pod/perlaix.pod Verbatim line length including indents exceeds 80 by 6 +os2/os2/os2-process/process.pm Verbatim line length including indents exceeds 79 by 27 +os2/os2/os2-rexx/dll/dll.pm Verbatim line length including indents exceeds 79 by 2 +os2/os2/os2-rexx/rexx.pm Verbatim line length including indents exceeds 79 by 1 +pod/perl.pod Verbatim line length including indents exceeds 79 by 9 +pod/perlaix.pod Verbatim line length including indents exceeds 79 by 11 pod/perlapi.pod ? Should you be using L<...> instead of 86 -pod/perlapi.pod Verbatim line length including indents exceeds 80 by 6 +pod/perlapi.pod Verbatim line length including indents exceeds 79 by 24 pod/perlapi.pod unresolved internal link 3 -pod/perlapio.pod Verbatim line length including indents exceeds 80 by 5 -pod/perlbook.pod Verbatim line length including indents exceeds 80 by 1 -pod/perlcall.pod Verbatim line length including indents exceeds 80 by 2 -pod/perlce.pod Verbatim line length including indents exceeds 80 by 2 -pod/perlclib.pod Verbatim line length including indents exceeds 80 by 3 -pod/perlcygwin.pod Verbatim line length including indents exceeds 80 by 22 -pod/perldbmfilter.pod Verbatim line length including indents exceeds 80 by 1 -pod/perldebguts.pod Verbatim line length including indents exceeds 80 by 55 -pod/perldebtut.pod Verbatim line length including indents exceeds 80 by 20 -pod/perldebug.pod Verbatim line length including indents exceeds 80 by 3 +pod/perlapio.pod Verbatim line length including indents exceeds 79 by 5 +pod/perlbook.pod Verbatim line length including indents exceeds 79 by 1 +pod/perlcall.pod Verbatim line length including indents exceeds 79 by 2 +pod/perlce.pod Verbatim line length including indents exceeds 79 by 2 +pod/perlclib.pod Verbatim line length including indents exceeds 79 by 3 +pod/perlcygwin.pod Verbatim line length including indents exceeds 79 by 27 +pod/perldbmfilter.pod Verbatim line length including indents exceeds 79 by 1 +pod/perldebguts.pod Verbatim line length including indents exceeds 79 by 68 +pod/perldebtut.pod Verbatim line length including indents exceeds 79 by 22 +pod/perldebug.pod Verbatim line length including indents exceeds 79 by 3 pod/perldiag.pod =item type mismatch 1 -pod/perldiag.pod Verbatim line length including indents exceeds 80 by 1 -pod/perldsc.pod Verbatim line length including indents exceeds 80 by 3 -pod/perldtrace.pod Verbatim line length including indents exceeds 80 by 21 -pod/perlebcdic.pod Verbatim line length including indents exceeds 80 by 272 -pod/perlembed.pod Verbatim line length including indents exceeds 80 by 14 +pod/perldiag.pod Verbatim line length including indents exceeds 79 by 2 +pod/perldsc.pod Verbatim line length including indents exceeds 79 by 4 +pod/perldtrace.pod Verbatim line length including indents exceeds 79 by 22 +pod/perlebcdic.pod Verbatim line length including indents exceeds 79 by 273 +pod/perlembed.pod Verbatim line length including indents exceeds 79 by 27 pod/perlfunc.pod There is more than one target 1 -pod/perlfunc.pod Verbatim line length including indents exceeds 80 by 157 -pod/perlgit.pod Verbatim line length including indents exceeds 80 by 13 -pod/perlgpl.pod Verbatim line length including indents exceeds 80 by 31 +pod/perlfunc.pod Verbatim line length including indents exceeds 79 by 168 +pod/perlgit.pod Verbatim line length including indents exceeds 79 by 14 +pod/perlgpl.pod Verbatim line length including indents exceeds 79 by 50 pod/perlguts.pod ? Should you be using F<...> or maybe L<...> instead of 2 pod/perlguts.pod ? Should you be using L<...> instead of 1 -pod/perlguts.pod Verbatim line length including indents exceeds 80 by 23 +pod/perlguts.pod Verbatim line length including indents exceeds 79 by 25 pod/perlhack.pod ? Should you be using L<...> instead of 1 -pod/perlhacktips.pod Verbatim line length including indents exceeds 80 by 1 -pod/perlhist.pod Verbatim line length including indents exceeds 80 by 1 -pod/perlhpux.pod Verbatim line length including indents exceeds 80 by 2 -pod/perlhurd.pod Verbatim line length including indents exceeds 80 by 2 +pod/perlhack.pod Verbatim line length including indents exceeds 79 by 1 +pod/perlhacktips.pod Verbatim line length including indents exceeds 79 by 1 +pod/perlhist.pod Verbatim line length including indents exceeds 79 by 2 +pod/perlhpux.pod Verbatim line length including indents exceeds 79 by 3 +pod/perlhurd.pod Verbatim line length including indents exceeds 79 by 2 pod/perlintern.pod ? Should you be using L<...> instead of 5 +pod/perlintern.pod Verbatim line length including indents exceeds 79 by 2 pod/perlinterp.pod ? Should you be using L<...> instead of 1 -pod/perlinterp.pod Verbatim line length including indents exceeds 80 by 1 -pod/perlintro.pod Verbatim line length including indents exceeds 80 by 8 -pod/perliol.pod Verbatim line length including indents exceeds 80 by 7 -pod/perlipc.pod Verbatim line length including indents exceeds 80 by 18 -pod/perlirix.pod Verbatim line length including indents exceeds 80 by 4 -pod/perllocale.pod Verbatim line length including indents exceeds 80 by 4 -pod/perllol.pod Verbatim line length including indents exceeds 80 by 4 -pod/perlmacosx.pod Verbatim line length including indents exceeds 80 by 3 -pod/perlmod.pod Verbatim line length including indents exceeds 80 by 2 -pod/perlmodlib.pod Verbatim line length including indents exceeds 80 by 3 -pod/perlmodstyle.pod Verbatim line length including indents exceeds 80 by 2 -pod/perlmpeix.pod Verbatim line length including indents exceeds 80 by 2 +pod/perlinterp.pod Verbatim line length including indents exceeds 79 by 1 +pod/perlintro.pod Verbatim line length including indents exceeds 79 by 11 +pod/perliol.pod Verbatim line length including indents exceeds 79 by 8 +pod/perlipc.pod Verbatim line length including indents exceeds 79 by 21 +pod/perlirix.pod Verbatim line length including indents exceeds 79 by 4 +pod/perllocale.pod Verbatim line length including indents exceeds 79 by 4 +pod/perllol.pod Verbatim line length including indents exceeds 79 by 4 +pod/perlmacosx.pod Verbatim line length including indents exceeds 79 by 3 +pod/perlmod.pod Verbatim line length including indents exceeds 79 by 3 +pod/perlmodlib.pod Verbatim line length including indents exceeds 79 by 3 +pod/perlmodstyle.pod Verbatim line length including indents exceeds 79 by 2 +pod/perlmpeix.pod Verbatim line length including indents exceeds 79 by 2 pod/perlmroapi.pod ? Should you be using L<...> instead of 1 -pod/perlnetware.pod Verbatim line length including indents exceeds 80 by 4 -pod/perlnewmod.pod Verbatim line length including indents exceeds 80 by 1 -pod/perlop.pod Verbatim line length including indents exceeds 80 by 26 +pod/perlnetware.pod Verbatim line length including indents exceeds 79 by 4 +pod/perlnewmod.pod Verbatim line length including indents exceeds 79 by 1 +pod/perlop.pod Verbatim line length including indents exceeds 79 by 30 pod/perlos2.pod ? Should you be using L<...> instead of 2 -pod/perlos2.pod Verbatim line length including indents exceeds 80 by 21 -pod/perlos390.pod Verbatim line length including indents exceeds 80 by 11 -pod/perlpacktut.pod Verbatim line length including indents exceeds 80 by 4 -pod/perlperf.pod Verbatim line length including indents exceeds 80 by 151 -pod/perlpodspec.pod Verbatim line length including indents exceeds 80 by 1 -pod/perlpodstyle.pod Verbatim line length including indents exceeds 80 by 1 -pod/perlreapi.pod Verbatim line length including indents exceeds 80 by 16 -pod/perlrebackslash.pod Verbatim line length including indents exceeds 80 by 1 -pod/perlref.pod Verbatim line length including indents exceeds 80 by 1 -pod/perlreguts.pod Verbatim line length including indents exceeds 80 by 13 -pod/perlrequick.pod Verbatim line length including indents exceeds 80 by 3 -pod/perlretut.pod Verbatim line length including indents exceeds 80 by 11 -pod/perlrun.pod Verbatim line length including indents exceeds 80 by 2 -pod/perlsolaris.pod Verbatim line length including indents exceeds 80 by 14 +pod/perlos2.pod Verbatim line length including indents exceeds 79 by 22 +pod/perlos390.pod Verbatim line length including indents exceeds 79 by 11 +pod/perlpacktut.pod Verbatim line length including indents exceeds 79 by 6 +pod/perlperf.pod Verbatim line length including indents exceeds 79 by 154 +pod/perlpodspec.pod Verbatim line length including indents exceeds 79 by 9 +pod/perlpodstyle.pod Verbatim line length including indents exceeds 79 by 1 +pod/perlreapi.pod Verbatim line length including indents exceeds 79 by 17 +pod/perlrebackslash.pod Verbatim line length including indents exceeds 79 by 1 +pod/perlref.pod Verbatim line length including indents exceeds 79 by 1 +pod/perlreguts.pod Verbatim line length including indents exceeds 79 by 17 +pod/perlrequick.pod Verbatim line length including indents exceeds 79 by 3 +pod/perlretut.pod Verbatim line length including indents exceeds 79 by 13 +pod/perlrun.pod Verbatim line length including indents exceeds 79 by 2 +pod/perlsec.pod Verbatim line length including indents exceeds 79 by 1 +pod/perlsolaris.pod Verbatim line length including indents exceeds 79 by 14 pod/perlsource.pod ? Should you be using F<...> or maybe L<...> instead of 1 pod/perlsub.pod ? Should you be using F<...> or maybe L<...> instead of 3 -pod/perlsub.pod Verbatim line length including indents exceeds 80 by 1 -pod/perlsymbian.pod Verbatim line length including indents exceeds 80 by 15 -pod/perlsyn.pod Verbatim line length including indents exceeds 80 by 6 -pod/perlthrtut.pod Verbatim line length including indents exceeds 80 by 4 -pod/perltie.pod Verbatim line length including indents exceeds 80 by 10 -pod/perltodo.pod Verbatim line length including indents exceeds 80 by 5 +pod/perlsub.pod Verbatim line length including indents exceeds 79 by 4 +pod/perlsymbian.pod Verbatim line length including indents exceeds 79 by 20 +pod/perlsyn.pod Verbatim line length including indents exceeds 79 by 7 +pod/perlthrtut.pod Verbatim line length including indents exceeds 79 by 5 +pod/perltie.pod Verbatim line length including indents exceeds 79 by 13 +pod/perltodo.pod Verbatim line length including indents exceeds 79 by 7 pod/perltodo.pod empty section in previous paragraph 2 -pod/perltoot.pod Verbatim line length including indents exceeds 80 by 1 +pod/perltoot.pod Verbatim line length including indents exceeds 79 by 1 pod/perltrap.pod ? Should you be using F<...> or maybe L<...> instead of 1 -pod/perltrap.pod Verbatim line length including indents exceeds 80 by 14 +pod/perltrap.pod Verbatim line length including indents exceeds 79 by 15 pod/perltru64.pod ? Should you be using F<...> or maybe L<...> instead of 1 -pod/perltru64.pod Verbatim line length including indents exceeds 80 by 4 +pod/perltru64.pod Verbatim line length including indents exceeds 79 by 4 pod/perlunifaq.pod empty section in previous paragraph 1 -pod/perluniintro.pod Verbatim line length including indents exceeds 80 by 1 +pod/perluniintro.pod Verbatim line length including indents exceeds 79 by 3 pod/perluniprops.pod =item type mismatch 6 -pod/perlvar.pod Verbatim line length including indents exceeds 80 by 9 +pod/perlvar.pod Verbatim line length including indents exceeds 79 by 9 pod/perlvms.pod ? Should you be using F<...> or maybe L<...> instead of 1 -pod/perlvms.pod Verbatim line length including indents exceeds 80 by 2 -pod/perlwin32.pod Verbatim line length including indents exceeds 80 by 12 -porting/epigraphs.pod Verbatim line length including indents exceeds 80 by 3 -porting/expand-macro.pl Verbatim line length including indents exceeds 80 by 2 +pod/perlvms.pod Verbatim line length including indents exceeds 79 by 2 +pod/perlwin32.pod Verbatim line length including indents exceeds 79 by 12 +porting/epigraphs.pod Verbatim line length including indents exceeds 79 by 3 +porting/expand-macro.pl Verbatim line length including indents exceeds 79 by 2 porting/how_to_write_a_perldelta.pod There is no NAME 1 -porting/how_to_write_a_perldelta.pod Verbatim line length including indents exceeds 80 by 3 -porting/pumpkin.pod Verbatim line length including indents exceeds 80 by 6 -porting/release_managers_guide.pod Verbatim line length including indents exceeds 80 by 7 +porting/how_to_write_a_perldelta.pod Verbatim line length including indents exceeds 79 by 3 +porting/pumpkin.pod Verbatim line length including indents exceeds 79 by 9 +porting/release_managers_guide.pod Verbatim line length including indents exceeds 79 by 9 porting/release_managers_guide.pod Verbatim paragraph in NAME section 1 porting/release_schedule.pod There is no NAME 1 -symbian/perlutil.pod Verbatim line length including indents exceeds 80 by 3 -utils/c2ph Verbatim line length including indents exceeds 80 by 42 +symbian/perlutil.pod Verbatim line length including indents exceeds 79 by 4 +utils/c2ph Verbatim line length including indents exceeds 79 by 44 utils/libnetcfg Apparent broken link 1 -vms/ext/filespec.pm Verbatim line length including indents exceeds 80 by 1 +vms/ext/filespec.pm Verbatim line length including indents exceeds 79 by 1 x2p/a2p.pod empty section in previous paragraph 2 -lib/benchmark.pm Verbatim line length including indents exceeds 80 by 4 +lib/benchmark.pm Verbatim line length including indents exceeds 79 by 4 lib/cpan/debug.pm There is no NAME 1 lib/cpan/handleconfig.pm =head2 without preceding higher level 1 lib/cpan/handleconfig.pm There is no NAME 1 -lib/class/struct.pm Verbatim line length including indents exceeds 80 by 6 +lib/class/struct.pm Verbatim line length including indents exceeds 79 by 7 lib/config.pod ? Should you be using L<...> instead of -1 lib/config.pod nested commands F<...F<...>...> 3 -lib/db.pm Verbatim line length including indents exceeds 80 by 2 -lib/english.pm Verbatim line length including indents exceeds 80 by 1 -lib/exporter.pm Verbatim line length including indents exceeds 80 by 2 -lib/extutils/embed.pm Verbatim line length including indents exceeds 80 by 1 -lib/extutils/xssymset.pm Verbatim line length including indents exceeds 80 by 1 -lib/file/basename.pm Verbatim line length including indents exceeds 80 by 2 -lib/file/find.pm Verbatim line length including indents exceeds 80 by 1 -lib/getopt/std.pm Verbatim line length including indents exceeds 80 by 1 -lib/perlio.pm Verbatim line length including indents exceeds 80 by 1 -lib/tie/hash.pm Verbatim line length including indents exceeds 80 by 3 -lib/tie/scalar.pm Verbatim line length including indents exceeds 80 by 1 -lib/unicode/ucd.pm Verbatim line length including indents exceeds 80 by 1 -lib/deprecate.pm Verbatim line length including indents exceeds 80 by 2 -lib/integer.pm Verbatim line length including indents exceeds 80 by 1 -lib/overload.pm Verbatim line length including indents exceeds 80 by 1 +lib/db.pm Verbatim line length including indents exceeds 79 by 2 +lib/dbm_filter.pm Verbatim line length including indents exceeds 79 by 1 +lib/dbm_filter/compress.pm Verbatim line length including indents exceeds 79 by 1 +lib/dbm_filter/encode.pm Verbatim line length including indents exceeds 79 by 1 +lib/dbm_filter/int32.pm Verbatim line length including indents exceeds 79 by 1 +lib/dbm_filter/null.pm Verbatim line length including indents exceeds 79 by 1 +lib/dbm_filter/utf8.pm Verbatim line length including indents exceeds 79 by 1 +lib/english.pm Verbatim line length including indents exceeds 79 by 1 +lib/exporter.pm Verbatim line length including indents exceeds 79 by 2 +lib/extutils/embed.pm Verbatim line length including indents exceeds 79 by 2 +lib/extutils/xssymset.pm Verbatim line length including indents exceeds 79 by 1 +lib/file/basename.pm Verbatim line length including indents exceeds 79 by 2 +lib/file/find.pm Verbatim line length including indents exceeds 79 by 1 +lib/getopt/std.pm Verbatim line length including indents exceeds 79 by 1 +lib/perlio.pm Verbatim line length including indents exceeds 79 by 2 +lib/pod/text/overstrike.pm Verbatim line length including indents exceeds 79 by 1 +lib/tie/array.pm Verbatim line length including indents exceeds 79 by 1 +lib/tie/hash.pm Verbatim line length including indents exceeds 79 by 3 +lib/tie/scalar.pm Verbatim line length including indents exceeds 79 by 1 +lib/unicode/ucd.pm Verbatim line length including indents exceeds 79 by 1 +lib/deprecate.pm Verbatim line length including indents exceeds 79 by 2 +lib/integer.pm Verbatim line length including indents exceeds 79 by 1 +lib/overload.pm Verbatim line length including indents exceeds 79 by 1 lib/perl5db.pl ? Should you be using L<...> instead of 1 -lib/perl5db.pl Verbatim line length including indents exceeds 80 by 1 -lib/strict.pm Verbatim line length including indents exceeds 80 by 1 -lib/utf8.pm Verbatim line length including indents exceeds 80 by 3 -lib/version.pod Verbatim line length including indents exceeds 80 by 2 -lib/version/internals.pod Verbatim line length including indents exceeds 80 by 2 -lib/vmsish.pm Verbatim line length including indents exceeds 80 by 1 +lib/perl5db.pl Verbatim line length including indents exceeds 79 by 1 +lib/strict.pm Verbatim line length including indents exceeds 79 by 1 +lib/utf8.pm Verbatim line length including indents exceeds 79 by 4 +lib/version.pod Verbatim line length including indents exceeds 79 by 2 +lib/version/internals.pod Verbatim line length including indents exceeds 79 by 2 +lib/vmsish.pm Verbatim line length including indents exceeds 79 by 1 diff --git a/t/porting/podcheck.t b/t/porting/podcheck.t index 1ab1c51..6f71914 100644 --- a/t/porting/podcheck.t +++ b/t/porting/podcheck.t @@ -71,13 +71,14 @@ If a link is broken, but there is an existing internal target of the same name, it is likely that the internal target was meant, and the C<"/"> is missing from the CE> pod command. -=item Verbatim paragraphs that wrap in an 80 column window +=item Verbatim paragraphs that wrap in an 80 (including 1 spare) column window It's annoying to have lines wrap when displaying pod documentation in a -terminal window. This checks that all such lines fit, and for those that -don't, it tells you how much needs to be cut in order to fit. However, -if you're fixing these, keep in mind that some terminal/pager combinations -require really a maximum of 79 or 78 columns to display properly. +terminal window. This checks that all verbatim lines fit in a standard 80 +column window, even when using a pager that reserves a column for its own use. +(Thus the check is for a net of 79 columns.) +For those that lines that don't fit, it tells you how much needs to be cut in +order to fit. Often, the easiest thing to do to gain space for these is to lower the indent to just one space. @@ -279,7 +280,7 @@ my $data_dir = File::Spec->catdir($original_dir, 'porting'); my $known_issues = File::Spec->catfile($data_dir, 'known_pod_issues.dat'); my $copy_fh; -my $MAX_LINE_LENGTH = 80; # 80 columns +my $MAX_LINE_LENGTH = 79; # 79 columns my $INDENT = 7; # default nroff indent # Our warning messages. Better not have [('"] in them, as those are used as -- 2.7.4