diff options
Diffstat (limited to 'doc/help')
| -rw-r--r-- | doc/help/annotate.rst | 28 | ||||
| -rw-r--r-- | doc/help/combine.rst | 25 | ||||
| -rw-r--r-- | doc/help/debug.rst | 20 | ||||
| -rw-r--r-- | doc/help/erase.rst | 17 | ||||
| -rw-r--r-- | doc/help/html.rst | 42 | ||||
| -rw-r--r-- | doc/help/json.rst | 36 | ||||
| -rw-r--r-- | doc/help/report.rst | 40 | ||||
| -rw-r--r-- | doc/help/run.rst | 44 | ||||
| -rw-r--r-- | doc/help/xml.rst | 31 |
9 files changed, 0 insertions, 283 deletions
diff --git a/doc/help/annotate.rst b/doc/help/annotate.rst deleted file mode 100644 index c8d59719..00000000 --- a/doc/help/annotate.rst +++ /dev/null @@ -1,28 +0,0 @@ - -.. This file is auto-generated by "make dochtml", don't edit it manually. - -.. code:: - - $ coverage annotate --help - Usage: coverage annotate [options] [modules] - - Make annotated copies of the given files, marking statements that are executed - with > and statements that are missed with !. - - Options: - -d DIR, --directory=DIR - Write the output files to DIR. - -i, --ignore-errors Ignore errors while reading source files. - --include=PAT1,PAT2,... - Include only files whose paths match one of these - patterns. Accepts shell-style wildcards, which must be - quoted. - --omit=PAT1,PAT2,... Omit files whose paths match one of these patterns. - Accepts shell-style wildcards, which must be quoted. - --debug=OPTS Debug options, separated by commas. [env: - COVERAGE_DEBUG] - -h, --help Get help on this command. - --rcfile=RCFILE Specify configuration file. By default '.coveragerc', - 'setup.cfg', 'tox.ini', and 'pyproject.toml' are - tried. [env: COVERAGE_RCFILE] - diff --git a/doc/help/combine.rst b/doc/help/combine.rst deleted file mode 100644 index 49c0e089..00000000 --- a/doc/help/combine.rst +++ /dev/null @@ -1,25 +0,0 @@ - -.. This file is auto-generated by "make dochtml", don't edit it manually. - -.. code:: - - $ coverage combine --help - Usage: coverage combine [options] <path1> <path2> ... <pathN> - - Combine data from multiple coverage files collected with 'run -p'. The - combined results are written to a single file representing the union of the - data. The positional arguments are data files or directories containing data - files. If no paths are provided, data files in the default data file's - directory are combined. - - Options: - -a, --append Append coverage data to .coverage, otherwise it starts - clean each time. - --keep Keep original coverage files, otherwise they are deleted. - -q, --quiet Don't print messages about what is happening. - --debug=OPTS Debug options, separated by commas. [env: COVERAGE_DEBUG] - -h, --help Get help on this command. - --rcfile=RCFILE Specify configuration file. By default '.coveragerc', - 'setup.cfg', 'tox.ini', and 'pyproject.toml' are tried. - [env: COVERAGE_RCFILE] - diff --git a/doc/help/debug.rst b/doc/help/debug.rst deleted file mode 100644 index b6361da5..00000000 --- a/doc/help/debug.rst +++ /dev/null @@ -1,20 +0,0 @@ - -.. This file is auto-generated by "make dochtml", don't edit it manually. - -.. code:: - - $ coverage debug --help - Usage: coverage debug <topic> - - Display information about the internals of coverage.py, for diagnosing - problems. Topics are: 'data' to show a summary of the collected data; 'sys' to - show installation information; 'config' to show the configuration; 'premain' - to show what is calling coverage. - - Options: - --debug=OPTS Debug options, separated by commas. [env: COVERAGE_DEBUG] - -h, --help Get help on this command. - --rcfile=RCFILE Specify configuration file. By default '.coveragerc', - 'setup.cfg', 'tox.ini', and 'pyproject.toml' are tried. - [env: COVERAGE_RCFILE] - diff --git a/doc/help/erase.rst b/doc/help/erase.rst deleted file mode 100644 index 372dd4fb..00000000 --- a/doc/help/erase.rst +++ /dev/null @@ -1,17 +0,0 @@ - -.. This file is auto-generated by "make dochtml", don't edit it manually. - -.. code:: - - $ coverage erase --help - Usage: coverage erase [options] - - Erase previously collected coverage data. - - Options: - --debug=OPTS Debug options, separated by commas. [env: COVERAGE_DEBUG] - -h, --help Get help on this command. - --rcfile=RCFILE Specify configuration file. By default '.coveragerc', - 'setup.cfg', 'tox.ini', and 'pyproject.toml' are tried. - [env: COVERAGE_RCFILE] - diff --git a/doc/help/html.rst b/doc/help/html.rst deleted file mode 100644 index 081646b9..00000000 --- a/doc/help/html.rst +++ /dev/null @@ -1,42 +0,0 @@ - -.. This file is auto-generated by "make dochtml", don't edit it manually. - -.. code:: - - $ coverage html --help - Usage: coverage html [options] [modules] - - Create an HTML report of the coverage of the files. Each file gets its own - page, with the source decorated to show executed, excluded, and missed lines. - - Options: - --contexts=REGEX1,REGEX2,... - Only display data from lines covered in the given - contexts. Accepts Python regexes, which must be - quoted. - -d DIR, --directory=DIR - Write the output files to DIR. - --fail-under=MIN Exit with a status of 2 if the total coverage is less - than MIN. - -i, --ignore-errors Ignore errors while reading source files. - --include=PAT1,PAT2,... - Include only files whose paths match one of these - patterns. Accepts shell-style wildcards, which must be - quoted. - --omit=PAT1,PAT2,... Omit files whose paths match one of these patterns. - Accepts shell-style wildcards, which must be quoted. - --precision=N Number of digits after the decimal point to display - for reported coverage percentages. - -q, --quiet Don't print messages about what is happening. - --show-contexts Show contexts for covered lines. - --skip-covered Skip files with 100% coverage. - --no-skip-covered Disable --skip-covered. - --skip-empty Skip files with no code. - --title=TITLE A text string to use as the title on the HTML. - --debug=OPTS Debug options, separated by commas. [env: - COVERAGE_DEBUG] - -h, --help Get help on this command. - --rcfile=RCFILE Specify configuration file. By default '.coveragerc', - 'setup.cfg', 'tox.ini', and 'pyproject.toml' are - tried. [env: COVERAGE_RCFILE] - diff --git a/doc/help/json.rst b/doc/help/json.rst deleted file mode 100644 index 58f08948..00000000 --- a/doc/help/json.rst +++ /dev/null @@ -1,36 +0,0 @@ - -.. This file is auto-generated by "make dochtml", don't edit it manually. - -.. code:: - - $ coverage json --help - Usage: coverage json [options] [modules] - - Generate a JSON report of coverage results. - - Options: - --contexts=REGEX1,REGEX2,... - Only display data from lines covered in the given - contexts. Accepts Python regexes, which must be - quoted. - --fail-under=MIN Exit with a status of 2 if the total coverage is less - than MIN. - -i, --ignore-errors Ignore errors while reading source files. - --include=PAT1,PAT2,... - Include only files whose paths match one of these - patterns. Accepts shell-style wildcards, which must be - quoted. - --omit=PAT1,PAT2,... Omit files whose paths match one of these patterns. - Accepts shell-style wildcards, which must be quoted. - -o OUTFILE Write the JSON report to this file. Defaults to - 'coverage.json' - --pretty-print Format the JSON for human readers. - -q, --quiet Don't print messages about what is happening. - --show-contexts Show contexts for covered lines. - --debug=OPTS Debug options, separated by commas. [env: - COVERAGE_DEBUG] - -h, --help Get help on this command. - --rcfile=RCFILE Specify configuration file. By default '.coveragerc', - 'setup.cfg', 'tox.ini', and 'pyproject.toml' are - tried. [env: COVERAGE_RCFILE] - diff --git a/doc/help/report.rst b/doc/help/report.rst deleted file mode 100644 index b8985e4b..00000000 --- a/doc/help/report.rst +++ /dev/null @@ -1,40 +0,0 @@ - -.. This file is auto-generated by "make dochtml", don't edit it manually. - -.. code:: - - $ coverage report --help - Usage: coverage report [options] [modules] - - Report coverage statistics on modules. - - Options: - --contexts=REGEX1,REGEX2,... - Only display data from lines covered in the given - contexts. Accepts Python regexes, which must be - quoted. - --fail-under=MIN Exit with a status of 2 if the total coverage is less - than MIN. - -i, --ignore-errors Ignore errors while reading source files. - --include=PAT1,PAT2,... - Include only files whose paths match one of these - patterns. Accepts shell-style wildcards, which must be - quoted. - --omit=PAT1,PAT2,... Omit files whose paths match one of these patterns. - Accepts shell-style wildcards, which must be quoted. - --precision=N Number of digits after the decimal point to display - for reported coverage percentages. - --sort=COLUMN Sort the report by the named column: name, stmts, - miss, branch, brpart, or cover. Default is name. - -m, --show-missing Show line numbers of statements in each module that - weren't executed. - --skip-covered Skip files with 100% coverage. - --no-skip-covered Disable --skip-covered. - --skip-empty Skip files with no code. - --debug=OPTS Debug options, separated by commas. [env: - COVERAGE_DEBUG] - -h, --help Get help on this command. - --rcfile=RCFILE Specify configuration file. By default '.coveragerc', - 'setup.cfg', 'tox.ini', and 'pyproject.toml' are - tried. [env: COVERAGE_RCFILE] - diff --git a/doc/help/run.rst b/doc/help/run.rst deleted file mode 100644 index 467764a6..00000000 --- a/doc/help/run.rst +++ /dev/null @@ -1,44 +0,0 @@ - -.. This file is auto-generated by "make dochtml", don't edit it manually. - -.. code:: - - $ coverage run --help - Usage: coverage run [options] <pyfile> [program options] - - Run a Python program, measuring code execution. - - Options: - -a, --append Append coverage data to .coverage, otherwise it starts - clean each time. - --branch Measure branch coverage in addition to statement - coverage. - --concurrency=LIB Properly measure code using a concurrency library. - Valid values are: thread, gevent, greenlet, eventlet, - multiprocessing. - --context=LABEL The context label to record for this coverage run. - --include=PAT1,PAT2,... - Include only files whose paths match one of these - patterns. Accepts shell-style wildcards, which must be - quoted. - -m, --module <pyfile> is an importable Python module, not a script - path, to be run as 'python -m' would run it. - --omit=PAT1,PAT2,... Omit files whose paths match one of these patterns. - Accepts shell-style wildcards, which must be quoted. - -L, --pylib Measure coverage even inside the Python installed - library, which isn't done by default. - -p, --parallel-mode Append the machine name, process id and random number - to the .coverage data file name to simplify collecting - data from many processes. - --source=SRC1,SRC2,... - A list of directories or importable names of code to - measure. - --timid Use a simpler but slower trace method. Try this if you - get seemingly impossible results! - --debug=OPTS Debug options, separated by commas. [env: - COVERAGE_DEBUG] - -h, --help Get help on this command. - --rcfile=RCFILE Specify configuration file. By default '.coveragerc', - 'setup.cfg', 'tox.ini', and 'pyproject.toml' are - tried. [env: COVERAGE_RCFILE] - diff --git a/doc/help/xml.rst b/doc/help/xml.rst deleted file mode 100644 index cb64877d..00000000 --- a/doc/help/xml.rst +++ /dev/null @@ -1,31 +0,0 @@ - -.. This file is auto-generated by "make dochtml", don't edit it manually. - -.. code:: - - $ coverage xml --help - Usage: coverage xml [options] [modules] - - Generate an XML report of coverage results. - - Options: - --fail-under=MIN Exit with a status of 2 if the total coverage is less - than MIN. - -i, --ignore-errors Ignore errors while reading source files. - --include=PAT1,PAT2,... - Include only files whose paths match one of these - patterns. Accepts shell-style wildcards, which must be - quoted. - --omit=PAT1,PAT2,... Omit files whose paths match one of these patterns. - Accepts shell-style wildcards, which must be quoted. - -o OUTFILE Write the XML report to this file. Defaults to - 'coverage.xml' - -q, --quiet Don't print messages about what is happening. - --skip-empty Skip files with no code. - --debug=OPTS Debug options, separated by commas. [env: - COVERAGE_DEBUG] - -h, --help Get help on this command. - --rcfile=RCFILE Specify configuration file. By default '.coveragerc', - 'setup.cfg', 'tox.ini', and 'pyproject.toml' are - tried. [env: COVERAGE_RCFILE] - |