Install newt tool on Linux
Getting your Linux box Ready
If you want to build the newt tool from its source code, follow the following steps:
1. Install git, libcurl
$ sudo apt-get install git $ sudo apt-get install libcurl4-gnutls-dev
NOTE: On 64-bit host, you may also need to install gcc-multilib, if you encounter compilation errors related to 'sys/cdefs.h'
2. Install Go, the programming language
Go language environment dictates a directory structure. Known in Go parlance as a workspace, it must contain three sibling directories with the directory names src, pkg and bin, as explained below.
src contains Go source files organized into packages (one package per directory),
pkg contains package objects, and
bin contains executable commands.
The GOPATH environment variable specifies the location of your workspace. To setup this workspace environment, create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory where you will soon clone the newt tool repository.
$ cd $HOME $ mkdir -p dev/go $ cd dev/go $ export GOPATH=`pwd`
(Note that you need to add export statements to ~/.bash_profile to export variables permanently. Don't forget to source the file for the change to go into effect.)
$ vi ~/.bash_profile $ source ~/.bash_profile
Next, install Go. When installed, Go offers you as a developer a language environment (to compile Go code), construct Go packages (to assemble Go packages) and import Go code (from github). In the next step, you will use the Go commands to import newt repo into your local Go environment.
Note: The Newt tool requires Go version 1.6 or later. Depending on the Ubuntu version you have, the following may install an earlier version. In that case, download the latest package of Go 1.6 from https://golang.org/dl/. You can search for more detailed instructions such as installing Go 1.6 on Ubuntu 14.04 which can be found at https://www.digitalocean.com/community/tutorials/how-to-install-go-1-6-on-ubuntu-14-04.
$ sudo apt-get install golang
3. Create local repository
- Use Go commands to copy the directory (currently the ASF incubator directory). Be patient as it may take a minute or two. Check the directories installed.
$ go get mynewt.apache.org/newt/...
- Check that newt.go is in place.
$ ls $GOPATH/src/mynewt.apache.org/newt DISCLAIMER NOTICE newt newtvm viper LICENSE README.md newtmgr util yaml
4. Build the Newt tool
- Use Go to run the newt.go program to build the newt tool. The command
go installcompiles and writes the resulting executable to an output file named
newt, which is then installed, along with its dependencies, in $GOPATH/bin. If you get errors it is likely because of path resolution issues. Try
go buildfollowed by
go installin that case.
$ cd $GOPATH/src/mynewt.apache.org/newt/newt $ go install $ ls "$GOPATH"/bin/ newt newtmgr newtvm
- At this point, you can try using newt. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.
(Note: If you are going to be modifying the newt often and going to be compile the program every time you call it, you will want to store the command in a variable in your .bash_profile. So type in
export newt="go run $GOPATH/mynewt.apache.org/newt/newt/newt.go" in your .bash_profile and execute it by calling
$newt at the prompt instead of
go run which runs the compiled binary directly without producing an executable. Don't forget to reload the updated bash profile by typing
source ~/.bash_profile at the prompt! )
$ newt version Newt version: 1.0 $ newt -h Newt allows you to create your own embedded application based on the Mynewt operating system. Newt provides both build and package management in a single tool, which allows you to compose an embedded application, and set of projects, and then build the necessary artifacts from those projects. For more information on the Mynewt operating system, please visit https://mynewt.apache.org/. Please use the newt help command, and specify the name of the command you want help for, for help on how to use a specific command Usage: newt [flags] newt [command] Examples: newt newt help [<command-name>] For help on <command-name>. If not specified, print this message. Available Commands: build Build one or more targets clean Delete build artifacts for one or more targets create-image Add image header to target binary debug Open debugger session to target info Show project info install Install project dependencies load Load built target to board mfg Manufacturing flash image commands new Create a new project pkg Create and manage packages in the current workspace run build/create-image/download/debug <target> size Size of target components sync Synchronize project dependencies target Commands to create, delete, configure, and query targets test Executes unit tests for one or more packages upgrade Upgrade project dependencies vals Display valid values for the specified element type(s) version Display the Newt version number Flags: -h, --help Help for newt commands -j, --jobs int Number of concurrent build jobs (default 8) -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 [command] --help" for more information about a comma
5. Updating the Newt tool
- You will update the newt tool in the same place as you initially installed the newt tool.
- Start by updating the git repository of the newt tool (you can change to a different branch using git checkout [branch] if you need to)
- Then update each of the tools newt, newtmgr and newtvm as needed
$ cd $GOPATH/src/mynewt.apache.org/newt $ git pull $ cd newt $ go install $ cd ../newtmgr $ go install $ cd ../newtvm $ go install $ ls "$GOPATH"/bin/ newt newtmgr newtvm
That should have updated your newt, newtmgr and newtvm to the latest versions based on the git repository you used.