ceedling 1.1.9 → 1.2.0

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

@@ -89,10 +89,34 @@
     </div>
     <div data-md-component="announce">
       
+        <aside class="md-banner">
+          <div class="md-banner__inner md-grid md-typeset">
+            
+            
+  
+
+          </div>
+          
+        </aside>
+      
     </div>
     
       <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 +356,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 +665,8 @@
         
       
         
+      
+        
       
         
       
@@ -788,6 +814,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 +868,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 +890,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>
             
   
@@ -1976,6 +2030,17 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#use_exceptions" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        :use_exceptions
+      
+    </span>
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -2649,6 +2714,8 @@
         
       
         
+      
+        
       
         
       
@@ -3280,8 +3347,61 @@
   
   
     <li class="md-nav__item">
-      <a href="../../plugins/bullseye.html" class="md-nav__link">
+      <a href="../../plugins/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--nested">
+      
         
+        
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_13" >
+        
+          
+          <div class="md-nav__link md-nav__container">
+            <a href="../../plugins/bullseye/index.html" class="md-nav__link ">
+              
   
   
   <span class="md-ellipsis">
@@ -3291,6 +3411,50 @@
   
 
     
+  </span>
+  
+  
+
+            </a>
+            
+              
+              <label class="md-nav__link " for="__nav_6_13" id="__nav_6_13_label" tabindex="0">
+                <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="../../plugins/bullseye/licensing.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Licensing
+  
+
+    
   </span>
   
   
@@ -3301,6 +3465,14 @@
 
               
             
+          </ul>
+        </nav>
+      
+    </li>
+  
+
+              
+            
               
                 
   
@@ -3770,6 +3942,12 @@
     
       
         
+          
+        
+      
+        
+      
+        
       
         
       
@@ -3789,8 +3967,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">
@@ -3804,8 +3983,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">
@@ -3819,6 +4004,8 @@
           <ul class="md-nav__list" data-md-scrollfix>
             
               
+            
+              
                 
   
   
@@ -3852,6 +4039,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">
         
@@ -3923,6 +4138,8 @@
       
         
       
+        
+      
         
       
     
@@ -4013,6 +4230,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/releases.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Branching & Releases
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     
     
       
@@ -4039,7 +4284,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">
@@ -4061,14 +4306,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>
             
   
@@ -4258,6 +4503,17 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#use_exceptions" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        :use_exceptions
+      
+    </span>
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -4532,6 +4788,10 @@ plugin tasks.</p>
 <p>Configures the build environment to make use of CMock. Note that if you do not
 use mocks, there's no harm in leaving this setting as its default value.</p>
 <p><strong>Default</strong>: TRUE</p>
+<h2 id="use_exceptions"><code>:use_exceptions</code></h2>
+<p>Configures the build environment to make use of CException. Ceedling enables
+this setting automatically when <code>:cmock</code> ↳ <code>:plugins</code> includes <code>:cexception</code>.</p>
+<p><strong>Default</strong>: FALSE</p>
 <h2 id="use_partials"><code>:use_partials</code></h2>
 <p>Enables Ceedling Partials. <a href="../../testing-guide/partials/index.html">Partials</a> allow you to test and mock
 inaccessible functions and variables in the C code under test without rewriting
@@ -4553,6 +4813,11 @@ accessible system search path.</p>
 <li><code>:mocks</code> enables only preprocessing of header files that are to be mocked.</li>
 <li><code>:tests</code> enables only preprocessing of your test files.</li>
 </ul>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Enabling Partials (<code>:project</code> ↳ <code>:use_partials</code>) sets this option to <code>:all</code>,
+whatever value you give it, since Partials require preprocessing.</p>
+</div>
 <p><strong>Default</strong>: <code>:none</code></p>
 <h2 id="test_file_prefix"><code>:test_file_prefix</code></h2>
 <p>Ceedling collects test files by convention from within the test file search
@@ -4693,6 +4958,18 @@ summary the offending line of code or failing <code>assert()</code> from the rep
 provided in the crash summary. The log filepath will comprise the containing 
 test executable as a subdirectory and the name of the crashing test case 
 function as the filename.</p>
+<div class="admonition warning">
+<p class="admonition-title">macOS: a working <code>gdb</code> can stop attaching to processes</p>
+<p>macOS restricts which debuggers may attach to a process. A Homebrew <code>gdb</code>
+needs to be codesigned to attach at all, and that trust is fragile — a
+<code>brew upgrade</code>, a macOS system update, or a Gatekeeper/<code>taskgated</code> cache
+reset can silently revoke it, even for a <code>gdb</code> that worked yesterday.</p>
+<p>Ceedling checks for this at build startup. If <code>:use_backtrace:</code> is <code>:gdb</code>
+but <code>gdb</code> cannot actually attach to a process, Ceedling logs a warning and
+automatically falls back to <code>:simple</code> for that run rather than failing the
+build. To restore <code>:gdb</code> backtraces, re-codesign <code>gdb</code> following the
+<a href="https://sourceware.org/gdb/wiki/PermissionsDarwin">Homebrew <code>gdb</code> instructions</a> and see <code>taskgated(8)</code>.</p>
+</div>
 <p>Sample Ceedling run output with backtrace <code>:gdb</code>:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>👟 Executing
 <a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>------------