This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
podcheck.t: perldoc standard indent is 4.
authorKarl Williamson <khw@cpan.org>
Mon, 14 Dec 2020 20:29:19 +0000 (13:29 -0700)
committerKarl Williamson <khw@cpan.org>
Mon, 14 Dec 2020 20:50:00 +0000 (13:50 -0700)
Before, it was using an expected nroff indent of 7.  But current perldoc
places the =head1 lines at the left margin, and the text within them
indented by 4.

t/porting/known_pod_issues.dat
t/porting/podcheck.t

index 89664ad..5783359 100644 (file)
@@ -369,157 +369,50 @@ XML::LibXML
 YAML
 YAML::Syck
 YAML::Tiny
-dist/attribute-handlers/lib/attribute/handlers.pm      Verbatim line length including indents exceeds 78 by    2
-dist/base/lib/fields.pm        Verbatim line length including indents exceeds 78 by    1
-dist/constant/lib/constant.pm  Verbatim line length including indents exceeds 78 by    1
-dist/data-dumper/changes       Verbatim line length including indents exceeds 78 by    2
+dist/data-dumper/changes       Verbatim line length including indents exceeds 78 by    1
 dist/data-dumper/dumper.pm     ? Should you be using L<...> instead of 1
-dist/data-dumper/dumper.pm     Verbatim line length including indents exceeds 78 by    3
-dist/devel-ppport/devel/buildperl.pl   Verbatim line length including indents exceeds 78 by    1
-dist/devel-ppport/hackers      Verbatim line length including indents exceeds 78 by    2
 dist/devel-ppport/parts/inc/ppphdoc    Unknown directive: =dontwarn    1
 dist/devel-ppport/parts/inc/ppphdoc    Unknown directive: =implementation      1
 dist/devel-ppport/parts/inc/ppphdoc    Unknown directive: =provides    1
-dist/encoding-warnings/lib/encoding/warnings.pm        Verbatim line length including indents exceeds 78 by    1
 dist/env/lib/env.pm    ? Should you be using F<...> or maybe L<...> instead of 1
-dist/exporter/lib/exporter.pm  Verbatim line length including indents exceeds 78 by    7
-dist/extutils-parsexs/lib/perlxstut.pod        Verbatim line length including indents exceeds 78 by    3
-dist/extutils-parsexs/lib/perlxstypemap.pod    Verbatim line length including indents exceeds 78 by    2
-dist/i18n-langtags/lib/i18n/langtags.pm        Verbatim line length including indents exceeds 78 by    1
-dist/io/io.pm  Verbatim line length including indents exceeds 78 by    1
-dist/io/lib/io/socket/inet.pm  Verbatim line length including indents exceeds 78 by    2
-dist/module-corelist/blib/script/corelist      Verbatim line length including indents exceeds 78 by    1
-dist/module-corelist/lib/module/corelist.pod   Verbatim line length including indents exceeds 78 by    2
+dist/exporter/lib/exporter.pm  Verbatim line length including indents exceeds 78 by    1
 dist/net-ping/lib/net/ping.pm  Apparent broken link    2
-dist/pathtools/lib/file/spec/mac.pm    Verbatim line length including indents exceeds 78 by    4
-dist/pathtools/lib/file/spec/vms.pm    Verbatim line length including indents exceeds 78 by    1
-dist/pathtools/lib/file/spec/win32.pm  Verbatim line length including indents exceeds 78 by    1
-dist/term-readline/lib/term/readline.pm        Verbatim line length including indents exceeds 78 by    2
-dist/test/lib/test.pm  Verbatim line length including indents exceeds 78 by    2
-dist/thread-queue/lib/thread/queue.pm  Verbatim line length including indents exceeds 78 by    2
-dist/thread-semaphore/lib/thread/semaphore.pm  Verbatim line length including indents exceeds 78 by    1
-dist/threads-shared/lib/threads/shared.pm      Verbatim line length including indents exceeds 78 by    1
-dist/tie-file/lib/tie/file.pm  Verbatim line length including indents exceeds 78 by    1
-dist/unicode-normalize/normalize.pm    Verbatim line length including indents exceeds 78 by    1
 ext/amiga-exec/exec.pm Verbatim line length including indents exceeds 78 by    1
