ceedling 1.1.6 → 1.1.7

data/docs/mkdocs/plugins/gcov/reportgenerator.md

@@ -4,55 +4,137 @@ The `ReportGenerator` utility may be configured with the following configuration
 
 All generated reports are found in `<build root>/artifacts/gcov/ReportGenerator/`.
 
+## Example configuration
+
 ```yaml
 :gcov:
   :report_generator:
-    # Optional directory for storing persistent coverage information.
-    # Can be used in future reports to show coverage evolution.
-    :history_directory: <path>
+    :history_directory: build/artifacts/gcov/history
+    :file_filters: "-./vendor/*;-./build/*;-./test/*;+./src/*"
+    :verbosity: Warning
+    :tag: "release-1.4.0"
+    :num_parallel_threads: 4
+    :gcov_exclude:
+      - some_excluded_file
+    :custom_args:
+      - "-title:MyProject"
+```
+
+## Plugin configuration
+
+### `:history_directory`
+
+Optional directory for storing persistent coverage information. Can be used
+in future reports to show coverage evolution.
+
+---
+
+### `:plugins`
+
+Optional plugin files for custom reports or custom history storage (separated
+by semicolon).
+
+**Example:** `plugin.dll;*.dll`
+
+---
+
+### `:assembly_filters`
+
+Optional list of assemblies that should be included or excluded in the
+report (separated by semicolon). Exclusion filters take precedence over
+inclusion filters. Wildcards are allowed, but not regular expressions.
+
+**Example:** `+<included>;-<excluded>`
+
+---
+
+### `:class_filters`
+
+Optional list of classes that should be included or excluded in the report
+(separated by semicolon). Exclusion filters take precedence over inclusion
+filters. Wildcards are allowed, but not regular expressions.
+
+**Example:** `+<included>;-<excluded>`
+
+---
+
+### `:file_filters`
+
+Optional list of files that should be included or excluded in the report
+(separated by semicolon). Exclusion filters take precedence over inclusion
+filters. Wildcards are allowed, but not regular expressions. Ceedling places
+your own patterns first, ahead of the exclusions it generates automatically
+for test paths, the build root, and (when Partials are in use) Partial
+source files, so your patterns take precedence.
 
-    # Optional plugin files for custom reports or custom history storage (separated by semicolon).
-    :plugins: <plugin.dll>;<*.dll>
+**Example:** `"-./vendor/*;-./build/*;-./test/*;-./lib/*;+./src/*"`
 
-    # Optional list of assemblies that should be included or excluded in the report (separated by semicolon).
-    # Exclusion filters take precedence over inclusion filters.
-    # Wildcards are allowed, but not regular expressions.
-    :assembly_filters: +<included>;-<excluded>
+---
 
-    # Optional list of classes that should be included or excluded in the report (separated by semicolon).
-    # Exclusion filters take precedence over inclusion filters.
-    # Wildcards are allowed, but not regular expressions.
-    :class_filters: +<included>;-<excluded>
+### `:verbosity`
 
-    # Optional list of files that should be included or excluded in the report (separated by semicolon).
-    # Exclusion filters take precedence over inclusion filters.
-    # Wildcards are allowed, but not regular expressions.
-    # Example: "-./vendor/*;-./build/*;-./test/*;-./lib/*;+./src/*"
-    :file_filters: +<included>;-<excluded>
+The verbosity level of the log messages.
 
-    # The verbosity level of the log messages.
-    # Values: Verbose, Info, Warning, Error, Off (defaults to Warning)
-    :verbosity: <level>
+**Values:** `Verbose`, `Info`, `Warning`, `Error`, `Off`
 
-    # Optional tag or build version.
-    :tag: <tag>
+**Default:** `Warning`
 
-    # Optional list of one or more regular expressions to exclude gcov notes files that match these filters.
+---
+
+### `:tag`
+
+Optional tag or build version.
+
+---
+
+### `:gcov_exclude`
+
+Optional list of one or more regular expressions to exclude gcov notes
+(`.gcno`) files that match these filters from coverage processing — these
+files are never run through `gcov` at all. A trailing `.gcov` or `.gcno`
+suffix on a pattern is stripped automatically, so either form works.
+
+```yaml
+:gcov:
+  :report_generator:
     :gcov_exclude:
       - <regex>
       - ...
+```
+
+**Default:** `[]`
 
