Updating libc documentation via Jenkins Pipeline Job

libc/d0/d2a/nl__types_8h_source.html

@@ -90,7 +90,7 @@
 <div class="title">nl_types.h</div>  </div>
 </div><!--header-->
 <div class="contents">
-<a href="../../d0/d2a/nl__types_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef __NL_TYPES_H</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define __NL_TYPES_H</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="../../d0/d2a/nl__types_8h.html#a1fa3a9147e893019af63f94143be86a2">    8</a></span>&#160;<span class="preprocessor">#define NL_SETD 1</span></div><div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="../../d0/d2a/nl__types_8h.html#a93536ea7e2abbebd47f675d70d3e3ad8">    9</a></span>&#160;<span class="preprocessor">#define NL_CAT_LOCALE 1</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="../../d0/d2a/nl__types_8h.html#a3e837d7c96871f164e3c8b28159f01bc">   11</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="../../d0/d2a/nl__types_8h.html#a3e837d7c96871f164e3c8b28159f01bc">nl_item</a>;</div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="../../d0/d2a/nl__types_8h.html#a3f305b6699c89f91aecfc0b5f8604a5f">   12</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span>* <a class="code" href="../../d0/d2a/nl__types_8h.html#a3f305b6699c89f91aecfc0b5f8604a5f">nl_catd</a>;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<a class="code" href="../../d0/d2a/nl__types_8h.html#a3f305b6699c89f91aecfc0b5f8604a5f">nl_catd</a> <a class="code" href="../../d0/d2a/nl__types_8h.html#a215011e68f1927f5605c10ccdf7224ba">catopen</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*, <span class="keywordtype">int</span>);</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="keywordtype">char</span>* <a class="code" href="../../d0/d2a/nl__types_8h.html#a922c08a3ba446fe9dc4f18a525f17898">catgets</a>(<a class="code" href="../../d0/d2a/nl__types_8h.html#a3f305b6699c89f91aecfc0b5f8604a5f">nl_catd</a>, <span class="keywordtype">int</span>, <span class="keywordtype">int</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>*);</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keywordtype">int</span> <a class="code" href="../../d0/d2a/nl__types_8h.html#a56f4c7a73dc2b03e5f8f65f307dbc9f4">catclose</a>(<a class="code" href="../../d0/d2a/nl__types_8h.html#a3f305b6699c89f91aecfc0b5f8604a5f">nl_catd</a>);</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;}</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#endif // __NL_TYPES_H</span></div><div class="ttc" id="nl__types_8h_html_a215011e68f1927f5605c10ccdf7224ba"><div class="ttname"><a href="../../d0/d2a/nl__types_8h.html#a215011e68f1927f5605c10ccdf7224ba">catopen</a></div><div class="ttdeci">nl_catd catopen(const char *, int)</div></div>
+<a href="../../d0/d2a/nl__types_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef __NL_TYPES_H</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define __NL_TYPES_H</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="../../d0/d2a/nl__types_8h.html#a1fa3a9147e893019af63f94143be86a2">    8</a></span>&#160;<span class="preprocessor">#define NL_SETD 1</span></div><div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="../../d0/d2a/nl__types_8h.html#a93536ea7e2abbebd47f675d70d3e3ad8">    9</a></span>&#160;<span class="preprocessor">#define NL_CAT_LOCALE 1</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="../../d0/d2a/nl__types_8h.html#a3e837d7c96871f164e3c8b28159f01bc">   11</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="../../d0/d2a/nl__types_8h.html#a3e837d7c96871f164e3c8b28159f01bc">nl_item</a>;</div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="../../d0/d2a/nl__types_8h.html#a3f305b6699c89f91aecfc0b5f8604a5f">   12</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span>* <a class="code" href="../../d0/d2a/nl__types_8h.html#a3f305b6699c89f91aecfc0b5f8604a5f">nl_catd</a>;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#ifndef DISABLE_UNIMPLEMENTED_LIBC_APIS</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<a class="code" href="../../d0/d2a/nl__types_8h.html#a3f305b6699c89f91aecfc0b5f8604a5f">nl_catd</a> <a class="code" href="../../d0/d2a/nl__types_8h.html#a215011e68f1927f5605c10ccdf7224ba">catopen</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*, <span class="keywordtype">int</span>);</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keywordtype">char</span>* <a class="code" href="../../d0/d2a/nl__types_8h.html#a922c08a3ba446fe9dc4f18a525f17898">catgets</a>(<a class="code" href="../../d0/d2a/nl__types_8h.html#a3f305b6699c89f91aecfc0b5f8604a5f">nl_catd</a>, <span class="keywordtype">int</span>, <span class="keywordtype">int</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>*);</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keywordtype">int</span> <a class="code" href="../../d0/d2a/nl__types_8h.html#a56f4c7a73dc2b03e5f8f65f307dbc9f4">catclose</a>(<a class="code" href="../../d0/d2a/nl__types_8h.html#a3f305b6699c89f91aecfc0b5f8604a5f">nl_catd</a>);</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;}</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#endif // __NL_TYPES_H</span></div><div class="ttc" id="nl__types_8h_html_a215011e68f1927f5605c10ccdf7224ba"><div class="ttname"><a href="../../d0/d2a/nl__types_8h.html#a215011e68f1927f5605c10ccdf7224ba">catopen</a></div><div class="ttdeci">nl_catd catopen(const char *, int)</div></div>
 <div class="ttc" id="nl__types_8h_html_a3f305b6699c89f91aecfc0b5f8604a5f"><div class="ttname"><a href="../../d0/d2a/nl__types_8h.html#a3f305b6699c89f91aecfc0b5f8604a5f">nl_catd</a></div><div class="ttdeci">void * nl_catd</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d2a/nl__types_8h_source.html#l00012">nl_types.h:12</a></div></div>
 <div class="ttc" id="nl__types_8h_html_a3e837d7c96871f164e3c8b28159f01bc"><div class="ttname"><a href="../../d0/d2a/nl__types_8h.html#a3e837d7c96871f164e3c8b28159f01bc">nl_item</a></div><div class="ttdeci">int nl_item</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d2a/nl__types_8h_source.html#l00011">nl_types.h:11</a></div></div>
 <div class="ttc" id="nl__types_8h_html_a56f4c7a73dc2b03e5f8f65f307dbc9f4"><div class="ttname"><a href="../../d0/d2a/nl__types_8h.html#a56f4c7a73dc2b03e5f8f65f307dbc9f4">catclose</a></div><div class="ttdeci">int catclose(nl_catd)</div></div>

