Author: Manuel Jacob
Branch: improve-docs
Changeset: r63887:9fc6184559ee
Date: 2013-05-06 16:18 +0200
http://bitbucket.org/pypy/pypy/changeset/9fc6184559ee/
Log: Cleanup whitespaces and underlines.
diff --git a/pypy/doc/getting-started-dev.rst b/pypy/doc/getting-started-dev.rst
--- a/pypy/doc/getting-started-dev.rst
+++ b/pypy/doc/getting-started-dev.rst
@@ -4,20 +4,21 @@
.. contents::
-.. _`start reading sources`:
+.. _`start reading sources`:
+
Where to start reading the sources
-----------------------------------
+----------------------------------
PyPy is made from parts that are relatively independent of each other.
You should start looking at the part that attracts you most (all paths are
-relative to the PyPy top level directory). You may look at our `directory
reference`_
+relative to the PyPy top level directory). You may look at our `directory
reference`_
or start off at one of the following points:
* `pypy/interpreter`_ contains the bytecode interpreter: bytecode dispatcher
in `pypy/interpreter/pyopcode.py`_, frame and code objects in
`pypy/interpreter/eval.py`_ and `pypy/interpreter/pyframe.py`_,
function objects and argument passing in `pypy/interpreter/function.py`_
and `pypy/interpreter/argument.py`_,
the object space interface definition in
`pypy/interpreter/baseobjspace.py`_, modules in
- `pypy/interpreter/module.py`_ and `pypy/interpreter/mixedmodule.py`_. Core
types supporting the bytecode
+ `pypy/interpreter/module.py`_ and `pypy/interpreter/mixedmodule.py`_. Core
types supporting the bytecode
interpreter are defined in `pypy/interpreter/typedef.py`_.
* `pypy/interpreter/pyparser`_ contains a recursive descent parser,
@@ -34,7 +35,7 @@
``xxxobject.py`` contain respectively the definition of the type and its
(default) implementation.
-.. _optionaltool:
+.. _optionaltool:
Running PyPy's unit tests
@@ -65,7 +66,7 @@
# or for running tests of a whole subdirectory
py.test pypy/interpreter/
-See `py.test usage and invocations`_ for some more generic info
+See `py.test usage and invocations`_ for some more generic info
on how you can run tests.
Beware trying to run "all" pypy tests by pointing to the root
@@ -133,14 +134,14 @@
.. _`interpreter-level and app-level`: coding-guide.html#interpreter-level
-.. _`trace example`:
+.. _`trace example`:
Tracing bytecode and operations on objects
-++++++++++++++++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++++++++++
You can use the trace object space to monitor the interpretation
-of bytecodes in connection with object space operations. To enable
-it, set ``__pytrace__=1`` on the interactive PyPy console::
+of bytecodes in connection with object space operations. To enable
+it, set ``__pytrace__=1`` on the interactive PyPy console::
>>>> __pytrace__ = 1
Tracing enabled
@@ -165,25 +166,25 @@
.. _`example-interpreter`: https://bitbucket.org/pypy/example-interpreter
-Additional Tools for running (and hacking) PyPy
+Additional Tools for running (and hacking) PyPy
-----------------------------------------------
-We use some optional tools for developing PyPy. They are not required to run
+We use some optional tools for developing PyPy. They are not required to run
the basic tests or to get an interactive PyPy prompt but they help to
-understand and debug PyPy especially for the translation process.
+understand and debug PyPy especially for the translation process.
graphviz & pygame for flow graph viewing (highly recommended)
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
graphviz and pygame are both necessary if you
-want to look at generated flow graphs:
+want to look at generated flow graphs:
- graphviz: http://www.graphviz.org/Download.php
+ graphviz: http://www.graphviz.org/Download.php
pygame: http://www.pygame.org/download.shtml
-py.test and the py lib
-+++++++++++++++++++++++
+py.test and the py lib
+++++++++++++++++++++++
The `py.test testing tool`_ drives all our testing needs.
@@ -193,8 +194,8 @@
You don't necessarily need to install these two libraries because
we also ship them inlined in the PyPy source tree.
-Getting involved
------------------
+Getting involved
+----------------
PyPy employs an open development process. You are invited to join our
`pypy-dev mailing list`_ or look at the other `contact
diff --git a/pypy/doc/getting-started-python.rst
b/pypy/doc/getting-started-python.rst
--- a/pypy/doc/getting-started-python.rst
+++ b/pypy/doc/getting-started-python.rst
@@ -6,7 +6,7 @@
PyPy's Python interpreter is a very compliant Python
-interpreter implemented in RPython. When compiled, it passes most of
+interpreter implemented in RPython. When compiled, it passes most of
`CPythons core language regression tests`_ and comes with many of the extension
modules included in the standard library including ``ctypes``. It can run large
libraries such as Django_ and Twisted_. There are some small behavioral
@@ -18,8 +18,8 @@
.. _`CPython differences`: cpython_differences.html
-To actually use PyPy's Python interpreter, the first thing to do is to
-`download a pre-built PyPy`_ for your architecture.
+To actually use PyPy's Python interpreter, the first thing to do is to
+`download a pre-built PyPy`_ for your architecture.
.. _`download a pre-built PyPy`: http://pypy.org/download.html
@@ -71,9 +71,9 @@
3. Translation is time-consuming -- 45 minutes on a very fast machine --
- and RAM-hungry. As of March 2011, you will need **at least** 2 GB of
- memory on a
- 32-bit machine and 4GB on a 64-bit machine. If your memory resources
+ and RAM-hungry. As of March 2011, you will need **at least** 2 GB of
+ memory on a
+ 32-bit machine and 4GB on a 64-bit machine. If your memory resources
are constrained, or your machine is slow you might want to pick the
`optimization level`_ `1` in the next step. A level of
`2` or `3` or `jit` gives much better results, though. But if all
@@ -82,7 +82,7 @@
Let me stress this again: at ``--opt=1`` you get the Boehm
GC, which is here mostly for historical and for testing reasons.
- You really do not want to pick it for a program you intend to use.
+ You really do not want to pick it for a program you intend to use.
The resulting ``pypy-c`` is slow.
4. Run::
@@ -92,7 +92,7 @@
possibly replacing ``--opt=jit`` with another `optimization level`_
of your choice like ``--opt=2`` if you do not want to include the JIT
- compiler, which makes the Python interpreter much slower.
+ compiler, which makes the Python interpreter much slower.
.. _`optimization level`: config/opt.html
@@ -119,7 +119,7 @@
>>>> pystone.main()
Pystone(1.1) time for 50000 passes = 0.060004
This machine benchmarks at 833278 pystones/second
- >>>>
+ >>>>
Note that pystone gets faster as the JIT kicks in.
This executable can be moved around or copied on other machines; see
@@ -134,7 +134,7 @@
.. _`configuration sections`: config/index.html
Translating with non-standard options
-++++++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++
It is possible to have non-standard features enabled for translation,
but they are not really tested any more. Look, for example, at the
@@ -142,7 +142,7 @@
.. _`objspace proxies`: objspace-proxies.html
-.. _`CLI code`:
+.. _`CLI code`:
Translating using the CLI backend
+++++++++++++++++++++++++++++++++
@@ -163,7 +163,7 @@
[PyPy 1.6.0] on linux2
Type "help", "copyright", "credits" or "license" for more information.
And now for something completely different: ``distopian and utopian
chairs''
- >>>>
+ >>>>
Moreover, at the moment it's not possible to do the full translation
using only the tools provided by the Microsoft .NET SDK, since
@@ -182,7 +182,7 @@
.. not working now:
- .. _`JVM code`:
+ .. _`JVM code`:
Translating using the JVM backend
+++++++++++++++++++++++++++++++++
@@ -195,12 +195,12 @@
script ``pypy-jvm`` for executing it. To try it out, simply run
``./pypy-jvm``::
- $ ./pypy-jvm
+ $ ./pypy-jvm
Python 2.7.0 (61ef2a11b56a, Mar 02 2011, 03:00:11)
[PyPy 1.6.0] on linux2
Type "help", "copyright", "credits" or "license" for more information.
And now for something completely different: ``# assert did not crash''
- >>>>
+ >>>>
Alternatively, you can run it using ``java -jar pypy-jvm.jar``. At the
moment
the executable does not provide any interesting features, like integration
with
@@ -247,10 +247,10 @@
.. _`pyinteractive.py interpreter`:
Running the Python Interpreter Without Translation
----------------------------------------------------
+--------------------------------------------------
The pyinteractive.py interpreter
-+++++++++++++++++++++
+++++++++++++++++++++++++++++++++
To start interpreting Python with PyPy, install a C compiler that is
supported by distutils and use Python 2.5 or greater to run PyPy::
@@ -258,26 +258,26 @@
cd pypy
python bin/pyinteractive.py
-After a few seconds (remember: this is running on top of CPython),
-you should be at the PyPy prompt, which is the same as the Python
+After a few seconds (remember: this is running on top of CPython),
+you should be at the PyPy prompt, which is the same as the Python
prompt, but with an extra ">".
Now you are ready to start running Python code. Most Python
-modules should work if they don't involve CPython extension
+modules should work if they don't involve CPython extension
modules. **This is slow, and most C modules are not present by
default even if they are standard!** Here is an example of
-determining PyPy's performance in pystones::
+determining PyPy's performance in pystones::
- >>>> from test import pystone
+ >>>> from test import pystone
>>>> pystone.main(10)
The parameter is the number of loops to run through the test. The
default is 50000, which is far too many to run in a non-translated
-PyPy version (i.e. when PyPy's interpreter itself is being interpreted
+PyPy version (i.e. when PyPy's interpreter itself is being interpreted
by CPython).
pyinteractive.py options
-+++++++++++++
+++++++++++++++++++++++++
To list the PyPy interpreter command line options, type::
_______________________________________________
pypy-commit mailing list
pypy-commit@python.org
http://mail.python.org/mailman/listinfo/pypy-commit