-    # Optionally set the number of threads to use in parallel. Defaults to 1.
-    :threads: <count>
+---
 
-    # Optional list of one or more command line arguments to pass to Report Generator.
-    # Useful for configuring Risk Hotspots and Other Settings.
-    # https://github.com/danielpalme/ReportGenerator/wiki/Settings
-    # Note: This can be accomplished with Ceedling's tool configuration options outside of plugin 
-    #       configuration but is supported here to collect configuration options in one place.
+### `:num_parallel_threads`
+
+Optionally set the number of threads ReportGenerator uses in parallel. Drives
+both of ReportGenerator's own `numberOfReportsParsedInParallel` and
+`numberOfReportsMergedInParallel` settings together.
+
+**Default:** unset (ReportGenerator's own default applies)
+
+---
+
+### `:custom_args`
+
+Optional list of one or more command line arguments to pass to Report
+Generator. Useful for configuring Risk Hotspots and other settings not
+covered by the options above. See the
+[ReportGenerator settings wiki](https://github.com/danielpalme/ReportGenerator/wiki/Settings).
+
+Note: This can be accomplished with Ceedling's tool configuration options
+outside of plugin configuration but is supported here to collect
+configuration options in one place.
+
+```yaml
+:gcov:
+  :report_generator:
     :custom_args:
       - <argument>
       - ...
 ```
 
+**Default:** `[]`
+
 <br/><br/>

data/docs/mkdocs/reference/gcov-plugin.md

@@ -213,8 +213,24 @@ Exit with status 4 if total branch coverage is below this percentage.
 Exit with status 8 if total decision coverage is below this percentage.
 (`gcovr --fail-under-decision`)
 
+`gcovr` treats `--fail-under-decision` as a no-op without `--decisions` also
+present — setting this option implies `:decisions` (below) automatically.
+
 **Values:** `1`–`100`
 
+**Requires:** `gcovr` 7.0 or higher
+
+---
+
+### `:decisions`
+
+Report the decision coverage. For HTML, JSON, and the summary report.
+(`gcovr --decisions`)
+
+Implied automatically whenever `:fail_under_decision` is set.
+
+**Requires:** `gcovr` 6.0 or higher
+
 ---
 
 ### `:fail_under_function`
@@ -552,11 +568,13 @@ are excluded from report generation.
 
 ---
 
-### `:threads`
+### `:num_parallel_threads`
 
-Number of parallel threads to use during report generation.
+Number of parallel threads to use during report generation. Drives both
+ReportGenerator's own `numberOfReportsParsedInParallel` and
+`numberOfReportsMergedInParallel` settings together.
 
-**Default:** `1`
+**Default:** unset (ReportGenerator's own default applies)
 
 ---
 

data/docs/mkdocs/snapshot/plugins/gcov/config/defaults.yml

@@ -27,7 +27,6 @@
 
   :report_generator:
     :verbosity: Warning           # Default verbosity
-    :collection_paths_source: []  # Explicitly defined as default empty array to simplify option validation code
     :custom_args: []              # Explicitly defined as default empty array to simplify option validation code
     :gcov_exclude: []             # Explicitly defined as default empty array to simplify option validation code
 ...

data/lib/ceedling/generators/generator_test_results_backtrace.rb

@@ -66,13 +66,17 @@ class GeneratorTestResultsBacktrace
       # Attribute each group member its own real result line, if Unity printed one
       group.each do |test_case|
         case crash_result[:output]
-        # Success test case
-        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:PASS\s*$)/
+        # Success test case -- tolerates a trailing duration suffix (e.g. `PASS (12 ms)`,
+        # UNITY_INCLUDE_EXEC_TIME), matching the real format generator_test_results.rb's
+        # own parser already recognizes for it.
+        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:PASS(\s\(.*ms\))?\s*$)/
           group_results[:passed]  += 1
           group_results[:output] << $1
 
-        # Ignored test case
-        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:IGNORE\s*$)/
+        # Ignored test case -- tolerates a trailing message (TEST_IGNORE_MESSAGE), same as
+        # FAIL below. Before this fix, a message-carrying ignore fell through to "unresolved"
+        # and was misreported as crash evidence -- IGNORE was only recognized bare.
+        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:IGNORE(:.+)?\s*$)/
           group_results[:ignored] += 1
           group_results[:output] << $1
 
