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

[hpk at codespeak.net]

Author: hpk
Date: Tue Jan  9 13:11:30 2007
New Revision: 36342

Modified:
   py/dist/py/documentation/test.txt
Log:
some streamlining of the distributed testing description (needs more work)


Modified: py/dist/py/documentation/test.txt
==============================================================================
--- py/dist/py/documentation/test.txt	(original)
+++ py/dist/py/documentation/test.txt	Tue Jan  9 13:11:30 2007
@@ -712,20 +712,22 @@
 How it works
 ------------
 
-Distributed testing is implemented as a new ``Session`` object named
-``RSession`` which is used instead of the default session. It splits the
-collection and reporting duties into two separate classes. 
-
-There is one master and one or more nodes. At start up, the master connects to
-each node using `py.execnet`_ and copies the tests and all specified python
-packages to all nodes. Once all of the files have been transferred, the master
-begins to collect all of the tests and immediately sends test item
-descriptions. Each node has a local queue of tests to run, and begins to
-execute the tests with proper py.test setup and teardown.  The tests are
-distributed at the function and method level. As tests are completed, each node
-reports the results back to the ``Reporter`` on the master.
+When you issue ``py.test --session=R`` then your computer becomes
+the distributor of tests ("master") and will start distributing tests
+to several machines which need to be specified in a ``conftest.py``
+file.  
+
+At start up, the master connects to each node using `py.execnet`_ and
+its SSHGateways and *rsyncs* all specified python packages to all nodes. 
+Then the master collects all of the tests and immediately sends test item
+descriptions to its connected nodes. Each node has a local queue of tests 
+to run and begins to execute the tests, following the setup and teardown 
+semantics.   The test are distributed at function and method level. 
+When a test run on a node is completed it reports back the result
+to the master. 
 
-Three reporters are available, command line, rest output and ajaxy web based. 
+The master can run one of three reporters to process the events 
+from the testing nodes: command line, rest output and ajaxy web based. 
 
 .. _`py.execnet`: execnet.html