You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/01/13 19:26:33 UTC
[1/7] incubator-mynewt-site git commit: Fix second level navigation
and function formats in docs
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/asf-site 5c9518358 -> bc3112c09
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/time/index.html
----------------------------------------------------------------------
diff --git a/os/time/index.html b/os/time/index.html
index 8a13cd9..3f607c8 100644
--- a/os/time/index.html
+++ b/os/time/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="./">Time</a></li>
+ <li class="toctree-l2"><a href="./">Time</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_time_get"> os_time_get </a></li>
+
+ <li class="toctree-l3"><a href="#os_time_tick"> os_time_tick </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,19 +240,18 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_time_get">os_time_get</a></li>
-<li><a href="#function-os_time_tick">os_time_tick</a></li>
+<li><a href="#os_time_get">os_time_get</a></li>
+<li><a href="#os_time_tick">os_time_tick</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_time_get"><font color="2980b9">function os_time_get </font><a class="headerlink" href="#function-os_time_get" title="Permanent link">¶</a></h3>
-<pre><code> os_time_t
+<h2 id="os_time_get"><font color="F2853F" style="font-size:24pt"> os_time_get </font><a class="headerlink" href="#os_time_get" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> os_time_t
os_time_get(void)
-
</code></pre>
<p><Insert short description></p>
@@ -266,15 +283,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_time_tick"><font color="#2980b9"> function os_time_tick </font><a class="headerlink" href="#function-os_time_tick" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_time_tick"><font color="#F2853F" style="font-size:24pt"> os_time_tick </font><a class="headerlink" href="#os_time_tick" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -312,7 +326,7 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
+<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> <Insert function callout here >
</code></pre>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/packaging/dist/index.html
----------------------------------------------------------------------
diff --git a/packaging/dist/index.html b/packaging/dist/index.html
index 942953f..a0c6697 100644
--- a/packaging/dist/index.html
+++ b/packaging/dist/index.html
@@ -146,7 +146,9 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="./">Creating Packages</a></li>
+ <li class="toctree-l2"><a href="./">Creating Packages</a></li>
+
+
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/sitemap.xml
----------------------------------------------------------------------
diff --git a/sitemap.xml b/sitemap.xml
index 5e3ab1c..8e8306f 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -4,7 +4,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -12,7 +12,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/documentation/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -20,7 +20,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/download/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -28,7 +28,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/community/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -36,7 +36,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/events/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -45,25 +45,25 @@
<url>
<loc>http://mynewt.incubator.apache.org/get_started/newt_concepts/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/get_started/project1/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/get_started/how_to_edit_docs/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/get_started/try_markdown/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -73,19 +73,19 @@
<url>
<loc>http://mynewt.incubator.apache.org/get_acclimated/vocabulary/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/get_acclimated/project2/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/get_acclimated/project3/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -95,13 +95,13 @@
<url>
<loc>http://mynewt.incubator.apache.org/newt/newt_ops/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/newt/newt_tool_reference/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -111,79 +111,79 @@
<url>
<loc>http://mynewt.incubator.apache.org/os/mynewt_os/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/context_switch/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/time/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/task/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/event_queue/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/semaphore/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/mutex/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/memory_pool/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/heap/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/mbufs/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/sanity/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/callout/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/os/port_os/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -193,31 +193,31 @@
<url>
<loc>http://mynewt.incubator.apache.org/modules/console/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/modules/shell/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/modules/bootloader/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/modules/filesystem/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/modules/testutil/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -227,7 +227,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/packaging/dist/</loc>
- <lastmod>2016-01-07</lastmod>
+ <lastmod>2016-01-13</lastmod>
<changefreq>daily</changefreq>
</url>
[6/7] incubator-mynewt-site git commit: Fix second level navigation
and function formats in docs
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/get_started/project1/index.html
----------------------------------------------------------------------
diff --git a/get_started/project1/index.html b/get_started/project1/index.html
index 4193cf5..2842d80 100644
--- a/get_started/project1/index.html
+++ b/get_started/project1/index.html
@@ -121,16 +121,40 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../newt_concepts/">Newt Concepts</a></li>
+ <li class="toctree-l2"><a href="../newt_concepts/">Newt Concepts</a></li>
- <li class="toctree-l3"><a href="./">Blinky, The First Project</a></li>
+ <li class="toctree-l2"><a href="./">Blinky, The First Project</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#objective">Objective</a></li>
+
+ <li class="toctree-l3"><a href="#what-you-need">What you need</a></li>
+
+ <li class="toctree-l3"><a href="#access-to-the-apache-repo">Access to the Apache repo</a></li>
+
+ <li class="toctree-l3"><a href="#getting-your-mac-ready">Getting your Mac Ready</a></li>
+
+ <li class="toctree-l3"><a href="#getting-your-ubuntu-machine-ready">Getting your Ubuntu machine Ready</a></li>
+
+ <li class="toctree-l3"><a href="#getting-your-windows-machine-ready-for-simulated-target">Getting your Windows machine ready for simulated target</a></li>
+
+ <li class="toctree-l3"><a href="#getting-your-windows-machine-ready-for-hardware-target">Getting your Windows machine ready for hardware target</a></li>
+
+ <li class="toctree-l3"><a href="#building-test-code-on-simulator">Building test code on simulator</a></li>
+
+ <li class="toctree-l3"><a href="#using-sram-to-make-led-blink">Using SRAM to make LED blink</a></li>
+
+ <li class="toctree-l3"><a href="#using-flash-to-make-led-blink">Using flash to make LED blink</a></li>
+
+
- <li class="toctree-l3"><a href="../how_to_edit_docs/">How to edit docs</a></li>
+ <li class="toctree-l2"><a href="../how_to_edit_docs/">How to edit docs</a></li>
- <li class="toctree-l3"><a href="../try_markdown/">Sample doc to edit</a></li>
+ <li class="toctree-l2"><a href="../try_markdown/">Sample doc to edit</a></li>
</ul>
@@ -224,27 +248,26 @@
</ul>
<p>The following shows how to clone a Mynewt OS code repository:</p>
<ul>
-<li>
-<p>Non Committers</p>
-<pre><code>$ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
-</code></pre>
-</li>
-<li>
-<p>Committers</p>
-<pre><code>$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+<li>Non Committers</li>
+</ul>
+<pre><code class="no-highlight"> $ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
</code></pre>
-</li>
+
+<ul>
+<li>Committers</li>
</ul>
+<pre><code class="no-highlight"> $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+</code></pre>
+
<h3 id="getting-your-mac-ready">Getting your Mac Ready<a class="headerlink" href="#getting-your-mac-ready" title="Permanent link">¶</a></h3>
<h4 id="installing-homebrew-to-ease-installs-on-os-x">Installing Homebrew to ease installs on OS X<a class="headerlink" href="#installing-homebrew-to-ease-installs-on-os-x" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>Do you have Homebrew? If not, open a terminal on your Mac and paste the following at a Terminal prompt. It will ask you for your sudo password.</p>
-<pre><code>$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+<li>Do you have Homebrew? If not, open a terminal on your Mac and paste the following at a Terminal prompt. It will ask you for your sudo password.</li>
+</ul>
+<pre><code class="no-highlight"> $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
</code></pre>
+
<p>Alternatively, you can just extract (or <code>git clone</code>) Homebrew and install it to <code>/usr/local</code>.</p>
-</li>
-</ul>
<h4 id="installing-go">Installing Go<a class="headerlink" href="#installing-go" title="Permanent link">¶</a></h4>
<ul>
<li>
@@ -261,153 +284,158 @@
</li>
</ul>
<p>The GOPATH environment variable specifies the location of your workspace. First create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory where you will soon clone the newt tool repository.</p>
-<pre><code>$ cd $HOME
-$ mkdir -p dev/go
-$ cd dev/go
-$ export GOPATH=`pwd`
+</li>
+</ul>
+<pre><code class="no-highlight"> $ cd $HOME
+ $ mkdir -p dev/go
+ $ cd dev/go
+ $ export GOPATH=`pwd`
</code></pre>
+
<p>Note that you need to add export statements to ~/.bash_profile to export variables permanently. Don't forget to source the file for the change to go into effect.</p>
-<pre><code>$ vi ~/.bash_profile
-$ source ~/.bash_profile
+<pre><code class="no-highlight"> $ vi ~/.bash_profile
+ $ source ~/.bash_profile
</code></pre>
-</li>
-<li>
-<p>Next you will use Homebrew to install Go. The summary message at the end of the installation should indicate that it is installed in the /usr/local/Cellar/go/ directory. You will use the Go command 'install' to compile and install packages (called eggs in the Mynewt world) and dependencies. </p>
-<pre><code>$ brew install go
-==>
-...
-...
-==> *Summary*
-🍺 /usr/local/Cellar/go/1.5.1: 5330 files, 273M
+
+<ul>
+<li>Next you will use Homebrew to install Go. The summary message at the end of the installation should indicate that it is installed in the /usr/local/Cellar/go/ directory. You will use the Go command 'install' to compile and install packages (called eggs in the Mynewt world) and dependencies. </li>
+</ul>
+<pre><code class="no-highlight"> $ brew install go
+ ==>
+ ...
+ ...
+ ==> *Summary*
+ 🍺 /usr/local/Cellar/go/1.5.1: 5330 files, 273M
</code></pre>
+
<p>Alternatively, you can download the Go package directly from (https://golang.org/dl/) instead of brewing it. Install it in /usr/local directory.</p>
-</li>
-</ul>
<h4 id="creating-local-repository">Creating local repository<a class="headerlink" href="#creating-local-repository" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>You are ready to download the newt tool repository. You will use Go to copy the directory (currently the asf incubator directory). Be patient as it may take a minute or two. Check the directories installed.</p>
-<pre><code>$ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
-$ ls
- bin pkg src
-$ ls src
-git-wip-us.apache.org github.com gopkg.in
-</code></pre>
-</li>
-<li>
-<p>Check that newt.go is in place.</p>
-<pre><code>$ ls $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
-Godeps README.md coding_style.txt newt.go
-LICENSE cli design.txt
+<li>You are ready to download the newt tool repository. You will use Go to copy the directory (currently the asf incubator directory). Be patient as it may take a minute or two. Check the directories installed.</li>
+</ul>
+<pre><code class="no-highlight"> $ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ $ ls
+ bin pkg src
+ $ ls src
+ git-wip-us.apache.org github.com gopkg.in
</code></pre>
-</li>
+
+<ul>
+<li>Check that newt.go is in place.</li>
</ul>
+<pre><code class="no-highlight"> $ ls $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ Godeps README.md coding_style.txt newt.go
+ LICENSE cli design.txt
+</code></pre>
+
<h4 id="building-the-newt-tool">Building the Newt tool<a class="headerlink" href="#building-the-newt-tool" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>You will use Go to run the newt.go program to build the newt tool. The command used is <code>go install</code> which compiles and writes the resulting executable to an output file named <code>newt</code>. It installs the results along with its dependencies in $GOPATH/bin.</p>
-<pre><code>$ cd $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
-$ go install
-$ ls "$GOPATH"/bin/
-godep incubator-mynewt-newt.git newt
+<li>You will use Go to run the newt.go program to build the newt tool. The command used is <code>go install</code> which compiles and writes the resulting executable to an output file named <code>newt</code>. It installs the results along with its dependencies in $GOPATH/bin.</li>
+</ul>
+<pre><code class="no-highlight"> $ cd $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ $ go install
+ $ ls "$GOPATH"/bin/
+ godep incubator-mynewt-newt.git newt
</code></pre>
-</li>
-<li>
-<p>Try running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.</p>
-</li>
+
+<ul>
+<li>Try running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.</li>
</ul>
<p>Note: If you are going to be be modifying the newt tool itself often and wish to compile the program every time you call it, you may want to store the command in a variable in your .bash_profile. So type in <code>export newt="go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt/newt/go"</code> in your .bash_profile and execute it by calling <code>$newt</code> at the prompt instead of <code>newt</code>. Here, you use <code>go run</code> which runs the compiled binary directly without producing an executable. Don't forget to reload the updated bash profile by typing <code>source ~/.bash_profile</code> at the prompt! </p>
-<pre><code> $ newt version
- Newt version: 1.0
- $ newt -h
- Newt allows you to create your own embedded project based on the Mynewt
- operating system. Newt provides both build and package management in a
- single tool, which allows you to compose an embedded workspace, and set
- of projects, and then build the necessary artifacts from those projects.
- For more information on the Mynewt operating system, please visit
- https://www.github.com/mynewt/documentation.
-
- Please use the newt help command, and specify the name of the command
- you want help for, for help on how to use a specific command
-
- Usage:
- newt [flags]
- newt [command]
-
- Examples:
- newt
- newt help [<command-name>]
- For help on <command-name>. If not specified, print this message.
-
-
- Available Commands:
- version Display the Newt version number.
- target Set and view target information
- egg Commands to list and inspect eggs on a nest
- nest Commands to manage nests & clutches (remote egg repositories)
- help Help about any command
-
- Flags:
- -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.
-
-
- Use "newt help [command]" for more information about a command.
+<pre><code class="no-highlight"> $ newt version
+ Newt version: 1.0
+ $ newt -h
+ Newt allows you to create your own embedded project based on the Mynewt
+ operating system. Newt provides both build and package management in a
+ single tool, which allows you to compose an embedded workspace, and set
+ of projects, and then build the necessary artifacts from those projects.
+ For more information on the Mynewt operating system, please visit
+ https://www.github.com/mynewt/documentation.
+
+ Please use the newt help command, and specify the name of the command
+ you want help for, for help on how to use a specific command
+
+ Usage:
+ newt [flags]
+ newt [command]
+
+ Examples:
+ newt
+ newt help [<command-name>]
+ For help on <command-name>. If not specified, print this message.
+
+
+ Available Commands:
+ version Display the Newt version number.
+ target Set and view target information
+ egg Commands to list and inspect eggs on a nest
+ nest Commands to manage nests & clutches (remote egg repositories)
+ help Help about any command
+
+ Flags:
+ -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.
+
+
+ Use "newt help [command]" for more information about a command.
</code></pre>
+
<ul>
<li>Without creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded a nest to try out the tool. </li>
</ul>
<h4 id="getting-the-debugger-ready">Getting the debugger ready<a class="headerlink" href="#getting-the-debugger-ready" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>Before you start building nests and hatching eggs, you need to do one final step in the environment preparation - install gcc / libc that can produce 32-bit executables. So, first install gcc. You will see the brew steps and a final summary confirming install.</p>
-<pre><code>$ brew install gcc
-...
-...
-==> Summary
-🍺 /usr/local/Cellar/gcc/5.2.0: 1353 files, 248M
+<li>Before you start building nests and hatching eggs, you need to do one final step in the environment preparation - install gcc / libc that can produce 32-bit executables. So, first install gcc. You will see the brew steps and a final summary confirming install.</li>
+</ul>
+<pre><code class="no-highlight"> $ brew install gcc
+ ...
+ ...
+ ==> Summary
+ 🍺 /usr/local/Cellar/gcc/5.2.0: 1353 files, 248M
</code></pre>
-</li>
-<li>
-<p>ARM maintains a pre-built GNU toolchain with a GCC source branch targeted at Embedded ARM Processors namely Cortex-R/Cortex-M processor families. Install the PX4 Toolchain and check the version installed. Make sure that the symbolic link installed by Homebrew points to the correct version of the debugger. If not, you can either change the symbolic link using the "ln -f -s" command or just go ahead and try with the version it points to!</p>
-<pre><code>$ brew tap PX4/homebrew-px4
-$ brew update
-$ brew install gcc-arm-none-eabi-49
-$ arm-none-eabi-gcc --version
-arm-none-eabi-gcc (GNU Tools for ARM Embedded Processors) 4.9.3 20150529 (release) [ARM/embedded-4_9-branch revision 224288]
-Copyright (C) 2014 Free Software Foundation, Inc.
-This is free software; see the source for copying conditions. There is NO
-warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-$ ls -al /usr/local/bin/arm-none-eabi-gdb
-lrwxr-xr-x 1 aditihilbert admin 69 Sep 22 17:16 /usr/local/bin/arm-none-eabi-gdb -> /usr/local/Cellar/gcc-arm-none-eabi-49/20150609/bin/arm-none-eabi-gdb
+
+<ul>
+<li>ARM maintains a pre-built GNU toolchain with a GCC source branch targeted at Embedded ARM Processors namely Cortex-R/Cortex-M processor families. Install the PX4 Toolchain and check the version installed. Make sure that the symbolic link installed by Homebrew points to the correct version of the debugger. If not, you can either change the symbolic link using the "ln -f -s" command or just go ahead and try with the version it points to!</li>
+</ul>
+<pre><code class="no-highlight"> $ brew tap PX4/homebrew-px4
+ $ brew update
+ $ brew install gcc-arm-none-eabi-49
+ $ arm-none-eabi-gcc --version
+ arm-none-eabi-gcc (GNU Tools for ARM Embedded Processors) 4.9.3 20150529 (release) [ARM/embedded-4_9-branch revision 224288]
+ Copyright (C) 2014 Free Software Foundation, Inc.
+ This is free software; see the source for copying conditions. There is NO
+ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ $ ls -al /usr/local/bin/arm-none-eabi-gdb
+ lrwxr-xr-x 1 aditihilbert admin 69 Sep 22 17:16 /usr/local/bin/arm-none-eabi-gdb -> /usr/local/Cellar/gcc-arm-none-eabi-49/20150609/bin/arm-none-eabi-gdb
</code></pre>
+
<p>Note: If no version is specified, brew will install the latest version available. MynewtOS will eventually work with multiple versions available including the latest releases. However, at present we have tested only with this version and recommend it for getting started. </p>
-</li>
-<li>
-<p>You have to install OpenOCD (Open On-Chip Debugger) which is an open-source software that will allow you to interface with the JTAG debug connector/adaptor for the Olimex board. It lets you program, debug, and test embedded target devices which, in this case, is the Olimex board. Use brew to install it. Brew adds a simlink /usr/local/bin/openocd to the openocd directory in the Cellar. For more on OpenOCD go to <a href="http://openocd.org">http://openocd.org</a>.</p>
-<pre><code>$ brew install open-ocd
-$ which openocd
-/usr/local/bin/openocd
-$ ls -l $(which openocd)
-lrwxr-xr-x 1 <user> admin 36 Sep 17 16:22 /usr/local/bin/openocd -> ../Cellar/open-ocd/0.9.0/bin/openocd
+<ul>
+<li>You have to install OpenOCD (Open On-Chip Debugger) which is an open-source software that will allow you to interface with the JTAG debug connector/adaptor for the Olimex board. It lets you program, debug, and test embedded target devices which, in this case, is the Olimex board. Use brew to install it. Brew adds a simlink /usr/local/bin/openocd to the openocd directory in the Cellar. For more on OpenOCD go to <a href="http://openocd.org">http://openocd.org</a>.</li>
+</ul>
+<pre><code class="no-highlight"> $ brew install open-ocd
+ $ which openocd
+ /usr/local/bin/openocd
+ $ ls -l $(which openocd)
+ lrwxr-xr-x 1 <user> admin 36 Sep 17 16:22 /usr/local/bin/openocd -> ../Cellar/open-ocd/0.9.0/bin/openocd
</code></pre>
-</li>
-<li>
-<p>Proceed to the <a href="#building-test-code-on-simulator">Building test code on simulator</a> section.</p>
-</li>
+
+<ul>
+<li>Proceed to the <a href="#building-test-code-on-simulator">Building test code on simulator</a> section.</li>
</ul>
<h3 id="getting-your-ubuntu-machine-ready">Getting your Ubuntu machine Ready<a class="headerlink" href="#getting-your-ubuntu-machine-ready" title="Permanent link">¶</a></h3>
<h4 id="installing-some-prerequisites">Installing some prerequisites<a class="headerlink" href="#installing-some-prerequisites" title="Permanent link">¶</a></h4>
<ul>
-<li>Install git, libcurl, and the Go language if you do not have them already.<pre><code>$ sudo apt-get install git
-$ sudo apt-get install libcurl4-gnutls-dev
-$ sudo apt-get install golang
-</code></pre>
-</li>
+<li>Install git, libcurl, and the Go language if you do not have them already.</li>
</ul>
+<pre><code class="no-highlight"> $ sudo apt-get install git
+ $ sudo apt-get install libcurl4-gnutls-dev
+ $ sudo apt-get install golang
+</code></pre>
+
<h4 id="creating-local-repository_1">Creating local repository<a class="headerlink" href="#creating-local-repository_1" title="Permanent link">¶</a></h4>
<ul>
<li>
@@ -423,114 +451,120 @@ $ sudo apt-get install golang
<p>bin contains executable commands.</p>
</li>
</ul>
+</li>
+</ul>
<p>The GOPATH environment variable specifies the location of your workspace. First create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory where you will soon clone the newt tool repository.</p>
-<pre><code>$ cd $HOME
-$ mkdir -p dev/go
-$ cd dev/go
-$ export GOPATH=$PWD
+<pre><code class="no-highlight"> $ cd $HOME
+ $ mkdir -p dev/go
+ $ cd dev/go
+ $ export GOPATH=$PWD
</code></pre>
+
<p>Note that you need to add export statements to ~/.bashrc (or equivalent) to export variables permanently.</p>
-</li>
-<li>
-<p>You are ready to download the newt tool repository. You will use Go to copy the directory (currently the asf incubator directory). Be patient as it may take a minute or two. Check the directories installed.</p>
-<pre><code>$ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
-$ ls
- bin pkg src
-$ ls src
-git-wip-us.apache.org github.com gopkg.in
-</code></pre>
-</li>
-<li>
-<p>Check that newt is in place.</p>
-<pre><code>$ ls $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
-Godeps README.md coding_style.txt newt.go
-LICENSE cli design.txt
+<ul>
+<li>You are ready to download the newt tool repository. You will use Go to copy the directory (currently the asf incubator directory). Be patient as it may take a minute or two. Check the directories installed.</li>
+</ul>
+<pre><code class="no-highlight"> $ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ $ ls
+ bin pkg src
+ $ ls src
+ git-wip-us.apache.org github.com gopkg.in
</code></pre>
-</li>
+
+<ul>
+<li>Check that newt is in place.</li>
</ul>
+<pre><code class="no-highlight"> $ ls $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ Godeps README.md coding_style.txt newt.go
+ LICENSE cli design.txt
+</code></pre>
+
<h4 id="building-the-newt-tool_1">Building the newt tool<a class="headerlink" href="#building-the-newt-tool_1" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>You will use Go to run the newt.go program to build the newt tool. The command used is <code>go install</code> which compiles and writes the resulting executable to an output file named <code>newt</code>. It installs the results along with its dependencies in $GOPATH/bin.</p>
-<pre><code>$ cd $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
-$ go install
-$ ls "$GOPATH"/bin/
-godep incubator-mynewt-newt.git newt
+<li>You will use Go to run the newt.go program to build the newt tool. The command used is <code>go install</code> which compiles and writes the resulting executable to an output file named <code>newt</code>. It installs the results along with its dependencies in $GOPATH/bin.</li>
+</ul>
+<pre><code class="no-highlight"> $ cd $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ $ go install
+ $ ls "$GOPATH"/bin/
+ godep incubator-mynewt-newt.git newt
</code></pre>
-</li>
-<li>
-<p>Try running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.</p>
-</li>
+
+<ul>
+<li>Try running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.</li>
</ul>
<p>Note: If you are going to be be modifying the newt tool itself often and wish to compile the program every time you call it, you may want to store the command in a variable in your .bash_profile. So type in <code>export newt="go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt/newt/go"</code> in your ~/.bashrc (or equivalent) and execute it by calling <code>$newt</code> at the prompt instead of <code>newt</code>. Here, you use <code>go run</code> which runs the compiled binary directly without producing an executable. </p>
-<pre><code> $ newt version
- Newt version: 1.0
- $ newt -h
- Newt allows you to create your own embedded project based on the Mynewt
- operating system. Newt provides both build and package management in a
- single tool, which allows you to compose an embedded workspace, and set
- of projects, and then build the necessary artifacts from those projects.
- For more information on the Mynewt operating system, please visit
- https://www.github.com/mynewt/documentation.
-
- Please use the newt help command, and specify the name of the command
- you want help for, for help on how to use a specific command
-
- Usage:
- newt [flags]
- newt [command]
-
- Examples:
- newt
- newt help [<command-name>]
- For help on <command-name>. If not specified, print this message.
-
-
- Available Commands:
- version Display the Newt version number.
- target Set and view target information
- egg Commands to list and inspect eggs on a nest
- nest Commands to manage nests & clutches (remote egg repositories)
- help Help about any command
-
- Flags:
- -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.
-
-
- Use "newt help [command]" for more information about a command.
+<pre><code class="no-highlight"> $ newt version
+ Newt version: 1.0
+ $ newt -h
+ Newt allows you to create your own embedded project based on the Mynewt
+ operating system. Newt provides both build and package management in a
+ single tool, which allows you to compose an embedded workspace, and set
+ of projects, and then build the necessary artifacts from those projects.
+ For more information on the Mynewt operating system, please visit
+ https://www.github.com/mynewt/documentation.
+
+ Please use the newt help command, and specify the name of the command
+ you want help for, for help on how to use a specific command
+
+ Usage:
+ newt [flags]
+ newt [command]
+
+ Examples:
+ newt
+ newt help [<command-name>]
+ For help on <command-name>. If not specified, print this message.
+
+
+ Available Commands:
+ version Display the Newt version number.
+ target Set and view target information
+ egg Commands to list and inspect eggs on a nest
+ nest Commands to manage nests & clutches (remote egg repositories)
+ help Help about any command
+
+ Flags:
+ -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.
+
+
+ Use "newt help [command]" for more information about a command.
</code></pre>
+
<ul>
<li>Without creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded a nest to try out the tool. </li>
</ul>
<h4 id="getting-the-debugger-ready_1">Getting the debugger ready<a class="headerlink" href="#getting-the-debugger-ready_1" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>Before you start building nests and hatching eggs, you need to do one final step in the environment preparation - install gcc / libc that can produce 32-bit executables. You can install these as follows: </p>
-<pre><code>$ sudo apt-get install gcc-multilib libc6-i386
+<li>Before you start building nests and hatching eggs, you need to do one final step in the environment preparation - install gcc / libc that can produce 32-bit executables. You can install these as follows: </li>
+</ul>
+<pre><code class="no-highlight"> $ sudo apt-get install gcc-multilib libc6-i386
</code></pre>
-</li>
-<li>
-<p>For the LED project on the Olimex hardware, you have to install gcc for AM 4.9.3. This package can be installed with apt-get as documented below. The steps are explained in depth at <a href="https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded">https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded</a>.</p>
-<pre><code>$ sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi
-$ sudo add-apt-repository ppa:terry.guo/gcc-arm-embedded
-$ sudo apt-get update
-$ sudo apt-get install gcc-arm-none-eabi
+
+<ul>
+<li>For the LED project on the Olimex hardware, you have to install gcc for AM 4.9.3. This package can be installed with apt-get as documented below. The steps are explained in depth at <a href="https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded">https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded</a>.</li>
+</ul>
+<pre><code class="no-highlight"> $ sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi
+ $ sudo add-apt-repository ppa:terry.guo/gcc-arm-embedded
+ $ sudo apt-get update
+ $ sudo apt-get install gcc-arm-none-eabi
</code></pre>
-</li>
+
+<ul>
<li>
<p>And finally, you have to install OpenOCD (Open On-Chip Debugger) which is an open-source software that will allow you to interface with the JTAG debug connector/adaptor for the Olimex board. It lets you program, debug, and test embedded target devices which, in this case, is the Olimex board. You have to acquire OpenOCD 0.8.0. </p>
<p>If you are running Ubuntu 15.x, then you are in luck and you can simply run: </p>
-<pre><code>$ sudo apt-get install openocd
+</li>
+</ul>
+<pre><code class="no-highlight"> $ sudo apt-get install openocd
</code></pre>
+
<p>Other versions of Ubuntu may not have the correct version of openocd available. In this case, you should download the openocd 0.8.0 package from <a href="https://launchpad.net/ubuntu/vivid/+source/openocd">https://launchpad.net/ubuntu/vivid/+source/openocd</a>. The direct link to the amd64 build is <a href="http://launchpadlibrarian.net/188260097/openocd_0.8.0-4_amd64.deb">http://launchpadlibrarian.net/188260097/openocd_0.8.0-4_amd64.deb</a>. </p>
-</li>
-<li>
-<p>Proceed to the <a href="#building-test-code-on-simulator">Building test code on simulator</a> section.</p>
-</li>
+<ul>
+<li>Proceed to the <a href="#building-test-code-on-simulator">Building test code on simulator</a> section.</li>
</ul>
<h3 id="getting-your-windows-machine-ready-for-simulated-target">Getting your Windows machine ready for simulated target<a class="headerlink" href="#getting-your-windows-machine-ready-for-simulated-target" title="Permanent link">¶</a></h3>
<p>The <code>newt</code> tool is the build software used to build Mynewt OS images or executables for any embedded hardware device/board, including the one for the current tutorial (STM32-E407 development board from Olimex). You can run the <code>newt</code> tool natively on a computer running any of the three Operating System machines - OSX, Linux, or Windows.</p>
@@ -565,38 +599,40 @@ environment variable. To add to the PATH environment variable, right-click on t
</ul>
<h4 id="install-newtvm-tool">Install newtvm tool<a class="headerlink" href="#install-newtvm-tool" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>From your base user (home) directory, pull or clone the latest code from the newt repository into the <code>newt</code> directory. It includes the executable <code>newtvm.exe</code> for the newtvm tool in the <code>newtvm</code> directory.</p>
-<p>C:\Users\admin> git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt newt</p>
-</li>
+<li>From your base user (home) directory, pull or clone the latest code from the newt repository into the <code>newt</code> directory. It includes the executable <code>newtvm.exe</code> for the newtvm tool in the <code>newtvm</code> directory.</li>
</ul>
+<pre><code class="no-highlight"> C:\Users\admin> git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt newt
+</code></pre>
+
<p>The newtvm tool is what allows you to run programs in the Linux docker
instance. </p>
<ul>
-<li>Run the Docker Quickstart Terminal application inside the Docker folder under Programs. You can find it by clicking Start button -> All apps. By default, the Docker Toolbox installer creates a shortcut to this program on your desktop. Wait until you see an ASCII art whale displayed in the terminal window and the Docker prompt given. <pre><code> ## .
- ## ## ## ==
- ## ## ## ## ## ===
- /"""""""""""""""""\___/ ===
-~~~ {~~ ~~~~ ~~~ ~~~~ ~~~ ~ / ===- ~~~
- \______ o __/
- \ \ __/
- \____\_______/
+<li>Run the Docker Quickstart Terminal application inside the Docker folder under Programs. You can find it by clicking Start button -> All apps. By default, the Docker Toolbox installer creates a shortcut to this program on your desktop. Wait until you see an ASCII art whale displayed in the terminal window and the Docker prompt given. </li>
+</ul>
+<pre><code class="no-highlight"> ## .
+ ## ## ## ==
+ ## ## ## ## ## ===
+ /"""""""""""""""""\___/ ===
+ ~~~ {~~ ~~~~ ~~~ ~~~~ ~~~ ~ / ===- ~~~
+ \______ o __/
+ \ \ __/
+ \____\_______/
- docker is configured to use the default machine with IP 192.168.99.100
- For help getting started, check out the docs at https://docs.docker.com
+ docker is configured to use the default machine with IP 192.168.99.100
+ For help getting started, check out the docs at https://docs.docker.com
- admin@dev1 MINGW64 ~ (master)
- $
+ admin@dev1 MINGW64 ~ (master)
+ $
</code></pre>
-</li>
-</ul>
+
<p>The first time you run this, it may take several minutes to complete. You will need to run the Docker Quickstart Terminal once each time you
restart your computer.</p>
<ul>
-<li>Open a command prompt (e.g., Windows-R, "cmd", enter). You execute the newt tool commands as though you were running newt in Linux, but you prefix each command with "newtvm". For example:<pre><code>C:\Users\admin\newt\newtvm> newtvm newt help
-</code></pre>
-</li>
+<li>Open a command prompt (e.g., Windows-R, "cmd", enter). You execute the newt tool commands as though you were running newt in Linux, but you prefix each command with "newtvm". For example:</li>
</ul>
+<pre><code class="no-highlight"> C:\Users\admin\newt\newtvm> newtvm newt help
+</code></pre>
+
<p>The newtvm tool will take a long time to run the first time you execute
it. The delay is due to the fact that the tool must download the mynewt
docker instance.</p>
@@ -675,17 +711,20 @@ tutorial for a Windows machine assumes the specified folders. </p>
</li>
</ul>
<p>The GOPATH environment variable specifies the location of your workspace. First create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory and then proceed to create the directory for cloning the newt tool repository.</p>
-<pre><code>$ cd c:\
-$ mkdir dev\go
-$ cd dev\go
-</code></pre>
</li>
-<li>
-<p>Set the following user environment variables using the steps outlined here.</p>
+</ul>
+<pre><code class="no-highlight"> $ cd c:\
+ $ mkdir dev\go
+ $ cd dev\go
+</code></pre>
+
<ul>
-<li>GOPATH: C:\dev\go</li>
-<li>PATH: C:\Program Files (x86)\GNU Tools ARM Embedded\4.9 2015q3\bin;%GOPATH%\bin;C:\win-builds-x86_64\bin;C:\win-builds-i686\bin;C:\msys\bin</li>
+<li>Set the following user environment variables using the steps outlined here.</li>
</ul>
+<pre><code class="no-highlight"> * GOPATH: C:\dev\go
+ * PATH: C:\Program Files (x86)\GNU Tools ARM Embedded\4.9 2015q3\bin;%GOPATH%\bin;C:\win-builds-x86_64\bin;C:\win-builds-i686\bin;C:\msys\bin
+</code></pre>
+
<p>Steps:</p>
<ol>
<li>Right-click the start button</li>
@@ -695,110 +734,111 @@ $ cd dev\go
<li>Click "Advanced system settings" in the left panel</li>
<li>Click the "Envoronment Variables..." button</li>
<li>There will be two sets of environment variables: user variables
- in the upper half of the screen, and system variables in the lower
- half. Configuring the user variables is recommended and tested
- (though system variables will work as well).</li>
+ in the upper half of the screen, and system variables in the lower
+ half. Configuring the user variables is recommended and tested
+ (though system variables will work as well).</li>
</ol>
-</li>
-<li>
-<p>Next, install godep. Note that the following command produces no output.</p>
-<pre><code>$ go get github.com/tools/godep
-</code></pre>
-</li>
-<li>
-<p>Set up the repository for the package building tool "newt" on your local machine. First create the appropriate directory for it and then clone the newt tool repository from the online apache repository (or its github.com mirror) into this newly created directory. Check the contents of the directory.</p>
-<pre><code>$ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
-$ dir
- bin pkg src
-$ dir src
-git-wip-us.apache.org github.com gopkg.in
-$ dir
-newt
-$ cd newt
-$ dir
-Godeps README.md coding_style.txt newt.go
-LICENSE cli design.txt
+<ul>
+<li>Next, install godep. Note that the following command produces no output.</li>
+</ul>
+<pre><code class="no-highlight"> $ go get github.com/tools/godep
</code></pre>
-</li>
-<li>
-<p>Check that newt is in place.</p>
-<pre><code>$ dir $GOPATH\src\git-wip-us.apache.org\repos\asf\incubator-mynewt-newt.git\newt
-Godeps README.md coding_style.txt newt.go
-LICENSE cli design.txt
+
+<ul>
+<li>Set up the repository for the package building tool "newt" on your local machine. First create the appropriate directory for it and then clone the newt tool repository from the online apache repository (or its github.com mirror) into this newly created directory. Check the contents of the directory.</li>
+</ul>
+<pre><code class="no-highlight"> $ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ $ dir
+ bin pkg src
+ $ dir src
+ git-wip-us.apache.org github.com gopkg.in
+ $ dir
+ newt
+ $ cd newt
+ $ dir
+ Godeps README.md coding_style.txt newt.go
+ LICENSE cli design.txt
</code></pre>
-</li>
+
+<ul>
+<li>Check that newt is in place.</li>
</ul>
+<pre><code class="no-highlight"> $ dir $GOPATH\src\git-wip-us.apache.org\repos\asf\incubator-mynewt-newt.git\newt
+ Godeps README.md coding_style.txt newt.go
+ LICENSE cli design.txt
+</code></pre>
+
<h4 id="building-the-newt-tool_2">Building the newt tool<a class="headerlink" href="#building-the-newt-tool_2" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>You will use Go to run the newt.go program to build the newt tool. The command used is <code>go install</code> which compiles and writes the resulting executable to an output file named <code>newt</code>. It installs the results along with its dependencies in $GOPATH/bin.</p>
-<pre><code>$ go install
-$ ls "$GOPATH"/bin/
-godep incubator-mynewt-newt.git newt
+<li>You will use Go to run the newt.go program to build the newt tool. The command used is <code>go install</code> which compiles and writes the resulting executable to an output file named <code>newt</code>. It installs the results along with its dependencies in $GOPATH/bin.</li>
+</ul>
+<pre><code class="no-highlight"> $ go install
+ $ ls "$GOPATH"/bin/
+ godep incubator-mynewt-newt.git newt
</code></pre>
-</li>
-<li>
-<p>Try running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.</p>
+
+<ul>
+<li>Try running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.</li>
+</ul>
<p>Note: If you are going to be be modifying the newt tool itself often and wish to compile the program every time you call it, you may want to define the newt environment variable that allows you to execute the command via <code>%newt%</code>. Use <code>set newt=go run %GOPATH%\src\github.com\mynewt\newt\newt.go</code> or set it from the GUI. Here, you use <code>go run</code> which runs the compiled binary directly without producing an executable.</p>
-<pre><code>$ newt version
-Newt version: 1.0
-$ newt -h
-Newt allows you to create your own embedded project based on the Mynewt
-operating system. Newt provides both build and package management in a
-single tool, which allows you to compose an embedded workspace, and set
-of projects, and then build the necessary artifacts from those projects.
-For more information on the Mynewt operating system, please visit
-https://www.github.com/mynewt/documentation.
-
-Please use the newt help command, and specify the name of the command
-you want help for, for help on how to use a specific command
-
-Usage:
- newt [flags]
- newt [command]
-
-Examples:
- newt
- newt help [<command-name>]
- For help on <command-name>. If not specified, print this message.
-
-Available Commands:
- version Display the Newt version number.
- target Set and view target information
- egg Commands to list and inspect eggs on a nest
- nest Commands to manage nests & clutches (remote egg repositories)
- help Help about any command
-
-Flags:
- -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.
-
-Use "newt help [command]" for more information about a command.
+<pre><code class="no-highlight"> $ newt version
+ Newt version: 1.0
+ $ newt -h
+ Newt allows you to create your own embedded project based on the Mynewt
+ operating system. Newt provides both build and package management in a
+ single tool, which allows you to compose an embedded workspace, and set
+ of projects, and then build the necessary artifacts from those projects.
+ For more information on the Mynewt operating system, please visit
+ https://www.github.com/mynewt/documentation.
+
+ Please use the newt help command, and specify the name of the command
+ you want help for, for help on how to use a specific command
+
+ Usage:
+ newt [flags]
+ newt [command]
+
+ Examples:
+ newt
+ newt help [<command-name>]
+ For help on <command-name>. If not specified, print this message.
+
+
+ Available Commands:
+ version Display the Newt version number.
+ target Set and view target information
+ egg Commands to list and inspect eggs on a nest
+ nest Commands to manage nests & clutches (remote egg repositories)
+ help Help about any command
+
+ Flags:
+ -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.
+
+
+ Use "newt help [command]" for more information about a command.
</code></pre>
-</li>
-<li>
-<p>Without creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded a nest to try out the tool. </p>
-</li>
+
+<ul>
+<li>Without creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded a nest to try out the tool. </li>
</ul>
<h4 id="getting-the-debugger-ready_2">Getting the debugger ready<a class="headerlink" href="#getting-the-debugger-ready_2" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>Use Zadig to configure the USB driver for your Olimex debugger. If your debugger is already set up, you can skip this step.</p>
+<li>Use Zadig to configure the USB driver for your Olimex debugger. If your debugger is already set up, you can skip this step.</li>
+</ul>
<ol>
<li>Plug in your Olimex debugger.</li>
<li>Start Zadig.</li>
-<li>Check the Options -> List All Devices checkbox.</li>
+<li>Check the Options -> List All Devices checkbox. </li>
<li>Select "Olimex OpenOCD JTAG ARM-USB-TINY-H" in the dropdown menu.</li>
<li>Select the "WinUSB" driver.</li>
<li>Click the "Install Driver" button.</li>
</ol>
-</li>
-<li>
-<p>Proceed to the section on how to <a href="#using-sram-to-make-led-blink">make an LED blink</a> section.</p>
-</li>
+<ul>
+<li>Proceed to the section on how to <a href="#using-sram-to-make-led-blink">make an LED blink</a> section.</li>
</ul>
<h3 id="building-test-code-on-simulator">Building test code on simulator<a class="headerlink" href="#building-test-code-on-simulator" title="Permanent link">¶</a></h3>
<p>Note: On a Windows computer, the simulator can be run only in a Linux virtual environment. Make sure you have installed the Docker instance as outlined in <a href="#getting-your-windows-machine-ready-for-simulated-target">an earlier section</a>. Consequently, all <code>newt</code> commands must be prefaced with <code>newtvm</code>.</p>
@@ -806,139 +846,140 @@ Use "newt help [command]" for more information about a command.
<li>
<p>First, you have to create a repository for the project i.e. build your first nest! Go to ~/dev (or your base user directory on a Windows machine)and clone the larva repository from the apache git repository into a local directory named <code>larva</code>.</p>
<p>Substitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows. The newt tool commands do not change.</p>
-<pre><code>$ cd ~/dev
-$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva
-$ ls
-go larva
-$ cd larva
-$ ls
-LICENSE clutch.yml hw nest.yml project
-README.md compiler libs net scripts
+</li>
+</ol>
+<pre><code class="no-highlight"> $ cd ~/dev
+ $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva
+ $ ls
+ go larva
+ $ cd larva
+ $ ls
+ LICENSE clutch.yml hw nest.yml project
+ README.md compiler libs net scripts
</code></pre>
+
<p>On Windows, open a command prompt (e.g., Windows-R, "cmd", enter) and work from your home directory:</p>
-<pre><code>C:\Users\admin> git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva
-C:\Users\admin> cd larva
-C:\Users\admin\larva> dir
-Volume in drive C is Windows
-Volume Serial Number is 4CBB-0920
-
-Directory of C:\Users\admin\larva
-
-<DIR> .
-<DIR> ..
- 76 .gitignore
- 0 .gitmodules
- .nest
- 6,133 clutch.yml
-<DIR> compiler
-<DIR> hw
-<DIR> libs
- 11,560 LICENSE
- 20 nest.yml
-<DIR> net
-<DIR> project
- 2,263 README.md
-<DIR> scripts
-6 File(s) 20,052 bytes
-9 Dir(s) 90,723,442,688 bytes free
+<pre><code class="no-highlight"> C:\Users\admin> git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva
+ C:\Users\admin> cd larva
+ C:\Users\admin\larva> dir
+ Volume in drive C is Windows
+ Volume Serial Number is 4CBB-0920
+
+ Directory of C:\Users\admin\larva
+
+ <DIR> .
+ <DIR> ..
+ 76 .gitignore
+ 0 .gitmodules
+ .nest
+ 6,133 clutch.yml
+ <DIR> compiler
+ <DIR> hw
+ <DIR> libs
+ 11,560 LICENSE
+ 20 nest.yml
+ <DIR> net
+ <DIR> project
+ 2,263 README.md
+ <DIR> scripts
+ 6 File(s) 20,052 bytes
+ 9 Dir(s) 90,723,442,688 bytes free
</code></pre>
-</li>
-<li>
-<p>You will now create a new target using the newt tool. You can either use the compiled binary <code>newt</code> or run the newt.go program using <code>$newt</code> (assuming you have stored the command in a variable in your .bash_profile or .bashrc). When you do a <code>newt target show</code> or <code>$newt target show</code> it should list all the projects you have created so far. </p>
-<pre><code>$ newt target create sim_test
-Creating target sim_test
-Target sim_test sucessfully created!
-$ newt target show
-sim_test
- name: sim_test
- arch: sim
+
+<p>2. You will now create a new target using the newt tool. You can either use the compiled binary <code>newt</code> or run the newt.go program using <code>$newt</code> (assuming you have stored the command in a variable in your .bash_profile or .bashrc). When you do a <code>newt target show</code> or <code>$newt target show</code> it should list all the projects you have created so far. </p>
+<pre><code class="no-highlight"> $ newt target create sim_test
+ Creating target sim_test
+ Target sim_test sucessfully created!
+ $ newt target show
+ sim_test
+ name: sim_test
+ arch: sim
</code></pre>
+
<p>Remember, on a Windows machine you will have to preface <code>newt</code> with <code>newtvm</code>!</p>
-<pre><code>C:\Users\admin\larva>newtvm newt target create sim_test
+<pre><code class="no-highlight"> C:\Users\admin\larva>newtvm newt target create sim_test
</code></pre>
-</li>
-<li>
-<p>Now continue to populate and build out the sim project.</p>
-<pre><code>$ newt target set sim_test project=test
-Target sim_test successfully set project to test
-$ newt target set sim_test compiler_def=debug
-Target sim_test successfully set compiler_def to debug
-$ newt target set sim_test bsp=hw/bsp/native
-Target sim_test successfully set bsp to hw/bsp/native
-$ newt target set sim_test compiler=sim
-Target sim_test successfully set compiler to sim
-$ newt target show sim_test
-sim_test
- arch: sim
- project: test
- compiler_def: debug
- bsp: hw/bsp/native
- compiler: sim
- name: sim_test
+
+<p>3. Now continue to populate and build out the sim project.</p>
+<pre><code class="no-highlight"> $ newt target set sim_test project=test
+ Target sim_test successfully set project to test
+ $ newt target set sim_test compiler_def=debug
+ Target sim_test successfully set compiler_def to debug
+ $ newt target set sim_test bsp=hw/bsp/native
+ Target sim_test successfully set bsp to hw/bsp/native
+ $ newt target set sim_test compiler=sim
+ Target sim_test successfully set compiler to sim
+ $ newt target show sim_test
+ sim_test
+ arch: sim
+ project: test
+ compiler_def: debug
+ bsp: hw/bsp/native
+ compiler: sim
+ name: sim_test
</code></pre>
+
<p>Again remember to preface <code>newt</code> with <code>newtvm</code>on a Windows machine as shown below. Continue to fill out all the project attributes.</p>
-<pre><code>C:\Users\admin\larva>newtvm newt target set sim_test project=test
-Target sim_test successfully set project to test
+<pre><code class="no-highlight"> C:\Users\admin\larva>newtvm newt target set sim_test project=test
+ Target sim_test successfully set project to test
</code></pre>
-</li>
-<li>
-<p>Configure newt to use the gnu build tools native to OS X or linux. In order for sim to work properly, it needs to be using 32-bit gcc (gcc-5). Replace
+
+<p>4. Configure newt to use the gnu build tools native to OS X or linux. In order for sim to work properly, it needs to be using 32-bit gcc (gcc-5). Replace
~/dev/larva/compiler/sim/compiler.yml with the compiler/sim/osx-compiler.yml or linux-compiler.yml file, depending on the system. On a Windows machine follow the instruction for the Linux machine as you are running commands in a Linux VM.</p>
<p>For a Mac OS X environment:</p>
-<pre><code>$ cp compiler/sim/osx-compiler.yml compiler/sim/compiler.yml
+<pre><code class="no-highlight"> $ cp compiler/sim/osx-compiler.yml compiler/sim/compiler.yml
</code></pre>
+
<p>For a Linux machine:</p>
-<pre><code>$ cp compiler/sim/linux-compiler.yml compiler/sim/compiler.yml
+<pre><code class="no-highlight"> $ cp compiler/sim/linux-compiler.yml compiler/sim/compiler.yml
</code></pre>
-</li>
-<li>
-<p>Next, create (hatch!) the eggs for this project using the newt tool - basically, build the packages for it. You can specify the VERBOSE option if you want to see the gory details. Always remember to preface <code>newt</code> with <code>newtvm</code>on a Windows machine.</p>
-<pre><code>$ newt target build sim_test
-Successfully run!
+
+<p>5. Next, create (hatch!) the eggs for this project using the newt tool - basically, build the packages for it. You can specify the VERBOSE option if you want to see the gory details. Always remember to preface <code>newt</code> with <code>newtvm</code>on a Windows machine.</p>
+<pre><code class="no-highlight"> $ newt target build sim_test
+ Successfully run!
</code></pre>
+
<p>You can specify the VERBOSE option if you want to see the gory details.</p>
-<pre><code>$newt -l VERBOSE target build sim_test
-2015/09/29 09:46:12 [INFO] Building project test
-2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//bootutil...
-2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//cmsis-core...
-2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//ffs..
-...
-Successfully run!
+<pre><code class="no-highlight"> $newt -l VERBOSE target build sim_test
+ 2015/09/29 09:46:12 [INFO] Building project test
+ 2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//bootutil...
+ 2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//cmsis-core...
+ 2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//ffs..
+ ...
+ Successfully run!
</code></pre>
-</li>
-<li>
-<p>Try running the test suite executable inside this project and enjoy your first successful hatch.</p>
-<pre><code>$ newt ./project/test/bin/sim_test/test.elf
-[pass] os_mempool_test_suite/os_mempool_test_case
-[pass] os_mutex_test_suite/os_mutex_test_basic
-[pass] os_mutex_test_suite/os_mutex_test_case_1
-[pass] os_mutex_test_suite/os_mutex_test_case_2
-[pass] os_sem_test_suite/os_sem_test_basic
-[pass] os_sem_test_suite/os_sem_test_case_1
-[pass] os_sem_test_suite/os_sem_test_case_2
-[pass] os_sem_test_suite/os_sem_test_case_3
-[pass] os_sem_test_suite/os_sem_test_case_4
-[pass] os_mbuf_test_suite/os_mbuf_test_case_1
-[pass] os_mbuf_test_suite/os_mbuf_test_case_2
-[pass] os_mbuf_test_suite/os_mbuf_test_case_3
-[pass] gen_1_1/ffs_test_unlink
-[pass] gen_1_1/ffs_test_rename
-[pass] gen_1_1/ffs_test_truncate
-[pass] gen_1_1/ffs_test_append
-[pass] gen_1_1/ffs_test_read
-[pass] gen_1_1/ffs_test_overwrite_one
-[pass] gen_1_1/ffs_test_overwrite_two
-[pass] gen_1_1/ffs_test_overwrite_three
-...
-...
-[pass] boot_test_main/boot_test_vb_ns_11
+
+<p>6. Try running the test suite executable inside this project and enjoy your first successful hatch.</p>
+<pre><code class="no-highlight"> $ newt ./project/test/bin/sim_test/test.elf
+ [pass] os_mempool_test_suite/os_mempool_test_case
+ [pass] os_mutex_test_suite/os_mutex_test_basic
+ [pass] os_mutex_test_suite/os_mutex_test_case_1
+ [pass] os_mutex_test_suite/os_mutex_test_case_2
+ [pass] os_sem_test_suite/os_sem_test_basic
+ [pass] os_sem_test_suite/os_sem_test_case_1
+ [pass] os_sem_test_suite/os_sem_test_case_2
+ [pass] os_sem_test_suite/os_sem_test_case_3
+ [pass] os_sem_test_suite/os_sem_test_case_4
+ [pass] os_mbuf_test_suite/os_mbuf_test_case_1
+ [pass] os_mbuf_test_suite/os_mbuf_test_case_2
+ [pass] os_mbuf_test_suite/os_mbuf_test_case_3
+ [pass] gen_1_1/ffs_test_unlink
+ [pass] gen_1_1/ffs_test_rename
+ [pass] gen_1_1/ffs_test_truncate
+ [pass] gen_1_1/ffs_test_append
+ [pass] gen_1_1/ffs_test_read
+ [pass] gen_1_1/ffs_test_overwrite_one
+ [pass] gen_1_1/ffs_test_overwrite_two
+ [pass] gen_1_1/ffs_test_overwrite_three
+ ...
+ ...
+ [pass] boot_test_main/boot_test_vb_ns_11
</code></pre>
-</li>
-</ol>
+
<h3 id="using-sram-to-make-led-blink">Using SRAM to make LED blink<a class="headerlink" href="#using-sram-to-make-led-blink" title="Permanent link">¶</a></h3>
<p>You are here because you want to build an image to be run from internal SRAM on the Olimex board.</p>
<h4 id="preparing-the-software">Preparing the Software<a class="headerlink" href="#preparing-the-software" title="Permanent link">¶</a></h4>
-<ol>
+<ul>
<li>
<p>Make sure the PATH environment variable includes the $HOME/dev/go/bin directory (or C:\%GOPATH%\bin on Windows machine). </p>
<p>Substitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows (e.g. <code>cd dev\go</code> instead of <code>cd dev/go</code>). The newt tool commands do not change.</p>
@@ -946,87 +987,95 @@ Successfully run!
<li>
<p>If you have cloned the larva repository for the simulator test in the previous section you can skip this step. Otherwise, you have to create a repository for the project i.e. build your first nest! Go to ~/dev and clone the larva repository from the apache git repository into a local directory named <code>larva</code>.</p>
<p>Substitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows. The newt tool commands do not change.</p>
-<pre><code>$ cd ~/dev
-$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva
-$ ls
-go larva
-$ cd larva
-$ ls
-LICENSE clutch.yml hw nest.yml project
-README.md compiler libs net scripts
-</code></pre>
</li>
+</ul>
+<pre><code class="no-highlight"> $ cd ~/dev
+ $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva
+ $ ls
+ go larva
+ $ cd larva
+ $ ls
+ LICENSE clutch.yml hw nest.yml project
+ README.md compiler libs net scripts
+</code></pre>
+
+<ul>
<li>
<p>You first have to create a repository for the project. Go to the ~dev/larva directory and build out a second project inside larva. The project name is "blinky", in keeping with the objective. Starting with the target name, you have to specify the different aspects of the project to pull the appropriate eggs and build the right package for the board. In this case that means setting the architecture (arch), compiler, board support package (bsp), project, and compiler mode.</p>
-</li>
-</ol>
<p>Remember to prefix each command with "newtvm" if you are executing the newt command in a Linux virtual machine on your Windows box!</p>
-<pre><code> $ newt target create blinky
- Creating target blinky
- Target blinky sucessfully created!
- $ newt target set blinky arch=cortex_m4
- Target blinky successfully set arch to arm
- $ newt target set blinky compiler=arm-none-eabi-m4
- Target blinky successfully set compiler to arm-none-eabi-m4
- $ newt target set blinky project=blinky
- Target blinky successfully set project to blinky
- $ newt target set blinky compiler_def=debug
- Target blinky successfully set compiler_def to debug
- $ newt target set blinky bsp=hw/bsp/olimex_stm32-e407_devboard
- Target blinky successfully set bsp to hw/bsp/olimex_stm32-e407_devboard
- $ newt target show blinky
- blinky
- compiler: arm-none-eabi-m4
- project: blinky
- compiler_def: debug
- bsp: hw/bsp/olimex_stm32-e407_devboard
- name: blinky
- arch: cortex_m4
+</li>
+</ul>
+<pre><code class="no-highlight"> $ newt target create blinky
+ Creating target blinky
+ Target blinky sucessfully created!
+ $ newt target set blinky arch=cortex_m4
+ Target blinky successfully set arch to arm
+ $ newt target set blinky compiler=arm-none-eabi-m4
+ Target blinky successfully set compiler to arm-none-eabi-m4
+ $ newt target set blinky project=blinky
+ Target blinky successfully set project to blinky
+ $ newt target set blinky compiler_def=debug
+ Target blinky successfully set compiler_def to debug
+ $ newt target set blinky bsp=hw/bsp/olimex_stm32-e407_devboard
+ Target blinky successfully set bsp to hw/bsp/olimex_stm32-e407_devboard
+ $ newt target show blinky
+ blinky
+ compiler: arm-none-eabi-m4
+ project: blinky
+ compiler_def: debug
+ bsp: hw/bsp/olimex_stm32-e407_devboard
+ name: blinky
+ arch: cortex_m4
</code></pre>
-<ol>
+
+<ul>
<li>
<p>Now you have to build the image. The linker script within the <code>hw/bsp/olimex_stm32-e407_devboard</code> egg builds an image for flash memory by default. Since you want an image for the SRAM, you need to switch that script with <code>run_from_sram.ld</code> in order to get the egg to produce an image for SRAM. <font color="red"> We are working on making it easier to specify where the executable will be run from for a particular project and automatically choose the correct linker scripts and generate the appropriate image. It will be specified as a project identity e.g. bootloader, RAM, flash (default) and the target will build accordingly. </font>. </p>
<p>Once the target is built, you can find the executable "blinky.elf" in the project directory at ~/dev/larva/project/blinky/bin/blinky. It's a good idea to take a little time to understand the directory structure.</p>
-<pre><code>$ cd ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard
-$ diff olimex_stm32-e407_devboard.ld run_from_sram.ld
-$ cp run_from_sram.ld olimex_stm32-e407_devboard.ld
-$ cd ~/dev/larva/project/blinky/bin/blinky
-$ newt target build blinky
-Building target blinky (project = blinky)
-Compiling case.c
-Compiling suite.c
-...
-Successfully run!
-$ ls
-LICENSE clutch.yml hw nest.yml project
-README.md compiler libs net scripts
-$ cd project
-$ ls
-bin2img bletest blinky boot ffs2native test
-$ cd blinky
-$ ls
-bin blinky.yml egg.yml src
-$ cd bin
-$ ls
-blinky
-$ cd blinky
-$ ls
-blinky.elf blinky.elf.bin blinky.elf.cmd blinky.elf.lst blinky.elf.map
-</code></pre>
</li>
+</ul>
+<pre><code class="no-highlight"> $ cd ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard
+ $ diff olimex_stm32-e407_devboard.ld run_from_sram.ld
+ $ cp run_from_sram.ld olimex_stm32-e407_devboard.ld
+ $ cd ~/dev/larva/project/blinky/bin/blinky
+ $ newt target build blinky
+ Building target blinky (project = blinky)
+ Compiling case.c
+ Compiling suite.c
+ ...
+ Successfully run!
+ $ ls
+ LICENSE clutch.yml hw nest.yml project
+ README.md compiler libs net scripts
+ $ cd project
+ $ ls
+ bin2img bletest blinky boot ffs2native test
+ $ cd blinky
+ $ ls
+ bin blinky.yml egg.yml src
+ $ cd bin
+ $ ls
+ blinky
+ $ cd blinky
+ $ ls
+ blinky.elf blinky.elf.bin blinky.elf.cmd blinky.elf.lst blinky.elf.map
+</code></pre>
+
+<ul>
<li>
<p>Check that you have all the scripts needed to get OpenOCD up and talking with the project's specific hardware. Depending on your system (Ubuntu, Windows) you may already have the scripts in your <code>/usr/share/openocd/scripts/</code> directory as they may have been part of the openocd download. If yes, you are all set and can proceed to preparing the hardware.</p>
-</li>
-</ol>
<p>Otherwise check the <code>~/dev/larva/hw/bsp/olimex_stm32-e407_devboard</code> directory for a file named <code>f407.cfg</code>. That is the config we will use to talk to this specific hardware using OpenOCD. You are all set if you see it.</p>
-<pre><code> $ ls ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard
- bin olimex_stm32-e407_devboard_debug.sh
- boot-olimex_stm32-e407_devboard.ld olimex_stm32-e407_devboard_download.sh
- egg.yml run_from_flash.ld
- f407.cfg run_from_loader.ld
- include run_from_sram.ld
- olimex_stm32-e407_devboard.ld src
+</li>
+</ul>
+<pre><code class="no-highlight"> $ ls ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard
+ bin olimex_stm32-e407_devboard_debug.sh
+ boot-olimex_stm32-e407_devboard.ld olimex_stm32-e407_devboard_download.sh
+ egg.yml run_from_flash.ld
+ f407.cfg run_from_loader.ld
+ include run_from_sram.ld
+ olimex_stm32-e407_devboard.ld src
</code></pre>
+
<h4 id="preparing-the-hardware-to-boot-from-embedded-sram">Preparing the hardware to boot from embedded SRAM<a class="headerlink" href="#preparing-the-hardware-to-boot-from-embedded-sram" title="Permanent link">¶</a></h4>
<ol>
<li>
@@ -1048,232 +1097,235 @@ blinky.elf blinky.elf.bin blinky.elf.cmd blinky.elf.lst blinky.elf.map
</li>
</ol>
<h4 id="lets-go">Let's Go!<a class="headerlink" href="#lets-go" title="Permanent link">¶</a></h4>
-<ol>
-<li>
-<p>Make sure you are in the blinky project directory with the blinky.elf executable. Run the debug command in the newt tool. You should see some status messages are shown below. There is an inbuilt <code>-c "reset halt"</code> flag that tells it to halt after opening the session.</p>
-<pre><code>$ cd dev/larva/project/blinky/bin/blinky
-$ newt target debug blinky
-Debugging with /Users/aditihilbert/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_debug.sh blinky
-Debugging /Users/aditihilbert/dev/larva/project/blinky/bin/blinky/blinky.elf
-GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs
-Copyright (C) 2014 Free Software Foundation, Inc.
-License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-This is free software: you are free to change and redistribute it.
-There is NO WARRANTY, to the extent permitted by law. Type "show copying"
-and "show warranty" for details.
-This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-eabi".
-Type "show configuration" for configuration details.
-For bug reporting instructions, please see:
-<http://www.gnu.org/software/gdb/bugs/>.
-Find the GDB manual and other documentation resources online at:
-<http://www.gnu.org/software/gdb/documentation/>.
-For help, type "help".
-Type "apropos word" to search for commands related to "word"...
-Reading symbols from /Users/aditihilbert/dev/larva/project/blinky/bin/ blinky/blinky.elf...done.
-Open On-Chip Debugger 0.8.0 (2015-09-22-18:21)
-Licensed under GNU GPL v2
-For bug reports, read
- http://openocd.sourceforge.net/doc/doxygen/bugs.html
-Info : only one transport option; autoselect 'jtag'
-adapter speed: 1000 kHz
-adapter_nsrst_delay: 100
-jtag_ntrst_delay: 100
-Warn : target name is deprecated use: 'cortex_m'
-DEPRECATED! use 'cortex_m' not 'cortex_m3'
-cortex_m reset_config sysresetreq
-Info : clock speed 1000 kHz
-Info : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)
-Info : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)
-Info : stm32f4x.cpu: hardware has 6 breakpoints, 4 watchpoints
-Info : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)
-Info : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)
-target state: halted
-target halted due to debug-request, current mode: Thread
-xPSR: 0x01000000 pc: 0x20000250 msp: 0x10010000
-Info : accepting 'gdb' connection from 3333
-Info : device id = 0x10036413
-Info : flash size = 1024kbytes
-Reset_Handler () at startup_STM32F40x.s:199
-199 ldr r1, =__etext
+<ul>
+<li>Make sure you are in the blinky project directory with the blinky.elf executable. Run the debug command in the newt tool. You should see some status messages are shown below. There is an inbuilt <code>-c "reset halt"</code> flag that tells it to halt after opening the session.</li>
+</ul>
+<pre><code class="no-highlight"> $ cd dev/larva/project/blinky/bin/blinky
+ $ newt target debug blinky
+ Debugging with /Users/aditihilbert/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_debug.sh blinky
+ Debugging /Users/aditihilbert/dev/larva/project/blinky/bin/blinky/blinky.elf
+ GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs
+ Copyright (C) 2014 Free Software Foundation, Inc.
+ License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+ This is free software: you are free to change and redistribute it.
+ There is NO WARRANTY, to the extent permitted by law. Type "show copying"
+ and "show warranty" for details.
+ This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-eabi".
+ Type "show configuration" for configuration details.
+ For bug reporting instructions, please see:
+ <http://www.gnu.org/software/gdb/bugs/>.
+ Find the GDB manual and other documentation resources online at:
+ <http://www.gnu.org/software/gdb/documentation/>.
+ For help, type "help".
+ Type "apropos word" to search for commands related to "word"...
+ Reading symbols from /Users/aditihilbert/dev/larva/project/blinky/bin/ blinky/blinky.elf...done.
+ Open On-Chip Debugger 0.8.0 (2015-09-22-18:21)
+ Licensed under GNU GPL v2
+ For bug reports, read
+ http://openocd.sourceforge.net/doc/doxygen/bugs.html
+ Info : only one transport option; autoselect 'jtag'
+ adapter speed: 1000 kHz
+ adapter_nsrst_delay: 100
+ jtag_ntrst_delay: 100
+ Warn : target name is deprecated use: 'cortex_m'
+ DEPRECATED! use 'cortex_m' not 'cortex_m3'
+ cortex_m reset_config sysresetreq
+ Info : clock speed 1000 kHz
+ Info : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)
+ Info : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)
+ Info : stm32f4x.cpu: hardware has 6 breakpoints, 4 watchpoints
+ Info : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)
+ Info : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)
+ target state: halted
+ target halted due to debug-request, current mode: Thread
+ xPSR: 0x01000000 pc: 0x20000250 msp: 0x10010000
+ Info : accepting 'gdb' connection from 3333
+ Info : device id = 0x10036413
+ Info : flash size = 1024kbytes
+ Reset_Handler () at startup_STM32F40x.s:199
+ 199 ldr r1, =__etext
</code></pre>
+
<p>Check the value of the msp (main service pointer) register. If it is not 0x10010000 as indicated above, you will have to manually set it after you open the gdp tool and load the image on it. </p>
-<pre><code>(gdb) set $msp=0x10010000
+<pre><code class="no-highlight"> (gdb) set $msp=0x10010000
</code></pre>
+
<p>Now load the image and type "c" or "continue" from the GNU debugger. </p>
-<pre><code>(gdb) load ~/dev/larva/project/blinky/bin/blinky/blinky.elf
-Loading section .text, size 0x4294 lma 0x20000000
-Loading section .ARM.extab, size 0x24 lma 0x20004294
-Loading section .ARM.exidx, size 0xd8 lma 0x200042b8
-Loading section .data, size 0x874 lma 0x20004390
-Start address 0x20000250, load size 19460
-Transfer rate: 81 KB/sec, 2432 bytes/write.
-(gdb) c
-Continuing.
+<pre><code class="no-highlight"> (gdb) load ~/dev/larva/project/blinky/bin/blinky/blinky.elf
+ Loading section .text, size 0x4294 lma 0x20000000
+ Loading section .ARM.extab, size 0x24 lma 0x20004294
+ Loading section .ARM.exidx, size 0xd8 lma 0x200042b8
+ Loading section .data, size 0x874 lma 0x20004390
+ Start address 0x20000250, load size 19460
+ Transfer rate: 81 KB/sec, 2432 bytes/write.
+ (gdb) c
+ Continuing.
</code></pre>
-</li>
-<li>
-<p>Voilà! The board's LED should be blinking at 1 Hz.</p>
-</li>
-</ol>
+
+<ul>
+<li>Voilà! The board's LED should be blinking at 1 Hz.</li>
+</ul>
<h3 id="using-flash-to-make-led-blink">Using flash to make LED blink<a class="headerlink" href="#using-flash-to-make-led-blink" title="Permanent link">¶</a></h3>
<p>You are here because you want to build an image to be run from flash memory on the Olimex board.</p>
-<ol>
+<ul>
<li>Configure the board to boot from flash by moving the two jumpers together to B0_0 and B1_0. Refer to the pictures of the board under the section titled <a href="#preparing-the-hardware-to-boot-from-embedded-sram">"Preparing the hardware to boot from embedded SRAM"</a>.</li>
-</ol>
+</ul>
<p>You will have to reset the board once the image is uploaded to it.</p>
-<ol>
-<li>
-<p>If you skipped the first option for the project <a href="#using-sram-to-make-led-blink">(downloading an image to SRAM)</a>, then skip this step. Otherwise, continue with this step. </p>
+<ul>
+<li>If you skipped the first option for the project <a href="#using-sram-to-make-led-blink">(downloading an image to SRAM)</a>, then skip this step. Otherwise, continue with this step. </li>
+</ul>
<p>By default, the linker script (<code>olimex_stm32-e407_devboard.ld</code>) is configured to run from bootloader and flash. However, if you first ran the image from SRAM you had changed <code>olimex_stm32-e407_devboard.ld</code> to match <code>run_from_sram.ld</code>. You will therefore return to defaults with <code>olimex_stm32-e407_devboard.ld</code> linker script matching the contents of 'run_from_loader.ld'. Return to the project directory.</p>
-<pre><code>$ cd ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard
-$ diff olimex_stm32-e407_devboard.ld run_from_sram.ld
-$ diff olimex_stm32-e407_devboard.ld run_from_loader.ld
-$ cp run_from_loader.ld olimex_stm32-e407_devboard.ld
-$ cd ~/dev/larva/project/blinky/bin/blinky
+<pre><code class="no-highlight"> $ cd ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard
+ $ diff olimex_stm32-e407_devboard.ld run_from_sram.ld
+ $ diff olimex_stm32-e407_devboard.ld run_from_loader.ld
+ $ cp run_from_loader.ld olimex_stm32-e407_devboard.ld
+ $ cd ~/dev/larva/project/blinky/bin/blinky
</code></pre>
-</li>
-<li>
-<p>In order to run the image from flash, you need to build the bootloader as well. The bootloader does the initial bring up of the Olimex board and then transfers control to the image stored at a location in flash known to it. The bootloader in turn requires the bin2image tool to check the image header for version information, CRC checks etc. So, we will need to build these two additional targets (bootloader and bin2img).</p>
-</li>
-</ol>
+
+<ul>
+<li>In order to run the image from flash, you need to build the bootloader as well. The bootloader does the initial bring up of the Olimex board and then transfers control to the image stored at a location in flash known to it. The bootloader in turn requires the bin2image tool to check the image header for version information, CRC checks etc. So, we will need to build these two additional targets (bootloader and bin2img).</li>
+</ul>
<p>Let's first create bin2img:</p>
-<pre><code> $ newt target create bin2img
- Creating target bin2img
- Target bin2img successfully created!
- $ newt target set bin2img arch=sim
- Target bin2img successfully set arch to sim
- $ newt target set bin2img compiler=sim
- Target bin2img successfully set compiler to sim
- $ newt target set bin2img project=bin2img
- Target bin2img successfully set project to bin2img
- $ newt target set bin2img compiler_def=debug
- Target bin2img successfully set compiler_def to debug
- $ newt target set bin2img bsp=hw/bsp/native
- Target bin2img successfully set bsp to hw/bsp/native
- $ newt target show bin2img
- bin2img
- arch: sim
- compiler: sim
- project: bin2img
- compiler_def: debug
- bsp: hw/bsp/native
- name: bin2img
+<pre><code class="no-highlight"> $ newt target create bin2img
+ Creating target bin2img
+ Target bin2img successfully created!
+ $ newt target set bin2img arch=sim
+ Target bin2img successfully set arch to sim
+ $ newt target set bin2img compiler=sim
+ Target bin2img successfully set compiler to sim
+ $ newt target set bin2img project=bin2img
+ Target bin2img successfully set project to bin2img
+ $ newt target set bin2img compiler_def=debug
+ Target bin2img successfully set compiler_def to debug
+ $ newt target set bin2img bsp=hw/bsp/native
+ Target bin2img successfully set bsp to hw/bsp/native
+ $ newt target show bin2img
+ bin2img
+ arch: sim
+ compiler: sim
+ project: bin2img
+ compiler_def: debug
+ bsp: hw/bsp/native
+ name: bin2img
</code></pre>
+
<p>And then let's create boot_olimex:</p>
-<pre><code> $ newt target create boot_olimex
- Creating target boot_olimex
- Target boot_olimex successfully created!
- $ newt target set boot_olimex arch=cortex_m4
- Target boot_olimex successfully set arch to cortex_m4
- $ newt target set boot_olimex compiler=arm-none-eabi-m4
- Target boot_olimex successfully set compiler to arm-none-eabi-m4
- $ newt target set boot_olimex project=boot
- Target boot_olimex successfully set project to boot
- $ newt target set boot_olimex compiler_def=optimized
- Target boot_olimex successfully set compiler_def to optimized
- $ newt target set boot_olimex bsp=hw/bsp/olimex_stm32-e407_devboard
- Target boot_olimex successfully set bsp to hw/bsp/olimex_stm32-e407_devboard
- $ newt target show boot_olimex
- boot_olimex
- project: boot
- compiler_def: optimized
- bsp: hw/bsp/olimex_stm32-e407_devboard
- name: boot_olimex
- arch: cortex_m4
- compiler: arm-none-eabi-m4
+<pre><code class="no-highlight"> $ newt target create boot_olimex
+ Creating target boot_olimex
+ Target boot_olimex successfully created!
+ $ newt target set boot_olimex arch=cortex_m4
+ Target boot_olimex successfully set arch to cortex_m4
+ $ newt target set boot_olimex compiler=arm-none-eabi-m4
+ Target boot_olimex successfully set compiler to arm-none-eabi-m4
+ $ newt target set boot_olimex project=boot
+ Target boot_olimex successfully set project to boot
+ $ newt target set boot_olimex compiler_def=optimized
+ Target boot_olimex successfully set compiler_def to optimized
+ $ newt target set boot_olimex bsp=hw/bsp/olimex_stm32-e407_devboard
+ Target boot_olimex successfully set bsp to hw/bsp/olimex_stm32-e407_devboard
+ $ newt target show boot_olimex
+ boot_olimex
+ project: boot
+ compiler_def: optimized
+ bsp: hw/bsp/olimex_stm32-e407_devboard
+ name: boot_olimex
+ arch: cortex_m4
+ compiler: arm-none-eabi-m4
</code></pre>
-<ol>
-<li>
-<p>Let's build all the three targets now.</p>
-<pre><code>$ newt target build bin2img
-Building target bin2img (project = bin2img)
-Building project bin2img
-Successfully run!
-$ newt target build boot_olimex
-Building target boot_olimex (project = boot)
-Building project boot
-Successfully run!
-$ newt target build blinky
-Building target blinky (project = blinky)
-Building project blinky
-Successfully run!
+
+<ul>
+<li>Let's build all the three targets now.</li>
+</ul>
+<pre><code class="no-highlight"> $ newt target build bin2img
+ Building target bin2img (project = bin2img)
+ Building project bin2img
+ Successfully run!
+ $ newt target build boot_olimex
+ Building target boot_olimex (project = boot)
+ Building project boot
+ Successfully run!
+ $ newt target build blinky
+ Building target blinky (project = blinky)
+ Building project blinky
+ Successfully run!
</code></pre>
-</li>
-<li>
-<p>Go to the project directory and download the bootloader and the image to flash ... in a flash! </p>
-<pre><code>$ cd ~/dev/larva/project/blinky/bin/blinky
-$ newt target download boot_olimex
-Downloading with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_download.sh
-$ newt target download blinky
-Downloading with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_download.sh
+
+<ul>
+<li>Go to the project directory and download the bootloader and the image to flash ... in a flash! </li>
+</ul>
+<pre><code class="no-highlight"> $ cd ~/dev/larva/project/blinky/bin/blinky
+ $ newt target download boot_olimex
+ Downloading with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_download.sh
+ $ newt target download blinky
+ Downloading with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_download.sh
</code></pre>
-</li>
+
+<ul>
<li>
<p>The LED should be blinking!</p>
</li>
<li>
<p>But wait...let's double check that it is indeed booting from flash and making the LED blink from the image in flash. Pull the USB cable off the Olimex JTAG adaptor. The debug connection to the JTAG port is now severed. Next power off the Olimex board by pulling out the USB cable from the board. Wait for a couple of seconds and plug the USB cable back to the board. </p>
+</li>
+</ul>
<p>The LED light will start blinking again. Success!</p>
<p>Note #1: If you want to download the image to flash and a gdb session opened up, use <code>newt target debug blinky</code> instead of <code>newt target download blinky</code>.</p>
-<pre><code>$ newt target debug blinky
-Debugging with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_debug.sh blinky
-Debugging ~/dev/larva/project/blinky/bin/blinky/blinky.elf
-GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs
-Copyright (C) 2014 Free Software Foundation, Inc.
-License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-This is free software: you are free to change and redistribute it.
-There is NO WARRANTY, to the extent permitted by law. Type "show copying"
-and "show warranty" for details.
-This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-eabi".
-Type "show configuration" for configuration details.
-For bug reporting instructions, please see:
-<http://www.gnu.org/software/gdb/bugs/>.
-Find the GDB manual and other documentation resources online at:
-<http://www.gnu.org/software/gdb/documentation/>.
-For help, type "help".
-Type "apropos word" to search for commands related to "word"...
-Reading symbols from /Users/aditihilbert/dev/larva/project/blinky/bin/blinky/blinky.elf...done.
-Open On-Chip Debugger 0.8.0 (2015-09-22-18:21)
-Licensed under GNU GPL v2
-For bug reports, read
- http://openocd.sourceforge.net/doc/doxygen/bugs.html
-Info : only one transport option; autoselect 'jtag'
-adapter speed: 1000 kHz
-adapter_nsrst_delay: 100
-jtag_ntrst_delay: 100
-Warn : target name is deprecated use: 'cortex_m'
-DEPRECATED! use 'cortex_m' not 'cortex_m3'
-cortex_m reset_config sysresetreq
-Info : clock speed 1000 kHz
-Info : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)
-Info : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)
-Info : stm32f4x.cpu: hardware has 6 breakpoints, 4 watchpoints
-Info : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)
-Info : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)
-target state: halted
-target halted due to debug-request, current mode: Thread
-xPSR: 0x01000000 pc: 0x08000250 msp: 0x10010000
-Info : accepting 'gdb' connection from 3333
-Info : device id = 0x10036413
-Info : flash size = 1024kbytes
-Reset_Handler () at startup_STM32F40x.s:199
-199 ldr r1, =__etext
-(gdb)
+<pre><code class="no-highlight"> $ newt target debug blinky
+ Debugging with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_debug.sh blinky
+ Debugging ~/dev/larva/project/blinky/bin/blinky/blinky.elf
+ GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs
+ Copyright (C) 2014 Free Software Foundation, Inc.
+ License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+ This is free software: you are free to change and redistribute it.
+ There is NO WARRANTY, to the extent permitted by law. Type "show copying"
+ and "show warranty" for details.
+ This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-eabi".
+ Type "show configuration" for configuration details.
+ For bug reporting instructions, please see:
+ <http://www.gnu.org/software/gdb/bugs/>.
+ Find the GDB manual and other documentation resources online at:
+ <http://www.gnu.org/software/gdb/documentation/>.
+ For help, type "help".
+ Type "apropos word" to search for commands related to "word"...
+ Reading symbols from /Users/aditihilbert/dev/larva/project/blinky/bin/blinky/blinky.elf...done.
+ Open On-Chip Debugger 0.8.0 (2015-09-22-18:21)
+ Licensed under GNU GPL v2
+ For bug reports, read
+ http://openocd.sourceforge.net/doc/doxygen/bugs.html
+ Info : only one trans
<TRUNCATED>
[7/7] incubator-mynewt-site git commit: Fix second level navigation
and function formats in docs
Posted by ad...@apache.org.
Fix second level navigation and function formats in docs
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/bc3112c0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/bc3112c0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/bc3112c0
Branch: refs/heads/asf-site
Commit: bc3112c09fbdd3dd966b7a51d48d92cba5fd0d3f
Parents: 5c95183
Author: aditihilbert <ad...@runtime.io>
Authored: Wed Jan 13 10:26:16 2016 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Wed Jan 13 10:26:16 2016 -0800
----------------------------------------------------------------------
css/custom.css | 61 +-
download/index.html | 5 +-
extra.css | 23 +
get_acclimated/project2/index.html | 668 ++++++------
get_acclimated/project3/index.html | 10 +-
get_acclimated/vocabulary/index.html | 77 +-
get_started/how_to_edit_docs/index.html | 257 +++--
get_started/newt_concepts/index.html | 20 +-
get_started/project1/index.html | 1480 +++++++++++++-------------
get_started/try_markdown/index.html | 14 +-
mkdocs/search_index.json | 383 ++++++-
modules/bootloader/index.html | 61 +-
modules/console/index.html | 172 +--
modules/filesystem/index.html | 55 +-
modules/shell/index.html | 64 +-
modules/testutil/index.html | 61 +-
newt/newt_ops/index.html | 8 +-
newt/newt_tool_reference/index.html | 20 +-
os/callout/index.html | 79 +-
os/context_switch/index.html | 70 +-
os/event_queue/index.html | 76 +-
os/heap/index.html | 76 +-
os/mbufs/index.html | 76 +-
os/memory_pool/index.html | 77 +-
os/mutex/index.html | 92 +-
os/mynewt_os/index.html | 80 +-
os/port_os/index.html | 34 +-
os/sanity/index.html | 77 +-
os/semaphore/index.html | 89 +-
os/task/index.html | 77 +-
os/time/index.html | 66 +-
packaging/dist/index.html | 4 +-
sitemap.xml | 66 +-
33 files changed, 2589 insertions(+), 1889 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/css/custom.css
----------------------------------------------------------------------
diff --git a/css/custom.css b/css/custom.css
index af92a14..f4dd137 100644
--- a/css/custom.css
+++ b/css/custom.css
@@ -31,8 +31,7 @@ h1 {
color: #42567E;
}
-h2,
-h3 {
+h2, h3 {
color: #42567E;
font-weight: 300;
}
@@ -219,6 +218,13 @@ body {
max-width: 280px;
}
+#search-input {
+ background-color: #fff;
+ box-shadow: none;
+ border-radius: 0;
+ -webkit-appearance: none;
+}
+
#rtd-search-form input,
#rtd-search-form button {
border: 1px solid #BFBFBF;
@@ -234,21 +240,17 @@ body {
#rtd-search-form button {
background-color: #ffffff;
- border-left: 0;
-
+ border-left: 0;
color: #42567E;
font-size: 20px;
-
width: 15%;
height: 44px;
-
-
+ margin-left: -10px;
position: relative;
- margin-left: -5px;
- top: 1px;
+ top: 2px;
+ padding: 6px 10px;
}
-
.home .search-container {
padding: 60px 30px;
margin-bottom: 20px;
@@ -259,25 +261,6 @@ body {
margin-bottom: 20px;
}
-.home #rtd-search-form input {
- border-right: 0;
- width: 80%;
- padding: 6px 10px;
- height: 44px;
- font-size: 18px;
-}
-
-.home #rtd-search-form button {
- background-color: #ffffff;
- margin-left: -5px;
- border-left: 0;
- color: #42567E;
- width: 15%;
- font-size: 20px;
- height: 44px;
- top: 0px;
-}
-
div.col-md-2 {
padding-left: 0;
}
@@ -319,10 +302,6 @@ footer .footnote {
/* margin-bottom: 40px; */
}
-.main-banner img {
- margin-bottom: 20px;
-}
-
.home h2 {
font-size: 26px;
}
@@ -410,6 +389,7 @@ footer .footnote {
}
.doc-section {
+ padding: 15px !important;
min-height: 300px;
margin-bottom: 20px;
}
@@ -618,4 +598,17 @@ a.bold-link:hover {
.event {
margin: 40px 0;
-}
\ No newline at end of file
+}
+
+.sidebar-container .nav>li>a:hover,
+.sidebar-container .nav>li>a:focus {
+ background-color: #F2853F;
+}
+
+code {
+ font-family: "Courier New";
+}
+
+li.toctree-l3 {
+ padding-left: 20px;
+}
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/download/index.html
----------------------------------------------------------------------
diff --git a/download/index.html b/download/index.html
index e970562..0d125ac 100644
--- a/download/index.html
+++ b/download/index.html
@@ -183,10 +183,11 @@
<p>If you are not a committer, follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is https://git-wip-us.apache.org/docs/workflow.html.</p>
<p>To clone the Mynewt OS development repository:</p>
<p><strong>Non Committers</strong></p>
-<pre><code>$ git clone http://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git
+<pre><code class="no-highlight"> $ git clone http://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git
</code></pre>
+
<p><strong>Committers</strong></p>
-<pre><code>$ git clone https://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git
+<pre><code class="no-highlight"> $ git clone https://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git
</code></pre>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/extra.css
----------------------------------------------------------------------
diff --git a/extra.css b/extra.css
index 98acda9..54322d5 100644
--- a/extra.css
+++ b/extra.css
@@ -1,4 +1,27 @@
/*
+ * Tweak the headers to better match RTD.
+ */
+
+body {
+ font-size: 100%;
+}
+
+
+h4, h5, h6 {
+ color: black;
+ font-weight: 300;
+ text-decoration: underline;
+}
+
+hr {
+ height: 4px;
+ background-color:#42567E;
+ color: #42567E;
+ border: 0 none;
+}
+
+
+/*
* Fix wrapping in the code highlighting
*
* https://github.com/mkdocs/mkdocs/issues/233
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/get_acclimated/project2/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/project2/index.html b/get_acclimated/project2/index.html
index d2d4e04..9c88869 100644
--- a/get_acclimated/project2/index.html
+++ b/get_acclimated/project2/index.html
@@ -126,13 +126,23 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../vocabulary/">Understanding Newt Terms</a></li>
+ <li class="toctree-l2"><a href="../vocabulary/">Understanding Newt Terms</a></li>
- <li class="toctree-l3"><a href="./">Project 2</a></li>
+ <li class="toctree-l2"><a href="./">Project 2</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#objective">Objective</a></li>
+
+ <li class="toctree-l3"><a href="#stm32f303vc-mcu">STM32F303VC MCU</a></li>
+
+ <li class="toctree-l3"><a href="#nrf52-series">nRF52 Series</a></li>
+
+
- <li class="toctree-l3"><a href="../project3/">Project 3</a></li>
+ <li class="toctree-l2"><a href="../project3/">Project 3</a></li>
</ul>
@@ -201,126 +211,133 @@
</ul>
<h4 id="step-by-step-instructions-to-build-image">Step by Step Instructions to build image<a class="headerlink" href="#step-by-step-instructions-to-build-image" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>The first step is to download the generic skeleton of the project. The eggs constituting the skeleton are not hardware architecture specific. The skeleton is maintained as a nest in a separate repository on Apache. You know it is a nest because there is a nest.yml file. </p>
-<pre><code>[user:~/dev]$ newt nest create test_project
-Downloading nest skeleton from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-tadpole.git... ok!
-Nest test_project successfully created in ~/dev/go/test_project
-
-[user:~/dev]$ cd test_project/
-[user:~/dev/test_project]$ ls
-README.md compiler hw libs nest.yml
+<li>The first step is to download the generic skeleton of the project. The eggs constituting the skeleton are not hardware architecture specific. The skeleton is maintained as a nest in a separate repository on Apache. You know it is a nest because there is a nest.yml file. </li>
+</ul>
+<pre><code class="no-highlight"> [user:~/dev]$ newt nest create test_project
+ Downloading nest skeleton from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-tadpole.git... ok!
+ Nest test_project successfully created in ~/dev/go/test_project
+
+ [user:~/dev]$ cd test_project/
+ [user:~/dev/test_project]$ ls
+ README.md compiler hw libs nest.yml
</code></pre>
-</li>
-<li>
-<p>Next, the clutch of eggs named larva is added from the nest (also named larva) from another repository on Apache. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (<code>clutch.yml</code>) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.</p>
-<pre><code>[user:~/dev/test_project]$ newt nest add-clutch larva https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
-Downloading clutch.yml from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!
-Verifying clutch.yml format...
-ok!
-Clutch larva successfully installed to Nest.
+
+<ul>
+<li>Next, the clutch of eggs named larva is added from the nest (also named larva) from another repository on Apache. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (<code>clutch.yml</code>) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.</li>
+</ul>
+<pre><code class="no-highlight"> [user:~/dev/test_project]$ newt nest add-clutch larva https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+ Downloading clutch.yml from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!
+ Verifying clutch.yml format...
+ ok!
+ Clutch larva successfully installed to Nest.
</code></pre>
-</li>
-<li>
-<p>The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. </p>
-<pre><code>[user:~/dev/test_project]$ newt egg install project/blinky
-Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!
-Installing project/blinky
-Installing libs/console/full
-Installing libs/shell
-Installation was a success!
-
-[user:~/dev/test_project]$ newt egg install hw/bsp/stm32f3discovery
-Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!
-Installing hw/bsp/stm32f3discovery
-Installing hw/mcu/stm/stm32f3xx
-Installing libs/cmsis-core
-Installing compiler/arm-none-eabi-m4
-Installation was a success!
+
+<ul>
+<li>The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. </li>
+</ul>
+<pre><code class="no-highlight">
+ [user:~/dev/test_project]$ newt egg install project/blinky
+ Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!
+ Installing project/blinky
+ Installing libs/console/full
+ Installing libs/shell
+ Installation was a success!
+
+ [user:~/dev/test_project]$ newt egg install hw/bsp/stm32f3discovery
+ Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!
+ Installing hw/bsp/stm32f3discovery
+ Installing hw/mcu/stm/stm32f3xx
+ Installing libs/cmsis-core
+ Installing compiler/arm-none-eabi-m4
+ Installation was a success!
</code></pre>
-</li>
-<li>
-<p>It's time to create a target for the project and define the target attributes. </p>
-<pre><code>[user:~/dev/test_project]$ newt target create blink_f3disc
-Creating target blink_f3disc
-Target blink_f3disc successfully created!
-
-[user:~/dev/test_project]$ newt target set blink_f3disc project=blinky
-Target blink_f3disc successfully set project to blinky
-
-[user:~/dev/test_project]$ newt target set blink_f3disc bsp=hw/bsp/stm32f3discovery
-Target blink_f3disc successfully set bsp to hw/bsp/stm32f3discovery
-
-[user:~/dev/test_project]$ newt target set blink_f3disc compiler_def=debug
-Target blink_f3disc successfully set compiler_def to debug
-
-[user:~/dev/test_project]$ newt target set blink_f3disc compiler=arm-none-eabi-m4
-Target blink_f3disc successfully set compiler to arm-none-eabi-m4
-
-[user:~/dev/test_project]$ newt target set blink_f3disc arch=cortex_m4
-Target blink_f3disc successfully set arch to cortex_m4
-
-[user:~/dev/test_project]$ newt target show blink_f3disc
-blink_f3disc
- arch: cortex_m4
- project: blinky
- bsp: hw/bsp/stm32f3discovery
- compiler_def: debug
- compiler: arm-none-eabi-m4
- name: blink_f3disc
+
+<ul>
+<li>It's time to create a target for the project and define the target attributes. </li>
+</ul>
+<pre><code class="no-highlight"> [user:~/dev/test_project]$ newt target create blink_f3disc
+ Creating target blink_f3disc
+ Target blink_f3disc successfully created!
+
+ [user:~/dev/test_project]$ newt target set blink_f3disc project=blinky
+ Target blink_f3disc successfully set project to blinky
+
+ [user:~/dev/test_project]$ newt target set blink_f3disc bsp=hw/bsp/stm32f3discovery
+ Target blink_f3disc successfully set bsp to hw/bsp/stm32f3discovery
+
+ [user:~/dev/test_project]$ newt target set blink_f3disc compiler_def=debug
+ Target blink_f3disc successfully set compiler_def to debug
+
+ [user:~/dev/test_project]$ newt target set blink_f3disc compiler=arm-none-eabi-m4
+ Target blink_f3disc successfully set compiler to arm-none-eabi-m4
+
+ [user:~/dev/test_project]$ newt target set blink_f3disc arch=cortex_m4
+ Target blink_f3disc successfully set arch to cortex_m4
+
+ [user:~/dev/test_project]$ newt target show blink_f3disc
+ blink_f3disc
+ arch: cortex_m4
+ project: blinky
+ bsp: hw/bsp/stm32f3discovery
+ compiler_def: debug
+ compiler: arm-none-eabi-m4
+ name: blink_f3disc
</code></pre>
-</li>
+
+<ul>
<li>
<p>Next, you get to build the target and generate an executable that can then be uploaded to the board. The STM32F3DISCOVERY board includes an ST-LINK/V2 embedded debug tool interface that will be used to program/debug the board. To program the MCU on the board, simply plug in the two jumpers on CN4, as shown in the picture in red. If you want to learn more about the board you will find the User Manual at <a href="http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf">http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf</a></p>
</li>
<li>
<p><img alt="STMdiscovery" src="../pics/STM32f3discovery_connector.png" /></p>
-<pre><code>[user:~/dev/test_project]$ newt target build blink_f3disc
-Building target blink_f3disc (project = blinky)
-Compiling case.c
-Compiling suite.c
-Compiling testutil.c
-Compiling testutil_arch_arm.c
-Archiving libtestutil.a
-Compiling os.c
-Compiling os_callout.c
-Compiling os_eventq.c
-Compiling os_heap.c
-Compiling os_mbuf.c
-Compiling os_mempool.c
-Compiling os_mutex.c
-Compiling os_sanity.c
-Compiling os_sched.c
-Compiling os_sem.c
-Compiling os_task.c
-Compiling os_time.c
-Compiling os_arch_arm.c
-Assembling HAL_CM4.s
-Assembling SVC_Table.s
-Archiving libos.a
-Compiling hal_gpio.c
-Compiling stm32f3xx_hal_gpio.c
-Archiving libstm32f3xx.a
-Compiling cmsis_nvic.c
-Compiling libc_stubs.c
-Compiling os_bsp.c
-Compiling sbrk.c
-Compiling system_stm32f3xx.c
-Assembling startup_stm32f303xc.s
-Archiving libstm32f3discovery.a
-Compiling main.c
-Building project blinky
-Linking blinky.elf
-Successfully run!
-</code></pre>
</li>
-<li>
-<p>Finally, you have to download the image on to the board. You will see a blue light start to blink.</p>
-<pre><code>[user:~/dev/test_project]$ newt target download blink_f3disc
-Downloading with /Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3discovery_download.sh
+</ul>
+<pre><code class="no-highlight"> [user:~/dev/test_project]$ newt target build blink_f3disc
+ Building target blink_f3disc (project = blinky)
+ Compiling case.c
+ Compiling suite.c
+ Compiling testutil.c
+ Compiling testutil_arch_arm.c
+ Archiving libtestutil.a
+ Compiling os.c
+ Compiling os_callout.c
+ Compiling os_eventq.c
+ Compiling os_heap.c
+ Compiling os_mbuf.c
+ Compiling os_mempool.c
+ Compiling os_mutex.c
+ Compiling os_sanity.c
+ Compiling os_sched.c
+ Compiling os_sem.c
+ Compiling os_task.c
+ Compiling os_time.c
+ Compiling os_arch_arm.c
+ Assembling HAL_CM4.s
+ Assembling SVC_Table.s
+ Archiving libos.a
+ Compiling hal_gpio.c
+ Compiling stm32f3xx_hal_gpio.c
+ Archiving libstm32f3xx.a
+ Compiling cmsis_nvic.c
+ Compiling libc_stubs.c
+ Compiling os_bsp.c
+ Compiling sbrk.c
+ Compiling system_stm32f3xx.c
+ Assembling startup_stm32f303xc.s
+ Archiving libstm32f3discovery.a
+ Compiling main.c
+ Building project blinky
+ Linking blinky.elf
+ Successfully run!
</code></pre>
-</li>
+
+<ul>
+<li>Finally, you have to download the image on to the board. You will see a blue light start to blink.</li>
</ul>
+<pre><code class="no-highlight"> [user:~/dev/test_project]$ newt target download blink_f3disc
+ Downloading with /Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3discovery_download.sh
+</code></pre>
+
<h3 id="nrf52-series">nRF52 Series<a class="headerlink" href="#nrf52-series" title="Permanent link">¶</a></h3>
<h4 id="hardware-needed_1">Hardware needed<a class="headerlink" href="#hardware-needed_1" title="Permanent link">¶</a></h4>
<ul>
@@ -329,232 +346,241 @@ Downloading with /Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3dis
</ul>
<h4 id="step-by-step-instructions-to-build-image_1">Step by Step Instructions to build image<a class="headerlink" href="#step-by-step-instructions-to-build-image_1" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>The first step is to download the generic skeleton of the project. The eggs installed are not hardware architecture specific.</p>
-<pre><code>[]user@~/dev]$ newt nest create nordic_blinky
-Downloading nest skeleton from https://www.github.com/mynewt/tadpole... ok!
-Nest nordic_blinky successfully created in ~dev/nordic_blinky
+<li>The first step is to download the generic skeleton of the project. The eggs installed are not hardware architecture specific.</li>
+</ul>
+<pre><code class="no-highlight"> []user@~/dev]$ newt nest create nordic_blinky
+ Downloading nest skeleton from https://www.github.com/mynewt/tadpole... ok!
+ Nest nordic_blinky successfully created in ~dev/nordic_blinky
-user@~/dev$ cd nordic_blinky/
+ user@~/dev$ cd nordic_blinky/
</code></pre>
-</li>
-<li>
-<p>Then, the clutch of eggs named larva is added from the nest (also named larva) on the github. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (<code>clutch.yml</code>) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.</p>
-<pre><code>[]user@~/dev/nordic_blinky]$ newt nest add-clutch larva https://github.com/mynewt/larva
-Downloading clutch.yml from https://github.com/mynewt/larva/master... ok!
-Verifying clutch.yml format...ok!
-Clutch larva successfully installed to Nest.
+
+<ul>
+<li>Then, the clutch of eggs named larva is added from the nest (also named larva) on the github. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (<code>clutch.yml</code>) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.</li>
+</ul>
+<pre><code class="no-highlight"> []user@~/dev/nordic_blinky]$ newt nest add-clutch larva https://github.com/mynewt/larva
+ Downloading clutch.yml from https://github.com/mynewt/larva/master... ok!
+ Verifying clutch.yml format...ok!
+ Clutch larva successfully installed to Nest.
</code></pre>
-</li>
-<li>
-<p>The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. </p>
-<pre><code>[user@~/dev/nordic_blinky]$ newt egg install project/blinky
-Downloading larva from https://github.com/mynewt/larva//master... ok!
-Installing project/blinky
-Installation was a success!
-
-[user@~/dev/nordic_blinky]$ newt egg install hw/bsp/nrf52pdk
-Downloading larva from https://github.com/mynewt/larva//master... ok!
-Installing hw/bsp/nrf52pdk
-Installing hw/mcu/nordic/nrf52xxx
-Installing libs/cmsis-core
-Installing compiler/arm-none-eabi-m4
-Installation was a success!
+
+<ul>
+<li>The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. </li>
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky]$ newt egg install project/blinky
+ Downloading larva from https://github.com/mynewt/larva//master... ok!
+ Installing project/blinky
+ Installation was a success!
+
+
+ [user@~/dev/nordic_blinky]$ newt egg install hw/bsp/nrf52pdk
+ Downloading larva from https://github.com/mynewt/larva//master... ok!
+ Installing hw/bsp/nrf52pdk
+ Installing hw/mcu/nordic/nrf52xxx
+ Installing libs/cmsis-core
+ Installing compiler/arm-none-eabi-m4
+ Installation was a success!
</code></pre>
-</li>
-<li>
-<p>It's time to create a target for the project and define the target attributes. </p>
-<pre><code>[user@~/dev/nordic_blinky]$ newt target create blink_nordic
-Creating target blink_nordic
-Target blink_nordic successfully created!
-[user@~/dev/nordic_blinky]$ newt target set blink_nordic project=blinky
-Target blink_nordic successfully set project to blinky
-[user@~/dev/nordic_blinky]$ newt target set blink_nordic bsp=hw/bsp/nrf52pdk
-Target blink_nordic successfully set bsp to hw/bsp/nrf52pdk
-[user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler_def=debug
-Target blink_nordic successfully set compiler_def to debug
-[user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler=arm-none-eabi-m4
-Target blink_nordic successfully set compiler to arm-none-eabi-m4
-[user@~/dev/nordic_blinky]$ newt target set blink_nordic arch=cortex_m4
-Target blink_nordic successfully set arch to cortex_m4
-[user@~/dev/nordic_blinky]$ newt target show
-blink_nordic
- compiler: arm-none-eabi-m4
- name: blink_nordic
- arch: cortex_m4
- project: blinky
- bsp: hw/bsp/nrf52pdk
- compiler_def: debug
+
+<ul>
+<li>It's time to create a target for the project and define the target attributes. </li>
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky]$ newt target create blink_nordic
+ Creating target blink_nordic
+ Target blink_nordic successfully created!
+ [user@~/dev/nordic_blinky]$ newt target set blink_nordic project=blinky
+ Target blink_nordic successfully set project to blinky
+ [user@~/dev/nordic_blinky]$ newt target set blink_nordic bsp=hw/bsp/nrf52pdk
+ Target blink_nordic successfully set bsp to hw/bsp/nrf52pdk
+ [user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler_def=debug
+ Target blink_nordic successfully set compiler_def to debug
+ [user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler=arm-none-eabi-m4
+ Target blink_nordic successfully set compiler to arm-none-eabi-m4
+ [user@~/dev/nordic_blinky]$ newt target set blink_nordic arch=cortex_m4
+ Target blink_nordic successfully set arch to cortex_m4
+ [user@~/dev/nordic_blinky]$ newt target show
+ blink_nordic
+ compiler: arm-none-eabi-m4
+ name: blink_nordic
+ arch: cortex_m4
+ project: blinky
+ bsp: hw/bsp/nrf52pdk
+ compiler_def: debug
</code></pre>
-</li>
-<li>
-<p>Finally, you get to build the target and generate an executable that can now be uploaded to the board via the on-board SEGGER J-Link debugger. </p>
-<pre><code>[user@~/dev/nordic_blinky]$ newt target build blink_nordic
-Building target blink_nordic (project = blinky)
-Compiling case.c
-Compiling suite.c
-Compiling testutil.c
-Compiling testutil_arch_arm.c
-Archiving libtestutil.a
-Compiling os.c
-Compiling os_callout.c
-Compiling os_eventq.c
-Compiling os_heap.c
-Compiling os_mbuf.c
-Compiling os_mempool.c
-Compiling os_mutex.c
-Compiling os_sanity.c
-Compiling os_sched.c
-Compiling os_sem.c
-Compiling os_task.c
-Compiling os_time.c
-Compiling os_arch_arm.c
-Assembling HAL_CM4.s
-Assembling SVC_Table.s
-Archiving libos.a
-Compiling hal_cputime.c
-Compiling hal_gpio.c
-Compiling hal_uart.c
-Archiving libnrf52xxx.a
-Compiling cmsis_nvic.c
-Compiling hal_bsp.c
-Compiling libc_stubs.c
-Compiling os_bsp.c
-Compiling sbrk.c
-Compiling system_nrf52.c
-Assembling gcc_startup_nrf52.s
-Archiving libnrf52pdk.a
-Compiling main.c
-Building project blinky
-Linking blinky.elf
-Successfully run!
+
+<ul>
+<li>Finally, you get to build the target and generate an executable that can now be uploaded to the board via the on-board SEGGER J-Link debugger. </li>
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky]$ newt target build blink_nordic
+ Building target blink_nordic (project = blinky)
+ Compiling case.c
+ Compiling suite.c
+ Compiling testutil.c
+ Compiling testutil_arch_arm.c
+ Archiving libtestutil.a
+ Compiling os.c
+ Compiling os_callout.c
+ Compiling os_eventq.c
+ Compiling os_heap.c
+ Compiling os_mbuf.c
+ Compiling os_mempool.c
+ Compiling os_mutex.c
+ Compiling os_sanity.c
+ Compiling os_sched.c
+ Compiling os_sem.c
+ Compiling os_task.c
+ Compiling os_time.c
+ Compiling os_arch_arm.c
+ Assembling HAL_CM4.s
+ Assembling SVC_Table.s
+ Archiving libos.a
+ Compiling hal_cputime.c
+ Compiling hal_gpio.c
+ Compiling hal_uart.c
+ Archiving libnrf52xxx.a
+ Compiling cmsis_nvic.c
+ Compiling hal_bsp.c
+ Compiling libc_stubs.c
+ Compiling os_bsp.c
+ Compiling sbrk.c
+ Compiling system_nrf52.c
+ Assembling gcc_startup_nrf52.s
+ Archiving libnrf52pdk.a
+ Compiling main.c
+ Building project blinky
+ Linking blinky.elf
+ Successfully run!
</code></pre>
-</li>
+
+<ul>
<li>
<p>In order to be able to communicate with the SEGGER J-Link debugger on the dev board, you have to download and install the J-Link GDB Server software on to your laptop. You may download the "Software and documentation pack for Mac OS X" from <a href="https://www.segger.com/jlink-software.html">https://www.segger.com/jlink-software.html</a>. The command line version of the server is used in the steps below. </p>
</li>
<li>
<p>Open a new terminal and start a J-Link session.</p>
-<pre><code>[user@~/dev/nordic_blinky/project/blinky/bin]$ which JLinkGDBServer
-/usr/local/bin/JLinkGDBServer
-[user@~/dev/nordic_blinky/project/blinky/bin]$ JLinkGDBServer -if SWD
-SEGGER J-Link GDB Server V5.02f Command Line Version
-
-JLinkARM.dll V5.02f (DLL compiled Oct 2 2015 20:55:03)
-
------GDB Server start settings-----
-GDBInit file: none
-GDB Server Listening port: 2331
-SWO raw output listening port: 2332
-Terminal I/O port: 2333
-Accept remote connection: yes
-Generate logfile: off
-Verify download: off
-Init regs on start: off
-Silent mode: off
-Single run mode: off
-Target connection timeout: 0 ms
-------J-Link related settings------
-J-Link Host interface: USB
-J-Link script: none
-J-Link settings file: none
-------Target related settings------
-Target device: unspecified
-Target interface: SWD
-Target interface speed: 1000kHz
-Target endian: little
-
-Connecting to J-Link...
-J-Link is connected.
-Firmware: J-Link OB-SAM3U128-V2-NordicSemi compiled Aug 28 2015 19:26:24
-Hardware: V1.00
-S/N: 682371959
-Checking target voltage...
-Target voltage: 3.30 V
-Listening on TCP/IP port 2331
-Connecting to target...Connected to target
-Waiting for GDB connection...Connected to 127.0.0.1
-</code></pre>
</li>
-<li>
-<p>You need a configuration file for the GDB session to be opened correctly and the image ("blinky.elf") you built for this target downloaded to flash. A sample config script is given below. Alternatively, you could choose to type each command at the gdb prompt.</p>
-<pre><code> [user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ cat jlink-gdb.cfg
- echo ***Setting up the environment for debugging gdb.***\n
- set complaints 1
- set prompt (gdb)
- set endian little
- echo \n*** Set target charset ASCII\n
- set target-charset ASCII
- echo \n*** Connecting over port #2331 ***\n
- target remote localhost:2331
- echo \n*** Enable flash write and set device to nrf52 ***\n
- monitor flash download=1
- monitor flash device=nRF52
- echo \n*** loading blinky.elf ***\n
- load ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf
- symbol-file ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf
- echo \n*** Resetting target ***\n
- monitor reset
- echo \n*** Halting target ***\n
- monitor halt
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky/project/blinky/bin]$ which JLinkGDBServer
+ /usr/local/bin/JLinkGDBServer
+ [user@~/dev/nordic_blinky/project/blinky/bin]$ JLinkGDBServer -if SWD
+ SEGGER J-Link GDB Server V5.02f Command Line Version
+
+ JLinkARM.dll V5.02f (DLL compiled Oct 2 2015 20:55:03)
+
+ -----GDB Server start settings-----
+ GDBInit file: none
+ GDB Server Listening port: 2331
+ SWO raw output listening port: 2332
+ Terminal I/O port: 2333
+ Accept remote connection: yes
+ Generate logfile: off
+ Verify download: off
+ Init regs on start: off
+ Silent mode: off
+ Single run mode: off
+ Target connection timeout: 0 ms
+ ------J-Link related settings------
+ J-Link Host interface: USB
+ J-Link script: none
+ J-Link settings file: none
+ ------Target related settings------
+ Target device: unspecified
+ Target interface: SWD
+ Target interface speed: 1000kHz
+ Target endian: little
+
+ Connecting to J-Link...
+ J-Link is connected.
+ Firmware: J-Link OB-SAM3U128-V2-NordicSemi compiled Aug 28 2015 19:26:24
+ Hardware: V1.00
+ S/N: 682371959
+ Checking target voltage...
+ Target voltage: 3.30 V
+ Listening on TCP/IP port 2331
+ Connecting to target...Connected to target
+ Waiting for GDB connection...Connected to 127.0.0.1
</code></pre>
-</li>
-<li>
-<p>Start the gdb session and monitor that it loads the image, resets the target, and halts for a command to continue. </p>
-<pre><code>[user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ arm-none-eabi-gdb -x ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/jlink-gdb.cfg
-
-GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs
-Copyright (C) 2014 Free Software Foundation, Inc.
-License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-This is free software: you are free to change and redistribute it.
-There is NO WARRANTY, to the extent permitted by law. Type "show copying"
-and "show warranty" for details.
-This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-eabi".
-Type "show configuration" for configuration details.
-For bug reporting instructions, please see:
-<http://www.gnu.org/software/gdb/bugs/>.
-Find the GDB manual and other documentation resources online at:
-<http://www.gnu.org/software/gdb/documentation/>.
-For help, type "help".
-Type "apropos word" to search for commands related to "word".
-
-***Setting up the environment for debugging gdb.***
-The target is assumed to be little endian
-
-*** Set target charset ASCII
-
-*** Connecting over port #2331 ***
-0x00003c34 in ?? ()
-
-*** Enable flash write and set device to nrf52 ***
-Flash download enabled
-Selecting device: nRF52
-
-*** loading blinky.elf ***
-Loading section .text, size 0x5c84 lma 0x0
-Loading section .ARM.extab, size 0x24 lma 0x5c84
-Loading section .ARM.exidx, size 0xd8 lma 0x5ca8
-Loading section .data, size 0x8f8 lma 0x5d80
-Start address 0x48c, load size 26232
-Transfer rate: 12808 KB/sec, 2914 bytes/write.
-During symbol reading, unexpected overlap between:
- (A) section `.text' from `~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x5c84)
- (B) section `*COM*' from `~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x0).
-Will ignore section B.
-
-*** Resetting target ***
-Resetting target
-
-*** Halting target ***
+
+<ul>
+<li>You need a configuration file for the GDB session to be opened correctly and the image ("blinky.elf") you built for this target downloaded to flash. A sample config script is given below. Alternatively, you could choose to type each command at the gdb prompt.</li>
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ cat jlink-gdb.cfg
+ echo ***Setting up the environment for debugging gdb.***\n
+ set complaints 1
+ set prompt (gdb)
+ set endian little
+ echo \n*** Set target charset ASCII\n
+ set target-charset ASCII
+ echo \n*** Connecting over port #2331 ***\n
+ target remote localhost:2331
+ echo \n*** Enable flash write and set device to nrf52 ***\n
+ monitor flash download=1
+ monitor flash device=nRF52
+ echo \n*** loading blinky.elf ***\n
+ load ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf
+ symbol-file ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf
+ echo \n*** Resetting target ***\n
+ monitor reset
+ echo \n*** Halting target ***\n
+ monitor halt
</code></pre>
-</li>
-<li>
-<p>Type 'c' to continue. The LED on the board will start to blink. You will also see some activity in the terminal showing the open J-Link GDB server connection. The LED will continue to blink after you quit out of that connection.</p>
-<pre><code>(gdb) c
-Continuing.
+
+<ul>
+<li>Start the gdb session and monitor that it loads the image, resets the target, and halts for a command to continue. </li>
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ arm-none-eabi-gdb -x ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/jlink-gdb.cfg
+
+ GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs
+ Copyright (C) 2014 Free Software Foundation, Inc.
+ License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+ This is free software: you are free to change and redistribute it.
+ There is NO WARRANTY, to the extent permitted by law. Type "show copying"
+ and "show warranty" for details.
+ This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-eabi".
+ Type "show configuration" for configuration details.
+ For bug reporting instructions, please see:
+ <http://www.gnu.org/software/gdb/bugs/>.
+ Find the GDB manual and other documentation resources online at:
+ <http://www.gnu.org/software/gdb/documentation/>.
+ For help, type "help".
+ Type "apropos word" to search for commands related to "word".
+
+ ***Setting up the environment for debugging gdb.***
+ The target is assumed to be little endian
+
+ *** Set target charset ASCII
+
+ *** Connecting over port #2331 ***
+ 0x00003c34 in ?? ()
+
+ *** Enable flash write and set device to nrf52 ***
+ Flash download enabled
+ Selecting device: nRF52
+
+ *** loading blinky.elf ***
+ Loading section .text, size 0x5c84 lma 0x0
+ Loading section .ARM.extab, size 0x24 lma 0x5c84
+ Loading section .ARM.exidx, size 0xd8 lma 0x5ca8
+ Loading section .data, size 0x8f8 lma 0x5d80
+ Start address 0x48c, load size 26232
+ Transfer rate: 12808 KB/sec, 2914 bytes/write.
+ During symbol reading, unexpected overlap between:
+ (A) section `.text' from `~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x5c84)
+ (B) section `*COM*' from `~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x0).
+ Will ignore section B.
+
+ *** Resetting target ***
+ Resetting target
+
+ *** Halting target ***
</code></pre>
-</li>
+
+<ul>
+<li>Type 'c' to continue. The LED on the board will start to blink. You will also see some activity in the terminal showing the open J-Link GDB server connection. The LED will continue to blink after you quit out of that connection.</li>
</ul>
+<pre><code class="no-highlight"> (gdb) c
+ Continuing.
+</code></pre>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/get_acclimated/project3/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/project3/index.html b/get_acclimated/project3/index.html
index c9f06f5..8f635a7 100644
--- a/get_acclimated/project3/index.html
+++ b/get_acclimated/project3/index.html
@@ -126,13 +126,17 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../vocabulary/">Understanding Newt Terms</a></li>
+ <li class="toctree-l2"><a href="../vocabulary/">Understanding Newt Terms</a></li>
- <li class="toctree-l3"><a href="../project2/">Project 2</a></li>
+ <li class="toctree-l2"><a href="../project2/">Project 2</a></li>
- <li class="toctree-l3"><a href="./">Project 3</a></li>
+ <li class="toctree-l2"><a href="./">Project 3</a></li>
+
+
+
+
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/get_acclimated/vocabulary/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/vocabulary/index.html b/get_acclimated/vocabulary/index.html
index 800a801..5b30756 100644
--- a/get_acclimated/vocabulary/index.html
+++ b/get_acclimated/vocabulary/index.html
@@ -126,13 +126,33 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="./">Understanding Newt Terms</a></li>
+ <li class="toctree-l2"><a href="./">Understanding Newt Terms</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#nest">Nest</a></li>
+
+ <li class="toctree-l3"><a href="#project">Project</a></li>
+
+ <li class="toctree-l3"><a href="#egg">Egg</a></li>
+
+ <li class="toctree-l3"><a href="#clutch">Clutch</a></li>
+
+ <li class="toctree-l3"><a href="#eggshell">Eggshell</a></li>
+
+ <li class="toctree-l3"><a href="#target">Target</a></li>
+
+ <li class="toctree-l3"><a href="#capability">Capability</a></li>
+
+ <li class="toctree-l3"><a href="#identity">Identity</a></li>
+
+
- <li class="toctree-l3"><a href="../project2/">Project 2</a></li>
+ <li class="toctree-l2"><a href="../project2/">Project 2</a></li>
- <li class="toctree-l3"><a href="../project3/">Project 3</a></li>
+ <li class="toctree-l2"><a href="../project3/">Project 3</a></li>
</ul>
@@ -190,7 +210,7 @@
<p>The nest is the base directory of your embedded software. It is meant to be the workspace containing a logical collection of the source code for one or more of your projects. A nest can contain multiple projects, and reflect multiple end products. </p>
<p>As the base repository of your source code, the nest has a master branch and several other branches off it. You may choose any branch to nest on. Each project in your nest will typically consist of several <a href="#egg">eggs</a>. A project could be an egg itself as well. In addition to eggs, a local nest will contain additional items such as <a href="#target">target</a> or build definitions, clutch description files, scripts etc.</p>
<p>For example, a walk through the "larva" nest at <a href="https://github.com/mynewt/larva.git">https://github.com/mynewt/larva.git</a> shows the following structure. The nest.yml file in the larva directory indicates that it is a nest. An egg will have the egg.yml file in it as shown below. By this nomenclature, each board support package for a particular chip is an egg, the API for the hardware abstraction layer is an egg, and so on. </p>
-<pre><code>larva
+<pre><code class="no-highlight">larva
|- nest.yml
|- compiler
|- arm-none-eabi-m4
@@ -255,9 +275,10 @@
</code></pre>
<p>The newt tool offers the <code>nest</code> command to create and manage nests. In general, commands represent actions and flags are modifiers for those actions. A command can have children commands and optionally run an action. A full description of the <code>nest</code> command can be found in the newt tool reference in Chapter 3.</p>
-<pre><code>newt nest [flags]
-newt nest [child-commands]
+<pre><code class="no-highlight"> newt nest [flags]
+ newt nest [child-commands]
</code></pre>
+
<p>A complete list of all the nest commands can be found in the newt tool reference in <a href="../../newt/newt_tool_reference/">Newt Tool</a>.</p>
<h3 id="project">Project<a class="headerlink" href="#project" title="Permanent link">¶</a></h3>
<p>Projects represent the individual build configurations of your embedded system and essentially defines your application. The project files are what dictate the resulting binary that is generated. </p>
@@ -273,49 +294,57 @@ newt nest [child-commands]
</ul>
<p>A project could itself be an egg if it is a distributable package for a specific application. </p>
<p>The newt tool offers various commands that you can use with a project. For example, if your project is an egg, you can use the following command to install a project from a nest.</p>
-<pre><code>newt egg install [flags] <project egg name>
+<pre><code class="no-highlight"> newt egg install [flags] <project egg name>
</code></pre>
+
<h3 id="egg">Egg<a class="headerlink" href="#egg" title="Permanent link">¶</a></h3>
<p>An egg is a distributable package of libraries. Just as an egg in nature has various parts each of which serves a certain purpose, the Mynewt egg consists of software parcels or modules that have different functions. However, unlike the egg in nature these software modules can exist by itself and may be distributed; therefore, they too are essentially eggs. Once this concept is grasped it is easy to see how an egg may consist of other eggs.</p>
<p>The two main directories in an egg are <code>/include</code> and <code>/src</code>.</p>
<p>The newt tool offers several egg commands to list, inspect, install, and do other operations on eggs. For example, the following command</p>
-<pre><code>newt egg list
+<pre><code class="no-highlight"> newt egg list
</code></pre>
+
<p>outputs all the eggs in the current nest where each egg has details on its version, path, and dependencies. A sample output for an egg is given below.</p>
-<pre><code>Egg libs/os, version 0.1.0
-path: /Users/aditihilbert/dev/test_project/libs/os
-deps: libs/testutil@none#stable
+<pre><code class="no-highlight"> Egg libs/os, version 0.1.0
+ path: /Users/aditihilbert/dev/test_project/libs/os
+ deps: libs/testutil@none#stable
</code></pre>
+
<p>A complete list of all the egg commands can be found in the newt tool reference in <a href="../../newt/newt_tool_reference/">Newt Tool</a>.</p>
<h3 id="clutch">Clutch<a class="headerlink" href="#clutch" title="Permanent link">¶</a></h3>
<p>A clutch is a snapshot of all eggs in a remote nest at any point in time. On any given github branch, a nest with a clutch of eggs will contain a <code>clutch.yml</code> file that specifies the version number, dependencies, and hash value for each constituent egg as well as the name of the entire clutch and the github url for it. [Note: Currently ]</p>
<p>You may download multiple clutches into your local nest as long as the names of the clutches are different. This allows you to mix and match various features and functionality coming from different clutches of eggs. You can see all the clutches in the <code>.nest/clutches</code> directory in your nest.</p>
<p>The newt tool offers clutch management commands within the <code>newt nest</code> command. For example, the following command creates a new clutch using all the eggs in the current directory. It requires that a clutch name be specified and the url for the location of that clutch in the online repository. These two inputs go into the <code>clutch.yml</code> file in the nest.</p>
-<pre><code>newt nest generate-clutch <name> <url>
+<pre><code class="no-highlight"> newt nest generate-clutch <name> <url>
</code></pre>
+
<p>Note that a clutch merely defines the eggs belonging together and requires the eggs to be installed (hatched) for the source code to be populated in the project. </p>
<h3 id="eggshell">Eggshell<a class="headerlink" href="#eggshell" title="Permanent link">¶</a></h3>
<p>The term eggshell is used to refer to the eggs of a clutch in a remote repository. They are not useful on your local machine until you actually install them. So they are mere shells of themselves while sitting on the online repository. When you enter the following command outputs the total number of shells in each remote clutch.</p>
-<pre><code>newt nest list-clutches
+<pre><code class="no-highlight"> newt nest list-clutches
</code></pre>
+
<p>So, if you had two clutches installed, the output could be:</p>
-<pre><code>Remote clutch larva (eggshells: 19)
-Remote clutch ble_test (eggshells: 15)
+<pre><code class="no-highlight"> Remote clutch larva (eggshells: 19)
+ Remote clutch ble_test (eggshells: 15)
</code></pre>
+
<h3 id="target">Target<a class="headerlink" href="#target" title="Permanent link">¶</a></h3>
<p>A target is the hardware build or its software equivalent (e.g. test, simulator) set for a project. It tells the newt tool how to build the source code within a given nest. Once a new target is created, its architecture and other details needs to be defined. An example of a defined target named "blink_f3disc" is given below.</p>
-<pre><code>blink_f3disc
- compiler_def: debug
- compiler: arm-none-eabi-m4
- name: blink_f3disc
- arch: cortex_m4
- project: blinky
- bsp: hw/bsp/stm32f3discovery
+<pre><code class="no-highlight"> blink_f3disc
+ compiler_def: debug
+ compiler: arm-none-eabi-m4
+ name: blink_f3disc
+ arch: cortex_m4
+ project: blinky
+ bsp: hw/bsp/stm32f3discovery
</code></pre>
+
<p>The newt tool offers commands to create, set up and manipulate targets. For example, the create command below creates an empty target named <code>my_target1</code> and the set command sets one detail of its definition, namely the architecture.</p>
-<pre><code>newt target create my_target1
-newt target set my_target1 arch=cortex_m4
+<pre><code class="no-highlight"> newt target create my_target1
+ newt target set my_target1 arch=cortex_m4
</code></pre>
+
<h3 id="capability">Capability<a class="headerlink" href="#capability" title="Permanent link">¶</a></h3>
<p>Capability is functionality that is exposed by an egg. A capability is tracked by its name and version. An egg may require capabilities exposed by another egg, thus establishing a dependency tracked through the egg.yml files. </p>
<p>The newt tool can ascertain a map of all the egg capabilities and use it to check dependencies and make sure all the necessary eggs are in a project for a particular target.</p>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/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 e2c9e98..5a513e9 100644
--- a/get_started/how_to_edit_docs/index.html
+++ b/get_started/how_to_edit_docs/index.html
@@ -121,16 +121,42 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../newt_concepts/">Newt Concepts</a></li>
+ <li class="toctree-l2"><a href="../newt_concepts/">Newt Concepts</a></li>
- <li class="toctree-l3"><a href="../project1/">Blinky, The First Project</a></li>
+ <li class="toctree-l2"><a href="../project1/">Blinky, The First Project</a></li>
- <li class="toctree-l3"><a href="./">How to edit docs</a></li>
+ <li class="toctree-l2"><a href="./">How to edit docs</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#objective">Objective</a></li>
+
+ <li class="toctree-l3"><a href="#markdown-mkdocs-mou">Markdown, MkDocs, Mou</a></li>
+
+ <li class="toctree-l3"><a href="#access-to-the-apache-repo">Access to the Apache repo</a></li>
+
+ <li class="toctree-l3"><a href="#making-a-local-copy">Making a local copy</a></li>
+
+ <li class="toctree-l3"><a href="#file-to-be-edited">File to be edited</a></li>
+
+ <li class="toctree-l3"><a href="#editing-an-existing-page">Editing an existing page</a></li>
+
+ <li class="toctree-l3"><a href="#adding-a-new-page">Adding a new page</a></li>
+
+ <li class="toctree-l3"><a href="#pushing-changes-to-remote-as-a-committer">Pushing changes to remote as a committer</a></li>
+
+ <li class="toctree-l3"><a href="#sharing-changes-as-a-non-committer">Sharing changes as a non-committer</a></li>
+
+ <li class="toctree-l3"><a href="#conversion-to-html">Conversion to HTML</a></li>
+
+ <li class="toctree-l3"><a href="#local-preview-of-html-files">Local preview of HTML files</a></li>
+
+
- <li class="toctree-l3"><a href="../try_markdown/">Sample doc to edit</a></li>
+ <li class="toctree-l2"><a href="../try_markdown/">Sample doc to edit</a></li>
</ul>
@@ -200,28 +226,28 @@
<p>If you are not a committer, you may follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is <a href="https://git-wip-us.apache.org/docs/workflow.html">https://git-wip-us.apache.org/docs/workflow.html</a>. You will find the steps described in more detail later in this tutorial.</p>
<h3 id="making-a-local-copy">Making a local copy<a class="headerlink" href="#making-a-local-copy" title="Permanent link">¶</a></h3>
<ul>
-<li>
-<p>Copy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure. Use http instead of https if you are a non-committer.</p>
-<pre><code>$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
-Cloning into 'incubator-mynewt-site'...
-remote: Counting objects: 330, done.
-remote: Compressing objects: 100% (263/263), done.
-remote: Total 330 (delta 120), reused 0 (delta 0)
-Receiving objects: 100% (330/330), 4.34 MiB | 830.00 KiB/s, done.
-Resolving deltas: 100% (120/120), done.
-Checking connectivity... done.
-$ ls
-incubator-mynewt-site
-$ ls incubator-mynewt-site/
-docs images mkdocs.yml
-</code></pre>
-</li>
-<li>
-<p>Create a new branch to work on your documentation and move to that branch.</p>
-<pre><code>$ git checkout -b <your-branch-name>
+<li>Copy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure. Use http instead of https if you are a non-committer.</li>
+</ul>
+<pre><code class="no-highlight"> $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
+ Cloning into 'incubator-mynewt-site'...
+ remote: Counting objects: 330, done.
+ remote: Compressing objects: 100% (263/263), done.
+ remote: Total 330 (delta 120), reused 0 (delta 0)
+ Receiving objects: 100% (330/330), 4.34 MiB | 830.00 KiB/s, done.
+ Resolving deltas: 100% (120/120), done.
+ Checking connectivity... done.
+ $ ls
+ incubator-mynewt-site
+ $ ls incubator-mynewt-site/
+ docs images mkdocs.yml
</code></pre>
-</li>
+
+<ul>
+<li>Create a new branch to work on your documentation and move to that branch.</li>
</ul>
+<pre><code class="no-highlight"> $ git checkout -b <your-branch-name>
+</code></pre>
+
<h3 id="file-to-be-edited">File to be edited<a class="headerlink" href="#file-to-be-edited" title="Permanent link">¶</a></h3>
<p>The file you will edit is <a href="../try_markdown/">try_markdown.md</a>.</p>
<h3 id="editing-an-existing-page">Editing an existing page<a class="headerlink" href="#editing-an-existing-page" title="Permanent link">¶</a></h3>
@@ -240,87 +266,90 @@ docs images mkdocs.yml
</li>
</ul>
<p>You may want to review the documentation organization back in <a href="../..">Home</a> to remind you how to locate files easily. The corresponding directory tree structure is shown below.</p>
-<pre><code> .
- ├── docs
- │ ├── get_started
- │ │ ├── how_to_edit_docs.md
- │ │ ├── newt_concepts.md
- │ │ ├── pics
- │ │ │ ├── bottomview.png
- │ │ │ └── topview.png
- │ │ ├── project1.md
- │ │ └── try_markdown.md
- │ ├── get_acclimated
- │ │ ├── project2.md
- │ │ ├── project3.md
- │ │ ├── ... (more to be added)
- │ │ └── vocabulary.md
- │ ├── newt
- │ │ ├── newt_ops.md
- │ │ └── newt_tool_reference.md
- │ ├── os
- │ │ ├── context_switch.md
- │ │ ├── event_queue.md
- │ │ ├── heap.md
- │ │ ├── mbufs.md
- │ │ ├── memory_pool.md
- │ │ ├── mutex.md
- │ │ ├── mynewt_os.md
- │ │ ├── port_os.md
- │ │ ├── sanity.md
- │ │ ├── semaphore.md
- │ │ ├── task.md
- │ │ ├── time.md
- │ │ └── ... (more to be added)
- │ ├── modules
- │ │ ├── bootloader.md
- │ │ ├── console.md
- │ │ ├── filesystem.md
- │ │ ├── shell.md
- │ │ ├── testutil.md
- │ │ └── ... (more to be added)
- │ ├── packaging
- │ │ ├── dist.md
- │ │ └── ... (more to be added)
- │ ├── extra.css
- │ ├── images
- │ │ └── egg-logo.png
- │ └── index.md
- ├── images
- │ ├── asf_logo_wide.gif
- │ ├── content-bg.png
- │ └── egg-logo.png
- ├── mkdocs.yml
+<pre><code class="no-highlight"> .
+ ├── docs
+ │ ├── get_started
+ │ │ ├── how_to_edit_docs.md
+ │ │ ├── newt_concepts.md
+ │ │ ├── pics
+ │ │ │ ├── bottomview.png
+ │ │ │ └── topview.png
+ │ │ ├── project1.md
+ │ │ └── try_markdown.md
+ │ ├── get_acclimated
+ │ │ ├── project2.md
+ │ │ ├── project3.md
+ │ │ ├── ... (more to be added)
+ │ │ └── vocabulary.md
+ │ ├── newt
+ │ │ ├── newt_ops.md
+ │ │ └── newt_tool_reference.md
+ │ ├── os
+ │ │ ├── context_switch.md
+ │ │ ├── event_queue.md
+ │ │ ├── heap.md
+ │ │ ├── mbufs.md
+ │ │ ├── memory_pool.md
+ │ │ ├── mutex.md
+ │ │ ├── mynewt_os.md
+ │ │ ├── port_os.md
+ │ │ ├── sanity.md
+ │ │ ├── semaphore.md
+ │ │ ├── task.md
+ │ │ ├── time.md
+ │ │ └── ... (more to be added)
+ │ ├── modules
+ │ │ ├── bootloader.md
+ │ │ ├── console.md
+ │ │ ├── filesystem.md
+ │ │ ├── shell.md
+ │ │ ├── testutil.md
+ │ │ └── ... (more to be added)
+ │ ├── packaging
+ │ │ ├── dist.md
+ │ │ └── ... (more to be added)
+ │ ├── extra.css
+ │ ├── images
+ │ │ └── egg-logo.png
+ │ └── index.md
+ ├── images
+ │ ├── asf_logo_wide.gif
+ │ ├── content-bg.png
+ │ └── egg-logo.png
+ ├── mkdocs.yml
</code></pre>
+
<h3 id="adding-a-new-page">Adding a new page<a class="headerlink" href="#adding-a-new-page" title="Permanent link">¶</a></h3>
<p>If you create a new file somewhere in the <code>docs</code> subdirectory to add a new page, you have to add a line in the <code>mkdocs.yml</code> file at the correct level. For example, if you add a new module named "Ethernet" by creating a new file named <code>ethernet.md</code> in the <code>modules</code> subdirectory, you have to insert the following line under <code>Modules:</code> in the <code>mkdocs.yml</code> file.</p>
-<pre><code> - 'Ethernet': 'modules/ethernet.md'
+<pre><code class="no-highlight"> - 'Ethernet': 'modules/ethernet.md'
</code></pre>
+
<h3 id="pushing-changes-to-remote-as-a-committer">Pushing changes to remote as a committer<a class="headerlink" href="#pushing-changes-to-remote-as-a-committer" title="Permanent link">¶</a></h3>
<p>If you are not a committer yet, skip this section and proceed to the <a href="#sharing-changes-as-a-non-committer">next section</a>.</p>
<ul>
-<li>
-<p>Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.</p>
-<pre><code>$ git remote -v
-origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (fetch)
-origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push)
+<li>Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.</li>
+</ul>
+<pre><code class="no-highlight"> $ git remote -v
+ origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (fetch)
+ origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push)
</code></pre>
-</li>
-<li>
-<p>If, however, you do not see your remote repository, then set it up as follows.</p>
-<pre><code>$ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
+
+<ul>
+<li>If, however, you do not see your remote repository, then set it up as follows.</li>
+</ul>
+<pre><code class="no-highlight"> $ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
</code></pre>
-</li>
-<li>
-<p>First check the git status. It will show you that the <code>try_markdown.md</code> document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository. </p>
-</li>
+
+<ul>
+<li>First check the git status. It will show you that the <code>try_markdown.md</code> document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository. </li>
</ul>
<p>During staging below using <code>git add</code>, we use the <code>-A</code> option indicating you want to stage all your modifications. Instead, you can choose to specify only the files that you want to. The commit message (specified after <code>-m</code>) should summarize what your changes are about.</p>
-<pre><code> $ git status
- $ git add -A
- $ git commit -m "My first doc change as a trial run"
- $ git push -u origin <your-branch-name>
+<pre><code class="no-highlight"> $ git status
+ $ git add -A
+ $ git commit -m "My first doc change as a trial run"
+ $ git push -u origin <your-branch-name>
</code></pre>
+
<ul>
<li>
<p>You can see the changed Markdown file if you traverse the tree on the git repository <a href="https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git"> https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git</a>.</p>
@@ -332,37 +361,39 @@ origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push)
<h3 id="sharing-changes-as-a-non-committer">Sharing changes as a non-committer<a class="headerlink" href="#sharing-changes-as-a-non-committer" title="Permanent link">¶</a></h3>
<p>We suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is <a href="https://git-wip-us.apache.org/docs/workflow.html">https://git-wip-us.apache.org/docs/workflow.html</a>. </p>
<ul>
-<li>
-<p>Assuming you have made changes to the example file, you will first commit your changes.</p>
-<pre><code>$ git add -A
-$ git commit -m "My first doc change as a trial run"
+<li>Assuming you have made changes to the example file, you will first commit your changes.</li>
+</ul>
+<pre><code class="no-highlight"> $ git add -A
+ $ git commit -m "My first doc change as a trial run"
</code></pre>
-</li>
-<li>
-<p>Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future):</p>
-<pre><code>$ git format-patch origin/trunk
+
+<ul>
+<li>Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future):</li>
+</ul>
+<pre><code class="no-highlight"> $ git format-patch origin/trunk
</code></pre>
-</li>
-<li>
-<p>Email the patch file to dev@mynewt.incubator.apache.org. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough. </p>
-</li>
+
+<ul>
+<li>Email the patch file to dev@mynewt.incubator.apache.org. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough. </li>
</ul>
<p>If there is a JIRA ticket associated with your work you should post your patch files to the ticket.</p>
<h3 id="conversion-to-html">Conversion to HTML<a class="headerlink" href="#conversion-to-html" title="Permanent link">¶</a></h3>
<p>The conversion of the Markdown files to HTML for the website happens manually and statically using MkDocs. You cannot see automatic and immediate rendering in HTML upon making a change in the Markdown file. You can choose to stop here and proceed to changing other Markdown files in your branch.</p>
<h3 id="local-preview-of-html-files">Local preview of HTML files<a class="headerlink" href="#local-preview-of-html-files" title="Permanent link">¶</a></h3>
<p>However, you have the option to download MkDocs and do a local conversion yourself to preview the pages using the built-in devserver that comes with MkDocs. But first you will have to install MkDocs for that. In order to install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have them already (usually you will).</p>
-<pre><code> $ python --version
- Python 2.7.2
- $ pip --version
- pip 1.5.2
- $ pip install mkdocs
+<pre><code class="no-highlight"> $ python --version
+ Python 2.7.2
+ $ pip --version
+ pip 1.5.2
+ $ pip install mkdocs
</code></pre>
+
<p>You will then run the built-in webserver from the root of the documentation directory using the command <code>mkdocs serve</code>. The root directory for documentation is <code>incubator-mynewt-site</code> or the directory with the <code>mkdocs.yml</code> file.</p>
-<pre><code> $ ls
- docs images mkdocs.yml
- $ mkdocs serve
+<pre><code class="no-highlight"> $ ls
+ docs images mkdocs.yml
+ $ mkdocs serve
</code></pre>
+
<p>Then go to <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a> to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be updated.</p>
<p>For more information on MkDocs go to <a href="http://www.mkdocs.org">http://www.mkdocs.org</a>. </p>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/get_started/newt_concepts/index.html
----------------------------------------------------------------------
diff --git a/get_started/newt_concepts/index.html b/get_started/newt_concepts/index.html
index b553567..4e1373e 100644
--- a/get_started/newt_concepts/index.html
+++ b/get_started/newt_concepts/index.html
@@ -121,16 +121,28 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="./">Newt Concepts</a></li>
+ <li class="toctree-l2"><a href="./">Newt Concepts</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#basic-components-in-the-ecosystem">Basic components in the ecosystem</a></li>
+
+ <li class="toctree-l3"><a href="#terminology">Terminology</a></li>
+
+ <li class="toctree-l3"><a href="#a-mynewt-contributor">A Mynewt contributor</a></li>
+
+ <li class="toctree-l3"><a href="#a-mynewt-user">A Mynewt user</a></li>
+
+
- <li class="toctree-l3"><a href="../project1/">Blinky, The First Project</a></li>
+ <li class="toctree-l2"><a href="../project1/">Blinky, The First Project</a></li>
- <li class="toctree-l3"><a href="../how_to_edit_docs/">How to edit docs</a></li>
+ <li class="toctree-l2"><a href="../how_to_edit_docs/">How to edit docs</a></li>
- <li class="toctree-l3"><a href="../try_markdown/">Sample doc to edit</a></li>
+ <li class="toctree-l2"><a href="../try_markdown/">Sample doc to edit</a></li>
</ul>
[3/7] incubator-mynewt-site git commit: Fix second level navigation
and function formats in docs
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/modules/bootloader/index.html
----------------------------------------------------------------------
diff --git a/modules/bootloader/index.html b/modules/bootloader/index.html
index e9020e1..93dceb4 100644
--- a/modules/bootloader/index.html
+++ b/modules/bootloader/index.html
@@ -141,19 +141,37 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../console/">Console</a></li>
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
- <li class="toctree-l3"><a href="../shell/">Shell</a></li>
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
- <li class="toctree-l3"><a href="./">Bootloader</a></li>
+ <li class="toctree-l2"><a href="./">Bootloader</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#boot_slot_addr"> boot_slot_addr </a></li>
+
+ <li class="toctree-l3"><a href="#boot_find_image_slot"> boot_find_image_slot </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
- <li class="toctree-l3"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
</ul>
@@ -198,19 +216,18 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-boot_slot_addr">boot_slot_addr</a></li>
-<li><a href="#function-boot_find_image_slot">boot_find_image_slot</a></li>
+<li><a href="#boot_slot_addr">boot_slot_addr</a></li>
+<li><a href="#boot_find_image_slot">boot_find_image_slot</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-boot_slot_addr"><font color="2980b9">function boot_slot_addr </font><a class="headerlink" href="#function-boot_slot_addr" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="boot_slot_addr"><font color="F2853F" style="font-size:24pt"> boot_slot_addr </font><a class="headerlink" href="#boot_slot_addr" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
boot_slot_addr(int slot_num, uint8_t *flash_id, uint32_t *address)
-
</code></pre>
<p><Insert short description></p>
@@ -242,15 +259,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-boot_find_image_slot"><font color="#2980b9"> function boot_find_image_slot </font><a class="headerlink" href="#function-boot_find_image_slot" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="boot_find_image_slot"><font color="#F2853F" style="font-size:24pt"> boot_find_image_slot </font><a class="headerlink" href="#boot_find_image_slot" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -282,15 +296,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -322,9 +333,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/modules/console/index.html
----------------------------------------------------------------------
diff --git a/modules/console/index.html b/modules/console/index.html
index 00b345e..fb0be1d 100644
--- a/modules/console/index.html
+++ b/modules/console/index.html
@@ -141,19 +141,55 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="./">Console</a></li>
+ <li class="toctree-l2"><a href="./">Console</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#console_printf"> console_printf</a></li>
+
+ <li class="toctree-l3"><a href="#console_add_char"> console_add_char</a></li>
+
+ <li class="toctree-l3"><a href="#console_pull_char"> console_pull_char </a></li>
+
+ <li class="toctree-l3"><a href="#console_pull_char_head"> console_pull_char_head </a></li>
+
+ <li class="toctree-l3"><a href="#console_queue_char"> console_queue_char </a></li>
+
+ <li class="toctree-l3"><a href="#console_blocking_tx"> console_blocking_tx </a></li>
+
+ <li class="toctree-l3"><a href="#console_blocking_mode"> console_blocking_mode </a></li>
+
+ <li class="toctree-l3"><a href="#console_write"> console_write </a></li>
+
+ <li class="toctree-l3"><a href="#console_read"> console_read </a></li>
+
+ <li class="toctree-l3"><a href="#console_tx_char"> console_tx_char </a></li>
+
+ <li class="toctree-l3"><a href="#console_rx_char"> console_rx_char </a></li>
+
+ <li class="toctree-l3"><a href="#console_init"> console_init </a></li>
+
+
- <li class="toctree-l3"><a href="../shell/">Shell</a></li>
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
- <li class="toctree-l3"><a href="../bootloader/">Bootloader</a></li>
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
- <li class="toctree-l3"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
- <li class="toctree-l3"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
</ul>
@@ -201,27 +237,29 @@
<li>stub - containing stubs for the API</li>
</ul>
<p>If an egg or project requires the full console capability it lists that dependency in its egg.yml file. For example, the shell egg is defined by the following egg.yml file:</p>
-<pre><code>egg.name: libs/shell
-egg.vers: 0.1
-egg.deps:
- - libs/console/full
- - libs/os
-egg.identities:
- - SHELL
+<pre><code class="no-highlight"> egg.name: libs/shell
+ egg.vers: 0.1
+ egg.deps:
+ - libs/console/full
+ - libs/os
+ egg.identities:
+ - SHELL
</code></pre>
+
<p>On the other hand, a project may not have a physical console (e.g. a UART port to connect a terminal to) but may have a dependency on an egg that has console capability. In that case you would use a console stub. Another example would be the bootloader project where we want to keep the size of the image small. It includes the <code>libs/os</code> egg that can print out messages on a console (e.g. if there is a hard fault) and the <code>libs/util</code> egg that uses full console (but only if SHELL is present to provide a CLI). However, we do not want to use any console I/O capability in this particular bootloader project to keep the size small. We simply use the console stub instead and the egg.yml file for the project boot egg looks like the following:</p>
-<pre><code>project.name: boot
-project.identities: bootloader
-project.eggs:
- - libs/os
- - libs/bootutil
- - libs/nffs
- - libs/console/stub
- - libs/util
+<pre><code class="no-highlight"> project.name: boot
+ project.identities: bootloader
+ project.eggs:
+ - libs/os
+ - libs/bootutil
+ - libs/nffs
+ - libs/console/stub
+ - libs/util
</code></pre>
+
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Console interaction is intrinsically composed of two unidirectional systems. The console implementation uses two ring buffers containing input (receive) and output (transmit) characters, respectively. Read and write operations on the console_ring structure are managed by labeling the read location indicator the <code>cr_tail</code> and the write location indicator the <code>cr_head</code>. The console ring length is variable and is specified as the <code>cr_size</code> member of the data structure. <code>cr_buf</code> is the pointer to the actual array of data contained.</p>
-<pre><code>struct console_ring {
+<pre><code class="no-highlight">struct console_ring {
32 uint8_t cr_head;
33 uint8_t cr_tail;
34 uint8_t cr_size;
@@ -230,7 +268,7 @@ project.eggs:
37 }
</code></pre>
-<pre><code>struct console_tty {
+<pre><code class="no-highlight">struct console_tty {
40 struct console_ring ct_tx;
41 uint8_t ct_tx_buf[CONSOLE_TX_BUF_SZ]; /* must be after console_ring */
42 struct console_ring ct_rx;
@@ -243,23 +281,23 @@ project.eggs:
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
<p>The functions available in console are:</p>
<ul>
-<li><a href="#function-console_printf">console_printf</a></li>
-<li><a href="#function-console_add_char">console_add_char</a></li>
-<li><a href="#function-console_pull_char">console_pull_char</a></li>
-<li><a href="#function-console_pull_char_head">console_pull_char_head</a></li>
-<li><a href="#function-console_queue_char">console_queue_char</a></li>
-<li><a href="#function-console_blocking_tx">console_blocking_tx</a></li>
-<li><a href="#function-console_blocking_mode">console_blocking_mode</a></li>
-<li><a href="#function-console_write">console_write</a></li>
-<li><a href="#function-console_read">console_read</a></li>
-<li><a href="#function-console_tx_char">console_tx_char</a></li>
-<li><a href="#function-console_rx_char">console_rx_char</a></li>
-<li><a href="#function-console_init">console_init</a></li>
+<li><a href="#console_printf">console_printf</a></li>
+<li><a href="#console_add_char">console_add_char</a></li>
+<li><a href="#console_pull_char">console_pull_char</a></li>
+<li><a href="#console_pull_char_head">console_pull_char_head</a></li>
+<li><a href="#console_queue_char">console_queue_char</a></li>
+<li><a href="#console_blocking_tx">console_blocking_tx</a></li>
+<li><a href="#console_blocking_mode">console_blocking_mode</a></li>
+<li><a href="#console_write">console_write</a></li>
+<li><a href="#console_read">console_read</a></li>
+<li><a href="#console_tx_char">console_tx_char</a></li>
+<li><a href="#console_rx_char">console_rx_char</a></li>
+<li><a href="#console_init">console_init</a></li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-console_printf"><font color="2980b9">function console_printf</font><a class="headerlink" href="#function-console_printf" title="Permanent link">¶</a></h3>
-<pre><code> void
+<h2 id="console_printf"><font color="F2853F" style="font-size:24pt"> console_printf</font><a class="headerlink" href="#console_printf" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> void
console_printf(const char *fmt, ...)
</code></pre>
@@ -289,7 +327,7 @@ project.eggs:
<p>While <code>console_printf</code>, with its well understood formatting options in C, is more convenient and easy on the eyes than the raw output of <code>console_write</code>, the associated code size is considerably larger.</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p>Example #1:</p>
-<pre><code>char adv_data_buf[32];
+<pre><code class="no-highlight">char adv_data_buf[32];
void
task()
@@ -301,7 +339,7 @@ task()
</code></pre>
<p>Example #2:</p>
-<pre><code>struct exception_frame {
+<pre><code class="no-highlight">struct exception_frame {
uint32_t r0;
uint32_t r1;
@@ -320,8 +358,8 @@ task(struct trap_frame *tf)
</code></pre>
<hr />
-<h3 id="function-console_add_char"><font color="#2980b9"> function console_add_char</font><a class="headerlink" href="#function-console_add_char" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="console_add_char"><font color="#F2853F" style="font-size:24pt"> console_add_char</font><a class="headerlink" href="#console_add_char" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
console_add_char(struct console_ring *cr, char ch)
</code></pre>
@@ -353,7 +391,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p>Add a new line character to the output (transmit) buffer.</p>
-<pre><code>void
+<pre><code class="no-highlight">void
task()
{
struct console_ring *tx = &ct->ct_tx;
@@ -363,8 +401,8 @@ task()
</code></pre>
<hr />
-<h3 id="function-console_pull_char"><font color="#2980b9"> function console_pull_char </font><a class="headerlink" href="#function-console_pull_char" title="Permanent link">¶</a></h3>
-<pre><code> static uint8_t
+<h2 id="console_pull_char"><font color="#F2853F" style="font-size:24pt"> console_pull_char </font><a class="headerlink" href="#console_pull_char" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static uint8_t
console_pull_char(struct console_ring *cr)
</code></pre>
@@ -392,7 +430,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p>Read the characters in the ring buffer into a string.</p>
-<pre><code>void
+<pre><code class="no-highlight">void
task(struct console_ring *cr, char *str, int cnt)
{
for (i = 0; i < cnt; i++) {
@@ -407,8 +445,8 @@ task(struct console_ring *cr, char *str, int cnt)
</code></pre>
<hr />
-<h3 id="function-console_pull_char_head"><font color="#2980b9"> function console_pull_char_head </font><a class="headerlink" href="#function-console_pull_char_head" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="console_pull_char_head"><font color="#F2853F" style="font-size:24pt"> console_pull_char_head </font><a class="headerlink" href="#console_pull_char_head" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
console_pull_char_head(struct console_ring *cr)
</code></pre>
@@ -443,7 +481,7 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
<li>remove the previous character from incoming RX queue</li>
</ul>
<p>The example below shows console_pull_char_head being used for the last step.</p>
-<pre><code>void
+<pre><code class="no-highlight">void
task(uint8_t data)
{
struct console_tty *ct = (struct console_tty *)arg;
@@ -463,8 +501,8 @@ task(uint8_t data)
</code></pre>
<hr />
-<h3 id="function-console_queue_char"><font color="#2980b9"> function console_queue_char </font><a class="headerlink" href="#function-console_queue_char" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="console_queue_char"><font color="#F2853F" style="font-size:24pt"> console_queue_char </font><a class="headerlink" href="#console_queue_char" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
console_queue_char(char ch)
</code></pre>
@@ -490,12 +528,12 @@ Error codes?</p>
<h4 id="notes_4">Notes<a class="headerlink" href="#notes_4" title="Permanent link">¶</a></h4>
<p>This function makes sure no interrupts are allowed while the transmit buffer is draining and the character is being added.</p>
<h4 id="example_4">Example<a class="headerlink" href="#example_4" title="Permanent link">¶</a></h4>
-<pre><code>Insert example
+<pre><code class="no-highlight">Insert example
</code></pre>
<hr />
-<h3 id="function-console_blocking_tx"><font color="#2980b9"> function console_blocking_tx </font><a class="headerlink" href="#function-console_blocking_tx" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="console_blocking_tx"><font color="#F2853F" style="font-size:24pt"> console_blocking_tx </font><a class="headerlink" href="#console_blocking_tx" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
console_blocking_tx(char ch)
</code></pre>
@@ -524,7 +562,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_5">Example<a class="headerlink" href="#example_5" title="Permanent link">¶</a></h4>
<p>Here is an example of a console output queue being flushed.</p>
-<pre><code>void
+<pre><code class="no-highlight">void
task(void)
{
struct console_tty *ct = &console_tty;
@@ -538,8 +576,8 @@ task(void)
</code></pre>
<hr />
-<h3 id="function-console_blocking_mode"><font color="#2980b9"> function console_blocking_mode </font><a class="headerlink" href="#function-console_blocking_mode" title="Permanent link">¶</a></h3>
-<pre><code> void
+<h2 id="console_blocking_mode"><font color="#F2853F" style="font-size:24pt"> console_blocking_mode </font><a class="headerlink" href="#console_blocking_mode" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> void
console_blocking_mode(void)
</code></pre>
@@ -566,7 +604,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_6">Example<a class="headerlink" href="#example_6" title="Permanent link">¶</a></h4>
<p>Here is an example of calling <code>console_blocking_mode</code> and printing crash information from an assert to help debug.</p>
-<pre><code>void
+<pre><code class="no-highlight">void
_assert_func(const char *file, int line, const char *func, const char *e)
{
int sr;
@@ -582,8 +620,8 @@ _assert_func(const char *file, int line, const char *func, const char *e)
</code></pre>
<hr />
-<h3 id="function-console_write"><font color="#2980b9">function console_write </font><a class="headerlink" href="#function-console_write" title="Permanent link">¶</a></h3>
-<pre><code> void
+<h2 id="console_write"><font color="#F2853F" style="font-size:24pt"> console_write </font><a class="headerlink" href="#console_write" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> void
console_write(char *str, int cnt)
</code></pre>
@@ -616,7 +654,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_7">Example<a class="headerlink" href="#example_7" title="Permanent link">¶</a></h4>
<p>Here is an example of the function being used in an echo command with a newline at the end.</p>
-<pre><code>static int
+<pre><code class="no-highlight">static int
shell_echo_cmd(int argc, char **argv)
{
int i;
@@ -632,8 +670,8 @@ shell_echo_cmd(int argc, char **argv)
</code></pre>
<hr />
-<h3 id="function-console_read"><font color="#2980b9"> function console_read </font><a class="headerlink" href="#function-console_read" title="Permanent link">¶</a></h3>
-<pre><code> int
+<h2 id="console_read"><font color="#F2853F" style="font-size:24pt"> console_read </font><a class="headerlink" href="#console_read" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> int
console_read(char *str, int cnt)
</code></pre>
@@ -667,8 +705,8 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_8">Example<a class="headerlink" href="#example_8" title="Permanent link">¶</a></h4>
<p>Give at least one example of usage.</p>
<hr />
-<h3 id="function-console_tx_char"><font color="#2980b9"> function console_tx_char </font><a class="headerlink" href="#function-console_tx_char" title="Permanent link">¶</a></h3>
-<pre><code> static int
+<h2 id="console_tx_char"><font color="#F2853F" style="font-size:24pt"> console_tx_char </font><a class="headerlink" href="#console_tx_char" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static int
console_tx_char(void *arg)
</code></pre>
@@ -701,8 +739,8 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_9">Example<a class="headerlink" href="#example_9" title="Permanent link">¶</a></h4>
<p>Give at least one example of usage.</p>
<hr />
-<h3 id="function-console_rx_char"><font color="#2980b9"> function console_rx_char </font><a class="headerlink" href="#function-console_rx_char" title="Permanent link">¶</a></h3>
-<pre><code> static int
+<h2 id="console_rx_char"><font color="#F2853F" style="font-size:24pt"> console_rx_char </font><a class="headerlink" href="#console_rx_char" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static int
console_rx_char(void *arg, uint8_t data)
</code></pre>
@@ -735,8 +773,8 @@ Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_10">Example<a class="headerlink" href="#example_10" title="Permanent link">¶</a></h4>
<p>Give at least one example of usage.</p>
<hr />
-<h3 id="function-console_init"><font color="#2980b9"> function console_init </font><a class="headerlink" href="#function-console_init" title="Permanent link">¶</a></h3>
-<pre><code> int
+<h2 id="console_init"><font color="#F2853F" style="font-size:24pt"> console_init </font><a class="headerlink" href="#console_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> int
console_init(console_rx_cb rx_cb)
</code></pre>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/modules/filesystem/index.html
----------------------------------------------------------------------
diff --git a/modules/filesystem/index.html b/modules/filesystem/index.html
index f3dac9c..3d9609f 100644
--- a/modules/filesystem/index.html
+++ b/modules/filesystem/index.html
@@ -141,19 +141,37 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../console/">Console</a></li>
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
- <li class="toctree-l3"><a href="../shell/">Shell</a></li>
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
- <li class="toctree-l3"><a href="../bootloader/">Bootloader</a></li>
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
- <li class="toctree-l3"><a href="./">File System</a></li>
+ <li class="toctree-l2"><a href="./">File System</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#nffs_lock"> nffs_lock </a></li>
+
+ <li class="toctree-l3"><a href="#nffs_unlock"> nffs_unlock </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
</ul>
@@ -198,17 +216,17 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-nffs_lock">nffs_lock</a></li>
-<li><a href="#function-nffs_unlock">nffs_unlock</a></li>
+<li><a href="#nffs_lock">nffs_lock</a></li>
+<li><a href="#nffs_unlock">nffs_unlock</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-nffs_lock"><font color="2980b9">function nffs_lock </font><a class="headerlink" href="#function-nffs_lock" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="nffs_lock"><font color="F2853F" style="font-size:24pt"> nffs_lock </font><a class="headerlink" href="#nffs_lock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
nffs_lock(void)
</code></pre>
@@ -242,14 +260,14 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
+<pre><code class="no-highlight">
<Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-nffs_unlock"><font color="#2980b9"> function nffs_unlock </font><a class="headerlink" href="#function-nffs_unlock" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
+<h2 id="nffs_unlock"><font color="#F2853F" style="font-size:24pt"> nffs_unlock </font><a class="headerlink" href="#nffs_unlock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
@@ -282,15 +300,14 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
+<pre><code class="no-highlight">
<Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -322,9 +339,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/modules/shell/index.html
----------------------------------------------------------------------
diff --git a/modules/shell/index.html b/modules/shell/index.html
index 2c5dd87..179e269 100644
--- a/modules/shell/index.html
+++ b/modules/shell/index.html
@@ -141,19 +141,37 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../console/">Console</a></li>
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
- <li class="toctree-l3"><a href="./">Shell</a></li>
+ <li class="toctree-l2"><a href="./">Shell</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#shell_cmd_list_lock"> shell_cmd_list_lock </a></li>
+
+ <li class="toctree-l3"><a href="#shell_cmd_list_unlock"> shell_cmd_list_unlock </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../bootloader/">Bootloader</a></li>
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
- <li class="toctree-l3"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
- <li class="toctree-l3"><a href="../testutil/">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="../testutil/">Test Utilities</a></li>
</ul>
@@ -196,7 +214,7 @@
<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
<p>A few commands to the console interface are currently available in the shell - <code>tasks</code>, <code>log</code>, and <code>stat stat</code>. A $ prompt sign will be coming soon!</p>
<p>Create a sim target to check out these commands available in shell.</p>
-<pre><code>user@~/dev/larva$ newt target create blinky_sim
+<pre><code class="no-highlight">user@~/dev/larva$ newt target create blinky_sim
Creating target blinky_sim
Target blinky_sim successfully created!
user@~/dev/larva$ newt target set blinky_sim name=blinky_sim
@@ -238,7 +256,7 @@ uart0 at /dev/ttys005
</code></pre>
<p>Open up a new terminal to run minicom, a text-based serial port control and terminal emulation program. Set device name to the serial port of the target. </p>
-<pre><code>user@~$ minicom -D /dev/ttys005
+<pre><code class="no-highlight">user@~$ minicom -D /dev/ttys005
Welcome to minicom 2.7
OPTIONS:
@@ -268,17 +286,17 @@ stat stat
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-shell_cmd_list_lock">shell_cmd_list_lock</a></li>
-<li><a href="#function-shell_cmd_list_unlock">shell_cmd_list_unlock</a></li>
+<li><a href="#shell_cmd_list_lock">shell_cmd_list_lock</a></li>
+<li><a href="#shell_cmd_list_unlock">shell_cmd_list_unlock</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-shell_cmd_list_lock"><font color="2980b9">function shell_cmd_list_lock </font><a class="headerlink" href="#function-shell_cmd_list_lock" title="Permanent link">¶</a></h3>
-<pre><code> static int
+<h2 id="shell_cmd_list_lock"><font color="F2853F" style="font-size:24pt"> shell_cmd_list_lock </font><a class="headerlink" href="#shell_cmd_list_lock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static int
shell_cmd_list_lock(void)
</code></pre>
@@ -311,15 +329,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-shell_cmd_list_unlock"><font color="#2980b9"> function shell_cmd_list_unlock </font><a class="headerlink" href="#function-shell_cmd_list_unlock" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="shell_cmd_list_unlock"><font color="#F2853F" style="font-size:24pt"> shell_cmd_list_unlock </font><a class="headerlink" href="#shell_cmd_list_unlock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -351,15 +366,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -391,9 +403,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/modules/testutil/index.html
----------------------------------------------------------------------
diff --git a/modules/testutil/index.html b/modules/testutil/index.html
index 13ae6e2..7c8884a 100644
--- a/modules/testutil/index.html
+++ b/modules/testutil/index.html
@@ -141,19 +141,37 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../console/">Console</a></li>
+ <li class="toctree-l2"><a href="../console/">Console</a></li>
- <li class="toctree-l3"><a href="../shell/">Shell</a></li>
+ <li class="toctree-l2"><a href="../shell/">Shell</a></li>
- <li class="toctree-l3"><a href="../bootloader/">Bootloader</a></li>
+ <li class="toctree-l2"><a href="../bootloader/">Bootloader</a></li>
- <li class="toctree-l3"><a href="../filesystem/">File System</a></li>
+ <li class="toctree-l2"><a href="../filesystem/">File System</a></li>
- <li class="toctree-l3"><a href="./">Test Utilities</a></li>
+ <li class="toctree-l2"><a href="./">Test Utilities</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#tu_init"> tu_init </a></li>
+
+ <li class="toctree-l3"><a href="#tu_restart"> tu_restart </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
</ul>
@@ -198,19 +216,18 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-tu_init">tu_init</a></li>
-<li><a href="#function-tu_restart">tu_restart</a></li>
+<li><a href="#tu_init">tu_init</a></li>
+<li><a href="#tu_restart">tu_restart</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-tu_init"><font color="2980b9">function tu_init </font><a class="headerlink" href="#function-tu_init" title="Permanent link">¶</a></h3>
-<pre><code> int
+<h2 id="tu_init"><font color="F2853F" style="font-size:24pt"> tu_init </font><a class="headerlink" href="#tu_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> int
tu_init(void)
-
</code></pre>
<p><Insert short description></p>
@@ -242,15 +259,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-tu_restart"><font color="#2980b9"> function tu_restart </font><a class="headerlink" href="#function-tu_restart" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="tu_restart"><font color="#F2853F" style="font-size:24pt"> tu_restart </font><a class="headerlink" href="#tu_restart" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -282,15 +296,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -322,9 +333,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/newt/newt_ops/index.html
----------------------------------------------------------------------
diff --git a/newt/newt_ops/index.html b/newt/newt_ops/index.html
index 3ec0a33..c73acaa 100644
--- a/newt/newt_ops/index.html
+++ b/newt/newt_ops/index.html
@@ -131,10 +131,14 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="./">Command structure</a></li>
+ <li class="toctree-l2"><a href="./">Command structure</a></li>
+
+
+
+
- <li class="toctree-l3"><a href="../newt_tool_reference/">Command list</a></li>
+ <li class="toctree-l2"><a href="../newt_tool_reference/">Command list</a></li>
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/newt/newt_tool_reference/index.html
----------------------------------------------------------------------
diff --git a/newt/newt_tool_reference/index.html b/newt/newt_tool_reference/index.html
index 35397aa..54be997 100644
--- a/newt/newt_tool_reference/index.html
+++ b/newt/newt_tool_reference/index.html
@@ -131,10 +131,26 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../newt_ops/">Command structure</a></li>
+ <li class="toctree-l2"><a href="../newt_ops/">Command structure</a></li>
- <li class="toctree-l3"><a href="./">Command list</a></li>
+ <li class="toctree-l2"><a href="./">Command list</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#available-high-level-commands">Available high-level commands</a></li>
+
+ <li class="toctree-l3"><a href="#version">version</a></li>
+
+ <li class="toctree-l3"><a href="#help">help</a></li>
+
+ <li class="toctree-l3"><a href="#nest">nest</a></li>
+
+ <li class="toctree-l3"><a href="#egg">egg</a></li>
+
+ <li class="toctree-l3"><a href="#target">target</a></li>
+
+
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/callout/index.html
----------------------------------------------------------------------
diff --git a/os/callout/index.html b/os/callout/index.html
index 7027e4e..81dc440 100644
--- a/os/callout/index.html
+++ b/os/callout/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="./">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="./">Callout Functions</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_callout_init">os_callout_init </a></li>
+
+ <li class="toctree-l3"><a href="#os_callout_func_init"> os_callout_func_init </a></li>
+
+ <li class="toctree-l3"><a href="#next_one">next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -221,19 +239,18 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_callout_init">os_callout_init</a></li>
-<li><a href="#function-os_callout_func_init">os_callout_func_init</a></li>
+<li><a href="#os_callout_init">os_callout_init</a></li>
+<li><a href="#os_callout_func_init">os_callout_func_init</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_callout_init"><font color="2980b9">function os_callout_init</font><a class="headerlink" href="#function-os_callout_init" title="Permanent link">¶</a></h3>
-<pre><code> void
- os_callout_init(struct os_callout *c, struct os_eventq *evq, void *ev_arg)
-
+<h2 id="os_callout_init"><font color="#F2853F" style="font-size:24pt">os_callout_init </font><a class="headerlink" href="#os_callout_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">void
+os_callout_init(struct os_callout *c, struct os_eventq *evq, void *ev_arg)
</code></pre>
<p><Insert short description></p>
@@ -265,15 +282,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_callout_func_init"><font color="#2980b9"> function os_callout_func_init</font><a class="headerlink" href="#function-os_callout_func_init" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_callout_func_init"><font color="#F2853F" style="font-size:24pt"> os_callout_func_init </font><a class="headerlink" href="#os_callout_func_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -305,15 +319,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt">next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -345,9 +356,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/context_switch/index.html
----------------------------------------------------------------------
diff --git a/os/context_switch/index.html b/os/context_switch/index.html
index f5150bd..0e92916 100644
--- a/os/context_switch/index.html
+++ b/os/context_switch/index.html
@@ -136,43 +136,55 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="./">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="./">Scheduler/Context Switching</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,17 +234,17 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in the scheduler are:</p>
<ul>
-<li><a href="#function-os_sched_insert">os_sched_insert</a></li>
-<li><a href="#function-os_sched_walk">os_sched_walk</a></li>
+<li><a href="#os_sched_insert">os_sched_insert</a></li>
+<li><a href="#os_sched_walk">os_sched_walk</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_sched_insert"><font color="2980b9">function os_sched_insert</font><a class="headerlink" href="#function-os_sched_insert" title="Permanent link">¶</a></h3>
-<pre><code> os_error_t
+<h3 id="os_sched_insert"><font color="#F2853F" style="font-size:24pt"> os_sched_insert</font><a class="headerlink" href="#os_sched_insert" title="Permanent link">¶</a></h3>
+<pre><code class="no-highlight"> os_error_t
os_sched_insert(struct os_task *t)
</code></pre>
@@ -265,15 +277,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_sched_walk"><font color="#2980b9"> function os_sched_walk</font><a class="headerlink" href="#function-os_sched_walk" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h3 id="os_sched_walk"><font color="#F2853F" style="font-size:24pt"> os_sched_walk</font><a class="headerlink" href="#os_sched_walk" title="Permanent link">¶</a></h3>
+<pre><code class="no-highlight"><Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -305,15 +314,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h3 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h3>
+<pre><code class="no-highlight"><Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -345,9 +351,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/event_queue/index.html
----------------------------------------------------------------------
diff --git a/os/event_queue/index.html b/os/event_queue/index.html
index 5236a70..2b52b26 100644
--- a/os/event_queue/index.html
+++ b/os/event_queue/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="./">Event Queues</a></li>
+ <li class="toctree-l2"><a href="./">Event Queues</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_eventq_init"> os_eventq_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_eventq_put2"> os_eventq_put2</a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,17 +240,17 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_eventq_init">os_eventq_init</a></li>
-<li><a href="#function-os_eventq_put2">os_eventq_put2</a></li>
+<li><a href="#os_eventq_init">os_eventq_init</a></li>
+<li><a href="#os_eventq_put2">os_eventq_put2</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_eventq_init"><font color="2980b9">function os_eventq_init</font><a class="headerlink" href="#function-os_eventq_init" title="Permanent link">¶</a></h3>
-<pre><code> void
+<h2 id="os_eventq_init"><font color="F2853F" style="font-size:24pt"> os_eventq_init</font><a class="headerlink" href="#os_eventq_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> void
os_eventq_init(struct os_eventq *evq)
</code></pre>
@@ -265,15 +283,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_eventq_put2"><font color="#2980b9"> function os_eventq_put2</font><a class="headerlink" href="#function-os_eventq_put2" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_eventq_put2"><font color="#F2853F" style="font-size:24pt"> os_eventq_put2</font><a class="headerlink" href="#os_eventq_put2" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -305,15 +320,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -345,9 +357,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
[4/7] incubator-mynewt-site git commit: Fix second level navigation
and function formats in docs
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/mkdocs/search_index.json
----------------------------------------------------------------------
diff --git a/mkdocs/search_index.json b/mkdocs/search_index.json
index e95e3d8..e042ecc 100644
--- a/mkdocs/search_index.json
+++ b/mkdocs/search_index.json
@@ -17,7 +17,7 @@
},
{
"location": "/download/",
- "text": "For general information on using Git at Apache, go to https://git-wip-us.apache.org.\n\n\nIf you are not a committer, follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is https://git-wip-us.apache.org/docs/workflow.html.\n\n\nTo clone the Mynewt OS development repository:\n\n\nNon Committers\n\n\n$ git clone http://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git\n\n\n\nCommitters\n\n\n$ git clone https://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git",
+ "text": "For general information on using Git at Apache, go to https://git-wip-us.apache.org.\n\n\nIf you are not a committer, follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is https://git-wip-us.apache.org/docs/workflow.html.\n\n\nTo clone the Mynewt OS development repository:\n\n\nNon Committers\n\n\n $ git clone http://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git\n\n\n\n\nCommitters\n\n\n $ git clone https://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git",
"title": "Download"
},
{
@@ -57,22 +57,22 @@
},
{
"location": "/get_started/project1/",
- "text": "Blinky, the First Project\n\n\nObjective\n\n\nWe will show you how you can use eggs from a nest on Mynewt to make an LED on a target board blink. We will call it \n Project Blinky\n. The goals of this tutorial are threefold:\n\n\n\n\nFirst, you will learn how to set up your environment to be ready to use Mynewt OS and newt tool. \n\n\nSecond, we will walk you through a download of eggs for building and testing \non a simulated target\n.\n\n\nThird, you will download eggs and use tools to create a runtime image for a board to make its LED blink. You have two choices here - you can \ndownload an image to SRAM\n or you can \ndownload it to flash\n.\n\n\n\n\n Time Requirement\n: Allow yourself a couple of hours for this project if you are relatively new to embedded systems and playing with development boards. Those jumpers can be pesky!\n\n\nWhat you need\n\n\n\n\nSTM32-E407 development board from Olimex. You can order it from \nhttp://www.mouser.com\n, \nhttp://www
.digikey.com\n, and other places.\n\n\nARM-USB-TINY-H connector with JTAG interface for debugging ARM microcontrollers (comes with the ribbon cable to hook up to the board)\n\n\nUSB A-B type cable to connect the debugger to your personal computer\n\n\nPersonal Computer\n\n\n\n\nThe instructions assume the user is using a Bourne-compatible shell (e.g. bash or zsh) on your computer. The given instructions have been tested with the following releases of operating systems:\n\n\n\n\nMac: OS X Yosemite Version 10.10.5\n\n\nLinux: Ubuntu 14.10 (Utopic Unicorn)\n\n\nWindows: Windows 10\n\n\n\n\nAccess to the Apache repo\n\n\n\n\n\n\nGet an account on Apache. You do not need a committer account to view the website or clone the repository but you need it to push changes to it.\n\n\n\n\n\n\nThe latest codebase for the Mynewt OS is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git\n\n\n\n\n\n\nThe latest codebase for the Newt tool is on the master branch
at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git\n\n\n\n\n\n\nThe following shows how to clone a Mynewt OS code repository:\n\n\n\n\n\n\nNon Committers\n\n\n$ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git\n\n\n\n\n\n\n\nCommitters\n\n\n$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git\n\n\n\n\n\n\n\nGetting your Mac Ready\n\n\nInstalling Homebrew to ease installs on OS X\n\n\n\n\n\n\nDo you have Homebrew? If not, open a terminal on your Mac and paste the following at a Terminal prompt. It will ask you for your sudo password.\n\n\n$ ruby -e \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)\"\n\n\n\nAlternatively, you can just extract (or \ngit clone\n) Homebrew and install it to \n/usr/local\n.\n\n\n\n\n\n\nInstalling Go\n\n\n\n\n\n\nThe directory structure must be first readied for using Go. Go code must be kept inside a workspace. A workspace is a directory hierarchy with
three directories at its root:\n\n\n\n\n\n\nsrc contains Go source files organized into packages (one package per directory),\n\n\n\n\n\n\npkg contains package objects, and\n\n\n\n\n\n\nbin contains executable commands.\n\n\n\n\n\n\nThe GOPATH environment variable specifies the location of your workspace. First create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory where you will soon clone the newt tool repository.\n\n\n$ cd $HOME\n$ mkdir -p dev/go \n$ cd dev/go\n$ export GOPATH=`pwd`\n\n\n\nNote that you need to add export statements to ~/.bash_profile to export variables permanently. Don't forget to source the file for the change to go into effect.\n\n\n$ vi ~/.bash_profile\n$ source ~/.bash_profile\n\n\n\n\n\n\n\nNext you will use Homebrew to install Go. The summary message at the end of the installation should indicate that it is installed in the /usr/local/Cellar/go/ directory. You will use the Go command 'install'
to compile and install packages (called eggs in the Mynewt world) and dependencies. \n\n\n$ brew install go\n==\n \n...\n... \n==\n *Summary*\n\ud83c\udf7a /usr/local/Cellar/go/1.5.1: 5330 files, 273M\n\n\n\nAlternatively, you can download the Go package directly from (https://golang.org/dl/) instead of brewing it. Install it in /usr/local directory.\n\n\n\n\n\n\nCreating local repository\n\n\n\n\n\n\nYou are ready to download the newt tool repository. You will use Go to copy the directory (currently the asf incubator directory). Be patient as it may take a minute or two. Check the directories installed.\n\n\n$ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt\n$ ls\n bin pkg src\n$ ls src\ngit-wip-us.apache.org github.com gopkg.in\n\n\n\n\n\n\n\nCheck that newt.go is in place.\n\n\n$ ls $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt \nGodeps README.md coding_style.txt newt.go\nLICENSE cli
design.txt\n\n\n\n\n\n\n\nBuilding the Newt tool\n\n\n\n\n\n\nYou will use Go to run the newt.go program to build the newt tool. The command used is \ngo install\n which compiles and writes the resulting executable to an output file named \nnewt\n. It installs the results along with its dependencies in $GOPATH/bin.\n\n\n$ cd $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt\n$ go install\n$ ls \"$GOPATH\"/bin/\ngodep incubator-mynewt-newt.git newt\n\n\n\n\n\n\n\nTry running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.\n\n\n\n\n\n\nNote: If you are going to be be modifying the newt tool itself often and wish to compile the program every time you call it, you may want to store the command in a variable in your .bash_profile. So type in \nexport newt=\"go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator
-mynewt-newt.git/newt/newt/go\"\n in your .bash_profile and execute it by calling \n$newt\n at the prompt instead of \nnewt\n. Here, you use \ngo run\n which runs the compiled binary directly without producing an executable. Don't forget to reload the updated bash profile by typing \nsource ~/.bash_profile\n at the prompt! \n\n\n $ newt version\n Newt version: 1.0\n $ newt -h\n Newt allows you to create your own embedded project based on the Mynewt\n operating system. Newt provides both build and package management in a\n single tool, which allows you to compose an embedded workspace, and set\n of projects, and then build the necessary artifacts from those projects.\n For more information on the Mynewt operating system, please visit\n https://www.github.com/mynewt/documentation.\n\n Please use the newt help command, and specify the name of the command\n you want help for, for help on how to use a specific command\n\n Usage:\n newt [flags]\n
newt [command]\n\n Examples:\n newt\n newt help [\ncommand-name\n]\n For help on \ncommand-name\n. If not specified, print this message.\n\n\n Available Commands:\n version Display the Newt version number.\n target Set and view target information\n egg Commands to list and inspect eggs on a nest\n nest Commands to manage nests \n clutches (remote egg repositories)\n help Help about any command\n\n 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.\n\n\n Use \"newt help [command]\" for more information about a command.\n\n\n\n\n\nWithout creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded
a nest to try out the tool. \n\n\n\n\nGetting the debugger ready\n\n\n\n\n\n\nBefore you start building nests and hatching eggs, you need to do one final step in the environment preparation - install gcc / libc that can produce 32-bit executables. So, first install gcc. You will see the brew steps and a final summary confirming install.\n\n\n$ brew install gcc\n...\n...\n==\n Summary\n\ud83c\udf7a /usr/local/Cellar/gcc/5.2.0: 1353 files, 248M\n\n\n\n\n\n\n\nARM maintains a pre-built GNU toolchain with a GCC source branch targeted at Embedded ARM Processors namely Cortex-R/Cortex-M processor families. Install the PX4 Toolchain and check the version installed. Make sure that the symbolic link installed by Homebrew points to the correct version of the debugger. If not, you can either change the symbolic link using the \"ln -f -s\" command or just go ahead and try with the version it points to!\n\n\n$ brew tap PX4/homebrew-px4\n$ brew update\n$ brew install gcc-arm-none-eabi-49\n$ arm-
none-eabi-gcc --version \narm-none-eabi-gcc (GNU Tools for ARM Embedded Processors) 4.9.3 20150529 (release) [ARM/embedded-4_9-branch revision 224288]\nCopyright (C) 2014 Free Software Foundation, Inc.\nThis is free software; see the source for copying conditions. There is NO\nwarranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n$ ls -al /usr/local/bin/arm-none-eabi-gdb\nlrwxr-xr-x 1 aditihilbert admin 69 Sep 22 17:16 /usr/local/bin/arm-none-eabi-gdb -\n /usr/local/Cellar/gcc-arm-none-eabi-49/20150609/bin/arm-none-eabi-gdb\n\n\n\nNote: If no version is specified, brew will install the latest version available. MynewtOS will eventually work with multiple versions available including the latest releases. However, at present we have tested only with this version and recommend it for getting started. \n\n\n\n\n\n\nYou have to install OpenOCD (Open On-Chip Debugger) which is an open-source software that will allow you to interface with the JTAG debug connecto
r/adaptor for the Olimex board. It lets you program, debug, and test embedded target devices which, in this case, is the Olimex board. Use brew to install it. Brew adds a simlink /usr/local/bin/openocd to the openocd directory in the Cellar. For more on OpenOCD go to \nhttp://openocd.org\n.\n\n\n$ brew install open-ocd\n$ which openocd\n/usr/local/bin/openocd\n$ ls -l $(which openocd)\nlrwxr-xr-x 1 \nuser\n admin 36 Sep 17 16:22 /usr/local/bin/openocd -\n ../Cellar/open-ocd/0.9.0/bin/openocd\n\n\n\n\n\n\n\nProceed to the \nBuilding test code on simulator\n section.\n\n\n\n\n\n\nGetting your Ubuntu machine Ready\n\n\nInstalling some prerequisites\n\n\n\n\nInstall git, libcurl, and the Go language if you do not have them already.\n$ sudo apt-get install git \n$ sudo apt-get install libcurl4-gnutls-dev \n$ sudo apt-get install golang\n\n\n\n\n\n\n\nCreating local repository\n\n\n\n\n\n\nThe directory structure must be first readied for using Go. Go code must be kept inside a workspa
ce. A workspace is a directory hierarchy with three directories at its root:\n\n\n\n\n\n\nsrc contains Go source files organized into packages (one package per directory),\n\n\n\n\n\n\npkg contains package objects, and\n\n\n\n\n\n\nbin contains executable commands.\n\n\n\n\n\n\nThe GOPATH environment variable specifies the location of your workspace. First create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory where you will soon clone the newt tool repository.\n\n\n$ cd $HOME\n$ mkdir -p dev/go \n$ cd dev/go\n$ export GOPATH=$PWD\n\n\n\nNote that you need to add export statements to ~/.bashrc (or equivalent) to export variables permanently.\n\n\n\n\n\n\nYou are ready to download the newt tool repository. You will use Go to copy the directory (currently the asf incubator directory). Be patient as it may take a minute or two. Check the directories installed.\n\n\n$ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-new
t.git/newt\n$ ls\n bin pkg src\n$ ls src\ngit-wip-us.apache.org github.com gopkg.in\n\n\n\n\n\n\n\nCheck that newt is in place.\n\n\n$ ls $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt \nGodeps README.md coding_style.txt newt.go\nLICENSE cli design.txt\n\n\n\n\n\n\n\nBuilding the newt tool\n\n\n\n\n\n\nYou will use Go to run the newt.go program to build the newt tool. The command used is \ngo install\n which compiles and writes the resulting executable to an output file named \nnewt\n. It installs the results along with its dependencies in $GOPATH/bin.\n\n\n$ cd $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt\n$ go install\n$ ls \"$GOPATH\"/bin/\ngodep incubator-mynewt-newt.git newt\n\n\n\n\n\n\n\nTry running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by
typing 'newt -h'.\n\n\n\n\n\n\nNote: If you are going to be be modifying the newt tool itself often and wish to compile the program every time you call it, you may want to store the command in a variable in your .bash_profile. So type in \nexport newt=\"go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt/newt/go\"\n in your ~/.bashrc (or equivalent) and execute it by calling \n$newt\n at the prompt instead of \nnewt\n. Here, you use \ngo run\n which runs the compiled binary directly without producing an executable. \n\n\n $ newt version\n Newt version: 1.0\n $ newt -h\n Newt allows you to create your own embedded project based on the Mynewt\n operating system. Newt provides both build and package management in a\n single tool, which allows you to compose an embedded workspace, and set\n of projects, and then build the necessary artifacts from those projects.\n For more information on the Mynewt operating system, please visit\n
https://www.github.com/mynewt/documentation.\n\n Please use the newt help command, and specify the name of the command\n you want help for, for help on how to use a specific command\n\n Usage:\n newt [flags]\n newt [command]\n\n Examples:\n newt\n newt help [\ncommand-name\n]\n For help on \ncommand-name\n. If not specified, print this message.\n\n\n Available Commands:\n version Display the Newt version number.\n target Set and view target information\n egg Commands to list and inspect eggs on a nest\n nest Commands to manage nests \n clutches (remote egg repositories)\n help Help about any command\n\n 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.\n\n\n Use \"newt help [command]\" for more information about a command.\n\n\n\n\n\nWithout creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded a nest to try out the tool. \n\n\n\n\nGetting the debugger ready\n\n\n\n\n\n\nBefore you start building nests and hatching eggs, you need to do one final step in the environment preparation - install gcc / libc that can produce 32-bit executables. You can install these as follows: \n\n\n$ sudo apt-get install gcc-multilib libc6-i386\n\n\n\n\n\n\n\nFor the LED project on the Olimex hardware, you have to install gcc for AM 4.9.3. This package can be installed with apt-get as documented below. The steps are explained in depth at \nhttps://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded\n.\n\n\n$ sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi \n$ sudo add-apt-repository ppa:terry.guo/gcc-arm-embedded \n$ sudo apt-get update \n$ sudo apt-g
et install gcc-arm-none-eabi\n\n\n\n\n\n\n\nAnd finally, you have to install OpenOCD (Open On-Chip Debugger) which is an open-source software that will allow you to interface with the JTAG debug connector/adaptor for the Olimex board. It lets you program, debug, and test embedded target devices which, in this case, is the Olimex board. You have to acquire OpenOCD 0.8.0. \n\n\nIf you are running Ubuntu 15.x, then you are in luck and you can simply run: \n\n\n$ sudo apt-get install openocd\n\n\n\nOther versions of Ubuntu may not have the correct version of openocd available. In this case, you should download the openocd 0.8.0 package from \nhttps://launchpad.net/ubuntu/vivid/+source/openocd\n. The direct link to the amd64 build is \nhttp://launchpadlibrarian.net/188260097/openocd_0.8.0-4_amd64.deb\n. \n\n\n\n\n\n\nProceed to the \nBuilding test code on simulator\n section.\n\n\n\n\n\n\nGetting your Windows machine ready for simulated target\n\n\nThe \nnewt\n tool is the build softwar
e used to build Mynewt OS images or executables for any embedded hardware device/board, including the one for the current tutorial (STM32-E407 development board from Olimex). You can run the \nnewt\n tool natively on a computer running any of the three Operating System machines - OSX, Linux, or Windows.\n\n\nHowever, Mynewt OS images for a simulated target are built on the Windows machine by using Linux versions of the build software (newt)in a virtual machine on your Windows box. The Linux VM is set up by installing the Docker Toolbox. Your Windows machine will communicate with the Linux VM via transient ssh connections. You will then download a Docker image (\nnewtvm.exe\n)that allows you to run the newt commands in the Linux Docker instance. The Docker image contains:\n\n\n\n\nThe newt command-line tool\n\n\nGo\n\n\nA multilib-capable native gcc / glibc\n\n\nAn arm-none-eabi gcc\n\n\nNative gdb\n\n\n\n\nThe sequence of events when using the Docker image is as follows:\n\n\n\n\nA
new docker environment is created in the Linux VM.\n\n\nThe specified command with the newtvm prefix (\nnewtvm newt\n command) is sent to the docker environment via ssh.\n\n\nThe Linux command runs.\n\n\nThe output from the command is sent back to Windows via ssh.\n\n\nThe output is displayed in the Windows command prompt.\n\n\n\n\nInstall Linux virtual machine\n\n\n\n\n\n\nDownload the Docker Toolbox for Windows (version 1.9.0c or later) from \nhttps://www.docker.com/docker-toolbox\n. The Docker toolbox creates a consistently reproducible and self-contained environment in Linux.\n\n\n\n\n\n\nRun the Docker Toolbox installer. All the default settings are OK.\n\n\n\n\n\n\nYou may need to add \"C:\\Program Files\\Git\\usr\\bin\" to your PATH\nenvironment variable. To add to the PATH environment variable, right-click on the Start button in the bottom left corner. Choose System -\n Advanced system settings -\n Environment Variables. Click on the PATH variable under \"System variables\
" and click Edit to check and add it if it is not already there. \n\n\n\n\n\n\nInstall newtvm tool\n\n\n\n\n\n\nFrom your base user (home) directory, pull or clone the latest code from the newt repository into the \nnewt\n directory. It includes the executable \nnewtvm.exe\n for the newtvm tool in the \nnewtvm\n directory.\n\n\nC:\\Users\\admin\n git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt newt\n\n\n\n\n\n\nThe newtvm tool is what allows you to run programs in the Linux docker\ninstance. \n\n\n\n\nRun the Docker Quickstart Terminal application inside the Docker folder under Programs. You can find it by clicking Start button -\n All apps. By default, the Docker Toolbox installer creates a shortcut to this program on your desktop. Wait until you see an ASCII art whale displayed in the terminal window and the Docker prompt given. \n ## .\n ## ## ## ==\n ## ## ## ## ## ===\n /\"\"\"\"\"\"\"\"\"\"\"\
"\"\"\"\"\"\\___/ ===\n~~~ {~~ ~~~~ ~~~ ~~~~ ~~~ ~ / ===- ~~~\n \\______ o __/\n \\ \\ __/\n \\____\\_______/\n\n docker is configured to use the default machine with IP 192.168.99.100\n For help getting started, check out the docs at https://docs.docker.com\n\n admin@dev1 MINGW64 ~ (master)\n $\n\n\n\n\n\n\n\nThe first time you run this, it may take several minutes to complete. You will need to run the Docker Quickstart Terminal once each time you\nrestart your computer.\n\n\n\n\nOpen a command prompt (e.g., Windows-R, \"cmd\", enter). You execute the newt tool commands as though you were running newt in Linux, but you prefix each command with \"newtvm\". For example:\nC:\\Users\\admin\\newt\\newtvm\n newtvm newt help\n\n\n\n\n\n\n\nThe newtvm tool will take a long time to run the first time you execute\nit. The delay is due to the fact that the tool must download the mynewt\ndocker instance.\n\n\n\n\nYou are now ready to proceed to \nbuilding the
image for the simulated target\n.\n\n\n\n\nGetting your Windows machine ready for hardware target\n\n\nWhen you want to produce images for actual hardware board on your Windows machine, go through the following setup procedure and then proceed to the \nblinky project on the Olimex board\n with this method.\n\n\nInstalling some prerequisites\n\n\n\n\n\n\nYou have to install the following if you do not have them already. The steps below indicate specific folders where each of these programs should be installed. You can choose different locations, but the remainder of this\ntutorial for a Windows machine assumes the specified folders. \n\n\n\n\nwin-builds-i686\n\n\nwin-builds-x86_64\n\n\nMSYS\n\n\ngcc for ARM\n\n\nopenocd\n\n\nzadig\n\n\ngit\n\n\n\n\ngo\n\n\n\n\nwin-builds (mingw64) 1.5 for i686\n\n\n\n\nDownload from \nhttp://win-builds.org/doku.php/download_and_installation_from_windows\n. Install at: \"C:\\win-builds-i686\".\n\n\nBe sure to click the i686 option (not x86_64). T
he defaults for all other options are OK. The installer will want to download a bunch of additional packages. They are not all necessary, but it is simplest to just accept the defaults.\n\n\n\n\nwin-builds (mingw64) 1.5 for x86_64\n\n\n\n\nDownload from \nhttp://win-builds.org/doku.php/download_and_installation_from_windows\n. Install at \"C:\\win-builds-x86_64\"\n\n\nRun the installer a second time, but this time click the x86_64 option, NOT i686. The defaults for all other options are OK.\n\n\n\n\nMSYS\n\n\n\n\nStart your download from \nhttp://sourceforge.net/projects/mingw-w64/files/External%20binary%20packages%20%28Win64%20hosted%29/MSYS%20%2832-bit%29/MSYS-20111123.zip\n\n\nUnzip to \"C:\\msys\"\n\n\n\n\ngcc for ARM, 4.9.3\n\n\n\n\nDownload the Windows installer from \nhttps://launchpad.net/gcc-arm-embedded/+download\n and install at \"C:\\Program Files (x86)\\GNU Tools ARM Embedded\\4.9 2015q3\".\n\n\n\n\nOpenOCD 0.8.0 \n\n\n\n\nDownload OpenOCD 0.8.0 from \nhttp://www.fredd
iechopin.info/en/download/category/4-openocd\n. Unzip to \"C:\\openocd\".\n\n\n\n\nZadig 2.1.2\n\n\n\n\nDownload it from \nhttp://zadig.akeo.ie\n and install it at \"C:\\zadig\".\n\n\n\n\nGit\n\n\n\n\nClick on \nhttps://git-scm.com/download/win\n to start the download. Install at \"C:\\Program Files (x86)\\Git\". Specify the \"Use Git from the Windows Command Prompt\" option. The defaults for all other options are OK.\n\n\n\n\nGo\n\n\n\n\nDownload the release for Microsoft Windows from \nhttps://golang.org/dl/\n and install it \"C:\\Go\".\n\n\n\n\n\n\n\n\n\n\nCreating local repository\n\n\n\n\n\n\nThe directory structure must be first readied for using Go. Go code must be kept inside a workspace. A workspace is a directory hierarchy with three directories at its root:\n\n\n\n\n\n\nsrc contains Go source files organized into packages (one package per directory),\n\n\n\n\n\n\npkg contains package objects, and\n\n\n\n\n\n\nbin contains executable commands.\n\n\n\n\n\n\nThe GOPATH envi
ronment variable specifies the location of your workspace. First create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory and then proceed to create the directory for cloning the newt tool repository.\n\n\n$ cd c:\\\n$ mkdir dev\\go\n$ cd dev\\go\n\n\n\n\n\n\n\nSet the following user environment variables using the steps outlined here.\n\n\n\n\nGOPATH: C:\\dev\\go\n\n\nPATH: C:\\Program Files (x86)\\GNU Tools ARM Embedded\\4.9 2015q3\\bin;%GOPATH%\\bin;C:\\win-builds-x86_64\\bin;C:\\win-builds-i686\\bin;C:\\msys\\bin\n\n\n\n\nSteps:\n\n\n\n\nRight-click the start button\n\n\nClick \"Control panel\"\n\n\nClick \"System and Security\"\n\n\nClick \"System\"\n\n\nClick \"Advanced system settings\" in the left panel\n\n\nClick the \"Envoronment Variables...\" button\n\n\nThere will be two sets of environment variables: user variables\n in the upper half of the screen, and system variables in the lower\n half. Configuring the us
er variables is recommended and tested \n (though system variables will work as well).\n\n\n\n\n\n\n\n\nNext, install godep. Note that the following command produces no output.\n\n\n$ go get github.com/tools/godep\n\n\n\n\n\n\n\nSet up the repository for the package building tool \"newt\" on your local machine. First create the appropriate directory for it and then clone the newt tool repository from the online apache repository (or its github.com mirror) into this newly created directory. Check the contents of the directory.\n\n\n$ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt\n$ dir \n bin pkg src\n$ dir src\ngit-wip-us.apache.org github.com gopkg.in\n$ dir\nnewt\n$ cd newt\n$ dir\nGodeps README.md coding_style.txt newt.go\nLICENSE cli design.txt\n\n\n\n\n\n\n\nCheck that newt is in place.\n\n\n$ dir $GOPATH\\src\\git-wip-us.apache.org\\repos\\asf\\incubator-mynewt-newt.
git\\newt \nGodeps README.md coding_style.txt newt.go\nLICENSE cli design.txt\n\n\n\n\n\n\n\nBuilding the newt tool\n\n\n\n\n\n\nYou will use Go to run the newt.go program to build the newt tool. The command used is \ngo install\n which compiles and writes the resulting executable to an output file named \nnewt\n. It installs the results along with its dependencies in $GOPATH/bin.\n\n\n$ go install\n$ ls \"$GOPATH\"/bin/\ngodep incubator-mynewt-newt.git newt\n\n\n\n\n\n\n\nTry running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.\n\n\nNote: If you are going to be be modifying the newt tool itself often and wish to compile the program every time you call it, you may want to define the newt environment variable that allows you to execute the command via \n%newt%\n. Use \nset newt=go run %GOPATH%\\src\\gith
ub.com\\mynewt\\newt\\newt.go\n or set it from the GUI. Here, you use \ngo run\n which runs the compiled binary directly without producing an executable.\n\n\n$ newt version\nNewt version: 1.0\n$ newt -h\nNewt allows you to create your own embedded project based on the Mynewt\noperating system. Newt provides both build and package management in a\nsingle tool, which allows you to compose an embedded workspace, and set\nof projects, and then build the necessary artifacts from those projects.\nFor more information on the Mynewt operating system, please visit\nhttps://www.github.com/mynewt/documentation.\n\nPlease use the newt help command, and specify the name of the command\nyou want help for, for help on how to use a specific command\n\nUsage:\n newt [flags]\n newt [command]\n\nExamples:\n newt\n newt help [\ncommand-name\n]\n For help on \ncommand-name\n. If not specified, print this message.\n\nAvailable Commands:\n version Display the Newt version number.\n target Se
t and view target information\n egg Commands to list and inspect eggs on a nest\n nest Commands to manage nests \n clutches (remote egg repositories)\n help Help about any command\n\nFlags:\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\nUse \"newt help [command]\" for more information about a command.\n\n\n\n\n\n\n\nWithout creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded a nest to try out the tool. \n\n\n\n\n\n\nGetting the debugger ready\n\n\n\n\n\n\nUse Zadig to configure the USB driver for your Olimex debugger. If your debugger is already set up, you can skip this step.\n\n\n\n\nPlug in your Olimex debugger.\n\n\nStart Zadig.\n\n\nCheck the Options -\n List
All Devices checkbox.\n\n\nSelect \"Olimex OpenOCD JTAG ARM-USB-TINY-H\" in the dropdown menu.\n\n\nSelect the \"WinUSB\" driver.\n\n\nClick the \"Install Driver\" button.\n\n\n\n\n\n\n\n\nProceed to the section on how to \nmake an LED blink\n section.\n\n\n\n\n\n\nBuilding test code on simulator\n\n\nNote: On a Windows computer, the simulator can be run only in a Linux virtual environment. Make sure you have installed the Docker instance as outlined in \nan earlier section\n. Consequently, all \nnewt\n commands must be prefaced with \nnewtvm\n.\n\n\n\n\n\n\nFirst, you have to create a repository for the project i.e. build your first nest! Go to ~/dev (or your base user directory on a Windows machine)and clone the larva repository from the apache git repository into a local directory named \nlarva\n.\n\n\nSubstitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows. The newt tool commands do not change.\n\n\n$ cd ~/dev \n$ git clon
e https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva\n$ ls\ngo larva\n$ cd larva\n$ ls\nLICENSE clutch.yml hw nest.yml project\nREADME.md compiler libs net scripts\n\n\n\nOn Windows, open a command prompt (e.g., Windows-R, \"cmd\", enter) and work from your home directory:\n\n\nC:\\Users\\admin\n git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva\nC:\\Users\\admin\n cd larva\nC:\\Users\\admin\\larva\n dir\nVolume in drive C is Windows\nVolume Serial Number is 4CBB-0920\n\nDirectory of C:\\Users\\admin\\larva\n\n\nDIR\n .\n\nDIR\n ..\n 76 .gitignore\n 0 .gitmodules\n .nest\n 6,133 clutch.yml\n\nDIR\n compiler\n\nDIR\n hw\n\nDIR\n libs\n 11,560 LICENSE\n 20 nest.yml\n\nDIR\n net\n\nDIR\n project\n 2,263 README.md\n\nDIR\n scripts\n6 File(s) 20,052 by
tes\n9 Dir(s) 90,723,442,688 bytes free\n\n\n\n\n\n\n\nYou will now create a new target using the newt tool. You can either use the compiled binary \nnewt\n or run the newt.go program using \n$newt\n (assuming you have stored the command in a variable in your .bash_profile or .bashrc). When you do a \nnewt target show\n or \n$newt target show\n it should list all the projects you have created so far. \n\n\n$ newt target create sim_test\nCreating target sim_test\nTarget sim_test sucessfully created!\n$ newt target show\nsim_test\n name: sim_test\n arch: sim\n\n\n\nRemember, on a Windows machine you will have to preface \nnewt\n with \nnewtvm\n!\n\n\nC:\\Users\\admin\\larva\nnewtvm newt target create sim_test\n\n\n\n\n\n\n\nNow continue to populate and build out the sim project.\n\n\n$ newt target set sim_test project=test\nTarget sim_test successfully set project to test\n$ newt target set sim_test compiler_def=debug\nTarget sim_test successfully set compiler_def to debug\n$ n
ewt target set sim_test bsp=hw/bsp/native\nTarget sim_test successfully set bsp to hw/bsp/native\n$ newt target set sim_test compiler=sim\nTarget sim_test successfully set compiler to sim\n$ newt target show sim_test\nsim_test\n arch: sim\n project: test\n compiler_def: debug\n bsp: hw/bsp/native\n compiler: sim\n name: sim_test\n\n\n\nAgain remember to preface \nnewt\n with \nnewtvm\non a Windows machine as shown below. Continue to fill out all the project attributes.\n\n\nC:\\Users\\admin\\larva\nnewtvm newt target set sim_test project=test\nTarget sim_test successfully set project to test\n\n\n\n\n\n\n\nConfigure newt to use the gnu build tools native to OS X or linux. In order for sim to work properly, it needs to be using 32-bit gcc (gcc-5). Replace \n~/dev/larva/compiler/sim/compiler.yml with the compiler/sim/osx-compiler.yml or linux-compiler.yml file, depending on the system. On a Windows machine follow the instruction for the Linux machine as you are runni
ng commands in a Linux VM.\n\n\nFor a Mac OS X environment:\n\n\n$ cp compiler/sim/osx-compiler.yml compiler/sim/compiler.yml\n\n\n\nFor a Linux machine:\n\n\n$ cp compiler/sim/linux-compiler.yml compiler/sim/compiler.yml\n\n\n\n\n\n\n\nNext, create (hatch!) the eggs for this project using the newt tool - basically, build the packages for it. You can specify the VERBOSE option if you want to see the gory details. Always remember to preface \nnewt\n with \nnewtvm\non a Windows machine.\n\n\n$ newt target build sim_test\nSuccessfully run!\n\n\n\nYou can specify the VERBOSE option if you want to see the gory details.\n\n\n$newt -l VERBOSE target build sim_test\n2015/09/29 09:46:12 [INFO] Building project test\n2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//bootutil...\n2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//cmsis-core...\n2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//ffs..\n...\nSuc
cessfully run!\n\n\n\n\n\n\n\nTry running the test suite executable inside this project and enjoy your first successful hatch.\n\n\n$ newt ./project/test/bin/sim_test/test.elf\n[pass] os_mempool_test_suite/os_mempool_test_case\n[pass] os_mutex_test_suite/os_mutex_test_basic\n[pass] os_mutex_test_suite/os_mutex_test_case_1\n[pass] os_mutex_test_suite/os_mutex_test_case_2\n[pass] os_sem_test_suite/os_sem_test_basic\n[pass] os_sem_test_suite/os_sem_test_case_1\n[pass] os_sem_test_suite/os_sem_test_case_2\n[pass] os_sem_test_suite/os_sem_test_case_3\n[pass] os_sem_test_suite/os_sem_test_case_4\n[pass] os_mbuf_test_suite/os_mbuf_test_case_1\n[pass] os_mbuf_test_suite/os_mbuf_test_case_2\n[pass] os_mbuf_test_suite/os_mbuf_test_case_3\n[pass] gen_1_1/ffs_test_unlink\n[pass] gen_1_1/ffs_test_rename\n[pass] gen_1_1/ffs_test_truncate\n[pass] gen_1_1/ffs_test_append\n[pass] gen_1_1/ffs_test_read\n[pass] gen_1_1/ffs_test_overwrite_one\n[pass] gen_1_1/ffs_test_overwrite_two\n[pass] gen_1_1/ffs_t
est_overwrite_three\n...\n...\n[pass] boot_test_main/boot_test_vb_ns_11\n\n\n\n\n\n\n\nUsing SRAM to make LED blink\n\n\nYou are here because you want to build an image to be run from internal SRAM on the Olimex board.\n\n\nPreparing the Software\n\n\n\n\n\n\nMake sure the PATH environment variable includes the $HOME/dev/go/bin directory (or C:\\%GOPATH%\\bin on Windows machine). \n\n\nSubstitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows (e.g. \ncd dev\\go\n instead of \ncd dev/go\n). The newt tool commands do not change.\n\n\n\n\n\n\nIf you have cloned the larva repository for the simulator test in the previous section you can skip this step. Otherwise, you have to create a repository for the project i.e. build your first nest! Go to ~/dev and clone the larva repository from the apache git repository into a local directory named \nlarva\n.\n\n\nSubstitute DOS commands for Unix commands as necessary in the following steps i
f your machine is running Windows. The newt tool commands do not change.\n\n\n$ cd ~/dev \n$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva\n$ ls\ngo larva\n$ cd larva\n$ ls\nLICENSE clutch.yml hw nest.yml project\nREADME.md compiler libs net scripts\n\n\n\n\n\n\n\nYou first have to create a repository for the project. Go to the ~dev/larva directory and build out a second project inside larva. The project name is \"blinky\", in keeping with the objective. Starting with the target name, you have to specify the different aspects of the project to pull the appropriate eggs and build the right package for the board. In this case that means setting the architecture (arch), compiler, board support package (bsp), project, and compiler mode.\n\n\n\n\n\n\nRemember to prefix each command with \"newtvm\" if you are executing the newt command in a Linux virtual machine on your Windows box!\n\n\n $ newt target create blinky
\n Creating target blinky\n Target blinky sucessfully created!\n $ newt target set blinky arch=cortex_m4\n Target blinky successfully set arch to arm\n $ newt target set blinky compiler=arm-none-eabi-m4\n Target blinky successfully set compiler to arm-none-eabi-m4\n $ newt target set blinky project=blinky\n Target blinky successfully set project to blinky\n $ newt target set blinky compiler_def=debug\n Target blinky successfully set compiler_def to debug\n $ newt target set blinky bsp=hw/bsp/olimex_stm32-e407_devboard\n Target blinky successfully set bsp to hw/bsp/olimex_stm32-e407_devboard\n $ newt target show blinky\n blinky\n compiler: arm-none-eabi-m4\n project: blinky\n compiler_def: debug\n bsp: hw/bsp/olimex_stm32-e407_devboard\n name: blinky\n arch: cortex_m4\n\n\n\n\n\n\n\nNow you have to build the image. The linker script within the \nhw/bsp/olimex_stm32-e407_devboard\n egg builds an image
for flash memory by default. Since you want an image for the SRAM, you need to switch that script with \nrun_from_sram.ld\n in order to get the egg to produce an image for SRAM. \n We are working on making it easier to specify where the executable will be run from for a particular project and automatically choose the correct linker scripts and generate the appropriate image. It will be specified as a project identity e.g. bootloader, RAM, flash (default) and the target will build accordingly. \n. \n\n\nOnce the target is built, you can find the executable \"blinky.elf\" in the project directory at ~/dev/larva/project/blinky/bin/blinky. It's a good idea to take a little time to understand the directory structure.\n\n\n$ cd ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard\n$ diff olimex_stm32-e407_devboard.ld run_from_sram.ld\n$ cp run_from_sram.ld olimex_stm32-e407_devboard.ld\n$ cd ~/dev/larva/project/blinky/bin/blinky\n$ newt target build blinky\nBuilding target blinky (project = blin
ky)\nCompiling case.c\nCompiling suite.c\n...\nSuccessfully run!\n$ ls\nLICENSE clutch.yml hw nest.yml project\nREADME.md compiler libs net scripts\n$ cd project\n$ ls\nbin2img bletest blinky boot ffs2native test\n$ cd blinky\n$ ls\nbin blinky.yml egg.yml src\n$ cd bin\n$ ls\nblinky\n$ cd blinky\n$ ls\nblinky.elf blinky.elf.bin blinky.elf.cmd blinky.elf.lst blinky.elf.map\n\n\n\n\n\n\n\nCheck that you have all the scripts needed to get OpenOCD up and talking with the project's specific hardware. Depending on your system (Ubuntu, Windows) you may already have the scripts in your \n/usr/share/openocd/scripts/\n directory as they may have been part of the openocd download. If yes, you are all set and can proceed to preparing the hardware.\n\n\n\n\n\n\nOtherwise check the \n~/dev/larva/hw/bsp/olimex_stm32-e407_devboard\n directory for a file named \nf407.cfg\n. That is the config we will use to talk to this specific hardware
using OpenOCD. You are all set if you see it.\n\n\n $ ls ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard\n bin olimex_stm32-e407_devboard_debug.sh\n boot-olimex_stm32-e407_devboard.ld olimex_stm32-e407_devboard_download.sh\n egg.yml run_from_flash.ld\n f407.cfg run_from_loader.ld\n include run_from_sram.ld\n olimex_stm32-e407_devboard.ld src\n\n\n\nPreparing the hardware to boot from embedded SRAM\n\n\n\n\n\n\nLocate the boot jumpers on the board.\n\n\n\n\n\n\n\n\n\nB1_1/B1_0 and B0_1/B0_0 are PTH jumpers which can be moved relatively easy. Note that the markings on the board may not always be accurate. Always refer to the manual for the correct positioning of jumpers in case of doubt. The two jumpers must always be moved together \u2013 they are responsible for the boot mode if bootloader is present. The board can search for bootloader on three places \u2013 User Flash Memory, System Memory or
the Embedded SRAM. We will configure it to boot from SRAM by jumpering B0_1 and B1_1.\n\n\n\n\n\n\nConnect USB-OTG#2 in the picture above to a USB port on your computer (or a powered USB hub to make sure there is enough power available to the board). \n\n\n\n\n\n\nThe red PWR LED should be lit. \n\n\n\n\n\n\nConnect the JTAG connector to the SWD/JTAG interface on the board. The other end of the cable should be connected to the USB port or hub of your computer.\n\n\n\n\n\n\nLet's Go!\n\n\n\n\n\n\nMake sure you are in the blinky project directory with the blinky.elf executable. Run the debug command in the newt tool. You should see some status messages are shown below. There is an inbuilt \n-c \"reset halt\"\n flag that tells it to halt after opening the session.\n\n\n$ cd dev/larva/project/blinky/bin/blinky\n$ newt target debug blinky\nDebugging with /Users/aditihilbert/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_debug.sh blinky\nDebugging /Users/aditihilb
ert/dev/larva/project/blinky/bin/blinky/blinky.elf\nGNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs\nCopyright (C) 2014 Free Software Foundation, Inc.\nLicense GPLv3+: GNU GPL version 3 or later \nhttp://gnu.org/licenses/gpl.html\n\nThis is free software: you are free to change and redistribute it.\nThere is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\nand \"show warranty\" for details.\nThis GDB was configured as \"--host=x86_64-apple-darwin10 --target=arm-none-eabi\".\nType \"show configuration\" for configuration details.\nFor bug reporting instructions, please see:\n\nhttp://www.gnu.org/software/gdb/bugs/\n.\nFind the GDB manual and other documentation resources online at:\n\nhttp://www.gnu.org/software/gdb/documentation/\n.\nFor help, type \"help\".\nType \"apropos word\" to search for commands related to \"word\"...\nReading symbols from /Users/aditihilbert/dev/larva/project/blinky/bin/ blinky/blinky.elf...done.\nOpen On-Chip D
ebugger 0.8.0 (2015-09-22-18:21)\nLicensed under GNU GPL v2\nFor bug reports, read\n http://openocd.sourceforge.net/doc/doxygen/bugs.html\nInfo : only one transport option; autoselect 'jtag'\nadapter speed: 1000 kHz\nadapter_nsrst_delay: 100\njtag_ntrst_delay: 100\nWarn : target name is deprecated use: 'cortex_m'\nDEPRECATED! use 'cortex_m' not 'cortex_m3'\ncortex_m reset_config sysresetreq\nInfo : clock speed 1000 kHz\nInfo : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)\nInfo : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)\nInfo : stm32f4x.cpu: hardware has 6 breakpoints, 4 watchpoints\nInfo : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)\nInfo : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)\ntarget state: halted\ntarget halted due to debug-request, current mode: Thread \nxPSR: 0x01000000 pc: 0x20000250 msp: 0x
10010000\nInfo : accepting 'gdb' connection from 3333\nInfo : device id = 0x10036413\nInfo : flash size = 1024kbytes\nReset_Handler () at startup_STM32F40x.s:199\n199 ldr r1, =__etext\n\n\n\nCheck the value of the msp (main service pointer) register. If it is not 0x10010000 as indicated above, you will have to manually set it after you open the gdp tool and load the image on it. \n\n\n(gdb) set $msp=0x10010000\n\n\n\nNow load the image and type \"c\" or \"continue\" from the GNU debugger. \n\n\n(gdb) load ~/dev/larva/project/blinky/bin/blinky/blinky.elf\nLoading section .text, size 0x4294 lma 0x20000000\nLoading section .ARM.extab, size 0x24 lma 0x20004294\nLoading section .ARM.exidx, size 0xd8 lma 0x200042b8\nLoading section .data, size 0x874 lma 0x20004390\nStart address 0x20000250, load size 19460\nTransfer rate: 81 KB/sec, 2432 bytes/write.\n(gdb) c\nContinuing.\n\n\n\n\n\n\n\nVoil\u00e0! The board's LED should be blinking at 1 Hz.\n\n\n\n\n\n\nUsing flash to make LED bli
nk\n\n\nYou are here because you want to build an image to be run from flash memory on the Olimex board.\n\n\n\n\nConfigure the board to boot from flash by moving the two jumpers together to B0_0 and B1_0. Refer to the pictures of the board under the section titled \n\"Preparing the hardware to boot from embedded SRAM\"\n.\n\n\n\n\nYou will have to reset the board once the image is uploaded to it.\n\n\n\n\n\n\nIf you skipped the first option for the project \n(downloading an image to SRAM)\n, then skip this step. Otherwise, continue with this step. \n\n\nBy default, the linker script (\nolimex_stm32-e407_devboard.ld\n) is configured to run from bootloader and flash. However, if you first ran the image from SRAM you had changed \nolimex_stm32-e407_devboard.ld\n to match \nrun_from_sram.ld\n. You will therefore return to defaults with \nolimex_stm32-e407_devboard.ld\n linker script matching the contents of 'run_from_loader.ld'. Return to the project directory.\n\n\n$ cd ~/dev/larva/hw
/bsp/olimex_stm32-e407_devboard\n$ diff olimex_stm32-e407_devboard.ld run_from_sram.ld\n$ diff olimex_stm32-e407_devboard.ld run_from_loader.ld\n$ cp run_from_loader.ld olimex_stm32-e407_devboard.ld\n$ cd ~/dev/larva/project/blinky/bin/blinky\n\n\n\n\n\n\n\nIn order to run the image from flash, you need to build the bootloader as well. The bootloader does the initial bring up of the Olimex board and then transfers control to the image stored at a location in flash known to it. The bootloader in turn requires the bin2image tool to check the image header for version information, CRC checks etc. So, we will need to build these two additional targets (bootloader and bin2img).\n\n\n\n\n\n\nLet's first create bin2img:\n\n\n $ newt target create bin2img\n Creating target bin2img\n Target bin2img successfully created!\n $ newt target set bin2img arch=sim\n Target bin2img successfully set arch to sim\n $ newt target set bin2img compiler=sim\n Target bin2img successfully
set compiler to sim\n $ newt target set bin2img project=bin2img\n Target bin2img successfully set project to bin2img\n $ newt target set bin2img compiler_def=debug\n Target bin2img successfully set compiler_def to debug\n $ newt target set bin2img bsp=hw/bsp/native\n Target bin2img successfully set bsp to hw/bsp/native\n $ newt target show bin2img\n bin2img\n arch: sim\n compiler: sim\n project: bin2img\n compiler_def: debug\n bsp: hw/bsp/native\n name: bin2img\n\n\n\nAnd then let's create boot_olimex:\n\n\n $ newt target create boot_olimex\n Creating target boot_olimex\n Target boot_olimex successfully created!\n $ newt target set boot_olimex arch=cortex_m4\n Target boot_olimex successfully set arch to cortex_m4\n $ newt target set boot_olimex compiler=arm-none-eabi-m4\n Target boot_olimex successfully set compiler to arm-none-eabi-m4\n $ newt target set boot_olimex project=boot\n Target bo
ot_olimex successfully set project to boot\n $ newt target set boot_olimex compiler_def=optimized\n Target boot_olimex successfully set compiler_def to optimized\n $ newt target set boot_olimex bsp=hw/bsp/olimex_stm32-e407_devboard\n Target boot_olimex successfully set bsp to hw/bsp/olimex_stm32-e407_devboard\n $ newt target show boot_olimex\n boot_olimex\n project: boot\n compiler_def: optimized\n bsp: hw/bsp/olimex_stm32-e407_devboard\n name: boot_olimex\n arch: cortex_m4\n compiler: arm-none-eabi-m4\n\n\n\n\n\n\n\nLet's build all the three targets now.\n\n\n$ newt target build bin2img\nBuilding target bin2img (project = bin2img)\nBuilding project bin2img\nSuccessfully run!\n$ newt target build boot_olimex\nBuilding target boot_olimex (project = boot)\nBuilding project boot\nSuccessfully run!\n$ newt target build blinky\nBuilding target blinky (project = blinky)\nBuilding project blinky\nSuccessfully run!\n\n\n\n\n\n\n\nG
o to the project directory and download the bootloader and the image to flash ... in a flash! \n\n\n$ cd ~/dev/larva/project/blinky/bin/blinky\n$ newt target download boot_olimex\nDownloading with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_download.sh\n$ newt target download blinky\nDownloading with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_download.sh\n\n\n\n\n\n\n\nThe LED should be blinking!\n\n\n\n\n\n\nBut wait...let's double check that it is indeed booting from flash and making the LED blink from the image in flash. Pull the USB cable off the Olimex JTAG adaptor. The debug connection to the JTAG port is now severed. Next power off the Olimex board by pulling out the USB cable from the board. Wait for a couple of seconds and plug the USB cable back to the board. \n\n\nThe LED light will start blinking again. Success!\n\n\nNote #1: If you want to download the image to flash and a gdb session opened up, use \nnewt targe
t debug blinky\n instead of \nnewt target download blinky\n.\n\n\n$ newt target debug blinky\nDebugging with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_debug.sh blinky\nDebugging ~/dev/larva/project/blinky/bin/blinky/blinky.elf\nGNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs\nCopyright (C) 2014 Free Software Foundation, Inc.\nLicense GPLv3+: GNU GPL version 3 or later \nhttp://gnu.org/licenses/gpl.html\n\nThis is free software: you are free to change and redistribute it.\nThere is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\nand \"show warranty\" for details.\nThis GDB was configured as \"--host=x86_64-apple-darwin10 --target=arm-none-eabi\".\nType \"show configuration\" for configuration details.\nFor bug reporting instructions, please see:\n\nhttp://www.gnu.org/software/gdb/bugs/\n.\nFind the GDB manual and other documentation resources online at:\n\nhttp://www.gnu.org/software/gdb/documentation/\n.\nFor hel
p, type \"help\".\nType \"apropos word\" to search for commands related to \"word\"...\nReading symbols from /Users/aditihilbert/dev/larva/project/blinky/bin/blinky/blinky.elf...done.\nOpen On-Chip Debugger 0.8.0 (2015-09-22-18:21)\nLicensed under GNU GPL v2\nFor bug reports, read\n http://openocd.sourceforge.net/doc/doxygen/bugs.html\nInfo : only one transport option; autoselect 'jtag'\nadapter speed: 1000 kHz\nadapter_nsrst_delay: 100\njtag_ntrst_delay: 100\nWarn : target name is deprecated use: 'cortex_m'\nDEPRECATED! use 'cortex_m' not 'cortex_m3'\ncortex_m reset_config sysresetreq\nInfo : clock speed 1000 kHz\nInfo : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)\nInfo : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)\nInfo : stm32f4x.cpu: hardware has 6 breakpoints, 4 watchpoints\nInfo : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)\nInfo : JTAG tap:
stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)\ntarget state: halted\ntarget halted due to debug-request, current mode: Thread \nxPSR: 0x01000000 pc: 0x08000250 msp: 0x10010000\nInfo : accepting 'gdb' connection from 3333\nInfo : device id = 0x10036413\nInfo : flash size = 1024kbytes\nReset_Handler () at startup_STM32F40x.s:199\n199 ldr r1, =__etext\n(gdb)\n\n\n\nNote #2: If you want to erase the flash and load the image again you may use the following commands from within gdb. \nflash erase_sector 0 0 x\n tells it to erase sectors 0 through x. When you ask it to display (in hex notation) the contents of the sector starting at location 'lma' you should therefore see all f's. The memory location 0x8000000 is the start or origin of the flash memory contents and is specified in the olimex_stm32-e407_devboard.ld linker script. The flash memory locations is specific to the processor.\n\n\n(gdb) monitor flash erase_sector 0 0 4\nerased sectors 0 throu
gh 4 on flash bank 0 in 2.296712s\n(gdb) monitor mdw 0x08000000 16\n0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff \n(0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff \n(0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff \n(0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff \n(gdb) monitor flash info 0\n\nmonitor flash erase_check 0",
+ "text": "Blinky, the First Project\n\n\nObjective\n\n\nWe will show you how you can use eggs from a nest on Mynewt to make an LED on a target board blink. We will call it \n Project Blinky\n. The goals of this tutorial are threefold:\n\n\n\n\nFirst, you will learn how to set up your environment to be ready to use Mynewt OS and newt tool. \n\n\nSecond, we will walk you through a download of eggs for building and testing \non a simulated target\n.\n\n\nThird, you will download eggs and use tools to create a runtime image for a board to make its LED blink. You have two choices here - you can \ndownload an image to SRAM\n or you can \ndownload it to flash\n.\n\n\n\n\n Time Requirement\n: Allow yourself a couple of hours for this project if you are relatively new to embedded systems and playing with development boards. Those jumpers can be pesky!\n\n\nWhat you need\n\n\n\n\nSTM32-E407 development board from Olimex. You can order it from \nhttp://www.mouser.com\n, \nhttp://www
.digikey.com\n, and other places.\n\n\nARM-USB-TINY-H connector with JTAG interface for debugging ARM microcontrollers (comes with the ribbon cable to hook up to the board)\n\n\nUSB A-B type cable to connect the debugger to your personal computer\n\n\nPersonal Computer\n\n\n\n\nThe instructions assume the user is using a Bourne-compatible shell (e.g. bash or zsh) on your computer. The given instructions have been tested with the following releases of operating systems:\n\n\n\n\nMac: OS X Yosemite Version 10.10.5\n\n\nLinux: Ubuntu 14.10 (Utopic Unicorn)\n\n\nWindows: Windows 10\n\n\n\n\nAccess to the Apache repo\n\n\n\n\n\n\nGet an account on Apache. You do not need a committer account to view the website or clone the repository but you need it to push changes to it.\n\n\n\n\n\n\nThe latest codebase for the Mynewt OS is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git\n\n\n\n\n\n\nThe latest codebase for the Newt tool is on the master branch
at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git\n\n\n\n\n\n\nThe following shows how to clone a Mynewt OS code repository:\n\n\n\n\nNon Committers\n\n\n\n\n $ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git\n\n\n\n\n\n\nCommitters\n\n\n\n\n $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git\n\n\n\n\nGetting your Mac Ready\n\n\nInstalling Homebrew to ease installs on OS X\n\n\n\n\nDo you have Homebrew? If not, open a terminal on your Mac and paste the following at a Terminal prompt. It will ask you for your sudo password.\n\n\n\n\n $ ruby -e \n$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)\n\n\n\n\n\nAlternatively, you can just extract (or \ngit clone\n) Homebrew and install it to \n/usr/local\n.\n\n\nInstalling Go\n\n\n\n\n\n\nThe directory structure must be first readied for using Go. Go code must be kept inside a workspace. A workspace is a directory
hierarchy with three directories at its root:\n\n\n\n\n\n\nsrc contains Go source files organized into packages (one package per directory),\n\n\n\n\n\n\npkg contains package objects, and\n\n\n\n\n\n\nbin contains executable commands.\n\n\n\n\n\n\nThe GOPATH environment variable specifies the location of your workspace. First create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory where you will soon clone the newt tool repository.\n\n\n\n\n\n\n $ cd $HOME\n $ mkdir -p dev/go \n $ cd dev/go\n $ export GOPATH=`pwd`\n\n\n\n\nNote that you need to add export statements to ~/.bash_profile to export variables permanently. Don't forget to source the file for the change to go into effect.\n\n\n $ vi ~/.bash_profile\n $ source ~/.bash_profile\n\n\n\n\n\n\nNext you will use Homebrew to install Go. The summary message at the end of the installation should indicate that it is installed in the
/usr/local/Cellar/go/ directory. You will use the Go command 'install' to compile and install packages (called eggs in the Mynewt world) and dependencies. \n\n\n\n\n $ brew install go\n ==\n \n ...\n ... \n ==\n *Summary*\n \ud83c\udf7a /usr/local/Cellar/go/1.5.1: 5330 files, 273M\n\n\n\n\nAlternatively, you can download the Go package directly from (https://golang.org/dl/) instead of brewing it. Install it in /usr/local directory.\n\n\nCreating local repository\n\n\n\n\nYou are ready to download the newt tool repository. You will use Go to copy the directory (currently the asf incubator directory). Be patient as it may take a minute or two. Check the directories installed.\n\n\n\n\n $ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt\n $ ls\n bin pkg src\n $ ls src\n git-wip-us.apache.org github.com gopkg.in\n\n\n\n\n\n\nCheck that newt.go is in place.\n\n\n\n\n $
ls $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt \n Godeps README.md coding_style.txt newt.go\n LICENSE cli design.txt\n\n\n\n\nBuilding the Newt tool\n\n\n\n\nYou will use Go to run the newt.go program to build the newt tool. The command used is \ngo install\n which compiles and writes the resulting executable to an output file named \nnewt\n. It installs the results along with its dependencies in $GOPATH/bin.\n\n\n\n\n $ cd $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt\n $ go install\n $ ls \n$GOPATH\n/bin/\n godep incubator-mynewt-newt.git newt\n\n\n\n\n\n\nTry running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.\n\n\n\n\nNote: If you are going to be be modifying the newt tool itself often and wish to
compile the program every time you call it, you may want to store the command in a variable in your .bash_profile. So type in \nexport newt=\"go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt/newt/go\"\n in your .bash_profile and execute it by calling \n$newt\n at the prompt instead of \nnewt\n. Here, you use \ngo run\n which runs the compiled binary directly without producing an executable. Don't forget to reload the updated bash profile by typing \nsource ~/.bash_profile\n at the prompt! \n\n\n $ newt version\n Newt version: 1.0\n $ newt -h\n Newt allows you to create your own embedded project based on the Mynewt\n operating system. Newt provides both build and package management in a\n single tool, which allows you to compose an embedded workspace, and set\n of projects, and then build the necessary artifacts from those projects.\n For more information on the Mynewt operating system, please v
isit\n https://www.github.com/mynewt/documentation.\n\n Please use the newt help command, and specify the name of the command\n you want help for, for help on how to use a specific command\n\n Usage:\n newt [flags]\n newt [command]\n\n Examples:\n newt\n newt help [\ncommand-name\n]\n For help on \ncommand-name\n. If not specified, print this message.\n\n\n Available Commands:\n version Display the Newt version number.\n target Set and view target information\n egg Commands to list and inspect eggs on a nest\n nest Commands to manage nests \n clutches (remote egg repositories)\n help Help about any command\n\n Flags:\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 sile
nt; don't output anything.\n -v, --verbose=false: Enable verbose output when executing commands.\n\n\n Use \nnewt help [command]\n for more information about a command.\n\n\n\n\n\n\nWithout creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded a nest to try out the tool. \n\n\n\n\nGetting the debugger ready\n\n\n\n\nBefore you start building nests and hatching eggs, you need to do one final step in the environment preparation - install gcc / libc that can produce 32-bit executables. So, first install gcc. You will see the brew steps and a final summary confirming install.\n\n\n\n\n $ brew install gcc\n ...\n ...\n ==\n Summary\n \ud83c\udf7a /usr/local/Cellar/gcc/5.2.0: 1353 files, 248M\n\n\n\n\n\n\nARM maintains a pre-built GNU toolchain with a GCC source branch targeted at Embedded ARM Processors namely Cortex-R/Cortex-M processor families. Install the PX4 Toolch
ain and check the version installed. Make sure that the symbolic link installed by Homebrew points to the correct version of the debugger. If not, you can either change the symbolic link using the \"ln -f -s\" command or just go ahead and try with the version it points to!\n\n\n\n\n $ brew tap PX4/homebrew-px4\n $ brew update\n $ brew install gcc-arm-none-eabi-49\n $ arm-none-eabi-gcc --version \n arm-none-eabi-gcc (GNU Tools for ARM Embedded Processors) 4.9.3 20150529 (release) [ARM/embedded-4_9-branch revision 224288]\n Copyright (C) 2014 Free Software Foundation, Inc.\n This is free software; see the source for copying conditions. There is NO\n warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n $ ls -al /usr/local/bin/arm-none-eabi-gdb\n lrwxr-xr-x 1 aditihilbert admin 69 Sep 22 17:16 /usr/local/bin/arm-none-eabi-gdb -\n /usr/local/Cellar/gcc-arm-none-eabi-49/20150609/bin/arm-non
e-eabi-gdb\n\n\n\n\nNote: If no version is specified, brew will install the latest version available. MynewtOS will eventually work with multiple versions available including the latest releases. However, at present we have tested only with this version and recommend it for getting started. \n\n\n\n\nYou have to install OpenOCD (Open On-Chip Debugger) which is an open-source software that will allow you to interface with the JTAG debug connector/adaptor for the Olimex board. It lets you program, debug, and test embedded target devices which, in this case, is the Olimex board. Use brew to install it. Brew adds a simlink /usr/local/bin/openocd to the openocd directory in the Cellar. For more on OpenOCD go to \nhttp://openocd.org\n.\n\n\n\n\n $ brew install open-ocd\n $ which openocd\n /usr/local/bin/openocd\n $ ls -l $(which openocd)\n lrwxr-xr-x 1 \nuser\n admin 36 Sep 17 16:22 /usr/local/bin/openocd -\n ../Cellar/open-ocd/0.9.0/bin/openocd\n\n\n
\n\n\n\nProceed to the \nBuilding test code on simulator\n section.\n\n\n\n\nGetting your Ubuntu machine Ready\n\n\nInstalling some prerequisites\n\n\n\n\nInstall git, libcurl, and the Go language if you do not have them already.\n\n\n\n\n $ sudo apt-get install git \n $ sudo apt-get install libcurl4-gnutls-dev \n $ sudo apt-get install golang \n\n\n\n\nCreating local repository\n\n\n\n\n\n\nThe directory structure must be first readied for using Go. Go code must be kept inside a workspace. A workspace is a directory hierarchy with three directories at its root:\n\n\n\n\n\n\nsrc contains Go source files organized into packages (one package per directory),\n\n\n\n\n\n\npkg contains package objects, and\n\n\n\n\n\n\nbin contains executable commands.\n\n\n\n\n\n\n\n\n\n\nThe GOPATH environment variable specifies the location of your workspace. First create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory wh
ere you will soon clone the newt tool repository.\n\n\n $ cd $HOME\n $ mkdir -p dev/go \n $ cd dev/go\n $ export GOPATH=$PWD\n\n\n\n\nNote that you need to add export statements to ~/.bashrc (or equivalent) to export variables permanently.\n\n\n\n\nYou are ready to download the newt tool repository. You will use Go to copy the directory (currently the asf incubator directory). Be patient as it may take a minute or two. Check the directories installed.\n\n\n\n\n $ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt\n $ ls\n bin pkg src\n $ ls src\n git-wip-us.apache.org github.com gopkg.in\n\n\n\n\n\n\nCheck that newt is in place.\n\n\n\n\n $ ls $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt \n Godeps README.md coding_style.txt newt.go\n LICENSE cli design.txt\n\n\n\n\nBuilding the newt tool\n\n\n\n\nYou
will use Go to run the newt.go program to build the newt tool. The command used is \ngo install\n which compiles and writes the resulting executable to an output file named \nnewt\n. It installs the results along with its dependencies in $GOPATH/bin.\n\n\n\n\n $ cd $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt\n $ go install\n $ ls \n$GOPATH\n/bin/\n godep incubator-mynewt-newt.git newt\n\n\n\n\n\n\nTry running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.\n\n\n\n\nNote: If you are going to be be modifying the newt tool itself often and wish to compile the program every time you call it, you may want to store the command in a variable in your .bash_profile. So type in \nexport newt=\"go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt/newt/go\"\n in your
~/.bashrc (or equivalent) and execute it by calling \n$newt\n at the prompt instead of \nnewt\n. Here, you use \ngo run\n which runs the compiled binary directly without producing an executable. \n\n\n $ newt version\n Newt version: 1.0\n $ newt -h\n Newt allows you to create your own embedded project based on the Mynewt\n operating system. Newt provides both build and package management in a\n single tool, which allows you to compose an embedded workspace, and set\n of projects, and then build the necessary artifacts from those projects.\n For more information on the Mynewt operating system, please visit\n https://www.github.com/mynewt/documentation.\n\n Please use the newt help command, and specify the name of the command\n you want help for, for help on how to use a specific command\n\n Usage:\n newt [flags]\n newt [command]\n\n Examples:\n newt\n newt hel
p [\ncommand-name\n]\n For help on \ncommand-name\n. If not specified, print this message.\n\n\n Available Commands:\n version Display the Newt version number.\n target Set and view target information\n egg Commands to list and inspect eggs on a nest\n nest Commands to manage nests \n clutches (remote egg repositories)\n help Help about any command\n\n Flags:\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 Use \nnewt help [command]\n for more information about a command.\n\n\n\n\n\n\nWithout creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded a
nest to try out the tool. \n\n\n\n\nGetting the debugger ready\n\n\n\n\nBefore you start building nests and hatching eggs, you need to do one final step in the environment preparation - install gcc / libc that can produce 32-bit executables. You can install these as follows: \n\n\n\n\n $ sudo apt-get install gcc-multilib libc6-i386\n\n\n\n\n\n\nFor the LED project on the Olimex hardware, you have to install gcc for AM 4.9.3. This package can be installed with apt-get as documented below. The steps are explained in depth at \nhttps://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded\n.\n\n\n\n\n $ sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi \n $ sudo add-apt-repository ppa:terry.guo/gcc-arm-embedded \n $ sudo apt-get update \n $ sudo apt-get install gcc-arm-none-eabi\n\n\n\n\n\n\n\n\nAnd finally, you have to install OpenOCD (Open On-Chip Debugger) which is an open-source software that will allow you to interface with the JT
AG debug connector/adaptor for the Olimex board. It lets you program, debug, and test embedded target devices which, in this case, is the Olimex board. You have to acquire OpenOCD 0.8.0. \n\n\nIf you are running Ubuntu 15.x, then you are in luck and you can simply run: \n\n\n\n\n\n\n $ sudo apt-get install openocd \n\n\n\n\nOther versions of Ubuntu may not have the correct version of openocd available. In this case, you should download the openocd 0.8.0 package from \nhttps://launchpad.net/ubuntu/vivid/+source/openocd\n. The direct link to the amd64 build is \nhttp://launchpadlibrarian.net/188260097/openocd_0.8.0-4_amd64.deb\n. \n\n\n\n\nProceed to the \nBuilding test code on simulator\n section.\n\n\n\n\nGetting your Windows machine ready for simulated target\n\n\nThe \nnewt\n tool is the build software used to build Mynewt OS images or executables for any embedded hardware device/board, including the one for the current tutorial (STM32-E407 development board from Olimex).
You can run the \nnewt\n tool natively on a computer running any of the three Operating System machines - OSX, Linux, or Windows.\n\n\nHowever, Mynewt OS images for a simulated target are built on the Windows machine by using Linux versions of the build software (newt)in a virtual machine on your Windows box. The Linux VM is set up by installing the Docker Toolbox. Your Windows machine will communicate with the Linux VM via transient ssh connections. You will then download a Docker image (\nnewtvm.exe\n)that allows you to run the newt commands in the Linux Docker instance. The Docker image contains:\n\n\n\n\nThe newt command-line tool\n\n\nGo\n\n\nA multilib-capable native gcc / glibc\n\n\nAn arm-none-eabi gcc\n\n\nNative gdb\n\n\n\n\nThe sequence of events when using the Docker image is as follows:\n\n\n\n\nA new docker environment is created in the Linux VM.\n\n\nThe specified command with the newtvm prefix (\nnewtvm newt\n command) is sent to the docker environment via ssh.\n\n\n
The Linux command runs.\n\n\nThe output from the command is sent back to Windows via ssh.\n\n\nThe output is displayed in the Windows command prompt.\n\n\n\n\nInstall Linux virtual machine\n\n\n\n\n\n\nDownload the Docker Toolbox for Windows (version 1.9.0c or later) from \nhttps://www.docker.com/docker-toolbox\n. The Docker toolbox creates a consistently reproducible and self-contained environment in Linux.\n\n\n\n\n\n\nRun the Docker Toolbox installer. All the default settings are OK.\n\n\n\n\n\n\nYou may need to add \"C:\\Program Files\\Git\\usr\\bin\" to your PATH\nenvironment variable. To add to the PATH environment variable, right-click on the Start button in the bottom left corner. Choose System -\n Advanced system settings -\n Environment Variables. Click on the PATH variable under \"System variables\" and click Edit to check and add it if it is not already there. \n\n\n\n\n\n\nInstall newtvm tool\n\n\n\n\nFrom your base user (home) directory, pull or clone the latest code
from the newt repository into the \nnewt\n directory. It includes the executable \nnewtvm.exe\n for the newtvm tool in the \nnewtvm\n directory.\n\n\n\n\n C:\\Users\\admin\n git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt newt\n\n\n\n\nThe newtvm tool is what allows you to run programs in the Linux docker\ninstance. \n\n\n\n\nRun the Docker Quickstart Terminal application inside the Docker folder under Programs. You can find it by clicking Start button -\n All apps. By default, the Docker Toolbox installer creates a shortcut to this program on your desktop. Wait until you see an ASCII art whale displayed in the terminal window and the Docker prompt given. \n\n\n\n\n ## .\n ## ## ## ==\n ## ## ## ## ## ===\n /\n\\___/ ===\n ~~~ {~~ ~~~~ ~~~ ~~~~ ~~~ ~ / ===- ~~~\n \\______ o __/\n \\ \\ __/\n \\____\
\_______/\n\n docker is configured to use the default machine with IP 192.168.99.100\n For help getting started, check out the docs at https://docs.docker.com\n\n admin@dev1 MINGW64 ~ (master)\n $\n\n\n\n\nThe first time you run this, it may take several minutes to complete. You will need to run the Docker Quickstart Terminal once each time you\nrestart your computer.\n\n\n\n\nOpen a command prompt (e.g., Windows-R, \"cmd\", enter). You execute the newt tool commands as though you were running newt in Linux, but you prefix each command with \"newtvm\". For example:\n\n\n\n\n C:\\Users\\admin\\newt\\newtvm\n newtvm newt help\n\n\n\n\nThe newtvm tool will take a long time to run the first time you execute\nit. The delay is due to the fact that the tool must download the mynewt\ndocker instance.\n\n\n\n\nYou are now ready to proceed to \nbuilding the image for the simulated target\n.\n\n\n\n\nGetting your Windows machine ready for hardware targe
t\n\n\nWhen you want to produce images for actual hardware board on your Windows machine, go through the following setup procedure and then proceed to the \nblinky project on the Olimex board\n with this method.\n\n\nInstalling some prerequisites\n\n\n\n\n\n\nYou have to install the following if you do not have them already. The steps below indicate specific folders where each of these programs should be installed. You can choose different locations, but the remainder of this\ntutorial for a Windows machine assumes the specified folders. \n\n\n\n\nwin-builds-i686\n\n\nwin-builds-x86_64\n\n\nMSYS\n\n\ngcc for ARM\n\n\nopenocd\n\n\nzadig\n\n\ngit\n\n\n\n\ngo\n\n\n\n\nwin-builds (mingw64) 1.5 for i686\n\n\n\n\nDownload from \nhttp://win-builds.org/doku.php/download_and_installation_from_windows\n. Install at: \"C:\\win-builds-i686\".\n\n\nBe sure to click the i686 option (not x86_64). The defaults for all other options are OK. The installer will want to download a bunch of addition
al packages. They are not all necessary, but it is simplest to just accept the defaults.\n\n\n\n\nwin-builds (mingw64) 1.5 for x86_64\n\n\n\n\nDownload from \nhttp://win-builds.org/doku.php/download_and_installation_from_windows\n. Install at \"C:\\win-builds-x86_64\"\n\n\nRun the installer a second time, but this time click the x86_64 option, NOT i686. The defaults for all other options are OK.\n\n\n\n\nMSYS\n\n\n\n\nStart your download from \nhttp://sourceforge.net/projects/mingw-w64/files/External%20binary%20packages%20%28Win64%20hosted%29/MSYS%20%2832-bit%29/MSYS-20111123.zip\n\n\nUnzip to \"C:\\msys\"\n\n\n\n\ngcc for ARM, 4.9.3\n\n\n\n\nDownload the Windows installer from \nhttps://launchpad.net/gcc-arm-embedded/+download\n and install at \"C:\\Program Files (x86)\\GNU Tools ARM Embedded\\4.9 2015q3\".\n\n\n\n\nOpenOCD 0.8.0 \n\n\n\n\nDownload OpenOCD 0.8.0 from \nhttp://www.freddiechopin.info/en/download/category/4-openocd\n. Unzip to \"C:\\openocd\".\n\n\n\n\nZadig 2.1.2\n\
n\n\n\nDownload it from \nhttp://zadig.akeo.ie\n and install it at \"C:\\zadig\".\n\n\n\n\nGit\n\n\n\n\nClick on \nhttps://git-scm.com/download/win\n to start the download. Install at \"C:\\Program Files (x86)\\Git\". Specify the \"Use Git from the Windows Command Prompt\" option. The defaults for all other options are OK.\n\n\n\n\nGo\n\n\n\n\nDownload the release for Microsoft Windows from \nhttps://golang.org/dl/\n and install it \"C:\\Go\".\n\n\n\n\n\n\n\n\n\n\nCreating local repository\n\n\n\n\n\n\nThe directory structure must be first readied for using Go. Go code must be kept inside a workspace. A workspace is a directory hierarchy with three directories at its root:\n\n\n\n\n\n\nsrc contains Go source files organized into packages (one package per directory),\n\n\n\n\n\n\npkg contains package objects, and\n\n\n\n\n\n\nbin contains executable commands.\n\n\n\n\n\n\nThe GOPATH environment variable specifies the location of your workspace. First create a 'dev' directory and the
n a 'go' directory under it. Set the GOPATH environment variable to this directory and then proceed to create the directory for cloning the newt tool repository.\n\n\n\n\n\n\n $ cd c:\\\n $ mkdir dev\\go\n $ cd dev\\go\n\n\n\n\n\n\nSet the following user environment variables using the steps outlined here.\n\n\n\n\n * GOPATH: C:\\dev\\go\n * PATH: C:\\Program Files (x86)\\GNU Tools ARM Embedded\\4.9 2015q3\\bin;%GOPATH%\\bin;C:\\win-builds-x86_64\\bin;C:\\win-builds-i686\\bin;C:\\msys\\bin\n\n\n\n\nSteps:\n\n\n\n\nRight-click the start button\n\n\nClick \"Control panel\"\n\n\nClick \"System and Security\"\n\n\nClick \"System\"\n\n\nClick \"Advanced system settings\" in the left panel\n\n\nClick the \"Envoronment Variables...\" button\n\n\nThere will be two sets of environment variables: user variables\n in the upper half of the screen, and system variables in the lower\n half. Configuring the user variables is recommended and tested \n (tho
ugh system variables will work as well).\n\n\n\n\n\n\nNext, install godep. Note that the following command produces no output.\n\n\n\n\n $ go get github.com/tools/godep \n\n\n\n\n\n\nSet up the repository for the package building tool \"newt\" on your local machine. First create the appropriate directory for it and then clone the newt tool repository from the online apache repository (or its github.com mirror) into this newly created directory. Check the contents of the directory.\n\n\n\n\n $ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt\n $ dir \n bin pkg src\n $ dir src\n git-wip-us.apache.org github.com gopkg.in\n $ dir\n newt\n $ cd newt\n $ dir\n Godeps README.md coding_style.txt newt.go\n LICENSE cli design.txt\n\n\n\n\n\n\nCheck that newt is in place.\n\n\n\n\n $ dir $GOPATH\\
src\\git-wip-us.apache.org\\repos\\asf\\incubator-mynewt-newt.git\\newt \n Godeps README.md coding_style.txt newt.go\n LICENSE cli design.txt\n\n\n\n\nBuilding the newt tool\n\n\n\n\nYou will use Go to run the newt.go program to build the newt tool. The command used is \ngo install\n which compiles and writes the resulting executable to an output file named \nnewt\n. It installs the results along with its dependencies in $GOPATH/bin.\n\n\n\n\n $ go install\n $ ls \n$GOPATH\n/bin/\n godep incubator-mynewt-newt.git newt\n\n\n\n\n\n\nTry running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.\n\n\n\n\nNote: If you are going to be be modifying the newt tool itself often and wish to compile the program every time you call it, you may want to define the newt environment variabl
e that allows you to execute the command via \n%newt%\n. Use \nset newt=go run %GOPATH%\\src\\github.com\\mynewt\\newt\\newt.go\n or set it from the GUI. Here, you use \ngo run\n which runs the compiled binary directly without producing an executable.\n\n\n $ newt version\n Newt version: 1.0\n $ newt -h\n Newt allows you to create your own embedded project based on the Mynewt\n operating system. Newt provides both build and package management in a\n single tool, which allows you to compose an embedded workspace, and set\n of projects, and then build the necessary artifacts from those projects.\n For more information on the Mynewt operating system, please visit\n https://www.github.com/mynewt/documentation.\n\n Please use the newt help command, and specify the name of the command\n you want help for, for help on how to use a specific command\n\n Usage:\n newt [flags]\n newt [command]\
n\n Examples:\n newt\n newt help [\ncommand-name\n]\n For help on \ncommand-name\n. If not specified, print this message.\n\n\n Available Commands:\n version Display the Newt version number.\n target Set and view target information\n egg Commands to list and inspect eggs on a nest\n nest Commands to manage nests \n clutches (remote egg repositories)\n help Help about any command\n\n Flags:\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 Use \nnewt help [command]\n for more information about a command.\n\n\n\n\n\n\nWithout creating a project repository you can't do a whole lot with the Newt to
ol. So you'll have to wait till you have downloaded a nest to try out the tool. \n\n\n\n\nGetting the debugger ready\n\n\n\n\nUse Zadig to configure the USB driver for your Olimex debugger. If your debugger is already set up, you can skip this step.\n\n\n\n\n\n\nPlug in your Olimex debugger.\n\n\nStart Zadig.\n\n\nCheck the Options -\n List All Devices checkbox. \n\n\nSelect \"Olimex OpenOCD JTAG ARM-USB-TINY-H\" in the dropdown menu.\n\n\nSelect the \"WinUSB\" driver.\n\n\nClick the \"Install Driver\" button.\n\n\n\n\n\n\nProceed to the section on how to \nmake an LED blink\n section.\n\n\n\n\nBuilding test code on simulator\n\n\nNote: On a Windows computer, the simulator can be run only in a Linux virtual environment. Make sure you have installed the Docker instance as outlined in \nan earlier section\n. Consequently, all \nnewt\n commands must be prefaced with \nnewtvm\n.\n\n\n\n\n\n\nFirst, you have to create a repository for the project i.e. build your first nest! Go to ~/d
ev (or your base user directory on a Windows machine)and clone the larva repository from the apache git repository into a local directory named \nlarva\n.\n\n\nSubstitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows. The newt tool commands do not change.\n\n\n\n\n\n\n $ cd ~/dev \n $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva\n $ ls\n go larva\n $ cd larva\n $ ls\n LICENSE clutch.yml hw nest.yml project\n README.md compiler libs net scripts\n\n\n\n\nOn Windows, open a command prompt (e.g., Windows-R, \"cmd\", enter) and work from your home directory:\n\n\n C:\\Users\\admin\n git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva\n C:\\Users\\admin\n cd larva\n C:\\Users\\admin\\larva\n dir\n Volume in drive C is Windows\n Volume Serial N
umber is 4CBB-0920\n\n Directory of C:\\Users\\admin\\larva\n\n \nDIR\n .\n \nDIR\n ..\n 76 .gitignore\n 0 .gitmodules\n .nest\n 6,133 clutch.yml\n \nDIR\n compiler\n \nDIR\n hw\n \nDIR\n libs\n 11,560 LICENSE\n 20 nest.yml\n \nDIR\n net\n \nDIR\n project\n 2,263 README.md\n \nDIR\n scripts\n 6 File(s) 20,052 bytes\n 9 Dir(s) 90,723,442,688 bytes free\n\n\n\n\n2. You will now create a new target using the newt tool. You can either use the compiled binary \nnewt\n or run the newt.go program using \n$newt\n (assuming you have stored the command in a variable in your .bash_profile or .bashrc). When you do a \nnewt target show\n or \n$newt target show\n it should list all the projects you have created so f
ar. \n\n\n $ newt target create sim_test\n Creating target sim_test\n Target sim_test sucessfully created!\n $ newt target show\n sim_test\n name: sim_test\n arch: sim\n\n\n\n\nRemember, on a Windows machine you will have to preface \nnewt\n with \nnewtvm\n!\n\n\n C:\\Users\\admin\\larva\nnewtvm newt target create sim_test\n\n\n\n\n3. Now continue to populate and build out the sim project.\n\n\n $ newt target set sim_test project=test\n Target sim_test successfully set project to test\n $ newt target set sim_test compiler_def=debug\n Target sim_test successfully set compiler_def to debug\n $ newt target set sim_test bsp=hw/bsp/native\n Target sim_test successfully set bsp to hw/bsp/native\n $ newt target set sim_test compiler=sim\n Target sim_test successfully set compiler to sim\n $ newt target show sim_test\n sim_test\n arch: sim\n
project: test\n compiler_def: debug\n bsp: hw/bsp/native\n compiler: sim\n name: sim_test\n\n\n\n\nAgain remember to preface \nnewt\n with \nnewtvm\non a Windows machine as shown below. Continue to fill out all the project attributes.\n\n\n C:\\Users\\admin\\larva\nnewtvm newt target set sim_test project=test\n Target sim_test successfully set project to test\n\n\n\n\n4. Configure newt to use the gnu build tools native to OS X or linux. In order for sim to work properly, it needs to be using 32-bit gcc (gcc-
<TRUNCATED>
[5/7] incubator-mynewt-site git commit: Fix second level navigation
and function formats in docs
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/get_started/try_markdown/index.html
----------------------------------------------------------------------
diff --git a/get_started/try_markdown/index.html b/get_started/try_markdown/index.html
index 2dd2fa2..03cc401 100644
--- a/get_started/try_markdown/index.html
+++ b/get_started/try_markdown/index.html
@@ -121,16 +121,22 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../newt_concepts/">Newt Concepts</a></li>
+ <li class="toctree-l2"><a href="../newt_concepts/">Newt Concepts</a></li>
- <li class="toctree-l3"><a href="../project1/">Blinky, The First Project</a></li>
+ <li class="toctree-l2"><a href="../project1/">Blinky, The First Project</a></li>
- <li class="toctree-l3"><a href="../how_to_edit_docs/">How to edit docs</a></li>
+ <li class="toctree-l2"><a href="../how_to_edit_docs/">How to edit docs</a></li>
- <li class="toctree-l3"><a href="./">Sample doc to edit</a></li>
+ <li class="toctree-l2"><a href="./">Sample doc to edit</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#heading3">Heading3</a></li>
+
+
</ul>
[2/7] incubator-mynewt-site git commit: Fix second level navigation
and function formats in docs
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/heap/index.html
----------------------------------------------------------------------
diff --git a/os/heap/index.html b/os/heap/index.html
index d53aca0..dae3624 100644
--- a/os/heap/index.html
+++ b/os/heap/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="./">Heap</a></li>
+ <li class="toctree-l2"><a href="./">Heap</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_malloc_lock"> os_malloc_lock</a></li>
+
+ <li class="toctree-l3"><a href="#os_malloc_unlock"> os_malloc_unlock</a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,17 +240,17 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_malloc_lock">os_malloc_lock</a></li>
-<li><a href="#function-os_malloc_unlock">os_malloc_unlock</a></li>
+<li><a href="#os_malloc_lock">os_malloc_lock</a></li>
+<li><a href="#os_malloc_unlock">os_malloc_unlock</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_malloc_lock"><font color="2980b9">function os_malloc_lock</font><a class="headerlink" href="#function-os_malloc_lock" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="os_malloc_lock"><font color="F2853F" style="font-size:24pt"> os_malloc_lock</font><a class="headerlink" href="#os_malloc_lock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> static void
os_malloc_lock(void)
</code></pre>
@@ -265,15 +283,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_malloc_unlock"><font color="#2980b9"> function os_malloc_unlock</font><a class="headerlink" href="#function-os_malloc_unlock" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_malloc_unlock"><font color="F2853F" style="font-size:24pt"> os_malloc_unlock</font><a class="headerlink" href="#os_malloc_unlock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -305,15 +320,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -345,9 +357,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/mbufs/index.html
----------------------------------------------------------------------
diff --git a/os/mbufs/index.html b/os/mbufs/index.html
index 7027523..7bdcf1d 100644
--- a/os/mbufs/index.html
+++ b/os/mbufs/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="./">Mbufs</a></li>
+ <li class="toctree-l2"><a href="./">Mbufs</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_mbuf_pool_init"> os_mbuf_pool_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_mbuf_get"> os_mbuf_get</a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,17 +240,17 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_mbuf_pool_init">os_mbuf_pool_init</a></li>
-<li><a href="#function-os_mbuf_get">os_mbuf_get</a></li>
+<li><a href="#os_mbuf_pool_init">os_mbuf_pool_init</a></li>
+<li><a href="#os_mbuf_get">os_mbuf_get</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_mbuf_pool_init"><font color="2980b9">function os_mbuf_pool_init</font><a class="headerlink" href="#function-os_mbuf_pool_init" title="Permanent link">¶</a></h3>
-<pre><code> int
+<h2 id="os_mbuf_pool_init"><font color="F2853F" style="font-size:24pt"> os_mbuf_pool_init</font><a class="headerlink" href="#os_mbuf_pool_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> int
os_mbuf_pool_init(struct os_mbuf_pool *omp, struct os_mempool *mp,
uint16_t hdr_len, uint16_t buf_len, uint16_t nbufs)
</code></pre>
@@ -266,15 +284,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_mbuf_get"><font color="#2980b9"> function os_mbuf_get</font><a class="headerlink" href="#function-os_mbuf_get" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_mbuf_get"><font color="F2853F" style="font-size:24pt"> os_mbuf_get</font><a class="headerlink" href="#os_mbuf_get" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -306,15 +321,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -346,9 +358,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/memory_pool/index.html
----------------------------------------------------------------------
diff --git a/os/memory_pool/index.html b/os/memory_pool/index.html
index eef2448..b4a3ec6 100644
--- a/os/memory_pool/index.html
+++ b/os/memory_pool/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="./">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="./">Memory Pools</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_mempool_init"> os_mempool_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_memblock_get"> os_memblock_get</a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,20 +240,19 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_mempool_init">os_mempool_init</a></li>
-<li><a href="#function-os_memblock_get">os_memblock_get</a></li>
+<li><a href="#os_mempool_init">os_mempool_init</a></li>
+<li><a href="#os_memblock_get">os_memblock_get</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_mempool_init"><font color="2980b9">function os_mempool_init</font><a class="headerlink" href="#function-os_mempool_init" title="Permanent link">¶</a></h3>
-<pre><code> os_error_t
+<h2 id="os_mempool_init"><font color="F2853F" style="font-size:24pt"> os_mempool_init</font><a class="headerlink" href="#os_mempool_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> os_error_t
os_mempool_init(struct os_mempool *mp, int blocks,
int block_size, void *membuf, char *name)
-
</code></pre>
<p><Insert short description></p>
@@ -267,15 +284,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_memblock_get"><font color="#2980b9"> function os_memblock_get</font><a class="headerlink" href="#function-os_memblock_get" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_memblock_get"><font color="#F2853F" style="font-size:24pt"> os_memblock_get</font><a class="headerlink" href="#os_memblock_get" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -307,15 +321,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -347,9 +358,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/mutex/index.html
----------------------------------------------------------------------
diff --git a/os/mutex/index.html b/os/mutex/index.html
index 9f538b7..e27273a 100644
--- a/os/mutex/index.html
+++ b/os/mutex/index.html
@@ -136,43 +136,63 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="./">Mutexes</a></li>
+ <li class="toctree-l2"><a href="./">Mutexes</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_mutex_init">os_mutex_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_mutex_release">os_mutex_release</a></li>
+
+ <li class="toctree-l3"><a href="#os_mutex_pend">os_mutex_pend </a></li>
+
+ <li class="toctree-l3"><a href="#os_mutex_delete">os_mutex_delete </a></li>
+
+
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -223,7 +243,7 @@
<p>The following example will illustrate how priority inheritance works. In this example, the task number is the same as its priority. Remember that the lower the number, the higher the priority (i.e. priority 0 is higher priority than priority 1). Suppose that task 5 gets ownership of a mutex but is preempted by task 4. Task 4 attempts to gain ownership of the mutex but cannot as it is owned by task 5. Task 4 is put to sleep and task 5 is temporarily raised to priority 4. Before task 5 can release the mutex, task 3 runs and attempts to acquire the mutex. At this point, both task 3 and task 4 are waiting on the mutex (sleeping). Task 5 now runs at priority 3 (the highest priority of all the tasks waiting on the mutex). When task 5 finally releases the mutex it will be preempted as two higher priority tasks are waiting for it. </p>
<p>Note that when multiple tasks are waiting on a mutex owned by another task, once the mutex is released the highest priority task waiting on the mutex is run. </p>
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
-<pre><code>struct os_mutex
+<pre><code class="no-highlight">struct os_mutex
{
SLIST_HEAD(, os_task) mu_head;
uint8_t _pad;
@@ -231,7 +251,6 @@
uint16_t mu_level;
struct os_task *mu_owner;
};
-
</code></pre>
<table>
@@ -268,16 +287,15 @@
<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_mutex_init">os_mutex_init</a></li>
-<li><a href="#function-os_mutex_release">os_mutex_release</a></li>
-<li><a href="#function-os_mutex_pend">os_mutex_pend</a></li>
-<li><a href="#function-os_mutex_delete">os_mutex_delete</a></li>
+<li><a href="#os_mutex_init">os_mutex_init</a></li>
+<li><a href="#os_mutex_release">os_mutex_release</a></li>
+<li><a href="#os_mutex_pend">os_mutex_pend</a></li>
+<li><a href="#os_mutex_delete">os_mutex_delete</a></li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_mutex_init"><font color="2980b9">function os_mutex_init</font><a class="headerlink" href="#function-os_mutex_init" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_mutex_init(struct os_mutex *mu)
-
+<h2 id="os_mutex_init"><font color="#F2853F" style="font-size:24pt">os_mutex_init</font><a class="headerlink" href="#os_mutex_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_mutex_init(struct os_mutex *mu)
</code></pre>
<p>Initialize the mutex. Must be called before the mutex can be used.</p>
@@ -304,19 +322,16 @@
Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).></p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
-<pre><code>struct os_mutex g_mutex1;
+<pre><code class="no-highlight">struct os_mutex g_mutex1;
os_error_t err;
err = os_mutex_init(&g_mutex1);
assert(err == OS_OK);
-
</code></pre>
<hr />
-<h3 id="function-os_mutex_release"><font color="#2980b9"> function os_mutex_release</font><a class="headerlink" href="#function-os_mutex_release" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_mutex_release(struct os_mutex *mu)
-
-
+<h2 id="os_mutex_release"><font color="#F2853F" style="font-size:24pt">os_mutex_release</font><a class="headerlink" href="#os_mutex_release" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_mutex_release(struct os_mutex *mu)
</code></pre>
<p>Release ownership of a mutex</p>
@@ -341,7 +356,7 @@ assert(err == OS_OK);
<p>OS_BAD_MUTEX: The mutex was not owned by the task attempting to release it.</p>
<p>OS_NOT_STARTED: Attempt to release a mutex before the os has been started.</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
-<pre><code>struct os_mutex g_mutex1;
+<pre><code class="no-highlight">struct os_mutex g_mutex1;
os_error_t err;
err = os_mutex_pend(&g_mutex1, 0);
@@ -351,13 +366,11 @@ assert(err == OS_OK);
err = os_mutex_release(&g_mutex1);
assert(err == OS_OK);
-
</code></pre>
<hr />
-<h3 id="function-os_mutex_pend"><font color="#2980b9"> function os_mutex_pend </font><a class="headerlink" href="#function-os_mutex_pend" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_mutex_pend(struct os_mutex *mu, uint32_t timeout)
-
+<h2 id="os_mutex_pend"><font color="#F2853F" style="font-size:24pt">os_mutex_pend </font><a class="headerlink" href="#os_mutex_pend" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_mutex_pend(struct os_mutex *mu, uint32_t timeout)
</code></pre>
<p>Acquire ownership of a mutex.</p>
@@ -388,7 +401,7 @@ assert(err == OS_OK);
<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
<p>If the mutex is owned by another task and the timeout is 0 the function returns immediately with the error code OS_TIMEOUT. The calling task <em>does not</em> own the mutex when this occurs.</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
-<pre><code>struct os_mutex g_mutex1;
+<pre><code class="no-highlight">struct os_mutex g_mutex1;
os_error_t err;
err = os_mutex_pend(&g_mutex1, 0);
@@ -398,14 +411,11 @@ assert(err == OS_OK);
err = os_mutex_release(&g_mutex1);
assert(err == OS_OK);
-
-
</code></pre>
<hr />
-<h3 id="function-os_mutex_delete"><font color="#2980b9"> function os_mutex_delete </font><a class="headerlink" href="#function-os_mutex_delete" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_mutex_pend(struct os_mutex *mu)
-
+<h2 id="os_mutex_delete"><font color="#F2853F" style="font-size:24pt">os_mutex_delete </font><a class="headerlink" href="#os_mutex_delete" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_mutex_pend(struct os_mutex *mu)
</code></pre>
<p>Delete a mutex</p>
@@ -429,13 +439,11 @@ assert(err == OS_OK);
<p>OS_OK: mutex initialized successfully.</p>
<p>OS_NOT_STARTED: Attempt to release a mutex before the os has been started.</p>
<h4 id="example_3">Example<a class="headerlink" href="#example_3" title="Permanent link">¶</a></h4>
-<pre><code>struct os_mutex g_mutex1;
+<pre><code class="no-highlight">struct os_mutex g_mutex1;
os_error_t err;
err = os_mutex_delete(&g_mutex1);
assert(err == OS_OK);
-
-
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/mynewt_os/index.html
----------------------------------------------------------------------
diff --git a/os/mynewt_os/index.html b/os/mynewt_os/index.html
index 840e9d7..b4c0554 100644
--- a/os/mynewt_os/index.html
+++ b/os/mynewt_os/index.html
@@ -136,43 +136,65 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="./">Overview</a></li>
+ <li class="toctree-l2"><a href="./">Overview</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#real-time-kernel">Real-Time Kernel </a></li>
+
+ <li class="toctree-l3"><a href="#real-time-os">Real-Time OS </a></li>
+
+ <li class="toctree-l3"><a href="#insert-topic-of-your-choice">Insert topic of your choice</a></li>
+
+ <li class="toctree-l3"><a href="#features">Features</a></li>
+
+ <li class="toctree-l3"><a href="#os-functions">OS Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_idle_task"> os_idle_task</a></li>
+
+ <li class="toctree-l3"><a href="#os_started"> os_started</a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -239,17 +261,17 @@
<li><a href="../port_os/">Porting OS to other platforms</a></li>
</ul>
<h2 id="os-functions">OS Functions<a class="headerlink" href="#os-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_idle_task">os_idle_task</a></li>
-<li><a href="#function-os_started">os_started</a></li>
+<li><a href="#os_idle_task">os_idle_task</a></li>
+<li><a href="#os_started">os_started</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_idle_task"><font color="2980b9">function os_idle_task</font><a class="headerlink" href="#function-os_idle_task" title="Permanent link">¶</a></h3>
-<pre><code> void
+<h2 id="os_idle_task"><font color="F2853F" style="font-size:24pt"> os_idle_task</font><a class="headerlink" href="#os_idle_task" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> void
os_idle_task(void *arg)
</code></pre>
@@ -282,15 +304,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_started"><font color="#2980b9"> function os_started</font><a class="headerlink" href="#function-os_started" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_started"><font color="#F2853F" style="font-size:24pt"> os_started</font><a class="headerlink" href="#os_started" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -322,15 +341,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -362,9 +378,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/port_os/index.html
----------------------------------------------------------------------
diff --git a/os/port_os/index.html b/os/port_os/index.html
index d4a9224..923ad98 100644
--- a/os/port_os/index.html
+++ b/os/port_os/index.html
@@ -136,43 +136,51 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="./">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="./">Porting to other Platforms</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#insert-sections-as-you-wish">Insert sections as you wish</a></li>
+
+
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/sanity/index.html
----------------------------------------------------------------------
diff --git a/os/sanity/index.html b/os/sanity/index.html
index 9dc73b9..53b7ed0 100644
--- a/os/sanity/index.html
+++ b/os/sanity/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="./">Sanity</a></li>
+ <li class="toctree-l2"><a href="./">Sanity</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_sanity_check_init"> os_sanity_check_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_sanity_check_list_lock"> os_sanity_check_list_lock </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,19 +240,18 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_sanity_check_init">os_sanity_check_init</a></li>
-<li><a href="#function-os_sanity_check_list_lock">os_sanity_check_list_lock</a></li>
+<li><a href="#os_sanity_check_init">os_sanity_check_init</a></li>
+<li><a href="#os_sanity_check_list_lock">os_sanity_check_list_lock</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_sanity_check_init"><font color="2980b9">function os_sanity_check_init</font><a class="headerlink" href="#function-os_sanity_check_init" title="Permanent link">¶</a></h3>
-<pre><code> int
+<h2 id="os_sanity_check_init"><font color="F2853F" style="font-size:24pt"> os_sanity_check_init</font><a class="headerlink" href="#os_sanity_check_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> int
os_sanity_check_init(struct os_sanity_check *sc)
-
</code></pre>
<p><Insert short description></p>
@@ -266,15 +283,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_sanity_check_list_lock"><font color="#2980b9"> function os_sanity_check_list_lock </font><a class="headerlink" href="#function-os_sanity_check_list_lock" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_sanity_check_list_lock"><font color="#F2853F" style="font-size:24pt"> os_sanity_check_list_lock </font><a class="headerlink" href="#os_sanity_check_list_lock" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -306,15 +320,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -346,9 +357,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/semaphore/index.html
----------------------------------------------------------------------
diff --git a/os/semaphore/index.html b/os/semaphore/index.html
index 5534553..02c0a9d 100644
--- a/os/semaphore/index.html
+++ b/os/semaphore/index.html
@@ -136,43 +136,63 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="../task/">Tasks</a></li>
+ <li class="toctree-l2"><a href="../task/">Tasks</a></li>
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="./">Semaphores</a></li>
+ <li class="toctree-l2"><a href="./">Semaphores</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#os_sem_init"> os_sem_init</a></li>
+
+ <li class="toctree-l3"><a href="#os_sem_release"> os_sem_release </a></li>
+
+ <li class="toctree-l3"><a href="#os_sem_pend"> os_sem_pend </a></li>
+
+ <li class="toctree-l3"><a href="#os_sem_delete"> os_sem_delete </a></li>
+
+
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -223,8 +243,7 @@
<p>Semaphores can also be used for task synchronization. A simple example of this would be the following. A task creates a semaphore and initializes it with no tokens. The task then waits on the semaphore, and since there are no tokens, the task is put to sleep. When other tasks want to wake up the sleeping task they simply add a token by calling <em>os_sem_release</em>. This will cause the sleeping task to wake up (instantly if no other higher priority tasks want to run).</p>
<p>The other common use of a counting semaphore is in what is commonly called a "producer/consumer" relationship. The producer adds tokens (by calling <em>os_sem_release</em>) and the consumer consumes them by calling <em>os_sem_pend</em>. In this relationship, the producer has work for the consumer to do. Each token added to the semaphore will cause the consumer to do whatever work is required. A simple example could be the following: every time a button is pressed there is some work to do (ring a bell). Each button press causes the producer to add a token. Each token consumed rings the bell. There will exactly the same number of bell rings as there are button presses. In other words, each call to <em>os_sem_pend</em> subtracts exactly one token and each call to <em>os_sem_release</em> adds exactly one token.</p>
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
-<pre><code>
-struct os_sem
+<pre><code class="no-highlight">struct os_sem
{
SLIST_HEAD(, os_task) sem_head; /* chain of waiting tasks */
uint16_t _pad;
@@ -258,16 +277,15 @@ struct os_sem
<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-os_sem_init">os_sem_init</a></li>
-<li><a href="#function-os_sem_release">os_sem_release</a></li>
-<li><a href="#function-os_sem_pend">os_sem_pend</a></li>
-<li><a href="#function-os_sem_delete">os_sem_delete</a></li>
+<li><a href="#os_sem_init">os_sem_init</a></li>
+<li><a href="#os_sem_release">os_sem_release</a></li>
+<li><a href="#os_sem_pend">os_sem_pend</a></li>
+<li><a href="#os_sem_delete">os_sem_delete</a></li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-os_sem_init"><font color="2980b9">function os_sem_init</font><a class="headerlink" href="#function-os_sem_init" title="Permanent link">¶</a></h3>
-<pre><code> os_error_t os_sem_init(struct os_sem *sem, uint16_t tokens)
-
+<h2 id="os_sem_init"><font color="F2853F" style="font-size:24pt"> os_sem_init</font><a class="headerlink" href="#os_sem_init" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_sem_init(struct os_sem *sem, uint16_t tokens)
</code></pre>
<p>Initialize a semaphore with a given number of tokens. Should be called before the semaphore is used.</p>
@@ -299,18 +317,16 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).></p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p>The following example shows how to initialize a semaphore used for exclusive access.</p>
-<pre><code>struct os_mutex g_os_sem;
+<pre><code class="no-highlight">struct os_mutex g_os_sem;
os_error_t err;
err = os_sem_init(&g_os_sem, 1);
assert(err == OS_OK);
-
</code></pre>
<hr />
-<h3 id="function-os_sem_release"><font color="#2980b9"> function os_sem_release </font><a class="headerlink" href="#function-os_sem_release" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_sem_release(struct os_sem *sem)
-
+<h2 id="os_sem_release"><font color="#F2853F" style="font-size:24pt"> os_sem_release </font><a class="headerlink" href="#os_sem_release" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_sem_release(struct os_sem *sem)
</code></pre>
<p>Release a semaphore that you are holding. This adds a token to the semaphore.</p>
@@ -335,7 +351,7 @@ assert(err == OS_OK);
<p>OS_OK: semaphore released successfully.</p>
<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
-<pre><code>struct os_sem g_os_sem;
+<pre><code class="no-highlight">struct os_sem g_os_sem;
os_error_t err;
err = os_sem_pend(&g_os_sem, OS_TIMEOUT_NEVER);
@@ -345,13 +361,11 @@ assert(err == OS_OK);
err = os_sem_release(&g_os_sem);
assert(err == OS_OK);
-
</code></pre>
<hr />
-<h3 id="function-os_sem_pend"><font color="#2980b9"> function os_sem_pend </font><a class="headerlink" href="#function-os_sem_pend" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_sem_pend(struct os_sem *sem, uint32_t timeout)
-
+<h2 id="os_sem_pend"><font color="#F2853F" style="font-size:24pt"> os_sem_pend </font><a class="headerlink" href="#os_sem_pend" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_sem_pend(struct os_sem *sem, uint32_t timeout)
</code></pre>
<p>Wait for a semaphore for a given amount of time.</p>
@@ -382,7 +396,7 @@ assert(err == OS_OK);
<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
<p>If a timeout of 0 is used and the function returns OS_TIMEOUT, the semaphore was not available and was not acquired. No release of the semaphore should occur and the calling task does not own the semaphore.</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
-<pre><code>struct os_sem g_os_sem;
+<pre><code class="no-highlight">struct os_sem g_os_sem;
os_error_t err;
err = os_sem_pend(&g_os_sem, OS_TIMEOUT_NEVER);
@@ -396,9 +410,8 @@ assert(err == OS_OK);
</code></pre>
<hr />
-<h3 id="function-os_sem_delete"><font color="#2980b9"> function os_sem_delete </font><a class="headerlink" href="#function-os_sem_delete" title="Permanent link">¶</a></h3>
-<pre><code>os_error_t os_sem_delete(struct os_sem *sem)
-
+<h2 id="os_sem_delete"><font color="#F2853F" style="font-size:24pt"> os_sem_delete </font><a class="headerlink" href="#os_sem_delete" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">os_error_t os_sem_delete(struct os_sem *sem)
</code></pre>
<p>Delete a semaphore</p>
@@ -424,13 +437,11 @@ assert(err == OS_OK);
<h4 id="notes_3">Notes<a class="headerlink" href="#notes_3" title="Permanent link">¶</a></h4>
<p>Care must be taken when deleting a semaphore as deleting a semaphore used by other tasks could causes unexpected/unwanted behavior.</p>
<h4 id="example_3">Example<a class="headerlink" href="#example_3" title="Permanent link">¶</a></h4>
-<pre><code>struct os_sem g_os_sem;
+<pre><code class="no-highlight">struct os_sem g_os_sem;
os_error_t err;
err = os_sem_delete(&g_os_sem);
assert(err == OS_OK);
-
-
</code></pre>
<hr />
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/os/task/index.html
----------------------------------------------------------------------
diff --git a/os/task/index.html b/os/task/index.html
index c6f1fb8..53608b1 100644
--- a/os/task/index.html
+++ b/os/task/index.html
@@ -136,43 +136,61 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../mynewt_os/">Overview</a></li>
+ <li class="toctree-l2"><a href="../mynewt_os/">Overview</a></li>
- <li class="toctree-l3"><a href="../context_switch/">Scheduler/Context Switching</a></li>
+ <li class="toctree-l2"><a href="../context_switch/">Scheduler/Context Switching</a></li>
- <li class="toctree-l3"><a href="../time/">Time</a></li>
+ <li class="toctree-l2"><a href="../time/">Time</a></li>
- <li class="toctree-l3"><a href="./">Tasks</a></li>
+ <li class="toctree-l2"><a href="./">Tasks</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#description">Description</a></li>
+
+ <li class="toctree-l3"><a href="#data-structures">Data structures</a></li>
+
+ <li class="toctree-l3"><a href="#list-of-functions">List of Functions</a></li>
+
+ <li class="toctree-l3"><a href="#function-reference">Function Reference</a></li>
+
+ <li class="toctree-l3"><a href="#_clear_stack"> _clear_stack </a></li>
+
+ <li class="toctree-l3"><a href="#os_task_next_id"> os_task_next_id </a></li>
+
+ <li class="toctree-l3"><a href="#next_one"> next_one </a></li>
+
+
- <li class="toctree-l3"><a href="../event_queue/">Event Queues</a></li>
+ <li class="toctree-l2"><a href="../event_queue/">Event Queues</a></li>
- <li class="toctree-l3"><a href="../semaphore/">Semaphores</a></li>
+ <li class="toctree-l2"><a href="../semaphore/">Semaphores</a></li>
- <li class="toctree-l3"><a href="../mutex/">Mutexes</a></li>
+ <li class="toctree-l2"><a href="../mutex/">Mutexes</a></li>
- <li class="toctree-l3"><a href="../memory_pool/">Memory Pools</a></li>
+ <li class="toctree-l2"><a href="../memory_pool/">Memory Pools</a></li>
- <li class="toctree-l3"><a href="../heap/">Heap</a></li>
+ <li class="toctree-l2"><a href="../heap/">Heap</a></li>
- <li class="toctree-l3"><a href="../mbufs/">Mbufs</a></li>
+ <li class="toctree-l2"><a href="../mbufs/">Mbufs</a></li>
- <li class="toctree-l3"><a href="../sanity/">Sanity</a></li>
+ <li class="toctree-l2"><a href="../sanity/">Sanity</a></li>
- <li class="toctree-l3"><a href="../callout/">Callout Functions</a></li>
+ <li class="toctree-l2"><a href="../callout/">Callout Functions</a></li>
- <li class="toctree-l3"><a href="../port_os/">Porting to other Platforms</a></li>
+ <li class="toctree-l2"><a href="../port_os/">Porting to other Platforms</a></li>
</ul>
@@ -222,19 +240,18 @@
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
<p>Replace this with the list of data structures used, why, any neat features</p>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
<ul>
-<li><a href="#function-_clear_stack">_clear_stack</a></li>
-<li><a href="#function-os_task_next_id">os_task_next_id</a></li>
+<li><a href="#_clear_stack">_clear_stack</a></li>
+<li><a href="#os_task_next_id">os_task_next_id</a></li>
<li>add the rest</li>
</ul>
<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
<hr />
-<h3 id="function-_clear_stack"><font color="2980b9">function _clear_stack </font><a class="headerlink" href="#function-_clear_stack" title="Permanent link">¶</a></h3>
-<pre><code> static void
+<h2 id="_clear_stack"><font color="F2853F" style="font-size:24pt"> _clear_stack </font><a class="headerlink" href="#_clear_stack" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight">static void
_clear_stack(os_stack_t *stack_bottom, int size)
-
</code></pre>
<p><Insert short description></p>
@@ -266,15 +283,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-os_task_next_id"><font color="#2980b9"> function os_task_next_id </font><a class="headerlink" href="#function-os_task_next_id" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="os_task_next_id"><font color="#F2853F" style="font-size:24pt"> os_task_next_id </font><a class="headerlink" href="#os_task_next_id" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -306,15 +320,12 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />
-<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
-<pre><code> <Insert function callout here >
-
+<h2 id="next_one"><font color="#F2853F" style="font-size:24pt"> next_one </font><a class="headerlink" href="#next_one" title="Permanent link">¶</a></h2>
+<pre><code class="no-highlight"> <Insert function callout here >
</code></pre>
<p><Insert short description></p>
@@ -346,9 +357,7 @@ Does it need to be used with some other specific functions?
Any caveats to be careful about (e.g. high memory requirements).</p>
<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
<p><Add text to set up the context for the example here></p>
-<pre><code>
-<Insert the code snippet here>
-
+<pre><code class="no-highlight"><Insert the code snippet here>
</code></pre>
<hr />