ceedling 1.1.6 → 1.1.8

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 (57) 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 +41 -0
  7. data/docs/KnownIssues.md +3 -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 +329 -189
  14. data/docs/mkdocs/plugins/gcov/reportgenerator.md +113 -31
  15. data/docs/mkdocs/reference/gcov-plugin.md +29 -6
  16. data/docs/mkdocs/snapshot/plugins/gcov/config/defaults.yml +0 -1
  17. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +11 -10
  18. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +39 -2
  19. data/lib/ceedling/generators/generator_test_results_backtrace.rb +21 -11
  20. data/lib/ceedling/generators/generator_test_runner.rb +5 -1
  21. data/lib/ceedling/plugins/plugin_reportinator.rb +9 -0
  22. data/lib/ceedling/plugins/report_tests_stdout_plugin.rb +1 -1
  23. data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb +6 -1
  24. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +18 -5
  25. data/lib/version.rb +1 -1
  26. data/plugins/gcov/config/defaults.yml +0 -1
  27. data/plugins/gcov/lib/console_reportinator.rb +7 -0
  28. data/plugins/gcov/lib/gcov.rb +64 -26
  29. data/plugins/gcov/lib/gcovr_reportinator.rb +91 -47
  30. data/plugins/gcov/lib/reportgenerator_reportinator.rb +10 -6
  31. data/plugins/valgrind/lib/valgrind.rb +1 -1
  32. data/site-local/configuration/project-file.html +78 -8
  33. data/site-local/configuration/reference/cexception.html +5 -5
  34. data/site-local/configuration/reference/cmock.html +5 -5
  35. data/site-local/configuration/reference/unity.html +5 -5
  36. data/site-local/getting-started/quick-start.html +13 -9
  37. data/site-local/plugins/gcov/gcovr.html +1220 -255
  38. data/site-local/plugins/gcov/reportgenerator.html +404 -46
  39. data/site-local/reference/gcov-plugin.html +48 -10
  40. data/site-local/sitemap.xml.gz +0 -0
  41. data/site-local/snapshot/plugins/gcov/config/defaults.yml +0 -1
  42. data/spec/support/system/system_context.rb +7 -3
  43. data/spec/system/deployment_as_gem_spec.rb +2 -0
  44. data/spec/system/deployment_as_vendor_spec.rb +2 -0
  45. data/spec/system/gcov_deployment_spec.rb +3 -0
  46. data/spec/system/support/common_test_cases.rb +42 -0
  47. data/spec/system/support/gcov_common_test_cases.rb +70 -0
  48. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +16 -0
  49. data/spec/units/c_extractor/c_extractor_integration_spec.rb +53 -0
  50. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +45 -0
  51. data/spec/units/generators/generator_partials_spec.rb +98 -0
  52. data/spec/units/generators/generator_test_results_backtrace_spec.rb +77 -0
  53. data/spec/units/generators/generator_test_runner_spec.rb +23 -0
  54. data/spec/units/plugin_reportinator_spec.rb +38 -0
  55. data/spec/units/preprocess/preprocessinator_line_marker_includes_extractor_spec.rb +64 -0
  56. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +74 -0
  57. metadata +6 -2
@@ -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