Skip to content

Commit b4344c6

Browse files
committed
man: Add description for --precision and genhtml_precision
Add man page sections for genhtml's command-line option --precision and lcovrc configuration setting genhtml_precision. Also add an example configuration setting in lcovrc. Signed-off-by: Peter Oberparleiter <[email protected]>
1 parent aa12174 commit b4344c6

File tree

3 files changed

+34
-0
lines changed

3 files changed

+34
-0
lines changed

lcovrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ genhtml_charset=UTF-8
9393
# Allow HTML markup in test case description text if non-zero
9494
genhtml_desc_html=0
9595

96+
# Specify the precision for coverage rates
97+
#genhtml_precision=1
98+
9699
# Location of the gcov tool (same as --gcov-info option of geninfo)
97100
#geninfo_gcov_tool = gcov
98101

man/genhtml.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,9 @@ genhtml \- Generate HTML view from LCOV coverage data files
6464
.RB [ \-\-rc
6565
.IR keyword = value ]
6666
.br
67+
.RB [ \-\-precision
68+
.IR num ]
69+
.br
6770
.IR tracefile(s)
6871
.RE
6972
.SH DESCRIPTION
@@ -545,6 +548,19 @@ See
545548
for a list of available keywords and their meaning.
546549
.RE
547550

551+
.BI "\-\-precision " num
552+
.RS
553+
Show coverage rates with
554+
.I num
555+
number of digits after the decimal-point.
556+
557+
Default value is 1.
558+
559+
This option can also be configured permanently using the configuration file
560+
option
561+
.IR genhtml_precision .
562+
.RE
563+
548564
.SH FILES
549565

550566
.I /etc/lcovrc

man/lcovrc.5

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,11 @@ genhtml_charset=UTF\-8
154154
genhtml_desc_html=0
155155
.br
156156

157+
# Specify the precision for coverage rates
158+
.br
159+
#genhtml_precision=1
160+
.br
161+
157162
# Location of the gcov tool
158163
.br
159164
#geninfo_gcov_tool = gcov
@@ -565,6 +570,16 @@ description page.
565570

566571
Default is 0.
567572
.PP
573+
574+
.BR genhtml_precision " ="
575+
.IR 1 | 2 | 3 | 4
576+
.IP
577+
Specify how many digits after the decimal-point should be used for
578+
displaying coverage rates.
579+
.br
580+
581+
Default is 1.
582+
.PP
568583
.
569584
.BR geninfo_gcov_tool " ="
570585
.I path_to_gcov

0 commit comments

Comments
 (0)