diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2009-09-13 09:14:39 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2009-09-13 09:14:39 -0400 |
| commit | 38b5b2f6e3b152f4073fee90e5684cf890184660 (patch) | |
| tree | 3edde069715e1084ca55372452445e87a70287a5 /doc/index.rst | |
| parent | 5979544c1cf0115c11555239d1da20add04c34ec (diff) | |
| download | python-coveragepy-git-38b5b2f6e3b152f4073fee90e5684cf890184660.tar.gz | |
Docs updated for the new command-line syntax.
Diffstat (limited to 'doc/index.rst')
| -rw-r--r-- | doc/index.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/index.rst b/doc/index.rst index a300678d..884a2558 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,6 +6,7 @@ coverage.py :history: 20090613T164000, final touches for 3.0
:history: 20090618T195900, minor tweaks
:history: 20090707T205200, changes for 3.0.1
+:history: 20090913T084400, new command line syntax
Coverage.py is a tool for measuring code coverage of Python programs. It
@@ -30,18 +31,18 @@ Getting started is easy: or by using "easy_install coverage". You may need to install the
python-dev support files, for example with "apt-get install python-dev".
-#. Run coverage to execute your program and gather data:
+#. Use ``coverage run`` to execute your program and gather data:
.. code-block:: console
- $ coverage -e -x my_program.py arg1 arg2
+ $ coverage run my_program.py arg1 arg2
blah blah ..your program's output.. blah blah
-#. Run coverage to report on the results:
+#. Use ``coverage report`` to report on the results:
.. code-block:: console
- $ coverage -r -m
+ $ coverage report -m
Name Stmts Exec Cover Missing
-------------------------------------------------------
my_program 20 16 80% 33-35, 39
@@ -49,12 +50,12 @@ Getting started is easy: -------------------------------------------------------
TOTAL 76 66 87%
-#. For a nicer presentation, run coverage to get annotated HTML listings
- detailing missed lines:
+#. For a nicer presentation, use ``coverage html`` to get annotated HTML
+ listings detailing missed lines:
.. code-block:: console
- $ coverage -b -i -d htmlcov
+ $ coverage html -i -d htmlcov
Then visit htmlcov/index.html in your browser, to see a
`report like this </code/coverage/sample_html/index.html>`_.
|