@@ -260,13 +264,17 @@ class GeneratorTestResultsBacktrace
       # Attribute each group member its own real result line, if Unity printed one
       group.each do |test_case|
         case crash_result[:output]
-        # Success test case
-        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:PASS\s*$)/
+        # Success test case -- tolerates a trailing duration suffix (e.g. `PASS (12 ms)`,
+        # UNITY_INCLUDE_EXEC_TIME), matching the real format generator_test_results.rb's
+        # own parser already recognizes for it.
+        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:PASS(\s\(.*ms\))?\s*$)/
           group_results[:passed]  += 1
           group_results[:output] << $1
 
-        # Ignored test case
-        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:IGNORE\s*$)/
+        # Ignored test case -- tolerates a trailing message (TEST_IGNORE_MESSAGE), same as
+        # FAIL below. Before this fix, a message-carrying ignore fell through to "unresolved"
+        # and was misreported as crash evidence -- IGNORE was only recognized bare.
+        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:IGNORE(:.+)?\s*$)/
           group_results[:ignored] += 1
           group_results[:output] << $1
 

data/lib/ceedling/plugins/plugin_reportinator.rb

@@ -95,6 +95,15 @@ class PluginReportinator
     return aggregated_results
   end
       
+  # A build's own test results -- pass or fail -- are core information a user
+  # silencing routine build chatter still wants to see; ERRORS is the floor
+  # for both, not just for a failing run. Centralized here so every plugin
+  # printing post-build test results (report_tests_stdout_plugin, gcov,
+  # valgrind) agrees on the same answer instead of each hardcoding its own.
+  def test_results_floor_verbosity
+    Verbosity::ERRORS
+  end
+
   def run_test_results_report(hash, verbosity=Verbosity::NORMAL)
     if @test_results_template.nil?
       raise CeedlingException.new( "No test results report template has been set." )

data/lib/ceedling/plugins/report_tests_stdout_plugin.rb

@@ -50,7 +50,7 @@ class ReportTestsStdoutPlugin < Plugin
 
     results = @plugin_reportinator.assemble_test_results( @result_list )
     hash = { :context => TEST_SYM, :results => results }
-    verbosity = (results[:counts][:failed] > 0) ? Verbosity::ERRORS : Verbosity::NORMAL
+    verbosity = @plugin_reportinator.test_results_floor_verbosity
 
     # Print unit test suite results
     @plugin_reportinator.run_test_results_report( hash, verbosity )

data/lib/version.rb

@@ -15,7 +15,7 @@
 module Ceedling
   module Version
     # Convenience constants for gem building, etc.
-    GEM = '1.1.6'
+    GEM = '1.1.7'
     TAG = GEM
 
     # If run as a script print Ceedling's version to $stdout

data/plugins/gcov/config/defaults.yml

@@ -27,7 +27,6 @@
 
   :report_generator:
     :verbosity: Warning           # Default verbosity
-    :collection_paths_source: []  # Explicitly defined as default empty array to simplify option validation code
     :custom_args: []              # Explicitly defined as default empty array to simplify option validation code
     :gcov_exclude: []             # Explicitly defined as default empty array to simplify option validation code
 ...

data/plugins/gcov/lib/gcov.rb

@@ -40,11 +40,19 @@ class Gcov < Plugin
       )
     end
 
-    # Validate configuration and tools while building Reportinators
-    @reportinators = build_reportinators( 
-      @project_config[:gcov_utilities],
-      @reports_enabled
-    )
+    # #1252 -- Validate `:gcov ↳ :utilities` config (cheap, no external tool needed) and
+    # build the console summary Reportinator (needs no external tool of its own) here,
+    # eagerly, since `setup()` runs for every build this plugin is merely *enabled* for,
+    # not only real `gcov:` builds. Deliberately NOT building the gcovr/ReportGenerator
+    # Reportinators here -- doing so validates gcovr/ReportGenerator are installed
+    # (see their own constructors), which would make either a hard dependency of any
+    # build at all (e.g. plain `test:all`) rather than only a real `gcov:` build. See
+    # generate_coverage_reports, which builds (and so validates) them lazily, only once
+    # post_build already knows a gcov: task actually ran.
+    validate_utilities_config( @project_config[:gcov_utilities] )
+    @console_reportinator = summaries_enabled?( @project_config ) ?
+      ConsoleReportinator.new( @ceedling, @project_config ) : nil
+    @reportinators = nil
 
     # Convenient instance variable references
     @configurator = @ceedling[:configurator]
