[pypy-svn] pypy default: Document hints

[fijal]

Author: Maciej Fijalkowski <fijall at gmail.com>
Branch: 
Changeset: r42405:ea0d96b9dbf4
Date: 2011-03-03 13:21 +0200
http://bitbucket.org/pypy/pypy/changeset/ea0d96b9dbf4/

Log:	Document hints

diff --git a/pypy/rlib/jit.py b/pypy/rlib/jit.py
--- a/pypy/rlib/jit.py
+++ b/pypy/rlib/jit.py
@@ -25,7 +25,14 @@
     """ Hint for the JIT
 
     possible arguments are:
-    XXX
+
+    * promote - promote the argument from a variable into a constant
+    * access_directly - directly access a virtualizable, as a structure
+                        and don't treat it as a virtualizable
+    * fresh_virtualizable - means that virtualizable was just allocated.
+                            Useful in say Frame.__init__ when we do want
+                            to store things directly on it. Has to come with
+                            access_directly=True
     """
     return x