Skip to content

Commit 93fae48

Browse files
committed
Add documentation for cbi-cov options
Signed-off-by: John Pennycook <john.pennycook@intel.com>
1 parent f45d2de commit 93fae48

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

docs/source/cmd.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,34 @@ directory is annotated with information about platform usage and coverage.
8181

8282
``-L <level>, --levels <level>``
8383
Print only the specified number of levels.
84+
85+
Coverage Tool
86+
-------------
87+
88+
The coverage tool reads a JSON compilation database and generates a JSON
89+
coverage file that is suitable to be read by other tools.
90+
91+
.. code-block:: text
92+
93+
cbi-cov compute [-h] [-S <path>] [-x <pattern>] [-o <output path>] <input path>
94+
95+
**positional arguments:**
96+
97+
``input path``
98+
Path to compilation database JSON file.
99+
100+
**options:**
101+
102+
``-h, --help``
103+
Display help message and exit.
104+
105+
``-S <path>, --source-dir <path>``
106+
Path to source directory.
107+
108+
``-x <pattern>, --exclude <pattern>``
109+
Exclude files matching this pattern from the code base.
110+
May be specified multiple times.
111+
112+
``-o <output path>, --output <output path>``
113+
Path to coverage JSON file.
114+
If not specified, defaults to 'coverage.json'.

0 commit comments

Comments
 (0)