From: Vincent Pit Date: Tue, 17 Feb 2009 23:36:49 +0000 (+0100) Subject: Reorder the POD so that the functions come before the constants and the history X-Git-Tag: v0.31~6 X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2FVariable-Magic.git;a=commitdiff_plain;h=465116de630d8f9964b584e370ca991bd14cf542 Reorder the POD so that the functions come before the constants and the history --- diff --git a/lib/Variable/Magic.pm b/lib/Variable/Magic.pm index b79bf8e..556e995 100644 --- a/lib/Variable/Magic.pm +++ b/lib/Variable/Magic.pm @@ -179,123 +179,6 @@ You can refer to the tests to have more insight of where the different magics ar To prevent any clash between different magics defined with this module, an unique numerical signature is attached to each kind of magic (i.e. each set of callbacks for magic operations). -=head1 PERL MAGIC HISTORY - -The places where magic is invoked have changed a bit through perl history. -Here's a little list of the most recent ones. - -=over 4 - -=item * - -B<5.6.x> - -I : 'copy' and 'dup' magic. - -=item * - -B<5.8.9> - -I : Integration of I (see below). - -I : Integration of I (see below). - -=item * - -B<5.9.3> - -I : 'len' magic is no longer called when pushing an element into a magic array. - -I : 'local' magic. - -=item * - -B<5.9.5> - -I : Meaningful 'uvar' magic. - -I : 'clear' magic wasn't invoked when undefining an array. -The bug is fixed as of this version. - -=item * - -B<5.10.0> - -Since C is uppercased, C triggers 'copy' magic on hash stores for (non-tied) hashes that also have 'uvar' magic. - -=item * - -B<5.11.x> - -I : 'len' magic is no longer invoked when calling C with a magical scalar. - -I : 'len' magic is no longer called when pushing / unshifting an element into a magical array in void context. -The C part was already covered by I. - -=back - -=head1 CONSTANTS - -=head2 C - -The minimum integer used as a signature for user-defined magic. - -=head2 C - -The maximum integer used as a signature for user-defined magic. - -=head2 C - - SIG_NBR = SIG_MAX - SIG_MIN + 1 - -=head2 C - -Evaluates to true iff the 'copy' magic is available. - -=head2 C - -Evaluates to true iff the 'dup' magic is available. - -=head2 C - -Evaluates to true iff the 'local' magic is available. - -=head2 C - -When this constant is true, you can use the C callbacks on hashes. - -=head2 C - -True for perls that don't call 'len' magic when you push an element in a magical array. - -=head2 C - -True for perls that don't call 'len' magic when you unshift in void context an element in a magical array. - -=head2 C - -True for perls that call 'clear' magic when undefining magical arrays. - -=head2 C - -True for perls that don't call 'len' magic when taking the C of a magical scalar. - -=head2 C - -The perl patchlevel this module was built with, or C<0> for non-debugging perls. - -=head2 C - -True iff this module could have been built with thread-safety features enabled. - -=head2 C - -Value to pass with C to get the current op name in the magic callbacks. - -=head2 C - -Value to pass with C to get a C object representing the current op in the magic callbacks. - =head1 FUNCTIONS =cut @@ -474,6 +357,123 @@ True is returned on success, C<0> on error or when no magic represented by C<$wi # Dispell now. If $wiz isn't a signature, undef can't be returned. die 'no such magic or error' unless dispell $x, $wiz; +=head1 CONSTANTS + +=head2 C + +The minimum integer used as a signature for user-defined magic. + +=head2 C + +The maximum integer used as a signature for user-defined magic. + +=head2 C + + SIG_NBR = SIG_MAX - SIG_MIN + 1 + +=head2 C + +Evaluates to true iff the 'copy' magic is available. + +=head2 C + +Evaluates to true iff the 'dup' magic is available. + +=head2 C + +Evaluates to true iff the 'local' magic is available. + +=head2 C + +When this constant is true, you can use the C callbacks on hashes. + +=head2 C + +True for perls that don't call 'len' magic when you push an element in a magical array. + +=head2 C + +True for perls that don't call 'len' magic when you unshift in void context an element in a magical array. + +=head2 C + +True for perls that call 'clear' magic when undefining magical arrays. + +=head2 C + +True for perls that don't call 'len' magic when taking the C of a magical scalar. + +=head2 C + +The perl patchlevel this module was built with, or C<0> for non-debugging perls. + +=head2 C + +True iff this module could have been built with thread-safety features enabled. + +=head2 C + +Value to pass with C to get the current op name in the magic callbacks. + +=head2 C + +Value to pass with C to get a C object representing the current op in the magic callbacks. + +=head1 PERL MAGIC HISTORY + +The places where magic is invoked have changed a bit through perl history. +Here's a little list of the most recent ones. + +=over 4 + +=item * + +B<5.6.x> + +I : 'copy' and 'dup' magic. + +=item * + +B<5.8.9> + +I : Integration of I (see below). + +I : Integration of I (see below). + +=item * + +B<5.9.3> + +I : 'len' magic is no longer called when pushing an element into a magic array. + +I : 'local' magic. + +=item * + +B<5.9.5> + +I : Meaningful 'uvar' magic. + +I : 'clear' magic wasn't invoked when undefining an array. +The bug is fixed as of this version. + +=item * + +B<5.10.0> + +Since C is uppercased, C triggers 'copy' magic on hash stores for (non-tied) hashes that also have 'uvar' magic. + +=item * + +B<5.11.x> + +I : 'len' magic is no longer invoked when calling C with a magical scalar. + +I : 'len' magic is no longer called when pushing / unshifting an element into a magical array in void context. +The C part was already covered by I. + +=back + =head1 EXPORT The functions L, L, L, L, L and L are only exported on request.