@@ -214,7 +222,7 @@ class Gcov < Plugin
         results: results
       }
 
-      verbosity = (results[:counts][:failed] > 0) ? Verbosity::ERRORS : Verbosity::NORMAL
+      verbosity = @plugin_reportinator.test_results_floor_verbosity
 
       # Print unit test suite results
       @plugin_reportinator.run_test_results_report( hash, verbosity )
@@ -257,6 +265,15 @@ class Gcov < Plugin
   def generate_coverage_reports()
     return if not @reports_enabled
 
+    # #1252 -- Lazily build (and so validate the external tools of) the gcovr/
+    # ReportGenerator Reportinators only now: this method only runs from post_build
+    # (automatic reporting) or the standalone `gcov:report` task (manual reporting,
+    # mutually exclusive with automatic per :gcov_report_task) -- either way, only
+    # once a real gcov: task is confirmed to have already run. See setup()'s own
+    # comment for why this can't happen any earlier. `||=` just guards against ever
+    # rebuilding (and so re-validating) on a hypothetical repeat call.
+    @reportinators ||= build_reportinators( @project_config[:gcov_utilities] )
+
     @reportinators.each do |reportinator|
       # Create the artifacts output directory.
       @file_wrapper.mkdir( reportinator.artifacts_path ) if reportinator.artifacts_path
@@ -312,16 +329,10 @@ class Gcov < Plugin
     return sources - tested_sources
   end
 
-  def build_reportinators(config, enabled)
-    reportinators = []
-
-    # Instantiate console summary reportinator if summaries enabled
-    @console_reportinator = summaries_enabled?(@project_config) ?
-      ConsoleReportinator.new(@ceedling, @project_config) : nil
-
-    # Do not instantiate file reportinators (and tool validation) unless reports enabled
-    return reportinators if (!enabled)
-
+  # Fail fast at plugin setup if :utilities holds an unrecognized name (e.g. a typo) --
+  # cheap, config-shape-only validation, so this stays eager even though the actual
+  # Reportinators it names are built lazily (see build_reportinators, generate_coverage_reports).
+  def validate_utilities_config(config)
     config.each do |reportinator|
       if not GCOV_UTILITY_NAMES.map(&:upcase).include?( reportinator.upcase )
         options = GCOV_UTILITY_NAMES.map{ |utility| "'#{utility}'" }.join(', ')
@@ -329,6 +340,14 @@ class Gcov < Plugin
         raise CeedlingException.new(msg)
       end
     end
+  end
+
+  # #1252 -- Deliberately not called from setup(); see its own comment and
+  # generate_coverage_reports, the only caller. Constructing GcovrReportinator/
+  # ReportGeneratorReportinator validates gcovr/ReportGenerator are installed, so this
+  # can only run once a real gcov: task is confirmed to have run.
+  def build_reportinators(config)
+    reportinators = []
 
     # Run reports using gcovr
     if utility_enabled?( config, GCOV_UTILITY_NAME_GCOVR )

data/plugins/gcov/lib/gcovr_reportinator.rb

@@ -50,6 +50,28 @@ class GcovrReportinator < GcovReportinator
         "(found #{@gcovr_version.major}.#{@gcovr_version.minor})"
       )
     end
