Bug#848274: libparse-debianchangelog-perl: Fix errorneous escaping in POD

[Christoph Biedl]

Package: libparse-debianchangelog-perl
Version: 1.2.0-11
Severity: minor
Tags: Patch Upstream

Dear Maintainer,

The Parse::DebianChangelog manpage contains a table which was
formatted as a "verbatim paragraph" i.e. "First character [is] a space
or a tab". However some character still are escaped using C<> and E<>
which is, by definition, rendered literally. And the resulting table
is pretty ugly.

The patch attached salvages this and also converts the tab characters to
spaces to avoid any ambigousity. Please apply when conventient. And
perhaps convenience might by achieved by re-visiting the sentence
"Parse::DebianChangelog parses Debian changelogs as described in the
Debian policy (version 3.6.2.1 at the time of this writing)." Perhaps it
can be safely upgraded to 3.9.8? That would avoid any confusion whether
the module still reflects the current policy.

Cheers, and thanks for all your work
    Christoph

-- System Information:
Debian Release: stretch/sid
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 4.9.0 (SMP w/4 CPU cores)
Locale: LANG=de_DE.UTF-8, LC_CTYPE=de_DE.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/bash
Init: unable to detect

Versions of packages libparse-debianchangelog-perl depends on:
ii  libcgi-pm-perl          4.35-1
ii  libclass-accessor-perl  0.34-1
ii  libio-string-perl       1.08-3
ii  liblocale-gettext-perl  1.07-3+b1
ii  libtimedate-perl        2.3000-2
ii  perl                    5.24.1~rc4-1

libparse-debianchangelog-perl recommends no packages.

Versions of packages libparse-debianchangelog-perl suggests:
ii  libhtml-parser-perl    3.72-3
pn  libhtml-template-perl  <none>
pn  libxml-simple-perl     <none>

-- no debconf information

-------------- next part --------------
--- DebianChangelog.pm	2016-10-08 15:26:40.000000000 +0200
+++ DebianChangelog.pm	2016-12-15 21:46:02.434030787 +0100
@@ -1249,21 +1249,21 @@
 Some examples for the above options. Imagine an example changelog with
 entries for the versions 1.2, 1.3, 2.0, 2.1, 2.2, 3.0 and 3.1.
 
-            Call                               Included entries
- C<E<lt>formatE<gt>({ since =E<gt> '2.0' })>  3.1, 3.0, 2.2
- C<E<lt>formatE<gt>({ until =E<gt> '2.0' })>  1.3, 1.2
- C<E<lt>formatE<gt>({ from =E<gt> '2.0' })>   3.1, 3.0, 2.2, 2.1, 2.0
- C<E<lt>formatE<gt>({ to =E<gt> '2.0' })>     2.0, 1.3, 1.2
- C<E<lt>formatE<gt>({ count =E<gt> 2 }>>      3.1, 3.0
- C<E<lt>formatE<gt>({ count =E<gt> -2 }>>     1.3, 1.2
- C<E<lt>formatE<gt>({ count =E<gt> 3,
-		      offset=E<gt> 2 }>>      2.2, 2.1, 2.0
- C<E<lt>formatE<gt>({ count =E<gt> 2,
-		      offset=E<gt> -3 }>>     2.0, 1.3
- C<E<lt>formatE<gt>({ count =E<gt> -2,
-		      offset=E<gt> 3 }>>      3.0, 2.2
- C<E<lt>formatE<gt>({ count =E<gt> -2,
-		      offset=E<gt> -3 }>>     2.2, 2.1
+            Call                       Included entries
+ format({ since => '2.0' })         3.1, 3.0, 2.2
+ format({ until => '2.0' })         1.3, 1.2
+ format({ from => '2.0' })          3.1, 3.0, 2.2, 2.1, 2.0
+ format({ to => '2.0' })            2.0, 1.3, 1.2
+ format({ count => 2 }              3.1, 3.0
+ format({ count => -2 }             1.3, 1.2
+ format({ count => 3,
+          offset => 2 }             2.2, 2.1, 2.0
+ format({ count => 2,
+          offset => -3 }            2.0, 1.3
+ format({ count => -2,
+          offset => 3 }             3.0, 2.2
+ format({ count => -2,
+          offset => -3 }            2.2, 2.1
 
 Any combination of one option of C<since> and C<from> and one of
 C<until> and C<to> returns the intersection of the two results
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: Digital signature
URL: <http://lists.alioth.debian.org/pipermail/pkg-perl-maintainers/attachments/20161215/3aa73ad5/attachment.sig>