ceedling 1.1.10 → 1.2.1

data/site-local/plugins/valgrind.html

@@ -14,14 +14,14 @@
         <link rel="prev" href="cppcheck.html">
       
       
-        <link rel="next" href="bullseye.html">
+        <link rel="next" href="sanitize.html">
       
       
         
       
       
       <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 @@
         
       
         
+      
+        
       
         
       
@@ -3173,6 +3215,28 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#suppressions" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        :suppressions:
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#xml_report" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        :xml_report:
+      
+    </span>
+  </a>
+  
 </li>
         
       </ul>
@@ -3228,6 +3292,17 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#console-output" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Console output
+      
+    </span>
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -3257,8 +3332,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">
@@ -3268,6 +3399,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>
   
   
@@ -3278,6 +3453,14 @@
 
               
             
+          </ul>
+        </nav>
+      
+    </li>
+  
+
+              
+            
               
                 
   
@@ -3747,6 +3930,12 @@
     
       
         
+          
+        
+      
+        
+      
+        
       
         
       
@@ -3766,8 +3955,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">
@@ -3781,8 +3971,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">
@@ -3796,6 +3992,8 @@
           <ul class="md-nav__list" data-md-scrollfix>
             
               
+            
+              
                 
   
   
@@ -3829,6 +4027,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">
         
@@ -3900,6 +4126,8 @@
       
         
       
+        
+      
         
       
     
@@ -3990,6 +4218,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../development/releases.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Branching & Releases
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     
     
       
@@ -4016,7 +4272,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">
@@ -4038,14 +4294,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>
             
   
@@ -4275,6 +4531,28 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#suppressions" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        :suppressions:
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#xml_report" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        :xml_report:
+      
+    </span>
+  </a>
+  
 </li>
         
       </ul>
@@ -4330,6 +4608,17 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#console-output" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Console output
+      
+    </span>
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -4415,10 +4704,13 @@
 <p>Adds Ceedling tasks to run test executables under <a href="https://valgrind.org">Valgrind</a> memory error
 detection to help find memory leaks, invalid memory accesses, and
 use-after-free bugs in your C code.</p>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
 <p>The Valgrind plugin creates a duplicate test build with <code>valgrind:</code> 
 command line plugin tasks. <a href="index.html#understanding-plugin-build-duplication">This is intentional and needed</a>.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>A <code>valgrind:</code> task is a <a href="../getting-started/builds.html">delta build</a>.
+This plugin maintains its own dependency cache. A test executable will be 
+rebuilt the first time you run a <code>valgrind:</code> build.</p>
 </div>
 <hr />
 <h2 id="plugin-overview">Plugin overview</h2>
@@ -4426,6 +4718,10 @@ command line plugin tasks. <a href="index.html#understanding-plugin-build-duplic
 <p class="admonition-title">Linux only</p>
 <p>Valgrind runs on Linux and other Unix-like systems. It is not available
 on Windows or macOS (ARM).</p>
+<p>Enabling this plugin on a platform without Valgrind does not affect your
+other builds. <code>ceedling test:all</code> and every non-<code>valgrind:</code> task run
+normally. Only a <code>valgrind:</code> task requires the executable, and it reports
+the platform constraint when it cannot find one.</p>
 </div>
 <p>The Valgrind plugin integrates <a href="https://valgrind.org">Valgrind</a> dynamic analysis into Ceedling,
 building and then running test executables under Valgrind’s Memcheck tool.</p>
@@ -4464,6 +4760,12 @@ project configuration:</p>
 <a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w">  </span><span class="nt">:enabled</span><span class="p">:</span>
 <a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">valgrind</span>
 </code></pre></div>
+<div class="admonition warning">
+<p class="admonition-title">Sanitizer flags</p>
+<p>A test executable built with sanitizers (<code>-fsanitize</code>) cannot run under
+Valgrind. A <code>valgrind:</code> build whose flags carry <code>-fsanitize</code> stops with 
+a message naming them.</p>
+</div>
 <h2 id="configuration">Configuration</h2>
 <p>The plugin ships with sensible defaults that enable full leak checking. By
 default the build runs all test binaries to completion and is marked as failed
@@ -4487,8 +4789,8 @@ defaults, redefine the argument list in your project configuration:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="nt">:valgrind</span><span class="p">:</span>
 <a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w">  </span><span class="nt">:arguments</span><span class="p">:</span>
 <a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w">    </span><span class="c1"># A subset of the default arguments</span>
-<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;--leak-check=full&quot;</span>
-<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;--show-leak-kinds=all&quot;</span>
+<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"--leak-check=full"</span>
+<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"--show-leak-kinds=all"</span>
 </code></pre></div>
 <h3 id="fail_build"><code>:fail_build:</code></h3>
 <p>When <code>true</code> (the default), any memory errors are logged immediately after 
