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 21:27:08 UTC
[10/17] incubator-mynewt-site git commit: new chapter names and
references, updated but not complete Windows instructions for blinky project
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/get_acclimated/project2/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/project2/index.html b/get_acclimated/project2/index.html
new file mode 100644
index 0000000..83b5266
--- /dev/null
+++ b/get_acclimated/project2/index.html
@@ -0,0 +1,768 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Project 2 - Mynewt</title>
+
+
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "Project 2";
+ </script>
+
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
+ <script src="../../js/theme.js"></script>
+
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href="../.." class="icon icon-home"> Mynewt</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+ <li>
+ <li class="toctree-l1 ">
+ <a class="" href="../..">Home</a>
+
+ </li>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Started</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/newt_concepts/">Newt Concepts</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/project1/">Blinky, The First Project</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/how_to_edit_docs/">How to edit docs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/try_markdown/">Sample doc to edit</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Acclimated</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../vocabulary/">Understanding Newt Terms</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 current">
+ <a class="current" href="./">Project 2</a>
+
+ <ul>
+
+ <li class="toctree-l3"><a href="#project-2-blinky-on-additional-boards">Project 2 - Blinky on additional boards</a></li>
+
+ <li><a class="toctree-l4" href="#objective">Objective</a></li>
+
+ <li><a class="toctree-l4" href="#stm32f303vc-mcu">STM32F303VC MCU</a></li>
+
+ <li><a class="toctree-l4" href="#nrf52-series">nRF52 Series</a></li>
+
+
+ </ul>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../project3/">Project 3</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt Tool</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../newt/newt_ops/">Command structure</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../newt/newt_tool_reference/">Command list</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Mynewt OS</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mynewt_os/">Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/context_switch/">Scheduler/Context Switching</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/time/">Time</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/task/">Tasks</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/event_queue/">Event Queues</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/semaphore/">Semaphores</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mutex/">Mutexes</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/memory_pool/">Memory Pools</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/heap/">Heap</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mbufs/">Mbufs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/sanity/">Sanity</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/callout/">Callout Functions</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/port_os/">Porting to other Platforms</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Chapter5 - Modules</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/console/">Console</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/shell/">Shell</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/bootloader/">Bootloader</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/filesystem/">File System</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/testutil/">Test Utilities</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Chapter6 - Packaging it</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../packaging/dist/">Creating Packages</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ </ul>
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../..">Mynewt</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Get Acclimated »</li>
+
+
+
+ <li>Project 2</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h2 id="project-2-blinky-on-additional-boards">Project 2 - Blinky on additional boards<a class="headerlink" href="#project-2-blinky-on-additional-boards" title="Permanent link">¶</a></h2>
+<h3 id="objective">Objective<a class="headerlink" href="#objective" title="Permanent link">¶</a></h3>
+<p>The goal of this tutorial is to download a generic firmware skeleton ("bootstrap image") that applies to any hardware and then throw in additional applicable eggs to generate a build for a specific board. In the process you will be exposed to more Mynewt terms and Newt tool commands.</p>
+<p>The following target hardware chips are covered:</p>
+<ul>
+<li><a href="#stm32f303vc-mcu">STM32F303VC MCU</a> from STMicroelectronics</li>
+<li><a href="#nrf52-series">nRF52 Series</a> from Nordic Semiconductors </li>
+</ul>
+<h3 id="stm32f303vc-mcu">STM32F303VC MCU<a class="headerlink" href="#stm32f303vc-mcu" title="Permanent link">¶</a></h3>
+<h4 id="hardware-needed">Hardware needed<a class="headerlink" href="#hardware-needed" title="Permanent link">¶</a></h4>
+<ul>
+<li>Discovery kit with STM32F303VC MCU</li>
+<li>Laptop running Mac OS</li>
+</ul>
+<h4 id="step-by-step-instructions-to-build-image">Step by Step Instructions to build image<a class="headerlink" href="#step-by-step-instructions-to-build-image" title="Permanent link">¶</a></h4>
+<ul>
+<li>
+<p>The first step is to download the generic skeleton of the project. The eggs constituting the skeleton are not hardware architecture specific. The skeleton is maintained as a nest in a separate repository on Apache. You know it is a nest because there is a nest.yml file. </p>
+<pre><code>[user:~/dev]$ newt nest create test_project
+Downloading nest skeleton from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-tadpole.git... ok!
+Nest test_project successfully created in ~/dev/go/test_project
+
+[user:~/dev]$ cd test_project/
+[user:~/dev/test_project]$ ls
+README.md compiler hw libs nest.yml
+</code></pre>
+</li>
+<li>
+<p>Next, the clutch of eggs named larva is added from the nest (also named larva) from another repository on Apache. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (<code>clutch.yml</code>) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.</p>
+<pre><code>[user:~/dev/test_project]$ newt nest add-clutch larva https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+Downloading clutch.yml from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!
+Verifying clutch.yml format...
+ok!
+Clutch larva successfully installed to Nest.
+</code></pre>
+</li>
+<li>
+<p>The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. </p>
+<pre><code>[user:~/dev/test_project]$ newt egg install project/blinky
+Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!
+Installing project/blinky
+Installing libs/console/full
+Installing libs/shell
+Installation was a success!
+
+[user:~/dev/test_project]$ newt egg install hw/bsp/stm32f3discovery
+Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!
+Installing hw/bsp/stm32f3discovery
+Installing hw/mcu/stm/stm32f3xx
+Installing libs/cmsis-core
+Installing compiler/arm-none-eabi-m4
+Installation was a success!
+</code></pre>
+</li>
+<li>
+<p>It's time to create a target for the project and define the target attributes. </p>
+<pre><code>[user:~/dev/test_project]$ newt target create blink_f3disc
+Creating target blink_f3disc
+Target blink_f3disc successfully created!
+
+[user:~/dev/test_project]$ newt target set blink_f3disc project=blinky
+Target blink_f3disc successfully set project to blinky
+
+[user:~/dev/test_project]$ newt target set blink_f3disc bsp=hw/bsp/stm32f3discovery
+Target blink_f3disc successfully set bsp to hw/bsp/stm32f3discovery
+
+[user:~/dev/test_project]$ newt target set blink_f3disc compiler_def=debug
+Target blink_f3disc successfully set compiler_def to debug
+
+[user:~/dev/test_project]$ newt target set blink_f3disc compiler=arm-none-eabi-m4
+Target blink_f3disc successfully set compiler to arm-none-eabi-m4
+
+[user:~/dev/test_project]$ newt target set blink_f3disc arch=cortex_m4
+Target blink_f3disc successfully set arch to cortex_m4
+
+[user:~/dev/test_project]$ newt target show blink_f3disc
+blink_f3disc
+ arch: cortex_m4
+ project: blinky
+ bsp: hw/bsp/stm32f3discovery
+ compiler_def: debug
+ compiler: arm-none-eabi-m4
+ name: blink_f3disc
+</code></pre>
+</li>
+<li>
+<p>Next, you get to build the target and generate an executable that can then be uploaded to the board. The STM32F3DISCOVERY board includes an ST-LINK/V2 embedded debug tool interface that will be used to program/debug the board. To program the MCU on the board, simply plug in the two jumpers on CN4, as shown in the picture in red. If you want to learn more about the board you will find the User Manual at <a href="http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf">http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf</a></p>
+</li>
+<li>
+<p><img alt="STMdiscovery" src="../pics/STM32f3discovery_connector.png" /></p>
+<pre><code>[user:~/dev/test_project]$ newt target build blink_f3disc
+Building target blink_f3disc (project = blinky)
+Compiling case.c
+Compiling suite.c
+Compiling testutil.c
+Compiling testutil_arch_arm.c
+Archiving libtestutil.a
+Compiling os.c
+Compiling os_callout.c
+Compiling os_eventq.c
+Compiling os_heap.c
+Compiling os_mbuf.c
+Compiling os_mempool.c
+Compiling os_mutex.c
+Compiling os_sanity.c
+Compiling os_sched.c
+Compiling os_sem.c
+Compiling os_task.c
+Compiling os_time.c
+Compiling os_arch_arm.c
+Assembling HAL_CM4.s
+Assembling SVC_Table.s
+Archiving libos.a
+Compiling hal_gpio.c
+Compiling stm32f3xx_hal_gpio.c
+Archiving libstm32f3xx.a
+Compiling cmsis_nvic.c
+Compiling libc_stubs.c
+Compiling os_bsp.c
+Compiling sbrk.c
+Compiling system_stm32f3xx.c
+Assembling startup_stm32f303xc.s
+Archiving libstm32f3discovery.a
+Compiling main.c
+Building project blinky
+Linking blinky.elf
+Successfully run!
+</code></pre>
+</li>
+<li>
+<p>Finally, you have to download the image on to the board. You will see a blue light start to blink.</p>
+<pre><code>[user:~/dev/test_project]$ newt target download blink_f3disc
+Downloading with /Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3discovery_download.sh
+</code></pre>
+</li>
+</ul>
+<h3 id="nrf52-series">nRF52 Series<a class="headerlink" href="#nrf52-series" title="Permanent link">¶</a></h3>
+<h4 id="hardware-needed_1">Hardware needed<a class="headerlink" href="#hardware-needed_1" title="Permanent link">¶</a></h4>
+<ul>
+<li>nRF52 Development Kit</li>
+<li>Laptop running Mac OS</li>
+</ul>
+<h4 id="step-by-step-instructions-to-build-image_1">Step by Step Instructions to build image<a class="headerlink" href="#step-by-step-instructions-to-build-image_1" title="Permanent link">¶</a></h4>
+<ul>
+<li>
+<p>The first step is to download the generic skeleton of the project. The eggs installed are not hardware architecture specific.</p>
+<pre><code>[]user@~/dev]$ newt nest create nordic_blinky
+Downloading nest skeleton from https://www.github.com/mynewt/tadpole... ok!
+Nest nordic_blinky successfully created in ~dev/nordic_blinky
+
+user@~/dev$ cd nordic_blinky/
+</code></pre>
+</li>
+<li>
+<p>Then, the clutch of eggs named larva is added from the nest (also named larva) on the github. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (<code>clutch.yml</code>) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.</p>
+<pre><code>[]user@~/dev/nordic_blinky]$ newt nest add-clutch larva https://github.com/mynewt/larva
+Downloading clutch.yml from https://github.com/mynewt/larva/master... ok!
+Verifying clutch.yml format...ok!
+Clutch larva successfully installed to Nest.
+</code></pre>
+</li>
+<li>
+<p>The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. </p>
+<pre><code>[user@~/dev/nordic_blinky]$ newt egg install project/blinky
+Downloading larva from https://github.com/mynewt/larva//master... ok!
+Installing project/blinky
+Installation was a success!
+
+[user@~/dev/nordic_blinky]$ newt egg install hw/bsp/nrf52pdk
+Downloading larva from https://github.com/mynewt/larva//master... ok!
+Installing hw/bsp/nrf52pdk
+Installing hw/mcu/nordic/nrf52xxx
+Installing libs/cmsis-core
+Installing compiler/arm-none-eabi-m4
+Installation was a success!
+</code></pre>
+</li>
+<li>
+<p>It's time to create a target for the project and define the target attributes. </p>
+<pre><code>[user@~/dev/nordic_blinky]$ newt target create blink_nordic
+Creating target blink_nordic
+Target blink_nordic successfully created!
+[user@~/dev/nordic_blinky]$ newt target set blink_nordic project=blinky
+Target blink_nordic successfully set project to blinky
+[user@~/dev/nordic_blinky]$ newt target set blink_nordic bsp=hw/bsp/nrf52pdk
+Target blink_nordic successfully set bsp to hw/bsp/nrf52pdk
+[user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler_def=debug
+Target blink_nordic successfully set compiler_def to debug
+[user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler=arm-none-eabi-m4
+Target blink_nordic successfully set compiler to arm-none-eabi-m4
+[user@~/dev/nordic_blinky]$ newt target set blink_nordic arch=cortex_m4
+Target blink_nordic successfully set arch to cortex_m4
+[user@~/dev/nordic_blinky]$ newt target show
+blink_nordic
+ compiler: arm-none-eabi-m4
+ name: blink_nordic
+ arch: cortex_m4
+ project: blinky
+ bsp: hw/bsp/nrf52pdk
+ compiler_def: debug
+</code></pre>
+</li>
+<li>
+<p>Finally, you get to build the target and generate an executable that can now be uploaded to the board via the on-board SEGGER J-Link debugger. </p>
+<pre><code>[user@~/dev/nordic_blinky]$ newt target build blink_nordic
+Building target blink_nordic (project = blinky)
+Compiling case.c
+Compiling suite.c
+Compiling testutil.c
+Compiling testutil_arch_arm.c
+Archiving libtestutil.a
+Compiling os.c
+Compiling os_callout.c
+Compiling os_eventq.c
+Compiling os_heap.c
+Compiling os_mbuf.c
+Compiling os_mempool.c
+Compiling os_mutex.c
+Compiling os_sanity.c
+Compiling os_sched.c
+Compiling os_sem.c
+Compiling os_task.c
+Compiling os_time.c
+Compiling os_arch_arm.c
+Assembling HAL_CM4.s
+Assembling SVC_Table.s
+Archiving libos.a
+Compiling hal_cputime.c
+Compiling hal_gpio.c
+Compiling hal_uart.c
+Archiving libnrf52xxx.a
+Compiling cmsis_nvic.c
+Compiling hal_bsp.c
+Compiling libc_stubs.c
+Compiling os_bsp.c
+Compiling sbrk.c
+Compiling system_nrf52.c
+Assembling gcc_startup_nrf52.s
+Archiving libnrf52pdk.a
+Compiling main.c
+Building project blinky
+Linking blinky.elf
+Successfully run!
+</code></pre>
+</li>
+<li>
+<p>In order to be able to communicate with the SEGGER J-Link debugger on the dev board, you have to download and install the J-Link GDB Server software on to your laptop. You may download the "Software and documentation pack for Mac OS X" from <a href="https://www.segger.com/jlink-software.html">https://www.segger.com/jlink-software.html</a>. The command line version of the server is used in the steps below. </p>
+</li>
+<li>
+<p>Open a new terminal and start a J-Link session.</p>
+<pre><code>[user@~/dev/nordic_blinky/project/blinky/bin]$ which JLinkGDBServer
+/usr/local/bin/JLinkGDBServer
+[user@~/dev/nordic_blinky/project/blinky/bin]$ JLinkGDBServer -if SWD
+SEGGER J-Link GDB Server V5.02f Command Line Version
+
+JLinkARM.dll V5.02f (DLL compiled Oct 2 2015 20:55:03)
+
+-----GDB Server start settings-----
+GDBInit file: none
+GDB Server Listening port: 2331
+SWO raw output listening port: 2332
+Terminal I/O port: 2333
+Accept remote connection: yes
+Generate logfile: off
+Verify download: off
+Init regs on start: off
+Silent mode: off
+Single run mode: off
+Target connection timeout: 0 ms
+------J-Link related settings------
+J-Link Host interface: USB
+J-Link script: none
+J-Link settings file: none
+------Target related settings------
+Target device: unspecified
+Target interface: SWD
+Target interface speed: 1000kHz
+Target endian: little
+
+Connecting to J-Link...
+J-Link is connected.
+Firmware: J-Link OB-SAM3U128-V2-NordicSemi compiled Aug 28 2015 19:26:24
+Hardware: V1.00
+S/N: 682371959
+Checking target voltage...
+Target voltage: 3.30 V
+Listening on TCP/IP port 2331
+Connecting to target...Connected to target
+Waiting for GDB connection...Connected to 127.0.0.1
+</code></pre>
+</li>
+<li>
+<p>You need a configuration file for the GDB session to be opened correctly and the image ("blinky.elf") you built for this target downloaded to flash. A sample config script is given below. Alternatively, you could choose to type each command at the gdb prompt.</p>
+<pre><code> [user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ cat jlink-gdb.cfg
+ echo ***Setting up the environment for debugging gdb.***\n
+ set complaints 1
+ set prompt (gdb)
+ set endian little
+ echo \n*** Set target charset ASCII\n
+ set target-charset ASCII
+ echo \n*** Connecting over port #2331 ***\n
+ target remote localhost:2331
+ echo \n*** Enable flash write and set device to nrf52 ***\n
+ monitor flash download=1
+ monitor flash device=nRF52
+ echo \n*** loading blinky.elf ***\n
+ load ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf
+ symbol-file ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf
+ echo \n*** Resetting target ***\n
+ monitor reset
+ echo \n*** Halting target ***\n
+ monitor halt
+</code></pre>
+</li>
+<li>
+<p>Start the gdb session and monitor that it loads the image, resets the target, and halts for a command to continue. </p>
+<pre><code>[user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ arm-none-eabi-gdb -x ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/jlink-gdb.cfg
+
+GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs
+Copyright (C) 2014 Free Software Foundation, Inc.
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law. Type "show copying"
+and "show warranty" for details.
+This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-eabi".
+Type "show configuration" for configuration details.
+For bug reporting instructions, please see:
+<http://www.gnu.org/software/gdb/bugs/>.
+Find the GDB manual and other documentation resources online at:
+<http://www.gnu.org/software/gdb/documentation/>.
+For help, type "help".
+Type "apropos word" to search for commands related to "word".
+
+***Setting up the environment for debugging gdb.***
+The target is assumed to be little endian
+
+*** Set target charset ASCII
+
+*** Connecting over port #2331 ***
+0x00003c34 in ?? ()
+
+*** Enable flash write and set device to nrf52 ***
+Flash download enabled
+Selecting device: nRF52
+
+*** loading blinky.elf ***
+Loading section .text, size 0x5c84 lma 0x0
+Loading section .ARM.extab, size 0x24 lma 0x5c84
+Loading section .ARM.exidx, size 0xd8 lma 0x5ca8
+Loading section .data, size 0x8f8 lma 0x5d80
+Start address 0x48c, load size 26232
+Transfer rate: 12808 KB/sec, 2914 bytes/write.
+During symbol reading, unexpected overlap between:
+ (A) section `.text' from `~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x5c84)
+ (B) section `*COM*' from `~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x0).
+Will ignore section B.
+
+*** Resetting target ***
+Resetting target
+
+*** Halting target ***
+</code></pre>
+</li>
+<li>
+<p>Type 'c' to continue. The LED on the board will start to blink. You will also see some activity in the terminal showing the open J-Link GDB server connection. The LED will continue to blink after you quit out of that connection.</p>
+<pre><code>(gdb) c
+Continuing.
+</code></pre>
+</li>
+</ul>
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../project3/" class="btn btn-neutral float-right" title="Project 3"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../vocabulary/" class="btn btn-neutral" title="Understanding Newt Terms"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+ <span><a href="../vocabulary/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../project3/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/get_acclimated/project3/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/project3/index.html b/get_acclimated/project3/index.html
new file mode 100644
index 0000000..cf1e6f1
--- /dev/null
+++ b/get_acclimated/project3/index.html
@@ -0,0 +1,393 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Project 3 - Mynewt</title>
+
+
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "Project 3";
+ </script>
+
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
+ <script src="../../js/theme.js"></script>
+
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href="../.." class="icon icon-home"> Mynewt</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+ <li>
+ <li class="toctree-l1 ">
+ <a class="" href="../..">Home</a>
+
+ </li>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Started</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/newt_concepts/">Newt Concepts</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/project1/">Blinky, The First Project</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/how_to_edit_docs/">How to edit docs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/try_markdown/">Sample doc to edit</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Acclimated</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../vocabulary/">Understanding Newt Terms</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../project2/">Project 2</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 current">
+ <a class="current" href="./">Project 3</a>
+
+ <ul>
+
+ <li class="toctree-l3"><a href="#how-to-test-an-egg">How to Test an Egg</a></li>
+
+
+ </ul>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt Tool</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../newt/newt_ops/">Command structure</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../newt/newt_tool_reference/">Command list</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Mynewt OS</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mynewt_os/">Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/context_switch/">Scheduler/Context Switching</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/time/">Time</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/task/">Tasks</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/event_queue/">Event Queues</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/semaphore/">Semaphores</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mutex/">Mutexes</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/memory_pool/">Memory Pools</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/heap/">Heap</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mbufs/">Mbufs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/sanity/">Sanity</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/callout/">Callout Functions</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/port_os/">Porting to other Platforms</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Chapter5 - Modules</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/console/">Console</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/shell/">Shell</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/bootloader/">Bootloader</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/filesystem/">File System</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/testutil/">Test Utilities</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Chapter6 - Packaging it</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../packaging/dist/">Creating Packages</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ </ul>
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../..">Mynewt</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Get Acclimated »</li>
+
+
+
+ <li>Project 3</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h2 id="how-to-test-an-egg">How to Test an Egg<a class="headerlink" href="#how-to-test-an-egg" title="Permanent link">¶</a></h2>
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../../newt/newt_ops/" class="btn btn-neutral float-right" title="Command structure"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../project2/" class="btn btn-neutral" title="Project 2"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+ <span><a href="../project2/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../../newt/newt_ops/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/get_acclimated/vocabulary/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/vocabulary/index.html b/get_acclimated/vocabulary/index.html
new file mode 100644
index 0000000..a45430d
--- /dev/null
+++ b/get_acclimated/vocabulary/index.html
@@ -0,0 +1,544 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Understanding Newt Terms - Mynewt</title>
+
+
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "Understanding Newt Terms";
+ </script>
+
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
+ <script src="../../js/theme.js"></script>
+
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href="../.." class="icon icon-home"> Mynewt</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+ <li>
+ <li class="toctree-l1 ">
+ <a class="" href="../..">Home</a>
+
+ </li>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Started</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/newt_concepts/">Newt Concepts</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/project1/">Blinky, The First Project</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/how_to_edit_docs/">How to edit docs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_started/try_markdown/">Sample doc to edit</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Acclimated</span></li>
+
+
+
+ <li class="toctree-l1 current">
+ <a class="current" href="./">Understanding Newt Terms</a>
+
+ <ul>
+
+ <li class="toctree-l3"><a href="#understanding-newt-terms">Understanding Newt Terms</a></li>
+
+ <li><a class="toctree-l4" href="#nest">Nest</a></li>
+
+ <li><a class="toctree-l4" href="#project">Project</a></li>
+
+ <li><a class="toctree-l4" href="#egg">Egg</a></li>
+
+ <li><a class="toctree-l4" href="#clutch">Clutch</a></li>
+
+ <li><a class="toctree-l4" href="#eggshell">Eggshell</a></li>
+
+ <li><a class="toctree-l4" href="#target">Target</a></li>
+
+ <li><a class="toctree-l4" href="#capability">Capability</a></li>
+
+ <li><a class="toctree-l4" href="#identity">Identity</a></li>
+
+
+ </ul>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../project2/">Project 2</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../project3/">Project 3</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt Tool</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../newt/newt_ops/">Command structure</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../newt/newt_tool_reference/">Command list</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Mynewt OS</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mynewt_os/">Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/context_switch/">Scheduler/Context Switching</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/time/">Time</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/task/">Tasks</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/event_queue/">Event Queues</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/semaphore/">Semaphores</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mutex/">Mutexes</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/memory_pool/">Memory Pools</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/heap/">Heap</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mbufs/">Mbufs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/sanity/">Sanity</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/callout/">Callout Functions</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/port_os/">Porting to other Platforms</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Chapter5 - Modules</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/console/">Console</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/shell/">Shell</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/bootloader/">Bootloader</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/filesystem/">File System</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/testutil/">Test Utilities</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Chapter6 - Packaging it</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../packaging/dist/">Creating Packages</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ </ul>
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../..">Mynewt</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Get Acclimated »</li>
+
+
+
+ <li>Understanding Newt Terms</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h2 id="understanding-newt-terms">Understanding Newt Terms<a class="headerlink" href="#understanding-newt-terms" title="Permanent link">¶</a></h2>
+<h3 id="nest">Nest<a class="headerlink" href="#nest" title="Permanent link">¶</a></h3>
+<p>The nest is the base directory of your embedded software. It is meant to be the workspace containing a logical collection of the source code for one or more of your projects. A nest can contain multiple projects, and reflect multiple end products. </p>
+<p>As the base repository of your source code, the nest has a master branch and several other branches off it. You may choose any branch to nest on. Each project in your nest will typically consist of several <a href="#egg">eggs</a>. A project could be an egg itself as well. In addition to eggs, a local nest will contain additional items such as <a href="#target">target</a> or build definitions, clutch description files, scripts etc.</p>
+<p>For example, a walk through the "larva" nest at <a href="https://github.com/mynewt/larva.git">https://github.com/mynewt/larva.git</a> shows the following structure. The nest.yml file in the larva directory indicates that it is a nest. An egg will have the egg.yml file in it as shown below. By this nomenclature, each board support package for a particular chip is an egg, the API for the hardware abstraction layer is an egg, and so on. </p>
+<pre><code>larva
+ |- nest.yml
+ |- 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 Project Blinky)
+ |- 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
+
+
+</code></pre>
+
+<p>The newt tool offers the <code>nest</code> command to create and manage nests. In general, commands represent actions and flags are modifiers for those actions. A command can have children commands and optionally run an action. A full description of the <code>nest</code> command can be found in the newt tool reference in Chapter 3.</p>
+<pre><code>newt nest [flags]
+newt nest [child-commands]
+</code></pre>
+<p>A complete list of all the nest commands can be found in the newt tool reference in <a href="../../newt/newt_tool_reference/">Newt Tool</a>.</p>
+<h3 id="project">Project<a class="headerlink" href="#project" title="Permanent link">¶</a></h3>
+<p>Projects represent the individual build configurations of your embedded system and essentially defines your application. The project files are what dictate the resulting binary that is generated. </p>
+<p>Layout-wise, a project is a directory inside a nest and contains eggs required for a certain application. For example, the <code>blinky</code> egg sits in <code>project/blinky</code> directory of the <code>larva</code> nest. This egg is used in the blinky project (application) outlined in <a href="../../get_started/project1/">Get Started</a>. <<em>Note: This Will Change</em>></p>
+<p>A project has the following concepts or properties associated with it. You can find them in the <code><project-name>.yml</code> file in the project directory. For example, the <code>project/blinky</code> directory has the <code>blinky.yml</code> file indicating some or all of the properties below. Only the name of a project is required for the project to exist, however additional properties may need to be specified for the eggs in it to compile properly and produce an executable. </p>
+<ul>
+<li>Project name</li>
+<li>Base path of the project (nest/project/project-name by default)</li>
+<li>Eggs belonging to the project</li>
+<li><a href="#capabilities">Capabilities</a> that are required for the project or target </li>
+<li><a href="#identity">Identity</a> to classify the type of project or target</li>
+<li>Compiler flags to call out any specific compiler requirement</li>
+</ul>
+<p>A project could itself be an egg if it is a distributable package for a specific application. </p>
+<p>The newt tool offers various commands that you can use with a project. For example, if your project is an egg, you can use the following command to install a project from a nest.</p>
+<pre><code>newt egg install [flags] <project egg name>
+</code></pre>
+<h3 id="egg">Egg<a class="headerlink" href="#egg" title="Permanent link">¶</a></h3>
+<p>An egg is a distributable package of libraries. Just as an egg in nature has various parts each of which serves a certain purpose, the Mynewt egg consists of software parcels or modules that have different functions. However, unlike the egg in nature these software modules can exist by itself and may be distributed; therefore, they too are essentially eggs. Once this concept is grasped it is easy to see how an egg may consist of other eggs.</p>
+<p>The two main directories in an egg are <code>/include</code> and <code>/src</code>.</p>
+<p>The newt tool offers several egg commands to list, inspect, install, and do other operations on eggs. For example, the following command</p>
+<pre><code>newt egg list
+</code></pre>
+<p>outputs all the eggs in the current nest where each egg has details on its version, path, and dependencies. A sample output for an egg is given below.</p>
+<pre><code>Egg libs/os, version 0.1.0
+path: /Users/aditihilbert/dev/test_project/libs/os
+deps: libs/testutil@none#stable
+</code></pre>
+<p>A complete list of all the egg commands can be found in the newt tool reference in <a href="../../newt/newt_tool_reference/">Newt Tool</a>.</p>
+<h3 id="clutch">Clutch<a class="headerlink" href="#clutch" title="Permanent link">¶</a></h3>
+<p>A clutch is a snapshot of all eggs in a remote nest at any point in time. On any given github branch, a nest with a clutch of eggs will contain a <code>clutch.yml</code> file that specifies the version number, dependencies, and hash value for each constituent egg as well as the name of the entire clutch and the github url for it. [Note: Currently ]</p>
+<p>You may download multiple clutches into your local nest as long as the names of the clutches are different. This allows you to mix and match various features and functionality coming from different clutches of eggs. You can see all the clutches in the <code>.nest/clutches</code> directory in your nest.</p>
+<p>The newt tool offers clutch management commands within the <code>newt nest</code> command. For example, the following command creates a new clutch using all the eggs in the current directory. It requires that a clutch name be specified and the url for the location of that clutch in the online repository. These two inputs go into the <code>clutch.yml</code> file in the nest.</p>
+<pre><code>newt nest generate-clutch <name> <url>
+</code></pre>
+<p>Note that a clutch merely defines the eggs belonging together and requires the eggs to be installed (hatched) for the source code to be populated in the project. </p>
+<h3 id="eggshell">Eggshell<a class="headerlink" href="#eggshell" title="Permanent link">¶</a></h3>
+<p>The term eggshell is used to refer to the eggs of a clutch in a remote repository. They are not useful on your local machine until you actually install them. So they are mere shells of themselves while sitting on the online repository. When you enter the following command outputs the total number of shells in each remote clutch.</p>
+<pre><code>newt nest list-clutches
+</code></pre>
+<p>So, if you had two clutches installed, the output could be:</p>
+<pre><code>Remote clutch larva (eggshells: 19)
+Remote clutch ble_test (eggshells: 15)
+</code></pre>
+<h3 id="target">Target<a class="headerlink" href="#target" title="Permanent link">¶</a></h3>
+<p>A target is the hardware build or its software equivalent (e.g. test, simulator) set for a project. It tells the newt tool how to build the source code within a given nest. Once a new target is created, its architecture and other details needs to be defined. An example of a defined target named "blink_f3disc" is given below.</p>
+<pre><code>blink_f3disc
+ compiler_def: debug
+ compiler: arm-none-eabi-m4
+ name: blink_f3disc
+ arch: cortex_m4
+ project: blinky
+ bsp: hw/bsp/stm32f3discovery
+</code></pre>
+<p>The newt tool offers commands to create, set up and manipulate targets. For example, the create command below creates an empty target named <code>my_target1</code> and the set command sets one detail of its definition, namely the architecture.</p>
+<pre><code>newt target create my_target1
+newt target set my_target1 arch=cortex_m4
+</code></pre>
+<h3 id="capability">Capability<a class="headerlink" href="#capability" title="Permanent link">¶</a></h3>
+<p>Capability is functionality that is exposed by an egg. A capability is tracked by its name and version. An egg may require capabilities exposed by another egg, thus establishing a dependency tracked through the egg.yml files. </p>
+<p>The newt tool can ascertain a map of all the egg capabilities and use it to check dependencies and make sure all the necessary eggs are in a project for a particular target.</p>
+<h3 id="identity">Identity<a class="headerlink" href="#identity" title="Permanent link">¶</a></h3>
+<p>Identity is a property of a target or project in the newt world. A target may inherit it from a project or vice versa. It may be used to determine what eggs to include or how an egg code should behave in a build or which linkerscripts to use. For example, the identity of a lock is different from the identity of a wearable monitor. Even if they were to be built on the same hardware target, different features and behavior are required. Their different identities result in differing sets of eggs in the projects and/or the same egg behaving differently depending on the identity.</p>
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../project2/" class="btn btn-neutral float-right" title="Project 2"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../../get_started/try_markdown/" class="btn btn-neutral" title="Sample doc to edit"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+ <span><a href="../../get_started/try_markdown/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../project2/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/get_started/how_to_edit_docs/index.html
----------------------------------------------------------------------
diff --git a/get_started/how_to_edit_docs/index.html b/get_started/how_to_edit_docs/index.html
new file mode 100644
index 0000000..90720f3
--- /dev/null
+++ b/get_started/how_to_edit_docs/index.html
@@ -0,0 +1,591 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>How to edit docs - Mynewt</title>
+
+
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "How to edit docs";
+ </script>
+
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
+ <script src="../../js/theme.js"></script>
+
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href="../.." class="icon icon-home"> Mynewt</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+ <li>
+ <li class="toctree-l1 ">
+ <a class="" href="../..">Home</a>
+
+ </li>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Started</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../newt_concepts/">Newt Concepts</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../project1/">Blinky, The First Project</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 current">
+ <a class="current" href="./">How to edit docs</a>
+
+ <ul>
+
+ <li class="toctree-l3"><a href="#how-to-edit-docs">How to Edit Docs</a></li>
+
+ <li><a class="toctree-l4" href="#objective">Objective</a></li>
+
+ <li><a class="toctree-l4" href="#markdown-mkdocs-mou">Markdown, MkDocs, Mou</a></li>
+
+ <li><a class="toctree-l4" href="#access-to-the-apache-repo">Access to the Apache repo</a></li>
+
+ <li><a class="toctree-l4" href="#making-a-local-copy">Making a local copy</a></li>
+
+ <li><a class="toctree-l4" href="#file-to-be-edited">File to be edited</a></li>
+
+ <li><a class="toctree-l4" href="#editing-an-existing-page">Editing an existing page</a></li>
+
+ <li><a class="toctree-l4" href="#adding-a-new-page">Adding a new page</a></li>
+
+ <li><a class="toctree-l4" href="#pushing-changes-to-remote-as-a-committer">Pushing changes to remote as a committer</a></li>
+
+ <li><a class="toctree-l4" href="#sharing-changes-as-a-non-committer">Sharing changes as a non-committer</a></li>
+
+ <li><a class="toctree-l4" href="#conversion-to-html">Conversion to HTML</a></li>
+
+ <li><a class="toctree-l4" href="#local-preview-of-html-files">Local preview of HTML files</a></li>
+
+
+ </ul>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../try_markdown/">Sample doc to edit</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Acclimated</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_acclimated/vocabulary/">Understanding Newt Terms</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_acclimated/project2/">Project 2</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../get_acclimated/project3/">Project 3</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt Tool</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../newt/newt_ops/">Command structure</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../newt/newt_tool_reference/">Command list</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Mynewt OS</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mynewt_os/">Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/context_switch/">Scheduler/Context Switching</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/time/">Time</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/task/">Tasks</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/event_queue/">Event Queues</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/semaphore/">Semaphores</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mutex/">Mutexes</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/memory_pool/">Memory Pools</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/heap/">Heap</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/mbufs/">Mbufs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/sanity/">Sanity</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/callout/">Callout Functions</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../os/port_os/">Porting to other Platforms</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Chapter5 - Modules</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/console/">Console</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/shell/">Shell</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/bootloader/">Bootloader</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/filesystem/">File System</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../modules/testutil/">Test Utilities</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Chapter6 - Packaging it</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../packaging/dist/">Creating Packages</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ </ul>
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../..">Mynewt</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Get Started »</li>
+
+
+
+ <li>How to edit docs</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h2 id="how-to-edit-docs">How to Edit Docs<a class="headerlink" href="#how-to-edit-docs" title="Permanent link">¶</a></h2>
+<h3 id="objective">Objective<a class="headerlink" href="#objective" title="Permanent link">¶</a></h3>
+<p>We will go through the process of downloading existing doccumentation and adding some content to a test document.</p>
+<h3 id="markdown-mkdocs-mou">Markdown, MkDocs, Mou<a class="headerlink" href="#markdown-mkdocs-mou" title="Permanent link">¶</a></h3>
+<p>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 <a href="http://www.mkdocs.org">http://www.mkdocs.org</a>. 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).</p>
+<p>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 <a href="http://25.io/mou/">Mou</a> is enough to check how it will look after the document has gone through MkDocs. Go ahead and download <a href="http://25.io/mou/">Mou</a>. If you are on a Windows machine, download the <a href="http://alternativeto.net/software/mou/?platform=windows">editor of your choice</a>.</p>
+<p>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.</p>
+<h3 id="access-to-the-apache-repo">Access to the Apache repo<a class="headerlink" href="#access-to-the-apache-repo" title="Permanent link">¶</a></h3>
+<p>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.</p>
+<p>If you are not a committer, you may follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is <a href="https://git-wip-us.apache.org/docs/workflow.html">https://git-wip-us.apache.org/docs/workflow.html</a>. You will find the steps described in more detail later in this tutorial.</p>
+<h3 id="making-a-local-copy">Making a local copy<a class="headerlink" href="#making-a-local-copy" title="Permanent link">¶</a></h3>
+<ul>
+<li>
+<p>Copy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure. Use http instead of https if you are a non-committer.</p>
+<pre><code>$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
+Cloning into 'incubator-mynewt-site'...
+remote: Counting objects: 330, done.
+remote: Compressing objects: 100% (263/263), done.
+remote: Total 330 (delta 120), reused 0 (delta 0)
+Receiving objects: 100% (330/330), 4.34 MiB | 830.00 KiB/s, done.
+Resolving deltas: 100% (120/120), done.
+Checking connectivity... done.
+$ ls
+incubator-mynewt-site
+$ ls incubator-mynewt-site/
+docs images mkdocs.yml
+</code></pre>
+</li>
+<li>
+<p>Create a new branch to work on your documentation and move to that branch.</p>
+<pre><code>$ git checkout -b <your-branch-name>
+</code></pre>
+</li>
+</ul>
+<h3 id="file-to-be-edited">File to be edited<a class="headerlink" href="#file-to-be-edited" title="Permanent link">¶</a></h3>
+<p>The file you will edit is <a href="../try_markdown/">try_markdown.md</a>.</p>
+<h3 id="editing-an-existing-page">Editing an existing page<a class="headerlink" href="#editing-an-existing-page" title="Permanent link">¶</a></h3>
+<ul>
+<li>
+<p>Open the application Mou.</p>
+</li>
+<li>
+<p>Open the file incubator-mynewt-site/docs/get_started/try_markdown.md in Mou.</p>
+</li>
+<li>
+<p>Edit the last item on the list.</p>
+</li>
+<li>
+<p>Save and quit the application.</p>
+</li>
+</ul>
+<p>You may want to review the documentation organization back in <a href="../..">Home</a> to remind you how to locate files easily. The corresponding directory tree structure is shown below.</p>
+<pre><code> .
+ ├── docs
+ │ ├── get_started
+ │ │ ├── how_to_edit_docs.md
+ │ │ ├── newt_concepts.md
+ │ │ ├── pics
+ │ │ │ ├── bottomview.png
+ │ │ │ └── topview.png
+ │ │ ├── project1.md
+ │ │ └── try_markdown.md
+ │ ├── get_acclimated
+ │ │ ├── project2.md
+ │ │ ├── project3.md
+ │ │ ├── ... (more to be added)
+ │ │ └── vocabulary.md
+ │ ├── newt
+ │ │ ├── newt_ops.md
+ │ │ └── newt_tool_reference.md
+ │ ├── os
+ │ │ ├── context_switch.md
+ │ │ ├── event_queue.md
+ │ │ ├── heap.md
+ │ │ ├── mbufs.md
+ │ │ ├── memory_pool.md
+ │ │ ├── mutex.md
+ │ │ ├── mynewt_os.md
+ │ │ ├── port_os.md
+ │ │ ├── sanity.md
+ │ │ ├── semaphore.md
+ │ │ ├── task.md
+ │ │ ├── time.md
+ │ │ └── ... (more to be added)
+ │ ├── modules
+ │ │ ├── bootloader.md
+ │ │ ├── console.md
+ │ │ ├── filesystem.md
+ │ │ ├── shell.md
+ │ │ ├── testutil.md
+ │ │ └── ... (more to be added)
+ │ ├── packaging
+ │ │ ├── dist.md
+ │ │ └── ... (more to be added)
+ │ ├── extra.css
+ │ ├── images
+ │ │ └── egg-logo.png
+ │ └── index.md
+ ├── images
+ │ ├── asf_logo_wide.gif
+ │ ├── content-bg.png
+ │ └── egg-logo.png
+ ├── mkdocs.yml
+</code></pre>
+<h3 id="adding-a-new-page">Adding a new page<a class="headerlink" href="#adding-a-new-page" title="Permanent link">¶</a></h3>
+<p>If you create a new file somewhere in the <code>docs</code> subdirectory to add a new page, you have to add a line in the <code>mkdocs.yml</code> file at the correct level. For example, if you add a new module named "Ethernet" by creating a new file named <code>ethernet.md</code> in the <code>modules</code> subdirectory, you have to insert the following line under <code>Modules:</code> in the <code>mkdocs.yml</code> file.</p>
+<pre><code> - 'Ethernet': 'modules/ethernet.md'
+</code></pre>
+<h3 id="pushing-changes-to-remote-as-a-committer">Pushing changes to remote as a committer<a class="headerlink" href="#pushing-changes-to-remote-as-a-committer" title="Permanent link">¶</a></h3>
+<p>If you are not a committer yet, skip this section and proceed to the <a href="#sharing-changes-as-a-non-committer">next section</a>.</p>
+<ul>
+<li>
+<p>Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.</p>
+<pre><code>$ git remote -v
+origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (fetch)
+origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push)
+</code></pre>
+</li>
+<li>
+<p>If, however, you do not see your remote repository, then set it up as follows.</p>
+<pre><code>$ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
+</code></pre>
+</li>
+<li>
+<p>First check the git status. It will show you that the <code>try_markdown.md</code> document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository. </p>
+</li>
+</ul>
+<p>During staging below using <code>git add</code>, we use the <code>-A</code> option indicating you want to stage all your modifications. Instead, you can choose to specify only the files that you want to. The commit message (specified after <code>-m</code>) should summarize what your changes are about.</p>
+<pre><code> $ git status
+ $ git add -A
+ $ git commit -m "My first doc change as a trial run"
+ $ git push -u origin <your-branch-name>
+</code></pre>
+<ul>
+<li>
+<p>You can see the changed Markdown file if you traverse the tree on the git repository <a href="https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git"> https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git</a>.</p>
+</li>
+<li>
+<p>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.</p>
+</li>
+</ul>
+<h3 id="sharing-changes-as-a-non-committer">Sharing changes as a non-committer<a class="headerlink" href="#sharing-changes-as-a-non-committer" title="Permanent link">¶</a></h3>
+<p>We suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is <a href="https://git-wip-us.apache.org/docs/workflow.html">https://git-wip-us.apache.org/docs/workflow.html</a>. </p>
+<ul>
+<li>
+<p>Assuming you have made changes to the example file, you will first commit your changes.</p>
+<pre><code>$ git add -A
+$ git commit -m "My first doc change as a trial run"
+</code></pre>
+</li>
+<li>
+<p>Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future):</p>
+<pre><code>$ git format-patch origin/trunk
+</code></pre>
+</li>
+<li>
+<p>Email the patch file to dev@mynewt.incubator.apache.org. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough. </p>
+</li>
+</ul>
+<p>If there is a JIRA ticket associated with your work you should post your patch files to the ticket.</p>
+<h3 id="conversion-to-html">Conversion to HTML<a class="headerlink" href="#conversion-to-html" title="Permanent link">¶</a></h3>
+<p>The conversion of the Markdown files to HTML for the website happens manually and statically using MkDocs. You cannot see automatic and immediate rendering in HTML upon making a change in the Markdown file. You can choose to stop here and proceed to changing other Markdown files in your branch.</p>
+<h3 id="local-preview-of-html-files">Local preview of HTML files<a class="headerlink" href="#local-preview-of-html-files" title="Permanent link">¶</a></h3>
+<p>However, you have the option to download MkDocs and do a local conversion yourself to preview the pages using the built-in devserver that comes with MkDocs. But first you will have to install MkDocs for that. In order to install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have them already (usually you will).</p>
+<pre><code> $ python --version
+ Python 2.7.2
+ $ pip --version
+ pip 1.5.2
+ $ pip install mkdocs
+</code></pre>
+<p>You will then run the built-in webserver from the root of the documentation directory using the command <code>mkdocs serve</code>. The root directory for documentation is <code>incubator-mynewt-site</code> or the directory with the <code>mkdocs.yml</code> file.</p>
+<pre><code> $ ls
+ docs images mkdocs.yml
+ $ mkdocs serve
+</code></pre>
+<p>Then go to <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a> to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be updated.</p>
+<p>For more information on MkDocs go to <a href="http://www.mkdocs.org">http://www.mkdocs.org</a>. </p>
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../try_markdown/" class="btn btn-neutral float-right" title="Sample doc to edit"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../project1/" class="btn btn-neutral" title="Blinky, The First Project"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+ <span><a href="../project1/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../try_markdown/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
+
+</body>
+</html>