ceedling 1.1.0 → 1.1.1

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 (148) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +7 -4
  4. data/docs/Changelog.md +66 -38
  5. data/docs/KnownIssues.md +9 -0
  6. data/docs/ReleaseNotes.md +5 -1
  7. data/docs/mkdocs/getting-started/installation.md +8 -1
  8. data/docs/mkdocs/getting-started/quick-start.md +20 -2
  9. data/docs/mkdocs/help.md +2 -2
  10. data/docs/mkdocs/index.md +13 -6
  11. data/docs/mkdocs/overview/build-system.md +4 -4
  12. data/docs/mkdocs/plugins/bullseye.md +6 -0
  13. data/docs/mkdocs/plugins/command-hooks.md +20 -15
  14. data/docs/mkdocs/plugins/gcov/gcovr.md +130 -109
  15. data/docs/mkdocs/plugins/gcov/index.md +6 -0
  16. data/docs/mkdocs/plugins/index.md +40 -0
  17. data/docs/mkdocs/plugins/valgrind.md +6 -0
  18. data/docs/mkdocs/testing-guide/partials/index.md +22 -13
  19. data/lib/ceedling/config/configurator.rb +2 -1
  20. data/lib/ceedling/preprocess/preprocessinator.rb +3 -2
  21. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +27 -13
  22. data/lib/ceedling/test_invoker/test_build_executor.rb +3 -4
  23. data/lib/ceedling/test_invoker/test_build_planner.rb +0 -2
  24. data/lib/ceedling/test_invoker/test_invoker_types.rb +1 -1
  25. data/lib/ceedling/tool_executor.rb +5 -0
  26. data/lib/version.rb +1 -1
  27. data/plugins/command_hooks/lib/command_hooks.rb +4 -0
  28. data/plugins/gcov/lib/console_reportinator.rb +3 -1
  29. data/plugins/gcov/lib/gcov.rb +3 -3
  30. data/plugins/gcov/lib/gcov_reportinator.rb +4 -0
  31. data/plugins/gcov/lib/gcovr_reportinator.rb +61 -14
  32. data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -1
  33. data/site-local/404.html +3 -3
  34. data/site-local/assets/javascripts/{bundle.79ae519e.min.js → bundle.d7400e89.min.js} +2 -2
  35. data/site-local/assets/javascripts/{bundle.79ae519e.min.js.map → bundle.d7400e89.min.js.map} +2 -2
  36. data/site-local/assets/stylesheets/main.ec1eaa64.min.css +1 -0
  37. data/site-local/assets/stylesheets/{main.484c7ddc.min.css.map → main.ec1eaa64.min.css.map} +1 -1
  38. data/site-local/configuration/environment-vars.html +3 -3
  39. data/site-local/configuration/global-collections.html +3 -3
  40. data/site-local/configuration/index.html +3 -3
  41. data/site-local/configuration/loading.html +3 -3
  42. data/site-local/configuration/mixins.html +3 -3
  43. data/site-local/configuration/parallel-builds.html +3 -3
  44. data/site-local/configuration/project-file.html +3 -3
  45. data/site-local/configuration/reference/cexception.html +3 -3
  46. data/site-local/configuration/reference/cmock.html +3 -3
  47. data/site-local/configuration/reference/defines.html +3 -3
  48. data/site-local/configuration/reference/environment.html +3 -3
  49. data/site-local/configuration/reference/extension.html +3 -3
  50. data/site-local/configuration/reference/files.html +3 -3
  51. data/site-local/configuration/reference/flags.html +3 -3
  52. data/site-local/configuration/reference/index.html +3 -3
  53. data/site-local/configuration/reference/libraries.html +3 -3
  54. data/site-local/configuration/reference/mixins.html +3 -3
  55. data/site-local/configuration/reference/paths.html +3 -3
  56. data/site-local/configuration/reference/plugins.html +3 -3
  57. data/site-local/configuration/reference/project.html +3 -3
  58. data/site-local/configuration/reference/release-build.html +3 -3
  59. data/site-local/configuration/reference/test-build.html +3 -3
  60. data/site-local/configuration/reference/test-runner.html +3 -3
  61. data/site-local/configuration/reference/tools.html +3 -3
  62. data/site-local/configuration/reference/unity.html +3 -3
  63. data/site-local/configuration/which-ceedling.html +3 -3
  64. data/site-local/development/index.html +3 -3
  65. data/site-local/development/plugins/configuration.html +3 -3
  66. data/site-local/development/plugins/index.html +3 -3
  67. data/site-local/development/plugins/plugin-subclass.html +3 -3
  68. data/site-local/development/plugins/rake-tasks.html +3 -3
  69. data/site-local/development/workflow.html +3 -3
  70. data/site-local/getting-started/command-line.html +3 -3
  71. data/site-local/getting-started/example-projects/cipher-quest.html +3 -3
  72. data/site-local/getting-started/example-projects/index.html +3 -3
  73. data/site-local/getting-started/example-projects/temp-sensor.html +3 -3
  74. data/site-local/getting-started/example-projects/wondrous-forest.html +3 -3
  75. data/site-local/getting-started/index.html +3 -3
  76. data/site-local/getting-started/installation.html +12 -4
  77. data/site-local/getting-started/quick-start.html +18 -4
  78. data/site-local/help.html +4 -4
  79. data/site-local/index.html +13 -8
  80. data/site-local/overview/build-system.html +6 -6
  81. data/site-local/overview/index.html +3 -3
  82. data/site-local/overview/test-environments.html +3 -3
  83. data/site-local/overview/tools-and-frameworks.html +3 -3
  84. data/site-local/plugins/beep.html +3 -3
  85. data/site-local/plugins/bullseye.html +9 -3
  86. data/site-local/plugins/command-hooks.html +42 -38
  87. data/site-local/plugins/compile-commands-json-db.html +3 -3
  88. data/site-local/plugins/cppcheck.html +3 -3
  89. data/site-local/plugins/dependencies.html +3 -3
  90. data/site-local/plugins/fff.html +3 -3
  91. data/site-local/plugins/gcov/examples.html +3 -3
  92. data/site-local/plugins/gcov/gcovr.html +325 -227
  93. data/site-local/plugins/gcov/index.html +9 -3
  94. data/site-local/plugins/gcov/overview.html +3 -3
  95. data/site-local/plugins/gcov/reportgenerator.html +3 -3
  96. data/site-local/plugins/gcov/reporting.html +3 -3
  97. data/site-local/plugins/gcov/setup.html +3 -3
  98. data/site-local/plugins/gcov/tool-versions.html +3 -3
  99. data/site-local/plugins/gcov/troubleshooting.html +3 -3
  100. data/site-local/plugins/index.html +79 -15
  101. data/site-local/plugins/module-generator.html +3 -3
  102. data/site-local/plugins/report-build-warnings-log.html +3 -3
  103. data/site-local/plugins/report-tests-gtestlike-stdout.html +3 -3
  104. data/site-local/plugins/report-tests-ide-stdout.html +3 -3
  105. data/site-local/plugins/report-tests-log-factory.html +3 -3
  106. data/site-local/plugins/report-tests-pretty-stdout.html +3 -3
  107. data/site-local/plugins/report-tests-raw-output-log.html +3 -3
  108. data/site-local/plugins/report-tests-teamcity-stdout.html +3 -3
  109. data/site-local/plugins/valgrind.html +9 -3
  110. data/site-local/project/release-history.html +3 -3
  111. data/site-local/project/upgrade.html +3 -3
  112. data/site-local/reference/build-directives.html +3 -3
  113. data/site-local/reference/command-line.html +3 -3
  114. data/site-local/reference/environment-vars.html +3 -3
  115. data/site-local/reference/gcov-plugin.html +3 -3
  116. data/site-local/reference/global-collections.html +3 -3
  117. data/site-local/reference/index.html +3 -3
  118. data/site-local/reference/partials-macros.html +3 -3
  119. data/site-local/reference/project-configuration.html +3 -3
  120. data/site-local/sitemap.xml.gz +0 -0
  121. data/site-local/snapshot/examples/cipher_quest/index.html +3 -3
  122. data/site-local/snapshot/examples/temp_sensor/index.html +3 -3
  123. data/site-local/snapshot/examples/wondrous_forest/index.html +3 -3
  124. data/site-local/testing-guide/build-directives.html +3 -3
  125. data/site-local/testing-guide/conventions.html +3 -3
  126. data/site-local/testing-guide/frameworks.html +3 -3
  127. data/site-local/testing-guide/index.html +3 -3
  128. data/site-local/testing-guide/partials/configuration.html +3 -3
  129. data/site-local/testing-guide/partials/conventions.html +3 -3
  130. data/site-local/testing-guide/partials/directives.html +3 -3
  131. data/site-local/testing-guide/partials/example.html +3 -3
  132. data/site-local/testing-guide/partials/index.html +25 -16
  133. data/site-local/testing-guide/partials/overview.html +3 -3
  134. data/site-local/testing-guide/partials/variables.html +3 -3
  135. data/site-local/testing-guide/test-cases.html +3 -3
  136. data/site-local/testing-guide/test-sample.html +3 -3
  137. data/site-local/testing-guide/test-suite-anatomy.html +3 -3
  138. data/spec/support/system/system_context.rb +3 -1
  139. data/spec/system/support/gcov_common_test_cases.rb +4 -1
  140. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +155 -0
  141. data/spec/units/test_build_executor_spec.rb +114 -0
  142. data/vendor/unity/auto/generate_test_runner.rb +55 -5
  143. data/vendor/unity/src/unity.h +1 -1
  144. data/vendor/unity/test/testdata/testRunnerGeneratorEmpty.c +13 -0
  145. data/vendor/unity/test/tests/test_generate_test_runner.rb +11 -0
  146. metadata +9 -7
  147. data/site-local/assets/stylesheets/main.484c7ddc.min.css +0 -1
  148. data/vendor/unity/auto/run_test.erb +0 -37
data/site-local/plugins/gcov/gcovr.html CHANGED
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
25
25
 
26
26
 
27
27
 
@@ -29,7 +29,7 @@
29
29
 
30
30
 
31
31
 
32
- <link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
32
+ <link rel="stylesheet" href="../../assets/stylesheets/main.ec1eaa64.min.css">
33
33
 
34
34
 
35
35
  <link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
@@ -2932,6 +2932,56 @@
2932
2932
  </label>
2933
2933
  <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2934
2934
 
2935
+ <li class="md-nav__item">
2936
+ <a href="#gcovr-options" class="md-nav__link">
2937
+ <span class="md-ellipsis">
2938
+
2939
+ GCovr options
2940
+
2941
+ </span>
2942
+ </a>
2943
+
2944
+ <nav class="md-nav" aria-label="GCovr options">
2945
+ <ul class="md-nav__list">
2946
+
2947
+ <li class="md-nav__item">
2948
+ <a href="#project-config-vs-gcovr-config-file" class="md-nav__link">
2949
+ <span class="md-ellipsis">
2950
+
2951
+ Project config vs. GCovr config file
2952
+
2953
+ </span>
2954
+ </a>
2955
+
2956
+ </li>
2957
+
2958
+ <li class="md-nav__item">
2959
+ <a href="#gcovr-configuration-file" class="md-nav__link">
2960
+ <span class="md-ellipsis">
2961
+
2962
+ Gcovr configuration file
2963
+
2964
+ </span>
2965
+ </a>
2966
+
2967
+ </li>
2968
+
2969
+ <li class="md-nav__item">
2970
+ <a href="#plugin-project-configuration" class="md-nav__link">
2971
+ <span class="md-ellipsis">
2972
+
2973
+ Plugin project configuration
2974
+
2975
+ </span>
2976
+ </a>
2977
+
2978
+ </li>
2979
+
2980
+ </ul>
2981
+ </nav>
2982
+
2983
+ </li>
2984
+
2935
2985
  <li class="md-nav__item">
2936
2986
  <a href="#html-reports" class="md-nav__link">
2937
2987
  <span class="md-ellipsis">
@@ -2985,17 +3035,6 @@
2985
3035
  </span>
2986
3036
  </a>
2987
3037
 
2988
- </li>
2989
-
2990
- <li class="md-nav__item">
2991
- <a href="#common-gcovr-options" class="md-nav__link">
2992
- <span class="md-ellipsis">
2993
-
2994
- Common GCovr options
2995
-
2996
- </span>
2997
- </a>
2998
-
2999
3038
  </li>
3000
3039
 
