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:20:02 UTC
incubator-mynewt-site git commit: added non-committer workflow info
and project2 step changes - still work in progress
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/master b6959da3f -> c91f293f2
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/c91f293f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/c91f293f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/c91f293f
Branch: refs/heads/master
Commit: c91f293f2e7aa57bdfa11a65c01767f93990ea42
Parents: b6959da
Author: aditihilbert <ad...@runtime.io>
Authored: Wed Nov 25 16:19:51 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Wed Nov 25 16:19:51 2015 -0800
----------------------------------------------------------------------
docs/chapter1/how_to_edit_docs.md | 40 +++++++++---
docs/chapter1/project1.md | 17 +++++-
.../pics/STM32f3discovery_connector.png | Bin 0 -> 612760 bytes
docs/chapter2/project2.md | 61 +++++++++++--------
docs/index.md | 17 ++++++
5 files changed, 97 insertions(+), 38 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c91f293f/docs/chapter1/how_to_edit_docs.md
----------------------------------------------------------------------
diff --git a/docs/chapter1/how_to_edit_docs.md b/docs/chapter1/how_to_edit_docs.md
index f3da5cf..86a5f39 100644
--- a/docs/chapter1/how_to_edit_docs.md
+++ b/docs/chapter1/how_to_edit_docs.md
@@ -15,13 +15,13 @@ Currently someone in the project is designated to use MkDocs to generate the HTM
### Access to the Apache repo
+Get an account on Apache. You do not need a committer account to view the website or clone the repository but you need it to push changes to it.
-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.
-
+If you are not a committer, you may follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is [https://git-wip-us.apache.org/docs/workflow.html](https://git-wip-us.apache.org/docs/workflow.html). You will find the steps described in more detail later in this tutorial.
### Making a local copy
-* Copy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure.
+* Copy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure. Use http instead of https if you are a non-committer.
$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
Cloning into 'incubator-mynewt-site'...
@@ -116,29 +116,51 @@ If you create a new file somewhere in the `docs` subdirectory to add a new page,
- 'Ethernet': 'chapter5/ethernet.md'
-### Pushing changes to remote
+### Pushing changes to remote as a committer
+
+If you are not a committer yet, skip this section and proceed to the [next section](#sharing-changes-as-a-non-committer).
-* Check whether your remote git repository is set up.
+* Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.
$ git remote -v
origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (fetch)
origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push)
-* If it is not, set it up. Otherwise, proceed to the next step.
+* If, however, you do not see your remote repository, then set it up as follows.
$ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
-* Commit and push the changes to the remote repository. Instead of "Green Arrow" type in your username.
+* First check the git status. It will show you that the `try_markdown.md` document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository.
+
+ During staging below using `git add`, we use the `-A` option indicating you want to stage all your modifications. Instead, you can choose to specify only the files that you want to. The commit message (specified after `-m`) should summarize what your changes are about.
+ $ git status
$ git add -A
- $ git commit -m "Green Arrow's first doc change"
+ $ git commit -m "My first doc change as a trial run"
$ git push -u origin <your-branch-name>
* You can see the changed Markdown file if you traverse the tree on the git repository [ https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git]( https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git).
* A commit notification automatically goes out to the commits@mynewt.incubator.apache.org mailing list. The "upstream" manager pulls the notified changes, reviews it, and merges it to the master branch if all is well. Otherwise you get an email for further changes.
+### Sharing changes as a non-committer
+
+We suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is [https://git-wip-us.apache.org/docs/workflow.html](https://git-wip-us.apache.org/docs/workflow.html).
+
+* Assuming you have made changes to the example file, you will first commit your changes.
+
+ $ git add -A
+ $ git commit -m "My first doc change as a trial run"
+
+* Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future):
+
+ $ git format-patch origin/trunk
+
+* Email the patch file to dev@mynewt.incubator.apache.org. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough.
+
+ If there is a JIRA ticket associated with your work you should post your patch files to the ticket.
+
### Conversion to HTML
@@ -162,4 +184,4 @@ You will then run the built-in webserver from the root of the documentation dire
Then go to [http://127.0.0.1:8000](http://127.0.0.1:8000) to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be updated.
-For more information on MkDocs go to [http://www.mkdocs.org].
\ No newline at end of file
+For more information on MkDocs go to [http://www.mkdocs.org](http://www.mkdocs.org).
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c91f293f/docs/chapter1/project1.md
----------------------------------------------------------------------
diff --git a/docs/chapter1/project1.md b/docs/chapter1/project1.md
index 0edb6ee..95d19e6 100644
--- a/docs/chapter1/project1.md
+++ b/docs/chapter1/project1.md
@@ -28,11 +28,22 @@ case, simply skip the corresponding installation step in the instructions under
### Access to the Apache repo
-* 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.
+* Get an account on Apache. You do not need a committer account to view the website or clone the repository but you need it to push changes to it.
-* The latest codebase for the Mynewt OS is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+* The latest codebase for the Mynewt OS is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+
+* The latest codebase for the Newt tool is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git
+
+The following shows how to clone a Mynewt OS code repository:
+
+* Non Committers
+
+ $ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+
+* Committers
+
+ $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
-* 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
### Getting your Mac Ready
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c91f293f/docs/chapter2/pics/STM32f3discovery_connector.png
----------------------------------------------------------------------
diff --git a/docs/chapter2/pics/STM32f3discovery_connector.png b/docs/chapter2/pics/STM32f3discovery_connector.png
new file mode 100644
index 0000000..1f4437a
Binary files /dev/null and b/docs/chapter2/pics/STM32f3discovery_connector.png differ
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c91f293f/docs/chapter2/project2.md
----------------------------------------------------------------------
diff --git a/docs/chapter2/project2.md b/docs/chapter2/project2.md
index a85fd03..ba7ec5c 100644
--- a/docs/chapter2/project2.md
+++ b/docs/chapter2/project2.md
@@ -2,7 +2,7 @@
### Objective
-The goal of this tutorial is to download a generic firmware skeleton ("bootstrap image") that applies to any hardware and then throw in additional applicable eggs to generate a build for a specific board.
+The goal of this tutorial is to download a generic firmware skeleton ("bootstrap image") that applies to any hardware and then throw in additional applicable eggs to generate a build for a specific board. In the process you will be exposed to more Mynewt terms and Newt tool commands.
The following target hardware chips are covered:
@@ -20,59 +20,65 @@ The following target hardware chips are covered:
#### Step by Step Instructions to build image
-* The first step is to download the generic skeleton of the project. The eggs installed are not hardware architecture specific.
+* The first step is to download the generic skeleton of the project. The eggs constituting the skeleton are not hardware architecture specific. The skeleton is maintained as a nest in a separate repository on Apache. You know it is a nest because there is a nest.yml file.
- [user:~/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:~/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:~/foo]$ cd test_project/
+ [user:~/dev]$ cd test_project/
+ [user:~/dev/test_project]$ ls
+ README.md compiler hw libs nest.yml
-* Then, the clutch of eggs named larva is added from the nest (also named larva) on the github. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (`clutch.yml`) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.
+
+* Next, the clutch of eggs named larva is added from the nest (also named larva) from another repository on Apache. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (`clutch.yml`) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.
- [user:~/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!
+ [user:~/dev/test_project]$ newt nest add-clutch larva https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+ Downloading clutch.yml from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!
+ Verifying clutch.yml format...
+ ok!
Clutch larva successfully installed to Nest.
* The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need.
- [user:~/foo/test_projec]$ newt egg install project/blinky
- Downloading larva from https://github.com/mynewt/larva//master... ok!
+<font color="red"> The command should download from apache git repo, not github. </font>
+
+
+ [user:~/dev/test_project]$ newt egg install project/blinky
+ Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!
Installing project/blinky
+ Installing libs/console/full
+ Installing libs/shell
Installation was a success!
- [user:~/foo/test_project]$ newt egg install hw/bsp/stm32f3discovery
- Downloading larva from https://github.com/mynewt/larva//master... ok!
+ [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
- Installing hw/mcu/stm/stm32f3xx
- Installing libs/cmsis-core
- Installing compiler/arm-none-eabi-m4
Installation was a success!
* It's time to create a target for the project and define the target attributes.
- [user:~/foo/test_project]$ newt target create blink_f3disc
+ [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
@@ -81,9 +87,12 @@ The following target hardware chips are covered:
compiler: arm-none-eabi-m4
name: blink_f3disc
-* Finally, you get to build the target and generate an executable that can now be uploaded to the board via the JTAG port. You can go into the openocd directory and start an OCD session as you did in Project 1.
+* Finally, you get to build the target and generate an executable that can now be uploaded to the board. The STM32F3DISCOVERY board includes an ST-LINK/V2 embedded debug tool interface that you will use to program/debug the board. To program the MCU on the board, simply plug in the two jumpers on CN4, as shown in the picture in red. If you want to learn more about the board you will find the User Manual at [http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf](http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf)
+
+* 
+
- [user:~/foo/test_project]$ newt target build blink_f3disc
+ [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/c91f293f/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index 2212c83..ac13a84 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -30,6 +30,22 @@ The world of Mynewt, therefore, has three primary collaborative goals:
* [Newt tool development repository (newt)](https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git) containing source code for the newt tool.
+### Using Project GIT Repository
+
+For general information on using Git at Apache, go to [https://git-wip-us.apache.org](https://git-wip-us.apache.org).
+
+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](https://git-wip-us.apache.org/docs/workflow.html).
+
+To clone the Mynewt OS development repository:
+
+* Non Committers
+
+ $ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+
+* Committers
+
+ $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+
### Mailing Lists
* dev@mynewt.incubator.apache.org
@@ -45,6 +61,7 @@ The world of Mynewt, therefore, has three primary collaborative goals:
This is for all autogenerated mail except commits e.g. JIRA notifications. In order to subscribe to the notifications list, send an email to notifications-subscribe@mynewt.incubator.apache.org.
To subscribe to a mailing list, you simply send an email to a special subscription address. To subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org. For the issues list, the address would be issues-subscribe@mynewt.incubator.apache.org. You should then get an automated email which details how to confirm your subscription.
+
### Documentation Organization