deploy: e322c50

jevinskie · Mar 26, 2024 · 2f77dc8 · 2f77dc8
1 parent 3a5f4aa
commit 2f77dc8
Show file tree

Hide file tree

Showing 15 changed files with 40 additions and 124 deletions.
diff --git a/about_8dox.html → _b_u_i_l_d_i_n_g_8md.html b/about_8dox.html → _b_u_i_l_d_i_n_g_8md.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8" />
-  <title>about.dox file | redirect-to-os-log</title>
+  <title>BUILDING.md file | redirect-to-os-log</title>
   <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
   <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
   <link rel="icon" href="favicon-dark.png" type="image/png" />
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">
@@ -49,7 +44,7 @@
     <div class="m-row">
       <div class="m-col-l-10 m-push-l-1">
         <h1>
-          about.dox <span class="m-thin">file</span>
+          BUILDING.md <span class="m-thin">file</span>
         </h1>
         <p><span></span></p>
       </div>

diff --git a/dir_ef3b2545113449f8f25e623a543d64e3.html → _l_i_c_e_n_s_e_8md.html b/dir_ef3b2545113449f8f25e623a543d64e3.html → _l_i_c_e_n_s_e_8md.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8" />
-  <title>docs/pages/ directory | redirect-to-os-log</title>
+  <title>LICENSE.md file | redirect-to-os-log</title>
   <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
   <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
   <link rel="icon" href="favicon-dark.png" type="image/png" />
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">
@@ -49,7 +44,7 @@
     <div class="m-row">
       <div class="m-col-l-10 m-push-l-1">
         <h1>
-          <span class="m-breadcrumb"><a href="dir_49e56c817e5e54854c35e136979f97ca.html">docs</a>/</span>pages<span class="m-breadcrumb">/</span> <span class="m-thin">directory</span>
+          LICENSE.md <span class="m-thin">file</span>
         </h1>
         <p><span></span></p>
       </div>

diff --git a/_r_e_a_d_m_e_8md.html b/_r_e_a_d_m_e_8md.html
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">

diff --git a/annotated.html b/annotated.html
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">

diff --git a/classexported__class.html b/classexported__class.html
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">

diff --git a/dir_72783cf1d3374632653f7beecc28604e.html → dir_734fde7134c1c1cf2293ba8c841644a0.html b/dir_72783cf1d3374632653f7beecc28604e.html → dir_734fde7134c1c1cf2293ba8c841644a0.html
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">

diff --git a/files.html b/files.html
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">
@@ -51,18 +46,13 @@
         <h1>Files</h1>
         <ul class="m-doc">
           <li class="m-doc-collapsible">
-            <a href="#" onclick="return toggle(this)">dir</a> <a href="dir_49e56c817e5e54854c35e136979f97ca.html" class="m-doc">docs</a> <span class="m-doc"><span></span></span>
-            <ul class="m-doc">
-              <li>dir <a href="dir_ef3b2545113449f8f25e623a543d64e3.html" class="m-doc">pages</a> <span class="m-doc"><span></span></span></li>
-            </ul>
-          </li>
-          <li class="m-doc-collapsible">
-            <a href="#" onclick="return toggle(this)">dir</a> <a href="dir_72783cf1d3374632653f7beecc28604e.html" class="m-doc">redirect-to-os-log</a> <span class="m-doc"><span></span></span>
+            <a href="#" onclick="return toggle(this)">dir</a> <a href="dir_734fde7134c1c1cf2293ba8c841644a0.html" class="m-doc">redirect-to-os-log</a> <span class="m-doc"><span></span></span>
             <ul class="m-doc">
               <li>file <a href="redirect-to-os-log_8hpp.html" class="m-doc">redirect-to-os-log.hpp</a> <span class="m-doc"><span></span></span></li>
             </ul>
           </li>
-          <li>file <a href="about_8dox.html" class="m-doc">about.dox</a> <span class="m-doc"><span></span></span></li>
+          <li>file <a href="_b_u_i_l_d_i_n_g_8md.html" class="m-doc">BUILDING.md</a> <span class="m-doc"><span></span></span></li>
+          <li>file <a href="_l_i_c_e_n_s_e_8md.html" class="m-doc">LICENSE.md</a> <span class="m-doc"><span></span></span></li>
           <li>file <a href="_r_e_a_d_m_e_8md.html" class="m-doc">README.md</a> <span class="m-doc"><span></span></span></li>
         </ul>
         <script>

