ceedling 1.1.6 → 1.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/Gemfile +4 -0
  4. data/Gemfile.lock +2 -0
  5. data/README.md +4 -1
  6. data/docs/Changelog.md +11 -0
  7. data/docs/KnownIssues.md +1 -0
  8. data/docs/mkdocs/configuration/project-file.md +25 -7
  9. data/docs/mkdocs/configuration/reference/cexception.md +1 -1
  10. data/docs/mkdocs/configuration/reference/cmock.md +1 -1
  11. data/docs/mkdocs/configuration/reference/unity.md +1 -1
  12. data/docs/mkdocs/getting-started/quick-start.md +11 -8
  13. data/docs/mkdocs/plugins/gcov/gcovr.md +324 -189
  14. data/docs/mkdocs/plugins/gcov/reportgenerator.md +113 -31
  15. data/docs/mkdocs/reference/gcov-plugin.md +21 -3
  16. data/docs/mkdocs/snapshot/plugins/gcov/config/defaults.yml +0 -1
  17. data/lib/ceedling/generators/generator_test_results_backtrace.rb +16 -8
  18. data/lib/ceedling/plugins/plugin_reportinator.rb +9 -0
  19. data/lib/ceedling/plugins/report_tests_stdout_plugin.rb +1 -1
  20. data/lib/version.rb +1 -1
  21. data/plugins/gcov/config/defaults.yml +0 -1
  22. data/plugins/gcov/lib/gcov.rb +35 -16
  23. data/plugins/gcov/lib/gcovr_reportinator.rb +31 -1
  24. data/plugins/valgrind/lib/valgrind.rb +1 -1
  25. data/site-local/configuration/project-file.html +78 -8
  26. data/site-local/configuration/reference/cexception.html +5 -5
  27. data/site-local/configuration/reference/cmock.html +5 -5
  28. data/site-local/configuration/reference/unity.html +5 -5
  29. data/site-local/getting-started/quick-start.html +13 -9
  30. data/site-local/plugins/gcov/gcovr.html +1215 -255
  31. data/site-local/plugins/gcov/reportgenerator.html +404 -46
  32. data/site-local/reference/gcov-plugin.html +40 -7
  33. data/site-local/sitemap.xml.gz +0 -0
  34. data/site-local/snapshot/plugins/gcov/config/defaults.yml +0 -1
  35. data/spec/support/system/system_context.rb +7 -3
  36. data/spec/system/deployment_as_gem_spec.rb +2 -0
  37. data/spec/system/deployment_as_vendor_spec.rb +2 -0
  38. data/spec/system/gcov_deployment_spec.rb +2 -0
  39. data/spec/system/support/common_test_cases.rb +42 -0
  40. data/spec/system/support/gcov_common_test_cases.rb +52 -0
  41. data/spec/units/generators/generator_test_results_backtrace_spec.rb +51 -0
  42. data/spec/units/plugin_reportinator_spec.rb +38 -0
  43. metadata +4 -2
@@ -2994,13 +2994,327 @@
2994
2994
  </span>
2995
2995
  </a>
2996
2996
 
2997
+ </li>
2998
+
2999
+ </ul>
3000
+ </nav>
3001
+
3002
+ </li>
3003
+
3004
+ <li class="md-nav__item">
3005
+ <a href="#plugin-configuration" class="md-nav__link">
3006
+ <span class="md-ellipsis">
3007
+
3008
+ Plugin configuration
3009
+
3010
+ </span>
3011
+ </a>
3012
+
3013
+ <nav class="md-nav" aria-label="Plugin configuration">
3014
+ <ul class="md-nav__list">
3015
+
3016
+ <li class="md-nav__item">
3017
+ <a href="#report_root" class="md-nav__link">
3018
+ <span class="md-ellipsis">
3019
+
3020
+ :report_root
3021
+
3022
+ </span>
3023
+ </a>
3024
+
3025
+ </li>
3026
+
3027
+ <li class="md-nav__item">
3028
+ <a href="#config_file" class="md-nav__link">
3029
+ <span class="md-ellipsis">
3030
+
3031
+ :config_file
3032
+
3033
+ </span>
3034
+ </a>
3035
+
3036
+ </li>
3037
+
3038
+ <li class="md-nav__item">
3039
+ <a href="#fail_under_line" class="md-nav__link">
3040
+ <span class="md-ellipsis">
3041
+
3042
+ :fail_under_line
3043
+
3044
+ </span>
3045
+ </a>
3046
+
3047
+ </li>
3048
+
3049
+ <li class="md-nav__item">
3050
+ <a href="#fail_under_branch" class="md-nav__link">
3051
+ <span class="md-ellipsis">
3052
+
3053
+ :fail_under_branch
3054
+
3055
+ </span>
3056
+ </a>
3057
+
3058
+ </li>
3059
+
3060
+ <li class="md-nav__item">
3061
+ <a href="#fail_under_decision" class="md-nav__link">
3062
+ <span class="md-ellipsis">
3063
+
3064
+ :fail_under_decision
3065
+
3066
+ </span>
3067
+ </a>
3068
+
3069
+ </li>
3070
+
3071
+ <li class="md-nav__item">
3072
+ <a href="#decisions" class="md-nav__link">
3073
+ <span class="md-ellipsis">
3074
+
3075
+ :decisions
3076
+
3077
+ </span>
3078
+ </a>
3079
+
3080
+ </li>
3081
+
3082
+ <li class="md-nav__item">
3083
+ <a href="#fail_under_function" class="md-nav__link">
3084
+ <span class="md-ellipsis">
3085
+
3086
+ :fail_under_function
3087
+
3088
+ </span>
3089
+ </a>
3090
+
3091
+ </li>
3092
+
3093
+ <li class="md-nav__item">
3094
+ <a href="#exception_on_fail" class="md-nav__link">
3095
+ <span class="md-ellipsis">
3096
+
3097
+ :exception_on_fail
3098
+
3099
+ </span>
3100
+ </a>
3101
+
3102
+ </li>
3103
+
3104
+ <li class="md-nav__item">
3105
+ <a href="#source_encoding" class="md-nav__link">
3106
+ <span class="md-ellipsis">
3107
+
3108
+ :source_encoding
3109
+
3110
+ </span>
3111
+ </a>
3112
+
3113
+ </li>
3114
+
3115
+ <li class="md-nav__item">
3116
+ <a href="#branches" class="md-nav__link">
3117
+ <span class="md-ellipsis">
3118
+
3119
+ :branches
3120
+
3121
+ </span>
3122
+ </a>
3123
+
3124
+ </li>
3125
+
3126
+ <li class="md-nav__item">
3127
+ <a href="#sort_uncovered" class="md-nav__link">
3128
+ <span class="md-ellipsis">
3129
+
3130
+ :sort_uncovered
3131
+
3132
+ </span>
3133
+ </a>
3134
+
3135
+ </li>
3136
+
3137
+ <li class="md-nav__item">
3138
+ <a href="#sort_percentage" class="md-nav__link">
3139
+ <span class="md-ellipsis">
3140
+
3141
+ :sort_percentage
3142
+
3143
+ </span>
3144
+ </a>
3145
+
3146
+ </li>
3147
+
3148
+ <li class="md-nav__item">
3149
+ <a href="#print_summary" class="md-nav__link">
3150
+ <span class="md-ellipsis">
3151
+
3152
+ :print_summary
3153
+
3154
+ </span>
3155
+ </a>
3156
+
3157
+ </li>
3158
+
3159
+ <li class="md-nav__item">
3160
+ <a href="#report_include" class="md-nav__link">
3161
+ <span class="md-ellipsis">
3162
+
3163
+ :report_include
3164
+
3165
+ </span>
3166
+ </a>
3167
+
3168
+ </li>
3169
+
3170
+ <li class="md-nav__item">
3171
+ <a href="#report_exclude" class="md-nav__link">
3172
+ <span class="md-ellipsis">
3173
+
3174
+ :report_exclude
3175
+
3176
+ </span>
3177
+ </a>
3178
+
3179
+ </li>
3180
+
3181
+ <li class="md-nav__item">
3182
+ <a href="#gcov_filter" class="md-nav__link">
3183
+ <span class="md-ellipsis">
3184
+
3185
+ :gcov_filter
3186
+
3187
+ </span>
3188
+ </a>
3189
+
3190
+ </li>
3191
+
3192
+ <li class="md-nav__item">
3193
+ <a href="#gcov_exclude" class="md-nav__link">
3194
+ <span class="md-ellipsis">
3195
+
3196
+ :gcov_exclude
3197
+
3198
+ </span>
3199
+ </a>
3200
+
3201
+ </li>
3202
+
3203
+ <li class="md-nav__item">
3204
+ <a href="#exclude_directories" class="md-nav__link">
3205
+ <span class="md-ellipsis">
3206
+
3207
+ :exclude_directories
3208
+
3209
+ </span>
3210
+ </a>
3211
+
3212
+ </li>
3213
+
3214
+ <li class="md-nav__item">
3215
+ <a href="#gcov_executable" class="md-nav__link">
3216
+ <span class="md-ellipsis">
3217
+
3218
+ :gcov_executable
3219
+
3220
+ </span>
3221
+ </a>
3222
+
3223
+ </li>
3224
+
3225
+ <li class="md-nav__item">
3226
+ <a href="#exclude_unreachable_branches" class="md-nav__link">
3227
+ <span class="md-ellipsis">
3228
+
3229
+ :exclude_unreachable_branches
3230
+
3231
+ </span>
3232
+ </a>
3233
+
2997
3234
  </li>
2998
3235
 
2999
3236
  <li class="md-nav__item">
3000
- <a href="#plugin-project-configuration" class="md-nav__link">
3237
+ <a href="#exclude_throw_branches" class="md-nav__link">
3001
3238
  <span class="md-ellipsis">
3002
3239
 
