Commits

Carl Friedrich Bolz committed 2841a5a

rename the config description files to .txt again, because sphinx is not supposed to touch them

Comments (0)

Files changed (365)

pypy/doc/config/generate.py

 import autopath
 import py
-from pypy.config import pypyoption, translationoption, config
+from pypy.config import pypyoption, translationoption, config, makerestdoc
 from pypy.doc.config.confrest import all_optiondescrs
 
+all_optiondescrs = [pypyoption.pypy_optiondescription,
+                    translationoption.translation_optiondescription,
+                   ]
+start_to_descr = dict([(descr._name, descr) for descr in all_optiondescrs])
+
+
 thisdir = py.path.local(__file__).dirpath()
 
 for descr in all_optiondescrs:
     prefix = descr._name
     c = config.Config(descr)
-    thisdir.join(prefix + ".rst").ensure()
+    thisdir.join(prefix + ".txt").ensure()
     for p in c.getpaths(include_groups=True):
-        basename = prefix + "." + p + ".rst"
-        f = thisdir.join(basename)
-        f.ensure()
+        basename = prefix + "." + p + ".txt"
+        txtpath = thisdir.join(basename)
+        txtpath.ensure()
+        rstpath = txtpath.new(ext=".rst")
+
+        fullpath = txtpath.purebasename
+        start = fullpath.split(".")[0]
+        path = fullpath.rsplit(".", 1)[0]
+        basedescr = start_to_descr.get(start)
+        if basedescr is None:
+            continue
+        if fullpath.count(".") == 0:
+            descr = basedescr
+            path = ""
+        else:
+            conf = config.Config(basedescr)
+            subconf, step = conf._cfgimpl_get_home_by_path(
+                    fullpath.split(".", 1)[1])
+            descr = getattr(subconf._cfgimpl_descr, step)
+        text = unicode(descr.make_rest_doc(path).text())
+        if txtpath.check(file=True):
+            content = txtpath.read()
+            if content:
+                text += "\nDescription\n==========="
+                text = u"%s\n\n%s" % (text, unicode(txtpath.read(), "utf-8"))
+        print path
+        print "***************************"
+        print text
+        rstpath.write(text.encode("utf-8"))

pypy/doc/config/objspace.allworkingmodules.rst

-This option enables the usage of all modules that are known to be working well
-and that translate without problems.
-
-Note that this option defaults to True (except when running
-``py.py`` because it takes a long time to start).  To force it
-to False, use ``--no-allworkingmodules``.

pypy/doc/config/objspace.allworkingmodules.txt

+This option enables the usage of all modules that are known to be working well
+and that translate without problems.
+
+Note that this option defaults to True (except when running
+``py.py`` because it takes a long time to start).  To force it
+to False, use ``--no-allworkingmodules``.

pypy/doc/config/objspace.disable_call_speedhacks.rst

-disable the speed hacks that the interpreter normally does. Usually you don't
-want to set this to False, but some object spaces require it.

pypy/doc/config/objspace.disable_call_speedhacks.txt

+disable the speed hacks that the interpreter normally does. Usually you don't
+want to set this to False, but some object spaces require it.

pypy/doc/config/objspace.extmodules.rst

-You can pass a comma-separated list of third-party builtin modules
-which should be translated along with the standard modules within
-``pypy.module``.
-
-The module names need to be fully qualified (i.e. have a ``.`` in them),
-be on the ``$PYTHONPATH`` and not conflict with any existing ones, e.g.
-``mypkg.somemod``.
-
-Once translated, the module will be accessible with a simple::
-
-    import somemod
-

pypy/doc/config/objspace.extmodules.txt

+You can pass a comma-separated list of third-party builtin modules
+which should be translated along with the standard modules within
+``pypy.module``.
+
+The module names need to be fully qualified (i.e. have a ``.`` in them),
+be on the ``$PYTHONPATH`` and not conflict with any existing ones, e.g.
+``mypkg.somemod``.
+
+Once translated, the module will be accessible with a simple::
+
+    import somemod
+

pypy/doc/config/objspace.geninterp.rst

-This option enables `geninterp`_. This will usually make the PyPy interpreter
-significantly faster (but also a bit bigger).
-
-.. _`geninterp`: ../geninterp.html

pypy/doc/config/objspace.geninterp.txt

+This option enables `geninterp`_. This will usually make the PyPy interpreter
+significantly faster (but also a bit bigger).
+
+.. _`geninterp`: ../geninterp.html

pypy/doc/config/objspace.honor__builtins__.rst

Empty file removed.

pypy/doc/config/objspace.honor__builtins__.txt

Empty file added.

pypy/doc/config/objspace.logbytecodes.rst

-Internal option.
-
-.. internal

pypy/doc/config/objspace.logbytecodes.txt

+Internal option.
+
+.. internal

pypy/doc/config/objspace.lonepycfiles.rst

-If turned on, PyPy accepts to import a module ``x`` if it finds a
-file ``x.pyc`` even if there is no file ``x.py``.
-
-This is the way that CPython behaves, but it is disabled by
-default for PyPy because it is a common cause of issues: most
-typically, the ``x.py`` file is removed (manually or by a
-version control system) but the ``x`` module remains
-accidentally importable because the ``x.pyc`` file stays
-around.
-
-The usual reason for wanting this feature is to distribute
-non-open-source Python programs by distributing ``pyc`` files
-only, but this use case is not practical for PyPy at the
-moment because multiple versions of PyPy compiled with various
-optimizations might be unable to load each other's ``pyc``
-files.

