From: Karen Etheridge <ether@cpan.org>
Date: Thu, 22 Dec 2011 23:10:43 +0000 (-0800)
Subject: doc patches, re Getopt::Long config and extra_argv.
X-Git-Tag: 0.38~2
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMooseX-Getopt.git;a=commitdiff_plain;h=449f00873d6a740b73bcb55c8d3afbbc1640036e

doc patches, re Getopt::Long config and extra_argv.
---

diff --git a/ChangeLog b/ChangeLog
index 0aa8866..3df29e8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 Revision history for Perl extension MooseX-Getopt
 
+{{$NEXT}}
+  * More documentation on Getopt::Long settings and how they alter this role's
+    behaviour, in particular with regards to extra_argv capturing.
+    (Karen Etheridge)
+
 0.37 Wed 30 Mar 2011
   * Fix missing dependency. (RT#67077)
 
diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm
index 038d141..cd0cd8b 100644
--- a/lib/MooseX/Getopt.pm
+++ b/lib/MooseX/Getopt.pm
@@ -218,6 +218,12 @@ This accessor contains an arrayref of leftover C<@ARGV> elements that
 L<Getopt::Long> did not parse.  Note that the real C<@ARGV> is left
 un-mangled.
 
+B<Important>: By default, L<Getopt::Long> will reject unrecognized arguments
+(that is, arguments that do not correspond with attributes using the Getopt
+trait). To disable this, and allow the population of C<extra_argv>, enable the
+C<pass_through> option of L<Getopt::Long> for your class:  C<use Getopt::Long
+qw(:config pass_through);>
+
 =method B<usage>
 
 This accessor contains the L<Getopt::Long::Descriptive::Usage> object (if
@@ -240,4 +246,12 @@ L<MooseX::Getopt::ProcessedArgv> object. C<new_with_options> uses this
 method internally, so modifying this method via subclasses/roles will affect
 C<new_with_options>.
 
+=head2 More Customization Options
+
+See L<Getopt::Long#Configuring_Getopt::Long> for many other customizations you
+can make to how options are parsed. Simply C<use Getopt::Long qw(:config
+other_options...)> in your class to set these.
+
+=back
+
 =cut