3003
- Plugin project configuration
3240
+ :exclude_throw_branches
3241
+
3242
+ </span>
3243
+ </a>
3244
+
3245
+ </li>
3246
+
3247
+ <li class="md-nav__item">
3248
+ <a href="#merge_mode_function" class="md-nav__link">
3249
+ <span class="md-ellipsis">
3250
+
3251
+ :merge_mode_function
3252
+
3253
+ </span>
3254
+ </a>
3255
+
3256
+ </li>
3257
+
3258
+ <li class="md-nav__item">
3259
+ <a href="#use_gcov_files" class="md-nav__link">
3260
+ <span class="md-ellipsis">
3261
+
3262
+ :use_gcov_files
3263
+
3264
+ </span>
3265
+ </a>
3266
+
3267
+ </li>
3268
+
3269
+ <li class="md-nav__item">
3270
+ <a href="#gcov_ignore_parse_errors" class="md-nav__link">
3271
+ <span class="md-ellipsis">
3272
+
3273
+ :gcov_ignore_parse_errors
3274
+
3275
+ </span>
3276
+ </a>
3277
+
3278
+ </li>
3279
+
3280
+ <li class="md-nav__item">
3281
+ <a href="#object_directory" class="md-nav__link">
3282
+ <span class="md-ellipsis">
3283
+
3284
+ :object_directory
3285
+
3286
+ </span>
3287
+ </a>
3288
+
3289
+ </li>
3290
+
3291
+ <li class="md-nav__item">
3292
+ <a href="#keep" class="md-nav__link">
3293
+ <span class="md-ellipsis">
3294
+
3295
+ :keep
3296
+
3297
+ </span>
3298
+ </a>
3299
+
3300
+ </li>
3301
+
3302
+ <li class="md-nav__item">
3303
+ <a href="#delete" class="md-nav__link">
3304
+ <span class="md-ellipsis">
3305
+
3306
+ :delete
3307
+
3308
+ </span>
3309
+ </a>
3310
+
3311
+ </li>
3312
+
3313
+ <li class="md-nav__item">
3314
+ <a href="#threads" class="md-nav__link">
3315
+ <span class="md-ellipsis">
3316
+
3317
+ :threads
3004
3318
 
3005
3319
  </span>
3006
3320
  </a>
@@ -3021,6 +3335,78 @@
3021
3335
  </span>
3022
3336
  </a>
3023
3337
 
3338
+ <nav class="md-nav" aria-label="HTML reports">
3339
+ <ul class="md-nav__list">
3340
+
3341
+ <li class="md-nav__item">
3342
+ <a href="#html_artifact_filename" class="md-nav__link">
3343
+ <span class="md-ellipsis">
3344
+
3345
+ :html_artifact_filename
3346
+
3347
+ </span>
3348
+ </a>
3349
+
3350
+ </li>
3351
+
3352
+ <li class="md-nav__item">
3353
+ <a href="#html_title" class="md-nav__link">
3354
+ <span class="md-ellipsis">
3355
+
3356
+ :html_title
3357
+
3358
+ </span>
3359
+ </a>
3360
+
3361
+ </li>
3362
+
3363
+ <li class="md-nav__item">
3364
+ <a href="#html_medium_threshold" class="md-nav__link">
3365
+ <span class="md-ellipsis">
3366
+
3367
+ :html_medium_threshold
3368
+
3369
+ </span>
3370
+ </a>
3371
+
3372
+ </li>
3373
+
3374
+ <li class="md-nav__item">
3375
+ <a href="#html_high_threshold" class="md-nav__link">
3376
+ <span class="md-ellipsis">
3377
+
3378
+ :html_high_threshold
3379
+
3380
+ </span>
3381
+ </a>
3382
+
3383
+ </li>
3384
+
3385
+ <li class="md-nav__item">
3386
+ <a href="#html_absolute_paths" class="md-nav__link">
3387
+ <span class="md-ellipsis">
3388
+
3389
+ :html_absolute_paths
3390
+
3391
+ </span>
3392
+ </a>
3393
+
3394
+ </li>
3395
+
3396
+ <li class="md-nav__item">
3397
+ <a href="#html_encoding" class="md-nav__link">
3398
+ <span class="md-ellipsis">
3399
+
3400
+ :html_encoding
3401
+
3402
+ </span>
3403
+ </a>
3404
+
3405
+ </li>
3406
+
3407
+ </ul>
3408
+ </nav>
3409
+
3024
3410
  </li>
3025
3411
 
3026
3412
  <li class="md-nav__item">
@@ -3032,6 +3418,34 @@
3032
3418
  </span>
3033
3419
  </a>
3034
3420
 
3421
+ <nav class="md-nav" aria-label="Cobertura XML reports">
3422
+ <ul class="md-nav__list">
3423
+
3424
+ <li class="md-nav__item">
3425
+ <a href="#cobertura_pretty" class="md-nav__link">
3426
+ <span class="md-ellipsis">
3427
+
3428
+ :cobertura_pretty
3429
+
3430
+ </span>
3431
+ </a>
3432
+
3433
+ </li>
3434
+
3435
+ <li class="md-nav__item">
3436
+ <a href="#cobertura_artifact_filename" class="md-nav__link">
3437
+ <span class="md-ellipsis">
3438
+
3439
+ :cobertura_artifact_filename
3440
+
3441
+ </span>
3442
+ </a>
3443
+
3444
+ </li>
3445
+
3446
+ </ul>
3447
+ </nav>
3448
+
3035
3449
  </li>
3036
3450
 
3037
3451
  <li class="md-nav__item">
@@ -3043,6 +3457,23 @@
3043
3457
  </span>
3044
3458
  </a>
3045
3459
 
3460
+ <nav class="md-nav" aria-label="SonarQube XML reports">
3461
+ <ul class="md-nav__list">
3462
+
3463
+ <li class="md-nav__item">
3464
+ <a href="#sonarqube_artifact_filename" class="md-nav__link">
3465
+ <span class="md-ellipsis">
3466
+
3467
+ :sonarqube_artifact_filename
3468
+
3469
+ </span>
3470
+ </a>
3471
+
3472
+ </li>
3473
+
3474
+ </ul>
3475
+ </nav>
3476
+
3046
3477
  </li>
3047
3478
 
3048
3479
  <li class="md-nav__item">
@@ -3054,6 +3485,34 @@
3054
3485
  </span>
3055
3486
  </a>
3056
3487
 
3488
+ <nav class="md-nav" aria-label="JSON reports">
3489
+ <ul class="md-nav__list">
3490
+
3491
+ <li class="md-nav__item">
3492
+ <a href="#json_pretty" class="md-nav__link">
3493
+ <span class="md-ellipsis">
3494
+
3495
+ :json_pretty
3496
+
3497
+ </span>
3498
+ </a>
3499
+
3500
+ </li>
3501
+
3502
+ <li class="md-nav__item">
3503
+ <a href="#json_artifact_filename" class="md-nav__link">
3504
+ <span class="md-ellipsis">
3505
+
3506
+ :json_artifact_filename
3507
+
3508
+ </span>
3509
+ </a>
3510
+
3511
+ </li>
3512
+
3513
+ </ul>
3514
+ </nav>
3515
+
3057
3516
  </li>
3058
3517
 
3059
3518
  <li class="md-nav__item">
@@ -3065,6 +3524,23 @@
3065
3524
  </span>
3066
3525
  </a>
3067
3526
 
3527
+ <nav class="md-nav" aria-label="Text reports">
3528
+ <ul class="md-nav__list">
3529
+
3530
+ <li class="md-nav__item">
3531
+ <a href="#text_artifact_filename" class="md-nav__link">
3532
+ <span class="md-ellipsis">
3533
+
3534
+ :text_artifact_filename
3535
+
3536
+ </span>
3537
+ </a>
3538
+
3539
+ </li>
3540
+
3541
+ </ul>
3542
+ </nav>
3543
+
3068
3544
  </li>
3069
3545
 
3070
3546
  </ul>
@@ -4070,81 +4546,445 @@
4070
4546
 
4071
4547
 
4072
4548
 