libc/d5/d69/md_docs__c_o_n_t_r_i_b_u_t_i_n_g.html

@@ -180,19 +180,27 @@ <h3>Getting Started</h3>
 <p>Install these dependencies:</p>
 <ul>
 <li><a href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</a> must be installed to generate documentation</li>
-<li><a href="https://github.com/premake/premake-core/wiki">Premake</a> is used as the buildsystem<ul>
-<li>Binaries are included for Windows, Linux, and OSX</li>
-<li>If yours is not natively supported please download a binary from the website or file a GitHub issue so I can help</li>
-</ul>
-</li>
+<li><a href="../../#meson-build-system">Meson</a> is the build system</li>
 <li><a href="https://git-lfs.github.com"><code>git-lfs</code></a> is used to store binary files</li>
-<li><code>make</code> and <code>gcc</code> should be installed in order to compile the files (XCode covers these)</li>
+<li><code>make</code> is required to use Makefile shims</li>
+<li>A compiler should be installed in order to build the project (gcc + clang have been tested)</li>
 </ul>
 <p>You will need to fork the main repository to work on your changes. Simply navigate to our GitHub page and click the "Fork" button at the top. Once you've forked the repository, you can clone your new repository and start making edits.</p>
 <p>When using <code>git</code>, it is best to isolate each topic or feature into a “topic branch”. Branches are a great way to group commits related to one feature together, or to isolate different efforts when you might be working on multiple topics at the same time.</p>
 <p>While it takes some experience to get the right feel about how to break up commits, a topic branch should be limited in scope to a single issue. If you are working on multiple issues, please create multiple branches and submit them for review separately.</p>
 <div class="fragment"><div class="line"># Checkout the master branch - you want your new branch to come from master</div><div class="line">git checkout master</div><div class="line"></div><div class="line"># Create a new branch named newfeature (give your branch its own simple informative name)</div><div class="line">git branch newfeature</div><div class="line"></div><div class="line"># Switch to your new branch</div><div class="line">git checkout newfeature</div></div><!-- fragment --><p>For more information on the GitHub fork and pull-request processes, <a href="https://gist.github.com/Chaser324/ce0505fbed06b947d962">please see this helpful guide</a>.</p>
