more pod patches
[p5sagit/p5-mst-13.2.git] / ext / attrs / attrs.pm
index 01a0de3..6c50bea 100644 (file)
@@ -1,14 +1,11 @@
 package attrs;
-require DynaLoader;
-use vars '@ISA';
-@ISA = 'DynaLoader';
+use XSLoader ();
 
-use vars qw($VERSION);
 $VERSION = "1.0";
 
 =head1 NAME
 
-attrs - set/get attributes of a subroutine
+attrs - set/get attributes of a subroutine (deprecated)
 
 =head1 SYNOPSIS
 
@@ -21,45 +18,41 @@ attrs - set/get attributes of a subroutine
 
 =head1 DESCRIPTION
 
-This module lets you set and get attributes for subroutines.
+NOTE: Use of this pragma is deprecated.  Use the syntax
+
+    sub foo : locked method { }
+
+to declare attributes instead.  See also L<attributes>.
+
+This pragma lets you set and get attributes for subroutines.
 Setting attributes takes place at compile time; trying to set
 invalid attribute names causes a compile-time error. Calling
-C<attr::get> on a subroutine reference or name returns its list
-of attribute names. Notice that C<attr::get> is not exported.
+C<attrs::get> on a subroutine reference or name returns its list
+of attribute names. Notice that C<attrs::get> is not exported.
 Valid attributes are as follows.
 
-=over
+=over 4
 
 =item method
 
 Indicates that the invoking subroutine is a method.
 
-=item package
-
-If the subroutine is locked, lock the package in which it is
-defined.
-
 =item locked
 
 Setting this attribute is only meaningful when the subroutine or
-method is to be called by multiple threads. When the B<package>
-attribute is set then before executing the subroutine or method
-perl acquires a lock on the package in which the subroutine is
-defined. 
-
-Otherwise, when set on a method subroutine (i.e. one
-marked with the B<method> attribute above), perl ensures that any
-invocation of it implicitly locks its first argument before
-execution. When set on a non-method subroutine,
-(without a B<package> attribute) perl ensures that a lock is taken 
-on the subroutine itself before execution. The semantics of the
-lock are exactly those of one explicitly taken with the C<lock> 
-operator immediately after the subroutine is entered.
+method is to be called by multiple threads. When set on a method
+subroutine (i.e. one marked with the B<method> attribute above),
+perl ensures that any invocation of it implicitly locks its first
+argument before execution. When set on a non-method subroutine,
+perl ensures that a lock is taken on the subroutine itself before
+execution. The semantics of the lock are exactly those of one
+explicitly taken with the C<lock> operator immediately after the
+subroutine is entered.
 
 =back
 
 =cut
 
-bootstrap attrs $VERSION;
+XSLoader::load 'attrs', $VERSION;
 
 1;