4073
- <span class="md-ellipsis">
4074
-
4075
-
4076
- Rake Task Plugin
4549
+ <span class="md-ellipsis">
4550
+
4551
+
4552
+ Rake Task Plugin
4553
+
4554
+
4555
+
4556
+ </span>
4557
+
4558
+
4559
+
4560
+ </a>
4561
+ </li>
4562
+
4563
+
4564
+
4565
+
4566
+ </ul>
4567
+ </nav>
4568
+
4569
+ </li>
4570
+
4571
+
4572
+
4573
+
4574
+ </ul>
4575
+ </nav>
4576
+
4577
+ </li>
4578
+
4579
+
4580
+
4581
+ </ul>
4582
+ </nav>
4583
+ </div>
4584
+ </div>
4585
+ </div>
4586
+
4587
+
4588
+
4589
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
4590
+ <div class="md-sidebar__scrollwrap">
4591
+ <div class="md-sidebar__inner">
4592
+
4593
+
4594
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
4595
+
4596
+
4597
+
4598
+
4599
+
4600
+
4601
+ <label class="md-nav__title" for="__toc">
4602
+ <span class="md-nav__icon md-icon"></span>
4603
+ Table of contents
4604
+ </label>
4605
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
4606
+
4607
+ <li class="md-nav__item">
4608
+ <a href="#gcovr-options" class="md-nav__link">
4609
+ <span class="md-ellipsis">
4610
+
4611
+ GCovr options
4612
+
4613
+ </span>
4614
+ </a>
4615
+
4616
+ <nav class="md-nav" aria-label="GCovr options">
4617
+ <ul class="md-nav__list">
4618
+
4619
+ <li class="md-nav__item">
4620
+ <a href="#project-config-vs-gcovr-config-file" class="md-nav__link">
4621
+ <span class="md-ellipsis">
4622
+
4623
+ Project config vs. GCovr config file
4624
+
4625
+ </span>
4626
+ </a>
4627
+
4628
+ </li>
4629
+
4630
+ <li class="md-nav__item">
4631
+ <a href="#gcovr-configuration-file" class="md-nav__link">
4632
+ <span class="md-ellipsis">
4633
+
4634
+ Gcovr configuration file
4635
+
4636
+ </span>
4637
+ </a>
4638
+
4639
+ </li>
4640
+
4641
+ </ul>
4642
+ </nav>
4643
+
4644
+ </li>
4645
+
4646
+ <li class="md-nav__item">
4647
+ <a href="#plugin-configuration" class="md-nav__link">
4648
+ <span class="md-ellipsis">
4649
+
4650
+ Plugin configuration
4651
+
4652
+ </span>
4653
+ </a>
4654
+
4655
+ <nav class="md-nav" aria-label="Plugin configuration">
4656
+ <ul class="md-nav__list">
4657
+
4658
+ <li class="md-nav__item">
4659
+ <a href="#report_root" class="md-nav__link">
4660
+ <span class="md-ellipsis">
4661
+
4662
+ :report_root
4663
+
4664
+ </span>
4665
+ </a>
4666
+
4667
+ </li>
4668
+
4669
+ <li class="md-nav__item">
4670
+ <a href="#config_file" class="md-nav__link">
4671
+ <span class="md-ellipsis">
4672
+
4673
+ :config_file
4674
+
4675
+ </span>
4676
+ </a>
4677
+
4678
+ </li>
4679
+
4680
+ <li class="md-nav__item">
4681
+ <a href="#fail_under_line" class="md-nav__link">
4682
+ <span class="md-ellipsis">
4683
+
4684
+ :fail_under_line
4685
+
4686
+ </span>
4687
+ </a>
4688
+
4689
+ </li>
4690
+
4691
+ <li class="md-nav__item">
4692
+ <a href="#fail_under_branch" class="md-nav__link">
4693
+ <span class="md-ellipsis">
4694
+
4695
+ :fail_under_branch
4696
+
4697
+ </span>
4698
+ </a>
4699
+
4700
+ </li>
4701
+
4702
+ <li class="md-nav__item">
4703
+ <a href="#fail_under_decision" class="md-nav__link">
4704
+ <span class="md-ellipsis">
4705
+
4706
+ :fail_under_decision
4707
+
4708
+ </span>
4709
+ </a>
4710
+
4711
+ </li>
4712
+
4713
+ <li class="md-nav__item">
4714
+ <a href="#decisions" class="md-nav__link">
4715
+ <span class="md-ellipsis">
4716
+
4717
+ :decisions
4718
+
4719
+ </span>
4720
+ </a>
4721
+
4722
+ </li>
4723
+
4724
+ <li class="md-nav__item">
4725
+ <a href="#fail_under_function" class="md-nav__link">
4726
+ <span class="md-ellipsis">
4727
+
4728
+ :fail_under_function
4729
+
4730
+ </span>
4731
+ </a>
4732
+
4733
+ </li>
4734
+
4735
+ <li class="md-nav__item">
4736
+ <a href="#exception_on_fail" class="md-nav__link">
4737
+ <span class="md-ellipsis">
4738
+
4739
+ :exception_on_fail
4740
+
4741
+ </span>
4742
+ </a>
4743
+
4744
+ </li>
4745
+
4746
+ <li class="md-nav__item">
4747
+ <a href="#source_encoding" class="md-nav__link">
4748
+ <span class="md-ellipsis">
4749
+
4750
+ :source_encoding
4751
+
4752
+ </span>
4753
+ </a>
4754
+
4755
+ </li>
4756
+
4757
+ <li class="md-nav__item">
4758
+ <a href="#branches" class="md-nav__link">
4759
+ <span class="md-ellipsis">
4760
+
4761
+ :branches
4762
+
4763
+ </span>
4764
+ </a>
4765
+
4766
+ </li>
4767
+
4768
+ <li class="md-nav__item">
4769
+ <a href="#sort_uncovered" class="md-nav__link">
4770
+ <span class="md-ellipsis">
4771
+
4772
+ :sort_uncovered
4773
+
4774
+ </span>
4775
+ </a>
4776
+
4777
+ </li>
4778
+
4779
+ <li class="md-nav__item">
4780
+ <a href="#sort_percentage" class="md-nav__link">
4781
+ <span class="md-ellipsis">
4782
+
4783
+ :sort_percentage
4784
+
4785
+ </span>
4786
+ </a>
4787
+
4788
+ </li>
4789
+
4790
+ <li class="md-nav__item">
4791
+ <a href="#print_summary" class="md-nav__link">
4792
+ <span class="md-ellipsis">
4793
+
4794
+ :print_summary
4795
+
4796
+ </span>
4797
+ </a>
4798
+
4799
+ </li>
4800
+
4801
+ <li class="md-nav__item">
4802
+ <a href="#report_include" class="md-nav__link">
4803
+ <span class="md-ellipsis">
4804
+
4805
+ :report_include
4806
+
4807
+ </span>
4808
+ </a>
4809
+
4810
+ </li>
4811
+
4812
+ <li class="md-nav__item">
4813
+ <a href="#report_exclude" class="md-nav__link">
4814
+ <span class="md-ellipsis">
4815
+
4816
+ :report_exclude
4817
+
4818
+ </span>
4819
+ </a>
4820
+
4821
+ </li>
4822
+
4823
+ <li class="md-nav__item">
4824
+ <a href="#gcov_filter" class="md-nav__link">
4825
+ <span class="md-ellipsis">
4826
+
4827
+ :gcov_filter
4828
+
4829
+ </span>
4830
+ </a>
4831
+
4832
+ </li>
4833
+
4834
+ <li class="md-nav__item">
4835
+ <a href="#gcov_exclude" class="md-nav__link">
4836
+ <span class="md-ellipsis">
4837
+
4838
+ :gcov_exclude
4839
+
4840
+ </span>
4841
+ </a>
4842
+
4843
+ </li>
4844
+
4845
+ <li class="md-nav__item">
4846
+ <a href="#exclude_directories" class="md-nav__link">
4847
+ <span class="md-ellipsis">
4848
+
4849
+ :exclude_directories
4850
+
4851
+ </span>
4852
+ </a>
4853
+
4854
+ </li>
4855
+
4856
+ <li class="md-nav__item">
4857
+ <a href="#gcov_executable" class="md-nav__link">
4858
+ <span class="md-ellipsis">
4859
+
4860
+ :gcov_executable
4861
+
4862
+ </span>
4863
+ </a>
4077
4864
 
4078
-
4079
-
4080
- </span>
4865
+ </li>
4866
+
4867
+ <li class="md-nav__item">
4868
+ <a href="#exclude_unreachable_branches" class="md-nav__link">
4869
+ <span class="md-ellipsis">
4870
+
4871
+ :exclude_unreachable_branches
4872
+
4873
+ </span>
4874
+ </a>
4081
4875
 
4876
+ </li>
4877
+
4878
+ <li class="md-nav__item">
4879
+ <a href="#exclude_throw_branches" class="md-nav__link">
4880
+ <span class="md-ellipsis">
4881
+
4882
+ :exclude_throw_branches
4883
+
4884
+ </span>
4885
+ </a>
4082
4886
 
4083
-
4084
- </a>
4085
- </li>
4887
+ </li>
4888
+
4889
+ <li class="md-nav__item">
4890
+ <a href="#merge_mode_function" class="md-nav__link">
4891
+ <span class="md-ellipsis">
4892
+
4893
+ :merge_mode_function
4894
+
4895
+ </span>
4896
+ </a>
4086
4897
 
4087
-
4088
-
4089
-
4090
- </ul>
4091
- </nav>
4898
+ </li>
4899
+
4900
+ <li class="md-nav__item">
4901
+ <a href="#use_gcov_files" class="md-nav__link">
4902
+ <span class="md-ellipsis">
4092
4903
 
4093
- </li>
4904
+ :use_gcov_files
4905
+
4906
+ </span>
4907
+ </a>
4094
4908
 
4095
-
4096
-
4097
-
4098
- </ul>
4099
- </nav>
4909
+ </li>
4910
+
4911
+ <li class="md-nav__item">
4912
+ <a href="#gcov_ignore_parse_errors" class="md-nav__link">
4913
+ <span class="md-ellipsis">
4100
4914
 
4101
- </li>
4915
+ :gcov_ignore_parse_errors
4916
+
4917
+ </span>
4918
+ </a>
4102
4919
 
4103
-
4104
-
4105
- </ul>
4106
- </nav>
4107
- </div>
4108
- </div>
4109
- </div>
4110
-
4111
-
4112
-
4113
- <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
4114
- <div class="md-sidebar__scrollwrap">
4115
- <div class="md-sidebar__inner">
4116
-
4117
-
4118
- <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
4920
+ </li>
4921
+
4922
+ <li class="md-nav__item">
4923
+ <a href="#object_directory" class="md-nav__link">
4924
+ <span class="md-ellipsis">
4925
+
4926
+ :object_directory
4927
+
4928
+ </span>
4929
+ </a>
4119
4930
 
4931
+ </li>
4932
+
4933
+ <li class="md-nav__item">
4934
+ <a href="#keep" class="md-nav__link">
4935
+ <span class="md-ellipsis">
4936
+
4937
+ :keep
4938
+
4939
+ </span>
4940
+ </a>
4120
4941
 
4942
+ </li>
4943
+
4944
+ <li class="md-nav__item">
4945
+ <a href="#delete" class="md-nav__link">
4946
+ <span class="md-ellipsis">
4947
+
4948
+ :delete
4949
+
4950
+ </span>
4951
+ </a>
4121
4952
 
4122
-
4953
+ </li>
4954
+
4955
+ <li class="md-nav__item">
4956
+ <a href="#threads" class="md-nav__link">
4957
+ <span class="md-ellipsis">
4958
+
4959
+ :threads
4960
+
4961
+ </span>
4962
+ </a>
4123
4963
 
4964
+ </li>
4965
+
4966
+ </ul>
4967
+ </nav>
4124
4968
 
4125
- <label class="md-nav__title" for="__toc">
4126
- <span class="md-nav__icon md-icon"></span>
4127
- Table of contents
4128
- </label>
4129
- <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
4969
+ </li>
4130
4970
 
4131
4971
  <li class="md-nav__item">
4132
- <a href="#gcovr-options" class="md-nav__link">
4972
+ <a href="#html-reports" class="md-nav__link">
4133
4973
  <span class="md-ellipsis">
4134
4974
 
4135
- GCovr options
4975
+ HTML reports
4136
4976
 
4137
4977
  </span>
4138
4978
  </a>
4139
4979
 
4140
- <nav class="md-nav" aria-label="GCovr options">
4980
+ <nav class="md-nav" aria-label="HTML reports">
4141
4981
  <ul class="md-nav__list">
