2.2.3 (#282)

* `is_release=1`, suffix=`""` * Update `changelog.md`, `sirtests.md` * Regenerate docs --------- Signed-off-by: Jeffrey H. Johnson <[email protected]> Co-authored-by: Jeffrey H. Johnson <[email protected]>
aremmell · Sep 8, 2023 · da60833 · da60833
1 parent cccf241
commit da60833
Show file tree

Hide file tree

Showing 119 changed files with 4,118 additions and 2,746 deletions.
diff --git a/docs/ansimacros_8h.html b/docs/ansimacros_8h.html
@@ -45,7 +45,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">libsir<span id="projectnumber">&#160;2.2.2</span>
+   <div id="projectname">libsir<span id="projectnumber">&#160;2.2.3</span>
    </div>
    <div id="projectbrief">Standard Incident Reporter</div>
   </td>
@@ -302,7 +302,7 @@
 <div class="ttc" id="aansimacros_8h_html_ae96a94895f9559215e6fb40c3c23c740"><div class="ttname"><a href="ansimacros_8h.html#ae96a94895f9559215e6fb40c3c23c740">RED</a></div><div class="ttdeci">#define RED(s)</div><div class="ttdoc">Red foreground text.</div><div class="ttdef"><b>Definition</b> ansimacros.h:83</div></div>
 </div><!-- fragment --><dl class="section author"><dt>Author</dt><dd>Ryan M. Lederman &lt;<a href="#" onclick="location.href='mai'+'lto:'+'led'+'er'+'man'+'@g'+'mai'+'l.'+'com'; return false;">leder<span class="obfuscator">.nosp@m.</span>man@<span class="obfuscator">.nosp@m.</span>gmail<span class="obfuscator">.nosp@m.</span>.com</a>&gt; </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>2018-2023 </dd></dl>
-<dl class="section version"><dt>Version</dt><dd>2.2.2 </dd></dl>
+<dl class="section version"><dt>Version</dt><dd>2.2.3 </dd></dl>
 <dl class="section copyright"><dt>Copyright</dt><dd>The MIT License (MIT)</dd></dl>
 <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
 <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>

diff --git a/docs/ansimacros_8h_source.html b/docs/ansimacros_8h_source.html
@@ -45,7 +45,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">libsir<span id="projectnumber">&#160;2.2.2</span>
+   <div id="projectname">libsir<span id="projectnumber">&#160;2.2.3</span>
    </div>
    <div id="projectbrief">Standard Incident Reporter</div>
   </td>

diff --git a/docs/condition_8h.html b/docs/condition_8h.html
@@ -45,7 +45,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">libsir<span id="projectnumber">&#160;2.2.2</span>
+   <div id="projectname">libsir<span id="projectnumber">&#160;2.2.3</span>
    </div>
    <div id="projectbrief">Standard Incident Reporter</div>
   </td>
@@ -132,15 +132,15 @@
 bool&#160;</td><td class="memItemRight" valign="bottom"><b>_sir_conddestroy</b> (sir_condition *cond)</td></tr>
 <tr class="memdesc:a150dd1b33dee56d4b02442f2f30f09c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys a condition variable. <br /></td></tr>
 <tr class="separator:a150dd1b33dee56d4b02442f2f30f09c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a24b03cb2cda2ff8bc5de7d20824f9249"><td class="memItemLeft" align="right" valign="top"><a id="a24b03cb2cda2ff8bc5de7d20824f9249" name="a24b03cb2cda2ff8bc5de7d20824f9249"></a>
-bool&#160;</td><td class="memItemRight" valign="bottom"><b>_sir_condwait_timeout</b> (sir_condition *cond, sir_mutex *mutex, sir_wait *how_long)</td></tr>
-<tr class="memdesc:a24b03cb2cda2ff8bc5de7d20824f9249"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits a given amount of time for a condition variable to become signaled. <br /></td></tr>
-<tr class="separator:a24b03cb2cda2ff8bc5de7d20824f9249"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8dda6e64ad0dcf2d4bc8ccd1c0c7d2ad"><td class="memItemLeft" align="right" valign="top"><a id="a8dda6e64ad0dcf2d4bc8ccd1c0c7d2ad" name="a8dda6e64ad0dcf2d4bc8ccd1c0c7d2ad"></a>
+bool&#160;</td><td class="memItemRight" valign="bottom"><b>_sir_condwait_timeout</b> (sir_condition *cond, sir_mutex *mutex, const sir_wait *how_long)</td></tr>
+<tr class="memdesc:a8dda6e64ad0dcf2d4bc8ccd1c0c7d2ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits a given amount of time for a condition variable to become signaled. <br /></td></tr>
+<tr class="separator:a8dda6e64ad0dcf2d4bc8ccd1c0c7d2ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><dl class="section author"><dt>Author</dt><dd>Ryan M. Lederman &lt;<a href="#" onclick="location.href='mai'+'lto:'+'led'+'er'+'man'+'@g'+'mai'+'l.'+'com'; return false;">leder<span class="obfuscator">.nosp@m.</span>man@<span class="obfuscator">.nosp@m.</span>gmail<span class="obfuscator">.nosp@m.</span>.com</a>&gt; </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>2018-2023 </dd></dl>
-<dl class="section version"><dt>Version</dt><dd>2.2.2 </dd></dl>
+<dl class="section version"><dt>Version</dt><dd>2.2.3 </dd></dl>
 <dl class="section copyright"><dt>Copyright</dt><dd>The MIT License (MIT)</dd></dl>
 <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
 <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>

diff --git a/docs/condition_8h.js b/docs/condition_8h.js
@@ -3,5 +3,5 @@ var condition_8h =
     [ "_sir_condcreate", "condition_8h.html#ae93cd64b12a564792d3bb0a48a8ddc32", null ],
     [ "_sir_condbroadcast", "condition_8h.html#ae8d6edc94bcfb430cf584b27a91e4040", null ],
     [ "_sir_conddestroy", "condition_8h.html#a150dd1b33dee56d4b02442f2f30f09c5", null ],
-    [ "_sir_condwait_timeout", "condition_8h.html#a24b03cb2cda2ff8bc5de7d20824f9249", null ]
+    [ "_sir_condwait_timeout", "condition_8h.html#a8dda6e64ad0dcf2d4bc8ccd1c0c7d2ad", null ]
 ];