diff --git a/index.html b/index.html
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">
@@ -51,7 +46,7 @@
         <h1>
           redirect-to-os-log
         </h1>
-<p><a name="md__r_e_a_d_m_e"></a> Command line utility to run a program and redirect its stdout and stderr to XNU&#x27;s os_log facilities. Also includes an injectable dylib for the same purpose.</p><section id="autotoc_md1"><h2><a href="#autotoc_md1">Building and installing</a></h2><p>See the BUILDING document.</p></section><section id="autotoc_md2"><h2><a href="#autotoc_md2">Licensing</a></h2><p>[BSD-2-Clause license](LICENSE)</p></section>
+<p><a name="md__r_e_a_d_m_e"></a> <a href="https://codecov.io/gh/jevinskie/redirect-to-os-log"><img class="m-image" src="https://codecov.io/gh/jevinskie/redirect-to-os-log/graph/badge.svg?token=IU5PKO6WKF" alt="Image" /></a></p><p>Command line utility to run a program and redirect its stdout and stderr to XNU&#x27;s os_log facilities. Also includes an injectable dylib for the same purpose.</p><section id="autotoc_md1"><h2><a href="#autotoc_md1">Building and installing</a></h2><p>See the <a href="md__b_u_i_l_d_i_n_g.html" class="m-doc">BUILDING</a> document.</p></section><section id="autotoc_md2"><h2><a href="#autotoc_md2">Licensing</a></h2><p><a href="md__l_i_c_e_n_s_e.html" class="m-doc">BSD-2-Clause license</a></p></section>
       </div>
     </div>
   </div>

diff --git a/dir_49e56c817e5e54854c35e136979f97ca.html → md__b_u_i_l_d_i_n_g.html b/dir_49e56c817e5e54854c35e136979f97ca.html → md__b_u_i_l_d_i_n_g.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8" />
-  <title>docs/ directory | redirect-to-os-log</title>
+  <title>Building with CMake | redirect-to-os-log</title>
   <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
   <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
   <link rel="icon" href="favicon-dark.png" type="image/png" />
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">
@@ -49,27 +44,17 @@
     <div class="m-row">
       <div class="m-col-l-10 m-push-l-1">
         <h1>
-          docs<span class="m-breadcrumb">/</span> <span class="m-thin">directory</span>
+          Building with CMake
         </h1>
-        <p><span></span></p>
-        <nav class="m-block m-default">
-          <h3>Contents</h3>
-          <ul>
-            <li>
-              Reference
-              <ul>
-                <li><a href="#subdirs">Directories</a></li>
-              </ul>
-            </li>
-          </ul>
-        </nav>
-        <section id="subdirs">
-          <h2><a href="#subdirs">Directories</a></h2>
-          <dl class="m-doc">
-            <dt>directory <a href="dir_ef3b2545113449f8f25e623a543d64e3.html" class="m-doc">pages</a>/</dt>
-            <dd><span></span></dd>
-          </dl>
-        </section>
+<p><a name="autotoc_md3"></a></p><section id="autotoc_md4"><h2><a href="#autotoc_md4">Build</a></h2><p>This project doesn&#x27;t require any special command-line flags to build to keep things simple.</p><p>Here are the steps for building in release mode with a single-configuration generator, like the Ninja one:</p><pre class="m-code">cmake<span class="w"> </span>-S<span class="w"> </span>.<span class="w"> </span>-B<span class="w"> </span>build<span class="w"> </span>-G<span class="w"> </span>Ninja-D<span class="w"> </span><span class="nv">CMAKE_BUILD_TYPE</span><span class="o">=</span>Release
+cmake<span class="w"> </span>--build<span class="w"> </span>build</pre><p>Here are the steps for building in release mode with a multi-configuration generator, like the Xcode ones:</p><pre class="m-code">cmake<span class="w"> </span>-S<span class="w"> </span>.<span class="w"> </span>-B<span class="w"> </span>build<span class="w"> </span>-G<span class="w"> </span>Xcode
+cmake<span class="w"> </span>--build<span class="w"> </span>build<span class="w"> </span>--config<span class="w"> </span>Release</pre></section><section id="autotoc_md5"><h2><a href="#autotoc_md5">Install</a></h2><p>This project doesn&#x27;t require any special command-line flags to install to keep things simple. As a prerequisite, the project has to be built with the above commands already.</p><p>The below commands require at least CMake 3.15 to run, because that is the version in which <a href="https://cmake.org/cmake/help/latest/manual/cmake.1.html#install-a-project">Install a Project</a> was added.</p><p>Here is the command for installing the release mode artifacts with a single-configuration generator, like the Ninja one:</p><pre class="m-code">cmake<span class="w"> </span>--install<span class="w"> </span>build</pre><p>Here is the command for installing the release mode artifacts with a multi-configuration generator, like the Xcode ones:</p><pre class="m-code">cmake<span class="w"> </span>--install<span class="w"> </span>build<span class="w"> </span>--config<span class="w"> </span>Release</pre><section id="autotoc_md6"><h3><a href="#autotoc_md6">CMake package</a></h3><p>This project exports a CMake package to be used with the <a href="https://cmake.org/cmake/help/latest/command/find_package.html"><code>find_package</code></a> command of CMake:</p><ul><li>Package name: <code>redirect-to-os-log</code></li><li>Target name: <code>redirect-to-os-log::redirect-to-os-log</code></li></ul><p>Example usage:</p><pre class="m-code"><span class="nb">find_package</span><span class="p">(</span><span class="s">redirect-to-os-log</span><span class="w"> </span><span class="s">REQUIRED</span><span class="p">)</span>
+<span class="c"># Declare the imported target as a build requirement using PRIVATE, where</span>
+<span class="c"># project_target is a target created in the consuming project</span>
+<span class="nb">target_link_libraries</span><span class="p">(</span>
+<span class="w">    </span><span class="s">project_target</span><span class="w"> </span><span class="s">PRIVATE</span>
+<span class="w">    </span><span class="s">redirect-to-os-log::redirect-to-os-log</span>
+<span class="p">)</span></pre></section><section id="autotoc_md7"><h3><a href="#autotoc_md7">Note to packagers</a></h3><p>The <code>CMAKE_INSTALL_INCLUDEDIR</code> is set to a path other than just <code>include</code> if the project is configured as a top level project to avoid indirectly including other libraries when installed to a common prefix. Please review the <a href="cmake/install-rules.cmake">install-rules.cmake</a> file for the full set of install rules.</p></section></section>
       </div>
     </div>
   </div>