4142
4982
 
4143
4983
  <li class="md-nav__item">
4144
- <a href="#project-config-vs-gcovr-config-file" class="md-nav__link">
4984
+ <a href="#html_artifact_filename" class="md-nav__link">
4145
4985
  <span class="md-ellipsis">
4146
4986
 
4147
- Project config vs. GCovr config file
4987
+ :html_artifact_filename
4148
4988
 
4149
4989
  </span>
4150
4990
  </a>
@@ -4152,10 +4992,10 @@
4152
4992
  </li>
4153
4993
 
4154
4994
  <li class="md-nav__item">
4155
- <a href="#gcovr-configuration-file" class="md-nav__link">
4995
+ <a href="#html_title" class="md-nav__link">
4156
4996
  <span class="md-ellipsis">
4157
4997
 
4158
- Gcovr configuration file
4998
+ :html_title
4159
4999
 
4160
5000
  </span>
4161
5001
  </a>
@@ -4163,30 +5003,52 @@
4163
5003
  </li>
4164
5004
 
4165
5005
  <li class="md-nav__item">
4166
- <a href="#plugin-project-configuration" class="md-nav__link">
5006
+ <a href="#html_medium_threshold" class="md-nav__link">
4167
5007
  <span class="md-ellipsis">
4168
5008
 
4169
- Plugin project configuration
5009
+ :html_medium_threshold
4170
5010
 
4171
5011
  </span>
4172
5012
  </a>
4173
5013
 
4174
5014
  </li>
4175
5015
 
4176
- </ul>
4177
- </nav>
5016
+ <li class="md-nav__item">
5017
+ <a href="#html_high_threshold" class="md-nav__link">
5018
+ <span class="md-ellipsis">
5019
+
5020
+ :html_high_threshold
5021
+
5022
+ </span>
5023
+ </a>
4178
5024
 
4179
5025
  </li>
5026
+
5027
+ <li class="md-nav__item">
5028
+ <a href="#html_absolute_paths" class="md-nav__link">
5029
+ <span class="md-ellipsis">
4180
5030
 
4181
- <li class="md-nav__item">
4182
- <a href="#html-reports" class="md-nav__link">
5031
+ :html_absolute_paths
5032
+
5033
+ </span>
5034
+ </a>
5035
+
5036
+ </li>
5037
+
5038
+ <li class="md-nav__item">
5039
+ <a href="#html_encoding" class="md-nav__link">
4183
5040
  <span class="md-ellipsis">
4184
5041
 
4185
- HTML reports
5042
+ :html_encoding
4186
5043
 
4187
5044
  </span>
4188
5045
  </a>
4189
5046
 
5047
+ </li>
5048
+
5049
+ </ul>
5050
+ </nav>
5051
+
4190
5052
  </li>
4191
5053
 
4192
5054
  <li class="md-nav__item">
@@ -4198,6 +5060,34 @@
4198
5060
  </span>
4199
5061
  </a>
4200
5062
 
5063
+ <nav class="md-nav" aria-label="Cobertura XML reports">
5064
+ <ul class="md-nav__list">
5065
+
5066
+ <li class="md-nav__item">
5067
+ <a href="#cobertura_pretty" class="md-nav__link">
5068
+ <span class="md-ellipsis">
5069
+
5070
+ :cobertura_pretty
5071
+
5072
+ </span>
5073
+ </a>
5074
+
5075
+ </li>
5076
+
5077
+ <li class="md-nav__item">
5078
+ <a href="#cobertura_artifact_filename" class="md-nav__link">
5079
+ <span class="md-ellipsis">
5080
+
5081
+ :cobertura_artifact_filename
5082
+
5083
+ </span>
5084
+ </a>
5085
+
5086
+ </li>
5087
+
5088
+ </ul>
5089
+ </nav>
5090
+
4201
5091
  </li>
4202
5092
 
4203
5093
  <li class="md-nav__item">
@@ -4209,6 +5099,23 @@
4209
5099
  </span>
4210
5100
  </a>
4211
5101
 
5102
+ <nav class="md-nav" aria-label="SonarQube XML reports">
5103
+ <ul class="md-nav__list">
5104
+
5105
+ <li class="md-nav__item">
5106
+ <a href="#sonarqube_artifact_filename" class="md-nav__link">
5107
+ <span class="md-ellipsis">
5108
+
5109
+ :sonarqube_artifact_filename
5110
+
5111
+ </span>
5112
+ </a>
5113
+
5114
+ </li>
5115
+
5116
+ </ul>
5117
+ </nav>
5118
+
4212
5119
  </li>
4213
5120
 
4214
5121
  <li class="md-nav__item">
@@ -4220,6 +5127,34 @@
4220
5127
  </span>
4221
5128
  </a>
4222
5129
 
5130
+ <nav class="md-nav" aria-label="JSON reports">
5131
+ <ul class="md-nav__list">
5132
+
5133
+ <li class="md-nav__item">
5134
+ <a href="#json_pretty" class="md-nav__link">
5135
+ <span class="md-ellipsis">
5136
+
5137
+ :json_pretty
5138
+
5139
+ </span>
5140
+ </a>
5141
+
5142
+ </li>
5143
+
5144
+ <li class="md-nav__item">
5145
+ <a href="#json_artifact_filename" class="md-nav__link">
5146
+ <span class="md-ellipsis">
5147
+
5148
+ :json_artifact_filename
5149
+
5150
+ </span>
5151
+ </a>
5152
+
5153
+ </li>
5154
+
5155
+ </ul>
5156
+ </nav>
5157
+
4223
5158
  </li>
4224
5159
 
4225
5160
  <li class="md-nav__item">
@@ -4231,6 +5166,23 @@
4231
5166
  </span>
4232
5167
  </a>
4233
5168
 
5169
+ <nav class="md-nav" aria-label="Text reports">
5170
+ <ul class="md-nav__list">
5171
+
5172
+ <li class="md-nav__item">
5173
+ <a href="#text_artifact_filename" class="md-nav__link">
5174
+ <span class="md-ellipsis">
5175
+
5176
+ :text_artifact_filename
5177
+
5178
+ </span>
5179
+ </a>
5180
+
5181
+ </li>
5182
+
5183
+ </ul>
5184
+ </nav>
5185
+
4234
5186
  </li>
4235
5187
 
4236
5188
  </ul>
@@ -4348,22 +5300,26 @@ by the Gcov plugin.</p>
4348
5300
  <p>To preserve filtering of test and build files from coverage results when
4349
5301
  using a Gcovr config file, you must provide explicit exclusion patterns matching
4350
5302
  your project layout (example below).</p>
4351
- <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="k">[gcovr]</span>
4352
- <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="c1">; You will need to revise these example exclude patterns to match your</span>
4353
- <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="c1">; project directories and file naming as they cannot be automatically </span>
4354
- <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="c1">; provided to Gcovr when a Gcovr configuration file is in use.</span>
4355
- <a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>
4356
- <a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="c1">; Test path(s) exclusions for &#39;test_&#39; files with .c extensions. </span>
4357
- <a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="na">exclude</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">.*test.*/test_.+\.c$</span>
4358
- <a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>
4359
- <a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="c1">; Build path exlcude for all generated C files (runners, mocks, partials).</span>
4360
- <a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="na">exclude</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">.*build/.+\.c$</span>
5303
+ <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1">; You will need to revise these example exclude patterns to match your</span>
5304
+ <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="c1">; project directories and file naming as they cannot be automatically </span>
5305
+ <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="c1">; provided to Gcovr when a Gcovr configuration file is in use.</span>
5306
+ <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="c1">;</span>
5307
+ <a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="c1">; Note: Format is flat `key = value` lines with no `[section]` header.</span>
5308
+ <a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>
5309
+ <a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="c1">; Test path(s) exclusions for &#39;test_&#39; files with .c extensions. </span>
5310
+ <a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="na">exclude</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">.*test.*/test_.+\.c$</span>
5311
+ <a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>
5312
+ <a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="c1">; Build path exlcude for all generated C files (runners, mocks, partials).</span>
5313
+ <a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="na">exclude</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">.*build/.+\.c$</span>
4361
5314
  </code></pre></div>
4362
- <h3 id="plugin-project-configuration">Plugin project configuration</h3>
4363
- <p>The following is an exhaustive commented version of all GCovr configuration
4364
- options exposed through your project configuration file. Only specify those
4365
- you need or those whose defaults you need to override. You do not need to
4366
- include all these options in your Gcov plugin configuration.</p>
5315
+ <h2 id="plugin-configuration">Plugin configuration</h2>
5316
+ <p>The following options are exposed through your project configuration file, all
5317
+ beneath <code>:gcov</code> <code>:gcovr</code>. Only specify those you need or those whose defaults
5318
+ you need to override. You do not need to include all these options in your
5319
+ Gcov plugin configuration.</p>
5320
+ <h3 id="report_root"><code>:report_root</code></h3>
5321
+ <p>The root directory of your source files. File names are reported relative to
5322
+ this root. <code>:report_root</code> is also the default <code>:report_include</code>.</p>
4367
5323
  <div class="admonition warning">
4368
5324
  <p class="admonition-title"><code>gcovr</code> accepts only one reporting root path</p>
4369
5325
  <p><code>gcovr</code> accepts only a single path for <code>:report_root</code>. In unusual project
@@ -4371,197 +5327,201 @@ layouts, you may need to specify as root a parent folder that includes
4371
5327
  <em>all</em> source files and selectively exclude paths or files from coverage
4372
5328
  reporting (see <code>:report_exclude</code> and <code>:exclude_directories</code>).</p>
4373
5329
  </div>
