From ca79f93c96e6a205f90d0502611b917149724e22 Mon Sep 17 00:00:00 2001
From: Ned Batchelder <ned@nedbatchelder.com>
Date: Sun, 6 Oct 2013 08:49:56 -0400
Subject: Document the --debug options.

---
 doc/cmd.rst    | 18 ++++++++++++++++++
 doc/config.rst |  3 +++
 2 files changed, 21 insertions(+)

diff --git a/doc/cmd.rst b/doc/cmd.rst
index 81a8fbe..3572fff 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -138,6 +138,24 @@ could affect the measurement process.  The possible warnings include:
   This could be because you asked to measure only modules that never ran,
   or for other reasons.
 
+.. _cmd_run_debug:
+
+The ``--debug`` option instructs coverage to log internal details of its
+operation, to help with diagnosing problems.  It takes a comma-separated list
+of options, each indicating a facet of operation to log to stderr:
+
+* ``trace``: print every decision about whether to trace a file or not. For
+  files not being traced, the reason is also given.
+
+* ``config``: before starting, dump all the :ref:`configuration <config>`
+  values.
+
+* ``sys``: before starting, dump all the system and environment information,
+  as with :ref:`coverage debug sys <cmd_debug>`.
+  
+* ``dataio``: log when reading or writing any data file.
+  
+* ``pid``: annotate all debug output with the process id.
 
 
 .. _cmd_datafile:
diff --git a/doc/config.rst b/doc/config.rst
index c32d401..7ff8202 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -93,6 +93,9 @@ standard library.
 ``data_file`` (string, default ".coverage"): the name of the data file to use
 for storing or reporting coverage.
 
+``debug`` (multi-string): a list of debug options.  See :ref:`the run
+--debug option <cmd_run_debug>` for details.
+
 ``include`` (multi-string): a list of filename patterns, the files to include
 in measurement or reporting.  See :ref:`source` for details.
 
-- 
cgit v1.2.1