pypy/doc/config/objspace.lonepycfiles.txt

+If turned on, PyPy accepts to import a module ``x`` if it finds a
+file ``x.pyc`` even if there is no file ``x.py``.
+
+This is the way that CPython behaves, but it is disabled by
+default for PyPy because it is a common cause of issues: most
+typically, the ``x.py`` file is removed (manually or by a
+version control system) but the ``x`` module remains
+accidentally importable because the ``x.pyc`` file stays
+around.
+
+The usual reason for wanting this feature is to distribute
+non-open-source Python programs by distributing ``pyc`` files
+only, but this use case is not practical for PyPy at the
+moment because multiple versions of PyPy compiled with various
+optimizations might be unable to load each other's ``pyc``
+files.

pypy/doc/config/objspace.name.rst

-Determine which `Object Space`_ to use. The `Standard Object Space`_ gives the
-normal Python semantics, the others are `Object Space Proxies`_ giving
-additional features (except the Flow Object Space which is not intended
-for normal usage):
-
-  * thunk_: The thunk object space adds lazy evaluation to PyPy.
-  * taint_: The taint object space adds soft security features.
-  * dump_:  Using this object spaces results in the dumpimp of all operations
-    to a log.
-
-.. _`Object Space`: ../objspace.html
-.. _`Object Space Proxies`: ../objspace-proxies.html
-.. _`Standard Object Space`: ../objspace.html#standard-object-space
-.. _thunk: ../objspace-proxies.html#thunk
-.. _taint: ../objspace-proxies.html#taint
-.. _dump: ../objspace-proxies.html#dump

pypy/doc/config/objspace.name.txt

+Determine which `Object Space`_ to use. The `Standard Object Space`_ gives the
+normal Python semantics, the others are `Object Space Proxies`_ giving
+additional features (except the Flow Object Space which is not intended
+for normal usage):
+
+  * thunk_: The thunk object space adds lazy evaluation to PyPy.
+  * taint_: The taint object space adds soft security features.
+  * dump_:  Using this object spaces results in the dumpimp of all operations
+    to a log.
+
+.. _`Object Space`: ../objspace.html
+.. _`Object Space Proxies`: ../objspace-proxies.html
+.. _`Standard Object Space`: ../objspace.html#standard-object-space
+.. _thunk: ../objspace-proxies.html#thunk
+.. _taint: ../objspace-proxies.html#taint
+.. _dump: ../objspace-proxies.html#dump

pypy/doc/config/objspace.nofaking.rst

-This options prevents the automagic borrowing of implementations of
-modules and types not present in PyPy from CPython.
-
-As such, it is required when translating, as then there is no CPython
-to borrow from.  For running py.py it is useful for testing the
-implementation of modules like "posix", but it makes everything even
-slower than it is already.

pypy/doc/config/objspace.nofaking.txt

+This options prevents the automagic borrowing of implementations of
+modules and types not present in PyPy from CPython.
+
+As such, it is required when translating, as then there is no CPython
+to borrow from.  For running py.py it is useful for testing the
+implementation of modules like "posix", but it makes everything even
+slower than it is already.

pypy/doc/config/objspace.opcodes.CALL_LIKELY_BUILTIN.rst

-Introduce a new opcode called ``CALL_LIKELY_BUILTIN``. It is used when something
-is called, that looks like a builtin function (but could in reality be shadowed
-by a name in the module globals). For all module globals dictionaries it is
-then tracked which builtin name is shadowed in this module. If the
-``CALL_LIKELY_BUILTIN`` opcode is executed, it is checked whether the builtin is
-shadowed. If not, the corresponding builtin is called. Otherwise the object that
-is shadowing it is called instead. If no shadowing is happening, this saves two
-dictionary lookups on calls to builtins.
-
-For more information, see the section in `Standard Interpreter Optimizations`_.
-
-.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#call-likely-builtin

pypy/doc/config/objspace.opcodes.CALL_LIKELY_BUILTIN.txt

+Introduce a new opcode called ``CALL_LIKELY_BUILTIN``. It is used when something
+is called, that looks like a builtin function (but could in reality be shadowed
+by a name in the module globals). For all module globals dictionaries it is
+then tracked which builtin name is shadowed in this module. If the
+``CALL_LIKELY_BUILTIN`` opcode is executed, it is checked whether the builtin is
+shadowed. If not, the corresponding builtin is called. Otherwise the object that
+is shadowing it is called instead. If no shadowing is happening, this saves two
+dictionary lookups on calls to builtins.
+
+For more information, see the section in `Standard Interpreter Optimizations`_.
+
+.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#call-likely-builtin

pypy/doc/config/objspace.opcodes.CALL_METHOD.rst

-Enable a pair of bytecodes that speed up method calls.
-See ``pypy.interpreter.callmethod`` for a description.
-
-The goal is to avoid creating the bound method object in the common
-case.  So far, this only works for calls with no keyword, no ``*arg``
-and no ``**arg`` but it would be easy to extend.
-
-For more information, see the section in `Standard Interpreter Optimizations`_.
-
-.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#lookup-method-call-method