4374
- <div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">:gcov</span><span class="p">:</span>
4375
- <a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="nt">:gcovr</span><span class="p">:</span>
4376
- <a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="c1"># The root directory of your source files. Defaults to &quot;.&quot;, the current directory.</span>
4377
- <a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="c1"># File names are reported relative to this root. The report_root is the default report_include.</span>
4378
- <a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="c1"># Default if unspecified: &quot;.&quot;</span>
4379
- <a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="nt">:report_root</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;path&gt;</span>
4380
- <a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>
4381
- <a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w"> </span><span class="c1"># Load the specified configuration file. (gcovr --config)</span>
4382
- <a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w"> </span><span class="c1"># Defaults to gcovr.cfg in the report_root directory if that file exists.</span>
4383
- <a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w"> </span><span class="c1">#</span>
4384
- <a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w"> </span><span class="c1"># When :config_file is set, Ceedling passes only --root and --config to</span>
4385
- <a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="w"> </span><span class="c1"># gcovr and defers all other configuration to the file. This prevents</span>
4386
- <a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="w"> </span><span class="c1"># Ceedling from overriding config file values with its CLI arguments. Only</span>
4387
- <a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="w"> </span><span class="c1"># :report_root is still applied because Ceedling may invoke gcovr from a</span>
4388
- <a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="w"> </span><span class="c1"># different working directory than your project root.</span>
4389
- <a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="w"> </span><span class="c1">#</span>
4390
- <a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a><span class="w"> </span><span class="c1"># To preserve the plugin’s base filtering behavior, include the following</span>
4391
- <a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a><span class="w"> </span><span class="c1"># patterns in your config file (adjust paths to match your project’s</span>
4392
- <a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a><span class="w"> </span><span class="c1"># :test_file_prefix, test paths, and :build_root settings):</span>
4393
- <a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a><span class="w"> </span><span class="c1">#</span>
4394
- <a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a><span class="w"> </span><span class="c1"># [gcovr]</span>
4395
- <a id="__codelineno-1-22" name="__codelineno-1-22" href="#__codelineno-1-22"></a><span class="w"> </span><span class="c1"># exclude = .*test.*/test_.+\.c$</span>
4396
- <a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a><span class="w"> </span><span class="c1"># exclude = .*build/.+\.c$</span>
4397
- <a id="__codelineno-1-24" name="__codelineno-1-24" href="#__codelineno-1-24"></a><span class="w"> </span><span class="nt">:config_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;config_file&gt;</span>
4398
- <a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a>
4399
- <a id="__codelineno-1-26" name="__codelineno-1-26" href="#__codelineno-1-26"></a><span class="w"> </span><span class="c1"># Exit with a status of 2 if the total line coverage is less than MIN percentage.</span>
4400
- <a id="__codelineno-1-27" name="__codelineno-1-27" href="#__codelineno-1-27"></a><span class="w"> </span><span class="c1"># Can be ORed with exit status of other fail options. (gcovr --fail-under-line)</span>
4401
- <a id="__codelineno-1-28" name="__codelineno-1-28" href="#__codelineno-1-28"></a><span class="w"> </span><span class="nt">:fail_under_line</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;1-100&gt;</span>
4402
- <a id="__codelineno-1-29" name="__codelineno-1-29" href="#__codelineno-1-29"></a>
4403
- <a id="__codelineno-1-30" name="__codelineno-1-30" href="#__codelineno-1-30"></a><span class="w"> </span><span class="c1"># Exit with a status of 4 if the total branch coverage is less than MIN percentage.</span>
4404
- <a id="__codelineno-1-31" name="__codelineno-1-31" href="#__codelineno-1-31"></a><span class="w"> </span><span class="c1"># Can be ORed with exit status of other fail options. (gcovr --fail-under-branch)</span>
4405
- <a id="__codelineno-1-32" name="__codelineno-1-32" href="#__codelineno-1-32"></a><span class="w"> </span><span class="nt">:fail_under_branch</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;1-100&gt;</span>
4406
- <a id="__codelineno-1-33" name="__codelineno-1-33" href="#__codelineno-1-33"></a>
4407
- <a id="__codelineno-1-34" name="__codelineno-1-34" href="#__codelineno-1-34"></a><span class="w"> </span><span class="c1"># Exit with a status of 8 if the total decision coverage is less than MIN percentage.</span>
4408
- <a id="__codelineno-1-35" name="__codelineno-1-35" href="#__codelineno-1-35"></a><span class="w"> </span><span class="c1"># Can be ORed with exit status of other fail options. (gcovr --fail-under-decision)</span>
4409
- <a id="__codelineno-1-36" name="__codelineno-1-36" href="#__codelineno-1-36"></a><span class="w"> </span><span class="nt">:fail_under_decision</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;1-100&gt;</span>
4410
- <a id="__codelineno-1-37" name="__codelineno-1-37" href="#__codelineno-1-37"></a>
4411
- <a id="__codelineno-1-38" name="__codelineno-1-38" href="#__codelineno-1-38"></a><span class="w"> </span><span class="c1"># Exit with a status of 16 if the total function coverage is less than MIN percentage.</span>
4412
- <a id="__codelineno-1-39" name="__codelineno-1-39" href="#__codelineno-1-39"></a><span class="w"> </span><span class="c1"># Can be ORed with exit status of other fail options. (gcovr --fail-under-function)</span>
4413
- <a id="__codelineno-1-40" name="__codelineno-1-40" href="#__codelineno-1-40"></a><span class="w"> </span><span class="nt">:fail_under_function</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;1-100&gt;</span>
4414
- <a id="__codelineno-1-41" name="__codelineno-1-41" href="#__codelineno-1-41"></a>
4415
- <a id="__codelineno-1-42" name="__codelineno-1-42" href="#__codelineno-1-42"></a><span class="w"> </span><span class="c1"># If the fail options above are set, specify whether those conditions should break a build.</span>
4416
- <a id="__codelineno-1-43" name="__codelineno-1-43" href="#__codelineno-1-43"></a><span class="w"> </span><span class="c1"># The default option is false and simply logs a warning without breaking the build.</span>
4417
- <a id="__codelineno-1-44" name="__codelineno-1-44" href="#__codelineno-1-44"></a><span class="w"> </span><span class="nt">:exception_on_fail</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4418
- <a id="__codelineno-1-45" name="__codelineno-1-45" href="#__codelineno-1-45"></a>
4419
- <a id="__codelineno-1-46" name="__codelineno-1-46" href="#__codelineno-1-46"></a><span class="w"> </span><span class="c1"># Select the source file encoding.</span>
4420
- <a id="__codelineno-1-47" name="__codelineno-1-47" href="#__codelineno-1-47"></a><span class="w"> </span><span class="c1"># Defaults to the system default encoding (UTF-8). (gcovr --source-encoding)</span>
4421
- <a id="__codelineno-1-48" name="__codelineno-1-48" href="#__codelineno-1-48"></a><span class="w"> </span><span class="nt">:source_encoding</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;encoding&gt;</span>
4422
- <a id="__codelineno-1-49" name="__codelineno-1-49" href="#__codelineno-1-49"></a>
4423
- <a id="__codelineno-1-50" name="__codelineno-1-50" href="#__codelineno-1-50"></a><span class="w"> </span><span class="c1"># Report the branch coverage instead of the line coverage. For text report only. (gcovr --branches).</span>
4424
- <a id="__codelineno-1-51" name="__codelineno-1-51" href="#__codelineno-1-51"></a><span class="w"> </span><span class="nt">:branches</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4425
- <a id="__codelineno-1-52" name="__codelineno-1-52" href="#__codelineno-1-52"></a>
4426
- <a id="__codelineno-1-53" name="__codelineno-1-53" href="#__codelineno-1-53"></a><span class="w"> </span><span class="c1"># Sort entries by increasing number of uncovered lines.</span>
4427
- <a id="__codelineno-1-54" name="__codelineno-1-54" href="#__codelineno-1-54"></a><span class="w"> </span><span class="c1"># For text and HTML report. (gcovr --sort-uncovered)</span>
4428
- <a id="__codelineno-1-55" name="__codelineno-1-55" href="#__codelineno-1-55"></a><span class="w"> </span><span class="nt">:sort_uncovered</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4429
- <a id="__codelineno-1-56" name="__codelineno-1-56" href="#__codelineno-1-56"></a>
4430
- <a id="__codelineno-1-57" name="__codelineno-1-57" href="#__codelineno-1-57"></a><span class="w"> </span><span class="c1"># Sort entries by increasing percentage of uncovered lines.</span>
4431
- <a id="__codelineno-1-58" name="__codelineno-1-58" href="#__codelineno-1-58"></a><span class="w"> </span><span class="c1"># For text and HTML report. (gcovr --sort-percentage)</span>
4432
- <a id="__codelineno-1-59" name="__codelineno-1-59" href="#__codelineno-1-59"></a><span class="w"> </span><span class="nt">:sort_percentage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4433
- <a id="__codelineno-1-60" name="__codelineno-1-60" href="#__codelineno-1-60"></a>
4434
- <a id="__codelineno-1-61" name="__codelineno-1-61" href="#__codelineno-1-61"></a><span class="w"> </span><span class="c1"># Print a small report to stdout with line &amp; branch percentage coverage.</span>
4435
- <a id="__codelineno-1-62" name="__codelineno-1-62" href="#__codelineno-1-62"></a><span class="w"> </span><span class="c1"># This is in addition to other reports. (gcovr --print-summary).</span>
4436
- <a id="__codelineno-1-63" name="__codelineno-1-63" href="#__codelineno-1-63"></a><span class="w"> </span><span class="nt">:print_summary</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4437
- <a id="__codelineno-1-64" name="__codelineno-1-64" href="#__codelineno-1-64"></a>
4438
- <a id="__codelineno-1-65" name="__codelineno-1-65" href="#__codelineno-1-65"></a><span class="w"> </span><span class="c1"># Keep only source files that match this filter. (gcovr --filter).</span>
4439
- <a id="__codelineno-1-66" name="__codelineno-1-66" href="#__codelineno-1-66"></a><span class="w"> </span><span class="c1"># Filters are regular expressions (ex: &quot;^src&quot;)</span>
4440
- <a id="__codelineno-1-67" name="__codelineno-1-67" href="#__codelineno-1-67"></a><span class="w"> </span><span class="nt">:report_include</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;filter&gt;</span>
4441
- <a id="__codelineno-1-68" name="__codelineno-1-68" href="#__codelineno-1-68"></a>
4442
- <a id="__codelineno-1-69" name="__codelineno-1-69" href="#__codelineno-1-69"></a><span class="w"> </span><span class="c1"># Exclude source files that match this filter. (gcovr --exclude).</span>
4443
- <a id="__codelineno-1-70" name="__codelineno-1-70" href="#__codelineno-1-70"></a><span class="w"> </span><span class="c1"># Filters are regular expressions (ex: &quot;^vendor.*|^build.*|^test.*|^lib.*&quot;)</span>
4444
- <a id="__codelineno-1-71" name="__codelineno-1-71" href="#__codelineno-1-71"></a><span class="w"> </span><span class="nt">:report_exclude</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;filter&gt;</span>
4445
- <a id="__codelineno-1-72" name="__codelineno-1-72" href="#__codelineno-1-72"></a>
4446
- <a id="__codelineno-1-73" name="__codelineno-1-73" href="#__codelineno-1-73"></a><span class="w"> </span><span class="c1"># Keep only gcov data files that match this filter. (gcovr --gcov-filter).</span>
4447
- <a id="__codelineno-1-74" name="__codelineno-1-74" href="#__codelineno-1-74"></a><span class="w"> </span><span class="c1"># Filters are regular expressions</span>
4448
- <a id="__codelineno-1-75" name="__codelineno-1-75" href="#__codelineno-1-75"></a><span class="w"> </span><span class="nt">:gcov_filter</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;filter&gt;</span>
4449
- <a id="__codelineno-1-76" name="__codelineno-1-76" href="#__codelineno-1-76"></a>
4450
- <a id="__codelineno-1-77" name="__codelineno-1-77" href="#__codelineno-1-77"></a><span class="w"> </span><span class="c1"># Exclude gcov data files that match this filter. (gcovr --gcov-exclude).</span>
4451
- <a id="__codelineno-1-78" name="__codelineno-1-78" href="#__codelineno-1-78"></a><span class="w"> </span><span class="c1"># Filters are regular expressions</span>
4452
- <a id="__codelineno-1-79" name="__codelineno-1-79" href="#__codelineno-1-79"></a><span class="w"> </span><span class="nt">:gcov_exclude</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;filter&gt;</span>
4453
- <a id="__codelineno-1-80" name="__codelineno-1-80" href="#__codelineno-1-80"></a>
4454
- <a id="__codelineno-1-81" name="__codelineno-1-81" href="#__codelineno-1-81"></a><span class="w"> </span><span class="c1"># Exclude directories that match this filter while searching </span>
4455
- <a id="__codelineno-1-82" name="__codelineno-1-82" href="#__codelineno-1-82"></a><span class="w"> </span><span class="c1"># raw coverage files. (gcovr --exclude-directories).</span>
4456
- <a id="__codelineno-1-83" name="__codelineno-1-83" href="#__codelineno-1-83"></a><span class="w"> </span><span class="c1"># Filters are regular expressions</span>
4457
- <a id="__codelineno-1-84" name="__codelineno-1-84" href="#__codelineno-1-84"></a><span class="w"> </span><span class="nt">:exclude_directories</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;filters&gt;</span>
4458
- <a id="__codelineno-1-85" name="__codelineno-1-85" href="#__codelineno-1-85"></a>
4459
- <a id="__codelineno-1-86" name="__codelineno-1-86" href="#__codelineno-1-86"></a><span class="w"> </span><span class="c1"># Use a particular gcov executable. (gcovr --gcov-executable).</span>
4460
- <a id="__codelineno-1-87" name="__codelineno-1-87" href="#__codelineno-1-87"></a><span class="w"> </span><span class="c1"># (This may be appropriate and necessary in special circumstances.</span>
4461
- <a id="__codelineno-1-88" name="__codelineno-1-88" href="#__codelineno-1-88"></a><span class="w"> </span><span class="c1"># Please review Ceedling’s options for modifying tools first.)</span>
4462
- <a id="__codelineno-1-89" name="__codelineno-1-89" href="#__codelineno-1-89"></a><span class="w"> </span><span class="nt">:gcov_executable</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;cmd&gt;</span>
4463
- <a id="__codelineno-1-90" name="__codelineno-1-90" href="#__codelineno-1-90"></a>
4464
- <a id="__codelineno-1-91" name="__codelineno-1-91" href="#__codelineno-1-91"></a><span class="w"> </span><span class="c1"># Exclude branch coverage from lines without useful</span>
4465
- <a id="__codelineno-1-92" name="__codelineno-1-92" href="#__codelineno-1-92"></a><span class="w"> </span><span class="c1"># source code. (gcovr --exclude-unreachable-branches).</span>
4466
- <a id="__codelineno-1-93" name="__codelineno-1-93" href="#__codelineno-1-93"></a><span class="w"> </span><span class="nt">:exclude_unreachable_branches</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4467
- <a id="__codelineno-1-94" name="__codelineno-1-94" href="#__codelineno-1-94"></a>
4468
- <a id="__codelineno-1-95" name="__codelineno-1-95" href="#__codelineno-1-95"></a><span class="w"> </span><span class="c1"># For branch coverage, exclude branches that the compiler</span>
4469
- <a id="__codelineno-1-96" name="__codelineno-1-96" href="#__codelineno-1-96"></a><span class="w"> </span><span class="c1"># generates for exception handling. (gcovr --exclude-throw-branches).</span>
4470
- <a id="__codelineno-1-97" name="__codelineno-1-97" href="#__codelineno-1-97"></a><span class="w"> </span><span class="nt">:exclude_throw_branches</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4471
- <a id="__codelineno-1-98" name="__codelineno-1-98" href="#__codelineno-1-98"></a>
4472
- <a id="__codelineno-1-99" name="__codelineno-1-99" href="#__codelineno-1-99"></a><span class="w"> </span><span class="c1"># For Gcovr 6.0+, multiple instances of the same function in coverage results can</span>
4473
- <a id="__codelineno-1-100" name="__codelineno-1-100" href="#__codelineno-1-100"></a><span class="w"> </span><span class="c1"># cause a fatal error. Since Ceedling can test multiple build variations of the</span>
4474
- <a id="__codelineno-1-101" name="__codelineno-1-101" href="#__codelineno-1-101"></a><span class="w"> </span><span class="c1"># same source function, this is bad.</span>
4475
- <a id="__codelineno-1-102" name="__codelineno-1-102" href="#__codelineno-1-102"></a><span class="w"> </span><span class="c1"># Default value for Gcov plugin is &#39;merge-use-line-max&#39;. See Gcovr docs for more.</span>
4476
- <a id="__codelineno-1-103" name="__codelineno-1-103" href="#__codelineno-1-103"></a><span class="w"> </span><span class="c1"># https://gcovr.com/en/stable/guide/merging.html</span>
4477
- <a id="__codelineno-1-104" name="__codelineno-1-104" href="#__codelineno-1-104"></a><span class="w"> </span><span class="nt">:merge_mode_function</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;...&gt;</span>
4478
- <a id="__codelineno-1-105" name="__codelineno-1-105" href="#__codelineno-1-105"></a>
4479
- <a id="__codelineno-1-106" name="__codelineno-1-106" href="#__codelineno-1-106"></a><span class="w"> </span><span class="c1"># Use existing gcov files for analysis. Default: False. (gcovr --use-gcov-files)</span>
4480
- <a id="__codelineno-1-107" name="__codelineno-1-107" href="#__codelineno-1-107"></a><span class="w"> </span><span class="nt">:use_gcov_files</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4481
- <a id="__codelineno-1-108" name="__codelineno-1-108" href="#__codelineno-1-108"></a>
4482
- <a id="__codelineno-1-109" name="__codelineno-1-109" href="#__codelineno-1-109"></a><span class="w"> </span><span class="c1"># Skip lines with parse errors in GCOV files instead of</span>
4483
- <a id="__codelineno-1-110" name="__codelineno-1-110" href="#__codelineno-1-110"></a><span class="w"> </span><span class="c1"># exiting with an error. (gcovr --gcov-ignore-parse-errors).</span>
4484
- <a id="__codelineno-1-111" name="__codelineno-1-111" href="#__codelineno-1-111"></a><span class="w"> </span><span class="nt">:gcov_ignore_parse_errors</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4485
- <a id="__codelineno-1-112" name="__codelineno-1-112" href="#__codelineno-1-112"></a>
4486
- <a id="__codelineno-1-113" name="__codelineno-1-113" href="#__codelineno-1-113"></a><span class="w"> </span><span class="c1"># Override normal working directory detection. (gcovr --object-directory)</span>
4487
- <a id="__codelineno-1-114" name="__codelineno-1-114" href="#__codelineno-1-114"></a><span class="w"> </span><span class="nt">:object_directory</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;path&gt;</span>
4488
- <a id="__codelineno-1-115" name="__codelineno-1-115" href="#__codelineno-1-115"></a>
4489
- <a id="__codelineno-1-116" name="__codelineno-1-116" href="#__codelineno-1-116"></a><span class="w"> </span><span class="c1"># Keep gcov files after processing. (gcovr --keep).</span>
4490
- <a id="__codelineno-1-117" name="__codelineno-1-117" href="#__codelineno-1-117"></a><span class="w"> </span><span class="nt">:keep</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4491
- <a id="__codelineno-1-118" name="__codelineno-1-118" href="#__codelineno-1-118"></a>
4492
- <a id="__codelineno-1-119" name="__codelineno-1-119" href="#__codelineno-1-119"></a><span class="w"> </span><span class="c1"># Delete gcda files after processing. (gcovr --delete).</span>
4493
- <a id="__codelineno-1-120" name="__codelineno-1-120" href="#__codelineno-1-120"></a><span class="w"> </span><span class="nt">:delete</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4494
- <a id="__codelineno-1-121" name="__codelineno-1-121" href="#__codelineno-1-121"></a>
4495
- <a id="__codelineno-1-122" name="__codelineno-1-122" href="#__codelineno-1-122"></a><span class="w"> </span><span class="c1"># Set the number of threads to use in parallel. (gcovr -j).</span>
4496
- <a id="__codelineno-1-123" name="__codelineno-1-123" href="#__codelineno-1-123"></a><span class="w"> </span><span class="nt">:threads</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;count&gt;</span>
4497
- </code></pre></div>
5330
+ <p><strong>Default:</strong> <code>"."</code> (the current directory)</p>
5331
+ <hr />
5332
+ <h3 id="config_file"><code>:config_file</code></h3>
5333
+ <p>Load the specified <code>gcovr</code> configuration file. (<code>gcovr --config</code>)</p>
5334
+ <p>When <code>:config_file</code> is set, Ceedling passes only <code>--root</code> and <code>--config</code> to
5335
+ <code>gcovr</code> and defers all other configuration to the file. This prevents
5336
+ Ceedling from overriding config file values with its CLI arguments.
5337
+ <code>:report_root</code> is still applied because Ceedling may invoke <code>gcovr</code> from a
5338
+ different working directory than your project root.</p>
5339
+ <p>To preserve the plugin's base filtering behavior, include exclusion patterns
5340
+ matching your project layout in the config file itself see
5341
+ <a href="#gcovr-configuration-file">Gcovr configuration file</a> above.</p>
5342
+ <p><strong>Default:</strong> <code>gcovr.cfg</code> in the <code>:report_root</code> directory, if that file exists.</p>
5343
+ <hr />
5344
+ <h3 id="fail_under_line"><code>:fail_under_line</code></h3>
5345
+ <p>Exit with a status of 2 if the total line coverage is less than this minimum
5346
+ percentage. Can be ORed with the exit status of other <code>:fail_under_*</code> options.
5347
+ (<code>gcovr --fail-under-line</code>)</p>
5348
+ <p><strong>Values:</strong> <code>1</code>–<code>100</code></p>
5349
+ <hr />
5350
+ <h3 id="fail_under_branch"><code>:fail_under_branch</code></h3>
5351
+ <p>Exit with a status of 4 if the total branch coverage is less than this minimum
5352
+ percentage. Can be ORed with the exit status of other <code>:fail_under_*</code> options.
5353
+ (<code>gcovr --fail-under-branch</code>)</p>
5354
+ <p><strong>Values:</strong> <code>1</code>–<code>100</code></p>
5355
+ <hr />
5356
+ <h3 id="fail_under_decision"><code>:fail_under_decision</code></h3>
5357
+ <p>Exit with a status of 8 if the total decision coverage is less than this minimum
5358
+ percentage. Can be ORed with the exit status of other <code>:fail_under_*</code> options.
5359
+ (<code>gcovr --fail-under-decision</code>)</p>
5360
+ <p><code>gcovr</code> treats <code>--fail-under-decision</code> as a no-op without <code>--decisions</code> also
5361
+ present setting this option implies <code>:decisions</code> (below) automatically, so
5362
+ it's never silently non-functional.</p>
5363
+ <p><strong>Values:</strong> <code>1</code>–<code>100</code></p>
5364
+ <p><strong>Requires:</strong> <code>gcovr</code> 7.0 or higher</p>
5365
+ <hr />
5366
+ <h3 id="decisions"><code>:decisions</code></h3>
5367
+ <p>Report the decision coverage. For HTML, JSON, and the summary report.
5368
+ (<code>gcovr --decisions</code>)</p>
5369
+ <p>Implied automatically whenever <code>:fail_under_decision</code> is set.</p>
5370
+ <p><strong>Requires:</strong> <code>gcovr</code> 6.0 or higher</p>
5371
+ <hr />
5372
+ <h3 id="fail_under_function"><code>:fail_under_function</code></h3>
5373
+ <p>Exit with a status of 16 if the total function coverage is less than this minimum
5374
+ percentage. Can be ORed with the exit status of other <code>:fail_under_*</code> options.
5375
+ (<code>gcovr --fail-under-function</code>)</p>
5376
+ <p><strong>Values:</strong> <code>1</code>–<code>100</code></p>
5377
+ <hr />
5378
+ <h3 id="exception_on_fail"><code>:exception_on_fail</code></h3>
5379
+ <p>If any <code>:fail_under_*</code> option above is set and its condition is met, specifies
5380
+ whether that condition should break the build. When disabled, Ceedling simply
5381
+ logs a warning without breaking the build.</p>
5382
+ <p><strong>Default:</strong> <code>false</code></p>
5383
+ <hr />
5384
+ <h3 id="source_encoding"><code>:source_encoding</code></h3>
5385
+ <p>Select the source file character encoding. (<code>gcovr --source-encoding</code>)</p>
5386
+ <p><strong>Default:</strong> the system default encoding (typically <code>UTF-8</code>)</p>
5387
+ <hr />
5388
+ <h3 id="branches"><code>:branches</code></h3>
5389
+ <p>Report the branch coverage instead of the line coverage. Applies to the text
5390
+ report only. (<code>gcovr --branches</code>)</p>
5391
+ <hr />
5392
+ <h3 id="sort_uncovered"><code>:sort_uncovered</code></h3>
5393
+ <p>Sort entries by increasing number of uncovered lines. Applies to text and HTML
5394
+ reports. (<code>gcovr --sort-uncovered</code>)</p>
5395
+ <hr />
5396
+ <h3 id="sort_percentage"><code>:sort_percentage</code></h3>
5397
+ <p>Sort entries by increasing percentage of uncovered lines. Applies to text and
5398
+ HTML reports. (<code>gcovr --sort-percentage</code>)</p>
5399
+ <hr />
5400
+ <h3 id="print_summary"><code>:print_summary</code></h3>
5401
+ <p>Print a small report to stdout with line and branch percentage coverage. This
5402
+ is in addition to any other configured reports. (<code>gcovr --print-summary</code>)</p>
5403
+ <hr />
5404
+ <h3 id="report_include"><code>:report_include</code></h3>
5405
+ <p>Keep only source files that match this filter. Filters are regular
5406
+ expressions. (<code>gcovr --filter</code>)</p>
5407
+ <p><strong>Example:</strong> <code>"^src"</code></p>
5408
+ <hr />
5409
+ <h3 id="report_exclude"><code>:report_exclude</code></h3>
5410
+ <p>Exclude source files that match this filter. Filters are regular expressions.
5411
+ (<code>gcovr --exclude</code>)</p>
5412
+ <p><strong>Example:</strong> <code>"^vendor.*|^build.*|^test.*|^lib.*"</code></p>
5413
+ <hr />
5414
+ <h3 id="gcov_filter"><code>:gcov_filter</code></h3>
5415
+ <p>Keep only <code>.gcov</code> data files that match this filter. Filters are regular
5416
+ expressions. (<code>gcovr --gcov-filter</code>)</p>
5417
+ <hr />
5418
+ <h3 id="gcov_exclude"><code>:gcov_exclude</code></h3>
5419
+ <p>Exclude <code>.gcov</code> data files that match this filter. Filters are regular
5420
+ expressions. (<code>gcovr --gcov-exclude</code>)</p>
5421
+ <hr />
5422
+ <h3 id="exclude_directories"><code>:exclude_directories</code></h3>
5423
+ <p>Exclude directories that match this filter while searching for raw coverage
5424
+ files. Filters are regular expressions. (<code>gcovr --exclude-directories</code>)</p>
5425
+ <hr />
5426
+ <h3 id="gcov_executable"><code>:gcov_executable</code></h3>
5427
+ <p>Use a particular <code>gcov</code> executable. This may be appropriate and necessary in
5428
+ special circumstances review Ceedling's options for modifying tools first.
5429
+ (<code>gcovr --gcov-executable</code>)</p>
5430
+ <hr />
5431
+ <h3 id="exclude_unreachable_branches"><code>:exclude_unreachable_branches</code></h3>
5432
+ <p>Exclude branch coverage from lines without useful source code.
5433
+ (<code>gcovr --exclude-unreachable-branches</code>)</p>
5434
+ <hr />
5435
+ <h3 id="exclude_throw_branches"><code>:exclude_throw_branches</code></h3>
5436
+ <p>For branch coverage, exclude branches that the compiler generates for
5437
+ exception handling. (<code>gcovr --exclude-throw-branches</code>)</p>
5438
+ <hr />
5439
+ <h3 id="merge_mode_function"><code>:merge_mode_function</code></h3>
5440
+ <p>For <code>gcovr</code> 6.0+, multiple instances of the same function in coverage results
5441
+ can cause a fatal error. Since Ceedling can test multiple build variations of
5442
+ the same source function, this is a real risk. This option controls how
5443
+ <code>gcovr</code> merges those repeated entries. See the
5444
+ <a href="https://gcovr.com/en/stable/guide/merging.html">gcovr merging docs</a> for all
5445
+ valid values. Ignored on <code>gcovr</code> versions below 6.0.</p>
5446
+ <p><strong>Default:</strong> <code>merge-use-line-max</code> (<code>gcovr</code>'s own default, <code>strict</code>, raises an
5447
+ exception for many Ceedling projects)</p>
5448
+ <hr />
5449
+ <h3 id="use_gcov_files"><code>:use_gcov_files</code></h3>
5450
+ <p>Use existing <code>.gcov</code> files for analysis instead of running <code>gcov</code> again.
5451
+ (<code>gcovr --use-gcov-files</code>)</p>
5452
+ <p><strong>Default:</strong> <code>false</code></p>
5453
+ <hr />
5454
+ <h3 id="gcov_ignore_parse_errors"><code>:gcov_ignore_parse_errors</code></h3>
5455
+ <p>Skip lines with parse errors in <code>.gcov</code> files instead of exiting with an
5456
+ error. (<code>gcovr --gcov-ignore-parse-errors</code>)</p>
5457
+ <hr />
5458
+ <h3 id="object_directory"><code>:object_directory</code></h3>
5459
+ <p>Override normal working directory detection for <code>.gcda</code>/<code>.gcno</code> files.
5460
+ (<code>gcovr --object-directory</code>)</p>
5461
+ <hr />
5462
+ <h3 id="keep"><code>:keep</code></h3>
5463
+ <p>Keep intermediate <code>.gcov</code> files after processing. (<code>gcovr --keep</code>)</p>
5464
+ <hr />
5465
+ <h3 id="delete"><code>:delete</code></h3>
5466
+ <p>Delete <code>.gcda</code> files after processing. (<code>gcovr --delete</code>)</p>
5467
+ <hr />
5468
+ <h3 id="threads"><code>:threads</code></h3>
5469
+ <p>Set the number of threads <code>gcovr</code> uses in parallel. (<code>gcovr -j</code>)</p>
4498
5470
  <h2 id="html-reports">HTML reports</h2>