3001
3040
  </ul>
@@ -4059,6 +4098,56 @@
4059
4098
  </label>
4060
4099
  <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
4061
4100
 
4101
+ <li class="md-nav__item">
4102
+ <a href="#gcovr-options" class="md-nav__link">
4103
+ <span class="md-ellipsis">
4104
+
4105
+ GCovr options
4106
+
4107
+ </span>
4108
+ </a>
4109
+
4110
+ <nav class="md-nav" aria-label="GCovr options">
4111
+ <ul class="md-nav__list">
4112
+
4113
+ <li class="md-nav__item">
4114
+ <a href="#project-config-vs-gcovr-config-file" class="md-nav__link">
4115
+ <span class="md-ellipsis">
4116
+
4117
+ Project config vs. GCovr config file
4118
+
4119
+ </span>
4120
+ </a>
4121
+
4122
+ </li>
4123
+
4124
+ <li class="md-nav__item">
4125
+ <a href="#gcovr-configuration-file" class="md-nav__link">
4126
+ <span class="md-ellipsis">
4127
+
4128
+ Gcovr configuration file
4129
+
4130
+ </span>
4131
+ </a>
4132
+
4133
+ </li>
4134
+
4135
+ <li class="md-nav__item">
4136
+ <a href="#plugin-project-configuration" class="md-nav__link">
4137
+ <span class="md-ellipsis">
4138
+
4139
+ Plugin project configuration
4140
+
4141
+ </span>
4142
+ </a>
4143
+
4144
+ </li>
4145
+
4146
+ </ul>
4147
+ </nav>
4148
+
4149
+ </li>
4150
+
4062
4151
  <li class="md-nav__item">
4063
4152
  <a href="#html-reports" class="md-nav__link">
4064
4153
  <span class="md-ellipsis">
@@ -4112,17 +4201,6 @@
4112
4201
  </span>
4113
4202
  </a>
4114
4203
 
4115
- </li>
4116
-
4117
- <li class="md-nav__item">
4118
- <a href="#common-gcovr-options" class="md-nav__link">
4119
- <span class="md-ellipsis">
4120
-
4121
- Common GCovr options
4122
-
4123
- </span>
4124
- </a>
4125
-
4126
4204
  </li>
4127
4205
 
4128
4206
  </ul>
@@ -4212,227 +4290,247 @@
4212
4290
 
4213
4291
 
4214
4292
  <h1 id="gcovr-configuration">GCovr Configuration</h1>
4293
+ <div class="admonition note">
4294
+ <p class="admonition-title">Note</p>
4215
4295
  <p>All reports generated by <code>gcovr</code> are found in <code>&lt;build root&gt;/artifacts/gcov/gcovr/</code>.</p>
4216
- <h2 id="html-reports">HTML reports</h2>
4217
- <p>Generation of HTML reports may be modified with the following configuration items.</p>
4218
- <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">:gcov</span><span class="p">:</span>
4219
- <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nt">:gcovr</span><span class="p">:</span>
4220
- <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="c1"># HTML report filename.</span>
4221
- <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-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>
4296
+ </div>
4297
+ <p>The following sections first discuss GCovr options in common across reports
4298
+ and then break out report-specific options.</p>
4299
+ <h2 id="gcovr-options">GCovr options</h2>
4300
+ <h3 id="project-config-vs-gcovr-config-file">Project config vs. GCovr config file</h3>
4301
+ <p>GCovr can be configured in two ways:</p>
4302
+ <ol>
4303
+ <li>Using one or more of the options documented below in the <code>:gcov</code> section
4304
+ of your project configuration.</li>
4305
+ <li>Through a Gcovr configuration file (.ini format) provided to Gcovr via
4306
+ the speciial <code>:config_file</code> value in the <code>:gcov</code> section of your project
4307
+ configuration.</li>
4308
+ </ol>
4309
+ <h3 id="gcovr-configuration-file">Gcovr configuration file</h3>
4310
+ <div class="admonition warning">
4311
+ <p class="admonition-title">Using a gcovr configuration file</p>
4312
+ <p>When <code>:config_file</code> is set, Ceedling passes only <code>--root</code> (<code>:report_root</code>)
4313
+ and <code>--config</code> (<code>:config_file</code>) to <code>gcovr</code> at the command line from your
4314
+ plugin configuration. This prevents overriding config file settings with
4315
+ CLI arguments. You must provide any settings that would have been provided
4316
+ by the Gcov plugin.</p>
4317
+ </div>
4318
+ <p>To preserve filtering of test and build files from coverage results when
4319
+ using a Gcovr config file, you must provide explicit exclusion patterns matching
4320
+ your project layout (example below).</p>
4321
+ <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>
4322
+ <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>
4323
+ <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>
4324
+ <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>
4222
4325
  <a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>
4223
- <a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w"> </span><span class="c1"># Use &#39;title&#39; as title for the HTML report.</span>
4224
- <a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w"> </span><span class="c1"># Default is &#39;Head&#39;. (gcovr --html-title)</span>
4225
- <a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-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>
4226
- <a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>
4227
- <a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-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>
4228
- <a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="w"> </span><span class="c1"># MEDIUM has to be lower than or equal to value of html_high_threshold.</span>
4229
- <a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-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>
4230
- <a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="w"> </span><span class="c1"># Default is 75.0. (gcovr --html-medium-threshold)</span>
4231
- <a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-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>
4232
- <a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>
4233
- <a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-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>
4234
- <a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="w"> </span><span class="c1"># HIGH has to be greater than or equal to value of html_medium_threshold.</span>
4235
- <a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-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>
4236
- <a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a><span class="w"> </span><span class="c1"># Default is 90.0. (gcovr -html-high-threshold)</span>
4237
- <a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-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>
4238
- <a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>
4239
- <a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-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>
4240
- <a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a><span class="w"> </span><span class="c1"># Defaults to relative links. (gcovr --html-absolute-paths)</span>
4241
- <a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-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>
4242
- <a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a>
4243
- <a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a><span class="w"> </span><span class="c1"># Override the declared HTML report encoding. Defaults to UTF-8. (gcovr --html-encoding)</span>
4244
- <a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-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>
4326
+ <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>
4327
+ <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>
4328
+ <a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>
4329
+ <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>
4330
+ <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>
4245
4331
  </code></pre></div>
