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/11/05 04:51:11 UTC
[26/50] incubator-mynewt-site git commit: Updated for newest versions
of newt
Updated for newest versions of newt
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/b3def6ad
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/b3def6ad
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/b3def6ad
Branch: refs/heads/develop
Commit: b3def6ad953586906949628941bb5ec39c730925
Parents: 8800078
Author: David G. Simmons <sa...@mac.com>
Authored: Thu Oct 20 12:00:09 2016 -0400
Committer: David G. Simmons <sa...@mac.com>
Committed: Thu Oct 20 12:00:09 2016 -0400
----------------------------------------------------------------------
docs/os/get_started/project_create.md | 100 +++++++++++++++++++++++------
docs/os/get_started/vocabulary.md | 32 ++++-----
docs/os/tutorials/tutorials.md | 2 +-
3 files changed, 98 insertions(+), 36 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3def6ad/docs/os/get_started/project_create.md
----------------------------------------------------------------------
diff --git a/docs/os/get_started/project_create.md b/docs/os/get_started/project_create.md
index 90ec19c..351941f 100644
--- a/docs/os/get_started/project_create.md
+++ b/docs/os/get_started/project_create.md
@@ -77,6 +77,20 @@ targets.
**NOTE:** the actual code and package files are not installed
(except the template for `main.c`). See the next step for installing the packages.
+**NOTE:** By default newt uses the code in the master branch. This is the latest stable
+code for newt. If you need to use a different branch, you can set this in the project.yml
+file.
+
+```no-highlight
+repository.apache-mynewt-core:
+ type: github
+ vers: 0-latest
+ user: apache
+ repo: incubator-mynewt-core
+```
+Changing to 0-dev will put you on the develop branch. **The Develop Branch may not be stable and
+you may encounter bugs or other problems.**
+
<br>
### Newt Install
@@ -100,8 +114,32 @@ Once _newt install_ has successfully finished, the contents of _apache-mynewt-co
```no-highlight
$ tree -L 2 repos/apache-mynewt-core/
-.
-<snip>
+repos/apache-mynewt-core/
+\u251c\u2500\u2500 CODING_STANDARDS.md
+\u251c\u2500\u2500 DISCLAIMER
+\u251c\u2500\u2500 LICENSE
+\u251c\u2500\u2500 NOTICE
+\u251c\u2500\u2500 README.md
+\u251c\u2500\u2500 RELEASE_NOTES.md
+\u251c\u2500\u2500 apps
+\u2502�� \u251c\u2500\u2500 blecent
+\u2502�� \u251c\u2500\u2500 blehci
+\u2502�� \u251c\u2500\u2500 bleprph
+\u2502�� \u251c\u2500\u2500 bletest
+\u2502�� \u251c\u2500\u2500 bletiny
+\u2502�� \u251c\u2500\u2500 bleuart
+\u2502�� \u251c\u2500\u2500 blinky
+\u2502�� \u251c\u2500\u2500 boot
+\u2502�� \u251c\u2500\u2500 ffs2native
+\u2502�� \u251c\u2500\u2500 luatest
+\u2502�� \u251c\u2500\u2500 slinky
+\u2502�� \u2514\u2500\u2500 test
+\u251c\u2500\u2500 compiler
+\u2502�� \u251c\u2500\u2500 arm-none-eabi-m0
+\u2502�� \u251c\u2500\u2500 arm-none-eabi-m4
+\u2502�� \u2514\u2500\u2500 sim
+\u251c\u2500\u2500 drivers
+\u2502�� \u2514\u2500\u2500 uart_bitbang
\u251c\u2500\u2500 fs
\u2502�� \u251c\u2500\u2500 fs
\u2502�� \u2514\u2500\u2500 nffs
@@ -111,12 +149,16 @@ $ tree -L 2 repos/apache-mynewt-core/
\u2502�� \u2514\u2500\u2500 mcu
\u251c\u2500\u2500 libs
\u2502�� \u251c\u2500\u2500 baselibc
+\u2502�� \u251c\u2500\u2500 bleuart
+\u2502�� \u251c\u2500\u2500 boot_serial
\u2502�� \u251c\u2500\u2500 bootutil
\u2502�� \u251c\u2500\u2500 cmsis-core
\u2502�� \u251c\u2500\u2500 console
+\u2502�� \u251c\u2500\u2500 crash_test
\u2502�� \u251c\u2500\u2500 elua
\u2502�� \u251c\u2500\u2500 flash_test
\u2502�� \u251c\u2500\u2500 imgmgr
+\u2502�� \u251c\u2500\u2500 inet_def_service
\u2502�� \u251c\u2500\u2500 json
\u2502�� \u251c\u2500\u2500 mbedtls
\u2502�� \u251c\u2500\u2500 newtmgr
@@ -124,10 +166,26 @@ $ tree -L 2 repos/apache-mynewt-core/
\u2502�� \u251c\u2500\u2500 shell
\u2502�� \u251c\u2500\u2500 testreport
\u2502�� \u251c\u2500\u2500 testutil
-\u2502�� \u2514\u2500\u2500 util
+\u2502�� \u251c\u2500\u2500 tinycrypt
+\u2502�� \u251c\u2500\u2500 util
+\u2502�� \u2514\u2500\u2500 wifi_mgmt
\u251c\u2500\u2500 net
\u2502�� \u2514\u2500\u2500 nimble
-<snip>
+\u251c\u2500\u2500 project.yml
+\u251c\u2500\u2500 repository.yml
+\u251c\u2500\u2500 sys
+\u2502�� \u251c\u2500\u2500 config
+\u2502�� \u251c\u2500\u2500 coredump
+\u2502�� \u251c\u2500\u2500 fcb
+\u2502�� \u251c\u2500\u2500 id
+\u2502�� \u251c\u2500\u2500 log
+\u2502�� \u251c\u2500\u2500 mn_socket
+\u2502�� \u251c\u2500\u2500 reboot
+\u2502�� \u2514\u2500\u2500 stats
+\u2514\u2500\u2500 targets
+ \u2514\u2500\u2500 unittest
+
+61 directories, 8 files
```
As you can see, the core of the Apache Mynewt operating system has been brought
@@ -150,6 +208,13 @@ Compiling flash_map.c
<snip>
```
+**NOTE:** If you've installed the latest gcc using homebrew on your Mac, you should downgrade to gcc-5 in order to use MyNewt.
+
+```
+$ brew uninstall gcc-6
+$ brew link gcc-5
+```
+
<br>
To test all the packages in a project, specify `all` instead of the package name.
@@ -158,10 +223,11 @@ To test all the packages in a project, specify `all` instead of the package name
$ newt test all
...lots of compiling and testing...
...about 2 minutes later ...
-Archiving bootutil.a
-Linking test_bootutil
-Executing test: /myproj/bin/unittest/libs/bootutil/test_bootutil
-Passed tests: [net/nimble/host fs/nffs libs/os hw/hal libs/mbedtls libs/util sys/config libs/bootutil]
+Compiling mn_sock_test.c
+Archiving mn_socket.a
+Linking test_mn_socket
+Executing test: /Users/dsimmons/myproj/bin/unittest/sys/mn_socket/test_mn_socket
+Passed tests: [libs/json libs/util libs/mbedtls net/nimble/host hw/hal libs/bootutil sys/log sys/config sys/fcb fs/nffs libs/os libs/boot_serial sys/mn_socket]
All tests passed
```
@@ -173,21 +239,17 @@ To build and run your new application, simply issue the following command:
```
$ newt build my_blinky_sim
-Compiling base64.c
-Compiling cbmem.c
-Compiling datetime.c
-Compiling tpq.c
-Archiving util.a
+Building target targets/my_blinky_sim
Compiling main.c
Archiving blinky.a
+Compiling hal_bsp.c
+Compiling os_bsp.c
+Compiling sbrk.c
+Archiving native.a
Compiling flash_map.c
-Compiling hal_flash.c
-Archiving hal.a
-Compiling cons_fmt.c
-Compiling cons_tty.c
<snip>
Linking blinky.elf
-App successfully built: /Users/sterling/dev/tmp/my_app/bin/my_blinky_sim/apps/blinky/blinky.elf
+App successfully built: /Users/dsimmons/myproj/bin/my_blinky_sim/apps/blinky/blinky.elf
```
<br>
@@ -196,7 +258,7 @@ You can run the simulated version of your project and see the simulated LED
blink.
```
-./bin/my_blinky_sim/apps/blinky/blinky.elf
+$ ./bin/my_blinky_sim/apps/blinky/blinky.elf
hal_gpio set pin 1 to 0
```
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3def6ad/docs/os/get_started/vocabulary.md
----------------------------------------------------------------------
diff --git a/docs/os/get_started/vocabulary.md b/docs/os/get_started/vocabulary.md
index 8598a40..5461f4f 100644
--- a/docs/os/get_started/vocabulary.md
+++ b/docs/os/get_started/vocabulary.md
@@ -46,6 +46,10 @@ relies upon.
* ```repository.apache-mynewt-core```: Defines the repository information for
the ```apache-mynewt-core``` repository.
+* ```vers=0-latest```: Defines the repository version. This string will use the
+latest code in the 'Master' github branch. To use the latest version in the
+develop branch, just change it to ```vers=0-dev```
+
Repositories are versioned collections of packages.
Projects can rely on remote repositories for functionality, and the newt tool
@@ -131,32 +135,28 @@ you can find more information about these by issuing:
```no-highlight
$ newt target
-
-Usage:
+Usage:
newt target [flags]
newt target [command]
-Available Commands:
- show View target configuration variables
- set Set target configuration variable
+Available Commands:
+ copy Copy target
create Create a target
delete Delete target
- copy Copy target
+ set Set target configuration variable
+ show View target configuration variables
vars Show variable names
Flags:
- -h, --help=false: help for target
+ -h, --help help for target
Global Flags:
- -l, --loglevel="WARN": Log level, defaults to WARN.
- -o, --outfile="": Filename to tee log output to
- -q, --quiet=false: Be quiet; only display error output.
- -s, --silent=false: Be silent; don't output anything.
- -v, --verbose=false: Enable verbose output when executing commands.
-
-Additional help topics:
-
+ -l, --loglevel string Log level (default "WARN")
+ -o, --outfile string Filename to tee output to
+ -q, --quiet Be quiet; only display error output
+ -s, --silent Be silent; don't output anything
+ -v, --verbose Enable verbose output when executing commands
-Use "newt help [command]" for more information about a command.
+Use "newt target [command] --help" for more information about a command.
$
```
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3def6ad/docs/os/tutorials/tutorials.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/tutorials.md b/docs/os/tutorials/tutorials.md
index 4a684ca..1136e1d 100644
--- a/docs/os/tutorials/tutorials.md
+++ b/docs/os/tutorials/tutorials.md
@@ -7,7 +7,7 @@ The full list of tutorials can be seen in the navigation bar on the left. New on
###Prerequisites:
* You have installed Docker container of Newt tool and toolchains or you have installed them natively on your machine
-* You have created a new project space (directory structure) and populated it with the core code repository (apache-mynewt-core) or know how to as explained in ../get_started/project_create.
+* You have created a new project space (directory structure) and populated it with the core code repository (apache-mynewt-core) or know how to as explained in [Create Project](../get_started/project_create).
###Tutorial categories: