Bug #47850 for Template-Toolkit: Template-Toolkit-2.21 breaks in

Mon Jul 13 20:25:45 2009 david [...] davidfavor.com - Ticket created

Subject:	Template-Toolkit-2.21 breaks in
Date:	Mon, 13 Jul 2009 19:25:21 -0500
To:	bug-Template-Toolkit [...] rt.cpan.org
From:	David Favor <david [...] davidfavor.com>

When Test::Kwalitee-1.01 is installed, the following error occurs: t/pod_kwalitee.t ...... 2/68 # Failed test 'blib/lib/Template/FAQ.pod' # at /runtime/perl-5.10.0-1572/lib/site_perl/5.10.0/Test/Pod.pm line 219. # blib/lib/Template/FAQ.pod (301): L<text|scheme:...> is invalid according to perlpod # Failed test 'blib/lib/Template/Toolkit.pod' # at /runtime/perl-5.10.0-1572/lib/site_perl/5.10.0/Test/Pod.pm line 219. # blib/lib/Template/Toolkit.pod (118): L<text|scheme:...> is invalid according to perlpod t/pod_kwalitee.t ...... 52/68 # Looks like you failed 2 tests of 68. t/pod_kwalitee.t ...... Dubious, test returned 2 (wstat 512, 0x200) Failed 2/68 subtests t/prefix.t ............ ok Show quoted text

_______ net2#perl -V Summary of my perl5 (revision 5 version 10 subversion 0) configuration: Commit id: e6a79cbbfdae09502004811a43d5005c482e3b25 Platform: osname=linux, osvers=2.6.27.21-170.2.56.fc10.i686, archname=i686-linux-thread-multi uname='linux net2.coolsurf.com 2.6.27.21-170.2.56.fc10.i686 #1 smp mon mar 23 23:37:54 edt 2009 i686 i686 i386 gnulinux ' config_args='-Dprefix=/runtime/perl-5.10.0-1572 -ders -Dusedevel -Dcf_by=David Favor -Dcf_email=david@davidfavor.com -Dperladmin=david@davidfavor.com -Dcc=gcc -Doptimize=-O2 -pipe -Wall -Wp,-D_FORTIFY_SOURCE=2 -fexceptions --param=ssp-buffer-size=4 -m32 -fstack-protector -mtune=generic -Dloclibpth=/usr/local/lib -Dlocincpth=/usr/local/include -Duseshrplib -Dusethreads -Uuseithreads -Duselargefiles -Dd_dosuid -Dd_semctl_semun -Dotherlibdirs=/runtime/pmlib:/common/pmlib:/usr/local/pmlib -Ui_db -Ui_ndbm -Di_gdbm -Di_shadow -Di_syslog -Dman3ext=3pm -Duseperlio -Dinstallusrbinperl=n -Ubincompat5005 -Uversiononly -Dpager=/usr/bin/less -Dd_gethostent_r_proto -Ud_endhostent_r_proto -Ud_sethostent_r_proto -Ud_endprotoent_r_proto -Ud_setprotoent_r_proto -Ud_endservent_r_proto -Ud_setservent_r_proto' hint=recommended, useposix=true, d_sigaction=define useithreads=define, usemultiplicity=define useperlio=define, d_sfio=undef, uselargefiles=define, usesocks=undef use64bitint=undef, use64bitall=undef, uselongdouble=undef usemymalloc=n, bincompat5005=undef Compiler: cc='gcc', ccflags ='-D_REENTRANT -D_GNU_SOURCE -fno-strict-aliasing -pipe -fstack-protector -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64', optimize='-O2 -pipe -Wall -Wp,-D_FORTIFY_SOURCE=2 -fexceptions --param=ssp-buffer-size=4 -m32 -fstack-protector -mtune=generic ', cppflags='-D_REENTRANT -D_GNU_SOURCE -fno-strict-aliasing -pipe -fstack-protector -I/usr/local/include' ccversion='', gccversion='4.3.2 20081105 (Red Hat 4.3.2-7)', gccosandvers='' intsize=4, longsize=4, ptrsize=4, doublesize=8, byteorder=1234 d_longlong=define, longlongsize=8, d_longdbl=define, longdblsize=12 ivtype='long', ivsize=4, nvtype='double', nvsize=8, Off_t='off_t', lseeksize=8 alignbytes=4, prototype=define Linker and Libraries: ld='gcc', ldflags =' -fstack-protector -L/usr/local/lib' libpth=/usr/local/lib /lib /usr/lib libs=-lnsl -lgdbm -ldb -ldl -lm -lcrypt -lutil -lpthread -lc perllibs=-lnsl -ldl -lm -lcrypt -lutil -lpthread -lc libc=/lib/libc-2.9.so, so=so, useshrplib=true, libperl=libperl.so gnulibc_version='2.9' Dynamic Linking: dlsrc=dl_dlopen.xs, dlext=so, d_dlsymun=undef, ccdlflags='-Wl,-E -Wl,-rpath,/runtime/perl-5.10.0-1572/lib/5.10.0/i686-linux-thread-multi/CORE' cccdlflags='-fPIC', lddlflags='-shared -O2 -pipe -Wall -Wp,-D_FORTIFY_SOURCE=2 -fexceptions --param=ssp-buffer-size=4 -m32 -fstack-protector -mtune=generic -L/usr/local/lib' Characteristics of this binary (from libperl): Compile-time options: MULTIPLICITY PERL_DONT_CREATE_GVSV PERL_IMPLICIT_CONTEXT PERL_MALLOC_WRAP PERL_USE_DEVEL USE_ITHREADS USE_LARGE_FILES USE_PERLIO USE_REENTRANT_API Built under linux Compiled at Jul 13 2009 11:30:17 @INC: /runtime/perl-5.10.0-1572/lib/5.10.0/i686-linux-thread-multi /runtime/perl-5.10.0-1572/lib/5.10.0 /runtime/perl-5.10.0-1572/lib/site_perl/5.10.0/i686-linux-thread-multi /runtime/perl-5.10.0-1572/lib/site_perl/5.10.0 /runtime/pmlib /common/pmlib /usr/local/pmlib . -- Love feeling your best ever, all day, every day? Click http://RadicalHealth.com/join for the easy way.

