| | | | |
| Offset 47, 50 lines modified | Offset 47, 50 lines modified |
| 47 | .UNINDENT | 47 | .UNINDENT |
| 48 | .SH·DESCRIPTION | 48 | .SH·DESCRIPTION |
| 49 | .sp | 49 | .sp |
| 50 | The·\fIlcovrc\fP·file·contains·configuration·information·for·the·\fBlcov\fP·code·coverage·tool·(see·\fBlcov\fP(1)). | 50 | The·\fIlcovrc\fP·file·contains·configuration·information·for·the·\fBlcov\fP·code·coverage·tool·(see·\fBlcov\fP(1)). |
| 51 | .sp | 51 | .sp |
| 52 | The·system\-wide·configuration·file·is·located·at·\fI$|TOOL_NAME|_HOME/etc/lcovrc\fP\&.·This·is·typically·either·\fI/etc/lcovrc\fP·or·\fI/usr/local/etc/lcovrc\fP·but·may·be·wherever·you·have·installed·the·lcov·package.·To·change·settings·for·a·single·user,·place·a·customized·copy·of·this·file·at·location·\fI~/.lcovrc\fP\&.·Where·available,·command\-line·options·override·configuration·file·settings. | 52 | The·system\-wide·configuration·file·is·located·at·\fI$|TOOL_NAME|_HOME/etc/lcovrc\fP\&.·This·is·typically·either·\fI/etc/lcovrc\fP·or·\fI/usr/local/etc/lcovrc\fP·but·may·be·wherever·you·have·installed·the·lcov·package.·To·change·settings·for·a·single·user,·place·a·customized·copy·of·this·file·at·location·\fI~/.lcovrc\fP\&.·Where·available,·command\-line·options·override·configuration·file·settings. |
| 53 | .sp | 53 | .sp |
| 54 | The·\fIgenhtml,·lcov,\fP·and·\fIgeninfo\fP·commands·also·support·the·\fI\-\-config\-file\fP·option,·which·can·be·used·to·specify·one·or·more·files·which·should·be·used·instead·of·the·system·or·user·default·rc·files.·Multiple·options·files·may·be·useful·if·you·have·both·project\-·and·team\-specific·common·options·and·want·to·ensure·consistency·across·multiple·users.·If·multiple·\-\-config\-file·options·are·applied·in·the·order·they·appear.·Note·that·the·\(dq\-\-config\-file\(dq·option·name·must·be·specified·in·full·and·cannot·be·abbreviated.·An·error·will·occur·if·the·option·is·not·recognized. | 54 | The·\fIgenhtml,·lcov,\fP·and·\fIgeninfo\fP·commands·also·support·the·\fI\-\-config\-file\fP·option,·which·can·be·used·to·specify·one·or·more·files·which·should·be·used·instead·of·the·system·or·user·default·rc·files.·Multiple·options·files·may·be·useful·if·you·have·both·project\-·and·team\-specific·common·options·and·want·to·ensure·consistency·across·multiple·users.·If·multiple·\-\-config\-file·options·are·applied·in·the·order·they·appear.·Note·that·the·“\-\-config\-file”·option·name·must·be·specified·in·full·and·cannot·be·abbreviated.·An·error·will·occur·if·the·option·is·not·recognized. |
| 55 | .sp | 55 | .sp |
| 56 | Lines·in·a·configuration·file·can·either·be: | 56 | Lines·in·a·configuration·file·can·either·be: |
| 57 | .INDENT·0.0 | 57 | .INDENT·0.0 |
| 58 | .IP·\(bu·2 | 58 | .IP·\(bu·2 |
| 59 | empty·lines·or·lines·consisting·only·of·white·space·characters.·These·lines·are·ignored. | 59 | empty·lines·or·lines·consisting·only·of·white·space·characters.·These·lines·are·ignored. |
| 60 | .IP·\(bu·2 | 60 | .IP·\(bu·2 |
| 61 | comment·lines·which·start·with·a·hash·sign·(\(aq#\(aq).·These·are·treated·like·empty·lines·and·will·be·ignored. | 61 | comment·lines·which·start·with·a·hash·sign·(‘#’).·These·are·treated·like·empty·lines·and·will·be·ignored. |
| 62 | .IP·\(bu·2 | 62 | .IP·\(bu·2 |
| 63 | statements·in·the·form·\(aqkey·=·value\(aq. | 63 | statements·in·the·form·‘key·=·value’. |
| 64 | .IP·\(bu·2 | 64 | .IP·\(bu·2 |
| 65 | Values·may·be·taken·from·environment·variables·via·the·syntax·\(aqkey·=·...·$ENV{ENV_VAR_NAME}·...\(aq. | 65 | Values·may·be·taken·from·environment·variables·via·the·syntax·‘key·=·…·$ENV{ENV_VAR_NAME}·…’. |
| 66 | .sp | 66 | .sp |
| 67 | The·substring·\(aq$ENV{ENV_VAR_NAME}\(aq·is·replaced·by·the·value·of·the·environment·variable. | 67 | The·substring·‘$ENV{ENV_VAR_NAME}’·is·replaced·by·the·value·of·the·environment·variable. |
| 68 | .sp | 68 | .sp |
| 69 | One·or·more·environment·variables·may·be·used·to·set·the·RC·value.·\(aqkey\(aq·is·ignored·if·any·of·the·environment·variables·are·not·set·in·your·user·environment. | 69 | One·or·more·environment·variables·may·be·used·to·set·the·RC·value.·‘key’·is·ignored·if·any·of·the·environment·variables·are·not·set·in·your·user·environment. |
| 70 | .UNINDENT | 70 | .UNINDENT |
| 71 | .sp | 71 | .sp |
| 72 | A·list·of·valid·statements·and·their·description·can·be·found·in·section·\(aqOPTIONS\(aq·below. | 72 | A·list·of·valid·statements·and·their·description·can·be·found·in·section·‘OPTIONS’·below. |
| 73 | .sp | 73 | .sp |
| 74 | \fBNOTE\fP·that·there·is·no·error·checking·of·keys·in·the·options·file:·spelling·errors·are·simply·seen·as·values·which·are·not·used·by·some·particular·tool.·If·you·are·unsure·of·whether·your·options·file·is·read·or·its·values·applied,·you·can·use·the·\fI\-\-verbose·\-\-verbose\fP·flag·to·enable·printing·of·option·value·overrides.·(The·option·appears·twice·to·enable·a·higher·level·of·verbosity.) | 74 | \fBNOTE\fP·that·there·is·no·error·checking·of·keys·in·the·options·file:·spelling·errors·are·simply·seen·as·values·which·are·not·used·by·some·particular·tool.·If·you·are·unsure·of·whether·your·options·file·is·read·or·its·values·applied,·you·can·use·the·\fI\-\-verbose·\-\-verbose\fP·flag·to·enable·printing·of·option·value·overrides.·(The·option·appears·twice·to·enable·a·higher·level·of·verbosity.) |
| 75 | .sp | 75 | .sp |
| 76 | Both·\(aqlist\(aq·and·\(aqscalar\(aq·(non·list)·options·are·supported·in·the·lcovrc·file. | 76 | Both·‘list’·and·‘scalar’·(non·list)·options·are·supported·in·the·lcovrc·file. |
| 77 | .sp | 77 | .sp |
| 78 | For·scalar·(non·list)·options: | 78 | For·scalar·(non·list)·options: |
| 79 | .INDENT·0.0 | 79 | .INDENT·0.0 |
| 80 | .IP·\(bu·2 | 80 | .IP·\(bu·2 |
| 81 | if·specified·on·the·command·line·and·in·the·lcovrc·file,·the·value·specified·on·the·command·line·wins.·The·value·from·the·RC·file·is·ignored. | 81 | if·specified·on·the·command·line·and·in·the·lcovrc·file,·the·value·specified·on·the·command·line·wins.·The·value·from·the·RC·file·is·ignored. |
| 82 | .IP·\(bu·2 | 82 | .IP·\(bu·2 |
| 83 | Scalar·options·include:·\(aqcriteria_script·=·...\(aq,·\(aqgenhtml_annotate_script·=·...\(aq,·\(aqversion_script·=·...\(aq,·etc. | 83 | Scalar·options·include:·‘criteria_script·=·…’,·‘genhtml_annotate_script·=·…’,·‘version_script·=·…’,·etc. |
| 84 | .UNINDENT | 84 | .UNINDENT |
| 85 | .sp | 85 | .sp |
| 86 | For·list·options: | 86 | For·list·options: |
| 87 | .INDENT·0.0 | 87 | .INDENT·0.0 |
| 88 | .IP·\(bu·2 | 88 | .IP·\(bu·2 |
| 89 | the·RC·file·entry·can·be·used·multiple·times;·each·use·appends·to·the·list.·For·example,·the·entry·below·will·result·in·two·\(aqomit\(aq·patterns·which·will·both·be·checked: | 89 | the·RC·file·entry·can·be·used·multiple·times;·each·use·appends·to·the·list.·For·example,·the·entry·below·will·result·in·two·‘omit’·patterns·which·will·both·be·checked: |
| 90 | .INDENT·2.0 | 90 | .INDENT·2.0 |
| 91 | .INDENT·3.5 | 91 | .INDENT·3.5 |
| 92 | .sp | 92 | .sp |
| 93 | .EX | 93 | .EX |
| 94 | #·note·explicit·start/end·line·markers·in·the·regexp | 94 | #·note·explicit·start/end·line·markers·in·the·regexp |
| 95 | omit_lines·=·^\e\es+//\e\es*MY_EXCLUDE_MARKER\e\es*$ | 95 | omit_lines·=·^\e\es+//\e\es*MY_EXCLUDE_MARKER\e\es*$ |
| 96 | #·Note·that·the·regexp·below·matches·anywhere·on·the·line | 96 | #·Note·that·the·regexp·below·matches·anywhere·on·the·line |
| Offset 498, 33 lines modified | Offset 498, 33 lines modified |
| 498 | By·default,·a·standard·CSS·file·is·generated. | 498 | By·default,·a·standard·CSS·file·is·generated. |
| 499 | .SH·GENHTML_HEADER·=·STRING | 499 | .SH·GENHTML_HEADER·=·STRING |
| 500 | .sp | 500 | .sp |
| 501 | Specify·header·text·to·use·at·top·of·each·HTML·page. | 501 | Specify·header·text·to·use·at·top·of·each·HTML·page. |
| 502 | .sp | 502 | .sp |
| 503 | This·option·corresponds·to·the·\-\-header\-title·command·line·option·of·\fBgenhtml\fP\&. | 503 | This·option·corresponds·to·the·\-\-header\-title·command·line·option·of·\fBgenhtml\fP\&. |
| 504 | .sp | 504 | .sp |
| 505 | Default·is·\(dqLCOV·\-·(differential·)?·coverage·report\(dq | 505 | Default·is·“LCOV·\-·(differential·)?·coverage·report” |
| 506 | .SH·GENHTML_FOOTER·=·STRING | 506 | .SH·GENHTML_FOOTER·=·STRING |
| 507 | .sp | 507 | .sp |
| 508 | Specify·footer·text·to·use·at·bottom·of·each·HTML·page. | 508 | Specify·footer·text·to·use·at·bottom·of·each·HTML·page. |
| 509 | .sp | 509 | .sp |
| 510 | This·option·corresponds·to·the·\-\-footer·command·line·option·of·\fBgenhtml\fP\&. | 510 | This·option·corresponds·to·the·\-\-footer·command·line·option·of·\fBgenhtml\fP\&. |
| 511 | .sp | 511 | .sp |
| 512 | Default·is·LCOV·tool·version·string. | 512 | Default·is·LCOV·tool·version·string. |
| 513 | .SH·GENHTML_DARK_MODE·=·0·|·1 | 513 | .SH·GENHTML_DARK_MODE·=·0·|·1 |
| 514 | .sp | 514 | .sp |
| 515 | If·non\-zero,·display·using·light·text·on·dark·background·rather·than·dark·text·on·light·background. | 515 | If·non\-zero,·display·using·light·text·on·dark·background·rather·than·dark·text·on·light·background. |
| 516 | .sp | 516 | .sp |
| 517 | This·option·corresponds·to·the·\-\-dark\-mode·command·line·option·of·\fBgenhtml\fP\&. | 517 | This·option·corresponds·to·the·\-\-dark\-mode·command·line·option·of·\fBgenhtml\fP\&. |
| 518 | .sp | 518 | .sp |
| 519 | By·default,·a·\(aqlight\(aq·palette·is·used. | 519 | By·default,·a·‘light’·palette·is·used. |
| 520 | .sp | 520 | .sp |
| 521 | \fBgenhtml_hi_limit\fP··=·\fIhi_limit\fP | 521 | \fBgenhtml_hi_limit\fP··=·\fIhi_limit\fP |
| 522 | \fBgenhtml_med_limit\fP·=·\fImed_limit\fP | 522 | \fBgenhtml_med_limit\fP·=·\fImed_limit\fP |
| 523 | \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- | 523 | ———————————– |
| 524 | .sp | 524 | .sp |
| 525 | Specify·coverage·rate·limits·for·classifying·file·entries.·Use·this·option·to·modify·the·coverage·rates·(in·percent)·for·line,·function·and·branch·coverage·at·which·a·result·is·classified·as·high,·medium·or·low·coverage.·This·classification·affects·the·color·of·the·corresponding·entries·on·the·overview·pages·of·the·HTML·output: | 525 | Specify·coverage·rate·limits·for·classifying·file·entries.·Use·this·option·to·modify·the·coverage·rates·(in·percent)·for·line,·function·and·branch·coverage·at·which·a·result·is·classified·as·high,·medium·or·low·coverage.·This·classification·affects·the·color·of·the·corresponding·entries·on·the·overview·pages·of·the·HTML·output: |
| 526 | .INDENT·0.0 | 526 | .INDENT·0.0 |
| 527 | .INDENT·3.5 | 527 | .INDENT·3.5 |
| 528 | .sp | 528 | .sp |
| 529 | .EX | 529 | .EX |
| 530 | High:···hi_limit··<=·rate·<=·100········default·color:·green | 530 | High:···hi_limit··<=·rate·<=·100········default·color:·green |
| Offset 536, 98 lines modified | Offset 536, 98 lines modified |
| 536 | .sp | 536 | .sp |
| 537 | Defaults·are·90·and·75·percent. | 537 | Defaults·are·90·and·75·percent. |
| 538 | .sp | 538 | .sp |
| 539 | There·are·also·options·to·configure·different·thresholds·for·line,·branch,·and·function·coverages.·See·below. | 539 | There·are·also·options·to·configure·different·thresholds·for·line,·branch,·and·function·coverages.·See·below. |
| 540 | .sp | 540 | .sp |
| 541 | \fBgenhtml_line_hi_limit\fP··=·\fIline_hi_limit\fP | 541 | \fBgenhtml_line_hi_limit\fP··=·\fIline_hi_limit\fP |
| 542 | \fBgenhtml_line_med_limit\fP·=·\fIline_med_limit\fP | 542 | \fBgenhtml_line_med_limit\fP·=·\fIline_med_limit\fP |
| 543 | \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- | 543 | ———————————————\- |
| 544 | .sp | 544 | .sp |
| 545 | Specify·specific·threshold·for·line·coverage·limits·used·to·decide·whether·a·particular·line·coverage·percentage·is·classified·as·high,·medium,·or·low·coverage.·If·the·line\-specific·values·are·not·specified,·then·the·default·\fIgenhtml_med_limit\fP·or·\fIgenhtml_hi_limit\fP·values·are·used. | 545 | Specify·specific·threshold·for·line·coverage·limits·used·to·decide·whether·a·particular·line·coverage·percentage·is·classified·as·high,·medium,·or·low·coverage.·If·the·line\-specific·values·are·not·specified,·then·the·default·\fIgenhtml_med_limit\fP·or·\fIgenhtml_hi_limit\fP·values·are·used. |
| 546 | .sp | 546 | .sp |
| 547 | \fBgenhtml_branch_hi_limit\fP··=·\fIbranch_hi_limit\fP | 547 | \fBgenhtml_branch_hi_limit\fP··=·\fIbranch_hi_limit\fP |
| 548 | \fBgenhtml_branch_med_limit\fP·=·\fIbranch_med_limit\fP | 548 | \fBgenhtml_branch_med_limit\fP·=·\fIbranch_med_limit\fP |
| 549 | \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- | 549 | ————————————————– |
| 550 | .sp | 550 | .sp |
| 551 | Specify·specific·threshold·for·branch·coverage·limits·used·to·decide·whether·a·particular·branch·coverage·percentage·is·classified·as·high,·medium,·or·low·coverage.·If·the·branch\-specific·values·are·not·specified,·then·the·default·\fIgenhtml_med_limit\fP·or·\fIgenhtml_hi_limit\fP·values·are·used. | 551 | Specify·specific·threshold·for·branch·coverage·limits·used·to·decide·whether·a·particular·branch·coverage·percentage·is·classified·as·high,·medium,·or·low·coverage.·If·the·branch\-specific·values·are·not·specified,·then·the·default·\fIgenhtml_med_limit\fP·or·\fIgenhtml_hi_limit\fP·values·are·used. |
| 552 | .sp | 552 | .sp |
| 553 | \fBgenhtml_function_hi_limit\fP··=·\fIfunction_hi_limit\fP | 553 | \fBgenhtml_function_hi_limit\fP··=·\fIfunction_hi_limit\fP |
| 554 | \fBgenhtml_function_med_limit\fP·=·\fIfunction_med_limit\fP | 554 | \fBgenhtml_function_med_limit\fP·=·\fIfunction_med_limit\fP |
| 555 | \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- | 555 | —————————————————— |
| 556 | .sp | 556 | .sp |
| 557 | Specify·specific·threshold·for·function·coverage·limits·used·to·decide·whether·a·particular·function·coverage·percentage·is·classified·as·high,·medium,·or·low·coverage.·If·the·function\-specific·values·are·not·specified,·then·the·default·\fIgenhtml_med_limit\fP·or·\fIgenhtml_hi_limit\fP·value·is·used. | 557 | Specify·specific·threshold·for·function·coverage·limits·used·to·decide·whether·a·particular·function·coverage·percentage·is·classified·as·high,·medium,·or·low·coverage.·If·the·function\-specific·values·are·not·specified,·then·the·default·\fIgenhtml_med_limit\fP·or·\fIgenhtml_hi_limit\fP·value·is·used. |
| 558 | .SH·RTL_FILE_EXTENSIONS·=·STR[,STR]+ | 558 | .SH·RTL_FILE_EXTENSIONS·=·STR[,STR]+ |
| 559 | .sp | 559 | .sp |
| 560 | Specify·a·comma\-separated·list·of·file·extensions·which·should·be·assumed·to·be·RTL·code·(\fIe.g.\fP,·Verilog). | 560 | Specify·a·comma\-separated·list·of·file·extensions·which·should·be·assumed·to·be·RTL·code·(\fIe.g.\fP,·Verilog). |
| 561 | .sp | 561 | .sp |
| 562 | If·not·specified,·the·default·set·is·\(aqv,vh,sv,vhdl?\(aq.·There·is·no·command·line·option·equivalent. | 562 | If·not·specified,·the·default·set·is·‘v,vh,sv,vhdl?’.·There·is·no·command·line·option·equivalent. |
| 563 | .sp | 563 | .sp |
| 564 | This·option·is·used·by·genhtml·and·lcov. | 564 | This·option·is·used·by·genhtml·and·lcov. |
| 565 | .SH·INFO_FILE_PATTERN·=·STR | 565 | .SH·INFO_FILE_PATTERN·=·STR |
| 566 | .sp | 566 | .sp |
| 567 | Specify·a·glob\-match·pattern·associated·with·lcov·trace·files·(suitable·as·an·argument·to·\(aqfind\(aq.·If·not·specified,·the·default·is·\(aq*.info\(aq. | 567 | Specify·a·glob\-match·pattern·associated·with·lcov·trace·files·(suitable·as·an·argument·to·‘find’.·If·not·specified,·the·default·is·‘*.info’. |
| 568 | .SH·C_FILE_EXTENSIONS·=·STR[,STR]+ | 568 | .SH·C_FILE_EXTENSIONS·=·STR[,STR]+ |
| 569 | .sp | 569 | .sp |
| 570 | Specify·a·comma\-separated·list·of·file·extensions·which·should·be·assumed·to·be·C/C++·code. | 570 | Specify·a·comma\-separated·list·of·file·extensions·which·should·be·assumed·to·be·C/C++·code. |
| 571 | .sp | 571 | .sp |
| 572 | If·not·specified,·the·default·set·is·\(aqc,h,i,C,H,I,icc,cpp,cc,cxx,hh,hpp,hxx\(aq.·If·you·want·all·files·to·be·treated·as·C/C++·code,·you·can·use:·\fIc_file_extensions·=·.*\fP | 572 | If·not·specified,·the·default·set·is·‘c,h,i,C,H,I,icc,cpp,cc,cxx,hh,hpp,hxx’.·If·you·want·all·files·to·be·treated·as·C/C++·code,·you·can·use:·\fIc_file_extensions·=·.*\fP |
| 573 | .sp | 573 | .sp |
| 574 | This·parameter·must·be·set·from·the·lcovrc·file·or·via·the·\fI\-\-rc·name=value\fP·command·line·option;·note·that·you·may·need·to·protect·the·value·from·shell·expansion·in·the·latter·case. | 574 | This·parameter·must·be·set·from·the·lcovrc·file·or·via·the·\fI\-\-rc·name=value\fP·command·line·option;·note·that·you·may·need·to·protect·the·value·from·shell·expansion·in·the·latter·case. |
| 575 | .SH·JAVA_FILE_EXTENSIONS·=·STR[,STR]+ | 575 | .SH·JAVA_FILE_EXTENSIONS·=·STR[,STR]+ |
| 576 | .sp | 576 | .sp |
| 577 | Specify·a·comma\-separated·list·of·file·extensions·which·should·be·assumed·to·be·Java·code. | 577 | Specify·a·comma\-separated·list·of·file·extensions·which·should·be·assumed·to·be·Java·code. |
|
Max report size reached; 47592/57346 bytes (82.99%) of diff not shown.
|