[pypy-commit] pypy default: Add a comment about @jit.promote_string.

[vext01]

Author: Edd Barrett <vext01 at gmail.com>
Branch: 
Changeset: r76964:56a37dcb76cf
Date: 2015-05-01 16:08 +0100
http://bitbucket.org/pypy/pypy/changeset/56a37dcb76cf/

Log:	Add a comment about @jit.promote_string.

	Input from fijal. Thanks.

diff --git a/rpython/rlib/jit.py b/rpython/rlib/jit.py
--- a/rpython/rlib/jit.py
+++ b/rpython/rlib/jit.py
@@ -116,6 +116,10 @@
     Overpromotion is characterised by a cascade of bridges branching from
     very similar guard_value opcodes, each guarding the same variable under
     a different value.
+
+    Note that promoting a string with @jit.promote will promote by pointer.
+    To promote a string by value, see @jit.promote_string.
+
     """
     return hint(x, promote=True)