| Subject: | Docpatch for case when extension not installed on author-side |
| Date: | Sun, 18 Jul 2010 01:55:12 +0100 |
| To: | bugs-Module-Install-ReadmeFromPod [...] rt.cpan.org |
| From: | Hakim Cassimally <hakim.cassimally [...] gmail.com> |
I just submitted https://rt.cpan.org/Public/Bug/Display.html?id=59495
against M::I because the instructions for M::I::RFP "don't work" out
of the box:
$ perl Makefile.PL
include /home/hakim/other_repos/Harold/inc/Module/Install.pm
String found where operator expected at Makefile.PL line 7, near
"readme_from 'lib/Harold.pm'"
(Do you need to predeclare readme_from?)
syntax error at Makefile.PL line 7, near "readme_from 'lib/Harold.pm'"
Execution of Makefile.PL aborted due to compilation errors.
Of course the problem is that I didn't have
Module::Install::ReadmeFromPod installed... the confusing error seems
to be a result of the way the M::I plugin system works, hence the
above bug. But in the meantime, would a doc-patch be reasonable?
diff --git a/lib/Module/Install/ReadmeFromPod.pm
b/lib/Module/Install/ReadmeFromPod.pm
index b04473b..99408cd 100644
--- a/lib/Module/Install/ReadmeFromPod.pm
+++ b/lib/Module/Install/ReadmeFromPod.pm
@@ -46,6 +46,9 @@ Module::Install::ReadmeFromPod - A Module::Install
extension to automatically co
A C<README> file will be generated from the POD of the indicated module file.
+Note that the author will need to make sure
C<Module::Install::ReadmeFromPod> is installed
+before running the C<Makefile.PL>. (The extension will be bundled
into the user-side distribution).
+
=head1 DESCRIPTION
Module::Install::ReadmeFromPod is a L<Module::Install> extension that
generates a C<README> file