diff --git a/about.html → md__l_i_c_e_n_s_e.html b/about.html → md__l_i_c_e_n_s_e.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8" />
-  <title>About | redirect-to-os-log</title>
+  <title>LICENSE | redirect-to-os-log</title>
   <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
   <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
   <link rel="icon" href="favicon-dark.png" type="image/png" />
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html" id="m-navbar-current">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">
@@ -49,9 +44,9 @@
     <div class="m-row">
       <div class="m-col-l-10 m-push-l-1">
         <h1>
-          About
+          LICENSE
         </h1>
-<section id="about-doxygen"><h2><a href="#about-doxygen">Doxygen documentation</a></h2><p>This page is auto generated using <a href="https://www.doxygen.nl/">Doxygen</a>, making use of some useful <a href="https://www.doxygen.nl/manual/commands.html">special commands</a>.</p></section>
+<p>BSD 2-Clause License</p><p>Copyright (c) 2024, Jevin Sweval</p><p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p><ol><li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li><li>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</li></ol><p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
       </div>
     </div>
   </div>

diff --git a/modules.html b/modules.html
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">

diff --git a/namespaces.html b/namespaces.html
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html">Pages</a></li>
             <li><a href="namespaces.html" id="m-navbar-current">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">

diff --git a/pages.html b/pages.html
@@ -24,12 +24,7 @@
       <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
         <div class="m-row">
           <ol class="m-col-t-6 m-col-m-none">
-            <li>
-              <a href="pages.html" id="m-navbar-current">Pages</a>
-              <ol>
-                <li><a href="about.html">About</a></li>
-              </ol>
-            </li>
+            <li><a href="pages.html" id="m-navbar-current">Pages</a></li>
             <li><a href="namespaces.html">Namespaces</a></li>
           </ol>
           <ol class="m-col-t-6 m-col-m-none" start="3">
@@ -50,7 +45,8 @@
       <div class="m-col-l-10 m-push-l-1">
         <h1>Pages</h1>
         <ul class="m-doc">
-          <li><a href="about.html" class="m-doc">About</a> <span class="m-doc"></span></li>
+          <li><a href="md__b_u_i_l_d_i_n_g.html" class="m-doc">Building with CMake</a> <span class="m-doc"></span></li>
+          <li><a href="md__l_i_c_e_n_s_e.html" class="m-doc">LICENSE</a> <span class="m-doc"></span></li>
         </ul>
         <script>
         function toggle(e) {