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/15 09:36:11 UTC
[1/5] incubator-mynewt-site git commit: push Marko's documentation
and filesystem documentation
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/asf-site 1c39271e5 -> b9c5b00c4
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/callout/index.html
----------------------------------------------------------------------
diff --git a/os/callout/index.html b/os/callout/index.html
index 81dc440..e4dcf45 100644
--- a/os/callout/index.html
+++ b/os/callout/index.html
@@ -185,7 +185,11 @@
<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="#os_callout_stop"> os_callout_stop </a></li>
+
+ <li class="toctree-l3"><a href="#os_callout_reset"> os_callout_reset </a></li>
+
+ <li class="toctree-l3"><a href="#os_callout_queued">os_callout_queued</a></li>
@@ -203,7 +207,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
@@ -234,26 +243,95 @@
</div>
<h1 id="callout">Callout<a class="headerlink" href="#callout" title="Permanent link">¶</a></h1>
+<p>Callouts are MyNewt OS timers.</p>
<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
-<p>Describe OS feature here </p>
+<p>Callout is a way of setting up an OS timer. When the timer fires, it is delivered as an event to task's event queue.</p>
+<p>User would initialize their callout structure using <em>os_callout_init()</em>, or <em>os_callout_func_init()</em> and then arm it with <em>os_callout_reset()</em>.</p>
+<p>If user wants to cancel the timer before it expires, they can either use <em>os_callout_reset()</em> to arm it for later expiry, or stop it altogether by calling <em>os_callout_stop()</em>.</p>
+<p>There are 2 different options for data structure to use. First is <em>struct os_callout</em>, which is a bare-bones version. You would initialize this with <em>os_callout_init()</em>.</p>
+<p>Second option is <em>struct os_callout_func</em>. This you can use if you expect to have multiple different types of timers in your task, running concurrently. The structure contains a function pointer, and you would call that function from your task's event processing loop.</p>
+<p>Time unit when arming the timer is OS ticks. This rate of this ticker depends on the platform this is running on. You should use OS define <em>OS_TICKS_PER_SEC</em> to convert wallclock time to OS ticks.</p>
+<p>Callout timer fires out just once. For periodic timer type of operation you need to rearm it once it fires.</p>
<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>
+<pre><code class="no-highlight">struct os_callout {
+ struct os_event c_ev;
+ struct os_eventq *c_evq;
+ uint32_t c_ticks;
+ TAILQ_ENTRY(os_callout) c_next;
+};
+</code></pre>
+
+<table>
+<thead>
+<tr>
+<th>Element</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>c_ev</td>
+<td>Event structure of this callout</td>
+</tr>
+<tr>
+<td>c_evq</td>
+<td>Event queue where this callout is placed on timer expiry</td>
+</tr>
+<tr>
+<td>c_ticks</td>
+<td>OS tick amount when timer fires</td>
+</tr>
+<tr>
+<td>c_next</td>
+<td>Linkage to other unexpired callouts</td>
+</tr>
+</tbody>
+</table>
+<pre><code class="no-highlight">struct os_callout_func {
+ struct os_callout cf_c;
+ os_callout_func_t cf_func;
+ void *cf_arg;
+};
+</code></pre>
+
+<table>
+<thead>
+<tr>
+<th>Element</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>cf_c</td>
+<td>struct os_callout. See above</td>
+</tr>
+<tr>
+<td>cf_func</td>
+<td>Function pointer which should be called by event queue processing</td>
+</tr>
+<tr>
+<td>cf_arg</td>
+<td>Generic void * argument to that function</td>
+</tr>
+</tbody>
+</table>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<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="#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>
+<li><a href="#os_callout_stop">os_callout_stop</a></li>
+<li><a href="#os_callout_reset">os_callout_reset</a></li>
+<li><a href="#os_callout_queued">os_callout_queued</a></li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
<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)
+<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>
+<p>Initializes <em>struct os_callout</em>. Event type will be set to <em>OS_EVENT_T_TIMER</em>.</p>
<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
<table>
<thead>
@@ -264,33 +342,40 @@ os_callout_init(struct os_callout *c, struct os_eventq *evq, void *ev_arg)
</thead>
<tbody>
<tr>
-<td>xx</td>
-<td>explain argument xx</td>
+<td>c</td>
+<td>Pointer to os_callout to initialize</td>
</tr>
<tr>
-<td>yy</td>
-<td>explain argument yy</td>
+<td>evq</td>
+<td>Event queue where this gets delivered to</td>
+</tr>
+<tr>
+<td>ev_arg</td>
+<td>Generic argument which is filled in for the event</td>
</tr>
</tbody>
</table>
<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
-<p>List any values returned.
-Error codes?</p>
+<p>N/A</p>
<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
-<p>Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).</p>
+<p>Be careful not to call this if the callout is armed, because that will mess up the list of pending callouts.
+Or if the timer has already fired, it will mess up the event queue where the callout was delivered to.</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 class="no-highlight"><Insert the code snippet here>
+<pre><code class="no-highlight">struct os_eventq my_evq;
+struct os_callout my_callouts[8];
+
+ for (i = 0; i < 8; i++) {
+ os_callout_init(&my_callouts[i], &my_evq, (void *)i);
+ }
</code></pre>
<hr />
<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 >
+<pre><code class="no-highlight">void os_callout_func_init(struct os_callout_func *cf, struct os_eventq *evq, os_callout_func_t timo_func, void *ev_arg)
</code></pre>
-<p><Insert short description></p>
+<p>Initializes the given <em>struct os_callout_func</em>. Data structure is filled in with elements given as argument.</p>
<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4>
<table>
<thead>
@@ -301,33 +386,47 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
</thead>
<tbody>
<tr>
-<td>xx</td>
-<td>explain argument xx</td>
+<td>cf</td>
+<td>Pointer to os_callout_func being initialized</td>
+</tr>
+<tr>
+<td>evq</td>
+<td>Event queue where this gets delivered to</td>
+</tr>
+<tr>
+<td>timo_func</td>
+<td>Timeout function. Event processing should call this</td>
</tr>
<tr>
-<td>yy</td>
-<td>explain argument yy</td>
+<td>ev_arg</td>
+<td>Generic argument for the event</td>
</tr>
</tbody>
</table>
<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4>
-<p>List any values returned.
-Error codes?</p>
+<p>N/A</p>
<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
-<p>Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).</p>
+<p>The same notes as with <em>os_callout_init()</em>.</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 class="no-highlight"><Insert the code snippet here>
+<pre><code class="no-highlight">struct os_callout_func g_native_cputimer;
+struct os_eventq g_native_cputime_evq;
+void native_cputimer_cb(void *arg);
+
+ /* Initialize the callout function */
+ os_callout_func_init(&g_native_cputimer,
+ &g_native_cputime_evq,
+ native_cputimer_cb,
+ NULL);
+
</code></pre>
<hr />
-<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 >
+<h2 id="os_callout_stop"><font color="#F2853F" style="font-size:24pt"> os_callout_stop </font><a class="headerlink" href="#os_callout_stop" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">void os_callout_stop(struct os_callout *c)
</code></pre>
-<p><Insert short description></p>
+<p>Disarms a timer.</p>
<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4>
<table>
<thead>
@@ -338,24 +437,82 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
</thead>
<tbody>
<tr>
-<td>xx</td>
-<td>explain argument xx</td>
-</tr>
-<tr>
-<td>yy</td>
-<td>explain argument yy</td>
+<td>c</td>
+<td>Pointer to os_callout being stopped</td>
</tr>
</tbody>
</table>
<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4>
-<p>List any values returned.
-Error codes?</p>
+<p>N/A</p>
<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
-<p>Any special feature/special benefit that we want to tout.
-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 class="no-highlight">struct os_callout_func g_native_cputimer;
+
+ os_callout_stop(&g_native_cputimer.cf_c);
+</code></pre>
+
+<hr />
+<h2 id="os_callout_reset"><font color="#F2853F" style="font-size:24pt"> os_callout_reset </font><a class="headerlink" href="#os_callout_reset" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">void os_callout_reset(struct os_callout *c, int32_t timo)
+</code></pre>
+
+<p>Resets the callout to happen <em>timo</em> in OS ticks.</p>
+<h4 id="arguments_3">Arguments<a class="headerlink" href="#arguments_3" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>c</td>
+<td>Pointer to os_callout being reset</td>
+</tr>
+<tr>
+<td>timo</td>
+<td>OS ticks the timer is being set to</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_3">Returned values<a class="headerlink" href="#returned-values_3" title="Permanent link">¶</a></h4>
+<p>N/A</p>
+<h4 id="notes_3">Notes<a class="headerlink" href="#notes_3" title="Permanent link">¶</a></h4>
+<h4 id="example_3">Example<a class="headerlink" href="#example_3" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code class="no-highlight"> /* Re-start the timer (run every 50 msecs) */
+ os_callout_reset(&g_bletest_timer.cf_c, OS_TICKS_PER_SEC / 20);
+</code></pre>
+
+<hr />
+<h2 id="os_callout_queued"><font color="#F2853F" style="font-size:24pt">os_callout_queued</font><a class="headerlink" href="#os_callout_queued" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">int os_callout_queued(struct os_callout *c)
+</code></pre>
+
+<p>Tells whether the callout has been armed or not.</p>
+<h4 id="arguments_4">Arguments<a class="headerlink" href="#arguments_4" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>c</td>
+<td>Pointer to callout being checked</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_4">Returned values<a class="headerlink" href="#returned-values_4" title="Permanent link">¶</a></h4>
+<p>0: timer is not armed
+non-zero: timer is armed</p>
+<h4 id="notes_4">Notes<a class="headerlink" href="#notes_4" title="Permanent link">¶</a></h4>
+<h4 id="example_4">Example<a class="headerlink" href="#example_4" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/context_switch/index.html
----------------------------------------------------------------------
diff --git a/os/context_switch/index.html b/os/context_switch/index.html
index 0e92916..83de92f 100644
--- a/os/context_switch/index.html
+++ b/os/context_switch/index.html
@@ -197,7 +197,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/event_queue/index.html
----------------------------------------------------------------------
diff --git a/os/event_queue/index.html b/os/event_queue/index.html
index e035877..4651b2e 100644
--- a/os/event_queue/index.html
+++ b/os/event_queue/index.html
@@ -207,7 +207,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
@@ -348,7 +353,7 @@ Processing task would then act according to event type.</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>
This initializes event queue used by newtmgr task.</p>
-<pre><code class="c">struct os_eventq g_nmgr_evq;
+<pre><code class="no-highlight">struct os_eventq g_nmgr_evq;
int
nmgr_task_init(uint8_t prio, os_stack_t *stack_ptr, uint16_t stack_len)
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/heap/index.html
----------------------------------------------------------------------
diff --git a/os/heap/index.html b/os/heap/index.html
index dae3624..441bfb3 100644
--- a/os/heap/index.html
+++ b/os/heap/index.html
@@ -172,11 +172,11 @@
<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"> os_malloc</a></li>
- <li class="toctree-l3"><a href="#os_malloc_unlock"> os_malloc_unlock</a></li>
+ <li class="toctree-l3"><a href="#os_free">os_free</a></li>
- <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+ <li class="toctree-l3"><a href="#os_realloc">os_realloc</a></li>
@@ -203,7 +203,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
@@ -234,27 +239,26 @@
</div>
<h1 id="heap">Heap<a class="headerlink" href="#heap" title="Permanent link">¶</a></h1>
-<p>Insert synopsis here</p>
+<p>API for doing dynamic memory allocation.</p>
<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
-<p>Describe OS feature here </p>
+<p>This provides malloc()/free() functionality with locking. The shared resource heap needs to be protected from concurrent access when OS has been started. <em>os_malloc()</em> function grabs a mutex before calling <em>malloc()</em>.</p>
<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>
+<p>N/A</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
<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="#os_malloc_lock">os_malloc_lock</a></li>
-<li><a href="#os_malloc_unlock">os_malloc_unlock</a></li>
-<li>add the rest</li>
+<li><a href="#os_malloc">os_malloc</a></li>
+<li><a href="#os_free">os_free</a></li>
+<li><a href="#os_realloc">os_realloc</a></li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<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)
+<h2 id="os_malloc"><font color="F2853F" style="font-size:24pt"> os_malloc</font><a class="headerlink" href="#os_malloc" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">void *os_malloc(size_t size)
</code></pre>
-<p><Insert short description></p>
+<p>Allocates <em>size</em> number of bytes from heap and returns a pointer to it.</p>
<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
<table>
<thead>
@@ -265,33 +269,33 @@
</thead>
<tbody>
<tr>
-<td>xx</td>
-<td>explain argument xx</td>
-</tr>
-<tr>
-<td>yy</td>
-<td>explain argument yy</td>
+<td>size</td>
+<td>Number of bytes to allocate</td>
</tr>
</tbody>
</table>
<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
-<p>List any values returned.
-Error codes?</p>
+<p><ptr>: pointer to memory allocated from heap.
+NULL: not enough memory available.</p>
<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
-<p>Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).</p>
+<p><em>os_malloc()</em> calls <em>malloc()</em>, which is provided by C-library. The heap must be set up during platform initialization.
+Depending on which C-library you use, you might have to do the heap setup differently. Most often <em>malloc()</em> implementation will maintain a list of allocated and then freed memory blocks. If user asks for memory which cannot be satisfied from free list, they'll call platform's <em>sbrk()</em>, which then tries to grow the heap.</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 class="no-highlight"><Insert the code snippet here>
+<pre><code class="no-highlight"> info = (struct os_task_info *) os_malloc(
+ sizeof(struct os_task_info) * tcount);
+ if (!info) {
+ rc = -1;
+ goto err;
+ }
</code></pre>
<hr />
-<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 >
+<h2 id="os_free"><font color="F2853F" style="font-size:24pt">os_free</font><a class="headerlink" href="#os_free" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">void os_free(void *mem)
</code></pre>
-<p><Insert short description></p>
+<p>Frees previously allocated memory back to the heap.</p>
<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4>
<table>
<thead>
@@ -302,33 +306,27 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
</thead>
<tbody>
<tr>
-<td>xx</td>
-<td>explain argument xx</td>
-</tr>
-<tr>
-<td>yy</td>
-<td>explain argument yy</td>
+<td>mem</td>
+<td>Pointer to memory being released</td>
</tr>
</tbody>
</table>
<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4>
-<p>List any values returned.
-Error codes?</p>
+<p>N/A</p>
<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
-<p>Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).</p>
+<p>Calls C-library <em>free()</em> behind the covers.</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 class="no-highlight"><Insert the code snippet here>
+<pre><code class="no-highlight"> os_free(info);
</code></pre>
<hr />
-<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 >
+<h2 id="os_realloc"><font color="F2853F" style="font-size:24pt">os_realloc</font><a class="headerlink" href="#os_realloc" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">void *os_realloc(void *ptr, size_t size)
</code></pre>
-<p><Insert short description></p>
+<p>Tries to resize previously allocated memory block, and returns pointer to resized memory.
+ptr can be NULL, in which case the call is similar to calling <em>os_malloc()</em>.</p>
<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4>
<table>
<thead>
@@ -339,22 +337,19 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
</thead>
<tbody>
<tr>
-<td>xx</td>
-<td>explain argument xx</td>
+<td>ptr</td>
+<td>Pointer to previously allocated memory</td>
</tr>
<tr>
-<td>yy</td>
-<td>explain argument yy</td>
+<td>size</td>
+<td>New size to adjust the memory block to</td>
</tr>
</tbody>
</table>
<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4>
-<p>List any values returned.
-Error codes?</p>
+<p>NULL: size adjustment was not successful. <br>
+ptr: pointer to new start of memory block</p>
<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
-<p>Any special feature/special benefit that we want to tout.
-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 class="no-highlight"><Insert the code snippet here>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/mbufs/index.html
----------------------------------------------------------------------
diff --git a/os/mbufs/index.html b/os/mbufs/index.html
index 7bdcf1d..f0e099e 100644
--- a/os/mbufs/index.html
+++ b/os/mbufs/index.html
@@ -203,7 +203,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/memory_pool/index.html
----------------------------------------------------------------------
diff --git a/os/memory_pool/index.html b/os/memory_pool/index.html
index b4a3ec6..7999a8c 100644
--- a/os/memory_pool/index.html
+++ b/os/memory_pool/index.html
@@ -173,7 +173,9 @@
<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="#os_memblock_put">os_memblock_put</a></li>
+
+ <li class="toctree-l3"><a href="#os_mempool_bytes">OS_MEMPOOL_BYTES</a></li>
@@ -203,7 +205,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
@@ -234,28 +241,65 @@
</div>
<h1 id="memory-pools">Memory Pools<a class="headerlink" href="#memory-pools" title="Permanent link">¶</a></h1>
-<p>Insert synopsis here</p>
+<p>Memory can be pre-allocated to a pool of fixed size elements.</p>
<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
-<p>Describe OS feature here </p>
+<p>Sometimes it's useful to have several memory blocks of same size preallocated for specific use. E.g. you want to limit the amount of memory used for it, or you want to make sure that there is memory available when you ask for it.</p>
+<p>This can be done using a memory pool. You allocate memory either statically or from heap, and then designate that memory to be used as storage for fixed size elements.</p>
+<p>Pool will be initialized by calling <em>os_mempool_init()</em>. Element can be allocated from it with <em>os_mempool_get()</em>, and released back with <em>os_mempool_put()</em>.</p>
<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>
+<pre><code class="no-highlight">struct os_mempool {
+ int mp_block_size;
+ int mp_num_blocks;
+ int mp_num_free;
+ SLIST_HEAD(,os_memblock);
+ char *name;
+};
+</code></pre>
+
+<table>
+<thead>
+<tr>
+<th>Element</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>mp_block_size</td>
+<td>Size of the memory blocks, in bytes</td>
+</tr>
+<tr>
+<td>mp_num_blocks</td>
+<td>Number of memory blocks in the pool</td>
+</tr>
+<tr>
+<td>mp_num_free</td>
+<td>Number of free blocks left</td>
+</tr>
+<tr>
+<td>name</td>
+<td>Name for the memory block</td>
+</tr>
+</tbody>
+</table>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
<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="#os_mempool_init">os_mempool_init</a></li>
<li><a href="#os_memblock_get">os_memblock_get</a></li>
-<li>add the rest</li>
+<li><a href="#os_memblock_put">os_memblock_put</a></li>
+<li><a href="#OS_MEMPOOL_BYTES">OS_MEMPOOL_BYTES</a></li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
<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)
+<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>
+<p>Initializes the memory pool. Memory pointed by <em>membuf</em> is taken and <em>blocks</em> number of elements of size <em>block_size</em> are added to the pool. <em>name</em> is optional, and names the memory pool.</p>
+<p>It is assumed that the amount of memory pointed by <em>membuf</em> has at least <em>OS_MEMPOOL_BYTES(blocks, block_size)</em> number of bytes.</p>
+<p><em>name</em> is not copied, so caller should make sure that the memory does not get reused.</p>
<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
<table>
<thead>
@@ -266,33 +310,51 @@
</thead>
<tbody>
<tr>
-<td>xx</td>
-<td>explain argument xx</td>
+<td>mp</td>
+<td>Memory pool being initialized</td>
</tr>
<tr>
-<td>yy</td>
-<td>explain argument yy</td>
+<td>blocks</td>
+<td>Number of elements in the pool</td>
+</tr>
+<tr>
+<td>block_size</td>
+<td>Size of an individual element in pool</td>
+</tr>
+<tr>
+<td>membuf</td>
+<td>Backing store for the memory pool elements</td>
+</tr>
+<tr>
+<td>name</td>
+<td>Name of the memory pool</td>
</tr>
</tbody>
</table>
<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
-<p>List any values returned.
-Error codes?</p>
+<p>OS_OK: operation was successful.
+OS_INVALID_PARAM: invalid parameters. Block count or block size was negative, or membuf or mp was NULL.
+OS_MEM_NOT_ALIGNED: membuf has to be aligned to 4 byte boundary.</p>
<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
-<p>Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).</p>
+<p>Note that os_mempool_init() does not allocate backing storage. <em>membuf</em> has to be allocated by the caller.</p>
+<p>It's recommended that you use <em>OS_MEMPOOL_BYTES()</em> to figure out how much memory to allocate for the pool.</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 class="no-highlight"><Insert the code snippet here>
+<pre><code class="no-highlight"> rc = os_mempool_init(&nffs_file_pool, nffs_config.nc_num_files,
+ sizeof (struct nffs_file), nffs_file_mem,
+ "nffs_file_pool");
+ if (rc != 0) {
+ return FS_EOS;
+ }
+
</code></pre>
<hr />
<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 >
+<pre><code class="no-highlight">void *os_memblock_get(struct os_mempool *mp)
</code></pre>
-<p><Insert short description></p>
+<p>Allocate an element from the memory pool. If succesful, you'll get a pointer to allocated element. If there are no elements available, you'll get NULL as response.</p>
<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4>
<table>
<thead>
@@ -303,33 +365,32 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
</thead>
<tbody>
<tr>
-<td>xx</td>
-<td>explain argument xx</td>
-</tr>
-<tr>
-<td>yy</td>
-<td>explain argument yy</td>
+<td>mp</td>
+<td>Pool where element is getting allocated from</td>
</tr>
</tbody>
</table>
<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4>
-<p>List any values returned.
-Error codes?</p>
+<p>NULL: no elements available.
+<pointer>: pointer to allocated element.</p>
<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
-<p>Any special feature/special benefit that we want to tout.
-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 class="no-highlight"><Insert the code snippet here>
+<pre><code class="no-highlight"> struct nffs_file *file;
+
+ file = os_memblock_get(&nffs_file_pool);
+ if (file != NULL) {
+ memset(file, 0, sizeof *file);
+ }
+
</code></pre>
<hr />
-<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 >
+<h2 id="os_memblock_put"><font color="#F2853F" style="font-size:24pt">os_memblock_put</font><a class="headerlink" href="#os_memblock_put" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_memblock_put(struct os_mempool *mp, void *block_addr)
</code></pre>
-<p><Insert short description></p>
+<p>Releases previously allocated element back to the pool.</p>
<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4>
<table>
<thead>
@@ -340,25 +401,67 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
</thead>
<tbody>
<tr>
-<td>xx</td>
-<td>explain argument xx</td>
+<td>mp</td>
+<td>Pointer to memory pool where element is put</td>
</tr>
<tr>
-<td>yy</td>
-<td>explain argument yy</td>
+<td>block_addr</td>
+<td>Pointer to element getting freed</td>
</tr>
</tbody>
</table>
<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4>
-<p>List any values returned.
-Error codes?</p>
+<p>OS_OK: operation was a success:
+OS_INVALID_PARAM: If either mp or block_addr were NULL.</p>
<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
-<p>Any special feature/special benefit that we want to tout.
-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 class="no-highlight"><Insert the code snippet here>
+<pre><code class="no-highlight"> if (file != NULL) {
+ rc = os_memblock_put(&nffs_file_pool, file);
+ if (rc != 0) {
+ return FS_EOS;
+ }
+ }
+</code></pre>
+
+<hr />
+<h2 id="os_mempool_bytes"><font color="#F2853F" style="font-size:24pt">OS_MEMPOOL_BYTES</font><a class="headerlink" href="#os_mempool_bytes" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">OS_MEMPOOL_BYTES(n,blksize)
+</code></pre>
+
+<p>Calculates how many bytes of memory is used by <em>n</em> number of elements, when individual element size is <em>blksize</em> bytes.</p>
+<h4 id="arguments_3">Arguments<a class="headerlink" href="#arguments_3" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>n</td>
+<td>Number of elements</td>
+</tr>
+<tr>
+<td>blksize</td>
+<td>Size of an element is number of bytes</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_3">Returned values<a class="headerlink" href="#returned-values_3" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_3">Notes<a class="headerlink" href="#notes_3" title="Permanent link">¶</a></h4>
+<h4 id="example_3">Example<a class="headerlink" href="#example_3" title="Permanent link">¶</a></h4>
+<p>Here we allocate memory to be used as a pool.</p>
+<pre><code class="no-highlight">void *nffs_file_mem;
+
+nffs_file_mem = malloc(
+ OS_MEMPOOL_BYTES(nffs_config.nc_num_files, sizeof (struct nffs_file)));
+ if (nffs_file_mem == NULL) {
+ return FS_ENOMEM;
+ }
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/mutex/index.html
----------------------------------------------------------------------
diff --git a/os/mutex/index.html b/os/mutex/index.html
index e27273a..8dc4d18 100644
--- a/os/mutex/index.html
+++ b/os/mutex/index.html
@@ -205,7 +205,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/mynewt_os/index.html
----------------------------------------------------------------------
diff --git a/os/mynewt_os/index.html b/os/mynewt_os/index.html
index b4c0554..6ebdb39 100644
--- a/os/mynewt_os/index.html
+++ b/os/mynewt_os/index.html
@@ -207,7 +207,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/port_os/index.html
----------------------------------------------------------------------
diff --git a/os/port_os/index.html b/os/port_os/index.html
index 923ad98..68f8125 100644
--- a/os/port_os/index.html
+++ b/os/port_os/index.html
@@ -193,7 +193,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/sanity/index.html
----------------------------------------------------------------------
diff --git a/os/sanity/index.html b/os/sanity/index.html
index 53b7ed0..104be38 100644
--- a/os/sanity/index.html
+++ b/os/sanity/index.html
@@ -203,7 +203,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/semaphore/index.html
----------------------------------------------------------------------
diff --git a/os/semaphore/index.html b/os/semaphore/index.html
index 02c0a9d..8b46849 100644
--- a/os/semaphore/index.html
+++ b/os/semaphore/index.html
@@ -205,7 +205,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/task/index.html
----------------------------------------------------------------------
diff --git a/os/task/index.html b/os/task/index.html
index 53608b1..1d54111 100644
--- a/os/task/index.html
+++ b/os/task/index.html
@@ -203,7 +203,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/os/time/index.html
----------------------------------------------------------------------
diff --git a/os/time/index.html b/os/time/index.html
index 3f607c8..5ffa13b 100644
--- a/os/time/index.html
+++ b/os/time/index.html
@@ -203,7 +203,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/packaging/dist/index.html
----------------------------------------------------------------------
diff --git a/packaging/dist/index.html b/packaging/dist/index.html
index a0c6697..52882c8 100644
--- a/packaging/dist/index.html
+++ b/packaging/dist/index.html
@@ -142,7 +142,12 @@
- <li class="main"><a href="./">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="./">Chapter 7 - Packaging it</a></li>
<ul class="current-toc">
@@ -169,7 +174,7 @@
- <li>Chapter 6 - Packaging it »</li>
+ <li>Chapter 7 - Packaging it »</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/search.html
----------------------------------------------------------------------
diff --git a/search.html b/search.html
index 9f468de..e4d6ae7 100644
--- a/search.html
+++ b/search.html
@@ -142,7 +142,12 @@
- <li class="main"><a href="packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/sitemap.xml
----------------------------------------------------------------------
diff --git a/sitemap.xml b/sitemap.xml
index 8e8306f..7ef19c5 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -4,7 +4,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -12,7 +12,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/documentation/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -20,7 +20,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/download/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -28,7 +28,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/community/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -36,7 +36,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/events/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -45,25 +45,25 @@
<url>
<loc>http://mynewt.incubator.apache.org/get_started/newt_concepts/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/get_started/project1/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/get_started/how_to_edit_docs/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/get_started/try_markdown/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -73,19 +73,19 @@
<url>
<loc>http://mynewt.incubator.apache.org/get_acclimated/vocabulary/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/get_acclimated/project2/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/get_acclimated/project3/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -95,13 +95,13 @@
<url>
<loc>http://mynewt.incubator.apache.org/newt/newt_ops/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/newt/newt_tool_reference/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -111,79 +111,79 @@
<url>
<loc>http://mynewt.incubator.apache.org/os/mynewt_os/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/context_switch/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/time/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/task/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/event_queue/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/semaphore/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/mutex/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/memory_pool/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/heap/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/mbufs/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/sanity/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/callout/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/port_os/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -193,31 +193,83 @@
<url>
<loc>http://mynewt.incubator.apache.org/modules/console/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/modules/shell/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/modules/bootloader/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/modules/filesystem/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>http://mynewt.incubator.apache.org/modules/nffs/</loc>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/modules/testutil/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>http://mynewt.incubator.apache.org/modules/imgmgr/</loc>
+ <lastmod>2016-01-15</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>http://mynewt.incubator.apache.org/modules/baselibc/</loc>
+ <lastmod>2016-01-15</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>http://mynewt.incubator.apache.org/modules/elua/</loc>
+ <lastmod>2016-01-15</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>http://mynewt.incubator.apache.org/modules/json/</loc>
+ <lastmod>2016-01-15</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+
+
+
+
+ <url>
+ <loc>http://mynewt.incubator.apache.org/newtmgr/overview/</loc>
+ <lastmod>2016-01-15</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>http://mynewt.incubator.apache.org/newtmgr/protocol/</loc>
+ <lastmod>2016-01-15</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>http://mynewt.incubator.apache.org/newtmgr/project-slinky/</loc>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -227,7 +279,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/packaging/dist/</loc>
- <lastmod>2016-01-13</lastmod>
+ <lastmod>2016-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
[4/5] incubator-mynewt-site git commit: push Marko's documentation
and filesystem documentation
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/mkdocs/search_index.json
----------------------------------------------------------------------
diff --git a/mkdocs/search_index.json b/mkdocs/search_index.json
index 7009b1b..97cec19 100644
--- a/mkdocs/search_index.json
+++ b/mkdocs/search_index.json
@@ -117,22 +117,22 @@
},
{
"location": "/newt/newt_ops/",
- "text": "Command Structure\n\n\nIn the newt tool, commands represent actions and flags are modifiers for those actions. A command can have children commands which are also simply referred to as commands. One or more arguments may need to be provided to a command to execute it correctly. \n\n\nIn the example below, the \nnewt\n command has the child command \ntarget set\n. The first argument 'my_target1' is the name of the target whose attributes are being set. The second argument 'arch=cortex_m4' specifies the value to set the attribute (variable) 'arch' to, which in this case is 'cortex_m4'. \n\n\nnewt target set my_target1 arch=cortex_m4\n\n\n\nGlobal flags work on all newt commands in the same way. An example is the flag \n-v, --verbose\n to ask for a verbose output while executing a command. The help flag \n-h\n or \n--help\n is available on all commands but provides command specific output, of course. These flags may be specified in either a long or a short form. \
n\n\nA command may additionally take flags specific to it. For example, the \n-b\n flag may be used with \nnewt egg install\n to tell it which branch to install the egg from. \n\n\nnewt egg install -b \nbranchname\n \neggname\n\n\n\n\nIn addition to the newt tool \nreference\n in this documentation set, command-line help is available for each command (and child command). Simply use the flag \n-h\n or \n--help\n as shown below:\n\n\n$ newt target export --help\nExport build targets from the current nest, and print them to \nstandard output. If the -a (or -export-all) option is specified, \nthen all targets will be exported. Otherwise, \ntarget-name\n \nmust be specified, and only that target will be exported.\n\nUsage: \n newt target export [flags]\n\nExamples:\n newt target export [-a -export-all] [\ntarget-name\n]\n newt target export -a \n my_exports.txt\n newt target export my_target \n my_target_export.txt\n\nFlags:\n -a, --export-all=false: If present, export all targets\n
-h, --help=false: help for export\n\nGlobal Flags:\n -l, --loglevel=\"WARN\": Log level, defaults to WARN.\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don't output anything.\n -v, --verbose=false: Enable verbose output when executing commands.",
+ "text": "Command Structure\n\n\nIn the newt tool, commands represent actions and flags are modifiers for those actions. A command can have children commands which are also simply referred to as commands. One or more arguments may need to be provided to a command to execute it correctly. \n\n\nIn the example below, the \nnewt\n command has the child command \ntarget set\n. The first argument 'my_target1' is the name of the target whose attributes are being set. The second argument 'arch=cortex_m4' specifies the value to set the attribute (variable) 'arch' to, which in this case is 'cortex_m4'. \n\n\n newt target set my_target1 arch=cortex_m4\n\n\n\n\nGlobal flags work on all newt commands in the same way. An example is the flag \n-v, --verbose\n to ask for a verbose output while executing a command. The help flag \n-h\n or \n--help\n is available on all commands but provides command specific output, of course. These flags may be specified in either a long or a short f
orm. \n\n\nA command may additionally take flags specific to it. For example, the \n-b\n flag may be used with \nnewt egg install\n to tell it which branch to install the egg from. \n\n\n newt egg install -b \nbranchname\n \neggname\n\n\n\n\n\nIn addition to the newt tool \nreference\n in this documentation set, command-line help is available for each command (and child command). Simply use the flag \n-h\n or \n--help\n as shown below:\n\n\n $ newt target export --help\n Export build targets from the current nest, and print them to \n standard output. If the -a (or -export-all) option is specified, \n then all targets will be exported. Otherwise, \ntarget-name\n \n must be specified, and only that target will be exported.\n\n Usage: \n newt target export [flags]\n\n Examples:\n newt target export [-a -export-all] [\ntarget-name\n]\n newt target export -a \n my_exports.txt\n newt target export my_target \n my_target_export.txt\n\n Flags:
\n -a, --export-all=false: If present, export all targets\n -h, --help=false: help for export\n\n Global Flags:\n -l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don't output anything.\n -v, --verbose=false: Enable verbose output when executing commands.",
"title": "Command structure"
},
{
"location": "/newt/newt_ops/#command-structure",
- "text": "In the newt tool, commands represent actions and flags are modifiers for those actions. A command can have children commands which are also simply referred to as commands. One or more arguments may need to be provided to a command to execute it correctly. In the example below, the newt command has the child command target set . The first argument 'my_target1' is the name of the target whose attributes are being set. The second argument 'arch=cortex_m4' specifies the value to set the attribute (variable) 'arch' to, which in this case is 'cortex_m4'. newt target set my_target1 arch=cortex_m4 Global flags work on all newt commands in the same way. An example is the flag -v, --verbose to ask for a verbose output while executing a command. The help flag -h or --help is available on all commands but provides command specific output, of course. These flags may be specified in either a long or a short form. A command may additionally take flags specific
to it. For example, the -b flag may be used with newt egg install to tell it which branch to install the egg from. newt egg install -b branchname eggname In addition to the newt tool reference in this documentation set, command-line help is available for each command (and child command). Simply use the flag -h or --help as shown below: $ newt target export --help\nExport build targets from the current nest, and print them to \nstandard output. If the -a (or -export-all) option is specified, \nthen all targets will be exported. Otherwise, target-name \nmust be specified, and only that target will be exported.\n\nUsage: \n newt target export [flags]\n\nExamples:\n newt target export [-a -export-all] [ target-name ]\n newt target export -a my_exports.txt\n newt target export my_target my_target_export.txt\n\nFlags:\n -a, --export-all=false: If present, export all targets\n -h, --help=false: help for export\n\nGlobal Flags:\n -l, --loglevel=\"WARN\": Log
level, defaults to WARN.\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don't output anything.\n -v, --verbose=false: Enable verbose output when executing commands.",
+ "text": "In the newt tool, commands represent actions and flags are modifiers for those actions. A command can have children commands which are also simply referred to as commands. One or more arguments may need to be provided to a command to execute it correctly. In the example below, the newt command has the child command target set . The first argument 'my_target1' is the name of the target whose attributes are being set. The second argument 'arch=cortex_m4' specifies the value to set the attribute (variable) 'arch' to, which in this case is 'cortex_m4'. newt target set my_target1 arch=cortex_m4 Global flags work on all newt commands in the same way. An example is the flag -v, --verbose to ask for a verbose output while executing a command. The help flag -h or --help is available on all commands but provides command specific output, of course. These flags may be specified in either a long or a short form. A command may additionally take flags spec
ific to it. For example, the -b flag may be used with newt egg install to tell it which branch to install the egg from. newt egg install -b branchname eggname In addition to the newt tool reference in this documentation set, command-line help is available for each command (and child command). Simply use the flag -h or --help as shown below: $ newt target export --help\n Export build targets from the current nest, and print them to \n standard output. If the -a (or -export-all) option is specified, \n then all targets will be exported. Otherwise, target-name \n must be specified, and only that target will be exported.\n\n Usage: \n newt target export [flags]\n\n Examples:\n newt target export [-a -export-all] [ target-name ]\n newt target export -a my_exports.txt\n newt target export my_target my_target_export.txt\n\n Flags:\n -a, --export-all=false: If present, export all targets\n -h, --help=false: h
elp for export\n\n Global Flags:\n -l, --loglevel= WARN : Log level, defaults to WARN.\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don't output anything.\n -v, --verbose=false: Enable verbose output when executing commands.",
"title": "Command Structure"
},
{
"location": "/newt/newt_tool_reference/",
- "text": "Command List\n\n\nAvailable high-level commands\n\n\nversion Display the Newt version number\nhelp Help about any command\nnest Commands to manage nests \n clutches (remote egg repositories)\negg Commands to list and inspect eggs on a nest\ntarget Set and view target information\n\n\n\n\nversion\n\n\nUsage:\n\n\nnewt version [flags]\n\n\n\nFlags:\n\n\n-h, --help=false: help for version\n\n\n\nGlobal Flags:\n\n\n-h, --help=false: help for newt\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nversion\n\n\nnewt version\n\n\nDisplays the version of newt tool installed\n\n\n\n\n\n\n\n\nhelp\n\n\nUsage:\n\n\nnewt help [input1]\n\n\n\nFlags:\n\n\n\n-h, --help=false: help for newt\n-l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n-q, --quiet=false: Be quiet; only display error output.\n-s, --silent=false: Be silent; don't output anything.\n-v, --verbose=false: Enable verbose output when ex
ecuting commands.\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nhelp\n\n\nnewt help target\n\n\nDisplays the help text for the newt command 'target'\n\n\n\n\n\n\nhelp\n\n\nnewt help\n\n\nDisplays the help text for newt tool\n\n\n\n\n\n\n\n\nnest\n\n\nUsage:\n\n\nnewt nest [command][flags] input1 input2...\n\n\n\nAvailable commands: \n\n\ncreate Create a new nest\ngenerate-clutch Generate a clutch file from the eggs in the current directory\nadd-clutch Add a remote clutch, and put it in the current nest\nlist-clutches List the clutches installed in the current nest\nshow-clutch Show an individual clutch in the current nest\n\n\n\nFlags:\n\n\n-h, --help=false: help for nest\n\n\n\nGlobal Flags:\n\n\n-h, --help=false: help for newt\n-l, --loglevel=\"WARN\": Log level, defaults to WARN.\n-q, --quiet=false: Be quiet; only display error output.\n-s, --silent=false: Be silent; don't output anything.\n-v, --verbose=false:
Enable verbose output when executing commands.\n\n\n\nDescription\n\n\n\n\n\n\n\n\nSub-command\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\ncreate\n\n\nDownloads the skeleton of a nest on your local machine from the optional \ninput2\nnest url, if specified, and creates a new nest directory by the name of \ninput1\n If \ninput2\nis not specified, then a default skeleton from the \ntadpole\nnest on Mynewt is downloaded. The command lays out a generic directory structure for the nest you are going to build under it and includes some default eggs in it.\n\n\n\n\n\n\ngenerate-clutch\n\n\nTakes a snapshot of the eggs in the current local directory and combines them into a clutch by the name of \ninput1\nand with the url of \ninput2\nand generates a standard output of the clutch details that can be redirected to a \n.yml\nclutch file. Typically the clutch file name is chosen to match the clutch name which means the standard output should be directed to a clutch file named \ninput1.yml\n\n\n\n\n
\n\nadd-clutch\n\n\nDownloads the clutch of the name \ninput1\nfrom the master branch of the github repository \ninput2\ninto the current nest. A file named \ninput1.yml\nfile is added in the \n.nest/clutches\nsubdirectory inside the current local nest. The \n.nest/\ndirectory structure is created automatically if it does not exist.\n\n\n\n\n\n\nlist-clutches\n\n\nLists all the clutches present in the current nest, including clutches that may have been added from other nests on github. The output shows all the remote clutch names and the total eggshells in each of the clutches.\n\n\n\n\n\n\nshow-clutch\n\n\nShows information about the clutch that has the name given in the \ninput1\nargument. Output includes the clutch name, url, and all the constituent eggs with their version numbers.\n\n\n\n\n\n\n\n\nCommand-specific flags\n\n\n\n\n\n\n\n\nSub-command\n\n\nAvailable flags\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nadd-clutch\n\n\n-b, --branch=\"\n\"\n\n\nFetches the clutch file with nam
e \ninput1\nfrom the specified branch at \ninput1\nurl of the github repository. All subsequent egg installations will be done from that branch.\n\n\n\n\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\ncreate\n\n\nnewt nest create test_project\n\n\nCreates a new nest named \"test_project \" using the default skeleton0\n\n\n\n\n\n\ncreate\n\n\nnewt nest create mynest \n\n\nCreates a new nest named \"mynest\" using the skeleton at the \n specified\n\n\n\n\n\n\ngenerate-clutch\n\n\nnewt nest generate-clutch myclutch https://www.github.com/mynewt/larva \n myclutch.yml\n\n\nTakes a snapshot of the eggs in the current nest to form a clutch named myclutch with the url https://www.github.com/mynewt/larva. The output is written to a file named \nmyclutch.yml\nand describes the properties and contents of the clutch (name, url, eggs).\n\n\n\n\n\n\nadd-clutch\n\n\nnewt nest add-clutch larva https://www.github.com/mynewt/larva\n\n\nAdds the remote c
lutch named larva at www.github.com/mynewt/larva to the local nest.\n\n\n\n\n\n\nlist-clutches\n\n\nnewt nest list-clutches\n\n\nShows all the remote clutch description files that been downloaded into the current nest\n\n\n\n\n\n\nshow-clutch\n\n\nnewt nest show-clutch larva\n\n\nOutputs the details of the clutch named larva such as the github url where the remote sits, the constituent eggs and their versions\n\n\n\n\n\n\n\n\negg\n\n\nUsage:\n\n\nnewt egg [command][flag] input1 input2\n\n\n\nAvailable Commands: \n\n\nlist List eggs in the current nest\ncheckdeps Check egg dependencies\nhunt Search for egg from clutches\nshow Show the contents of an egg.\ninstall Install an egg\nremove Remove an egg\n\n\n\nFlags:\n\n\n-h, --help=false: help for egg\n\n\n\nGlobal Flags:\n\n\n-l, --loglevel=\"WARN\": Log level, defaults to WARN.\n-q, --quiet=false: Be quiet; only display error output.\n-s, --silent=false: Be silent; don't output anything.\n-v, --verbose=
false: Enable verbose output when executing commands.\n\n\n\nDescription\n\n\n\n\n\n\n\n\nSub-command\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nlist\n\n\nList all the eggs in the current nest. The output shows the name, version, path, and any additional attributes of each egg in the nest such as dependencies, capabilities, and linker scripts. The newt command gets the attributes of each egg from the corresponsing egg.yml description file.\n\n\n\n\n\n\ncheckdeps\n\n\nResolve all dependencies in the local nest. This command goes through all eggs currently installed, checks their dependencies, and prints any unresolved dependencies between eggs.\n\n\n\n\n\n\nhunt\n\n\nHunts for an egg, specified by \ninput1\n The local nest, along with all remote nests (clutches) are searched. All matched eggs are shown along with the clutch informaton. Installed eggs are called out as such. The command can be invoked from anywhere in the nest.\n\n\n\n\n\n\nshow\n\n\nShow the contents of the egg named \nin
put2\nfound in the clutch named \ninput1\n The clutch name is optional; if only the egg name is given as the argument it is resolved using all the clutches installed in the current nest. If the egg is present in multiple clutches it will list all of them along with the clutch information for each.\n\n\n\n\n\n\ninstall\n\n\nInstall the egg specified by \ninput2\nfrom the clutch named \ninput1\n The command downloads the egg from the github repository using the URL in the clutch description file (typically donwloaded as 'input1@\n.yml' in .nest/clutches). It also downloads all the dependencies (constituent eggs) as decribed in the egg's description file ('egg.yml') and installs all of them. The clutch name is optional. If only the egg name is given as the argument, the command looks for the egg name in all the clutches in the local nest and installs accordingly. An egg is installed by this command only if it has not already been installed.\n\n\n\n\n\n\nremove\n\n\nRemove an egg named
\ninput2\nfrom clutch \ninput1\n if clutch is specified. Otherwise only one input required - that of the name of the egg to be removed from the local nest.\n\n\n\n\n\n\n\n\nCommand-specific flags\n\n\n\n\n\n\n\n\nSub-command\n\n\nAvailable flags\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\ninstall\n\n\n-b, --branch=\"\n\"\n\n\nInstalls the eggs from the branch name or tag of the clutch specified\n\n\n\n\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nlist\n\n\nnewt egg list\n\n\nCList all of the eggs in the current nest and the details of the eggs.\n\n\n\n\n\n\ncheckdeps\n\n\nnewt egg checkdeps\n\n\nChecks all the dependencies between eggs in the nest. Lists any unresolved dependencies.\n\n\n\n\n\n\nhunt\n\n\nnewt egg hunt blinky\n\n\nHunts for the egg named 'blinky'. The command can be invoked from anywhere in the nest. Results show if the egg is installed and which clutch, if any, has the egg.\n\n\n\n\n\n\nshow\n\n\nnewt egg show larva libs
/os\n\n\nShow the contents of the egg named 'libs/os' in the clutch named larva. The contents are essentially derived from the egg's 'egg.yml' file.\n\n\n\n\n\n\ninstall\n\n\nnewt egg install hw/bsp/stm32f3discovery\n\n\nDownloads and installs the egg named \"stm32f3discovery\" (specified with its full path name inside the remote nest) along with all its dependencies from the remote nest on github. Since no clutch is specified, the URL for the remote nest in the clutch description file found in the local nest (in .nest/clutches for the project) is used.\n\n\n\n\n\n\nremove\n\n\nnewt egg remove larva blinky\n\n\nRemoves the egg named blinky only from the clutch named larva\n\n\n\n\n\n\nremove\n\n\nnewt egg remove blinky\n\n\nRemoves the egg named blinky from the local nest\n\n\n\n\n\n\n\n\ntarget\n\n\nUsage:\n\n\nUsage: \n\n\nnewt target [command] input1 [flag1] [flag2]\n\n\n\nAvailable Commands: \n\n\nset Set target configuration variable\nunset Unset target configurat
ion variable\ndelete Delete target\ncreate Create a target\nshow View target configuration variables\nbuild Build target\ntest Test target\nexport Export target\nimport Import target\ndownload Download image to target\ndebug Download image to target and start an openocd/gdb session\n\n\n\nFlags:\n\n\n-h, --help=false: help for target\n\n\n\nGlobal Flags:\n\n\n-l, --loglevel=\"WARN\": Log level, defaults to WARN.\n-q, --quiet=false: Be quiet; only display error output.\n-s, --silent=false: Be silent; don't output anything.\n-v, --verbose=false: Enable verbose output when executing commands.\n\n\n\nDescription\n\n\n\n\n\n\n\n\nSub-command\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nset\n\n\nSet attributes of the target. Currently the list of possible attributes are:\narch, compiler, compiler_def, project, bsp, egg, identities, capabilities, dependencies, cflags, lflags\n Typically only the first 5 need to be set for a hardware target. For a s
imulated target, e.g. for software testing purposes, \narch=sim\n \ncompiler=sim\n and \negg=\negg name to be tested\n You cannot set both the project and egg for a target.\n\n\n\n\n\n\nunset\n\n\nUnset attributes of the target in its configuration.\n\n\n\n\n\n\ndelete\n\n\nDeletes only the description for the target. Does not delete the target directory with associated binaries. If you want to clean out the binaries, list files, and executables use\nnewt target build \ntarget-name\n clean\nbefore\n deleting the target!\n\n\n\n\n\n\ncreate\n\n\nCreates a target description or build definition by the name \ninput1\n By default it assigns the sim (simulator) architecture to it which allows you to build new projects and software on your native OS and try it out.\n\n\n\n\n\n\nshow\n\n\nDisplay the configuration defined for the target named \ninput1\n If no \ninput1\nis specified then show the details for all the targets in the nest.\n\n\n\n\n\n\nbuild\n\n\nBuild the source code into an
image that can be loaded on the hardware associated with the target named \ninput1\nto do the application enabled by the 'project' associated with that target (via the target definition). It creates 'bin/' and 'bin/\n/' subdirectories inside the base directory for the project, compiles and generates binaries and executables, and places them in 'bin/\n/.\n\n\n\n\n\n\ntest\n\n\nTest an egg on the target named \ninput1\n The egg is either supplied as an argument to the command line invocation of \nnewt target test\nor added as part of the target definition. If only the target is specified as \ninput1\n then the egg in the target's definition is automatically chosen to be tested. You currently cannot test an entire project on a hardware target. The test command is envisioned for use if one or two eggs gets updated and each needs to be tested against a target. Alternatively, a script may be written for a series of tests on several eggs.\n\n\n\n\n\n\nexport\n\n\nExports the configurations
of the specified target \ninput1\n If -a or -export-all flag is used, then all targets are exported and printed out to standard out. You may redirect the output to a file.\n\n\n\n\n\n\nimport\n\n\nImport one or more target configuration from standard input or a file. Each target starts with \n@target=\ntarget-name\nfollowed by the attributes. The list of targets should end with \n@endtargets\n\n\n\n\n\n\nsize\n\n\nOutputs the RAM and flash consumption by the components of the specified target \ninput1\n\n\n\n\n\n\ndownload\n\n\nDownloads the binary executable \ntarget-name\n.elf.bin\nto the board.\n\n\n\n\n\n\ndebug\n\n\nDownloads the binary executable \ntarget-name\n.elf.bin\nto the board and starts up the openocd/gdb combination session. gdb takes over the terminal.\n\n\n\n\n\n\n\n\nCommand-specific flags\n\n\n\n\n\n\n\n\nSub-command\n\n\nAvailable flags\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nbuild\n\n\nclean\n\n\nAll the binaries and object files for the specified target will be
removed. The subdirectory named after the specified target within that project is removed.\n\n\n\n\n\n\nbuild clean\n\n\nall\n\n\nAll the binaries and object files for all targets are removed, and subdirectories of all targets for the project are removed. However, the entire repository is not emptied since any eggs or projects that the specified target doesn't reference are not touched.\n\n\n\n\n\n\nexport\n\n\n-a, -export-all\n\n\nExport all targets. \ninput1\nis not necessary when this flag is used.\n\n\n\n\n\n\nimport\n\n\n-a, -import-all\n\n\nImport all targets typed into standard input or redirected from a file.\n\n\n\n\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nset\n\n\nnewt target set myblinky compiler=arm-none-eabi-m4\n\n\nSet the compiler for the 'myblinky' target to the gcc compiler for embedded ARM chips.\n\n\n\n\n\n\nunset\n\n\nnewt target unset myblinky compiler\n\n\nRemove the setting for the compiler for the 'myblin
ky' target.\n\n\n\n\n\n\ndelete\n\n\nnewt target delete myblinky\n\n\nDelete the target description for the target named 'myblinky'. Note that it does not remove any binaries or clean out the directory for this target.\n\n\n\n\n\n\ncreate\n\n\nnewt target create blink_f3disc\n\n\nCreate a new target description by the name 'blink_f3disc'. The architecture is 'sim' by default and can be changed using subcommand 'set' above.\n\n\n\n\n\n\nshow\n\n\nnewt target show myblinky\n\n\nShow the target attributes set for 'myblinky'\n\n\n\n\n\n\nbuild\n\n\nnewt target build blink_f3disc\n\n\nCompile the source code for the target named blink_f3disc and generate binaries that can be loaded into the target hardware.\n\n\n\n\n\n\ntest\n\n\nnewt target test test_target egg=libs/os\n\n\nTests the egg named 'libs/os' against the target named 'test_target'\n\n\n\n\n\n\nexport\n\n\nnewt target export -a \n my_exports.txt\n\n\nExport all build targets from the current nest, and redirect output to a file
named 'my_exports.txt'.\n\n\n\n\n\n\nexport\n\n\nnewt target export -export-all\n\n\nExport all build targets from the current nest, and print them to standard output on the screen.\n\n\n\n\n\n\nexport\n\n\nnewt target export my_target\n\n\nExport only target named 'my_target' and print it to standard output on the screen.\n\n\n\n\n\n\nimport\n\n\nnewt target import ex_tgt_1 \n exported_targets.txt\n\n\nImports the target configuration for 'ex_tgt_1' in 'exported_targets.txt'.\n\n\n\n\n\n\nimport\n\n\nnewt target import -a \n in_targets.txt\n\n\nImports all the targets specified in the file named \nin_targets.txt\n A sample file is shown after this table.\n\n\n\n\n\n\nsize\n\n\nnewt target size blink_nordic\n\n\nInspects and lists the RAM and Flash memory use by each component (object files and libraries) of the target.\n\n\n\n\n\n\ndownload\n\n\nnewt target -v -lVERBOSE download blinky\n\n\nDownloads \nblinky.elf.bin\nto the hardware in verbose mode with logging turned on at VERBO
SE level.\n\n\n\n\n\n\ndebug\n\n\nnewt target debug blinky\n\n\nDownloads \nblinky.elf.bin\nto the hardware, opens up a gdb session with \nblinky.elf\nin the terminal, and halts for further input in gdb.\n\n\n\n\n\n\n\n\nExample content for \nin_targets.txt\n file used for importing targets \ntest3\n and \ntest4\n. \n\n\n\n\n@target=test3\n\nproject=blinked\n\narch=sim\n\ncompiler_def=debug\n\ncompiler=arm-none-eabi-m4\n\n@target=test4\n\nproject=super_blinky\n\narch=sim\n\ncompiler_def=debug\n\ncompiler=arm-none-eabi-m4\n\n@endtargets",
+ "text": "Command List\n\n\nAvailable high-level commands\n\n\nversion Display the Newt version number\nhelp Help about any command\nnest Commands to manage nests \n clutches (remote egg repositories)\negg Commands to list and inspect eggs on a nest\ntarget Set and view target information\n\n\n\n\nversion\n\n\nUsage:\n\n\n newt version [flags]\n\n\n\n\nFlags:\n\n\n -h, --help=false: help for version\n\n\n\n\nGlobal Flags:\n\n\n -h, --help=false: help for newt\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nversion\n\n\nnewt version\n\n\nDisplays the version of newt tool installed\n\n\n\n\n\n\n\n\nhelp\n\n\nUsage:\n\n\n newt help [input1]\n\n\n\n\nFlags:\n\n\n\n-h, --help=false: help for newt\n-l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n-q, --quiet=false: Be quiet; only display error output.\n-s, --silent=false: Be silent; don't output anything.\n-v, --verbose=false: Enabl
e verbose output when executing commands.\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nhelp\n\n\nnewt help target\n\n\nDisplays the help text for the newt command 'target'\n\n\n\n\n\n\nhelp\n\n\nnewt help\n\n\nDisplays the help text for newt tool\n\n\n\n\n\n\n\n\nnest\n\n\nUsage:\n\n\n newt nest [command][flags] input1 input2...\n\n\n\n\nAvailable commands: \n\n\n create Create a new nest\n generate-clutch Generate a clutch file from the eggs in the current directory\n add-clutch Add a remote clutch, and put it in the current nest\n list-clutches List the clutches installed in the current nest\n show-clutch Show an individual clutch in the current nest\n\n\n\n\nFlags:\n\n\n -h, --help=false: help for nest\n\n\n\n\nGlobal Flags:\n\n\n -h, --help=false: help for newt\n -l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n -q, --quiet=false: Be quiet; only display error output.\n -
s, --silent=false: Be silent; don't output anything.\n -v, --verbose=false: Enable verbose output when executing commands.\n\n\n\n\nDescription\n\n\n\n\n\n\n\n\nSub-command\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\ncreate\n\n\nDownloads the skeleton of a nest on your local machine from the optional \ninput2\nnest url, if specified, and creates a new nest directory by the name of \ninput1\n If \ninput2\nis not specified, then a default skeleton from the \ntadpole\nnest on Mynewt is downloaded. The command lays out a generic directory structure for the nest you are going to build under it and includes some default eggs in it.\n\n\n\n\n\n\ngenerate-clutch\n\n\nTakes a snapshot of the eggs in the current local directory and combines them into a clutch by the name of \ninput1\nand with the url of \ninput2\nand generates a standard output of the clutch details that can be redirected to a \n.yml\nclutch file. Typically the clutch file name is chosen to match the clutch name which means the
standard output should be directed to a clutch file named \ninput1.yml\n\n\n\n\n\n\nadd-clutch\n\n\nDownloads the clutch of the name \ninput1\nfrom the master branch of the github repository \ninput2\ninto the current nest. A file named \ninput1.yml\nfile is added in the \n.nest/clutches\nsubdirectory inside the current local nest. The \n.nest/\ndirectory structure is created automatically if it does not exist.\n\n\n\n\n\n\nlist-clutches\n\n\nLists all the clutches present in the current nest, including clutches that may have been added from other nests on github. The output shows all the remote clutch names and the total eggshells in each of the clutches.\n\n\n\n\n\n\nshow-clutch\n\n\nShows information about the clutch that has the name given in the \ninput1\nargument. Output includes the clutch name, url, and all the constituent eggs with their version numbers.\n\n\n\n\n\n\n\n\nCommand-specific flags\n\n\n\n\n\n\n\n\nSub-command\n\n\nAvailable flags\n\n\nExplanation\n\n\n\n\n\n\n\
n\n\n\nadd-clutch\n\n\n-b, --branch=\"\n\"\n\n\nFetches the clutch file with name \ninput1\nfrom the specified branch at \ninput1\nurl of the github repository. All subsequent egg installations will be done from that branch.\n\n\n\n\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\ncreate\n\n\nnewt nest create test_project\n\n\nCreates a new nest named \"test_project \" using the default skeleton0\n\n\n\n\n\n\ncreate\n\n\nnewt nest create mynest \n\n\nCreates a new nest named \"mynest\" using the skeleton at the \n specified\n\n\n\n\n\n\ngenerate-clutch\n\n\nnewt nest generate-clutch myclutch https://www.github.com/mynewt/larva \n myclutch.yml\n\n\nTakes a snapshot of the eggs in the current nest to form a clutch named myclutch with the url https://www.github.com/mynewt/larva. The output is written to a file named \nmyclutch.yml\nand describes the properties and contents of the clutch (name, url, eggs).\n\n\n\n\n\n\nadd-clutch\n\n\nnewt
nest add-clutch larva https://www.github.com/mynewt/larva\n\n\nAdds the remote clutch named larva at www.github.com/mynewt/larva to the local nest.\n\n\n\n\n\n\nlist-clutches\n\n\nnewt nest list-clutches\n\n\nShows all the remote clutch description files that been downloaded into the current nest\n\n\n\n\n\n\nshow-clutch\n\n\nnewt nest show-clutch larva\n\n\nOutputs the details of the clutch named larva such as the github url where the remote sits, the constituent eggs and their versions\n\n\n\n\n\n\n\n\negg\n\n\nUsage:\n\n\n newt egg [command][flag] input1 input2\n\n\n\n\nAvailable Commands: \n\n\n list List eggs in the current nest\n checkdeps Check egg dependencies\n hunt Search for egg from clutches\n show Show the contents of an egg.\n install Install an egg\n remove Remove an egg\n\n\n\n\nFlags:\n\n\n -h, --help=false: help for egg\n\nGlobal Flags:\n\n -l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n -q, --qu
iet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don't output anything.\n -v, --verbose=false: Enable verbose output when executing commands.\n\n\n\n\nDescription\n\n\n\n\n\n\n\n\nSub-command\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nlist\n\n\nList all the eggs in the current nest. The output shows the name, version, path, and any additional attributes of each egg in the nest such as dependencies, capabilities, and linker scripts. The newt command gets the attributes of each egg from the corresponsing egg.yml description file.\n\n\n\n\n\n\ncheckdeps\n\n\nResolve all dependencies in the local nest. This command goes through all eggs currently installed, checks their dependencies, and prints any unresolved dependencies between eggs.\n\n\n\n\n\n\nhunt\n\n\nHunts for an egg, specified by \ninput1\n The local nest, along with all remote nests (clutches) are searched. All matched eggs are shown along with the clutch informaton. Installed eggs are called o
ut as such. The command can be invoked from anywhere in the nest.\n\n\n\n\n\n\nshow\n\n\nShow the contents of the egg named \ninput2\nfound in the clutch named \ninput1\n The clutch name is optional; if only the egg name is given as the argument it is resolved using all the clutches installed in the current nest. If the egg is present in multiple clutches it will list all of them along with the clutch information for each.\n\n\n\n\n\n\ninstall\n\n\nInstall the egg specified by \ninput2\nfrom the clutch named \ninput1\n The command downloads the egg from the github repository using the URL in the clutch description file (typically donwloaded as 'input1@\n.yml' in .nest/clutches). It also downloads all the dependencies (constituent eggs) as decribed in the egg's description file ('egg.yml') and installs all of them. The clutch name is optional. If only the egg name is given as the argument, the command looks for the egg name in all the clutches in the local nest and installs according
ly. An egg is installed by this command only if it has not already been installed.\n\n\n\n\n\n\nremove\n\n\nRemove an egg named \ninput2\nfrom clutch \ninput1\n if clutch is specified. Otherwise only one input required - that of the name of the egg to be removed from the local nest.\n\n\n\n\n\n\n\n\nCommand-specific flags\n\n\n\n\n\n\n\n\nSub-command\n\n\nAvailable flags\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\ninstall\n\n\n-b, --branch=\"\n\"\n\n\nInstalls the eggs from the branch name or tag of the clutch specified\n\n\n\n\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nlist\n\n\nnewt egg list\n\n\nCList all of the eggs in the current nest and the details of the eggs.\n\n\n\n\n\n\ncheckdeps\n\n\nnewt egg checkdeps\n\n\nChecks all the dependencies between eggs in the nest. Lists any unresolved dependencies.\n\n\n\n\n\n\nhunt\n\n\nnewt egg hunt blinky\n\n\nHunts for the egg named 'blinky'. The command can be invoked from anywhere in the n
est. Results show if the egg is installed and which clutch, if any, has the egg.\n\n\n\n\n\n\nshow\n\n\nnewt egg show larva libs/os\n\n\nShow the contents of the egg named 'libs/os' in the clutch named larva. The contents are essentially derived from the egg's 'egg.yml' file.\n\n\n\n\n\n\ninstall\n\n\nnewt egg install hw/bsp/stm32f3discovery\n\n\nDownloads and installs the egg named \"stm32f3discovery\" (specified with its full path name inside the remote nest) along with all its dependencies from the remote nest on github. Since no clutch is specified, the URL for the remote nest in the clutch description file found in the local nest (in .nest/clutches for the project) is used.\n\n\n\n\n\n\nremove\n\n\nnewt egg remove larva blinky\n\n\nRemoves the egg named blinky only from the clutch named larva\n\n\n\n\n\n\nremove\n\n\nnewt egg remove blinky\n\n\nRemoves the egg named blinky from the local nest\n\n\n\n\n\n\n\n\ntarget\n\n\nUsage:\n\n\nUsage: \n\n\n newt target [command] input1
[flag1] [flag2]\n\n\n\n\nAvailable Commands: \n\n\n set Set target configuration variable\n unset Unset target configuration variable\n delete Delete target\n create Create a target\n show View target configuration variables\n build Build target\n test Test target\n export Export target\n import Import target\n download Download image to target\n debug Download image to target and start an openocd/gdb session\n\n\n\n\nFlags:\n\n\n -h, --help=false: help for target\n\n\n\n\nGlobal Flags:\n\n\n -l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don't output anything.\n -v, --verbose=false: Enable verbose output when executing commands.\n\n\n\n\nDescription\n\n\n\n\n\n\n\n\nSub-command\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nset\n\n\nSet attributes of the target. Currently the list of
possible attributes are:\narch, compiler, compiler_def, project, bsp, egg, identities, capabilities, dependencies, cflags, lflags\n Typically only the first 5 need to be set for a hardware target. For a simulated target, e.g. for software testing purposes, \narch=sim\n \ncompiler=sim\n and \negg=\negg name to be tested\n You cannot set both the project and egg for a target.\n\n\n\n\n\n\nunset\n\n\nUnset attributes of the target in its configuration.\n\n\n\n\n\n\ndelete\n\n\nDeletes only the description for the target. Does not delete the target directory with associated binaries. If you want to clean out the binaries, list files, and executables use\nnewt target build \ntarget-name\n clean\nbefore\n deleting the target!\n\n\n\n\n\n\ncreate\n\n\nCreates a target description or build definition by the name \ninput1\n By default it assigns the sim (simulator) architecture to it which allows you to build new projects and software on your native OS and try it out.\n\n\n\n\n\n\nshow\n\n\n
Display the configuration defined for the target named \ninput1\n If no \ninput1\nis specified then show the details for all the targets in the nest.\n\n\n\n\n\n\nbuild\n\n\nBuild the source code into an image that can be loaded on the hardware associated with the target named \ninput1\nto do the application enabled by the 'project' associated with that target (via the target definition). It creates 'bin/' and 'bin/\n/' subdirectories inside the base directory for the project, compiles and generates binaries and executables, and places them in 'bin/\n/.\n\n\n\n\n\n\ntest\n\n\nTest an egg on the target named \ninput1\n The egg is either supplied as an argument to the command line invocation of \nnewt target test\nor added as part of the target definition. If only the target is specified as \ninput1\n then the egg in the target's definition is automatically chosen to be tested. You currently cannot test an entire project on a hardware target. The test command is envisioned for use if
one or two eggs gets updated and each needs to be tested against a target. Alternatively, a script may be written for a series of tests on several eggs.\n\n\n\n\n\n\nexport\n\n\nExports the configurations of the specified target \ninput1\n If -a or -export-all flag is used, then all targets are exported and printed out to standard out. You may redirect the output to a file.\n\n\n\n\n\n\nimport\n\n\nImport one or more target configuration from standard input or a file. Each target starts with \n@target=\ntarget-name\nfollowed by the attributes. The list of targets should end with \n@endtargets\n\n\n\n\n\n\nsize\n\n\nOutputs the RAM and flash consumption by the components of the specified target \ninput1\n\n\n\n\n\n\ndownload\n\n\nDownloads the binary executable \ntarget-name\n.elf.bin\nto the board.\n\n\n\n\n\n\ndebug\n\n\nDownloads the binary executable \ntarget-name\n.elf.bin\nto the board and starts up the openocd/gdb combination session. gdb takes over the terminal.\n\n\n\n\n\n\n
\n\nCommand-specific flags\n\n\n\n\n\n\n\n\nSub-command\n\n\nAvailable flags\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nbuild\n\n\nclean\n\n\nAll the binaries and object files for the specified target will be removed. The subdirectory named after the specified target within that project is removed.\n\n\n\n\n\n\nbuild clean\n\n\nall\n\n\nAll the binaries and object files for all targets are removed, and subdirectories of all targets for the project are removed. However, the entire repository is not emptied since any eggs or projects that the specified target doesn't reference are not touched.\n\n\n\n\n\n\nexport\n\n\n-a, -export-all\n\n\nExport all targets. \ninput1\nis not necessary when this flag is used.\n\n\n\n\n\n\nimport\n\n\n-a, -import-all\n\n\nImport all targets typed into standard input or redirected from a file.\n\n\n\n\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nset\n\n\nnewt target set myblinky compiler=arm-none-eabi-m4\n\n\
nSet the compiler for the 'myblinky' target to the gcc compiler for embedded ARM chips.\n\n\n\n\n\n\nunset\n\n\nnewt target unset myblinky compiler\n\n\nRemove the setting for the compiler for the 'myblinky' target.\n\n\n\n\n\n\ndelete\n\n\nnewt target delete myblinky\n\n\nDelete the target description for the target named 'myblinky'. Note that it does not remove any binaries or clean out the directory for this target.\n\n\n\n\n\n\ncreate\n\n\nnewt target create blink_f3disc\n\n\nCreate a new target description by the name 'blink_f3disc'. The architecture is 'sim' by default and can be changed using subcommand 'set' above.\n\n\n\n\n\n\nshow\n\n\nnewt target show myblinky\n\n\nShow the target attributes set for 'myblinky'\n\n\n\n\n\n\nbuild\n\n\nnewt target build blink_f3disc\n\n\nCompile the source code for the target named blink_f3disc and generate binaries that can be loaded into the target hardware.\n\n\n\n\n\n\ntest\n\n\nnewt target test test_target egg=libs/os\n\n\nTests the eg
g named 'libs/os' against the target named 'test_target'\n\n\n\n\n\n\nexport\n\n\nnewt target export -a \n my_exports.txt\n\n\nExport all build targets from the current nest, and redirect output to a file named 'my_exports.txt'.\n\n\n\n\n\n\nexport\n\n\nnewt target export -export-all\n\n\nExport all build targets from the current nest, and print them to standard output on the screen.\n\n\n\n\n\n\nexport\n\n\nnewt target export my_target\n\n\nExport only target named 'my_target' and print it to standard output on the screen.\n\n\n\n\n\n\nimport\n\n\nnewt target import ex_tgt_1 \n exported_targets.txt\n\n\nImports the target configuration for 'ex_tgt_1' in 'exported_targets.txt'.\n\n\n\n\n\n\nimport\n\n\nnewt target import -a \n in_targets.txt\n\n\nImports all the targets specified in the file named \nin_targets.txt\n A sample file is shown after this table.\n\n\n\n\n\n\nsize\n\n\nnewt target size blink_nordic\n\n\nInspects and lists the RAM and Flash memory use by each component (obj
ect files and libraries) of the target.\n\n\n\n\n\n\ndownload\n\n\nnewt target -v -lVERBOSE download blinky\n\n\nDownloads \nblinky.elf.bin\nto the hardware in verbose mode with logging turned on at VERBOSE level.\n\n\n\n\n\n\ndebug\n\n\nnewt target debug blinky\n\n\nDownloads \nblinky.elf.bin\nto the hardware, opens up a gdb session with \nblinky.elf\nin the terminal, and halts for further input in gdb.\n\n\n\n\n\n\n\n\nExample content for \nin_targets.txt\n file used for importing targets \ntest3\n and \ntest4\n. \n\n\n\n\n@target=test3\n\nproject=blinked\n\narch=sim\n\ncompiler_def=debug\n\ncompiler=arm-none-eabi-m4\n\n@target=test4\n\nproject=super_blinky\n\narch=sim\n\ncompiler_def=debug\n\ncompiler=arm-none-eabi-m4\n\n@endtargets",
"title": "Command list"
},
{
"location": "/newt/newt_tool_reference/#command-list",
- "text": "Available high-level commands version Display the Newt version number\nhelp Help about any command\nnest Commands to manage nests clutches (remote egg repositories)\negg Commands to list and inspect eggs on a nest\ntarget Set and view target information version Usage: newt version [flags] Flags: -h, --help=false: help for version Global Flags: -h, --help=false: help for newt Examples Sub-command Usage Explanation version newt version Displays the version of newt tool installed help Usage: newt help [input1] Flags: \n-h, --help=false: help for newt\n-l, --loglevel= WARN : Log level, defaults to WARN.\n-q, --quiet=false: Be quiet; only display error output.\n-s, --silent=false: Be silent; don't output anything.\n-v, --verbose=false: Enable verbose output when executing commands. Examples Sub-command Usage Explanation help newt help target Displays the help text for the newt command 'targe
t' help newt help Displays the help text for newt tool nest Usage: newt nest [command][flags] input1 input2... Available commands: create Create a new nest\ngenerate-clutch Generate a clutch file from the eggs in the current directory\nadd-clutch Add a remote clutch, and put it in the current nest\nlist-clutches List the clutches installed in the current nest\nshow-clutch Show an individual clutch in the current nest Flags: -h, --help=false: help for nest Global Flags: -h, --help=false: help for newt\n-l, --loglevel=\"WARN\": Log level, defaults to WARN.\n-q, --quiet=false: Be quiet; only display error output.\n-s, --silent=false: Be silent; don't output anything.\n-v, --verbose=false: Enable verbose output when executing commands. Description Sub-command Explanation create Downloads the skeleton of a nest on your local machine from the optional input2 nest url, if specified, and creates a new nest directory by the name of input1
If input2 is not specified, then a default skeleton from the tadpole nest on Mynewt is downloaded. The command lays out a generic directory structure for the nest you are going to build under it and includes some default eggs in it. generate-clutch Takes a snapshot of the eggs in the current local directory and combines them into a clutch by the name of input1 and with the url of input2 and generates a standard output of the clutch details that can be redirected to a .yml clutch file. Typically the clutch file name is chosen to match the clutch name which means the standard output should be directed to a clutch file named input1.yml add-clutch Downloads the clutch of the name input1 from the master branch of the github repository input2 into the current nest. A file named input1.yml file is added in the .nest/clutches subdirectory inside the current local nest. The .nest/ directory structure is created automatically if it does not exist. list-clutches Lists al
l the clutches present in the current nest, including clutches that may have been added from other nests on github. The output shows all the remote clutch names and the total eggshells in each of the clutches. show-clutch Shows information about the clutch that has the name given in the input1 argument. Output includes the clutch name, url, and all the constituent eggs with their version numbers. Command-specific flags Sub-command Available flags Explanation add-clutch -b, --branch=\" \" Fetches the clutch file with name input1 from the specified branch at input1 url of the github repository. All subsequent egg installations will be done from that branch. Examples Sub-command Usage Explanation create newt nest create test_project Creates a new nest named \"test_project \" using the default skeleton0 create newt nest create mynest Creates a new nest named \"mynest\" using the skeleton at the specified generate-clutch newt nest gene
rate-clutch myclutch https://www.github.com/mynewt/larva myclutch.yml Takes a snapshot of the eggs in the current nest to form a clutch named myclutch with the url https://www.github.com/mynewt/larva. The output is written to a file named myclutch.yml and describes the properties and contents of the clutch (name, url, eggs). add-clutch newt nest add-clutch larva https://www.github.com/mynewt/larva Adds the remote clutch named larva at www.github.com/mynewt/larva to the local nest. list-clutches newt nest list-clutches Shows all the remote clutch description files that been downloaded into the current nest show-clutch newt nest show-clutch larva Outputs the details of the clutch named larva such as the github url where the remote sits, the constituent eggs and their versions egg Usage: newt egg [command][flag] input1 input2 Available Commands: list List eggs in the current nest\ncheckdeps Check egg dependencies\nhunt Search for egg from clu
tches\nshow Show the contents of an egg.\ninstall Install an egg\nremove Remove an egg Flags: -h, --help=false: help for egg Global Flags: -l, --loglevel=\"WARN\": Log level, defaults to WARN.\n-q, --quiet=false: Be quiet; only display error output.\n-s, --silent=false: Be silent; don't output anything.\n-v, --verbose=false: Enable verbose output when executing commands. Description Sub-command Explanation list List all the eggs in the current nest. The output shows the name, version, path, and any additional attributes of each egg in the nest such as dependencies, capabilities, and linker scripts. The newt command gets the attributes of each egg from the corresponsing egg.yml description file. checkdeps Resolve all dependencies in the local nest. This command goes through all eggs currently installed, checks their dependencies, and prints any unresolved dependencies between eggs. hunt Hunts for an egg, specified by input1 The local nest, al
ong with all remote nests (clutches) are searched. All matched eggs are shown along with the clutch informaton. Installed eggs are called out as such. The command can be invoked from anywhere in the nest. show Show the contents of the egg named input2 found in the clutch named input1 The clutch name is optional; if only the egg name is given as the argument it is resolved using all the clutches installed in the current nest. If the egg is present in multiple clutches it will list all of them along with the clutch information for each. install Install the egg specified by input2 from the clutch named input1 The command downloads the egg from the github repository using the URL in the clutch description file (typically donwloaded as 'input1@ .yml' in .nest/clutches). It also downloads all the dependencies (constituent eggs) as decribed in the egg's description file ('egg.yml') and installs all of them. The clutch name is optional. If only the egg name is given as the arg
ument, the command looks for the egg name in all the clutches in the local nest and installs accordingly. An egg is installed by this command only if it has not already been installed. remove Remove an egg named input2 from clutch input1 if clutch is specified. Otherwise only one input required - that of the name of the egg to be removed from the local nest. Command-specific flags Sub-command Available flags Explanation install -b, --branch=\" \" Installs the eggs from the branch name or tag of the clutch specified Examples Sub-command Usage Explanation list newt egg list CList all of the eggs in the current nest and the details of the eggs. checkdeps newt egg checkdeps Checks all the dependencies between eggs in the nest. Lists any unresolved dependencies. hunt newt egg hunt blinky Hunts for the egg named 'blinky'. The command can be invoked from anywhere in the nest. Results show if the egg is installed and which clutch, if any, h
as the egg. show newt egg show larva libs/os Show the contents of the egg named 'libs/os' in the clutch named larva. The contents are essentially derived from the egg's 'egg.yml' file. install newt egg install hw/bsp/stm32f3discovery Downloads and installs the egg named \"stm32f3discovery\" (specified with its full path name inside the remote nest) along with all its dependencies from the remote nest on github. Since no clutch is specified, the URL for the remote nest in the clutch description file found in the local nest (in .nest/clutches for the project) is used. remove newt egg remove larva blinky Removes the egg named blinky only from the clutch named larva remove newt egg remove blinky Removes the egg named blinky from the local nest target Usage: Usage: newt target [command] input1 [flag1] [flag2] Available Commands: set Set target configuration variable\nunset Unset target configuration variable\ndelete Delete target\ncreate
Create a target\nshow View target configuration variables\nbuild Build target\ntest Test target\nexport Export target\nimport Import target\ndownload Download image to target\ndebug Download image to target and start an openocd/gdb session Flags: -h, --help=false: help for target Global Flags: -l, --loglevel=\"WARN\": Log level, defaults to WARN.\n-q, --quiet=false: Be quiet; only display error output.\n-s, --silent=false: Be silent; don't output anything.\n-v, --verbose=false: Enable verbose output when executing commands. Description Sub-command Explanation set Set attributes of the target. Currently the list of possible attributes are: arch, compiler, compiler_def, project, bsp, egg, identities, capabilities, dependencies, cflags, lflags Typically only the first 5 need to be set for a hardware target. For a simulated target, e.g. for software testing purposes, arch=sim compiler=sim and egg= egg name to be tested Y
ou cannot set both the project and egg for a target. unset Unset attributes of the target in its configuration. delete Deletes only the description for the target. Does not delete the target directory with associated binaries. If you want to clean out the binaries, list files, and executables use newt target build target-name clean before deleting the target! create Creates a target description or build definition by the name input1 By default it assigns the sim (simulator) architecture to it which allows you to build new projects and software on your native OS and try it out. show Display the configuration defined for the target named input1 If no input1 is specified then show the details for all the targets in the nest. build Build the source code into an image that can be loaded on the hardware associated with the target named input1 to do the application enabled by the 'project' associated with that target (via the target definition). It creates 'bin
/' and 'bin/ /' subdirectories inside the base directory for the project, compiles and generates binaries and executables, and places them in 'bin/ /. test Test an egg on the target named input1 The egg is either supplied as an argument to the command line invocation of newt target test or added as part of the target definition. If only the target is specified as input1 then the egg in the target's definition is automatically chosen to be tested. You currently cannot test an entire project on a hardware target. The test command is envisioned for use if one or two eggs gets updated and each needs to be tested against a target. Alternatively, a script may be written for a series of tests on several eggs. export Exports the configurations of the specified target input1 If -a or -export-all flag is used, then all targets are exported and printed out to standard out. You may redirect the output to a file. import Import one or more target configuration from standard inp
ut or a file. Each target starts with @target= target-name followed by the attributes. The list of targets should end with @endtargets size Outputs the RAM and flash consumption by the components of the specified target input1 download Downloads the binary executable target-name .elf.bin to the board. debug Downloads the binary executable target-name .elf.bin to the board and starts up the openocd/gdb combination session. gdb takes over the terminal. Command-specific flags Sub-command Available flags Explanation build clean All the binaries and object files for the specified target will be removed. The subdirectory named after the specified target within that project is removed. build clean all All the binaries and object files for all targets are removed, and subdirectories of all targets for the project are removed. However, the entire repository is not emptied since any eggs or projects that the specified target doesn't reference are not tou
ched. export -a, -export-all Export all targets. input1 is not necessary when this flag is used. import -a, -import-all Import all targets typed into standard input or redirected from a file. Examples Sub-command Usage Explanation set newt target set myblinky compiler=arm-none-eabi-m4 Set the compiler for the 'myblinky' target to the gcc compiler for embedded ARM chips. unset newt target unset myblinky compiler Remove the setting for the compiler for the 'myblinky' target. delete newt target delete myblinky Delete the target description for the target named 'myblinky'. Note that it does not remove any binaries or clean out the directory for this target. create newt target create blink_f3disc Create a new target description by the name 'blink_f3disc'. The architecture is 'sim' by default and can be changed using subcommand 'set' above. show newt target show myblinky Show the target attributes set for 'myblinky' build newt target bui
ld blink_f3disc Compile the source code for the target named blink_f3disc and generate binaries that can be loaded into the target hardware. test newt target test test_target egg=libs/os Tests the egg named 'libs/os' against the target named 'test_target' export newt target export -a my_exports.txt Export all build targets from the current nest, and redirect output to a file named 'my_exports.txt'. export newt target export -export-all Export all build targets from the current nest, and print them to standard output on the screen. export newt target export my_target Export only target named 'my_target' and print it to standard output on the screen. import newt target import ex_tgt_1 exported_targets.txt Imports the target configuration for 'ex_tgt_1' in 'exported_targets.txt'. import newt target import -a in_targets.txt Imports all the targets specified in the file named in_targets.txt A sample file is shown after this table. size newt targ
et size blink_nordic Inspects and lists the RAM and Flash memory use by each component (object files and libraries) of the target. download newt target -v -lVERBOSE download blinky Downloads blinky.elf.bin to the hardware in verbose mode with logging turned on at VERBOSE level. debug newt target debug blinky Downloads blinky.elf.bin to the hardware, opens up a gdb session with blinky.elf in the terminal, and halts for further input in gdb. Example content for in_targets.txt file used for importing targets test3 and test4 . @target=test3 \nproject=blinked \narch=sim \ncompiler_def=debug \ncompiler=arm-none-eabi-m4 \n@target=test4 \nproject=super_blinky \narch=sim \ncompiler_def=debug \ncompiler=arm-none-eabi-m4 \n@endtargets",
+ "text": "Available high-level commands version Display the Newt version number\nhelp Help about any command\nnest Commands to manage nests clutches (remote egg repositories)\negg Commands to list and inspect eggs on a nest\ntarget Set and view target information version Usage: newt version [flags] Flags: -h, --help=false: help for version Global Flags: -h, --help=false: help for newt Examples Sub-command Usage Explanation version newt version Displays the version of newt tool installed help Usage: newt help [input1] Flags: \n-h, --help=false: help for newt\n-l, --loglevel= WARN : Log level, defaults to WARN.\n-q, --quiet=false: Be quiet; only display error output.\n-s, --silent=false: Be silent; don't output anything.\n-v, --verbose=false: Enable verbose output when executing commands. Examples Sub-command Usage Explanation help newt help target Displays the help text for the new
t command 'target' help newt help Displays the help text for newt tool nest Usage: newt nest [command][flags] input1 input2... Available commands: create Create a new nest\n generate-clutch Generate a clutch file from the eggs in the current directory\n add-clutch Add a remote clutch, and put it in the current nest\n list-clutches List the clutches installed in the current nest\n show-clutch Show an individual clutch in the current nest Flags: -h, --help=false: help for nest Global Flags: -h, --help=false: help for newt\n -l, --loglevel= WARN : Log level, defaults to WARN.\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don't output anything.\n -v, --verbose=false: Enable verbose output when executing commands. Description Sub-command Explanation create Downloads the skeleton of a nest on your local machine from the optional input2 nest url, if specif
ied, and creates a new nest directory by the name of input1 If input2 is not specified, then a default skeleton from the tadpole nest on Mynewt is downloaded. The command lays out a generic directory structure for the nest you are going to build under it and includes some default eggs in it. generate-clutch Takes a snapshot of the eggs in the current local directory and combines them into a clutch by the name of input1 and with the url of input2 and generates a standard output of the clutch details that can be redirected to a .yml clutch file. Typically the clutch file name is chosen to match the clutch name which means the standard output should be directed to a clutch file named input1.yml add-clutch Downloads the clutch of the name input1 from the master branch of the github repository input2 into the current nest. A file named input1.yml file is added in the .nest/clutches subdirectory inside the current local nest. The .nest/ directory structure is created
automatically if it does not exist. list-clutches Lists all the clutches present in the current nest, including clutches that may have been added from other nests on github. The output shows all the remote clutch names and the total eggshells in each of the clutches. show-clutch Shows information about the clutch that has the name given in the input1 argument. Output includes the clutch name, url, and all the constituent eggs with their version numbers. Command-specific flags Sub-command Available flags Explanation add-clutch -b, --branch=\" \" Fetches the clutch file with name input1 from the specified branch at input1 url of the github repository. All subsequent egg installations will be done from that branch. Examples Sub-command Usage Explanation create newt nest create test_project Creates a new nest named \"test_project \" using the default skeleton0 create newt nest create mynest Creates a new nest named \"mynest\" using the
skeleton at the specified generate-clutch newt nest generate-clutch myclutch https://www.github.com/mynewt/larva myclutch.yml Takes a snapshot of the eggs in the current nest to form a clutch named myclutch with the url https://www.github.com/mynewt/larva. The output is written to a file named myclutch.yml and describes the properties and contents of the clutch (name, url, eggs). add-clutch newt nest add-clutch larva https://www.github.com/mynewt/larva Adds the remote clutch named larva at www.github.com/mynewt/larva to the local nest. list-clutches newt nest list-clutches Shows all the remote clutch description files that been downloaded into the current nest show-clutch newt nest show-clutch larva Outputs the details of the clutch named larva such as the github url where the remote sits, the constituent eggs and their versions egg Usage: newt egg [command][flag] input1 input2 Available Commands: list List eggs in the current nest\n
checkdeps Check egg dependencies\n hunt Search for egg from clutches\n show Show the contents of an egg.\n install Install an egg\n remove Remove an egg Flags: -h, --help=false: help for egg\n\nGlobal Flags:\n\n -l, --loglevel= WARN : Log level, defaults to WARN.\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don't output anything.\n -v, --verbose=false: Enable verbose output when executing commands. Description Sub-command Explanation list List all the eggs in the current nest. The output shows the name, version, path, and any additional attributes of each egg in the nest such as dependencies, capabilities, and linker scripts. The newt command gets the attributes of each egg from the corresponsing egg.yml description file. checkdeps Resolve all dependencies in the local nest. This command goes through all eggs currently installed, checks their dependencies, and prin
ts any unresolved dependencies between eggs. hunt Hunts for an egg, specified by input1 The local nest, along with all remote nests (clutches) are searched. All matched eggs are shown along with the clutch informaton. Installed eggs are called out as such. The command can be invoked from anywhere in the nest. show Show the contents of the egg named input2 found in the clutch named input1 The clutch name is optional; if only the egg name is given as the argument it is resolved using all the clutches installed in the current nest. If the egg is present in multiple clutches it will list all of them along with the clutch information for each. install Install the egg specified by input2 from the clutch named input1 The command downloads the egg from the github repository using the URL in the clutch description file (typically donwloaded as 'input1@ .yml' in .nest/clutches). It also downloads all the dependencies (constituent eggs) as decribed in the egg's description
file ('egg.yml') and installs all of them. The clutch name is optional. If only the egg name is given as the argument, the command looks for the egg name in all the clutches in the local nest and installs accordingly. An egg is installed by this command only if it has not already been installed. remove Remove an egg named input2 from clutch input1 if clutch is specified. Otherwise only one input required - that of the name of the egg to be removed from the local nest. Command-specific flags Sub-command Available flags Explanation install -b, --branch=\" \" Installs the eggs from the branch name or tag of the clutch specified Examples Sub-command Usage Explanation list newt egg list CList all of the eggs in the current nest and the details of the eggs. checkdeps newt egg checkdeps Checks all the dependencies between eggs in the nest. Lists any unresolved dependencies. hunt newt egg hunt blinky Hunts for the egg named 'blinky'. The co
mmand can be invoked from anywhere in the nest. Results show if the egg is installed and which clutch, if any, has the egg. show newt egg show larva libs/os Show the contents of the egg named 'libs/os' in the clutch named larva. The contents are essentially derived from the egg's 'egg.yml' file. install newt egg install hw/bsp/stm32f3discovery Downloads and installs the egg named \"stm32f3discovery\" (specified with its full path name inside the remote nest) along with all its dependencies from the remote nest on github. Since no clutch is specified, the URL for the remote nest in the clutch description file found in the local nest (in .nest/clutches for the project) is used. remove newt egg remove larva blinky Removes the egg named blinky only from the clutch named larva remove newt egg remove blinky Removes the egg named blinky from the local nest target Usage: Usage: newt target [command] input1 [flag1] [flag2] Available Commands: set
Set target configuration variable\n unset Unset target configuration variable\n delete Delete target\n create Create a target\n show View target configuration variables\n build Build target\n test Test target\n export Export target\n import Import target\n download Download image to target\n debug Download image to target and start an openocd/gdb session Flags: -h, --help=false: help for target Global Flags: -l, --loglevel= WARN : Log level, defaults to WARN.\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don't output anything.\n -v, --verbose=false: Enable verbose output when executing commands. Description Sub-command Explanation set Set attributes of the target. Currently the list of possible attributes are: arch, compiler, compiler_def, project, bsp, egg, identities, capabilities, dependencies, cflags, lflags Typical
ly only the first 5 need to be set for a hardware target. For a simulated target, e.g. for software testing purposes, arch=sim compiler=sim and egg= egg name to be tested You cannot set both the project and egg for a target. unset Unset attributes of the target in its configuration. delete Deletes only the description for the target. Does not delete the target directory with associated binaries. If you want to clean out the binaries, list files, and executables use newt target build target-name clean before deleting the target! create Creates a target description or build definition by the name input1 By default it assigns the sim (simulator) architecture to it which allows you to build new projects and software on your native OS and try it out. show Display the configuration defined for the target named input1 If no input1 is specified then show the details for all the targets in the nest. build Build the source code into an image that can be loade
d on the hardware associated with the target named input1 to do the application enabled by the 'project' associated with that target (via the target definition). It creates 'bin/' and 'bin/ /' subdirectories inside the base directory for the project, compiles and generates binaries and executables, and places them in 'bin/ /. test Test an egg on the target named input1 The egg is either supplied as an argument to the command line invocation of newt target test or added as part of the target definition. If only the target is specified as input1 then the egg in the target's definition is automatically chosen to be tested. You currently cannot test an entire project on a hardware target. The test command is envisioned for use if one or two eggs gets updated and each needs to be tested against a target. Alternatively, a script may be written for a series of tests on several eggs. export Exports the configurations of the specified target input1 If -a or -export-all flag i
s used, then all targets are exported and printed out to standard out. You may redirect the output to a file. import Import one or more target configuration from standard input or a file. Each target starts with @target= target-name followed by the attributes. The list of targets should end with @endtargets size Outputs the RAM and flash consumption by the components of the specified target input1 download Downloads the binary executable target-name .elf.bin to the board. debug Downloads the binary executable target-name .elf.bin to the board and starts up the openocd/gdb combination session. gdb takes over the terminal. Command-specific flags Sub-command Available flags Explanation build clean All the binaries and object files for the specified target will be removed. The subdirectory named after the specified target within that project is removed. build clean all All the binaries and object files for all targets are removed, and subdirect
ories of all targets for the project are removed. However, the entire repository is not emptied since any eggs or projects that the specified target doesn't reference are not touched. export -a, -export-all Export all targets. input1 is not necessary when this flag is used. import -a, -import-all Import all targets typed into standard input or redirected from a file. Examples Sub-command Usage Explanation set newt target set myblinky compiler=arm-none-eabi-m4 Set the compiler for the 'myblinky' target to the gcc compiler for embedded ARM chips. unset newt target unset myblinky compiler Remove the setting for the compiler for the 'myblinky' target. delete newt target delete myblinky Delete the target description for the target named 'myblinky'. Note that it does not remove any binaries or clean out the directory for this target. create newt target create blink_f3disc Create a new target description by the name 'blink_f3disc'. The architectur
e is 'sim' by default and can be changed using subcommand 'set' above. show newt target show myblinky Show the target attributes set for 'myblinky' build newt target build blink_f3disc Compile the source code for the target named blink_f3disc and generate binaries that can be loaded into the target hardware. test newt target test test_target egg=libs/os Tests the egg named 'libs/os' against the target named 'test_target' export newt target export -a my_exports.txt Export all build targets from the current nest, and redirect output to a file named 'my_exports.txt'. export newt target export -export-all Export all build targets from the current nest, and print them to standard output on the screen. export newt target export my_target Export only target named 'my_target' and print it to standard output on the screen. import newt target import ex_tgt_1 exported_targets.txt Imports the target configuration for 'ex_tgt_1' in 'exported_targets.txt'.
import newt target import -a in_targets.txt Imports all the targets specified in the file named in_targets.txt A sample file is shown after this table. size newt target size blink_nordic Inspects and lists the RAM and Flash memory use by each component (object files and libraries) of the target. download newt target -v -lVERBOSE download blinky Downloads blinky.elf.bin to the hardware in verbose mode with logging turned on at VERBOSE level. debug newt target debug blinky Downloads blinky.elf.bin to the hardware, opens up a gdb session with blinky.elf in the terminal, and halts for further input in gdb. Example content for in_targets.txt file used for importing targets test3 and test4 . @target=test3 \nproject=blinked \narch=sim \ncompiler_def=debug \ncompiler=arm-none-eabi-m4 \n@target=test4 \nproject=super_blinky \narch=sim \ncompiler_def=debug \ncompiler=arm-none-eabi-m4 \n@endtargets",
"title": "Command List"
},
{
@@ -467,27 +467,27 @@
},
{
"location": "/os/memory_pool/",
- "text": "Memory Pools\n\n\nInsert synopsis here\n\n\nDescription\n\n\nDescribe OS feature here \n\n\nData structures\n\n\nReplace this with the list of data structures used, why, any neat features\n\n\nList of Functions\n\n\n\n\nThe functions available in this OS feature are:\n\n\n\n\nos_mempool_init\n\n\nos_memblock_get\n\n\nadd the rest\n\n\n\n\nFunction Reference\n\n\n\n\n os_mempool_init\n\n\n os_error_t\n os_mempool_init(struct os_mempool *mp, int blocks, \n int block_size, void *membuf, char *name)\n\n\n\n\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nxx\n\n\nexplain argument xx\n\n\n\n\n\n\nyy\n\n\nexplain argument yy\n\n\n\n\n\n\n\n\nReturned values\n\n\nList any values returned.\nError codes?\n\n\nNotes\n\n\nAny special feature/special benefit that we want to tout. \nDoes it need to be used with some other specific functions?\nAny caveats to be careful about (e.g. high memory requirements).\n\n\nExample\
n\n\n\n\nInsert the code snippet here\n\n\n\n\n\n\n\n os_memblock_get\n\n\n \nInsert function callout here \n\n\n\n\n\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nxx\n\n\nexplain argument xx\n\n\n\n\n\n\nyy\n\n\nexplain argument yy\n\n\n\n\n\n\n\n\nReturned values\n\n\nList any values returned.\nError codes?\n\n\nNotes\n\n\nAny special feature/special benefit that we want to tout. \nDoes it need to be used with some other specific functions?\nAny caveats to be careful about (e.g. high memory requirements).\n\n\nExample\n\n\n\n\nInsert the code snippet here\n\n\n\n\n\n\n\n next_one \n\n\n \nInsert function callout here \n\n\n\n\n\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nxx\n\n\nexplain argument xx\n\n\n\n\n\n\nyy\n\n\nexplain argument yy\n\n\n\n\n\n\n\n\nReturned values\n\n\nList any values returned.\nError codes?\n\n\nNotes\n\n\nAny special feature/special benefit that we want to tout. \nDoes it need to be
used with some other specific functions?\nAny caveats to be careful about (e.g. high memory requirements).\n\n\nExample\n\n\n\n\nInsert the code snippet here",
+ "text": "Memory Pools\n\n\nMemory can be pre-allocated to a pool of fixed size elements.\n\n\nDescription\n\n\nSometimes it's useful to have several memory blocks of same size preallocated for specific use. E.g. you want to limit the amount of memory used for it, or you want to make sure that there is memory available when you ask for it.\n\n\nThis can be done using a memory pool. You allocate memory either statically or from heap, and then designate that memory to be used as storage for fixed size elements.\n\n\nPool will be initialized by calling \nos_mempool_init()\n. Element can be allocated from it with \nos_mempool_get()\n, and released back with \nos_mempool_put()\n.\n\n\nData structures\n\n\nstruct os_mempool {\n int mp_block_size;\n int mp_num_blocks;\n int mp_num_free;\n SLIST_HEAD(,os_memblock);\n char *name;\n};\n\n\n\n\n\n\n\n\n\n\nElement\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nmp_block_size\n\n\nSize of the memory blocks, in bytes\n\n\n\n\n\n\
nmp_num_blocks\n\n\nNumber of memory blocks in the pool\n\n\n\n\n\n\nmp_num_free\n\n\nNumber of free blocks left\n\n\n\n\n\n\nname\n\n\nName for the memory block\n\n\n\n\n\n\n\n\nList of Functions\n\n\n\n\nThe functions available in this OS feature are:\n\n\n\n\nos_mempool_init\n\n\nos_memblock_get\n\n\nos_memblock_put\n\n\nOS_MEMPOOL_BYTES\n\n\n\n\nFunction Reference\n\n\n\n\n os_mempool_init\n\n\nos_error_t os_mempool_init(struct os_mempool *mp, int blocks, int block_size, void *membuf, char *name)\n\n\n\n\nInitializes the memory pool. Memory pointed by \nmembuf\n is taken and \nblocks\n number of elements of size \nblock_size\n are added to the pool. \nname\n is optional, and names the memory pool.\n\n\nIt is assumed that the amount of memory pointed by \nmembuf\n has at least \nOS_MEMPOOL_BYTES(blocks, block_size)\n number of bytes.\n\n\nname\n is not copied, so caller should make sure that the memory does not get reused.\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescriptio
n\n\n\n\n\n\n\n\n\n\n\nmp\n\n\nMemory pool being initialized\n\n\n\n\n\n\nblocks\n\n\nNumber of elements in the pool\n\n\n\n\n\n\nblock_size\n\n\nSize of an individual element in pool\n\n\n\n\n\n\nmembuf\n\n\nBacking store for the memory pool elements\n\n\n\n\n\n\nname\n\n\nName of the memory pool\n\n\n\n\n\n\n\n\nReturned values\n\n\nOS_OK: operation was successful.\nOS_INVALID_PARAM: invalid parameters. Block count or block size was negative, or membuf or mp was NULL.\nOS_MEM_NOT_ALIGNED: membuf has to be aligned to 4 byte boundary.\n\n\nNotes\n\n\nNote that os_mempool_init() does not allocate backing storage. \nmembuf\n has to be allocated by the caller.\n\n\nIt's recommended that you use \nOS_MEMPOOL_BYTES()\n to figure out how much memory to allocate for the pool.\n\n\nExample\n\n\n\n\n rc = os_mempool_init(\nnffs_file_pool, nffs_config.nc_num_files,\n sizeof (struct nffs_file), nffs_file_mem,\n \nnffs_file_pool\n);\n if (rc
!= 0) {\n return FS_EOS;\n }\n\n\n\n\n\n\n\n os_memblock_get\n\n\nvoid *os_memblock_get(struct os_mempool *mp)\n\n\n\n\nAllocate an element from the memory pool. If succesful, you'll get a pointer to allocated element. If there are no elements available, you'll get NULL as response.\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nmp\n\n\nPool where element is getting allocated from\n\n\n\n\n\n\n\n\nReturned values\n\n\nNULL: no elements available.\n\n: pointer to allocated element.\n\n\nNotes\n\n\nExample\n\n\n\n\n struct nffs_file *file;\n\n file = os_memblock_get(\nnffs_file_pool);\n if (file != NULL) {\n memset(file, 0, sizeof *file);\n }\n\n\n\n\n\n\n\nos_memblock_put\n\n\nos_error_t os_memblock_put(struct os_mempool *mp, void *block_addr)\n\n\n\n\nReleases previously allocated element back to the pool.\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nmp\n\n\nPointer to memory pool where
element is put\n\n\n\n\n\n\nblock_addr\n\n\nPointer to element getting freed\n\n\n\n\n\n\n\n\nReturned values\n\n\nOS_OK: operation was a success:\nOS_INVALID_PARAM: If either mp or block_addr were NULL.\n\n\nNotes\n\n\nExample\n\n\n\n\n if (file != NULL) {\n rc = os_memblock_put(\nnffs_file_pool, file);\n if (rc != 0) {\n return FS_EOS;\n }\n }\n\n\n\n\n\n\nOS_MEMPOOL_BYTES\n\n\nOS_MEMPOOL_BYTES(n,blksize)\n\n\n\n\nCalculates how many bytes of memory is used by \nn\n number of elements, when individual element size is \nblksize\n bytes.\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nn\n\n\nNumber of elements\n\n\n\n\n\n\nblksize\n\n\nSize of an element is number of bytes\n\n\n\n\n\n\n\n\nReturned values\n\n\nList any values returned.\nError codes?\n\n\nNotes\n\n\nExample\n\n\nHere we allocate memory to be used as a pool.\n\n\nvoid *nffs_file_mem;\n\nnffs_file_mem = malloc(\n OS_MEMPOOL_BYTES(nffs_config.
nc_num_files, sizeof (struct nffs_file)));\n if (nffs_file_mem == NULL) {\n return FS_ENOMEM;\n }",
"title": "Memory Pools"
},
{
"location": "/os/memory_pool/#memory-pools",
- "text": "Insert synopsis here",
+ "text": "Memory can be pre-allocated to a pool of fixed size elements.",
"title": "Memory Pools"
},
{
"location": "/os/memory_pool/#description",
- "text": "Describe OS feature here",
+ "text": "Sometimes it's useful to have several memory blocks of same size preallocated for specific use. E.g. you want to limit the amount of memory used for it, or you want to make sure that there is memory available when you ask for it. This can be done using a memory pool. You allocate memory either statically or from heap, and then designate that memory to be used as storage for fixed size elements. Pool will be initialized by calling os_mempool_init() . Element can be allocated from it with os_mempool_get() , and released back with os_mempool_put() .",
"title": "Description"
},
{
"location": "/os/memory_pool/#data-structures",
- "text": "Replace this with the list of data structures used, why, any neat features",
+ "text": "struct os_mempool {\n int mp_block_size;\n int mp_num_blocks;\n int mp_num_free;\n SLIST_HEAD(,os_memblock);\n char *name;\n}; Element Description mp_block_size Size of the memory blocks, in bytes mp_num_blocks Number of memory blocks in the pool mp_num_free Number of free blocks left name Name for the memory block",
"title": "Data structures"
},
{
"location": "/os/memory_pool/#list-of-functions",
- "text": "The functions available in this OS feature are: os_mempool_init os_memblock_get add the rest",
+ "text": "The functions available in this OS feature are: os_mempool_init os_memblock_get os_memblock_put OS_MEMPOOL_BYTES",
"title": "List of Functions"
},
{
@@ -497,42 +497,47 @@
},
{
"location": "/os/memory_pool/#os_mempool_init",
- "text": "os_error_t\n os_mempool_init(struct os_mempool *mp, int blocks, \n int block_size, void *membuf, char *name) Arguments Arguments Description xx explain argument xx yy explain argument yy Returned values List any values returned.\nError codes? Notes Any special feature/special benefit that we want to tout. \nDoes it need to be used with some other specific functions?\nAny caveats to be careful about (e.g. high memory requirements). Example Insert the code snippet here",
+ "text": "os_error_t os_mempool_init(struct os_mempool *mp, int blocks, int block_size, void *membuf, char *name) Initializes the memory pool. Memory pointed by membuf is taken and blocks number of elements of size block_size are added to the pool. name is optional, and names the memory pool. It is assumed that the amount of memory pointed by membuf has at least OS_MEMPOOL_BYTES(blocks, block_size) number of bytes. name is not copied, so caller should make sure that the memory does not get reused. Arguments Arguments Description mp Memory pool being initialized blocks Number of elements in the pool block_size Size of an individual element in pool membuf Backing store for the memory pool elements name Name of the memory pool Returned values OS_OK: operation was successful.\nOS_INVALID_PARAM: invalid parameters. Block count or block size was negative, or membuf or mp was NULL.\nOS_MEM_NOT_ALIGNED: membuf has to be aligned to
4 byte boundary. Notes Note that os_mempool_init() does not allocate backing storage. membuf has to be allocated by the caller. It's recommended that you use OS_MEMPOOL_BYTES() to figure out how much memory to allocate for the pool. Example rc = os_mempool_init( nffs_file_pool, nffs_config.nc_num_files,\n sizeof (struct nffs_file), nffs_file_mem,\n nffs_file_pool );\n if (rc != 0) {\n return FS_EOS;\n }",
"title": " os_mempool_init"
},
{
"location": "/os/memory_pool/#os_memblock_get",
- "text": "Insert function callout here Arguments Arguments Description xx explain argument xx yy explain argument yy Returned values List any values returned.\nError codes? Notes Any special feature/special benefit that we want to tout. \nDoes it need to be used with some other specific functions?\nAny caveats to be careful about (e.g. high memory requirements). Example Insert the code snippet here",
+ "text": "void *os_memblock_get(struct os_mempool *mp) Allocate an element from the memory pool. If succesful, you'll get a pointer to allocated element. If there are no elements available, you'll get NULL as response. Arguments Arguments Description mp Pool where element is getting allocated from Returned values NULL: no elements available. : pointer to allocated element. Notes Example struct nffs_file *file;\n\n file = os_memblock_get( nffs_file_pool);\n if
<TRUNCATED>
[3/5] incubator-mynewt-site git commit: push Marko's documentation
and filesystem documentation
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/modules/baselibc/index.html
----------------------------------------------------------------------
diff --git a/modules/baselibc/index.html b/modules/baselibc/index.html
new file mode 100644
index 0000000..d5d72fc
--- /dev/null
+++ b/modules/baselibc/index.html
@@ -0,0 +1,441 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/modules/baselibc/">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>Baselibc library - Mynewt Testing</title>
+
+ <link href="../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/custom.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="Baselibc library">
+
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="logo-container">
+ <img src="http://mynewt.incubator.apache.org/img/logo.svg">
+ </div>
+ <div class="container-fluid">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="http://mynewt.incubator.apache.org/">Home</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/documentation/">Docs</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/download/">Download</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/community/">Community</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container-fluid">
+
+ <div class="row sm-extra-padding">
+ <div class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
+ <div class="sidebar-top">
+ <img class="hidden-xs hidden-sm logo-small" src="http://mynewt.incubator.apache.org/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div class="small" role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" placeholder="Search documentation" />
+ <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="nav bs-sidenav">
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="main"><a href="../../get_started/newt_concepts/">Chapter 1 - Get Started</a></li>
+
+
+
+
+ <li class="main"><a href="../../get_acclimated/vocabulary/">Chapter 2 - Get Acclimated</a></li>
+
+
+
+
+ <li class="main"><a href="../../newt/newt_ops/">Chapter 3 - Newt Tool</a></li>
+
+
+
+
+ <li class="main"><a href="../../os/mynewt_os/">Chapter 4 - Mynewt OS</a></li>
+
+
+
+
+ <li class="main"><a href="../console/">Chapter 5 - Modules</a></li>
+
+ <ul class="current-toc">
+
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
+
+
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
+
+
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
+
+
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
+
+
+ <li class="toctree-l2"><a href="../nffs/">Newtron File System</a></li>
+
+
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
+
+
+ <li class="toctree-l2"><a href="../imgmgr/">Image Manager</a></li>
+
+
+ <li class="toctree-l2"><a href="./">Baselibc library</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#how-to-switch-to-baselibc">How to switch to baselibc</a></li>
+
+ <li class="toctree-l3"><a href="#stdout_write"> stdout_write </a></li>
+
+
+
+
+ <li class="toctree-l2"><a href="../elua/">Embedded Lua</a></li>
+
+
+ <li class="toctree-l2"><a href="../json/">JSON</a></li>
+
+
+ </ul>
+
+
+
+
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9 documentation-viewer" role="main">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Chapter 5 - Modules »</li>
+
+
+
+ <li>Baselibc library</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <h1 id="baselibc">Baselibc<a class="headerlink" href="#baselibc" title="Permanent link">¶</a></h1>
+<p>baselibc is a very simple libc for embedded systems geared primarily for 32-bit microcontrollers in the 10-100kB memory range. The library of basic system calls and facilities compiles to less than 5kB total on Cortex-M3, and much less if some functions aren't used.</p>
+<p>The code is based on klibc and tinyprintf modules, and licensed under the BSD license.</p>
+<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
+<p>Mynewt Os comes bundled with libc (the standard C library). However, you may choose to replace libc functions with baselibc ones for a reduced image size.</p>
+<h2 id="how-to-switch-to-baselibc">How to switch to baselibc<a class="headerlink" href="#how-to-switch-to-baselibc" title="Permanent link">¶</a></h2>
+<p>In order to switch from using libc to using baselibc you have to add the baselibc egg as dependency in the project egg. Specifying this dependency ensures that the linker first looks for the functions in baselibc before falling back to libc while creating the executable. For example, project <code>boot</code> uses baselibc. Its project description file <code>boot.yml</code> looks like the following:</p>
+<pre><code class="no-highlight"> project.name: boot
+ project.identities: bootloader
+ project.eggs:
+ - libs/os
+ - libs/bootutil
+ - libs/nffs
+ - libs/console/stub
+ - libs/util
+ - libs/baselibc
+ ```
+
+## List of Functions
+
+The functions available in this OS feature are listed below. Documentation is available in the form of on-line manual pages or at [https://www.freebsd.org/cgi/man.cgi](#https://www.freebsd.org/cgi/man.cgi). `mynewt.c` adds two new functions listed in the Function reference section.
+
+* asprintf.c
+* atoi.c
+* atol.c
+* atoll.c
+* bsearch.c
+* bzero.c
+* calloc.c
+* fgets.c
+* inline.c
+* jrand48.c
+* lrand48.c
+* malloc.c
+* malloc.h
+* memccpy.c
+* memchr.c
+* memcmp.c
+* memcpy.c
+* memfile.c
+* memmem.c
+* memmove.c
+* memrchr.c
+* memset.c
+* memswap.c
+* mrand48.c
+* mynewt.c
+* nrand48.c
+* qsort.c
+* realloc.c
+* sprintf.c
+* srand48.c
+* sscanf.c
+* strcasecmp.c
+* strcat.c
+* strchr.c
+* strcmp.c
+* strcpy.c
+* strcspn.c
+* strdup.c
+* strlcat.c
+* strlcpy.c
+* strlen.c
+* strncasecmp.c
+* strncat.c
+* strncmp.c
+* strncpy.c
+* strndup.c
+* strnlen.c
+* strntoimax.c
+* strntoumax.c
+* strpbrk.c
+* strrchr.c
+* strsep.c
+* strspn.c
+* strstr.c
+* strtoimax.c
+* strtok.c
+* strtok_r.c
+* strtol.c
+* strtoll.c
+* strtoul.c
+* strtoull.c
+* strtoumax.c
+* templates
+* test
+* tinyprintf.c
+* vasprintf.c
+* vprintf.c
+* vsprintf.c
+* vsscanf.c
+
+## Function Reference
+
+------------------
+
+## <font color="F2853F" style="font-size:24pt"> stdin_read </font>
+
+```no-highlight
+ static size_t
+ stdin_read(FILE *fp, char *bp, size_t n)
+</code></pre>
+
+<p>Read from a file.</p>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>fp</td>
+<td>pointer to the input file</td>
+</tr>
+<tr>
+<td>bp</td>
+<td>pointer to the string to be read</td>
+</tr>
+<tr>
+<td>n</td>
+<td>size of buffer (number of characters) to be read</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>N/A</p>
+<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<p>N/A</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 class="no-highlight"><Insert the code snippet here>
+</code></pre>
+
+<hr />
+<h2 id="stdout_write"><font color="#F2853F" style="font-size:24pt"> stdout_write </font><a class="headerlink" href="#stdout_write" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static size_t
+ stdout_write(FILE *fp, const char *bp, size_t n)
+</code></pre>
+
+<p>Write to a file or console. </p>
+<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>fp</td>
+<td>pointer to the output file</td>
+</tr>
+<tr>
+<td>bp</td>
+<td>pointer to the string to be written</td>
+</tr>
+<tr>
+<td>n</td>
+<td>size of buffer (number of characters) to be output</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4>
+<p>N/A</p>
+<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
+<p>N/A</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 class="no-highlight"><Insert the code snippet here>
+</code></pre>
+
+<hr />
+
+ </div>
+ </div>
+
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="http://mynewt.incubator.apache.org/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="http://mynewt.incubator.apache.org/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script src="../../js/base.js"></script>
+ <script src="../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/modules/bootloader/index.html
----------------------------------------------------------------------
diff --git a/modules/bootloader/index.html b/modules/bootloader/index.html
index 93dceb4..672c93f 100644
--- a/modules/bootloader/index.html
+++ b/modules/bootloader/index.html
@@ -171,15 +171,35 @@
<li class="toctree-l2"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../nffs/">Newtron File System</a></li>
+
+
<li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../imgmgr/">Image Manager</a></li>
+
+
+ <li class="toctree-l2"><a href="../baselibc/">Baselibc library</a></li>
+
+
+ <li class="toctree-l2"><a href="../elua/">Embedded Lua</a></li>
+
+
+ <li class="toctree-l2"><a href="../json/">JSON</a></li>
+
+
</ul>
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/modules/console/index.html
----------------------------------------------------------------------
diff --git a/modules/console/index.html b/modules/console/index.html
index fb0be1d..fa42eee 100644
--- a/modules/console/index.html
+++ b/modules/console/index.html
@@ -189,15 +189,35 @@
<li class="toctree-l2"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../nffs/">Newtron File System</a></li>
+
+
<li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../imgmgr/">Image Manager</a></li>
+
+
+ <li class="toctree-l2"><a href="../baselibc/">Baselibc library</a></li>
+
+
+ <li class="toctree-l2"><a href="../elua/">Embedded Lua</a></li>
+
+
+ <li class="toctree-l2"><a href="../json/">JSON</a></li>
+
+
</ul>
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/modules/elua/index.html
----------------------------------------------------------------------
diff --git a/modules/elua/index.html b/modules/elua/index.html
new file mode 100644
index 0000000..fc9edef
--- /dev/null
+++ b/modules/elua/index.html
@@ -0,0 +1,401 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/modules/elua/">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>Embedded Lua - Mynewt Testing</title>
+
+ <link href="../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/custom.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="Embedded Lua">
+
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="logo-container">
+ <img src="http://mynewt.incubator.apache.org/img/logo.svg">
+ </div>
+ <div class="container-fluid">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="http://mynewt.incubator.apache.org/">Home</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/documentation/">Docs</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/download/">Download</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/community/">Community</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container-fluid">
+
+ <div class="row sm-extra-padding">
+ <div class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
+ <div class="sidebar-top">
+ <img class="hidden-xs hidden-sm logo-small" src="http://mynewt.incubator.apache.org/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div class="small" role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" placeholder="Search documentation" />
+ <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="nav bs-sidenav">
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="main"><a href="../../get_started/newt_concepts/">Chapter 1 - Get Started</a></li>
+
+
+
+
+ <li class="main"><a href="../../get_acclimated/vocabulary/">Chapter 2 - Get Acclimated</a></li>
+
+
+
+
+ <li class="main"><a href="../../newt/newt_ops/">Chapter 3 - Newt Tool</a></li>
+
+
+
+
+ <li class="main"><a href="../../os/mynewt_os/">Chapter 4 - Mynewt OS</a></li>
+
+
+
+
+ <li class="main"><a href="../console/">Chapter 5 - Modules</a></li>
+
+ <ul class="current-toc">
+
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
+
+
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
+
+
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
+
+
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
+
+
+ <li class="toctree-l2"><a href="../nffs/">Newtron File System</a></li>
+
+
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
+
+
+ <li class="toctree-l2"><a href="../imgmgr/">Image Manager</a></li>
+
+
+ <li class="toctree-l2"><a href="../baselibc/">Baselibc library</a></li>
+
+
+ <li class="toctree-l2"><a href="./">Embedded Lua</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-l2"><a href="../json/">JSON</a></li>
+
+
+ </ul>
+
+
+
+
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9 documentation-viewer" role="main">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Chapter 5 - Modules »</li>
+
+
+
+ <li>Embedded Lua</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <h1 id="bootloader">Bootloader<a class="headerlink" href="#bootloader" title="Permanent link">¶</a></h1>
+<p>Insert synopsis here</p>
+<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
+<p>Describe module here, special features, how pieces fit together etc.</p>
+<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><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="#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 />
+<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>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+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 class="no-highlight"><Insert the code snippet here>
+</code></pre>
+
+<hr />
+<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>
+<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+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 class="no-highlight"><Insert the code snippet here>
+</code></pre>
+
+<hr />
+<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>
+<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+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 class="no-highlight"><Insert the code snippet here>
+</code></pre>
+
+<hr />
+
+ </div>
+ </div>
+
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="http://mynewt.incubator.apache.org/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="http://mynewt.incubator.apache.org/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script src="../../js/base.js"></script>
+ <script src="../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/modules/filesystem/index.html
----------------------------------------------------------------------
diff --git a/modules/filesystem/index.html b/modules/filesystem/index.html
index 3d9609f..5ad5598 100644
--- a/modules/filesystem/index.html
+++ b/modules/filesystem/index.html
@@ -162,24 +162,44 @@
<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="#fs_ls_file"> fs_ls_file </a></li>
- <li class="toctree-l3"><a href="#nffs_unlock"> nffs_unlock </a></li>
+ <li class="toctree-l3"><a href="#fs_ls_dir"> fs_ls_dir </a></li>
<li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+ <li class="toctree-l2"><a href="../nffs/">Newtron File System</a></li>
+
+
<li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../imgmgr/">Image Manager</a></li>
+
+
+ <li class="toctree-l2"><a href="../baselibc/">Baselibc library</a></li>
+
+
+ <li class="toctree-l2"><a href="../elua/">Embedded Lua</a></li>
+
+
+ <li class="toctree-l2"><a href="../json/">JSON</a></li>
+
+
</ul>
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
@@ -210,24 +230,34 @@
</div>
<h1 id="filesystem">Filesystem<a class="headerlink" href="#filesystem" title="Permanent link">¶</a></h1>
-<p>Insert synopsis here</p>
+<p>Mynewt provides a Flash File System abstraction layer (fs) to allow you to swap out the default Newtron File System (nffs) with a different file system of your choice. </p>
<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
-<p>Describe module here, special features, how pieces fit together etc.</p>
+<p>The default file system used in the Mynewt OS is the Newtron Flash File System (nffs). Hence the <code>nffs</code> egg description lists <code>libs/fs</code> as a dependency. </p>
+<pre><code class="no-highlight">egg.name: libs/nffs
+egg.vers: 0.1
+egg.identities: NFFS
+egg.deps:
+ - libs/os
+ - libs/fs
+ - libs/testutil
+ - hw/hal
+</code></pre>
+
+<p>If the user wishes to use a different flash file system (say, "ownffs"), the directory containing "ownffs" code must include the <code>egg.yml</code> file with the dependency on <code>libs/fs</code> listed as shown above. "ownffs" uses the <code>libs/fs</code> API available in mynewt, thus eliminating the need to change other parts of the projec.</p>
<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><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="#nffs_lock">nffs_lock</a></li>
-<li><a href="#nffs_unlock">nffs_unlock</a></li>
+<li><a href="#fs_ls_file">fs_ls_file</a></li>
+<li><a href="#fs_ls_dir">fs_ls_dir</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 />
-<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>
+<h2 id="fs_ls_file"><font color="F2853F" style="font-size:24pt"> fs_ls_file </font><a class="headerlink" href="#fs_ls_file" title="Permanent link">¶</a></h2>
<pre><code class="no-highlight"> static void
- nffs_lock(void)
+ fs_ls_file(const char *name, struct fs_file *file)
</code></pre>
@@ -242,12 +272,12 @@
</thead>
<tbody>
<tr>
-<td>xx</td>
-<td>explain argument xx</td>
+<td>name</td>
+<td>explain argument</td>
</tr>
<tr>
-<td>yy</td>
-<td>explain argument yy</td>
+<td>file</td>
+<td>explain argument</td>
</tr>
</tbody>
</table>
@@ -266,8 +296,9 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
</code></pre>
<hr />
-<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 >
+<h2 id="fs_ls_dir"><font color="#F2853F" style="font-size:24pt"> fs_ls_dir </font><a class="headerlink" href="#fs_ls_dir" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
+ fs_ls_dir(const char *name)
</code></pre>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/modules/imgmgr/index.html
----------------------------------------------------------------------
diff --git a/modules/imgmgr/index.html b/modules/imgmgr/index.html
new file mode 100644
index 0000000..142305f
--- /dev/null
+++ b/modules/imgmgr/index.html
@@ -0,0 +1,401 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/modules/imgmgr/">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>Image Manager - Mynewt Testing</title>
+
+ <link href="../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/custom.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="Image Manager">
+
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="logo-container">
+ <img src="http://mynewt.incubator.apache.org/img/logo.svg">
+ </div>
+ <div class="container-fluid">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="http://mynewt.incubator.apache.org/">Home</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/documentation/">Docs</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/download/">Download</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/community/">Community</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container-fluid">
+
+ <div class="row sm-extra-padding">
+ <div class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
+ <div class="sidebar-top">
+ <img class="hidden-xs hidden-sm logo-small" src="http://mynewt.incubator.apache.org/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div class="small" role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" placeholder="Search documentation" />
+ <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="nav bs-sidenav">
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="main"><a href="../../get_started/newt_concepts/">Chapter 1 - Get Started</a></li>
+
+
+
+
+ <li class="main"><a href="../../get_acclimated/vocabulary/">Chapter 2 - Get Acclimated</a></li>
+
+
+
+
+ <li class="main"><a href="../../newt/newt_ops/">Chapter 3 - Newt Tool</a></li>
+
+
+
+
+ <li class="main"><a href="../../os/mynewt_os/">Chapter 4 - Mynewt OS</a></li>
+
+
+
+
+ <li class="main"><a href="../console/">Chapter 5 - Modules</a></li>
+
+ <ul class="current-toc">
+
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
+
+
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
+
+
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
+
+
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
+
+
+ <li class="toctree-l2"><a href="../nffs/">Newtron File System</a></li>
+
+
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
+
+
+ <li class="toctree-l2"><a href="./">Image Manager</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-l2"><a href="../baselibc/">Baselibc library</a></li>
+
+
+ <li class="toctree-l2"><a href="../elua/">Embedded Lua</a></li>
+
+
+ <li class="toctree-l2"><a href="../json/">JSON</a></li>
+
+
+ </ul>
+
+
+
+
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9 documentation-viewer" role="main">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Chapter 5 - Modules »</li>
+
+
+
+ <li>Image Manager</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <h1 id="bootloader">Bootloader<a class="headerlink" href="#bootloader" title="Permanent link">¶</a></h1>
+<p>Insert synopsis here</p>
+<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
+<p>Describe module here, special features, how pieces fit together etc.</p>
+<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><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="#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 />
+<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>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+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 class="no-highlight"><Insert the code snippet here>
+</code></pre>
+
+<hr />
+<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>
+<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+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 class="no-highlight"><Insert the code snippet here>
+</code></pre>
+
+<hr />
+<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>
+<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+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 class="no-highlight"><Insert the code snippet here>
+</code></pre>
+
+<hr />
+
+ </div>
+ </div>
+
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="http://mynewt.incubator.apache.org/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="http://mynewt.incubator.apache.org/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script src="../../js/base.js"></script>
+ <script src="../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/modules/json/index.html
----------------------------------------------------------------------
diff --git a/modules/json/index.html b/modules/json/index.html
new file mode 100644
index 0000000..507fc5e
--- /dev/null
+++ b/modules/json/index.html
@@ -0,0 +1,401 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/modules/json/">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>JSON - Mynewt Testing</title>
+
+ <link href="../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/custom.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="JSON">
+
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="logo-container">
+ <img src="http://mynewt.incubator.apache.org/img/logo.svg">
+ </div>
+ <div class="container-fluid">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="http://mynewt.incubator.apache.org/">Home</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/documentation/">Docs</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/download/">Download</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/community/">Community</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container-fluid">
+
+ <div class="row sm-extra-padding">
+ <div class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
+ <div class="sidebar-top">
+ <img class="hidden-xs hidden-sm logo-small" src="http://mynewt.incubator.apache.org/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div class="small" role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" placeholder="Search documentation" />
+ <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="nav bs-sidenav">
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="main"><a href="../../get_started/newt_concepts/">Chapter 1 - Get Started</a></li>
+
+
+
+
+ <li class="main"><a href="../../get_acclimated/vocabulary/">Chapter 2 - Get Acclimated</a></li>
+
+
+
+
+ <li class="main"><a href="../../newt/newt_ops/">Chapter 3 - Newt Tool</a></li>
+
+
+
+
+ <li class="main"><a href="../../os/mynewt_os/">Chapter 4 - Mynewt OS</a></li>
+
+
+
+
+ <li class="main"><a href="../console/">Chapter 5 - Modules</a></li>
+
+ <ul class="current-toc">
+
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
+
+
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
+
+
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
+
+
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
+
+
+ <li class="toctree-l2"><a href="../nffs/">Newtron File System</a></li>
+
+
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
+
+
+ <li class="toctree-l2"><a href="../imgmgr/">Image Manager</a></li>
+
+
+ <li class="toctree-l2"><a href="../baselibc/">Baselibc library</a></li>
+
+
+ <li class="toctree-l2"><a href="../elua/">Embedded Lua</a></li>
+
+
+ <li class="toctree-l2"><a href="./">JSON</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>
+
+
+
+
+ </ul>
+
+
+
+
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9 documentation-viewer" role="main">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Chapter 5 - Modules »</li>
+
+
+
+ <li>JSON</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <h1 id="bootloader">Bootloader<a class="headerlink" href="#bootloader" title="Permanent link">¶</a></h1>
+<p>Insert synopsis here</p>
+<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
+<p>Describe module here, special features, how pieces fit together etc.</p>
+<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><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="#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 />
+<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>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+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 class="no-highlight"><Insert the code snippet here>
+</code></pre>
+
+<hr />
+<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>
+<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+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 class="no-highlight"><Insert the code snippet here>
+</code></pre>
+
+<hr />
+<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>
+<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+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 class="no-highlight"><Insert the code snippet here>
+</code></pre>
+
+<hr />
+
+ </div>
+ </div>
+
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="http://mynewt.incubator.apache.org/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="http://mynewt.incubator.apache.org/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script src="../../js/base.js"></script>
+ <script src="../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
[5/5] incubator-mynewt-site git commit: push Marko's documentation
and filesystem documentation
Posted by ad...@apache.org.
push Marko's documentation and filesystem documentation
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/b9c5b00c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/b9c5b00c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/b9c5b00c
Branch: refs/heads/asf-site
Commit: b9c5b00c47bfacf9aceb4d100336d6663db9bab8
Parents: 1c39271
Author: aditihilbert <ad...@runtime.io>
Authored: Fri Jan 15 00:35:42 2016 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Fri Jan 15 00:35:42 2016 -0800
----------------------------------------------------------------------
documentation/index.html | 48 +-
get_acclimated/project2/index.html | 7 +-
get_acclimated/project3/index.html | 7 +-
get_acclimated/vocabulary/index.html | 7 +-
get_started/how_to_edit_docs/index.html | 7 +-
get_started/newt_concepts/index.html | 7 +-
get_started/project1/index.html | 7 +-
get_started/try_markdown/index.html | 7 +-
mkdocs/search_index.json | 393 ++++++++++++--
modules/baselibc/index.html | 441 +++++++++++++++
modules/bootloader/index.html | 22 +-
modules/console/index.html | 22 +-
modules/elua/index.html | 401 ++++++++++++++
modules/filesystem/index.html | 63 ++-
modules/imgmgr/index.html | 401 ++++++++++++++
modules/json/index.html | 401 ++++++++++++++
modules/nffs/index.html | 771 +++++++++++++++++++++++++++
modules/shell/index.html | 22 +-
modules/testutil/index.html | 22 +-
newt/newt_ops/index.html | 51 +-
newt/newt_tool_reference/index.html | 121 +++--
newtmgr/overview/index.html | 246 +++++++++
newtmgr/project-slinky/index.html | 246 +++++++++
newtmgr/protocol/index.html | 246 +++++++++
os/callout/index.html | 247 +++++++--
os/context_switch/index.html | 7 +-
os/event_queue/index.html | 9 +-
os/heap/index.html | 101 ++--
os/mbufs/index.html | 7 +-
os/memory_pool/index.html | 197 +++++--
os/mutex/index.html | 7 +-
os/mynewt_os/index.html | 7 +-
os/port_os/index.html | 7 +-
os/sanity/index.html | 7 +-
os/semaphore/index.html | 7 +-
os/task/index.html | 7 +-
os/time/index.html | 7 +-
packaging/dist/index.html | 9 +-
search.html | 7 +-
sitemap.xml | 118 ++--
40 files changed, 4375 insertions(+), 342 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/documentation/index.html
----------------------------------------------------------------------
diff --git a/documentation/index.html b/documentation/index.html
index 59683db..7eda1fe 100644
--- a/documentation/index.html
+++ b/documentation/index.html
@@ -290,9 +290,53 @@
</li>
<li class="">
+ <a href="../modules/nffs/">Newtron File System</a>
+ </li>
+
+ <li class="">
<a href="../modules/testutil/">Test Utilities</a>
</li>
+ <li class="">
+ <a href="../modules/imgmgr/">Image Manager</a>
+ </li>
+
+ <li class="">
+ <a href="../modules/baselibc/">Baselibc library</a>
+ </li>
+
+ <li class="">
+ <a href="../modules/elua/">Embedded Lua</a>
+ </li>
+
+ <li class="">
+ <a href="../modules/json/">JSON</a>
+ </li>
+
+ </ul>
+
+ </div>
+
+
+
+ <div class="col-md-6 doc-section">
+ <div class="outline-title">Chapter 6 - Newt Manager</div>
+ <p></p>
+
+ <ul>
+
+ <li class="">
+ <a href="../newtmgr/overview/">Overview</a>
+ </li>
+
+ <li class="">
+ <a href="../newtmgr/protocol/">Protocol</a>
+ </li>
+
+ <li class="">
+ <a href="../newtmgr/project-slinky/">Project Slinky</a>
+ </li>
+
</ul>
</div>
@@ -300,8 +344,8 @@
<div class="col-md-6 doc-section">
- <div class="outline-title">Chapter 6 - Packaging it</div>
- <p>Packages for distribution delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.</p>
+ <div class="outline-title">Chapter 7 - Packaging it</div>
+ <p></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/get_acclimated/project2/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/project2/index.html b/get_acclimated/project2/index.html
index 9c88869..a7d008a 100644
--- a/get_acclimated/project2/index.html
+++ b/get_acclimated/project2/index.html
@@ -165,7 +165,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/get_acclimated/project3/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/project3/index.html b/get_acclimated/project3/index.html
index 8f635a7..3009b18 100644
--- a/get_acclimated/project3/index.html
+++ b/get_acclimated/project3/index.html
@@ -159,7 +159,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/get_acclimated/vocabulary/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/vocabulary/index.html b/get_acclimated/vocabulary/index.html
index 5b30756..c9476c2 100644
--- a/get_acclimated/vocabulary/index.html
+++ b/get_acclimated/vocabulary/index.html
@@ -175,7 +175,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/get_started/how_to_edit_docs/index.html
----------------------------------------------------------------------
diff --git a/get_started/how_to_edit_docs/index.html b/get_started/how_to_edit_docs/index.html
index 5a513e9..eed7a5b 100644
--- a/get_started/how_to_edit_docs/index.html
+++ b/get_started/how_to_edit_docs/index.html
@@ -184,7 +184,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/get_started/newt_concepts/index.html
----------------------------------------------------------------------
diff --git a/get_started/newt_concepts/index.html b/get_started/newt_concepts/index.html
index 4e1373e..0bc839e 100644
--- a/get_started/newt_concepts/index.html
+++ b/get_started/newt_concepts/index.html
@@ -170,7 +170,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/get_started/project1/index.html
----------------------------------------------------------------------
diff --git a/get_started/project1/index.html b/get_started/project1/index.html
index 2842d80..64ae07f 100644
--- a/get_started/project1/index.html
+++ b/get_started/project1/index.html
@@ -182,7 +182,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/get_started/try_markdown/index.html
----------------------------------------------------------------------
diff --git a/get_started/try_markdown/index.html b/get_started/try_markdown/index.html
index 03cc401..e9a6716 100644
--- a/get_started/try_markdown/index.html
+++ b/get_started/try_markdown/index.html
@@ -164,7 +164,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
[2/5] incubator-mynewt-site git commit: push Marko's documentation
and filesystem documentation
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/modules/nffs/index.html
----------------------------------------------------------------------
diff --git a/modules/nffs/index.html b/modules/nffs/index.html
new file mode 100644
index 0000000..d2893db
--- /dev/null
+++ b/modules/nffs/index.html
@@ -0,0 +1,771 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/modules/nffs/">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>Newtron File System - Mynewt Testing</title>
+
+ <link href="../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/custom.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="Newtron File System">
+
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="logo-container">
+ <img src="http://mynewt.incubator.apache.org/img/logo.svg">
+ </div>
+ <div class="container-fluid">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="http://mynewt.incubator.apache.org/">Home</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/documentation/">Docs</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/download/">Download</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/community/">Community</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container-fluid">
+
+ <div class="row sm-extra-padding">
+ <div class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
+ <div class="sidebar-top">
+ <img class="hidden-xs hidden-sm logo-small" src="http://mynewt.incubator.apache.org/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div class="small" role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" placeholder="Search documentation" />
+ <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="nav bs-sidenav">
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="main"><a href="../../get_started/newt_concepts/">Chapter 1 - Get Started</a></li>
+
+
+
+
+ <li class="main"><a href="../../get_acclimated/vocabulary/">Chapter 2 - Get Acclimated</a></li>
+
+
+
+
+ <li class="main"><a href="../../newt/newt_ops/">Chapter 3 - Newt Tool</a></li>
+
+
+
+
+ <li class="main"><a href="../../os/mynewt_os/">Chapter 4 - Mynewt OS</a></li>
+
+
+
+
+ <li class="main"><a href="../console/">Chapter 5 - Modules</a></li>
+
+ <ul class="current-toc">
+
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
+
+
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
+
+
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
+
+
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
+
+
+ <li class="toctree-l2"><a href="./">Newtron File System</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#disk-and-data-structures">Disk and data structures</a></li>
+
+ <li class="toctree-l3"><a href="#configuration">Configuration</a></li>
+
+ <li class="toctree-l3"><a href="#initialization">Initialization</a></li>
+
+ <li class="toctree-l3"><a href="#detection">Detection</a></li>
+
+ <li class="toctree-l3"><a href="#formatting">Formatting</a></li>
+
+ <li class="toctree-l3"><a href="#flash-writes">Flash writes</a></li>
+
+ <li class="toctree-l3"><a href="#garbage-collection">Garbage collection</a></li>
+
+ <li class="toctree-l3"><a href="#miscellaneous-measures">Miscellaneous measures</a></li>
+
+ <li class="toctree-l3"><a href="#future-enhancements">Future enhancements</a></li>
+
+
+
+
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
+
+
+ <li class="toctree-l2"><a href="../imgmgr/">Image Manager</a></li>
+
+
+ <li class="toctree-l2"><a href="../baselibc/">Baselibc library</a></li>
+
+
+ <li class="toctree-l2"><a href="../elua/">Embedded Lua</a></li>
+
+
+ <li class="toctree-l2"><a href="../json/">JSON</a></li>
+
+
+ </ul>
+
+
+
+
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9 documentation-viewer" role="main">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Chapter 5 - Modules »</li>
+
+
+
+ <li>Newtron File System</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <h1 id="newtron-flash-filesystem">Newtron Flash Filesystem<a class="headerlink" href="#newtron-flash-filesystem" title="Permanent link">¶</a></h1>
+<p>Mynewt comes with the flash file system called the Newtron Flash File System (nffs) which is designed with two priorities that makes it suitable for embedded use: </p>
+<ul>
+<li>Minimal RAM usage</li>
+<li>Reliability</li>
+</ul>
+<p>Mynewt also provides an abstraction layer API (fs) to allow you to swap out nffs with a different file system of your choice.</p>
+<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
+<p>Describe module here, special features, how pieces fit together etc.</p>
+<h2 id="disk-and-data-structures">Disk and data structures<a class="headerlink" href="#disk-and-data-structures" title="Permanent link">¶</a></h2>
+<p>At the top level, an nffs disk is partitioned into areas. An area is a region
+of disk with the following properties:</p>
+<ol>
+<li>An area can be fully erased without affecting any other areas.</li>
+<li>A write to one area does not restrict writes to other areas.</li>
+</ol>
+<p><strong>Note</strong>: Some flash hardware divides its memory space into "blocks." Writes within a block must be sequential, but writes to one block have no effect on what parts of other blocks can be written. Thus, for flash hardware with such a restriction, each area must comprise a discrete number of blocks.</p>
+<p>While not strictly necessary, it is recommended that all areas have the same
+size.</p>
+<p>On disk, each area is prefixed with the following header:</p>
+<pre><code class="no-highlight">/** On-disk representation of an area header. */
+struct nffs_disk_area {
+ uint32_t nda_magic[4]; /* NFFS_AREA_MAGIC{0,1,2,3} */
+ uint32_t nda_length; /* Total size of area, in bytes. */
+ uint8_t nda_ver; /* Current nffs version: 0 */
+ uint8_t nda_gc_seq; /* Garbage collection count. */
+ uint8_t reserved8;
+ uint8_t nda_id; /* 0xff if scratch area. */
+};
+</code></pre>
+
+<p>Beyond its header, an area contains a sequence of disk objects, representing
+the contents of the file system. There are two types of objects: <strong>inodes</strong> and
+<strong>data blocks</strong>. An inode represents a file or directory; a data block represents
+part of a file's contents.</p>
+<pre><code class="no-highlight">/** On-disk representation of an inode (file or directory). */
+struct nffs_disk_inode {
+ uint32_t ndi_magic; /* NFFS_INODE_MAGIC */
+ uint32_t ndi_id; /* Unique object ID. */
+ uint32_t ndi_seq; /* Sequence number; greater supersedes
+ lesser. */
+ uint32_t ndi_parent_id; /* Object ID of parent directory inode. */
+ uint8_t reserved8;
+ uint8_t ndi_filename_len; /* Length of filename, in bytes. */
+ uint16_t ndi_crc16; /* Covers rest of header and filename. */
+ /* Followed by filename. */
+};
+</code></pre>
+
+<p>An inode filename's length cannot exceed 256 bytes. The filename is not
+null-terminated. The following ASCII characters are not allowed in a
+filename:
+ * / (slash character)
+ * \0 (NUL character)</p>
+<pre><code class="no-highlight">/** On-disk representation of a data block. */
+struct nffs_disk_block {
+ uint32_t ndb_magic; /* NFFS_BLOCK_MAGIC */
+ uint32_t ndb_id; /* Unique object ID. */
+ uint32_t ndb_seq; /* Sequence number; greater supersedes lesser. */
+ uint32_t ndb_inode_id; /* Object ID of owning inode. */
+ uint32_t ndb_prev_id; /* Object ID of previous block in file;
+ NFFS_ID_NONE if this is the first block. */
+ uint16_t ndb_data_len; /* Length of data contents, in bytes. */
+ uint16_t ndb_crc16; /* Covers rest of header and data. */
+ /* Followed by 'ndb_data_len' bytes of data. */
+};
+</code></pre>
+
+<p>Each data block contains the ID of the previous data block in the file.
+Together, the set of blocks in a file form a reverse singly-linked list.</p>
+<p>The maximum number of data bytes that a block can contain is determined at
+initialization-time. The result is the greatest number which satisfies all of
+the following restrictions:
+ o No more than 2048.
+ o At least two maximum-sized blocks can fit in the smallest area.</p>
+<p>The 2048 number was chosen somewhat arbitrarily, and may change in the future.</p>
+<h3 id="id-space">ID space<a class="headerlink" href="#id-space" title="Permanent link">¶</a></h3>
+<p>All disk objects have a unique 32-bit ID. The ID space is partitioned as
+follows:
+ * 0x00000000 - 0x0fffffff: Directory inodes.
+ * 0x10000000 - 0x7fffffff: File inodes.
+ * 0x80000000 - 0xfffffffe: Data blocks.
+ * 0xffffffff : Reserved (NFFS_ID_NONE)</p>
+<h3 id="scratch-area">Scratch area<a class="headerlink" href="#scratch-area" title="Permanent link">¶</a></h3>
+<p>A valid nffs file system must contain a single "scratch area." The scratch
+area does not contain any objects of its own, and is only used during garbage
+collection. The scratch area must have a size greater than or equal to each
+of the other areas in flash.</p>
+<h3 id="ram-representation">RAM representation<a class="headerlink" href="#ram-representation" title="Permanent link">¶</a></h3>
+<p>Every object in the file system is stored in a 256-entry hash table. An
+object's hash key is derived from its 32-bit ID. Each list in the hash table
+is sorted by time of use; most-recently-used is at the front of the list. All
+objects are represented by the following structure:</p>
+<pre><code class="no-highlight">/**
+ * What gets stored in the hash table. Each entry represents a data block or
+ * an inode.
+ */
+struct nffs_hash_entry {
+ SLIST_ENTRY(nffs_hash_entry) nhe_next;
+ uint32_t nhe_id; /* 0 - 0x7fffffff if inode; else if block. */
+ uint32_t nhe_flash_loc; /* Upper-byte = area idx; rest = area offset. */
+};
+</code></pre>
+
+<p>For each data block, the above structure is all that is stored in RAM. To
+acquire more information about a data block, the block header must be read
+from flash.</p>
+<p>Inodes require a fuller RAM representation to capture the structure of the
+file system. There are two types of inodes: <strong>files</strong> and <strong>directories</strong>. Each
+inode hash entry is actually an instance of the following structure:</p>
+<pre><code class="no-highlight">/** Each inode hash entry is actually one of these. */
+struct nffs_inode_entry {
+ struct nffs_hash_entry nie_hash_entry;
+ SLIST_ENTRY(nffs_inode_entry) nie_sibling_next;
+ union {
+ struct nffs_inode_list nie_child_list; /* If directory */
+ struct nffs_hash_entry *nie_last_block_entry; /* If file */
+ };
+ uint8_t nie_refcnt;
+};
+</code></pre>
+
+<p>A directory inode contains a list of its child files and directories
+(fie_child_list). These entries are sorted alphabetically using the ASCII
+character set.</p>
+<p>A file inode contains a pointer to the last data block in the file
+(nie_last_block_entry). For most file operations, the reversed block list must
+be walked backwards. This introduces a number of speed inefficiencies:
+ * All data blocks must be read to determine the length of the file.
+ * Data blocks often need to be processed sequentially. The reversed
+ nature of the block list transforms this from linear time to an O(n^2)
+ operation.</p>
+<p>Furthermore, obtaining information about any constituent data block requires a
+separate flash read.</p>
+<h3 id="inode-cache-and-data-block-cache">Inode cache and Data Block cache<a class="headerlink" href="#inode-cache-and-data-block-cache" title="Permanent link">¶</a></h3>
+<p>The speed issues are addressed by a pair of caches. Cached inodes entries
+contain the file length and a much more convenient doubly-linked list of
+cached data blocks. The benefit of using caches is that the size of the
+caches need not be proportional to the size of the file system. In other
+words, caches can address speed efficiency concerns without negatively
+impacting the file system's scalability.</p>
+<p>nffs requires both caches during normal operation, so it is not possible to
+disable them. However, the cache sizes are configurable, and both caches can
+be configured with a size of one if RAM usage must be minimized.</p>
+<p>The following data structures are used in the inode and data block caches.</p>
+<pre><code class="no-highlight">/** Full data block representation; not stored permanently in RAM. */
+struct nffs_block {
+ struct nffs_hash_entry *nb_hash_entry; /* Points to real block entry. */
+ uint32_t nb_seq; /* Sequence number; greater
+ supersedes lesser. */
+ struct nffs_inode_entry *nb_inode_entry; /* Owning inode. */
+ struct nffs_hash_entry *nb_prev; /* Previous block in file. */
+ uint16_t nb_data_len; /* # of data bytes in block. */
+ uint16_t reserved16;
+};
+
+/** Represents a single cached data block. */
+struct nffs_cache_block {
+ TAILQ_ENTRY(nffs_cache_block) ncb_link; /* Next / prev cached block. */
+ struct nffs_block ncb_block; /* Full data block. */
+ uint32_t ncb_file_offset; /* File offset of this block. */
+};
+
+/** Full inode representation; not stored permanently in RAM. */
+struct nffs_inode {
+ struct nffs_inode_entry *ni_inode_entry; /* Points to real inode entry. */
+ uint32_t ni_seq; /* Sequence number; greater
+ supersedes lesser. */
+ struct nffs_inode_entry *ni_parent; /* Points to parent directory. */
+ uint8_t ni_filename_len; /* # chars in filename. */
+ uint8_t ni_filename[NFFS_SHORT_FILENAME_LEN]; /* First 3 bytes. */
+};
+
+/** Doubly-linked tail queue of cached blocks; contained in cached inodes. */
+TAILQ_HEAD(nffs_block_cache_list, nffs_block_cache_entry);
+
+/** Represents a single cached file inode. */
+struct nffs_cache_inode {
+ TAILQ_ENTRY(nffs_cache_inode) nci_link; /* Sorted; LRU at tail. */
+ struct nffs_inode nci_inode; /* Full inode. */
+ struct nffs_cache_block_list nci_block_list; /* List of cached blocks. */
+ uint32_t nci_file_size; /* Total file size. */
+};
+</code></pre>
+
+<p>Only file inodes are cached; directory inodes are never cached.</p>
+<p>Within a cached inode, all cached data blocks are contiguous. E.g., if the
+start and end of a file are cached, then the middle must also be cached. A
+data block is only cached if its owning file is also cached.</p>
+<p>Internally, cached inodes are stored in a singly-linked list, ordered by time
+of use. The most-recently-used entry is the first element in the list. If a
+new inode needs to be cached, but the inode cache is full, the
+least-recently-used entry is freed to make room for the new one. The
+following operations cause an inode to be cached:</p>
+<ul>
+<li>Querying a file's length.</li>
+<li>Seeking within a file.</li>
+<li>Reading from a file.</li>
+<li>Writing to a file.</li>
+</ul>
+<p>The following operations cause a data block to be cached:</p>
+<ul>
+<li>Reading from the block.</li>
+<li>Writing to the block.</li>
+</ul>
+<p>If one of the above operations is applied to a data block that is not currently
+cached, nffs uses the following procedure to cache the necessary block:</p>
+<ol>
+<li>If none of the owning inode's blocks are currently cached, allocate a
+ cached block entry corresponding to the requested block and insert it
+ into the inode's list.</li>
+<li>Else if the requested file offset is less than that of the first cached
+ block, bridge the gap between the inode's sequence of cached blocks and
+ the block that now needs to be cached. This is accomplished by caching
+ each block in the gap, finishing with the requested block.</li>
+<li>Else (the requested offset is beyond the end of the cache),
+ a. If the requested offset belongs to the block that immediately follows the end of the cache, cache the block and append it to the list.
+ b. Else, clear the cache, and populate it with the single entry corresponding to the requested block.</li>
+</ol>
+<p>If the system is unable to allocate a cached block entry at any point during
+the above procedure, the system frees up other blocks currently in the cache. This is accomplished as follows:</p>
+<ul>
+<li>Iterate the inode cache in reverse (i.e., start with the least-recently-used entry). For each entry:
+ a. If the entry's cached block list is empty, advance to the next entry.
+ b. Else, free all the cached blocks in the entry's list.</li>
+</ul>
+<p>Because the system imposes a minimum block cache size of one, the above
+procedure will always reclaim at least one cache block entry. The above
+procedure may result in the freeing of the block list that belongs to the very
+inode being operated on. This is OK, as the final block to get cached is
+always the block being requested.</p>
+<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">¶</a></h2>
+<p>The file system is configured by populating fields in a global structure.
+Each field in the structure corresponds to a setting. All configuration must
+be done prior to calling nffs_init(). The configuration structure is defined
+as follows:</p>
+<pre><code class="no-highlight">
+struct nffs_config {
+ /** Maximum number of inodes; default=1024. */
+ uint32_t nc_num_inodes;
+
+ /** Maximum number of data blocks; default=4096. */
+ uint32_t nc_num_blocks;
+
+ /** Maximum number of open files; default=4. */
+ uint32_t nc_num_files;
+
+ /** Inode cache size; default=4. */
+ uint32_t nc_num_cache_inodes;
+
+ /** Data block cache size; default=64. */
+ uint32_t nc_num_cache_blocks;
+ };
+
+extern struct nffs_config nffs_config;
+</code></pre>
+
+<p>Any fields that are set to 0 (or not set at all) inherit the corresponding
+default value. This means that it is impossible to configure any setting with
+a value of zero.</p>
+<h2 id="initialization">Initialization<a class="headerlink" href="#initialization" title="Permanent link">¶</a></h2>
+<p>There are two means of initializing an nffs file system:</p>
+<ol>
+<li>Restore an existing file system via detection.</li>
+<li>Create a new file system via formatting.</li>
+</ol>
+<p>Both methods require the user to describe how the flash memory is divided into
+areas. This is accomplished with an array of struct nffs_area_desc, defined as
+follows:</p>
+<pre><code class="no-highlight">struct nffs_area_desc {
+ uint32_t nad_offset; /* Flash offset of start of area. */
+ uint32_t nad_length; /* Size of area, in bytes. */
+};
+</code></pre>
+
+<p>An array of area descriptors is terminated by an entry with a fad_length field
+of 0.</p>
+<p>One common initialization sequence is the following:</p>
+<ol>
+<li>Detect an nffs file system anywhere in flash.</li>
+<li>If no file system detected, format a new file system in a specific
+ region of flash.</li>
+</ol>
+<h2 id="detection">Detection<a class="headerlink" href="#detection" title="Permanent link">¶</a></h2>
+<p>The file system detection process consists of scanning a specified set of
+flash regions for valid nffs areas, and then populating the RAM representation
+of the file system with the detected objects. Detection is initiated with the
+following function:</p>
+<pre><code class="no-highlight">/**
+ * Searches for a valid nffs file system among the specified areas. This
+ * function succeeds if a file system is detected among any subset of the
+ * supplied areas. If the area set does not contain a valid file system,
+ * a new one can be created via a separate call to nffs_format().
+ *
+ * @param area_descs The area set to search. This array must be
+ * terminated with a 0-length area.
+ *
+ * @return 0 on success;
+ * NFFS_ECORRUPT if no valid file system was detected;
+ * other nonzero on error.
+ */
+int nffs_detect(const struct nffs_area_desc *area_descs);
+</code></pre>
+
+<p>As indicated, not every area descriptor needs to reference a valid nffs area.
+Detection is successful as long as a complete file system is detected
+somewhere in the specified regions of flash. If an application is unsure
+where a file system might be located, it can initiate detection across the
+entire flash region.</p>
+<p>A detected file system is valid if:</p>
+<ol>
+<li>At least one non-scratch area is present.</li>
+<li>At least one scratch area is present (only the first gets used if there is more than one).</li>
+<li>The root directory inode is present.</li>
+</ol>
+<p>During detection, each indicated region of flash is checked for a valid area
+header. The contents of each valid non-scratch area are then restored into
+the nffs RAM representation. The following procedure is applied to each object
+in the area:</p>
+<ol>
+<li>
+<p>Verify the object's integrity via a crc16 check. If invalid, the object is discarded and the procedure restarts on the next object in the area.</p>
+</li>
+<li>
+<p>Convert the disk object into its corresponding RAM representation and insert it into the hash table. If the object is an inode, its reference count is initialized to 1, indicating ownership by its parent directory.</p>
+</li>
+<li>
+<p>If an object with the same ID is already present, then one supersedes the other. Accept the object with the greater sequence number and discard the other.</p>
+</li>
+<li>
+<p>If the object references a nonexistant inode (parent directory in the case of an inode; owning file in the case of a data block), insert a temporary "dummy" inode into the hash table so that inter-object links can be maintained until the absent inode is eventually restored. Dummy inodes are identified by a reference count of 0.</p>
+</li>
+<li>
+<p>If a delete record for an inode is encountered, the inode's parent pointer is set to null to indicate that it should be removed from RAM.</p>
+</li>
+</ol>
+<p>If nffs encounters an object that cannot be identified (i.e., its magic number
+is not valid), it scans the remainder of the flash area for the next valid
+magic number. Upon encountering a valid object, nffs resumes the procedure
+described above.</p>
+<p>After all areas have been restored, a sweep is performed across the entire RAM
+representation so that invalid inodes can be deleted from memory.</p>
+<p>For each directory inode:</p>
+<ul>
+<li>If its reference count is 0 (i.e., it is a dummy), migrate its children to the /lost+found directory, and delete it from the RAM representation. This should only happen in the case of file system corruption.</li>
+<li>If its parent reference is null (i.e., it was deleted), delete it and all its children from the RAM representation.</li>
+</ul>
+<p>For each file inode:</p>
+<ul>
+<li>If its reference count is 0 (i.e., it is a dummy), delete it from the RAM representation. This should only happen in the case of file system corruption. (We should try to migrate the file to the lost+found directory in this case, as mentioned in the todo section).</li>
+</ul>
+<p>When an object is deleted during this sweep, it is only deleted from the RAM
+representation; nothing is written to disk.</p>
+<p>When objects are migrated to the lost+found directory, their parent inode
+reference is permanently updated on the disk.</p>
+<p>In addition, a single scratch area is identified during the detection process.
+The first area whose 'fda_id' value is set to 0xff is designated as the file
+system scratch area. If no valid scratch area is found, the cause could be
+that the system was restarted while a garbage collection cycle was in progress.
+Such a condition is identified by the presence of two areas with the same ID.
+In such a case, the shorter of the two areas is erased and designated as the
+scratch area.</p>
+<h2 id="formatting">Formatting<a class="headerlink" href="#formatting" title="Permanent link">¶</a></h2>
+<p>A new file system is created via formatting. Formatting is achieved via the
+following function:</p>
+<pre><code class="no-highlight">/**
+ * Erases all the specified areas and initializes them with a clean nffs
+ * file system.
+ *
+ * @param area_descs The set of areas to format.
+ *
+ * @return 0 on success;
+ * nonzero on failure.
+ */
+int nffs_format(const struct nffs_area_desc *area_descs);
+</code></pre>
+
+<p>On success, an area header is written to each of the specified locations. The
+largest area in the set is designated as the initial scratch area.</p>
+<h2 id="flash-writes">Flash writes<a class="headerlink" href="#flash-writes" title="Permanent link">¶</a></h2>
+<p>The nffs implementation always writes in a strictly sequential fashion within an
+area. For each area, the system keeps track of the current offset. Whenever
+an object gets written to an area, it gets written to that area's current
+offset, and the offset is increased by the object's disk size.</p>
+<p>When a write needs to be performed, the nffs implementation selects the
+appropriate destination area by iterating though each area until one with
+sufficient free space is encountered.</p>
+<p>There is no write buffering. Each call to a write function results in a write
+operation being sent to the flash hardware.</p>
+<h3 id="new-objects">New objects<a class="headerlink" href="#new-objects" title="Permanent link">¶</a></h3>
+<p>Whenever a new object is written to disk, it is assigned the following
+properties:
+ * ID: A unique value is selected from the 32-bit ID space, as appropriate
+ for the object's type.
+ * Sequence number: 0</p>
+<p>When a new file or directory is created, a corresponding inode is written to
+flash. Likewise, a new data block also results in the writing of a
+corresponding disk object.</p>
+<h3 id="movingrenaming-files-and-directories">Moving/Renaming files and directories<a class="headerlink" href="#movingrenaming-files-and-directories" title="Permanent link">¶</a></h3>
+<p>When a file or directory is moved or renamed, its corresponding inode is
+rewritten to flash with the following properties:</p>
+<ul>
+<li>ID: Unchanged</li>
+<li>Sequence number: Previous value plus one.</li>
+<li>Parent inode: As specified by the move / rename operation.</li>
+<li>Filename: As specified by the move / rename operation.</li>
+</ul>
+<p>Because the inode's ID is unchanged, all dependent objects remain valid.</p>
+<h3 id="unlinking-files-and-directories">Unlinking files and directories<a class="headerlink" href="#unlinking-files-and-directories" title="Permanent link">¶</a></h3>
+<p>When a file or directory is unlinked from its parent directory, a deletion
+record for the unlinked inode gets written to flash. The deletion record is an
+inode with the following properties:</p>
+<ul>
+<li>ID: Unchanged</li>
+<li>Sequence number: Previous value plus one.</li>
+<li>Parent inode ID: NFFS_ID_NONE</li>
+</ul>
+<p>When an inode is unlinked, no deletion records need to be written for the
+inode's dependent objects (constituent data blocks or child inodes). During
+the next file system detection, it is recognized that the objects belong to
+a deleted inode, so they are not restored into the RAM representation.</p>
+<p>If a file has an open handle at the time it gets unlinked, application code
+can continued to use the file handle to read and write data. All files retain
+a reference count, and a file isn't deleted from the RAM representation until
+its reference code drops to 0. Any attempt to open an unlinked file fails,
+even if the file is referenced by other file handles.</p>
+<h3 id="writing-to-a-file">Writing to a file<a class="headerlink" href="#writing-to-a-file" title="Permanent link">¶</a></h3>
+<p>The following procedure is used whenever the application code writes to a file.
+First, if the write operation specifies too much data to fit into a single
+block, the operation is split into several separate write operations. Then,
+for each write operation:</p>
+<p>1. Determine which existing blocks the write operation overlaps (n = number of overwritten blocks).</p>
+<p>2. If n = 0, this is an append operation. Write a data block with the following properties:</p>
+<ul>
+<li>ID: New unique value.</li>
+<li>Sequence number: 0.</li>
+</ul>
+<p>3. Else (n > 1), this write overlaps existing data.</p>
+<p>(a) For each block in [1, 2, ... n-1], write a new block containing the updated contents. Each new block supersedes the block it overwrites. That is, each block has the following properties:</p>
+<ul>
+<li>ID: Unchanged</li>
+<li>Sequence number: Previous value plus one.</li>
+</ul>
+<p>(b) Write the nth block. The nth block includes all appended data, if any. As with the other blocks, its ID is unchanged and its sequence number is incremented.</p>
+<p>Appended data can only be written to the end of the file. That is, "holes" are
+not supported.</p>
+<h2 id="garbage-collection">Garbage collection<a class="headerlink" href="#garbage-collection" title="Permanent link">¶</a></h2>
+<p>When the file system is too full to accomodate a write operation, the system
+must perform garbage collection to make room. The garbage collection
+procedure is described below:</p>
+<ul>
+<li>
+<p>The non-scratch area with the lowest garbage collection sequence number is selected as the "source area." If there are other areas with the same sequence number, the one with the smallest flash offset is selected. </p>
+</li>
+<li>
+<p>The source area's ID is written to the scratch area's header, transforming it into a non-scratch ID. This former scratch area is now known as the "destination area."</p>
+</li>
+<li>
+<p>The RAM representation is exhaustively searched for collectible objects. The following procedure is applied to each inode in the system:</p>
+<ul>
+<li>If the inode is resident in the source area, copy the inode record to the destination area.</li>
+<li>If the inode is a file inode, walk the inode's list of data blocks, starting with the last block in the file. Each block that is resident in the source area is copied to the destination area. If there is a run of two or more blocks that are resident in the source area, they are consolidated and copied to the destination area as a single new block (subject to the maximum block size restriction).</li>
+</ul>
+</li>
+<li>
+<p>The source area is reformatted as a scratch sector (i.e., is is fully erased, and its header is rewritten with an ID of 0xff). The area's garbage collection sequence number is incremented prior to rewriting the header. This area is now the new scratch sector.</p>
+</li>
+</ul>
+<h2 id="miscellaneous-measures">Miscellaneous measures<a class="headerlink" href="#miscellaneous-measures" title="Permanent link">¶</a></h2>
+<ul>
+<li>
+<p>RAM usage:</p>
+<ul>
+<li>24 bytes per inode</li>
+<li>12 bytes per data block</li>
+<li>36 bytes per inode cache entry</li>
+<li>32 bytes per data block cache entry</li>
+</ul>
+</li>
+<li>
+<p>Maximum filename size: 256 characters (no null terminator required)</p>
+</li>
+<li>Disallowed filename characters: '/' and '\0'</li>
+</ul>
+<h2 id="future-enhancements">Future enhancements<a class="headerlink" href="#future-enhancements" title="Permanent link">¶</a></h2>
+<ul>
+<li>API function to traverse a directory.</li>
+<li>Migrate corrupt files to the /lost+found directory during restore, rather than discarding them from RAM.</li>
+<li>Error correction.</li>
+<li>Encryption.</li>
+<li>Compression.</li>
+</ul>
+
+ </div>
+ </div>
+
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="http://mynewt.incubator.apache.org/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="http://mynewt.incubator.apache.org/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script src="../../js/base.js"></script>
+ <script src="../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/modules/shell/index.html
----------------------------------------------------------------------
diff --git a/modules/shell/index.html b/modules/shell/index.html
index 179e269..75e41d6 100644
--- a/modules/shell/index.html
+++ b/modules/shell/index.html
@@ -171,15 +171,35 @@
<li class="toctree-l2"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../nffs/">Newtron File System</a></li>
+
+
<li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../imgmgr/">Image Manager</a></li>
+
+
+ <li class="toctree-l2"><a href="../baselibc/">Baselibc library</a></li>
+
+
+ <li class="toctree-l2"><a href="../elua/">Embedded Lua</a></li>
+
+
+ <li class="toctree-l2"><a href="../json/">JSON</a></li>
+
+
</ul>
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/modules/testutil/index.html
----------------------------------------------------------------------
diff --git a/modules/testutil/index.html b/modules/testutil/index.html
index 7c8884a..baea973 100644
--- a/modules/testutil/index.html
+++ b/modules/testutil/index.html
@@ -153,6 +153,9 @@
<li class="toctree-l2"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../nffs/">Newtron File System</a></li>
+
+
<li class="toctree-l2"><a href="./">Test Utilities</a></li>
@@ -174,12 +177,29 @@
+ <li class="toctree-l2"><a href="../imgmgr/">Image Manager</a></li>
+
+
+ <li class="toctree-l2"><a href="../baselibc/">Baselibc library</a></li>
+
+
+ <li class="toctree-l2"><a href="../elua/">Embedded Lua</a></li>
+
+
+ <li class="toctree-l2"><a href="../json/">JSON</a></li>
+
+
</ul>
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/newt/newt_ops/index.html
----------------------------------------------------------------------
diff --git a/newt/newt_ops/index.html b/newt/newt_ops/index.html
index c73acaa..f113ed4 100644
--- a/newt/newt_ops/index.html
+++ b/newt/newt_ops/index.html
@@ -156,7 +156,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
@@ -189,36 +194,38 @@
<h2 id="command-structure">Command Structure<a class="headerlink" href="#command-structure" title="Permanent link">¶</a></h2>
<p>In the newt tool, commands represent actions and flags are modifiers for those actions. A command can have children commands which are also simply referred to as commands. One or more arguments may need to be provided to a command to execute it correctly. </p>
<p>In the example below, the <code>newt</code> command has the child command <code>target set</code>. The first argument 'my_target1' is the name of the target whose attributes are being set. The second argument 'arch=cortex_m4' specifies the value to set the attribute (variable) 'arch' to, which in this case is 'cortex_m4'. </p>
-<pre><code>newt target set my_target1 arch=cortex_m4
+<pre><code class="no-highlight"> newt target set my_target1 arch=cortex_m4
</code></pre>
+
<p>Global flags work on all newt commands in the same way. An example is the flag <code>-v, --verbose</code> to ask for a verbose output while executing a command. The help flag <code>-h</code> or <code>--help</code> is available on all commands but provides command specific output, of course. These flags may be specified in either a long or a short form. </p>
<p>A command may additionally take flags specific to it. For example, the <code>-b</code> flag may be used with <code>newt egg install</code> to tell it which branch to install the egg from. </p>
-<pre><code>newt egg install -b <branchname> <eggname>
+<pre><code class="no-highlight"> newt egg install -b <branchname> <eggname>
</code></pre>
+
<p>In addition to the newt tool <a href="../newt_tool_reference/">reference</a> in this documentation set, command-line help is available for each command (and child command). Simply use the flag <code>-h</code> or <code>--help</code> as shown below:</p>
-<pre><code>$ newt target export --help
-Export build targets from the current nest, and print them to
-standard output. If the -a (or -export-all) option is specified,
-then all targets will be exported. Otherwise, <target-name>
-must be specified, and only that target will be exported.
+<pre><code class="no-highlight"> $ newt target export --help
+ Export build targets from the current nest, and print them to
+ standard output. If the -a (or -export-all) option is specified,
+ then all targets will be exported. Otherwise, <target-name>
+ must be specified, and only that target will be exported.
-Usage:
- newt target export [flags]
+ Usage:
+ newt target export [flags]
-Examples:
- newt target export [-a -export-all] [<target-name>]
- newt target export -a > my_exports.txt
- newt target export my_target > my_target_export.txt
+ Examples:
+ newt target export [-a -export-all] [<target-name>]
+ newt target export -a > my_exports.txt
+ newt target export my_target > my_target_export.txt
-Flags:
- -a, --export-all=false: If present, export all targets
- -h, --help=false: help for export
+ Flags:
+ -a, --export-all=false: If present, export all targets
+ -h, --help=false: help for export
-Global Flags:
- -l, --loglevel="WARN": Log level, defaults to WARN.
- -q, --quiet=false: Be quiet; only display error output.
- -s, --silent=false: Be silent; don't output anything.
- -v, --verbose=false: Enable verbose output when executing commands.
+ Global Flags:
+ -l, --loglevel="WARN": Log level, defaults to WARN.
+ -q, --quiet=false: Be quiet; only display error output.
+ -s, --silent=false: Be silent; don't output anything.
+ -v, --verbose=false: Enable verbose output when executing commands.
</code></pre>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/newt/newt_tool_reference/index.html
----------------------------------------------------------------------
diff --git a/newt/newt_tool_reference/index.html b/newt/newt_tool_reference/index.html
index 54be997..76c5e6b 100644
--- a/newt/newt_tool_reference/index.html
+++ b/newt/newt_tool_reference/index.html
@@ -168,7 +168,12 @@
- <li class="main"><a href="../../packaging/dist/">Chapter 6 - Packaging it</a></li>
+ <li class="main"><a href="../../newtmgr/overview/">Chapter 6 - Newt Manager</a></li>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
@@ -200,7 +205,7 @@
<h2 id="command-list">Command List<a class="headerlink" href="#command-list" title="Permanent link">¶</a></h2>
<h3 id="available-high-level-commands">Available high-level commands<a class="headerlink" href="#available-high-level-commands" title="Permanent link">¶</a></h3>
-<pre><code>version Display the Newt version number
+<pre><code class="no-highlight">version Display the Newt version number
help Help about any command
nest Commands to manage nests & clutches (remote egg repositories)
egg Commands to list and inspect eggs on a nest
@@ -209,14 +214,17 @@ target Set and view target information
<h3 id="version"><em>version</em><a class="headerlink" href="#version" title="Permanent link">¶</a></h3>
<h4 id="usage">Usage:<a class="headerlink" href="#usage" title="Permanent link">¶</a></h4>
-<pre><code>newt version [flags]
+<pre><code class="no-highlight"> newt version [flags]
</code></pre>
+
<p>Flags:</p>
-<pre><code>-h, --help=false: help for version
+<pre><code class="no-highlight"> -h, --help=false: help for version
</code></pre>
+
<p>Global Flags:</p>
-<pre><code>-h, --help=false: help for newt
+<pre><code class="no-highlight"> -h, --help=false: help for newt
</code></pre>
+
<p>Examples</p>
<table>
<thead>
@@ -236,10 +244,11 @@ target Set and view target information
</table>
<h3 id="help"><em>help</em><a class="headerlink" href="#help" title="Permanent link">¶</a></h3>
<h4 id="usage_1">Usage:<a class="headerlink" href="#usage_1" title="Permanent link">¶</a></h4>
-<pre><code>newt help [input1]
+<pre><code class="no-highlight"> newt help [input1]
</code></pre>
+
<p>Flags:</p>
-<pre><code>
+<pre><code class="no-highlight">
-h, --help=false: help for newt
-l, --loglevel="WARN": Log level, defaults to WARN.
-q, --quiet=false: Be quiet; only display error output.
@@ -271,25 +280,29 @@ target Set and view target information
</table>
<h3 id="nest"><em>nest</em><a class="headerlink" href="#nest" title="Permanent link">¶</a></h3>
<h4 id="usage_2">Usage:<a class="headerlink" href="#usage_2" title="Permanent link">¶</a></h4>
-<pre><code>newt nest [command][flags] input1 input2...
+<pre><code class="no-highlight"> newt nest [command][flags] input1 input2...
</code></pre>
+
<p>Available commands: </p>
-<pre><code>create Create a new nest
-generate-clutch Generate a clutch file from the eggs in the current directory
-add-clutch Add a remote clutch, and put it in the current nest
-list-clutches List the clutches installed in the current nest
-show-clutch Show an individual clutch in the current nest
+<pre><code class="no-highlight"> create Create a new nest
+ generate-clutch Generate a clutch file from the eggs in the current directory
+ add-clutch Add a remote clutch, and put it in the current nest
+ list-clutches List the clutches installed in the current nest
+ show-clutch Show an individual clutch in the current nest
</code></pre>
+
<p>Flags:</p>
-<pre><code>-h, --help=false: help for nest
+<pre><code class="no-highlight"> -h, --help=false: help for nest
</code></pre>
+
<p>Global Flags:</p>
-<pre><code>-h, --help=false: help for newt
--l, --loglevel="WARN": Log level, defaults to WARN.
--q, --quiet=false: Be quiet; only display error output.
--s, --silent=false: Be silent; don't output anything.
--v, --verbose=false: Enable verbose output when executing commands.
+<pre><code class="no-highlight"> -h, --help=false: help for newt
+ -l, --loglevel="WARN": Log level, defaults to WARN.
+ -q, --quiet=false: Be quiet; only display error output.
+ -s, --silent=false: Be silent; don't output anything.
+ -v, --verbose=false: Enable verbose output when executing commands.
</code></pre>
+
<p>Description</p>
<table>
<thead>
@@ -382,25 +395,29 @@ show-clutch Show an individual clutch in the current nest
</table>
<h3 id="egg"><em>egg</em><a class="headerlink" href="#egg" title="Permanent link">¶</a></h3>
<h4 id="usage_3">Usage:<a class="headerlink" href="#usage_3" title="Permanent link">¶</a></h4>
-<pre><code>newt egg [command][flag] input1 input2
+<pre><code class="no-highlight"> newt egg [command][flag] input1 input2
</code></pre>
+
<p>Available Commands: </p>
-<pre><code>list List eggs in the current nest
-checkdeps Check egg dependencies
-hunt Search for egg from clutches
-show Show the contents of an egg.
-install Install an egg
-remove Remove an egg
+<pre><code class="no-highlight"> list List eggs in the current nest
+ checkdeps Check egg dependencies
+ hunt Search for egg from clutches
+ show Show the contents of an egg.
+ install Install an egg
+ remove Remove an egg
</code></pre>
+
<p>Flags:</p>
-<pre><code>-h, --help=false: help for egg
-</code></pre>
-<p>Global Flags:</p>
-<pre><code>-l, --loglevel="WARN": Log level, defaults to WARN.
--q, --quiet=false: Be quiet; only display error output.
--s, --silent=false: Be silent; don't output anything.
--v, --verbose=false: Enable verbose output when executing commands.
+<pre><code class="no-highlight"> -h, --help=false: help for egg
+
+Global Flags:
+
+ -l, --loglevel="WARN": Log level, defaults to WARN.
+ -q, --quiet=false: Be quiet; only display error output.
+ -s, --silent=false: Be silent; don't output anything.
+ -v, --verbose=false: Enable verbose output when executing commands.
</code></pre>
+
<p>Description</p>
<table>
<thead>
@@ -503,30 +520,34 @@ remove Remove an egg
<h3 id="target"><em>target</em><a class="headerlink" href="#target" title="Permanent link">¶</a></h3>
<h4 id="usage_4">Usage:<a class="headerlink" href="#usage_4" title="Permanent link">¶</a></h4>
<p>Usage: </p>
-<pre><code>newt target [command] input1 [flag1] [flag2]
+<pre><code class="no-highlight"> newt target [command] input1 [flag1] [flag2]
</code></pre>
+
<p>Available Commands: </p>
-<pre><code>set Set target configuration variable
-unset Unset target configuration variable
-delete Delete target
-create Create a target
-show View target configuration variables
-build Build target
-test Test target
-export Export target
-import Import target
-download Download image to target
-debug Download image to target and start an openocd/gdb session
+<pre><code class="no-highlight"> set Set target configuration variable
+ unset Unset target configuration variable
+ delete Delete target
+ create Create a target
+ show View target configuration variables
+ build Build target
+ test Test target
+ export Export target
+ import Import target
+ download Download image to target
+ debug Download image to target and start an openocd/gdb session
</code></pre>
+
<p>Flags:</p>
-<pre><code>-h, --help=false: help for target
+<pre><code class="no-highlight"> -h, --help=false: help for target
</code></pre>
+
<p>Global Flags:</p>
-<pre><code>-l, --loglevel="WARN": Log level, defaults to WARN.
--q, --quiet=false: Be quiet; only display error output.
--s, --silent=false: Be silent; don't output anything.
--v, --verbose=false: Enable verbose output when executing commands.
+<pre><code class="no-highlight"> -l, --loglevel="WARN": Log level, defaults to WARN.
+ -q, --quiet=false: Be quiet; only display error output.
+ -s, --silent=false: Be silent; don't output anything.
+ -v, --verbose=false: Enable verbose output when executing commands.
</code></pre>
+
<p>Description</p>
<table>
<thead>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/newtmgr/overview/index.html
----------------------------------------------------------------------
diff --git a/newtmgr/overview/index.html b/newtmgr/overview/index.html
new file mode 100644
index 0000000..da1ed65
--- /dev/null
+++ b/newtmgr/overview/index.html
@@ -0,0 +1,246 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/newtmgr/overview/">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>Overview - Mynewt Testing</title>
+
+ <link href="../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/custom.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="Overview">
+
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="logo-container">
+ <img src="http://mynewt.incubator.apache.org/img/logo.svg">
+ </div>
+ <div class="container-fluid">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="http://mynewt.incubator.apache.org/">Home</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/documentation/">Docs</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/download/">Download</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/community/">Community</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container-fluid">
+
+ <div class="row sm-extra-padding">
+ <div class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
+ <div class="sidebar-top">
+ <img class="hidden-xs hidden-sm logo-small" src="http://mynewt.incubator.apache.org/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div class="small" role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" placeholder="Search documentation" />
+ <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="nav bs-sidenav">
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="main"><a href="../../get_started/newt_concepts/">Chapter 1 - Get Started</a></li>
+
+
+
+
+ <li class="main"><a href="../../get_acclimated/vocabulary/">Chapter 2 - Get Acclimated</a></li>
+
+
+
+
+ <li class="main"><a href="../../newt/newt_ops/">Chapter 3 - Newt Tool</a></li>
+
+
+
+
+ <li class="main"><a href="../../os/mynewt_os/">Chapter 4 - Mynewt OS</a></li>
+
+
+
+
+ <li class="main"><a href="../../modules/console/">Chapter 5 - Modules</a></li>
+
+
+
+
+ <li class="main"><a href="./">Chapter 6 - Newt Manager</a></li>
+
+ <ul class="current-toc">
+
+ <li class="toctree-l2"><a href="./">Overview</a></li>
+
+
+
+
+
+
+
+
+
+
+ <li class="toctree-l2"><a href="../protocol/">Protocol</a></li>
+
+
+ <li class="toctree-l2"><a href="../project-slinky/">Project Slinky</a></li>
+
+
+ </ul>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9 documentation-viewer" role="main">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Chapter 6 - Newt Manager »</li>
+
+
+
+ <li>Overview</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <h2 id="newt-manager">Newt Manager<a class="headerlink" href="#newt-manager" title="Permanent link">¶</a></h2>
+<p><synopsis> </p>
+<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
+<h2 id="command-list">Command List<a class="headerlink" href="#command-list" title="Permanent link">¶</a></h2>
+
+ </div>
+ </div>
+
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="http://mynewt.incubator.apache.org/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="http://mynewt.incubator.apache.org/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script src="../../js/base.js"></script>
+ <script src="../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/newtmgr/project-slinky/index.html
----------------------------------------------------------------------
diff --git a/newtmgr/project-slinky/index.html b/newtmgr/project-slinky/index.html
new file mode 100644
index 0000000..415dcdd
--- /dev/null
+++ b/newtmgr/project-slinky/index.html
@@ -0,0 +1,246 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/newtmgr/project-slinky/">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>Project Slinky - Mynewt Testing</title>
+
+ <link href="../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/custom.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="Project Slinky">
+
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="logo-container">
+ <img src="http://mynewt.incubator.apache.org/img/logo.svg">
+ </div>
+ <div class="container-fluid">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="http://mynewt.incubator.apache.org/">Home</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/documentation/">Docs</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/download/">Download</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/community/">Community</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container-fluid">
+
+ <div class="row sm-extra-padding">
+ <div class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
+ <div class="sidebar-top">
+ <img class="hidden-xs hidden-sm logo-small" src="http://mynewt.incubator.apache.org/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div class="small" role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" placeholder="Search documentation" />
+ <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="nav bs-sidenav">
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="main"><a href="../../get_started/newt_concepts/">Chapter 1 - Get Started</a></li>
+
+
+
+
+ <li class="main"><a href="../../get_acclimated/vocabulary/">Chapter 2 - Get Acclimated</a></li>
+
+
+
+
+ <li class="main"><a href="../../newt/newt_ops/">Chapter 3 - Newt Tool</a></li>
+
+
+
+
+ <li class="main"><a href="../../os/mynewt_os/">Chapter 4 - Mynewt OS</a></li>
+
+
+
+
+ <li class="main"><a href="../../modules/console/">Chapter 5 - Modules</a></li>
+
+
+
+
+ <li class="main"><a href="../overview/">Chapter 6 - Newt Manager</a></li>
+
+ <ul class="current-toc">
+
+ <li class="toctree-l2"><a href="../overview/">Overview</a></li>
+
+
+ <li class="toctree-l2"><a href="../protocol/">Protocol</a></li>
+
+
+ <li class="toctree-l2"><a href="./">Project Slinky</a></li>
+
+
+
+
+
+
+
+
+
+
+ </ul>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9 documentation-viewer" role="main">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Chapter 6 - Newt Manager »</li>
+
+
+
+ <li>Project Slinky</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <h2 id="project-slinky">Project Slinky<a class="headerlink" href="#project-slinky" title="Permanent link">¶</a></h2>
+<p><synopsis> </p>
+<h2 id="objective">Objective<a class="headerlink" href="#objective" title="Permanent link">¶</a></h2>
+<h2 id="what-you-need">What you need<a class="headerlink" href="#what-you-need" title="Permanent link">¶</a></h2>
+
+ </div>
+ </div>
+
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="http://mynewt.incubator.apache.org/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="http://mynewt.incubator.apache.org/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script src="../../js/base.js"></script>
+ <script src="../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b9c5b00c/newtmgr/protocol/index.html
----------------------------------------------------------------------
diff --git a/newtmgr/protocol/index.html b/newtmgr/protocol/index.html
new file mode 100644
index 0000000..baa5e58
--- /dev/null
+++ b/newtmgr/protocol/index.html
@@ -0,0 +1,246 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/newtmgr/protocol/">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>Protocol - Mynewt Testing</title>
+
+ <link href="../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/custom.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="Protocol">
+
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="logo-container">
+ <img src="http://mynewt.incubator.apache.org/img/logo.svg">
+ </div>
+ <div class="container-fluid">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="http://mynewt.incubator.apache.org/">Home</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/documentation/">Docs</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/download/">Download</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/community/">Community</a>
+ </li>
+ <li>
+ <a href="http://mynewt.incubator.apache.org/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container-fluid">
+
+ <div class="row sm-extra-padding">
+ <div class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
+ <div class="sidebar-top">
+ <img class="hidden-xs hidden-sm logo-small" src="http://mynewt.incubator.apache.org/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div class="small" role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" placeholder="Search documentation" />
+ <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="nav bs-sidenav">
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="main"><a href="../../get_started/newt_concepts/">Chapter 1 - Get Started</a></li>
+
+
+
+
+ <li class="main"><a href="../../get_acclimated/vocabulary/">Chapter 2 - Get Acclimated</a></li>
+
+
+
+
+ <li class="main"><a href="../../newt/newt_ops/">Chapter 3 - Newt Tool</a></li>
+
+
+
+
+ <li class="main"><a href="../../os/mynewt_os/">Chapter 4 - Mynewt OS</a></li>
+
+
+
+
+ <li class="main"><a href="../../modules/console/">Chapter 5 - Modules</a></li>
+
+
+
+
+ <li class="main"><a href="../overview/">Chapter 6 - Newt Manager</a></li>
+
+ <ul class="current-toc">
+
+ <li class="toctree-l2"><a href="../overview/">Overview</a></li>
+
+
+ <li class="toctree-l2"><a href="./">Protocol</a></li>
+
+
+
+
+
+
+
+
+
+
+ <li class="toctree-l2"><a href="../project-slinky/">Project Slinky</a></li>
+
+
+ </ul>
+
+
+
+
+ <li class="main"><a href="../../packaging/dist/">Chapter 7 - Packaging it</a></li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9 documentation-viewer" role="main">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Chapter 6 - Newt Manager »</li>
+
+
+
+ <li>Protocol</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <h2 id="newt-manager-protocol">Newt Manager Protocol<a class="headerlink" href="#newt-manager-protocol" title="Permanent link">¶</a></h2>
+<p><synopsis> </p>
+<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
+<h2 id="how-it-works">How it works<a class="headerlink" href="#how-it-works" title="Permanent link">¶</a></h2>
+
+ </div>
+ </div>
+
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="http://mynewt.incubator.apache.org/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="http://mynewt.incubator.apache.org/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script src="../../js/base.js"></script>
+ <script src="../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file