4499
5471
  <p>Generation of HTML reports may be modified with the following configuration items.</p>
4500
- <div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="nt">:gcov</span><span class="p">:</span>
4501
- <a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span><span class="nt">:gcovr</span><span class="p">:</span>
4502
- <a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="c1"># HTML report filename.</span>
4503
- <a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w"> </span><span class="nt">:html_artifact_filename</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;filename&gt;</span>
4504
- <a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>
4505
- <a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w"> </span><span class="c1"># Use &#39;title&#39; as title for the HTML report.</span>
4506
- <a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="w"> </span><span class="c1"># Default is &#39;Head&#39;. (gcovr --html-title)</span>
4507
- <a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="w"> </span><span class="nt">:html_title</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;title&gt;</span>
4508
- <a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a>
4509
- <a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="w"> </span><span class="c1"># If the coverage is below MEDIUM, the value is marked as low coverage in the HTML report.</span>
4510
- <a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="w"> </span><span class="c1"># MEDIUM has to be lower than or equal to value of html_high_threshold.</span>
4511
- <a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="w"> </span><span class="c1"># If MEDIUM is equal to value of html_high_threshold the report has only high and low coverage.</span>
4512
- <a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a><span class="w"> </span><span class="c1"># Default is 75.0. (gcovr --html-medium-threshold)</span>
4513
- <a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a><span class="w"> </span><span class="nt">:html_medium_threshold</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">75</span>
4514
- <a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a>
4515
- <a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a><span class="w"> </span><span class="c1"># If the coverage is below HIGH, the value is marked as medium coverage in the HTML report.</span>
4516
- <a id="__codelineno-2-17" name="__codelineno-2-17" href="#__codelineno-2-17"></a><span class="w"> </span><span class="c1"># HIGH has to be greater than or equal to value of html_medium_threshold.</span>
4517
- <a id="__codelineno-2-18" name="__codelineno-2-18" href="#__codelineno-2-18"></a><span class="w"> </span><span class="c1"># If HIGH is equal to value of html_medium_threshold the report has only high and low coverage.</span>
4518
- <a id="__codelineno-2-19" name="__codelineno-2-19" href="#__codelineno-2-19"></a><span class="w"> </span><span class="c1"># Default is 90.0. (gcovr -html-high-threshold)</span>
4519
- <a id="__codelineno-2-20" name="__codelineno-2-20" href="#__codelineno-2-20"></a><span class="w"> </span><span class="nt">:html_high_threshold</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">90</span>
4520
- <a id="__codelineno-2-21" name="__codelineno-2-21" href="#__codelineno-2-21"></a>
4521
- <a id="__codelineno-2-22" name="__codelineno-2-22" href="#__codelineno-2-22"></a><span class="w"> </span><span class="c1"># Set to &#39;true&#39; to use absolute paths to link the &#39;detailed&#39; reports.</span>
4522
- <a id="__codelineno-2-23" name="__codelineno-2-23" href="#__codelineno-2-23"></a><span class="w"> </span><span class="c1"># Defaults to relative links. (gcovr --html-absolute-paths)</span>
4523
- <a id="__codelineno-2-24" name="__codelineno-2-24" href="#__codelineno-2-24"></a><span class="w"> </span><span class="nt">:html_absolute_paths</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4524
- <a id="__codelineno-2-25" name="__codelineno-2-25" href="#__codelineno-2-25"></a>
4525
- <a id="__codelineno-2-26" name="__codelineno-2-26" href="#__codelineno-2-26"></a><span class="w"> </span><span class="c1"># Override the declared HTML report encoding. Defaults to UTF-8. (gcovr --html-encoding)</span>
4526
- <a id="__codelineno-2-27" name="__codelineno-2-27" href="#__codelineno-2-27"></a><span class="w"> </span><span class="nt">:html_encoding</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;html_encoding&gt;</span>
4527
- </code></pre></div>
5472
+ <h3 id="html_artifact_filename"><code>:html_artifact_filename</code></h3>
5473
+ <p>Override the default HTML report output filename.</p>
5474
+ <hr />
5475
+ <h3 id="html_title"><code>:html_title</code></h3>
5476
+ <p>Use <code>title</code> as the title for the HTML report. (<code>gcovr --html-title</code>)</p>
5477
+ <p><strong>Default:</strong> <code>Head</code></p>
5478
+ <hr />
5479
+ <h3 id="html_medium_threshold"><code>:html_medium_threshold</code></h3>
5480
+ <p>If the coverage is below this value, it is marked as low coverage in the HTML
5481
+ report. Must be lower than or equal to <code>:html_high_threshold</code>. If equal to
5482
+ <code>:html_high_threshold</code>, the report has only high and low coverage.
5483
+ (<code>gcovr --html-medium-threshold</code>)</p>
5484
+ <p><strong>Default:</strong> <code>75.0</code></p>
5485
+ <hr />
5486
+ <h3 id="html_high_threshold"><code>:html_high_threshold</code></h3>
5487
+ <p>If the coverage is below this value, it is marked as medium coverage in the
5488
+ HTML report. Must be greater than or equal to <code>:html_medium_threshold</code>. If
5489
+ equal to <code>:html_medium_threshold</code>, the report has only high and low coverage.
5490
+ (<code>gcovr --html-high-threshold</code>)</p>
5491
+ <p><strong>Default:</strong> <code>90.0</code></p>
5492
+ <hr />
5493
+ <h3 id="html_absolute_paths"><code>:html_absolute_paths</code></h3>
5494
+ <p>Use absolute paths to link the "detailed" reports. Defaults to relative
5495
+ links. (<code>gcovr --html-absolute-paths</code>)</p>
5496
+ <hr />
5497
+ <h3 id="html_encoding"><code>:html_encoding</code></h3>
5498
+ <p>Override the declared HTML report encoding. (<code>gcovr --html-encoding</code>)</p>
5499
+ <p><strong>Default:</strong> <code>UTF-8</code></p>
4528
5500
  <h2 id="cobertura-xml-reports">Cobertura XML reports</h2>
