You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by we...@apache.org on 2015/10/30 08:41:50 UTC
[3/4] incubator-mynewt-site git commit: anchors fixed
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ff2aecef/site/chapter1/project1/index.html
----------------------------------------------------------------------
diff --git a/site/chapter1/project1/index.html b/site/chapter1/project1/index.html
index 8201c22..4b21f81 100644
--- a/site/chapter1/project1/index.html
+++ b/site/chapter1/project1/index.html
@@ -6,10 +6,10 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
-
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/chapter1/project1/">
<link rel="shortcut icon" href="../../img/favicon.ico">
- <title>Blinkie, The First Project - MyNewt</title>
+ <title>Blinkie, The First Project - Mynewt</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
@@ -43,7 +43,7 @@
<!-- Main title -->
- <a class="navbar-brand" href="../..">MyNewt</a>
+ <a class="navbar-brand" href="../..">Mynewt</a>
</div>
<!-- Expanded navigation -->
@@ -54,7 +54,7 @@
<li >
- <a href="../..">Home</a>
+ <a href="../..">Doc Home</a>
</li>
@@ -65,12 +65,6 @@
<li >
- <a href="../intro/">Introduction</a>
-</li>
-
-
-
-<li >
<a href="../newt_concepts/">Newt Concepts</a>
</li>
@@ -165,90 +159,41 @@
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
- <li class="main active"><a href="#objective">Objective</a></li>
-
-
- <li class="main "><a href="#what-you-need">What you need</a></li>
-
-
- <li class="main "><a href="#getting-your-mac-ready">Getting your Mac Ready</a></li>
+ <li class="main active"><a href="#blinkie-the-first-project">Blinkie, the First Project</a></li>
- <li><a href="#getting-an-account-on-github">Getting an account on GitHub</a></li>
+ <li><a href="#objective">Objective</a></li>
- <li><a href="#installing-homebrew-to-ease-installs-on-os-x">Installing Homebrew to ease installs on OS X</a></li>
+ <li><a href="#what-you-need">What you need</a></li>
- <li><a href="#creating-local-repository">Creating local repository</a></li>
+ <li><a href="#getting-your-mac-ready">Getting your Mac Ready</a></li>
- <li><a href="#installing-go-and-godep">Installing Go and Godep</a></li>
+ <li><a href="#getting-your-ubuntu-machine-ready">Getting your Ubuntu machine Ready</a></li>
- <li><a href="#building-the-newt-tool">Building the Newt tool</a></li>
+ <li><a href="#getting-your-windows-machine-ready">Getting your Windows machine Ready</a></li>
- <li><a href="#getting-the-debugger-ready">Getting the debugger ready</a></li>
+ <li><a href="#building-test-code-on-simulator">Building test code on simulator</a></li>
- <li><a href="#proceed-to-the-building-test-code-on-simulator-section">Proceed to the Building test code on simulator section.</a></li>
+ <li><a href="#building-test-code-on-simulator-on-windows-machine">Building test code on simulator on Windows machine</a></li>
-
- <li class="main "><a href="#getting-your-ubuntu-machine-ready">Getting your Ubuntu machine Ready</a></li>
-
- <li><a href="#getting-an-account-on-github_1">Getting an account on GitHub</a></li>
-
- <li><a href="#installing-some-prerequisites">Installing some prerequisites</a></li>
-
- <li><a href="#creating-local-repository_1">Creating local repository</a></li>
-
- <li><a href="#building-the-newt-tool_1">Building the newt tool</a></li>
+ <li><a href="#making-an-led-blink">Making an LED blink</a></li>
- <li><a href="#getting-the-debugger-ready_1">Getting the debugger ready</a></li>
-
- <li><a href="#proceed-to-the-building-test-code-on-simulator-section_1">Proceed to the Building test code on simulator section.</a></li>
-
-
- <li class="main "><a href="#getting-your-windows-machine-ready">Getting your Windows machine Ready</a></li>
-
- <li><a href="#getting-an-account-on-github_2">Getting an account on GitHub</a></li>
-
- <li><a href="#installing-some-prerequisites_1">Installing some prerequisites</a></li>
-
- <li><a href="#creating-local-repository_2">Creating local repository</a></li>
-
- <li><a href="#building-the-newt-tool_2">Building the newt tool</a></li>
-
- <li><a href="#getting-the-debugger-ready_2">Getting the debugger ready</a></li>
-
- <li><a href="#proceed-to-the-building-test-code-on-simulator-on-windows-machine-section">Proceed to the Building test code on simulator on Windows machine section.</a></li>
-
-
- <li class="main "><a href="#building-test-code-on-simulator-on-non-windows-machine">Building test code on simulator on non-Windows machine</a></li>
-
-
- <li class="main "><a href="#building-test-code-on-simulator-on-windows-machine">Building test code on simulator on Windows machine</a></li>
-
-
- <li class="main "><a href="#making-an-led-blink">Making an LED blink</a></li>
-
- <li><a href="#preparing-the-software">Preparing the Software</a></li>
-
- <li><a href="#preparing-the-hardware-to-boot-from-embedded-sram">Preparing the hardware to boot from embedded SRAM</a></li>
-
- <li><a href="#lets-go">Let's Go!</a></li>
-
-
- <li class="main "><a href="#using-flash-to-make-led-blink">Using flash to make LED blink</a></li>
+ <li><a href="#using-flash-to-make-led-blink">Using flash to make LED blink</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
-<h3 id="objective">Objective</h3>
+<h2 id="blinkie-the-first-project">Blinkie, the First Project<a class="headerlink" href="#blinkie-the-first-project" title="Permanent link">¶</a></h2>
+<h3 id="objective">Objective<a class="headerlink" href="#objective" title="Permanent link">¶</a></h3>
<p>We 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 <strong> Project Blinky</strong>. The goals of this tutorial are threefold:</p>
<ol>
<li>First, you will learn how to set up your environment to be ready to use the various eggs that you will download from Mynewt. </li>
-<li>Second, we will walk you through a download of eggs for building and testing <a href="#anchor4">on a simulated target</a>.</li>
-<li>Third, you will download eggs and use tools to create a runtime image for a board to <a href="#anchor5">make its LED blink</a>. </li>
+<li>Second, we will walk you through a download of eggs for building and testing <a href="#building-test-code-on-simulator">on a simulated target</a> on a non-Windows machine.</li>
+<li>Third, you will download eggs and use tools to create a runtime image for a board to <a href="#making-an-led-blink">make its LED blink</a>. </li>
</ol>
-<p>If you want to explore even further, you can try to upload the image to the board's flash memory and have it <a href="#anchor6">boot from flash</a>!</p>
-<h3 id="what-you-need">What you need</h3>
+<p>If you want to explore even further, you can try to upload the image to the board's flash memory and have it <a href="#using-flash-to-make-led-blink">boot from flash</a>!</p>
+<h3 id="what-you-need">What you need<a class="headerlink" href="#what-you-need" title="Permanent link">¶</a></h3>
<ol>
<li>STM32-E407 development board from Olimex.</li>
<li>ARM-USB-TINY-H connector with JTAG interface for debugging ARM microcontrollers (comes with the ribbon cable to hook up to the board)</li>
@@ -256,18 +201,18 @@
<li>Personal Computer</li>
</ol>
<p>The instructions assume the user is using a Bourne-compatible shell (e.g. bash or zsh) on your computer. You may already have some of the required packages on your machine. In that
-case, simply skip the corresponding installation step in the instructions under <a href="#anchor1">Getting your Mac Ready</a> or <a href="#anchor2">Getting your Ubuntu machine Ready</a> or <a href="#anchor3">Getting your Windows machine Ready</a>. While the given instructions should work on other versions, they have been tested for the three specific releases of operating systems noted here:</p>
+case, simply skip the corresponding installation step in the instructions under <a href="./#getting-your-mac-ready">Getting your Mac Ready</a> or <a href="./#getting-your-ubuntu-machine-ready">Getting your Ubuntu machine Ready</a> or <a href="#getting-your-windows-machine-ready">Getting your Windows machine Ready</a>. While the given instructions should work on other versions, they have been tested for the three specific releases of operating systems noted here:</p>
<ul>
<li>Mac: OS X Yosemite Version 10.10.5</li>
<li>Linux: Ubuntu 14.10 (Utopic Unicorn)</li>
<li>Windows: Windows 10</li>
</ul>
-<h3 id="getting-your-mac-ready"><a href="id:anchor1">Getting your Mac Ready</a></h3>
-<h4 id="getting-an-account-on-github">Getting an account on GitHub</h4>
+<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="getting-an-account-on-github">Getting an account on GitHub<a class="headerlink" href="#getting-an-account-on-github" title="Permanent link">¶</a></h4>
<ul>
<li>Get an account on GitHub. Make sure you have joined the "Newt Operating System" organization.</li>
</ul>
-<h4 id="installing-homebrew-to-ease-installs-on-os-x">Installing Homebrew to ease installs on OS X</h4>
+<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>
@@ -276,7 +221,7 @@ case, simply skip the corresponding installation step in the instructions under
<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="creating-local-repository">Creating local repository</h4>
+<h4 id="creating-local-repository">Creating local repository<a class="headerlink" href="#creating-local-repository" title="Permanent link">¶</a></h4>
<ul>
<li>
<p>The 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:</p>
@@ -314,7 +259,7 @@ LICENSE cli design.txt
</code></pre>
</li>
</ul>
-<h4 id="installing-go-and-godep">Installing Go and Godep</h4>
+<h4 id="installing-go-and-godep">Installing Go and Godep<a class="headerlink" href="#installing-go-and-godep" title="Permanent link">¶</a></h4>
<ul>
<li>
<p>Next you will use brew 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>
@@ -347,7 +292,7 @@ $ go install
</code></pre>
</li>
</ul>
-<h4 id="building-the-newt-tool">Building the Newt tool</h4>
+<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>You will now use go to run the newt.go program to build the newt tool. You will have to use <code>go build</code> command which compiles and writes the resulting executable to an output file named <code>newt</code>. However, it does not install the results along with its dependencies in $GOPATH/bin (for that you will need to use <code>go install</code>). Now 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>
@@ -400,7 +345,7 @@ $ go install
<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</h4>
+<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>
@@ -435,14 +380,16 @@ $ 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>
-<h4 id="proceed-to-the-building-test-code-on-simulator-section">Proceed to the <a href="#anchor4">Building test code on simulator</a> section.</h4>
-<h3 id="getting-your-ubuntu-machine-ready"><a href="id:anchor2">Getting your Ubuntu machine Ready</a></h3>
-<h4 id="getting-an-account-on-github_1">Getting an account on GitHub</h4>
+<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="getting-an-account-on-github_1">Getting an account on GitHub<a class="headerlink" href="#getting-an-account-on-github_1" title="Permanent link">¶</a></h4>
<ul>
<li>Get an account on GitHub. Make sure you have joined the "Newt Operating System" organization.</li>
</ul>
-<h4 id="installing-some-prerequisites">Installing some prerequisites</h4>
+<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
@@ -450,7 +397,7 @@ $ sudo apt-get install golang
</code></pre>
</li>
</ul>
-<h4 id="creating-local-repository_1">Creating local repository</h4>
+<h4 id="creating-local-repository_1">Creating local repository<a class="headerlink" href="#creating-local-repository_1" title="Permanent link">¶</a></h4>
<ul>
<li>
<p>The 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:</p>
@@ -500,7 +447,7 @@ $ export PATH=$PATH:$GOPATH/bin
</code></pre>
</li>
</ul>
-<h4 id="building-the-newt-tool_1">Building the newt tool</h4>
+<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>You will now use go to run the newt.go program to build the newt tool. You will have to use <code>go build</code> command which compiles and writes the resulting executable to an output file named <code>newt</code>. However, it does not install the results along with its dependencies in $GOPATH/bin (for that you will need to use <code>go install</code>). Now 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>
@@ -553,7 +500,7 @@ $ export PATH=$PATH:$GOPATH/bin
<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</h4>
+<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>
@@ -575,14 +522,16 @@ $ sudo apt-get install gcc-arm-none-eabi
</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>
-<h4 id="proceed-to-the-building-test-code-on-simulator-section_1">Proceed to the <a href="#anchor4">Building test code on simulator</a> section.</h4>
-<h3 id="getting-your-windows-machine-ready"><a href="id:anchor3">Getting your Windows machine Ready</a></h3>
-<h4 id="getting-an-account-on-github_2">Getting an account on GitHub</h4>
+<h3 id="getting-your-windows-machine-ready">Getting your Windows machine Ready<a class="headerlink" href="#getting-your-windows-machine-ready" title="Permanent link">¶</a></h3>
+<h4 id="getting-an-account-on-github_2">Getting an account on GitHub<a class="headerlink" href="#getting-an-account-on-github_2" title="Permanent link">¶</a></h4>
<ul>
<li>Get an account on GitHub. Make sure you have joined the "Newt Operating System" organization.</li>
</ul>
-<h4 id="installing-some-prerequisites_1">Installing some prerequisites</h4>
+<h4 id="installing-some-prerequisites_1">Installing some prerequisites<a class="headerlink" href="#installing-some-prerequisites_1" title="Permanent link">¶</a></h4>
<ul>
<li>
<p>You 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
@@ -636,7 +585,7 @@ tutorial for a Windows machine assumes the specified folders. </p>
</ul>
</li>
</ul>
-<h4 id="creating-local-repository_2">Creating local repository</h4>
+<h4 id="creating-local-repository_2">Creating local repository<a class="headerlink" href="#creating-local-repository_2" title="Permanent link">¶</a></h4>
<ul>
<li>
<p>The 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:</p>
@@ -703,7 +652,7 @@ $ go install
</code></pre>
</li>
</ul>
-<h4 id="building-the-newt-tool_2">Building the newt tool</h4>
+<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 now use go to run the newt.go program to build the newt tool. You will have to use <code>go build</code> command which compiles and writes the resulting executable to an output file named <code>newt</code>. However, it does not install the results along with its dependencies in $GOPATH/bin (for that you will need to use <code>go install</code>). Now 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>
@@ -756,7 +705,7 @@ Use "newt help [command]" for more information about a command.
<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>
-<h4 id="getting-the-debugger-ready_2">Getting the debugger ready</h4>
+<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>
@@ -770,9 +719,10 @@ Use "newt help [command]" for more information about a command.
</ol>
</li>
</ul>
-<h4 id="proceed-to-the-building-test-code-on-simulator-on-windows-machine-section">Proceed to the <a href="#anchor7">Building test code on simulator on Windows machine</a> section.</h4>
-<p>Note: Currently, the simulator cannot be run in the Windows machine. We are working on it. In the meantime proceed to the <a href="#anchor5">Making an LED blink</a> on the Olimex hardware directly.</p>
-<h3 id="building-test-code-on-simulator-on-non-windows-machine"><a href="id:anchor4">Building test code on simulator on non-Windows machine</a></h3>
+<h4 id="proceed-to-the-building-test-code-on-simulator-on-windows-machine-section">Proceed to the <a href="#building-test-code-on-simulator">Building test code on simulator on Windows machine</a> section.<a class="headerlink" href="#proceed-to-the-building-test-code-on-simulator-on-windows-machine-section" title="Permanent link">¶</a></h4>
+<p>Note: Currently, the simulator cannot be run in the Windows machine. We are working on it. In the meantime proceed to the <a href="#making-an-led-blink">Making an LED blink</a> on the Olimex hardware directly.</p>
+<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: Currently, the simulator cannot be run in the Windows machine. We are working on it. If you are on a Windows machine proceed to the <a href="#making-an-led-blink">Making an LED blink</a> on the Olimex hardware directly.</p>
<ol>
<li>
<p>First, you have to create a repository for the project i.e. build your first nest! Go to ~/dev and clone the larva repository from github. The URL used below is the HTTPS clone URL from the github.com repository for the Newt Operating System. </p>
@@ -873,10 +823,10 @@ Successfully run!
</code></pre>
</li>
</ol>
-<h3 id="building-test-code-on-simulator-on-windows-machine"><a href="id:anchor7">Building test code on simulator on Windows machine</a></h3>
+<h3 id="building-test-code-on-simulator-on-windows-machine">Building test code on simulator on Windows machine<a class="headerlink" href="#building-test-code-on-simulator-on-windows-machine" title="Permanent link">¶</a></h3>
<p>Coming soon.</p>
-<h3 id="making-an-led-blink"><a href="id:anchor5">Making an LED blink</a></h3>
-<h4 id="preparing-the-software">Preparing the Software</h4>
+<h3 id="making-an-led-blink">Making an LED blink<a class="headerlink" href="#making-an-led-blink" title="Permanent link">¶</a></h3>
+<h4 id="preparing-the-software">Preparing the Software<a class="headerlink" href="#preparing-the-software" title="Permanent link">¶</a></h4>
<ol>
<li>
<p>Make sure the PATH environment variable includes the $HOME/dev/go/bin directory (or C:\%GOPATH%\bin on Windows machine). </p>
@@ -964,7 +914,7 @@ symbol-file ~/dev/larva/project/main/bin/blink/main.elf
<p>Note that an OpenOCD configuration script is available from Olimex for the STM32-E407 development board e.g. at <a href="https://www.olimex.com/Products/ARM/ST/STM32-E407/resources/stm32f4x.cfg">https://www.olimex.com/Products/ARM/ST/STM32-E407/resources/stm32f4x.cfg</a>, however getting it to work with different versions of OpenOCD and gcc could get tricky. [<span style="color:red"><em>This will be simplified eventually into a consolidated single action step instead of manual tweaks currently required</em></span>]</p>
</li>
</ol>
-<h4 id="preparing-the-hardware-to-boot-from-embedded-sram">Preparing the hardware to boot from embedded SRAM</h4>
+<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>
<p>Locate the boot jumpers on the board.
@@ -984,7 +934,7 @@ symbol-file ~/dev/larva/project/main/bin/blink/main.elf
<p>The red PWR LED should be lit. </p>
</li>
</ol>
-<h4 id="lets-go">Let's Go!</h4>
+<h4 id="lets-go">Let's Go!<a class="headerlink" href="#lets-go" title="Permanent link">¶</a></h4>
<ol>
<li>
<p>Go into the openocd directory and start an OCD session. You should see some status messages are shown below. Check the value of the msp (main service pointer) register. If it is not 0x10010000 as indicated below, you will have to manually set it after you open the gdp tool to load the image on it (next step). Note the <code>-c "reset halt"</code> flag that tells it to halt after opening the session. It will now require a manual "continue" command from the GNU debugger in step 3. </p>
@@ -1104,7 +1054,7 @@ Reading symbols from C:/dev/larva/project/blinky/bin/blinky/blinky.elf...done.
<p>Voilà! The board's LED should be blinking at 1 Hz.</p>
</li>
</ol>
-<h3 id="using-flash-to-make-led-blink"><a href="id:anchor6">Using flash to make LED blink</a></h3>
+<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>
<ol>
<li>Configure the board to boot from flash by moving the two jumpers together to B0_0 and B1_0. </li>
</ol>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ff2aecef/site/chapter2/project2/index.html
----------------------------------------------------------------------
diff --git a/site/chapter2/project2/index.html b/site/chapter2/project2/index.html
index 5408c59..e357187 100644
--- a/site/chapter2/project2/index.html
+++ b/site/chapter2/project2/index.html
@@ -6,10 +6,10 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
-
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/chapter2/project2/">
<link rel="shortcut icon" href="../../img/favicon.ico">
- <title>Project 2 - MyNewt</title>
+ <title>Project 2 - Mynewt</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
@@ -43,7 +43,7 @@
<!-- Main title -->
- <a class="navbar-brand" href="../..">MyNewt</a>
+ <a class="navbar-brand" href="../..">Mynewt</a>
</div>
<!-- Expanded navigation -->
@@ -54,7 +54,7 @@
<li >
- <a href="../..">Home</a>
+ <a href="../..">Doc Home</a>
</li>
@@ -65,12 +65,6 @@
<li >
- <a href="../../chapter1/intro/">Introduction</a>
-</li>
-
-
-
-<li >
<a href="../../chapter1/newt_concepts/">Newt Concepts</a>
</li>
@@ -165,7 +159,7 @@
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
- <li class="main active"><a href="#porting-project-blinky-to-additional-boards">Porting Project Blinky to additional boards</a></li>
+ <li class="main active"><a href="#project-2-blinky-on-additional-boards">Project 2 - Blinky on additional boards</a></li>
<li><a href="#objective">Objective</a></li>
@@ -178,21 +172,21 @@
</div></div>
<div class="col-md-9" role="main">
-<h2 id="porting-project-blinky-to-additional-boards">Porting Project Blinky to additional boards</h2>
-<h3 id="objective">Objective</h3>
+<h2 id="project-2-blinky-on-additional-boards">Project 2 - Blinky on additional boards<a class="headerlink" href="#project-2-blinky-on-additional-boards" title="Permanent link">¶</a></h2>
+<h3 id="objective">Objective<a class="headerlink" href="#objective" title="Permanent link">¶</a></h3>
<p>The goal of this tutorial is to download a generic firmware skeleton ("bootstrap image") that applies to any hardware and then throw in additional applicable eggs to generate a build for a specific board. </p>
<p>The following target hardware chips are covered:</p>
<ul>
-<li><a href="#anchor1">STM32F303VC MCU</a> from STMicroelectronics</li>
-<li><a href="#anchor2">nRF52 Series</a> from Nordic Semiconductors </li>
+<li><a href="#stm32f303vc-mcu">STM32F303VC MCU</a> from STMicroelectronics</li>
+<li><a href="#nrf52-series">nRF52 Series</a> from Nordic Semiconductors </li>
</ul>
-<h3 id="stm32f303vc-mcu"><a href="id:anchor1">STM32F303VC MCU</a></h3>
-<h4 id="hardware-needed">Hardware needed</h4>
+<h3 id="stm32f303vc-mcu">STM32F303VC MCU<a class="headerlink" href="#stm32f303vc-mcu" title="Permanent link">¶</a></h3>
+<h4 id="hardware-needed">Hardware needed<a class="headerlink" href="#hardware-needed" title="Permanent link">¶</a></h4>
<ul>
<li>Discovery kit with STM32F303VC MCU</li>
<li>Laptop running Mac OS</li>
</ul>
-<h4 id="step-by-step-instructions-to-build-image">Step by Step Instructions to build image</h4>
+<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 installed are not hardware architecture specific.</p>
@@ -300,13 +294,13 @@ Successfully run!
</code></pre>
</li>
</ul>
-<h3 id="nrf52-series"><a href="id:anchor2">nRF52 Series</a></h3>
-<h4 id="hardware-needed_1">Hardware needed</h4>
+<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>
<li>nRF52 Development Kit</li>
<li>Laptop running Mac OS</li>
</ul>
-<h4 id="step-by-step-instructions-to-build-image_1">Step by Step Instructions to build image</h4>
+<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>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ff2aecef/site/chapter2/project3/index.html
----------------------------------------------------------------------
diff --git a/site/chapter2/project3/index.html b/site/chapter2/project3/index.html
index a012e7e..53207f3 100644
--- a/site/chapter2/project3/index.html
+++ b/site/chapter2/project3/index.html
@@ -6,10 +6,10 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
-
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/chapter2/project3/">
<link rel="shortcut icon" href="../../img/favicon.ico">
- <title>Project 3 - MyNewt</title>
+ <title>Project 3 - Mynewt</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
@@ -43,7 +43,7 @@
<!-- Main title -->
- <a class="navbar-brand" href="../..">MyNewt</a>
+ <a class="navbar-brand" href="../..">Mynewt</a>
</div>
<!-- Expanded navigation -->
@@ -54,7 +54,7 @@
<li >
- <a href="../..">Home</a>
+ <a href="../..">Doc Home</a>
</li>
@@ -65,12 +65,6 @@
<li >
- <a href="../../chapter1/intro/">Introduction</a>
-</li>
-
-
-
-<li >
<a href="../../chapter1/newt_concepts/">Newt Concepts</a>
</li>
@@ -172,7 +166,7 @@
</div></div>
<div class="col-md-9" role="main">
-<h2 id="how-to-test-an-egg">How to Test an Egg</h2></div>
+<h2 id="how-to-test-an-egg">How to Test an Egg<a class="headerlink" href="#how-to-test-an-egg" title="Permanent link">¶</a></h2></div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ff2aecef/site/chapter2/vocabulary/index.html
----------------------------------------------------------------------
diff --git a/site/chapter2/vocabulary/index.html b/site/chapter2/vocabulary/index.html
index e40cc48..a66a121 100644
--- a/site/chapter2/vocabulary/index.html
+++ b/site/chapter2/vocabulary/index.html
@@ -6,10 +6,10 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
-
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/chapter2/vocabulary/">
<link rel="shortcut icon" href="../../img/favicon.ico">
- <title>Understanding Newt Terms - MyNewt</title>
+ <title>Understanding Newt Terms - Mynewt</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
@@ -43,7 +43,7 @@
<!-- Main title -->
- <a class="navbar-brand" href="../..">MyNewt</a>
+ <a class="navbar-brand" href="../..">Mynewt</a>
</div>
<!-- Expanded navigation -->
@@ -54,7 +54,7 @@
<li >
- <a href="../..">Home</a>
+ <a href="../..">Doc Home</a>
</li>
@@ -65,12 +65,6 @@
<li >
- <a href="../../chapter1/intro/">Introduction</a>
-</li>
-
-
-
-<li >
<a href="../../chapter1/newt_concepts/">Newt Concepts</a>
</li>
@@ -165,7 +159,7 @@
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
- <li class="main active"><a href="#vocabulary">Vocabulary</a></li>
+ <li class="main active"><a href="#understanding-newt-terms">Understanding Newt Terms</a></li>
<li><a href="#nest">Nest</a></li>
@@ -188,10 +182,10 @@
</div></div>
<div class="col-md-9" role="main">
-<h2 id="vocabulary">Vocabulary</h2>
-<h4 id="nest">Nest</h4>
+<h2 id="understanding-newt-terms">Understanding Newt Terms<a class="headerlink" href="#understanding-newt-terms" title="Permanent link">¶</a></h2>
+<h3 id="nest">Nest<a class="headerlink" href="#nest" title="Permanent link">¶</a></h3>
<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="#anchor1">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="#anchor4">target</a> or build definitions, clutch description files, scripts etc.</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
|- nest.yml
@@ -262,7 +256,7 @@
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="../../chapter3/newt_tool_reference/">Chapter 3</a>.</p>
-<h4 id="project">Project</h4>
+<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>
<p>Layout-wise, a project is a directory inside a nest and contains eggs required for a certain application. For example, the <code>blinky</code> egg sits in <code>project/blinky</code> directory of the <code>larva</code> nest. This egg is used in the blinky project (application) outlined in <a href="../../chapter1/project1/">Chapter 1</a>. <<em>Note: This Will Change</em>></p>
<p>A project has the following concepts or properties associated with it. You can find them in the <code><project-name>.yml</code> file in the project directory. For example, the <code>project/blinky</code> directory has the <code>blinky.yml</code> file indicating some or all of the properties below. Only the name of a project is required for the project to exist, however additional properties may need to be specified for the eggs in it to compile properly and produce an executable. </p>
@@ -270,15 +264,15 @@ newt nest [child-commands]
<li>Project name</li>
<li>Base path of the project (nest/project/project-name by default)</li>
<li>Eggs belonging to the project</li>
-<li><a href="#anchor2">Capabilities</a> that are required for the project or target </li>
-<li><a href="#anchor3">Identity</a> to classify the type of project or target</li>
+<li><a href="#capabilities">Capabilities</a> that are required for the project or target </li>
+<li><a href="#identity">Identity</a> to classify the type of project or target</li>
<li>Compiler flags to call out any specific compiler requirement</li>
</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>
</code></pre>
-<h4 id="egg"><a href="id:anchor1">Egg</a></h4>
+<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>
@@ -290,14 +284,14 @@ 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="../../chapter3/newt_tool_reference/">Chapter 3</a>.</p>
-<h4 id="clutch">Clutch</h4>
+<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>
</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>
-<h4 id="eggshell">Eggshell</h4>
+<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
</code></pre>
@@ -305,7 +299,7 @@ deps: libs/testutil@none#stable
<pre><code>Remote clutch larva (eggshells: 19)
Remote clutch ble_test (eggshells: 15)
</code></pre>
-<h4 id="target"><a href="id:anchor4">Target</a></h4>
+<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
@@ -319,10 +313,10 @@ Remote clutch ble_test (eggshells: 15)
<pre><code>newt target create my_target1
newt target set my_target1 arch=cortex_m4
</code></pre>
-<h4 id="capability"><a href="id:anchor2">Capability</a></h4>
+<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>
-<h4 id="identity"><a href="id:anchor3">Identity</a></h4>
+<h3 id="identity">Identity<a class="headerlink" href="#identity" title="Permanent link">¶</a></h3>
<p>Identity is a property of a target or project in the newt world. A target may inherit it from a project or vice versa. It may be used to determine what eggs to include or how an egg code should behave in a build or which linkerscripts to use. For example, the identity of a lock is different from the identity of a wearable monitor. Even if they were to be built on the same hardware target, different features and behavior are required. Their different identities result in differing sets of eggs in the projects and/or the same egg behaving differently depending on the identity.</p></div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ff2aecef/site/chapter3/newt_ops/index.html
----------------------------------------------------------------------
diff --git a/site/chapter3/newt_ops/index.html b/site/chapter3/newt_ops/index.html
index dd86991..84a393d 100644
--- a/site/chapter3/newt_ops/index.html
+++ b/site/chapter3/newt_ops/index.html
@@ -6,10 +6,10 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
-
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/chapter3/newt_ops/">
<link rel="shortcut icon" href="../../img/favicon.ico">
- <title>Command structure - MyNewt</title>
+ <title>Command structure - Mynewt</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
@@ -43,7 +43,7 @@
<!-- Main title -->
- <a class="navbar-brand" href="../..">MyNewt</a>
+ <a class="navbar-brand" href="../..">Mynewt</a>
</div>
<!-- Expanded navigation -->
@@ -54,7 +54,7 @@
<li >
- <a href="../..">Home</a>
+ <a href="../..">Doc Home</a>
</li>
@@ -65,12 +65,6 @@
<li >
- <a href="../../chapter1/intro/">Introduction</a>
-</li>
-
-
-
-<li >
<a href="../../chapter1/newt_concepts/">Newt Concepts</a>
</li>
@@ -172,7 +166,7 @@
</div></div>
<div class="col-md-9" role="main">
-<h2 id="command-structure">Command Structure</h2>
+<h2 id="command-structure">Command Structure<a class="headerlink" href="#command-structure" title="Permanent link">¶</a></h2>
<p>In the newt tool, commands represent actions and flags are modifiers for those actions. A command can have children commands which are also simply referred to as commands. One or more arguments may need to be provided to a command to execute it correctly. </p>
<p>In the example below, the <code>newt</code> command has the child command <code>target set</code>. The first argument 'my_target1' is the name of the target whose attributes are being set. The second argument 'arch=cortex_m4' specifies the value to set the attribute (variable) 'arch' to, which in this case is 'cortex_m4'. </p>
<pre><code>newt target set my_target1 arch=cortex_m4
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ff2aecef/site/chapter3/newt_tool_reference/index.html
----------------------------------------------------------------------
diff --git a/site/chapter3/newt_tool_reference/index.html b/site/chapter3/newt_tool_reference/index.html
index 20323e8..7a978d3 100644
--- a/site/chapter3/newt_tool_reference/index.html
+++ b/site/chapter3/newt_tool_reference/index.html
@@ -6,10 +6,10 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
-
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/chapter3/newt_tool_reference/">
<link rel="shortcut icon" href="../../img/favicon.ico">
- <title>Command list - MyNewt</title>
+ <title>Command list - Mynewt</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
@@ -43,7 +43,7 @@
<!-- Main title -->
- <a class="navbar-brand" href="../..">MyNewt</a>
+ <a class="navbar-brand" href="../..">Mynewt</a>
</div>
<!-- Expanded navigation -->
@@ -54,7 +54,7 @@
<li >
- <a href="../..">Home</a>
+ <a href="../..">Doc Home</a>
</li>
@@ -65,12 +65,6 @@
<li >
- <a href="../../chapter1/intro/">Introduction</a>
-</li>
-
-
-
-<li >
<a href="../../chapter1/newt_concepts/">Newt Concepts</a>
</li>
@@ -165,7 +159,7 @@
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
- <li class="main active"><a href="#newt-tool-reference">Newt tool Reference</a></li>
+ <li class="main active"><a href="#command-list">Command List</a></li>
<li><a href="#available-high-level-commands">Available high-level commands</a></li>
@@ -184,8 +178,8 @@
</div></div>
<div class="col-md-9" role="main">
-<h2 id="newt-tool-reference">Newt tool Reference</h2>
-<h3 id="available-high-level-commands">Available high-level commands</h3>
+<h2 id="command-list">Command List<a class="headerlink" href="#command-list" title="Permanent link">¶</a></h2>
+<h3 id="available-high-level-commands">Available high-level commands<a class="headerlink" href="#available-high-level-commands" title="Permanent link">¶</a></h3>
<pre><code>version Display the Newt version number
help Help about any command
nest Commands to manage nests & clutches (remote egg repositories)
@@ -193,8 +187,8 @@ egg Commands to list and inspect eggs on a nest
target Set and view target information
</code></pre>
-<h3 id="version"><em>version</em></h3>
-<h4 id="usage">Usage:</h4>
+<h3 id="version"><em>version</em><a class="headerlink" href="#version" title="Permanent link">¶</a></h3>
+<h4 id="usage">Usage:<a class="headerlink" href="#usage" title="Permanent link">¶</a></h4>
<pre><code>newt version [flags]
</code></pre>
<p>Flags:</p>
@@ -220,8 +214,8 @@ target Set and view target information
</tr>
</tbody>
</table>
-<h3 id="help"><em>help</em></h3>
-<h4 id="usage_1">Usage:</h4>
+<h3 id="help"><em>help</em><a class="headerlink" href="#help" title="Permanent link">¶</a></h3>
+<h4 id="usage_1">Usage:<a class="headerlink" href="#usage_1" title="Permanent link">¶</a></h4>
<pre><code>newt help [input1]
</code></pre>
<p>Flags:</p>
@@ -255,8 +249,8 @@ target Set and view target information
</tr>
</tbody>
</table>
-<h3 id="nest"><em>nest</em></h3>
-<h4 id="usage_2">Usage:</h4>
+<h3 id="nest"><em>nest</em><a class="headerlink" href="#nest" title="Permanent link">¶</a></h3>
+<h4 id="usage_2">Usage:<a class="headerlink" href="#usage_2" title="Permanent link">¶</a></h4>
<pre><code>newt nest [command][flags] input1 input2...
</code></pre>
<p>Available commands: </p>
@@ -287,15 +281,15 @@ show-clutch Show an individual clutch in the current nest
<tbody>
<tr>
<td>create</td>
-<td>Downloads the skeleton of a nest on your local machine from the optional <code>input2</code> nest url, if specified, and creates a new nest directory by the name of <code>input1</code>. If <code>input2</code> is not specified, then a default skeleton from the <code>tadpole</code> nest on Mynewt is downloaded. The command lays out a generic directory structure for the nest you are going to build under it and includes some default eggs in it.</td>
+<td>Downloads the skeleton of a nest on your local machine from the optional <code>input2</code>nest url, if specified, and creates a new nest directory by the name of <code>input1</code> If <code>input2</code>is not specified, then a default skeleton from the <code>tadpole</code>nest on Mynewt is downloaded. The command lays out a generic directory structure for the nest you are going to build under it and includes some default eggs in it.</td>
</tr>
<tr>
<td>generate-clutch</td>
-<td>Takes a snapshot of the eggs in the current local directory and combines them into a clutch by the name of <code>input1</code> and with the url of <code>input2</code> and generates a standard output of the clutch details that can be redirected to a <code>.yml</code> clutch file. Typically the clutch file name is chosen to match the clutch name which means the standard output should be directed to a clutch file named <code>input1.yml</code></td>
+<td>Takes a snapshot of the eggs in the current local directory and combines them into a clutch by the name of <code>input1</code>and with the url of <code>input2</code>and generates a standard output of the clutch details that can be redirected to a <code>.yml</code>clutch file. Typically the clutch file name is chosen to match the clutch name which means the standard output should be directed to a clutch file named <code>input1.yml</code></td>
</tr>
<tr>
<td>add-clutch</td>
-<td>Downloads the clutch of the name <code>input1</code> from the master branch of the github repository <code>input2</code> into the current nest. A file named <code>input1.yml</code> file is added in the <code>.nest/clutches</code> subdirectory inside the current local nest. The <code>.nest/</code> directory structure is created automatically if it does not exist.</td>
+<td>Downloads the clutch of the name <code>input1</code>from the master branch of the github repository <code>input2</code>into the current nest. A file named <code>input1.yml</code>file is added in the <code>.nest/clutches</code>subdirectory inside the current local nest. The <code>.nest/</code>directory structure is created automatically if it does not exist.</td>
</tr>
<tr>
<td>list-clutches</td>
@@ -303,7 +297,7 @@ show-clutch Show an individual clutch in the current nest
</tr>
<tr>
<td>show-clutch</td>
-<td>Shows information about the clutch that has the name given in the <code>input1</code> argument. Output includes the clutch name, url, and all the constituent eggs with their version numbers.</td>
+<td>Shows information about the clutch that has the name given in the <code>input1</code>argument. Output includes the clutch name, url, and all the constituent eggs with their version numbers.</td>
</tr>
</tbody>
</table>
@@ -320,7 +314,7 @@ show-clutch Show an individual clutch in the current nest
<tr>
<td>add-clutch</td>
<td>-b, --branch="<branch-name>"</td>
-<td>Fetches the clutch file with name <code>input1</code> from the specified branch at <code>input1</code> url of the github repository. All subsequent egg installations will be done from that branch.</td>
+<td>Fetches the clutch file with name <code>input1</code>from the specified branch at <code>input1</code>url of the github repository. All subsequent egg installations will be done from that branch.</td>
</tr>
</tbody>
</table>
@@ -347,7 +341,7 @@ show-clutch Show an individual clutch in the current nest
<tr>
<td>generate-clutch</td>
<td>newt nest generate-clutch myclutch https://www.github.com/mynewt/larva > myclutch.yml</td>
-<td>Takes a snapshot of the eggs in the current nest to form a clutch named myclutch with the url https://www.github.com/mynewt/larva. The output is written to a file named <code>myclutch.yml</code> and describes the properties and contents of the clutch (name, url, eggs).</td>
+<td>Takes a snapshot of the eggs in the current nest to form a clutch named myclutch with the url https://www.github.com/mynewt/larva. The output is written to a file named <code>myclutch.yml</code>and describes the properties and contents of the clutch (name, url, eggs).</td>
</tr>
<tr>
<td>add-clutch</td>
@@ -366,8 +360,8 @@ show-clutch Show an individual clutch in the current nest
</tr>
</tbody>
</table>
-<h3 id="egg"><em>egg</em></h3>
-<h4 id="usage_3">Usage:</h4>
+<h3 id="egg"><em>egg</em><a class="headerlink" href="#egg" title="Permanent link">¶</a></h3>
+<h4 id="usage_3">Usage:<a class="headerlink" href="#usage_3" title="Permanent link">¶</a></h4>
<pre><code>newt egg [command][flag] input1 input2
</code></pre>
<p>Available Commands: </p>
@@ -406,19 +400,19 @@ remove Remove an egg
</tr>
<tr>
<td>hunt</td>
-<td>Hunts for an egg, specified by <code>input1</code>. The local nest, along with all remote nests (clutches) are searched. All matched eggs are shown along with the clutch informaton. Installed eggs are called out as such. The command can be invoked from anywhere in the nest.</td>
+<td>Hunts for an egg, specified by <code>input1</code> The local nest, along with all remote nests (clutches) are searched. All matched eggs are shown along with the clutch informaton. Installed eggs are called out as such. The command can be invoked from anywhere in the nest.</td>
</tr>
<tr>
<td>show</td>
-<td>Show the contents of the egg named <code>input2</code> found in the clutch named <code>input1</code>. The clutch name is optional; if only the egg name is given as the argument it is resolved using all the clutches installed in the current nest. If the egg is present in multiple clutches it will list all of them along with the clutch information for each.</td>
+<td>Show the contents of the egg named <code>input2</code>found in the clutch named <code>input1</code> The clutch name is optional; if only the egg name is given as the argument it is resolved using all the clutches installed in the current nest. If the egg is present in multiple clutches it will list all of them along with the clutch information for each.</td>
</tr>
<tr>
<td>install</td>
-<td>Install the egg specified by <code>input2</code> from the clutch named <code>input1</code>. The command downloads the egg from the github repository using the URL in the clutch description file (typically donwloaded as 'input1@<branch-name>.yml' in .nest/clutches). It also downloads all the dependencies (constituent eggs) as decribed in the egg's description file ('egg.yml') and installs all of them. The clutch name is optional. If only the egg name is given as the argument, the command looks for the egg name in all the clutches in the local nest and installs accordingly. An egg is installed by this command only if it has not already been installed.</td>
+<td>Install the egg specified by <code>input2</code>from the clutch named <code>input1</code> The command downloads the egg from the github repository using the URL in the clutch description file (typically donwloaded as 'input1@<branch-name>.yml' in .nest/clutches). It also downloads all the dependencies (constituent eggs) as decribed in the egg's description file ('egg.yml') and installs all of them. The clutch name is optional. If only the egg name is given as the argument, the command looks for the egg name in all the clutches in the local nest and installs accordingly. An egg is installed by this command only if it has not already been installed.</td>
</tr>
<tr>
<td>remove</td>
-<td>Remove an egg named <code>input2</code> from clutch <code>input1</code>, if clutch is specified. Otherwise only one input required - that of the name of the egg to be removed from the local nest.</td>
+<td>Remove an egg named <code>input2</code>from clutch <code>input1</code> if clutch is specified. Otherwise only one input required - that of the name of the egg to be removed from the local nest.</td>
</tr>
</tbody>
</table>
@@ -486,8 +480,8 @@ remove Remove an egg
</tr>
</tbody>
</table>
-<h3 id="target"><em>target</em></h3>
-<h4 id="usage_4">Usage:</h4>
+<h3 id="target"><em>target</em><a class="headerlink" href="#target" title="Permanent link">¶</a></h3>
+<h4 id="usage_4">Usage:<a class="headerlink" href="#usage_4" title="Permanent link">¶</a></h4>
<p>Usage: </p>
<pre><code>newt target [command] input1 [flag1] [flag2]
</code></pre>
@@ -522,7 +516,7 @@ import Import target
<tbody>
<tr>
<td>set</td>
-<td>Set attributes of the target. Currently the list of possible attributes are:<code>arch, compiler, compiler_def, project, bsp, egg, identities, capabilities, dependencies, cflags, lflags</code>. Typically only the first 5 need to be set for a hardware target. For a simulated target, e.g. for software testing purposes, <code>arch=sim</code>, <code>compiler=sim</code>, and <code>egg=<egg name to be tested></code>. You cannot set both the project and egg for a target.</td>
+<td>Set attributes of the target. Currently the list of possible attributes are:<code>arch, compiler, compiler_def, project, bsp, egg, identities, capabilities, dependencies, cflags, lflags</code> Typically only the first 5 need to be set for a hardware target. For a simulated target, e.g. for software testing purposes, <code>arch=sim</code> <code>compiler=sim</code> and <code>egg=<egg name to be tested></code> You cannot set both the project and egg for a target.</td>
</tr>
<tr>
<td>unset</td>
@@ -530,35 +524,35 @@ import Import target
</tr>
<tr>
<td>delete</td>
-<td>Deletes only the description for the target. Does not delete the target directory with associated binaries. If you want to clean out the binaries, list files, and executables use<code>newt target build <target-name> clean</code> <strong>before</strong> deleting the target!</td>
+<td>Deletes only the description for the target. Does not delete the target directory with associated binaries. If you want to clean out the binaries, list files, and executables use<code>newt target build <target-name> clean</code><strong>before</strong> deleting the target!</td>
</tr>
<tr>
<td>create</td>
-<td>Creates a target description or build definition by the name <code>input1</code>. By default it assigns the sim (simulator) architecture to it which allows you to build new projects and software on your native OS and try it out.</td>
+<td>Creates a target description or build definition by the name <code>input1</code> By default it assigns the sim (simulator) architecture to it which allows you to build new projects and software on your native OS and try it out.</td>
</tr>
<tr>
<td>show</td>
-<td>Display the configuration defined for the target named <code>input1</code>. If no <code>input1</code> is specified then show the details for all the targets in the nest.</td>
+<td>Display the configuration defined for the target named <code>input1</code> If no <code>input1</code>is specified then show the details for all the targets in the nest.</td>
</tr>
<tr>
<td>build</td>
-<td>Build the source code into an image that can be loaded on the hardware associated with the target named <code>input1</code> to do the application enabled by the 'project' associated with that target (via the target definition). It creates 'bin/' and 'bin/<input1>/' subdirectories inside the base directory for the project, compiles and generates binaries and executables, and places them in 'bin/<input1>/.</td>
+<td>Build the source code into an image that can be loaded on the hardware associated with the target named <code>input1</code>to do the application enabled by the 'project' associated with that target (via the target definition). It creates 'bin/' and 'bin/<input1>/' subdirectories inside the base directory for the project, compiles and generates binaries and executables, and places them in 'bin/<input1>/.</td>
</tr>
<tr>
<td>test</td>
-<td>Test an egg on the target named <code>input1</code>. The egg is either supplied as an argument to the command line invocation of <code>newt target test</code> or added as part of the target definition. If only the target is specified as <code>input1</code>, then the egg in the target's definition is automatically chosen to be tested. You currently cannot test an entire project on a hardware target. The test command is envisioned for use if one or two eggs gets updated and each needs to be tested against a target. Alternatively, a script may be written for a series of tests on several eggs.</td>
+<td>Test an egg on the target named <code>input1</code> The egg is either supplied as an argument to the command line invocation of <code>newt target test</code>or added as part of the target definition. If only the target is specified as <code>input1</code> then the egg in the target's definition is automatically chosen to be tested. You currently cannot test an entire project on a hardware target. The test command is envisioned for use if one or two eggs gets updated and each needs to be tested against a target. Alternatively, a script may be written for a series of tests on several eggs.</td>
</tr>
<tr>
<td>export</td>
-<td>Exports the configurations of the specified target <code>input1</code>. If -a or -export-all flag is used, then all targets are exported and printed out to standard out. You may redirect the output to a file.</td>
+<td>Exports the configurations of the specified target <code>input1</code> If -a or -export-all flag is used, then all targets are exported and printed out to standard out. You may redirect the output to a file.</td>
</tr>
<tr>
<td>import</td>
-<td>Import one or more target configuration from standard input or a file. Each target starts with <code>@target=<target-name></code> followed by the attributes. The list of targets should end with <code>@endtargets</code>.</td>
+<td>Import one or more target configuration from standard input or a file. Each target starts with <code>@target=<target-name></code>followed by the attributes. The list of targets should end with <code>@endtargets</code></td>
</tr>
<tr>
<td>size</td>
-<td>Outputs the RAM and flash consumption by the components of the specified target <code>input1</code>.</td>
+<td>Outputs the RAM and flash consumption by the components of the specified target <code>input1</code></td>
</tr>
</tbody>
</table>
@@ -585,7 +579,7 @@ import Import target
<tr>
<td>export</td>
<td>-a, -export-all</td>
-<td>Export all targets. <code>input1</code> is not necessary when this flag is used.</td>
+<td>Export all targets. <code>input1</code>is not necessary when this flag is used.</td>
</tr>
<tr>
<td>import</td>
@@ -662,7 +656,7 @@ import Import target
<tr>
<td>import</td>
<td>newt target import -a < in_targets.txt</td>
-<td>Imports all the targets specified in the file named <code>in_targets.txt</code>. A sample file is shown after this table.</td>
+<td>Imports all the targets specified in the file named <code>in_targets.txt</code> A sample file is shown after this table.</td>
</tr>
<tr>
<td>size</td>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ff2aecef/site/index.html
----------------------------------------------------------------------
diff --git a/site/index.html b/site/index.html
index 8852a5f..e924a98 100644
--- a/site/index.html
+++ b/site/index.html
@@ -6,10 +6,10 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
-
+ <link rel="canonical" href="http://mynewt.incubator.apache.org/">
<link rel="shortcut icon" href="./img/favicon.ico">
- <title>MyNewt</title>
+ <title>Mynewt</title>
<link href="./css/bootstrap-custom.min.css" rel="stylesheet">
<link href="./css/font-awesome-4.0.3.css" rel="stylesheet">
@@ -43,7 +43,7 @@
<!-- Main title -->
- <a class="navbar-brand" href=".">MyNewt</a>
+ <a class="navbar-brand" href=".">Mynewt</a>
</div>
<!-- Expanded navigation -->
@@ -54,7 +54,7 @@
<li class="active">
- <a href=".">Home</a>
+ <a href=".">Doc Home</a>
</li>
@@ -65,12 +65,6 @@
<li >
- <a href="chapter1/intro/">Introduction</a>
-</li>
-
-
-
-<li >
<a href="chapter1/newt_concepts/">Newt Concepts</a>
</li>
@@ -149,7 +143,7 @@
</a>
</li>
<li >
- <a rel="prev" href="chapter1/intro/">
+ <a rel="prev" href="chapter1/newt_concepts/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
@@ -172,7 +166,7 @@
</div></div>
<div class="col-md-9" role="main">
-<h2 id="objective-of-mynewt">Objective of Mynewt</h2>
+<h2 id="objective-of-mynewt">Objective of Mynewt<a class="headerlink" href="#objective-of-mynewt" title="Permanent link">¶</a></h2>
<p>Mynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices. The modular implementation allows the user the flexibility to mix and match hardware components and customize the software stack depending on the feature and performance requirements of the particular application he or she has in mind.</p>
<p>The world of Mynewt, therefore, has three primary collaborative goals:</p>
<ul>
@@ -183,13 +177,13 @@
<p>The chapter organization is outlined below. Each Chapter has one or more tutorials for hands-on experience with the material in each chapter. </p>
<ul>
<li>
-<p><a href="chapter1/intro/">Chapter 1: Getting Started</a> introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.</p>
+<p><a href="chapter1/newt_concepts/">Chapter 1: Getting Started</a> introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.</p>
</li>
<li>
<p><a href="chapter2/vocabulary/">Chapter 2: Getting Acclimatized</a> delves deeper into the concepts crucial to the software development effort. </p>
</li>
<li>
-<p><a href="chapter3/newt_ops/">Chapter 3: Newt Tool Reference</a> is a detailed listing of the available commands to help you with your project. </p>
+<p><a href="chapter3/newt_ops/">Chapter 3: Newt Tool Reference</a> describes the command structure and details all the available commands to help you with your project. </p>
</li>
</ul></div>
@@ -238,5 +232,5 @@
<!--
MkDocs version : 0.14.0
-Build Date UTC : 2015-10-29 07:11:55.134082
+Build Date UTC : 2015-10-30 07:38:55.060375
-->