Skip Menu |

This queue is for tickets about the Test-Harness CPAN distribution.

Report information
The Basics
Id: 73399
Status: resolved
Priority: 0/
Queue: Test-Harness
People
Owner: Nobody in particular
Requestors: dom [...] cpan.org
Cc:
AdminCc:
Bug Information
Severity: (no value)
Broken in: 3.23
Fixed in: 3.29

History Show all quoted text
  Tue Dec 20 18:54:14 2011 dom [...] cpan.org - Ticket created
Subject: NAME sections in manpages
Please find the attached patch which adds missing NAMES to the pod files/manpages of this distribution. Thanks, Dominic.
Subject: 0003-cpan-Test-Harness-add-NAME-headings-in-modules-with-.patch
From ad3f2a97aa5de5aea8ebe515f2f50a4669dc6ca7 Mon Sep 17 00:00:00 2001 From: Dominic Hargreaves <dom@earth.li> Date: Tue, 20 Dec 2011 23:28:18 +0000 Subject: [PATCH 3/4] cpan/Test-Harness: add NAME headings in modules with POD This fixes the Debian Lintian warning about missing NAME sections in manpages. Bug-Debian: http://bugs.debian.org/650451 Patch-Name: fixes/manpage_name_Test-Harness.diff --- cpan/Test-Harness/lib/TAP/Harness/Beyond.pod | 4 ++++ 1 files changed, 4 insertions(+), 0 deletions(-) diff --git a/cpan/Test-Harness/lib/TAP/Harness/Beyond.pod b/cpan/Test-Harness/lib/TAP/Harness/Beyond.pod index ed77e13..7281508 100644 --- a/cpan/Test-Harness/lib/TAP/Harness/Beyond.pod +++ b/cpan/Test-Harness/lib/TAP/Harness/Beyond.pod @@ -1,3 +1,7 @@ +=head1 NAME + +Test::Harness - Beyond make test + =head1 Beyond make test Test::Harness is responsible for running test scripts, analysing
  Wed Apr 11 19:00:43 2012 mschwern [...] cpan.org - Correspondence added
Does every POD file need a NAME section? This one isn't documenting a module and doesn't follow the normal man page format kinda deliberately, it's a policy document.
  Wed Apr 11 19:00:45 2012 The RT System itself - Status changed from 'new' to 'open'
  Fri Apr 13 18:23:48 2012 dom [...] earth.li - Correspondence added
Subject: Re: [rt.cpan.org #73399] NAME sections in manpages
Date: Fri, 13 Apr 2012 23:23:37 +0100
To: Michael G Schwern via RT <bug-Test-Harness [...] rt.cpan.org>
From: Dominic Hargreaves <dom [...] earth.li>
On Wed, Apr 11, 2012 at 07:00:45PM -0400, Michael G Schwern via RT wrote: Show quoted text
> Does every POD file need a NAME section? This one isn't documenting a > module and doesn't follow the normal man page format kinda deliberately, > it's a policy document.
The trigger for preparing this patch was to get rid of the warning from Debian's code checking tool lintian: the warning in question is described at <http://lintian.debian.org/tags/manpage-has-bad-whatis-entry.html> In other words, pod2man was creating an invalid manpage as a result of this POD. I won't go so far as to say whether this is technically a problem with pod2man, or your POD. I suppose a third possibility is that manpages shouldn't be build from those at all. Cheers, Dominic. -- Dominic Hargreaves | http://www.larted.org.uk/~dom/ PGP key 5178E2A5 from the.earth.li (keyserver,web,email)
  Wed Oct 02 10:08:56 2013 LEONT [...] cpan.org - Correspondence added
On Tue Dec 20 18:54:14 2011, DOM wrote: Show quoted text
> Please find the attached patch which adds missing NAMES to the pod > files/manpages of this distribution.
I just pushed the patch, it will be part of the upcoming 3.29 release. Leon
  Tue Nov 12 11:29:34 2013 LEONT [...] cpan.org - Status changed from 'open' to 'resolved'
  Tue Nov 12 11:29:34 2013 LEONT [...] cpan.org - Fixed in 3.29 added