Document that restricted hashes are not atomic

(from Dave Mitchell).

p4raw-id: //depot/perl@19346

diff --git a/lib/Hash/Util.pm b/lib/Hash/Util.pm
index 90a8e5a..c7350f6 100644 (file)
--- a/lib/Hash/Util.pm
+++ b/lib/Hash/Util.pm
@@ -178,6 +178,15 @@ sub unlock_hash (\%) {
 
 =back
 
+=head1 CAVEATS
+
+Note that the trapping of the restricted operations is not atomic:
+for example
+
+    eval { %hash = (illegal_key => 1) }
+
+leaves the C<%hash> empty rather than with its original contents.
+
 =head1 AUTHOR
 
 Michael G Schwern <schwern@pobox.com> on top of code by Nick