-ext/b/b.pm     Verbatim line length including indents exceeds 78 by    1
-ext/b/b/concise.pm     Verbatim line length including indents exceeds 78 by    1
 ext/dynaloader/dynaloader.pm   Verbatim line length including indents exceeds 78 by    1
-ext/file-find/lib/file/find.pm Verbatim line length including indents exceeds 78 by    1
-ext/hash-util-fieldhash/lib/hash/util/fieldhash.pm     Verbatim line length including indents exceeds 78 by    1
-ext/hash-util/lib/hash/util.pm Verbatim line length including indents exceeds 78 by    3
-ext/opcode/opcode.pm   Verbatim line length including indents exceeds 78 by    1
-ext/pod-html/testdir/perlpodspec-copy.pod      Verbatim line length including indents exceeds 78 by    8
+ext/hash-util/lib/hash/util.pm Verbatim line length including indents exceeds 78 by    2
 ext/pod-html/testdir/perlvar-copy.pod  ? Should you be using L<...> instead of 3
-ext/pod-html/testdir/perlvar-copy.pod  Verbatim line length including indents exceeds 78 by    7
-ext/posix/lib/posix.pod        Verbatim line length including indents exceeds 78 by    5
-ext/re/re.pm   Verbatim line length including indents exceeds 78 by    1
-ext/sdbm_file/sdbm_file.pm     Verbatim line length including indents exceeds 78 by    1
+ext/pod-html/testdir/perlvar-copy.pod  Verbatim line length including indents exceeds 78 by    5
 ext/vms-filespec/lib/vms/filespec.pm   Verbatim line length including indents exceeds 78 by    1
 install        ? Should you be using F<...> or maybe L<...> instead of 1
-install        Verbatim line length including indents exceeds 78 by    9
-installhtml    Verbatim line length including indents exceeds 78 by    3
-os2/os2/os2-process/process.pm Verbatim line length including indents exceeds 78 by    8
-os2/os2/os2-rexx/dll/dll.pm    Verbatim line length including indents exceeds 78 by    1
-os2/os2/os2-rexx/rexx.pm       Verbatim line length including indents exceeds 78 by    1
-pod/perl.pod   Verbatim line length including indents exceeds 78 by    8
-pod/perlaix.pod        Verbatim line length including indents exceeds 78 by    12
-pod/perlandroid.pod    Verbatim line length including indents exceeds 78 by    4
-pod/perlapi.pod        Verbatim line length including indents exceeds 78 by    4
-pod/perlapio.pod       Verbatim line length including indents exceeds 78 by    5
+pod/perl.pod   Verbatim line length including indents exceeds 78 by    5
+pod/perlandroid.pod    Verbatim line length including indents exceeds 78 by    3
 pod/perlbook.pod       Verbatim line length including indents exceeds 78 by    1
-pod/perlcall.pod       Verbatim line length including indents exceeds 78 by    2
-pod/perlclib.pod       Verbatim line length including indents exceeds 78 by    1
-pod/perlcygwin.pod     Verbatim line length including indents exceeds 78 by    8
-pod/perldata.pod       Verbatim line length including indents exceeds 78 by    4
-pod/perldebguts.pod    Verbatim line length including indents exceeds 78 by    47
-pod/perldebtut.pod     Verbatim line length including indents exceeds 78 by    20
-pod/perldebug.pod      Verbatim line length including indents exceeds 78 by    4
-pod/perldiag.pod       Verbatim line length including indents exceeds 78 by    6
-pod/perldsc.pod        Verbatim line length including indents exceeds 78 by    2
-pod/perldtrace.pod     Verbatim line length including indents exceeds 78 by    25
-pod/perlebcdic.pod     Verbatim line length including indents exceeds 78 by    31
-pod/perlembed.pod      Verbatim line length including indents exceeds 78 by    2
-pod/perlfork.pod       Verbatim line length including indents exceeds 78 by    1
-pod/perlfunc.pod       Verbatim line length including indents exceeds 78 by    156
+pod/perldebguts.pod    Verbatim line length including indents exceeds 78 by    24
+pod/perldebtut.pod     Verbatim line length including indents exceeds 78 by    2
+pod/perldtrace.pod     Verbatim line length including indents exceeds 78 by    7
 pod/perlgit.pod        ? Should you be using F<...> or maybe L<...> instead of 1
