third_party/lcov/man/lcovrc.5

   1 .TH lcovrc 5 "LCOV 1.7" 2008\-11\-17 "User Manuals"
   2
   3 .SH NAME
   4 lcovrc \- lcov configuration file
   5
   6 .SH DESCRIPTION
   7 The
   8 .I lcovrc
   9 file contains configuration information for the
  10 .B lcov
  11 code coverage tool (see
  12 .BR lcov (1)).
  13 .br
  14
  15 The system\-wide configuration file is located at
  16 .IR /etc/lcovrc .
  17 To change settings for a single user, place a customized copy of this file at
  18 location
  19 .IR ~/.lcovrc .
  20 Where available, command\-line options override configuration file settings.
  21
  22 Lines in a configuration file can either be:
  23 .IP "     *"
  24 empty lines or lines consisting only of white space characters. These lines are
  25 ignored.
  26 .IP "     *"
  27 comment lines which start with a hash sign ('#'). These are treated like empty
  28 lines and will be ignored.
  29 .IP "     *"
  30 statements in the form
  31 .RI ' key " = " value '.
  32 A list of valid statements and their description can be found in
  33 section 'OPTIONS' below.
  34 .PP
  35
  36 .B Example configuration:
  37 .IP
  38 #
  39 .br
  40 # Example LCOV configuration file
  41 .br
  42 #
  43 .br
  44
  45 # External style sheet file
  46 .br
  47 #genhtml_css_file = gcov.css
  48 .br
  49
  50 # Coverage rate limits for line coverage
  51 .br
  52 genhtml_hi_limit = 50
  53 .br
  54 genhtml_med_limit = 15
  55 .br
  56
  57 # Coverage rate limits for function coverage
  58 .br
  59 genhtml_function_hi_limit = 90
  60 .br
  61 genhtml_function_med_limit = 75
  62 .br
  63
  64 # Width of overview image
  65 .br
  66 genhtml_overview_width = 80
  67 .br
  68
  69 # Resolution of overview navigation
  70 .br
  71 genhtml_nav_resolution = 4
  72 .br
  73
  74 # Offset for source code navigation
  75 .br
  76 genhtml_nav_offset = 10
  77 .br
  78
  79 # Do not remove unused test descriptions if non\-zero
  80 .br
  81 genhtml_keep_descriptions = 0
  82 .br
  83
  84 # Do not remove prefix from directory names if non\-zero
  85 .br
  86 genhtml_no_prefix = 0
  87 .br
  88
  89 # Do not create source code view if non\-zero
  90 .br
  91 genhtml_no_source = 0
  92 .br
  93
  94 # Specify size of tabs
  95 .br
  96 genhtml_num_spaces = 8
  97 .br
  98
  99 # Highlight lines with converted\-only data if non\-zero
 100 .br
 101 genhtml_highlight = 0
 102 .br
 103
 104 # Include color legend in HTML output if non\-zero
 105 .br
 106 genhtml_legend = 0
 107 .br
 108
 109 # Include HTML file at start of HTML output
 110 .br
 111 #genhtml_html_prolog = prolog.html
 112 .br
 113
 114 # Include HTML file at end of HTML output
 115 .br
 116 #genhtml_html_epilog = epilog.html
 117 .br
 118
 119 # Use custom HTML file extension
 120 .br
 121 #genhtml_html_extension = html
 122 .br
 123
 124 # Compress all generated html files with gzip.
 125 .br
 126 #genhtml_html_gzip = 1
 127 .br
 128
 129 # Include sorted overview pages
 130 .br
 131 genhtml_sort = 1
 132 .br
 133
 134 # Include function coverage data display
 135 .br
 136 genhtml_function_coverage = 1
 137 .br
 138
 139 # Location of the gcov tool
 140 .br
 141 #geninfo_gcov_tool = gcov
 142 .br
 143
 144 # Adjust test names if non\-zero
 145 .br
 146 #geninfo_adjust_testname = 0
 147 .br
 148
 149 # Calculate a checksum for each line if non\-zero
 150 .br
 151 geninfo_checksum = 0
 152 .br
 153
 154 # Enable libtool compatibility mode if non\-zero
 155 .br
 156 geninfo_compat_libtool = 0
 157 .br
 158
 159 # Directory containing gcov kernel files
 160 .br
 161 lcov_gcov_dir = /proc/gcov
 162 .br
 163
 164 # Location of the insmod tool
 165 .br
 166 lcov_insmod_tool = /sbin/insmod
 167 .br
 168
 169 # Location of the modprobe tool
 170 .br
 171 lcov_modprobe_tool = /sbin/modprobe
 172 .br
 173
 174 # Location of the rmmod tool
 175 .br
 176 lcov_rmmod_tool = /sbin/rmmod
 177 .br
 178
 179 # Location for temporary directories
 180 .br
 181 lcov_tmp_dir = /tmp
 182 .br
 183 .PP
 184
 185 .SH OPTIONS
 186
 187 .BR genhtml_css_file " ="
 188 .I filename
 189 .IP
 190 Specify an external style sheet file. Use this option to modify the appearance of the HTML output as generated by
 191 .BR genhtml .
 192 During output generation, a copy of this file will be placed in the output
 193 directory.
 194 .br
 195
 196 This option corresponds to the \-\-css\-file command line option of
 197 .BR genhtml .
 198 .br
 199
 200 By default, a standard CSS file is generated.
 201 .PP
 202
 203 .BR genhtml_hi_limit "  ="
 204 .I hi_limit
 205 .br
 206 .BR genhtml_med_limit " ="
 207 .I med_limit
 208 .br
 209 .BR genhtml_function_med_limit " ="
 210 .I hi_limit
 211 .br
 212 .BR genhtml_function_med_limit " ="
 213 .I med_limit
 214 .IP
 215 Specify coverage rate limits for classifying file entries. Use this option to
 216 modify the coverage rates (in percent) for line or function coverage at which
 217 a result is classified as high, medium or low coverage. This classification
 218 affects the color of the corresponding entries on the overview pages of the
 219 HTML output:
 220 .br
 221
 222 High:   hi_limit  <= rate <= 100        default color: green
 223 .br
 224 Medium: med_limit <= rate < hi_limit    default color: orange
 225 .br
 226 Low:    0         <= rate < med_limit   default color: red
 227 .br
 228
 229 Defaults are 50 and 15 percent for line coverage and 90 and 75 percent for
 230 function coverage.
 231 .PP
 232
 233 .BR genhtml_overview_width " ="
 234 .I pixel_size
 235 .IP
 236 Specify the width (in pixel) of the overview image created when generating HTML
 237 output using the \-\-frames option of
 238 .BR genhtml .
 239 .br
 240
 241 Default is 80.
 242 .PP
 243
 244 .BR genhtml_nav_resolution " ="
 245 .I lines
 246 .IP
 247 Specify the resolution of overview navigation when generating HTML output using
 248 the \-\-frames option of
 249 .BR genhtml .
 250 This number specifies the maximum difference in lines between the position a
 251 user selected from the overview and the position the source code window is
 252 scrolled to.
 253 .br
 254
 255 Default is 4.
 256 .PP
 257
 258
 259 .BR genhtml_nav_offset " ="
 260 .I lines
 261 .IP
 262 Specify the overview navigation line offset as applied when generating HTML
 263 output using the \-\-frames option of
 264 .BR genhtml.
 265 .br
 266
 267 Clicking a line in the overview image should show the source code view at
 268 a position a bit further up, so that the requested line is not the first
 269 line in the window.  This number specifies that offset.
 270 .br
 271
 272 Default is 10.
 273 .PP
 274
 275
 276 .BR genhtml_keep_descriptions " ="
 277 .IR 0 | 1
 278 .IP
 279 If non\-zero, keep unused test descriptions when generating HTML output using
 280 .BR genhtml .
 281 .br
 282
 283 This option corresponds to the \-\-keep\-descriptions option of
 284 .BR genhtml .
 285 .br
 286
 287 Default is 0.
 288 .PP
 289
 290 .BR genhtml_no_prefix " ="
 291 .IR 0 | 1
 292 .IP
 293 If non\-zero, do not try to find and remove a common prefix from directory names.
 294 .br
 295
 296 This option corresponds to the \-\-no\-prefix option of
 297 .BR genhtml .
 298 .br
 299
 300 Default is 0.
 301 .PP
 302
 303 .BR genhtml_no_source " ="
 304 .IR 0 | 1
 305 .IP
 306 If non\-zero, do not create a source code view when generating HTML output using
 307 .BR genhtml .
 308 .br
 309
 310 This option corresponds to the \-\-no\-source option of
 311 .BR genhtml .
 312 .br
 313
 314 Default is 0.
 315 .PP
 316
 317 .BR genhtml_num_spaces " ="
 318 .I num
 319 .IP
 320 Specify the number of spaces to use as replacement for tab characters in the
 321 HTML source code view as generated by
 322 .BR genhtml .
 323 .br
 324
 325 This option corresponds to the \-\-num\-spaces option of
 326 .BR genthml .
 327 .br
 328
 329 Default is 8.
 330
 331 .PP
 332
 333 .BR genhtml_highlight " ="
 334 .IR 0 | 1
 335 .IP
 336 If non\-zero, highlight lines with converted\-only data in
 337 HTML output as generated by
 338 .BR genhtml .
 339 .br
 340
 341 This option corresponds to the \-\-highlight option of
 342 .BR genhtml .
 343 .br
 344
 345 Default is 0.
 346 .PP
 347
 348 .BR genhtml_legend " ="
 349 .IR 0 | 1
 350 .IP
 351 If non\-zero, include a legend explaining the meaning of color coding in the HTML
 352 output as generated by
 353 .BR genhtml .
 354 .br
 355
 356 This option corresponds to the \-\-legend option of
 357 .BR genhtml .
 358 .br
 359
 360 Default is 0.
 361 .PP
 362
 363 .BR genhtml_html_prolog " ="
 364 .I filename
 365 .IP
 366 If set, include the contents of the specified file at the beginning of HTML
 367 output.
 368
 369 This option corresponds to the \-\-html\-prolog option of
 370 .BR genhtml .
 371 .br
 372
 373 Default is to use no extra prolog.
 374 .PP
 375
 376 .BR genhtml_html_epilog " ="
 377 .I filename
 378 .IP
 379 If set, include the contents of the specified file at the end of HTML output.
 380
 381 This option corresponds to the \-\-html\-epilog option of
 382 .BR genhtml .
 383 .br
 384
 385 Default is to use no extra epilog.
 386 .PP
 387
 388 .BR genhtml_html_extension " ="
 389 .I extension
 390 .IP
 391 If set, use the specified string as filename extension for generated HTML files.
 392
 393 This option corresponds to the \-\-html\-extension option of
 394 .BR genhtml .
 395 .br
 396
 397 Default extension is "html".
 398 .PP
 399
 400 .BR genhtml_html_gzip " ="
 401 .IR 0 | 1
 402 .IP
 403 If set, compress all html files using gzip.
 404
 405 This option corresponds to the \-\-html\-gzip option of
 406 .BR genhtml .
 407 .br
 408
 409 Default extension is 0.
 410 .PP
 411
 412 .BR genhtml_sort " ="
 413 .IR 0 | 1
 414 .IP
 415 If non\-zero, create overview pages sorted by coverage rates when generating
 416 HTML output using
 417 .BR genhtml .
 418 .br
 419
 420 This option can be set to 0 by using the \-\-no\-sort option of
 421 .BR genhtml .
 422 .br
 423
 424 Default is 1.
 425 .PP
 426
 427 .BR genhtml_function_coverage " ="
 428 .IR 0 | 1
 429 .IP
 430 If non\-zero, include function coverage data when generating HTML output using
 431 .BR genhtml .
 432 .br
 433
 434 This option can be set to 0 by using the \-\-no\-function\-coverage option of
 435 .BR genhtml .
 436 .br
 437
 438 Default is 1.
 439 .PP
 440
 441 .BR geninfo_gcov_tool " ="
 442 .I path_to_gcov
 443 .IP
 444 Specify the location of the gcov tool (see
 445 .BR gcov (1))
 446 which is used to generate coverage information from data files.
 447 .br
 448
 449 Default is 'gcov'.
 450 .PP
 451
 452 .BR geninfo_adjust_testname " ="
 453 .IR 0 | 1
 454 .IP
 455 If non\-zero,  adjust test names to include operating system information
 456 when capturing coverage data.
 457 .br
 458
 459 Default is 0.
 460 .PP
 461
 462 .BR geninfo_checksum " ="
 463 .IR 0 | 1
 464 .IP
 465 If non\-zero, generate source code checksums when capturing coverage data.
 466 Checksums are useful to prevent merging coverage data from incompatible
 467 source code versions but checksum generation increases the size of coverage
 468 files and the time used to generate those files.
 469 .br
 470
 471 This option corresponds to the \-\-checksum and \-\-no\-checksum command line
 472 option of
 473 .BR geninfo .
 474 .br
 475
 476 Default is 0.
 477 .PP
 478
 479 .BR geninfo_compat_libtool " ="
 480 .IR 0 | 1
 481 .IP
 482 If non\-zero, enable libtool compatibility mode. When libtool compatibility
 483 mode is enabled, lcov will assume that the source code relating to a .da file
 484 located in a directory named ".libs" can be found in its parent directory.
 485 .br
 486
 487 This option corresponds to the \-\-compat\-libtool and \-\-no\-compat\-libtool
 488 command line option of
 489 .BR geninfo .
 490 .br
 491
 492 Default is 1.
 493 .PP
 494
 495 .BR lcov_gcov_dir " ="
 496 .I path_to_kernel_coverage_data
 497 .IP
 498 Specify the path to the directory where kernel coverage data can be found.
 499 .br
 500
 501 Default is '/proc/gcov'.
 502 .PP
 503
 504 .BR lcov_insmod_tool " ="
 505 .I path_to_insmod
 506 .IP
 507 Specify the location of the insmod tool used to load kernel modules.
 508 .br
 509
 510 Default is '/sbin/insmod'.
 511 .PP
 512
 513 .BR lcov_modprobe_tool " ="
 514 .I path_to_modprobe
 515 .IP
 516 Specify the location of the modprobe tool used to load kernel modules.
 517 .br
 518
 519 Default is '/sbin/modprobe'.
 520 .PP
 521
 522 .BR lcov_rmmod_tool " ="
 523 .I path_to_rmmod
 524 .IP
 525 Specify the location of the rmmod tool used to unload kernel modules.
 526 .br
 527
 528 Default is '/sbin/rmmod'.
 529 .PP
 530
 531 .BR lcov_tmp_dir " ="
 532 .I temp
 533 .IP
 534 Specify the location of a directory used for temporary files.
 535 .br
 536
 537 Default is '/tmp'.
 538 .PP
 539
 540 .SH FILES
 541
 542 .TP
 543 .I /etc/lcovrc
 544 The system\-wide
 545 .B lcov
 546 configuration file.
 547
 548 .TP
 549 .I ~/.lcovrc
 550 The individual per\-user configuration file.
 551 .PP
 552
 553 .SH SEE ALSO
 554 .BR lcov (1),
 555 .BR genhtml (1),
 556 .BR geninfo (1),
 557 .BR gcov (1)