summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/index.rst1
-rw-r--r--doc/trouble.rst49
2 files changed, 50 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
index 319e525..9d08530 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -159,6 +159,7 @@ More information
subprocess
api
contributing
+ trouble
faq
changes
diff --git a/doc/trouble.rst b/doc/trouble.rst
new file mode 100644
index 0000000..9d021de
--- /dev/null
+++ b/doc/trouble.rst
@@ -0,0 +1,49 @@
+.. _trouble:
+
+====================
+When things go wrong
+====================
+
+Coverage works pretty well, but occasionally things don't go as you would like.
+This page details problems, with links to coverage.py bug reports if
+appropriate.
+
+You can of course search the `coverage.py bug tracker`_ directly to see if
+there is some mention of your problem.
+
+.. _coverage.py bug tracker: https://bitbucket.org/ned/coveragepy/issues?status=new&status=open
+
+
+Kryptonite
+----------
+
+There are a number of popular packages that prevent coverage.py from working
+properly.
+
+* gevent, `issue 149`_.
+
+* execv, or one of its variants, `issue 43`_.
+
+* multiprocessing, `issue 117`_.
+
+Code is marked as not executed when I know it is.
+
+link to DecoratorTools, TurboGears
+
+Try --timid
+
+psyco is an issue?
+
+.. _issue 43: https://bitbucket.org/ned/coveragepy/issue/43/coverage-measurement-fails-on-code
+.. _issue 117: https://bitbucket.org/ned/coveragepy/issue/117/enable-coverage-measurement-of-code-run-by
+.. _issue 149: https://bitbucket.org/ned/coveragepy/issue/149/coverage-gevent-looks-broken
+
+
+Really obscure stuff
+--------------------
+
+* Python 2.5 had a bug (`1569356`_) that could make your program behave
+ differently when being measured with coverage. This is diagnosed in `issue 51`_.
+
+.. _issue 51: http://bitbucket.org/ned/coveragepy/issue/51/turbogears-15-test-failing-with-coverage
+.. _1569356: http://bugs.python.org/issue1569356