@@ -4501,40 +4803,117 @@ not marked as failed.</p>
 <a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w">  </span><span class="nt">:fail_build</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
 </code></pre></div>
 <div class="admonition note">
-<p class="admonition-title">Detection uses log parsing, not Valgrind’s exit code</p>
+<p class="admonition-title">Detection uses report parsing, not Valgrind’s exit code</p>
 <p>Valgrind’s <code>--error-exitcode</code> flag is not used because its exit code would
 overlap with Unity’s own exit code, which equals the number of failing test
-cases. Instead, the plugin parses the <code>ERROR SUMMARY: N errors</code> line written
-to the Valgrind log file.</p>
+cases. Instead, the plugin counts errors from the report it wrote.</p>
+<p>With <a href="#xml_report"><code>:xml_report:</code></a> disabled, it sums every
+<code>ERROR SUMMARY: N errors</code> line in the text log. Valgrind writes one such
+line per traced process, so a test that forks reports more than one.</p>
+<p>With <code>:xml_report:</code> enabled, it counts <code>&lt;error&gt;</code> elements in the XML
+instead. Valgrind writes no error summary to the text log once XML output
+is active.</p>
 </div>
+<h3 id="suppressions"><code>:suppressions:</code></h3>
+<p>A list of Valgrind suppression files. Each becomes one <code>--suppressions=</code>
+argument, placed ahead of your own <code>:arguments:</code> entries.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nt">:valgrind</span><span class="p">:</span>
+<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w">  </span><span class="nt">:suppressions</span><span class="p">:</span>
+<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">suppressions/third_party.supp</span>
+</code></pre></div>
+<p><strong>Default:</strong> <code>[]</code></p>
+<div class="admonition warning">
+<p class="admonition-title">A malformed suppression file aborts the run</p>
+<p>Valgrind refuses to start when it cannot parse a suppression file, which
+surfaces as a test executable that produced no output. Each suppression
+needs at least one location line that is not <code>...</code>.</p>
+</div>
+<h3 id="xml_report"><code>:xml_report:</code></h3>
+<p>When <code>true</code>, writes a machine-readable XML report per test binary alongside the
+text log. Useful for CI systems that consume Valgrind output directly.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nt">:valgrind</span><span class="p">:</span>
+<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w">  </span><span class="nt">:xml_report</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
+</code></pre></div>
+<p><strong>Default:</strong> <code>false</code></p>
 <h2 id="usage">Usage</h2>
 <p>The Valgrind plugin follows the conventions of <code>test:</code> tasks.</p>
 <h3 id="run-valgrind-for-all-tests">Run Valgrind for all tests</h3>
 <p>Build all test executables and run each under Valgrind:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>$<span class="w"> </span>ceedling<span class="w"> </span>valgrind:all
+<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>$<span class="w"> </span>ceedling<span class="w"> </span>valgrind:all
 </code></pre></div>
 <h3 id="run-valgrind-for-a-single-test-file">Run Valgrind for a single test file</h3>
-<p>Build and run Valgrind for one test file (pass the filename, no path):</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>$<span class="w"> </span>ceedling<span class="w"> </span>valgrind:test_my_module.c
+<p>Build and run Valgrind for one test file (pass the filename):</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>$<span class="w"> </span>ceedling<span class="w"> </span>valgrind:test_my_module.c
 </code></pre></div>
 <p>You can also pass just the source filename; Ceedling will locate the
 corresponding test file automatically:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>$<span class="w"> </span>ceedling<span class="w"> </span>valgrind:my_module.c
+<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>$<span class="w"> </span>ceedling<span class="w"> </span>valgrind:my_module.c
+</code></pre></div>
+<p>As with <a href="../getting-started/command-line.html#ceedling-test"><code>test:</code> tasks</a>, add
+as much of the file’s path as needed to tell same-named test files apart:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>$<span class="w"> </span>ceedling<span class="w"> </span>valgrind:unit/test_my_module.c
 </code></pre></div>
 <h2 id="artifacts">Artifacts</h2>
 <p>Each test executable produces a Valgrind log file at:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>build/artifacts/valgrind/&lt;test_name&gt;.log
+<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>build/artifacts/valgrind/&lt;test_name&gt;.log
+</code></pre></div>
+<p>With <a href="#xml_report"><code>:xml_report:</code></a> enabled, a machine-readable report is written
+beside it:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>build/artifacts/valgrind/&lt;test_name&gt;.xml
 </code></pre></div>
 <p>For example, running <code>ceedling valgrind:test_my_module.c</code> produces:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>build/artifacts/valgrind/test_my_module.log
+<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>build/artifacts/valgrind/test_my_module.log
 </code></pre></div>
 <p>These log files contain the full Valgrind Memcheck output, including any
 detected memory errors, leak summaries, and (with <code>--track-origins=yes</code>)
 the origin of uninitialized values.</p>
 <p>The log files are included in <code>ceedling clean</code> targets.</p>