4246
- <h2 id="cobertura-xml-reports">Cobertura XML reports</h2>
4247
- <p>Generation of Cobertura XML reports may be modified with the following configuration items.</p>
4332
+ <h3 id="plugin-project-configuration">Plugin project configuration</h3>
4333
+ <p>The following is an exhaustive commented version of all GCovr configuration
4334
+ options exposed through your project configuration file. Only specify those
4335
+ you need or those whose defaults you need to override. You do not need to
4336
+ include all these options in your Gcov plugin configuration.</p>
4337
+ <div class="admonition warning">
4338
+ <p class="admonition-title"><code>gcovr</code> accepts only one reporting root path</p>
4339
+ <p><code>gcovr</code> accepts only a single path for <code>:report_root</code>. In unusual project
4340
+ layouts, you may need to specify as root a parent folder that includes
4341
+ <em>all</em> source files and selectively exclude paths or files from coverage
4342
+ reporting (see <code>:report_exclude</code> and <code>:exclude_directories</code>).</p>
4343
+ </div>
4248
4344
  <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>
4249
4345
  <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>
4250
- <a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-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>
4251
- <a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="c1"># Defaults to disabled. (gcovr --xml-pretty)</span>
4252
- <a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-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>
4253
- <a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>
4254
- <a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="c1"># Override default Cobertura XML report filename.</span>
4255
- <a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-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>
4346
+ <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>
4347
+ <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>
4348
+ <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>
4349
+ <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>
4350
+ <a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>
4351
+ <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>
4352
+ <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>
4353
+ <a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w"> </span><span class="c1">#</span>
4354
+ <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>
4355
+ <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>
4356
+ <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>
4357
+ <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>
4358
+ <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>
4359
+ <a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="w"> </span><span class="c1">#</span>
4360
+ <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>
4361
+ <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>
4362
+ <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>
4363
+ <a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a><span class="w"> </span><span class="c1">#</span>
4364
+ <a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a><span class="w"> </span><span class="c1"># [gcovr]</span>
4365
+ <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>
4366
+ <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>
4367
+ <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>
4368
+ <a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a>
4369
+ <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>
4370
+ <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>
4371
+ <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>
4372
+ <a id="__codelineno-1-29" name="__codelineno-1-29" href="#__codelineno-1-29"></a>
4373
+ <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>
4374
+ <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>
4375
+ <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>
4376
+ <a id="__codelineno-1-33" name="__codelineno-1-33" href="#__codelineno-1-33"></a>
4377
+ <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>
4378
+ <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>
4379
+ <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>
4380
+ <a id="__codelineno-1-37" name="__codelineno-1-37" href="#__codelineno-1-37"></a>
4381
+ <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>
4382
+ <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>
4383
+ <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>
4384
+ <a id="__codelineno-1-41" name="__codelineno-1-41" href="#__codelineno-1-41"></a>
4385
+ <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>
4386
+ <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>
4387
+ <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>
4388
+ <a id="__codelineno-1-45" name="__codelineno-1-45" href="#__codelineno-1-45"></a>
4389
+ <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>
4390
+ <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>
4391
+ <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>
4392
+ <a id="__codelineno-1-49" name="__codelineno-1-49" href="#__codelineno-1-49"></a>
4393
+ <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>
4394
+ <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>
4395
+ <a id="__codelineno-1-52" name="__codelineno-1-52" href="#__codelineno-1-52"></a>
4396
+ <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>
4397
+ <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>
4398
+ <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>
4399
+ <a id="__codelineno-1-56" name="__codelineno-1-56" href="#__codelineno-1-56"></a>
4400
+ <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>
4401
+ <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>
4402
+ <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>
4403
+ <a id="__codelineno-1-60" name="__codelineno-1-60" href="#__codelineno-1-60"></a>
4404
+ <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>
4405
+ <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>
4406
+ <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>
4407
+ <a id="__codelineno-1-64" name="__codelineno-1-64" href="#__codelineno-1-64"></a>
4408
+ <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>
4409
+ <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>
4410
+ <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>
4411
+ <a id="__codelineno-1-68" name="__codelineno-1-68" href="#__codelineno-1-68"></a>
4412
+ <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>
4413
+ <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>
4414
+ <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>
4415
+ <a id="__codelineno-1-72" name="__codelineno-1-72" href="#__codelineno-1-72"></a>
4416
+ <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>
4417
+ <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>
4418
+ <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>
4419
+ <a id="__codelineno-1-76" name="__codelineno-1-76" href="#__codelineno-1-76"></a>
4420
+ <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>
4421
+ <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>
4422
+ <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>
4423
+ <a id="__codelineno-1-80" name="__codelineno-1-80" href="#__codelineno-1-80"></a>
4424
+ <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>
4425
+ <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>
4426
+ <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>
4427
+ <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>
4428
+ <a id="__codelineno-1-85" name="__codelineno-1-85" href="#__codelineno-1-85"></a>
4429
+ <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>
4430
+ <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>
4431
+ <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>
4432
+ <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>
4433
+ <a id="__codelineno-1-90" name="__codelineno-1-90" href="#__codelineno-1-90"></a>
4434
+ <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>
4435
+ <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>
4436
+ <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>
4437
+ <a id="__codelineno-1-94" name="__codelineno-1-94" href="#__codelineno-1-94"></a>
4438
+ <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>
4439
+ <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>
4440
+ <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>
4441
+ <a id="__codelineno-1-98" name="__codelineno-1-98" href="#__codelineno-1-98"></a>
4442
+ <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>
4443
+ <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>
4444
+ <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>
4445
+ <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>
4446
+ <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>
4447
+ <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>
4448
+ <a id="__codelineno-1-105" name="__codelineno-1-105" href="#__codelineno-1-105"></a>
4449
+ <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>
4450
+ <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>
4451
+ <a id="__codelineno-1-108" name="__codelineno-1-108" href="#__codelineno-1-108"></a>
4452
+ <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>
4453
+ <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>
4454
+ <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>
4455
+ <a id="__codelineno-1-112" name="__codelineno-1-112" href="#__codelineno-1-112"></a>
4456
+ <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>
4457
+ <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>
4458
+ <a id="__codelineno-1-115" name="__codelineno-1-115" href="#__codelineno-1-115"></a>
4459
+ <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>
4460
+ <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>
4461
+ <a id="__codelineno-1-118" name="__codelineno-1-118" href="#__codelineno-1-118"></a>
4462
+ <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>
4463
+ <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>
4464
+ <a id="__codelineno-1-121" name="__codelineno-1-121" href="#__codelineno-1-121"></a>
4465
+ <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>
4466
+ <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>
4256
4467
  </code></pre></div>