-pod/perlgit.pod        Verbatim line length including indents exceeds 78 by    9
-pod/perlgpl.pod        Verbatim line length including indents exceeds 78 by    19
+pod/perlgit.pod        Verbatim line length including indents exceeds 78 by    1
 pod/perlguts.pod       ? Should you be using L<...> instead of 1
-pod/perlguts.pod       Verbatim line length including indents exceeds 78 by    10
 pod/perlhack.pod       ? Should you be using L<...> instead of 1
-pod/perlhack.pod       Verbatim line length including indents exceeds 78 by    2
-pod/perlhacktips.pod   Verbatim line length including indents exceeds 78 by    2
-pod/perlhacktut.pod    Verbatim line length including indents exceeds 78 by    5
-pod/perlhist.pod       Verbatim line length including indents exceeds 78 by    3
-pod/perlhpux.pod       Verbatim line length including indents exceeds 78 by    4
-pod/perlhurd.pod       Verbatim line length including indents exceeds 78 by    1
+pod/perlhack.pod       Verbatim line length including indents exceeds 78 by    1
+pod/perlhist.pod       Verbatim line length including indents exceeds 78 by    1
 pod/perlinterp.pod     ? Should you be using L<...> instead of 1
-pod/perlintro.pod      Verbatim line length including indents exceeds 78 by    2
-pod/perliol.pod        Verbatim line length including indents exceeds 78 by    2
-pod/perlipc.pod        Verbatim line length including indents exceeds 78 by    10
-pod/perlirix.pod       Verbatim line length including indents exceeds 78 by    2
-pod/perllocale.pod     Verbatim line length including indents exceeds 78 by    1
-pod/perllol.pod        Verbatim line length including indents exceeds 78 by    1
-pod/perlmacosx.pod     Verbatim line length including indents exceeds 78 by    4
-pod/perlmod.pod        Verbatim line length including indents exceeds 78 by    1
-pod/perlmodlib.pod     Verbatim line length including indents exceeds 78 by    1
+pod/perlirix.pod       Verbatim line length including indents exceeds 78 by    1
+pod/perlmacosx.pod     Verbatim line length including indents exceeds 78 by    3
 pod/perlmroapi.pod     ? Should you be using L<...> instead of 1
-pod/perlobj.pod        Verbatim line length including indents exceeds 78 by    1
-pod/perlop.pod Verbatim line length including indents exceeds 78 by    18
-pod/perlopentut.pod    Verbatim line length including indents exceeds 78 by    1
 pod/perlos2.pod        ? Should you be using L<...> instead of 2
-pod/perlos2.pod        Verbatim line length including indents exceeds 78 by    11
-pod/perlos390.pod      Verbatim line length including indents exceeds 78 by    6
-pod/perlpacktut.pod    Verbatim line length including indents exceeds 78 by    3
-pod/perlperf.pod       Verbatim line length including indents exceeds 78 by    139
-pod/perlpodspec.pod    Verbatim line length including indents exceeds 78 by    8
+pod/perlos2.pod        Verbatim line length including indents exceeds 78 by    5
+pod/perlos390.pod      Verbatim line length including indents exceeds 78 by    2
+pod/perlperf.pod       Verbatim line length including indents exceeds 78 by    113
 pod/perlport.pod       ? Should you be using L<...> instead of 1
-pod/perlport.pod       Verbatim line length including indents exceeds 78 by    1
-pod/perlqnx.pod        Verbatim line length including indents exceeds 78 by    1
-pod/perlre.pod Verbatim line length including indents exceeds 78 by    7
-pod/perlreapi.pod      Verbatim line length including indents exceeds 78 by    3
-pod/perlrebackslash.pod        Verbatim line length including indents exceeds 78 by    4
-pod/perlrecharclass.pod        Verbatim line length including indents exceeds 78 by    12
-pod/perlref.pod        Verbatim line length including indents exceeds 78 by    1
-pod/perlreftut.pod     Verbatim line length including indents exceeds 78 by    1
-pod/perlreguts.pod     Verbatim line length including indents exceeds 78 by    10
-pod/perlreref.pod      Verbatim line length including indents exceeds 78 by    6
-pod/perlretut.pod      Verbatim line length including indents exceeds 78 by    9
-pod/perlrun.pod        Verbatim line length including indents exceeds 78 by    10
-pod/perlsec.pod        Verbatim line length including indents exceeds 78 by    1
+pod/perlrun.pod        Verbatim line length including indents exceeds 78 by    3
 pod/perlsolaris.pod    Verbatim line length including indents exceeds 78 by    13
