Skip to content

Commit f2a5518

Browse files
committed
Add 'genhtml_frames' to lcovrc config file - corresponds to
'genhtml --frames' Clarify implications of chrome/firefox bug when using 'frames'. Signed-off-by: Henry Cox <[email protected]>
1 parent 1aed8e1 commit f2a5518

File tree

3 files changed

+35
-0
lines changed

3 files changed

+35
-0
lines changed

bin/genhtml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5257,6 +5257,7 @@ my %genhtml_rc_opts = (
52575257
"genhtml_no_source" => \$no_sourceview,
52585258
"genhtml_num_spaces" => \$tab_size,
52595259
"genhtml_highlight" => \$highlight,
5260+
"genhtml_frames" => \$frames,
52605261
"genhtml_legend" => \$legend,
52615262
"genhtml_html_prolog" => \$html_prolog_file,
52625263
"genhtml_html_epilog" => \$html_epilog_file,
@@ -5359,6 +5360,7 @@ $fn_hi_limit = $hi_limit if (!defined($fn_hi_limit));
53595360
$fn_med_limit = $med_limit if (!defined($fn_med_limit));
53605361
$br_hi_limit = $hi_limit if (!defined($br_hi_limit));
53615362
$br_med_limit = $med_limit if (!defined($br_med_limit));
5363+
$frames = undef unless (defined($frames) && $frames);
53625364

53635365
@datebins = @rc_date_bins unless @datebins;
53645366
@SourceFile::annotateScript = @rc_annotate_script

man/genhtml.1

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -644,6 +644,21 @@ code character has to be inspected once. Note also that the GD.pm Perl
644644
module has to be installed for this option to work (it may be obtained
645645
from http://www.cpan.org).
646646

647+
This option can also be controlled from the
648+
.I genhtml_frames
649+
entry of the
650+
.B lcovrc
651+
file.
652+
653+
Please note that there is a bug in firefox and in chrome, such that
654+
enabling frames will disable hyperlinks from the 'directory' level summary
655+
table entry to the first line in the corresponding file in the particular
656+
category - e.g., to the first 'MIS' line (vanilla coverage report - see the
657+
.i \-\-show\-navigation
658+
option, below), to
659+
the first 'UNC' branch (differential coverage repot), etc.
660+
Hyperlinks from the summary table at the top of the 'source detail' page are not affected.
661+
647662
.RE
648663
.B \-s
649664
.br
@@ -1446,6 +1461,13 @@ Hyperlinks are always generated for differential coverage reports.
14461461

14471462
This feature enables developers to find and understand coverage issues more quickly than they might otherwise, if they had to rely on scrolling.
14481463

1464+
See the
1465+
.I \-\-frames
1466+
description above for a description of a browser bug which disables
1467+
these hyperlinks in certain conditions.
1468+
1469+
Navigation hyperlinks are always enabled in differential coveage report.
1470+
14491471
.RE
14501472
.BI "\-\-show\-proportions "
14511473
.RS

man/lcovrc.5

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -855,6 +855,17 @@ age of the corresponding block (as reported by your annotation script). This o
855855
Default is 5.
856856
.PP
857857

858+
.BR genhtml_frames " ="
859+
.I 0 | 1
860+
.IP
861+
Specify whether source detail view should contain a navigation image.
862+
See the
863+
.I \-\-frame
864+
entry in the
865+
.B genhtml
866+
man page.
867+
.PP
868+
858869
.BR genhtml_overview_width " ="
859870
.I pixel_size
860871
.IP

0 commit comments

Comments
 (0)