pypy/doc/config/objspace.opcodes.CALL_METHOD.txt

+Enable a pair of bytecodes that speed up method calls.
+See ``pypy.interpreter.callmethod`` for a description.
+
+The goal is to avoid creating the bound method object in the common
+case.  So far, this only works for calls with no keyword, no ``*arg``
+and no ``**arg`` but it would be easy to extend.
+
+For more information, see the section in `Standard Interpreter Optimizations`_.
+
+.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#lookup-method-call-method

pypy/doc/config/objspace.opcodes.rst

-..  intentionally empty

pypy/doc/config/objspace.opcodes.txt

+..  intentionally empty

pypy/doc/config/objspace.rst

-..  intentionally empty

pypy/doc/config/objspace.soabi.rst

-This option controls the tag included into extension module file names.  The
-default is something like `pypy-14`, which means that `import foo` will look for
-a file named `foo.pypy-14.so` (or `foo.pypy-14.pyd` on Windows).
-
-This is an implementation of PEP3149_, with two differences:
-
- * the filename without tag `foo.so` is not considered.
- * the feature is also available on Windows.
-
-When set to the empty string (with `--soabi=`), the interpreter will only look
-for a file named `foo.so`, and will crash if this file was compiled for another
-Python interpreter.
-
-.. _PEP3149: http://www.python.org/dev/peps/pep-3149/

pypy/doc/config/objspace.soabi.txt

+This option controls the tag included into extension module file names.  The
+default is something like `pypy-14`, which means that `import foo` will look for
+a file named `foo.pypy-14.so` (or `foo.pypy-14.pyd` on Windows).
+
+This is an implementation of PEP3149_, with two differences:
+
+ * the filename without tag `foo.so` is not considered.
+ * the feature is also available on Windows.
+
+When set to the empty string (with `--soabi=`), the interpreter will only look
+for a file named `foo.so`, and will crash if this file was compiled for another
+Python interpreter.
+
+.. _PEP3149: http://www.python.org/dev/peps/pep-3149/

pypy/doc/config/objspace.std.builtinshortcut.rst

-A shortcut speeding up primitive operations between built-in types.
-
-This is a space-time trade-off: at the moment, this option makes a
-translated pypy-c executable bigger by about 1.7 MB.  (This can probably
-be improved with careful analysis.)

pypy/doc/config/objspace.std.builtinshortcut.txt

+A shortcut speeding up primitive operations between built-in types.
+
+This is a space-time trade-off: at the moment, this option makes a
+translated pypy-c executable bigger by about 1.7 MB.  (This can probably
+be improved with careful analysis.)

pypy/doc/config/objspace.std.getattributeshortcut.rst

-Performance only: track types that override __getattribute__.

pypy/doc/config/objspace.std.getattributeshortcut.txt

+Performance only: track types that override __getattribute__.

pypy/doc/config/objspace.std.logspaceoptypes.rst

-.. internal
-
-Wrap "simple" bytecode implementations like BINARY_ADD with code that collects
-information about which types these bytecodes receive as arguments.

pypy/doc/config/objspace.std.logspaceoptypes.txt

+.. internal
+
+Wrap "simple" bytecode implementations like BINARY_ADD with code that collects
+information about which types these bytecodes receive as arguments.

pypy/doc/config/objspace.std.methodcachesizeexp.rst

-Set the cache size (number of entries) for :config:`objspace.std.withmethodcache`.

pypy/doc/config/objspace.std.methodcachesizeexp.txt

+Set the cache size (number of entries) for :config:`objspace.std.withmethodcache`.

pypy/doc/config/objspace.std.multimethods.rst

-Choose the multimethod implementation.
-
-* ``doubledispatch`` turns
-  a multimethod call into a sequence of normal method calls.
-
-* ``mrd`` uses a technique known as Multiple Row Displacement
-  which precomputes a few compact tables of numbers and
-  function pointers.

pypy/doc/config/objspace.std.multimethods.txt

+Choose the multimethod implementation.
+
+* ``doubledispatch`` turns
+  a multimethod call into a sequence of normal method calls.
+
+* ``mrd`` uses a technique known as Multiple Row Displacement
+  which precomputes a few compact tables of numbers and
+  function pointers.

pypy/doc/config/objspace.std.mutable_builtintypes.rst

-Allow modification of builtin types.  Disabled by default.

pypy/doc/config/objspace.std.mutable_builtintypes.txt

+Allow modification of builtin types.  Disabled by default.

pypy/doc/config/objspace.std.newshortcut.rst

-Performance only: cache and shortcut calling __new__ from builtin types

pypy/doc/config/objspace.std.newshortcut.txt

+Performance only: cache and shortcut calling __new__ from builtin types

pypy/doc/config/objspace.std.optimized_comparison_op.rst

-Optimize the comparison of two integers a bit.

pypy/doc/config/objspace.std.optimized_comparison_op.txt

+Optimize the comparison of two integers a bit.

pypy/doc/config/objspace.std.optimized_int_add.rst

-Optimize the addition of two integers a bit. Enabling this option gives small
-speedups.

pypy/doc/config/objspace.std.optimized_int_add.txt

+Optimize the addition of two integers a bit. Enabling this option gives small
+speedups.

pypy/doc/config/objspace.std.optimized_list_getitem.rst

-Optimized list[int] a bit.

pypy/doc/config/objspace.std.optimized_list_getitem.txt

+Optimized list[int] a bit.

pypy/doc/config/objspace.std.prebuiltintfrom.rst

-see :config:`objspace.std.withprebuiltint`.

pypy/doc/config/objspace.std.prebuiltintfrom.txt

+see :config:`objspace.std.withprebuiltint`.

pypy/doc/config/objspace.std.prebuiltintto.rst

-See :config:`objspace.std.withprebuiltint`.

pypy/doc/config/objspace.std.prebuiltintto.txt

+See :config:`objspace.std.withprebuiltint`.

pypy/doc/config/objspace.std.rst

-..  intentionally empty

pypy/doc/config/objspace.std.sharesmallstr.rst

Empty file removed.

pypy/doc/config/objspace.std.sharesmallstr.txt

Empty file added.

pypy/doc/config/objspace.std.txt

+..  intentionally empty

pypy/doc/config/objspace.std.withcelldict.rst

-Enable cell-dicts. This optimization is not helpful without the JIT. In the
-presence of the JIT, it greatly helps looking up globals.

pypy/doc/config/objspace.std.withcelldict.txt

+Enable cell-dicts. This optimization is not helpful without the JIT. In the
+presence of the JIT, it greatly helps looking up globals.

pypy/doc/config/objspace.std.withdictmeasurement.rst

-Internal option.
-
-.. internal

pypy/doc/config/objspace.std.withdictmeasurement.txt

+Internal option.
+
+.. internal

pypy/doc/config/objspace.std.withmapdict.rst

-Enable the new version of "sharing dictionaries".
-
-See the section in `Standard Interpreter Optimizations`_ for more details.
-
-.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#sharing-dicts

pypy/doc/config/objspace.std.withmapdict.txt

+Enable the new version of "sharing dictionaries".
+
+See the section in `Standard Interpreter Optimizations`_ for more details.
+
+.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#sharing-dicts

pypy/doc/config/objspace.std.withmethodcache.rst

-Enable method caching. See the section "Method Caching" in `Standard
-Interpreter Optimizations <../interpreter-optimizations.html#method-caching>`__.

pypy/doc/config/objspace.std.withmethodcache.txt

+Enable method caching. See the section "Method Caching" in `Standard
+Interpreter Optimizations <../interpreter-optimizations.html#method-caching>`__.

pypy/doc/config/objspace.std.withmethodcachecounter.rst

-Testing/debug option for :config:`objspace.std.withmethodcache`.

pypy/doc/config/objspace.std.withmethodcachecounter.txt

+Testing/debug option for :config:`objspace.std.withmethodcache`.

pypy/doc/config/objspace.std.withprebuiltchar.rst

Empty file removed.

pypy/doc/config/objspace.std.withprebuiltchar.txt

Empty file added.

pypy/doc/config/objspace.std.withprebuiltint.rst

-This option enables the caching of small integer objects (similar to what
-CPython does). The range of which integers are cached can be influenced with
-the :config:`objspace.std.prebuiltintfrom` and
-:config:`objspace.std.prebuiltintto` options.
-

pypy/doc/config/objspace.std.withprebuiltint.txt

+This option enables the caching of small integer objects (similar to what
+CPython does). The range of which integers are cached can be influenced with
+the :config:`objspace.std.prebuiltintfrom` and
+:config:`objspace.std.prebuiltintto` options.
+

pypy/doc/config/objspace.std.withrangelist.rst

-Enable "range list" objects. They are an additional implementation of the Python
-``list`` type, indistinguishable for the normal user. Whenever the ``range``
-builtin is called, an range list is returned. As long as this list is not
-mutated (and for example only iterated over), it uses only enough memory to
-store the start, stop and step of the range. This makes using ``range`` as
-efficient as ``xrange``, as long as the result is only used in a ``for``-loop.
-
-See the section in `Standard Interpreter Optimizations`_ for more details.
-
-.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#range-lists
-

pypy/doc/config/objspace.std.withrangelist.txt

+Enable "range list" objects. They are an additional implementation of the Python
+``list`` type, indistinguishable for the normal user. Whenever the ``range``
+builtin is called, an range list is returned. As long as this list is not
+mutated (and for example only iterated over), it uses only enough memory to
+store the start, stop and step of the range. This makes using ``range`` as
+efficient as ``xrange``, as long as the result is only used in a ``for``-loop.
+
+See the section in `Standard Interpreter Optimizations`_ for more details.
+
+.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#range-lists
+

pypy/doc/config/objspace.std.withrope.rst

-Enable ropes to be the default string implementation.
-
-See the section in `Standard Interpreter Optimizations`_ for more details.
-
-.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#ropes
-
-

pypy/doc/config/objspace.std.withrope.txt

+Enable ropes to be the default string implementation.
+
+See the section in `Standard Interpreter Optimizations`_ for more details.
+
+.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#ropes
+
+

pypy/doc/config/objspace.std.withropeunicode.rst

-Use ropes to implement unicode strings (and also normal strings).
-
-See the section in `Standard Interpreter Optimizations`_ for more details.
-
-.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#ropes
-
-

pypy/doc/config/objspace.std.withropeunicode.txt

+Use ropes to implement unicode strings (and also normal strings).
+
+See the section in `Standard Interpreter Optimizations`_ for more details.
+
+.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#ropes
+
+

pypy/doc/config/objspace.std.withsmallint.rst

-Use "tagged pointers" to represent small enough integer values: Integers that
-fit into 31 bits (respective 63 bits on 64 bit machines) are not represented by
-boxing them in an instance of ``W_IntObject``. Instead they are represented as a
-pointer having the lowest bit set and the rest of the bits used to store the
-value of the integer. This gives a small speedup for integer operations as well
-as better memory behaviour.

pypy/doc/config/objspace.std.withsmallint.txt

+Use "tagged pointers" to represent small enough integer values: Integers that
+fit into 31 bits (respective 63 bits on 64 bit machines) are not represented by
+boxing them in an instance of ``W_IntObject``. Instead they are represented as a
+pointer having the lowest bit set and the rest of the bits used to store the
+value of the integer. This gives a small speedup for integer operations as well
+as better memory behaviour.

pypy/doc/config/objspace.std.withsmalllong.rst

-Enable "small longs", an additional implementation of the Python
-type "long", implemented with a C long long.  It is mostly useful
-on 32-bit; on 64-bit, a C long long is the same as a C long, so
-its usefulness is limited to Python objects of type "long" that
-would anyway fit in an "int".

pypy/doc/config/objspace.std.withsmalllong.txt

+Enable "small longs", an additional implementation of the Python
+type "long", implemented with a C long long.  It is mostly useful
+on 32-bit; on 64-bit, a C long long is the same as a C long, so
+its usefulness is limited to Python objects of type "long" that
+would anyway fit in an "int".

pypy/doc/config/objspace.std.withstrbuf.rst

-Enable "string buffer" objects.
-
-Similar to "string join" objects, but using a StringBuilder to represent
-a string built by repeated application of ``+=``.

pypy/doc/config/objspace.std.withstrbuf.txt

+Enable "string buffer" objects.
+
+Similar to "string join" objects, but using a StringBuilder to represent
+a string built by repeated application of ``+=``.

pypy/doc/config/objspace.std.withstrjoin.rst

-Enable "string join" objects.
-
-See the page about `Standard Interpreter Optimizations`_ for more details.
-
-.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#string-join-objects
-
-

pypy/doc/config/objspace.std.withstrjoin.txt

+Enable "string join" objects.
+
+See the page about `Standard Interpreter Optimizations`_ for more details.
+
+.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#string-join-objects
+
+

pypy/doc/config/objspace.std.withstrslice.rst

-Enable "string slice" objects.
-
-See the page about `Standard Interpreter Optimizations`_ for more details.
-
-.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#string-slice-objects
-
-

pypy/doc/config/objspace.std.withstrslice.txt

+Enable "string slice" objects.
+
+See the page about `Standard Interpreter Optimizations`_ for more details.
+
+.. _`Standard Interpreter Optimizations`: ../interpreter-optimizations.html#string-slice-objects
+
+

pypy/doc/config/objspace.std.withtproxy.rst

-Enable `transparent proxies`_.
-
-.. _`transparent proxies`: ../objspace-proxies.html#tproxy

pypy/doc/config/objspace.std.withtproxy.txt

+Enable `transparent proxies`_.
+
+.. _`transparent proxies`: ../objspace-proxies.html#tproxy

pypy/doc/config/objspace.std.withtypeversion.rst

-This (mostly internal) option enables "type versions": Every type object gets an
-(only internally visible) version that is updated when the type's dict is
-changed. This is e.g. used for invalidating caches. It does not make sense to
-enable this option alone.
-
-.. internal

pypy/doc/config/objspace.std.withtypeversion.txt

+This (mostly internal) option enables "type versions": Every type object gets an
+(only internally visible) version that is updated when the type's dict is
+changed. This is e.g. used for invalidating caches. It does not make sense to
+enable this option alone.
+
+.. internal

pypy/doc/config/objspace.timing.rst

-timing of various parts of the interpreter (simple profiling)

pypy/doc/config/objspace.timing.txt

+timing of various parts of the interpreter (simple profiling)

pypy/doc/config/objspace.translationmodules.rst

-This option enables all modules which are needed to translate PyPy using PyPy.

pypy/doc/config/objspace.translationmodules.txt

+This option enables all modules which are needed to translate PyPy using PyPy.

pypy/doc/config/objspace.txt

+..  intentionally empty

pypy/doc/config/objspace.usemodules.__builtin__.rst

-Use the '__builtin__' module. 
-This module is essential, included by default and should not be removed.

pypy/doc/config/objspace.usemodules.__builtin__.txt

+Use the '__builtin__' module. 
+This module is essential, included by default and should not be removed.

pypy/doc/config/objspace.usemodules.__pypy__.rst

-Use the '__pypy__' module. 
-This module is expected to be working and is included by default.
-It contains special PyPy-specific functionality.
-For example most of the special functions described in the `object space proxies`
-document are in the module.
-See the `__pypy__ module documentation`_ for more details.
-
-.. _`object space proxy`: ../objspace-proxies.html
-.. _`__pypy__ module documentation`: ../__pypy__-module.html

pypy/doc/config/objspace.usemodules.__pypy__.txt

+Use the '__pypy__' module. 
+This module is expected to be working and is included by default.
+It contains special PyPy-specific functionality.
+For example most of the special functions described in the `object space proxies`
+document are in the module.
+See the `__pypy__ module documentation`_ for more details.
+
+.. _`object space proxy`: ../objspace-proxies.html
+.. _`__pypy__ module documentation`: ../__pypy__-module.html

pypy/doc/config/objspace.usemodules._ast.rst

-Use the '_ast' module. 
-This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._ast.txt

+Use the '_ast' module. 
+This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._bisect.rst

-Use the '_bisect' module.
-Used, optionally,  by the 'bisect' standard lib module. This module is expected to be working and is included by default.
-
-

pypy/doc/config/objspace.usemodules._bisect.txt

+Use the '_bisect' module.
+Used, optionally,  by the 'bisect' standard lib module. This module is expected to be working and is included by default.
+
+

pypy/doc/config/objspace.usemodules._codecs.rst

-Use the '_codecs' module. 
-Used by the 'codecs' standard lib module. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._codecs.txt

+Use the '_codecs' module. 
+Used by the 'codecs' standard lib module. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._collections.rst

-Use the '_collections' module.
-Used by the 'collections' standard lib module. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._collections.txt

+Use the '_collections' module.
+Used by the 'collections' standard lib module. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._demo.rst

-Use the '_demo' module. 
-
-This is the demo module for mixed modules. Not enabled by default.

pypy/doc/config/objspace.usemodules._demo.txt

+Use the '_demo' module. 
+
+This is the demo module for mixed modules. Not enabled by default.

pypy/doc/config/objspace.usemodules._ffi.rst

-Applevel interface to libffi.  It is more high level than _rawffi, and most importantly it is JIT friendly

pypy/doc/config/objspace.usemodules._ffi.txt

+Applevel interface to libffi.  It is more high level than _rawffi, and most importantly it is JIT friendly

pypy/doc/config/objspace.usemodules._file.rst

-Use the '_file' module. It is an internal module that contains helper
-functionality for the builtin ``file`` type.
-
-.. internal

pypy/doc/config/objspace.usemodules._file.txt

+Use the '_file' module. It is an internal module that contains helper
+functionality for the builtin ``file`` type.
+
+.. internal

pypy/doc/config/objspace.usemodules._hashlib.rst

-Use the '_hashlib' module.
-Used by the 'hashlib' standard lib module, and indirectly by the various cryptographic libs. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._hashlib.txt

+Use the '_hashlib' module.
+Used by the 'hashlib' standard lib module, and indirectly by the various cryptographic libs. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._io.rst

-Use the '_io module.
-Used by the 'io' standard lib module. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._io.txt

+Use the '_io module.
+Used by the 'io' standard lib module. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._locale.rst

-Use the '_locale' module.
-This module runs _locale written in RPython (instead of ctypes version).
-It's not really finished yet; it's enabled by default on Windows.

pypy/doc/config/objspace.usemodules._locale.txt

+Use the '_locale' module.
+This module runs _locale written in RPython (instead of ctypes version).
+It's not really finished yet; it's enabled by default on Windows.

pypy/doc/config/objspace.usemodules._lsprof.rst

-Use the '_lsprof' module. 

pypy/doc/config/objspace.usemodules._lsprof.txt

+Use the '_lsprof' module. 

pypy/doc/config/objspace.usemodules._md5.rst

-Use the built-in '_md5' module.
-This module is expected to be working and is included by default.
-There is also a pure Python version in lib_pypy which is used
-if the built-in is disabled, but it is several orders of magnitude 
-slower.

pypy/doc/config/objspace.usemodules._md5.txt

+Use the built-in '_md5' module.
+This module is expected to be working and is included by default.
+There is also a pure Python version in lib_pypy which is used
+if the built-in is disabled, but it is several orders of magnitude 
+slower.

pypy/doc/config/objspace.usemodules._minimal_curses.rst

-Use the '_curses' module.
-This module is just a stub.  It only implements a few functions.

pypy/doc/config/objspace.usemodules._minimal_curses.txt

+Use the '_curses' module.
+This module is just a stub.  It only implements a few functions.

pypy/doc/config/objspace.usemodules._multiprocessing.rst

-Use the '_multiprocessing' module.
-Used by the 'multiprocessing' standard lib module. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._multiprocessing.txt

+Use the '_multiprocessing' module.
+Used by the 'multiprocessing' standard lib module. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._pickle_support.rst

-Use the '_pickle_support' module. 
-Internal helpers for pickling runtime builtin types (frames, cells, etc)
-for `stackless`_ tasklet pickling support.
-.. _`stackless`: ../stackless.html
-
-.. internal

pypy/doc/config/objspace.usemodules._pickle_support.txt

