Bug #62498 for Pod-Simple: Warn about non-ASCII characters without =encoding statement

Wed Oct 27 13:45:22 2010 dolmen [...] cpan.org - Ticket created

Subject:

Warn about non-ASCII characters without =encoding statement

Many POD files on the CPAN are broken because the author use 8-bit characters, mostly UTF-8 but also Latin1 or other local single-byte encoding (Windows-1252...). Those POD files would be ok if they used the "=encoding" statement. But many authors forget it, as accents shows fine on their platform and perldoc does not warn. http://search.cpan.org/~natanael/Devel-CoverReport-0.03/bin/cover_report Test::Pod doesn't help either because it uses Pod::Simple and P::S doesn't warn about that problem. So I suggest Pod::Simple should: - detect non-ASCII bytes in POD content - report them if no "=encoding" was specified and suggest either: * to add a "=encoding" statement (but not all Pod parsers support it) * to escape character with E<> entities (E<eacute> for 'é'...) As Test::Pod failures could make installation of many, many, many, many, many CPAN modules fail (while it is the author fault and not due to the user environment), I suggest those problems should be reported only in the following cases to avoid breaking the CPAN: - $ENV{RELEASE_TESTING} is set - or $0 !~ /\.t$/ -- Olivier Mengué - http://search.cpan.org/~dolmen/ http://github.com/dolmen/

Mon Nov 08 12:24:23 2010 dwheeler [...] cpan.org - Status changed from 'new' to 'stalled'

Mon Nov 08 12:24:23 2010 dwheeler [...] cpan.org - Severity Important changed to Wishlist

Mon Nov 08 12:25:25 2010 dwheeler [...] cpan.org - Correspondence added

Good idea. Any chance you could work up a patch for this this week? Allison and I plan to hack on Pod::Simple on Thursday. http://twitter.com/theory/status/1685834864529408. —Theory

Mon Nov 08 12:25:26 2010 The RT System itself - Status changed from 'stalled' to 'open'

Mon Nov 08 12:25:42 2010 dwheeler [...] cpan.org - Status changed from 'open' to 'stalled'

Wed Jun 13 21:58:50 2012 DAMI [...] cpan.org - Correspondence added

Le Mer 27 Oct 2010 13:45:22, DOLMEN a écrit : [..] Show quoted text

> So I suggest Pod::Simple should: > - detect non-ASCII bytes in POD content > - report them if no "=encoding" was specified and suggest either: > * to add a "=encoding" statement (but not all Pod parsers support

it) Show quoted text

> * to escape character with E<> entities (E<eacute> for 'é'...) >

Apparently this part was done in release 3.22 (2012-05-27) ... Show quoted text

> As Test::Pod failures could make installation of many, many, many,

many, Show quoted text

> many CPAN modules fail (while it is the author fault and not due to

the Show quoted text

> user environment), I suggest those problems should be reported only in > the following cases to avoid breaking the CPAN: > - $ENV{RELEASE_TESTING} is set > - or $0 !~ /\.t$/

... but this part was not done, and as anticipated by DOLMEN, it creates problems. As far as I am concerned, I start receiving many bug reports from CPAN testers, because several of my modules indeed do not have the =encoding line, and this was never a problem before. The good point is that now I am aware that something was missing, so OK, I will fix my modules; but this cannot be expected from all CPAN authors of modules with non-ASCII chars in pod (some people may have no time or may even have disappeared). So please make it a little less rude (issue a warning instead of provoking test failure). Thanks in advance, Laurent D.

Wed Jun 13 21:58:51 2012 The RT System itself - Status changed from 'stalled' to 'open'

Wed Jun 13 22:52:14 2012 dwheeler [...] cpan.org - Cc GRANTM added

Wed Jun 13 22:54:56 2012 dwheeler [...] cpan.org - Correspondence added

Subject:	Re: [rt.cpan.org #62498] Warn about non-ASCII characters without =encoding statement
Date:	Wed, 13 Jun 2012 19:54:40 -0700
To:	bug-Pod-Simple [...] rt.cpan.org
From:	"David E. Wheeler" <dwheeler [...] cpan.org>

On Jun 13, 2012, at 6:58 PM, Laurent Dami via RT wrote: Show quoted text

> So please make it a little less rude (issue a warning instead of > provoking test failure). Thanks in advance, Laurent D.

It is a warning. Test::Pod considers warnings failures. So it's a Test::Pod issue. There has been some discussion of changing it, but the consensus seems to be not to. See the thread starting here: http://www.mail-archive.com/pod-people@perl.org/msg01604.html Best, David

Wed Jun 13 22:55:15 2012 dwheeler [...] cpan.org - Status changed from 'open' to 'resolved'

Wed Jun 13 22:55:15 2012 dwheeler [...] cpan.org - Fixed in 3.21 added

Bug #62498 for Pod-Simple: Warn about non-ASCII characters without =encoding statement

Preferred bug tracker