Skip Menu |

This queue is for tickets about the Module-CPANTS-Analyse CPAN distribution.

Report information
The Basics
Id: 102324
Status: new
Priority: 0/
Queue: Module-CPANTS-Analyse
People
Owner: Nobody in particular
Requestors: ether [...] cpan.org
Cc:
AdminCc:
Bug Information
Severity: Wishlist
Broken in: (no value)
Fixed in: (no value)

History Show all quoted text
  Tue Feb 24 13:12:18 2015 ether [...] cpan.org - Ticket created
Subject: new kwalitee metric: dist contains README.pod
Many dists, especially those using Dist::Zilla, are now generating README.pod documents in their distribution. Unfortunately due to the way installers (EUMM, MB, MBT) work, a .pod file in the root of the Foo-Bar distribution will get installed for the user as lib/Foo/README.pod (making it possible to 'perldoc Foo::README') -- definitely not the user's intent! This problem can happen with any .pod or .pm file in the root directory, but README.pod is a common instance where we know it's unintentional, and we can catch this case and alert the author to the problem.
  Sat Mar 07 17:54:27 2015 ether [...] cpan.org - Correspondence added
On 2015-02-24 10:12:18, ETHER wrote: Show quoted text
> Many dists, especially those using Dist::Zilla, are now generating > README.pod documents in their distribution. Unfortunately due to the > way installers (EUMM, MB, MBT) work, a .pod file in the root of the > Foo-Bar distribution will get installed for the user as > lib/Foo/README.pod (making it possible to 'perldoc Foo::README') -- > definitely not the user's intent! > > This problem can happen with any .pod or .pm file in the root > directory, but README.pod is a common instance where we know it's > unintentional, and we can catch this case and alert the author to the > problem.
This metric also needs to check the INSTALL.SKIP file - any files listed there will be skipped by ExtUtils::Install.