4529
5501
  <p>Generation of Cobertura XML reports may be modified with the following configuration items.</p>
4530
- <div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nt">:gcov</span><span class="p">:</span>
4531
- <a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="nt">:gcovr</span><span class="p">:</span>
4532
- <a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="c1"># Set to &#39;true&#39; to pretty-print the Cobertura XML report, otherwise set to &#39;false&#39;.</span>
4533
- <a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="c1"># Defaults to disabled. (gcovr --xml-pretty)</span>
4534
- <a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="w"> </span><span class="nt">:cobertura_pretty</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4535
- <a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a>
4536
- <a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="w"> </span><span class="c1"># Override default Cobertura XML report filename.</span>
4537
- <a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a><span class="w"> </span><span class="nt">:cobertura_artifact_filename</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;filename&gt;</span>
4538
- </code></pre></div>
5502
+ <h3 id="cobertura_pretty"><code>:cobertura_pretty</code></h3>
5503
+ <p>Pretty-print the Cobertura XML report. (<code>gcovr --xml-pretty</code>)</p>
5504
+ <p><strong>Default:</strong> <code>false</code></p>
5505
+ <hr />
5506
+ <h3 id="cobertura_artifact_filename"><code>:cobertura_artifact_filename</code></h3>
5507
+ <p>Override the default Cobertura XML report output filename.</p>
4539
5508
  <h2 id="sonarqube-xml-reports">SonarQube XML reports</h2>
