Updates to newt commands including target, mfg, complete
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/48437c63 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/48437c63 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/48437c63 Branch: refs/heads/asf-site Commit: 48437c63812f3e2296f38c4bf0e945dfcb32ea6e Parents: 361462f Author: aditihilbert <[email protected]> Authored: Mon Jan 2 13:23:53 2017 -0800 Committer: aditihilbert <[email protected]> Committed: Mon Jan 2 13:23:53 2017 -0800 ---------------------------------------------------------------------- develop/mkdocs/search_index.json | 77 ++- develop/newt/command_list/newt_build/index.html | 16 + develop/newt/command_list/newt_clean/index.html | 20 +- .../newt/command_list/newt_complete/index.html | 568 ++++++++++++++++ .../command_list/newt_create_image/index.html | 20 +- develop/newt/command_list/newt_debug/index.html | 16 + develop/newt/command_list/newt_help/index.html | 16 + develop/newt/command_list/newt_info/index.html | 16 + .../newt/command_list/newt_install/index.html | 16 + develop/newt/command_list/newt_load/index.html | 20 +- develop/newt/command_list/newt_mfg/index.html | 651 +++++++++++++++++++ develop/newt/command_list/newt_new/index.html | 20 +- develop/newt/command_list/newt_run/index.html | 16 + develop/newt/command_list/newt_size/index.html | 16 + .../newt/command_list/newt_target/index.html | 91 ++- develop/newt/command_list/newt_test/index.html | 16 + .../newt/command_list/newt_upgrade/index.html | 16 + .../newt/command_list/newt_version/index.html | 16 + develop/newt/newt_ops/index.html | 64 +- develop/sitemap.xml | 24 +- latest/mkdocs/search_index.json | 77 ++- latest/newt/command_list/newt_build/index.html | 16 + latest/newt/command_list/newt_clean/index.html | 20 +- .../newt/command_list/newt_complete/index.html | 568 ++++++++++++++++ .../command_list/newt_create_image/index.html | 20 +- latest/newt/command_list/newt_debug/index.html | 16 + latest/newt/command_list/newt_help/index.html | 16 + latest/newt/command_list/newt_info/index.html | 16 + .../newt/command_list/newt_install/index.html | 16 + latest/newt/command_list/newt_load/index.html | 20 +- latest/newt/command_list/newt_mfg/index.html | 651 +++++++++++++++++++ latest/newt/command_list/newt_new/index.html | 20 +- latest/newt/command_list/newt_run/index.html | 16 + latest/newt/command_list/newt_size/index.html | 16 + latest/newt/command_list/newt_target/index.html | 91 ++- latest/newt/command_list/newt_test/index.html | 16 + .../newt/command_list/newt_upgrade/index.html | 16 + .../newt/command_list/newt_version/index.html | 16 + latest/newt/newt_ops/index.html | 64 +- latest/sitemap.xml | 24 +- sitemap.xml | 26 +- v0_9_0/sitemap.xml | 26 +- 42 files changed, 3298 insertions(+), 184 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/mkdocs/search_index.json ---------------------------------------------------------------------- diff --git a/develop/mkdocs/search_index.json b/develop/mkdocs/search_index.json index a55d558..53c0f4e 100644 --- a/develop/mkdocs/search_index.json +++ b/develop/mkdocs/search_index.json @@ -10022,12 +10022,12 @@ }, { "location": "/newt/newt_ops/", - "text": "Command Structure\n\n\nJust like verbs are actions in a sentence and adverdbs modifiy verbs, so in \nnewt\n tool, commands are actions and flags modify actions. A command can have subcommands, too. Arguments to commands and subcommands, with appropriate flags, will dictate the execution and result of a command. \n\n\nFor instance, in the example below, the \nnewt\n command has the subcommand \ntarget set\n in which the argument 'my_target1' is the target whose attribute, \narch\n, is set to 'cortex_md.' \n\n\n newt target set my_target1 arch=cortex_m4\n\n\n\n\n\nGlobal flags work uniformly across \nnewt\n commands. Consider the flag \n-v, --verbose,\n It works both for command and subcommands, to generate verbose output. Likewise, the help flag \n-h\n or \n--help,\n to print helpful messsages.\n\n\nA command may additionally take flags specific to it. For example, the \n-b\n flag instructs \nnewt pkg install\n to install the pkg from a git \nbranch.\n\n\n newt pkg install -b \nbranchname\n \neggname\n\n\n\n\n\n\nIn addition to the \nNewt Tool Manual\n in docs, command-line help is available for each command (and subcommand), through the \n-h\n or \n--help\n options. \n\n\n $ newt target export --help\n Export build targets from the current nest, and print them to \n standard output. If the -a (or -export-all) option is specified, \n then all targets will be exported. Otherwise, \ntarget-name\n \n must be specified, and only that target will be exported.\n\n Usage: \n newt target export [flags]\n\n Examples:\n newt target export [-a -export-all] [\ntarget-name\n]\n newt target export -a \n my_exports.txt\n newt target export my_target \n my_target_export.txt\n\n Flags:\n -a, --export-all=false: If present, export all targets\n -h, --help=false: help for export\n\n Global Flags:\n -l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n -q, --quiet=false: Be quiet; onl y display error output.\n -s, --silent=false: Be silent; don\nt output anything.\n -v, --verbose=false: Enable verbose output when executing commands.", + "text": "Command Structure\n\n\nJust like verbs are actions in a sentence and adverdbs modifiy verbs, so in \nnewt\n tool, commands are actions and flags modify actions. A command can have subcommands, too. Arguments to commands and subcommands, with appropriate flags, will dictate the execution and result of a command. \n\n\nFor instance, in the example below, the \nnewt\n command has the subcommand \ntarget set\n in which the argument 'my_target1' is the target whose attribute, \narch\n, is set to 'cortex_md.' \n\n\n newt target set my_target1 arch=cortex_m4\n\n\n\n\n\nGlobal flags work uniformly across \nnewt\n commands. Consider the flag \n-v, --verbose,\n It works both for command and subcommands, to generate verbose output. Likewise, the help flag \n-h\n or \n--help,\n to print helpful messsages.\n\n\nA command may additionally take flags specific to it. For example, the \n-n\n flag instructs \nnewt debug\n not to start GDB from command line.\n\n\n newt deb ug \ntarget-name\n -n\n\n\n\n\n\nIn addition to the \nNewt Tool Manual\n in docs, command-line help is available for each command (and subcommand), through the \n-h\n or \n--help\n options. \n\n\n newt target --help\n Command for manipulating targets\n\n Usage:\n newt target [flags]\n newt target [command]\n\n Available Commands:\n config View target system configuration\n copy Copy target\n create Create a target\n delete Delete target\n dep View target\ns dependency graph\n revdep View target\ns reverse-dependency graph\n set Set target configuration variable\n show View target configuration variables\n\n Global Flags:\n -l, --loglevel string Log level (default \nWARN\n)\n -o, --outfile string Filename to tee output to\n -q, --quiet Be quiet; only display error output\n -s, --silent Be silent; don\nt output anything\n -v, --verbose Enable verbose output when executing commands\n\n Use \nnewt target [command] --help\n for more information about a command.", "title": "toc" }, { "location": "/newt/newt_ops/#command-structure", - "text": "Just like verbs are actions in a sentence and adverdbs modifiy verbs, so in newt tool, commands are actions and flags modify actions. A command can have subcommands, too. Arguments to commands and subcommands, with appropriate flags, will dictate the execution and result of a command. For instance, in the example below, the newt command has the subcommand target set in which the argument 'my_target1' is the target whose attribute, arch , is set to 'cortex_md.' newt target set my_target1 arch=cortex_m4 Global flags work uniformly across newt commands. Consider the flag -v, --verbose, It works both for command and subcommands, to generate verbose output. Likewise, the help flag -h or --help, to print helpful messsages. A command may additionally take flags specific to it. For example, the -b flag instructs newt pkg install to install the pkg from a git branch. newt pkg install -b branchname eggname In addition to the Newt Tool Manual in docs, command-line help is available for each command (and subcommand), through the -h or --help options. $ newt target export --help\n Export build targets from the current nest, and print them to \n standard output. If the -a (or -export-all) option is specified, \n then all targets will be exported. Otherwise, target-name \n must be specified, and only that target will be exported.\n\n Usage: \n newt target export [flags]\n\n Examples:\n newt target export [-a -export-all] [ target-name ]\n newt target export -a my_exports.txt\n newt target export my_target my_target_export.txt\n\n Flags:\n -a, --export-all=false: If present, export all targets\n -h, --help=false: help for export\n\n Global Flags:\n -l, --loglevel= WARN : Log level, defaults to WARN.\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don t output anything.\n -v, --verb ose=false: Enable verbose output when executing commands.", + "text": "Just like verbs are actions in a sentence and adverdbs modifiy verbs, so in newt tool, commands are actions and flags modify actions. A command can have subcommands, too. Arguments to commands and subcommands, with appropriate flags, will dictate the execution and result of a command. For instance, in the example below, the newt command has the subcommand target set in which the argument 'my_target1' is the target whose attribute, arch , is set to 'cortex_md.' newt target set my_target1 arch=cortex_m4 Global flags work uniformly across newt commands. Consider the flag -v, --verbose, It works both for command and subcommands, to generate verbose output. Likewise, the help flag -h or --help, to print helpful messsages. A command may additionally take flags specific to it. For example, the -n flag instructs newt debug not to start GDB from command line. newt debug target-name -n In addition to the Newt Tool Manual in docs, c ommand-line help is available for each command (and subcommand), through the -h or --help options. newt target --help\n Command for manipulating targets\n\n Usage:\n newt target [flags]\n newt target [command]\n\n Available Commands:\n config View target system configuration\n copy Copy target\n create Create a target\n delete Delete target\n dep View target s dependency graph\n revdep View target s reverse-dependency graph\n set Set target configuration variable\n show View target configuration variables\n\n Global Flags:\n -l, --loglevel string Log level (default WARN )\n -o, --outfile string Filename to tee output to\n -q, --quiet Be quiet; only display error output\n -s, --silent Be silent; don t output anything\n -v, --verbose Enable verbose output when executing commands\n\n Use newt targe t [command] --help for more information about a command.", "title": "Command Structure" }, { @@ -10096,6 +10096,31 @@ "title": "Examples" }, { + "location": "/newt/command_list/newt_complete/", + "text": "newt complete \n\n\nPerforms bash autocompletion using tab. It is not intended to be called directly from the command line.\n\n\nInstall bash autocompletion\n\n\n $ brew install bash-completion\n Updating Homebrew...\n \nsnip\n\n Bash completion has been installed to:\n /usr/local/etc/bash_completion.d\n ==\n Summary\n \ud83c\udf7a /usr/local/Cellar/bash-completion/1.3_1: 189 files, 607.8K\n\n\n\n\n\nEnable autocompletion for newt\n\n\n $ complete -C \nnewt complete\n newt\n\n\n\n\n\nUsage\n\n\nHit tab and see possible completion options or completed command.\n\n\n $ newt target s\n set show \n $ newt target show", + "title": "newt complete" + }, + { + "location": "/newt/command_list/newt_complete/#newt-complete", + "text": "Performs bash autocompletion using tab. It is not intended to be called directly from the command line.", + "title": "newt complete " + }, + { + "location": "/newt/command_list/newt_complete/#install-bash-autocompletion", + "text": "$ brew install bash-completion\n Updating Homebrew...\n snip \n Bash completion has been installed to:\n /usr/local/etc/bash_completion.d\n == Summary\n \ud83c\udf7a /usr/local/Cellar/bash-completion/1.3_1: 189 files, 607.8K", + "title": "Install bash autocompletion" + }, + { + "location": "/newt/command_list/newt_complete/#enable-autocompletion-for-newt", + "text": "$ complete -C newt complete newt", + "title": "Enable autocompletion for newt" + }, + { + "location": "/newt/command_list/newt_complete/#usage", + "text": "Hit tab and see possible completion options or completed command. $ newt target s\n set show \n $ newt target show", + "title": "Usage" + }, + { "location": "/newt/command_list/newt_create_image/", "text": "newt create-image \n\n\nCreates a signed image by adding image header to created binary file for specified target. Version number in the header is set to be \n \n\n\nUsage:\n\n\n newt create-image \ntarget-name\n \nversion\n [flags]\n\n\n\n\n\nFlags:\n\n\n -h, --help=false: help for target\n\n\n\n\n\nGlobal Flags:\n\n\n -l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n -o, --outfile string Filename to tee log output to\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don\nt output anything.\n -v, --verbose=false: Enable verbose output when executing commands.\n\n\n\n\n\nDescription\n\n\n\n\n\n\n\n\nSub-command\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\ncreate-image\n\n\nSigns and adds image header to the created binary file for target named \ntarget-name\n and given the version specified as \nversion\n. The application image generated is \napp-name\n.img\n where the app-name is the same as the ap p specified in the target definition. The generated application image can be found in \n/bin/\ntarget-name\n/apps/\napp-name\n/\n. \n \n A build manifest file \nmanifest.json\n is also generated in the same directory. This build manifest contains information such as build time, version, image name, a hash to identify the image, packages actually used to create the build, and the target for which the image is built.\n\n\n\n\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\ncreate-image\n\n\nnewt create-image myble2 1.0.1.0\n\n\nCreates a signed image for target \nmyble2\n and assigns it the version \n1.0.1.0\n. \n \n If the target is as follows: \n targets/myble2 \n app=@apache-mynewt-core/apps/bletiny \n bsp=@apache-mynewt-core/hw/bsp/nrf52pdk \n build_profile=optimized \n cflags=-DSTATS_NAME_ENABLE \n \n then, the created image is \nbin/myble2/apps/bletiny/bletiny.img\n and the manifest is \nbin/myble2/apps/bletiny/manifest.json", "title": "newt create-image" @@ -10281,6 +10306,46 @@ "title": "Description" }, { + "location": "/newt/command_list/newt_mfg/", + "text": "newt mfg \n\n\nProvides commands to create, build, and upload manufacturing image. \n\n\nUsage:\n\n\n newt mfg [flags]\n newt mfg [command]\n\n\n\n\n\nAvailable Commands:\n\n\n create Create a manufacturing flash image\n deploy Builds and uploads a manufacturing image (build + load)\n load Load a manufacturing flash image onto a device\n\n\n\n\n\nFlags:\n\n\n -h, --help=false: help for mfg\n\n\n\n\n\nGlobal Flags:\n\n\n -l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n -o, --outfile string Filename to tee log output to\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don\nt output anything.\n -v, --verbose=false: Enable verbose output when executing commands.\n\n\n\n\n\nDescription\n\n\n\n\n\n\n\n\nSub-command\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\ncreate\n\n\nA manufacturing image specifies 1) a boot loader target, and 2) one or more image targets. Assuming the m anufacturing entity has been created and defined in the \nmfgs/\nmfg image name\n/\n package(see Examples below), this command collects the manufacturing related files in the newly created \nbin/mfgs/\nmfg image name\n directory. The collection includes manifests with the image build time, version, manufacturing package build time, image ID (or hash) etc. It is essentially a snapshot of the image data and metadata uploaded to the device flash at manufacturing time. Note that the command expects the targets and images to have already been built using \nnewt build\n and \nnewt create-image\n commands.\n\n\n\n\n\n\ndeploy\n\n\nA combination of build and load commands to put together and upload manufacturing image on to the device.\n\n\n\n\n\n\nload\n\n\nLoads the manufacturing package onto to the flash of the connected device.\n\n\n\n\n\n\n\n\nExamples\n\n\nSuppose you have created two targets (one for the bootloader and one for the \nblinky\n app). \n\n\n$ newt target show\ntargets/my _blinky_sim\n app=apps/blinky\n bsp=@apache-mynewt-core/hw/bsp/native\n build_profile=debug\ntargets/rb_blinky\n app=apps/blinky\n bsp=@apache-mynewt-core/hw/bsp/rb-nano2\n build_profile=debug\ntargets/rb_boot\n app=@apache-mynewt-core/apps/boot\n bsp=@apache-mynewt-core/hw/bsp/rb-nano2\n build_profile=optimized\n\n\n\n\n\nBuild the bootloader and app images.\n\n\n$ newt build rb_boot\n$ newt build rb_boot\n$ newt create-image rb_blinky 0.0.1\n\n\n\n\n\nCreate the directory and package to hold the manufacturing images.\n\n\n$ mkdir -p mfgs/rb_blinky_rsa\n\n\n\n\n\nThe \nrb_blinky_rsa\n package needs a pkg.yml file. In addition it is needs a mfg.yml file where the two constituent targets are defined. An example of each file is shown below.\n\n\n$ more mfgs/rb_blinky_rsa/pkg.yml \npkg.name: \nmfgs/rb_blinky_rsa\n\npkg.type: \nmfg\n\npkg.description: \npkg.author: \npkg.homepage: \n\n\n\n\n\n$ more mfgs/rb_blinky_rsa/mfg.yml \nmfg.bootloader: \ntargets/rb_b oot\n\nmfg.images:\n - \ntargets/rb_blinky\n\n\n\n\n\n\nRun the \nnewt mfg create\n command to collect all the manufacturing snapshot files.\n\n\n$ newt mfg create rb_blinky_rsa\nCreating a manufacturing image from the following files:\n\nsnip\n\nGenerated the following files:\n\nsnip\n\n$", + "title": "newt mfg" + }, + { + "location": "/newt/command_list/newt_mfg/#newt-mfg", + "text": "Provides commands to create, build, and upload manufacturing image.", + "title": "newt mfg " + }, + { + "location": "/newt/command_list/newt_mfg/#usage", + "text": "newt mfg [flags]\n newt mfg [command]", + "title": "Usage:" + }, + { + "location": "/newt/command_list/newt_mfg/#available-commands", + "text": "create Create a manufacturing flash image\n deploy Builds and uploads a manufacturing image (build + load)\n load Load a manufacturing flash image onto a device", + "title": "Available Commands:" + }, + { + "location": "/newt/command_list/newt_mfg/#flags", + "text": "-h, --help=false: help for mfg", + "title": "Flags:" + }, + { + "location": "/newt/command_list/newt_mfg/#global-flags", + "text": "-l, --loglevel= WARN : Log level, defaults to WARN.\n -o, --outfile string Filename to tee log output to\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don t output anything.\n -v, --verbose=false: Enable verbose output when executing commands.", + "title": "Global Flags:" + }, + { + "location": "/newt/command_list/newt_mfg/#description", + "text": "Sub-command Explanation create A manufacturing image specifies 1) a boot loader target, and 2) one or more image targets. Assuming the manufacturing entity has been created and defined in the mfgs/ mfg image name / package(see Examples below), this command collects the manufacturing related files in the newly created bin/mfgs/ mfg image name directory. The collection includes manifests with the image build time, version, manufacturing package build time, image ID (or hash) etc. It is essentially a snapshot of the image data and metadata uploaded to the device flash at manufacturing time. Note that the command expects the targets and images to have already been built using newt build and newt create-image commands. deploy A combination of build and load commands to put together and upload manufacturing image on to the device. load Loads the manufacturing package onto to the flash of the connected device.", + "title": "Description" + }, + { + "location": "/newt/command_list/newt_mfg/#examples", + "text": "Suppose you have created two targets (one for the bootloader and one for the blinky app). $ newt target show\ntargets/my_blinky_sim\n app=apps/blinky\n bsp=@apache-mynewt-core/hw/bsp/native\n build_profile=debug\ntargets/rb_blinky\n app=apps/blinky\n bsp=@apache-mynewt-core/hw/bsp/rb-nano2\n build_profile=debug\ntargets/rb_boot\n app=@apache-mynewt-core/apps/boot\n bsp=@apache-mynewt-core/hw/bsp/rb-nano2\n build_profile=optimized Build the bootloader and app images. $ newt build rb_boot\n$ newt build rb_boot\n$ newt create-image rb_blinky 0.0.1 Create the directory and package to hold the manufacturing images. $ mkdir -p mfgs/rb_blinky_rsa The rb_blinky_rsa package needs a pkg.yml file. In addition it is needs a mfg.yml file where the two constituent targets are defined. An example of each file is shown below. $ more mfgs/rb_blinky_rsa/pkg.yml \npkg.name: mfgs/rb_blinky_rsa \npkg.type: mfg \npkg.description: \npkg.author : \npkg.homepage: $ more mfgs/rb_blinky_rsa/mfg.yml \nmfg.bootloader: targets/rb_boot \nmfg.images:\n - targets/rb_blinky Run the newt mfg create command to collect all the manufacturing snapshot files. $ newt mfg create rb_blinky_rsa\nCreating a manufacturing image from the following files: snip \nGenerated the following files: snip \n$", + "title": "Examples" + }, + { "location": "/newt/command_list/newt_new/", "text": "newt new \n\n\nCreate a new application, specified by \n, from a given skeleton. Currently, the default skeleton is the \nblinky repository\n in Apache Mynewt (or \nhttps://github.com/apache/incubator-mynewt-blinky\n on its github mirror.)\n\n\nUsage:\n\n\n newt new [flags] \napp-name\n\n\n\n\n\n\nFlags:\n\n\n -h, --help=false: help for new\n\n\n\n\n\nGlobal Flags:\n\n\n -h, --help=false: help for newt\n -o, --outfile string Filename to tee output to\n -l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don\nt output anything.\n -v, --verbose=false: Enable verbose output when executing commands.\n\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nnewt new\n\n\nnewt new test_project\n\n\nCreates a new app named \"test_project \" using the default skeleton from the \napache/incubator-mynewt-blinky\n r epo.", "title": "newt new" @@ -10382,7 +10447,7 @@ }, { "location": "/newt/command_list/newt_target/", - "text": "newt target \n\n\nProvides commands to create, build, delete, and query targets. \n\n\nUsage:\n\n\n newt target [command] input1 [input2]\n\n\n\n\n\nAvailable Commands:\n\n\n show View target configuration variables\n set Set target configuration variable\n create Create a target\n delete Delete target\n copy Copy target\n vars Show variable names possible for a target\n\n\n\n\n\nFlags:\n\n\n -h, --help=false: help for target\n\n\n\n\n\nGlobal Flags:\n\n\n -l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n -o, --outfile string Filename to tee log output to\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don\nt output anything.\n -v, --verbose=false: Enable verbose output when executing commands.\n\n\n\n\n\nDescription\n\n\n\n\n\n\n\n\nSub-command\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nshow\n\n\nShows what variables (attributes) are set on the specified target \ninput1\n. If no \ninput1\n is specified then show the configuration for all the targets defined so far.\n\n\n\n\n\n\nset\n\n\nSet variables (attributes) of the target named via \ninput1\n. Currently the list of possible attributes (variables) are:\napp\n, \nbsp\n, \nbuild_profile\n, \nfeatures\n, \ncflags\n, \nlflags\n. For a simulated target, e.g. for software testing purposes, \nbsp\n is set to \n@apache-mynewt-core/hw/bsp/native\n.\n\n\n\n\n\n\n\n\nTo display all the existing values for a target variable (attribute), you can simply hit return after that variable. For example, \nnewt target set input1 app\n displays the valid values available for the variable \napp\n for a target named \ninput11\n.\n\n\n\n\n\n\n\n\nCurrently, the only two values available for \nbuild_profile\n are \noptimized\n and \ndebug\n.\n\n\n\n\n\n\ncreate\n\n\nCreates an empty target definition by the name of \ninput1\n.\n\n\n\n\n\n\ndelete\n\n\nDeletes 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\nnewt target clean \ntarget-name\n \nbefore\n deleting the target!\n\n\n\n\n\n\ncopy\n\n\nCreates a new target by the name of \ninput2\n by cloning the definition of an existing target named \ninput1\n.\n\n\n\n\n\n\nvars\n\n\nShows what variables (attributes) are available to set on the target\n\n\n\n\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nshow\n\n\nnewt target show myble\n\n\nShows all variable settings for the target named \"myble\" i.e. what app, bsp, build_profile, features, cflags are set to. Note that all variables are not required to be set in order to successfully define a target.\n\n\n\n\n\n\nshow\n\n\nnewt target show\n\n\nShows all variable settings for all the targets defined.\n\n\n\n\n\n\nset\n\n\nnewt target set myble app=@apache-mynewt-core/apps/bletiny\n\n\nAssign \nblet iny\n to be the application to be included in the build for the target named \nmyble\n.\n\n\n\n\n\n\ncopy\n\n\nnewt target copy my_blinky_sim test1\n\n\nCreates a new target by the name \ntest1\n by copying the attributes from \nmy_blinky_sim\n\n\n\n\n\n\nvars\n\n\nnewt target vars\n\n\nShows all the variables newt recognizes - app, bsp, build_profile, features", + "text": "newt target \n\n\nProvides commands to create, build, delete, and query targets. \n\n\nUsage:\n\n\n newt target [command] input1 [input2]\n\n\n\n\n\nAvailable Commands:\n\n\n config View target system configuration\n copy Copy target\n create Create a target\n delete Delete target\n dep View target\ns dependency graph\n revdep View target\ns reverse-dependency graph\n set Set target configuration variable\n show View target configuration variables\n\n\n\n\n\nFlags:\n\n\n -h, --help=false: help for target\n\n\n\n\n\nGlobal Flags:\n\n\n -l, --loglevel=\nWARN\n: Log level, defaults to WARN.\n -o, --outfile string Filename to tee log output to\n -q, --quiet=false: Be quiet; only display error output.\n -s, --silent=false: Be silent; don\nt output anything.\n -v, --verbose=false: Enable verbose output when executing commands.\n\n\n\n\n\nDescription\n\n\n\n\n\n\n\n\nSub-c ommand\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nconfig\n\n\nDisplays the specified target's system configuration. The configuration for any package is listed in its \nsyscfg.yml\n file. A target build consists of several packages. The command lists the settings for the config variables from all the included packages. If the default values have not been changed then the default values will be seen.\n\n\n\n\n\n\ncopy\n\n\nSet variables (attributes) of the target named via \ninput1\n. Currently the list of possible attributes (variables) are:\napp\n, \nbsp\n, \nbuild_profile\n, \ncflags\n, \nlflags\n. For a simulated target, e.g. for software testing purposes, \nbsp\n is set to \n@apache-mynewt-core/hw/bsp/native\n.\n\n\n\n\n\n\ncreate\n\n\nCreates an empty target definition by the name of \ninput1\n.\n\n\n\n\n\n\ndelete\n\n\nDeletes 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 ex ecutables use\nnewt clean \ntarget-name\n \nbefore\n deleting the target!\n\n\n\n\n\n\ndep\n\n\nCreates dependency tree for packages in the code for a target. Display shows each package followed by the list of libraries or packages that it depends on.\n\n\n\n\n\n\nrevdep\n\n\nCreates the reverse dependency tree for packages in the code for a target. Display shows each package followed by the list of libraries or packages that depend on it.\n\n\n\n\n\n\nset\n\n\nSet variables (attributes) of the target named via \ninput1\n. Currently the list of possible attributes (variables) are:\napp\n, \nbsp\n, \nbuild_profile\n, \nfeatures\n, \ncflags\n, \nlflags\n. For a simulated target, e.g. for software testing purposes, \nbsp\n is set to \n@apache-mynewt-core/hw/bsp/native\n.\n\n\n\n\n\n\n\n\nTo display all the existing values for a target variable (attribute), you can issue a \nnewt vals \nvariable-name\n command. For example, \nnewt vals app\n displays the valid values available for the v ariable \napp\n for any target.\n\n\n\n\n\n\n\n\nCurrently, the only two values available for \nbuild_profile\n are \noptimized\n and \ndebug\n.\n\n\n\n\n\n\nshow\n\n\nShows what variables (attributes) are set on the specified target \ninput1\n. If no \ninput1\n is specified then show the configuration for all the targets defined so far.\n\n\n\n\n\n\n\n\nExamples\n\n\n\n\n\n\n\n\nSub-command\n\n\nUsage\n\n\nExplanation\n\n\n\n\n\n\n\n\n\n\nconfig\n\n\nnewt target config rb_blinky\n\n\nShows all the system configuration settings for all the packages in the target named \nrb_blinky\n.\n\n\n\n\n\n\ncopy\n\n\nnewt target copy rb_blinky rb_bletiny\n\n\nClones the target settings in \nrb_blinky\n to the destination target \nrb_bletiny\n\n\n\n\n\n\ncreate\n\n\nnewt target create target1\n\n\nCreates an empty target by the name \ntarget1\n\n\n\n\n\n\nshow\n\n\nnewt target show myble\n\n\nShows all variable settings for the target named \"myble\" i.e. what app, bsp, build_profile, features, cflags are set to. Note that all variables are not required to be set in order to successfully define a target.\n\n\n\n\n\n\nshow\n\n\nnewt target show\n\n\nShows all variable settings for all the targets defined.\n\n\n\n\n\n\nset\n\n\nnewt target set myble app=@apache-mynewt-core/apps/bletiny\n\n\nAssign \nbletiny\n to be the application to be included in the build for the target named \nmyble\n.", "title": "newt target" }, { @@ -10397,7 +10462,7 @@ }, { "location": "/newt/command_list/newt_target/#available-commands", - "text": "show View target configuration variables\n set Set target configuration variable\n create Create a target\n delete Delete target\n copy Copy target\n vars Show variable names possible for a target", + "text": "config View target system configuration\n copy Copy target\n create Create a target\n delete Delete target\n dep View target s dependency graph\n revdep View target s reverse-dependency graph\n set Set target configuration variable\n show View target configuration variables", "title": "Available Commands:" }, { @@ -10412,12 +10477,12 @@ }, { "location": "/newt/command_list/newt_target/#description", - "text": "Sub-command Explanation show Shows what variables (attributes) are set on the specified target input1 . If no input1 is specified then show the configuration for all the targets defined so far. set Set variables (attributes) of the target named via input1 . Currently the list of possible attributes (variables) are: app , bsp , build_profile , features , cflags , lflags . For a simulated target, e.g. for software testing purposes, bsp is set to @apache-mynewt-core/hw/bsp/native . To display all the existing values for a target variable (attribute), you can simply hit return after that variable. For example, newt target set input1 app displays the valid values available for the variable app for a target named input11 . Currently, the only two values available for build_profile are optimized and debug . create Creates an empty target definition by the name of input1 . delete Deletes only the description for the targ et. Does not delete the target directory with associated binaries. If you want to clean out the binaries, list files, and executables use newt target clean target-name before deleting the target! copy Creates a new target by the name of input2 by cloning the definition of an existing target named input1 . vars Shows what variables (attributes) are available to set on the target", + "text": "Sub-command Explanation config Displays the specified target's system configuration. The configuration for any package is listed in its syscfg.yml file. A target build consists of several packages. The command lists the settings for the config variables from all the included packages. If the default values have not been changed then the default values will be seen. copy Set variables (attributes) of the target named via input1 . Currently the list of possible attributes (variables) are: app , bsp , build_profile , cflags , lflags . For a simulated target, e.g. for software testing purposes, bsp is set to @apache-mynewt-core/hw/bsp/native . create Creates an empty target definition by the name of input1 . 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 clean target-name before deleting the target! dep Creates dependency tree for packages in the code for a target. Display shows each package followed by the list of libraries or packages that it depends on. revdep Creates the reverse dependency tree for packages in the code for a target. Display shows each package followed by the list of libraries or packages that depend on it. set Set variables (attributes) of the target named via input1 . Currently the list of possible attributes (variables) are: app , bsp , build_profile , features , cflags , lflags . For a simulated target, e.g. for software testing purposes, bsp is set to @apache-mynewt-core/hw/bsp/native . To display all the existing values for a target variable (attribute), you can issue a newt vals variable-name command. For example, newt vals app displays the valid values available for the variable app for any target. Currently, the only two values available for build_profile are optimized and debug . show Shows what variables (attributes) are set on the specified target input1 . If no input1 is specified then show the configuration for all the targets defined so far.", "title": "Description" }, { "location": "/newt/command_list/newt_target/#examples", - "text": "Sub-command Usage Explanation show newt target show myble Shows all variable settings for the target named \"myble\" i.e. what app, bsp, build_profile, features, cflags are set to. Note that all variables are not required to be set in order to successfully define a target. show newt target show Shows all variable settings for all the targets defined. set newt target set myble app=@apache-mynewt-core/apps/bletiny Assign bletiny to be the application to be included in the build for the target named myble . copy newt target copy my_blinky_sim test1 Creates a new target by the name test1 by copying the attributes from my_blinky_sim vars newt target vars Shows all the variables newt recognizes - app, bsp, build_profile, features", + "text": "Sub-command Usage Explanation config newt target config rb_blinky Shows all the system configuration settings for all the packages in the target named rb_blinky . copy newt target copy rb_blinky rb_bletiny Clones the target settings in rb_blinky to the destination target rb_bletiny create newt target create target1 Creates an empty target by the name target1 show newt target show myble Shows all variable settings for the target named \"myble\" i.e. what app, bsp, build_profile, features, cflags are set to. Note that all variables are not required to be set in order to successfully define a target. show newt target show Shows all variable settings for all the targets defined. set newt target set myble app=@apache-mynewt-core/apps/bletiny Assign bletiny to be the application to be included in the build for the target named myble .", "title": "Examples" }, { http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_build/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_build/index.html b/develop/newt/command_list/newt_build/index.html index ca2b95e..e5df214 100644 --- a/develop/newt/command_list/newt_build/index.html +++ b/develop/newt/command_list/newt_build/index.html @@ -301,6 +301,14 @@ <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + + <li > <a href="../newt_create_image/">newt create-image</a> </li> @@ -349,6 +357,14 @@ <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + + <li > <a href="../newt_new/">newt new</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_clean/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_clean/index.html b/develop/newt/command_list/newt_clean/index.html index f904320..3bd357d 100644 --- a/develop/newt/command_list/newt_clean/index.html +++ b/develop/newt/command_list/newt_clean/index.html @@ -301,6 +301,14 @@ <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + + <li > <a href="../newt_create_image/">newt create-image</a> </li> @@ -349,6 +357,14 @@ <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + + <li > <a href="../newt_new/">newt new</a> </li> @@ -541,8 +557,8 @@ </li> <li class="pull-right"> - <a href=../newt_create_image/> - Next: newt create-image + <a href=../newt_complete/> + Next: newt complete <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_complete/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_complete/index.html b/develop/newt/command_list/newt_complete/index.html new file mode 100644 index 0000000..c419791 --- /dev/null +++ b/develop/newt/command_list/newt_complete/index.html @@ -0,0 +1,568 @@ +<!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"> + + + <!-- This is broken by doc revisioning. + <link rel="canonical" href="http://mynewt.apache.org/newt/command_list/newt_complete/";> --> + <link rel="shortcut icon" href="../../../img/favicon.ico"> + + <title>newt complete - Apache Mynewt</title> + + <link href="../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link rel="stylesheet" href="../../../css/highlight.css"> + <link href="../../../css/base.css" rel="stylesheet"> + <link href="../../../css/custom.css" rel="stylesheet"> + <link href="../../../css/v2.css" rel="stylesheet"> + <link href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> + <link href="../../../extra.css" rel="stylesheet"> + + <!-- 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]--> + + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-72162311-1', 'auto'); + ga('send', 'pageview'); + </script> + + </head> + + + <body class="newt complete"> + + + <div class="container"> + <div class="row v2-main-banner"> + <a class="logo-cell" href="/"> + <img class="logo" src="/img/logo.png"> + </a> + <div class="tagline-cell"> + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + <div class="news-cell"> + <div class="well"> + <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.0.0-b1</a> released (Dec 13, 2016) + </div> + </div> + </div> +</div> + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" 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> + + </div> + + <!-- Expanded navigation --> + <div class="navbar-collapse collapse"> + <!-- Main navigation --> + <ul class="nav navbar-nav navbar-right"> + <li + class="" +> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">Documentation</a> + </li> + <li + class="" +> + <a href="/download/">Download</a> + </li> + <li + class="" +> + <a href="/community/">Community</a> + </li> + <li + class="" +> + <a href="/events/">Events</a> + </li> + </ul> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search documentation" /> + </div> + </form> + </div> + </div> + <ul class="toc-nav"> + <li class="doc-version"> +<select class="form-control" onchange="if (this.value) window.location.href=this.value"> + + <option + value="/develop/os/introduction" + selected="selected" + > + Version: develop (latest) + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 + </option> + +</select> +</li> + + + + + + + + + + + + + + + + + + + + + + <li ><a href="../../../os/introduction/">Mynewt Documentation</a> + + + <ul> + + + + + + + + <li ><a href="../../../os/get_started/get_started/">Basic Setup</a> + + + </li> + + + + + + <li > + <a href="../../../os/get_started/vocabulary/">Concepts</a> + </li> + + + + + + + + <li ><a href="../../../os/tutorials/tutorials/">Tutorials</a> + + + </li> + + + + + + + + <li ><a href="../../../os/os_user_guide/">OS User Guide</a> + + + </li> + + + + + + + + <li><a href=" + ../../../network/ble/ble_intro/ +">BLE User Guide</a> + + + </li> + + + + + + + + <li ><a href="../../newt_intro/">Newt Tool Guide</a> + + + <ul> + + + + + + <li > + <a href="../../newt_operation/">Newt Theory of Ops</a> + </li> + + + + + + + + <li ><a href="../../newt_ops/">Command Guide</a> + + + <ul> + + + + + + <li > + <a href="../newt_build/">newt build</a> + </li> + + + + + + <li > + <a href="../newt_clean/">newt clean</a> + </li> + + + + + + <li class="active"> + <a href="./">newt complete</a> + </li> + + + + + + <li > + <a href="../newt_create_image/">newt create-image</a> + </li> + + + + + + <li > + <a href="../newt_debug/">newt debug</a> + </li> + + + + + + <li > + <a href="../newt_help/">newt help</a> + </li> + + + + + + <li > + <a href="../newt_info/">newt info</a> + </li> + + + + + + <li > + <a href="../newt_install/">newt install</a> + </li> + + + + + + <li > + <a href="../newt_load/">newt load</a> + </li> + + + + + + <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + + <li > + <a href="../newt_new/">newt new</a> + </li> + + + + + + <li > + <a href="../newt_run/">newt run</a> + </li> + + + + + + <li > + <a href="../newt_size/">newt size</a> + </li> + + + + + + <li > + <a href="../newt_target/">newt target</a> + </li> + + + + + + <li > + <a href="../newt_test/">newt test</a> + </li> + + + + + + <li > + <a href="../newt_upgrade/">newt upgrade</a> + </li> + + + + + + <li > + <a href="../newt_version/">newt version</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../newtmgr/overview/">Newt Manager Guide</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="col-md-9" role="main"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../newt_intro/">Newt Tool Guide</a></li> + + + + <li>» <a href="../../newt_ops/">Command Guide</a></li> + + + + <li>» newt complete</li> + + + + </ul> +</div> + </div> + + <h2 id="newt-complete"><font color="#F2853F" style="font-size:24pt">newt complete </font></h2> +<p>Performs bash autocompletion using tab. It is not intended to be called directly from the command line.</p> +<h4 id="install-bash-autocompletion">Install bash autocompletion</h4> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> $ brew install bash-completion + Updating Homebrew... + <snip> + Bash completion has been installed to: + /usr/local/etc/bash_completion.d + ==> Summary + ðº /usr/local/Cellar/bash-completion/1.3_1: 189 files, 607.8K +</pre></div> + + +<h4 id="enable-autocompletion-for-newt">Enable autocompletion for newt</h4> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> $ complete -C "newt complete" newt +</pre></div> + + +<h4 id="usage">Usage</h4> +<p>Hit tab and see possible completion options or completed command.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> $ newt target s + set show + $ newt target show +</pre></div> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../newt_clean/> + <span class="fa fa-arrow-left"></span> + Previous: newt clean + </a> + + </li> + <li class="pull-right"> + + <a href=../newt_create_image/> + Next: newt create-image + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <footer class="row"> + <div class="col-xs-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + + </div> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> +</footer> + </div> + </div> + + + </div> + + <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 src="../../../js/base.js"></script> + <script src="../../../js/custom.js"></script> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_create_image/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_create_image/index.html b/develop/newt/command_list/newt_create_image/index.html index f86c628..78c60c7 100644 --- a/develop/newt/command_list/newt_create_image/index.html +++ b/develop/newt/command_list/newt_create_image/index.html @@ -300,6 +300,14 @@ + <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + <li class="active"> <a href="./">newt create-image</a> </li> @@ -349,6 +357,14 @@ <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + + <li > <a href="../newt_new/">newt new</a> </li> @@ -533,9 +549,9 @@ <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../newt_clean/> + <a href=../newt_complete/> <span class="fa fa-arrow-left"></span> - Previous: newt clean + Previous: newt complete </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_debug/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_debug/index.html b/develop/newt/command_list/newt_debug/index.html index 2e4a1dd..a3dde09 100644 --- a/develop/newt/command_list/newt_debug/index.html +++ b/develop/newt/command_list/newt_debug/index.html @@ -301,6 +301,14 @@ <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + + <li > <a href="../newt_create_image/">newt create-image</a> </li> @@ -349,6 +357,14 @@ <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + + <li > <a href="../newt_new/">newt new</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_help/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_help/index.html b/develop/newt/command_list/newt_help/index.html index a933c4e..653154f 100644 --- a/develop/newt/command_list/newt_help/index.html +++ b/develop/newt/command_list/newt_help/index.html @@ -301,6 +301,14 @@ <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + + <li > <a href="../newt_create_image/">newt create-image</a> </li> @@ -349,6 +357,14 @@ <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + + <li > <a href="../newt_new/">newt new</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_info/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_info/index.html b/develop/newt/command_list/newt_info/index.html index 939c82a..5b40de1 100644 --- a/develop/newt/command_list/newt_info/index.html +++ b/develop/newt/command_list/newt_info/index.html @@ -301,6 +301,14 @@ <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + + <li > <a href="../newt_create_image/">newt create-image</a> </li> @@ -349,6 +357,14 @@ <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + + <li > <a href="../newt_new/">newt new</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_install/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_install/index.html b/develop/newt/command_list/newt_install/index.html index 3f1da92..3a28d95 100644 --- a/develop/newt/command_list/newt_install/index.html +++ b/develop/newt/command_list/newt_install/index.html @@ -301,6 +301,14 @@ <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + + <li > <a href="../newt_create_image/">newt create-image</a> </li> @@ -349,6 +357,14 @@ <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + + <li > <a href="../newt_new/">newt new</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_load/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_load/index.html b/develop/newt/command_list/newt_load/index.html index f9cb2aa..9e6779e 100644 --- a/develop/newt/command_list/newt_load/index.html +++ b/develop/newt/command_list/newt_load/index.html @@ -301,6 +301,14 @@ <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + + <li > <a href="../newt_create_image/">newt create-image</a> </li> @@ -349,6 +357,14 @@ <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + + <li > <a href="../newt_new/">newt new</a> </li> @@ -524,8 +540,8 @@ </li> <li class="pull-right"> - <a href=../newt_new/> - Next: newt new + <a href=../newt_mfg/> + Next: newt mfg <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_mfg/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_mfg/index.html b/develop/newt/command_list/newt_mfg/index.html new file mode 100644 index 0000000..284aad7 --- /dev/null +++ b/develop/newt/command_list/newt_mfg/index.html @@ -0,0 +1,651 @@ +<!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"> + + + <!-- This is broken by doc revisioning. + <link rel="canonical" href="http://mynewt.apache.org/newt/command_list/newt_mfg/";> --> + <link rel="shortcut icon" href="../../../img/favicon.ico"> + + <title>newt mfg - Apache Mynewt</title> + + <link href="../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link rel="stylesheet" href="../../../css/highlight.css"> + <link href="../../../css/base.css" rel="stylesheet"> + <link href="../../../css/custom.css" rel="stylesheet"> + <link href="../../../css/v2.css" rel="stylesheet"> + <link href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> + <link href="../../../extra.css" rel="stylesheet"> + + <!-- 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]--> + + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-72162311-1', 'auto'); + ga('send', 'pageview'); + </script> + + </head> + + + <body class="newt mfg"> + + + <div class="container"> + <div class="row v2-main-banner"> + <a class="logo-cell" href="/"> + <img class="logo" src="/img/logo.png"> + </a> + <div class="tagline-cell"> + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + <div class="news-cell"> + <div class="well"> + <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.0.0-b1</a> released (Dec 13, 2016) + </div> + </div> + </div> +</div> + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" 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> + + </div> + + <!-- Expanded navigation --> + <div class="navbar-collapse collapse"> + <!-- Main navigation --> + <ul class="nav navbar-nav navbar-right"> + <li + class="" +> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">Documentation</a> + </li> + <li + class="" +> + <a href="/download/">Download</a> + </li> + <li + class="" +> + <a href="/community/">Community</a> + </li> + <li + class="" +> + <a href="/events/">Events</a> + </li> + </ul> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search documentation" /> + </div> + </form> + </div> + </div> + <ul class="toc-nav"> + <li class="doc-version"> +<select class="form-control" onchange="if (this.value) window.location.href=this.value"> + + <option + value="/develop/os/introduction" + selected="selected" + > + Version: develop (latest) + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 + </option> + +</select> +</li> + + + + + + + + + + + + + + + + + + + + + + <li ><a href="../../../os/introduction/">Mynewt Documentation</a> + + + <ul> + + + + + + + + <li ><a href="../../../os/get_started/get_started/">Basic Setup</a> + + + </li> + + + + + + <li > + <a href="../../../os/get_started/vocabulary/">Concepts</a> + </li> + + + + + + + + <li ><a href="../../../os/tutorials/tutorials/">Tutorials</a> + + + </li> + + + + + + + + <li ><a href="../../../os/os_user_guide/">OS User Guide</a> + + + </li> + + + + + + + + <li><a href=" + ../../../network/ble/ble_intro/ +">BLE User Guide</a> + + + </li> + + + + + + + + <li ><a href="../../newt_intro/">Newt Tool Guide</a> + + + <ul> + + + + + + <li > + <a href="../../newt_operation/">Newt Theory of Ops</a> + </li> + + + + + + + + <li ><a href="../../newt_ops/">Command Guide</a> + + + <ul> + + + + + + <li > + <a href="../newt_build/">newt build</a> + </li> + + + + + + <li > + <a href="../newt_clean/">newt clean</a> + </li> + + + + + + <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + + <li > + <a href="../newt_create_image/">newt create-image</a> + </li> + + + + + + <li > + <a href="../newt_debug/">newt debug</a> + </li> + + + + + + <li > + <a href="../newt_help/">newt help</a> + </li> + + + + + + <li > + <a href="../newt_info/">newt info</a> + </li> + + + + + + <li > + <a href="../newt_install/">newt install</a> + </li> + + + + + + <li > + <a href="../newt_load/">newt load</a> + </li> + + + + + + <li class="active"> + <a href="./">newt mfg</a> + </li> + + + + + + <li > + <a href="../newt_new/">newt new</a> + </li> + + + + + + <li > + <a href="../newt_run/">newt run</a> + </li> + + + + + + <li > + <a href="../newt_size/">newt size</a> + </li> + + + + + + <li > + <a href="../newt_target/">newt target</a> + </li> + + + + + + <li > + <a href="../newt_test/">newt test</a> + </li> + + + + + + <li > + <a href="../newt_upgrade/">newt upgrade</a> + </li> + + + + + + <li > + <a href="../newt_version/">newt version</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../newtmgr/overview/">Newt Manager Guide</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="col-md-9" role="main"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../newt_intro/">Newt Tool Guide</a></li> + + + + <li>» <a href="../../newt_ops/">Command Guide</a></li> + + + + <li>» newt mfg</li> + + + + </ul> +</div> + </div> + + <h2 id="newt-mfg"><font color="#F2853F" style="font-size:24pt">newt mfg </font></h2> +<p>Provides commands to create, build, and upload manufacturing image. </p> +<h4 id="usage">Usage:</h4> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> newt mfg [flags] + newt mfg [command] +</pre></div> + + +<h4 id="available-commands">Available Commands:</h4> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> create Create a manufacturing flash image + deploy Builds and uploads a manufacturing image (build + load) + load Load a manufacturing flash image onto a device +</pre></div> + + +<h4 id="flags">Flags:</h4> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> -h, --help=false: help for mfg +</pre></div> + + +<h4 id="global-flags">Global Flags:</h4> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> -l, --loglevel="WARN": Log level, defaults to WARN. + -o, --outfile string 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. +</pre></div> + + +<h4 id="description">Description</h4> +<table> +<thead> +<tr> +<th>Sub-command</th> +<th>Explanation</th> +</tr> +</thead> +<tbody> +<tr> +<td>create</td> +<td>A manufacturing image specifies 1) a boot loader target, and 2) one or more image targets. Assuming the manufacturing entity has been created and defined in the <code>mfgs/<mfg image name>/</code> package(see Examples below), this command collects the manufacturing related files in the newly created <code>bin/mfgs/<mfg image name></code> directory. The collection includes manifests with the image build time, version, manufacturing package build time, image ID (or hash) etc. It is essentially a snapshot of the image data and metadata uploaded to the device flash at manufacturing time. Note that the command expects the targets and images to have already been built using <code>newt build</code> and <code>newt create-image</code> commands.</td> +</tr> +<tr> +<td>deploy</td> +<td>A combination of build and load commands to put together and upload manufacturing image on to the device.</td> +</tr> +<tr> +<td>load</td> +<td>Loads the manufacturing package onto to the flash of the connected device.</td> +</tr> +</tbody> +</table> +<h4 id="examples">Examples</h4> +<p>Suppose you have created two targets (one for the bootloader and one for the <code>blinky</code> app). </p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt target show +targets/my_blinky_sim + app=apps/blinky + bsp=@apache-mynewt-core/hw/bsp/native + build_profile=debug +targets/rb_blinky + app=apps/blinky + bsp=@apache-mynewt-core/hw/bsp/rb-nano2 + build_profile=debug +targets/rb_boot + app=@apache-mynewt-core/apps/boot + bsp=@apache-mynewt-core/hw/bsp/rb-nano2 + build_profile=optimized +</pre></div> + + +<p>Build the bootloader and app images.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt build rb_boot +$ newt build rb_boot +$ newt create-image rb_blinky 0.0.1 +</pre></div> + + +<p>Create the directory and package to hold the manufacturing images.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ mkdir -p mfgs/rb_blinky_rsa +</pre></div> + + +<p>The <code>rb_blinky_rsa</code> package needs a pkg.yml file. In addition it is needs a mfg.yml file where the two constituent targets are defined. An example of each file is shown below.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ more mfgs/rb_blinky_rsa/pkg.yml +pkg.name: "mfgs/rb_blinky_rsa" +pkg.type: "mfg" +pkg.description: +pkg.author: +pkg.homepage: +</pre></div> + + +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ more mfgs/rb_blinky_rsa/mfg.yml +mfg.bootloader: 'targets/rb_boot' +mfg.images: + - 'targets/rb_blinky' +</pre></div> + + +<p>Run the <code>newt mfg create</code> command to collect all the manufacturing snapshot files.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt mfg create rb_blinky_rsa +Creating a manufacturing image from the following files: +<snip> +Generated the following files: +<snip> +$ +</pre></div> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../newt_load/> + <span class="fa fa-arrow-left"></span> + Previous: newt load + </a> + + </li> + <li class="pull-right"> + + <a href=../newt_new/> + Next: newt new + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <footer class="row"> + <div class="col-xs-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + + </div> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> +</footer> + </div> + </div> + + + </div> + + <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 src="../../../js/base.js"></script> + <script src="../../../js/custom.js"></script> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_new/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_new/index.html b/develop/newt/command_list/newt_new/index.html index a587011..76eb817 100644 --- a/develop/newt/command_list/newt_new/index.html +++ b/develop/newt/command_list/newt_new/index.html @@ -301,6 +301,14 @@ <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + + <li > <a href="../newt_create_image/">newt create-image</a> </li> @@ -348,6 +356,14 @@ + <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + <li class="active"> <a href="./">newt new</a> </li> @@ -519,9 +535,9 @@ <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../newt_load/> + <a href=../newt_mfg/> <span class="fa fa-arrow-left"></span> - Previous: newt load + Previous: newt mfg </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_run/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_run/index.html b/develop/newt/command_list/newt_run/index.html index f6b25d2..d2be077 100644 --- a/develop/newt/command_list/newt_run/index.html +++ b/develop/newt/command_list/newt_run/index.html @@ -301,6 +301,14 @@ <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + + <li > <a href="../newt_create_image/">newt create-image</a> </li> @@ -349,6 +357,14 @@ <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + + <li > <a href="../newt_new/">newt new</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/48437c63/develop/newt/command_list/newt_size/index.html ---------------------------------------------------------------------- diff --git a/develop/newt/command_list/newt_size/index.html b/develop/newt/command_list/newt_size/index.html index b0faab6..5cfbb7f 100644 --- a/develop/newt/command_list/newt_size/index.html +++ b/develop/newt/command_list/newt_size/index.html @@ -301,6 +301,14 @@ <li > + <a href="../newt_complete/">newt complete</a> + </li> + + + + + + <li > <a href="../newt_create_image/">newt create-image</a> </li> @@ -349,6 +357,14 @@ <li > + <a href="../newt_mfg/">newt mfg</a> + </li> + + + + + + <li > <a href="../newt_new/">newt new</a> </li>