+Use the '_pickle_support' module. 
+Internal helpers for pickling runtime builtin types (frames, cells, etc)
+for `stackless`_ tasklet pickling support.
+.. _`stackless`: ../stackless.html
+
+.. internal

pypy/doc/config/objspace.usemodules._random.rst

-Use the '_random' module. It is necessary to use the module "random" from the standard library.
-This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._random.txt

+Use the '_random' module. It is necessary to use the module "random" from the standard library.
+This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._rawffi.rst

-An experimental module providing very low-level interface to
-C-level libraries, for use when implementing ctypes, not
-intended for a direct use at all.

pypy/doc/config/objspace.usemodules._rawffi.txt

+An experimental module providing very low-level interface to
+C-level libraries, for use when implementing ctypes, not
+intended for a direct use at all.

pypy/doc/config/objspace.usemodules._sha.rst

-Use the built-in _'sha' module.
-This module is expected to be working and is included by default.
-There is also a pure Python version in lib_pypy which is used
-if the built-in is disabled, but it is several orders of magnitude 
-slower.

pypy/doc/config/objspace.usemodules._sha.txt

+Use the built-in _'sha' module.
+This module is expected to be working and is included by default.
+There is also a pure Python version in lib_pypy which is used
+if the built-in is disabled, but it is several orders of magnitude 
+slower.

pypy/doc/config/objspace.usemodules._socket.rst

-Use the '_socket' module. 
-
-This is our implementation of '_socket', the Python builtin module
-exposing socket primitives, which is wrapped and used by the standard
-library 'socket.py' module. It is based on `rffi`_.
-
-.. _`rffi`: ../rffi.html

pypy/doc/config/objspace.usemodules._socket.txt

+Use the '_socket' module. 
+
+This is our implementation of '_socket', the Python builtin module
+exposing socket primitives, which is wrapped and used by the standard
+library 'socket.py' module. It is based on `rffi`_.
+
+.. _`rffi`: ../rffi.html

pypy/doc/config/objspace.usemodules._sre.rst

-Use the '_sre' module. 
-This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._sre.txt

+Use the '_sre' module. 
+This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._ssl.rst

-Use the '_ssl' module, which implements SSL socket operations.

pypy/doc/config/objspace.usemodules._ssl.txt

+Use the '_ssl' module, which implements SSL socket operations.

pypy/doc/config/objspace.usemodules._stackless.rst

-Use the '_stackless' module. 
-
-Exposes the `stackless` primitives, and also implies a stackless build. 
-See also :config:`translation.stackless`.
-
-.. _`stackless`: ../stackless.html

pypy/doc/config/objspace.usemodules._stackless.txt

+Use the '_stackless' module. 
+
+Exposes the `stackless` primitives, and also implies a stackless build. 
+See also :config:`translation.stackless`.
+
+.. _`stackless`: ../stackless.html

pypy/doc/config/objspace.usemodules._testing.rst

-Use the '_testing' module. This module exists only for PyPy own testing purposes.
- 
-This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._testing.txt

+Use the '_testing' module. This module exists only for PyPy own testing purposes.
+ 
+This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._warnings.rst

-Use the '_warning' module. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._warnings.txt

+Use the '_warning' module. This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules._weakref.rst

-Use the '_weakref' module, necessary for the standard lib 'weakref' module.
-PyPy's weakref implementation is not completely stable yet. The first
-difference to CPython is that weak references only go away after the next
-garbage collection, not immediately. The other problem seems to be that under
-certain circumstances (that we have not determined) weak references keep the
-object alive.

pypy/doc/config/objspace.usemodules._weakref.txt

+Use the '_weakref' module, necessary for the standard lib 'weakref' module.
+PyPy's weakref implementation is not completely stable yet. The first
+difference to CPython is that weak references only go away after the next
+garbage collection, not immediately. The other problem seems to be that under
+certain circumstances (that we have not determined) weak references keep the
+object alive.

pypy/doc/config/objspace.usemodules._winreg.rst

-Use the built-in '_winreg' module, provides access to the Windows registry.
-This module is expected to be working and is included by default on Windows.

pypy/doc/config/objspace.usemodules._winreg.txt

+Use the built-in '_winreg' module, provides access to the Windows registry.
+This module is expected to be working and is included by default on Windows.

pypy/doc/config/objspace.usemodules.array.rst

-Use interpreter-level version of array module (on by default).

pypy/doc/config/objspace.usemodules.array.txt

+Use interpreter-level version of array module (on by default).

pypy/doc/config/objspace.usemodules.binascii.rst

-Use the RPython 'binascii' module.

pypy/doc/config/objspace.usemodules.binascii.txt

+Use the RPython 'binascii' module.

pypy/doc/config/objspace.usemodules.bz2.rst

-Use the 'bz2' module. 
-This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.bz2.txt

+Use the 'bz2' module. 
+This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.cStringIO.rst

-Use the built-in cStringIO module.
-
-If not enabled, importing cStringIO gives you the app-level
-implementation from the standard library StringIO module.

pypy/doc/config/objspace.usemodules.cStringIO.txt

+Use the built-in cStringIO module.
+
+If not enabled, importing cStringIO gives you the app-level
+implementation from the standard library StringIO module.

pypy/doc/config/objspace.usemodules.clr.rst

-Use the 'clr' module. 

