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 2017/02/08 15:23:39 UTC
[07/11] incubator-mynewt-site git commit: Updated the docs for new
system startup and initialization implementation - Author:cwanda
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/develop/os/modules/shell/shell_task_init/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/shell/shell_task_init/index.html b/develop/os/modules/shell/shell_task_init/index.html
deleted file mode 100644
index a78c8b6..0000000
--- a/develop/os/modules/shell/shell_task_init/index.html
+++ /dev/null
@@ -1,703 +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">
-
-
- <!-- This is broken by doc revisioning.
- <link rel="canonical" href="http://mynewt.apache.org/os/modules/shell/shell_task_init/"> -->
- <link rel="shortcut icon" href="../../../../img/favicon.ico">
-
- <title>shell_task_init - 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="shell_task_init">
-
-
- <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="../../../introduction/">Mynewt Documentation</a>
-
-
- <ul>
-
-
-
-
-
-
-
- <li ><a href="../../../get_started/get_started/">Basic Setup</a>
-
-
- </li>
-
-
-
-
-
- <li >
- <a href="../../../get_started/vocabulary/">Concepts</a>
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../os_user_guide/">OS User Guide</a>
-
-
- <ul>
-
-
-
-
-
-
-
- <li ><a href="../../../core_os/mynewt_os/">OS Core</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../console/console/">Console</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../shell/">Shell</a>
-
-
- <ul>
-
-
-
-
-
-
-
- <li><a href="
- ./
-">Functions</a>
-
-
- <ul>
-
-
-
- <li class="active">
- <a href="./">shell_task_init</a>
- </li>
-
-
-
-
-
- <li >
- <a href="../shell_cmd_register/">shell_cmd_register</a>
- </li>
-
-
-
-
-
- <li >
- <a href="../shell_nlip_input_register/">shell_nlip_input_register</a>
- </li>
-
-
-
-
-
- <li >
- <a href="../shell_nlip_output/">shell_nlip_output</a>
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../split/split/">Split Images</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../bootloader/bootloader/">Bootloader</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
-
-
- ../../fs/fs/fs/
-
-">File System</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../drivers/driver/">Drivers</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../testutil/testutil/">Test Utilities</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../devmgmt/newtmgr/">Device Management with Newt Manager</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../imgmgr/imgmgr/">Image Manager</a>
-
-
- </li>
-
-
-
-
-
- <li >
- <a href="../../baselibc/">Baselibc library</a>
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../elua/elua/">Embedded Lua</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../json/json/">JSON</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../fcb/fcb/">Flash Circular Buffer</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../stats/stats/">Stats</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../logs/logs/">Logs</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../sysinitconfig/sysinitconfig/">System Configuration And Initialization</a>
-
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../network/ble/ble_intro/
-">BLE User Guide</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
-
-
- </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="../shell/">Shell</a></li>
-
-
-
- <li>» Functions</li>
-
-
-
- <li>» shell_task_init</li>
-
-
-
- </ul>
-</div>
- </div>
-
- <h2 id="shell_task_init"><font color="F2853F" style="font-size:24pt"> shell_task_init</font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">shell_task_init</span>(<span style="color: #A90D91">uint8_t</span> <span style="color: #000000">prio</span>, <span style="color: #A90D91">os_stack_t</span> <span style="color: #000000">*stack</span>, <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">stack_size</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">max_input_length</span>);
-</pre></div>
-
-
-<p>Initializes the shell package. This creates a task for shell, and registers a few commands on its own
-(<code>echo</code>, <code>?</code>, <code>prompt</code> for example). It also allocates memory for buffering console input.</p>
-<h4 id="arguments">Arguments</h4>
-<table>
-<thead>
-<tr>
-<th>Arguments</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td><code>prio</code></td>
-<td>Priority of the shell task</td>
-</tr>
-<tr>
-<td><code>stack</code></td>
-<td>Pointer to shell tasks's stack</td>
-</tr>
-<tr>
-<td><code>stack_size</code></td>
-<td>Size of the aforementioned stack (in units of os_stack_t)</td>
-</tr>
-<tr>
-<td><code>max_input_length</code></td>
-<td>the maximum expected length of line for input</td>
-</tr>
-</tbody>
-</table>
-<h4 id="returned-values">Returned values</h4>
-<p>Returns 0 on success; nonzero on failure.</p>
-<h4 id="notes">Notes</h4>
-<p>You can register commands before calling this, but only if OS has not been started.</p>
-<h4 id="example">Example</h4>
-<p>Here's an example of stand-alone code which allows the user to execute regression tests for sys/config package only.</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#define SHELL_TASK_PRIO (3)</span>
-<span style="color: #633820">#define SHELL_MAX_INPUT_LEN (256)</span>
-<span style="color: #633820">#define SHELL_TASK_STACK_SIZE (OS_STACK_ALIGN(384))</span>
-<span style="color: #A90D91">os_stack_t</span> <span style="color: #000000">shell_stack</span>[<span style="color: #000000">SHELL_TASK_STACK_SIZE</span>];
-
-<span style="color: #A90D91">int</span>
-<span style="color: #000000">main</span>(<span style="color: #A90D91">int</span> <span style="color: #000000">argc</span>, <span style="color: #A90D91">char</span> <span style="color: #000000">**argv</span>)
-{
- ....
- <span style="color: #000000">shell_task_init</span>(<span style="color: #000000">SHELL_TASK_PRIO</span>, <span style="color: #000000">shell_stack</span>, <span style="color: #000000">SHELL_TASK_STACK_SIZE</span>,
- <span style="color: #000000">SHELL_MAX_INPUT_LEN</span>);
- ....
-}
-</pre></div>
-
- <div class="row">
-
-
-
-
-<ul class="nav nav-pills" style="margin-bottom: 10px">
- <li>
-
- <a href=../shell/>
- <span class="fa fa-arrow-left"></span>
- Previous: Shell
- </a>
-
- </li>
- <li class="pull-right">
-
- <a href=../shell_cmd_register/>
- Next: shell_cmd_register
- <span class="fa fa-arrow-right"></span>
- </a>
-
- </li>
-</ul>
- </div>
- <footer class="row">
- <div class="col-xs-12">
-
- <p class="copyright">Apache Mynewt (incubating) is available under Apache License, version 2.0.</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/8e70b507/develop/os/modules/split/split/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/split/split/index.html b/develop/os/modules/split/split/index.html
index e323153..b848ac6 100644
--- a/develop/os/modules/split/split/index.html
+++ b/develop/os/modules/split/split/index.html
@@ -981,9 +981,9 @@ special loader.elf image during the link.</p>
<ul class="nav nav-pills" style="margin-bottom: 10px">
<li>
- <a href=../../shell/shell_nlip_output/>
+ <a href=../../shell/shell_evq_set/>
<span class="fa fa-arrow-left"></span>
- Previous: shell_nlip_output
+ Previous: shell_evq_set
</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/develop/os/modules/sysinitconfig/sysinitconfig/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/sysinitconfig/sysinitconfig/index.html b/develop/os/modules/sysinitconfig/sysinitconfig/index.html
index 2e1927f..c2374e4 100644
--- a/develop/os/modules/sysinitconfig/sysinitconfig/index.html
+++ b/develop/os/modules/sysinitconfig/sysinitconfig/index.html
@@ -907,7 +907,7 @@ You can override the <code>OS_MAIN_TASK_PRIO</code> and <code>OS_MAIN_TASK_STACK
<ul>
<li>At the start of <code>main()</code>, call the Mynewt <code>sysinit()</code> function to initialize
the packages before performing any other processing.</li>
-<li>At the end of <code>main()</code>, wait for and dispatch events from the default event queue in a forever loop. </li>
+<li>At the end of <code>main()</code>, wait for and dispatch events from the default event queue in an infinite loop. </li>
</ul>
<p><strong>Note:</strong> You must include the <code>sysinit/sysinit.h</code> header file to access the <code>sysinit()</code> function.</p>
<p>Here is an example of a <code>main()</code> function:</p>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/develop/sitemap.xml
----------------------------------------------------------------------
diff --git a/develop/sitemap.xml b/develop/sitemap.xml
index c210311..0c120ee 100644
--- a/develop/sitemap.xml
+++ b/develop/sitemap.xml
@@ -4,7 +4,7 @@
<url>
<loc>http://mynewt.apache.org/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -13,7 +13,7 @@
<url>
<loc>http://mynewt.apache.org/pages/ble/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -22,7 +22,7 @@
<url>
<loc>http://mynewt.apache.org/quick-start/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -30,7 +30,7 @@
<url>
<loc>http://mynewt.apache.org/about/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -38,7 +38,7 @@
<url>
<loc>http://mynewt.apache.org/talks/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -46,7 +46,7 @@
<url>
<loc>http://mynewt.apache.org/download/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -54,7 +54,7 @@
<url>
<loc>http://mynewt.apache.org/community/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -62,7 +62,7 @@
<url>
<loc>http://mynewt.apache.org/events/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -71,7 +71,7 @@
<url>
<loc>http://mynewt.apache.org/os/introduction/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -83,7 +83,7 @@
<url>
<loc>http://mynewt.apache.org/os/get_started/vocabulary/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -123,13 +123,13 @@
<url>
<loc>http://mynewt.apache.org/faq/how_to_edit_docs/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.apache.org/faq/answers/</loc>
- <lastmod>2017-02-02</lastmod>
+ <lastmod>2017-02-08</lastmod>
<changefreq>daily</changefreq>
</url>