Skip Menu |

This queue is for tickets about the DBD-mysql CPAN distribution.

Report information
The Basics
Id: 90101
Status: rejected
Priority: 0/
Queue: DBD-mysql

People
Owner: Nobody in particular
Requestors: dmn [...] debian.org
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: (no value)
Fixed in: (no value)



Subject: [PATCH] README.pod misses proper NAME heading
Date: Wed, 6 Nov 2013 22:43:08 +0200
To: bug-dbd-mysql [...] rt.cpan.org
From: Damyan Ivanov <dmn [...] debian.org>
Hi, While preparing and update of the Debian package of DBD-mysql, I noticed that the README.pod file misses a proper NAME heading. Each manual page should start with a "NAME" section, which lists the name and a brief description of the page separated by "-". The "NAME" section is parsed by lexgrog and used to generate a database that's queried by commands like apropos and whatis. The attached patch modifies the first heading to match this requirement. Thanks for considering, Damyan Ivanov, Debian Perl Group

Message body is not shown because sender requested not to inline it.

Thanks for the patch. I was not aware there actually is a spec for README files :D I applied it here: https://github.com/perl5-dbi/DBD-mysql/commit/1b1e5f3ca5df2842ff83b05754551d2043109917 -- Mike
Your patch caused issues with displaying the documentation on search.cpan.org and metacpan.org -- see https://rt.cpan.org/Ticket/Display.html?id=92350 Unfortunately I had to revert the patch; so the next version of DBD::mysql will no longer have it. Of course if the Debian team needs it to match with your guidelines, you might decide to carry it downstream. -- Mike.