4257
- <h2 id="sonarqube-xml-reports">SonarQube XML reports</h2>
4258
- <p>Generation of SonarQube XML reports may be modified with the following configuration items.</p>
4468
+ <h2 id="html-reports">HTML reports</h2>
4469
+ <p>Generation of HTML reports may be modified with the following configuration items.</p>
4259
4470
  <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>
4260
4471
  <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>
4261
- <a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="c1"># Override default SonarQube XML report filename.</span>
4262
- <a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-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>
4472
+ <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>
4473
+ <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>
4474
+ <a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>
4475
+ <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>
4476
+ <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>
4477
+ <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>
4478
+ <a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a>
4479
+ <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>
4480
+ <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>
4481
+ <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>
4482
+ <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>
4483
+ <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>
4484
+ <a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a>
4485
+ <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>
4486
+ <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>
4487
+ <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>
4488
+ <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>
4489
+ <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>
4490
+ <a id="__codelineno-2-21" name="__codelineno-2-21" href="#__codelineno-2-21"></a>
4491
+ <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>
4492
+ <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>
4493
+ <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>
4494
+ <a id="__codelineno-2-25" name="__codelineno-2-25" href="#__codelineno-2-25"></a>
4495
+ <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>
4496
+ <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>
4263
4497
  </code></pre></div>
4264
- <h2 id="json-reports">JSON reports</h2>
4265
- <p>Generation of JSON reports may be modified with the following configuration items.</p>
4498
+ <h2 id="cobertura-xml-reports">Cobertura XML reports</h2>
4499
+ <p>Generation of Cobertura XML reports may be modified with the following configuration items.</p>
4266
4500
  <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>
4267
4501
  <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>
4268
- <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 JSON report, otherwise set &#39;false&#39;.</span>
4269
- <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 --json-pretty)</span>
4270
- <a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-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>
4502
+ <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>
4503
+ <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>
4504
+ <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>
4271
4505
  <a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a>
4272
- <a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="w"> </span><span class="c1"># Override default JSON report filename.</span>
4273
- <a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-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>
4506
+ <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>
4507
+ <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>
4274
4508
  </code></pre></div>
4275
- <h2 id="text-reports">Text reports</h2>
4276
- <p>Generation of text reports may be modified with the following configuration items.
4277
- Text reports may be printed to the console or output to a file.</p>
4509
+ <h2 id="sonarqube-xml-reports">SonarQube XML reports</h2>
4510
+ <p>Generation of SonarQube XML reports may be modified with the following configuration items.</p>
4278
4511
  <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>
4279
4512
  <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>
4280
- <a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span><span class="c1"># Override default text report filename.</span>
4281
- <a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-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>
4513
+ <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>
4514
+ <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>
4282
4515
  </code></pre></div>
