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 2015/12/18 20:39:55 UTC
[01/11] incubator-mynewt-site git commit: Blinky instructions update
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/master fa06e3d59 -> 3355bd0d8
Blinky instructions update
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/66ee6b18
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/66ee6b18
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/66ee6b18
Branch: refs/heads/master
Commit: 66ee6b182f30c1ba08427c2d0f851b186635e17c
Parents: c91f293
Author: aditihilbert <ad...@runtime.io>
Authored: Thu Dec 17 17:04:32 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Thu Dec 17 17:04:32 2015 -0800
----------------------------------------------------------------------
docs/chapter1/project1.md | 165 +++++++++++++++++++++++++++++++++++------
1 file changed, 141 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/66ee6b18/docs/chapter1/project1.md
----------------------------------------------------------------------
diff --git a/docs/chapter1/project1.md b/docs/chapter1/project1.md
index 95d19e6..26f565d 100644
--- a/docs/chapter1/project1.md
+++ b/docs/chapter1/project1.md
@@ -5,7 +5,7 @@
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 ** Project Blinky**. The goals of this tutorial are threefold:
1. First, you will learn how to set up your environment to be ready to use Mynewt OS and newt tool.
-2. Second, we will walk you through a download of eggs for building and testing [on a simulated target](#building-test-code-on-simulator) on a non-Windows machine.
+2. Second, we will walk you through a download of eggs for building and testing [on a simulated target](#building-test-code-on-simulator).
3. Third, 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 [download an image to SRAM](#using-sram-to-make-led-blink) or you can [download it to flash](#using-flash-to-make-led-blink).
** Time Requirement**: 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!
@@ -18,8 +18,7 @@ We will show you how you can use eggs from a nest on Mynewt to make an LED on a
3. USB A-B type cable to connect the debugger to your personal computer
4. Personal Computer
-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 [Getting your Mac Ready](project1.md#getting-your-mac-ready) or [Getting your Ubuntu machine Ready](project1.md#getting-your-ubuntu-machine-ready) or [Getting your Windows machine Ready](#getting-your-windows-machine-ready). While the given instructions should work on other versions, they have been tested for the three specific releases of operating systems noted here:
+The 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:
* Mac: OS X Yosemite Version 10.10.5
* Linux: Ubuntu 14.10 (Utopic Unicorn)
@@ -325,9 +324,82 @@ The following shows how to clone a Mynewt OS code repository:
* Proceed to the [Building test code on simulator](#building-test-code-on-simulator) section.
-### Getting your Windows machine Ready
+### Getting your Windows machine ready for simulated target
-<font color="red"> Note: The instructions for Windows machine are still under review. We are working on providing a Docker container to make the prep work easy. </font>
+The `newt` 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 `newt` tool natively on a computer running any of the three Operating System machines - OSX, Linux, or Windows.
+
+However, 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 (`newtvm.exe`)that allows you to run the newt commands in the Linux Docker instance. The Docker image contains:
+
+ * The newt command-line tool
+ * Go
+ * A multilib-capable native gcc / glibc
+ * An arm-none-eabi gcc
+ * Native gdb
+
+ The sequence of events when using the Docker image is as follows:
+
+ 1. A new docker environment is created in the Linux VM.
+ 2. The specified command with the newtvm prefix (`newtvm newt` command) is sent to the docker environment via ssh.
+ 3. The Linux command runs.
+ 4. The output from the command is sent back to Windows via ssh.
+ 5. The output is displayed in the Windows command prompt.
+
+
+#### Install Linux virtual machine
+
+* Download the Docker Toolbox for Windows (version 1.9.0c or later) from [https://www.docker.com/docker-toolbox](https://www.docker.com/docker-toolbox). The Docker toolbox creates a consistently reproducible and self-contained environment in Linux.
+
+* Run the Docker Toolbox installer. All the default settings are OK.
+
+* You may need to add "C:\Program Files\Git\usr\bin" to your PATH
+environment variable. To add to the PATH environment variable, right-click on the Start button in the bottom left corner. Choose System -> Advanced system settings -> Environment Variables. Click on the PATH variable under "System variables" and click Edit to check and add it if it is not already there.
+
+#### Install newtvm tool
+
+* From your base user (home) directory, pull or clone the latest code from the newt repository into the `newt` directory. It includes the executable `newtvm.exe` for the newtvm tool in the `newtvm` directory.
+
+ C:\Users\admin> git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt newt
+
+ The newtvm tool is what allows you to run programs in the Linux docker
+instance.
+
+* 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.
+
+
+
+ ## .
+ ## ## ## ==
+ ## ## ## ## ## ===
+ /"""""""""""""""""\___/ ===
+ ~~~ {~~ ~~~~ ~~~ ~~~~ ~~~ ~ / ===- ~~~
+ \______ 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
+
+ admin@dev1 MINGW64 ~ (master)
+ $
+
+ 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.
+
+* 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:
+
+ C:\Users\admin\newt\newtvm> newtvm newt help
+
+
+ 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.
+
+* You are now ready to proceed to [building the image for the simulated target](#building test code on simulator).
+
+
+### Getting your Windows machine ready for hardware target
+
+When you want to produce images for actual hardware board on your Windows machine, go through the following setup procedure and then proceed to the [blinky project on the Olimex board](#Using-SRAM-to-make-LED-blink) with this method.
#### Installing some prerequisites
@@ -508,18 +580,14 @@ tutorial for a Windows machine assumes the specified folders.
5. Select the "WinUSB" driver.
6. Click the "Install Driver" button.
-#### Proceed to the [Building test code on simulator on Windows machine](#building-test-code-on-simulator) section.
-
-Note: Currently, the simulator cannot be run in the Windows machine. We are still working on it. So you will go ahead and [make an LED blink](#making-an-led-blink-from-sram) on the Olimex hardware directly.
-
-However, before you skip to the hardware target, you still need to build your first nest as outlined in step 1 in the [Building test code on simulator](#building-test-code-on-simulator).
+* Proceed to the section on how to [make an LED blink](#making-an-led-blink-from-sram) section.
### Building test code on simulator
-Note: Currently, the simulator cannot be run in the Windows machine. We are working on it. If you are on a Windows machine, do step 1 below and then proceed to the [Making an LED blink](#making-an-led-blink) on the Olimex hardware directly.
+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 [an earlier section](#Getting your Windows machine Ready for simulated target). Consequently, all `newt` commands must be prefaced with `newtvm`.
-1. 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 the apache git repository into a local directory named `larva`.
+1. 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 `larva`.
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.
@@ -533,7 +601,35 @@ Note: Currently, the simulator cannot be run in the Windows machine. We are work
LICENSE clutch.yml hw nest.yml project
README.md compiler libs net scripts
-2. You will now create a new target using the newt tool. You can either use the compiled binary `newt` or run the newt.go program using `$newt` (assuming you have stored the command in a variable in your .bash_profile or .bashrc). When you do a `newt target show` or `$newt target show` it should list all the projects you have created so far.
+ On Windows, open a command prompt (e.g., Windows-R, "cmd", enter) and work from your home directory:
+
+ 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
+
+2. You will now create a new target using the newt tool. You can either use the compiled binary `newt` or run the newt.go program using `$newt` (assuming you have stored the command in a variable in your .bash_profile or .bashrc). When you do a `newt target show` or `$newt target show` it should list all the projects you have created so far.
$ newt target create sim_test
Creating target sim_test
@@ -543,6 +639,10 @@ Note: Currently, the simulator cannot be run in the Windows machine. We are work
name: sim_test
arch: sim
+ Remember, on a Windows machine you will have to preface `newt` with `newtvm`!
+
+ C:\Users\admin\larva>newtvm newt target create sim_test
+
3. Now continue to populate and build out the sim project.
$ newt target set sim_test project=test
@@ -562,8 +662,13 @@ Note: Currently, the simulator cannot be run in the Windows machine. We are work
compiler: sim
name: sim_test
+ Again remember to preface `newt` with `newtvm`on a Windows machine as shown below. Continue to fill out all the project attributes.
+
+ C:\Users\admin\larva>newtvm newt target set sim_test project=test
+ Target sim_test successfully set project to test
+
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.
+~/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.
For a Mac OS X environment:
@@ -573,9 +678,9 @@ Note: Currently, the simulator cannot be run in the Windows machine. We are work
$ cp compiler/sim/linux-compiler.yml compiler/sim/compiler.yml
-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.
+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 `newt` with `newtvm`on a Windows machine.
- $ $newt target build sim_test
+ $ newt target build sim_test
Successfully run!
You can specify the VERBOSE option if you want to see the gory details.
@@ -590,7 +695,7 @@ Note: Currently, the simulator cannot be run in the Windows machine. We are work
6. Try running the test suite executable inside this project and enjoy your first successful hatch.
- $ ./project/test/bin/sim_test/test.elf
+ $ 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
@@ -615,9 +720,6 @@ Note: Currently, the simulator cannot be run in the Windows machine. We are work
...
[pass] boot_test_main/boot_test_vb_ns_11
-### Building test code on simulator on Windows machine
-
-Coming soon.
### Using SRAM to make LED blink
@@ -630,7 +732,23 @@ You are here because you want to build an image to be run from internal SRAM on
Substitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows (e.g. `cd dev\go` instead of `cd dev/go`). The newt tool commands do not change.
-2. 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.
+2. 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 `larva`.
+
+ 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.
+
+ $ 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
+
+3. 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.
+
+Remember to prefix each command with "newtvm" if you are executing the newt command in a Linux virtual machine on your Windows box!
+
$ newt target create blinky
Creating target blinky
@@ -654,7 +772,7 @@ You are here because you want to build an image to be run from internal SRAM on
name: blinky
arch: cortex_m4
-3. Now you have to build the image. The linker script within the `hw/bsp/olimex_stm32-e407_devboard` egg builds an image for flash memory by default. Since you want an image for the SRAM, you need to switch that script with `run_from_sram.ld` 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>.
+4. Now you have to build the image. The linker script within the `hw/bsp/olimex_stm32-e407_devboard` egg builds an image for flash memory by default. Since you want an image for the SRAM, you need to switch that script with `run_from_sram.ld` 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>.
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.
@@ -685,7 +803,7 @@ You are here because you want to build an image to be run from internal SRAM on
blinky.elf blinky.elf.bin blinky.elf.cmd blinky.elf.lst blinky.elf.map
-4. 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 `/usr/share/openocd/scripts/ ` directory as they may have been part of the openocd download. If yes, you are all set and can proceed to preparing the hardware.
+5. 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 `/usr/share/openocd/scripts/ ` directory as they may have been part of the openocd download. If yes, you are all set and can proceed to preparing the hardware.
Otherwise check the `~/dev/larva/hw/bsp/olimex_stm32-e407_devboard` directory for a file named `f407.cfg`. That is the config we will use to talk to this specific hardware using OpenOCD. You are all set if you see it.
@@ -817,7 +935,6 @@ You are here because you want to build an image to be run from flash memory on t
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 bin2image
$ newt target show bin2img
bin2img
arch: sim
[03/11] incubator-mynewt-site git commit: fixed anchors in project
Blinky - still need to update Windows instructions for hardware target
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/modules/testutil.md
----------------------------------------------------------------------
diff --git a/docs/modules/testutil.md b/docs/modules/testutil.md
new file mode 100644
index 0000000..601ed02
--- /dev/null
+++ b/docs/modules/testutil.md
@@ -0,0 +1,149 @@
+# testutil
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe module here, special features, how pieces fit together etc.
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [tu_init](#function-tu_init)
+* [tu_restart](#function-tu_restart)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function tu_init </font>
+
+```
+ int
+ tu_init(void)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function tu_restart </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/newt/newt_ops.md
----------------------------------------------------------------------
diff --git a/docs/newt/newt_ops.md b/docs/newt/newt_ops.md
new file mode 100644
index 0000000..39171d0
--- /dev/null
+++ b/docs/newt/newt_ops.md
@@ -0,0 +1,40 @@
+## Command Structure
+
+In the newt tool, commands represent actions and flags are modifiers for those actions. A command can have children commands which are also simply referred to as commands. One or more arguments may need to be provided to a command to execute it correctly.
+
+In the example below, the `newt` command has the child command `target set`. The first argument 'my_target1' is the name of the target whose attributes are being set. The second argument 'arch=cortex_m4' specifies the value to set the attribute (variable) 'arch' to, which in this case is 'cortex_m4'.
+
+ newt target set my_target1 arch=cortex_m4
+
+Global flags work on all newt commands in the same way. An example is the flag `-v, --verbose` to ask for a verbose output while executing a command. The help flag `-h` or `--help` is available on all commands but provides command specific output, of course. These flags may be specified in either a long or a short form.
+
+A command may additionally take flags specific to it. For example, the `-b ` flag may be used with `newt egg install` to tell it which branch to install the egg from.
+
+ newt egg install -b <branchname> <eggname>
+
+In addition to the newt tool [reference](../chapter3/newt_tool_reference.md) in this documentation set, command-line help is available for each command (and child command). Simply use the flag `-h` or `--help` as shown below:
+
+ $ newt target export --help
+ Export build targets from the current nest, and print them to
+ standard output. If the -a (or -export-all) option is specified,
+ then all targets will be exported. Otherwise, <target-name>
+ must be specified, and only that target will be exported.
+
+ Usage:
+ newt target export [flags]
+
+ Examples:
+ newt target export [-a -export-all] [<target-name>]
+ newt target export -a > my_exports.txt
+ newt target export my_target > my_target_export.txt
+
+ Flags:
+ -a, --export-all=false: If present, export all targets
+ -h, --help=false: help for export
+
+ Global Flags:
+ -l, --loglevel="WARN": Log level, defaults to WARN.
+ -q, --quiet=false: Be quiet; only display error output.
+ -s, --silent=false: Be silent; don't output anything.
+ -v, --verbose=false: Enable verbose output when executing commands.
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/newt/newt_tool_reference.md
----------------------------------------------------------------------
diff --git a/docs/newt/newt_tool_reference.md b/docs/newt/newt_tool_reference.md
new file mode 100644
index 0000000..27cf442
--- /dev/null
+++ b/docs/newt/newt_tool_reference.md
@@ -0,0 +1,269 @@
+
+## Command List
+
+### Available high-level commands
+
+```
+version Display the Newt version number
+help Help about any command
+nest Commands to manage nests & clutches (remote egg repositories)
+egg Commands to list and inspect eggs on a nest
+target Set and view target information
+```
+
+### *version*
+
+#### Usage:
+
+ newt version [flags]
+
+Flags:
+
+ -h, --help=false: help for version
+
+Global Flags:
+
+ -h, --help=false: help for newt
+
+
+Examples
+
+Sub-command | Usage | Explanation
+-------------| -----------------------|-----------------
+version | newt version | Displays the version of newt tool installed
+
+
+### *help*
+
+#### Usage:
+
+ newt help [input1]
+
+Flags:
+
+```
+
+-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.
+```
+
+Examples
+
+Sub-command | Usage | Explanation
+-------------| -----------------------|-----------------
+help | newt help target | Displays the help text for the newt command 'target'
+help | newt help | Displays the help text for newt tool
+
+
+
+### *nest*
+
+#### Usage:
+
+ newt nest [command][flags] input1 input2...
+
+Available commands:
+
+ create Create a new nest
+ generate-clutch Generate a clutch file from the eggs in the current directory
+ add-clutch Add a remote clutch, and put it in the current nest
+ list-clutches List the clutches installed in the current nest
+ show-clutch Show an individual clutch in the current nest
+
+
+Flags:
+
+ -h, --help=false: help for nest
+
+Global 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.
+
+Description
+
+Sub-command | Explanation
+-------------| ------------------------
+create | Downloads the skeleton of a nest on your local machine from the optional `input2` nest url, if specified, and creates a new nest directory by the name of `input1`. If `input2` is not specified, then a default skeleton from the `tadpole` nest on Mynewt is downloaded. The command lays out a generic directory structure for the nest you are going to build under it and includes some default eggs in it.
+generate-clutch | Takes a snapshot of the eggs in the current local directory and combines them into a clutch by the name of `input1` and with the url of `input2` and generates a standard output of the clutch details that can be redirected to a `.yml` clutch file. Typically the clutch file name is chosen to match the clutch name which means the standard output should be directed to a clutch file named `input1.yml`
+add-clutch | Downloads the clutch of the name `input1` from the master branch of the github repository `input2` into the current nest. A file named `input1.yml` file is added in the `.nest/clutches` subdirectory inside the current local nest. The `.nest/` directory structure is created automatically if it does not exist.
+list-clutches | Lists all the clutches present in the current nest, including clutches that may have been added from other nests on github. The output shows all the remote clutch names and the total eggshells in each of the clutches.
+show-clutch | Shows information about the clutch that has the name given in the `input1` argument. Output includes the clutch name, url, and all the constituent eggs with their version numbers.
+
+Command-specific flags
+
+Sub-command | Available flags | Explanation
+-------------| ----------------|------------
+add-clutch | -b, --branch="<branch-name>" | Fetches the clutch file with name `input1` from the specified branch at `input1` url of the github repository. All subsequent egg installations will be done from that branch.
+
+Examples
+
+Sub-command | Usage | Explanation
+-------------| -----------------------|-----------------
+create | newt nest create test_project | Creates a new nest named "test_project " using the default skeleton0
+create | newt nest create mynest <nest-url> | Creates a new nest named "mynest" using the skeleton at the <nest-url> specified
+generate-clutch | newt nest generate-clutch myclutch https://www.github.com/mynewt/larva > myclutch.yml| Takes a snapshot of the eggs in the current nest to form a clutch named myclutch with the url https://www.github.com/mynewt/larva. The output is written to a file named `myclutch.yml` and describes the properties and contents of the clutch (name, url, eggs).
+add-clutch | newt nest add-clutch larva https://www.github.com/mynewt/larva | Adds the remote clutch named larva at www.github.com/mynewt/larva to the local nest.
+list-clutches | newt nest list-clutches | Shows all the remote clutch description files that been downloaded into the current nest
+show-clutch | newt nest show-clutch larva | Outputs the details of the clutch named larva such as the github url where the remote sits, the constituent eggs and their versions
+
+
+### *egg*
+
+#### Usage:
+
+ newt egg [command][flag] input1 input2
+
+
+Available Commands:
+
+ list List eggs in the current nest
+ checkdeps Check egg dependencies
+ hunt Search for egg from clutches
+ show Show the contents of an egg.
+ install Install an egg
+ remove Remove an egg
+
+Flags:
+
+ -h, --help=false: help for egg
+
+Global Flags:
+
+ -l, --loglevel="WARN": Log level, defaults to WARN.
+ -q, --quiet=false: Be quiet; only display error output.
+ -s, --silent=false: Be silent; don't output anything.
+ -v, --verbose=false: Enable verbose output when executing commands.
+
+Description
+
+Sub-command | Explanation
+-------------| ------------------------
+list | List all the eggs in the current nest. The output shows the name, version, path, and any additional attributes of each egg in the nest such as dependencies, capabilities, and linker scripts. The newt command gets the attributes of each egg from the corresponsing egg.yml description file.
+checkdeps | Resolve all dependencies in the local nest. This command goes through all eggs currently installed, checks their dependencies, and prints any unresolved dependencies between eggs.
+hunt | Hunts for an egg, specified by `input1`. The local nest, along with all remote nests (clutches) are searched. All matched eggs are shown along with the clutch informaton. Installed eggs are called out as such. The command can be invoked from anywhere in the nest.
+show | Show the contents of the egg named `input2` found in the clutch named `input1`. The clutch name is optional; if only the egg name is given as the argument it is resolved using all the clutches installed in the current nest. If the egg is present in multiple clutches it will list all of them along with the clutch information for each.
+install | Install the egg specified by `input2` from the clutch named `input1`. The command downloads the egg from the github repository using the URL in the clutch description file (typically donwloaded as 'input1@<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.
+remove | Remove an egg named `input2` from clutch `input1`, if clutch is specified. Otherwise only one input required - that of the name of the egg to be removed from the local nest.
+
+
+
+
+Command-specific flags
+
+Sub-command | Available flags | Explanation
+-------------| ----------------|------------
+install | -b, --branch="<branch-name>" | Installs the eggs from the branch name or tag of the clutch specified
+
+Examples
+
+Sub-command | Usage | Explanation
+-------------| -----------------------|-----------------
+list | newt egg list | CList all of the eggs in the current nest and the details of the eggs.
+checkdeps | newt egg checkdeps | Checks all the dependencies between eggs in the nest. Lists any unresolved dependencies.
+hunt | newt egg hunt blinky| Hunts for the egg named 'blinky'. The command can be invoked from anywhere in the nest. Results show if the egg is installed and which clutch, if any, has the egg.
+show | newt egg show larva libs/os | Show the contents of the egg named 'libs/os' in the clutch named larva. The contents are essentially derived from the egg's 'egg.yml' file.
+install | newt egg install hw/bsp/stm32f3discovery | Downloads and installs the egg named "stm32f3discovery" (specified with its full path name inside the remote nest) along with all its dependencies from the remote nest on github. Since no clutch is specified, the URL for the remote nest in the clutch description file found in the local nest (in .nest/clutches for the project) is used.
+remove | newt egg remove larva blinky| Removes the egg named blinky only from the clutch named larva
+remove | newt egg remove blinky| Removes the egg named blinky from the local nest
+
+
+### *target*
+
+#### Usage:
+
+Usage:
+
+ newt target [command] input1 [flag1] [flag2]
+
+Available Commands:
+
+ set Set target configuration variable
+ unset Unset target configuration variable
+ delete Delete target
+ create Create a target
+ show View target configuration variables
+ build Build target
+ test Test target
+ export Export target
+ import Import target
+ download Download image to target
+ debug Download image to target and start an openocd/gdb session
+
+Flags:
+
+ -h, --help=false: help for target
+
+Global Flags:
+
+ -l, --loglevel="WARN": Log level, defaults to WARN.
+ -q, --quiet=false: Be quiet; only display error output.
+ -s, --silent=false: Be silent; don't output anything.
+ -v, --verbose=false: Enable verbose output when executing commands.
+
+Description
+
+Sub-command | Explanation
+-------------| ------------------------
+set | Set attributes of the target. Currently the list of possible attributes are:``` arch, compiler, compiler_def, project, bsp, egg, identities, capabilities, dependencies, cflags, lflags```. Typically only the first 5 need to be set for a hardware target. For a simulated target, e.g. for software testing purposes, `arch=sim`, `compiler=sim`, and `egg=<egg name to be tested>`. You cannot set both the project and egg for a target.
+unset | Unset attributes of the target in its configuration.
+delete | Deletes only the description for the target. Does not delete the target directory with associated binaries. If you want to clean out the binaries, list files, and executables use`newt target build <target-name> clean` **before** deleting the target!
+create | Creates a target description or build definition by the name `input1`. By default it assigns the sim (simulator) architecture to it which allows you to build new projects and software on your native OS and try it out.
+show | Display the configuration defined for the target named `input1`. If no `input1` is specified then show the details for all the targets in the nest.
+build | Build the source code into an image that can be loaded on the hardware associated with the target named `input1` to do the application enabled by the 'project' associated with that target (via the target definition). It creates 'bin/' and 'bin/<input1>/' subdirectories inside the base directory for the project, compiles and generates binaries and executables, and places them in 'bin/<input1>/.
+test | Test an egg on the target named `input1`. The egg is either supplied as an argument to the command line invocation of `newt target test` or added as part of the target definition. If only the target is specified as `input1`, then the egg in the target's definition is automatically chosen to be tested. You currently cannot test an entire project on a hardware target. The test command is envisioned for use if one or two eggs gets updated and each needs to be tested against a target. Alternatively, a script may be written for a series of tests on several eggs.
+export | Exports the configurations of the specified target `input1`. If -a or -export-all flag is used, then all targets are exported and printed out to standard out. You may redirect the output to a file.
+import | Import one or more target configuration from standard input or a file. Each target starts with `@target=<target-name>` followed by the attributes. The list of targets should end with `@endtargets`.
+size | Outputs the RAM and flash consumption by the components of the specified target `input1`.
+download | Downloads the binary executable `<target-name>.elf.bin` to the board.
+debug | Downloads the binary executable `<target-name>.elf.bin` to the board and starts up the openocd/gdb combination session. gdb takes over the terminal.
+
+
+Command-specific flags
+
+Sub-command | Available flags | Explanation
+-------------| ----------------|------------
+build | clean | All the binaries and object files for the specified target will be removed. The subdirectory named after the specified target within that project is removed.
+build clean | all | All the binaries and object files for all targets are removed, and subdirectories of all targets for the project are removed. However, the entire repository is not emptied since any eggs or projects that the specified target doesn't reference are not touched.
+export | -a, -export-all | Export all targets. `input1` is not necessary when this flag is used.
+import | -a, -import-all | Import all targets typed into standard input or redirected from a file.
+
+Examples
+
+ Sub-command | Usage | Explanation
+-------------| -----------------------|-----------------
+set | newt target set myblinky compiler=arm-none-eabi-m4 | Set the compiler for the 'myblinky' target to the gcc compiler for embedded ARM chips.
+unset | newt target unset myblinky compiler | Remove the setting for the compiler for the 'myblinky' target.
+delete | newt target delete myblinky | Delete the target description for the target named 'myblinky'. Note that it does not remove any binaries or clean out the directory for this target.
+create | newt target create blink_f3disc | Create a new target description by the name 'blink_f3disc'. The architecture is 'sim' by default and can be changed using subcommand 'set' above.
+show | newt target show myblinky | Show the target attributes set for 'myblinky'
+build | newt target build blink_f3disc | Compile the source code for the target named blink_f3disc and generate binaries that can be loaded into the target hardware.
+test | newt target test test_target egg=libs/os | Tests the egg named 'libs/os' against the target named 'test_target'
+export | newt target export -a > my_exports.txt | Export all build targets from the current nest, and redirect output to a file named 'my_exports.txt'.
+export | newt target export -export-all | Export all build targets from the current nest, and print them to standard output on the screen.
+export | newt target export my_target | Export only target named 'my_target' and print it to standard output on the screen.
+import | newt target import ex_tgt_1 < exported_targets.txt | Imports the target configuration for 'ex_tgt_1' in 'exported_targets.txt'.
+import | newt target import -a < in_targets.txt | Imports all the targets specified in the file named `in_targets.txt`. A sample file is shown after this table.
+size | newt target size blink_nordic | Inspects and lists the RAM and Flash memory use by each component (object files and libraries) of the target.
+download | newt target -v -lVERBOSE download blinky | Downloads `blinky.elf.bin` to the hardware in verbose mode with logging turned on at VERBOSE level.
+debug | newt target debug blinky | Downloads `blinky.elf.bin` to the hardware, opens up a gdb session with `blinky.elf` in the terminal, and halts for further input in gdb.
+
+Example content for `in_targets.txt` file used for importing targets `test3` and `test4`.
+
+> @target=test3
+project=blinked
+arch=sim
+compiler_def=debug
+compiler=arm-none-eabi-m4
+@target=test4
+project=super_blinky
+arch=sim
+compiler_def=debug
+compiler=arm-none-eabi-m4
+@endtargets
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/callout.md
----------------------------------------------------------------------
diff --git a/docs/os/callout.md b/docs/os/callout.md
new file mode 100644
index 0000000..a7f1d1a
--- /dev/null
+++ b/docs/os/callout.md
@@ -0,0 +1,149 @@
+# Callout
+
+
+
+
+## Description
+
+Describe OS feature here
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [os_callout_init](#function-os_callout_init)
+* [os_callout_func_init](#function-os_callout_func_init)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function os_callout_init</font>
+
+```
+ void
+ os_callout_init(struct os_callout *c, struct os_eventq *evq, void *ev_arg)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_callout_func_init</font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/context_switch.md
----------------------------------------------------------------------
diff --git a/docs/os/context_switch.md b/docs/os/context_switch.md
new file mode 100644
index 0000000..d2e8b80
--- /dev/null
+++ b/docs/os/context_switch.md
@@ -0,0 +1,149 @@
+# Scheduler/Context Switching
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe scheduler here
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in the scheduler are:
+
+* [os_sched_insert](#function-os_sched_insert)
+* [os_sched_walk](#function-os_sched_walk)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function os_sched_insert</font>
+
+```
+ os_error_t
+ os_sched_insert(struct os_task *t)
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_sched_walk</font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/event_queue.md
----------------------------------------------------------------------
diff --git a/docs/os/event_queue.md b/docs/os/event_queue.md
new file mode 100644
index 0000000..6de4adb
--- /dev/null
+++ b/docs/os/event_queue.md
@@ -0,0 +1,149 @@
+# Event Queues
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe scheduler here
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [os_eventq_init](#function-os_eventq_init)
+* [os_eventq_put2](#function-os_eventq_put2)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function os_eventq_init</font>
+
+```
+ void
+ os_eventq_init(struct os_eventq *evq)
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_eventq_put2</font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/heap.md
----------------------------------------------------------------------
diff --git a/docs/os/heap.md b/docs/os/heap.md
new file mode 100644
index 0000000..b960c26
--- /dev/null
+++ b/docs/os/heap.md
@@ -0,0 +1,149 @@
+# Heap
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe OS feature here
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [os_malloc_lock](#function-os_malloc_lock)
+* [os_malloc_unlock](#function-os_malloc_unlock)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function os_malloc_lock</font>
+
+```
+ static void
+ os_malloc_lock(void)
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_malloc_unlock</font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/mbufs.md
----------------------------------------------------------------------
diff --git a/docs/os/mbufs.md b/docs/os/mbufs.md
new file mode 100644
index 0000000..c2938fc
--- /dev/null
+++ b/docs/os/mbufs.md
@@ -0,0 +1,150 @@
+# Mbufs
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe OS feature here
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [os_mbuf_pool_init](#function-os_mbuf_pool_init)
+* [os_mbuf_get](#function-os_mbuf_get)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function os_mbuf_pool_init</font>
+
+```
+ 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)
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_mbuf_get</font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/memory_pool.md
----------------------------------------------------------------------
diff --git a/docs/os/memory_pool.md b/docs/os/memory_pool.md
new file mode 100644
index 0000000..4048648
--- /dev/null
+++ b/docs/os/memory_pool.md
@@ -0,0 +1,151 @@
+# Memory Pools
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe OS feature here
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [os_mempool_init](#function-os_mempool_init)
+* [os_memblock_get](#function-os_memblock_get)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function os_mempool_init</font>
+
+```
+ os_error_t
+ os_mempool_init(struct os_mempool *mp, int blocks,
+ int block_size, void *membuf, char *name)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_memblock_get</font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/mutex.md
----------------------------------------------------------------------
diff --git a/docs/os/mutex.md b/docs/os/mutex.md
new file mode 100644
index 0000000..0e0c329
--- /dev/null
+++ b/docs/os/mutex.md
@@ -0,0 +1,150 @@
+# Mutex
+
+
+Mutex is short for "mutual exclusion"; a mutex provides mutually exclusive access to a shared resource. A mutex provides *priority inheritance* in order to prevent *priority inversion*. Priority inversion occurs when a higher priority task is waiting on a resource owned by a lower priority task. Using a mutex, the lower priority task will inherit the highest priority of any task waiting on the mutex.
+
+
+## Description
+
+Describe OS feature here
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [os_mutex_init](#function-os_mutex_init)
+* [os_mutex_release](#function-os_mutex_release)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function os_mutex_init</font>
+
+```
+ os_error_t
+ os_mutex_init(struct os_mutex *mu)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_mutex_release</font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/mynewt_os.md
----------------------------------------------------------------------
diff --git a/docs/os/mynewt_os.md b/docs/os/mynewt_os.md
new file mode 100644
index 0000000..f1865c4
--- /dev/null
+++ b/docs/os/mynewt_os.md
@@ -0,0 +1,167 @@
+# Mynewt OS
+
+Insert introduction here
+
+## Real-Time Kernel <Modify as you Wish>
+
+ Description
+
+## Real-Time OS <Modify as you Wish>
+
+ Description
+
+
+## Insert topic of your choice
+
+ Description
+
+## Features
+
+<Insert basic feature descriptions, how the various pieces fit together etc., what's special in Mynewt OS>
+
+* [Scheduler/context switching](context_switch.md)
+* [Time](time.md)
+* [Tasks](task.md)
+* [Event queues/callouts](event_queue.md)
+* [Semaphores](semaphore.md)
+* [Mutexes](mutex.md)
+* [Memory pools](memory_pool.md)
+* [Heap](heap.md)
+* [Mbufs](mbufs.md)
+* [Sanity](sanity.md)
+* [Porting OS to other platforms](port_os.md)
+
+## OS Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [os_idle_task](#function-os_idle_task)
+* [os_started](#function-os_started)
+* add the rest
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function os_idle_task</font>
+
+```
+ void
+ os_idle_task(void *arg)
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_started</font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/port_os.md
----------------------------------------------------------------------
diff --git a/docs/os/port_os.md b/docs/os/port_os.md
new file mode 100644
index 0000000..1331dde
--- /dev/null
+++ b/docs/os/port_os.md
@@ -0,0 +1,12 @@
+# Porting Mynewt OS
+
+
+This chapter describes how to adapt Newt OS to different processors. Adapting μC/OS-III to a microprocessor or a microcontroller is called porting.
+
+
+## Description
+
+
+## Insert sections as you wish
+
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/sanity.md
----------------------------------------------------------------------
diff --git a/docs/os/sanity.md b/docs/os/sanity.md
new file mode 100644
index 0000000..8b021f4
--- /dev/null
+++ b/docs/os/sanity.md
@@ -0,0 +1,150 @@
+# Sanity
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe OS feature here
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [os_sanity_check_init](#function-os_sanity_check_init)
+* [os_sanity_check_list_lock](#function-os_sanity_check_list_lock)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function os_sanity_check_init</font>
+
+```
+ int
+ os_sanity_check_init(struct os_sanity_check *sc)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_sanity_check_list_lock </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/semaphore.md
----------------------------------------------------------------------
diff --git a/docs/os/semaphore.md b/docs/os/semaphore.md
new file mode 100644
index 0000000..c05a1a8
--- /dev/null
+++ b/docs/os/semaphore.md
@@ -0,0 +1,149 @@
+# Semaphore
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe OS feature here
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [os_sem_init](#function-os_sem_init)
+* [os_sem_release](#function-os_sem_release)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function os_sem_init</font>
+
+```
+ os_error_t
+ os_sem_init(struct os_sem *sem, uint16_t tokens)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_sem_release </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/task.md
----------------------------------------------------------------------
diff --git a/docs/os/task.md b/docs/os/task.md
new file mode 100644
index 0000000..52d6481
--- /dev/null
+++ b/docs/os/task.md
@@ -0,0 +1,149 @@
+# Tasks
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe OS feature here
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [_clear_stack](#function-_clear_stack)
+* [os_task_next_id](#function-os_task_next_id)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function _clear_stack </font>
+
+```
+ static void
+ _clear_stack(os_stack_t *stack_bottom, int size)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_task_next_id </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/os/time.md
----------------------------------------------------------------------
diff --git a/docs/os/time.md b/docs/os/time.md
new file mode 100644
index 0000000..5daf9e9
--- /dev/null
+++ b/docs/os/time.md
@@ -0,0 +1,149 @@
+# Time
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe OS feature here
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [os_time_get](#function-os_time_get)
+* [os_time_tick](#function-os_time_tick)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function os_time_get </font>
+
+```
+ os_time_t
+ os_time_get(void)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function os_time_tick </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/packaging/dist.md
----------------------------------------------------------------------
diff --git a/docs/packaging/dist.md b/docs/packaging/dist.md
new file mode 100644
index 0000000..e69de29
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index a05b1a0..53d25ad 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -3,44 +3,45 @@ site_url: http://mynewt.incubator.apache.org/index.html
pages:
- Home: 'index.md'
-- Chapter1 - Get Started:
- - 'Newt Concepts': 'chapter1/newt_concepts.md'
- - 'Blinky, The First Project': 'chapter1/project1.md'
- - 'How to edit docs': 'chapter1/how_to_edit_docs.md'
- - 'Sample doc to edit': 'chapter1/try_markdown.md'
-- Chapter2 - Get Acclimated:
- - 'Understanding Newt Terms': 'chapter2/vocabulary.md'
- - 'Project 2': 'chapter2/project2.md'
- - 'Project 3': 'chapter2/project3.md'
-- Chapter3 - Newt Tool:
- - 'Command structure': 'chapter3/newt_ops.md'
- - 'Command list': 'chapter3/newt_tool_reference.md'
-- Chapter4 - Newt OS:
- - 'Overview': 'chapter4/mynewt_os.md'
- - 'Scheduler/Context Switching': 'chapter4/context_switch.md'
- - 'Time': 'chapter4/time.md'
- - 'Tasks': 'chapter4/task.md'
- - 'Event Queues': 'chapter4/event_queue.md'
- - 'Semaphores': 'chapter4/semaphore.md'
- - 'Mutexes': 'chapter4/mutex.md'
- - 'Memory Pools': 'chapter4/memory_pool.md'
- - 'Heap': 'chapter4/heap.md'
- - 'Mbufs': 'chapter4/mbufs.md'
- - 'Sanity': 'chapter4/sanity.md'
- - 'Porting to other Platforms': 'chapter4/port_os.md'
+- Get Started:
+ - 'Newt Concepts': 'get_started/newt_concepts.md'
+ - 'Blinky, The First Project': 'get_started/project1.md'
+ - 'How to edit docs': 'get_started/how_to_edit_docs.md'
+ - 'Sample doc to edit': 'get_started/try_markdown.md'
+- Get Acclimated:
+ - 'Understanding Newt Terms': 'get_acclimated/vocabulary.md'
+ - 'Project 2': 'get_acclimated/project2.md'
+ - 'Project 3': 'get_acclimated/project3.md'
+- Newt Tool:
+ - 'Command structure': 'newt/newt_ops.md'
+ - 'Command list': 'newt/newt_tool_reference.md'
+- Mynewt OS:
+ - 'Overview': 'os/mynewt_os.md'
+ - 'Scheduler/Context Switching': 'os/context_switch.md'
+ - 'Time': 'os/time.md'
+ - 'Tasks': 'os/task.md'
+ - 'Event Queues': 'os/event_queue.md'
+ - 'Semaphores': 'os/semaphore.md'
+ - 'Mutexes': 'os/mutex.md'
+ - 'Memory Pools': 'os/memory_pool.md'
+ - 'Heap': 'os/heap.md'
+ - 'Mbufs': 'os/mbufs.md'
+ - 'Sanity': 'os/sanity.md'
+ - 'Callout Functions': 'os/callout.md'
+ - 'Porting to other Platforms': 'os/port_os.md'
- Chapter5 - Modules:
- - 'Console': 'chapter5/console.md'
- - 'Shell': 'chapter5/shell.md'
- - 'Bootloader': 'chapter5/bootloader.md'
- - 'File System': 'chapter5/filesystem.md'
- - 'Test Utilities': 'chapter5/testutil.md'
+ - 'Console': 'modules/console.md'
+ - 'Shell': 'modules/shell.md'
+ - 'Bootloader': 'modules/bootloader.md'
+ - 'File System': 'modules/filesystem.md'
+ - 'Test Utilities': 'modules/testutil.md'
- Chapter6 - Packaging it:
- - 'Creating Packages': 'chapter6/dist.md'
+ - 'Creating Packages': 'packaging/dist.md'
markdown_extensions:
- toc:
permalink: true
- sane_lists
-theme: readthedocs
+theme: readthedocs
extra_css: [extra.css]
[10/11] incubator-mynewt-site git commit: .DS_Store to be ignored
Posted by ad...@apache.org.
.DS_Store to be ignored
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/6350a43a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/6350a43a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/6350a43a
Branch: refs/heads/master
Commit: 6350a43a1ba0696c112da0e4e585a2e357dab0f2
Parents: 0108b7d
Author: aditihilbert <ad...@runtime.io>
Authored: Fri Dec 18 11:34:59 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Fri Dec 18 11:34:59 2015 -0800
----------------------------------------------------------------------
docs/.DS_Store | Bin 6148 -> 6148 bytes
1 file changed, 0 insertions(+), 0 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6350a43a/docs/.DS_Store
----------------------------------------------------------------------
diff --git a/docs/.DS_Store b/docs/.DS_Store
index 260ae9d..d0c74e3 100644
Binary files a/docs/.DS_Store and b/docs/.DS_Store differ
[05/11] incubator-mynewt-site git commit: fixed anchors in project
Blinky - still need to update Windows instructions for hardware target
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter5/bootloader.md
----------------------------------------------------------------------
diff --git a/docs/chapter5/bootloader.md b/docs/chapter5/bootloader.md
deleted file mode 100644
index 381630a..0000000
--- a/docs/chapter5/bootloader.md
+++ /dev/null
@@ -1,148 +0,0 @@
-# Bootloader
-
-Insert synopsis here
-
-
-## Description
-
-Describe module here, special features, how pieces fit together etc.
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [boot_slot_addr](#function-boot_slot_addr)
-* [boot_find_image_slot](#function-boot_find_image_slot)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function boot_slot_addr </font>
-
-```
- static void
- boot_slot_addr(int slot_num, uint8_t *flash_id, uint32_t *address)
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function boot_find_image_slot </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter5/console.md
----------------------------------------------------------------------
diff --git a/docs/chapter5/console.md b/docs/chapter5/console.md
deleted file mode 100644
index 4e0bd73..0000000
--- a/docs/chapter5/console.md
+++ /dev/null
@@ -1,546 +0,0 @@
-# Console
-
-
-The console is an operating system window where users interact with system programs of the operating system or a console application by entering text input (typically from a keyboard) and reading text output (typically on the computer terminal). The text written on the console brings some information and is a sequence of characters sent by the OS or programs running on the OS.
-
-Support is currently available for console access via the serial port on the hardware board.
-
-
-## Description
-
-In the Mynewt OS, the console library comes in two versions:
-
-* full - containing the full implementation
-* stub - containing stubs for the API
-
-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:
-
- egg.name: libs/shell
- egg.vers: 0.1
- egg.deps:
- - libs/console/full
- - libs/os
- egg.identities:
- - SHELL
-
-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 `libs/os` egg that can print out messages on a console (e.g. if there is a hard fault) and the `libs/util` 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:
-
- project.name: boot
- project.identities: bootloader
- project.eggs:
- - libs/os
- - libs/bootutil
- - libs/nffs
- - libs/console/stub
- - libs/util
-
-## Data structures
-
-
-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 `cr_tail` and the write location indicator the `cr_head`. The console ring length is variable and is specified as the `cr_size` member of the data structure. `cr_buf` is the pointer to the actual array of data contained.
-
-
-```
-struct console_ring {
- 32 uint8_t cr_head;
- 33 uint8_t cr_tail;
- 34 uint8_t cr_size;
- 35 uint8_t _pad;
- 36 uint8_t *cr_buf;
- 37 }
-```
-
-
-```
-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;
- 43 uint8_t ct_rx_buf[CONSOLE_RX_BUF_SZ]; /* must be after console_ring */
- 44 console_rx_cb ct_rx_cb; /* callback that input is ready */
- 45 console_write_char ct_write_char;
- 46 } console_tty
-```
-
-## List of Functions
-
-The functions available in console are:
-
-* [console_printf](#function-console_printf)
-* [console_add_char](#function-console_add_char)
-* [console_pull_char](#function-console_pull_char)
-* [console_pull_char_head](#function-console_pull_char_head)
-* [console_queue_char](#function-console_queue_char)
-* [console_blocking_tx](#function-console_blocking_tx)
-* [console_blocking_mode](#function-console_blocking_mode)
-* [console_write](#function-console_write)
-* [console_read](#function-console_read)
-* [console_tx_char](#function-console_tx_char)
-* [console_rx_char](#function-console_rx_char)
-* [console_init](#function-console_init)
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function console_printf</font>
-
-```
- void
- console_printf(const char *fmt, ...)
-```
-
-Writes a formatted message instead of raw output to the console. It first composes a C string containing text specified as arguments to the function or containing the elements in the variable argument list passed to it using snprintf or vsnprintf, respectively. It then uses function `console_write` to output the formatted data (messages) on the console.
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| fmt | Pointer to C string that contains a format string that follows the same specifications as format in printf. The string is printed to console. |
-| ... | Depending on the format string, the function may expect either a sequence of additional arguments to be used to replace a format specifier in the format string or a variable arguments list. va_list is a special type defined in <cstdarg> in stdarg.h. |
-
-#### Returned values
-
-None
-
-#### Notes
-
-While `console_printf`, with its well understood formatting options in C, is more convenient and easy on the eyes than the raw output of `console_write`, the associated code size is considerably larger.
-
-#### Example
-Example #1:
-
-```
-char adv_data_buf[32];
-
-void
-task()
-{
- char adv_data_buf[32];
-
- console_printf("%s", adv_data_buf);
-}
-```
-
-Example #2:
-
-```
-struct exception_frame {
- uint32_t r0;
- uint32_t r1;
-
-struct trap_frame {
- struct exception_frame *ef;
- uint32_t r2;
- uint32_t r3;
-};
-
-void
-task(struct trap_frame *tf)
-{
- console_printf(" r0:%8.8x r1:%8.8x", tf->ef->r0, tf->ef->r1);
- console_printf(" r8:%8.8x r9:%8.8x", tf->r2, tf->r3);
-}
-```
-
----------------------
-
-### <font color="#2980b9"> function console_add_char</font>
-
-```
- static void
- console_add_char(struct console_ring *cr, char ch)
-```
-
-Adds a character to the console ring buffer. When you store an item in the buffer you store it at the head location, and the head advances to the next location.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| *cr | Pointer to a console ring data structure whose `cr_head` variable is to be set to the second argument in this function call|
-| ch | Character to be inserted to the ring |
-
-#### Returned values
-
-None
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Add a new line character to the output (transmit) buffer.
-
-```
-void
-task()
-{
- struct console_ring *tx = &ct->ct_tx;
-
- console_add_char(tx, '\n');
-}
-```
-
--------------------
-
-### <font color="#2980b9"> function console_pull_char </font>
-
-```
- static uint8_t
- console_pull_char(struct console_ring *cr)
-```
-
-Reads (remove) a byte from the console ring buffer. When you read (pull) an item, you read it at the current tail location, and the tail advances to the next position.
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| *cr | Pointer to the console ring buffer from where a character is to be removed |
-
-
-#### Returned values
-
-Returns the character pulled from the ring buffer.
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Read the characters in the ring buffer into a string.
-
-```
-void
-task(struct console_ring *cr, char *str, int cnt)
-{
- for (i = 0; i < cnt; i++) {
- if (cr->cr_head == cr->cr_tail) {
- i = -1;
- break;
- }
- ch = console_pull_char(cr);
- *str++ = ch;
- }
-}
-```
-
----------------
-
-### <font color="#2980b9"> function console_pull_char_head </font>
-
-```
- static void
- console_pull_char_head(struct console_ring *cr)
-```
-
-Removes the last character inserted into the ring buffer by moving back the head location and shrinking the ring size by 1.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| cr | Pointer to the console ring buffer from which the last inserted character must be deleted |
-
-
-#### Returned values
-
-None
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-In order to see a character getting deleted when a user hits backspace while typying a command, the following needs to happen in sequence:
-
-* output a backspace (move cursor back one character)
-* output space (erasing whatever character there was before)
-* output backspace (move cursor back one character)
-* remove the previous character from incoming RX queue
-
-The example below shows console_pull_char_head being used for the last step.
-
-```
-void
-task(uint8_t data)
-{
- struct console_tty *ct = (struct console_tty *)arg;
- struct console_ring *tx = &ct->ct_tx;
- struct console_ring *rx = &ct->ct_rx;
-
- switch (data) {
- case '\b':
- console_add_char(tx, '\b');
- console_add_char(tx, ' ');
- console_add_char(tx, '\b');
- console_pull_char_head(rx);
- break;
- }
-}
-
-```
-
--------------
-
-### <font color="#2980b9"> function console_queue_char </font>
-
-```
- static void
- console_queue_char(char ch)
-```
-
-Manage the buffer queue before inserting a character into it. If the head of the output (transmit) console ring is right up to its tail, the queue needs to be drained first before any data can be added. Then it uses console_add_char function to add the character.
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| ch | Character to be inserted to the queue |
-
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-This function makes sure no interrupts are allowed while the transmit buffer is draining and the character is being added.
-
-#### Example
-
-```
-Insert example
-```
-------------------
-
-### <font color="#2980b9"> function console_blocking_tx </font>
-
-```
- static void
- console_blocking_tx(char ch)
-```
-
- Calls the hal function hal_uart_blocking_tx to transmit a byte to the console over UART in a blocking mode until the character has been sent. Hence it must be called with interrupts disabled. It is used when printing diagnostic output from system crash.
-
-#### Arguments
-
-| Arguments | Description |
-|-------------------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Give at least one example of usage.
-
------------
-
-### <font color="#2980b9"> function console_blocking_mode </font>
-
-```
- void
- console_blocking_mode(void)
-```
- Calls the console_blocking_tx function to flush the buffered console output (transmit) queue. The function OS_ENTER_CRITICAL() is called to disable interrupts and OS_EXIT_CRITICAL() is called to enable interrupts back again once the buffer is flushed.
-
-#### Arguments
-
-| Arguments | Description |
-|-------------------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Give at least one example of usage.
-
-
-### <font color="#2980b9">function console_write </font>
-
-```
- void
- console_write(char *str, int cnt)
-```
-Transmit characters to console display over serial port.
-
-#### Arguments
-
-| Arguments | Description |
-|-------------------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Give at least one example of usage.
-
-
-### <font color="#2980b9"> function console_read </font>
-
-```
- int
- console_read(char *str, int cnt)
-```
- Calls hal function hal_uart_start_rx to start receiving input from console terminal over serial port.
-
-#### Arguments
-
-| Arguments | Description |
-|-------------------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Give at least one example of usage.
-
-
-### <font color="#2980b9"> function console_tx_char </font>
-
- ```
- static int
- console_tx_char(void *arg)
- ```
-
-#### Arguments
-
-| Arguments | Description |
-|-------------------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Give at least one example of usage.
-
-
-### <font color="#2980b9"> function console_rx_char </font>
-
-```
- static int
- console_rx_char(void *arg, uint8_t data)
-```
-
-#### Arguments
-
-| Arguments | Description |
-|-------------------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Give at least one example of usage.
-
-
-### <font color="#2980b9"> function console_init </font>
-
-```
- int
- console_init(console_rx_cb rx_cb)
-```
-
- Initializes console receive buffer and calls hal funtions hal_uart_init_cbs and hal_uart_config to initialize serial port connection and configure it (e.g. baud rate, flow control etc.)
-
-#### Arguments
-
-| Arguments | Description |
-|-------------------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-Give at least one example of usage.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter5/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/chapter5/filesystem.md b/docs/chapter5/filesystem.md
deleted file mode 100644
index dc1ad43..0000000
--- a/docs/chapter5/filesystem.md
+++ /dev/null
@@ -1,149 +0,0 @@
-# Filesystem
-
-
-Insert synopsis here
-
-
-## Description
-
-Describe module here, special features, how pieces fit together etc.
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [nffs_lock](#function-nffs_lock)
-* [nffs_unlock](#function-nffs_unlock)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function nffs_lock </font>
-
-```
- static void
- nffs_lock(void)
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function nffs_unlock </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter5/shell.md
----------------------------------------------------------------------
diff --git a/docs/chapter5/shell.md b/docs/chapter5/shell.md
deleted file mode 100644
index 1b2928a..0000000
--- a/docs/chapter5/shell.md
+++ /dev/null
@@ -1,147 +0,0 @@
-# Shell
-
-Insert synopsis here
-
-
-## Description
-
-Describe module here, special features, how pieces fit together etc.
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [shell_cmd_list_lock](#function-shell_cmd_list_lock)
-* [shell_cmd_list_unlock](#function-shell_cmd_list_unlock)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function shell_cmd_list_lock </font>
-
-```
- static int
- shell_cmd_list_lock(void)
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function shell_cmd_list_unlock </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter5/testutil.md
----------------------------------------------------------------------
diff --git a/docs/chapter5/testutil.md b/docs/chapter5/testutil.md
deleted file mode 100644
index 601ed02..0000000
--- a/docs/chapter5/testutil.md
+++ /dev/null
@@ -1,149 +0,0 @@
-# testutil
-
-
-Insert synopsis here
-
-
-## Description
-
-Describe module here, special features, how pieces fit together etc.
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [tu_init](#function-tu_init)
-* [tu_restart](#function-tu_restart)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function tu_init </font>
-
-```
- int
- tu_init(void)
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function tu_restart </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter6/dist.md
----------------------------------------------------------------------
diff --git a/docs/chapter6/dist.md b/docs/chapter6/dist.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_acclimated/pics/STM32f3discovery_connector.png
----------------------------------------------------------------------
diff --git a/docs/get_acclimated/pics/STM32f3discovery_connector.png b/docs/get_acclimated/pics/STM32f3discovery_connector.png
new file mode 100644
index 0000000..1f4437a
Binary files /dev/null and b/docs/get_acclimated/pics/STM32f3discovery_connector.png differ
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_acclimated/project2.md
----------------------------------------------------------------------
diff --git a/docs/get_acclimated/project2.md b/docs/get_acclimated/project2.md
new file mode 100644
index 0000000..3a6e5a6
--- /dev/null
+++ b/docs/get_acclimated/project2.md
@@ -0,0 +1,374 @@
+## Project 2 - Blinky on additional boards
+
+### Objective
+
+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. In the process you will be exposed to more Mynewt terms and Newt tool commands.
+
+The following target hardware chips are covered:
+
+* [STM32F303VC MCU](#stm32f303vc-mcu) from STMicroelectronics
+* [nRF52 Series](#nrf52-series) from Nordic Semiconductors
+
+
+### STM32F303VC MCU
+
+#### Hardware needed
+
+* Discovery kit with STM32F303VC MCU
+* Laptop running Mac OS
+
+
+#### Step by Step Instructions to build image
+
+* 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.
+
+ [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
+
+
+* 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 (`clutch.yml`) 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.
+
+ [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.
+
+* 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.
+
+ [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!
+
+* It's time to create a target for the project and define the target attributes.
+
+ [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
+
+* 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 [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)
+
+* 
+
+
+ [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!
+
+* Finally, you have to download the image on to the board. You will see a blue light start to blink.
+
+ [user:~/dev/test_project]$ newt target download blink_f3disc
+ Downloading with /Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3discovery_download.sh
+
+
+
+### nRF52 Series
+
+
+#### Hardware needed
+
+* nRF52 Development Kit
+* Laptop running Mac OS
+
+
+#### Step by Step Instructions to build image
+
+* The first step is to download the generic skeleton of the project. The eggs installed are not hardware architecture specific.
+
+ []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/
+
+
+* 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 (`clutch.yml`) 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.
+
+ []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.
+
+* 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.
+
+ [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!
+
+
+* It's time to create a target for the project and define the target attributes.
+
+ [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
+
+
+* 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.
+
+ [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!
+
+* 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 [https://www.segger.com/jlink-software.html](https://www.segger.com/jlink-software.html). The command line version of the server is used in the steps below.
+
+* Open a new terminal and start a J-Link session.
+
+ [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
+
+
+* 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.
+
+ [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
+
+* Start the gdb session and monitor that it loads the image, resets the target, and halts for a command to continue.
+
+ [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 ***
+
+* 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.
+
+ (gdb) c
+ Continuing.
+
+
+
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_acclimated/project3.md
----------------------------------------------------------------------
diff --git a/docs/get_acclimated/project3.md b/docs/get_acclimated/project3.md
new file mode 100644
index 0000000..43e6a59
--- /dev/null
+++ b/docs/get_acclimated/project3.md
@@ -0,0 +1 @@
+## How to Test an Egg
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_acclimated/vocabulary.md
----------------------------------------------------------------------
diff --git a/docs/get_acclimated/vocabulary.md b/docs/get_acclimated/vocabulary.md
new file mode 100644
index 0000000..5e6b792
--- /dev/null
+++ b/docs/get_acclimated/vocabulary.md
@@ -0,0 +1,170 @@
+## Understanding Newt Terms
+
+### Nest
+
+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.
+
+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 [eggs](#egg). A project could be an egg itself as well. In addition to eggs, a local nest will contain additional items such as [target](#target) or build definitions, clutch description files, scripts etc.
+
+For example, a walk through the "larva" nest at [https://github.com/mynewt/larva.git](https://github.com/mynewt/larva.git) 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.
+
+```
+larva
+ |- nest.yml
+ |- compiler
+ |- arm-none-eabi-m4
+ |- sim
+ |- hw (hardware)
+ |- bsp (board support package)
+ |- nrf52pdk (Nordic nRF52 series chip)
+ |- egg.yml
+ |- ...
+ |- olimex_stm32-e407_devboard (used in chapter1 project)
+ |- egg.yml
+ |- ...
+ |- stm32f3discovery (another board with stm32f3 mcu)
+ |- egg.yml
+ |- ...
+ |- yet another board
+ |- egg.yml
+ |- ...
+ |- hal (hardware abstraction layer APIs)
+ |- egg.yml
+ |- include
+ |- hal_cputime.h
+ |- hal_flash.h
+ |- hal_gpio.h
+ |- ... (header files for other peripherals)
+ |- mcu (microcontroller)
+ |- stm (STMicro family)
+ |- stm32f3xx (STM32f3 series, 32-bit ARM Cortex-M4 core)
+ |- egg.yml
+ |- src
+ |- hal_gpio.c (specific to the STM32f3 mcu)
+ |- hal_cputime.c
+ |- ... (code for other peripherals)
+ |- nordic (Nordic Semiconductor family)
+ |- nrf52xxx (nRF52 Series SoC, Cortex-M4F core)
+ |- egg.yml
+ |- src
+ |- hal_gpio.c (specific to the nRF52 mcu )
+ |- hal_cputime.c
+ |- ... (code for other peripherals)
+ |- yet another family of mcu
+ |- ...
+ |- libs
+ |- bootutil (hw architecture independent boot loader library)
+ |- egg.yml
+ |- src
+ |- loader.c
+ |- ... (related source code files)
+ |- nffs (hw architecture independent Newtron Flash File System)
+ |- egg.yml
+ |- src
+ |- nffs.c
+ |- ... (related source code files)
+ |- another library
+ |- egg.yml
+ |- src
+ |- ... (related source code files)
+ |- project
+ |- scripts
+
+
+```
+
+The newt tool offers the `nest` 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 `nest` command can be found in the newt tool reference in Chapter 3.
+
+ newt nest [flags]
+ newt nest [child-commands]
+
+A complete list of all the nest commands can be found in the newt tool reference in [Chapter 3](../chapter3/newt_tool_reference.md).
+
+### Project
+
+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.
+
+Layout-wise, a project is a directory inside a nest and contains eggs required for a certain application. For example, the `blinky` egg sits in `project/blinky` directory of the `larva` nest. This egg is used in the blinky project (application) outlined in [Chapter 1](../chapter1/project1.md). <*Note: This Will Change*>
+
+A project has the following concepts or properties associated with it. You can find them in the `<project-name>.yml` file in the project directory. For example, the `project/blinky` directory has the `blinky.yml` 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.
+
+* Project name
+* Base path of the project (nest/project/project-name by default)
+* Eggs belonging to the project
+* [Capabilities](#capabilities) that are required for the project or target
+* [Identity](#identity) to classify the type of project or target
+* Compiler flags to call out any specific compiler requirement
+
+A project could itself be an egg if it is a distributable package for a specific application.
+
+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.
+
+ newt egg install [flags] <project egg name>
+
+### Egg
+
+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.
+
+The two main directories in an egg are `/include` and `/src`.
+
+The newt tool offers several egg commands to list, inspect, install, and do other operations on eggs. For example, the following command
+
+ newt egg list
+
+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.
+
+ Egg libs/os, version 0.1.0
+ path: /Users/aditihilbert/dev/test_project/libs/os
+ deps: libs/testutil@none#stable
+
+A complete list of all the egg commands can be found in the newt tool reference in [Chapter 3](../chapter3/newt_tool_reference.md).
+
+### Clutch
+
+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 `clutch.yml` 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 ]
+
+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 `.nest/clutches` directory in your nest.
+
+The newt tool offers clutch management commands within the `newt nest` 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 `clutch.yml` file in the nest.
+
+ newt nest generate-clutch <name> <url>
+
+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.
+
+### Eggshell
+
+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.
+
+ newt nest list-clutches
+
+So, if you had two clutches installed, the output could be:
+
+ Remote clutch larva (eggshells: 19)
+ Remote clutch ble_test (eggshells: 15)
+
+### Target
+
+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.
+
+ blink_f3disc
+ compiler_def: debug
+ compiler: arm-none-eabi-m4
+ name: blink_f3disc
+ arch: cortex_m4
+ project: blinky
+ bsp: hw/bsp/stm32f3discovery
+
+The newt tool offers commands to create, set up and manipulate targets. For example, the create command below creates an empty target named `my_target1` and the set command sets one detail of its definition, namely the architecture.
+
+ newt target create my_target1
+ newt target set my_target1 arch=cortex_m4
+
+### Capability
+
+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.
+
+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.
+
+### Identity
+
+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.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_started/how_to_edit_docs.md
----------------------------------------------------------------------
diff --git a/docs/get_started/how_to_edit_docs.md b/docs/get_started/how_to_edit_docs.md
new file mode 100644
index 0000000..69c7743
--- /dev/null
+++ b/docs/get_started/how_to_edit_docs.md
@@ -0,0 +1,187 @@
+## How to Edit Docs
+
+### Objective
+
+We will go through the process of downloading existing doccumentation and adding some content to a test document.
+
+### Markdown, MkDocs, Mou
+
+The Mynewt documentation you see on the Apache incubator website is a bunch of HTML files generated using MkDocs which is a simple static site generation tool geared towards building project documentation. You can read about it at [http://www.mkdocs.org](http://www.mkdocs.org). Documentation source files are written in Markdown, and configured with a single YAML configuration file. Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats using a tool (which in our case is MkDocs).
+
+You do not need to install MkDocs unless you want to actually render your documentation in HTML in order to preview it before pushing your content to the remote repository. Typically, using a Markdown editor such as [Mou](http://25.io/mou/) is enough to check how it will look after the document has gone through MkDocs. Go ahead and download [Mou](http://25.io/mou/). If you are on a Windows machine, download the [editor of your choice](http://alternativeto.net/software/mou/?platform=windows).
+
+Currently someone in the project is designated to use MkDocs to generate the HTML pages periodically after changes have been reviewed and accepted into the master branch.
+
+
+### Access to the Apache repo
+
+Get 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.
+
+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 [https://git-wip-us.apache.org/docs/workflow.html](https://git-wip-us.apache.org/docs/workflow.html). You will find the steps described in more detail later in this tutorial.
+
+### Making a local copy
+
+* 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.
+
+ $ 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
+
+* Create a new branch to work on your documentation and move to that branch.
+
+ $ git checkout -b <your-branch-name>
+
+
+### File to be edited
+
+The file you will edit is [try_markdown.md](./try_markdown.md).
+
+### Editing an existing page
+
+* Open the application Mou.
+
+* Open the file incubator-mynewt-site/docs/get_started/try_markdown.md in Mou.
+
+* Edit the last item on the list.
+
+* Save and quit the application.
+
+You may want to review the documentation organization back in [Home](../index.md) to remind you how to locate files easily. The corresponding directory tree structure is shown below.
+
+ .
+ ├── 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
+
+
+### Adding a new page
+
+If you create a new file somewhere in the `docs` subdirectory to add a new page, you have to add a line in the `mkdocs.yml` file at the correct level. For example, if you add a new module named "Ethernet" by creating a new file named `ethernet.md` in the `modules` subdirectory, you have to insert the following line under `Modules:` in the `mkdocs.yml` file.
+
+ - 'Ethernet': 'modules/ethernet.md'
+
+### Pushing changes to remote as a committer
+
+If you are not a committer yet, skip this section and proceed to the [next section](#sharing-changes-as-a-non-committer).
+
+* Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.
+
+ $ 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)
+
+* If, however, you do not see your remote repository, then set it up as follows.
+
+
+ $ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
+
+* First check the git status. It will show you that the `try_markdown.md` 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.
+
+ During staging below using `git add`, we use the `-A` 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 `-m`) should summarize what your changes are about.
+
+ $ git status
+ $ git add -A
+ $ git commit -m "My first doc change as a trial run"
+ $ git push -u origin <your-branch-name>
+
+* You can see the changed Markdown file if you traverse the tree on the git repository [ 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 commit notification automatically goes out to the commits@mynewt.incubator.apache.org mailing list. The "upstream" manager pulls the notified changes, reviews it, and merges it to the master branch if all is well. Otherwise you get an email for further changes.
+
+### Sharing changes as a non-committer
+
+We suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is [https://git-wip-us.apache.org/docs/workflow.html](https://git-wip-us.apache.org/docs/workflow.html).
+
+* Assuming you have made changes to the example file, you will first commit your changes.
+
+ $ git add -A
+ $ git commit -m "My first doc change as a trial run"
+
+* 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):
+
+ $ git format-patch origin/trunk
+
+* 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.
+
+ If there is a JIRA ticket associated with your work you should post your patch files to the ticket.
+
+
+### Conversion to HTML
+
+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.
+
+### Local preview of HTML files
+
+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).
+
+ $ python --version
+ Python 2.7.2
+ $ pip --version
+ pip 1.5.2
+ $ pip install mkdocs
+
+You will then run the built-in webserver from the root of the documentation directory using the command `mkdocs serve`. The root directory for documentation is `incubator-mynewt-site` or the directory with the `mkdocs.yml` file.
+
+ $ ls
+ docs images mkdocs.yml
+ $ mkdocs serve
+
+Then go to [http://127.0.0.1:8000](http://127.0.0.1:8000) to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be updated.
+
+For more information on MkDocs go to [http://www.mkdocs.org](http://www.mkdocs.org).
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_started/newt_concepts.md
----------------------------------------------------------------------
diff --git a/docs/get_started/newt_concepts.md b/docs/get_started/newt_concepts.md
new file mode 100644
index 0000000..6ac28da
--- /dev/null
+++ b/docs/get_started/newt_concepts.md
@@ -0,0 +1,48 @@
+## Newt Concepts
+
+This page introduces the basic terms you will need to find your way around the Mynewt ecosystem.
+
+### Basic components in the ecosystem
+
+* NewtOS is an open-source RTOS (Real Time Operating System) that works on a variety of hardware. The goal is to develop a pre-emptive, multitasking OS that is highly modular, making it possible to mix and match components to enable desired features and capabilities on multiple hardware architectures. Examples of components being worked on are the Core RTOS, a flash file system, utility functions, a variety of board support packages, packages of microcontrollers etc.
+
+
+* Network protocol stacks such as Bluetooth Low Energy, and more
+
+
+* Newt Tool helps you mix the specific packages for the combination of hardware and low-level embedded architecture features of the user's choice and generate the corresponding run-time image based on the NewtOS. It provides the infrastructure to manage and build for different CPU architectures, memory units, board support packages etc., allowing a user to formulate the contents according to the low-level features needed by his or her project.
+
+
+### Terminology
+
+A Mynewt user starts with a project in mind that defines the application or utility that he or she wants to implement on an embedded device. Making an LED blink on an electronics prototyping board is a common starter project. Enabling a BLE (Bluetooth Low Energy) peripheral mode on a development board is a more complex project. Specifying a project requires naming it, at the very least, and then adding the desired properties or attributes. In order to actualize a project, it needs to be applied to a target which is essentially a combination of some specified hardware and the execution environment.
+
+In the mynewt lifecycle, a project grows in a nest. A nest may house multiple projects. The nest is, therefore, a repository where various component packages for one or more projects reside. Each package is an egg (naturally!). However, in the world of Mynewt an egg may consist of other eggs! For example, the starter project Blinky is an egg consisting of several constituent eggs that enable core features. The egg form is suitable for elemental units of code as it explicitly exposes characteristics such as dependencies, versions, capabilities, requirements etc., thus making assembling appropriate components for a project and building an image for it easy to follow, modular, and robust.
+
+A nest can be given any name. For example, you will see a nest named "tadpole" in Mynewt ([https://git-wip-us.apache.org/repos/asf?p=incubator-mynewt-tadpole.git](https://git-wip-us.apache.org/repos/asf?p=incubator-mynewt-tadpole.git)). It contains all the core libraries of the operating system for the native platform which currently supports compilation on Mac OS X. The core libraries are contained in the form of eggs where an egg is a basic unit of implementation of any aspect of the RTOS. The eggs are distributed in the following directory structure inside the nest:
+
+* libs: contains the two eggs `os` and `testutil`
+* hw: contains three eggs - (i) `hal` which has the abstraction layer (HAL) API definitions that all BSP and MCU implementations must support, (ii) `/mcu/native` which in an MCU implementation for the native platform (a simulator, in this case), and (iii) `bsp/native` which is a BSP implementation for the native platform
+* compiler: contains the `sim` egg which bundles the compiler specifications for the native platform.
+
+Let's explore this sample nest a bit further. The `libs/os` egg contains code for scheduler, process/thread/memory management, semaphores etc. It is the core RTOS which ports to all supported chip platforms.The `libs/testutil` egg contains code for testing packages on hardware or simulated environment. The `hw/hal` egg contains header files that provide abstraction for physical hardware components such as GPIO (general purpose input/output), network adapters, timers, and UARTs. This `hw/hal` egg is an MCU peripheral abstraction designed to make it easy to port to different MCUs (microcontrollers). The `hw/mcu/native` egg contains code for microcontroller operations on the native platform. The `hw/bsp/native` egg contains the board support package for the native platform. And finally, the sixth egg `sim` contains the compiler specifications such as path and flags. Currently the compilation is supported on Mac OS X.
+
+You can see another nest in the mynewt ecosystem called the "larva". It was spawned from the skeletal "tadpole" nest using the newt tool. Spawning is easy - ` $ newt create nest <your_nest_name> `. "larva" is the developer's test repository containing all sorts of eggs being written and incubated, including ones to enhance the core operating system which should eventually make their way into the "tadpole" nest. There is a `hatch_tadpole` script to update the "tadpole" nest when the core OS related eggs in "larva" are ready.
+
+There is a third nest named "newt" that contains all the eggs needed to support the build and release process of mynewt software. In the future, there will also be pre-built nests for certain common hardware devices to enable a user to quickly get started with a project.
+
+
+### A Mynewt contributor
+
+A contributor can choose to work on any area(s) of the Mynewt endeavor that appeals to him or her. Hence, you can work on one or more eggs or an entire nest. You can create your own nest (master) or create a branch in an existing nest. For now, Runtime contributors will review any new areas of support that you may wish to introduce e.g. a new board support package (BSP) or a new network protocol.
+
+A contributer role necessarily implies he or she is a Mynewt user (see below) of some or all of the products developed.
+
+### A Mynewt user
+
+An application developer is interested only in using software available in this ecosystem to build a top level build artifact. He or she may either:
+
+* Use a pre-built nest, or
+* Spawn a new nest using the newt tool for a target where a target is a custom combination of supported hardware components
+
+In either case, the user would use the newt tool to create and set the target in the chosen nest. The newt tool would then be used to build out the target profile which would determine which eggs to choose. Finally, the user would use the newt tool to generate a run-time image that can be run on the device.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_started/pics/bottomview.png
----------------------------------------------------------------------
diff --git a/docs/get_started/pics/bottomview.png b/docs/get_started/pics/bottomview.png
new file mode 100644
index 0000000..fb7bf0a
Binary files /dev/null and b/docs/get_started/pics/bottomview.png differ
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_started/pics/topview.png
----------------------------------------------------------------------
diff --git a/docs/get_started/pics/topview.png b/docs/get_started/pics/topview.png
new file mode 100644
index 0000000..e57995e
Binary files /dev/null and b/docs/get_started/pics/topview.png differ
[11/11] incubator-mynewt-site git commit: removing .DS_Store
Posted by ad...@apache.org.
removing .DS_Store
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/3355bd0d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/3355bd0d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/3355bd0d
Branch: refs/heads/master
Commit: 3355bd0d8ffd075b5c8a7f03c932aac5da6d6dad
Parents: 6350a43 fa06e3d
Author: aditihilbert <ad...@runtime.io>
Authored: Fri Dec 18 11:39:14 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Fri Dec 18 11:39:14 2015 -0800
----------------------------------------------------------------------
.gitignore | 1 +
docs/.DS_Store | Bin 6148 -> 0 bytes
2 files changed, 1 insertion(+)
----------------------------------------------------------------------
[07/11] incubator-mynewt-site git commit: fixed anchors in project
Blinky - still need to update Windows instructions for hardware target
Posted by ad...@apache.org.
fixed anchors in project Blinky - still need to update Windows instructions for hardware target
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/8aced2b5
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/8aced2b5
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/8aced2b5
Branch: refs/heads/master
Commit: 8aced2b5f28d39b81e65c778db71f1c78be1e0e8
Parents: 515e9ad
Author: aditihilbert <ad...@runtime.io>
Authored: Fri Dec 18 11:12:58 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Fri Dec 18 11:12:58 2015 -0800
----------------------------------------------------------------------
docs/chapter1/how_to_edit_docs.md | 187 ---
docs/chapter1/newt_concepts.md | 48 -
docs/chapter1/pics/bottomview.png | Bin 1995826 -> 0 bytes
docs/chapter1/pics/topview.png | Bin 1945584 -> 0 bytes
docs/chapter1/project1.md | 1062 ------------------
docs/chapter1/try_markdown.md | 32 -
.../pics/STM32f3discovery_connector.png | Bin 612760 -> 0 bytes
docs/chapter2/project2.md | 374 ------
docs/chapter2/project3.md | 1 -
docs/chapter2/vocabulary.md | 170 ---
docs/chapter3/newt_ops.md | 40 -
docs/chapter3/newt_tool_reference.md | 269 -----
docs/chapter4/context_switch.md | 149 ---
docs/chapter4/event_queue.md | 149 ---
docs/chapter4/heap.md | 149 ---
docs/chapter4/mbufs.md | 150 ---
docs/chapter4/memory_pool.md | 151 ---
docs/chapter4/mutex.md | 150 ---
docs/chapter4/mynewt_os.md | 167 ---
docs/chapter4/port_os.md | 12 -
docs/chapter4/sanity.md | 150 ---
docs/chapter4/semaphore.md | 149 ---
docs/chapter4/task.md | 149 ---
docs/chapter4/time.md | 149 ---
docs/chapter5/bootloader.md | 148 ---
docs/chapter5/console.md | 546 ---------
docs/chapter5/filesystem.md | 149 ---
docs/chapter5/shell.md | 147 ---
docs/chapter5/testutil.md | 149 ---
docs/chapter6/dist.md | 0
.../pics/STM32f3discovery_connector.png | Bin 0 -> 612760 bytes
docs/get_acclimated/project2.md | 374 ++++++
docs/get_acclimated/project3.md | 1 +
docs/get_acclimated/vocabulary.md | 170 +++
docs/get_started/how_to_edit_docs.md | 187 +++
docs/get_started/newt_concepts.md | 48 +
docs/get_started/pics/bottomview.png | Bin 0 -> 1995826 bytes
docs/get_started/pics/topview.png | Bin 0 -> 1945584 bytes
docs/get_started/project1.md | 1062 ++++++++++++++++++
docs/get_started/try_markdown.md | 32 +
docs/index.md | 12 +-
docs/modules/bootloader.md | 148 +++
docs/modules/console.md | 546 +++++++++
docs/modules/filesystem.md | 149 +++
docs/modules/shell.md | 147 +++
docs/modules/testutil.md | 149 +++
docs/newt/newt_ops.md | 40 +
docs/newt/newt_tool_reference.md | 269 +++++
docs/os/callout.md | 149 +++
docs/os/context_switch.md | 149 +++
docs/os/event_queue.md | 149 +++
docs/os/heap.md | 149 +++
docs/os/mbufs.md | 150 +++
docs/os/memory_pool.md | 151 +++
docs/os/mutex.md | 150 +++
docs/os/mynewt_os.md | 167 +++
docs/os/port_os.md | 12 +
docs/os/sanity.md | 150 +++
docs/os/semaphore.md | 149 +++
docs/os/task.md | 149 +++
docs/os/time.md | 149 +++
docs/packaging/dist.md | 0
mkdocs.yml | 65 +-
63 files changed, 5184 insertions(+), 5034 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter1/how_to_edit_docs.md
----------------------------------------------------------------------
diff --git a/docs/chapter1/how_to_edit_docs.md b/docs/chapter1/how_to_edit_docs.md
deleted file mode 100644
index 86a5f39..0000000
--- a/docs/chapter1/how_to_edit_docs.md
+++ /dev/null
@@ -1,187 +0,0 @@
-## How to Edit Docs
-
-### Objective
-
-We will go through the process of downloading existing doccumentation and adding some content to a test document.
-
-### Markdown, MkDocs, Mou
-
-The Mynewt documentation you see on the Apache incubator website is a bunch of HTML files generated using MkDocs which is a simple static site generation tool geared towards building project documentation. You can read about it at [http://www.mkdocs.org](http://www.mkdocs.org). Documentation source files are written in Markdown, and configured with a single YAML configuration file. Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats using a tool (which in our case is MkDocs).
-
-You do not need to install MkDocs unless you want to actually render your documentation in HTML in order to preview it before pushing your content to the remote repository. Typically, using a Markdown editor such as [Mou](http://25.io/mou/) is enough to check how it will look after the document has gone through MkDocs. Go ahead and download [Mou](http://25.io/mou/). If you are on a Windows machine, download the [editor of your choice](http://alternativeto.net/software/mou/?platform=windows).
-
-Currently someone in the project is designated to use MkDocs to generate the HTML pages periodically after changes have been reviewed and accepted into the master branch.
-
-
-### Access to the Apache repo
-
-Get 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.
-
-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 [https://git-wip-us.apache.org/docs/workflow.html](https://git-wip-us.apache.org/docs/workflow.html). You will find the steps described in more detail later in this tutorial.
-
-### Making a local copy
-
-* 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.
-
- $ 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
-
-* Create a new branch to work on your documentation and move to that branch.
-
- $ git checkout -b <your-branch-name>
-
-
-### File to be edited
-
-The file you will edit is [try_markdown.md](./try_markdown.md).
-
-### Editing an existing page
-
-* Open the application Mou.
-
-* Open the file incubator-mynewt-site/docs/chapter1/try_markdown.md in Mou.
-
-* Edit the last item on the list.
-
-* Save and quit the application.
-
-You may want to review the documentation organization back in [Home](../index.md) to remind you how to locate files easily. The corresponding directory tree structure is shown below.
-
- .
- ├── docs
- │ ├── chapter1
- │ │ ├── how_to_edit_docs.md
- │ │ ├── newt_concepts.md
- │ │ ├── pics
- │ │ │ ├── bottomview.png
- │ │ │ └── topview.png
- │ │ ├── project1.md
- │ │ └── try_markdown.md
- │ ├── chapter2
- │ │ ├── project2.md
- │ │ ├── project3.md
- │ │ ├── ... (more to be added)
- │ │ └── vocabulary.md
- │ ├── chapter3
- │ │ ├── newt_ops.md
- │ │ └── newt_tool_reference.md
- │ ├── chapter4
- │ │ ├── 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)
- │ ├── chapter5
- │ │ ├── bootloader.md
- │ │ ├── console.md
- │ │ ├── filesystem.md
- │ │ ├── shell.md
- │ │ ├── testutil.md
- │ │ └── ... (more to be added)
- │ ├── chapter6
- │ │ ├── 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
-
-
-### Adding a new page
-
-If you create a new file somewhere in the `docs` subdirectory to add a new page, you have to add a line in the `mkdocs.yml` file at the correct level. For example, if you add a new module named "Ethernet" by creating a new file named `ethernet.md` in the chapter5 subdirectory, you have to insert the following line under `Modules:` in the `mkdocs.yml` file.
-
- - 'Ethernet': 'chapter5/ethernet.md'
-
-### Pushing changes to remote as a committer
-
-If you are not a committer yet, skip this section and proceed to the [next section](#sharing-changes-as-a-non-committer).
-
-* Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.
-
- $ 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)
-
-* If, however, you do not see your remote repository, then set it up as follows.
-
-
- $ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
-
-* First check the git status. It will show you that the `try_markdown.md` 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.
-
- During staging below using `git add`, we use the `-A` 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 `-m`) should summarize what your changes are about.
-
- $ git status
- $ git add -A
- $ git commit -m "My first doc change as a trial run"
- $ git push -u origin <your-branch-name>
-
-* You can see the changed Markdown file if you traverse the tree on the git repository [ 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 commit notification automatically goes out to the commits@mynewt.incubator.apache.org mailing list. The "upstream" manager pulls the notified changes, reviews it, and merges it to the master branch if all is well. Otherwise you get an email for further changes.
-
-### Sharing changes as a non-committer
-
-We suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is [https://git-wip-us.apache.org/docs/workflow.html](https://git-wip-us.apache.org/docs/workflow.html).
-
-* Assuming you have made changes to the example file, you will first commit your changes.
-
- $ git add -A
- $ git commit -m "My first doc change as a trial run"
-
-* 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):
-
- $ git format-patch origin/trunk
-
-* 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.
-
- If there is a JIRA ticket associated with your work you should post your patch files to the ticket.
-
-
-### Conversion to HTML
-
-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.
-
-### Local preview of HTML files
-
-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).
-
- $ python --version
- Python 2.7.2
- $ pip --version
- pip 1.5.2
- $ pip install mkdocs
-
-You will then run the built-in webserver from the root of the documentation directory using the command `mkdocs serve`. The root directory for documentation is `incubator-mynewt-site` or the directory with the `mkdocs.yml` file.
-
- $ ls
- docs images mkdocs.yml
- $ mkdocs serve
-
-Then go to [http://127.0.0.1:8000](http://127.0.0.1:8000) to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be updated.
-
-For more information on MkDocs go to [http://www.mkdocs.org](http://www.mkdocs.org).
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter1/newt_concepts.md
----------------------------------------------------------------------
diff --git a/docs/chapter1/newt_concepts.md b/docs/chapter1/newt_concepts.md
deleted file mode 100644
index 6ac28da..0000000
--- a/docs/chapter1/newt_concepts.md
+++ /dev/null
@@ -1,48 +0,0 @@
-## Newt Concepts
-
-This page introduces the basic terms you will need to find your way around the Mynewt ecosystem.
-
-### Basic components in the ecosystem
-
-* NewtOS is an open-source RTOS (Real Time Operating System) that works on a variety of hardware. The goal is to develop a pre-emptive, multitasking OS that is highly modular, making it possible to mix and match components to enable desired features and capabilities on multiple hardware architectures. Examples of components being worked on are the Core RTOS, a flash file system, utility functions, a variety of board support packages, packages of microcontrollers etc.
-
-
-* Network protocol stacks such as Bluetooth Low Energy, and more
-
-
-* Newt Tool helps you mix the specific packages for the combination of hardware and low-level embedded architecture features of the user's choice and generate the corresponding run-time image based on the NewtOS. It provides the infrastructure to manage and build for different CPU architectures, memory units, board support packages etc., allowing a user to formulate the contents according to the low-level features needed by his or her project.
-
-
-### Terminology
-
-A Mynewt user starts with a project in mind that defines the application or utility that he or she wants to implement on an embedded device. Making an LED blink on an electronics prototyping board is a common starter project. Enabling a BLE (Bluetooth Low Energy) peripheral mode on a development board is a more complex project. Specifying a project requires naming it, at the very least, and then adding the desired properties or attributes. In order to actualize a project, it needs to be applied to a target which is essentially a combination of some specified hardware and the execution environment.
-
-In the mynewt lifecycle, a project grows in a nest. A nest may house multiple projects. The nest is, therefore, a repository where various component packages for one or more projects reside. Each package is an egg (naturally!). However, in the world of Mynewt an egg may consist of other eggs! For example, the starter project Blinky is an egg consisting of several constituent eggs that enable core features. The egg form is suitable for elemental units of code as it explicitly exposes characteristics such as dependencies, versions, capabilities, requirements etc., thus making assembling appropriate components for a project and building an image for it easy to follow, modular, and robust.
-
-A nest can be given any name. For example, you will see a nest named "tadpole" in Mynewt ([https://git-wip-us.apache.org/repos/asf?p=incubator-mynewt-tadpole.git](https://git-wip-us.apache.org/repos/asf?p=incubator-mynewt-tadpole.git)). It contains all the core libraries of the operating system for the native platform which currently supports compilation on Mac OS X. The core libraries are contained in the form of eggs where an egg is a basic unit of implementation of any aspect of the RTOS. The eggs are distributed in the following directory structure inside the nest:
-
-* libs: contains the two eggs `os` and `testutil`
-* hw: contains three eggs - (i) `hal` which has the abstraction layer (HAL) API definitions that all BSP and MCU implementations must support, (ii) `/mcu/native` which in an MCU implementation for the native platform (a simulator, in this case), and (iii) `bsp/native` which is a BSP implementation for the native platform
-* compiler: contains the `sim` egg which bundles the compiler specifications for the native platform.
-
-Let's explore this sample nest a bit further. The `libs/os` egg contains code for scheduler, process/thread/memory management, semaphores etc. It is the core RTOS which ports to all supported chip platforms.The `libs/testutil` egg contains code for testing packages on hardware or simulated environment. The `hw/hal` egg contains header files that provide abstraction for physical hardware components such as GPIO (general purpose input/output), network adapters, timers, and UARTs. This `hw/hal` egg is an MCU peripheral abstraction designed to make it easy to port to different MCUs (microcontrollers). The `hw/mcu/native` egg contains code for microcontroller operations on the native platform. The `hw/bsp/native` egg contains the board support package for the native platform. And finally, the sixth egg `sim` contains the compiler specifications such as path and flags. Currently the compilation is supported on Mac OS X.
-
-You can see another nest in the mynewt ecosystem called the "larva". It was spawned from the skeletal "tadpole" nest using the newt tool. Spawning is easy - ` $ newt create nest <your_nest_name> `. "larva" is the developer's test repository containing all sorts of eggs being written and incubated, including ones to enhance the core operating system which should eventually make their way into the "tadpole" nest. There is a `hatch_tadpole` script to update the "tadpole" nest when the core OS related eggs in "larva" are ready.
-
-There is a third nest named "newt" that contains all the eggs needed to support the build and release process of mynewt software. In the future, there will also be pre-built nests for certain common hardware devices to enable a user to quickly get started with a project.
-
-
-### A Mynewt contributor
-
-A contributor can choose to work on any area(s) of the Mynewt endeavor that appeals to him or her. Hence, you can work on one or more eggs or an entire nest. You can create your own nest (master) or create a branch in an existing nest. For now, Runtime contributors will review any new areas of support that you may wish to introduce e.g. a new board support package (BSP) or a new network protocol.
-
-A contributer role necessarily implies he or she is a Mynewt user (see below) of some or all of the products developed.
-
-### A Mynewt user
-
-An application developer is interested only in using software available in this ecosystem to build a top level build artifact. He or she may either:
-
-* Use a pre-built nest, or
-* Spawn a new nest using the newt tool for a target where a target is a custom combination of supported hardware components
-
-In either case, the user would use the newt tool to create and set the target in the chosen nest. The newt tool would then be used to build out the target profile which would determine which eggs to choose. Finally, the user would use the newt tool to generate a run-time image that can be run on the device.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter1/pics/bottomview.png
----------------------------------------------------------------------
diff --git a/docs/chapter1/pics/bottomview.png b/docs/chapter1/pics/bottomview.png
deleted file mode 100644
index fb7bf0a..0000000
Binary files a/docs/chapter1/pics/bottomview.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter1/pics/topview.png
----------------------------------------------------------------------
diff --git a/docs/chapter1/pics/topview.png b/docs/chapter1/pics/topview.png
deleted file mode 100644
index e57995e..0000000
Binary files a/docs/chapter1/pics/topview.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter1/project1.md
----------------------------------------------------------------------
diff --git a/docs/chapter1/project1.md b/docs/chapter1/project1.md
deleted file mode 100644
index 26f565d..0000000
--- a/docs/chapter1/project1.md
+++ /dev/null
@@ -1,1062 +0,0 @@
-## Blinky, the First Project
-
-### Objective
-
-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 ** Project Blinky**. The goals of this tutorial are threefold:
-
-1. First, you will learn how to set up your environment to be ready to use Mynewt OS and newt tool.
-2. Second, we will walk you through a download of eggs for building and testing [on a simulated target](#building-test-code-on-simulator).
-3. Third, 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 [download an image to SRAM](#using-sram-to-make-led-blink) or you can [download it to flash](#using-flash-to-make-led-blink).
-
-** Time Requirement**: 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!
-
-
-### What you need
-
-1. STM32-E407 development board from Olimex. You can order it from [http://www.mouser.com](http://www.mouser.com/ProductDetail/Olimex-Ltd/STM32-E407/?qs=UN6GZl1KCcit6Ye0xmPO4A%3D%3D), [http://www.digikey.com](http://www.digikey.com/product-detail/en/STM32-E407/1188-1093-ND/3726951), and other places.
-2. ARM-USB-TINY-H connector with JTAG interface for debugging ARM microcontrollers (comes with the ribbon cable to hook up to the board)
-3. USB A-B type cable to connect the debugger to your personal computer
-4. Personal Computer
-
-The 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:
-
-* Mac: OS X Yosemite Version 10.10.5
-* Linux: Ubuntu 14.10 (Utopic Unicorn)
-* Windows: Windows 10
-
-
-### Access to the Apache repo
-
-* Get 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.
-
-* The latest codebase for the Mynewt OS is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
-
-* The latest codebase for the Newt tool is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git
-
-The following shows how to clone a Mynewt OS code repository:
-
-* Non Committers
-
- $ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
-
-* Committers
-
- $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
-
-
-
-### Getting your Mac Ready
-
-#### Installing Homebrew to ease installs on OS X
-
-* 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.
-
- $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-
- Alternatively, you can just extract (or `git clone`) Homebrew and install it to `/usr/local`.
-
-#### Installing Go
-
-* 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:
-
- * src contains Go source files organized into packages (one package per directory),
-
- * pkg contains package objects, and
-
- * bin contains executable commands.
-
- 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.
-
- $ cd $HOME
- $ mkdir -p dev/go
- $ cd dev/go
- $ export GOPATH=`pwd`
-
- 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.
-
- $ vi ~/.bash_profile
- $ source ~/.bash_profile
-
-* 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.
-
- $ brew install go
- ==>
- ...
- ...
- ==> *Summary*
- 🍺 /usr/local/Cellar/go/1.5.1: 5330 files, 273M
-
- Alternatively, you can download the Go package directly from (https://golang.org/dl/) instead of brewing it. Install it in /usr/local directory.
-
-
-#### Creating local repository
-
-* 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.
-
- $ 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
-
-
-* Check that newt.go is in place.
-
- $ 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
-
-
-#### Building the Newt tool
-
-* You will use Go to run the newt.go program to build the newt tool. The command used is `go install` which compiles and writes the resulting executable to an output file named `newt`. It installs the results along with its dependencies in $GOPATH/bin.
-
- $ 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
-
-* 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'.
-
- 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 `export newt="go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt/newt/go"` in your .bash_profile and execute it by calling `$newt` at the prompt instead of `newt`. Here, you use `go run` which runs the compiled binary directly without producing an executable. Don't forget to reload the updated bash profile by typing `source ~/.bash_profile` at the prompt!
-
- $ 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.
-
-* 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.
-
-#### Getting the debugger ready
-
-* 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.
-
- $ brew install gcc
- ...
- ...
- ==> Summary
- 🍺 /usr/local/Cellar/gcc/5.2.0: 1353 files, 248M
-
-
-* 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!
-
- $ 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
-
- 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.
-
-* 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 [http://openocd.org](http://openocd.org).
-
- $ 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
-
-* Proceed to the [Building test code on simulator](#building-test-code-on-simulator) section.
-
-
-### Getting your Ubuntu machine Ready
-
-
-#### Installing some prerequisites
-
-* Install git, libcurl, and the Go language if you do not have them already.
-
- $ sudo apt-get install git
- $ sudo apt-get install libcurl4-gnutls-dev
- $ sudo apt-get install golang
-
-#### Creating local repository
-
-* 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:
-
- * src contains Go source files organized into packages (one package per directory),
-
- * pkg contains package objects, and
-
- * bin contains executable commands.
-
- 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.
-
- $ cd $HOME
- $ mkdir -p dev/go
- $ cd dev/go
- $ export GOPATH=$PWD
-
- Note that you need to add export statements to ~/.bashrc (or equivalent) to export variables permanently.
-
-* 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.
-
- $ 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
-
-
-* Check that newt is in place.
-
- $ 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
-
-#### Building the newt tool
-
-
-* You will use Go to run the newt.go program to build the newt tool. The command used is `go install` which compiles and writes the resulting executable to an output file named `newt`. It installs the results along with its dependencies in $GOPATH/bin.
-
- $ 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
-
-* 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'.
-
- 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 `export newt="go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt/newt/go"` in your ~/.bashrc (or equivalent) and execute it by calling `$newt` at the prompt instead of `newt`. Here, you use `go run` which runs the compiled binary directly without producing an executable.
-
-
- $ 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.
-
-* 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.
-
-#### Getting the debugger ready
-
-* 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:
-
- $ sudo apt-get install gcc-multilib libc6-i386
-
-* 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 [https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded](https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded).
-
- $ 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
-
-* 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.
-
- If you are running Ubuntu 15.x, then you are in luck and you can simply run:
-
- $ sudo apt-get install openocd
-
- 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 [https://launchpad.net/ubuntu/vivid/+source/openocd](https://launchpad.net/ubuntu/vivid/+source/openocd). The direct link to the amd64 build is [http://launchpadlibrarian.net/188260097/openocd_0.8.0-4_amd64.deb](http://launchpadlibrarian.net/188260097/openocd_0.8.0-4_amd64.deb).
-
-* Proceed to the [Building test code on simulator](#building-test-code-on-simulator) section.
-
-### Getting your Windows machine ready for simulated target
-
-The `newt` 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 `newt` tool natively on a computer running any of the three Operating System machines - OSX, Linux, or Windows.
-
-However, 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 (`newtvm.exe`)that allows you to run the newt commands in the Linux Docker instance. The Docker image contains:
-
- * The newt command-line tool
- * Go
- * A multilib-capable native gcc / glibc
- * An arm-none-eabi gcc
- * Native gdb
-
- The sequence of events when using the Docker image is as follows:
-
- 1. A new docker environment is created in the Linux VM.
- 2. The specified command with the newtvm prefix (`newtvm newt` command) is sent to the docker environment via ssh.
- 3. The Linux command runs.
- 4. The output from the command is sent back to Windows via ssh.
- 5. The output is displayed in the Windows command prompt.
-
-
-#### Install Linux virtual machine
-
-* Download the Docker Toolbox for Windows (version 1.9.0c or later) from [https://www.docker.com/docker-toolbox](https://www.docker.com/docker-toolbox). The Docker toolbox creates a consistently reproducible and self-contained environment in Linux.
-
-* Run the Docker Toolbox installer. All the default settings are OK.
-
-* You may need to add "C:\Program Files\Git\usr\bin" to your PATH
-environment variable. To add to the PATH environment variable, right-click on the Start button in the bottom left corner. Choose System -> Advanced system settings -> Environment Variables. Click on the PATH variable under "System variables" and click Edit to check and add it if it is not already there.
-
-#### Install newtvm tool
-
-* From your base user (home) directory, pull or clone the latest code from the newt repository into the `newt` directory. It includes the executable `newtvm.exe` for the newtvm tool in the `newtvm` directory.
-
- C:\Users\admin> git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt newt
-
- The newtvm tool is what allows you to run programs in the Linux docker
-instance.
-
-* 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.
-
-
-
- ## .
- ## ## ## ==
- ## ## ## ## ## ===
- /"""""""""""""""""\___/ ===
- ~~~ {~~ ~~~~ ~~~ ~~~~ ~~~ ~ / ===- ~~~
- \______ 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
-
- admin@dev1 MINGW64 ~ (master)
- $
-
- 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.
-
-* 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:
-
- C:\Users\admin\newt\newtvm> newtvm newt help
-
-
- 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.
-
-* You are now ready to proceed to [building the image for the simulated target](#building test code on simulator).
-
-
-### Getting your Windows machine ready for hardware target
-
-When you want to produce images for actual hardware board on your Windows machine, go through the following setup procedure and then proceed to the [blinky project on the Olimex board](#Using-SRAM-to-make-LED-blink) with this method.
-
-#### Installing some prerequisites
-
-* 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
-tutorial for a Windows machine assumes the specified folders.
-
- * win-builds-i686
- * win-builds-x86_64
- * MSYS
- * gcc for ARM
- * openocd
- * zadig
- * git
- * go
-
- - *win-builds (mingw64) 1.5 for i686*
-
- Download from [http://win-builds.org/doku.php/download_and_installation_from_windows](http://win-builds.org/doku.php/download_and_installation_from_windows). Install at: "C:\win-builds-i686".
-
- Be 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 additional packages. They are not all necessary, but it is simplest to just accept the defaults.
-
- - *win-builds (mingw64) 1.5 for x86_64*
-
- Download from [http://win-builds.org/doku.php/download_and_installation_from_windows](http://win-builds.org/doku.php/download_and_installation_from_windows). Install at "C:\win-builds-x86_64"
-
- Run the installer a second time, but this time click the x86_64 option, NOT i686. The defaults for all other options are OK.
-
- - *MSYS*
-
- Start your download from [http://sourceforge.net/projects/mingw-w64/files/External%20binary%20packages%20%28Win64%20hosted%29/MSYS%20%2832-bit%29/MSYS-20111123.zip](http://sourceforge.net/projects/mingw-w64/files/External%20binary%20packages%20%28Win64%20hosted%29/MSYS%20%2832-bit%29/MSYS-20111123.zip)
-
- Unzip to "C:\msys"
-
- - *gcc for ARM, 4.9.3*
-
- Download the Windows installer from [https://launchpad.net/gcc-arm-embedded/+download](https://launchpad.net/gcc-arm-embedded/+download) and install at "C:\Program Files (x86)\GNU Tools ARM Embedded\4.9 2015q3".
-
- - OpenOCD 0.8.0
-
- Download OpenOCD 0.8.0 from [http://www.freddiechopin.info/en/download/category/4-openocd](http://www.freddiechopin.info/en/download/category/4-openocd). Unzip to "C:\openocd".
-
- - Zadig 2.1.2
-
- Download it from [http://zadig.akeo.ie](http://zadig.akeo.ie) and install it at "C:\zadig".
-
- - Git
-
- Click on [https://git-scm.com/download/win](https://git-scm.com/download/win) 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.
-
- - Go
-
- Download the release for Microsoft Windows from [https://golang.org/dl/](https://golang.org/dl/) and install it "C:\Go".
-
-
-#### Creating local repository
-
-* 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:
-
- * src contains Go source files organized into packages (one package per directory),
-
- * pkg contains package objects, and
-
- * bin contains executable commands.
-
- 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.
-
- $ cd c:\
- $ mkdir dev\go
- $ cd dev\go
-
-* Set the following user environment variables using the steps outlined here.
-
- * 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
-
- Steps:
-
- 1. Right-click the start button
- 2. Click "Control panel"
- 3. Click "System and Security"
- 4. Click "System"
- 5. Click "Advanced system settings" in the left panel
- 6. Click the "Envoronment Variables..." button
- 7. 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).
-
-
-* Next, install godep. Note that the following command produces no output.
-
- $ go get github.com/tools/godep
-
-* 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.
-
- $ 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
-
-* Check that newt is in place.
-
- $ 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
-
-
-
-#### Building the newt tool
-
-* * You will use Go to run the newt.go program to build the newt tool. The command used is `go install` which compiles and writes the resulting executable to an output file named `newt`. It installs the results along with its dependencies in $GOPATH/bin.
-
- $ go install
- $ ls "$GOPATH"/bin/
- godep incubator-mynewt-newt.git newt
-
-* 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'.
-
- 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 `%newt%`. Use `set newt=go run %GOPATH%\src\github.com\mynewt\newt\newt.go` or set it from the GUI. Here, you use `go run` which runs the compiled binary directly without producing an executable.
-
- $ 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.
-
-* 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.
-
-#### Getting the debugger ready
-
-* Use Zadig to configure the USB driver for your Olimex debugger. If your debugger is already set up, you can skip this step.
-
- 1. Plug in your Olimex debugger.
- 2. Start Zadig.
- 3. Check the Options -> List All Devices checkbox.
- 4. Select "Olimex OpenOCD JTAG ARM-USB-TINY-H" in the dropdown menu.
- 5. Select the "WinUSB" driver.
- 6. Click the "Install Driver" button.
-
-* Proceed to the section on how to [make an LED blink](#making-an-led-blink-from-sram) section.
-
-
-### Building test code on simulator
-
-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 [an earlier section](#Getting your Windows machine Ready for simulated target). Consequently, all `newt` commands must be prefaced with `newtvm`.
-
-1. 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 `larva`.
-
- 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.
-
-
- $ 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
-
- On Windows, open a command prompt (e.g., Windows-R, "cmd", enter) and work from your home directory:
-
- 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
-
-2. You will now create a new target using the newt tool. You can either use the compiled binary `newt` or run the newt.go program using `$newt` (assuming you have stored the command in a variable in your .bash_profile or .bashrc). When you do a `newt target show` or `$newt target show` it should list all the projects you have created so far.
-
- $ newt target create sim_test
- Creating target sim_test
- Target sim_test sucessfully created!
- $ newt target show
- sim_test
- name: sim_test
- arch: sim
-
- Remember, on a Windows machine you will have to preface `newt` with `newtvm`!
-
- C:\Users\admin\larva>newtvm newt target create sim_test
-
-3. Now continue to populate and build out the sim project.
-
- $ 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
-
- Again remember to preface `newt` with `newtvm`on a Windows machine as shown below. Continue to fill out all the project attributes.
-
- C:\Users\admin\larva>newtvm newt target set sim_test project=test
- Target sim_test successfully set project to test
-
-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.
-
- For a Mac OS X environment:
-
- $ cp compiler/sim/osx-compiler.yml compiler/sim/compiler.yml
-
- For a Linux machine:
-
- $ cp compiler/sim/linux-compiler.yml compiler/sim/compiler.yml
-
-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 `newt` with `newtvm`on a Windows machine.
-
- $ newt target build sim_test
- Successfully run!
-
- You can specify the VERBOSE option if you want to see the gory details.
-
- $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!
-
-6. Try running the test suite executable inside this project and enjoy your first successful hatch.
-
- $ 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
-
-
-### Using SRAM to make LED blink
-
-You are here because you want to build an image to be run from internal SRAM on the Olimex board.
-
-#### Preparing the Software
-
-1. Make sure the PATH environment variable includes the $HOME/dev/go/bin directory (or C:\%GOPATH%\bin on Windows machine).
-
- Substitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows (e.g. `cd dev\go` instead of `cd dev/go`). The newt tool commands do not change.
-
-
-2. 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 `larva`.
-
- 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.
-
- $ 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
-
-3. 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.
-
-Remember to prefix each command with "newtvm" if you are executing the newt command in a Linux virtual machine on your Windows box!
-
-
- $ 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
-
-4. Now you have to build the image. The linker script within the `hw/bsp/olimex_stm32-e407_devboard` egg builds an image for flash memory by default. Since you want an image for the SRAM, you need to switch that script with `run_from_sram.ld` 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>.
-
- 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.
-
- $ 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
-
-
-5. 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 `/usr/share/openocd/scripts/ ` directory as they may have been part of the openocd download. If yes, you are all set and can proceed to preparing the hardware.
-
- Otherwise check the `~/dev/larva/hw/bsp/olimex_stm32-e407_devboard` directory for a file named `f407.cfg`. That is the config we will use to talk to this specific hardware using OpenOCD. You are all set if you see it.
-
- $ 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
-
-
-#### Preparing the hardware to boot from embedded SRAM
-
-1. Locate the boot jumpers on the board.
-
-
-
-2. B1_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 – they are responsible for the boot mode if bootloader is present. The board can search for bootloader on three places – User Flash Memory, System Memory or the Embedded SRAM. We will configure it to boot from SRAM by jumpering B0_1 and B1_1.
-
-3. Connect 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).
-
-4. The red PWR LED should be lit.
-
-5. Connect 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.
-
-
-
-#### Let's Go!
-
-1. 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 `-c "reset halt"` flag that tells it to halt after opening the session.
-
- $ 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
-
-
- 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.
-
- (gdb) set $msp=0x10010000
-
- Now load the image and type "c" or "continue" from the GNU debugger.
-
- (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.
-
-2. Voilà! The board's LED should be blinking at 1 Hz.
-
-### Using flash to make LED blink
-
-You are here because you want to build an image to be run from flash memory on the Olimex board.
-
-1. 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 ["Preparing the hardware to boot from embedded SRAM"](#preparing-the-hardware-to-boot-from-embedded-sram).
-
- You will have to reset the board once the image is uploaded to it.
-
-2. If you skipped the first option for the project [(downloading an image to SRAM)](#using-sram-to-make-led-blink), then skip this step. Otherwise, continue with this step.
-
- By default, the linker script (`olimex_stm32-e407_devboard.ld`) is configured to run from bootloader and flash. However, if you first ran the image from SRAM you had changed `olimex_stm32-e407_devboard.ld` to match `run_from_sram.ld`. You will therefore return to defaults with `olimex_stm32-e407_devboard.ld` linker script matching the contents of 'run_from_loader.ld'. Return to the project directory.
-
- $ 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
-
-3. 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).
-
- Let's first create bin2img:
-
- $ 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
-
- And then let's create boot_olimex:
-
- $ 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
-
-4. Let's build all the three targets now.
-
- $ 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!
-
-
-5. Go to the project directory and download the bootloader and the image to flash ... in a flash!
-
- $ 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
-
-6. The LED should be blinking!
-
-7. 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.
-
- The LED light will start blinking again. Success!
-
- Note #1: If you want to download the image to flash and a gdb session opened up, use `newt target debug blinky` instead of `newt target download blinky`.
-
- $ 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)
-
-
- Note #2: If you want to erase the flash and load the image again you may use the following commands from within gdb. `flash erase_sector 0 0 x` 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.
-
- (gdb) monitor flash erase_sector 0 0 4
- erased sectors 0 through 4 on flash bank 0 in 2.296712s
- (gdb) monitor mdw 0x08000000 16
- 0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
- (0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
- (0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
- (0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
- (gdb) monitor flash info 0
-
-
- monitor flash erase_check 0
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter1/try_markdown.md
----------------------------------------------------------------------
diff --git a/docs/chapter1/try_markdown.md b/docs/chapter1/try_markdown.md
deleted file mode 100644
index e35707c..0000000
--- a/docs/chapter1/try_markdown.md
+++ /dev/null
@@ -1,32 +0,0 @@
-## Try Markdown
-
-### Heading3
-
-#### Heading4
-
-- - -
-
-##### List
-
-* Start with one # for the largest heading (Heading1). The next smaller heading (Heading2) starts with ##. You can go all the way up to Heading 6 (######).
-
-* Heading4 (####) and Heading5 (#####) has been styled to show up underlined. Yes, it can be changed. If you are curious, you can look at the extra.css file in your repo branch.
-
-* It's **very** easy to do **bold** and *italics*.
-
-* See how this list has been made using *
-
-* Click on "Help" in Mou and then on "Markdown Syntax Reference".
-
-* <font color="red"> Substitute a sentence of your own here </font>
-
-* <font color="red"> Guinea Pig!!! </font>
-
----
-
-> <font color="red"> Note! </font>
->> You will not be able to see the change immediately by refreshing your browser right after editign the Markdown file. You can only push the change to the Apache repository. So continue with the steps in [how_to_edit_docs.md](how_to_edit_docs.md).
->>
->> You can see the change on the website if/when a doc builder on the project team merges your changes to the master branch and generates the pages for the website.
->>
->> You do have the option to download MkDocs and preview the change by hosting the pages locally using its built-in web server. The steps are described in [how_to_edit_docs.md](how_to_edit_docs.md).
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter2/pics/STM32f3discovery_connector.png
----------------------------------------------------------------------
diff --git a/docs/chapter2/pics/STM32f3discovery_connector.png b/docs/chapter2/pics/STM32f3discovery_connector.png
deleted file mode 100644
index 1f4437a..0000000
Binary files a/docs/chapter2/pics/STM32f3discovery_connector.png and /dev/null differ
[04/11] incubator-mynewt-site git commit: fixed anchors in project
Blinky - still need to update Windows instructions for hardware target
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_started/project1.md
----------------------------------------------------------------------
diff --git a/docs/get_started/project1.md b/docs/get_started/project1.md
new file mode 100644
index 0000000..3be7e26
--- /dev/null
+++ b/docs/get_started/project1.md
@@ -0,0 +1,1062 @@
+## Blinky, the First Project
+
+### Objective
+
+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 ** Project Blinky**. The goals of this tutorial are threefold:
+
+1. First, you will learn how to set up your environment to be ready to use Mynewt OS and newt tool.
+2. Second, we will walk you through a download of eggs for building and testing [on a simulated target](#building-test-code-on-simulator).
+3. Third, 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 [download an image to SRAM](#using-sram-to-make-led-blink) or you can [download it to flash](#using-flash-to-make-led-blink).
+
+** Time Requirement**: 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!
+
+
+### What you need
+
+1. STM32-E407 development board from Olimex. You can order it from [http://www.mouser.com](http://www.mouser.com/ProductDetail/Olimex-Ltd/STM32-E407/?qs=UN6GZl1KCcit6Ye0xmPO4A%3D%3D), [http://www.digikey.com](http://www.digikey.com/product-detail/en/STM32-E407/1188-1093-ND/3726951), and other places.
+2. ARM-USB-TINY-H connector with JTAG interface for debugging ARM microcontrollers (comes with the ribbon cable to hook up to the board)
+3. USB A-B type cable to connect the debugger to your personal computer
+4. Personal Computer
+
+The 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:
+
+* Mac: OS X Yosemite Version 10.10.5
+* Linux: Ubuntu 14.10 (Utopic Unicorn)
+* Windows: Windows 10
+
+
+### Access to the Apache repo
+
+* Get 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.
+
+* The latest codebase for the Mynewt OS is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+
+* The latest codebase for the Newt tool is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git
+
+The following shows how to clone a Mynewt OS code repository:
+
+* Non Committers
+
+ $ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+
+* Committers
+
+ $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+
+
+
+### Getting your Mac Ready
+
+#### Installing Homebrew to ease installs on OS X
+
+* 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.
+
+ $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+ Alternatively, you can just extract (or `git clone`) Homebrew and install it to `/usr/local`.
+
+#### Installing Go
+
+* 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:
+
+ * src contains Go source files organized into packages (one package per directory),
+
+ * pkg contains package objects, and
+
+ * bin contains executable commands.
+
+ 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.
+
+ $ cd $HOME
+ $ mkdir -p dev/go
+ $ cd dev/go
+ $ export GOPATH=`pwd`
+
+ 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.
+
+ $ vi ~/.bash_profile
+ $ source ~/.bash_profile
+
+* 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.
+
+ $ brew install go
+ ==>
+ ...
+ ...
+ ==> *Summary*
+ 🍺 /usr/local/Cellar/go/1.5.1: 5330 files, 273M
+
+ Alternatively, you can download the Go package directly from (https://golang.org/dl/) instead of brewing it. Install it in /usr/local directory.
+
+
+#### Creating local repository
+
+* 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.
+
+ $ 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
+
+
+* Check that newt.go is in place.
+
+ $ 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
+
+
+#### Building the Newt tool
+
+* You will use Go to run the newt.go program to build the newt tool. The command used is `go install` which compiles and writes the resulting executable to an output file named `newt`. It installs the results along with its dependencies in $GOPATH/bin.
+
+ $ 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
+
+* 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'.
+
+ 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 `export newt="go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt/newt/go"` in your .bash_profile and execute it by calling `$newt` at the prompt instead of `newt`. Here, you use `go run` which runs the compiled binary directly without producing an executable. Don't forget to reload the updated bash profile by typing `source ~/.bash_profile` at the prompt!
+
+ $ 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.
+
+* 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.
+
+#### Getting the debugger ready
+
+* 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.
+
+ $ brew install gcc
+ ...
+ ...
+ ==> Summary
+ 🍺 /usr/local/Cellar/gcc/5.2.0: 1353 files, 248M
+
+
+* 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!
+
+ $ 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
+
+ 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.
+
+* 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 [http://openocd.org](http://openocd.org).
+
+ $ 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
+
+* Proceed to the [Building test code on simulator](#building-test-code-on-simulator) section.
+
+
+### Getting your Ubuntu machine Ready
+
+
+#### Installing some prerequisites
+
+* Install git, libcurl, and the Go language if you do not have them already.
+
+ $ sudo apt-get install git
+ $ sudo apt-get install libcurl4-gnutls-dev
+ $ sudo apt-get install golang
+
+#### Creating local repository
+
+* 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:
+
+ * src contains Go source files organized into packages (one package per directory),
+
+ * pkg contains package objects, and
+
+ * bin contains executable commands.
+
+ 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.
+
+ $ cd $HOME
+ $ mkdir -p dev/go
+ $ cd dev/go
+ $ export GOPATH=$PWD
+
+ Note that you need to add export statements to ~/.bashrc (or equivalent) to export variables permanently.
+
+* 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.
+
+ $ 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
+
+
+* Check that newt is in place.
+
+ $ 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
+
+#### Building the newt tool
+
+
+* You will use Go to run the newt.go program to build the newt tool. The command used is `go install` which compiles and writes the resulting executable to an output file named `newt`. It installs the results along with its dependencies in $GOPATH/bin.
+
+ $ 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
+
+* 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'.
+
+ 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 `export newt="go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt/newt/go"` in your ~/.bashrc (or equivalent) and execute it by calling `$newt` at the prompt instead of `newt`. Here, you use `go run` which runs the compiled binary directly without producing an executable.
+
+
+ $ 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.
+
+* 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.
+
+#### Getting the debugger ready
+
+* 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:
+
+ $ sudo apt-get install gcc-multilib libc6-i386
+
+* 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 [https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded](https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded).
+
+ $ 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
+
+* 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.
+
+ If you are running Ubuntu 15.x, then you are in luck and you can simply run:
+
+ $ sudo apt-get install openocd
+
+ 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 [https://launchpad.net/ubuntu/vivid/+source/openocd](https://launchpad.net/ubuntu/vivid/+source/openocd). The direct link to the amd64 build is [http://launchpadlibrarian.net/188260097/openocd_0.8.0-4_amd64.deb](http://launchpadlibrarian.net/188260097/openocd_0.8.0-4_amd64.deb).
+
+* Proceed to the [Building test code on simulator](#building-test-code-on-simulator) section.
+
+### Getting your Windows machine ready for simulated target
+
+The `newt` 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 `newt` tool natively on a computer running any of the three Operating System machines - OSX, Linux, or Windows.
+
+However, 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 (`newtvm.exe`)that allows you to run the newt commands in the Linux Docker instance. The Docker image contains:
+
+ * The newt command-line tool
+ * Go
+ * A multilib-capable native gcc / glibc
+ * An arm-none-eabi gcc
+ * Native gdb
+
+ The sequence of events when using the Docker image is as follows:
+
+ 1. A new docker environment is created in the Linux VM.
+ 2. The specified command with the newtvm prefix (`newtvm newt` command) is sent to the docker environment via ssh.
+ 3. The Linux command runs.
+ 4. The output from the command is sent back to Windows via ssh.
+ 5. The output is displayed in the Windows command prompt.
+
+
+#### Install Linux virtual machine
+
+* Download the Docker Toolbox for Windows (version 1.9.0c or later) from [https://www.docker.com/docker-toolbox](https://www.docker.com/docker-toolbox). The Docker toolbox creates a consistently reproducible and self-contained environment in Linux.
+
+* Run the Docker Toolbox installer. All the default settings are OK.
+
+* You may need to add "C:\Program Files\Git\usr\bin" to your PATH
+environment variable. To add to the PATH environment variable, right-click on the Start button in the bottom left corner. Choose System -> Advanced system settings -> Environment Variables. Click on the PATH variable under "System variables" and click Edit to check and add it if it is not already there.
+
+#### Install newtvm tool
+
+* From your base user (home) directory, pull or clone the latest code from the newt repository into the `newt` directory. It includes the executable `newtvm.exe` for the newtvm tool in the `newtvm` directory.
+
+ C:\Users\admin> git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt newt
+
+ The newtvm tool is what allows you to run programs in the Linux docker
+instance.
+
+* 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.
+
+
+
+ ## .
+ ## ## ## ==
+ ## ## ## ## ## ===
+ /"""""""""""""""""\___/ ===
+ ~~~ {~~ ~~~~ ~~~ ~~~~ ~~~ ~ / ===- ~~~
+ \______ 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
+
+ admin@dev1 MINGW64 ~ (master)
+ $
+
+ 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.
+
+* 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:
+
+ C:\Users\admin\newt\newtvm> newtvm newt help
+
+
+ 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.
+
+* You are now ready to proceed to [building the image for the simulated target](#building-test-code-on-simulator).
+
+
+### Getting your Windows machine ready for hardware target
+
+When you want to produce images for actual hardware board on your Windows machine, go through the following setup procedure and then proceed to the [blinky project on the Olimex board](#Using-SRAM-to-make-LED-blink) with this method.
+
+#### Installing some prerequisites
+
+* 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
+tutorial for a Windows machine assumes the specified folders.
+
+ * win-builds-i686
+ * win-builds-x86_64
+ * MSYS
+ * gcc for ARM
+ * openocd
+ * zadig
+ * git
+ * go
+
+ - *win-builds (mingw64) 1.5 for i686*
+
+ Download from [http://win-builds.org/doku.php/download_and_installation_from_windows](http://win-builds.org/doku.php/download_and_installation_from_windows). Install at: "C:\win-builds-i686".
+
+ Be 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 additional packages. They are not all necessary, but it is simplest to just accept the defaults.
+
+ - *win-builds (mingw64) 1.5 for x86_64*
+
+ Download from [http://win-builds.org/doku.php/download_and_installation_from_windows](http://win-builds.org/doku.php/download_and_installation_from_windows). Install at "C:\win-builds-x86_64"
+
+ Run the installer a second time, but this time click the x86_64 option, NOT i686. The defaults for all other options are OK.
+
+ - *MSYS*
+
+ Start your download from [http://sourceforge.net/projects/mingw-w64/files/External%20binary%20packages%20%28Win64%20hosted%29/MSYS%20%2832-bit%29/MSYS-20111123.zip](http://sourceforge.net/projects/mingw-w64/files/External%20binary%20packages%20%28Win64%20hosted%29/MSYS%20%2832-bit%29/MSYS-20111123.zip)
+
+ Unzip to "C:\msys"
+
+ - *gcc for ARM, 4.9.3*
+
+ Download the Windows installer from [https://launchpad.net/gcc-arm-embedded/+download](https://launchpad.net/gcc-arm-embedded/+download) and install at "C:\Program Files (x86)\GNU Tools ARM Embedded\4.9 2015q3".
+
+ - OpenOCD 0.8.0
+
+ Download OpenOCD 0.8.0 from [http://www.freddiechopin.info/en/download/category/4-openocd](http://www.freddiechopin.info/en/download/category/4-openocd). Unzip to "C:\openocd".
+
+ - Zadig 2.1.2
+
+ Download it from [http://zadig.akeo.ie](http://zadig.akeo.ie) and install it at "C:\zadig".
+
+ - Git
+
+ Click on [https://git-scm.com/download/win](https://git-scm.com/download/win) 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.
+
+ - Go
+
+ Download the release for Microsoft Windows from [https://golang.org/dl/](https://golang.org/dl/) and install it "C:\Go".
+
+
+#### Creating local repository
+
+* 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:
+
+ * src contains Go source files organized into packages (one package per directory),
+
+ * pkg contains package objects, and
+
+ * bin contains executable commands.
+
+ 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.
+
+ $ cd c:\
+ $ mkdir dev\go
+ $ cd dev\go
+
+* Set the following user environment variables using the steps outlined here.
+
+ * 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
+
+ Steps:
+
+ 1. Right-click the start button
+ 2. Click "Control panel"
+ 3. Click "System and Security"
+ 4. Click "System"
+ 5. Click "Advanced system settings" in the left panel
+ 6. Click the "Envoronment Variables..." button
+ 7. 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).
+
+
+* Next, install godep. Note that the following command produces no output.
+
+ $ go get github.com/tools/godep
+
+* 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.
+
+ $ 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
+
+* Check that newt is in place.
+
+ $ 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
+
+
+
+#### Building the newt tool
+
+* You will use Go to run the newt.go program to build the newt tool. The command used is `go install` which compiles and writes the resulting executable to an output file named `newt`. It installs the results along with its dependencies in $GOPATH/bin.
+
+ $ go install
+ $ ls "$GOPATH"/bin/
+ godep incubator-mynewt-newt.git newt
+
+* 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'.
+
+ 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 `%newt%`. Use `set newt=go run %GOPATH%\src\github.com\mynewt\newt\newt.go` or set it from the GUI. Here, you use `go run` which runs the compiled binary directly without producing an executable.
+
+ $ 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.
+
+* 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.
+
+#### Getting the debugger ready
+
+* Use Zadig to configure the USB driver for your Olimex debugger. If your debugger is already set up, you can skip this step.
+
+ 1. Plug in your Olimex debugger.
+ 2. Start Zadig.
+ 3. Check the Options -> List All Devices checkbox.
+ 4. Select "Olimex OpenOCD JTAG ARM-USB-TINY-H" in the dropdown menu.
+ 5. Select the "WinUSB" driver.
+ 6. Click the "Install Driver" button.
+
+* Proceed to the section on how to [make an LED blink](#using-sram-to-make-led-blink) section.
+
+
+### Building test code on simulator
+
+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 [an earlier section](#getting-your-windows-machine-ready-for-simulated-target). Consequently, all `newt` commands must be prefaced with `newtvm`.
+
+1. 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 `larva`.
+
+ 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.
+
+
+ $ 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
+
+ On Windows, open a command prompt (e.g., Windows-R, "cmd", enter) and work from your home directory:
+
+ 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
+
+2. You will now create a new target using the newt tool. You can either use the compiled binary `newt` or run the newt.go program using `$newt` (assuming you have stored the command in a variable in your .bash_profile or .bashrc). When you do a `newt target show` or `$newt target show` it should list all the projects you have created so far.
+
+ $ newt target create sim_test
+ Creating target sim_test
+ Target sim_test sucessfully created!
+ $ newt target show
+ sim_test
+ name: sim_test
+ arch: sim
+
+ Remember, on a Windows machine you will have to preface `newt` with `newtvm`!
+
+ C:\Users\admin\larva>newtvm newt target create sim_test
+
+3. Now continue to populate and build out the sim project.
+
+ $ 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
+
+ Again remember to preface `newt` with `newtvm`on a Windows machine as shown below. Continue to fill out all the project attributes.
+
+ C:\Users\admin\larva>newtvm newt target set sim_test project=test
+ Target sim_test successfully set project to test
+
+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.
+
+ For a Mac OS X environment:
+
+ $ cp compiler/sim/osx-compiler.yml compiler/sim/compiler.yml
+
+ For a Linux machine:
+
+ $ cp compiler/sim/linux-compiler.yml compiler/sim/compiler.yml
+
+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 `newt` with `newtvm`on a Windows machine.
+
+ $ newt target build sim_test
+ Successfully run!
+
+ You can specify the VERBOSE option if you want to see the gory details.
+
+ $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!
+
+6. Try running the test suite executable inside this project and enjoy your first successful hatch.
+
+ $ 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
+
+
+### Using SRAM to make LED blink
+
+You are here because you want to build an image to be run from internal SRAM on the Olimex board.
+
+#### Preparing the Software
+
+1. Make sure the PATH environment variable includes the $HOME/dev/go/bin directory (or C:\%GOPATH%\bin on Windows machine).
+
+ Substitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows (e.g. `cd dev\go` instead of `cd dev/go`). The newt tool commands do not change.
+
+
+2. 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 `larva`.
+
+ 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.
+
+ $ 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
+
+3. 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.
+
+Remember to prefix each command with "newtvm" if you are executing the newt command in a Linux virtual machine on your Windows box!
+
+
+ $ 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
+
+4. Now you have to build the image. The linker script within the `hw/bsp/olimex_stm32-e407_devboard` egg builds an image for flash memory by default. Since you want an image for the SRAM, you need to switch that script with `run_from_sram.ld` 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>.
+
+ 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.
+
+ $ 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
+
+
+5. 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 `/usr/share/openocd/scripts/ ` directory as they may have been part of the openocd download. If yes, you are all set and can proceed to preparing the hardware.
+
+ Otherwise check the `~/dev/larva/hw/bsp/olimex_stm32-e407_devboard` directory for a file named `f407.cfg`. That is the config we will use to talk to this specific hardware using OpenOCD. You are all set if you see it.
+
+ $ 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
+
+
+#### Preparing the hardware to boot from embedded SRAM
+
+1. Locate the boot jumpers on the board.
+
+
+
+2. B1_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 – they are responsible for the boot mode if bootloader is present. The board can search for bootloader on three places – User Flash Memory, System Memory or the Embedded SRAM. We will configure it to boot from SRAM by jumpering B0_1 and B1_1.
+
+3. Connect 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).
+
+4. The red PWR LED should be lit.
+
+5. Connect 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.
+
+
+
+#### Let's Go!
+
+1. 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 `-c "reset halt"` flag that tells it to halt after opening the session.
+
+ $ 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
+
+
+ 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.
+
+ (gdb) set $msp=0x10010000
+
+ Now load the image and type "c" or "continue" from the GNU debugger.
+
+ (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.
+
+2. Voilà! The board's LED should be blinking at 1 Hz.
+
+### Using flash to make LED blink
+
+You are here because you want to build an image to be run from flash memory on the Olimex board.
+
+1. 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 ["Preparing the hardware to boot from embedded SRAM"](#preparing-the-hardware-to-boot-from-embedded-sram).
+
+ You will have to reset the board once the image is uploaded to it.
+
+2. If you skipped the first option for the project [(downloading an image to SRAM)](#using-sram-to-make-led-blink), then skip this step. Otherwise, continue with this step.
+
+ By default, the linker script (`olimex_stm32-e407_devboard.ld`) is configured to run from bootloader and flash. However, if you first ran the image from SRAM you had changed `olimex_stm32-e407_devboard.ld` to match `run_from_sram.ld`. You will therefore return to defaults with `olimex_stm32-e407_devboard.ld` linker script matching the contents of 'run_from_loader.ld'. Return to the project directory.
+
+ $ 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
+
+3. 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).
+
+ Let's first create bin2img:
+
+ $ 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
+
+ And then let's create boot_olimex:
+
+ $ 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
+
+4. Let's build all the three targets now.
+
+ $ 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!
+
+
+5. Go to the project directory and download the bootloader and the image to flash ... in a flash!
+
+ $ 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
+
+6. The LED should be blinking!
+
+7. 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.
+
+ The LED light will start blinking again. Success!
+
+ Note #1: If you want to download the image to flash and a gdb session opened up, use `newt target debug blinky` instead of `newt target download blinky`.
+
+ $ 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)
+
+
+ Note #2: If you want to erase the flash and load the image again you may use the following commands from within gdb. `flash erase_sector 0 0 x` 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.
+
+ (gdb) monitor flash erase_sector 0 0 4
+ erased sectors 0 through 4 on flash bank 0 in 2.296712s
+ (gdb) monitor mdw 0x08000000 16
+ 0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ (0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ (0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ (0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ (gdb) monitor flash info 0
+
+
+ monitor flash erase_check 0
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_started/try_markdown.md
----------------------------------------------------------------------
diff --git a/docs/get_started/try_markdown.md b/docs/get_started/try_markdown.md
new file mode 100644
index 0000000..e35707c
--- /dev/null
+++ b/docs/get_started/try_markdown.md
@@ -0,0 +1,32 @@
+## Try Markdown
+
+### Heading3
+
+#### Heading4
+
+- - -
+
+##### List
+
+* Start with one # for the largest heading (Heading1). The next smaller heading (Heading2) starts with ##. You can go all the way up to Heading 6 (######).
+
+* Heading4 (####) and Heading5 (#####) has been styled to show up underlined. Yes, it can be changed. If you are curious, you can look at the extra.css file in your repo branch.
+
+* It's **very** easy to do **bold** and *italics*.
+
+* See how this list has been made using *
+
+* Click on "Help" in Mou and then on "Markdown Syntax Reference".
+
+* <font color="red"> Substitute a sentence of your own here </font>
+
+* <font color="red"> Guinea Pig!!! </font>
+
+---
+
+> <font color="red"> Note! </font>
+>> You will not be able to see the change immediately by refreshing your browser right after editign the Markdown file. You can only push the change to the Apache repository. So continue with the steps in [how_to_edit_docs.md](how_to_edit_docs.md).
+>>
+>> You can see the change on the website if/when a doc builder on the project team merges your changes to the master branch and generates the pages for the website.
+>>
+>> You do have the option to download MkDocs and preview the change by hosting the pages locally using its built-in web server. The steps are described in [how_to_edit_docs.md](how_to_edit_docs.md).
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index ac13a84..b4974bf 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -67,17 +67,17 @@ To subscribe to a mailing list, you simply send an email to a special subscripti
The chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter.
-* [Chapter 1: Get Started](chapter1/newt_concepts.md) 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.
+* [Chapter 1: Get Started](get_started/newt_concepts.md) 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.
-* [Chapter 2: Get Acclimated](chapter2/vocabulary.md) delves deeper into the concepts crucial to the software development effort.
+* [Chapter 2: Get Acclimated](get_acclimated/vocabulary.md) delves deeper into the concepts crucial to the software development effort.
-* [Chapter 3: Newt Tool Reference](chapter3/newt_ops.md) describes the command structure and details all the available commands to help you with your project.
+* [Chapter 3: Newt Tool Reference](newt/newt_ops.md) describes the command structure and details all the available commands to help you with your project.
-* [Chapter 4: Newt OS](chapter4/mynewt_os.md) provides an overview of the features available and how to customize for your hardware and software application.
+* [Chapter 4: Newt OS](os/newt_os.md) provides an overview of the features available and how to customize for your hardware and software application.
-* [Chapter 5: Modules](chapter5/console.md) lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components.
+* [Chapter 5: Modules](modules/console.md) lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components.
-* [Chapter 6: Creating packages for distribution](chapter6/dist.md) delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.
+* [Chapter 6: Creating packages for distribution](packaging/dist.md) delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.
### Contributing to Documentation
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/modules/bootloader.md
----------------------------------------------------------------------
diff --git a/docs/modules/bootloader.md b/docs/modules/bootloader.md
new file mode 100644
index 0000000..381630a
--- /dev/null
+++ b/docs/modules/bootloader.md
@@ -0,0 +1,148 @@
+# Bootloader
+
+Insert synopsis here
+
+
+## Description
+
+Describe module here, special features, how pieces fit together etc.
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [boot_slot_addr](#function-boot_slot_addr)
+* [boot_find_image_slot](#function-boot_find_image_slot)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function boot_slot_addr </font>
+
+```
+ static void
+ boot_slot_addr(int slot_num, uint8_t *flash_id, uint32_t *address)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function boot_find_image_slot </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/modules/console.md
----------------------------------------------------------------------
diff --git a/docs/modules/console.md b/docs/modules/console.md
new file mode 100644
index 0000000..4e0bd73
--- /dev/null
+++ b/docs/modules/console.md
@@ -0,0 +1,546 @@
+# Console
+
+
+The console is an operating system window where users interact with system programs of the operating system or a console application by entering text input (typically from a keyboard) and reading text output (typically on the computer terminal). The text written on the console brings some information and is a sequence of characters sent by the OS or programs running on the OS.
+
+Support is currently available for console access via the serial port on the hardware board.
+
+
+## Description
+
+In the Mynewt OS, the console library comes in two versions:
+
+* full - containing the full implementation
+* stub - containing stubs for the API
+
+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:
+
+ egg.name: libs/shell
+ egg.vers: 0.1
+ egg.deps:
+ - libs/console/full
+ - libs/os
+ egg.identities:
+ - SHELL
+
+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 `libs/os` egg that can print out messages on a console (e.g. if there is a hard fault) and the `libs/util` 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:
+
+ project.name: boot
+ project.identities: bootloader
+ project.eggs:
+ - libs/os
+ - libs/bootutil
+ - libs/nffs
+ - libs/console/stub
+ - libs/util
+
+## Data structures
+
+
+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 `cr_tail` and the write location indicator the `cr_head`. The console ring length is variable and is specified as the `cr_size` member of the data structure. `cr_buf` is the pointer to the actual array of data contained.
+
+
+```
+struct console_ring {
+ 32 uint8_t cr_head;
+ 33 uint8_t cr_tail;
+ 34 uint8_t cr_size;
+ 35 uint8_t _pad;
+ 36 uint8_t *cr_buf;
+ 37 }
+```
+
+
+```
+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;
+ 43 uint8_t ct_rx_buf[CONSOLE_RX_BUF_SZ]; /* must be after console_ring */
+ 44 console_rx_cb ct_rx_cb; /* callback that input is ready */
+ 45 console_write_char ct_write_char;
+ 46 } console_tty
+```
+
+## List of Functions
+
+The functions available in console are:
+
+* [console_printf](#function-console_printf)
+* [console_add_char](#function-console_add_char)
+* [console_pull_char](#function-console_pull_char)
+* [console_pull_char_head](#function-console_pull_char_head)
+* [console_queue_char](#function-console_queue_char)
+* [console_blocking_tx](#function-console_blocking_tx)
+* [console_blocking_mode](#function-console_blocking_mode)
+* [console_write](#function-console_write)
+* [console_read](#function-console_read)
+* [console_tx_char](#function-console_tx_char)
+* [console_rx_char](#function-console_rx_char)
+* [console_init](#function-console_init)
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function console_printf</font>
+
+```
+ void
+ console_printf(const char *fmt, ...)
+```
+
+Writes a formatted message instead of raw output to the console. It first composes a C string containing text specified as arguments to the function or containing the elements in the variable argument list passed to it using snprintf or vsnprintf, respectively. It then uses function `console_write` to output the formatted data (messages) on the console.
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| fmt | Pointer to C string that contains a format string that follows the same specifications as format in printf. The string is printed to console. |
+| ... | Depending on the format string, the function may expect either a sequence of additional arguments to be used to replace a format specifier in the format string or a variable arguments list. va_list is a special type defined in <cstdarg> in stdarg.h. |
+
+#### Returned values
+
+None
+
+#### Notes
+
+While `console_printf`, with its well understood formatting options in C, is more convenient and easy on the eyes than the raw output of `console_write`, the associated code size is considerably larger.
+
+#### Example
+Example #1:
+
+```
+char adv_data_buf[32];
+
+void
+task()
+{
+ char adv_data_buf[32];
+
+ console_printf("%s", adv_data_buf);
+}
+```
+
+Example #2:
+
+```
+struct exception_frame {
+ uint32_t r0;
+ uint32_t r1;
+
+struct trap_frame {
+ struct exception_frame *ef;
+ uint32_t r2;
+ uint32_t r3;
+};
+
+void
+task(struct trap_frame *tf)
+{
+ console_printf(" r0:%8.8x r1:%8.8x", tf->ef->r0, tf->ef->r1);
+ console_printf(" r8:%8.8x r9:%8.8x", tf->r2, tf->r3);
+}
+```
+
+---------------------
+
+### <font color="#2980b9"> function console_add_char</font>
+
+```
+ static void
+ console_add_char(struct console_ring *cr, char ch)
+```
+
+Adds a character to the console ring buffer. When you store an item in the buffer you store it at the head location, and the head advances to the next location.
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| *cr | Pointer to a console ring data structure whose `cr_head` variable is to be set to the second argument in this function call|
+| ch | Character to be inserted to the ring |
+
+#### Returned values
+
+None
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Add a new line character to the output (transmit) buffer.
+
+```
+void
+task()
+{
+ struct console_ring *tx = &ct->ct_tx;
+
+ console_add_char(tx, '\n');
+}
+```
+
+-------------------
+
+### <font color="#2980b9"> function console_pull_char </font>
+
+```
+ static uint8_t
+ console_pull_char(struct console_ring *cr)
+```
+
+Reads (remove) a byte from the console ring buffer. When you read (pull) an item, you read it at the current tail location, and the tail advances to the next position.
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| *cr | Pointer to the console ring buffer from where a character is to be removed |
+
+
+#### Returned values
+
+Returns the character pulled from the ring buffer.
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Read the characters in the ring buffer into a string.
+
+```
+void
+task(struct console_ring *cr, char *str, int cnt)
+{
+ for (i = 0; i < cnt; i++) {
+ if (cr->cr_head == cr->cr_tail) {
+ i = -1;
+ break;
+ }
+ ch = console_pull_char(cr);
+ *str++ = ch;
+ }
+}
+```
+
+---------------
+
+### <font color="#2980b9"> function console_pull_char_head </font>
+
+```
+ static void
+ console_pull_char_head(struct console_ring *cr)
+```
+
+Removes the last character inserted into the ring buffer by moving back the head location and shrinking the ring size by 1.
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| cr | Pointer to the console ring buffer from which the last inserted character must be deleted |
+
+
+#### Returned values
+
+None
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+In order to see a character getting deleted when a user hits backspace while typying a command, the following needs to happen in sequence:
+
+* output a backspace (move cursor back one character)
+* output space (erasing whatever character there was before)
+* output backspace (move cursor back one character)
+* remove the previous character from incoming RX queue
+
+The example below shows console_pull_char_head being used for the last step.
+
+```
+void
+task(uint8_t data)
+{
+ struct console_tty *ct = (struct console_tty *)arg;
+ struct console_ring *tx = &ct->ct_tx;
+ struct console_ring *rx = &ct->ct_rx;
+
+ switch (data) {
+ case '\b':
+ console_add_char(tx, '\b');
+ console_add_char(tx, ' ');
+ console_add_char(tx, '\b');
+ console_pull_char_head(rx);
+ break;
+ }
+}
+
+```
+
+-------------
+
+### <font color="#2980b9"> function console_queue_char </font>
+
+```
+ static void
+ console_queue_char(char ch)
+```
+
+Manage the buffer queue before inserting a character into it. If the head of the output (transmit) console ring is right up to its tail, the queue needs to be drained first before any data can be added. Then it uses console_add_char function to add the character.
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| ch | Character to be inserted to the queue |
+
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+This function makes sure no interrupts are allowed while the transmit buffer is draining and the character is being added.
+
+#### Example
+
+```
+Insert example
+```
+------------------
+
+### <font color="#2980b9"> function console_blocking_tx </font>
+
+```
+ static void
+ console_blocking_tx(char ch)
+```
+
+ Calls the hal function hal_uart_blocking_tx to transmit a byte to the console over UART in a blocking mode until the character has been sent. Hence it must be called with interrupts disabled. It is used when printing diagnostic output from system crash.
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+-----------
+
+### <font color="#2980b9"> function console_blocking_mode </font>
+
+```
+ void
+ console_blocking_mode(void)
+```
+ Calls the console_blocking_tx function to flush the buffered console output (transmit) queue. The function OS_ENTER_CRITICAL() is called to disable interrupts and OS_EXIT_CRITICAL() is called to enable interrupts back again once the buffer is flushed.
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+
+### <font color="#2980b9">function console_write </font>
+
+```
+ void
+ console_write(char *str, int cnt)
+```
+Transmit characters to console display over serial port.
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+
+### <font color="#2980b9"> function console_read </font>
+
+```
+ int
+ console_read(char *str, int cnt)
+```
+ Calls hal function hal_uart_start_rx to start receiving input from console terminal over serial port.
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+
+### <font color="#2980b9"> function console_tx_char </font>
+
+ ```
+ static int
+ console_tx_char(void *arg)
+ ```
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+
+### <font color="#2980b9"> function console_rx_char </font>
+
+```
+ static int
+ console_rx_char(void *arg, uint8_t data)
+```
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+
+### <font color="#2980b9"> function console_init </font>
+
+```
+ int
+ console_init(console_rx_cb rx_cb)
+```
+
+ Initializes console receive buffer and calls hal funtions hal_uart_init_cbs and hal_uart_config to initialize serial port connection and configure it (e.g. baud rate, flow control etc.)
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/modules/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/modules/filesystem.md b/docs/modules/filesystem.md
new file mode 100644
index 0000000..dc1ad43
--- /dev/null
+++ b/docs/modules/filesystem.md
@@ -0,0 +1,149 @@
+# Filesystem
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe module here, special features, how pieces fit together etc.
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [nffs_lock](#function-nffs_lock)
+* [nffs_unlock](#function-nffs_unlock)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function nffs_lock </font>
+
+```
+ static void
+ nffs_lock(void)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function nffs_unlock </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/modules/shell.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell.md b/docs/modules/shell.md
new file mode 100644
index 0000000..1b2928a
--- /dev/null
+++ b/docs/modules/shell.md
@@ -0,0 +1,147 @@
+# Shell
+
+Insert synopsis here
+
+
+## Description
+
+Describe module here, special features, how pieces fit together etc.
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<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.>
+
+The functions available in this OS feature are:
+
+* [shell_cmd_list_lock](#function-shell_cmd_list_lock)
+* [shell_cmd_list_unlock](#function-shell_cmd_list_unlock)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function shell_cmd_list_lock </font>
+
+```
+ static int
+ shell_cmd_list_lock(void)
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function shell_cmd_list_unlock </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
[06/11] incubator-mynewt-site git commit: fixed anchors in project
Blinky - still need to update Windows instructions for hardware target
Posted by ad...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter2/project2.md
----------------------------------------------------------------------
diff --git a/docs/chapter2/project2.md b/docs/chapter2/project2.md
deleted file mode 100644
index 3a6e5a6..0000000
--- a/docs/chapter2/project2.md
+++ /dev/null
@@ -1,374 +0,0 @@
-## Project 2 - Blinky on additional boards
-
-### Objective
-
-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. In the process you will be exposed to more Mynewt terms and Newt tool commands.
-
-The following target hardware chips are covered:
-
-* [STM32F303VC MCU](#stm32f303vc-mcu) from STMicroelectronics
-* [nRF52 Series](#nrf52-series) from Nordic Semiconductors
-
-
-### STM32F303VC MCU
-
-#### Hardware needed
-
-* Discovery kit with STM32F303VC MCU
-* Laptop running Mac OS
-
-
-#### Step by Step Instructions to build image
-
-* 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.
-
- [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
-
-
-* 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 (`clutch.yml`) 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.
-
- [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.
-
-* 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.
-
- [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!
-
-* It's time to create a target for the project and define the target attributes.
-
- [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
-
-* 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 [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)
-
-* 
-
-
- [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!
-
-* Finally, you have to download the image on to the board. You will see a blue light start to blink.
-
- [user:~/dev/test_project]$ newt target download blink_f3disc
- Downloading with /Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3discovery_download.sh
-
-
-
-### nRF52 Series
-
-
-#### Hardware needed
-
-* nRF52 Development Kit
-* Laptop running Mac OS
-
-
-#### Step by Step Instructions to build image
-
-* The first step is to download the generic skeleton of the project. The eggs installed are not hardware architecture specific.
-
- []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/
-
-
-* 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 (`clutch.yml`) 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.
-
- []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.
-
-* 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.
-
- [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!
-
-
-* It's time to create a target for the project and define the target attributes.
-
- [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
-
-
-* 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.
-
- [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!
-
-* 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 [https://www.segger.com/jlink-software.html](https://www.segger.com/jlink-software.html). The command line version of the server is used in the steps below.
-
-* Open a new terminal and start a J-Link session.
-
- [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
-
-
-* 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.
-
- [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
-
-* Start the gdb session and monitor that it loads the image, resets the target, and halts for a command to continue.
-
- [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 ***
-
-* 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.
-
- (gdb) c
- Continuing.
-
-
-
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter2/project3.md
----------------------------------------------------------------------
diff --git a/docs/chapter2/project3.md b/docs/chapter2/project3.md
deleted file mode 100644
index 43e6a59..0000000
--- a/docs/chapter2/project3.md
+++ /dev/null
@@ -1 +0,0 @@
-## How to Test an Egg
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter2/vocabulary.md
----------------------------------------------------------------------
diff --git a/docs/chapter2/vocabulary.md b/docs/chapter2/vocabulary.md
deleted file mode 100644
index 5e6b792..0000000
--- a/docs/chapter2/vocabulary.md
+++ /dev/null
@@ -1,170 +0,0 @@
-## Understanding Newt Terms
-
-### Nest
-
-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.
-
-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 [eggs](#egg). A project could be an egg itself as well. In addition to eggs, a local nest will contain additional items such as [target](#target) or build definitions, clutch description files, scripts etc.
-
-For example, a walk through the "larva" nest at [https://github.com/mynewt/larva.git](https://github.com/mynewt/larva.git) 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.
-
-```
-larva
- |- nest.yml
- |- compiler
- |- arm-none-eabi-m4
- |- sim
- |- hw (hardware)
- |- bsp (board support package)
- |- nrf52pdk (Nordic nRF52 series chip)
- |- egg.yml
- |- ...
- |- olimex_stm32-e407_devboard (used in chapter1 project)
- |- egg.yml
- |- ...
- |- stm32f3discovery (another board with stm32f3 mcu)
- |- egg.yml
- |- ...
- |- yet another board
- |- egg.yml
- |- ...
- |- hal (hardware abstraction layer APIs)
- |- egg.yml
- |- include
- |- hal_cputime.h
- |- hal_flash.h
- |- hal_gpio.h
- |- ... (header files for other peripherals)
- |- mcu (microcontroller)
- |- stm (STMicro family)
- |- stm32f3xx (STM32f3 series, 32-bit ARM Cortex-M4 core)
- |- egg.yml
- |- src
- |- hal_gpio.c (specific to the STM32f3 mcu)
- |- hal_cputime.c
- |- ... (code for other peripherals)
- |- nordic (Nordic Semiconductor family)
- |- nrf52xxx (nRF52 Series SoC, Cortex-M4F core)
- |- egg.yml
- |- src
- |- hal_gpio.c (specific to the nRF52 mcu )
- |- hal_cputime.c
- |- ... (code for other peripherals)
- |- yet another family of mcu
- |- ...
- |- libs
- |- bootutil (hw architecture independent boot loader library)
- |- egg.yml
- |- src
- |- loader.c
- |- ... (related source code files)
- |- nffs (hw architecture independent Newtron Flash File System)
- |- egg.yml
- |- src
- |- nffs.c
- |- ... (related source code files)
- |- another library
- |- egg.yml
- |- src
- |- ... (related source code files)
- |- project
- |- scripts
-
-
-```
-
-The newt tool offers the `nest` 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 `nest` command can be found in the newt tool reference in Chapter 3.
-
- newt nest [flags]
- newt nest [child-commands]
-
-A complete list of all the nest commands can be found in the newt tool reference in [Chapter 3](../chapter3/newt_tool_reference.md).
-
-### Project
-
-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.
-
-Layout-wise, a project is a directory inside a nest and contains eggs required for a certain application. For example, the `blinky` egg sits in `project/blinky` directory of the `larva` nest. This egg is used in the blinky project (application) outlined in [Chapter 1](../chapter1/project1.md). <*Note: This Will Change*>
-
-A project has the following concepts or properties associated with it. You can find them in the `<project-name>.yml` file in the project directory. For example, the `project/blinky` directory has the `blinky.yml` 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.
-
-* Project name
-* Base path of the project (nest/project/project-name by default)
-* Eggs belonging to the project
-* [Capabilities](#capabilities) that are required for the project or target
-* [Identity](#identity) to classify the type of project or target
-* Compiler flags to call out any specific compiler requirement
-
-A project could itself be an egg if it is a distributable package for a specific application.
-
-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.
-
- newt egg install [flags] <project egg name>
-
-### Egg
-
-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.
-
-The two main directories in an egg are `/include` and `/src`.
-
-The newt tool offers several egg commands to list, inspect, install, and do other operations on eggs. For example, the following command
-
- newt egg list
-
-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.
-
- Egg libs/os, version 0.1.0
- path: /Users/aditihilbert/dev/test_project/libs/os
- deps: libs/testutil@none#stable
-
-A complete list of all the egg commands can be found in the newt tool reference in [Chapter 3](../chapter3/newt_tool_reference.md).
-
-### Clutch
-
-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 `clutch.yml` 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 ]
-
-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 `.nest/clutches` directory in your nest.
-
-The newt tool offers clutch management commands within the `newt nest` 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 `clutch.yml` file in the nest.
-
- newt nest generate-clutch <name> <url>
-
-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.
-
-### Eggshell
-
-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.
-
- newt nest list-clutches
-
-So, if you had two clutches installed, the output could be:
-
- Remote clutch larva (eggshells: 19)
- Remote clutch ble_test (eggshells: 15)
-
-### Target
-
-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.
-
- blink_f3disc
- compiler_def: debug
- compiler: arm-none-eabi-m4
- name: blink_f3disc
- arch: cortex_m4
- project: blinky
- bsp: hw/bsp/stm32f3discovery
-
-The newt tool offers commands to create, set up and manipulate targets. For example, the create command below creates an empty target named `my_target1` and the set command sets one detail of its definition, namely the architecture.
-
- newt target create my_target1
- newt target set my_target1 arch=cortex_m4
-
-### Capability
-
-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.
-
-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.
-
-### Identity
-
-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.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter3/newt_ops.md
----------------------------------------------------------------------
diff --git a/docs/chapter3/newt_ops.md b/docs/chapter3/newt_ops.md
deleted file mode 100644
index 39171d0..0000000
--- a/docs/chapter3/newt_ops.md
+++ /dev/null
@@ -1,40 +0,0 @@
-## Command Structure
-
-In the newt tool, commands represent actions and flags are modifiers for those actions. A command can have children commands which are also simply referred to as commands. One or more arguments may need to be provided to a command to execute it correctly.
-
-In the example below, the `newt` command has the child command `target set`. The first argument 'my_target1' is the name of the target whose attributes are being set. The second argument 'arch=cortex_m4' specifies the value to set the attribute (variable) 'arch' to, which in this case is 'cortex_m4'.
-
- newt target set my_target1 arch=cortex_m4
-
-Global flags work on all newt commands in the same way. An example is the flag `-v, --verbose` to ask for a verbose output while executing a command. The help flag `-h` or `--help` is available on all commands but provides command specific output, of course. These flags may be specified in either a long or a short form.
-
-A command may additionally take flags specific to it. For example, the `-b ` flag may be used with `newt egg install` to tell it which branch to install the egg from.
-
- newt egg install -b <branchname> <eggname>
-
-In addition to the newt tool [reference](../chapter3/newt_tool_reference.md) in this documentation set, command-line help is available for each command (and child command). Simply use the flag `-h` or `--help` as shown below:
-
- $ newt target export --help
- Export build targets from the current nest, and print them to
- standard output. If the -a (or -export-all) option is specified,
- then all targets will be exported. Otherwise, <target-name>
- must be specified, and only that target will be exported.
-
- Usage:
- newt target export [flags]
-
- Examples:
- newt target export [-a -export-all] [<target-name>]
- newt target export -a > my_exports.txt
- newt target export my_target > my_target_export.txt
-
- Flags:
- -a, --export-all=false: If present, export all targets
- -h, --help=false: help for export
-
- Global Flags:
- -l, --loglevel="WARN": Log level, defaults to WARN.
- -q, --quiet=false: Be quiet; only display error output.
- -s, --silent=false: Be silent; don't output anything.
- -v, --verbose=false: Enable verbose output when executing commands.
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter3/newt_tool_reference.md
----------------------------------------------------------------------
diff --git a/docs/chapter3/newt_tool_reference.md b/docs/chapter3/newt_tool_reference.md
deleted file mode 100644
index 27cf442..0000000
--- a/docs/chapter3/newt_tool_reference.md
+++ /dev/null
@@ -1,269 +0,0 @@
-
-## Command List
-
-### Available high-level commands
-
-```
-version Display the Newt version number
-help Help about any command
-nest Commands to manage nests & clutches (remote egg repositories)
-egg Commands to list and inspect eggs on a nest
-target Set and view target information
-```
-
-### *version*
-
-#### Usage:
-
- newt version [flags]
-
-Flags:
-
- -h, --help=false: help for version
-
-Global Flags:
-
- -h, --help=false: help for newt
-
-
-Examples
-
-Sub-command | Usage | Explanation
--------------| -----------------------|-----------------
-version | newt version | Displays the version of newt tool installed
-
-
-### *help*
-
-#### Usage:
-
- newt help [input1]
-
-Flags:
-
-```
-
--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.
-```
-
-Examples
-
-Sub-command | Usage | Explanation
--------------| -----------------------|-----------------
-help | newt help target | Displays the help text for the newt command 'target'
-help | newt help | Displays the help text for newt tool
-
-
-
-### *nest*
-
-#### Usage:
-
- newt nest [command][flags] input1 input2...
-
-Available commands:
-
- create Create a new nest
- generate-clutch Generate a clutch file from the eggs in the current directory
- add-clutch Add a remote clutch, and put it in the current nest
- list-clutches List the clutches installed in the current nest
- show-clutch Show an individual clutch in the current nest
-
-
-Flags:
-
- -h, --help=false: help for nest
-
-Global 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.
-
-Description
-
-Sub-command | Explanation
--------------| ------------------------
-create | Downloads the skeleton of a nest on your local machine from the optional `input2` nest url, if specified, and creates a new nest directory by the name of `input1`. If `input2` is not specified, then a default skeleton from the `tadpole` nest on Mynewt is downloaded. The command lays out a generic directory structure for the nest you are going to build under it and includes some default eggs in it.
-generate-clutch | Takes a snapshot of the eggs in the current local directory and combines them into a clutch by the name of `input1` and with the url of `input2` and generates a standard output of the clutch details that can be redirected to a `.yml` clutch file. Typically the clutch file name is chosen to match the clutch name which means the standard output should be directed to a clutch file named `input1.yml`
-add-clutch | Downloads the clutch of the name `input1` from the master branch of the github repository `input2` into the current nest. A file named `input1.yml` file is added in the `.nest/clutches` subdirectory inside the current local nest. The `.nest/` directory structure is created automatically if it does not exist.
-list-clutches | Lists all the clutches present in the current nest, including clutches that may have been added from other nests on github. The output shows all the remote clutch names and the total eggshells in each of the clutches.
-show-clutch | Shows information about the clutch that has the name given in the `input1` argument. Output includes the clutch name, url, and all the constituent eggs with their version numbers.
-
-Command-specific flags
-
-Sub-command | Available flags | Explanation
--------------| ----------------|------------
-add-clutch | -b, --branch="<branch-name>" | Fetches the clutch file with name `input1` from the specified branch at `input1` url of the github repository. All subsequent egg installations will be done from that branch.
-
-Examples
-
-Sub-command | Usage | Explanation
--------------| -----------------------|-----------------
-create | newt nest create test_project | Creates a new nest named "test_project " using the default skeleton0
-create | newt nest create mynest <nest-url> | Creates a new nest named "mynest" using the skeleton at the <nest-url> specified
-generate-clutch | newt nest generate-clutch myclutch https://www.github.com/mynewt/larva > myclutch.yml| Takes a snapshot of the eggs in the current nest to form a clutch named myclutch with the url https://www.github.com/mynewt/larva. The output is written to a file named `myclutch.yml` and describes the properties and contents of the clutch (name, url, eggs).
-add-clutch | newt nest add-clutch larva https://www.github.com/mynewt/larva | Adds the remote clutch named larva at www.github.com/mynewt/larva to the local nest.
-list-clutches | newt nest list-clutches | Shows all the remote clutch description files that been downloaded into the current nest
-show-clutch | newt nest show-clutch larva | Outputs the details of the clutch named larva such as the github url where the remote sits, the constituent eggs and their versions
-
-
-### *egg*
-
-#### Usage:
-
- newt egg [command][flag] input1 input2
-
-
-Available Commands:
-
- list List eggs in the current nest
- checkdeps Check egg dependencies
- hunt Search for egg from clutches
- show Show the contents of an egg.
- install Install an egg
- remove Remove an egg
-
-Flags:
-
- -h, --help=false: help for egg
-
-Global Flags:
-
- -l, --loglevel="WARN": Log level, defaults to WARN.
- -q, --quiet=false: Be quiet; only display error output.
- -s, --silent=false: Be silent; don't output anything.
- -v, --verbose=false: Enable verbose output when executing commands.
-
-Description
-
-Sub-command | Explanation
--------------| ------------------------
-list | List all the eggs in the current nest. The output shows the name, version, path, and any additional attributes of each egg in the nest such as dependencies, capabilities, and linker scripts. The newt command gets the attributes of each egg from the corresponsing egg.yml description file.
-checkdeps | Resolve all dependencies in the local nest. This command goes through all eggs currently installed, checks their dependencies, and prints any unresolved dependencies between eggs.
-hunt | Hunts for an egg, specified by `input1`. The local nest, along with all remote nests (clutches) are searched. All matched eggs are shown along with the clutch informaton. Installed eggs are called out as such. The command can be invoked from anywhere in the nest.
-show | Show the contents of the egg named `input2` found in the clutch named `input1`. The clutch name is optional; if only the egg name is given as the argument it is resolved using all the clutches installed in the current nest. If the egg is present in multiple clutches it will list all of them along with the clutch information for each.
-install | Install the egg specified by `input2` from the clutch named `input1`. The command downloads the egg from the github repository using the URL in the clutch description file (typically donwloaded as 'input1@<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.
-remove | Remove an egg named `input2` from clutch `input1`, if clutch is specified. Otherwise only one input required - that of the name of the egg to be removed from the local nest.
-
-
-
-
-Command-specific flags
-
-Sub-command | Available flags | Explanation
--------------| ----------------|------------
-install | -b, --branch="<branch-name>" | Installs the eggs from the branch name or tag of the clutch specified
-
-Examples
-
-Sub-command | Usage | Explanation
--------------| -----------------------|-----------------
-list | newt egg list | CList all of the eggs in the current nest and the details of the eggs.
-checkdeps | newt egg checkdeps | Checks all the dependencies between eggs in the nest. Lists any unresolved dependencies.
-hunt | newt egg hunt blinky| Hunts for the egg named 'blinky'. The command can be invoked from anywhere in the nest. Results show if the egg is installed and which clutch, if any, has the egg.
-show | newt egg show larva libs/os | Show the contents of the egg named 'libs/os' in the clutch named larva. The contents are essentially derived from the egg's 'egg.yml' file.
-install | newt egg install hw/bsp/stm32f3discovery | Downloads and installs the egg named "stm32f3discovery" (specified with its full path name inside the remote nest) along with all its dependencies from the remote nest on github. Since no clutch is specified, the URL for the remote nest in the clutch description file found in the local nest (in .nest/clutches for the project) is used.
-remove | newt egg remove larva blinky| Removes the egg named blinky only from the clutch named larva
-remove | newt egg remove blinky| Removes the egg named blinky from the local nest
-
-
-### *target*
-
-#### Usage:
-
-Usage:
-
- newt target [command] input1 [flag1] [flag2]
-
-Available Commands:
-
- set Set target configuration variable
- unset Unset target configuration variable
- delete Delete target
- create Create a target
- show View target configuration variables
- build Build target
- test Test target
- export Export target
- import Import target
- download Download image to target
- debug Download image to target and start an openocd/gdb session
-
-Flags:
-
- -h, --help=false: help for target
-
-Global Flags:
-
- -l, --loglevel="WARN": Log level, defaults to WARN.
- -q, --quiet=false: Be quiet; only display error output.
- -s, --silent=false: Be silent; don't output anything.
- -v, --verbose=false: Enable verbose output when executing commands.
-
-Description
-
-Sub-command | Explanation
--------------| ------------------------
-set | Set attributes of the target. Currently the list of possible attributes are:``` arch, compiler, compiler_def, project, bsp, egg, identities, capabilities, dependencies, cflags, lflags```. Typically only the first 5 need to be set for a hardware target. For a simulated target, e.g. for software testing purposes, `arch=sim`, `compiler=sim`, and `egg=<egg name to be tested>`. You cannot set both the project and egg for a target.
-unset | Unset attributes of the target in its configuration.
-delete | Deletes only the description for the target. Does not delete the target directory with associated binaries. If you want to clean out the binaries, list files, and executables use`newt target build <target-name> clean` **before** deleting the target!
-create | Creates a target description or build definition by the name `input1`. By default it assigns the sim (simulator) architecture to it which allows you to build new projects and software on your native OS and try it out.
-show | Display the configuration defined for the target named `input1`. If no `input1` is specified then show the details for all the targets in the nest.
-build | Build the source code into an image that can be loaded on the hardware associated with the target named `input1` to do the application enabled by the 'project' associated with that target (via the target definition). It creates 'bin/' and 'bin/<input1>/' subdirectories inside the base directory for the project, compiles and generates binaries and executables, and places them in 'bin/<input1>/.
-test | Test an egg on the target named `input1`. The egg is either supplied as an argument to the command line invocation of `newt target test` or added as part of the target definition. If only the target is specified as `input1`, then the egg in the target's definition is automatically chosen to be tested. You currently cannot test an entire project on a hardware target. The test command is envisioned for use if one or two eggs gets updated and each needs to be tested against a target. Alternatively, a script may be written for a series of tests on several eggs.
-export | Exports the configurations of the specified target `input1`. If -a or -export-all flag is used, then all targets are exported and printed out to standard out. You may redirect the output to a file.
-import | Import one or more target configuration from standard input or a file. Each target starts with `@target=<target-name>` followed by the attributes. The list of targets should end with `@endtargets`.
-size | Outputs the RAM and flash consumption by the components of the specified target `input1`.
-download | Downloads the binary executable `<target-name>.elf.bin` to the board.
-debug | Downloads the binary executable `<target-name>.elf.bin` to the board and starts up the openocd/gdb combination session. gdb takes over the terminal.
-
-
-Command-specific flags
-
-Sub-command | Available flags | Explanation
--------------| ----------------|------------
-build | clean | All the binaries and object files for the specified target will be removed. The subdirectory named after the specified target within that project is removed.
-build clean | all | All the binaries and object files for all targets are removed, and subdirectories of all targets for the project are removed. However, the entire repository is not emptied since any eggs or projects that the specified target doesn't reference are not touched.
-export | -a, -export-all | Export all targets. `input1` is not necessary when this flag is used.
-import | -a, -import-all | Import all targets typed into standard input or redirected from a file.
-
-Examples
-
- Sub-command | Usage | Explanation
--------------| -----------------------|-----------------
-set | newt target set myblinky compiler=arm-none-eabi-m4 | Set the compiler for the 'myblinky' target to the gcc compiler for embedded ARM chips.
-unset | newt target unset myblinky compiler | Remove the setting for the compiler for the 'myblinky' target.
-delete | newt target delete myblinky | Delete the target description for the target named 'myblinky'. Note that it does not remove any binaries or clean out the directory for this target.
-create | newt target create blink_f3disc | Create a new target description by the name 'blink_f3disc'. The architecture is 'sim' by default and can be changed using subcommand 'set' above.
-show | newt target show myblinky | Show the target attributes set for 'myblinky'
-build | newt target build blink_f3disc | Compile the source code for the target named blink_f3disc and generate binaries that can be loaded into the target hardware.
-test | newt target test test_target egg=libs/os | Tests the egg named 'libs/os' against the target named 'test_target'
-export | newt target export -a > my_exports.txt | Export all build targets from the current nest, and redirect output to a file named 'my_exports.txt'.
-export | newt target export -export-all | Export all build targets from the current nest, and print them to standard output on the screen.
-export | newt target export my_target | Export only target named 'my_target' and print it to standard output on the screen.
-import | newt target import ex_tgt_1 < exported_targets.txt | Imports the target configuration for 'ex_tgt_1' in 'exported_targets.txt'.
-import | newt target import -a < in_targets.txt | Imports all the targets specified in the file named `in_targets.txt`. A sample file is shown after this table.
-size | newt target size blink_nordic | Inspects and lists the RAM and Flash memory use by each component (object files and libraries) of the target.
-download | newt target -v -lVERBOSE download blinky | Downloads `blinky.elf.bin` to the hardware in verbose mode with logging turned on at VERBOSE level.
-debug | newt target debug blinky | Downloads `blinky.elf.bin` to the hardware, opens up a gdb session with `blinky.elf` in the terminal, and halts for further input in gdb.
-
-Example content for `in_targets.txt` file used for importing targets `test3` and `test4`.
-
-> @target=test3
-project=blinked
-arch=sim
-compiler_def=debug
-compiler=arm-none-eabi-m4
-@target=test4
-project=super_blinky
-arch=sim
-compiler_def=debug
-compiler=arm-none-eabi-m4
-@endtargets
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/context_switch.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/context_switch.md b/docs/chapter4/context_switch.md
deleted file mode 100644
index d2e8b80..0000000
--- a/docs/chapter4/context_switch.md
+++ /dev/null
@@ -1,149 +0,0 @@
-# Scheduler/Context Switching
-
-
-Insert synopsis here
-
-
-## Description
-
-Describe scheduler here
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in the scheduler are:
-
-* [os_sched_insert](#function-os_sched_insert)
-* [os_sched_walk](#function-os_sched_walk)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function os_sched_insert</font>
-
-```
- os_error_t
- os_sched_insert(struct os_task *t)
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function os_sched_walk</font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/event_queue.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/event_queue.md b/docs/chapter4/event_queue.md
deleted file mode 100644
index 6de4adb..0000000
--- a/docs/chapter4/event_queue.md
+++ /dev/null
@@ -1,149 +0,0 @@
-# Event Queues
-
-
-Insert synopsis here
-
-
-## Description
-
-Describe scheduler here
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [os_eventq_init](#function-os_eventq_init)
-* [os_eventq_put2](#function-os_eventq_put2)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function os_eventq_init</font>
-
-```
- void
- os_eventq_init(struct os_eventq *evq)
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function os_eventq_put2</font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/heap.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/heap.md b/docs/chapter4/heap.md
deleted file mode 100644
index b960c26..0000000
--- a/docs/chapter4/heap.md
+++ /dev/null
@@ -1,149 +0,0 @@
-# Heap
-
-
-Insert synopsis here
-
-
-## Description
-
-Describe OS feature here
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [os_malloc_lock](#function-os_malloc_lock)
-* [os_malloc_unlock](#function-os_malloc_unlock)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function os_malloc_lock</font>
-
-```
- static void
- os_malloc_lock(void)
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function os_malloc_unlock</font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/mbufs.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/mbufs.md b/docs/chapter4/mbufs.md
deleted file mode 100644
index c2938fc..0000000
--- a/docs/chapter4/mbufs.md
+++ /dev/null
@@ -1,150 +0,0 @@
-# Mbufs
-
-
-Insert synopsis here
-
-
-## Description
-
-Describe OS feature here
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [os_mbuf_pool_init](#function-os_mbuf_pool_init)
-* [os_mbuf_get](#function-os_mbuf_get)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function os_mbuf_pool_init</font>
-
-```
- 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)
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function os_mbuf_get</font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/memory_pool.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/memory_pool.md b/docs/chapter4/memory_pool.md
deleted file mode 100644
index 4048648..0000000
--- a/docs/chapter4/memory_pool.md
+++ /dev/null
@@ -1,151 +0,0 @@
-# Memory Pools
-
-
-Insert synopsis here
-
-
-## Description
-
-Describe OS feature here
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [os_mempool_init](#function-os_mempool_init)
-* [os_memblock_get](#function-os_memblock_get)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function os_mempool_init</font>
-
-```
- os_error_t
- os_mempool_init(struct os_mempool *mp, int blocks,
- int block_size, void *membuf, char *name)
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function os_memblock_get</font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/mutex.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/mutex.md b/docs/chapter4/mutex.md
deleted file mode 100644
index 0e0c329..0000000
--- a/docs/chapter4/mutex.md
+++ /dev/null
@@ -1,150 +0,0 @@
-# Mutex
-
-
-Mutex is short for "mutual exclusion"; a mutex provides mutually exclusive access to a shared resource. A mutex provides *priority inheritance* in order to prevent *priority inversion*. Priority inversion occurs when a higher priority task is waiting on a resource owned by a lower priority task. Using a mutex, the lower priority task will inherit the highest priority of any task waiting on the mutex.
-
-
-## Description
-
-Describe OS feature here
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [os_mutex_init](#function-os_mutex_init)
-* [os_mutex_release](#function-os_mutex_release)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function os_mutex_init</font>
-
-```
- os_error_t
- os_mutex_init(struct os_mutex *mu)
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function os_mutex_release</font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/mynewt_os.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/mynewt_os.md b/docs/chapter4/mynewt_os.md
deleted file mode 100644
index f1865c4..0000000
--- a/docs/chapter4/mynewt_os.md
+++ /dev/null
@@ -1,167 +0,0 @@
-# Mynewt OS
-
-Insert introduction here
-
-## Real-Time Kernel <Modify as you Wish>
-
- Description
-
-## Real-Time OS <Modify as you Wish>
-
- Description
-
-
-## Insert topic of your choice
-
- Description
-
-## Features
-
-<Insert basic feature descriptions, how the various pieces fit together etc., what's special in Mynewt OS>
-
-* [Scheduler/context switching](context_switch.md)
-* [Time](time.md)
-* [Tasks](task.md)
-* [Event queues/callouts](event_queue.md)
-* [Semaphores](semaphore.md)
-* [Mutexes](mutex.md)
-* [Memory pools](memory_pool.md)
-* [Heap](heap.md)
-* [Mbufs](mbufs.md)
-* [Sanity](sanity.md)
-* [Porting OS to other platforms](port_os.md)
-
-## OS Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [os_idle_task](#function-os_idle_task)
-* [os_started](#function-os_started)
-* add the rest
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function os_idle_task</font>
-
-```
- void
- os_idle_task(void *arg)
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function os_started</font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/port_os.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/port_os.md b/docs/chapter4/port_os.md
deleted file mode 100644
index 1331dde..0000000
--- a/docs/chapter4/port_os.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# Porting Mynewt OS
-
-
-This chapter describes how to adapt Newt OS to different processors. Adapting μC/OS-III to a microprocessor or a microcontroller is called porting.
-
-
-## Description
-
-
-## Insert sections as you wish
-
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/sanity.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/sanity.md b/docs/chapter4/sanity.md
deleted file mode 100644
index 8b021f4..0000000
--- a/docs/chapter4/sanity.md
+++ /dev/null
@@ -1,150 +0,0 @@
-# Sanity
-
-
-Insert synopsis here
-
-
-## Description
-
-Describe OS feature here
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [os_sanity_check_init](#function-os_sanity_check_init)
-* [os_sanity_check_list_lock](#function-os_sanity_check_list_lock)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function os_sanity_check_init</font>
-
-```
- int
- os_sanity_check_init(struct os_sanity_check *sc)
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function os_sanity_check_list_lock </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/semaphore.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/semaphore.md b/docs/chapter4/semaphore.md
deleted file mode 100644
index c05a1a8..0000000
--- a/docs/chapter4/semaphore.md
+++ /dev/null
@@ -1,149 +0,0 @@
-# Semaphore
-
-
-Insert synopsis here
-
-
-## Description
-
-Describe OS feature here
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [os_sem_init](#function-os_sem_init)
-* [os_sem_release](#function-os_sem_release)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function os_sem_init</font>
-
-```
- os_error_t
- os_sem_init(struct os_sem *sem, uint16_t tokens)
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function os_sem_release </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/task.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/task.md b/docs/chapter4/task.md
deleted file mode 100644
index 52d6481..0000000
--- a/docs/chapter4/task.md
+++ /dev/null
@@ -1,149 +0,0 @@
-# Tasks
-
-
-Insert synopsis here
-
-
-## Description
-
-Describe OS feature here
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [_clear_stack](#function-_clear_stack)
-* [os_task_next_id](#function-os_task_next_id)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function _clear_stack </font>
-
-```
- static void
- _clear_stack(os_stack_t *stack_bottom, int size)
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function os_task_next_id </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/chapter4/time.md
----------------------------------------------------------------------
diff --git a/docs/chapter4/time.md b/docs/chapter4/time.md
deleted file mode 100644
index 5daf9e9..0000000
--- a/docs/chapter4/time.md
+++ /dev/null
@@ -1,149 +0,0 @@
-# Time
-
-
-Insert synopsis here
-
-
-## Description
-
-Describe OS feature here
-
-## Data structures
-
-Replace this with the list of data structures used, why, any neat features
-
-## List of Functions
-
-<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.>
-
-The functions available in this OS feature are:
-
-* [os_time_get](#function-os_time_get)
-* [os_time_tick](#function-os_time_tick)
-* add the rest
-
-
-## Function Reference
-
-------------------
-
-### <font color="2980b9">function os_time_get </font>
-
-```
- os_time_t
- os_time_get(void)
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function os_time_tick </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
-
-### <font color="#2980b9"> function next_one </font>
-
-```
- <Insert function callout here >
-
-```
-
-<Insert short description>
-
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| xx | explain argument xx |
-| yy | explain argument yy |
-
-#### Returned values
-
-List any values returned.
-Error codes?
-
-#### Notes
-
-Any special feature/special benefit that we want to tout.
-Does it need to be used with some other specific functions?
-Any caveats to be careful about (e.g. high memory requirements).
-
-#### Example
-
-<Add text to set up the context for the example here>
-
-```
-
-<Insert the code snippet here>
-
-```
-
----------------------
\ No newline at end of file
[02/11] incubator-mynewt-site git commit: Partial update to
STM32discovery board instructions - more to come
Posted by ad...@apache.org.
Partial update to STM32discovery board instructions - more to come
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/515e9ad7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/515e9ad7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/515e9ad7
Branch: refs/heads/master
Commit: 515e9ad7bdeca43340ef3bf872dd28732ff89ae2
Parents: 66ee6b1
Author: aditihilbert <ad...@runtime.io>
Authored: Thu Dec 17 17:05:42 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Thu Dec 17 17:05:42 2015 -0800
----------------------------------------------------------------------
docs/chapter2/project2.md | 19 +++++++++++--------
1 file changed, 11 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/515e9ad7/docs/chapter2/project2.md
----------------------------------------------------------------------
diff --git a/docs/chapter2/project2.md b/docs/chapter2/project2.md
index ba7ec5c..3a6e5a6 100644
--- a/docs/chapter2/project2.md
+++ b/docs/chapter2/project2.md
@@ -41,22 +41,21 @@ The following target hardware chips are covered:
* 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.
-<font color="red"> The command should download from apache git repo, not github. </font>
-
-
[user:~/dev/test_project]$ newt egg install project/blinky
- Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!
+ 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.git/master... ok!
+ 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!
-
* It's time to create a target for the project and define the target attributes.
[user:~/dev/test_project]$ newt target create blink_f3disc
@@ -87,12 +86,12 @@ The following target hardware chips are covered:
compiler: arm-none-eabi-m4
name: blink_f3disc
-* Finally, you get to build the target and generate an executable that can now be uploaded to the board. The STM32F3DISCOVERY board includes an ST-LINK/V2 embedded debug tool interface that you will use 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 [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)
+* 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 [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)
* 
- [user:~/foo/test_project]$ newt target build blink_f3disc
+ [user:~/dev/test_project]$ newt target build blink_f3disc
Building target blink_f3disc (project = blinky)
Compiling case.c
Compiling suite.c
@@ -129,7 +128,11 @@ The following target hardware chips are covered:
Building project blinky
Linking blinky.elf
Successfully run!
+
+* Finally, you have to download the image on to the board. You will see a blue light start to blink.
+ [user:~/dev/test_project]$ newt target download blink_f3disc
+ Downloading with /Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3discovery_download.sh
[09/11] incubator-mynewt-site git commit: corrected newt_os.md to
mynewt_os.md in index.md
Posted by ad...@apache.org.
corrected newt_os.md to mynewt_os.md in index.md
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/0108b7d6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/0108b7d6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/0108b7d6
Branch: refs/heads/master
Commit: 0108b7d62bfc5b4660f0f05eb3d67858a021639d
Parents: 71e3922
Author: aditihilbert <ad...@runtime.io>
Authored: Fri Dec 18 11:28:07 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Fri Dec 18 11:28:07 2015 -0800
----------------------------------------------------------------------
docs/index.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0108b7d6/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index 92bcae6..c47128d 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -73,7 +73,7 @@ The chapter organization is outlined below. Each chapter will include one or mor
* [Chapter 3: Newt Tool Reference](newt/newt_ops.md) describes the command structure and details all the available commands to help you with your project.
-* [Chapter 4: Newt OS](os/newt_os.md) provides an overview of the features available and how to customize for your hardware and software application.
+* [Chapter 4: Newt OS](os/mynewt_os.md) provides an overview of the features available and how to customize for your hardware and software application.
* [Chapter 5: Modules](modules/console.md) lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components.
[08/11] incubator-mynewt-site git commit: Fixing chapter callout
errors
Posted by ad...@apache.org.
Fixing chapter callout errors
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/71e3922c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/71e3922c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/71e3922c
Branch: refs/heads/master
Commit: 71e3922cc1356da20e25fa58aaf8d5e8f3a76a23
Parents: 8aced2b
Author: aditihilbert <ad...@runtime.io>
Authored: Fri Dec 18 11:22:09 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Fri Dec 18 11:22:09 2015 -0800
----------------------------------------------------------------------
docs/get_acclimated/vocabulary.md | 8 ++++----
docs/index.md | 4 ++--
docs/newt/newt_ops.md | 2 +-
3 files changed, 7 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/71e3922c/docs/get_acclimated/vocabulary.md
----------------------------------------------------------------------
diff --git a/docs/get_acclimated/vocabulary.md b/docs/get_acclimated/vocabulary.md
index 5e6b792..d80384b 100644
--- a/docs/get_acclimated/vocabulary.md
+++ b/docs/get_acclimated/vocabulary.md
@@ -19,7 +19,7 @@ larva
|- nrf52pdk (Nordic nRF52 series chip)
|- egg.yml
|- ...
- |- olimex_stm32-e407_devboard (used in chapter1 project)
+ |- olimex_stm32-e407_devboard (used in Project Blinky)
|- egg.yml
|- ...
|- stm32f3discovery (another board with stm32f3 mcu)
@@ -78,13 +78,13 @@ The newt tool offers the `nest` command to create and manage nests. In general,
newt nest [flags]
newt nest [child-commands]
-A complete list of all the nest commands can be found in the newt tool reference in [Chapter 3](../chapter3/newt_tool_reference.md).
+A complete list of all the nest commands can be found in the newt tool reference in [Newt Tool](../newt/newt_tool_reference.md).
### Project
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.
-Layout-wise, a project is a directory inside a nest and contains eggs required for a certain application. For example, the `blinky` egg sits in `project/blinky` directory of the `larva` nest. This egg is used in the blinky project (application) outlined in [Chapter 1](../chapter1/project1.md). <*Note: This Will Change*>
+Layout-wise, a project is a directory inside a nest and contains eggs required for a certain application. For example, the `blinky` egg sits in `project/blinky` directory of the `larva` nest. This egg is used in the blinky project (application) outlined in [Get Started](../get_started/project1.md). <*Note: This Will Change*>
A project has the following concepts or properties associated with it. You can find them in the `<project-name>.yml` file in the project directory. For example, the `project/blinky` directory has the `blinky.yml` 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.
@@ -117,7 +117,7 @@ outputs all the eggs in the current nest where each egg has details on its versi
path: /Users/aditihilbert/dev/test_project/libs/os
deps: libs/testutil@none#stable
-A complete list of all the egg commands can be found in the newt tool reference in [Chapter 3](../chapter3/newt_tool_reference.md).
+A complete list of all the egg commands can be found in the newt tool reference in [Newt Tool](../newt/newt_tool_reference.md).
### Clutch
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/71e3922c/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index b4974bf..92bcae6 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,4 +1,4 @@
-#
+[ASF Incubator Project](images/egg-logo.png)
---
## Objective of Mynewt
@@ -88,7 +88,7 @@ To edit content in a Markdown file and be able to see how the changes look you m
* [Mou](http://25.io/mou/) for Mac
* [Something like Mou](http://alternativeto.net/software/mou/?platform=windows) for Windows
-Click on the tutorial [How to edit docs](chapter1/how_to_edit_docs.md) under "Get Started" to learn how to edit a sample file [try_markdown.md](chapter1/try_markdown.md) on Mynewt's documentation git repository.
+Click on the tutorial [How to edit docs](get_started/how_to_edit_docs.md) under "Get Started" to learn how to edit a sample file [try_markdown.md](get_started/try_markdown.md) on Mynewt's documentation git repository.
The static html content is generated and maintained in the asf-site branch in the documentation repository. Currently, the static html files are generated manually once a day. This will be automated in the future.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/71e3922c/docs/newt/newt_ops.md
----------------------------------------------------------------------
diff --git a/docs/newt/newt_ops.md b/docs/newt/newt_ops.md
index 39171d0..b4dc2c8 100644
--- a/docs/newt/newt_ops.md
+++ b/docs/newt/newt_ops.md
@@ -12,7 +12,7 @@ A command may additionally take flags specific to it. For example, the `-b ` fla
newt egg install -b <branchname> <eggname>
-In addition to the newt tool [reference](../chapter3/newt_tool_reference.md) in this documentation set, command-line help is available for each command (and child command). Simply use the flag `-h` or `--help` as shown below:
+In addition to the newt tool [reference](../newt/newt_tool_reference.md) in this documentation set, command-line help is available for each command (and child command). Simply use the flag `-h` or `--help` as shown below:
$ newt target export --help
Export build targets from the current nest, and print them to