4540
5509
  <p>Generation of SonarQube XML reports may be modified with the following configuration items.</p>
4541
- <div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nt">:gcov</span><span class="p">:</span>
4542
- <a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="nt">:gcovr</span><span class="p">:</span>
4543
- <a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span><span class="c1"># Override default SonarQube XML report filename.</span>
4544
- <a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w"> </span><span class="nt">:sonarqube_artifact_filename</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;filename&gt;</span>
4545
- </code></pre></div>
5510
+ <h3 id="sonarqube_artifact_filename"><code>:sonarqube_artifact_filename</code></h3>
5511
+ <p>Override the default SonarQube XML report output filename.</p>
4546
5512
  <h2 id="json-reports">JSON reports</h2>
4547
5513
  <p>Generation of JSON reports may be modified with the following configuration items.</p>
4548
- <div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nt">:gcov</span><span class="p">:</span>
4549
- <a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="nt">:gcovr</span><span class="p">:</span>
4550
- <a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="c1"># Set to &#39;true&#39; to pretty-print the JSON report, otherwise set &#39;false&#39;.</span>
4551
- <a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span><span class="c1"># Defaults to disabled. (gcovr --json-pretty)</span>
4552
- <a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="w"> </span><span class="nt">:json_pretty</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;true|false&gt;</span>
4553
- <a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a>
4554
- <a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="w"> </span><span class="c1"># Override default JSON report filename.</span>
4555
- <a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a><span class="w"> </span><span class="nt">:json_artifact_filename</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;filename&gt;</span>
4556
- </code></pre></div>
5514
+ <h3 id="json_pretty"><code>:json_pretty</code></h3>
5515
+ <p>Pretty-print the JSON report. (<code>gcovr --json-pretty</code>)</p>
5516
+ <p><strong>Default:</strong> <code>false</code></p>
5517
+ <hr />
5518
+ <h3 id="json_artifact_filename"><code>:json_artifact_filename</code></h3>
5519
+ <p>Override the default JSON report output filename.</p>
4557
5520
  <h2 id="text-reports">Text reports</h2>
4558
5521
  <p>Generation of text reports may be modified with the following configuration items.
4559
5522
  Text reports may be printed to the console or output to a file.</p>
4560
- <div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="nt">:gcov</span><span class="p">:</span>
4561
- <a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="w"> </span><span class="nt">:gcovr</span><span class="p">:</span>
4562
- <a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="w"> </span><span class="c1"># Override default text report filename.</span>
4563
- <a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="w"> </span><span class="nt">:text_artifact_filename</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;filename&gt;</span>
4564
- </code></pre></div>
5523
+ <h3 id="text_artifact_filename"><code>:text_artifact_filename</code></h3>
5524
+ <p>Override the default text report output filename.</p>
4565
5525
  <p><br/><br/></p>
4566
5526
 
4567
5527