[pypy-svn] r37744 - pypy/dist/pypy/doc/config

[cfbolz at codespeak.net]

Author: cfbolz
Date: Thu Feb  1 16:26:57 2007
New Revision: 37744

Modified:
   pypy/dist/pypy/doc/config/objspace.allworkingmodules.txt
   pypy/dist/pypy/doc/config/objspace.geninterp.txt
   pypy/dist/pypy/doc/config/objspace.std.oldstyle.txt
   pypy/dist/pypy/doc/config/objspace.std.withprebuiltint.txt
   pypy/dist/pypy/doc/config/objspace.std.withrangelist.txt
   pypy/dist/pypy/doc/config/objspace.std.withstrjoin.txt
   pypy/dist/pypy/doc/config/objspace.std.withstrslice.txt
   pypy/dist/pypy/doc/config/objspace.std.withtypeversion.txt
Log:
start a rough documentation of some of the options.


Modified: pypy/dist/pypy/doc/config/objspace.allworkingmodules.txt
==============================================================================
--- pypy/dist/pypy/doc/config/objspace.allworkingmodules.txt	(original)
+++ pypy/dist/pypy/doc/config/objspace.allworkingmodules.txt	Thu Feb  1 16:26:57 2007
@@ -0,0 +1,2 @@
+This option enables the usage of all modules that are known to be working well
+and that translate without problem.

Modified: pypy/dist/pypy/doc/config/objspace.geninterp.txt
==============================================================================
--- pypy/dist/pypy/doc/config/objspace.geninterp.txt	(original)
+++ pypy/dist/pypy/doc/config/objspace.geninterp.txt	Thu Feb  1 16:26:57 2007
@@ -0,0 +1,4 @@
+This option enables `geninterp`_. This will usually make the PyPy interpreter
+significantly faster (but also a bit bigger).
+
+.. _`geninterp`: ../geninterp.html

Modified: pypy/dist/pypy/doc/config/objspace.std.oldstyle.txt
==============================================================================
--- pypy/dist/pypy/doc/config/objspace.std.oldstyle.txt	(original)
+++ pypy/dist/pypy/doc/config/objspace.std.oldstyle.txt	Thu Feb  1 16:26:57 2007
@@ -0,0 +1,2 @@
+With this option you can enable the use of old-style classes by default.
+Normally, all PyPy classes are new-style.

Modified: pypy/dist/pypy/doc/config/objspace.std.withprebuiltint.txt
==============================================================================
--- pypy/dist/pypy/doc/config/objspace.std.withprebuiltint.txt	(original)
+++ pypy/dist/pypy/doc/config/objspace.std.withprebuiltint.txt	Thu Feb  1 16:26:57 2007
@@ -0,0 +1,6 @@
+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
+`objspace.std.prebuiltintfrom`_ and `objspace.std.prebuiltintto`_ options.
+
+.. _`objspace.std.prebuiltintfrom`: objspace.std.prebuiltintfrom.html
+.. _`objspace.std.prebuiltintto`: objspace.std.prebuiltintto.html

Modified: pypy/dist/pypy/doc/config/objspace.std.withrangelist.txt
==============================================================================
--- pypy/dist/pypy/doc/config/objspace.std.withrangelist.txt	(original)
+++ pypy/dist/pypy/doc/config/objspace.std.withrangelist.txt	Thu Feb  1 16:26:57 2007
@@ -0,0 +1,6 @@
+Enable "range list" objects. They are a different 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.

Modified: pypy/dist/pypy/doc/config/objspace.std.withstrjoin.txt
==============================================================================
--- pypy/dist/pypy/doc/config/objspace.std.withstrjoin.txt	(original)
+++ pypy/dist/pypy/doc/config/objspace.std.withstrjoin.txt	Thu Feb  1 16:26:57 2007
@@ -0,0 +1,7 @@
+Enable "string join" objects. They are a different implementation of the Python
+``str`` type, indistinguishable for the normal user. They represent the lazy
+addition of several strings without actually performing the addition (which
+involves copying etc.). When the actual value of the string join object is
+needed, the addition is performed. This makes it possible efficiently perform
+string additions in a loop without using the ``"".join(list_of_strings)``
+pattern.

Modified: pypy/dist/pypy/doc/config/objspace.std.withstrslice.txt
==============================================================================
--- pypy/dist/pypy/doc/config/objspace.std.withstrslice.txt	(original)
+++ pypy/dist/pypy/doc/config/objspace.std.withstrslice.txt	Thu Feb  1 16:26:57 2007
@@ -0,0 +1,8 @@
+Enable "string slice" objects. They are a different implementation of the Python
+``str`` type, indistinguishable for the normal user. They represent the lazy
+slicing of a string without actually performing the slicing (which involves
+copying). This is only done for slices of step one.  When the actual value of
+the string slice object is needed, the slicing is done (although a lot of string
+methods don't make this necessary). This makes string slicing a very efficient
+operation. It also saves memory in some cases but can also lead to memory leaks,
+since the string slice retains a reference to the original string.

Modified: pypy/dist/pypy/doc/config/objspace.std.withtypeversion.txt
==============================================================================
--- pypy/dist/pypy/doc/config/objspace.std.withtypeversion.txt	(original)
+++ pypy/dist/pypy/doc/config/objspace.std.withtypeversion.txt	Thu Feb  1 16:26:57 2007
@@ -0,0 +1,4 @@
+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 cashes. It does not make sense to
+enable this option alone.