Sat Jul 18 11:33:19 2009 jjnapiork [...] cpan.org - Correspondence added

On Mon Jul 13 20:25:45 2009, david@davidfavor.com wrote: Show quoted text

> When Test::Kwalitee-1.01 is installed, the following error occurs: > > t/pod_kwalitee.t ...... 2/68 > # Failed test 'blib/lib/Template/FAQ.pod' > # at /runtime/perl-5.10.0-1572/lib/site_perl/5.10.0/Test/Pod.pm line > 219. > # blib/lib/Template/FAQ.pod (301): L<text|scheme:...> is invalid > according to perlpod > > # Failed test 'blib/lib/Template/Toolkit.pod' > # at /runtime/perl-5.10.0-1572/lib/site_perl/5.10.0/Test/Pod.pm line > 219. > # blib/lib/Template/Toolkit.pod (118): L<text|scheme:...> is invalid > according to perlpod > t/pod_kwalitee.t ...... 52/68 # Looks like you failed 2 tests of 68. > t/pod_kwalitee.t ...... Dubious, test returned 2 (wstat 512, 0x200) > Failed 2/68 subtests > t/prefix.t ............ ok

[CONTENT SKIPPED] And here is a patch to fix the documentation attached. Basically has to do with a rule about the correct way to embed URLs pointing to external sites. Here's the actual Pod formatting rules that specific this: ======= (URL SOURCE: http://perldoc.perl.org/perlpod.html#Formatting-Codes) L<scheme:...> Links to an absolute URL. For example, L<<a href="http://www.perl.org/">http://www.perl.org/</a>>. But note that there is no corresponding L<text|scheme:...> syntax, for various reasons. ======== I notice that the vast majority of failures reported by cpan testers are related to this issue, so even though it's not something that is a bug or broken, it is going to cause people a lot of trouble. That Test::Kwalitee is now part of some requirements for popular modules, which why we are seeing so much of this. john napiorkowski

