You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/01/13 19:26:34 UTC
[2/7] incubator-mynewt-site git commit: Fix second level navigation
and function formats in docs
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/heap/index.html
----------------------------------------------------------------------
diff --git a/os/heap/index.html b/os/heap/index.html
index d53aca0..dae3624 100644
--- a/os/heap/index.html
+++ b/os/heap/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="./">Heap</a></li>
+ <li class="toctree-l2"><a href="./">Heap</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_malloc_lock"> os_malloc_lock</a></li>
+
+ <li class="toctree-l3"><a href="#os_malloc_unlock"> os_malloc_unlock</a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,17 +240,17 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_malloc_lock">os_malloc_lock</a></li>
-<li><a href="#function-os_malloc_unlock">os_malloc_unlock</a></li>
+<li><a href="#os_malloc_lock">os_malloc_lock</a></li>
+<li><a href="#os_malloc_unlock">os_malloc_unlock</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_malloc_lock"><font color="2980b9">function os_malloc_lock</font><a class="headerlink" href="#function-os_malloc_lock" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="os_malloc_lock"><font color="F2853F" style="font-size:24pt"> os_malloc_lock</font><a class="headerlink" href="#os_malloc_lock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
os_malloc_lock(void)
</code></pre>
@@ -265,15 +283,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_malloc_unlock"><font color="#2980b9"> function os_malloc_unlock</font><a class="headerlink" href="#function-os_malloc_unlock" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_malloc_unlock"><font color="F2853F" style="font-size:24pt"> os_malloc_unlock</font><a class="headerlink" href="#os_malloc_unlock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -305,15 +320,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -345,9 +357,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/mbufs/index.html
----------------------------------------------------------------------
diff --git a/os/mbufs/index.html b/os/mbufs/index.html
index 7027523..7bdcf1d 100644
--- a/os/mbufs/index.html
+++ b/os/mbufs/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="./">Mbufs</a></li>
+ <li class="toctree-l2"><a href="./">Mbufs</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_mbuf_pool_init"> os_mbuf_pool_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_mbuf_get"> os_mbuf_get</a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,17 +240,17 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_mbuf_pool_init">os_mbuf_pool_init</a></li>
-<li><a href="#function-os_mbuf_get">os_mbuf_get</a></li>
+<li><a href="#os_mbuf_pool_init">os_mbuf_pool_init</a></li>
+<li><a href="#os_mbuf_get">os_mbuf_get</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_mbuf_pool_init"><font color="2980b9">function os_mbuf_pool_init</font><a class="headerlink" href="#function-os_mbuf_pool_init" title="Permanent link">¶</a></h3>
-<pre><code> int
+<h2 id="os_mbuf_pool_init"><font color="F2853F" style="font-size:24pt"> os_mbuf_pool_init</font><a class="headerlink" href="#os_mbuf_pool_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> int
os_mbuf_pool_init(struct os_mbuf_pool *omp, struct os_mempool *mp,
uint16_t hdr_len, uint16_t buf_len, uint16_t nbufs)
</code></pre>
@@ -266,15 +284,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_mbuf_get"><font color="#2980b9"> function os_mbuf_get</font><a class="headerlink" href="#function-os_mbuf_get" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_mbuf_get"><font color="F2853F" style="font-size:24pt"> os_mbuf_get</font><a class="headerlink" href="#os_mbuf_get" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -306,15 +321,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -346,9 +358,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/memory_pool/index.html
----------------------------------------------------------------------
diff --git a/os/memory_pool/index.html b/os/memory_pool/index.html
index eef2448..b4a3ec6 100644
--- a/os/memory_pool/index.html
+++ b/os/memory_pool/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="./">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="./">Memory Pools</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_mempool_init"> os_mempool_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_memblock_get"> os_memblock_get</a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,20 +240,19 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_mempool_init">os_mempool_init</a></li>
-<li><a href="#function-os_memblock_get">os_memblock_get</a></li>
+<li><a href="#os_mempool_init">os_mempool_init</a></li>
+<li><a href="#os_memblock_get">os_memblock_get</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_mempool_init"><font color="2980b9">function os_mempool_init</font><a class="headerlink" href="#function-os_mempool_init" title="Permanent link">¶</a></h3>
-<pre><code> os_error_t
+<h2 id="os_mempool_init"><font color="F2853F" style="font-size:24pt"> os_mempool_init</font><a class="headerlink" href="#os_mempool_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> os_error_t
os_mempool_init(struct os_mempool *mp, int blocks,
int block_size, void *membuf, char *name)
-
</code></pre>
<p><Insert short description></p>
@@ -267,15 +284,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_memblock_get"><font color="#2980b9"> function os_memblock_get</font><a class="headerlink" href="#function-os_memblock_get" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_memblock_get"><font color="#F2853F" style="font-size:24pt"> os_memblock_get</font><a class="headerlink" href="#os_memblock_get" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -307,15 +321,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -347,9 +358,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/mutex/index.html
----------------------------------------------------------------------
diff --git a/os/mutex/index.html b/os/mutex/index.html
index 9f538b7..e27273a 100644
--- a/os/mutex/index.html
+++ b/os/mutex/index.html
@@ -136,43 +136,63 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="./">Mutexes</a></li>
+ <li class="toctree-l2"><a href="./">Mutexes</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_mutex_init">os_mutex_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_mutex_release">os_mutex_release</a></li>
+
+ <li class="toctree-l3"><a href="#os_mutex_pend">os_mutex_pend </a></li>
+
+ <li class="toctree-l3"><a href="#os_mutex_delete">os_mutex_delete </a></li>
+
+
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -223,7 +243,7 @@
<p>The following example will illustrate how priority inheritance works. In this example, the task number is the same as its priority. Remember that the lower the number, the higher the priority (i.e. priority 0 is higher priority than priority 1). Suppose that task 5 gets ownership of a mutex but is preempted by task 4. Task 4 attempts to gain ownership of the mutex but cannot as it is owned by task 5. Task 4 is put to sleep and task 5 is temporarily raised to priority 4. Before task 5 can release the mutex, task 3 runs and attempts to acquire the mutex. At this point, both task 3 and task 4 are waiting on the mutex (sleeping). Task 5 now runs at priority 3 (the highest priority of all the tasks waiting on the mutex). When task 5 finally releases the mutex it will be preempted as two higher priority tasks are waiting for it. </p>
<p>Note that when multiple tasks are waiting on a mutex owned by another task, once the mutex is released the highest priority task waiting on the mutex is run. </p>
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
-<pre><code>struct os_mutex
+<pre><code class="no-highlight">struct os_mutex
{
SLIST_HEAD(, os_task) mu_head;
uint8_t _pad;
@@ -231,7 +251,6 @@
uint16_t mu_level;
struct os_task *mu_owner;
};
-
</code></pre>
<table>
@@ -268,16 +287,15 @@
<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_mutex_init">os_mutex_init</a></li>
-<li><a href="#function-os_mutex_release">os_mutex_release</a></li>
-<li><a href="#function-os_mutex_pend">os_mutex_pend</a></li>
-<li><a href="#function-os_mutex_delete">os_mutex_delete</a></li>
+<li><a href="#os_mutex_init">os_mutex_init</a></li>
+<li><a href="#os_mutex_release">os_mutex_release</a></li>
+<li><a href="#os_mutex_pend">os_mutex_pend</a></li>
+<li><a href="#os_mutex_delete">os_mutex_delete</a></li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_mutex_init"><font color="2980b9">function os_mutex_init</font><a class="headerlink" href="#function-os_mutex_init" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_mutex_init(struct os_mutex *mu)
-
+<h2 id="os_mutex_init"><font color="#F2853F" style="font-size:24pt">os_mutex_init</font><a class="headerlink" href="#os_mutex_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_mutex_init(struct os_mutex *mu)
</code></pre>
<p>Initialize the mutex. Must be called before the mutex can be used.</p>
@@ -304,19 +322,16 @@
Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).></p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
-<pre><code>struct os_mutex g_mutex1;
+<pre><code class="no-highlight">struct os_mutex g_mutex1;
os_error_t err;
err = os_mutex_init(&g_mutex1);
assert(err == OS_OK);
-
</code></pre>
<hr />
-<h3 id="function-os_mutex_release"><font color="#2980b9"> function os_mutex_release</font><a class="headerlink" href="#function-os_mutex_release" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_mutex_release(struct os_mutex *mu)
-
-
+<h2 id="os_mutex_release"><font color="#F2853F" style="font-size:24pt">os_mutex_release</font><a class="headerlink" href="#os_mutex_release" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_mutex_release(struct os_mutex *mu)
</code></pre>
<p>Release ownership of a mutex</p>
@@ -341,7 +356,7 @@ assert(err == OS_OK);
<p>OS_BAD_MUTEX: The mutex was not owned by the task attempting to release it.</p>
<p>OS_NOT_STARTED: Attempt to release a mutex before the os has been started.</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
-<pre><code>struct os_mutex g_mutex1;
+<pre><code class="no-highlight">struct os_mutex g_mutex1;
os_error_t err;
err = os_mutex_pend(&g_mutex1, 0);
@@ -351,13 +366,11 @@ assert(err == OS_OK);
err = os_mutex_release(&g_mutex1);
assert(err == OS_OK);
-
</code></pre>
<hr />
-<h3 id="function-os_mutex_pend"><font color="#2980b9"> function os_mutex_pend </font><a class="headerlink" href="#function-os_mutex_pend" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_mutex_pend(struct os_mutex *mu, uint32_t timeout)
-
+<h2 id="os_mutex_pend"><font color="#F2853F" style="font-size:24pt">os_mutex_pend </font><a class="headerlink" href="#os_mutex_pend" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_mutex_pend(struct os_mutex *mu, uint32_t timeout)
</code></pre>
<p>Acquire ownership of a mutex.</p>
@@ -388,7 +401,7 @@ assert(err == OS_OK);
<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
<p>If the mutex is owned by another task and the timeout is 0 the function returns immediately with the error code OS_TIMEOUT. The calling task <em>does not</em> own the mutex when this occurs.</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
-<pre><code>struct os_mutex g_mutex1;
+<pre><code class="no-highlight">struct os_mutex g_mutex1;
os_error_t err;
err = os_mutex_pend(&g_mutex1, 0);
@@ -398,14 +411,11 @@ assert(err == OS_OK);
err = os_mutex_release(&g_mutex1);
assert(err == OS_OK);
-
-
</code></pre>
<hr />
-<h3 id="function-os_mutex_delete"><font color="#2980b9"> function os_mutex_delete </font><a class="headerlink" href="#function-os_mutex_delete" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_mutex_pend(struct os_mutex *mu)
-
+<h2 id="os_mutex_delete"><font color="#F2853F" style="font-size:24pt">os_mutex_delete </font><a class="headerlink" href="#os_mutex_delete" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_mutex_pend(struct os_mutex *mu)
</code></pre>
<p>Delete a mutex</p>
@@ -429,13 +439,11 @@ assert(err == OS_OK);
<p>OS_OK: mutex initialized successfully.</p>
<p>OS_NOT_STARTED: Attempt to release a mutex before the os has been started.</p>
<h4 id="example_3">Example<a class="headerlink" href="#example_3" title="Permanent link">¶</a></h4>
-<pre><code>struct os_mutex g_mutex1;
+<pre><code class="no-highlight">struct os_mutex g_mutex1;
os_error_t err;
err = os_mutex_delete(&g_mutex1);
assert(err == OS_OK);
-
-
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/mynewt_os/index.html
----------------------------------------------------------------------
diff --git a/os/mynewt_os/index.html b/os/mynewt_os/index.html
index 840e9d7..b4c0554 100644
--- a/os/mynewt_os/index.html
+++ b/os/mynewt_os/index.html
@@ -136,43 +136,65 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="./">Overview</a></li>
+ <li class="toctree-l2"><a href="./">Overview</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#real-time-kernel">Real-Time Kernel </a></li>
+
+ <li class="toctree-l3"><a href="#real-time-os">Real-Time OS </a></li>
+
+ <li class="toctree-l3"><a href="#insert-topic-of-your-choice">Insert topic of your choice</a></li>
+
+ <li class="toctree-l3"><a href="#features">Features</a></li>
+
+ <li class="toctree-l3"><a href="#os-functions">OS Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_idle_task"> os_idle_task</a></li>
+
+ <li class="toctree-l3"><a href="#os_started"> os_started</a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -239,17 +261,17 @@
<li><a href="../port_os/">Porting OS to other platforms</a></li>
</ul>
<h2 id="os-functions">OS Functions<a class="headerlink" href="#os-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_idle_task">os_idle_task</a></li>
-<li><a href="#function-os_started">os_started</a></li>
+<li><a href="#os_idle_task">os_idle_task</a></li>
+<li><a href="#os_started">os_started</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_idle_task"><font color="2980b9">function os_idle_task</font><a class="headerlink" href="#function-os_idle_task" title="Permanent link">¶</a></h3>
-<pre><code> void
+<h2 id="os_idle_task"><font color="F2853F" style="font-size:24pt"> os_idle_task</font><a class="headerlink" href="#os_idle_task" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> void
os_idle_task(void *arg)
</code></pre>
@@ -282,15 +304,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_started"><font color="#2980b9"> function os_started</font><a class="headerlink" href="#function-os_started" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_started"><font color="#F2853F" style="font-size:24pt"> os_started</font><a class="headerlink" href="#os_started" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -322,15 +341,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -362,9 +378,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/port_os/index.html
----------------------------------------------------------------------
diff --git a/os/port_os/index.html b/os/port_os/index.html
index d4a9224..923ad98 100644
--- a/os/port_os/index.html
+++ b/os/port_os/index.html
@@ -136,43 +136,51 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="./">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="./">Porting to other Platforms</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#insert-sections-as-you-wish">Insert sections as you wish</a></li>
+
+
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/sanity/index.html
----------------------------------------------------------------------
diff --git a/os/sanity/index.html b/os/sanity/index.html
index 9dc73b9..53b7ed0 100644
--- a/os/sanity/index.html
+++ b/os/sanity/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="./">Sanity</a></li>
+ <li class="toctree-l2"><a href="./">Sanity</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_sanity_check_init"> os_sanity_check_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_sanity_check_list_lock"> os_sanity_check_list_lock </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,19 +240,18 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_sanity_check_init">os_sanity_check_init</a></li>
-<li><a href="#function-os_sanity_check_list_lock">os_sanity_check_list_lock</a></li>
+<li><a href="#os_sanity_check_init">os_sanity_check_init</a></li>
+<li><a href="#os_sanity_check_list_lock">os_sanity_check_list_lock</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_sanity_check_init"><font color="2980b9">function os_sanity_check_init</font><a class="headerlink" href="#function-os_sanity_check_init" title="Permanent link">¶</a></h3>
-<pre><code> int
+<h2 id="os_sanity_check_init"><font color="F2853F" style="font-size:24pt"> os_sanity_check_init</font><a class="headerlink" href="#os_sanity_check_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> int
os_sanity_check_init(struct os_sanity_check *sc)
-
</code></pre>
<p><Insert short description></p>
@@ -266,15 +283,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_sanity_check_list_lock"><font color="#2980b9"> function os_sanity_check_list_lock </font><a class="headerlink" href="#function-os_sanity_check_list_lock" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_sanity_check_list_lock"><font color="#F2853F" style="font-size:24pt"> os_sanity_check_list_lock </font><a class="headerlink" href="#os_sanity_check_list_lock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -306,15 +320,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -346,9 +357,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/semaphore/index.html
----------------------------------------------------------------------
diff --git a/os/semaphore/index.html b/os/semaphore/index.html
index 5534553..02c0a9d 100644
--- a/os/semaphore/index.html
+++ b/os/semaphore/index.html
@@ -136,43 +136,63 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="./">Semaphores</a></li>
+ <li class="toctree-l2"><a href="./">Semaphores</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_sem_init"> os_sem_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_sem_release"> os_sem_release </a></li>
+
+ <li class="toctree-l3"><a href="#os_sem_pend"> os_sem_pend </a></li>
+
+ <li class="toctree-l3"><a href="#os_sem_delete"> os_sem_delete </a></li>
+
+
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -223,8 +243,7 @@
<p>Semaphores can also be used for task synchronization. A simple example of this would be the following. A task creates a semaphore and initializes it with no tokens. The task then waits on the semaphore, and since there are no tokens, the task is put to sleep. When other tasks want to wake up the sleeping task they simply add a token by calling <em>os_sem_release</em>. This will cause the sleeping task to wake up (instantly if no other higher priority tasks want to run).</p>
<p>The other common use of a counting semaphore is in what is commonly called a "producer/consumer" relationship. The producer adds tokens (by calling <em>os_sem_release</em>) and the consumer consumes them by calling <em>os_sem_pend</em>. In this relationship, the producer has work for the consumer to do. Each token added to the semaphore will cause the consumer to do whatever work is required. A simple example could be the following: every time a button is pressed there is some work to do (ring a bell). Each button press causes the producer to add a token. Each token consumed rings the bell. There will exactly the same number of bell rings as there are button presses. In other words, each call to <em>os_sem_pend</em> subtracts exactly one token and each call to <em>os_sem_release</em> adds exactly one token.</p>
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
-<pre><code>
-struct os_sem
+<pre><code class="no-highlight">struct os_sem
{
SLIST_HEAD(, os_task) sem_head; /* chain of waiting tasks */
uint16_t _pad;
@@ -258,16 +277,15 @@ struct os_sem
<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_sem_init">os_sem_init</a></li>
-<li><a href="#function-os_sem_release">os_sem_release</a></li>
-<li><a href="#function-os_sem_pend">os_sem_pend</a></li>
-<li><a href="#function-os_sem_delete">os_sem_delete</a></li>
+<li><a href="#os_sem_init">os_sem_init</a></li>
+<li><a href="#os_sem_release">os_sem_release</a></li>
+<li><a href="#os_sem_pend">os_sem_pend</a></li>
+<li><a href="#os_sem_delete">os_sem_delete</a></li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_sem_init"><font color="2980b9">function os_sem_init</font><a class="headerlink" href="#function-os_sem_init" title="Permanent link">¶</a></h3>
-<pre><code> os_error_t os_sem_init(struct os_sem *sem, uint16_t tokens)
-
+<h2 id="os_sem_init"><font color="F2853F" style="font-size:24pt"> os_sem_init</font><a class="headerlink" href="#os_sem_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_sem_init(struct os_sem *sem, uint16_t tokens)
</code></pre>
<p>Initialize a semaphore with a given number of tokens. Should be called before the semaphore is used.</p>
@@ -299,18 +317,16 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).></p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p>The following example shows how to initialize a semaphore used for exclusive access.</p>
-<pre><code>struct os_mutex g_os_sem;
+<pre><code class="no-highlight">struct os_mutex g_os_sem;
os_error_t err;
err = os_sem_init(&g_os_sem, 1);
assert(err == OS_OK);
-
</code></pre>
<hr />
-<h3 id="function-os_sem_release"><font color="#2980b9"> function os_sem_release </font><a class="headerlink" href="#function-os_sem_release" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_sem_release(struct os_sem *sem)
-
+<h2 id="os_sem_release"><font color="#F2853F" style="font-size:24pt"> os_sem_release </font><a class="headerlink" href="#os_sem_release" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_sem_release(struct os_sem *sem)
</code></pre>
<p>Release a semaphore that you are holding. This adds a token to the semaphore.</p>
@@ -335,7 +351,7 @@ assert(err == OS_OK);
<p>OS_OK: semaphore released successfully.</p>
<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
-<pre><code>struct os_sem g_os_sem;
+<pre><code class="no-highlight">struct os_sem g_os_sem;
os_error_t err;
err = os_sem_pend(&g_os_sem, OS_TIMEOUT_NEVER);
@@ -345,13 +361,11 @@ assert(err == OS_OK);
err = os_sem_release(&g_os_sem);
assert(err == OS_OK);
-
</code></pre>
<hr />
-<h3 id="function-os_sem_pend"><font color="#2980b9"> function os_sem_pend </font><a class="headerlink" href="#function-os_sem_pend" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_sem_pend(struct os_sem *sem, uint32_t timeout)
-
+<h2 id="os_sem_pend"><font color="#F2853F" style="font-size:24pt"> os_sem_pend </font><a class="headerlink" href="#os_sem_pend" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_sem_pend(struct os_sem *sem, uint32_t timeout)
</code></pre>
<p>Wait for a semaphore for a given amount of time.</p>
@@ -382,7 +396,7 @@ assert(err == OS_OK);
<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
<p>If a timeout of 0 is used and the function returns OS_TIMEOUT, the semaphore was not available and was not acquired. No release of the semaphore should occur and the calling task does not own the semaphore.</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
-<pre><code>struct os_sem g_os_sem;
+<pre><code class="no-highlight">struct os_sem g_os_sem;
os_error_t err;
err = os_sem_pend(&g_os_sem, OS_TIMEOUT_NEVER);
@@ -396,9 +410,8 @@ assert(err == OS_OK);
</code></pre>
<hr />
-<h3 id="function-os_sem_delete"><font color="#2980b9"> function os_sem_delete </font><a class="headerlink" href="#function-os_sem_delete" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_sem_delete(struct os_sem *sem)
-
+<h2 id="os_sem_delete"><font color="#F2853F" style="font-size:24pt"> os_sem_delete </font><a class="headerlink" href="#os_sem_delete" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_sem_delete(struct os_sem *sem)
</code></pre>
<p>Delete a semaphore</p>
@@ -424,13 +437,11 @@ assert(err == OS_OK);
<h4 id="notes_3">Notes<a class="headerlink" href="#notes_3" title="Permanent link">¶</a></h4>
<p>Care must be taken when deleting a semaphore as deleting a semaphore used by other tasks could causes unexpected/unwanted behavior.</p>
<h4 id="example_3">Example<a class="headerlink" href="#example_3" title="Permanent link">¶</a></h4>
-<pre><code>struct os_sem g_os_sem;
+<pre><code class="no-highlight">struct os_sem g_os_sem;
os_error_t err;
err = os_sem_delete(&g_os_sem);
assert(err == OS_OK);
-
-
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/task/index.html
----------------------------------------------------------------------
diff --git a/os/task/index.html b/os/task/index.html
index c6f1fb8..53608b1 100644
--- a/os/task/index.html
+++ b/os/task/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="./">Tasks</a></li>
+ <li class="toctree-l2"><a href="./">Tasks</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#_clear_stack"> _clear_stack </a></li>
+
+ <li class="toctree-l3"><a href="#os_task_next_id"> os_task_next_id </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,19 +240,18 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-_clear_stack">_clear_stack</a></li>
-<li><a href="#function-os_task_next_id">os_task_next_id</a></li>
+<li><a href="#_clear_stack">_clear_stack</a></li>
+<li><a href="#os_task_next_id">os_task_next_id</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-_clear_stack"><font color="2980b9">function _clear_stack </font><a class="headerlink" href="#function-_clear_stack" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="_clear_stack"><font color="F2853F" style="font-size:24pt"> _clear_stack </font><a class="headerlink" href="#_clear_stack" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">static void
_clear_stack(os_stack_t *stack_bottom, int size)
-
</code></pre>
<p><Insert short description></p>
@@ -266,15 +283,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_task_next_id"><font color="#2980b9"> function os_task_next_id </font><a class="headerlink" href="#function-os_task_next_id" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_task_next_id"><font color="#F2853F" style="font-size:24pt"> os_task_next_id </font><a class="headerlink" href="#os_task_next_id" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -306,15 +320,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -346,9 +357,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />