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

[fijal at codespeak.net]

Author: fijal
Date: Fri Nov 24 16:18:44 2006
New Revision: 34936

Modified:
   py/dist/py/documentation/test-distributed.txt
   py/dist/py/documentation/test.txt
Log:
Updated a bit distributed testing docs.


Modified: py/dist/py/documentation/test-distributed.txt
==============================================================================
--- py/dist/py/documentation/test-distributed.txt	(original)
+++ py/dist/py/documentation/test-distributed.txt	Fri Nov 24 16:18:44 2006
@@ -29,6 +29,12 @@
 Writing down new reporter is relatively easy, way easier than writing session
 from a scratch, so one can write down GTK reporter and whatnot.
 
+Only thing to do is to write down new reporter classs which subclasses
+`AbstractReporter` in `reporter.py`_ and overrides all the report_Xxx methods
+(each of these method is called when one of the message, defined in 
+`report.py`_ arrives to reporter). Special consideration is needed when dealing
+with ReceivedItemOutcome, which is in details described in `outcome.py`_.
+
 Another abstraction layer (present only in `LSession`) is runner. Actual
 object which runs tests. There are two existing runners: box_runner and
 plain_runner, both defined in `local.py`_. box_runner can run tests
@@ -42,16 +48,17 @@
 .. _`report.py`: http://codespeak.net/svn/py/dist/py/test/rsession/report.py
 .. _`web.py`: http://codespeak.net/svn/py/dist/py/test/rsession/web.py
 .. _`local.py`: http://codespeak.net/svn/py/dist/py/test/rsession/local.py
+.. _`reporter.py`: http://codespeak.net/svn/py/dist/py/test/rsession/reporter.py
+.. _`outcome.py`: http://codespeak.net/svn/py/dist/py/test/rsession/outcome.py
 
 Implemented features:
 =====================
 
 Actually most of normal py.test features are implemented in distributed
 version. These are command line options: -v -x -k --pdb (only for LSession).
-Missing options are -s (makes sense for LSession, easy), --exec (moderatly
-easy for L/R Sessions), --pdb for RSession (with screen, unsure if it'll
-be implemented). Quite missing is testing LSession under OSX/Windows or other
-machines than mine.
+--exec (moderatly easy for L/R Sessions), --pdb for RSession (with screen, 
+unsure if it'll be implemented). Quite missing is testing LSession under 
+OSX/Windows or other machines than mine.
 
 Unique features:
 ================

Modified: py/dist/py/documentation/test.txt
==============================================================================
--- py/dist/py/documentation/test.txt	(original)
+++ py/dist/py/documentation/test.txt	Fri Nov 24 16:18:44 2006
@@ -755,8 +755,9 @@
 * `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.
-* `waittime` - Default waiting time for remote host to finish test (after
+* `waittime` - Default waiting time for remote host to finish tests (after
   that period we consider node as dead, default to 100s).
+* `max_tasks_per_node` - Maximum number of tasks which can be send to one node.
 
 Development Notes
 -----------------
@@ -764,11 +765,11 @@
 Changing the behavior of the web based reporter requires `pypy`_ since the
 javascript is actually generated fom rpython source.
 
-At some point it would be good to split the default collection process into a
-separate collector and reporter as well. This would all the web based reporter
-to be used locally.
+There exists as well `L/Rsession document`_ which discusses in more details
+unique features and developement notes.
 
 .. _`pypy`: http://codespeak.net/pypy
+.. _`L/Rsession document`: test-distributed.html
 
 
 Future/Planned Features of py.test