Skip to content

Commit 6509b2c

Browse files
committed
Merge branch 'eyraud/document_subp_of_interest' into 'master'
Document subprograms of interest See merge request eng/cov/gnatcoverage!259 Ref: eng/cov/gnatcoverage#65
2 parents 18cefc4 + 8f433cd commit 6509b2c

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

doc/gnatcov/units_of_interest.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,23 @@ and then executing::
203203

204204
gnatcov <command> --units=@units.list
205205

206+
Conveying *subprograms* of interest
207+
*********************************
208+
209+
|gcv| enables even finer grain control through the use of ``--subprograms``
210+
switch, which restricts coverage analysis to the specified list of subprograms
211+
of interest.
212+
213+
The ``--subprograms`` switch expects a ``<full_filename>:<line>`` argument,
214+
where ``<full_filename>`` is the full path to the subprogram source, and
215+
``line`` is the specification line for Ada subprograms, and the body line for
216+
C/C++ functions.
217+
218+
Every coverage obligation from non subprograms of interest is discarded and
219+
reported as *no code* in the various output formats, and the associated coverage
220+
data is ignored. This means that checkpoints will hold coverage data for
221+
subprograms of interest only.
222+
206223
.. _gpr_context:
207224

208225
Other switches or attributes of importance

0 commit comments

Comments
 (0)