* add feature to disable cycle checking, eitehr via trait or option

[gitmo/MooseX-Storage.git] / lib / MooseX / Storage / Basic.pm

diff --git a/lib/MooseX/Storage/Basic.pm b/lib/MooseX/Storage/Basic.pm
index 686772b..8b74b37 100644 (file)
--- a/lib/MooseX/Storage/Basic.pm
+++ b/lib/MooseX/Storage/Basic.pm
@@ -82,7 +82,14 @@ but the exported C<Storage> function.
 
 =over 4
 
-=item B<pack>
+=item B<pack ([ disable_cycle_check => 1])>
+
+Providing the C<disable_cycle_check> argument disables checks for any cyclical
+references. The current implementation for this check is rather naive, so if
+you know what you are doing, you can bypass this check.
+
+This trait is applied on a perl-case basis. To set this flag for all objects
+that inherit from this role, see L<MooseX::Storage::Traits::DisableCycleDetection>.
 
 =item B<unpack ($data [, insert => { key => val, ... } ] )>