-<h3><code>adr-tools</code></h3>
+<h4>git-lfs</h4>
+<p>This project stores some files using <a href="https://git-lfs.github.com"><code>git-lfs</code></a>.</p>
+<p>To install <code>git-lfs</code> on Linux:</p>
+<div class="fragment"><div class="line">sudo apt install git-lfs</div></div><!-- fragment --><p>To install <code>git-lfs</code> on OS X:</p>
+<div class="fragment"><div class="line">brew install git-lfs</div></div><!-- fragment --><p>Additional installation instructions can be found on the <a href="https://git-lfs.github.com"><code>git-lfs</code> website</a>.</p>
+<h4>Meson Build System</h4>
+<p>The [Meson][meson] build system depends on <code>python3</code> and <code>ninja-build</code>.</p>
+<p>To install on Linux:</p>
+<div class="fragment"><div class="line">sudo apt-get install python3 python3-pip ninja-build</div></div><!-- fragment --><p>To install on OSX:</p>
+<div class="fragment"><div class="line">brew install python3 ninja</div></div><!-- fragment --><p>Meson can be installed through <code>pip3</code>:</p>
+<div class="fragment"><div class="line">pip3 install meson</div></div><!-- fragment --><p>If you want to install Meson globally on Linux, use:</p>
+<div class="fragment"><div class="line">sudo -H pip3 install meson</div></div><!-- fragment --><h3><code>adr-tools</code></h3>
 <p>This repository uses <a href="https://embeddedartistry.com/blog/2018/4/5/documenting-architectural-decisions-within-our-repositories">Architecture Decision Records</a>. Please install <a href="https://github.com/npryce/adr-tools"><code>adr-tools</code></a> to contribute to architecture decisions.</p>
 <p>If you are using OSX, you can install <code>adr-tools</code> through Homebrew:</p>
 <div class="fragment"><div class="line">brew install adr-tools</div></div><!-- fragment --><p>If you are using Windows or Linux, please install <code>adr-tools</code> via <a href="https://github.com/npryce/adr-tools">GitHub</a>.</p>
@@ -204,12 +212,22 @@ <h3>Finding an Issue</h3>
 <li><a href="https://github.com/embeddedartistry/libc/issues?q=is%3Aissue+is%3Aopen+label%3ADocumentation_"><code>Documentation</code></a> labeled issues apply to new documents</li>
 </ul>
 <h3>Development Process</h3>
-<p>This project is still a work-in-progress and does not have a strict development model. <code>master</code> contains the latest code, and new versions are tagged nightly.</p>
-<p>Please branch from <code>master</code> for any new changes.</p>
+<p><code>master</code> contains the latest code, and new versions are tagged nightly.</p>
+<p>Please branch from <code>master</code> for any new changes. Once you are ready to merge changes, open a pull request. The build server will test and analyze the branch to ensure it can be safely merged.</p>
 <h3>Building the Project</h3>
-<p>To run the build, simply call:</p>
-<div class="fragment"><div class="line">$ make</div></div><!-- fragment --><p>This will build the library and tests. You can build individual projects by navigating to <code>build/gen</code>. You will need to run <code>make build_gen</code> before this directory is populated.</p>
-<p>New files in the <code>src/</code> and <code>test/</code> directory trees will be automatically added and compiled. No additional work is necessary.</p>
+<p>The library can be built by issuing the following command:</p>
+<div class="fragment"><div class="line">make</div></div><!-- fragment --><p>This will build all targets for your current architecture.</p>
+<p>You can clean builds using:</p>
+<div class="fragment"><div class="line">make clean</div></div><!-- fragment --><p>You can eliminate the generated <code>buildresults</code> folder using:</p>
+<div class="fragment"><div class="line">make purify</div></div><!-- fragment --><p>You can also use the <code>meson</code> method for compiling.</p>
+<p>Create a build output folder:</p>
+<div class="fragment"><div class="line">meson buildresults</div></div><!-- fragment --><p>Then change into that folder and build targets by running:</p>
+<div class="fragment"><div class="line">ninja</div></div><!-- fragment --><p>At this point, <code>make</code> would still work.</p>
+<h4>Cross-compiling</h4>
+<p>Cross-compilation is handled using <code>meson</code> cross files. Example files are included in the <a href="../../build/cross/"><code>build/cross</code></a> folder. You can write your own cross files for your specific platform (or open an issue and we can help you).</p>
+<p>Cross-compilation must be configured using the meson command when creating the build output folder. For example:</p>
+<div class="fragment"><div class="line">meson buildresults --cross-file build/cross/gcc/arm/gcc_arm_cortex-m4.txt</div></div><!-- fragment --><p>Following that, you can run <code>make</code> (at the project root) or <code>ninja</code> (within the build output directory) to build the project.</p>
+<p>Tests will not be cross-compiled. They will be built for the native platform.</p>
 <h3>Testing</h3>
 <p>If you add code you need to add tests! We’ve learned the hard way that code without tests is undependable. If your pull request reduces our test coverage because it lacks tests then it will be rejected.</p>
 <p>This project uses CMocka as the testing framework.</p>

libc/d5/dbf/md_docs__i_s_s_u_e__t_e_m_p_l_a_t_e.html

@@ -101,7 +101,7 @@
 <h2>Context</h2>
 <p>Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.</p>
 <ul>
-<li>Project Version/Tag/Comit:</li>
+<li>Project Version/Tag/Commit:</li>
 <li>Operating System:</li>
 <li>SDK version:</li>
 <li>Toolchain version:</li>