Bug 7168 - More POD errors and warnings
Summary: More POD errors and warnings
Status: RESOLVED FIXED
Alias: None
Product: Spamassassin
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 3.4 SVN branch
Hardware: All All
: P2 minor
Target Milestone: 3.4.2
Assignee: SpamAssassin Developer Mailing List
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-04-08 16:00 UTC by Mark Martinec
Modified: 2018-02-21 17:59 UTC (History)
2 users (show)


Attachment Type Modified Status Actions Submitter/CLA Status
Fix all pod errors patch None Giovanni Bechis [HasCLA]
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Mark Martinec 2015-04-08 16:00:12 UTC 
podchecker (that comes with perl 5.20) still has some complaints
on POD documentation sections:


*** WARNING: empty section in previous paragraph at line 24 in file
  lib/Mail/SpamAssassin/Message/Metadata.pm
  lib/Mail/SpamAssassin/Message/Node.pm
  lib/Mail/SpamAssassin/AICache.pm
  lib/Mail/SpamAssassin/BayesStore/SQL.pm
  lib/Mail/SpamAssassin/BayesStore/Redis.pm
  lib/Mail/SpamAssassin/BayesStore/MySQL.pm
  lib/Mail/SpamAssassin/BayesStore/PgSQL.pm
  lib/Mail/SpamAssassin/BayesStore/BDB.pm

*** WARNING: line containing nothing but whitespace in paragraph at line 235 in file lib/Mail/SpamAssassin/Plugin/SPF.pm

*** ERROR: Spurious text after =cut at line 330 in file lib/Mail/SpamAssassin/Plugin/DNSEval.pm
lib/Mail/SpamAssassin/Plugin/DNSEval.pm has 1 pod syntax error.

*** ERROR: =item without previous =over at line 74 in file lib/Mail/SpamAssassin/Plugin/MIMEEval.pm
*** ERROR: Spurious text after =cut at line 476 in file lib/Mail/SpamAssassin/Plugin/MIMEEval.pm
*** ERROR: Spurious text after =cut at line 486 in file lib/Mail/SpamAssassin/Plugin/MIMEEval.pm
lib/Mail/SpamAssassin/Plugin/MIMEEval.pm has 3 pod syntax errors.

*** ERROR: Spurious text after =cut at line 737 in file lib/Mail/SpamAssassin/PerMsgStatus.pm
*** ERROR: Spurious text after =cut at line 760 in file lib/Mail/SpamAssassin/PerMsgStatus.pm
lib/Mail/SpamAssassin/PerMsgStatus.pm has 2 pod syntax errors.


and all the following in lib/Mail/SpamAssassin/Plugin/TxRep.pm :

*** WARNING: Verbatim paragraph in NAME section at line 23
*** WARNING: node 'BLACKLISTING / WHITELISTING' contains non-escaped | or / at line 113
*** ERROR: Spurious text after =cut at line 195
*** ERROR: Spurious text after =cut at line 265
*** ERROR: Spurious text after =cut at line 293
*** ERROR: Spurious =cut command at line 293
*** ERROR: Spurious text after =cut at line 337
*** ERROR: Spurious =cut command at line 337
*** ERROR: Spurious text after =cut at line 385
*** ERROR: Spurious =cut command at line 385
*** ERROR: Spurious text after =cut at line 408
*** ERROR: Spurious =cut command at line 408
*** ERROR: Spurious text after =cut at line 433
*** ERROR: Spurious =cut command at line 433
*** ERROR: Spurious text after =cut at line 457
*** ERROR: Spurious =cut command at line 457
*** ERROR: Spurious text after =cut at line 482
*** ERROR: Spurious =cut command at line 482
*** ERROR: Spurious text after =cut at line 511
*** ERROR: Spurious =cut command at line 511
*** ERROR: Spurious text after =cut at line 544
*** ERROR: Spurious =cut command at line 544
*** ERROR: Spurious text after =cut at line 571
*** ERROR: Spurious =cut command at line 571
*** ERROR: Spurious text after =cut at line 657
*** ERROR: Spurious =cut command at line 657
*** ERROR: Spurious text after =cut at line 680
*** ERROR: Spurious text after =cut at line 745
*** ERROR: Spurious text after =cut at line 779
*** ERROR: Spurious =cut command at line 779
*** ERROR: Spurious text after =cut at line 818
*** ERROR: Spurious =cut command at line 818
*** ERROR: Spurious text after =cut at line 844
*** ERROR: Spurious =cut command at line 844
*** ERROR: Spurious text after =cut at line 875
*** ERROR: Spurious =cut command at line 875
*** ERROR: =over on line 726 without closing =back (at head1) at line 891
*** ERROR: Spurious text after =cut at line 906
*** ERROR: Spurious text after =cut at line 925
*** ERROR: Spurious =cut command at line 925
*** ERROR: Spurious text after =cut at line 957
*** ERROR: Spurious =cut command at line 957
*** ERROR: Spurious text after =cut at line 977
*** ERROR: Spurious =cut command at line 977
*** ERROR: Spurious text after =cut at line 1001
*** ERROR: Spurious =cut command at line 1001
*** ERROR: Spurious text after =cut at line 1016
*** ERROR: Spurious =cut command at line 1016
*** ERROR: Spurious text after =cut at line 1031
*** ERROR: Spurious =cut command at line 1031
*** ERROR: Spurious text after =cut at line 1050
*** ERROR: Spurious text after =cut at line 1165
*** ERROR: Spurious =cut command at line 1165
*** ERROR: Spurious text after =cut at line 1208
*** ERROR: Spurious =cut command at line 1208
*** ERROR: Spurious text after =cut at line 1745
*** ERROR: Spurious =cut command at line 1745
*** ERROR: Spurious =cut command at line 1895
*** ERROR: unresolved internal link 'txrep_factor' at line 67
*** ERROR: unresolved internal link 'LEARNING SPAM / HAM' at line 79
*** ERROR: unresolved internal link 'txrep_learn_penalty' at line 86
*** ERROR: unresolved internal link 'txrep_learn_bonus' at line 87
*** ERROR: unresolved internal link 'txrep_autolearn' at line 88
*** ERROR: unresolved internal link 'txrep_track_messages' at line 93
*** ERROR: unresolved internal link 'txrep_factor' at line 100
*** ERROR: unresolved internal link 'txrep_dilution_factor' at line 101
*** ERROR: unresolved internal link 'BLACKLISTING / WHITELISTING'
*** ERROR: unresolved internal link 'REPUTATION WEIGHTS' at line 125
*** ERROR: unresolved internal link 'txrep_track_messages' at line 141
*** ERROR: unresolved internal link 'txrep_user2global_ratio' at line 147
*** ERROR: unresolved internal link 'txrep_whitelist_out' at line 158
lib/Mail/SpamAssassin/Plugin/TxRep.pm has 69 pod syntax errors.
Comment 1 Giovanni Bechis 2018-02-16 11:43:03 UTC 
Created attachment 5530 [details]
Fix all pod errors

Fix all pod errors spotted by podchecker(1).
In TxRep.pm there is no "SQL-BASED STORAGE" section, so I deleted the all line that refers to it.
Any other way to fix the last line error ?
Comment 2 Giovanni Bechis 2018-02-18 18:38:05 UTC 
Committed in r1824686, all pod errors fixed as well as those in spamd-apache2 subdirectory, bz can be closed.
Comment 3 Giovanni Bechis 2018-02-21 17:59:41 UTC 
Committed in r1824686, all pod errors fixed as well as those in spamd-apache2 subdirectory.