Merge commit '890c2fa555314a67a8d97a1b8ea4881a14be69c4' into merge-master

CHANGELOG.rst

@@ -79,7 +79,8 @@
 
 *
 
-*
+* Minor improvements and fixes to the documentation.
+  Thanks `@omarkohl`_ for the PR.
 
 
 2.9.1
@@ -235,6 +236,7 @@
 .. _@RonnyPfannschmidt: https://github.com/RonnyPfannschmidt
 .. _@rabbbit: https://github.com/rabbbit
 .. _@hackebrot: https://github.com/hackebrot
+.. _@omarkohl: https://github.com/omarkohl
 
 2.8.7
 =====

doc/en/example/simple.rst

@@ -201,7 +201,7 @@ Example::
 
 The ``__tracebackhide__`` setting influences ``pytest`` showing
 of tracebacks: the ``checkconfig`` function will not be shown
-unless the ``--fulltrace`` command line option is specified.
+unless the ``--full-trace`` command line option is specified.
 Let's run our little function::
 
     $ py.test -q test_checkconfig.py

doc/en/plugins.rst

@@ -90,7 +90,7 @@ Finding out which plugins are active
 If you want to find out which plugins are active in your
 environment you can type::
 
-    py.test --traceconfig
+    py.test --trace-config
 
 and will get an extended test header which shows activated plugins
 and their names. It will also print local plugins aka

doc/en/test/attic.rst

@@ -21,7 +21,7 @@ but note that project specific settings will be considered
 first.  There is a flag that helps you debugging your
 conftest.py configurations::
 
-    py.test --traceconfig
+    py.test --trace-config
 
 
 customizing the collecting and running process

doc/en/test/plugin/helpconfig.rst

@@ -16,7 +16,7 @@ command line options
     display py lib version and import information.
 ``-p name``
     early-load given plugin (multi-allowed).
-``--traceconfig``
+``--trace-config``
     trace considerations of conftest.py files.
 ``--nomagic``
     don't reinterpret asserts, no traceback cutting.

doc/en/test/plugin/terminal.rst

@@ -22,7 +22,7 @@ command line options
     (deprecated, use -r)
 ``--tb=style``
     traceback print mode (long/short/line/no).
-``--fulltrace``
+``--full-trace``
     don't cut any tracebacks (default is to cut).
 ``--fixtures``
     show available function arguments, sorted by plugin

doc/en/usage.rst

@@ -74,6 +74,14 @@ Examples for modifying traceback printing::
     py.test --tb=native  # Python standard library formatting
     py.test --tb=no      # no traceback at all
 
+The ``--full-trace`` causes very long traces to be printed on error (longer
+than ``--tb=long``). It also ensures that a stack trace is printed on
+**KeyboardInterrrupt** (Ctrl+C).
+This is very useful if the tests are taking too long and you interrupt them
+with Ctrl+C to find out where the tests are *hanging*. By default no output
+will be shown (because KeyboardInterrupt is catched by pytest). By using this
+option you make sure a trace is shown.
+
 Dropping to PDB_ (Python Debugger) on failures
 -----------------------------------------------
 

doc/en/writing_plugins.rst

@@ -194,7 +194,7 @@ the plugin manager like this:
     plugin = config.pluginmanager.getplugin("name_of_plugin")
 
 If you want to look at the names of existing plugins, use
-the ``--traceconfig`` option.
+the ``--trace-config`` option.
 
 Testing plugins
 ---------------