[py-svn] r34558 - py/dist/py/documentation

[fijal at codespeak.net]

Author: fijal
Date: Mon Nov 13 14:00:17 2006
New Revision: 34558

Modified:
   py/dist/py/documentation/test.txt
Log:
Updated documentation a bit.


Modified: py/dist/py/documentation/test.txt
==============================================================================
--- py/dist/py/documentation/test.txt	(original)
+++ py/dist/py/documentation/test.txt	Mon Nov 13 14:00:17 2006
@@ -733,20 +733,29 @@
 
 The options are:
 
-* disthosts - a list of ssh addresses (including a specific path if it 
+* `disthosts` - a list of ssh addresses (including a specific path if it 
   should be different than the default: ``$HOME/pytestcache-hostname``)
-* distrsync_roots - a list of packages to copy to the remote machines.
-* dist_remotepython - the remote python to run.
+* `distrsync_roots` - a list of packages to copy to the remote machines.
+* `dist_remotepython` - the remote python to run.
+* `SessionOptions` - containing some specific tuning options
 
 Sample configuration::
 
     disthosts = ['localhost', 'user at someserver:/tmp/somedir']
     distrsync_roots = ['pypy', 'py']
     dist_remotepython = 'python2.4'
+    class SessionOptions:
+        nice_level = 10
 
 Running server is done by ``-w`` command line option or ``--startserver``
 (the former might change at some point due to conflicts).
 
+Possible `SessionOptions` arguments:
+
+* `nice_level` - Level of nice under which tests are run
+* `runner_policy` - (for `LSession` only) - contains policy for the test boxig.
+  `"plain_runner"` means no boxing, `"box_runner"` means boxing.
+
 Development Notes
 -----------------