[libnet-irc-perl] 06/06: Add patch to fix issues reported by pod2man

[Axel Beckert]

This is an automated email from the git hooks/post-receive script.

abe pushed a commit to branch master
in repository libnet-irc-perl.

commit 28daf899ae4abfcf049c4c822e001a2941cd2be9
Author: Axel Beckert <abe at deuxchevaux.org>
Date:   Sun Nov 19 22:08:35 2017 +0100

    Add patch to fix issues reported by pod2man
---
 debian/changelog                     |  2 +
 debian/patches/80fix_pod_errors.diff | 89 ++++++++++++++++++++++++++++++++++++
 debian/patches/series                |  1 +
 3 files changed, 92 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index 2b3817a..0a88844 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -16,6 +16,8 @@ libnet-irc-perl (0.79-2) UNRELEASED; urgency=medium
     + Update versioned debhelper build-dependency accordingly.
   * Add minimal DEP3 headers (description only + "Forwarded: no") to all
     patches.
+  * Add patch to fix (partially valid) POD syntax claimed to be erroneous
+    by pod2man.
 
  -- Axel Beckert <abe at debian.org>  Sun, 19 Nov 2017 21:14:28 +0100
 
diff --git a/debian/patches/80fix_pod_errors.diff b/debian/patches/80fix_pod_errors.diff
new file mode 100644
index 0000000..389294e
--- /dev/null
+++ b/debian/patches/80fix_pod_errors.diff
@@ -0,0 +1,89 @@
+Description: Fix (partially valid) POD syntax claimed to be erroneous by pod2man
+ pod2man is known to issue "Expected text after =item, not a number"
+ errors despite "perldoc perlpod" (as of Perl 5.26.1) clearly states
+ 'use "=item 1.", "=item 2.", etc., to produce numbered lists'.
+ .
+ It seems that pod2man doesn't dislike numbers in general, but
+ dislikes one specific number: Zero. So the fix is to change all cases
+ of "=item 0." to "=item 1." and bump all further cases of "=item
+ <some number>" by adding 1, too.
+ .
+ The remaining issue is a real error, a misbalance between "=over" and
+ "=back". While the error messages states "You forgot a '=back' before
+ '=head1'", it seems to me as if there's an "=over" too many. Removing
+ that fixes the last issue, too.
+Author: Axel Beckert <abe at debian.org>
+
+--- a/IRC.pm
++++ b/IRC.pm
+@@ -569,11 +569,11 @@
+ 
+ =over
+ 
+-=item 0.
++=item 1.
+ 
+ An object whose socket needs to be added to the select loop
+ 
+-=item 1.
++=item 2.
+ 
+ B<Optional:> A string consisting of one or more of the letters r, w, and e.
+ Passed directly to C<addfh()>... see the description below for more info.
+@@ -593,17 +593,17 @@
+ 
+ =over
+ 
+-=item 0.
++=item 1.
+ 
+ A socket or filehandle to monitor
+ 
+-=item 1.
++=item 2.
+ 
+ A reference to a subroutine. When C<select()> determines that the filehandle
+ is ready, it passes the filehandle to this (presumably user-supplied) sub,
+ where you can read from it, write to it, etc. as your script sees fit.
+ 
+-=item 2.
++=item 3.
+ 
+ B<Optional:> A string containing any combination of the letters r, w or e
+ (standing for read, write, and error, respectively) which determines what
+@@ -649,7 +649,7 @@
+ 
+ =over
+ 
+-=item 0.
++=item 1.
+ 
+ An object whose socket or filehandle needs to be removed from the select loop
+ 
+@@ -666,7 +666,7 @@
+ 
+ =over
+ 
+-=item 0.
++=item 1.
+ 
+ A socket or filehandle to remove
+ 
+@@ -692,7 +692,7 @@
+ 
+ =over
+ 
+-=item 0.
++=item 1.
+ 
+ B<Optional:> A new value for the C<select()> timeout for this IRC object.
+ 
+@@ -705,8 +705,6 @@
+ Flushes any waiting messages in the output queue if pacing is enabled. This
+ method will not return until the output queue is empty.
+ 
+-=over
+-
+ =back
+ 
+ =head1 AUTHORS
diff --git a/debian/patches/series b/debian/patches/series
index cb8e33b..76cc158 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -5,3 +5,4 @@
 50fix_next_outside_loop_with_return.diff
 60warnings_from_unknown_event.diff
 70interactive-makefile-pl.diff
+80fix_pod_errors.diff

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libnet-irc-perl.git