Return-Path: X-Original-To: apmail-mynewt-commits-archive@minotaur.apache.org Delivered-To: apmail-mynewt-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 7E75A187DE for ; Thu, 26 Nov 2015 00:21:53 +0000 (UTC) Received: (qmail 80768 invoked by uid 500); 26 Nov 2015 00:21:53 -0000 Delivered-To: apmail-mynewt-commits-archive@mynewt.apache.org Received: (qmail 80742 invoked by uid 500); 26 Nov 2015 00:21:53 -0000 Mailing-List: contact commits-help@mynewt.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@mynewt.incubator.apache.org Delivered-To: mailing list commits@mynewt.incubator.apache.org Received: (qmail 80706 invoked by uid 99); 26 Nov 2015 00:21:53 -0000 Received: from Unknown (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 26 Nov 2015 00:21:53 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id D99211A2987 for ; Thu, 26 Nov 2015 00:21:52 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 3.248 X-Spam-Level: *** X-Spam-Status: No, score=3.248 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_BADIPHTTP=2, KAM_LAZY_DOMAIN_SECURITY=1, RP_MATCHES_RCVD=-0.554, URIBL_BLOCKED=0.001, WEIRD_PORT=0.001] autolearn=disabled Received: from mx1-eu-west.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id aCYzrzn02HeB for ; Thu, 26 Nov 2015 00:21:38 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-eu-west.apache.org (ASF Mail Server at mx1-eu-west.apache.org) with SMTP id C584C20229 for ; Thu, 26 Nov 2015 00:21:36 +0000 (UTC) Received: (qmail 80454 invoked by uid 99); 26 Nov 2015 00:21:35 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 26 Nov 2015 00:21:35 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id C794FE2C0A; Thu, 26 Nov 2015 00:21:35 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: aditi@apache.org To: commits@mynewt.incubator.apache.org Date: Thu, 26 Nov 2015 00:21:37 -0000 Message-Id: <92e1a8e4025f41bd9f705cbb70258091@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [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 Authored: Wed Nov 25 16:21:16 2015 -0800 Committer: aditihilbert 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 @@
  • Adding a new page
    • -
  • Pushing changes to remote
    • +
  • Pushing changes to remote as a committer
    • + +
  • Sharing changes as a non-committer
  • Conversion to HTML
    • @@ -365,11 +367,12 @@

    You do not need to install MkDocs unless you want to actually render your documentation in HTML in order to preview it before pushing your content to the remote repository. Typically, using a Markdown editor such as Mou is enough to check how it will look after the document has gone through MkDocs. Go ahead and download Mou. If you are on a Windows machine, download the editor of your choice.

    Currently someone in the project is designated to use MkDocs to generate the HTML pages periodically after changes have been reviewed and accepted into the master branch.

    Access to the Apache repo

    -

    Get an account on Apache. You do not need 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.

    +

    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. 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'...
 remote: Counting objects: 330, done.
@@ -464,27 +467,32 @@ docs        images      mkdocs.yml
 
      If you create a new file somewhere in the docs subdirectory to add a new page, you have to add a line in the mkdocs.yml file at the correct level. For example, if you add a new module named "Ethernet" by creating a new file named ethernet.md in the chapter5 subdirectory, you have to insert the following line under Modules: in the mkdocs.yml file.
      
 
          - 'Ethernet': 'chapter5/ethernet.md'
 
      
-
      Pushing changes to remote
      
+
      Pushing changes to remote as a committer
      
+
      If you are not a committer yet, skip this section and proceed to the next section.
      
 
        
 
      • 
-
        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.
        
-
        $ git add -A 
-$ git commit -m "Green Arrow's first doc change"
-$ git push -u origin <your-branch-name>
-
        
+
        First check the git status. It will show you that the try_markdown.md document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository. 
        
 
        • 
+
      
+
      During staging below using git add, we use the -A option indicating you want to stage all your modifications. Instead, you can choose to specify only the files that you want to. The commit message (specified after -m) should summarize what your changes are about.
      
+
          $ git status
+    $ git add -A 
+    $ git commit -m "My first doc change as a trial run"
+    $ git push -u origin <your-branch-name>
+
      
+
        
 
      • 
 
        You can see the changed Markdown file if you traverse the tree on the git repository  https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git.
        
 
        • 
@@ -492,6 +500,25 @@ $ git push -u origin <your-branch-name>
 
        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. 
      
+
        
+
      • 
+
        Assuming you have made changes to the example file, you will first commit your changes.
        
+
        $ git add -A 
+$ git commit -m "My first doc change as a trial run"
+
        
+
        • 
+
      • 
+
        Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future):
        
