Skip to content

Commit d363421

Browse files
committed
Bring README/doc up to date.
Signed-off-by: Henry Cox <[email protected]>
1 parent 4ac3504 commit d363421

File tree

2 files changed

+28
-7
lines changed

2 files changed

+28
-7
lines changed

README

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ These perl packages include:
124124
- JSON::PP
125125
- JSON
126126
- Memory::Process
127+
- Module::Load::Conditional
128+
- Scalar::Util
127129
- Time::HiRes
128130

129131
If your system is missing any of these, then you may be able to install them
@@ -218,8 +220,8 @@ For further information on the gcc profiling mechanism, please also
218220
consult the gcov man page.
219221

220222

221-
6. New features in lcov 2.0:
222-
----------------------------
223+
6. New features:
224+
----------------
223225

224226
New features and capabilities fall into 7 major categories:
225227

@@ -292,12 +294,19 @@ New features and capabilities fall into 7 major categories:
292294
not exactly match the layout in your revision control system; this
293295
is common in large projects with reusable components.)
294296

297+
During coverage data capture, the --build-directory option can be used
298+
to specify a search path, to find the .gcno (compile-time coverage data)
299+
file corresponding to a particular .gcda runtime coverage data) file.
300+
Similarly, the --source-directory pption can be used to specify a
301+
search path for source files.
302+
295303
See the lcov/geninfo/genhtml man pages for a detailed description of
296304
the available filters and manipulation features.
297305

298306
Related options:
299307
--include, --exclude, --erase-functions, --omit-lines,
300308
--substitute, --filter
309+
--build-directory --source-directory
301310

302311
e) Callbacks/customization
303312

@@ -312,15 +321,21 @@ New features and capabilities fall into 7 major categories:
312321
and 'gitversion'
313322
iii) enforce a desired code coverage criteria
314323
Sample script: criteria
324+
iv) find source files in more complicated environments - where
325+
simple substitutions become complicated or unweildy.
326+
327+
The callback may be any desired script or executable - but there
328+
may be performance advantages if it is written as a Perl module.
315329

316330
See the genhtml/lcov/geninfo man pages for details.
317331

318-
Note that the various sample scripts are found in the source code 'bin'
319-
directory, but are installed in the $LCOV_HOME/share/lcov/support-scripts
320-
directory of the release.
332+
Note that the various sample scripts are found in the source code
333+
'scripts' directory, but are installed in the
334+
$LCOV_HOME/share/lcov/support-scripts directory of the release.
321335

322336
Related options:
323337
--annotate-script, --criteria-script, --version-script
338+
--resolve-script
324339

325340
f) Performance
326341

@@ -332,7 +347,12 @@ New features and capabilities fall into 7 major categories:
332347
memory consumption contraints, as well as options to enable simple
333348
profile data collection - so you can see where time is going and
334349
thus to hint at potential optimizations. The 'spreadsheet.py'
335-
script can be used to view generated profile data..
350+
script can be used to view generated profile data.
351+
352+
There are several configuration file options which can be used to
353+
tweak certain parallelization parameters to optimize performance
354+
for your environment in cases that the default behaviour is suboptimal.
355+
See the lcovrc man page for more information.
336356

337357
See the genhtml/lcov/geninfo man pages for details
338358

@@ -346,6 +366,8 @@ New features and capabilities fall into 7 major categories:
346366
See the Coverage.py documentation at https://coverage.readthedocs.io,
347367
as well as ".../py2lcov --help"
348368

369+
Other languages can be integrated using a similar approach.
370+
349371
In general, the new features and options are implemented uniformly in lcov,
350372
genhtml, and geninfo. Most of the features can be enabled/disabled
351373
using either command line options or by setting defaults in your 'lcovrc'

bin/geninfo

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ use File::Path;
6464
use Cwd qw/abs_path getcwd/;
6565
use Time::HiRes; # for profiling
6666
use Capture::Tiny;
67-
use Module::Load;
6867
use FindBin;
6968
use Storable;
7069

0 commit comments

Comments
 (0)