diff options
author | Carl Friedrich Bolz <cfbolz@gmx.de> | 2007-03-22 19:17:23 +0000 |
---|---|---|
committer | Carl Friedrich Bolz <cfbolz@gmx.de> | 2007-03-22 19:17:23 +0000 |
commit | 9bd7734f076c1707ae7685ed3e55bfc9a88e6d93 (patch) | |
tree | cb489c69a4036b73ce2beacd58f2397896857541 /pypy/doc/__pypy__-module.txt | |
parent | typo (diff) | |
download | pypy-9bd7734f076c1707ae7685ed3e55bfc9a88e6d93.tar.gz pypy-9bd7734f076c1707ae7685ed3e55bfc9a88e6d93.tar.bz2 pypy-9bd7734f076c1707ae7685ed3e55bfc9a88e6d93.zip |
don't duplicate the interface section, point to it (still mention the names,
for easier greppability).
Diffstat (limited to 'pypy/doc/__pypy__-module.txt')
-rw-r--r-- | pypy/doc/__pypy__-module.txt | 36 |
1 files changed, 13 insertions, 23 deletions
diff --git a/pypy/doc/__pypy__-module.txt b/pypy/doc/__pypy__-module.txt index 24253b9fb4..6fba7ac0fb 100644 --- a/pypy/doc/__pypy__-module.txt +++ b/pypy/doc/__pypy__-module.txt @@ -37,36 +37,26 @@ For explanations and examples see the `thunk object space docs`_. .. _`thunk object space docs`: objspace-proxies.html#thunk Taint Object Space Functionality -=============================== +================================ When the taint object space is used (choose with :config:`objspace.name`), -the following objects are put into ``__pypy__``: - - - ``taint(obj)``: Return a tainted version of the argument. - - - ``is_tainted(obj)``: Return whether the argument is tainted. - - - ``untaint(expectedtype, tainted_obj)``: Untaint untainted_obj and return it. - If the result is not of expectedtype, raise a type error. - - - ``taint_atomic(callable)``: decorator to make a callable "taint-atomic": if - the function is called with tainted arguments, those are untainted. The - result of the function is tainted again. All exceptions that the callable - raises are turned into taint bombs. - - - ``_taint_debug(debug_level)``: Set the debug level. If the debug level is - greater than 0, the creation of taint bombs will print debug information. For - debugging purposes only! +the following names are put into ``__pypy__``: - - ``_taint_look(obj)``: Print some info about the taintedness of an object. For - debugging purposes only! + - ``taint`` + - ``is_tainted`` + - ``untaint`` + - ``taint_atomic`` + - ``_taint_debug`` + - ``_taint_look`` + - ``TaintError`` - - ``TaintError``: Exception that is raised when an operation revealing - information on a tainted object is performed. +Those are all described in the `interface section`_ of the taint object space +docs. -For explanations and examples see the `taint object space docs`_. +For more detailed explanations and examples see the `taint object space docs`_. .. _`taint object space docs`: objspace-proxies.html#taint +.. _`interface section`: objspace-proxies.html#taint-interface Transparent Proxy Functionality =============================== |