diff --git a/docs/condition_8h_source.html b/docs/condition_8h_source.html
@@ -45,7 +45,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">libsir<span id="projectnumber">&#160;2.2.2</span>
+   <div id="projectname">libsir<span id="projectnumber">&#160;2.2.3</span>
    </div>
    <div id="projectbrief">Standard Incident Reporter</div>
   </td>
@@ -133,13 +133,14 @@
 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="keywordtype">bool</span> _sir_condwait(sir_condition* cond, sir_mutex* mutex);</div>
 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="preprocessor"># endif</span></div>
 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div>
-<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="keywordtype">bool</span> <a class="code hl_function" href="condition_8h.html#a24b03cb2cda2ff8bc5de7d20824f9249">_sir_condwait_timeout</a>(sir_condition* cond, sir_mutex* mutex, sir_wait* how_long);</div>
-<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
-<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="preprocessor">#endif </span><span class="comment">/* !_SIR_CONDITION_H_INCLUDED */</span><span class="preprocessor"></span></div>
-<div class="ttc" id="acondition_8h_html_a150dd1b33dee56d4b02442f2f30f09c5"><div class="ttname"><a href="condition_8h.html#a150dd1b33dee56d4b02442f2f30f09c5">_sir_conddestroy</a></div><div class="ttdeci">bool _sir_conddestroy(sir_condition *cond)</div><div class="ttdoc">Destroys a condition variable.</div><div class="ttdef"><b>Definition</b> sircondition.c:66</div></div>
-<div class="ttc" id="acondition_8h_html_a24b03cb2cda2ff8bc5de7d20824f9249"><div class="ttname"><a href="condition_8h.html#a24b03cb2cda2ff8bc5de7d20824f9249">_sir_condwait_timeout</a></div><div class="ttdeci">bool _sir_condwait_timeout(sir_condition *cond, sir_mutex *mutex, sir_wait *how_long)</div><div class="ttdoc">Waits a given amount of time for a condition variable to become signaled.</div><div class="ttdef"><b>Definition</b> sircondition.c:90</div></div>
-<div class="ttc" id="acondition_8h_html_ae8d6edc94bcfb430cf584b27a91e4040"><div class="ttname"><a href="condition_8h.html#ae8d6edc94bcfb430cf584b27a91e4040">_sir_condbroadcast</a></div><div class="ttdeci">bool _sir_condbroadcast(sir_condition *cond)</div><div class="ttdoc">Broadcast signals a condition variable.</div><div class="ttdef"><b>Definition</b> sircondition.c:55</div></div>
-<div class="ttc" id="acondition_8h_html_ae93cd64b12a564792d3bb0a48a8ddc32"><div class="ttname"><a href="condition_8h.html#ae93cd64b12a564792d3bb0a48a8ddc32">_sir_condcreate</a></div><div class="ttdeci">bool _sir_condcreate(sir_condition *cond)</div><div class="ttdoc">Creates/initializes a new condition variable.</div><div class="ttdef"><b>Definition</b> sircondition.c:31</div></div>
+<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="keywordtype">bool</span> <a class="code hl_function" href="condition_8h.html#a8dda6e64ad0dcf2d4bc8ccd1c0c7d2ad">_sir_condwait_timeout</a>(sir_condition* cond, sir_mutex* mutex,</div>
+<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>    <span class="keyword">const</span> sir_wait* how_long);</div>
+<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span> </div>
+<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="preprocessor">#endif </span><span class="comment">/* !_SIR_CONDITION_H_INCLUDED */</span><span class="preprocessor"></span></div>
+<div class="ttc" id="acondition_8h_html_a150dd1b33dee56d4b02442f2f30f09c5"><div class="ttname"><a href="condition_8h.html#a150dd1b33dee56d4b02442f2f30f09c5">_sir_conddestroy</a></div><div class="ttdeci">bool _sir_conddestroy(sir_condition *cond)</div><div class="ttdoc">Destroys a condition variable.</div><div class="ttdef"><b>Definition</b> sircondition.c:77</div></div>
+<div class="ttc" id="acondition_8h_html_a8dda6e64ad0dcf2d4bc8ccd1c0c7d2ad"><div class="ttname"><a href="condition_8h.html#a8dda6e64ad0dcf2d4bc8ccd1c0c7d2ad">_sir_condwait_timeout</a></div><div class="ttdeci">bool _sir_condwait_timeout(sir_condition *cond, sir_mutex *mutex, const sir_wait *how_long)</div><div class="ttdoc">Waits a given amount of time for a condition variable to become signaled.</div><div class="ttdef"><b>Definition</b> sircondition.c:110</div></div>
+<div class="ttc" id="acondition_8h_html_ae8d6edc94bcfb430cf584b27a91e4040"><div class="ttname"><a href="condition_8h.html#ae8d6edc94bcfb430cf584b27a91e4040">_sir_condbroadcast</a></div><div class="ttdeci">bool _sir_condbroadcast(sir_condition *cond)</div><div class="ttdoc">Broadcast signals a condition variable.</div><div class="ttdef"><b>Definition</b> sircondition.c:62</div></div>
+<div class="ttc" id="acondition_8h_html_ae93cd64b12a564792d3bb0a48a8ddc32"><div class="ttname"><a href="condition_8h.html#ae93cd64b12a564792d3bb0a48a8ddc32">_sir_condcreate</a></div><div class="ttdeci">bool _sir_condcreate(sir_condition *cond)</div><div class="ttdoc">Creates/initializes a new condition variable.</div><div class="ttdef"><b>Definition</b> sircondition.c:30</div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- HTML footer for doxygen 1.9.7-->