From ca2c19731abf47972457338ae3ba13c3e813f4c7 Mon Sep 17 00:00:00 2001 From: hpk Date: Thu, 2 Apr 2009 20:59:31 +0200 Subject: [PATCH] [svn r63548] fixing lots of little issues with the docs --HG-- branch : trunk --- doc/coding-style.txt | 6 ------ doc/contact.txt | 2 -- doc/impl-test.txt | 1 - doc/index.txt | 5 ----- doc/misc.txt | 27 ++++----------------------- doc/test-ext.txt | 22 +++------------------- doc/test-features.txt | 2 +- doc/test.txt | 1 - 8 files changed, 8 insertions(+), 58 deletions(-) diff --git a/doc/coding-style.txt b/doc/coding-style.txt index 085902b9a..340dc8d28 100644 --- a/doc/coding-style.txt +++ b/doc/coding-style.txt @@ -61,11 +61,5 @@ Miscellaneous - Try to put the tests close to the tested code, don't overload directories with names. -- If you think of exporting new py lib APIs, discuss it first on the - `py-dev mailing list`_ and possibly write a chapter in our - `future_` book. Communication is considered a key here to make - sure that the py lib develops in a consistent way. - .. _`PEP 8 Style Guide for Python Code`: http://www.python.org/peps/pep-0008.html .. _`py-dev mailing list`: http://codespeak.net/mailman/listinfo/py-dev -.. _`future`: future.html diff --git a/doc/contact.txt b/doc/contact.txt index 2ae637bed..7e3857da5 100644 --- a/doc/contact.txt +++ b/doc/contact.txt @@ -16,8 +16,6 @@ Contact and communication .. _`merlinux.eu`: http://merlinux.eu -.. _future: future.html - .. _`get an account`: .. _tetamap: http://tetamap.wordpress.com diff --git a/doc/impl-test.txt b/doc/impl-test.txt index f76b5f723..9f42f3f32 100644 --- a/doc/impl-test.txt +++ b/doc/impl-test.txt @@ -2,7 +2,6 @@ ATTIC documentation =============================================== - XXX REVIEW and remove the below XXX diff --git a/doc/index.txt b/doc/index.txt index f892f159b..49c031c33 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -33,11 +33,7 @@ Minor support functionality .. _`py.test`: test.html .. _`py lib scripts`: bin.html .. _`py.xml`: xml.html -.. _`Why What how py?`: why_py.html -.. _`future`: future.html .. _`miscellaneous features`: misc.html -.. _`0.9.2 release announcement`: release-0.9.2.html - Full Contents =================================== @@ -64,4 +60,3 @@ Full Contents * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/doc/misc.txt b/doc/misc.txt index 1b4f8dab7..df835d84f 100644 --- a/doc/misc.txt +++ b/doc/misc.txt @@ -2,7 +2,6 @@ Miscellaneous features of the py lib ==================================== - Mapping the standard python library into py =========================================== @@ -52,32 +51,14 @@ However, the ``cmdexec`` approach has a few shortcomings: local paths have ``sysexec`` ---------------------------- -The py lib currently offers a stripped down functionality of what -the new `PEP-324 subprocess module`_ offers. The main functionality -of synchronously executing a system executable has a straightforward API:: +In order to synchronously execute an executable file you +can use ``sysexec``:: binsvn.sysexec('ls', 'http://codespeak.net/svn') where ``binsvn`` is a path that points to the ``svn`` commandline -binary. Note that this function would not offer any shell-escaping -so you really have to pass in separated arguments. This idea -fits nicely into `a more general view on path objects`_. - -For a first go, we are just reusing the existing `subprocess -implementation`_ but don't expose any of its API apart -from the above ``sysexec()`` method. - -Note, however, that currently the support for the ``sysexec`` interface on -win32 is not thoroughly tested. If you run into problems with it, we are -interested to hear about them. If you are running a Python older than 2.4 you -will have to install the `pywin32 package`_. - - -.. _`future book`: future.html -.. _`PEP-324 subprocess module`: http://www.python.org/peps/pep-0324.html -.. _`subprocess implementation`: http://www.lysator.liu.se/~astrand/popen5/ -.. _`a more general view on path objects`: future.html#general-path -.. _`pywin32 package`: http://pywin32.sourceforge.net/ +binary. Note that this function does not offer any shell-escaping +so you have to pass in already separated arguments. finding an executable local path -------------------------------- diff --git a/doc/test-ext.txt b/doc/test-ext.txt index 7b4988d2e..7255ae7a0 100644 --- a/doc/test-ext.txt +++ b/doc/test-ext.txt @@ -51,9 +51,6 @@ home-directoray, per shell session or per test-run. Test Collection process ====================================================== -.. module:: py.test.collect - :synopsis: basic test collection classes - The collecting process is iterative so that distribution and execution of tests can start as soon as the first test item is collected. Collection nodes with children are @@ -110,22 +107,9 @@ name. Given a filesystem ``fspath`` it is constructed as follows: the trailing ``.py``. - - - -Plugin methods +Plugin hooks and events ======================================= -.. module:: py.__.test.pluginapi - -A Plugin class may implement the following attributes and methods: - -XXX - -_`pytest event`: - -Pytest Events -======================================= - -XXX +See definitions at +http://codespeak.net/svn/py/trunk/py/test/plugin/api.py diff --git a/doc/test-features.txt b/doc/test-features.txt index 8bacd3ecc..81d376ecb 100644 --- a/doc/test-features.txt +++ b/doc/test-features.txt @@ -23,7 +23,7 @@ From each test module every function with a leading ``test_`` or class with a leading ``Test`` name is collected. .. _`generative tests`: -.. _`collection process`: impl-test.html#collection-process +.. _`collection process`: test-ext.html#collection-process load-balance tests to multiple CPUs =================================== diff --git a/doc/test.txt b/doc/test.txt index 9301b4019..f98a9a9b8 100644 --- a/doc/test.txt +++ b/doc/test.txt @@ -24,7 +24,6 @@ extend_: writing plugins and advanced configuration. .. _`distributed testing`: test-dist.html - Contents: .. toctree::