[Jifty-commit] r5450 - Runops-Trace/trunk/lib/Runops

[Jifty commits]

Author: nothingmuch
Date: Sat May 10 13:20:17 2008
New Revision: 5450

Modified:
   Runops-Trace/trunk/lib/Runops/Trace.pm

Log:
document arity

Modified: Runops-Trace/trunk/lib/Runops/Trace.pm
==============================================================================
--- Runops-Trace/trunk/lib/Runops/Trace.pm	(original)
+++ Runops-Trace/trunk/lib/Runops/Trace.pm	Sat May 10 13:20:17 2008
@@ -213,6 +213,33 @@
 
 Like C<mask_none> was called, but removes the mask entirely.
 
+=item ARITY_NULL
+
+=item ARITY_UNARY
+
+=item ARITY_BINARY
+
+=item ARITY_LIST
+
+=item ARITY_LIST_UNARY
+
+=item ARITY_LIST_BINARY
+
+=item ARITY_UNKNOWN
+
+These constants can be used to inspect the arity paramter.
+
+Note that for C<ARITY_LIST_UNARY> (C<entersub>) and C<ARITY_LIST_BINARY>
+(C<aassign>) the arity value is the binary or of C<ARITY_LIST> and
+C<ARITY_UNARY> or C<ARITY_BINARY>. Test with C<&> or with C<==> according to
+what you are really interested in.
+
+C<ARITY_NULL> means no arguments (e.g. an C<SVOP>).
+
+Some operators do not have their arity figured out yet. Patches welcome.
+
+This should ideally become a method of L<B::OP> later.
+
 =back
 
 =head1 PERL HACKS COMPATIBILITY