+
+    # --decisions requires gcovr 6+; --fail-under-decision (which depends on --decisions)
+    # is a distinct, later addition requiring gcovr 7+ -- confirmed directly against real
+    # gcovr 6.0, which rejects --fail-under-decision outright as an unrecognized argument.
+    # Raised here, upfront, rather than left to surface as gcovr's own opaque CLI error or
+    # silently dropped -- either of which would leave a configured coverage threshold
+    # quietly never actually checked.
+    gcovr_opts = @config[GCOVR_SETTING_PREFIX.to_sym] || {}
+
+    if !gcovr_opts[:fail_under_decision].nil? && !min_version?( @gcovr_version, 7, 0 )
+      raise CeedlingException.new(
+        ":gcov ↳ :gcovr ↳ :fail_under_decision ➡️ requires gcovr 7 or higher " \
+        "(found #{@gcovr_version.major}.#{@gcovr_version.minor})"
+      )
+    end
+
+    if gcovr_opts[:decisions] && !min_version?( @gcovr_version, 6, 0 )
+      raise CeedlingException.new(
+        ":gcov ↳ :gcovr ↳ :decisions ➡️ requires gcovr 6 or higher " \
+        "(found #{@gcovr_version.major}.#{@gcovr_version.minor})"
+      )
+    end
   end
 
   # Generate the gcovr report(s) specified in the options.
@@ -112,6 +134,14 @@ class GcovrReportinator < GcovReportinator
       args += "--merge-mode-functions \"#{gcovr_opts[:merge_mode_function]}\" " unless gcovr_opts[:merge_mode_function].nil?
     end
 