+<h2 id="console-output">Console output</h2>
+<p>These excerpts come from real runs. Build progress lines are left out.</p>
+<p>A clean run adds one notice after the test summary:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>VALGRIND: ✅ OVERALL TEST SUMMARY
+<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a>TESTED:  2
+<a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a>PASSED:  1
+<a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a>FAILED:  0
+<a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a>IGNORED: 1
+<a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a>
+<a id="__codelineno-13-7" name="__codelineno-13-7" href="#__codelineno-13-7"></a>ℹ️ NOTICE: Wrote 1 Valgrind report to build/artifacts/valgrind/
+</code></pre></div>
+<p>A test that a memory error ends gets a notice naming the first error and its
+report. It replaces Ceedling’s generic crash notice:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>☠️ ERROR: Test executable `test_nosanitize_crash_sigsegv.out` terminated with Valgrind memory errors.
+<a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>&gt; Invalid read of size 4 at test_nosanitize_crash_sigsegv.c:32
+<a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a>&gt; Boom log: build/artifacts/valgrind/test_nosanitize_crash_sigsegv.log
+<a id="__codelineno-14-4" name="__codelineno-14-4" href="#__codelineno-14-4"></a>
+<a id="__codelineno-14-5" name="__codelineno-14-5" href="#__codelineno-14-5"></a>VALGRIND: FAILED TEST SUMMARY
+<a id="__codelineno-14-6" name="__codelineno-14-6" href="#__codelineno-14-6"></a>[test/test_nosanitize_crash_sigsegv.c]
+<a id="__codelineno-14-7" name="__codelineno-14-7" href="#__codelineno-14-7"></a>  Test: test_add_numbers_will_fail
+<a id="__codelineno-14-8" name="__codelineno-14-8" href="#__codelineno-14-8"></a>  At line (28): "Test case crashed &gt;&gt; Segmentation fault"
+<a id="__codelineno-14-9" name="__codelineno-14-9" href="#__codelineno-14-9"></a>
+<a id="__codelineno-14-10" name="__codelineno-14-10" href="#__codelineno-14-10"></a>VALGRIND: ❌ OVERALL TEST SUMMARY
+<a id="__codelineno-14-11" name="__codelineno-14-11" href="#__codelineno-14-11"></a>TESTED:  2
+<a id="__codelineno-14-12" name="__codelineno-14-12" href="#__codelineno-14-12"></a>PASSED:  1
+<a id="__codelineno-14-13" name="__codelineno-14-13" href="#__codelineno-14-13"></a>FAILED:  1
+<a id="__codelineno-14-14" name="__codelineno-14-14" href="#__codelineno-14-14"></a>IGNORED: 0
+<a id="__codelineno-14-15" name="__codelineno-14-15" href="#__codelineno-14-15"></a>
+<a id="__codelineno-14-16" name="__codelineno-14-16" href="#__codelineno-14-16"></a>ℹ️ NOTICE: Wrote 1 Valgrind report to build/artifacts/valgrind/
+<a id="__codelineno-14-17" name="__codelineno-14-17" href="#__codelineno-14-17"></a>
+<a id="__codelineno-14-18" name="__codelineno-14-18" href="#__codelineno-14-18"></a>❌ BUILD FAILURE SUMMARY
+<a id="__codelineno-14-19" name="__codelineno-14-19" href="#__codelineno-14-19"></a> • [VALGRIND] Unit test failures
+<a id="__codelineno-14-20" name="__codelineno-14-20" href="#__codelineno-14-20"></a> • [VALGRIND] Valgrind detected 2 memory errors across 1 test
+</code></pre></div>
+<p>With <a href="#fail_build"><code>:fail_build:</code></a> set to <code>false</code>, the same run omits the last
+line. Only the test failure fails the build.</p>
+<p>A test that completes despite memory errors logs one line as it runs:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>🪲 ERROR: Valgrind detected 2 memory errors in test_example ➡️ see build/artifacts/valgrind/test_example.log
+</code></pre></div>
+<p>A test whose report is missing logs a warning, since its memory error status
+is unknown:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a>⚠️ WARNING: Valgrind wrote no report for test_example at build/artifacts/valgrind/test_example.log. Memory error status is unknown.
+</code></pre></div>
 <h2 id="interpreting-results">Interpreting results</h2>
 <p>To review the log for a specific test:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>cat<span class="w"> </span>build/artifacts/valgrind/test_my_module.log
+<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>cat<span class="w"> </span>build/artifacts/valgrind/test_my_module.log
 </code></pre></div>
 <p>Common Valgrind findings include:</p>
 <table>
@@ -4564,6 +4943,7 @@ the origin of uninitialized values.</p>
 </tbody>
 </table>
 <p>See <a href="https://valgrind.org">Valgrind</a> documentation for more details.</p>
+<p><br/><br/></p>
 
 
 
@@ -4631,10 +5011,10 @@ the origin of uninitialized values.</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>