File: genhtml.1

package info (click to toggle)
lcov 2.3.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,464 kB
  • sloc: perl: 27,911; sh: 7,320; xml: 6,982; python: 1,152; makefile: 597; cpp: 520; ansic: 176
file content (3600 lines) | stat: -rw-r--r-- 95,785 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
\" Define path to scripts
.ds scriptdir scripts

\" Define project URL
.ds lcovurl https://github.com/linux\-test\-project/lcov

.TH genhtml 1 "LCOV 2.0" 2023\-05\-17 "User Manuals"
.SH NAME
genhtml \- Generate HTML view from LCOV coverage data files
.SH SYNOPSIS
.B genhtml
.RB [ \-h | \-\-help ]
.RB [ \-\-version ]
.RS 8
.br
.RB [ \-q | \-\-quiet ]
.RB [ \-v | \-\-verbose ]
.br
.RB [ \-\-debug ] [ \-\-validate ]
.br
.RB [ \-s | \-\-show\-details ]
.br
.RB [ \-f | \-\-frames ]
.br
.RB [ \-b | \-\-baseline\-file
.IR baseline\-file\-pattern ]
.br
.RB [ \-o | \-\-output\-directory
.IR output\-directory ]
.br
.RB [ \-\-header-title
.IR banner ]
.br
.RB [ \-\-footer
.IR string ]
.br
.RB [ \-t | \-\-title
.IR title ]
.br
.RB [ \-d | \-\-description\-file
.IR description\-file ]
.br
.RB [ \-k | \-\-keep\-descriptions ]
.RB [ \-c | \-\-css\-file
.IR css\-file ]
.br
.RB [ \-p | \-\-prefix
.IR prefix ]
.RB [ \-\-no\-prefix ]
.br
.RB [ \-\-build\-directory
.IR directory ]
.br
.RB [ \-\-source\-directory
.IR dirname ]
.br
.RB [ \-\-no\-source ]
.RB [ \-\-no\-html ]
.br
.RB [ \-\-num\-spaces
.IR num ]
.RB [ \-\-highlight ]
.br
.RB [ \-\-legend ]
.RB [ \-\-html\-prolog
.IR prolog\-file ]
.br
.RB [ \-\-html\-epilog
.IR epilog\-file ]
.RB [ \-\-html\-extension
.IR extension ]
.br
.RB [ \-\-html\-gzip ]
.RB [ \-\-sort\-tables ]
.RB [ \-\-no\-sort ]
.br
.RB [ \-\-function\-coverage ]
.RB [ \-\-no\-function\-coverage ]
.br
.RB [ \-\-branch\-coverage ]
.RB [ \-\-no\-branch\-coverage ]
.br
.RB [ \-\-mcdc\-coverage ]
.br
.RB [ \-\-demangle\-cpp
.IR [ param ] ]
.br
.RB [ \-\-msg\-log
.IR [ log_file_name ] ]
.br
.RB [ \-\-ignore\-errors
.IR errors  ]
.br
.RB [\-\-expect\-message\-count
.IR message_type=expr[,message_type=expr..]]
.br
.RB [ \-\-keep\-going ]
.RB [ \-\-config\-file
.IR config\-file ]
.br
.RB [ \-\-profile
.IR [profile\-file ]
.br
.RB [ \-\-rc
.IR keyword = value ]
.br
.RB [ \-\-precision
.IR num ]
.RB [ \-\-missed ]
.br
.RB [ \-\-merge\-aliases ]
.br
.RB [ \-\-suppress\-aliases ]
.br
.RB [ \-\-forget\-test\-names ]
.br
.RB [ \-\-dark\-mode ]
.br
.RB [ \-\-baseline\-title
.IR title ]
.br
.RB [ \-\-baseline\-date
.IR date ]
.br
.RB [ \-\-current\-date
.IR date ]
.br
.RB [ \-\-diff\-file
.IR diff\-file ]
.br
.RB [ \-\-annotate\-script
.IR script ]
.br
.RB [ \-\-context\-script
.IR script ]
.br
.RB [ \-\-criteria\-script
.IR script ]
.br
.RB [ \-\-version\-script
.IR script  ]
.br
.RB [ \-\-resolve\-script
.IR script  ]
.br
.RB [ \-\-select\-script
.IR script  ]
.br
.RB [ \-\-checksum ]
.br
.RB [ \-\-fail\-under\-branches
.IR percentage ]
.br
.RB [ \-\-fail\-under\-lines
.IR percentage ]
.br
.RB [ \-\-new\-file\-as\-baseline ]
.br
.RB [ \-\-elide\-path\-mismatch ]
.br
.RB [ \-\-synthesize\-missing ]
.br
.RB [ \-\-date\-bins
.IR day[,day,...]]
.br
.RB [ \-\-date\-labels
.IR string[,string,...]]
.br
.RB [ \-\-show\-owners
.IR [ all ] ]
.br
.RB [ \-\-show\-noncode ]
.br
.RB [ \-\-show\-zero\-columns ]
.br
.RB [ \-\-show\-navigation ]
.br
.RB [ \-\-show\-proportions ]
.br
.RB [ \-\-simplified-colors ]
.br
.RB [ \-\-hierarchical ]
.RB [ \-\-flat ]
.br
.RB [ \-\-filter
.IR filters ]
.br
.RB [ \-\-include
.IR glob_pattern ]
.br
.RB [ \-\-exclude
.IR glob_pattern ]
.br
.RB [ \-\-erase\-functions
.IR regexp_pattern ]
.br
.RB [ \-\-substitute
.IR regexp_pattern ]
.br
.RB [ \-\-omit\-lines
.IR regexp_pattern ]
.br
.RB [ \-\-parallel | -j
.IR [integer] ]
.br
.RB [ \-\-memory
.IR integer_num_Mb ]
.br
.RB [ \-\-tempdir
.IR dirname ]
.br
.RB [ \-\-preserve ]
.br
.RB [ \-\-save ]
.br
.RB [ \-\-sort\-input ]
.br
.RB [ \-\-serialize
.IR serialize_output_file ]
.br
.IR tracefile_pattern(s)
.RE
.SH DESCRIPTION

.B genhtml
creates an HTML view of coverage data found in tracefiles
.B geninfo
and
.B lcov
tools which are found from glob-match pattern(s)
.I tracefile_pattern.
See man
.B geninfo(1) for a description of the tracefile format.

 Features include:

.IP \(bu 3
Differential coverage comparison against baseline coverage data
.PP
.IP \(bu 3
Annotation of reports with date and owner information ("binning")
.PP

The basic concepts of differential coverage and date/owner binning are described in the paper found at
.I https://arxiv.org/abs/2008.07947

.SS Differential coverage

Differential coverage compares two versions of source code - the baseline and the current versions - and the coverage results for each to segment the code into categories.
.br

To create a differential coverage report,
.B genhtml
requires

.IP 1. 3
one or more
.I baseline\-files
specified via
.BR \-\-baseline\-file ,
and
.PP
.IP 2. 3
a patch file in unified format specified using
.BR \-\-diff\-file .
.PP
.br

Both
.I tracefile_pattern
and
.I baseline\-file
are treated as glob patterns which match one or more files.
.br

The difference in coverage between the set of
.I tracefiles
and
.I baseline\-files
is classified line-by-line into categories based on changes in 2 aspects:

.IP 1. 3
.BR "Test coverage results" :
a line of code can be tested (1), untested (0),
or unused (#). An unused line is a source code line that has no associated
coverage data, for example due to a disabled #ifdef statement.
.br
.PP

.IP 2. 3
.BR "Source code changes" :
a line can be unchanged, added (+\ =>), or removed (=>\ \-).
Note that the diff-file format used by
.B genhtml
reports changes in lines as removal of old line and addition of new line.
.br
.PP

Below are the resulting 12 categories, sorted by priority (assuming that untested code is more interesting than tested code, and new code is more interesting than old code):
.br

.RE
.B UNC
.RS
Uncovered New Code (+ => 0): newly added code is not tested.
.br
.RE

.B LBC
.RS
Lost Baseline Coverage (1 => 0): unchanged code is no longer tested.
.br
.RE

.B UIC
.RS
Uncovered Included Code (# => 0): previously unused code is untested.
.br
.RE

.B UBC
.RS
Uncovered Baseline Code (0 => 0): unchanged code was untested before, is untested now.
.br
.RE

.B GBC
.RS
Gained Baseline Coverage (0 => 1): unchanged code is tested now.
.br
.RE

.B GIC
.RS
Gained Included Coverage (# => 1): previously unused code is tested now.
.br
.RE

.B GNC
.RS
Gained New Coverage (+ => 1): newly added code is tested.
.br
.RE

.B CBC
.RS
Covered Baseline Code (1 => 1): unchanged code was tested before and is still tested.
.br
.RE

.B EUB
.RS
Excluded Uncovered Baseline (0 => #): previously untested code is unused now.
.br
.RE

.B ECB
.RS
Excluded Covered Baseline (1 => #): previously tested code is unused now.
.br
.RE

.B DUB
.RS
Deleted Uncovered Baseline (0 => \-): previously untested code has been deleted.
.br

Note: Because these lines are not represented in the current source version,
they are only represented in the classification summary table.
.RE

.B DCB
.RS
Deleted Covered Baseline (1 => \-): previously tested code has been deleted.
.br

Note: Because these lines are not represented in the current source version,
they are only represented in the classification summary table.
.br
.RE

The differential coverage report colorizes categorized regions in the source code view using unique colors for each.  You can use the
.B \-\-simplified\-colors
option to instead use one color for 'covered' code and another for 'uncovered'.

.SS Date and owner binning

.B "Date binning"
annotates coverage reports with age-of-last-change information to distinguish
recently added or modified code which has not been tested from older, presumed
stable code which is also not tested.
.B "Owner binning"
adds annotation identifying the author of changes.
.br

Both age and ownership reporting can be used to enhance team efforts to maintain
good coverage discipline by spotlighting coverage shortfalls in recently
modified code, even in the absence of baseline coverage data.
.br

To enable date and owner binning, the
.B \-\-annotate\-script
option must be used to specify a script that provides source code line age and
ownership information.
.br

For each source line, age is the interval since the most recent modification date
and the owner is the user identity responsible for the most recent change to that line.
.br

Line coverage overall totals and counts for each of the 12 classification categories are
collected for each of the specified age ranges (see the
.B \-\-date\-bins
option, below).

.SS Script conventions

Some
.B genhtml
options expect the name of an external script or tool as argument. These
scripts are then run as part of the associated function. This includes the
following options:

.RS
.B \-\-annotate\-script
.br
.B \-\-context\-script
.br
.B \-\-criteria\-script
.br
.B \-\-resolve\-script
.br
.B \-\-select\-script
.br
.B \-\-version\-script
.br
.RE

While each script performs a separate function there are some common aspects
in the way these options are handled:

.IP 1. 3
If the callback script name ends in
.B \.pm
then the script is assumed to be a Perl module.
.br
A perl module may offer performance advantages over an external script, as it is compiled once and loaded into the interpreter and because it can load and maintain internal state.
.br
The module is expected to export a method 'new', which is
called with the script name and the script parameters (if any) as arguments.  It is expected to return an object which implements several standard methods:
.br
.I $callback_obj = packagename\-\>new(perl_module_file, args);
.RS 3
.IP version\-script 3
.I $version = $callback_obj->extract_version($source_file_ename);
.br
.I $match = $callback_obj->check_version($old_version, $new_version, $source_file_name);
.br
.RS
.IP $match 3
 is expected to be 1 (true) if the version keys refer to the came file and 0 (false) otherwise.
.PP

.IP $version 3
 is a string representing a unique identifier of the particular version of the file
.PP
.RE

See example implementations
.I $LCOV_HOME/share/lcov/support-scripts/gitversion.pm
and
.I $LCOV_HOME/share/lcov/support-scripts/getp4version.pm.
.PP
.IP annotate\-script 3
.I ($status, $array) = $callback_obj->annotate($source_file_name);
.br
.br
.br

where
.RS
.IP $status 3
 is 0 if the command succeeded and nonzero otherwise.
.I $status
is interpreted in same way as the return code from 'system(..)'
.PP
.IP $array 3
is a list of line data of the form:
.br
.I [$text, $abbrev, $full_name, $when, $changelist].
.PP
.br

and

.IP $text 3
is the source text from the corresponding line (without newline termination)
.PP
.IP $abbrev 3
is the "abbreviated author name" responsible for this line of code.  This is the name that will be used in the various HTML tables.  For example, for brevity/readability, you may want to strip the domain from developers who are inside your organization.  If there is no associated author, then the value should be
.I \"NONE\".
.PP
.IP $full_name 3
is the "full author name" which is used in annotation tooltips.  See the
.I genhtml_annotate_tooltip
entry in man
.B lcovrc(5).
.I $fullname
may be
.I undef
if the full name and abbreviated names are the same.
.PP
.IP $when 3
is the timestamp associated with the most recent edit of the corresponding
line and may be
.I \"NONE\"
if there is no associated time.
.PP
.IP $changelist 3
is the commit identifier associated with the most recent change to this line, or
.I \"NONE\"
if there isn't one.
.PP


See example implementations
.I $LCOV_HOME/share/lcov/support-scripts/gitblame.pm
and
.I $LCOV_HOME/share/lcov/support-scripts/p4annotate.pm.
.RE

.IP context\-script
.I $hash = $callback_obj->context();
.br
.br

where
.I $hash
is a reference to a hash of key/value pairs which are meaningful to you.
This data is stored in the
.I profile
database.  See the 'profile' section in man
.B lcovrc(5)
for more information.

If your callback is not a perl module - for example, is a shellscript - then it should return a string such that the first word on each line is the key and the remainder is the associated data.  If a key is repeated, then the corresponding data strings are concatenated, separated by newline.

If you want to record only system information, then a shell callback is likely sufficient.  If you want to record any tool-specific/internal information, then you will need to implement a perl module so that your callback will be able to access the information.
Note that the constructor of your
.I context-script
callback (or of any callback) can perform any additional actions which
are required - for example, to write additional files, to query or set
tool-specific information,
.I etc.
For example, the example implementation, below, has an option to append
comments to the generated .info file.


See the example implementation
.I $LCOV_HOME/share/lcov/support-scripts/context.pm.
.RE



.IP criteria\-script
.I ($status, $array) = $callback_obj->check_criteria($obj_name, $type, $json);
.br
.br

where
.RS
.IP $obj_name 3
is the source file or directory name, or \"top\" of the object whose coverage criteria is being checked.
.PP
.IP $type 3
is the object type - either
.I \"file\", \"directory\", or \"top\".
.PP
.IP $json 3
is the coverage data associated with this object, in JSON format - see below.
.PP
.IP $status 3
is the return status of the operation, interpreted the same way as the
.I annotate
callback status, described above.
.PP
.IP $array 3
is a reference to a possibly empty list of strings which will be reported by genhtml.  The strings are are expected to explain why the coverage criteria failed.
.PP

See example implementations
.I $LCOV_HOME/share/lcov/support-scripts/criteria.pm.
.RE

.IP resolve\-script
$newpath = $callback_obj->resolve($source_file_name)
.br
.br

where
.I $newpath
is the correct path to the indicated source file or
.I undef
if the source file is not found by the callback.
.PP

.RE

.IP 2. 3
The option may be specified as a single
.I split_char
separated string which is divied into words (see
.B man lcovrc(5)
), or as a list of arguments.
The resulting command line is passed
to a shell interpreter to be executed.
The command line includes the script path followed by optional additional parameters
separated by spaces. Care must be taken to provide proper quoting if script
path or any parameter contains spaces or shell special characters.
.PP

.IP 3. 3
If an option is specified multiple times, then the parameters are
.I not
split, but are simply concatenated to form the command line - see the examples, below.
.br
For simplicity and ease of understanding:  your command line should
pass all arguments individually, or all as a comma-separated list - not a mix of the two.
.PP

.IP 4. 3
.B genhtml
passes any additional parameters specified via option arguments
between the script path and the parameters required by the script's function.
.br
.PP

Example:
.br

.RS
genhtml --annotate-script /bin/script.sh
.br
        --annotate-script arg0 ...
.br

results in the same callback as

.br
genhtml --annotate-script "/bin/script.sh arg0" ...
.br

or

.br
genhtml --annotate-script /bin/script.sh,arg0 ...
.br

Note that the first form is preferred.

.RE

The resulting
.B genhtml
callback executes the command line:
.br

.RS
/bin/script.sh arg0
.I source_file_name
.RE
.br

Similarly
.br
.RS
genhtml --annotate-script
.I /bin/myMoodule.pm
.br
        --annotate-script arg0 --annotate-script arg1 ...
.br

or
.br
genhtml --annotate-script
.I /bin/myMoodule.pm,arg0,arg1
.br

.br
.RE

result in
.B genhtml
executing
.br

.RS
$annotateCallback = myModule->new(arg0, arg1);
.RE

to initialize the class object -
.I arg0
and
.I arg1
passed as strings - and then to execute

.RS
($status, $arrayRef) = $annotateCallback(
.I source_file_name
);
.RE

to retrieve the annotation information.

In contrast, the command
.br
.RS
genhtml --annotate-script
.I /bin/myMoodule.pm
.br
        --annotate-script arg0,arg1 ...
.RE
would result in
.B genhtml
initializing the callback object via
.br

.RS
$annotateCallback = myModule->new("arg0,arg1");
.RE
where "arg0,arg1" is passed as single comma-separated string.

Similarly, the command
.br
.RS
genhtml --annotate-script
.I /bin/myMoodule.pm,arg0
.br
        --annotate-script arg1 ...
.RE
would very likely result in an error when genhtml tries to find
a script called "/bin/mymodule.pm,arg0".


Note that multiple instances of each script may execute simultaneously if the
.B \-\-parallel
option was specified. Therefore each script must either be reentrant or should arrange for its own synchronization, if necessary.
.br
In particular, if your callback is implemented via a perl module:
.IP \- 3
the class object associated with the module will initialized once (in the parent process)
.PP
.IP \- 3
The callback will occur in the child process (possibly simultaneously with other child processes).
.PP
As a result:  if your callback needs to pass data back to the parent, you will need to arrange a communication mechanism to do so.
.br

.SS Additional considerations

If the
.B \-\-criteria\-script
option is used, genhtml will use the referenced script to determine whether your coverage criteria have been met - and will return a non\-zero status and print a message if the criteria are not met.
.br

The
.B \-\-version\-script
option is used to verify that the same/compatible source code versions are displayed as were used to capture coverage data, as well as to verify that the same source code was used to capture coverage information which is going to be merged and to verify that the source version used for filtering operations is compatible with the version used to generate the data.

HTML output files are created in the current working directory unless the
.B \-\-output\-directory
option is used. If
.I tracefile
or
.I baseline\-file
ends with ".gz", it is assumed to be GZIP\-compressed and the gunzip tool
will be used to decompress it transparently.

Note that all source code files have to be present and readable at the
exact file system location they were compiled, and all path references in the input data ".info" and "diff" files must match exactly (i.e., exact string match).
.br

Further, the
.BR \-\-version\-script ", " \-\-annotate\-script ", and " \-\-criteria\-script " scripts "
use the same path strings. However, see the
.B \-\-substitute
and
.B \-\-resolve\-script
options for a mechanism to adjust extracted paths so they match your source and/or revision control layout.

.br
You can use the
.BR check_exisitence_before_callback
configuration option to tell the tool to check that the file exists before
calling the
.BR \-\-version\-script
or
.BR \-\-annotate\-script
callback. See man
.B lcovrc(5)
for details.
.br

.SS Additional options

Use option
.B \-\-diff\-file
to supply a unified diff file that represents the changes to the source
code files between the version used to compile and capture the baseline
trace files, and the version used to compile and capture the current
trace files.

Use option
.B \-\-css\-file
to modify layout and colors of the generated HTML output. Files are
marked in different colors depending on the associated coverage rate.
.br

By default, the coverage limits for low, medium and high coverage are set to
0\-75%, 75\-90% and 90\-100% percent respectively. To change these
values, use configuration file options.
.br

.RS
.IR genhtml_hi_limit " and " genhtml_med_limit
.RE
.br

or type-specific limits:
.br

.RS
.IR genhtml_line_hi_limit " and " genhtml_line_med_limit
.br
.IR genhtml_branch_hi_limit " and " genhtml_branch_med_limit
.br
.IR genhtml_function_hi_limit " and " genhtml_function_med_limit
.br
.RE

See man
.B lcovrc(5)
for details.

Also note that when displaying percentages, 0% and 100% are only printed when
the values are exactly 0% and 100% respectively. Other values which would
conventionally be rounded to 0% or 100% are instead printed as nearest
non\-boundary value. This behavior is in accordance with that of the
.BR gcov (1)
tool.

By default,
.B genhtml
reports will include both line and function coverage data.
Neither branch or MC/DC data is displayed by default; you can use the
.B \-\-branch\-coverage
and
.B \-\-mcdc\-coverage
options to enable branch or MC/DC coverage, respectively - or you can permanently enable branch coverage by adding the appropriate
settings to your personal, group, or site lcov configuration file.  See the
.B branch_coverage
and
.B mcdc_coverage
sections of man
.B lcovrc(5)
for details.


.SH OPTIONS

In general, (almost) all
.B genhtml
options can also be specified in your personal, group, project, or site
configuration file - see man
.B lcovrc(5)
for details.


.B \-h
.br
.B \-\-help
.RS
Print a short help text, then exit.

.RE
.B \-\-version
.RS
Print version number, then exit.

.RE
.B \-v
.br
.B \-\-verbose
.RS
Increment informational message verbosity.  This is mainly used for script and/or flow debugging - e.g., to figure out which data files are found, where.
Also see the \-\-quiet flag.

.RE
.B \-q
.br
.B \-\-quiet
.RS
Decrement informational message verbosity.

Decreased verbosity will suppress 'progress' messages for example - while error and warning messages will continue to be printed.

.RE
.B \-\-debug
.RS
Increment 'debug messages' verbosity.  This is useful primarily to developers who want to enhance the lcov tool suite.

.RE
.B \-\-validate
.RS
Check the generated HTML to verify that there are no dead hyperlinks and no unused files in the output directory.
The checks can also be enabled by setting environment variable
.B LCOV_VALIDATE = 1.
This option is primarily intended for use by developers who modify the HTML report.

.RE
.B \-\-flat
.br
.B \-\-hierarchical
.RS
Use the specified HTML report hierarchy layout.
.br

The default HTML report is 3 levels:

.RS 2
.IP 1. 3
.B top\-level:
table of all directories,
.PP

.IP 2. 3
.B directory:
table of source files in a directory, and
.PP

.IP 3. 3
.B source file detail:
annotated source code.
.PP
.RE

Option
.B \-\-hierarchical
produces a multilevel report which follows the directory structure of the
source code (similar to the file tool in Microsoft Windows).

Option
.B \-\-flat
produces a two-level HTML report:

.RS 2
.IP 1. 3
.B top\-level:
table of all project source files, and
.PP

.IP 2. 3
.B source file detail:
annotated source code.
.PP
.RE

The 'flat' view can reduce the number of clicks required to navigate around
the coverage report - but is unwieldy except for rather small projects consisting of only a few source files.  It can be useful in 'code review' mode, even for very large projects (see the
.I \-\-select\-script
option).
.br
Most large projects follow a rational directory structure - which favors the 'hierarchical' report format.  Teams responsible for a particular module can focus on a specific subdirectory or set of subdirectories.

Only one of options
.B \-\-flat
or
.B \-\-hierarchical
can be specified at the same time.

These options can also be persistently set via the lcovrc configuration file
using either:
.br

.RS
.I genhtml_hierarchical
= 1
.br
.RE

or
.br

.RS
.I genhtml_flat_view
= 1
.br
.RE

See man
.B lcovrc(5)
for details.

.RE
.B \-f
.br
.B \-\-frames
.RS
Use HTML frames for source code view.

If enabled, a frameset is created for each source code file, providing
an overview of the source code as a "clickable" image. Note that this
option will slow down output creation noticeably because each source
code character has to be inspected once. Note also that the GD.pm Perl
module has to be installed for this option to work (it may be obtained
from http://www.cpan.org).

This option can also be controlled from the
.I genhtml_frames
entry of the
.B lcovrc
file.

Please note that there is a bug in firefox and in chrome, such that
enabling frames will disable hyperlinks from the 'directory' level summary
table entry to the first line in the corresponding file in the particular
category - e.g., to the first 'MIS' line (vanilla coverage report - see the
.i \-\-show\-navigation
option, below), to
the first 'UNC' branch (differential coverage report), etc.
Hyperlinks from the summary table at the top of the 'source detail' page are not affected.

.RE
.B \-s
.br
.B \-\-show\-details
.RS
Generate detailed directory view.

When this option is enabled,
.B genhtml
generates two versions of each source file file entry in the corresponding summary table:
.IP
one containing the standard information plus a link to a
"detailed" version, and
.PP
.IP
a second which contains the number of coverpoints in the hit by each
testcase.
.br
Note that missed coverpoints are not shown in the per-testcase table entry data.
.PP

The corresponding summary table is found on the 'directory' page of the default 3-level genthm report, or on the top-level page of the 'flat' report (see
.I genhtml \-\-flat ...
), or on the parent directory page of the 'hierarchical' report (see
.I genhtml \-\-hierarchical ...
).

Note that this option may significantly increase memory consumption.

.RE
.BI "\-b " baseline\-file\-pattern
.br
.BI "\-\-baseline\-file " baseline\-file\-pattern
.RS
Use data in the files found from glob pattern
.I baseline\-file\-pattern
as coverage baseline.

.B \-\-baseline\-file
may be specified multiple times - for example, if you have multiple trace data files for each of several test suites and you do not want to go through the additional step of merging all of them into a single aggregated data file.

The coverage data files specified by
.I baseline\-file\-pattern
is read and used as the baseline for classifying the change in coverage represented by the coverage counts in
.IR tracefile\-patterns .
If
.I baseline\-file\-pattern
is a directory, then genhtml will search the directory for all files ending in '.info'.
See the
.I info_file_extension
section in
.B man(5) lcovrc
for how to change this pattern.

In general, you should specify a diff file in unified diff format via
.B \-\-diff\-file
when you specify a
.IR \-\-baseline\-file\-pattern .
Without a diff file, genhtml will assume that there are no source differences
between 'baseline' and 'current'.
For example:  this might be used to find
incremental changes caused by the addition of more testcases, or to compare
coverage results between gcc versions, or between gcc and llvm.

.RE
.BI "\-\-baseline\-title " title
.RS
Use
.I title
as the descriptive label text for the source of coverage baseline data.

.RE
.BI "\-\-baseline\-date " date
.RS
Use
.I date
as the collection date in text format for the coverage baseline data.
If this argument is not specified, the default is to use the creation time of the first file matched by
.I baseline\-file\-pattern
as the baseline date.  If there are multiple baseline files, then the creation date of the first file is used.

.RE
.BI "\-\-current\-date " date
.RS
Use
.I date
as the collection date in text format for the coverage baseline data.
If this argument is not specified, the default is to use the creation time of the current
.IR tracefile .

.RE
.BI "\-\-diff\-file " diff\-file
.RS
Use the
.I diff\-file
as the definition for source file changes between the sample points for
.I baseline\-file\-pattern
and
.IR tracefile(s) .
.br


Note:

.IP - 3
if filters are applied during the creation of a differential coverage report,
(see the
,I \-\-filter
section, below), then those filters will be applied to the
.I baseline coverage data
(see the
.I \-\-baseline\-file
section, above) as well as to the
.I current coverage data.
It is important that the
.I diff-file
accurately reflect all source code changes so that the baseline coverage data can be correctly filtered.
.PP

.IP - 3
Best practice is to use a
.I \-\-version\-script
callback to verify that source versions match before source-based filtering is applied.
.PP

It is almost always a better idea to filter at capture or aggregate time - not at report generation.

A suitable
.I \"universal diff\"
input file for the
.I \-\-diff\-file
option
can be generated using either the "p4udiff" or "gitdiff" sample scripts that are provided as part of this package, or by using revision control commands directly.

The "p4udiff" or "gitdiff" sample scripts are found in:

.RS
\*[scriptdir]/p4udiff
.br
.RE

and

.RS
\*[scriptdir]/gitdiff
.br
.RE


These scripts simply post\-process the 'p4' or 'git' output to (optionally) remove files that are not of interest and to explicitly note files which have not changed.

.B p4udiff
accepts either a changelist ID or the literal string "sandbox"; "sandbox" indicates that there are modified files which have not been checked in.
See "
.I gitdiff \-\- help
" and "
.I p4udiff \-\- help
" for more information.

It is useful to note unchanged files denoted by lines of the form:
.br

.RS
diff [optional header strings]
.br
=== file_path
.RE
.br

in the p4diff/gitdiff output as this knowledge will help to suppress spurious 'path mismatch' warnings.  See the
.B \-\-elide\-path\-mismatch
and
.B \-\-build\-directory
entries, below.

In general, you will specify
.B \-\-baseline\-file
when you specify
.BR \-\-diff\-file .
The
.I baseline_files
are used to compute coverage differences (
.I e.g.
gains and losses) between the baseline and current, where the
.I diff_file
is used to compute code changes:  source text is
identical between 'baseline' and 'current'.
If you specify
.I baseline_files
but no
.I diff_file,
the tool will assume that there are no code changes between baseline and current.
If you specify a
.I diff_file
but no
.I baseline_files,
the tool will assume that there is no baseline coverage data (no baseline code was covered); as result unchanged code (
.I i.e.,
which does not appear in the
.I diff_file
will be categorized as eiher GIC (covered) or UIC (not covered) while new or changed code will be categorized as either GNC or UNC.

.RE
.BI "\-\-annotate\-script " script
.RS
Use
.I script
to get source code annotation data.

Use this option to specify an external tool or command line that
.B genhtml
can use to obtain source code annotation data such as age and author of the last
change for each source code line.
.br

This option also instructs
.B genhtml
to add a summary table to the HTML report header that shows counts in the various coverage categories, associated with each date bin. In addition, each source code line will show age and owner information.
Annotation data is also used to populate a 'tooltip' which appears when the mouse
hovers over the associated source code.  See the
.I genhtml_annotate_tooltip
entry in man
.B lcovrc(5)
for details.
.br

The specified
.I script
is expected to obtain age and ownership information
for each source code line from the revision management system and to output
this information in the format described below.
.br

If the annotate script fails and annotation errors are ignored via
.BR --ignore-errors ,
then
.B genhtml
will try to load the source file normally.  If the file is not present or not readable, and the
.B \-\-synthesize\-missing
flag is specified, then
.B genhtml
will synthesize fake data for the file.
.br

.B genhtml
will emit an error if you have specified an annotation script but no files are
successfully annotated (see below).
This can happen, for example, if your P4USER, P4CLIENT,
or P4PORT environment variables are not set correctly -
.I e.g. if the
Jenkins user who generates coverage reports is not the same and the user
who checked out the code and owns the sandbox.
.br

Sample annotation scripts for Perforce ("p4annotate") and git ("gitblame")
are provided as part of this package in the following locations:
.br

.RS
\*[scriptdir]/p4annotate
.br
.RE

and
.br

.RS
\*[scriptdir]/gitblame
.br
.RE

Note that these scripts generate annotations from the file version checked in to the repository - not the locally modified file in the build directory.  If you need annotations for locally modified files, you can shelve your changes in P4, or check them in to a local branch in git.

.B "Creating your own script"
.br

When creating your own script, please first see
.B "Script considerations"
above for general calling conventions and script requirements.
.br

.I script
is called by genhtml with the following command line:

.RS
.B script
.I "[additional_parameters] " source_file_name
.RE
.br

where

.RS
.B script
.br
.RS
is the script executable
.br
.RE

.B additional_parameters
.br
.RS
includes any optional parameters specified (see
.B "Script conventions"
above)
.br
.RE

.B source_file_name
.br
.RS
is the source code file name
.br
.RE
.RE

The
.I script
executable should output a line to the standard output stream in the following format for each line in file
.IR source_file_name :
.br

.RS
.IR commit_id | author_data | date | source_code
.br
.RE

where

.RS
.B commit_id
.br
.RS
is an ID identifying the last change to the line or NONE if this file is not
checked in to your revision control system.
.br
.B genhtml
counts the file as not 'successfully annotated' if
.B commit_id
is
.I NONE
and as 'successfully annotated' otherwise.
.br
.RE
.br

.B author_data
.br
.RS
identifies the author of the last change.
.br
For backward compatibility with existing annotate-script implementations,
two
.I author_data
formats are supported:
.IP - 3
.I string
:  the string used as both the 'abbreviated name' (used as 'owner' name in
HTML output and callbacks) and as 'full name' (used in tooltip callbacks)
.PP
.IP - 3
.I abbrev_string;full_name
: the
.I author_data
string contains both an 'abbreviated name' and a 'full name' - separated by a semicolon character (';').
.br
This is useful when generating coverage reports for opensource software
components where there are many 'External' contributors who you do not want
to distinguish in 'owner' summary tables but you still want to know who the
actual author was.  (See the
.B gitblame
callback script for an example.)
.PP
.br
.RE
.br

.B date
.br
.RS
is the data of last change in W3CDTF format (<YYYY>-<MM>-<DD>T<hh>:<mm>:<ss><TZD>)
.br
.RE
.br

.B source_code
.br
.RS
is the line's source code
.br
.RE
.br
.RE

The script should return 0 (zero) if processing was successful and non\-zero if it encountered an error.
.br

.RE
.BI "\-\-criteria\-script " script
.RS
Use
.I script
to test for coverage acceptance criteria.
.br

Use this option to specify an external tool or command line that
.B genhtml
can use to determine if coverage results meet custom acceptance criteria.
Criteria checking results are shown in the standard output log of
.BR genhtml .
If at least one check fails,
.B genhtml
will exit with a non-zero exit code after completing its processing.
.br

A sample coverage criteria script is provided as part of this package in the
following location:

.RS
\*[scriptdir]/criteria
.br
.RE

The sample script checks that top\-level line coverage meets the criteria "UNC + LBC + UIC == 0" (added code and newly activated code must be tested, and existing tested code must not become untested).
.br

As another example, it is possible to create scripts that mimic the
.B "lcov \-\-fail\-under\-lines"
feature by checking that the ratio of exercised lines to total lines ("(GNC + GIC + CBC) / (GNC + GIC + CBC + UNC + UIC + UBC)") is greater than the threshold - either only at the top level, in every directory, or wherever desired. Similarly, criteria may include branch and function coverage metrics.
.br

By default the criteria script is called for all source code hierarchy levels, i.e.: top-level, directory, and file-level. The
.I criteria_callback_levels
configuration file option can be used to limit the hierarchy levels to any combination of 'top', 'directory', or 'file' levels.
.br

Example:
.br

.RS
genhtml --rc criteria_callback_levels=directory,top ...
.br
.RE

You can increase the amount of data passed to the criteria script using
configuration file option
.IR criteria_callback_data .
By default, only total counts are included. Specifying "date" adds per
date-bin counts, "owner" adds per owner-bin counts.
.br

Example:
.br

.RS
genhtml --rc criteria_callback_data=date,owner ...
.br
.RE

See man
.B lcovrc(5)
for more details.

.B "Creating your own script"
.br

When creating your own script, please first see
.B "Script considerations"
above for general calling conventions and script requirements.
.br

.I script
is run with the following command line for each source code file,
leaf\-directory, and top-level coverage results:

.RS
.B script
.I "[additional_parameters] " "name " " type"
.I "coverage_data"
.br
.RE

where

.RS
.B script
.br
.RS
is the script executable
.br
.RE

.B additional_parameters
.br
.RS
includes any optional parameters specified (see
.B "Script conventions"
above)
.br
.RE

.B name
.br
.RS
is the name of the object for which coverage criteria should be checked,
that is either the source code file name, directory name, or "top" if the
script is called for top-level data
.br
.RE

.B type
.br
.RS
is the type of source code object for which coverage criteria should be
checked, that is one of "file", "directory", or "top"
.br
.RE

.B coverage_data
.br
.RS
is either a coverage data hash or a JSON representation of coverage data hash of the corresponding source code
object.
If the callback is a Perl module, then the it is passes a hash object - other wise, it is passed a JSON representation of that data.
.br
.RE
.RE

The JSON data format is defined as follows:
.br

{
.br
  "<type>": {
.br
    "found": <count>,
.br
    "hit": <count>,
.br
    "<category>": <count>,
.br
    ...
.br
  },
.br
  "<bin_type>": {
.br
    "<bin_id>" : {
.br
      "found": <count>,
.br
      "hit": <count>,
.br
      "<category>": <count>,
.br
      ...
.br
    },
.br
    ...
.br
  },
.br
  ...
.br
}
.br

where

.RS
.B type
.br
.RS
specifies the type of coverage as one of "line", "function", or "branch"
.br
.RE

.B bin_type
.br
.RS
specifies the type of per-bin coverage as one of "line_age", "function_age", or "branch_age" for date-bin data, and "line_owners" or "branch_owners" for owner-bin data
.br
.RE

.B bin_id
.br
.RS
specifies the date-bin index for date-bin data, and owner ID for owner-bin data.
.br
.RE

.B found
.br
.RS
defines the number of found lines, functions, or branches
.br
.RE

.B hit
.br
.RS
defines the number of hit lines, functions, or branches
.br
.RE

.B category
.br
.RS
defines the number of lines, functions, or branches that fall in the specified
category (see
.B "Differential coverage"
above)
.br
.RE

.RE

Note that data is only reported for non-empty coverage types and bins.
.br

The script should return 0 (zero) if the criteria are met and non\-zero otherwise.
.br

If desired, it may print a single line output string which will be appended to the error log if the return status is non\-zero.  Additionally, non\-empty lines are appended to the genhtml standard output log.
.br

.RE

.B \-\-version\-script
.I script
.br
.RS
Use
.I script
to get source code file version data.

Use this option to specify an external tool or command line that
.B genhtml
can use to obtain a source code file's version ID when generating HTML or
applying source filters (see
.B \-\-filter
option).
.br

A version ID can be a file hash or commit ID from revision control. It is used to check the version of the source file which is loaded against the version which was used to generate coverage data (i.e., the file version seen by lcov/geninfo). It is important that source code versions match - otherwise inconsistent or confusing results may be produced.
.br

Version mismatches typically happen when the tasks of capture, aggregation, and report generation are split between multiple jobs - e.g., when the same source code is used in multiple projects, a unified/global coverage report is required, and the projects accidentally use different revisions.
.br

If your .info (coverage data) file does not contain version information - for example, because it was generated by a tool which did not support versioning - then you can use the
.I compute_file_version " = 1"
config file option to generate the data afterward.  A convenient way to do this might be to use
.B lcov
.I \-\-add\-tracefile
to read the original file, insert version information, and write out the result.
See man
.B lcovrc(5)
for more details.


Sample scripts for Perforce ("getp4version"), git ("gitversion") and using an md5 hash ("get_signature") are provided as part of this package in the following locations:
.br

.RS
.I \*[scriptdir]/getp4version
.RE
.br

.RS
.I \*[scriptdir]/gitversion
.RE
.br

and
.br

.RS
.I \*[scriptdir]/get_signature
.RE
.br

Note that you must use the same script/same mechanism to determine the file version when you extract, merge, and display coverage data - otherwise, you may see spurious mismatch reports.
.br

.B "Creating your own script"
.br

When creating your own script, please first see
.B "Script considerations"
above for general calling conventions and script requirements.
.br

.I "script "
is used both to generate and to compare the version ID to enable retaining history between calls or to do more complex processing to determine equivalence.
It will be called by
.B genhtml
with either of the following command lines:
.br

1. Determine source file version ID
.br

.RS
.BI script " source_file_name"
.RE
.br

It should write the version ID of
.I " source_file_name "
to stdout and return a 0 exit status.
If the file is not versioned, it should write an empty string and return a 0 exit status.
.br

2. Compare source file version IDs

.RS
.B script \-\-compare
.I " source_file_name source_file_id"
.br
.I "                  info_file_id"
.br

.RE
where
.RS
.br

.B "source_file_name"
.RS
is the source code file name
.RE
.br

.B "source_file_id "
.RS
is the version ID returned by calling "script source_file_name"
.RE
.br

.B "info_file_id "
.RS
is the version ID found in the corresponding .info file
.RE
.RE
.br

It should return non\-zero if the IDs do not match.
.br

.RE

.B \-\-resolve\-script
.I script
.br
.RS
Use
.I script
to find the file path for some source file which which appears in
an input data file if the file is not found after applying
.I \-\-substitute
patterns and searching the
.I \-\-source\-directory
list.  This option is equivalent to the
.B resolve_script
config file option. See man
.B lcovrc(5)
for details.
.RE

.B \-\-select\-script
.I callback
.br
.RS
Use
.I callback
to decide whether a particular source line is interesting and should be
included in the output data/generated report or not.

This option is equivalent to the
.B select_script
config file option. See man
.B lcovrc(5)
for details.
.RE

.BI "\-\-checksum "
.RS
Specify whether to compare stored tracefile checksum to checksum computed from the source code.

Checksum verification is
.B disabled
by default.

When checksum verification is enabled, a checksum will be computed for each source
code line and compared to the checksum found in the 'current' tracefile.
This will help to prevent attempts to display source code which is not identical
to the code used to generate the coverage data.

Note that this option is somewhat subsumed by the
.B \-\-version\-script
option - which does something similar, but at the 'whole file' level.

.RE
.B \-\-fail\-under\-branches
.I percentage
.br
.RS
Use this option to tell genhtml to exit with a status of 1 if the total
branch coverage is less than
.I percentage.
See
.B man lcov(1)
for more details.

.RE
.B \-\-fail\-under\-lines
.I percentage
.br
.RS
Use this option to tell genhtml to exit with a status of 1 if the total
line coverage is less than
.I percentage.
See
.B man lcov(1)
for more details.


.RE
.B \-\-new\-file\-as\-baseline
.RS
By default, when code is identified on source lines in the 'current' data which were not identified as code in the 'baseline' data, but the source text has not changed, their coverpoints are categorized as "included code":
.I GIC
or
.I UIC.
.br

However, if the configuration of the coverage job has been recently changed to instrument additional files, then all un\-exercised coverpoints in those files will fall into the
.I GIC
category - which may cause certain coverage criteria checks to fail.
.br

When this option is specified, genhtml pretends that the baseline data for the file is the same as the current data - so coverpoints are categorized as
.I CBC
or
.I UBC
which do not trigger the coverage criteria check.

Please note that coverpoints in the file are re\-categorized only if:

.RS
.IP \(bu 3
There is no 'baseline' data for any coverpoint in this file, AND
.PP
.IP \(bu 3
The file pre\-dates the baseline:  the oldest line in the file is older than the 'baseline' data file (or the value specified by the
.B \-\-baseline\-date
option).
.PP
.RE

.RE
.BI "\-\-elide\-path\-mismatch"
.RS
Differential categorization uses file pathnames to match coverage entries from the ".info" file with file difference entries in the unified\-diff\-file.  If the entries are not identical, then categorization may be incorrect or strange.

When paths do not match, genhtml will produce "path" error messages to tell you about the mismatches.

If mismatches occur, the best solution is to fix the incorrect entries in the .info and/or unified\-diff\-file files.  However, fixing these entries is not possible, then you can use this option to attempt to automatically work around them.
.br

When this option is specified, genhtml will pretend that the unified\-diff\-file entry matches the .info file entries if:

.RS
.IP \(bu 3
the same path is found in both the 'baseline' and 'current' .info files, and
.PP
.IP \(bu 3
the basename of the path in the .info file and the path in the unified\-diff\-file are the same, and
.PP
.IP \(bu 3
there is only one unmatched unified\-diff\-file entry with that basename.
.PP
.RE

See the
.B \-\-diff\-file
and
.B \-\-build\-directory
entries for a discussion of how to avoid spurious warnings and/or incorrect matches.

.RE
.BI "\-\-synthesize\-missing"
.RS
Generate (fake) file content if source file does not exist.
This option can be used to work around otherwise fatal annotation errors.

When generating annotated file content,
.B genhtml
assumes that the source was written 'now' (so age is zero), the author is
.I no.body
and the commit ID is
.I synthesized.
These names and ages will appear in your HTML reports.

.br
This option is equivalent config file
.I genhtml_synthesize_missing
parameter; see man
.B lcovrc(5)
for details.


.RE
.BI "\-\-date\-bins " day[,day,...]
.RS
The
.B \-\-date\-bins
option is used to specify age boundaries (cutpoints) for date\-binning classification.  Each
.I age
element is expected to be an integer number of days prior to today (or prior to your SOURCE_DATE_EPOCH environment variable, if set).  If
.I \-\-date\-bins is not specified, the default is to use 4 age ranges: less than 7 days, 7 to 30 days, 30 to 180 days, and more than 180 days.
This option is equivalent to the
.I genhtml_date_bins
config file option.  See man
.B lcovrc(5).

This argument has no effect if there is no
.I source\-annotation\-script .

.RE
.BI "\-\-date\-labels " string[,string,...]
.RS
The
.B \-\-date\-labels
option is used to specify labels used for the 'date\-bin' table entries in the HTML report.
.br
The number of labels should be one greater than the number of cutpoints.
.br
If not specified, the default is to use label strings which specify the
.I [from ..to)
range of ages held by the corresponding bin.

One possible use of this option is to use release names in the tables -
.I i.e.,
to indicate the release in which each particular line first appeared.

This option is equivalent to the
.I genhtml_date_labels
config file option.  See man
.B lcovrc(5).

This argument has no effect if there is no
.I source\-annotation\-script .

.RE
.BI "\-\-show\-owners " [all]
.RS
If the
.B \-\-show\-owners
option is used, each coverage report header report contain a summary table, showing counts in the various coverage categories for everyone who appears in the revision control annotation as the most recent editor of the corresponding line.  If the optional argument 'all' is not specified, the table will show only users who are responsible for un\-exercised code lines.  If the optional argument is specified, then users responsible for any code lines will appear.  In both cases, users who are responsible for non\-code lines (e.g, comments) are not shown.
This option does nothing if
.B \-\-annotate\-script
is not used; it needs revision control information provided by calling the script.

Please note: if the
.I all
option is not specified, the summary table will contain "Total" rows for all date/owner bins which are not empty - but there will be no secondary "File/Directory" entries for elements which have no "missed" coverpoints.

.br
This option is equivalent config file
.I genhtml_show_owner_table
parameter; see man
.B lcovrc(5)
for details.

The lcovrc controls
.I owner_table_entries
and
.I truncate_owner_table
can be used to improve readability by limiting the number of authors who are displayed in the table
when the author number is large.
For example, if your configuration is:
.RS
.PP
.I owner_table_entries = 5
.IP
.PP
.I truncate_owner_table = top,directory
.PP
.RE
then the owner table displayed at the top- and directory-levels will be truncated while the table shown at the 'file' level will display the full list.

See man
.B lcovrc(5)
for details.


.RE
.BI "\-\-show\-noncode "
.RS
By default, the source code detail view does not show owner or date annotations in the far-left column for non\-code lines (e.g., comments). If the
.B \-\-show\-noncode
option is used, then the source code view will show annotations for both code and non\-code lines.
This argument has no effect if there is no
.I source\-annotation\-script .

.br
This option is equivalent config file
.I genhtml_show_noncode_owners
parameter; see man
.B lcovrc(5)
for details.


.RE
.BI "\-\-show\-zero\-columns "
.RS
By default, columns whose entries are all zero are removed (not shown) in the summary table at the top of each HTML page.
If the
.B \-\-show\-zero\-columns
option is used, then those columns will be shown.

When columns are retained, then all the tables have the same width/contain the same number of columns - which may be a benefit in some situations.

When columns are removed, then the tables are more compact and easier to read.
This is especially true in relatively mature development environments, when there are very few un-exercised coverpoints in the project.

.RE
.BI "\-\-show\-navigation "
.RS
By default, the summary table in the source code detail view does not contain hyperlinks from the number to the first line in the corresponding category ('Hit' or 'Missed') and from the current location to the next location in the current category, in non-differential coverage reports.  (This is the lcov 'legacy' view non-differential reports.)

If the
.B \-\-show\-navigation
option is used, then the source code summary table will be generated with navigation links.
Hyperlinks are always generated for differential coverage reports.

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

See the
.I \-\-frames
description above for a description of a browser bug which disables
these hyperlinks in certain conditions.

Navigation hyperlinks are always enabled in differential coveage report.

.RE
.BI "\-\-show\-proportions "
.RS
In the 'function coverage detail' table, also show the percentage of lines and branches within the function which are exercised.

This feature enables developers to focus attention on functions which have the largest effect on overall code coverage.

This feature is disabled by default.
Note that this option requires that you use a compiler version which is new enough to support function begin/end line reports or that you configure the tool to derive the required data - see the
.BI derive_function_end_line
discussion in man
.B lcovrc(5).


.RE
.BI "\-\-simplified\-colors "
.RS
By default, each differential category is colorized uniquely in the source code detail view.  With this option, only two colors are used:  one for covered code and another for uncovered code.  Note that ECB and EUB code is neither covered nor uncovered - and so may be difficult to distinguish in the source code view, as they will be presented in normal background color.

.RE
.BI "\-\-exclude "
.I pattern
.RS
pattern is a glob\-match pattern of filenames to exclude from the report.
Files which do NOT match will be included.
See the lcov man page for details.

.RE
.BI "\-\-include "
.I pattern
.RS
pattern is a glob\-match pattern of filenames to include in processing.
Files which do not match will be excluded from the report.
See the lcov man page for details.
.RE

.B \-\-erase\-functions
.I regexp
.br
.RS
Exclude coverage data from lines which fall within a function whose name matches the supplied regexp.  Note that this is a mangled or demangled name, depending on whether the
.B \-\-demangle\-cpp
option is used or not.

Note that this option requires that you use a compiler version which is new enough to support function begin/end line reports or that you configure the tool to derive the required data - see the
.BI derive_function_end_line
discussion in man
.B lcovrc(5).


.RE
.B \-\-substitute
.I regexp_pattern
.br
.RS
Apply Perl regexp
.IR regexp_pattern
to source file names found during processing.  This is useful when some file paths in the baseline or current .info file do not match your source layout and so the source code is not found.
See the lcov man page for more details.

Note that the substitution patterns are applied to the
.IR \-\-diff\-file
entries as well as the baseline and current .info files.
.RE

.B \-\-omit\-lines
.I regexp_pattern
.br
.RS
Exclude coverage data from lines whose content matches
.IR regexp .

Use this switch if you want to exclude line and branch coverage data for some particular constructs in your code (e.g., some complicated macro).
See the lcov man page for details.

.RE
.BI "\-\-parallel "
.I [ integer ]
.br
.BI "\-j "
.I [ integer ]
.RS
Specify parallelism to use during processing (maximum number of forked child processes).  If the optional integer parallelism parameter is zero or is missing, then use to use up the number of cores on the machine.  Default is to use a single process (no parallelism).
.br
Also see the
.I memory, memory_percentage, max_fork_fails
and
.I fork_fail_timeout
entries in man
.B lcovrc(5).


.RE
.BI "\-\-memory "
.I integer
.RS
Specify the maximum amount of memory to use during parallel processing, in Mb.  Effectively, the process will not fork() if this limit would be exceeded.  Default is 0 (zero) - which means that there is no limit.

This option may be useful if the compute farm environment imposes strict limits on resource utilization such that the job will be killed if it tries to use too many parallel children - but the user does not know a priori what the permissible maximum is.  This option enables the tool to use maximum parallelism - up to the limit imposed by the memory restriction.

The configuration file
.I memory_percentage
option provided another way to set the maximum memory consumption.
See man
.B lcovrc (5)
for details.


.RE
.BI \-\-filter " filters"
.RS
Specify a list of coverpoint filters to apply to input data.

Note that certain filters apply only to C/C++ source files.
.B genhtml
associates the file extension ('.c', '.vhd',
.I etc.
) with its source language.  See the
.I c_file_extentions
and
.I rtl_file_extensions
sections of man
.B lcovrc(5)
for a description of the default associations and how they can be changed.

Note that filters are applied to both 'branch' and 'MC/DC' coverpoints,
where appropriate: if a particular filter would remove some branch,
then it will also remove corresponding MC/DC coverpoints - for example,
.I "\-\-filter branch"
will remove MC/DC coverpoints if there is no conditional expression on the
corresponding line, and
.I "\-\-filter branch_region"
will remove both branch and MC/DC coverpoints in the marked region.

Most filters need the source code; filters are not applied if the source file is not available.  Similarly, for each source file, if the version recorded in the coverage data (the '.info' file)
does not match the version found on the filesystem, then a
.I version
error is reported.  If the
.I version
error is ignored, then filtering is not applied to the mismatched file.
See the
.I \-\-version\-script
for more information.

.I filters
can be a comma\-separated list of the following keywords:

.IP branch: 3
ignore branch counts for C/C++ source code lines which do not appear to contain conditionals.  These may be generated automatically by the compiler (e.g., from C++ exception handling) - and are not interesting to users.
This option has no effect unless
.B \-\-branch\-coverage
is used.

See also man
.B lcovrc(5)
- which describes several variables which affect branch filtering:
.I filter_lookahead
and
.I filter_bitwise_conditional.

The most common use for branch filtering is to remove compiler-generated branches related to C++ exception handlers.  See the no_exception_branch' option in man
.B lcovrc(5)
for a way to remove all identified exception branches.
.PP

.IP brace: 3
ignore line coverage counts on the closing brace of C/C++ code block, if the line contains only a closing brace and the preceding line has the same count or if the close brace has a zero count and either the preceding line has a non\-zero count, or the close brace is not the body of a conditional.

These lines seem to appear and disappear in gcov output - and cause differential coverage to report bogus LBC and/or GIC and/or UIC counts.  Bogus LBC or UIC counts are a problem because an automated regression which uses pass criteria "LBC + UIC + UNC == 0" will fail.
.PP

.IP blank: 3
ignore lines which contain only whitespace (or whitespace + comments) whose 'hit' count is zero.  These appear to be a 'gcov' artifact related to compiler-generated code - such as exception handlers and destructor calls at the end of scope - and can confuse differential coverage criteria.
.br
If lcovrc option
.I filter_blank_aggressive = 1
is enabled, then blank lines will be ignored whether their 'hit' count is zero or not.  Aggressive filtering may be useful in LLVM-generated coverage data, which tends to include large numbers of such lines.
.PP

.IP directive: 3
ignore lines which look like C compiler directives: #ifdef, #include, #define,
.I etc.
These lines are sometimes included by
.I llvm\-cov
when LLVM profile data is translated to LCOV format.
.PP

.IP exception: 3
Exclude branches related to C++ exception handling from branch coverage.
Whether C++ exception branches are identified and removed is dependent on your compiler/toolchain correctly marking them in the generated coverage data.
See the
.I no_exception_branch
section of
.B man lcovrc(5).

.IP initializer: 3
Exclude lines which appear to be part of a C++ std::initializer_list.
.PP

.IP line: 3
alias for "\-\-filter brace,blank".
.PP

.IP mcdc: 3
Remove MC/DC coverpoint which contains single expression, if 'branch' coverpoint
is present on the same line.
Singe-element MC/DC coverpoints are identical to the corresponding branch - except
in the case of compile-time expression evaluation, for example, in a template
function.

.IP orphan: 3
Remove branches which appear by themselves -
.I i.e.,
the branch has only one destination and so cannot be a conditional.
.br
These occur most frequently as a result of exception branch filtering.

.IP range: 3
Ignore line and branch coverpoints on lines which are out-of range/whose line number is beyond the end of the source file.  These appear to be gcov artifacts caused by a macro instantiation on the last line of the file.
.PP

.IP region: 3
apply LCOV_EXCL_START/LCOV_EXCL_STOP directives found in source text to the coverpoints found in the current and baseline .info files.
This option may be useful in cases that the source code was not found during 'lcov \-\-capture ...' but is accessible now.
.PP

.IP branch_region: 3
apply LCOV_EXCL_BR_START/LCOV_EXCL_BR_STOP directives found in source text to the coverpoints found in the current and baseline .info files.
This is similar to the 'region option, above - but applies to branch coverpoints only.
.PP

.IP function: 3
combine data for every "unique" function which is defined at the same file/line.
.I geninfo/gcov
seem to have a bug such that they create multiple entries for the same function.
This feature also merges all instances of the same template function/template method.
.PP

.IP trivial: 3
remove trivial functions and associated coverpoints.  'Trivial' functions are
whose body is empty/do not contain any statements.  Commonly, these include compiler-generated methods (e.g., default constructors and assignment operators) as well as static initialization wrappers, etc.

Note that the
.I trivial
filter requires function end line information - and so requires that you use a compiler version which is new enough to support begin/end line reports
(
.I e.g.,
gcc/9 or newer) or that you enable lcov/genhtml/geninfo to derive the information:

In man
.B lcovrc(5),
see the
.I derive_function_end_line
setting as well as the
.I trivial_function_threshold
setting.  The former is used to turn end line calculation on or off,
and the latter to change the lookahead used to determine whether the
function body is empty.
Also see the
.I lcov_filter_parallel
and
.I lcov_filter_chunk_size
settings, which may improve CPU performance if the number of files to process is very large.
.PP

.RE
.BI "\-o " output\-directory
.br
.BI "\-\-output\-directory " output\-directory
.RS
Create files in
.I output\-directory.

Use this option to tell
.B genhtml
to write the resulting files to a directory other than
the current one. If
.I output\-directory
does not exist, it will be created.

It is advisable to use this option since depending on the
project size, a lot of files and subdirectories may be created.

.RE
.BI "\-t " title
.br
.BI "\-\-title " title
.RS
Display
.I title
in header table of all pages.

.I title
is written to the "Test:"-field in the header table at the top of each
generated HTML page to identify the context in which a particular output
was created. By default, this is the name of the 'current; tracefile.

A common use is to specify a test run name, or a version control system
identifier (perforce changelist or git SHA, for example) that indicates
the code level that was tested.

.RE
.BI "\-\-header\-title " BANNER
.RS
Display
.I BANNER
in header of all pages.

.I BANNER
is written to the header portion of each generated HTML page.
By default, this
simply identifies this as an LCOV (differential) coverage report.

A common use is to specify the name of the project or project branch and the
Jenkins build ID.

.RE
.BI "\-\-footer " FOOTER
.RS
Display
.I FOOTER
in footer of all pages.

.I FOOTER
is written to the footer portion of each generated HTML page.
The default simply identifies the LCOV tool version used to generate the report.

.RE
.BI "\-d " description\-file
.br
.BI "\-\-description\-file " description\-file
.RS
Read test case descriptions from
.IR description\-file .

All test case descriptions found in
.I description\-file
and referenced in the input data file are read and written to an extra page
which is then incorporated into the HTML output.

The file format of
.IR "description\-file " is:

for each test case:
.RS
TN:<testname>
.br
TD:<test description>

.RE

Valid test case names can consist of letters, numbers and the underscore
character ('_').
.RE
.br

.B \-k
.br
.B \-\-keep\-descriptions
.RS
Do not remove unused test descriptions.

Keep descriptions found in the description file even if the coverage data
indicates that the associated test case did not cover any lines of code.

This option can also be configured permanently using the configuration file
option
.IR genhtml_keep_descriptions .

.RE
.BI "\-c " css\-file
.br
.BI "\-\-css\-file " css\-file
.RS
Use external style sheet file
.IR css\-file .

Using this option, an extra .css file may be specified which will replace
the default one. This may be helpful if the default colors make your eyes want
to jump out of their sockets :)

This option can also be configured permanently using the configuration file
option
.IR genhtml_css_file .

.RE
.BI "\-\-build\-directory " dirname
.RS
To support 'linked build directory' structures, add 'dirname' to the list of
places to search for soft links to source files -
.I e.g.,
to handle the case that the links point to source files which are held in your
revision control system, and appear in the
.I \-\-diff\-file
data.  In this use case, paths in the coverage data very likely refer to the
structure seen by the compiler during the build - so resolving them back to
the corresponding revsion-controlled source structure is likely to be successful.
.br

Look in
.I dirname
for file paths which appear in
.IR tracefile
\- possibly after substitutions have been applied \-
which are soft links.
Both the original file path and the path to the linked file will resolve to the same
.I \-\-diff\-file entry.

This option can be specified multiple times, to add more directories to the search path.


.RE
.BI "\-\-source\-directory " dirname
.RS
Add 'dirname' to the list of places to look for source files.
.br

For relative source file paths
.I e.g.
paths found in
.IR tracefile,
or in
.IR diff-file
\- possibly after substitutions have been applied -
.B genhtml
will first look for the path from 'cwd' (where genhtml was
invoked) and
then from each alternate directory name in the order specified.
The first location matching location is used.

This option can be specified multiple times, to add more directories to the source search path.


.RE
.BI "\-p " prefix
.br
.BI "\-\-prefix " prefix
.RS
Remove
.I prefix
from all directory names.

Because lists containing long filenames are difficult to read, there is a
mechanism implemented that will automatically try to shorten all directory
names on the overview page beginning with a common prefix. By default,
this is done using an algorithm that tries to find the prefix which, when
applied, will minimize the resulting sum of characters of all directory
names.

Use this option to specify the prefix to be removed by yourself.

.RE
.B \-\-no\-prefix
.RS
Do not remove prefix from directory names.

This switch will completely disable the prefix mechanism described in the
previous section.

This option can also be configured permanently using the configuration file
option
.IR genhtml_no_prefix .

.RE
.B \-\-no\-source
.RS
Do not create source code view.

Use this switch if you don't want to get a source code view for each file.

This option can also be configured permanently using the configuration file
option
.IR genhtml_no_source .

.RE
.B \-\-no\-html
.RS
Do not create HTML report.

Use this switch if you want some artifact of coverage report generation -
.I e.g.,
the coverage criteria check or the serialized coverage DB,
.B etc.
- but do not need the coverage report HTML itself.


.RE
.BI "\-\-num\-spaces " spaces
.RS
Replace tabs in source view with
.I num
spaces.

Default value is 8.

This option can also be configured permanently using the configuration file
option
.IR genhtml_num_spaces .

.RE
.B \-\-highlight
.RS
Highlight lines with converted\-only coverage data.

Use this option in conjunction with the
.B \-\-diff
option of
.B lcov
to highlight those lines which were only covered in data sets which were
converted from previous source code versions.

This option can also be configured permanently using the configuration file
option
.IR genhtml_highlight .

.RE
.B \-\-legend
.RS
Include color legend in HTML output.

Use this option to include a legend explaining the meaning of color coding
in the resulting HTML output.

This option can also be configured permanently using the configuration file
option
.IR genhtml_legend .

.RE
.BI "\-\-html\-prolog " prolog\-file
.RS
Read customized HTML prolog from
.IR prolog\-file .

Use this option to replace the default HTML prolog (the initial part of the
HTML source code leading up to and including the <body> tag) with the contents
of
.IR prolog\-file .
Within the prolog text, the following words will be replaced when a page is generated:

.B "@pagetitle@"
.br
The title of the page.

.B "@basedir@"
.br
A relative path leading to the base directory (e.g., for locating css\-files).

This option can also be configured permanently using the configuration file
option
.IR genhtml_html_prolog .

.RE
.BI "\-\-html\-epilog " epilog\-file
.RS
Read customized HTML epilog from
.IR epilog\-file .

Use this option to replace the default HTML epilog (the final part of the HTML
source including </body>) with the contents of
.IR epilog\-file .

Within the epilog text, the following words will be replaced when a page is generated:

.B "@basedir@"
.br
A relative path leading to the base directory (e.g., for locating css\-files).

This option can also be configured permanently using the configuration file
option
.IR genhtml_html_epilog .

.RE
.BI "\-\-html\-extension " extension
.RS
Use customized filename extension for generated HTML pages.

This option is useful in situations where different filename extensions
are required to render the resulting pages correctly (e.g., php). Note that
a '.' will be inserted between the filename and the extension specified by
this option.

This option can also be configured permanently using the configuration file
option
.IR genhtml_html_extension .
.RE

.B \-\-html\-gzip
.RS
Compress all generated html files with gzip and add a .htaccess file specifying
gzip\-encoding in the root output directory.

Use this option if you want to save space on your webserver. Requires a
webserver with .htaccess support and a browser with support for gzip
compressed html.

This option can also be configured permanently using the configuration file
option
.IR genhtml_html_gzip .

.RE
.B \-\-sort-tables
.br
.B \-\-no\-sort
.RS
Specify whether to include sorted views of file and directory overviews.

This option replaces the deprecated
.I "\-\-sort"
option.
.I "\-\-sort"
is still supported and is treated as an alias of
.I "\-\-sort\-tables"
but will be removed in a subsequent LCOV release.

Use
.B \-\-sort-tables
to include sorted views or
.B \-\-no\-sort
to not include them.
Sorted views are
.B enabled
by default.

When sorted views are enabled, each overview page will contain links to
views of that page sorted by coverage rate.

This option can also be configured permanently using the configuration file
option
.IR genhtml_sort .

.RE
.B \-\-function\-coverage
.br
.B \-\-no\-function\-coverage
.RS
Specify whether to display function coverage summaries in HTML output.

Use \-\-function\-coverage to enable function coverage summaries or
\-\-no\-function\-coverage to disable it. Function coverage summaries are
.B enabled
by default.

This option can also be configured permanently using the configuration file
option
.IR genhtml_function_coverage .

When function coverage summaries are enabled, each overview page will contain
the number of functions found and hit per file or directory, together with
the resulting coverage rate. In addition, each source code view will contain
a link to a page which lists all functions found in that file plus the
respective call count for those functions.
The function coverage page groups the data for every alias of each function, sorted by name or execution count.  The representative name of the group of functions is the shorted (i.e., containing the fewest characters).

If using differential coverage and a sufficiently recent compiler version which report both begin and end line of functions (
.I e.g.,
gcc/9 and newer), functions are considered 'new' if any of their source lines have changed.
With older compiler versions, functions are considered 'new' if the function signature has changed or if the entire function is new.

.RE
.B \-\-branch\-coverage
.br
.B \-\-no\-branch\-coverage
.RS
Specify whether to display branch coverage data in HTML output.

Use
.B \-\-branch\-coverage
to enable branch coverage display or
.B \-\-no\-branch\-coverage
to disable it. Branch coverage data display is
.B disabled
by default.

When branch coverage display is enabled, each overview page will contain
the number of branches found and hit per file or directory, together with
the resulting coverage rate. In addition, each source code view will contain
an extra column which lists all branches of a line with indications of
whether the branch was taken or not. Branches are shown in the following format:

 ' + ': Branch was taken at least once
.br
 ' - ': Branch was not taken
.br
 ' # ': The basic block containing the branch was never executed
.br

Note that it might not always be possible to relate branches to the
corresponding source code statements: during compilation, GCC might shuffle
branches around or eliminate some of them to generate better code.

This option can also be configured permanently using the configuration file
option
.IR branch_coverage .

.RE

.B \-\-mcdc\-coverage
.RS
Specify whether to display Modifie Condition / Decision Coverage (MC/DC)
data in HTML output.

MC/DC data display is
.B disabled
by default.

MC/DC coverage is supported for GCC versions 14.2 and higher, or
LLVM 18.1 and higher.
.br
See
.I llvm2lcov \-\-help
for details on MC/DC data capture in LLVM.

When MC/DC display is enabled, each overview page will contain
the number of MC/DC expressions found and hit per file or directory - two senses per expression - together with
the resulting coverage rate. In addition, each source code view will contain
an extra column which lists all expressions and condition senses of a line with indications of
whether the condition was sensitized or not. Conditions are shown in the following format:

.RS 3
.IP T: 3
True sense of subexpression was sensitized: if this subexpression's value had been false, then the condition result would have been different.
.IP t: 3
True sense of subexpression was
.B not
sensitized:  the condition result would not change if the subexpression value was different.
.IP F:
False sense of subexpression was sensitized: if this subexpression's value had been true, then the condition result would have been different.
.IP f:
False sense of subexpression was
.B not
sensitized:  the condition result would not change if the subexpression value was different.
.RE

Note that branch and MC/DC coverage are identical if the condition is
a simple expression -
.I e.g.,
.RS 3
 if (enable) ...
.RE

Note that, where appropriate, filters are applied to both 'branch' and 'MC/DC' coverpoints: if a particular filter would remove some branch,
then it will also remove corresponding MC/DC coverpoints.  See the
.I \-\-filter
section, above.

This option can also be configured permanently using the configuration file
option
.IR mcdc_coverage .
See man
.B lcovrc(5) .

Note that MC/DC coverpoints are defined differently by GCC and LLVM.
.IP GCC: 3
evaluates the sensitivity of the condition to the 'true' and 'false' sense of each constituent (leaf) expression independently.
.br
That is:  it evaluates the question:  does the result of the condition change if
.I this
constituent expression changed from true to false (termed the 'true' sense, above) or from false to true (termed the 'false' sens, above).
.br
For example, the expression
.I A || B
is sensitive to
.I A==true
when
.I B==false,
but is is not sensitive to
.I A==true
when
.I B==true.

.IP LLVM: 3
records the subexpression as covered if and only if there is a pair of evaluations
of the condition such that the condition was
sensitized for both 'true' and 'false' values of the subexpression.
This is defined as an
.I independence pair
in the LLVM documentation.
.PP

That is: the testcase must sensitize both values in order to be marked covered by
LLVM, whereas GCC will independently mark each.
Consequently:  in LLVM-generated
.B lcov
reports, either both 'true' and 'false' sensitizations will be covered, or neither will be.
.br
See the examples in tesctcase
.I .../tests/lcov/mcdc.



.RE
.BI "\-\-demangle\-cpp " [param]
.RS
Specify whether to demangle C++ function names.

Use this option if you want to convert C++ internal function names to
human readable format for display on the HTML function overview page.

If called with no parameters, genhtml will use
.I c++filt
for demangling.  This requires that the c++filt tool is installed (see
.BR c++filt (1)).

If
.I param
is specified, it is treated as th tool to call to demangle source code.
The
.I \-\-demangle\-cpp
option can be used multiple times to specify the demangling tool and a set of
command line options that are passed to the tool - similar to how the gcc
.I -Xlinker
parameter works.  In that case, you callback will be executed as:
.I | demangle_param0 demangle_param1 ...
Note that the demangle tool is called as a pipe and is expected to read from stdin and write to stdout.

.RE
.B \-\-msg\-log
.I [ log_file_name ]
.br
.RS
Specify location to store error and warning messages (in addition to writing to STDERR).
If
.I log_file_name
is not specified, then default location is used.
.RE

.RE
.B \-\-ignore\-errors
.I errors
.br
.RS
Specify a list of errors after which to continue processing.

Use this option to specify a list of error classes after which
.B genhtml
should continue processing with a warning message instead of aborting.
To suppress the warning message, specify the error class twice.
.br

.I errors
can be a comma\-separated list of the following keywords:

.IP annotate: 3
.B \-\-annotate\-script
returned non\-zero exit status - likely a file path or related error.  HTML source code display will not be correct and ownership/date information may be missing.
.PP

.IP branch: 3
Branch ID (2nd field in the .info file 'BRDA' entry) does not follow expected integer sequence.
.PP

.IP callback: 3
Annotate, version, or criteria script error.
.PP

.IP category: 3
Line number categorizations are incorrect in the .info file, so branch coverage line number turns out to not be an executable source line.
.PP

.IP child: 3
child process returned non-zero exit code during
.I \-\-parallel
execution.  This typically indicates that the child encountered an error:  see the log file immediately above this message.
In contrast:  the
.B parallel
error indicates an unexpected/unhandled exception in the child process - not a 'typical' lcov error.
.PP

.IP count: 3
An excessive number of messages of some class has been reported - subsequent messages of that type will be suppressed.
The limit can be controlled by the 'max_message_count' variable. See man
.B lcovrc(5).
.PP

.IP corrupt: 3
Corrupt/unreadable coverage data file found.
.PP

.IP deprecated: 3
You are using a deprecated option.
This option will be removed in an upcoming release - so you should change your
scripts now.
.PP

.IP empty: 3
The patch file specified by the
.B \-\-diff\-file
argument does not contain any differences.  This may be OK if there were no source code changes between 'baseline' and 'current' (e.g., the only change was to modify a Makefile) - or may indicate an unsupported file format.
.PP

.IP excessive: 3
your coverage data contains a suspiciously large 'hit' count which is unlikely
to be correct - possibly indicating a bug in your toolchain.
See the
.I excessive_count_threshold
section in man
.B lcorc(5)
for details.
.PP

.IP fork: 3
Unable to create child process during
.I \-\-parallel
execution.
.br
If the message is ignored (
.I \-\-ignore\-errors fork
), then genhtml
will wait a brief period and then retry the failed execution.
.br
If you see continued errors, either turn off or reduce parallelism, set a memory limit, or find a larger server to run the task.

.PP

.IP format: 3
Unexpected syntax or value found in .info file - for example, negative number or
zero line number encountered.

.PP

.IP inconsistent: 3
This error indicates that your coverage data is internally inconsistent:  it makes two or more mutually exclusive claims.  For example:
.RS
.IP \- 3
Files have been moved or repository history presented by
.B \-\-diff\-file
data is not consistent with coverage data; for example, an 'inserted' line has baseline coverage data.  These issues are likely to be caused by inconsistent handling in the 'diff' data compared to the 'baseline' and 'current' coverage data (e.g., using different source versions to collect the data but incorrectly annotating those differences), or by inconsistent treatment in the 'annotate' script.
Consider using a
.B \-\-version\-script
to guard against version mismatches.
.PP
.IP \- 3
Two or more
.B gcov
data files or
.B lcov
".info" files report different end lines for the same function.  This is likely due either to a gcc/gcov bug or to a source version mismatch.
.br
In this context, if the
.I "inconsistent"
error is ignored, then the tool will record the largest number as the function end line.
.PP
.IP \- 3
Two or more
.B gcov
data files or
.B lcov
".info" files report different start lines for the same function.  This is likely due either to a gcc/gcov bug or to a source version mismatch.
.br
In this context, if the
.I "inconsistent"
error is ignored, then the tool will retain only the first function definition that it saw.
.PP
.IP \- 3
Mismatched function declaration/alias records encountered:
.RS 3
.IP "(backward compatible LCOV format)" 3
function execution count record (
.I FNDA
) without matching function declaration record (
.I FN
).
.PP
.IP "(enhanced LCOV format)" 3
function alias record (
.I FNA
) without matching function declaration record (
.I FLN
).
.PP
.RE
.PP
.IP \- 3
branch expression (3rd field in the .info file 'BRDA' entry) of merge data does not match

.br
If the error is ignored, the offending record is skipped.
.RE
.PP

.IP internal: 3
internal tool issue detected.  Please report this bug along with a testcase.
.PP

.IP mismatch: 3
Incorrect or inconsistent information found in coverage data and/or source code - for example,
the source code contains overlapping exclusion directives.

.PP

.IP missing: 3
remove all coverpoints associated with source files which are not found or are not readable.
This is equivalent to adding a
.I \-\-exclude <name>
pattern for each file which is not found.
.br
If a
.I \-\-resolve\-script
callback is specified, then the file is considered missing if it is not
locally visible and the callback
returns "" (empty string) or 'undef' - otherwise not missing.
.br

.IP negative: 3
negative 'hit' count found.

Note that negative counts may be caused by a known GCC bug - see

  https://gcc.gnu.org/bugzilla/show_bug.cgi?id=68080

and try compiling with "-fprofile-update=atomic". You will need to recompile, re-run your tests, and re-capture coverage data.
.PP


.IP package: 3
A required perl package is not installed on your system.  In some cases, it is possible to ignore this message and continue - however, certain features will be disabled in that case.
.PP

.IP parallel: 3
various types of errors related to parallelism -
.I i.e.,
a child process died due to an error.  The corresponding error message appears in the log file immediately before the
.I parallel
error.
If you see an error related to parallel execution that seems invalid, it may be a good idea to remove the \-\-parallel flag and try again.  If removing the flag leads to a different result, please report the issue (along with a testcase) so that the tool can be fixed.
.PP

.IP path: 3
File name found in
.B \-\-diff\-file
file but does not appear in either baseline or current trace data.  These may be mapping issues - different pathname in the tracefile vs. the diff file.
.PP

.IP range: 3
Coverage data refers to a line number which is larger than the number of
lines in the source file.  This can be caused by a version mismatch or
by an issue in the
.I gcov
data.
.PP

.IP source: 3
The source code file for a data set could not be found.
.PP

.IP unmapped: 3
Coverage data for a particular line cannot be found, possibly because the source code was not found, or because the line number mapping in the \.info file is wrong.

This can happen if the source file used in HTML generation is not the same as the file used to generate the coverage data - for example, lines have been added or removed.
.PP

.IP unsupported: 3
The requested feature is not supported for this tool configuration.  For example, function begin/end line range exclusions use some GCOV features that are not available in older GCC releases.
.PP

.IP unused: 3
The include/exclude/erase/substitute/omit pattern did not match any file pathnames.
.PP

.IP usage: 3
unsupported usage detected - e.g. an unsupported option combination.
.PP

.IP utility: 3
a tool called during processing returned an error code (e.g., 'find' encountered an unreadable directory).
.PP

.IP version: 3
\-\-version\-script comparison returned non\-zero mismatch indication.  It likely that the version of the file which was used in coverage data extraction is different than the source version which was found.  File annotations may be incorrect.
.PP

Note that certain error messages are caused by issues that you probably cannot
fix by yourself - for example, bugs in your tool chain which result in
.I inconsistent
coverage DB data (see above).
In those cases, after reviewing the messages you may want to exclude the offending code or the entire offending
file, or you may simply ignore the messages - either by converting to warning or suppressing entirely.
Another alternative is to tell
.B genhtml
about the number of messages you expect - so that it can warn you if something changes
such that the count differs, such that you know to review the messages again.
See the
.I "\-\-expect\-message\-count"
flag, below.

Also see 'man
.B lcovrc(5)
' for a discussion of the 'max_message_count' parameter which can be used to control the number of warnings which are emitted before all subsequent messages are suppressed.  This can be used to reduce log file volume.
.br

.RE
.BI "\-\-expect\-message\-count message_type:expr[,message_type:expr]"
.RS
Give
.B genhtml
a constraint on the number of messages of one or more types which are expected to
be produced during execution.  Note that the total includes _all_ messages
of the given type - including those which have been suppressed.
If the constraint is not true, an
error of type
.I "count"
(see above) is generated.
.I message_type
is one of the message mnemonics described above, and
.I expr
may be either
.IP \- 3
an integer - interpreted to mean that there should be exactly that number
of messages of the corresponding type, or
.IP \- 3
a Perl expression containing the substring
.B %C
; %C is replaced with the total number of messages of the corresponding type and
then evaluated.  The constraint is met if the result is non-zero and is not met
otherwise.

For example:
.IP
\-\-expect\-message\-count inconsistent:5
.br
says that we expect exactly 5 messages of type 'inconsistent'.
.PP
.IP
\-\-expect\-message\-count inconsistent:%C==5
.br
also says that we expect exactly 5 messages of this type, but specified
using expression syntax.
.PP
.IP
\-\-expect\-message\-count 'inconsistent : %C > 6 && %C <= 10'
.br
says that we expect the number of messages to be in the range (6:10].
(Note that quoting may be necessary, to protect whitespace from interpretation by
your shell, if you want to improve expression readability by adding spaces to your expression.)
.PP

Multiple constraints can be specified using a comma-separated list or
by using the option multiple times.

This flag is equivalent to the
.I "expect_message_count"
configuration option.  See man
.B lcovrc(5)
for more details on the expression syntax and how expressions are interpreted.
The number of messages of the particular type is substituted into the
expression before it is evaluated.

.RE

.BI "\-\-keep\-going "
.RS
Do not stop if error occurs: attempt to generate a result, however flawed.

This command line option corresponds to the
.I stop_on_error
lcovrc option.  See man
.B lcovrc(5)
for more details.

.RE

.B \-\-config\-file
.I config\-file
.br
.RS
Specify a configuration file to use.
See man
.B lcovrc(5)
for details of the file format and options.  Also see the
.I config_file
entry in the same man page for details on how to include one config file into
another.

When this option is specified, neither the system\-wide configuration file
/etc/lcovrc, nor the per\-user configuration file ~/.lcovrc is read.

This option may be useful when there is a need to run several
instances of
.B genhtml
with different configuration file options in parallel.

Note that this option must be specified in full - abbreviations are not supported.

.RE

.B \-\-profile
.I [ profile\-data\-file ]
.br
.RS
Tell the tool to keep track of performance and other configuration data.
If the optional
.I profile\-data\-file
is not specified, then the profile data is written to a file named
.I "genhtml.json"
in the output directory.

.RE


.B \-\-rc
.IR keyword = value
.br
.RS
Override a configuration directive.

Use this option to specify a
.IR keyword = value
statement which overrides the corresponding configuration statement in
the lcovrc configuration file. You can specify this option more than once
to override multiple configuration statements.
See man
.BR lcovrc (5)
for a list of available keywords and their meaning.
.RE

.BI "\-\-precision " num
.RS
Show coverage rates with
.I num
number of digits after the decimal point.

Default value is 1.

This option can also be configured permanently using the configuration file
option
.IR genhtml_precision .
.RE

.B \-\-merge\-aliases
.RS
Functions whose file/line is the same are considered to be aliases;
.B genthml
uses the shortest name in the list of aliases (fewest characters) as the leader.
.br
This option counts each alias group as a single object - so the 'function'
count will be the number of distinct function groups rather than the total number
of aliases of all functions - and displays them as groups in the 'function detail
table.
.br
Note that this option has an effect only if
.B "\-\-filter function"
has been applied to the coverage DB.
.br

This parameter an be configured via the configuration file
.IR merge_function_aliases
option.  See
.B man(5) lcovrc.


.B \-\-suppress\-aliases
.RS
Suppress list of aliases in function detail table.
.br

Functions whose file/line is the same are considered to be aliases;
.B genthml
uses the shortest name in the list of aliases (fewest characters) as the leader.
.br

The number of aliases can be large, for example due to instantiated templates - which can make function coverage results difficult to read.  This option removes the list of aliases, making it easier to focus on the overall function coverage number, which is likely more interesting.

Note that this option has an effect only if
.B "\-\-filter function"
has been applied to the coverage DB.

This parameter an be configured via the configuration file
.IR merge_function_aliases
option.  See
.B man(5) lcovrc.


.B \-\-forget\-test\-names
.br
.RS
If non\-zero, ignore testcase names in .info file -
.I i.e.,
treat all coverage data as if it came from the same testcase.
This may improve performance and reduce memory consumption if user does
not need per-testcase coverage summary in coverage reports.

This option can also be configured permanently using the configuration file
option
.IR forget_testcase_names .
.RE

.B \-\-missed
.RS
Show counts of missed lines, functions, branches, and MC/DC expressions.

Use this option to change overview pages to show the count of lines, functions,
branches, or MC/DC expressions that were not hit. These counts are represented by negative numbers.

When specified together with \-\-sort\-tables, file and directory views will be sorted
by missed counts.

This option can also be configured permanently using the configuration file
option
.IR genhtml_missed .
.RE

.B \-\-dark\-mode
.RS
Use a light\-display\-on\-dark\-background color scheme rather than the default dark\-display\-on\-light\-background.

The idea is to reduce eye strain due to viewing dark text on a bright screen - particularly at night.
.RE

.B \-\-tempdir
.I dirname
.br
.RS
Write temporary and intermediate data to indicated directory.  Default is "/tmp".
.RE

.BI "\-\-preserve "
.RS
Preserve intermediate data files generated by various steps in the tool - e.g., for debugging.  By default, these files are deleted.

.RE

.BI "\-\-save "
.RS
Copy
.I unified\-diff\-file, baseline_trace_files,
and
.I tracefile(s)
to
output\-directory.

Keeping copies of the input data files may help to debug any issues or to regenerate report files later.

.RE

.B \-\-sort\-input
.br
.RS
Specify whether to sort file names before capture and/or aggregation.
Sorting reduces certain types of processing order-dependent output differences.
See the
.BI sort_input
section in
man
.B lcovrc(5).

.RE

.BI "\-\-serialize " file_name
.RS
Save coverage database to
.I file_name.

The file is in Perl "Storable" format.

Note that this option may significantly increase
.I genhtml
memory requirements, as a great deal of data must be retained.

.RE

.SH FILES

.I /etc/lcovrc
.RS
The system\-wide configuration file.
.RE

.I ~/.lcovrc
.RS
The per\-user configuration file.
.RE

Sample
.I  \-\-diff\-file
data creation scripts:
.RS

.I \*[scriptdir]/p4udiff
.RS
Sample script for use with
.B --diff-file
that creates a unified diff file via
.B Perforce.
.br
.RE

.I \*[scriptdir]/gitdiff
.RS
Sample script for use with
.B --diff-file
that creates a unified diff file via
.B git.
.br
.RE
.RE

Sample
.I \-\-annotate\-script
callback Perl modules:

.RS
.I \*[scriptdir]/p4annotate.pm
.RS
Sample script written as Perl module for use with
.B --annotate-script
that provides annotation data via
.B Perforce.
.br
.RE

.I \*[scriptdir]/gitblame.pm
.RS
Sample script written as Perl module for use with
.B --annotate-script
that provides annotation data via git.
.br
.RE
.RE

Sample
.I \-\-criteria\-script
callback Perl modules:
.RS

.I \*[scriptdir]/criteria.pm
.RS
Sample script written as Perl module for use with
.B --criteria-script
that implements a check for "UNC + LBC + UIC == 0".
.br
.RE

.I \*[scriptdir]/threshold.pm
.RS
Sample script written as Perl module to check for minimum acceptable
line and/or branch and/or and/or MC/DC function coverage.
For example, the
.RS
.I "genhtml --fail_under_lines 75 ..."
.RE
feature can instead be realized by
.RS
.I "genhtml --criteria-script \*[scriptdir]/threshold.pm,--line,75 ..."
.RE
.br
.RE
.RE

Sample
.I \-\-version\-script
callback Perl modules and scripts:
.RS

.I \*[scriptdir]/getp4version
.RS
Sample script for use with
.B \-\-version\-script
that obtains version IDs via
.B Perforce.
.br
.RE

.I \*[scriptdir]/P4version.pm
.RS
A perl module with similar functionality to
.B getp4version
but higher performance.
.br
.RE

.I \*[scriptdir]/get_signature
.RS
Sample script for use with
.B --version-script
that uses md5hash as version IDs.
.br
.RE

.I \*[scriptdir]/gitversion.pm
.RS
A perl module with for use with
.B \-\-version\-script
which retrieves version IDs from
.B git.
.br
.RE

.I \*[scriptdir]/batchGitVersion.pm
.RS
A perl module with similar functionality to
.B gitversion.pm
but higher performance.
.br
.RE
.RE


.SH AUTHORS
Peter Oberparleiter <Peter.Oberparleiter@de.ibm.com>
.br

Henry Cox <henry.cox@mediatek.com>
.RS
Differential coverage and date/owner binning, filtering, error management,
parallel execution sections,
.RE
.br

.SH SEE ALSO
.BR lcov (1),
.BR lcovrc (5),
.BR geninfo (1),
.BR genpng (1),
.BR gendesc (1),
.BR gcov (1)
.br

.I \*[lcovurl]
.br