Update of /cvsroot/module-build/Module-Build/lib/Module/Build
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24983/lib/Module/Build
Modified Files:
Authoring.pod
Log Message:
Fix (and otherwise improve) the docs for auto_features
Index: Authoring.pod
===================================================================
RCS file: /cvsroot/module-build/Module-Build/lib/Module/Build/Authoring.pod,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -d -r1.11 -r1.12
--- Authoring.pod 19 Jul 2005 00:14:21 -0000 1.11
+++ Authoring.pod 19 Jul 2005 00:29:01 -0000 1.12
@@ -127,20 +127,25 @@
pg_support =>
{
description => "Interface with Postgres databases",
- requires => q{ DBD::Pg >= 23.3 && DateTime::Format::Pg },
+ requires => { 'DBD::Pg' => 23.3,
+ 'DateTime::Format::Pg' => 0 },
},
mysql_support =>
{
description => "Interface with MySQL databases",
- requires => q{ DBD::mysql >= 17.9 && DateTime::Format::Pg },
+ requires => { 'DBD::mysql' => 17.9,
+ 'DateTime::Format::MySQL' => 0},
},
);
-For each feature named, the prerequisite options will be checked, and
+For each feature named, the required prerequisites will be checked, and
if there are no failures, the feature will be enabled (set to C<1>).
Otherwise the failures will be displayed to the user and the feature
will be disabled (set to C<0>).
+See the documentation for L<requires> for the details of how
+requirements can be specified.
+
=item autosplit
An optional C<autosplit> argument specifies a file which should be run
@@ -173,6 +178,9 @@
the body of installed modules, and facilitates correct dependency
checking on binary/packaged distributions of the module.
+See the documentation for L<requires> for the details of how
+requirements can be specified.
+
=item c_source
An optional C<c_source> argument specifies a directory which contains
@@ -188,6 +196,9 @@
refuse to install the given module if the given module/version is also
installed.
+See the documentation for L<requires> for the details of how
+requirements can be specified.
+
=item create_makefile_pl
This parameter lets you use Module::Build::Compat during the
@@ -562,12 +573,15 @@
If a module is recommended but not required, all tests should still
pass if the module isn't installed. This may mean that some tests
-will be skipped if recommended dependencies aren't present.
+may be skipped if recommended dependencies aren't present.
Automated tools like CPAN.pm should inform the user when recommended
modules aren't installed, and it should offer to install them if it
wants to be helpful.
+See the documentation for L<requires> for the details of how
+requirements can be specified.
+
=item requires
An optional C<requires> argument specifies any module prerequisites that
@@ -596,7 +610,7 @@
One note: currently C<Module::Build> doesn't actually I<require> the
user to have dependencies installed, it just strongly urges. In the
-future we may require it. There's now a C<recommends> section for
+future we may require it. There's also a C<recommends> section for
things that aren't absolutely required.
Automated tools like CPAN.pm should refuse to install a module if one
|
