diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2016-05-08 12:07:33 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2016-05-08 12:07:33 -0400 |
commit | cdc41fcff090144f59f274d806ad9f3a8097f0a9 (patch) | |
tree | 4f2550b511325a9b817b1364f40e3fc469df395b | |
parent | b313394537fedcc0266482dd65e0ee8d5e62223c (diff) | |
download | python-coveragepy-git-cdc41fcff090144f59f274d806ad9f3a8097f0a9.tar.gz |
Added an example to [omit] docs
-rw-r--r-- | doc/source.rst | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/source.rst b/doc/source.rst index fd8370e9..8f5b31bc 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. |