4283
- <h2 id="common-gcovr-options">Common GCovr options</h2>
4284
- <p>A number of options exist to control which files are considered part of a
4285
- coverage report. This Ceedling gcov plugin itself handles the most important
4286
- aspect — only source files under test are compiled with coverage. Tests, mocks,
4287
- and test runners, are not compiled with coverage.</p>
4288
- <div class="admonition note">
4289
- <p class="admonition-title"><code>gcovr</code> accepts only one report root path</p>
4290
- <p><code>gcovr</code> will only accept a single path for <code>:report_root</code>. In typical usage,
4291
- this is of no concern as it is handled automatically. In unusual project
4292
- layouts, you may need to specify a folder that encompasses <em>all</em> build folders
4293
- containing coverage result files and optionally, selectively exclude patterns
4294
- of paths or files. For instance, if your Ceedling project file is not at the
4295
- root of your project, you may need set <code>:report_root</code> as well as
4296
- <code>:report_exclude</code> and <code>:exclude_directories</code>.</p>
4297
- </div>
4298
- <div class="admonition note">
4299
- <p class="admonition-title">Using a gcovr configuration file</p>
4300
- <p>When <code>:config_file:</code> is set, Ceedling passes only <code>--root</code> and <code>--config</code>
4301
- to gcovr and defers all other settings to that file. This prevents Ceedling
4302
- from overriding config file values with its CLI arguments. Only <code>:report_root:</code>
4303
- is still applied because Ceedling may invoke gcovr from a different working
4304
- directory than your project root.</p>
4305
- <p>To preserve the plugin's default filtering of test and build files, include
4306
- equivalent exclusion patterns in your gcovr config file (adjust for your
4307
- project's <code>:test_file_prefix</code>, test paths, and <code>:build_root</code> settings):</p>
4308
- <div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="k">[gcovr]</span>
4309
- <a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></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>
4310
- <a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="na">exclude</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">.*build/.+\.c$</span>
4516
+ <h2 id="json-reports">JSON reports</h2>
4517
+ <p>Generation of JSON reports may be modified with the following configuration items.</p>
4518
+ <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>
4519
+ <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>
4520
+ <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>
4521
+ <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>
4522
+ <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>
4523
+ <a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a>
4524
+ <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>
4525
+ <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>
4311
4526
  </code></pre></div>
4312
- </div>
4527
+ <h2 id="text-reports">Text reports</h2>
4528
+ <p>Generation of text reports may be modified with the following configuration items.
4529
+ Text reports may be printed to the console or output to a file.</p>
4313
4530
  <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>
4314
4531
  <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>
4315
- <a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="w"> </span><span class="c1"># The root directory of your source files. Defaults to &quot;.&quot;, the current directory.</span>
4316
- <a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-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>
4317
- <a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="w"> </span><span class="c1"># Default if unspecified: &quot;.&quot;</span>
4318
- <a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-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>
4319
- <a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a>
4320
- <a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a><span class="w"> </span><span class="c1"># Load the specified configuration file. (gcovr --config)</span>
4321
- <a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a><span class="w"> </span><span class="c1"># Defaults to gcovr.cfg in the report_root directory if that file exists.</span>
4322
- <a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a><span class="w"> </span><span class="c1">#</span>
4323
- <a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a><span class="w"> </span><span class="c1"># When :config_file is set, Ceedling passes only --root and --config to</span>
4324
- <a id="__codelineno-6-12" name="__codelineno-6-12" href="#__codelineno-6-12"></a><span class="w"> </span><span class="c1"># gcovr and defers all other configuration to the file. This prevents</span>
4325
- <a id="__codelineno-6-13" name="__codelineno-6-13" href="#__codelineno-6-13"></a><span class="w"> </span><span class="c1"># Ceedling from overriding config file values with its CLI arguments. Only</span>
4326
- <a id="__codelineno-6-14" name="__codelineno-6-14" href="#__codelineno-6-14"></a><span class="w"> </span><span class="c1"># :report_root is still applied because Ceedling may invoke gcovr from a</span>
4327
- <a id="__codelineno-6-15" name="__codelineno-6-15" href="#__codelineno-6-15"></a><span class="w"> </span><span class="c1"># different working directory than your project root.</span>
4328
- <a id="__codelineno-6-16" name="__codelineno-6-16" href="#__codelineno-6-16"></a><span class="w"> </span><span class="c1">#</span>
4329
- <a id="__codelineno-6-17" name="__codelineno-6-17" href="#__codelineno-6-17"></a><span class="w"> </span><span class="c1"># To preserve the plugin&#39;s base filtering behavior, include the following</span>
4330
- <a id="__codelineno-6-18" name="__codelineno-6-18" href="#__codelineno-6-18"></a><span class="w"> </span><span class="c1"># patterns in your config file (adjust paths to match your project&#39;s</span>
4331
- <a id="__codelineno-6-19" name="__codelineno-6-19" href="#__codelineno-6-19"></a><span class="w"> </span><span class="c1"># :test_file_prefix, test paths, and :build_root settings):</span>
4332
- <a id="__codelineno-6-20" name="__codelineno-6-20" href="#__codelineno-6-20"></a><span class="w"> </span><span class="c1">#</span>
4333
- <a id="__codelineno-6-21" name="__codelineno-6-21" href="#__codelineno-6-21"></a><span class="w"> </span><span class="c1"># [gcovr]</span>
4334
- <a id="__codelineno-6-22" name="__codelineno-6-22" href="#__codelineno-6-22"></a><span class="w"> </span><span class="c1"># exclude = .*test.*/test_.+\.c$</span>
4335
- <a id="__codelineno-6-23" name="__codelineno-6-23" href="#__codelineno-6-23"></a><span class="w"> </span><span class="c1"># exclude = .*build/.+\.c$</span>
4336
- <a id="__codelineno-6-24" name="__codelineno-6-24" href="#__codelineno-6-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>
4337
- <a id="__codelineno-6-25" name="__codelineno-6-25" href="#__codelineno-6-25"></a>
4338
- <a id="__codelineno-6-26" name="__codelineno-6-26" href="#__codelineno-6-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>
4339
- <a id="__codelineno-6-27" name="__codelineno-6-27" href="#__codelineno-6-27"></a><span class="w"> </span><span class="c1"># Can be ORed with exit status of other fail options. (gcovr --fail-under-line)</span>
4340
- <a id="__codelineno-6-28" name="__codelineno-6-28" href="#__codelineno-6-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>
4341
- <a id="__codelineno-6-29" name="__codelineno-6-29" href="#__codelineno-6-29"></a>
4342
- <a id="__codelineno-6-30" name="__codelineno-6-30" href="#__codelineno-6-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>
4343
- <a id="__codelineno-6-31" name="__codelineno-6-31" href="#__codelineno-6-31"></a><span class="w"> </span><span class="c1"># Can be ORed with exit status of other fail options. (gcovr --fail-under-branch)</span>
4344
- <a id="__codelineno-6-32" name="__codelineno-6-32" href="#__codelineno-6-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>
4345
- <a id="__codelineno-6-33" name="__codelineno-6-33" href="#__codelineno-6-33"></a>
4346
- <a id="__codelineno-6-34" name="__codelineno-6-34" href="#__codelineno-6-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>
4347
- <a id="__codelineno-6-35" name="__codelineno-6-35" href="#__codelineno-6-35"></a><span class="w"> </span><span class="c1"># Can be ORed with exit status of other fail options. (gcovr --fail-under-decision)</span>
4348
- <a id="__codelineno-6-36" name="__codelineno-6-36" href="#__codelineno-6-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>
4349
- <a id="__codelineno-6-37" name="__codelineno-6-37" href="#__codelineno-6-37"></a>
4350
- <a id="__codelineno-6-38" name="__codelineno-6-38" href="#__codelineno-6-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>
4351
- <a id="__codelineno-6-39" name="__codelineno-6-39" href="#__codelineno-6-39"></a><span class="w"> </span><span class="c1"># Can be ORed with exit status of other fail options. (gcovr --fail-under-function)</span>
4352
- <a id="__codelineno-6-40" name="__codelineno-6-40" href="#__codelineno-6-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>
4353
- <a id="__codelineno-6-41" name="__codelineno-6-41" href="#__codelineno-6-41"></a>
4354
- <a id="__codelineno-6-42" name="__codelineno-6-42" href="#__codelineno-6-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>
4355
- <a id="__codelineno-6-43" name="__codelineno-6-43" href="#__codelineno-6-43"></a><span class="w"> </span><span class="c1"># The default option is false and simply logs a warning without breaking the build.</span>
4356
- <a id="__codelineno-6-44" name="__codelineno-6-44" href="#__codelineno-6-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>
4357
- <a id="__codelineno-6-45" name="__codelineno-6-45" href="#__codelineno-6-45"></a>
4358
- <a id="__codelineno-6-46" name="__codelineno-6-46" href="#__codelineno-6-46"></a><span class="w"> </span><span class="c1"># Select the source file encoding.</span>
4359
- <a id="__codelineno-6-47" name="__codelineno-6-47" href="#__codelineno-6-47"></a><span class="w"> </span><span class="c1"># Defaults to the system default encoding (UTF-8). (gcovr --source-encoding)</span>
4360
- <a id="__codelineno-6-48" name="__codelineno-6-48" href="#__codelineno-6-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>
4361
- <a id="__codelineno-6-49" name="__codelineno-6-49" href="#__codelineno-6-49"></a>
4362
- <a id="__codelineno-6-50" name="__codelineno-6-50" href="#__codelineno-6-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>
4363
- <a id="__codelineno-6-51" name="__codelineno-6-51" href="#__codelineno-6-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>
4364
- <a id="__codelineno-6-52" name="__codelineno-6-52" href="#__codelineno-6-52"></a>
4365
- <a id="__codelineno-6-53" name="__codelineno-6-53" href="#__codelineno-6-53"></a><span class="w"> </span><span class="c1"># Sort entries by increasing number of uncovered lines.</span>
4366
- <a id="__codelineno-6-54" name="__codelineno-6-54" href="#__codelineno-6-54"></a><span class="w"> </span><span class="c1"># For text and HTML report. (gcovr --sort-uncovered)</span>
4367
- <a id="__codelineno-6-55" name="__codelineno-6-55" href="#__codelineno-6-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>
4368
- <a id="__codelineno-6-56" name="__codelineno-6-56" href="#__codelineno-6-56"></a>
4369
- <a id="__codelineno-6-57" name="__codelineno-6-57" href="#__codelineno-6-57"></a><span class="w"> </span><span class="c1"># Sort entries by increasing percentage of uncovered lines.</span>
4370
- <a id="__codelineno-6-58" name="__codelineno-6-58" href="#__codelineno-6-58"></a><span class="w"> </span><span class="c1"># For text and HTML report. (gcovr --sort-percentage)</span>
4371
- <a id="__codelineno-6-59" name="__codelineno-6-59" href="#__codelineno-6-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>
4372
- <a id="__codelineno-6-60" name="__codelineno-6-60" href="#__codelineno-6-60"></a>
4373
- <a id="__codelineno-6-61" name="__codelineno-6-61" href="#__codelineno-6-61"></a><span class="w"> </span><span class="c1"># Print a small report to stdout with line &amp; branch percentage coverage.</span>
4374
- <a id="__codelineno-6-62" name="__codelineno-6-62" href="#__codelineno-6-62"></a><span class="w"> </span><span class="c1"># This is in addition to other reports. (gcovr --print-summary).</span>
4375
- <a id="__codelineno-6-63" name="__codelineno-6-63" href="#__codelineno-6-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>
4376
- <a id="__codelineno-6-64" name="__codelineno-6-64" href="#__codelineno-6-64"></a>
4377
- <a id="__codelineno-6-65" name="__codelineno-6-65" href="#__codelineno-6-65"></a><span class="w"> </span><span class="c1"># Keep only source files that match this filter. (gcovr --filter).</span>
4378
- <a id="__codelineno-6-66" name="__codelineno-6-66" href="#__codelineno-6-66"></a><span class="w"> </span><span class="c1"># Filters are regular expressions (ex: &quot;^src&quot;)</span>
4379
- <a id="__codelineno-6-67" name="__codelineno-6-67" href="#__codelineno-6-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>
4380
- <a id="__codelineno-6-68" name="__codelineno-6-68" href="#__codelineno-6-68"></a>
4381
- <a id="__codelineno-6-69" name="__codelineno-6-69" href="#__codelineno-6-69"></a><span class="w"> </span><span class="c1"># Exclude source files that match this filter. (gcovr --exclude).</span>
4382
- <a id="__codelineno-6-70" name="__codelineno-6-70" href="#__codelineno-6-70"></a><span class="w"> </span><span class="c1"># Filters are regular expressions (ex: &quot;^vendor.*|^build.*|^test.*|^lib.*&quot;)</span>
4383
- <a id="__codelineno-6-71" name="__codelineno-6-71" href="#__codelineno-6-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>
4384
- <a id="__codelineno-6-72" name="__codelineno-6-72" href="#__codelineno-6-72"></a>
4385
- <a id="__codelineno-6-73" name="__codelineno-6-73" href="#__codelineno-6-73"></a><span class="w"> </span><span class="c1"># Keep only gcov data files that match this filter. (gcovr --gcov-filter).</span>
4386
- <a id="__codelineno-6-74" name="__codelineno-6-74" href="#__codelineno-6-74"></a><span class="w"> </span><span class="c1"># Filters are regular expressions</span>
4387
- <a id="__codelineno-6-75" name="__codelineno-6-75" href="#__codelineno-6-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>
4388
- <a id="__codelineno-6-76" name="__codelineno-6-76" href="#__codelineno-6-76"></a>
4389
- <a id="__codelineno-6-77" name="__codelineno-6-77" href="#__codelineno-6-77"></a><span class="w"> </span><span class="c1"># Exclude gcov data files that match this filter. (gcovr --gcov-exclude).</span>
4390
- <a id="__codelineno-6-78" name="__codelineno-6-78" href="#__codelineno-6-78"></a><span class="w"> </span><span class="c1"># Filters are regular expressions</span>
4391
- <a id="__codelineno-6-79" name="__codelineno-6-79" href="#__codelineno-6-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>
4392
- <a id="__codelineno-6-80" name="__codelineno-6-80" href="#__codelineno-6-80"></a>
4393
- <a id="__codelineno-6-81" name="__codelineno-6-81" href="#__codelineno-6-81"></a><span class="w"> </span><span class="c1"># Exclude directories that match this filter while searching </span>
4394
- <a id="__codelineno-6-82" name="__codelineno-6-82" href="#__codelineno-6-82"></a><span class="w"> </span><span class="c1"># raw coverage files. (gcovr --exclude-directories).</span>
4395
- <a id="__codelineno-6-83" name="__codelineno-6-83" href="#__codelineno-6-83"></a><span class="w"> </span><span class="c1"># Filters are regular expressions</span>
4396
- <a id="__codelineno-6-84" name="__codelineno-6-84" href="#__codelineno-6-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>
4397
- <a id="__codelineno-6-85" name="__codelineno-6-85" href="#__codelineno-6-85"></a>
4398
- <a id="__codelineno-6-86" name="__codelineno-6-86" href="#__codelineno-6-86"></a><span class="w"> </span><span class="c1"># Use a particular gcov executable. (gcovr --gcov-executable).</span>
4399
- <a id="__codelineno-6-87" name="__codelineno-6-87" href="#__codelineno-6-87"></a><span class="w"> </span><span class="c1"># (This may be appropriate and necessary in special circumstances.</span>
4400
- <a id="__codelineno-6-88" name="__codelineno-6-88" href="#__codelineno-6-88"></a><span class="w"> </span><span class="c1"># Please review Ceedling&#39;s options for modifying tools first.)</span>
4401
- <a id="__codelineno-6-89" name="__codelineno-6-89" href="#__codelineno-6-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>
4402
- <a id="__codelineno-6-90" name="__codelineno-6-90" href="#__codelineno-6-90"></a>
4403
- <a id="__codelineno-6-91" name="__codelineno-6-91" href="#__codelineno-6-91"></a><span class="w"> </span><span class="c1"># Exclude branch coverage from lines without useful</span>
4404
- <a id="__codelineno-6-92" name="__codelineno-6-92" href="#__codelineno-6-92"></a><span class="w"> </span><span class="c1"># source code. (gcovr --exclude-unreachable-branches).</span>
4405
- <a id="__codelineno-6-93" name="__codelineno-6-93" href="#__codelineno-6-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>
4406
- <a id="__codelineno-6-94" name="__codelineno-6-94" href="#__codelineno-6-94"></a>
4407
- <a id="__codelineno-6-95" name="__codelineno-6-95" href="#__codelineno-6-95"></a><span class="w"> </span><span class="c1"># For branch coverage, exclude branches that the compiler</span>
4408
- <a id="__codelineno-6-96" name="__codelineno-6-96" href="#__codelineno-6-96"></a><span class="w"> </span><span class="c1"># generates for exception handling. (gcovr --exclude-throw-branches).</span>
4409
- <a id="__codelineno-6-97" name="__codelineno-6-97" href="#__codelineno-6-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>
4410
- <a id="__codelineno-6-98" name="__codelineno-6-98" href="#__codelineno-6-98"></a>
4411
- <a id="__codelineno-6-99" name="__codelineno-6-99" href="#__codelineno-6-99"></a><span class="w"> </span><span class="c1"># For Gcovr 6.0+, multiple instances of the same function in coverage results can</span>
4412
- <a id="__codelineno-6-100" name="__codelineno-6-100" href="#__codelineno-6-100"></a><span class="w"> </span><span class="c1"># cause a fatal error. Since Ceedling can test multiple build variations of the</span>
4413
- <a id="__codelineno-6-101" name="__codelineno-6-101" href="#__codelineno-6-101"></a><span class="w"> </span><span class="c1"># same source function, this is bad.</span>
4414
- <a id="__codelineno-6-102" name="__codelineno-6-102" href="#__codelineno-6-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>
4415
- <a id="__codelineno-6-103" name="__codelineno-6-103" href="#__codelineno-6-103"></a><span class="w"> </span><span class="c1"># https://gcovr.com/en/stable/guide/merging.html</span>
4416
- <a id="__codelineno-6-104" name="__codelineno-6-104" href="#__codelineno-6-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>
4417
- <a id="__codelineno-6-105" name="__codelineno-6-105" href="#__codelineno-6-105"></a>
4418
- <a id="__codelineno-6-106" name="__codelineno-6-106" href="#__codelineno-6-106"></a><span class="w"> </span><span class="c1"># Use existing gcov files for analysis. Default: False. (gcovr --use-gcov-files)</span>
4419
- <a id="__codelineno-6-107" name="__codelineno-6-107" href="#__codelineno-6-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>
4420
- <a id="__codelineno-6-108" name="__codelineno-6-108" href="#__codelineno-6-108"></a>
4421
- <a id="__codelineno-6-109" name="__codelineno-6-109" href="#__codelineno-6-109"></a><span class="w"> </span><span class="c1"># Skip lines with parse errors in GCOV files instead of</span>
4422
- <a id="__codelineno-6-110" name="__codelineno-6-110" href="#__codelineno-6-110"></a><span class="w"> </span><span class="c1"># exiting with an error. (gcovr --gcov-ignore-parse-errors).</span>
4423
- <a id="__codelineno-6-111" name="__codelineno-6-111" href="#__codelineno-6-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>
4424
- <a id="__codelineno-6-112" name="__codelineno-6-112" href="#__codelineno-6-112"></a>
4425
- <a id="__codelineno-6-113" name="__codelineno-6-113" href="#__codelineno-6-113"></a><span class="w"> </span><span class="c1"># Override normal working directory detection. (gcovr --object-directory)</span>
4426
- <a id="__codelineno-6-114" name="__codelineno-6-114" href="#__codelineno-6-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>
4427
- <a id="__codelineno-6-115" name="__codelineno-6-115" href="#__codelineno-6-115"></a>
4428
- <a id="__codelineno-6-116" name="__codelineno-6-116" href="#__codelineno-6-116"></a><span class="w"> </span><span class="c1"># Keep gcov files after processing. (gcovr --keep).</span>
4429
- <a id="__codelineno-6-117" name="__codelineno-6-117" href="#__codelineno-6-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>
4430
- <a id="__codelineno-6-118" name="__codelineno-6-118" href="#__codelineno-6-118"></a>
4431
- <a id="__codelineno-6-119" name="__codelineno-6-119" href="#__codelineno-6-119"></a><span class="w"> </span><span class="c1"># Delete gcda files after processing. (gcovr --delete).</span>
4432
- <a id="__codelineno-6-120" name="__codelineno-6-120" href="#__codelineno-6-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>
4433
- <a id="__codelineno-6-121" name="__codelineno-6-121" href="#__codelineno-6-121"></a>
4434
- <a id="__codelineno-6-122" name="__codelineno-6-122" href="#__codelineno-6-122"></a><span class="w"> </span><span class="c1"># Set the number of threads to use in parallel. (gcovr -j).</span>
4435
- <a id="__codelineno-6-123" name="__codelineno-6-123" href="#__codelineno-6-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>
4532
+ <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>
4533
+ <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>
4436
4534
  </code></pre></div>
4437
4535
  <p><br/><br/></p>
4438
4536
 
@@ -4505,7 +4603,7 @@ project's <code>:test_file_prefix</code>, test paths, and <code>:build_root</cod
4505
4603
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4506
4604
 
4507
4605
 
4508
- <script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
4606
+ <script src="../../assets/javascripts/bundle.d7400e89.min.js"></script>
4509
4607
 
4510
4608
 
4511
4609
  </body>