+
        $ git format-patch origin/trunk
+
        
+
        • 
+
      • 
+
        Email the patch file to dev@mynewt.incubator.apache.org. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough. 
        
+
        • 
+
      
+
      If there is a JIRA ticket associated with your work you should post your patch files to the ticket.
      
 
      Conversion to HTML
      
 
      The conversion of the Markdown files to HTML for the website happens manually and statically using MkDocs. You cannot see automatic and immediate rendering in HTML upon making a change in the Markdown file. You can choose to stop here and proceed to changing other Markdown files in your branch.
      
 
      Local preview of HTML files
      
@@ -508,7 +535,7 @@ $ git push -u origin <your-branch-name>
     $ mkdocs serve

      Then go to 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].

      +

      For more information on MkDocs go to http://www.mkdocs.org.

      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

      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 latest codebase for the Newt tool is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git

        +
        • +
      +

      The following shows how to clone a Mynewt OS code repository:

      +
        +
      • +

        Non Committers

        +
        $ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+
        +
        • +
      • +

        Committers

        +
        $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+

      Getting your Mac Ready

      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 @@

      Project 2 - Blinky on additional boards

      Objective

      -

      The goal of this tutorial is to download a generic firmware skeleton ("bootstrap image") that applies to any hardware and then throw in additional applicable eggs to generate a build for a specific board.

      +

      The goal of this tutorial is to download a generic firmware skeleton ("bootstrap image") that applies to any hardware and then throw in additional applicable eggs to generate a build for a specific board. In the process you will be exposed to more Mynewt terms and Newt tool commands.

      The following target hardware chips are covered:

      • STM32F303VC MCU from STMicroelectronics
        • @@ -360,60 +360,65 @@

        Step by Step Instructions to build image

        • -

          The first step is to download the generic skeleton of the project. The eggs installed are not hardware architecture specific.

          -
          [user:~/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/
+
          The first step is to download the generic skeleton of the project. The eggs constituting the skeleton are not hardware architecture specific. The skeleton is maintained as a nest in a separate repository on Apache. You know it is a nest because there is a nest.yml file. 
          
+
          [user:~/dev]$ newt nest create test_project
+Downloading nest skeleton from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-tadpole.git... ok!
+Nest test_project successfully created in ~/dev/go/test_project
+
+[user:~/dev]$ cd test_project/
+[user:~/dev/test_project]$ ls
+README.md   compiler    hw      libs    nest.yml
        • -

          Then, the clutch of eggs named larva is added from the nest (also named larva) on the github. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (clutch.yml) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.

          -
          [user:~/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!
+
          Next, the clutch of eggs named larva is added from the nest (also named larva) from another repository on Apache. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (clutch.yml) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.
          
+
          [user:~/dev/test_project]$ newt nest add-clutch larva https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+Downloading clutch.yml from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!
+Verifying clutch.yml format...
+ok!
 Clutch larva successfully installed to Nest.

        • The next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need.

          -
          [user:~/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!
-
          • +
        +

        The command should download from apache git repo, not github.

        +
            [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!
+
        +

        • 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
@@ -424,8 +429,11 @@ 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.

          -
          [user:~/foo/test_project]$ newt target build         blink_f3disc
+
          Finally, you get to build the target and generate an executable that can now be uploaded to the board. The STM32F3DISCOVERY board includes an ST-LINK/V2 embedded debug tool interface that you will use to program/debug the board. To program the MCU on the board, simply plug in the two jumpers on CN4, as shown in the picture in red. If you want to learn more about the board you will find the User Manual at http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf
          
+
          • +
        • +

          STMdiscovery

          +
          [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 @@
                 
                     
        • Project GIT Repository
          • 
                 
+                    
        • Using Project GIT Repository
          • 
+                
                     
        • Mailing Lists
          • 
                 
                     
        • Documentation Organization
          • 
@@ -377,6 +379,22 @@
 
          Newt tool development repository (newt) 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.

        +

        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.

        +

        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

        • @@ -470,5 +488,5 @@