Skip to content

Commit e50613f

Browse files
committed
gnatcov doc: improve the documentation for --subprograms
Specify its behavior when it refers to subprograms declared in units that are not of interest.
1 parent ef2f8af commit e50613f

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

doc/gnatcov/units_of_interest.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -205,22 +205,27 @@ and then executing::
205205

206206
Conveying *subprograms* of interest (experimental)
207207
**************************************************
208-
>>>>>>> 9544dc8f5 (Mark the --subprograms switch as experimental)
209208

210209
|gcv| enables even finer grain control through the use of ``--subprograms``
211210
switch, which restricts coverage analysis to the specified list of subprograms
212211
of interest.
213212

214-
The ``--subprograms`` switch expects a ``<full_filename>:<line>`` argument,
215-
where ``<full_filename>`` is the full path to the subprogram source, and
216-
``line`` is the specification line for Ada subprograms, and the body line for
217-
C/C++ functions.
213+
The ``--subprograms`` switch expects a ``<filename>:<line>`` argument, where
214+
``<filename>`` is a source file name path, absolute or relative to the current
215+
directory, pointing to the subprogram source and ``line`` is the first line of
216+
the subprogram specification in Ada, and the first line of the function
217+
definition in C/C++.
218218

219219
Every coverage obligation from non subprograms of interest is discarded and
220220
reported as *no code* in the various output formats, and the associated coverage
221221
data is ignored. This means that checkpoints will hold coverage data for
222222
subprograms of interest only.
223223

224+
The ``--subprograms`` switch acts only on subprograms within units of interest.
225+
If a unit was ignored for coverage analysis through a project attribute (e.g.
226+
``Excluded_Units``) or through a command line switch (e.g. ``--units``), the
227+
designated subprogram will be ignored for coverage analysis as well.
228+
224229
.. _gpr_context:
225230

226231
Other switches or attributes of importance

0 commit comments

Comments
 (0)