summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2016-05-08 12:07:33 -0400
committerNed Batchelder <ned@nedbatchelder.com>2016-05-08 12:07:33 -0400
commit7fd6e25fb85fb7643f679bf4f33816ea645ddadf (patch)
treed62c2a073ed7e1b2b414056d5c65888d8a6e32bd
parenta71b2ecde3892293fa713742db3a9ecc44814cce (diff)
downloadpython-coveragepy-7fd6e25fb85fb7643f679bf4f33816ea645ddadf.tar.gz
Added an example to [omit] docs
-rw-r--r--doc/source.rst11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/source.rst b/doc/source.rst
index fd8370e..8f5b31b 100644
--- a/doc/source.rst
+++ b/doc/source.rst
@@ -51,7 +51,16 @@ removed from the set.
The ``include`` and ``omit`` file name patterns follow typical shell syntax:
``*`` matches any number of characters and ``?`` matches a single character.
Patterns that start with a wildcard character are used as-is, other patterns
-are interpreted relative to the current directory.
+are interpreted relative to the current directory::
+
+ [run]
+ omit =
+ # omit anything in a .local directory anywhere
+ */.local/*
+ # omit everything in /usr
+ /usr/*
+ # omit this single file
+ utils/tirefire.py
The ``source``, ``include``, and ``omit`` values all work together to determine
the source that will be measured.