+    # --fail-under-decision is a no-op to gcovr without --decisions also present (that's
+    # what actually turns decision-coverage analysis on) -- :fail_under_decision implies
+    # it automatically so the threshold option can never be configured into silently
+    # failing outright. initialize already guarantees gcovr 6+ whenever either is set
+    # (7+ specifically whenever :fail_under_decision is set), matching this method's own
+    # 6+ gate above.
+    args += "--decisions " if gcovr_opts[:decisions] || !gcovr_opts[:fail_under_decision].nil?
+
     [:fail_under_line,
      :fail_under_branch,
      :fail_under_decision,
@@ -327,7 +357,7 @@ class GcovrReportinator < GcovReportinator
   # configuration must come from the gcovr configuration file itself.
   IGNORED_WHEN_CONFIG_FILE_SET = [
     :report_include, :report_exclude, :gcov_filter, :gcov_exclude, :exclude_directories,
-    :branches, :sort_uncovered, :sort_percentage, :print_summary, :gcov_executable,
+    :branches, :decisions, :sort_uncovered, :sort_percentage, :print_summary, :gcov_executable,
     :exclude_unreachable_branches, :exclude_throw_branches, :use_gcov_files, :gcov_ignore_parse_errors,
     :keep, :delete, :threads, :merge_mode_function,
     :fail_under_line, :fail_under_branch, :fail_under_decision, :fail_under_function,

data/plugins/valgrind/lib/valgrind.rb

@@ -101,7 +101,7 @@ class Valgrind < Plugin
         results: results
       }
 
-      verbosity = (results[:counts][:failed] > 0) ? Verbosity::ERRORS : Verbosity::NORMAL
+      verbosity = @plugin_reportinator.test_results_floor_verbosity
 
       # Print unit test suite results
       @plugin_reportinator.run_test_results_report( hash, verbosity )

data/site-local/configuration/project-file.html

@@ -1684,6 +1684,34 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="Some YAML Learnin’">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#yaml-highlights-overview" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        YAML highlights &amp; overview
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#yaml-anchors-aliases-and-extensions" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        YAML anchors, aliases, and extensions
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -4102,6 +4130,34 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="Some YAML Learnin’">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#yaml-highlights-overview" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        YAML highlights &amp; overview
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#yaml-anchors-aliases-and-extensions" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        YAML anchors, aliases, and extensions
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -4241,10 +4297,20 @@
 example of a complete project configuration.</p>
 </div>
 <h2 id="some-yaml-learnin">Some YAML Learnin’</h2>
-<p>Please consult YAML documentation for the finer points of format
-and to understand details of our YAML-based configuration file.</p>
 <p>We recommend <a href="http://en.wikipedia.org/wiki/Yaml">Wikipedia’s entry on YAML</a>
-for this. A few highlights from that reference page:</p>
+and <a href="https://www.educative.io/blog/advanced-yaml-syntax-cheatsheet">educative.io’s advanced YAML cheatsheet</a>
+for a simple overview of YAML and its syntax sufficient for 
+understanding your Ceedling project configuration.</p>
+<div class="admonition tip">
+<p class="admonition-title"><code>ceedling dumpconfig</code> to verify your YAML</p>
+<p>Ceedling provides a means to export the final result of YAML
+processing for your inspection via <a href="../getting-started/command-line.html#ceedling-dumpconfig-filepath-sections"><code>dumpconfig</code></a>.
+Dump output includes the resolution of advanced YAML features and 
+Ceedling’s own manipulations. This is a good way to troubleshoot 
+your project configuration.</p>
+</div>
+<h3 id="yaml-highlights-overview">YAML highlights &amp; overview</h3>
+<p>A few points from the preceding references:</p>
 <ul>
 <li>
 <p>YAML streams are encoded using the set of printable Unicode
@@ -4279,12 +4345,16 @@ for this. A few highlights from that reference page:</p>
   punctuation can generally be represented without needing
   to be enclosed in quotes.</p>
 </li>
-<li>
-<p>Repeated nodes are initially denoted by an ampersand (<code>&amp;</code>) and
-  thereafter referenced with an asterisk (<code>*</code>). These are known as
-  anchors and aliases in YAML speak.</p>
-</li>
 </ul>
+<h3 id="yaml-anchors-aliases-and-extensions">YAML anchors, aliases, and extensions</h3>
+<p>YAML provides several “shortcuts” for referencing and modifying blocks
+of YAML so you can avoid duplication. This is advanced YAML and 
+well beyond the scope of Ceedling documentation. However, know that
+Ceedling’s YAML parser is entirely capable of handling these advanced 
+aspects of YAML.</p>
+<p>See this <a href="https://www.educative.io/blog/advanced-yaml-syntax-cheatsheet#anchors">cheatsheet entry</a> 
+and <a href="https://blog.daemonl.com/2016/02/yaml.html">this guide</a>
+for much more on these powerful but finicky features.</p>
 <h2 id="notes-on-project-file-structure">Notes on Project File Structure</h2>
 <ul>
 <li>

data/site-local/configuration/reference/cexception.html

@@ -2344,10 +2344,10 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#exmaple-cmock-yaml" class="md-nav__link">
+  <a href="#example-cmock-yaml" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Exmaple :cmock YAML
+        Example :cmock YAML
       
     </span>
   </a>
@@ -4046,10 +4046,10 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#exmaple-cmock-yaml" class="md-nav__link">
+  <a href="#example-cmock-yaml" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Exmaple :cmock YAML
+        Example :cmock YAML
       
     </span>
   </a>
@@ -4155,7 +4155,7 @@
 
 <h1 id="cexception"><code>:cexception</code></h1>
 <p><strong>Configure CException’s features</strong></p>
-<h2 id="exmaple-cmock-yaml">Exmaple <code>:cmock</code> YAML</h2>
+<h2 id="example-cmock-yaml">Example <code>:cmock</code> YAML</h2>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">:cexception</span><span class="p">:</span>
 <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>
 <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w">    </span><span class="c1"># Enables CException `#include`ing CExceptionConfig.h</span>

data/site-local/configuration/reference/cmock.html

@@ -2288,10 +2288,10 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#exmaple-cmock-yaml" class="md-nav__link">
+  <a href="#example-cmock-yaml" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Exmaple :cmock YAML
+        Example :cmock YAML
       
     </span>
   </a>
@@ -4112,10 +4112,10 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#exmaple-cmock-yaml" class="md-nav__link">
+  <a href="#example-cmock-yaml" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Exmaple :cmock YAML
+        Example :cmock YAML
       
     </span>
   </a>
@@ -4290,7 +4290,7 @@
 <p>Ceedling sets values for a subset of CMock settings. All CMock options are
 available to be set, but only those options set by Ceedling in an automated
 fashion are documented below. See <a href="https://github.com/ThrowTheSwitch/CMock/blob/master/docs/CMock_Summary.md">CMock documentation</a>.</p>
-<h2 id="exmaple-cmock-yaml">Exmaple <code>:cmock</code> YAML</h2>
+<h2 id="example-cmock-yaml">Example <code>:cmock</code> YAML</h2>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">:cmock</span><span class="p">:</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w">  </span><span class="nt">:when_no_prototypes</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">:warn</span>
 <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w">  </span><span class="nt">:enforce_strict_ordering</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TRUE</span>