This is 0.10

[perl/modules/Scope-Upper.git] / README

diff --git a/README b/README
index 16f88ca56cd9895c60ad6903efac19530457fa7e..074581cbe7cf8130d2d391cbbc85974e775d7b8f 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     Scope::Upper - Act on upper scopes.
 
 VERSION
-    Version 0.07
+    Version 0.10
 
 SYNOPSIS
         package X;
@@ -57,7 +57,9 @@ SYNOPSIS
         sub zap {
          try {
           return @things; # returns to try() and then outside zap()
+          # not reached
          }
+         # not reached
         }
 
         my @what = zap(); # @what contains @things
@@ -86,8 +88,8 @@ FUNCTIONS
     needed, and it will still denote the original scope.
 
   "reap $callback, $context"
-    Add a destructor that calls $callback when the upper scope represented
-    by $context ends.
+    Add a destructor that calls $callback (in void context) when the upper
+    scope represented by $context ends.
 
   "localize $what, $value, $context"
     A "local" delayed to the time of first return into the upper scope
@@ -151,6 +153,7 @@ FUNCTIONS
         my $num = sub {
          my @a = ('a' .. 'z');
          unwind @a => HERE;
+         # not reached
         }->();
 
     will set $num to 'z'. You can use "want_at" to handle these cases.
@@ -164,9 +167,14 @@ FUNCTIONS
         my $num = sub {
          my @a = ('a' .. 'z');
          unwind +(want_at(HERE) ? @a : scalar @a) => HERE;
+         # not reached
         }->();
 
-    will righteously set $num to 26.
+    will rightfully set $num to 26.
+
+CONSTANTS
+  "SU_THREADSAFE"
+    True iff the module could have been built when thread-safety features.
 
 WORDS
   Constants
@@ -268,6 +276,9 @@ EXPORT
     "unwind" and "want_at" are only exported on request, either individually
     or by the tags ':funcs' and ':all'.
 
+    The constant "SU_THREADSAFE" is also only exported on request,
+    individually or by the tags ':consts' and ':all'.
+
     Same goes for the words "TOP", "HERE", "UP", "SUB", "EVAL", "SCOPE" and
     "CALLER" that are only exported on request, individually or by the tags
     ':words' and ':all'.
@@ -311,6 +322,11 @@ DEPENDENCIES
 SEE ALSO
     Alias, Hook::Scope, Scope::Guard, Guard.
 
+    Continuation::Escape is a thin wrapper around Scope::Upper that gives
+    you a continuation passing style interface to "unwind". It's easier to
+    use, but it requires you to have control over the scope where you want
+    to return.
+
 AUTHOR
     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
 
@@ -337,7 +353,7 @@ ACKNOWLEDGEMENTS
     Thanks to Shawn M. Moore for motivation.
 
 COPYRIGHT & LICENSE
-    Copyright 2008-2009 Vincent Pit, all rights reserved.
+    Copyright 2008,2009,2010 Vincent Pit, all rights reserved.
 
     This program is free software; you can redistribute it and/or modify it
     under the same terms as Perl itself.