-pod/perlstyle.pod      Verbatim line length including indents exceeds 78 by    1
-pod/perlsub.pod        Verbatim line length including indents exceeds 78 by    8
-pod/perlsynology.pod   Verbatim line length including indents exceeds 78 by    1
-pod/perlthrtut.pod     Verbatim line length including indents exceeds 78 by    2
-pod/perltie.pod        Verbatim line length including indents exceeds 78 by    7
+pod/perltie.pod        Verbatim line length including indents exceeds 78 by    3
 pod/perltru64.pod      Verbatim line length including indents exceeds 78 by    1
-pod/perlunicode.pod    Verbatim line length including indents exceeds 78 by    4
-pod/perlunifaq.pod     Verbatim line length including indents exceeds 78 by    1
-pod/perluniintro.pod   Verbatim line length including indents exceeds 78 by    5
-pod/perlvar.pod        Verbatim line length including indents exceeds 78 by    1
-pod/perlwin32.pod      Verbatim line length including indents exceeds 78 by    8
-porting/bench.pl       Verbatim line length including indents exceeds 78 by    2
-porting/bisect-runner.pl       Verbatim line length including indents exceeds 78 by    2
-porting/epigraphs.pod  Verbatim line length including indents exceeds 78 by    51
-porting/pumpkin.pod    Verbatim line length including indents exceeds 78 by    3
-porting/release_managers_guide.pod     Verbatim line length including indents exceeds 78 by    6
+pod/perlwin32.pod      Verbatim line length including indents exceeds 78 by    7
+porting/epigraphs.pod  Verbatim line length including indents exceeds 78 by    28
+porting/release_managers_guide.pod     Verbatim line length including indents exceeds 78 by    2
 porting/todo.pod       ? Should you be using F<...> or maybe L<...> instead of 1
-porting/todo.pod       Verbatim line length including indents exceeds 78 by    2
-lib/b/op_private.pm    Verbatim line length including indents exceeds 78 by    1
 lib/benchmark.pm       Verbatim line length including indents exceeds 78 by    2
-lib/charnames.pm       Verbatim line length including indents exceeds 78 by    2
-lib/class/struct.pm    Verbatim line length including indents exceeds 78 by    3
 lib/config.pod ? Should you be using L<...> instead of -1
-lib/db.pm      Verbatim line length including indents exceeds 78 by    2
-lib/overload.pm        Verbatim line length including indents exceeds 78 by    1
 lib/perl5db.pl ? Should you be using L<...> instead of 1
-lib/perlio.pm  Verbatim line length including indents exceeds 78 by    1
-lib/strict.pm  Verbatim line length including indents exceeds 78 by    1
-lib/tie/array.pm       Verbatim line length including indents exceeds 78 by    1
-lib/tie/hash.pm        Verbatim line length including indents exceeds 78 by    1
-lib/unicode/ucd.pm     Verbatim line length including indents exceeds 78 by    17
-lib/utf8.pm    Verbatim line length including indents exceeds 78 by    1
-lib/vmsish.pm  Verbatim line length including indents exceeds 78 by    1
-lib/warnings.pm        Verbatim line length including indents exceeds 78 by    2
index 94c56e8..c7fa9f1 100644 (file)
@@ -360,7 +360,8 @@ my $MANIFEST = File::Spec->catfile(File::Spec->updir($original_dir), 'MANIFEST')
 my $copy_fh;
 
 my $MAX_LINE_LENGTH = 78;   # 78 columns
-my $INDENT = 7;             # default nroff indent
+my $INDENT = 4;             # Things besides =head lines are indented at this
+                            #least much
 
 # Our warning messages.  Better not have [('"] in them, as those are used as
 # delimiters for variable parts of the messages by poderror.