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/11/26 01:21:37 UTC
[3/3] incubator-mynewt-site git commit: added non-committer workflow
info and project2 step changes - still work in progress
added non-committer workflow info and project2 step changes - still work in progress
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/d88b9606
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/d88b9606
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/d88b9606
Branch: refs/heads/asf-site
Commit: d88b96063f10b76e7088fc97b438c43dd29314e4
Parents: f6bc105
Author: aditihilbert <ad...@runtime.io>
Authored: Wed Nov 25 16:21:16 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Wed Nov 25 16:21:16 2015 -0800
----------------------------------------------------------------------
chapter1/how_to_edit_docs/index.html | 51 +++++++++++----
chapter1/project1/index.html | 19 +++++-
chapter2/pics/STM32f3discovery_connector.png | Bin 0 -> 612760 bytes
chapter2/project2/index.html | 74 ++++++++++++----------
index.html | 20 +++++-
mkdocs/search_index.json | 16 ++---
sitemap.xml | 56 ++++++++--------
7 files changed, 151 insertions(+), 85 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d88b9606/chapter1/how_to_edit_docs/index.html
----------------------------------------------------------------------
diff --git a/chapter1/how_to_edit_docs/index.html b/chapter1/how_to_edit_docs/index.html
index 8b6f7f4..a23c4b3 100644
--- a/chapter1/how_to_edit_docs/index.html
+++ b/chapter1/how_to_edit_docs/index.html
@@ -98,7 +98,9 @@
<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">Pushing changes to remote</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>
@@ -365,11 +367,12 @@
<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 an account to view the website or clone the repository but you need it to push changes to it.</p>
+<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. </p>
+<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.
@@ -464,27 +467,32 @@ docs images mkdocs.yml
<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 chapter5 subdirectory, you have to insert the following line under <code>Modules:</code> in the <code>mkdocs.yml</code> file.</p>
<pre><code> - 'Ethernet': 'chapter5/ethernet.md'
</code></pre>
-<h3 id="pushing-changes-to-remote">Pushing changes to remote<a class="headerlink" href="#pushing-changes-to-remote" title="Permanent link">¶</a></h3>
+<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.</p>
+<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 it is not, set it up. Otherwise, proceed to the next step.</p>
+<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>Commit and push the changes to the remote repository. Instead of "Green Arrow" type in your username.</p>
-<pre><code>$ git add -A
-$ git commit -m "Green Arrow's first doc change"
-$ git push -u origin <your-branch-name>
-</code></pre>
+<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>
@@ -492,6 +500,25 @@ $ git push -u origin <your-branch-name>
<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>
@@ -508,7 +535,7 @@ $ git push -u origin <your-branch-name>
$ 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 [http://www.mkdocs.org]. </p>
+<p>For more information on MkDocs go to <a href="http://www.mkdocs.org">http://www.mkdocs.org</a>. </p>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d88b9606/chapter1/project1/index.html
----------------------------------------------------------------------
diff --git a/chapter1/project1/index.html b/chapter1/project1/index.html
index 7a51257..e7338ea 100644
--- a/chapter1/project1/index.html
+++ b/chapter1/project1/index.html
@@ -383,13 +383,26 @@ case, simply skip the corresponding installation step in the instructions under
<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>
<ul>
<li>
-<p>Get an account on Apache. You do not need an account to view the website or clone the repository but you need it to push changes to it.</p>
+<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>
</li>
<li>
-<p>The latest codebase for the Mynewt OS is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git</p>
+<p>The latest codebase for the Mynewt OS is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git</p>
</li>
<li>
-<p>The latest codebase for the Newt tool is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git</p>
+<p>The latest codebase for the Newt tool is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git</p>
+</li>
+</ul>
+<p>The following shows how to clone a Mynewt OS code repository:</p>
+<ul>
+<li>
+<p>Non Committers</p>
+<pre><code>$ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+</code></pre>
+</li>
+<li>
+<p>Committers</p>
+<pre><code>$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+</code></pre>
</li>
</ul>
<h3 id="getting-your-mac-ready">Getting your Mac Ready<a class="headerlink" href="#getting-your-mac-ready" title="Permanent link">¶</a></h3>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d88b9606/chapter2/pics/STM32f3discovery_connector.png
----------------------------------------------------------------------
diff --git a/chapter2/pics/STM32f3discovery_connector.png b/chapter2/pics/STM32f3discovery_connector.png
new file mode 100644
index 0000000..1f4437a
Binary files /dev/null and b/chapter2/pics/STM32f3discovery_connector.png differ
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d88b9606/chapter2/project2/index.html
----------------------------------------------------------------------
diff --git a/chapter2/project2/index.html b/chapter2/project2/index.html
index 83524bb..5552fdc 100644
--- a/chapter2/project2/index.html
+++ b/chapter2/project2/index.html
@@ -345,7 +345,7 @@
<h2 id="project-2-blinky-on-additional-boards">Project 2 - Blinky on additional boards<a class="headerlink" href="#project-2-blinky-on-additional-boards" title="Permanent link">¶</a></h2>
<h3 id="objective">Objective<a class="headerlink" href="#objective" title="Permanent link">¶</a></h3>
-<p>The goal of this tutorial is to download a generic firmware skeleton ("bootstrap image") that applies to any hardware and then throw in additional applicable eggs to generate a build for a specific board. </p>
+<p>The 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>
@@ -360,60 +360,65 @@
<h4 id="step-by-step-instructions-to-build-image">Step by Step Instructions to build image<a class="headerlink" href="#step-by-step-instructions-to-build-image" title="Permanent link">¶</a></h4>
<ul>
<li>
-<p>The first step is to download the generic skeleton of the project. The eggs installed are not hardware architecture specific.</p>
-<pre><code>[user:~/foo]$ newt nest create test_project
-Downloading nest skeleton from https://www.github.com/mynewt/tadpole... ok!
-Nest test_project successfully created in ~/foo/test_project
-
-[user:~/foo]$ cd test_project/
+<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>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:~/foo/test_project]$ 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!
+<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:~/foo/test_projec]$ newt egg install project/blinky
-Downloading larva from https://github.com/mynewt/larva//master... ok!
-Installing project/blinky
-Installation was a success!
-
-[user:~/foo/test_project]$ newt egg install hw/bsp/stm32f3discovery
-Downloading larva from https://github.com/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>
+</ul>
+<p><font color="red"> The command should download from apache git repo, not github. </font></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.git/master... ok!
+ Installing project/blinky
+ Installing libs/console/full
+ Installing libs/shell
+ Installation was a success!
+
+ [user:~/dev/test_project]$ newt egg install hw/bsp/stm32f3discovery
+ Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!
+ Installing hw/bsp/stm32f3discovery
+ Installation was a success!
+</code></pre>
+<ul>
<li>
<p>It's time to create a target for the project and define the target attributes. </p>
-<pre><code>[user:~/foo/test_project]$ newt target create blink_f3disc
+<pre><code>[user:~/dev/test_project]$ newt target create blink_f3disc
Creating target blink_f3disc
Target blink_f3disc successfully created!
-[user:~/foo/test_project]$ newt target set blink_f3disc project=blinky
+[user:~/dev/test_project]$ newt target set blink_f3disc project=blinky
Target blink_f3disc successfully set project to blinky
-[user:~/foo/test_project]$ newt target set blink_f3disc bsp=hw/bsp/stm32f3discovery
+[user:~/dev/test_project]$ newt target set blink_f3disc bsp=hw/bsp/stm32f3discovery
Target blink_f3disc successfully set bsp to hw/bsp/stm32f3discovery
-[marko@Markos-MacBook-Pro-2:~/foo/test_project]$ newt target set blink_f3disc compiler_def=debug
+[user:~/dev/test_project]$ newt target set blink_f3disc compiler_def=debug
Target blink_f3disc successfully set compiler_def to debug
-[user:~/foo/test_project]$ newt target set blink_f3disc compiler=arm-none-eabi-m4
+[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:~/foo/test_project]$ newt target set blink_f3disc arch=cortex_m4
+[user:~/dev/test_project]$ newt target set blink_f3disc arch=cortex_m4
Target blink_f3disc successfully set arch to cortex_m4
-[user:~/foo/test_project]$ newt target show blink_f3disc
+[user:~/dev/test_project]$ newt target show blink_f3disc
blink_f3disc
arch: cortex_m4
project: blinky
@@ -424,8 +429,11 @@ blink_f3disc
</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 JTAG port. You can go into the openocd directory and start an OCD session as you did in Project 1.</p>
-<pre><code>[user:~/foo/test_project]$ newt target build blink_f3disc
+<p>Finally, you get to build the target and generate an executable that can now be uploaded to the board. The STM32F3DISCOVERY board includes an ST-LINK/V2 embedded debug tool interface that you will use to program/debug the board. To program the MCU on the board, simply plug in the two jumpers on CN4, as shown in the picture in red. If you want to learn more about the board you will find the User Manual at <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:~/foo/test_project]$ newt target build blink_f3disc
Building target blink_f3disc (project = blinky)
Compiling case.c
Compiling suite.c
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d88b9606/index.html
----------------------------------------------------------------------
diff --git a/index.html b/index.html
index c51905d..fffd94b 100644
--- a/index.html
+++ b/index.html
@@ -62,6 +62,8 @@
<li><a class="toctree-l4" href="#project-git-repository">Project GIT Repository</a></li>
+ <li><a class="toctree-l4" href="#using-project-git-repository">Using Project GIT Repository</a></li>
+
<li><a class="toctree-l4" href="#mailing-lists">Mailing Lists</a></li>
<li><a class="toctree-l4" href="#documentation-organization">Documentation Organization</a></li>
@@ -377,6 +379,22 @@
<p><a href="https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git">Newt tool development repository (newt)</a> containing source code for the newt tool.</p>
</li>
</ul>
+<h3 id="using-project-git-repository">Using Project GIT Repository<a class="headerlink" href="#using-project-git-repository" title="Permanent link">¶</a></h3>
+<p>For general information on using Git at Apache, go to <a href="https://git-wip-us.apache.org">https://git-wip-us.apache.org</a>.</p>
+<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 <a href="https://git-wip-us.apache.org/docs/workflow.html">https://git-wip-us.apache.org/docs/workflow.html</a>. </p>
+<p>To clone the Mynewt OS development repository:</p>
+<ul>
+<li>
+<p>Non Committers</p>
+<pre><code>$ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+</code></pre>
+</li>
+<li>
+<p>Committers</p>
+<pre><code>$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+</code></pre>
+</li>
+</ul>
<h3 id="mailing-lists">Mailing Lists<a class="headerlink" href="#mailing-lists" title="Permanent link">¶</a></h3>
<ul>
<li>
@@ -470,5 +488,5 @@
<!--
MkDocs version : 0.14.0
-Build Date UTC : 2015-11-24 20:13:01.280949
+Build Date UTC : 2015-11-26 00:20:10.466335
-->