update the CAVEATS section
[gitmo/Package-Stash-XS.git] / lib / Package / Stash / XS.pm
1 package Package::Stash::XS;
2 use strict;
3 use warnings;
4 # ABSTRACT: faster and more correct implementation of the Package::Stash API
5
6 use XSLoader;
7 XSLoader::load(
8     __PACKAGE__,
9     # we need to be careful not to touch $VERSION at compile time, otherwise
10     # DynaLoader will assume it's set and check against it, which will cause
11     # fail when being run in the checkout without dzil having set the actual
12     # $VERSION
13     exists $Package::Stash::XS::{VERSION}
14         ? ${ $Package::Stash::XS::{VERSION} } : (),
15 );
16
17 =head1 SYNOPSIS
18
19   use Package::Stash;
20
21 =head1 DESCRIPTION
22
23 This is a backend for L<Package::Stash>, which provides the functionality in a
24 way that's less buggy and much faster. It will be used by default if it's
25 installed, and should be preferred in all environments with a compiler.
26
27 =head1 BUGS / CAVEATS
28
29 =over 4
30
31 =item * Prior to perl 5.10, scalar slots are only considered to exist if they are defined
32
33 This is due to a shortcoming within perl itself. See 
34 L<perlref/Making References> point 7 for more information.
35
36 =back
37
38 Please report any bugs through RT: email
39 C<bug-package-stash-xs at rt.cpan.org>, or browse to
40 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Package-Stash-XS>.
41
42 =head1 SEE ALSO
43
44 =over 4
45
46 =item * L<Class::MOP::Package>
47
48 This module is a factoring out of code that used to live here
49
50 =back
51
52 =head1 SUPPORT
53
54 You can find this documentation for this module with the perldoc command.
55
56     perldoc Package::Stash::XS
57
58 You can also look for information at:
59
60 =over 4
61
62 =item * AnnoCPAN: Annotated CPAN documentation
63
64 L<http://annocpan.org/dist/Package-Stash-XS>
65
66 =item * CPAN Ratings
67
68 L<http://cpanratings.perl.org/d/Package-Stash-XS>
69
70 =item * RT: CPAN's request tracker
71
72 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Package-Stash-XS>
73
74 =item * Search CPAN
75
76 L<http://search.cpan.org/dist/Package-Stash-XS>
77
78 =back
79
80 =head1 AUTHOR
81
82 Jesse Luehrs <doy at tozt dot net>
83
84 Based on code from L<Class::MOP::Package>, by Stevan Little and the Moose
85 Cabal.
86
87 =cut
88
89 1;