Author: dagolden
Date: Sat Aug 8 07:55:34 2009
New Revision: 13182
Modified:
Module-Build/trunk/Changes
Module-Build/trunk/lib/Module/Build/API.pod
Log:
Added warning in POD to capitalize get_options
Modified: Module-Build/trunk/Changes
==============================================================================
--- Module-Build/trunk/Changes (original)
+++ Module-Build/trunk/Changes Sat Aug 8 07:55:34 2009
@@ -2,6 +2,11 @@
0.34_04 -
+ Other:
+ - Added documentation warning that 'get_options' should be capitalized
+ to avoid conflicting with future Module::Build options and changed
+ the examples accordingly.
+
0.34_03 - Sat Aug 8 07:39:16 EDT 2009
Bug fixes:
Modified: Module-Build/trunk/lib/Module/Build/API.pod
==============================================================================
--- Module-Build/trunk/lib/Module/Build/API.pod (original)
+++ Module-Build/trunk/lib/Module/Build/API.pod Sat Aug 8 07:55:34 2009
@@ -387,23 +387,24 @@
(
module_name => 'Foo::Bar',
get_options => {
- loud => { store => \$loud },
- dbd => { type => '=s' },
- quantity => { type => '+' },
+ Loud => { store => \$loud },
+ Dbd => { type => '=s' },
+ Quantity => { type => '+' },
}
);
print STDERR "HEY, ARE YOU LISTENING??\n" if $loud;
- print "We'll use the ", $build->args('dbd'), " DBI driver\n";
+ print "We'll use the ", $build->args('Dbd'), " DBI driver\n";
print "Are you sure you want that many?\n"
- if $build->args('quantity') > 2;
+ if $build->args('Quantity') > 2;
The arguments for such a specification can be called like so:
- perl Build.PL --loud --dbd=DBD::pg --quantity --quantity --quantity
+ perl Build.PL --Loud --Dbd=DBD::pg --Quantity --Quantity --Quantity
B<WARNING:> Any option specifications that conflict with Module::Build's own
-options (defined by its properties) will throw an exception.
+options (defined by its properties) will throw an exception. Use capitalized
+option names to avoid unintended conflicts with future Module::Build options.
Consult the Getopt::Long documentation for details on its usage.
