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/10 09:00:19 UTC
[12/14] incubator-mynewt-site git commit: removing all files from
asf-site to redo doc structure
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d880edf/docs/chapter2/vocabulary.md
----------------------------------------------------------------------
diff --git a/docs/chapter2/vocabulary.md b/docs/chapter2/vocabulary.md
deleted file mode 100644
index 5e6b792..0000000
--- a/docs/chapter2/vocabulary.md
+++ /dev/null
@@ -1,170 +0,0 @@
-## Understanding Newt Terms
-
-### Nest
-
-The nest is the base directory of your embedded software. It is meant to be the workspace containing a logical collection of the source code for one or more of your projects. A nest can contain multiple projects, and reflect multiple end products.
-
-As the base repository of your source code, the nest has a master branch and several other branches off it. You may choose any branch to nest on. Each project in your nest will typically consist of several [eggs](#egg). A project could be an egg itself as well. In addition to eggs, a local nest will contain additional items such as [target](#target) or build definitions, clutch description files, scripts etc.
-
-For example, a walk through the "larva" nest at [https://github.com/mynewt/larva.git](https://github.com/mynewt/larva.git) shows the following structure. The nest.yml file in the larva directory indicates that it is a nest. An egg will have the egg.yml file in it as shown below. By this nomenclature, each board support package for a particular chip is an egg, the API for the hardware abstraction layer is an egg, and so on.
-
-```
-larva
- |- nest.yml
- |- compiler
- |- arm-none-eabi-m4
- |- sim
- |- hw (hardware)
- |- bsp (board support package)
- |- nrf52pdk (Nordic nRF52 series chip)
- |- egg.yml
- |- ...
- |- olimex_stm32-e407_devboard (used in chapter1 project)
- |- egg.yml
- |- ...
- |- stm32f3discovery (another board with stm32f3 mcu)
- |- egg.yml
- |- ...
- |- yet another board
- |- egg.yml
- |- ...
- |- hal (hardware abstraction layer APIs)
- |- egg.yml
- |- include
- |- hal_cputime.h
- |- hal_flash.h
- |- hal_gpio.h
- |- ... (header files for other peripherals)
- |- mcu (microcontroller)
- |- stm (STMicro family)
- |- stm32f3xx (STM32f3 series, 32-bit ARM Cortex-M4 core)
- |- egg.yml
- |- src
- |- hal_gpio.c (specific to the STM32f3 mcu)
- |- hal_cputime.c
- |- ... (code for other peripherals)
- |- nordic (Nordic Semiconductor family)
- |- nrf52xxx (nRF52 Series SoC, Cortex-M4F core)
- |- egg.yml
- |- src
- |- hal_gpio.c (specific to the nRF52 mcu )
- |- hal_cputime.c
- |- ... (code for other peripherals)
- |- yet another family of mcu
- |- ...
- |- libs
- |- bootutil (hw architecture independent boot loader library)
- |- egg.yml
- |- src
- |- loader.c
- |- ... (related source code files)
- |- nffs (hw architecture independent Newtron Flash File System)
- |- egg.yml
- |- src
- |- nffs.c
- |- ... (related source code files)
- |- another library
- |- egg.yml
- |- src
- |- ... (related source code files)
- |- project
- |- scripts
-
-
-```
-
-The newt tool offers the `nest` command to create and manage nests. In general, commands represent actions and flags are modifiers for those actions. A command can have children commands and optionally run an action. A full description of the `nest` command can be found in the newt tool reference in Chapter 3.
-
- newt nest [flags]
- newt nest [child-commands]
-
-A complete list of all the nest commands can be found in the newt tool reference in [Chapter 3](../chapter3/newt_tool_reference.md).
-
-### Project
-
-Projects represent the individual build configurations of your embedded system and essentially defines your application. The project files are what dictate the resulting binary that is generated.
-
-Layout-wise, a project is a directory inside a nest and contains eggs required for a certain application. For example, the `blinky` egg sits in `project/blinky` directory of the `larva` nest. This egg is used in the blinky project (application) outlined in [Chapter 1](../chapter1/project1.md). <*Note: This Will Change*>
-
-A project has the following concepts or properties associated with it. You can find them in the `<project-name>.yml` file in the project directory. For example, the `project/blinky` directory has the `blinky.yml` file indicating some or all of the properties below. Only the name of a project is required for the project to exist, however additional properties may need to be specified for the eggs in it to compile properly and produce an executable.
-
-* Project name
-* Base path of the project (nest/project/project-name by default)
-* Eggs belonging to the project
-* [Capabilities](#capabilities) that are required for the project or target
-* [Identity](#identity) to classify the type of project or target
-* Compiler flags to call out any specific compiler requirement
-
-A project could itself be an egg if it is a distributable package for a specific application.
-
-The newt tool offers various commands that you can use with a project. For example, if your project is an egg, you can use the following command to install a project from a nest.
-
- newt egg install [flags] <project egg name>
-
-### Egg
-
-An egg is a distributable package of libraries. Just as an egg in nature has various parts each of which serves a certain purpose, the Mynewt egg consists of software parcels or modules that have different functions. However, unlike the egg in nature these software modules can exist by itself and may be distributed; therefore, they too are essentially eggs. Once this concept is grasped it is easy to see how an egg may consist of other eggs.
-
-The two main directories in an egg are `/include` and `/src`.
-
-The newt tool offers several egg commands to list, inspect, install, and do other operations on eggs. For example, the following command
-
- newt egg list
-
-outputs all the eggs in the current nest where each egg has details on its version, path, and dependencies. A sample output for an egg is given below.
-
- Egg libs/os, version 0.1.0
- path: /Users/aditihilbert/dev/test_project/libs/os
- deps: libs/testutil@none#stable
-
-A complete list of all the egg commands can be found in the newt tool reference in [Chapter 3](../chapter3/newt_tool_reference.md).
-
-### Clutch
-
-A clutch is a snapshot of all eggs in a remote nest at any point in time. On any given github branch, a nest with a clutch of eggs will contain a `clutch.yml` file that specifies the version number, dependencies, and hash value for each constituent egg as well as the name of the entire clutch and the github url for it. [Note: Currently ]
-
-You may download multiple clutches into your local nest as long as the names of the clutches are different. This allows you to mix and match various features and functionality coming from different clutches of eggs. You can see all the clutches in the `.nest/clutches` directory in your nest.
-
-The newt tool offers clutch management commands within the `newt nest` command. For example, the following command creates a new clutch using all the eggs in the current directory. It requires that a clutch name be specified and the url for the location of that clutch in the online repository. These two inputs go into the `clutch.yml` file in the nest.
-
- newt nest generate-clutch <name> <url>
-
-Note that a clutch merely defines the eggs belonging together and requires the eggs to be installed (hatched) for the source code to be populated in the project.
-
-### Eggshell
-
-The term eggshell is used to refer to the eggs of a clutch in a remote repository. They are not useful on your local machine until you actually install them. So they are mere shells of themselves while sitting on the online repository. When you enter the following command outputs the total number of shells in each remote clutch.
-
- newt nest list-clutches
-
-So, if you had two clutches installed, the output could be:
-
- Remote clutch larva (eggshells: 19)
- Remote clutch ble_test (eggshells: 15)
-
-### Target
-
-A target is the hardware build or its software equivalent (e.g. test, simulator) set for a project. It tells the newt tool how to build the source code within a given nest. Once a new target is created, its architecture and other details needs to be defined. An example of a defined target named "blink_f3disc" is given below.
-
- blink_f3disc
- compiler_def: debug
- compiler: arm-none-eabi-m4
- name: blink_f3disc
- arch: cortex_m4
- project: blinky
- bsp: hw/bsp/stm32f3discovery
-
-The newt tool offers commands to create, set up and manipulate targets. For example, the create command below creates an empty target named `my_target1` and the set command sets one detail of its definition, namely the architecture.
-
- newt target create my_target1
- newt target set my_target1 arch=cortex_m4
-
-### Capability
-
-Capability is functionality that is exposed by an egg. A capability is tracked by its name and version. An egg may require capabilities exposed by another egg, thus establishing a dependency tracked through the egg.yml files.
-
-The newt tool can ascertain a map of all the egg capabilities and use it to check dependencies and make sure all the necessary eggs are in a project for a particular target.
-
-### Identity
-
-Identity is a property of a target or project in the newt world. A target may inherit it from a project or vice versa. It may be used to determine what eggs to include or how an egg code should behave in a build or which linkerscripts to use. For example, the identity of a lock is different from the identity of a wearable monitor. Even if they were to be built on the same hardware target, different features and behavior are required. Their different identities result in differing sets of eggs in the projects and/or the same egg behaving differently depending on the identity.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d880edf/docs/chapter3/newt_ops.md
----------------------------------------------------------------------
diff --git a/docs/chapter3/newt_ops.md b/docs/chapter3/newt_ops.md
deleted file mode 100644
index 39171d0..0000000
--- a/docs/chapter3/newt_ops.md
+++ /dev/null
@@ -1,40 +0,0 @@
-## Command Structure
-
-In the newt tool, commands represent actions and flags are modifiers for those actions. A command can have children commands which are also simply referred to as commands. One or more arguments may need to be provided to a command to execute it correctly.
-
-In the example below, the `newt` command has the child command `target set`. The first argument 'my_target1' is the name of the target whose attributes are being set. The second argument 'arch=cortex_m4' specifies the value to set the attribute (variable) 'arch' to, which in this case is 'cortex_m4'.
-
- newt target set my_target1 arch=cortex_m4
-
-Global flags work on all newt commands in the same way. An example is the flag `-v, --verbose` to ask for a verbose output while executing a command. The help flag `-h` or `--help` is available on all commands but provides command specific output, of course. These flags may be specified in either a long or a short form.
-
-A command may additionally take flags specific to it. For example, the `-b ` flag may be used with `newt egg install` to tell it which branch to install the egg from.
-
- newt egg install -b <branchname> <eggname>
-
-In addition to the newt tool [reference](../chapter3/newt_tool_reference.md) in this documentation set, command-line help is available for each command (and child command). Simply use the flag `-h` or `--help` as shown below:
-
- $ newt target export --help
- Export build targets from the current nest, and print them to
- standard output. If the -a (or -export-all) option is specified,
- then all targets will be exported. Otherwise, <target-name>
- must be specified, and only that target will be exported.
-
- Usage:
- newt target export [flags]
-
- Examples:
- newt target export [-a -export-all] [<target-name>]
- newt target export -a > my_exports.txt
- newt target export my_target > my_target_export.txt
-
- Flags:
- -a, --export-all=false: If present, export all targets
- -h, --help=false: help for export
-
- Global Flags:
- -l, --loglevel="WARN": Log level, defaults to WARN.
- -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.
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d880edf/docs/chapter3/newt_tool_reference.md
----------------------------------------------------------------------
diff --git a/docs/chapter3/newt_tool_reference.md b/docs/chapter3/newt_tool_reference.md
deleted file mode 100644
index 27cf442..0000000
--- a/docs/chapter3/newt_tool_reference.md
+++ /dev/null
@@ -1,269 +0,0 @@
-
-## Command List
-
-### Available high-level commands
-
-```
-version Display the Newt version number
-help Help about any command
-nest Commands to manage nests & clutches (remote egg repositories)
-egg Commands to list and inspect eggs on a nest
-target Set and view target information
-```
-
-### *version*
-
-#### Usage:
-
- newt version [flags]
-
-Flags:
-
- -h, --help=false: help for version
-
-Global Flags:
-
- -h, --help=false: help for newt
-
-
-Examples
-
-Sub-command | Usage | Explanation
--------------| -----------------------|-----------------
-version | newt version | Displays the version of newt tool installed
-
-
-### *help*
-
-#### Usage:
-
- newt help [input1]
-
-Flags:
-
-```
-
--h, --help=false: help for newt
--l, --loglevel="WARN": Log level, defaults to WARN.
--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.
-```
-
-Examples
-
-Sub-command | Usage | Explanation
--------------| -----------------------|-----------------
-help | newt help target | Displays the help text for the newt command 'target'
-help | newt help | Displays the help text for newt tool
-
-
-
-### *nest*
-
-#### Usage:
-
- newt nest [command][flags] input1 input2...
-
-Available commands:
-
- create Create a new nest
- generate-clutch Generate a clutch file from the eggs in the current directory
- add-clutch Add a remote clutch, and put it in the current nest
- list-clutches List the clutches installed in the current nest
- show-clutch Show an individual clutch in the current nest
-
-
-Flags:
-
- -h, --help=false: help for nest
-
-Global Flags:
-
- -h, --help=false: help for newt
- -l, --loglevel="WARN": Log level, defaults to WARN.
- -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.
-
-Description
-
-Sub-command | Explanation
--------------| ------------------------
-create | Downloads the skeleton of a nest on your local machine from the optional `input2` nest url, if specified, and creates a new nest directory by the name of `input1`. If `input2` is not specified, then a default skeleton from the `tadpole` nest on Mynewt is downloaded. The command lays out a generic directory structure for the nest you are going to build under it and includes some default eggs in it.
-generate-clutch | Takes a snapshot of the eggs in the current local directory and combines them into a clutch by the name of `input1` and with the url of `input2` and generates a standard output of the clutch details that can be redirected to a `.yml` clutch file. Typically the clutch file name is chosen to match the clutch name which means the standard output should be directed to a clutch file named `input1.yml`
-add-clutch | Downloads the clutch of the name `input1` from the master branch of the github repository `input2` into the current nest. A file named `input1.yml` file is added in the `.nest/clutches` subdirectory inside the current local nest. The `.nest/` directory structure is created automatically if it does not exist.
-list-clutches | Lists all the clutches present in the current nest, including clutches that may have been added from other nests on github. The output shows all the remote clutch names and the total eggshells in each of the clutches.
-show-clutch | Shows information about the clutch that has the name given in the `input1` argument. Output includes the clutch name, url, and all the constituent eggs with their version numbers.
-
-Command-specific flags
-
-Sub-command | Available flags | Explanation
--------------| ----------------|------------
-add-clutch | -b, --branch="<branch-name>" | Fetches the clutch file with name `input1` from the specified branch at `input1` url of the github repository. All subsequent egg installations will be done from that branch.
-
-Examples
-
-Sub-command | Usage | Explanation
--------------| -----------------------|-----------------
-create | newt nest create test_project | Creates a new nest named "test_project " using the default skeleton0
-create | newt nest create mynest <nest-url> | Creates a new nest named "mynest" using the skeleton at the <nest-url> specified
-generate-clutch | newt nest generate-clutch myclutch https://www.github.com/mynewt/larva > myclutch.yml| Takes a snapshot of the eggs in the current nest to form a clutch named myclutch with the url https://www.github.com/mynewt/larva. The output is written to a file named `myclutch.yml` and describes the properties and contents of the clutch (name, url, eggs).
-add-clutch | newt nest add-clutch larva https://www.github.com/mynewt/larva | Adds the remote clutch named larva at www.github.com/mynewt/larva to the local nest.
-list-clutches | newt nest list-clutches | Shows all the remote clutch description files that been downloaded into the current nest
-show-clutch | newt nest show-clutch larva | Outputs the details of the clutch named larva such as the github url where the remote sits, the constituent eggs and their versions
-
-
-### *egg*
-
-#### Usage:
-
- newt egg [command][flag] input1 input2
-
-
-Available Commands:
-
- list List eggs in the current nest
- checkdeps Check egg dependencies
- hunt Search for egg from clutches
- show Show the contents of an egg.
- install Install an egg
- remove Remove an egg
-
-Flags:
-
- -h, --help=false: help for egg
-
-Global Flags:
-
- -l, --loglevel="WARN": Log level, defaults to WARN.
- -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.
-
-Description
-
-Sub-command | Explanation
--------------| ------------------------
-list | List all the eggs in the current nest. The output shows the name, version, path, and any additional attributes of each egg in the nest such as dependencies, capabilities, and linker scripts. The newt command gets the attributes of each egg from the corresponsing egg.yml description file.
-checkdeps | Resolve all dependencies in the local nest. This command goes through all eggs currently installed, checks their dependencies, and prints any unresolved dependencies between eggs.
-hunt | Hunts for an egg, specified by `input1`. The local nest, along with all remote nests (clutches) are searched. All matched eggs are shown along with the clutch informaton. Installed eggs are called out as such. The command can be invoked from anywhere in the nest.
-show | Show the contents of the egg named `input2` found in the clutch named `input1`. The clutch name is optional; if only the egg name is given as the argument it is resolved using all the clutches installed in the current nest. If the egg is present in multiple clutches it will list all of them along with the clutch information for each.
-install | Install the egg specified by `input2` from the clutch named `input1`. The command downloads the egg from the github repository using the URL in the clutch description file (typically donwloaded as 'input1@<branch-name>.yml' in .nest/clutches). It also downloads all the dependencies (constituent eggs) as decribed in the egg's description file ('egg.yml') and installs all of them. The clutch name is optional. If only the egg name is given as the argument, the command looks for the egg name in all the clutches in the local nest and installs accordingly. An egg is installed by this command only if it has not already been installed.
-remove | Remove an egg named `input2` from clutch `input1`, if clutch is specified. Otherwise only one input required - that of the name of the egg to be removed from the local nest.
-
-
-
-
-Command-specific flags
-
-Sub-command | Available flags | Explanation
--------------| ----------------|------------
-install | -b, --branch="<branch-name>" | Installs the eggs from the branch name or tag of the clutch specified
-
-Examples
-
-Sub-command | Usage | Explanation
--------------| -----------------------|-----------------
-list | newt egg list | CList all of the eggs in the current nest and the details of the eggs.
-checkdeps | newt egg checkdeps | Checks all the dependencies between eggs in the nest. Lists any unresolved dependencies.
-hunt | newt egg hunt blinky| Hunts for the egg named 'blinky'. The command can be invoked from anywhere in the nest. Results show if the egg is installed and which clutch, if any, has the egg.
-show | newt egg show larva libs/os | Show the contents of the egg named 'libs/os' in the clutch named larva. The contents are essentially derived from the egg's 'egg.yml' file.
-install | newt egg install hw/bsp/stm32f3discovery | Downloads and installs the egg named "stm32f3discovery" (specified with its full path name inside the remote nest) along with all its dependencies from the remote nest on github. Since no clutch is specified, the URL for the remote nest in the clutch description file found in the local nest (in .nest/clutches for the project) is used.
-remove | newt egg remove larva blinky| Removes the egg named blinky only from the clutch named larva
-remove | newt egg remove blinky| Removes the egg named blinky from the local nest
-
-
-### *target*
-
-#### Usage:
-
-Usage:
-
- newt target [command] input1 [flag1] [flag2]
-
-Available Commands:
-
- set Set target configuration variable
- unset Unset target configuration variable
- delete Delete target
- create Create a target
- show View target configuration variables
- build Build target
- test Test target
- export Export target
- import Import target
- download Download image to target
- debug Download image to target and start an openocd/gdb session
-
-Flags:
-
- -h, --help=false: help for target
-
-Global Flags:
-
- -l, --loglevel="WARN": Log level, defaults to WARN.
- -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.
-
-Description
-
-Sub-command | Explanation
--------------| ------------------------
-set | Set attributes of the target. Currently the list of possible attributes are:``` arch, compiler, compiler_def, project, bsp, egg, identities, capabilities, dependencies, cflags, lflags```. Typically only the first 5 need to be set for a hardware target. For a simulated target, e.g. for software testing purposes, `arch=sim`, `compiler=sim`, and `egg=<egg name to be tested>`. You cannot set both the project and egg for a target.
-unset | Unset attributes of the target in its configuration.
-delete | Deletes only the description for the target. Does not delete the target directory with associated binaries. If you want to clean out the binaries, list files, and executables use`newt target build <target-name> clean` **before** deleting the target!
-create | Creates a target description or build definition by the name `input1`. By default it assigns the sim (simulator) architecture to it which allows you to build new projects and software on your native OS and try it out.
-show | Display the configuration defined for the target named `input1`. If no `input1` is specified then show the details for all the targets in the nest.
-build | Build the source code into an image that can be loaded on the hardware associated with the target named `input1` to do the application enabled by the 'project' associated with that target (via the target definition). It creates 'bin/' and 'bin/<input1>/' subdirectories inside the base directory for the project, compiles and generates binaries and executables, and places them in 'bin/<input1>/.
-test | Test an egg on the target named `input1`. The egg is either supplied as an argument to the command line invocation of `newt target test` or added as part of the target definition. If only the target is specified as `input1`, then the egg in the target's definition is automatically chosen to be tested. You currently cannot test an entire project on a hardware target. The test command is envisioned for use if one or two eggs gets updated and each needs to be tested against a target. Alternatively, a script may be written for a series of tests on several eggs.
-export | Exports the configurations of the specified target `input1`. If -a or -export-all flag is used, then all targets are exported and printed out to standard out. You may redirect the output to a file.
-import | Import one or more target configuration from standard input or a file. Each target starts with `@target=<target-name>` followed by the attributes. The list of targets should end with `@endtargets`.
-size | Outputs the RAM and flash consumption by the components of the specified target `input1`.
-download | Downloads the binary executable `<target-name>.elf.bin` to the board.
-debug | Downloads the binary executable `<target-name>.elf.bin` to the board and starts up the openocd/gdb combination session. gdb takes over the terminal.
-
-
-Command-specific flags
-
-Sub-command | Available flags | Explanation
--------------| ----------------|------------
-build | clean | All the binaries and object files for the specified target will be removed. The subdirectory named after the specified target within that project is removed.
-build clean | all | All the binaries and object files for all targets are removed, and subdirectories of all targets for the project are removed. However, the entire repository is not emptied since any eggs or projects that the specified target doesn't reference are not touched.
-export | -a, -export-all | Export all targets. `input1` is not necessary when this flag is used.
-import | -a, -import-all | Import all targets typed into standard input or redirected from a file.
-
-Examples
-
- Sub-command | Usage | Explanation
--------------| -----------------------|-----------------
-set | newt target set myblinky compiler=arm-none-eabi-m4 | Set the compiler for the 'myblinky' target to the gcc compiler for embedded ARM chips.
-unset | newt target unset myblinky compiler | Remove the setting for the compiler for the 'myblinky' target.
-delete | newt target delete myblinky | Delete the target description for the target named 'myblinky'. Note that it does not remove any binaries or clean out the directory for this target.
-create | newt target create blink_f3disc | Create a new target description by the name 'blink_f3disc'. The architecture is 'sim' by default and can be changed using subcommand 'set' above.
-show | newt target show myblinky | Show the target attributes set for 'myblinky'
-build | newt target build blink_f3disc | Compile the source code for the target named blink_f3disc and generate binaries that can be loaded into the target hardware.
-test | newt target test test_target egg=libs/os | Tests the egg named 'libs/os' against the target named 'test_target'
-export | newt target export -a > my_exports.txt | Export all build targets from the current nest, and redirect output to a file named 'my_exports.txt'.
-export | newt target export -export-all | Export all build targets from the current nest, and print them to standard output on the screen.
-export | newt target export my_target | Export only target named 'my_target' and print it to standard output on the screen.
-import | newt target import ex_tgt_1 < exported_targets.txt | Imports the target configuration for 'ex_tgt_1' in 'exported_targets.txt'.
-import | newt target import -a < in_targets.txt | Imports all the targets specified in the file named `in_targets.txt`. A sample file is shown after this table.
-size | newt target size blink_nordic | Inspects and lists the RAM and Flash memory use by each component (object files and libraries) of the target.
-download | newt target -v -lVERBOSE download blinky | Downloads `blinky.elf.bin` to the hardware in verbose mode with logging turned on at VERBOSE level.
-debug | newt target debug blinky | Downloads `blinky.elf.bin` to the hardware, opens up a gdb session with `blinky.elf` in the terminal, and halts for further input in gdb.
-
-Example content for `in_targets.txt` file used for importing targets `test3` and `test4`.
-
-> @target=test3
-project=blinked
-arch=sim
-compiler_def=debug
-compiler=arm-none-eabi-m4
-@target=test4
-project=super_blinky
-arch=sim
-compiler_def=debug
-compiler=arm-none-eabi-m4
-@endtargets
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d880edf/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index 9175ab1..0000000
--- a/docs/index.md
+++ /dev/null
@@ -1,18 +0,0 @@
-## Objective of Mynewt
-
-
-Mynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind.
-
-The world of Mynewt, therefore, has three primary collaborative goals:
-
-* Build a modularized real-time operating system for a rich set of hardware components
-* Offer a suite of open-source software for efficient and secure two-way communications with an embedded device
-* Develop method and tools necessary to build an optimized executable image on the desired hardware
-
-The chapter organization is outlined below. Each Chapter has one or more tutorials for hands-on experience with the material in each chapter.
-
-* [Chapter 1: Getting Started](chapter1/newt_concepts.md) introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.
-
-* [Chapter 2: Getting Acclimated](chapter2/vocabulary.md) delves deeper into the concepts crucial to the software development effort.
-
-* [Chapter 3: Newt Tool Reference](chapter3/newt_ops.md) describes the command structure and details all the available commands to help you with your project.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d880edf/images/content-bg.png
----------------------------------------------------------------------
diff --git a/images/content-bg.png b/images/content-bg.png
deleted file mode 100644
index 8829c20..0000000
Binary files a/images/content-bg.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d880edf/images/egg-logo.png
----------------------------------------------------------------------
diff --git a/images/egg-logo.png b/images/egg-logo.png
deleted file mode 100644
index c04e70d..0000000
Binary files a/images/egg-logo.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d880edf/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
deleted file mode 100644
index 720f846..0000000
--- a/mkdocs.yml
+++ /dev/null
@@ -1,22 +0,0 @@
-site_name: Mynewt
-site_url: http://mynewt.incubator.apache.org/index.html
-
-pages:
-- Doc Home: index.md
-- Getting Started:
- - 'Newt Concepts': 'chapter1/newt_concepts.md'
- - 'Blinky, The First Project': 'chapter1/project1.md'
-- Getting Acclimated:
- - 'Understanding Newt Terms': 'chapter2/vocabulary.md'
- - 'Project 2': 'chapter2/project2.md'
- - 'Project 3': 'chapter2/project3.md'
-- Newt tool Reference:
- - 'Command structure': 'chapter3/newt_ops.md'
- - 'Command list': 'chapter3/newt_tool_reference.md'
-
-markdown_extensions:
- - toc:
- permalink: true
- - admonition:
-
-theme: mkdocs
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d880edf/site/404.html
----------------------------------------------------------------------
diff --git a/site/404.html b/site/404.html
deleted file mode 100644
index 755cb05..0000000
--- a/site/404.html
+++ /dev/null
@@ -1,209 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-
-
- <link rel="shortcut icon" href="./img/favicon.ico">
-
- <title>Mynewt</title>
-
- <link href="./css/bootstrap-custom.min.css" rel="stylesheet">
- <link href="./css/font-awesome-4.0.3.css" rel="stylesheet">
- <link href="./css/base.css" rel="stylesheet">
- <link rel="stylesheet" href="./css/highlight.css">
-
- <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
- <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
- <![endif]-->
-
-
- </head>
-
- <body>
-
- <div class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="container">
-
- <!-- Collapsed navigation -->
- <div class="navbar-header">
-
- <!-- Expander button -->
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
-
- <!-- Main title -->
- <a class="navbar-brand" href=".">Mynewt</a>
- </div>
-
- <!-- Expanded navigation -->
- <div class="navbar-collapse collapse">
-
- <!-- Main navigation -->
- <ul class="nav navbar-nav">
-
-
- <li >
- <a href=".">Doc Home</a>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Getting Started <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="chapter1/newt_concepts/">Newt Concepts</a>
-</li>
-
-
-
-<li >
- <a href="chapter1/project1/">Blinky, The First Project</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Getting Acclimated <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="chapter2/vocabulary/">Understanding Newt Terms</a>
-</li>
-
-
-
-<li >
- <a href="chapter2/project2/">Project 2</a>
-</li>
-
-
-
-<li >
- <a href="chapter2/project3/">Project 3</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Newt tool Reference <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="chapter3/newt_ops/">Command structure</a>
-</li>
-
-
-
-<li >
- <a href="chapter3/newt_tool_reference/">Command list</a>
-</li>
-
-
- </ul>
- </li>
-
-
- </ul>
-
-
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
- <i class="fa fa-search"></i> Search
- </a>
- </li>
-
- <li class="disabled">
- <a rel="next" >
- <i class="fa fa-arrow-left"></i> Previous
- </a>
- </li>
- <li class="disabled">
- <a rel="prev" >
- Next <i class="fa fa-arrow-right"></i>
- </a>
- </li>
-
-
- </ul>
- </div>
- </div>
-</div>
-
- <div class="container">
-
-
- <div class="row-fluid">
- <div id="main-content" class="span12">
- <h1 id="404-page-not-found" style="text-align: center">404</h1>
- <p style="text-align: center"><strong>Page not found</strong></p>
- </div>
- </div>
-
-
- </div>
-
- <footer class="col-md-12">
- <hr>
-
- <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p>
- </footer>
-
- <script src="./js/jquery-1.10.2.min.js"></script>
- <script src="./js/bootstrap-3.0.3.min.js"></script>
- <script src="./js/highlight.pack.js"></script>
- <script>var base_url = '.';</script>
- <script data-main="./mkdocs/js/search.js" src="./mkdocs/js/require.js"></script>
- <script src="./js/base.js"></script>
-
- <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
- <div class="modal-dialog">
- <div class="modal-content">
- <div class="modal-header">
- <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
- <h4 class="modal-title" id="exampleModalLabel">Search</h4>
- </div>
- <div class="modal-body">
- <p>
- From here you can search these documents. Enter
- your search terms below.
- </p>
- <form role="form">
- <div class="form-group">
- <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
- </div>
- </form>
- <div id="mkdocs-search-results"></div>
- </div>
- <div class="modal-footer">
- </div>
- </div>
- </div>
- </div>
-
- </body>
-</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d880edf/site/chapter1/newt_concepts/index.html
----------------------------------------------------------------------
diff --git a/site/chapter1/newt_concepts/index.html b/site/chapter1/newt_concepts/index.html
deleted file mode 100644
index f413b51..0000000
--- a/site/chapter1/newt_concepts/index.html
+++ /dev/null
@@ -1,255 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-
- <link rel="canonical" href="http://mynewt.incubator.apache.org/index.html/chapter1/newt_concepts/">
- <link rel="shortcut icon" href="../../img/favicon.ico">
-
- <title>Newt Concepts - Mynewt</title>
-
- <link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
- <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
- <link href="../../css/base.css" rel="stylesheet">
- <link rel="stylesheet" href="../../css/highlight.css">
-
- <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
- <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
- <![endif]-->
-
-
- </head>
-
- <body>
-
- <div class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="container">
-
- <!-- Collapsed navigation -->
- <div class="navbar-header">
-
- <!-- Expander button -->
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
-
- <!-- Main title -->
- <a class="navbar-brand" href="../..">Mynewt</a>
- </div>
-
- <!-- Expanded navigation -->
- <div class="navbar-collapse collapse">
-
- <!-- Main navigation -->
- <ul class="nav navbar-nav">
-
-
- <li >
- <a href="../..">Doc Home</a>
- </li>
-
-
-
- <li class="dropdown active">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Getting Started <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li class="active">
- <a href="./">Newt Concepts</a>
-</li>
-
-
-
-<li >
- <a href="../project1/">Blinky, The First Project</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Getting Acclimated <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter2/vocabulary/">Understanding Newt Terms</a>
-</li>
-
-
-
-<li >
- <a href="../../chapter2/project2/">Project 2</a>
-</li>
-
-
-
-<li >
- <a href="../../chapter2/project3/">Project 3</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Newt tool Reference <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter3/newt_ops/">Command structure</a>
-</li>
-
-
-
-<li >
- <a href="../../chapter3/newt_tool_reference/">Command list</a>
-</li>
-
-
- </ul>
- </li>
-
-
- </ul>
-
-
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
- <i class="fa fa-search"></i> Search
- </a>
- </li>
-
- <li >
- <a rel="next" href="../..">
- <i class="fa fa-arrow-left"></i> Previous
- </a>
- </li>
- <li >
- <a rel="prev" href="../project1/">
- Next <i class="fa fa-arrow-right"></i>
- </a>
- </li>
-
-
- </ul>
- </div>
- </div>
-</div>
-
- <div class="container">
-
- <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
- <ul class="nav bs-sidenav">
-
- <li class="main active"><a href="#newt-concepts">Newt Concepts</a></li>
-
- <li><a href="#basic-components-in-the-ecosystem">Basic components in the ecosystem</a></li>
-
- <li><a href="#terminology">Terminology</a></li>
-
- <li><a href="#a-mynewt-contributor">A Mynewt contributor</a></li>
-
- <li><a href="#a-mynewt-user">A Mynewt user</a></li>
-
-
- </ul>
-</div></div>
- <div class="col-md-9" role="main">
-
-<h2 id="newt-concepts">Newt Concepts<a class="headerlink" href="#newt-concepts" title="Permanent link">¶</a></h2>
-<p>This page introduces the basic terms you will need to find your way around the Mynewt ecosystem.</p>
-<h3 id="basic-components-in-the-ecosystem">Basic components in the ecosystem<a class="headerlink" href="#basic-components-in-the-ecosystem" title="Permanent link">¶</a></h3>
-<ul>
-<li>
-<p>NewtOS is an open-source RTOS (Real Time Operating System) that works on a variety of hardware. The goal is to develop a pre-emptive, multitasking OS that is highly modular, making it possible to mix and match components to enable desired features and capabilities on multiple hardware architectures. Examples of components being worked on are the Core RTOS, a flash file system, utility functions, a variety of board support packages, packages of microcontrollers etc.</p>
-</li>
-<li>
-<p>Network protocol stacks such as Bluetooth Low Energy, and more</p>
-</li>
-<li>
-<p>Newt Tool helps you mix the specific packages for the combination of hardware and low-level embedded architecture features of the user's choice and generate the corresponding run-time image based on the NewtOS. It provides the infrastructure to manage and build for different CPU architectures, memory units, board support packages etc., allowing a user to formulate the contents according to the low-level features needed by his or her project.</p>
-</li>
-</ul>
-<h3 id="terminology">Terminology<a class="headerlink" href="#terminology" title="Permanent link">¶</a></h3>
-<p>A Mynewt user starts with a project in mind that defines the application or utility that he or she wants to implement on an embedded device. Making an LED blink on an electronics prototyping board is a common starter project. Enabling a BLE (Bluetooth Low Energy) peripheral mode on a development board is a more complex project. Specifying a project requires naming it, at the very least, and then adding the desired properties or attributes. In order to actualize a project, it needs to be applied to a target which is essentially a combination of some specified hardware and the execution environment. </p>
-<p>In the mynewt lifecycle, a project grows in a nest. A nest may house multiple projects. The nest is, therefore, a repository where various component packages for one or more projects reside. Each package is an egg (naturally!). However, in the world of Mynewt an egg may consist of other eggs! For example, the starter project Blinky is an egg consisting of several constituent eggs that enable core features. The egg form is suitable for elemental units of code as it explicitly exposes characteristics such as dependencies, versions, capabilities, requirements etc., thus making assembling appropriate components for a project and building an image for it easy to follow, modular, and robust.</p>
-<p>A nest can be given any name. For example, you will see a nest named "tadpole" in Mynewt (<a href="https://git-wip-us.apache.org/repos/asf?p=incubator-mynewt-tadpole.git">https://git-wip-us.apache.org/repos/asf?p=incubator-mynewt-tadpole.git</a>). It contains all the core libraries of the operating system for the native platform which currently supports compilation on Mac OS X. The core libraries are contained in the form of eggs where an egg is a basic unit of implementation of any aspect of the RTOS. The eggs are distributed in the following directory structure inside the nest:</p>
-<ul>
-<li>libs: contains the two eggs <code>os</code> and <code>testutil</code></li>
-<li>hw: contains three eggs - (i) <code>hal</code> which has the abstraction layer (HAL) API definitions that all BSP and MCU implementations must support, (ii) <code>/mcu/native</code> which in an MCU implementation for the native platform (a simulator, in this case), and (iii) <code>bsp/native</code> which is a BSP implementation for the native platform </li>
-<li>compiler: contains the <code>sim</code> egg which bundles the compiler specifications for the native platform.</li>
-</ul>
-<p>Let's explore this sample nest a bit further. The <code>libs/os</code> egg contains code for scheduler, process/thread/memory management, semaphores etc. It is the core RTOS which ports to all supported chip platforms.The <code>libs/testutil</code> egg contains code for testing packages on hardware or simulated environment. The <code>hw/hal</code> egg contains header files that provide abstraction for physical hardware components such as GPIO (general purpose input/output), network adapters, timers, and UARTs. This <code>hw/hal</code> egg is an MCU peripheral abstraction designed to make it easy to port to different MCUs (microcontrollers). The <code>hw/mcu/native</code> egg contains code for microcontroller operations on the native platform. The <code>hw/bsp/native</code> egg contains the board support package for the native platform. And finally, the sixth egg <code>sim</code> contains the compiler specifications such as path and flags. Currently the compilation is supported on
Mac OS X.</p>
-<p>You can see another nest in the mynewt ecosystem called the "larva". It was spawned from the skeletal "tadpole" nest using the newt tool. Spawning is easy - <code>$ newt create nest <your_nest_name></code>. "larva" is the developer's test repository containing all sorts of eggs being written and incubated, including ones to enhance the core operating system which should eventually make their way into the "tadpole" nest. There is a <code>hatch_tadpole</code> script to update the "tadpole" nest when the core OS related eggs in "larva" are ready.</p>
-<p>There is a third nest named "newt" that contains all the eggs needed to support the build and release process of mynewt software. In the future, there will also be pre-built nests for certain common hardware devices to enable a user to quickly get started with a project.</p>
-<h3 id="a-mynewt-contributor">A Mynewt contributor<a class="headerlink" href="#a-mynewt-contributor" title="Permanent link">¶</a></h3>
-<p>A contributor can choose to work on any area(s) of the Mynewt endeavor that appeals to him or her. Hence, you can work on one or more eggs or an entire nest. You can create your own nest (master) or create a branch in an existing nest. For now, Runtime contributors will review any new areas of support that you may wish to introduce e.g. a new board support package (BSP) or a new network protocol. </p>
-<p>A contributer role necessarily implies he or she is a Mynewt user (see below) of some or all of the products developed.</p>
-<h3 id="a-mynewt-user">A Mynewt user<a class="headerlink" href="#a-mynewt-user" title="Permanent link">¶</a></h3>
-<p>An application developer is interested only in using software available in this ecosystem to build a top level build artifact. He or she may either:</p>
-<ul>
-<li>Use a pre-built nest, or</li>
-<li>Spawn a new nest using the newt tool for a target where a target is a custom combination of supported hardware components</li>
-</ul>
-<p>In either case, the user would use the newt tool to create and set the target in the chosen nest. The newt tool would then be used to build out the target profile which would determine which eggs to choose. Finally, the user would use the newt tool to generate a run-time image that can be run on the device.</p></div>
-
- </div>
-
- <footer class="col-md-12">
- <hr>
-
- <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p>
- </footer>
-
- <script src="../../js/jquery-1.10.2.min.js"></script>
- <script src="../../js/bootstrap-3.0.3.min.js"></script>
- <script src="../../js/highlight.pack.js"></script>
- <script>var base_url = '../..';</script>
- <script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
- <script src="../../js/base.js"></script>
-
- <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
- <div class="modal-dialog">
- <div class="modal-content">
- <div class="modal-header">
- <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
- <h4 class="modal-title" id="exampleModalLabel">Search</h4>
- </div>
- <div class="modal-body">
- <p>
- From here you can search these documents. Enter
- your search terms below.
- </p>
- <form role="form">
- <div class="form-group">
- <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
- </div>
- </form>
- <div id="mkdocs-search-results"></div>
- </div>
- <div class="modal-footer">
- </div>
- </div>
- </div>
- </div>
-
- </body>
-</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d880edf/site/chapter1/pics/bottomview.png
----------------------------------------------------------------------
diff --git a/site/chapter1/pics/bottomview.png b/site/chapter1/pics/bottomview.png
deleted file mode 100644
index fb7bf0a..0000000
Binary files a/site/chapter1/pics/bottomview.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0d880edf/site/chapter1/pics/topview.png
----------------------------------------------------------------------
diff --git a/site/chapter1/pics/topview.png b/site/chapter1/pics/topview.png
deleted file mode 100644
index e57995e..0000000
Binary files a/site/chapter1/pics/topview.png and /dev/null differ