pypy/doc/config/objspace.usemodules.clr.txt

+Use the 'clr' module. 

pypy/doc/config/objspace.usemodules.cmath.rst

-Use the 'cmath' module. 
-This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.cmath.txt

+Use the 'cmath' module. 
+This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.cpyext.rst

-Use (experimental) cpyext module, that tries to load and run CPython extension modules

pypy/doc/config/objspace.usemodules.cpyext.txt

+Use (experimental) cpyext module, that tries to load and run CPython extension modules

pypy/doc/config/objspace.usemodules.crypt.rst

-Use the 'crypt' module. 
-This module is expected to be fully working.

pypy/doc/config/objspace.usemodules.crypt.txt

+Use the 'crypt' module. 
+This module is expected to be fully working.

pypy/doc/config/objspace.usemodules.errno.rst

-Use the 'errno' module. 
-This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.errno.txt

+Use the 'errno' module. 
+This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.exceptions.rst

-Use the 'exceptions' module.
-This module is essential, included by default and should not be removed.

pypy/doc/config/objspace.usemodules.exceptions.txt

+Use the 'exceptions' module.
+This module is essential, included by default and should not be removed.

pypy/doc/config/objspace.usemodules.fcntl.rst

-Use the 'fcntl' module. 
-This module is expected to be fully working.

pypy/doc/config/objspace.usemodules.fcntl.txt

+Use the 'fcntl' module. 
+This module is expected to be fully working.

pypy/doc/config/objspace.usemodules.gc.rst

-Use the 'gc' module. 
-This module is expected to be working and is included by default.
-Note that since the gc module is highly implementation specific, it contains
-only the ``collect`` function in PyPy, which forces a collection when compiled
-with the framework or with Boehm.

pypy/doc/config/objspace.usemodules.gc.txt

+Use the 'gc' module. 
+This module is expected to be working and is included by default.
+Note that since the gc module is highly implementation specific, it contains
+only the ``collect`` function in PyPy, which forces a collection when compiled
+with the framework or with Boehm.

pypy/doc/config/objspace.usemodules.imp.rst

-Use the 'imp' module.
-This module is included by default.

pypy/doc/config/objspace.usemodules.imp.txt

+Use the 'imp' module.
+This module is included by default.

pypy/doc/config/objspace.usemodules.itertools.rst

-Use the interp-level 'itertools' module.
-If not included, a slower app-level version of itertools is used.

pypy/doc/config/objspace.usemodules.itertools.txt

+Use the interp-level 'itertools' module.
+If not included, a slower app-level version of itertools is used.

pypy/doc/config/objspace.usemodules.marshal.rst

-Use the 'marshal' module. 
-This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.marshal.txt

+Use the 'marshal' module. 
+This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.math.rst

-Use the 'math' module. 
-This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.math.txt

+Use the 'math' module. 
+This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.micronumpy.rst

-Use the micronumpy module.
-This module provides a very basic numpy-like interface. Major use-case
-is to show how jit scales for other code.

pypy/doc/config/objspace.usemodules.micronumpy.txt

+Use the micronumpy module.
+This module provides a very basic numpy-like interface. Major use-case
+is to show how jit scales for other code.

pypy/doc/config/objspace.usemodules.mmap.rst

-Use the 'mmap' module. 
-This module is expected to be fully working.

pypy/doc/config/objspace.usemodules.mmap.txt

+Use the 'mmap' module. 
+This module is expected to be fully working.

pypy/doc/config/objspace.usemodules.operator.rst

-Use the 'operator' module. 
-This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.operator.txt

+Use the 'operator' module. 
+This module is expected to be working and is included by default.

pypy/doc/config/objspace.usemodules.oracle.rst

-Use the 'oracle' module.
-This module is off by default, requires oracle client installed.

pypy/doc/config/objspace.usemodules.oracle.txt

+Use the 'oracle' module.
+This module is off by default, requires oracle client installed.

pypy/doc/config/objspace.usemodules.parser.rst

-Use the 'parser' module. 
-This is PyPy implementation of the standard library 'parser' module (e.g. if
-this option is enabled and you say ``import parser`` you get this module).
-It is enabled by default.

pypy/doc/config/objspace.usemodules.parser.txt

+Use the 'parser' module. 
+This is PyPy implementation of the standard library 'parser' module (e.g. if
+this option is enabled and you say ``import parser`` you get this module).
+It is enabled by default.

pypy/doc/config/objspace.usemodules.posix.rst

-Use the essential 'posix' module.
-This module is essential, included by default and cannot be removed (even when
-specified explicitly, the option gets overridden later).

pypy/doc/config/objspace.usemodules.posix.txt

+Use the essential 'posix' module.
+This module is essential, included by default and cannot be removed (even when
+specified explicitly, the option gets overridden later).

pypy/doc/config/objspace.usemodules.pyexpat.rst

-Use (experimental) pyexpat module written in RPython, instead of CTypes
-version which is used by default.

pypy/doc/config/objspace.usemodules.pyexpat.txt

+Use (experimental) pyexpat module written in RPython, instead of CTypes
+version which is used by default.

pypy/doc/config/objspace.usemodules.pypyjit.rst

-Use the 'pypyjit' module.