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
data/site-local/configuration/reference/unity.html CHANGED
@@ -2260,10 +2260,10 @@
2260
2260
  <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2261
2261
 
2262
2262
  <li class="md-nav__item">
2263
- <a href="#exmaple-unity-yaml" class="md-nav__link">
2263
+ <a href="#example-unity-yaml" class="md-nav__link">
2264
2264
  <span class="md-ellipsis">
2265
2265
 
2266
- Exmaple :unity YAML
2266
+ Example :unity YAML
2267
2267
 
2268
2268
  </span>
2269
2269
  </a>
@@ -4057,10 +4057,10 @@
4057
4057
  <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
4058
4058
 
4059
4059
  <li class="md-nav__item">
4060
- <a href="#exmaple-unity-yaml" class="md-nav__link">
4060
+ <a href="#example-unity-yaml" class="md-nav__link">
4061
4061
  <span class="md-ellipsis">
4062
4062
 
4063
- Exmaple :unity YAML
4063
+ Example :unity YAML
4064
4064
 
4065
4065
  </span>
4066
4066
  </a>
@@ -4177,7 +4177,7 @@
4177
4177
 
4178
4178
  <h1 id="unity"><code>:unity</code></h1>
4179
4179
  <p><strong>Configure Unity’s features</strong></p>
4180
- <h2 id="exmaple-unity-yaml">Exmaple <code>:unity</code> YAML</h2>
4180
+ <h2 id="example-unity-yaml">Example <code>:unity</code> YAML</h2>
4181
4181
  <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">:unity</span><span class="p">:</span>
4182
4182
  <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nt">:defines</span><span class="p">:</span>
4183
4183
  <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">UNITY_INT_WIDTH=16</span><span class="w"> </span><span class="c1"># 16 bit processor without support for 32 bit instructions</span>
data/site-local/getting-started/quick-start.html CHANGED
@@ -4185,6 +4185,12 @@ configuration file could be as simple as this:</p>
4185
4185
  through running build tasks. Jump down just a teeny bit to see what the Ceedling
4186
4186
  command line looks like and navigate to all the documentation for the steps
4187
4187
  listed immediately below.</p>
4188
+ <div class="admonition warning">
4189
+ <p class="admonition-title">C toolchain requirement</p>
4190
+ <p>Ceedling requires a command line C toolchain be available in your path and is
4191
+ flexible enough to work with most anything. By default, Ceedling is ready to
4192
+ work with <a href="https://gcc.gnu.org">GCC</a> out of the box (we recommend <a href="http://www.mingw.org/">MinGW</a> on Windows).</p>
4193
+ </div>
4188
4194
  <ol>
4189
4195
  <li><a href="installation.html">Install Ceedling</a></li>
4190
4196
  <li>Create a project<ul>
@@ -4200,16 +4206,14 @@ listed immediately below.</p>
4200
4206
  </li>
4201
4207
  <li>Run Ceedling tasks (see next section) from the working directory of your project.</li>
4202
4208
  </ol>
4203
- <div class="admonition note">
4204
- <p class="admonition-title">Note</p>
4205
- <p>Ceedling requires a command line C toolchain be available in your path. It’s
4206
- flexible enough to work with most anything on any platform. By default, Ceedling
4207
- is ready to work with <a href="https://gcc.gnu.org">GCC</a> out of the box (we recommend the <a href="http://www.mingw.org/">MinGW</a> project
4208
- on Windows).</p>
4209
+ <p>A common build strategy is to use your target toolchain for release builds—with or
4210
+ without Ceedling—but rely on Ceedling + GCC for test builds (more on this
4211
+ <a href="../overview/index.html">here</a>).</p>
4212
+ <div class="admonition tip">
4213
+ <p class="admonition-title">Ceedling VS Code extension</p>
4214
+ <p>If you are a Visual Studio Code user, you may want to install the
4215
+ <a href="https://marketplace.visualstudio.com/items?itemName=throw-the-switch.vscode-ceedling">Ceedling extension</a>.</p>
4209
4216
  </div>
4210
- <p>A common build strategy with tooling other than GCC is to use your target
4211
- toolchain for release builds—with or without Ceedling—but rely on Ceedling +
4212
- GCC for test builds (more on all this <a href="../overview/index.html">here</a>).</p>
4213
4217
  <h2 id="command-line-build-tasks">Command Line &amp; Build Tasks</h2>
4214
4218
  <p>Once you have Ceedling installed, you always have access to <code>ceedling help</code>.</p>
4215
4219
  <p>Once you have Ceedling installed, you have options for project creation