From 1d28dcf140017fd8f43cb5c39883e5884410394b Mon Sep 17 00:00:00 2001
From: holger krekel <holger@merlinux.eu>
Date: Mon, 12 Apr 2010 16:08:12 +0200
Subject: [PATCH] add links to new plugins

--HG--
branch : trunk
---
 CHANGELOG                      |  6 ++++
 bin-for-dist/makepluginlist.py |  7 +++--
 doc/test/plugin/coverage.txt   | 54 ++++++++++++++++++++++++++++++----
 doc/test/plugin/index.txt      |  8 +++--
 doc/test/plugin/links.txt      |  2 ++
 5 files changed, 67 insertions(+), 10 deletions(-)

diff --git a/CHANGELOG b/CHANGELOG
index 5d9d29b0b..d2b8dfddd 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,3 +1,9 @@
+Changes between 1.2.1 and XXX
+=====================================
+
+- added links to the new capturelog and coverage plugins 
+
+
 Changes between 1.2.1 and 1.2.0
 =====================================
 
diff --git a/bin-for-dist/makepluginlist.py b/bin-for-dist/makepluginlist.py
index 80587a94f..bf2152541 100644
--- a/bin-for-dist/makepluginlist.py
+++ b/bin-for-dist/makepluginlist.py
@@ -5,10 +5,10 @@ WIDTH = 75
 plugins = [
     ('advanced python testing', 
             'skipping mark pdb figleaf '
-            'monkeypatch capture recwarn tmpdir',),
+            'monkeypatch coverage capture capturelog recwarn tmpdir',),
     ('distributed testing, CI and deployment',
         'xdist pastebin junitxml resultlog genscript',),
-    ('testing domains and conventions',
+    ('testing domains and conventions codecheckers',
             'oejskit django unittest nose doctest restdoc'),
     ('internal, debugging, help functionality', 
           'helpconfig terminal hooklog')
@@ -22,6 +22,9 @@ externals = {
     'oejskit': "run javascript tests in real life browsers", 
     'xdist': None,
     'figleaf': None,
+    'capturelog': None, 
+    'coverage': None, 
+    'codecheckers': None, 
     'django': "for testing django applications", 
 }
 
diff --git a/doc/test/plugin/coverage.txt b/doc/test/plugin/coverage.txt
index be815b995..965b4a4ee 100644
--- a/doc/test/plugin/coverage.txt
+++ b/doc/test/plugin/coverage.txt
@@ -1,9 +1,51 @@
-pytest_coverage plugin (EXTERNAL)
-==========================================
 
-This plugin allows to use Ned's coverage_ package, see
-
-    http://github.com/rozza/py.test-plugins
+Write and report coverage data with the 'coverage' package.
+===========================================================
 
 
-.. _coverage: http://pypi.python.org/pypi/coverage
+.. contents::
+  :local:
+
+Note: Original code by Ross Lawley. 
+
+Install
+--------------
+
+Use pip to (un)install::
+
+    pip install pytest-coverage 
+    pip uninstall pytest-coverage 
+
+or alternatively use easy_install to install::
+
+    easy_install pytest-coverage 
+
+
+Usage 
+-------------
+
+To get full test coverage reports for a particular package type::
+
+    py.test --cover-report=report
+
+command line options
+--------------------
+
+
+``--cover=COVERPACKAGES``
+    (multi allowed) only include info from specified package.
+``--cover-report=REPORT_TYPE``
+    html: Directory for html output.
+                    report: Output a text report.
+                    annotate: Annotate your source code for which lines were executed and which were not.
+                    xml: Output an xml report compatible with the cobertura plugin for hudson.
+``--cover-directory=DIRECTORY``
+    Directory for the reports (html / annotate results) defaults to ./coverage
+``--cover-xml-file=XML_FILE``
+    File for the xml report defaults to ./coverage.xml
+``--cover-show-missing``
+    Show missing files
+``--cover-ignore-errors=IGNORE_ERRORS``
+    Ignore errors of finding source files for code.
+
+.. include:: links.txt
diff --git a/doc/test/plugin/index.txt b/doc/test/plugin/index.txt
index 86ce92c54..e309b65b7 100644
--- a/doc/test/plugin/index.txt
+++ b/doc/test/plugin/index.txt
@@ -12,8 +12,12 @@ figleaf_ (external) report test coverage using the 'figleaf' package.
 
 monkeypatch_ safely patch object attributes, dicts and environment variables.
 
+coverage_ (external) Write and report coverage data with the 'coverage' package.
+
 capture_ configurable per-test stdout/stderr capturing mechanisms.
 
+capturelog_ (external) capture output of logging module.
+
 recwarn_ helpers for asserting deprecation and other warnings.
 
 tmpdir_ provide temporary directories to test functions.
@@ -33,8 +37,8 @@ resultlog_ non-xml machine-readable logging of test results.
 genscript_ generate standalone test script to be distributed along with an application.
 
 
-testing domains and conventions
-===============================
+testing domains and conventions codecheckers
+============================================
 
 oejskit_ (external) run javascript tests in real life browsers
 
diff --git a/doc/test/plugin/links.txt b/doc/test/plugin/links.txt
index c85dbd78e..a3aea95d3 100644
--- a/doc/test/plugin/links.txt
+++ b/doc/test/plugin/links.txt
@@ -19,6 +19,7 @@
 .. _`pytest_tmpdir.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_tmpdir.py
 .. _`terminal`: terminal.html
 .. _`pytest_hooklog.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_hooklog.py
+.. _`capturelog`: capturelog.html
 .. _`junitxml`: junitxml.html
 .. _`pytest_skipping.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_skipping.py
 .. _`checkout the py.test development version`: ../../install.html#checkout
@@ -35,6 +36,7 @@
 .. _`recwarn`: recwarn.html
 .. _`pytest_pdb.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_pdb.py
 .. _`monkeypatch`: monkeypatch.html
+.. _`coverage`: coverage.html
 .. _`resultlog`: resultlog.html
 .. _`pytest_junitxml.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_junitxml.py
 .. _`django`: django.html