ceedling 1.1.10 → 1.2.1

data/site-local/plugins/index.html

@@ -21,7 +21,7 @@
       
       
       <link rel="icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
     
     
       
@@ -29,10 +29,10 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.57a0d79d.min.css">
       
         
-        <link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.fb2fffe2.min.css">
       
       
 
@@ -93,6 +93,16 @@
     
       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
         
+          <aside class="md-banner md-banner--warning">
+            <div class="md-banner__inner md-grid md-typeset">
+              You are not viewing the latest version.
+    <a href="../..">
+      <strong>Click here to go to latest.</strong>
+    </a>
+            </div>
+            <script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL(".."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
+          </aside>
+        
       </div>
     
     
@@ -332,7 +342,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="../project/release-history.html" class="md-tabs__link">
+        <a href="../project/index.html" class="md-tabs__link">
           
   
   
@@ -641,6 +651,8 @@
         
       
         
+      
+        
       
         
       
@@ -788,6 +800,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../getting-started/builds.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Builds
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     
     
       
@@ -814,7 +854,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_6" >
         
           
           <div class="md-nav__link md-nav__container">
@@ -836,14 +876,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3_5">
+        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_3_6">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -2412,6 +2452,8 @@
         
       
         
+      
+        
       
         
       
@@ -3049,8 +3091,64 @@
   
   
     <li class="md-nav__item">
-      <a href="bullseye.html" class="md-nav__link">
+      <a href="sanitize.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Sanitize (ASan, UBSan & Leaks)
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    
+    
+      
+        
+          
         
+      
+        
+      
+    
+    
+    
+      
+      
+        
+          
+          
+        
+      
+    
+    
+    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
+      
+        
+        
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_13" >
+        
+          
+          <div class="md-nav__link md-nav__container">
+            <a href="bullseye/index.html" class="md-nav__link ">
+              
   
   
   <span class="md-ellipsis">
@@ -3060,6 +3158,50 @@
   
 
     
+  </span>
+  
+  
+
+            </a>
+            
+              
+              <label class="md-nav__link " for="__nav_6_13" id="__nav_6_13_label" tabindex="">
+                <span class="md-nav__icon md-icon"></span>
+              </label>
+            
+          </div>
+        
+        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_13_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_6_13">
+            <span class="md-nav__icon md-icon"></span>
+            
+  
+    Bullseye (Coverage)
+  
+
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+            
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="bullseye/licensing.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Licensing
+  
+
+    
   </span>
   
   
@@ -3070,6 +3212,14 @@
 
               
             
+          </ul>
+        </nav>
+      
+    </li>
+  
+
+              
+            
               
                 
   
@@ -3539,6 +3689,12 @@
     
       
         
+          
+        
+      
+        
+      
+        
       
         
       
@@ -3558,8 +3714,9 @@
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
         
           
-          <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
-            
+          <div class="md-nav__link md-nav__container">
+            <a href="../project/index.html" class="md-nav__link ">
+              
   
   
   <span class="md-ellipsis">
@@ -3573,8 +3730,14 @@
   
   
 
-            <span class="md-nav__icon md-icon"></span>
-          </label>
+            </a>
+            
+              
+              <label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="0">
+                <span class="md-nav__icon md-icon"></span>
+              </label>
+            
+          </div>
         
         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_8">
@@ -3588,6 +3751,8 @@
           <ul class="md-nav__list" data-md-scrollfix>
             
               
+            
+              
                 
   
   
@@ -3621,6 +3786,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../project/sbom.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Software Bill of Materials
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../project/upgrade.html" class="md-nav__link">
         
@@ -3692,6 +3885,8 @@
       
         
       
+        
+      
         
       
     
@@ -3782,6 +3977,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../development/releases.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Branching & Releases
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     
     
       
@@ -3808,7 +4031,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10_3" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10_4" >
         
           
           <div class="md-nav__link md-nav__container">
@@ -3830,14 +4053,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_10_3" id="__nav_10_3_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_10_4" id="__nav_10_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_10_3">
+        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_10_4">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -4170,11 +4393,11 @@ for how to enable built-in plugins and load custom plugins in your project.</p>
 <p class="admonition-title">Warning</p>
 <p>Build-related plugins intentionally execute duplicated builds.</p>
 </div>
-<p>Plugins including <a href="gcov/index.html">Gcov</a>, <a href="bullseye.html">Bullseye</a>, and <a href="valgrind.html">Valgrind</a>
-recreate test build tasks. That is, the command line build task <code>test:foo</code> also exists 
-as <code>gcov:foo</code>, <code>bullseye:foo</code>, and/or <code>valgrind:foo</code> if these plugins are enabled.
-Each of these triggers a full rebuild of the named test with instrumentation 
-activated. <strong>This duplication is intentional and very necessary.</strong></p>
+<p>Plugins including <a href="gcov/index.html">Gcov</a>, <a href="bullseye/index.html">Bullseye</a>, <a href="valgrind.html">Valgrind</a>,
+and <a href="sanitize.html">Sanitize</a> recreate test build tasks. That is, the command line build task
+<code>test:foo</code> also exists as <code>gcov:foo</code>, <code>bullseye:foo</code>, <code>valgrind:foo</code>, and/or <code>sanitize:foo</code>
+if these plugins are enabled. Each of these triggers a full rebuild of the named test with 
+instrumentation activated. <strong>This duplication is intentional and very necessary.</strong></p>
 <p>These plugins modify executable code or the environment in which a test suite 
 executable runs. Duplicating and segregating the build tasks addresses several 
 important issues:</p>
@@ -4183,7 +4406,8 @@ important issues:</p>
    duplicated tasks (i.e. integrated build tasks) can bring about conflicts and
    undefined behavior. For instance, Gcov’s instrumentation does not
    necessarily play nice with Valgrind’s memory-instrumented emulation
-   runtime, and the two should be kept entirely segregated.</li>
+   runtime, and the two should be kept entirely segregated. Likewise, a
+   sanitizer-instrumented test executable cannot run under Valgrind at all.</li>
 <li><strong>Unforeseen effects</strong>. These plugins can directly alter the functioning of
    the code under test. For instance, coverage instrumentation inserted into
    your compiled code can alter its function or timing. As such, it is vital
@@ -4198,6 +4422,17 @@ important issues:</p>
    plugin task namespacing scheme naturally accomplished this along with the
    needs of (1) and (2).</li>
 </ol>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>A duplicated build task is a <a href="../getting-started/builds.html">delta build</a>.
+Ceedling skips unneeded work in a <code>gcov:</code>, <code>bullseye:</code>, <code>valgrind:</code>, or
+<code>sanitize:</code> build in the same way it does in a standard <code>test:</code> build.</p>
+</div>
+<p>Each of these plugins maintains its own separate delta build cache, apart from
+plain test builds and from each other. A file with no role specific to a
+given plugin will still be rebuilt the first you run that plugin’s build.
+This happens because each build tracks state in its own dependency cache, 
+not because of the file itself.</p>
 <hr />
 <h2 id="directory">Directory</h2>
 <h3 id="console-test-results">Console Test Results</h3>
@@ -4213,15 +4448,15 @@ any extraneous output collected from test fixtures.</p>
 <li>
 <p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9 6H5v4h2V8h2m10 2h-2v2h-2v2h4m2 2H3V4h18m0-2H3c-1.11 0-2 .89-2 2v12a2 2 0 0 0 2 2h7v2H8v2h8v-2h-2v-2h7a2 2 0 0 0 2-2V4a2 2 0 0 0-2-2"/></svg></span> <strong><a href="report-tests-ide-stdout.html"><code>report_tests_ide_stdout</code></a></strong></p>
 <hr />
-<p>Formats test results for the console such that an IDE executing Ceedling
-tasks can recognize file paths and line numbers in test failures and link
-them for direct file navigation.</p>
+<p>Lists failed and ignored tests in the shape of GCC diagnostics, which
+Eclipse CDT, VS Code, CLion, and other IDEs read as problems that link to
+each test.</p>
 </li>
 <li>
 <p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9 6H5v4h2V8h2m10 2h-2v2h-2v2h4m2 2H3V4h18m0-2H3c-1.11 0-2 .89-2 2v12a2 2 0 0 0 2 2h7v2H8v2h8v-2h-2v-2h7a2 2 0 0 0 2-2V4a2 2 0 0 0-2-2"/></svg></span> <strong><a href="report-tests-gtestlike-stdout.html"><code>report_tests_gtestlike_stdout</code></a></strong></p>
 <hr />
 <p>Prints test results to the console in a format that mimics
-<a href="https://subscription.packtpub.com/book/programming/9781800208988/11/ch11lvl1sec31/controlling-output-with-google-test">Google Test's output</a> — both human readable and
+<a href="https://subscription.packtpub.com/book/programming/9781800208988/11/ch11lvl1sec31/controlling-output-with-google-test">Google Test’s output</a> — both human readable and 
 recognized by a variety of reporting tools, IDEs, and CI servers.</p>
 </li>
 <li>
@@ -4252,8 +4487,8 @@ typically for debugging — to log files named after the test executables.</p>
 <li>
 <p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 9h5.5L13 3.5zM6 2h8l6 6v12a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V4c0-1.11.89-2 2-2m1 18h2v-6H7zm4 0h2v-8h-2zm4 0h2v-4h-2z"/></svg></span> <strong><a href="report-build-warnings-log.html"><code>report_build_warnings_log</code></a></strong></p>
 <hr />
-<p>Scans the output of build tools for console warning notices and produces
-a simple text file that collects all such warning messages.</p>
+<p>Scans the output of build tools for console warning notices and collects
+them in a simple text file and optional SARIF and JSON reports.</p>
 </li>
 </ul>
 </div>
@@ -4282,6 +4517,14 @@ as is common in embedded projects. The plugin can produce various reports.</p>
 detection. Valgrind catches memory leaks, invalid accesses, and use-after-free
 bugs. The plugin produces per-test log files in the build artifacts directory.</p>
 </li>
+<li>
+<p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11 13h2v1h-2zm10-8v6c0 5.5-3.8 10.7-9 12-5.2-1.3-9-6.5-9-12V5l9-4zm-4 5h-2.2c-.2-.6-.6-1.1-1.1-1.5l1.2-1.2-.7-.7L12.8 8H12c-.2 0-.5 0-.7.1L9.9 6.6l-.8.8 1.2 1.2c-.5.3-.9.8-1.1 1.4H7v1h2v1H7v1h2v1H7v1h2.2c.4 1.2 1.5 2 2.8 2s2.4-.8 2.8-2H17v-1h-2v-1h2v-1h-2v-1h2zm-6 2h2v-1h-2z"/></svg></span> <strong><a href="sanitize.html"><code>sanitize</code></a></strong></p>
+<hr />
+<p>Adds Ceedling tasks to build and run test executables with the compiler’s
+sanitizers. ASan, UBSan, and LeakSanitizer find memory errors, undefined
+behavior, and leaks as tests run. Findings fail the build and can be written
+as text, JSON, and SARIF reports.</p>
+</li>
 </ul>
 </div>
 <h3 id="code-coverage">Code Coverage</h3>
@@ -4296,11 +4539,13 @@ and .Net-based <a href="https://reportgenerator.io">ReportGenerator</a> to produ
 variety of formats.</p>
 </li>
 <li>
-<p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m18.5 3.5-15 15 2 2 15-15M7 4a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m10 10a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3"/></svg></span> <strong><a href="bullseye.html"><code>bullseye</code></a></strong></p>
+<p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m18.5 3.5-15 15 2 2 15-15M7 4a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m10 10a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3"/></svg></span> <strong><a href="bullseye/index.html"><code>bullseye</code></a></strong></p>
 <hr />
 <p>Adds Ceedling tasks to execute tests with code coverage instrumentation
 provided by the commercial <a href="http://www.bullseye.com">Bullseye</a> tool, which provides visualization
 and report generation from the coverage results.</p>
+<p>Note: Bullseye requires a commercial license. It was disabled as of 1.0.0
+and is enabled again as of 1.2.0.</p>
 </li>
 </ul>
 </div>
@@ -4324,9 +4569,9 @@ and report generation from the coverage results.</p>
 <li>
 <p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13.8 22H5c-1.7 0-3-1.3-3-3v-1h11.1c-.1.3-.1.7-.1 1 0 1.1.3 2.1.8 3m0-6H5V5c0-1.7 1.3-3 3-3h11c1.7 0 3 1.3 3 3v1h-2V5c0-.6-.4-1-1-1s-1 .4-1 1v8.1c-1.8.3-3.3 1.4-4.2 2.9M8 8h7V6H8zm0 4h6v-2H8zm9 4v6l5-3z"/></svg></span> <strong><a href="command-hooks.html"><code>command_hooks</code></a></strong></p>
 <hr />
-<p>Connects Ceedling's build events to tool entries you define in your
-project configuration. Easily attach your own scripts or command line
-utilities to build steps without writing a full custom plugin.</p>
+<p>Connects Ceedling’s build events to tool entries you define. Easily 
+attach your own scripts or command line utilities to build steps 
+without writing a full custom plugin.</p>
 </li>
 <li>
 <p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 3C7.58 3 4 4.79 4 7s3.58 4 8 4 8-1.79 8-4-3.58-4-8-4M4 9v3c0 2.21 3.58 4 8 4s8-1.79 8-4V9c0 2.21-3.58 4-8 4s-8-1.79-8-4m0 5v3c0 2.21 3.58 4 8 4s8-1.79 8-4v-3c0 2.21-3.58 4-8 4s-8-1.79-8-4"/></svg></span> <strong><a href="compile-commands-json-db.html"><code>compile_commands_json_db</code></a></strong></p>
@@ -4350,17 +4595,16 @@ running time-consuming test suites locally in the background.</p>
 <li>
 <p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 16.5c0 .38-.21.71-.53.88l-7.9 4.44c-.16.12-.36.18-.57.18s-.41-.06-.57-.18l-7.9-4.44A.99.99 0 0 1 3 16.5v-9c0-.38.21-.71.53-.88l7.9-4.44c.16-.12.36-.18.57-.18s.41.06.57.18l7.9 4.44c.32.17.53.5.53.88zM12 4.15l-1.89 1.07L16 8.61l1.96-1.11zM6.04 7.5 12 10.85l1.96-1.1-5.88-3.4zM5 15.91l6 3.38v-6.71L5 9.21zm14 0v-6.7l-6 3.37v6.71z"/></svg></span> <strong><a href="module-generator.html"><code>module_generator</code></a></strong></p>
 <hr />
-<p>Saves time in Test-Driven Development by generating a templated triplet
+<p>Save time in Test-Driven Development by generating a templated triplet
 of source file, header file, and test file — scaffolded such that they
-refer to one another — with convenient command line tasks.</p>
+refer to one another — with a variety of options through command line tasks.</p>
 </li>
 <li>
 <p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 16.5c0 .38-.21.71-.53.88l-7.9 4.44c-.16.12-.36.18-.57.18s-.41-.06-.57-.18l-7.9-4.44A.99.99 0 0 1 3 16.5v-9c0-.38.21-.71.53-.88l7.9-4.44c.16-.12.36-.18.57-.18s.41.06.57.18l7.9 4.44c.32.17.53.5.53.88zM12 4.15l-1.89 1.07L16 8.61l1.96-1.11zM6.04 7.5 12 10.85l1.96-1.1-5.88-3.4zM5 15.91l6 3.38v-6.71L5 9.21zm14 0v-6.7l-6 3.37v6.71z"/></svg></span> <strong><a href="dependencies.html"><code>dependencies</code></a></strong></p>
 <hr />
-<p>Manages release build dependencies (e.g. static libraries) including 
-fetching those dependencies and calling a given dependency‘s build 
-process to generate the components needed by your Ceedling release 
-build target.</p>
+<p>Manages release build dependencies (e.g. static libraries or built tools)
+including fetching dependencies, calling a dependency’s build process, 
+and deploying resulting executables and dynamic libraries.</p>
 </li>
 </ul>
 </div>
@@ -4432,10 +4676,10 @@ build target.</p>
     
       
       
-      <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>
+      <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.a7633da7.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>
     
     
-      <script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
+      <script src="../assets/javascripts/bundle.c21346df.min.js"></script>
       
     
   </body>