added a caveat regarding XML::Simple's strict mode (Peter Corlett)

[p5sagit/Config-Any.git] / lib / Config / Any / XML.pm

diff --git a/lib/Config/Any/XML.pm b/lib/Config/Any/XML.pm
index a5fc881..ca2d55b 100644 (file)
--- a/lib/Config/Any/XML.pm
+++ b/lib/Config/Any/XML.pm
@@ -73,19 +73,37 @@ sub _coerce {
     $out;
 }
 
-=head1 AUTHOR
+=head2 is_supported( )
 
-=over 4 
+Returns true if L<XML::Simple> is available.
 
-=item * Brian Cassidy E<lt>bricas@cpan.orgE<gt>
+=cut
 
-=item * Joel Bernstein E<lt>rataxis@cpan.orgE<gt>
+sub is_supported {
+    eval { require XML::Simple; };
+    return $@ ? 0 : 1;
+}
 
-=back
+=head1 CAVEATS
+
+=head2 Strict Mode
+
+If, by some chance, L<XML::Simple> has already been loaded with the strict
+flag turned on, then you will likely get errors as warnings will become
+fatal exceptions and certain arguments to XMLin() will no longer be optional.
+
+See L<XML::Simple's strict mode documentation|XML::Simple/STRICT_MODE> for
+more information.
+
+=head1 AUTHORS
+
+Brian Cassidy E<lt>bricas@cpan.orgE<gt>
+
+Joel Bernstein E<lt>rataxis@cpan.orgE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006 by Brian Cassidy
+Copyright 2007 by Brian Cassidy
 
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself.