You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/01/13 19:26:39 UTC
[7/7] incubator-mynewt-site git commit: Fix second level navigation
and function formats in docs
Fix second level navigation and function formats in docs
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/bc3112c0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/bc3112c0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/bc3112c0
Branch: refs/heads/asf-site
Commit: bc3112c09fbdd3dd966b7a51d48d92cba5fd0d3f
Parents: 5c95183
Author: aditihilbert <ad...@runtime.io>
Authored: Wed Jan 13 10:26:16 2016 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Wed Jan 13 10:26:16 2016 -0800
----------------------------------------------------------------------
css/custom.css | 61 +-
download/index.html | 5 +-
extra.css | 23 +
get_acclimated/project2/index.html | 668 ++++++------
get_acclimated/project3/index.html | 10 +-
get_acclimated/vocabulary/index.html | 77 +-
get_started/how_to_edit_docs/index.html | 257 +++--
get_started/newt_concepts/index.html | 20 +-
get_started/project1/index.html | 1480 +++++++++++++-------------
get_started/try_markdown/index.html | 14 +-
mkdocs/search_index.json | 383 ++++++-
modules/bootloader/index.html | 61 +-
modules/console/index.html | 172 +--
modules/filesystem/index.html | 55 +-
modules/shell/index.html | 64 +-
modules/testutil/index.html | 61 +-
newt/newt_ops/index.html | 8 +-
newt/newt_tool_reference/index.html | 20 +-
os/callout/index.html | 79 +-
os/context_switch/index.html | 70 +-
os/event_queue/index.html | 76 +-
os/heap/index.html | 76 +-
os/mbufs/index.html | 76 +-
os/memory_pool/index.html | 77 +-
os/mutex/index.html | 92 +-
os/mynewt_os/index.html | 80 +-
os/port_os/index.html | 34 +-
os/sanity/index.html | 77 +-
os/semaphore/index.html | 89 +-
os/task/index.html | 77 +-
os/time/index.html | 66 +-
packaging/dist/index.html | 4 +-
sitemap.xml | 66 +-
33 files changed, 2589 insertions(+), 1889 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/css/custom.css
----------------------------------------------------------------------
diff --git a/css/custom.css b/css/custom.css
index af92a14..f4dd137 100644
--- a/css/custom.css
+++ b/css/custom.css
@@ -31,8 +31,7 @@ h1 {
color: #42567E;
}
-h2,
-h3 {
+h2, h3 {
color: #42567E;
font-weight: 300;
}
@@ -219,6 +218,13 @@ body {
max-width: 280px;
}
+#search-input {
+ background-color: #fff;
+ box-shadow: none;
+ border-radius: 0;
+ -webkit-appearance: none;
+}
+
#rtd-search-form input,
#rtd-search-form button {
border: 1px solid #BFBFBF;
@@ -234,21 +240,17 @@ body {
#rtd-search-form button {
background-color: #ffffff;
- border-left: 0;
-
+ border-left: 0;
color: #42567E;
font-size: 20px;
-
width: 15%;
height: 44px;
-
-
+ margin-left: -10px;
position: relative;
- margin-left: -5px;
- top: 1px;
+ top: 2px;
+ padding: 6px 10px;
}
-
.home .search-container {
padding: 60px 30px;
margin-bottom: 20px;
@@ -259,25 +261,6 @@ body {
margin-bottom: 20px;
}
-.home #rtd-search-form input {
- border-right: 0;
- width: 80%;
- padding: 6px 10px;
- height: 44px;
- font-size: 18px;
-}
-
-.home #rtd-search-form button {
- background-color: #ffffff;
- margin-left: -5px;
- border-left: 0;
- color: #42567E;
- width: 15%;
- font-size: 20px;
- height: 44px;
- top: 0px;
-}
-
div.col-md-2 {
padding-left: 0;
}
@@ -319,10 +302,6 @@ footer .footnote {
/* margin-bottom: 40px; */
}
-.main-banner img {
- margin-bottom: 20px;
-}
-
.home h2 {
font-size: 26px;
}
@@ -410,6 +389,7 @@ footer .footnote {
}
.doc-section {
+ padding: 15px !important;
min-height: 300px;
margin-bottom: 20px;
}
@@ -618,4 +598,17 @@ a.bold-link:hover {
.event {
margin: 40px 0;
-}
\ No newline at end of file
+}
+
+.sidebar-container .nav>li>a:hover,
+.sidebar-container .nav>li>a:focus {
+ background-color: #F2853F;
+}
+
+code {
+ font-family: "Courier New";
+}
+
+li.toctree-l3 {
+ padding-left: 20px;
+}
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/download/index.html
----------------------------------------------------------------------
diff --git a/download/index.html b/download/index.html
index e970562..0d125ac 100644
--- a/download/index.html
+++ b/download/index.html
@@ -183,10 +183,11 @@
<p>If you are not a committer, follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is https://git-wip-us.apache.org/docs/workflow.html.</p>
<p>To clone the Mynewt OS development repository:</p>
<p><strong>Non Committers</strong></p>
-<pre><code>$ git clone http://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git
+<pre><code class="no-highlight"> $ git clone http://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git
</code></pre>
+
<p><strong>Committers</strong></p>
-<pre><code>$ git clone https://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git
+<pre><code class="no-highlight"> $ git clone https://git/wip/us.apache.org/repos/asf/incubator-mynewt-larva.git
</code></pre>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/extra.css
----------------------------------------------------------------------
diff --git a/extra.css b/extra.css
index 98acda9..54322d5 100644
--- a/extra.css
+++ b/extra.css
@@ -1,4 +1,27 @@
/*
+ * Tweak the headers to better match RTD.
+ */
+
+body {
+ font-size: 100%;
+}
+
+
+h4, h5, h6 {
+ color: black;
+ font-weight: 300;
+ text-decoration: underline;
+}
+
+hr {
+ height: 4px;
+ background-color:#42567E;
+ color: #42567E;
+ border: 0 none;
+}
+
+
+/*
* Fix wrapping in the code highlighting
*
* https://github.com/mkdocs/mkdocs/issues/233
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/get_acclimated/project2/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/project2/index.html b/get_acclimated/project2/index.html
index d2d4e04..9c88869 100644
--- a/get_acclimated/project2/index.html
+++ b/get_acclimated/project2/index.html
@@ -126,13 +126,23 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../vocabulary/">Understanding Newt Terms</a></li>
+ <li class="toctree-l2"><a href="../vocabulary/">Understanding Newt Terms</a></li>
- <li class="toctree-l3"><a href="./">Project 2</a></li>
+ <li class="toctree-l2"><a href="./">Project 2</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#objective">Objective</a></li>
+
+ <li class="toctree-l3"><a href="#stm32f303vc-mcu">STM32F303VC MCU</a></li>
+
+ <li class="toctree-l3"><a href="#nrf52-series">nRF52 Series</a></li>
+
+
- <li class="toctree-l3"><a href="../project3/">Project 3</a></li>
+ <li class="toctree-l2"><a href="../project3/">Project 3</a></li>
</ul>
@@ -201,126 +211,133 @@
</ul>
<h4 id="step-by-step-instructions-to-build-image">Step by Step Instructions to build image<a class="headerlink" href="#step-by-step-instructions-to-build-image" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>The first step is to download the generic skeleton of the project. The eggs constituting the skeleton are not hardware architecture specific. The skeleton is maintained as a nest in a separate repository on Apache. You know it is a nest because there is a nest.yml file. </p>
-<pre><code>[user:~/dev]$ newt nest create test_project
-Downloading nest skeleton from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-tadpole.git... ok!
-Nest test_project successfully created in ~/dev/go/test_project
-
-[user:~/dev]$ cd test_project/
-[user:~/dev/test_project]$ ls
-README.md compiler hw libs nest.yml
+<li>The first step is to download the generic skeleton of the project. The eggs constituting the skeleton are not hardware architecture specific. The skeleton is maintained as a nest in a separate repository on Apache. You know it is a nest because there is a nest.yml file. </li>
+</ul>
+<pre><code class="no-highlight"> [user:~/dev]$ newt nest create test_project
+ Downloading nest skeleton from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-tadpole.git... ok!
+ Nest test_project successfully created in ~/dev/go/test_project
+
+ [user:~/dev]$ cd test_project/
+ [user:~/dev/test_project]$ ls
+ README.md compiler hw libs nest.yml
</code></pre>
-</li>
-<li>
-<p>Next, the clutch of eggs named larva is added from the nest (also named larva) from another repository on Apache. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (<code>clutch.yml</code>) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.</p>
-<pre><code>[user:~/dev/test_project]$ newt nest add-clutch larva https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
-Downloading clutch.yml from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!
-Verifying clutch.yml format...
-ok!
-Clutch larva successfully installed to Nest.
+
+<ul>
+<li>Next, the clutch of eggs named larva is added from the nest (also named larva) from another repository on Apache. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (<code>clutch.yml</code>) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.</li>
+</ul>
+<pre><code class="no-highlight"> [user:~/dev/test_project]$ newt nest add-clutch larva https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+ Downloading clutch.yml from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!
+ Verifying clutch.yml format...
+ ok!
+ Clutch larva successfully installed to Nest.
</code></pre>
-</li>
-<li>
-<p>The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. </p>
-<pre><code>[user:~/dev/test_project]$ newt egg install project/blinky
-Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!
-Installing project/blinky
-Installing libs/console/full
-Installing libs/shell
-Installation was a success!
-
-[user:~/dev/test_project]$ newt egg install hw/bsp/stm32f3discovery
-Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!
-Installing hw/bsp/stm32f3discovery
-Installing hw/mcu/stm/stm32f3xx
-Installing libs/cmsis-core
-Installing compiler/arm-none-eabi-m4
-Installation was a success!
+
+<ul>
+<li>The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. </li>
+</ul>
+<pre><code class="no-highlight">
+ [user:~/dev/test_project]$ newt egg install project/blinky
+ Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!
+ Installing project/blinky
+ Installing libs/console/full
+ Installing libs/shell
+ Installation was a success!
+
+ [user:~/dev/test_project]$ newt egg install hw/bsp/stm32f3discovery
+ Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!
+ Installing hw/bsp/stm32f3discovery
+ Installing hw/mcu/stm/stm32f3xx
+ Installing libs/cmsis-core
+ Installing compiler/arm-none-eabi-m4
+ Installation was a success!
</code></pre>
-</li>
-<li>
-<p>It's time to create a target for the project and define the target attributes. </p>
-<pre><code>[user:~/dev/test_project]$ newt target create blink_f3disc
-Creating target blink_f3disc
-Target blink_f3disc successfully created!
-
-[user:~/dev/test_project]$ newt target set blink_f3disc project=blinky
-Target blink_f3disc successfully set project to blinky
-
-[user:~/dev/test_project]$ newt target set blink_f3disc bsp=hw/bsp/stm32f3discovery
-Target blink_f3disc successfully set bsp to hw/bsp/stm32f3discovery
-
-[user:~/dev/test_project]$ newt target set blink_f3disc compiler_def=debug
-Target blink_f3disc successfully set compiler_def to debug
-
-[user:~/dev/test_project]$ newt target set blink_f3disc compiler=arm-none-eabi-m4
-Target blink_f3disc successfully set compiler to arm-none-eabi-m4
-
-[user:~/dev/test_project]$ newt target set blink_f3disc arch=cortex_m4
-Target blink_f3disc successfully set arch to cortex_m4
-
-[user:~/dev/test_project]$ newt target show blink_f3disc
-blink_f3disc
- arch: cortex_m4
- project: blinky
- bsp: hw/bsp/stm32f3discovery
- compiler_def: debug
- compiler: arm-none-eabi-m4
- name: blink_f3disc
+
+<ul>
+<li>It's time to create a target for the project and define the target attributes. </li>
+</ul>
+<pre><code class="no-highlight"> [user:~/dev/test_project]$ newt target create blink_f3disc
+ Creating target blink_f3disc
+ Target blink_f3disc successfully created!
+
+ [user:~/dev/test_project]$ newt target set blink_f3disc project=blinky
+ Target blink_f3disc successfully set project to blinky
+
+ [user:~/dev/test_project]$ newt target set blink_f3disc bsp=hw/bsp/stm32f3discovery
+ Target blink_f3disc successfully set bsp to hw/bsp/stm32f3discovery
+
+ [user:~/dev/test_project]$ newt target set blink_f3disc compiler_def=debug
+ Target blink_f3disc successfully set compiler_def to debug
+
+ [user:~/dev/test_project]$ newt target set blink_f3disc compiler=arm-none-eabi-m4
+ Target blink_f3disc successfully set compiler to arm-none-eabi-m4
+
+ [user:~/dev/test_project]$ newt target set blink_f3disc arch=cortex_m4
+ Target blink_f3disc successfully set arch to cortex_m4
+
+ [user:~/dev/test_project]$ newt target show blink_f3disc
+ blink_f3disc
+ arch: cortex_m4
+ project: blinky
+ bsp: hw/bsp/stm32f3discovery
+ compiler_def: debug
+ compiler: arm-none-eabi-m4
+ name: blink_f3disc
</code></pre>
-</li>
+
+<ul>
<li>
<p>Next, you get to build the target and generate an executable that can then be uploaded to the board. The STM32F3DISCOVERY board includes an ST-LINK/V2 embedded debug tool interface that will be used to program/debug the board. To program the MCU on the board, simply plug in the two jumpers on CN4, as shown in the picture in red. If you want to learn more about the board you will find the User Manual at <a href="http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf">http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf</a></p>
</li>
<li>
<p><img alt="STMdiscovery" src="../pics/STM32f3discovery_connector.png" /></p>
-<pre><code>[user:~/dev/test_project]$ newt target build blink_f3disc
-Building target blink_f3disc (project = blinky)
-Compiling case.c
-Compiling suite.c
-Compiling testutil.c
-Compiling testutil_arch_arm.c
-Archiving libtestutil.a
-Compiling os.c
-Compiling os_callout.c
-Compiling os_eventq.c
-Compiling os_heap.c
-Compiling os_mbuf.c
-Compiling os_mempool.c
-Compiling os_mutex.c
-Compiling os_sanity.c
-Compiling os_sched.c
-Compiling os_sem.c
-Compiling os_task.c
-Compiling os_time.c
-Compiling os_arch_arm.c
-Assembling HAL_CM4.s
-Assembling SVC_Table.s
-Archiving libos.a
-Compiling hal_gpio.c
-Compiling stm32f3xx_hal_gpio.c
-Archiving libstm32f3xx.a
-Compiling cmsis_nvic.c
-Compiling libc_stubs.c
-Compiling os_bsp.c
-Compiling sbrk.c
-Compiling system_stm32f3xx.c
-Assembling startup_stm32f303xc.s
-Archiving libstm32f3discovery.a
-Compiling main.c
-Building project blinky
-Linking blinky.elf
-Successfully run!
-</code></pre>
</li>
-<li>
-<p>Finally, you have to download the image on to the board. You will see a blue light start to blink.</p>
-<pre><code>[user:~/dev/test_project]$ newt target download blink_f3disc
-Downloading with /Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3discovery_download.sh
+</ul>
+<pre><code class="no-highlight"> [user:~/dev/test_project]$ newt target build blink_f3disc
+ Building target blink_f3disc (project = blinky)
+ Compiling case.c
+ Compiling suite.c
+ Compiling testutil.c
+ Compiling testutil_arch_arm.c
+ Archiving libtestutil.a
+ Compiling os.c
+ Compiling os_callout.c
+ Compiling os_eventq.c
+ Compiling os_heap.c
+ Compiling os_mbuf.c
+ Compiling os_mempool.c
+ Compiling os_mutex.c
+ Compiling os_sanity.c
+ Compiling os_sched.c
+ Compiling os_sem.c
+ Compiling os_task.c
+ Compiling os_time.c
+ Compiling os_arch_arm.c
+ Assembling HAL_CM4.s
+ Assembling SVC_Table.s
+ Archiving libos.a
+ Compiling hal_gpio.c
+ Compiling stm32f3xx_hal_gpio.c
+ Archiving libstm32f3xx.a
+ Compiling cmsis_nvic.c
+ Compiling libc_stubs.c
+ Compiling os_bsp.c
+ Compiling sbrk.c
+ Compiling system_stm32f3xx.c
+ Assembling startup_stm32f303xc.s
+ Archiving libstm32f3discovery.a
+ Compiling main.c
+ Building project blinky
+ Linking blinky.elf
+ Successfully run!
</code></pre>
-</li>
+
+<ul>
+<li>Finally, you have to download the image on to the board. You will see a blue light start to blink.</li>
</ul>
+<pre><code class="no-highlight"> [user:~/dev/test_project]$ newt target download blink_f3disc
+ Downloading with /Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3discovery_download.sh
+</code></pre>
+
<h3 id="nrf52-series">nRF52 Series<a class="headerlink" href="#nrf52-series" title="Permanent link">¶</a></h3>
<h4 id="hardware-needed_1">Hardware needed<a class="headerlink" href="#hardware-needed_1" title="Permanent link">¶</a></h4>
<ul>
@@ -329,232 +346,241 @@ Downloading with /Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3dis
</ul>
<h4 id="step-by-step-instructions-to-build-image_1">Step by Step Instructions to build image<a class="headerlink" href="#step-by-step-instructions-to-build-image_1" title="Permanent link">¶</a></h4>
<ul>
-<li>
-<p>The first step is to download the generic skeleton of the project. The eggs installed are not hardware architecture specific.</p>
-<pre><code>[]user@~/dev]$ newt nest create nordic_blinky
-Downloading nest skeleton from https://www.github.com/mynewt/tadpole... ok!
-Nest nordic_blinky successfully created in ~dev/nordic_blinky
+<li>The first step is to download the generic skeleton of the project. The eggs installed are not hardware architecture specific.</li>
+</ul>
+<pre><code class="no-highlight"> []user@~/dev]$ newt nest create nordic_blinky
+ Downloading nest skeleton from https://www.github.com/mynewt/tadpole... ok!
+ Nest nordic_blinky successfully created in ~dev/nordic_blinky
-user@~/dev$ cd nordic_blinky/
+ user@~/dev$ cd nordic_blinky/
</code></pre>
-</li>
-<li>
-<p>Then, the clutch of eggs named larva is added from the nest (also named larva) on the github. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (<code>clutch.yml</code>) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.</p>
-<pre><code>[]user@~/dev/nordic_blinky]$ newt nest add-clutch larva https://github.com/mynewt/larva
-Downloading clutch.yml from https://github.com/mynewt/larva/master... ok!
-Verifying clutch.yml format...ok!
-Clutch larva successfully installed to Nest.
+
+<ul>
+<li>Then, the clutch of eggs named larva is added from the nest (also named larva) on the github. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (<code>clutch.yml</code>) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.</li>
+</ul>
+<pre><code class="no-highlight"> []user@~/dev/nordic_blinky]$ newt nest add-clutch larva https://github.com/mynewt/larva
+ Downloading clutch.yml from https://github.com/mynewt/larva/master... ok!
+ Verifying clutch.yml format...ok!
+ Clutch larva successfully installed to Nest.
</code></pre>
-</li>
-<li>
-<p>The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. </p>
-<pre><code>[user@~/dev/nordic_blinky]$ newt egg install project/blinky
-Downloading larva from https://github.com/mynewt/larva//master... ok!
-Installing project/blinky
-Installation was a success!
-
-[user@~/dev/nordic_blinky]$ newt egg install hw/bsp/nrf52pdk
-Downloading larva from https://github.com/mynewt/larva//master... ok!
-Installing hw/bsp/nrf52pdk
-Installing hw/mcu/nordic/nrf52xxx
-Installing libs/cmsis-core
-Installing compiler/arm-none-eabi-m4
-Installation was a success!
+
+<ul>
+<li>The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. </li>
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky]$ newt egg install project/blinky
+ Downloading larva from https://github.com/mynewt/larva//master... ok!
+ Installing project/blinky
+ Installation was a success!
+
+
+ [user@~/dev/nordic_blinky]$ newt egg install hw/bsp/nrf52pdk
+ Downloading larva from https://github.com/mynewt/larva//master... ok!
+ Installing hw/bsp/nrf52pdk
+ Installing hw/mcu/nordic/nrf52xxx
+ Installing libs/cmsis-core
+ Installing compiler/arm-none-eabi-m4
+ Installation was a success!
</code></pre>
-</li>
-<li>
-<p>It's time to create a target for the project and define the target attributes. </p>
-<pre><code>[user@~/dev/nordic_blinky]$ newt target create blink_nordic
-Creating target blink_nordic
-Target blink_nordic successfully created!
-[user@~/dev/nordic_blinky]$ newt target set blink_nordic project=blinky
-Target blink_nordic successfully set project to blinky
-[user@~/dev/nordic_blinky]$ newt target set blink_nordic bsp=hw/bsp/nrf52pdk
-Target blink_nordic successfully set bsp to hw/bsp/nrf52pdk
-[user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler_def=debug
-Target blink_nordic successfully set compiler_def to debug
-[user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler=arm-none-eabi-m4
-Target blink_nordic successfully set compiler to arm-none-eabi-m4
-[user@~/dev/nordic_blinky]$ newt target set blink_nordic arch=cortex_m4
-Target blink_nordic successfully set arch to cortex_m4
-[user@~/dev/nordic_blinky]$ newt target show
-blink_nordic
- compiler: arm-none-eabi-m4
- name: blink_nordic
- arch: cortex_m4
- project: blinky
- bsp: hw/bsp/nrf52pdk
- compiler_def: debug
+
+<ul>
+<li>It's time to create a target for the project and define the target attributes. </li>
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky]$ newt target create blink_nordic
+ Creating target blink_nordic
+ Target blink_nordic successfully created!
+ [user@~/dev/nordic_blinky]$ newt target set blink_nordic project=blinky
+ Target blink_nordic successfully set project to blinky
+ [user@~/dev/nordic_blinky]$ newt target set blink_nordic bsp=hw/bsp/nrf52pdk
+ Target blink_nordic successfully set bsp to hw/bsp/nrf52pdk
+ [user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler_def=debug
+ Target blink_nordic successfully set compiler_def to debug
+ [user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler=arm-none-eabi-m4
+ Target blink_nordic successfully set compiler to arm-none-eabi-m4
+ [user@~/dev/nordic_blinky]$ newt target set blink_nordic arch=cortex_m4
+ Target blink_nordic successfully set arch to cortex_m4
+ [user@~/dev/nordic_blinky]$ newt target show
+ blink_nordic
+ compiler: arm-none-eabi-m4
+ name: blink_nordic
+ arch: cortex_m4
+ project: blinky
+ bsp: hw/bsp/nrf52pdk
+ compiler_def: debug
</code></pre>
-</li>
-<li>
-<p>Finally, you get to build the target and generate an executable that can now be uploaded to the board via the on-board SEGGER J-Link debugger. </p>
-<pre><code>[user@~/dev/nordic_blinky]$ newt target build blink_nordic
-Building target blink_nordic (project = blinky)
-Compiling case.c
-Compiling suite.c
-Compiling testutil.c
-Compiling testutil_arch_arm.c
-Archiving libtestutil.a
-Compiling os.c
-Compiling os_callout.c
-Compiling os_eventq.c
-Compiling os_heap.c
-Compiling os_mbuf.c
-Compiling os_mempool.c
-Compiling os_mutex.c
-Compiling os_sanity.c
-Compiling os_sched.c
-Compiling os_sem.c
-Compiling os_task.c
-Compiling os_time.c
-Compiling os_arch_arm.c
-Assembling HAL_CM4.s
-Assembling SVC_Table.s
-Archiving libos.a
-Compiling hal_cputime.c
-Compiling hal_gpio.c
-Compiling hal_uart.c
-Archiving libnrf52xxx.a
-Compiling cmsis_nvic.c
-Compiling hal_bsp.c
-Compiling libc_stubs.c
-Compiling os_bsp.c
-Compiling sbrk.c
-Compiling system_nrf52.c
-Assembling gcc_startup_nrf52.s
-Archiving libnrf52pdk.a
-Compiling main.c
-Building project blinky
-Linking blinky.elf
-Successfully run!
+
+<ul>
+<li>Finally, you get to build the target and generate an executable that can now be uploaded to the board via the on-board SEGGER J-Link debugger. </li>
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky]$ newt target build blink_nordic
+ Building target blink_nordic (project = blinky)
+ Compiling case.c
+ Compiling suite.c
+ Compiling testutil.c
+ Compiling testutil_arch_arm.c
+ Archiving libtestutil.a
+ Compiling os.c
+ Compiling os_callout.c
+ Compiling os_eventq.c
+ Compiling os_heap.c
+ Compiling os_mbuf.c
+ Compiling os_mempool.c
+ Compiling os_mutex.c
+ Compiling os_sanity.c
+ Compiling os_sched.c
+ Compiling os_sem.c
+ Compiling os_task.c
+ Compiling os_time.c
+ Compiling os_arch_arm.c
+ Assembling HAL_CM4.s
+ Assembling SVC_Table.s
+ Archiving libos.a
+ Compiling hal_cputime.c
+ Compiling hal_gpio.c
+ Compiling hal_uart.c
+ Archiving libnrf52xxx.a
+ Compiling cmsis_nvic.c
+ Compiling hal_bsp.c
+ Compiling libc_stubs.c
+ Compiling os_bsp.c
+ Compiling sbrk.c
+ Compiling system_nrf52.c
+ Assembling gcc_startup_nrf52.s
+ Archiving libnrf52pdk.a
+ Compiling main.c
+ Building project blinky
+ Linking blinky.elf
+ Successfully run!
</code></pre>
-</li>
+
+<ul>
<li>
<p>In order to be able to communicate with the SEGGER J-Link debugger on the dev board, you have to download and install the J-Link GDB Server software on to your laptop. You may download the "Software and documentation pack for Mac OS X" from <a href="https://www.segger.com/jlink-software.html">https://www.segger.com/jlink-software.html</a>. The command line version of the server is used in the steps below. </p>
</li>
<li>
<p>Open a new terminal and start a J-Link session.</p>
-<pre><code>[user@~/dev/nordic_blinky/project/blinky/bin]$ which JLinkGDBServer
-/usr/local/bin/JLinkGDBServer
-[user@~/dev/nordic_blinky/project/blinky/bin]$ JLinkGDBServer -if SWD
-SEGGER J-Link GDB Server V5.02f Command Line Version
-
-JLinkARM.dll V5.02f (DLL compiled Oct 2 2015 20:55:03)
-
------GDB Server start settings-----
-GDBInit file: none
-GDB Server Listening port: 2331
-SWO raw output listening port: 2332
-Terminal I/O port: 2333
-Accept remote connection: yes
-Generate logfile: off
-Verify download: off
-Init regs on start: off
-Silent mode: off
-Single run mode: off
-Target connection timeout: 0 ms
-------J-Link related settings------
-J-Link Host interface: USB
-J-Link script: none
-J-Link settings file: none
-------Target related settings------
-Target device: unspecified
-Target interface: SWD
-Target interface speed: 1000kHz
-Target endian: little
-
-Connecting to J-Link...
-J-Link is connected.
-Firmware: J-Link OB-SAM3U128-V2-NordicSemi compiled Aug 28 2015 19:26:24
-Hardware: V1.00
-S/N: 682371959
-Checking target voltage...
-Target voltage: 3.30 V
-Listening on TCP/IP port 2331
-Connecting to target...Connected to target
-Waiting for GDB connection...Connected to 127.0.0.1
-</code></pre>
</li>
-<li>
-<p>You need a configuration file for the GDB session to be opened correctly and the image ("blinky.elf") you built for this target downloaded to flash. A sample config script is given below. Alternatively, you could choose to type each command at the gdb prompt.</p>
-<pre><code> [user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ cat jlink-gdb.cfg
- echo ***Setting up the environment for debugging gdb.***\n
- set complaints 1
- set prompt (gdb)
- set endian little
- echo \n*** Set target charset ASCII\n
- set target-charset ASCII
- echo \n*** Connecting over port #2331 ***\n
- target remote localhost:2331
- echo \n*** Enable flash write and set device to nrf52 ***\n
- monitor flash download=1
- monitor flash device=nRF52
- echo \n*** loading blinky.elf ***\n
- load ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf
- symbol-file ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf
- echo \n*** Resetting target ***\n
- monitor reset
- echo \n*** Halting target ***\n
- monitor halt
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky/project/blinky/bin]$ which JLinkGDBServer
+ /usr/local/bin/JLinkGDBServer
+ [user@~/dev/nordic_blinky/project/blinky/bin]$ JLinkGDBServer -if SWD
+ SEGGER J-Link GDB Server V5.02f Command Line Version
+
+ JLinkARM.dll V5.02f (DLL compiled Oct 2 2015 20:55:03)
+
+ -----GDB Server start settings-----
+ GDBInit file: none
+ GDB Server Listening port: 2331
+ SWO raw output listening port: 2332
+ Terminal I/O port: 2333
+ Accept remote connection: yes
+ Generate logfile: off
+ Verify download: off
+ Init regs on start: off
+ Silent mode: off
+ Single run mode: off
+ Target connection timeout: 0 ms
+ ------J-Link related settings------
+ J-Link Host interface: USB
+ J-Link script: none
+ J-Link settings file: none
+ ------Target related settings------
+ Target device: unspecified
+ Target interface: SWD
+ Target interface speed: 1000kHz
+ Target endian: little
+
+ Connecting to J-Link...
+ J-Link is connected.
+ Firmware: J-Link OB-SAM3U128-V2-NordicSemi compiled Aug 28 2015 19:26:24
+ Hardware: V1.00
+ S/N: 682371959
+ Checking target voltage...
+ Target voltage: 3.30 V
+ Listening on TCP/IP port 2331
+ Connecting to target...Connected to target
+ Waiting for GDB connection...Connected to 127.0.0.1
</code></pre>
-</li>
-<li>
-<p>Start the gdb session and monitor that it loads the image, resets the target, and halts for a command to continue. </p>
-<pre><code>[user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ arm-none-eabi-gdb -x ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/jlink-gdb.cfg
-
-GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs
-Copyright (C) 2014 Free Software Foundation, Inc.
-License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-This is free software: you are free to change and redistribute it.
-There is NO WARRANTY, to the extent permitted by law. Type "show copying"
-and "show warranty" for details.
-This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-eabi".
-Type "show configuration" for configuration details.
-For bug reporting instructions, please see:
-<http://www.gnu.org/software/gdb/bugs/>.
-Find the GDB manual and other documentation resources online at:
-<http://www.gnu.org/software/gdb/documentation/>.
-For help, type "help".
-Type "apropos word" to search for commands related to "word".
-
-***Setting up the environment for debugging gdb.***
-The target is assumed to be little endian
-
-*** Set target charset ASCII
-
-*** Connecting over port #2331 ***
-0x00003c34 in ?? ()
-
-*** Enable flash write and set device to nrf52 ***
-Flash download enabled
-Selecting device: nRF52
-
-*** loading blinky.elf ***
-Loading section .text, size 0x5c84 lma 0x0
-Loading section .ARM.extab, size 0x24 lma 0x5c84
-Loading section .ARM.exidx, size 0xd8 lma 0x5ca8
-Loading section .data, size 0x8f8 lma 0x5d80
-Start address 0x48c, load size 26232
-Transfer rate: 12808 KB/sec, 2914 bytes/write.
-During symbol reading, unexpected overlap between:
- (A) section `.text' from `~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x5c84)
- (B) section `*COM*' from `~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x0).
-Will ignore section B.
-
-*** Resetting target ***
-Resetting target
-
-*** Halting target ***
+
+<ul>
+<li>You need a configuration file for the GDB session to be opened correctly and the image ("blinky.elf") you built for this target downloaded to flash. A sample config script is given below. Alternatively, you could choose to type each command at the gdb prompt.</li>
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ cat jlink-gdb.cfg
+ echo ***Setting up the environment for debugging gdb.***\n
+ set complaints 1
+ set prompt (gdb)
+ set endian little
+ echo \n*** Set target charset ASCII\n
+ set target-charset ASCII
+ echo \n*** Connecting over port #2331 ***\n
+ target remote localhost:2331
+ echo \n*** Enable flash write and set device to nrf52 ***\n
+ monitor flash download=1
+ monitor flash device=nRF52
+ echo \n*** loading blinky.elf ***\n
+ load ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf
+ symbol-file ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf
+ echo \n*** Resetting target ***\n
+ monitor reset
+ echo \n*** Halting target ***\n
+ monitor halt
</code></pre>
-</li>
-<li>
-<p>Type 'c' to continue. The LED on the board will start to blink. You will also see some activity in the terminal showing the open J-Link GDB server connection. The LED will continue to blink after you quit out of that connection.</p>
-<pre><code>(gdb) c
-Continuing.
+
+<ul>
+<li>Start the gdb session and monitor that it loads the image, resets the target, and halts for a command to continue. </li>
+</ul>
+<pre><code class="no-highlight"> [user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ arm-none-eabi-gdb -x ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/jlink-gdb.cfg
+
+ GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs
+ Copyright (C) 2014 Free Software Foundation, Inc.
+ License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+ This is free software: you are free to change and redistribute it.
+ There is NO WARRANTY, to the extent permitted by law. Type "show copying"
+ and "show warranty" for details.
+ This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-eabi".
+ Type "show configuration" for configuration details.
+ For bug reporting instructions, please see:
+ <http://www.gnu.org/software/gdb/bugs/>.
+ Find the GDB manual and other documentation resources online at:
+ <http://www.gnu.org/software/gdb/documentation/>.
+ For help, type "help".
+ Type "apropos word" to search for commands related to "word".
+
+ ***Setting up the environment for debugging gdb.***
+ The target is assumed to be little endian
+
+ *** Set target charset ASCII
+
+ *** Connecting over port #2331 ***
+ 0x00003c34 in ?? ()
+
+ *** Enable flash write and set device to nrf52 ***
+ Flash download enabled
+ Selecting device: nRF52
+
+ *** loading blinky.elf ***
+ Loading section .text, size 0x5c84 lma 0x0
+ Loading section .ARM.extab, size 0x24 lma 0x5c84
+ Loading section .ARM.exidx, size 0xd8 lma 0x5ca8
+ Loading section .data, size 0x8f8 lma 0x5d80
+ Start address 0x48c, load size 26232
+ Transfer rate: 12808 KB/sec, 2914 bytes/write.
+ During symbol reading, unexpected overlap between:
+ (A) section `.text' from `~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x5c84)
+ (B) section `*COM*' from `~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x0).
+ Will ignore section B.
+
+ *** Resetting target ***
+ Resetting target
+
+ *** Halting target ***
</code></pre>
-</li>
+
+<ul>
+<li>Type 'c' to continue. The LED on the board will start to blink. You will also see some activity in the terminal showing the open J-Link GDB server connection. The LED will continue to blink after you quit out of that connection.</li>
</ul>
+<pre><code class="no-highlight"> (gdb) c
+ Continuing.
+</code></pre>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/get_acclimated/project3/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/project3/index.html b/get_acclimated/project3/index.html
index c9f06f5..8f635a7 100644
--- a/get_acclimated/project3/index.html
+++ b/get_acclimated/project3/index.html
@@ -126,13 +126,17 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../vocabulary/">Understanding Newt Terms</a></li>
+ <li class="toctree-l2"><a href="../vocabulary/">Understanding Newt Terms</a></li>
- <li class="toctree-l3"><a href="../project2/">Project 2</a></li>
+ <li class="toctree-l2"><a href="../project2/">Project 2</a></li>
- <li class="toctree-l3"><a href="./">Project 3</a></li>
+ <li class="toctree-l2"><a href="./">Project 3</a></li>
+
+
+
+
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/get_acclimated/vocabulary/index.html
----------------------------------------------------------------------
diff --git a/get_acclimated/vocabulary/index.html b/get_acclimated/vocabulary/index.html
index 800a801..5b30756 100644
--- a/get_acclimated/vocabulary/index.html
+++ b/get_acclimated/vocabulary/index.html
@@ -126,13 +126,33 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="./">Understanding Newt Terms</a></li>
+ <li class="toctree-l2"><a href="./">Understanding Newt Terms</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#nest">Nest</a></li>
+
+ <li class="toctree-l3"><a href="#project">Project</a></li>
+
+ <li class="toctree-l3"><a href="#egg">Egg</a></li>
+
+ <li class="toctree-l3"><a href="#clutch">Clutch</a></li>
+
+ <li class="toctree-l3"><a href="#eggshell">Eggshell</a></li>
+
+ <li class="toctree-l3"><a href="#target">Target</a></li>
+
+ <li class="toctree-l3"><a href="#capability">Capability</a></li>
+
+ <li class="toctree-l3"><a href="#identity">Identity</a></li>
+
+
- <li class="toctree-l3"><a href="../project2/">Project 2</a></li>
+ <li class="toctree-l2"><a href="../project2/">Project 2</a></li>
- <li class="toctree-l3"><a href="../project3/">Project 3</a></li>
+ <li class="toctree-l2"><a href="../project3/">Project 3</a></li>
</ul>
@@ -190,7 +210,7 @@
<p>The nest is the base directory of your embedded software. It is meant to be the workspace containing a logical collection of the source code for one or more of your projects. A nest can contain multiple projects, and reflect multiple end products. </p>
<p>As the base repository of your source code, the nest has a master branch and several other branches off it. You may choose any branch to nest on. Each project in your nest will typically consist of several <a href="#egg">eggs</a>. A project could be an egg itself as well. In addition to eggs, a local nest will contain additional items such as <a href="#target">target</a> or build definitions, clutch description files, scripts etc.</p>
<p>For example, a walk through the "larva" nest at <a href="https://github.com/mynewt/larva.git">https://github.com/mynewt/larva.git</a> shows the following structure. The nest.yml file in the larva directory indicates that it is a nest. An egg will have the egg.yml file in it as shown below. By this nomenclature, each board support package for a particular chip is an egg, the API for the hardware abstraction layer is an egg, and so on. </p>
-<pre><code>larva
+<pre><code class="no-highlight">larva
|- nest.yml
|- compiler
|- arm-none-eabi-m4
@@ -255,9 +275,10 @@
</code></pre>
<p>The newt tool offers the <code>nest</code> command to create and manage nests. In general, commands represent actions and flags are modifiers for those actions. A command can have children commands and optionally run an action. A full description of the <code>nest</code> command can be found in the newt tool reference in Chapter 3.</p>
-<pre><code>newt nest [flags]
-newt nest [child-commands]
+<pre><code class="no-highlight"> newt nest [flags]
+ newt nest [child-commands]
</code></pre>
+
<p>A complete list of all the nest commands can be found in the newt tool reference in <a href="../../newt/newt_tool_reference/">Newt Tool</a>.</p>
<h3 id="project">Project<a class="headerlink" href="#project" title="Permanent link">¶</a></h3>
<p>Projects represent the individual build configurations of your embedded system and essentially defines your application. The project files are what dictate the resulting binary that is generated. </p>
@@ -273,49 +294,57 @@ newt nest [child-commands]
</ul>
<p>A project could itself be an egg if it is a distributable package for a specific application. </p>
<p>The newt tool offers various commands that you can use with a project. For example, if your project is an egg, you can use the following command to install a project from a nest.</p>
-<pre><code>newt egg install [flags] <project egg name>
+<pre><code class="no-highlight"> newt egg install [flags] <project egg name>
</code></pre>
+
<h3 id="egg">Egg<a class="headerlink" href="#egg" title="Permanent link">¶</a></h3>
<p>An egg is a distributable package of libraries. Just as an egg in nature has various parts each of which serves a certain purpose, the Mynewt egg consists of software parcels or modules that have different functions. However, unlike the egg in nature these software modules can exist by itself and may be distributed; therefore, they too are essentially eggs. Once this concept is grasped it is easy to see how an egg may consist of other eggs.</p>
<p>The two main directories in an egg are <code>/include</code> and <code>/src</code>.</p>
<p>The newt tool offers several egg commands to list, inspect, install, and do other operations on eggs. For example, the following command</p>
-<pre><code>newt egg list
+<pre><code class="no-highlight"> newt egg list
</code></pre>
+
<p>outputs all the eggs in the current nest where each egg has details on its version, path, and dependencies. A sample output for an egg is given below.</p>
-<pre><code>Egg libs/os, version 0.1.0
-path: /Users/aditihilbert/dev/test_project/libs/os
-deps: libs/testutil@none#stable
+<pre><code class="no-highlight"> Egg libs/os, version 0.1.0
+ path: /Users/aditihilbert/dev/test_project/libs/os
+ deps: libs/testutil@none#stable
</code></pre>
+
<p>A complete list of all the egg commands can be found in the newt tool reference in <a href="../../newt/newt_tool_reference/">Newt Tool</a>.</p>
<h3 id="clutch">Clutch<a class="headerlink" href="#clutch" title="Permanent link">¶</a></h3>
<p>A clutch is a snapshot of all eggs in a remote nest at any point in time. On any given github branch, a nest with a clutch of eggs will contain a <code>clutch.yml</code> file that specifies the version number, dependencies, and hash value for each constituent egg as well as the name of the entire clutch and the github url for it. [Note: Currently ]</p>
<p>You may download multiple clutches into your local nest as long as the names of the clutches are different. This allows you to mix and match various features and functionality coming from different clutches of eggs. You can see all the clutches in the <code>.nest/clutches</code> directory in your nest.</p>
<p>The newt tool offers clutch management commands within the <code>newt nest</code> command. For example, the following command creates a new clutch using all the eggs in the current directory. It requires that a clutch name be specified and the url for the location of that clutch in the online repository. These two inputs go into the <code>clutch.yml</code> file in the nest.</p>
-<pre><code>newt nest generate-clutch <name> <url>
+<pre><code class="no-highlight"> newt nest generate-clutch <name> <url>
</code></pre>
+
<p>Note that a clutch merely defines the eggs belonging together and requires the eggs to be installed (hatched) for the source code to be populated in the project. </p>
<h3 id="eggshell">Eggshell<a class="headerlink" href="#eggshell" title="Permanent link">¶</a></h3>
<p>The term eggshell is used to refer to the eggs of a clutch in a remote repository. They are not useful on your local machine until you actually install them. So they are mere shells of themselves while sitting on the online repository. When you enter the following command outputs the total number of shells in each remote clutch.</p>
-<pre><code>newt nest list-clutches
+<pre><code class="no-highlight"> newt nest list-clutches
</code></pre>
+
<p>So, if you had two clutches installed, the output could be:</p>
-<pre><code>Remote clutch larva (eggshells: 19)
-Remote clutch ble_test (eggshells: 15)
+<pre><code class="no-highlight"> Remote clutch larva (eggshells: 19)
+ Remote clutch ble_test (eggshells: 15)
</code></pre>
+
<h3 id="target">Target<a class="headerlink" href="#target" title="Permanent link">¶</a></h3>
<p>A target is the hardware build or its software equivalent (e.g. test, simulator) set for a project. It tells the newt tool how to build the source code within a given nest. Once a new target is created, its architecture and other details needs to be defined. An example of a defined target named "blink_f3disc" is given below.</p>
-<pre><code>blink_f3disc
- compiler_def: debug
- compiler: arm-none-eabi-m4
- name: blink_f3disc
- arch: cortex_m4
- project: blinky
- bsp: hw/bsp/stm32f3discovery
+<pre><code class="no-highlight"> blink_f3disc
+ compiler_def: debug
+ compiler: arm-none-eabi-m4
+ name: blink_f3disc
+ arch: cortex_m4
+ project: blinky
+ bsp: hw/bsp/stm32f3discovery
</code></pre>
+
<p>The newt tool offers commands to create, set up and manipulate targets. For example, the create command below creates an empty target named <code>my_target1</code> and the set command sets one detail of its definition, namely the architecture.</p>
-<pre><code>newt target create my_target1
-newt target set my_target1 arch=cortex_m4
+<pre><code class="no-highlight"> newt target create my_target1
+ newt target set my_target1 arch=cortex_m4
</code></pre>
+
<h3 id="capability">Capability<a class="headerlink" href="#capability" title="Permanent link">¶</a></h3>
<p>Capability is functionality that is exposed by an egg. A capability is tracked by its name and version. An egg may require capabilities exposed by another egg, thus establishing a dependency tracked through the egg.yml files. </p>
<p>The newt tool can ascertain a map of all the egg capabilities and use it to check dependencies and make sure all the necessary eggs are in a project for a particular target.</p>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/get_started/how_to_edit_docs/index.html
----------------------------------------------------------------------
diff --git a/get_started/how_to_edit_docs/index.html b/get_started/how_to_edit_docs/index.html
index e2c9e98..5a513e9 100644
--- a/get_started/how_to_edit_docs/index.html
+++ b/get_started/how_to_edit_docs/index.html
@@ -121,16 +121,42 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="../newt_concepts/">Newt Concepts</a></li>
+ <li class="toctree-l2"><a href="../newt_concepts/">Newt Concepts</a></li>
- <li class="toctree-l3"><a href="../project1/">Blinky, The First Project</a></li>
+ <li class="toctree-l2"><a href="../project1/">Blinky, The First Project</a></li>
- <li class="toctree-l3"><a href="./">How to edit docs</a></li>
+ <li class="toctree-l2"><a href="./">How to edit docs</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#objective">Objective</a></li>
+
+ <li class="toctree-l3"><a href="#markdown-mkdocs-mou">Markdown, MkDocs, Mou</a></li>
+
+ <li class="toctree-l3"><a href="#access-to-the-apache-repo">Access to the Apache repo</a></li>
+
+ <li class="toctree-l3"><a href="#making-a-local-copy">Making a local copy</a></li>
+
+ <li class="toctree-l3"><a href="#file-to-be-edited">File to be edited</a></li>
+
+ <li class="toctree-l3"><a href="#editing-an-existing-page">Editing an existing page</a></li>
+
+ <li class="toctree-l3"><a href="#adding-a-new-page">Adding a new page</a></li>
+
+ <li class="toctree-l3"><a href="#pushing-changes-to-remote-as-a-committer">Pushing changes to remote as a committer</a></li>
+
+ <li class="toctree-l3"><a href="#sharing-changes-as-a-non-committer">Sharing changes as a non-committer</a></li>
+
+ <li class="toctree-l3"><a href="#conversion-to-html">Conversion to HTML</a></li>
+
+ <li class="toctree-l3"><a href="#local-preview-of-html-files">Local preview of HTML files</a></li>
+
+
- <li class="toctree-l3"><a href="../try_markdown/">Sample doc to edit</a></li>
+ <li class="toctree-l2"><a href="../try_markdown/">Sample doc to edit</a></li>
</ul>
@@ -200,28 +226,28 @@
<p>If you are not a committer, you may follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is <a href="https://git-wip-us.apache.org/docs/workflow.html">https://git-wip-us.apache.org/docs/workflow.html</a>. You will find the steps described in more detail later in this tutorial.</p>
<h3 id="making-a-local-copy">Making a local copy<a class="headerlink" href="#making-a-local-copy" title="Permanent link">¶</a></h3>
<ul>
-<li>
-<p>Copy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure. Use http instead of https if you are a non-committer.</p>
-<pre><code>$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
-Cloning into 'incubator-mynewt-site'...
-remote: Counting objects: 330, done.
-remote: Compressing objects: 100% (263/263), done.
-remote: Total 330 (delta 120), reused 0 (delta 0)
-Receiving objects: 100% (330/330), 4.34 MiB | 830.00 KiB/s, done.
-Resolving deltas: 100% (120/120), done.
-Checking connectivity... done.
-$ ls
-incubator-mynewt-site
-$ ls incubator-mynewt-site/
-docs images mkdocs.yml
-</code></pre>
-</li>
-<li>
-<p>Create a new branch to work on your documentation and move to that branch.</p>
-<pre><code>$ git checkout -b <your-branch-name>
+<li>Copy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure. Use http instead of https if you are a non-committer.</li>
+</ul>
+<pre><code class="no-highlight"> $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
+ Cloning into 'incubator-mynewt-site'...
+ remote: Counting objects: 330, done.
+ remote: Compressing objects: 100% (263/263), done.
+ remote: Total 330 (delta 120), reused 0 (delta 0)
+ Receiving objects: 100% (330/330), 4.34 MiB | 830.00 KiB/s, done.
+ Resolving deltas: 100% (120/120), done.
+ Checking connectivity... done.
+ $ ls
+ incubator-mynewt-site
+ $ ls incubator-mynewt-site/
+ docs images mkdocs.yml
</code></pre>
-</li>
+
+<ul>
+<li>Create a new branch to work on your documentation and move to that branch.</li>
</ul>
+<pre><code class="no-highlight"> $ git checkout -b <your-branch-name>
+</code></pre>
+
<h3 id="file-to-be-edited">File to be edited<a class="headerlink" href="#file-to-be-edited" title="Permanent link">¶</a></h3>
<p>The file you will edit is <a href="../try_markdown/">try_markdown.md</a>.</p>
<h3 id="editing-an-existing-page">Editing an existing page<a class="headerlink" href="#editing-an-existing-page" title="Permanent link">¶</a></h3>
@@ -240,87 +266,90 @@ docs images mkdocs.yml
</li>
</ul>
<p>You may want to review the documentation organization back in <a href="../..">Home</a> to remind you how to locate files easily. The corresponding directory tree structure is shown below.</p>
-<pre><code> .
- ├── docs
- │ ├── get_started
- │ │ ├── how_to_edit_docs.md
- │ │ ├── newt_concepts.md
- │ │ ├── pics
- │ │ │ ├── bottomview.png
- │ │ │ └── topview.png
- │ │ ├── project1.md
- │ │ └── try_markdown.md
- │ ├── get_acclimated
- │ │ ├── project2.md
- │ │ ├── project3.md
- │ │ ├── ... (more to be added)
- │ │ └── vocabulary.md
- │ ├── newt
- │ │ ├── newt_ops.md
- │ │ └── newt_tool_reference.md
- │ ├── os
- │ │ ├── context_switch.md
- │ │ ├── event_queue.md
- │ │ ├── heap.md
- │ │ ├── mbufs.md
- │ │ ├── memory_pool.md
- │ │ ├── mutex.md
- │ │ ├── mynewt_os.md
- │ │ ├── port_os.md
- │ │ ├── sanity.md
- │ │ ├── semaphore.md
- │ │ ├── task.md
- │ │ ├── time.md
- │ │ └── ... (more to be added)
- │ ├── modules
- │ │ ├── bootloader.md
- │ │ ├── console.md
- │ │ ├── filesystem.md
- │ │ ├── shell.md
- │ │ ├── testutil.md
- │ │ └── ... (more to be added)
- │ ├── packaging
- │ │ ├── dist.md
- │ │ └── ... (more to be added)
- │ ├── extra.css
- │ ├── images
- │ │ └── egg-logo.png
- │ └── index.md
- ├── images
- │ ├── asf_logo_wide.gif
- │ ├── content-bg.png
- │ └── egg-logo.png
- ├── mkdocs.yml
+<pre><code class="no-highlight"> .
+ ├── docs
+ │ ├── get_started
+ │ │ ├── how_to_edit_docs.md
+ │ │ ├── newt_concepts.md
+ │ │ ├── pics
+ │ │ │ ├── bottomview.png
+ │ │ │ └── topview.png
+ │ │ ├── project1.md
+ │ │ └── try_markdown.md
+ │ ├── get_acclimated
+ │ │ ├── project2.md
+ │ │ ├── project3.md
+ │ │ ├── ... (more to be added)
+ │ │ └── vocabulary.md
+ │ ├── newt
+ │ │ ├── newt_ops.md
+ │ │ └── newt_tool_reference.md
+ │ ├── os
+ │ │ ├── context_switch.md
+ │ │ ├── event_queue.md
+ │ │ ├── heap.md
+ │ │ ├── mbufs.md
+ │ │ ├── memory_pool.md
+ │ │ ├── mutex.md
+ │ │ ├── mynewt_os.md
+ │ │ ├── port_os.md
+ │ │ ├── sanity.md
+ │ │ ├── semaphore.md
+ │ │ ├── task.md
+ │ │ ├── time.md
+ │ │ └── ... (more to be added)
+ │ ├── modules
+ │ │ ├── bootloader.md
+ │ │ ├── console.md
+ │ │ ├── filesystem.md
+ │ │ ├── shell.md
+ │ │ ├── testutil.md
+ │ │ └── ... (more to be added)
+ │ ├── packaging
+ │ │ ├── dist.md
+ │ │ └── ... (more to be added)
+ │ ├── extra.css
+ │ ├── images
+ │ │ └── egg-logo.png
+ │ └── index.md
+ ├── images
+ │ ├── asf_logo_wide.gif
+ │ ├── content-bg.png
+ │ └── egg-logo.png
+ ├── mkdocs.yml
</code></pre>
+
<h3 id="adding-a-new-page">Adding a new page<a class="headerlink" href="#adding-a-new-page" title="Permanent link">¶</a></h3>
<p>If you create a new file somewhere in the <code>docs</code> subdirectory to add a new page, you have to add a line in the <code>mkdocs.yml</code> file at the correct level. For example, if you add a new module named "Ethernet" by creating a new file named <code>ethernet.md</code> in the <code>modules</code> subdirectory, you have to insert the following line under <code>Modules:</code> in the <code>mkdocs.yml</code> file.</p>
-<pre><code> - 'Ethernet': 'modules/ethernet.md'
+<pre><code class="no-highlight"> - 'Ethernet': 'modules/ethernet.md'
</code></pre>
+
<h3 id="pushing-changes-to-remote-as-a-committer">Pushing changes to remote as a committer<a class="headerlink" href="#pushing-changes-to-remote-as-a-committer" title="Permanent link">¶</a></h3>
<p>If you are not a committer yet, skip this section and proceed to the <a href="#sharing-changes-as-a-non-committer">next section</a>.</p>
<ul>
-<li>
-<p>Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.</p>
-<pre><code>$ git remote -v
-origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (fetch)
-origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push)
+<li>Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.</li>
+</ul>
+<pre><code class="no-highlight"> $ git remote -v
+ origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (fetch)
+ origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push)
</code></pre>
-</li>
-<li>
-<p>If, however, you do not see your remote repository, then set it up as follows.</p>
-<pre><code>$ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
+
+<ul>
+<li>If, however, you do not see your remote repository, then set it up as follows.</li>
+</ul>
+<pre><code class="no-highlight"> $ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
</code></pre>
-</li>
-<li>
-<p>First check the git status. It will show you that the <code>try_markdown.md</code> document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository. </p>
-</li>
+
+<ul>
+<li>First check the git status. It will show you that the <code>try_markdown.md</code> document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository. </li>
</ul>
<p>During staging below using <code>git add</code>, we use the <code>-A</code> option indicating you want to stage all your modifications. Instead, you can choose to specify only the files that you want to. The commit message (specified after <code>-m</code>) should summarize what your changes are about.</p>
-<pre><code> $ git status
- $ git add -A
- $ git commit -m "My first doc change as a trial run"
- $ git push -u origin <your-branch-name>
+<pre><code class="no-highlight"> $ git status
+ $ git add -A
+ $ git commit -m "My first doc change as a trial run"
+ $ git push -u origin <your-branch-name>
</code></pre>
+
<ul>
<li>
<p>You can see the changed Markdown file if you traverse the tree on the git repository <a href="https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git"> https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git</a>.</p>
@@ -332,37 +361,39 @@ origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push)
<h3 id="sharing-changes-as-a-non-committer">Sharing changes as a non-committer<a class="headerlink" href="#sharing-changes-as-a-non-committer" title="Permanent link">¶</a></h3>
<p>We suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is <a href="https://git-wip-us.apache.org/docs/workflow.html">https://git-wip-us.apache.org/docs/workflow.html</a>. </p>
<ul>
-<li>
-<p>Assuming you have made changes to the example file, you will first commit your changes.</p>
-<pre><code>$ git add -A
-$ git commit -m "My first doc change as a trial run"
+<li>Assuming you have made changes to the example file, you will first commit your changes.</li>
+</ul>
+<pre><code class="no-highlight"> $ git add -A
+ $ git commit -m "My first doc change as a trial run"
</code></pre>
-</li>
-<li>
-<p>Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future):</p>
-<pre><code>$ git format-patch origin/trunk
+
+<ul>
+<li>Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future):</li>
+</ul>
+<pre><code class="no-highlight"> $ git format-patch origin/trunk
</code></pre>
-</li>
-<li>
-<p>Email the patch file to dev@mynewt.incubator.apache.org. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough. </p>
-</li>
+
+<ul>
+<li>Email the patch file to dev@mynewt.incubator.apache.org. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough. </li>
</ul>
<p>If there is a JIRA ticket associated with your work you should post your patch files to the ticket.</p>
<h3 id="conversion-to-html">Conversion to HTML<a class="headerlink" href="#conversion-to-html" title="Permanent link">¶</a></h3>
<p>The conversion of the Markdown files to HTML for the website happens manually and statically using MkDocs. You cannot see automatic and immediate rendering in HTML upon making a change in the Markdown file. You can choose to stop here and proceed to changing other Markdown files in your branch.</p>
<h3 id="local-preview-of-html-files">Local preview of HTML files<a class="headerlink" href="#local-preview-of-html-files" title="Permanent link">¶</a></h3>
<p>However, you have the option to download MkDocs and do a local conversion yourself to preview the pages using the built-in devserver that comes with MkDocs. But first you will have to install MkDocs for that. In order to install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have them already (usually you will).</p>
-<pre><code> $ python --version
- Python 2.7.2
- $ pip --version
- pip 1.5.2
- $ pip install mkdocs
+<pre><code class="no-highlight"> $ python --version
+ Python 2.7.2
+ $ pip --version
+ pip 1.5.2
+ $ pip install mkdocs
</code></pre>
+
<p>You will then run the built-in webserver from the root of the documentation directory using the command <code>mkdocs serve</code>. The root directory for documentation is <code>incubator-mynewt-site</code> or the directory with the <code>mkdocs.yml</code> file.</p>
-<pre><code> $ ls
- docs images mkdocs.yml
- $ mkdocs serve
+<pre><code class="no-highlight"> $ ls
+ docs images mkdocs.yml
+ $ mkdocs serve
</code></pre>
+
<p>Then go to <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a> to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be updated.</p>
<p>For more information on MkDocs go to <a href="http://www.mkdocs.org">http://www.mkdocs.org</a>. </p>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bc3112c0/get_started/newt_concepts/index.html
----------------------------------------------------------------------
diff --git a/get_started/newt_concepts/index.html b/get_started/newt_concepts/index.html
index b553567..4e1373e 100644
--- a/get_started/newt_concepts/index.html
+++ b/get_started/newt_concepts/index.html
@@ -121,16 +121,28 @@
<ul class="current-toc">
- <li class="toctree-l3"><a href="./">Newt Concepts</a></li>
+ <li class="toctree-l2"><a href="./">Newt Concepts</a></li>
+
+
+
+ <li class="toctree-l3"><a href="#basic-components-in-the-ecosystem">Basic components in the ecosystem</a></li>
+
+ <li class="toctree-l3"><a href="#terminology">Terminology</a></li>
+
+ <li class="toctree-l3"><a href="#a-mynewt-contributor">A Mynewt contributor</a></li>
+
+ <li class="toctree-l3"><a href="#a-mynewt-user">A Mynewt user</a></li>
+
+
- <li class="toctree-l3"><a href="../project1/">Blinky, The First Project</a></li>
+ <li class="toctree-l2"><a href="../project1/">Blinky, The First Project</a></li>
- <li class="toctree-l3"><a href="../how_to_edit_docs/">How to edit docs</a></li>
+ <li class="toctree-l2"><a href="../how_to_edit_docs/">How to edit docs</a></li>
- <li class="toctree-l3"><a href="../try_markdown/">Sample doc to edit</a></li>
+ <li class="toctree-l2"><a href="../try_markdown/">Sample doc to edit</a></li>
</ul>