Index: lib/Template/FAQ.pod =================================================================== --- lib/Template/FAQ.pod (revision 1247) +++ lib/Template/FAQ.pod (working copy) @@ -298,7 +298,7 @@ =head2 Why do I get rubbish for my utf-8 templates? First of all, make sure that your template files define a Byte Order -Mark (L<BOM|http://en.wikipedia.org/wiki/Byte_Order_Mark>). +Mark L<<a href="http://en.wikipedia.org/wiki/Byte_Order_Mark">(BOM)</a>> If you for some reason don't want to add BOM to your templates, you can force Template to use a particular encoding (e.g. C<utf8>) for your Index: lib/Template/Toolkit.pod =================================================================== --- lib/Template/Toolkit.pod (revision 1247) +++ lib/Template/Toolkit.pod (working copy) @@ -113,7 +113,7 @@ =head1 Author -The Template Toolkit was written by L<Andy Wardley|http://wardley.org/> +The Template Toolkit was written by L<<a href="http://wardley.org/">Andy Wardley</a>> E<lt>abw@wardley.orgE<gt> with assistance and contributions from a great number of people. Please see L<Template::Manual::Credits> for a full list.

Sat Jul 18 11:33:20 2009 The RT System itself - Status changed from 'new' to 'open'

Sun Jul 19 01:28:42 2009 adam [...] ali.as - Correspondence added

Subject:	Re: [rt.cpan.org #47850] Template-Toolkit-2.21 breaks in
Date:	Sun, 19 Jul 2009 15:28:22 +1000
To:	bug-Template-Toolkit [...] rt.cpan.org
From:	Adam Kennedy <adamkennedybackup [...] gmail.com>

Worse, modules like Template Toolkit incorrectly run author tests during an end-user installation. Some, worse again, even put dependencies on them. Module should NEVER run author/releases tests during end user installation, exactly to prevent the kind of failures we're seeing here. Adam K 2009/7/19 John Napiorkowski via RT <bug-Template-Toolkit@rt.cpan.org>: Show quoted text

> I notice that the vast majority of failures reported by cpan testers are > related to this issue, so even though it's not something that is a bug > or broken, it is going to cause people a lot of trouble. That > Test::Kwalitee is now part of some requirements for popular modules, > which why we are seeing so much of this.

Sun Jul 19 10:54:01 2009 jjnapiork [...] cpan.org - Correspondence added

On Sun Jul 19 01:28:42 2009, adam@ali.as wrote: Show quoted text

> Worse, modules like Template Toolkit incorrectly run author tests > during an end-user installation. > > Some, worse again, even put dependencies on them. > > Module should NEVER run author/releases tests during end user > installation, exactly to prevent the kind of failures we're seeing > here. > > Adam K

I'd be happy to do a minimum "skip all if $ENV{AUTHOR_TESTS}" patch for the usual suspects if requested. Whatever way we need to do this so that I don't have to force install or use distroprefs to apply my patch manually. I have several clients with administrators that won't move my apps to production when "make install" returns any errors (which is highly reasonable, even for this case). I imagine I'm not the only one. I'd be willing to put a few hours into this. john napiorkowski

Sun Jul 19 21:53:02 2009 adam [...] ali.as - Correspondence added

Subject:	Re: [rt.cpan.org #47850] Template-Toolkit-2.21 breaks in
Date:	Mon, 20 Jul 2009 11:52:45 +1000
To:	bug-Template-Toolkit [...] rt.cpan.org
From:	Adam Kennedy <adamkennedybackup [...] gmail.com>

It's actually $ENV{RELEASE_TESTING}, but putting the case on just $ENV{AUTOMATED_TESTING} is also acceptable. See http://use.perl.org/~Alias/journal/38822 for more on what these author tests should look like. Adam K 2009/7/20 John Napiorkowski via RT <bug-Template-Toolkit@rt.cpan.org>: Show quoted text

> Queue: Template-Toolkit > Ticket <URL: https://rt.cpan.org/Ticket/Display.html?id=47850 > > > On Sun Jul 19 01:28:42 2009, adam@ali.as wrote:

>> Worse, modules like Template Toolkit incorrectly run author tests >> during an end-user installation. >> >> Some, worse again, even put dependencies on them. >> >> Module should NEVER run author/releases tests during end user >> installation, exactly to prevent the kind of failures we're seeing >> here. >> >> Adam K

> > I'd be happy to do a minimum "skip all if $ENV{AUTHOR_TESTS}" patch for > the usual suspects if requested. Whatever way we need to do this so > that I don't have to force install or use distroprefs to apply my patch > manually. I have several clients with administrators that won't move my > apps to production when "make install" returns any errors (which is > highly reasonable, even for this case). I imagine I'm not the only one. > I'd be willing to put a few hours into this. > > john napiorkowski >

Mon Jul 20 03:13:01 2009 abw [...] wardley.org - Correspondence added

Subject:	Re: [rt.cpan.org #47850] Template-Toolkit-2.21 breaks in
Date:	Mon, 20 Jul 2009 08:12:36 +0100
To:	bug-Template-Toolkit [...] rt.cpan.org
From:	Andy Wardley <abw [...] wardley.org>

Adam wrote: Show quoted text

> Module should NEVER run author/releases tests during end user > installation, exactly to prevent the kind of failures we're seeing > here.

My bad. John Napiorkowski via RT wrote: Show quoted text

> I'd be happy to do a minimum "skip all if $ENV{AUTHOR_TESTS}" patch for > the usual suspects if requested.

Yes please. Send me a username/password and I'll give you a commit bit. I'll push out a new release as soon as it's done. Many thanks. Andy

Tue Jul 21 07:18:03 2009 cpan [...] wardley.org - Correspondence added

Tests have now been patched to only run under RELEASE_TESTING (thanks John).

Tue Jul 21 07:18:04 2009 cpan [...] wardley.org - Status changed from 'open' to 'resolved'