[pypy-svn] r12603 - pypy/dist/pypy/documentation

hpk at codespeak.net hpk at codespeak.net
Fri May 20 10:18:38 CEST 2005

Author: hpk
Date: Fri May 20 10:18:38 2005
New Revision: 12603

issue25 testing 

added and clarified a bit the trace object space documentation 
and linked to the implemenation file.  regenerated references. 
removed the assignment to 'rxe' from the issue for now because
it gives a false impression of "somebody currently cares for this". 

Modified: pypy/dist/pypy/documentation/_ref.txt
--- pypy/dist/pypy/documentation/_ref.txt	(original)
+++ pypy/dist/pypy/documentation/_ref.txt	Fri May 20 10:18:38 2005
@@ -13,19 +13,19 @@
 .. _`pypy/lib/test2`: http://codespeak.net/svn/pypy/dist/pypy/lib/test2
 .. _`module/`:
 .. _`pypy/module`: http://codespeak.net/svn/pypy/dist/pypy/module
+.. _`module/__builtin__/`: http://codespeak.net/svn/pypy/dist/pypy/module/__builtin__
 .. _`module/_sre_pypy/`: http://codespeak.net/svn/pypy/dist/pypy/module/_sre_pypy
-.. _`module/builtin/`: http://codespeak.net/svn/pypy/dist/pypy/module/builtin
-.. _`pypy/module/builtin/__init__.py`: http://codespeak.net/svn/pypy/dist/pypy/module/builtin/__init__.py
 .. _`module/parser/`: http://codespeak.net/svn/pypy/dist/pypy/module/parser
 .. _`module/recparser/`: http://codespeak.net/svn/pypy/dist/pypy/module/recparser
-.. _`module/sys2/`: http://codespeak.net/svn/pypy/dist/pypy/module/sys2
+.. _`module/sys/`: http://codespeak.net/svn/pypy/dist/pypy/module/sys
 .. _`pypy/objspace`:
 .. _`objspace/`: http://codespeak.net/svn/pypy/dist/pypy/objspace
 .. _`objspace/flow/`: http://codespeak.net/svn/pypy/dist/pypy/objspace/flow
 .. _`pypy/objspace/std`:
 .. _`objspace/std/`: http://codespeak.net/svn/pypy/dist/pypy/objspace/std
 .. _`objspace/thunk.py`: http://codespeak.net/svn/pypy/dist/pypy/objspace/thunk.py
-.. _`objspace/trace.py`: http://codespeak.net/svn/pypy/dist/pypy/objspace/trace.py
+.. _`objspace/trace.py`:
+.. _`pypy/objspace/trace.py`: http://codespeak.net/svn/pypy/dist/pypy/objspace/trace.py
 .. _`rpython/`: http://codespeak.net/svn/pypy/dist/pypy/rpython
 .. _`tool/`: http://codespeak.net/svn/pypy/dist/pypy/tool
 .. _`tool/pytest/`: http://codespeak.net/svn/pypy/dist/pypy/tool/pytest

Modified: pypy/dist/pypy/documentation/getting_started.txt
--- pypy/dist/pypy/documentation/getting_started.txt	(original)
+++ pypy/dist/pypy/documentation/getting_started.txt	Fri May 20 10:18:38 2005
@@ -172,6 +172,8 @@
 Note that the prompt of the interpreter-level console is only '>>>' since
 it runs on CPython level. To return to PyPy, press <Ctrl-D>.
+.. _`trace example`: 
 Tracing bytecode and operations on objects
@@ -527,13 +529,13 @@
 `module/_sre_pypy/`_           an experimental approach wrapping CPython's ``_sre`` module 
                                without using faking 
-`module/builtin/`_             full implementation of CPython's ``__builtin__`` module. 
+`module/__builtin__/`_         full implementation of CPython's ``__builtin__`` module. 
 `module/parser/`_              parser package from Jonathan David Riehl's `basil`_ package
 `module/recparser/`_           parser package from Logilab 
-`module/sys2/`_                implementation of CPython's ``sys`` module.  
+`module/sys/`_                 implementation of CPython's ``sys`` module.  
 `objspace/`_                   `object space`_ implementations

Modified: pypy/dist/pypy/documentation/objspace.txt
--- pypy/dist/pypy/documentation/objspace.txt	(original)
+++ pypy/dist/pypy/documentation/objspace.txt	Fri May 20 10:18:38 2005
@@ -201,16 +201,25 @@
 The Trace Object Space
-The Trace Object space is a proxy object space, delegating most operations to
-another one -- usually a standard object space -- while tracing them.  It also
-traces frame creation, deletion and bytecode execution.  The ease with which
-the Trace Object Space was implemented at the Amsterdam Sprint
-underlines the power of the Object Space abstraction.  (Of course, the
-previously-implemented Flow Object Space producing the flow graph
-already was proof enough). 
+The Trace Object space is a proxy object space, intercepting and memorizing 
+space operations.  It also traces frame creation, deletion and bytecode execution.  
+It's implementation delegates to another object space - usually the standard 
+object space - in order to  carry out the operations.  The ease with which
+the Trace Object Space was implemented in `pypy/objspace/trace.py`_  
+underlines the power of the Object Space abstraction.   
-In an interactive PyPy prompt, type ``__pytrace__ = 1`` to enable it.
+To make use of the tracing facilities you can at runtime switch
+your interactive session to tracing mode by typing:: 
+    >>> __pytrace__ = 1 
+(Also see the `trace example`_). 
+Note that tracing mode will not show or record all space operations 
+by default to avoid presenting too much information.  Only non-helper 
+operations are usually shown.   
+.. _`trace example`: getting_started.html#trace-example
 The Thunk Object Space

More information about the Pypy-commit mailing list