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:35 UTC
[3/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/modules/bootloader/index.html
----------------------------------------------------------------------
diff --git a/modules/bootloader/index.html b/modules/bootloader/index.html
index e9020e1..93dceb4 100644
--- a/modules/bootloader/index.html
+++ b/modules/bootloader/index.html
@@ -141,19 +141,37 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../console/">Console</a></li>
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
- <li class="toctree-l3"><a href="../shell/">Shell</a></li>
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
- <li class="toctree-l3"><a href="./">Bootloader</a></li>
+ <li class="toctree-l2"><a href="./">Bootloader</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="#boot_slot_addr"> boot_slot_addr </a></li>
+
+ <li class="toctree-l3"><a href="#boot_find_image_slot"> boot_find_image_slot </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
- <li class="toctree-l3"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
</ul>
@@ -198,19 +216,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-boot_slot_addr">boot_slot_addr</a></li>
-<li><a href="#function-boot_find_image_slot">boot_find_image_slot</a></li>
+<li><a href="#boot_slot_addr">boot_slot_addr</a></li>
+<li><a href="#boot_find_image_slot">boot_find_image_slot</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-boot_slot_addr"><font color="2980b9">function boot_slot_addr </font><a class="headerlink" href="#function-boot_slot_addr" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="boot_slot_addr"><font color="F2853F" style="font-size:24pt"> boot_slot_addr </font><a class="headerlink" href="#boot_slot_addr" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
boot_slot_addr(int slot_num, uint8_t *flash_id, uint32_t *address)
-
</code></pre>
<p><Insert short description></p>
@@ -242,15 +259,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-boot_find_image_slot"><font color="#2980b9"> function boot_find_image_slot </font><a class="headerlink" href="#function-boot_find_image_slot" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="boot_find_image_slot"><font color="#F2853F" style="font-size:24pt"> boot_find_image_slot </font><a class="headerlink" href="#boot_find_image_slot" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -282,15 +296,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>
@@ -322,9 +333,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/modules/console/index.html
----------------------------------------------------------------------
diff --git a/modules/console/index.html b/modules/console/index.html
index 00b345e..fb0be1d 100644
--- a/modules/console/index.html
+++ b/modules/console/index.html
@@ -141,19 +141,55 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="./">Console</a></li>
+ <li class="toctree-l2"><a href="./">Console</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="#console_printf"> console_printf</a></li>
+
+ <li class="toctree-l3"><a href="#console_add_char"> console_add_char</a></li>
+
+ <li class="toctree-l3"><a href="#console_pull_char"> console_pull_char </a></li>
+
+ <li class="toctree-l3"><a href="#console_pull_char_head"> console_pull_char_head </a></li>
+
+ <li class="toctree-l3"><a href="#console_queue_char"> console_queue_char </a></li>
+
+ <li class="toctree-l3"><a href="#console_blocking_tx"> console_blocking_tx </a></li>
+
+ <li class="toctree-l3"><a href="#console_blocking_mode"> console_blocking_mode </a></li>
+
+ <li class="toctree-l3"><a href="#console_write"> console_write </a></li>
+
+ <li class="toctree-l3"><a href="#console_read"> console_read </a></li>
+
+ <li class="toctree-l3"><a href="#console_tx_char"> console_tx_char </a></li>
+
+ <li class="toctree-l3"><a href="#console_rx_char"> console_rx_char </a></li>
+
+ <li class="toctree-l3"><a href="#console_init"> console_init </a></li>
+
+
- <li class="toctree-l3"><a href="../shell/">Shell</a></li>
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
- <li class="toctree-l3"><a href="../bootloader/">Bootloader</a></li>
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
- <li class="toctree-l3"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
- <li class="toctree-l3"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
</ul>
@@ -201,27 +237,29 @@
<li>stub - containing stubs for the API</li>
</ul>
<p>If an egg or project requires the full console capability it lists that dependency in its egg.yml file. For example, the shell egg is defined by the following egg.yml file:</p>
-<pre><code>egg.name: libs/shell
-egg.vers: 0.1
-egg.deps:
- - libs/console/full
- - libs/os
-egg.identities:
- - SHELL
+<pre><code class="no-highlight"> egg.name: libs/shell
+ egg.vers: 0.1
+ egg.deps:
+ - libs/console/full
+ - libs/os
+ egg.identities:
+ - SHELL
</code></pre>
+
<p>On the other hand, a project may not have a physical console (e.g. a UART port to connect a terminal to) but may have a dependency on an egg that has console capability. In that case you would use a console stub. Another example would be the bootloader project where we want to keep the size of the image small. It includes the <code>libs/os</code> egg that can print out messages on a console (e.g. if there is a hard fault) and the <code>libs/util</code> egg that uses full console (but only if SHELL is present to provide a CLI). However, we do not want to use any console I/O capability in this particular bootloader project to keep the size small. We simply use the console stub instead and the egg.yml file for the project boot egg looks like the following:</p>
-<pre><code>project.name: boot
-project.identities: bootloader
-project.eggs:
- - libs/os
- - libs/bootutil
- - libs/nffs
- - libs/console/stub
- - libs/util
+<pre><code class="no-highlight"> project.name: boot
+ project.identities: bootloader
+ project.eggs:
+ - libs/os
+ - libs/bootutil
+ - libs/nffs
+ - libs/console/stub
+ - libs/util
</code></pre>
+
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Console interaction is intrinsically composed of two unidirectional systems. The console implementation uses two ring buffers containing input (receive) and output (transmit) characters, respectively. Read and write operations on the console_ring structure are managed by labeling the read location indicator the <code>cr_tail</code> and the write location indicator the <code>cr_head</code>. The console ring length is variable and is specified as the <code>cr_size</code> member of the data structure. <code>cr_buf</code> is the pointer to the actual array of data contained.</p>
-<pre><code>struct console_ring {
+<pre><code class="no-highlight">struct console_ring {
32 uint8_t cr_head;
33 uint8_t cr_tail;
34 uint8_t cr_size;
@@ -230,7 +268,7 @@ project.eggs:
37 }
</code></pre>
-<pre><code>struct console_tty {
+<pre><code class="no-highlight">struct console_tty {
40 struct console_ring ct_tx;
41 uint8_t ct_tx_buf[CONSOLE_TX_BUF_SZ]; /* must be after console_ring */
42 struct console_ring ct_rx;
@@ -243,23 +281,23 @@ project.eggs:
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
<p>The functions available in console are:</p>
<ul>
-<li><a href="#function-console_printf">console_printf</a></li>
-<li><a href="#function-console_add_char">console_add_char</a></li>
-<li><a href="#function-console_pull_char">console_pull_char</a></li>
-<li><a href="#function-console_pull_char_head">console_pull_char_head</a></li>
-<li><a href="#function-console_queue_char">console_queue_char</a></li>
-<li><a href="#function-console_blocking_tx">console_blocking_tx</a></li>
-<li><a href="#function-console_blocking_mode">console_blocking_mode</a></li>
-<li><a href="#function-console_write">console_write</a></li>
-<li><a href="#function-console_read">console_read</a></li>
-<li><a href="#function-console_tx_char">console_tx_char</a></li>
-<li><a href="#function-console_rx_char">console_rx_char</a></li>
-<li><a href="#function-console_init">console_init</a></li>
+<li><a href="#console_printf">console_printf</a></li>
+<li><a href="#console_add_char">console_add_char</a></li>
+<li><a href="#console_pull_char">console_pull_char</a></li>
+<li><a href="#console_pull_char_head">console_pull_char_head</a></li>
+<li><a href="#console_queue_char">console_queue_char</a></li>
+<li><a href="#console_blocking_tx">console_blocking_tx</a></li>
+<li><a href="#console_blocking_mode">console_blocking_mode</a></li>
+<li><a href="#console_write">console_write</a></li>
+<li><a href="#console_read">console_read</a></li>
+<li><a href="#console_tx_char">console_tx_char</a></li>
+<li><a href="#console_rx_char">console_rx_char</a></li>
+<li><a href="#console_init">console_init</a></li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-console_printf"><font color="2980b9">function console_printf</font><a class="headerlink" href="#function-console_printf" title="Permanent link">¶</a></h3>
-<pre><code> void
+<h2 id="console_printf"><font color="F2853F" style="font-size:24pt"> console_printf</font><a class="headerlink" href="#console_printf" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> void
console_printf(const char *fmt, ...)
</code></pre>
@@ -289,7 +327,7 @@ project.eggs:
<p>While <code>console_printf</code>, with its well understood formatting options in C, is more convenient and easy on the eyes than the raw output of <code>console_write</code>, the associated code size is considerably larger.</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p>Example #1:</p>
-<pre><code>char adv_data_buf[32];
+<pre><code class="no-highlight">char adv_data_buf[32];
void
task()
@@ -301,7 +339,7 @@ task()
</code></pre>
<p>Example #2:</p>
-<pre><code>struct exception_frame {
+<pre><code class="no-highlight">struct exception_frame {
uint32_t r0;
uint32_t r1;
@@ -320,8 +358,8 @@ task(struct trap_frame *tf)
</code></pre>
<hr />
-<h3 id="function-console_add_char"><font color="#2980b9"> function console_add_char</font><a class="headerlink" href="#function-console_add_char" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="console_add_char"><font color="#F2853F" style="font-size:24pt"> console_add_char</font><a class="headerlink" href="#console_add_char" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
console_add_char(struct console_ring *cr, char ch)
</code></pre>
@@ -353,7 +391,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_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p>Add a new line character to the output (transmit) buffer.</p>
-<pre><code>void
+<pre><code class="no-highlight">void
task()
{
struct console_ring *tx = &ct->ct_tx;
@@ -363,8 +401,8 @@ task()
</code></pre>
<hr />
-<h3 id="function-console_pull_char"><font color="#2980b9"> function console_pull_char </font><a class="headerlink" href="#function-console_pull_char" title="Permanent link">¶</a></h3>
-<pre><code> static uint8_t
+<h2 id="console_pull_char"><font color="#F2853F" style="font-size:24pt"> console_pull_char </font><a class="headerlink" href="#console_pull_char" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static uint8_t
console_pull_char(struct console_ring *cr)
</code></pre>
@@ -392,7 +430,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>Read the characters in the ring buffer into a string.</p>
-<pre><code>void
+<pre><code class="no-highlight">void
task(struct console_ring *cr, char *str, int cnt)
{
for (i = 0; i < cnt; i++) {
@@ -407,8 +445,8 @@ task(struct console_ring *cr, char *str, int cnt)
</code></pre>
<hr />
-<h3 id="function-console_pull_char_head"><font color="#2980b9"> function console_pull_char_head </font><a class="headerlink" href="#function-console_pull_char_head" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="console_pull_char_head"><font color="#F2853F" style="font-size:24pt"> console_pull_char_head </font><a class="headerlink" href="#console_pull_char_head" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
console_pull_char_head(struct console_ring *cr)
</code></pre>
@@ -443,7 +481,7 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
<li>remove the previous character from incoming RX queue</li>
</ul>
<p>The example below shows console_pull_char_head being used for the last step.</p>
-<pre><code>void
+<pre><code class="no-highlight">void
task(uint8_t data)
{
struct console_tty *ct = (struct console_tty *)arg;
@@ -463,8 +501,8 @@ task(uint8_t data)
</code></pre>
<hr />
-<h3 id="function-console_queue_char"><font color="#2980b9"> function console_queue_char </font><a class="headerlink" href="#function-console_queue_char" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="console_queue_char"><font color="#F2853F" style="font-size:24pt"> console_queue_char </font><a class="headerlink" href="#console_queue_char" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
console_queue_char(char ch)
</code></pre>
@@ -490,12 +528,12 @@ Error codes?</p>
<h4 id="notes_4">Notes<a class="headerlink" href="#notes_4" title="Permanent link">¶</a></h4>
<p>This function makes sure no interrupts are allowed while the transmit buffer is draining and the character is being added.</p>
<h4 id="example_4">Example<a class="headerlink" href="#example_4" title="Permanent link">¶</a></h4>
-<pre><code>Insert example
+<pre><code class="no-highlight">Insert example
</code></pre>
<hr />
-<h3 id="function-console_blocking_tx"><font color="#2980b9"> function console_blocking_tx </font><a class="headerlink" href="#function-console_blocking_tx" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="console_blocking_tx"><font color="#F2853F" style="font-size:24pt"> console_blocking_tx </font><a class="headerlink" href="#console_blocking_tx" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
console_blocking_tx(char ch)
</code></pre>
@@ -524,7 +562,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_5">Example<a class="headerlink" href="#example_5" title="Permanent link">¶</a></h4>
<p>Here is an example of a console output queue being flushed.</p>
-<pre><code>void
+<pre><code class="no-highlight">void
task(void)
{
struct console_tty *ct = &console_tty;
@@ -538,8 +576,8 @@ task(void)
</code></pre>
<hr />
-<h3 id="function-console_blocking_mode"><font color="#2980b9"> function console_blocking_mode </font><a class="headerlink" href="#function-console_blocking_mode" title="Permanent link">¶</a></h3>
-<pre><code> void
+<h2 id="console_blocking_mode"><font color="#F2853F" style="font-size:24pt"> console_blocking_mode </font><a class="headerlink" href="#console_blocking_mode" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> void
console_blocking_mode(void)
</code></pre>
@@ -566,7 +604,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_6">Example<a class="headerlink" href="#example_6" title="Permanent link">¶</a></h4>
<p>Here is an example of calling <code>console_blocking_mode</code> and printing crash information from an assert to help debug.</p>
-<pre><code>void
+<pre><code class="no-highlight">void
_assert_func(const char *file, int line, const char *func, const char *e)
{
int sr;
@@ -582,8 +620,8 @@ _assert_func(const char *file, int line, const char *func, const char *e)
</code></pre>
<hr />
-<h3 id="function-console_write"><font color="#2980b9">function console_write </font><a class="headerlink" href="#function-console_write" title="Permanent link">¶</a></h3>
-<pre><code> void
+<h2 id="console_write"><font color="#F2853F" style="font-size:24pt"> console_write </font><a class="headerlink" href="#console_write" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> void
console_write(char *str, int cnt)
</code></pre>
@@ -616,7 +654,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_7">Example<a class="headerlink" href="#example_7" title="Permanent link">¶</a></h4>
<p>Here is an example of the function being used in an echo command with a newline at the end.</p>
-<pre><code>static int
+<pre><code class="no-highlight">static int
shell_echo_cmd(int argc, char **argv)
{
int i;
@@ -632,8 +670,8 @@ shell_echo_cmd(int argc, char **argv)
</code></pre>
<hr />
-<h3 id="function-console_read"><font color="#2980b9"> function console_read </font><a class="headerlink" href="#function-console_read" title="Permanent link">¶</a></h3>
-<pre><code> int
+<h2 id="console_read"><font color="#F2853F" style="font-size:24pt"> console_read </font><a class="headerlink" href="#console_read" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> int
console_read(char *str, int cnt)
</code></pre>
@@ -667,8 +705,8 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_8">Example<a class="headerlink" href="#example_8" title="Permanent link">¶</a></h4>
<p>Give at least one example of usage.</p>
<hr />
-<h3 id="function-console_tx_char"><font color="#2980b9"> function console_tx_char </font><a class="headerlink" href="#function-console_tx_char" title="Permanent link">¶</a></h3>
-<pre><code> static int
+<h2 id="console_tx_char"><font color="#F2853F" style="font-size:24pt"> console_tx_char </font><a class="headerlink" href="#console_tx_char" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static int
console_tx_char(void *arg)
</code></pre>
@@ -701,8 +739,8 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_9">Example<a class="headerlink" href="#example_9" title="Permanent link">¶</a></h4>
<p>Give at least one example of usage.</p>
<hr />
-<h3 id="function-console_rx_char"><font color="#2980b9"> function console_rx_char </font><a class="headerlink" href="#function-console_rx_char" title="Permanent link">¶</a></h3>
-<pre><code> static int
+<h2 id="console_rx_char"><font color="#F2853F" style="font-size:24pt"> console_rx_char </font><a class="headerlink" href="#console_rx_char" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static int
console_rx_char(void *arg, uint8_t data)
</code></pre>
@@ -735,8 +773,8 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_10">Example<a class="headerlink" href="#example_10" title="Permanent link">¶</a></h4>
<p>Give at least one example of usage.</p>
<hr />
-<h3 id="function-console_init"><font color="#2980b9"> function console_init </font><a class="headerlink" href="#function-console_init" title="Permanent link">¶</a></h3>
-<pre><code> int
+<h2 id="console_init"><font color="#F2853F" style="font-size:24pt"> console_init </font><a class="headerlink" href="#console_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> int
console_init(console_rx_cb rx_cb)
</code></pre>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/modules/filesystem/index.html
----------------------------------------------------------------------
diff --git a/modules/filesystem/index.html b/modules/filesystem/index.html
index f3dac9c..3d9609f 100644
--- a/modules/filesystem/index.html
+++ b/modules/filesystem/index.html
@@ -141,19 +141,37 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../console/">Console</a></li>
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
- <li class="toctree-l3"><a href="../shell/">Shell</a></li>
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
- <li class="toctree-l3"><a href="../bootloader/">Bootloader</a></li>
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
- <li class="toctree-l3"><a href="./">File System</a></li>
+ <li class="toctree-l2"><a href="./">File System</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="#nffs_lock"> nffs_lock </a></li>
+
+ <li class="toctree-l3"><a href="#nffs_unlock"> nffs_unlock </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
</ul>
@@ -198,17 +216,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-nffs_lock">nffs_lock</a></li>
-<li><a href="#function-nffs_unlock">nffs_unlock</a></li>
+<li><a href="#nffs_lock">nffs_lock</a></li>
+<li><a href="#nffs_unlock">nffs_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-nffs_lock"><font color="2980b9">function nffs_lock </font><a class="headerlink" href="#function-nffs_lock" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="nffs_lock"><font color="F2853F" style="font-size:24pt"> nffs_lock </font><a class="headerlink" href="#nffs_lock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
nffs_lock(void)
</code></pre>
@@ -242,14 +260,14 @@ 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>
+<pre><code class="no-highlight">
<Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-nffs_unlock"><font color="#2980b9"> function nffs_unlock </font><a class="headerlink" href="#function-nffs_unlock" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
+<h2 id="nffs_unlock"><font color="#F2853F" style="font-size:24pt"> nffs_unlock </font><a class="headerlink" href="#nffs_unlock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
@@ -282,15 +300,14 @@ 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>
+<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>
@@ -322,9 +339,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/modules/shell/index.html
----------------------------------------------------------------------
diff --git a/modules/shell/index.html b/modules/shell/index.html
index 2c5dd87..179e269 100644
--- a/modules/shell/index.html
+++ b/modules/shell/index.html
@@ -141,19 +141,37 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../console/">Console</a></li>
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
- <li class="toctree-l3"><a href="./">Shell</a></li>
+ <li class="toctree-l2"><a href="./">Shell</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="#shell_cmd_list_lock"> shell_cmd_list_lock </a></li>
+
+ <li class="toctree-l3"><a href="#shell_cmd_list_unlock"> shell_cmd_list_unlock </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../bootloader/">Bootloader</a></li>
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
- <li class="toctree-l3"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
- <li class="toctree-l3"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
</ul>
@@ -196,7 +214,7 @@
<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
<p>A few commands to the console interface are currently available in the shell - <code>tasks</code>, <code>log</code>, and <code>stat stat</code>. A $ prompt sign will be coming soon!</p>
<p>Create a sim target to check out these commands available in shell.</p>
-<pre><code>user@~/dev/larva$ newt target create blinky_sim
+<pre><code class="no-highlight">user@~/dev/larva$ newt target create blinky_sim
Creating target blinky_sim
Target blinky_sim successfully created!
user@~/dev/larva$ newt target set blinky_sim name=blinky_sim
@@ -238,7 +256,7 @@ uart0 at /dev/ttys005
</code></pre>
<p>Open up a new terminal to run minicom, a text-based serial port control and terminal emulation program. Set device name to the serial port of the target. </p>
-<pre><code>user@~$ minicom -D /dev/ttys005
+<pre><code class="no-highlight">user@~$ minicom -D /dev/ttys005
Welcome to minicom 2.7
OPTIONS:
@@ -268,17 +286,17 @@ stat stat
<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-shell_cmd_list_lock">shell_cmd_list_lock</a></li>
-<li><a href="#function-shell_cmd_list_unlock">shell_cmd_list_unlock</a></li>
+<li><a href="#shell_cmd_list_lock">shell_cmd_list_lock</a></li>
+<li><a href="#shell_cmd_list_unlock">shell_cmd_list_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-shell_cmd_list_lock"><font color="2980b9">function shell_cmd_list_lock </font><a class="headerlink" href="#function-shell_cmd_list_lock" title="Permanent link">¶</a></h3>
-<pre><code> static int
+<h2 id="shell_cmd_list_lock"><font color="F2853F" style="font-size:24pt"> shell_cmd_list_lock </font><a class="headerlink" href="#shell_cmd_list_lock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static int
shell_cmd_list_lock(void)
</code></pre>
@@ -311,15 +329,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-shell_cmd_list_unlock"><font color="#2980b9"> function shell_cmd_list_unlock </font><a class="headerlink" href="#function-shell_cmd_list_unlock" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="shell_cmd_list_unlock"><font color="#F2853F" style="font-size:24pt"> shell_cmd_list_unlock </font><a class="headerlink" href="#shell_cmd_list_unlock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -351,15 +366,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>
@@ -391,9 +403,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/modules/testutil/index.html
----------------------------------------------------------------------
diff --git a/modules/testutil/index.html b/modules/testutil/index.html
index 13ae6e2..7c8884a 100644
--- a/modules/testutil/index.html
+++ b/modules/testutil/index.html
@@ -141,19 +141,37 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../console/">Console</a></li>
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
- <li class="toctree-l3"><a href="../shell/">Shell</a></li>
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
- <li class="toctree-l3"><a href="../bootloader/">Bootloader</a></li>
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
- <li class="toctree-l3"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
- <li class="toctree-l3"><a href="./">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="./">Test Utilities</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="#tu_init"> tu_init </a></li>
+
+ <li class="toctree-l3"><a href="#tu_restart"> tu_restart </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
</ul>
@@ -198,19 +216,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-tu_init">tu_init</a></li>
-<li><a href="#function-tu_restart">tu_restart</a></li>
+<li><a href="#tu_init">tu_init</a></li>
+<li><a href="#tu_restart">tu_restart</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-tu_init"><font color="2980b9">function tu_init </font><a class="headerlink" href="#function-tu_init" title="Permanent link">¶</a></h3>
-<pre><code> int
+<h2 id="tu_init"><font color="F2853F" style="font-size:24pt"> tu_init </font><a class="headerlink" href="#tu_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> int
tu_init(void)
-
</code></pre>
<p><Insert short description></p>
@@ -242,15 +259,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-tu_restart"><font color="#2980b9"> function tu_restart </font><a class="headerlink" href="#function-tu_restart" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="tu_restart"><font color="#F2853F" style="font-size:24pt"> tu_restart </font><a class="headerlink" href="#tu_restart" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -282,15 +296,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>
@@ -322,9 +333,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/newt/newt_ops/index.html
----------------------------------------------------------------------
diff --git a/newt/newt_ops/index.html b/newt/newt_ops/index.html
index 3ec0a33..c73acaa 100644
--- a/newt/newt_ops/index.html
+++ b/newt/newt_ops/index.html
@@ -131,10 +131,14 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="./">Command structure</a></li>
+ <li class="toctree-l2"><a href="./">Command structure</a></li>
+
+
+
+
- <li class="toctree-l3"><a href="../newt_tool_reference/">Command list</a></li>
+ <li class="toctree-l2"><a href="../newt_tool_reference/">Command list</a></li>
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/newt/newt_tool_reference/index.html
----------------------------------------------------------------------
diff --git a/newt/newt_tool_reference/index.html b/newt/newt_tool_reference/index.html
index 35397aa..54be997 100644
--- a/newt/newt_tool_reference/index.html
+++ b/newt/newt_tool_reference/index.html
@@ -131,10 +131,26 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../newt_ops/">Command structure</a></li>
+ <li class="toctree-l2"><a href="../newt_ops/">Command structure</a></li>
- <li class="toctree-l3"><a href="./">Command list</a></li>
+ <li class="toctree-l2"><a href="./">Command list</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#available-high-level-commands">Available high-level commands</a></li>
+
+ <li class="toctree-l3"><a href="#version">version</a></li>
+
+ <li class="toctree-l3"><a href="#help">help</a></li>
+
+ <li class="toctree-l3"><a href="#nest">nest</a></li>
+
+ <li class="toctree-l3"><a href="#egg">egg</a></li>
+
+ <li class="toctree-l3"><a href="#target">target</a></li>
+
+
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/callout/index.html
----------------------------------------------------------------------
diff --git a/os/callout/index.html b/os/callout/index.html
index 7027e4e..81dc440 100644
--- a/os/callout/index.html
+++ b/os/callout/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/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="./">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="./">Callout Functions</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_callout_init">os_callout_init </a></li>
+
+ <li class="toctree-l3"><a href="#os_callout_func_init"> os_callout_func_init </a></li>
+
+ <li class="toctree-l3"><a href="#next_one">next_one </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>
@@ -221,19 +239,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_callout_init">os_callout_init</a></li>
-<li><a href="#function-os_callout_func_init">os_callout_func_init</a></li>
+<li><a href="#os_callout_init">os_callout_init</a></li>
+<li><a href="#os_callout_func_init">os_callout_func_init</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_callout_init"><font color="2980b9">function os_callout_init</font><a class="headerlink" href="#function-os_callout_init" title="Permanent link">¶</a></h3>
-<pre><code> void
- os_callout_init(struct os_callout *c, struct os_eventq *evq, void *ev_arg)
-
+<h2 id="os_callout_init"><font color="#F2853F" style="font-size:24pt">os_callout_init </font><a class="headerlink" href="#os_callout_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">void
+os_callout_init(struct os_callout *c, struct os_eventq *evq, void *ev_arg)
</code></pre>
<p><Insert short description></p>
@@ -265,15 +282,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_callout_func_init"><font color="#2980b9"> function os_callout_func_init</font><a class="headerlink" href="#function-os_callout_func_init" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_callout_func_init"><font color="#F2853F" style="font-size:24pt"> os_callout_func_init </font><a class="headerlink" href="#os_callout_func_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -305,15 +319,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 +356,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/context_switch/index.html
----------------------------------------------------------------------
diff --git a/os/context_switch/index.html b/os/context_switch/index.html
index f5150bd..0e92916 100644
--- a/os/context_switch/index.html
+++ b/os/context_switch/index.html
@@ -136,43 +136,55 @@
<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="./">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="./">Scheduler/Context Switching</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="../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>
@@ -222,17 +234,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 the scheduler are:</p>
<ul>
-<li><a href="#function-os_sched_insert">os_sched_insert</a></li>
-<li><a href="#function-os_sched_walk">os_sched_walk</a></li>
+<li><a href="#os_sched_insert">os_sched_insert</a></li>
+<li><a href="#os_sched_walk">os_sched_walk</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_sched_insert"><font color="2980b9">function os_sched_insert</font><a class="headerlink" href="#function-os_sched_insert" title="Permanent link">¶</a></h3>
-<pre><code> os_error_t
+<h3 id="os_sched_insert"><font color="#F2853F" style="font-size:24pt"> os_sched_insert</font><a class="headerlink" href="#os_sched_insert" title="Permanent link">¶</a></h3>
+<pre><code class="no-highlight"> os_error_t
os_sched_insert(struct os_task *t)
</code></pre>
@@ -265,15 +277,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_sched_walk"><font color="#2980b9"> function os_sched_walk</font><a class="headerlink" href="#function-os_sched_walk" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h3 id="os_sched_walk"><font color="#F2853F" style="font-size:24pt"> os_sched_walk</font><a class="headerlink" href="#os_sched_walk" title="Permanent link">¶</a></h3>
+<pre><code class="no-highlight"><Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -305,15 +314,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 >
-
+<h3 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h3>
+<pre><code class="no-highlight"><Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -345,9 +351,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/event_queue/index.html
----------------------------------------------------------------------
diff --git a/os/event_queue/index.html b/os/event_queue/index.html
index 5236a70..2b52b26 100644
--- a/os/event_queue/index.html
+++ b/os/event_queue/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 Queues</a></li>
+ <li class="toctree-l2"><a href="./">Event Queues</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_eventq_init"> os_eventq_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_eventq_put2"> os_eventq_put2</a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </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,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_eventq_init">os_eventq_init</a></li>
-<li><a href="#function-os_eventq_put2">os_eventq_put2</a></li>
+<li><a href="#os_eventq_init">os_eventq_init</a></li>
+<li><a href="#os_eventq_put2">os_eventq_put2</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_eventq_init"><font color="2980b9">function os_eventq_init</font><a class="headerlink" href="#function-os_eventq_init" title="Permanent link">¶</a></h3>
-<pre><code> void
+<h2 id="os_eventq_init"><font color="F2853F" style="font-size:24pt"> os_eventq_init</font><a class="headerlink" href="#os_eventq_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> void
os_eventq_init(struct os_eventq *evq)
</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_eventq_put2"><font color="#2980b9"> function os_eventq_put2</font><a class="headerlink" href="#function-os_eventq_put2" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_eventq_put2"><font color="#F2853F" style="font-size:24pt"> os_eventq_put2</font><a class="headerlink" href="#os_eventq_put2" 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 />