[pypy-svn] pypy default: Added documentation on the new extmodules config option.

[tav]

Author: tav <tav at espians.com>
Branch: 
Changeset: r42906:331f1f55cf74
Date: 2011-03-24 17:32 +0000
http://bitbucket.org/pypy/pypy/changeset/331f1f55cf74/

Log:	Added documentation on the new extmodules config option.

diff --git a/pypy/doc/config/objspace.extmodules.rst b/pypy/doc/config/objspace.extmodules.rst
new file mode 100644
--- /dev/null
+++ b/pypy/doc/config/objspace.extmodules.rst
@@ -0,0 +1,12 @@
+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
+

diff --git a/pypy/config/pypyoption.py b/pypy/config/pypyoption.py
--- a/pypy/config/pypyoption.py
+++ b/pypy/config/pypyoption.py
@@ -160,7 +160,7 @@
                negation=True),
 
     StrOption("extmodules",
-              "Comma-separated list of third-party extension modules",
+              "Comma-separated list of third-party builtin modules",
               cmdline="--ext",
               default=None),