Repository: incubator-mynewt-site Updated Branches: refs/heads/asf-site 8e70b507d -> 35f2fc764
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/os_start/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/os_start/index.html b/os/core_os/os_start/index.html new file mode 100644 index 0000000..4809f04 --- /dev/null +++ b/os/core_os/os_start/index.html @@ -0,0 +1,750 @@ +<!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/core_os/os_start/";> --> + <link rel="shortcut icon" href="../../../img/favicon.ico"> + + <title>os_start - 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="os_start"> + + + <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="../mynewt_os/">OS Core</a> + + + <ul> + + + + + + + + <li><a href=" + ../os_init/ +">System-level Functions</a> + + + <ul> + + + + <li > + <a href="../os_init/">os_init</a> + </li> + + + + + + <li class="active"> + <a href="./">os_start</a> + </li> + + + + + + <li > + <a href="../os_started/">os_started</a> + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../context_switch/context_switch/">Scheduler</a> + + + </li> + + + + + + + + <li ><a href="../time/os_time/">Time</a> + + + </li> + + + + + + + + <li ><a href="../task/task/">Tasks</a> + + + </li> + + + + + + + + <li ><a href="../event_queue/event_queue/">Event Queues</a> + + + </li> + + + + + + + + <li ><a href="../semaphore/semaphore/">Semaphores</a> + + + </li> + + + + + + + + <li ><a href="../mutex/mutex/">Mutexes</a> + + + </li> + + + + + + + + <li ><a href="../memory_pool/memory_pool/">Memory Pools</a> + + + </li> + + + + + + + + <li ><a href="../heap/heap/">Heap</a> + + + </li> + + + + + + + + <li><a href=" + + + ../mbuf/mbuf/ + +">Memory Buffers</a> + + + </li> + + + + + + + + <li ><a href="../sanity/sanity/">Sanity</a> + + + </li> + + + + + + + + <li ><a href="../callout/callout/">Callouts</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../porting/port_os/">Porting to your Platform</a> + + + </li> + + + + + + + + <li ><a href="../../modules/console/console/">Console</a> + + + </li> + + + + + + + + <li ><a href="../../modules/shell/shell/">Shell</a> + + + </li> + + + + + + + + <li ><a href="../../modules/bootloader/bootloader/">Bootloader</a> + + + </li> + + + + + + + + <li><a href=" + + + ../../modules/fs/fs/fs/ + +">File System</a> + + + </li> + + + + + + + + <li ><a href="../../modules/hal/hal/">Hardware Abstraction Layer</a> + + + </li> + + + + + + + + <li ><a href="../../modules/testutil/testutil/">Test Utilities</a> + + + </li> + + + + + + + + <li ><a href="../../modules/devmgmt/newtmgr/">Device Management with Newt Manager</a> + + + </li> + + + + + + + + <li ><a href="../../modules/imgmgr/imgmgr/">Image Manager</a> + + + </li> + + + + + + <li > + <a href="../../modules/baselibc/">Baselibc library</a> + </li> + + + + + + + + <li ><a href="../../modules/elua/elua/">Embedded Lua</a> + + + </li> + + + + + + + + <li ><a href="../../modules/json/json/">JSON</a> + + + </li> + + + + + + + + <li ><a href="../../modules/stats/stats/">Stats</a> + + + </li> + + + + + + + + <li ><a href="../../modules/logs/logs/">Logs</a> + + + </li> + + + + + + + + <li ><a href="../../modules/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="../mynewt_os/">OS Core</a></li> + + + + <li>» <a href="../os_init/">System-level Functions</a></li> + + + + <li>» os_start</li> + + + + </ul> +</div> + </div> + + <h2 id="os_start"><font color="#F2853F" style="font-size:24pt">os_start</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">void os_start(void) +</pre></div> + + +<p>Starts the OS by initializing and enabling the OS time tick and starting the scheduler.</p> +<p>This function does not return.</p> +<p><br></p> +<h4 id="arguments">Arguments</h4> +<p>None</p> +<p><br></p> +<h4 id="returned-values">Returned values</h4> +<p>None (does not return).</p> +<p><br></p> +<h4 id="notes">Notes</h4> +<p>Once os_start has been called, context is switched to the highest priority task that was initialized prior to calling os_start.</p> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../os_init/> + <span class="fa fa-arrow-left"></span> + Previous: os_init + </a> + + </li> + <li class="pull-right"> + + <a href=../os_started/> + Next: os_started + <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/35f2fc76/os/core_os/os_started/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/os_started/index.html b/os/core_os/os_started/index.html index 6d9e6aa..1c4997d 100644 --- a/os/core_os/os_started/index.html +++ b/os/core_os/os_started/index.html @@ -255,14 +255,30 @@ <li><a href=" - ./ -">Functions</a> + ../os_init/ +">System-level Functions</a> <ul> + <li > + <a href="../os_init/">os_init</a> + </li> + + + + + + <li > + <a href="../os_start/">os_start</a> + </li> + + + + + <li class="active"> <a href="./">os_started</a> </li> @@ -649,7 +665,7 @@ - <li>» Functions</li> + <li>» <a href="../os_init/">System-level Functions</a></li> @@ -682,9 +698,9 @@ <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../mynewt_os/> + <a href=../os_start/> <span class="fa fa-arrow-left"></span> - Previous: OS Core + Previous: os_start </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/sanity/os_sanity_check_init/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/sanity/os_sanity_check_init/index.html b/os/core_os/sanity/os_sanity_check_init/index.html index 69ecaf3..0352335 100644 --- a/os/core_os/sanity/os_sanity_check_init/index.html +++ b/os/core_os/sanity/os_sanity_check_init/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/sanity/os_sanity_check_register/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/sanity/os_sanity_check_register/index.html b/os/core_os/sanity/os_sanity_check_register/index.html index 094e961..ddcdb0a 100644 --- a/os/core_os/sanity/os_sanity_check_register/index.html +++ b/os/core_os/sanity/os_sanity_check_register/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/sanity/os_sanity_check_reset/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/sanity/os_sanity_check_reset/index.html b/os/core_os/sanity/os_sanity_check_reset/index.html index f7481f1..32bee97 100644 --- a/os/core_os/sanity/os_sanity_check_reset/index.html +++ b/os/core_os/sanity/os_sanity_check_reset/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/sanity/os_sanity_task_checkin/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/sanity/os_sanity_task_checkin/index.html b/os/core_os/sanity/os_sanity_task_checkin/index.html index 0aba184..8ba1654 100644 --- a/os/core_os/sanity/os_sanity_task_checkin/index.html +++ b/os/core_os/sanity/os_sanity_task_checkin/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/sanity/os_sanity_task_init/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/sanity/os_sanity_task_init/index.html b/os/core_os/sanity/os_sanity_task_init/index.html index dd9bb31..f05bb0e 100644 --- a/os/core_os/sanity/os_sanity_task_init/index.html +++ b/os/core_os/sanity/os_sanity_task_init/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/sanity/sanity/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/sanity/sanity/index.html b/os/core_os/sanity/sanity/index.html index ce72733..fca395c 100644 --- a/os/core_os/sanity/sanity/index.html +++ b/os/core_os/sanity/sanity/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/semaphore/os_sem_init/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/semaphore/os_sem_init/index.html b/os/core_os/semaphore/os_sem_init/index.html index 1de4192..2dba121 100644 --- a/os/core_os/semaphore/os_sem_init/index.html +++ b/os/core_os/semaphore/os_sem_init/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/semaphore/os_sem_pend/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/semaphore/os_sem_pend/index.html b/os/core_os/semaphore/os_sem_pend/index.html index 4826e73..59ebd26 100644 --- a/os/core_os/semaphore/os_sem_pend/index.html +++ b/os/core_os/semaphore/os_sem_pend/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/semaphore/os_sem_release/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/semaphore/os_sem_release/index.html b/os/core_os/semaphore/os_sem_release/index.html index 9e67d6c..e116bbb 100644 --- a/os/core_os/semaphore/os_sem_release/index.html +++ b/os/core_os/semaphore/os_sem_release/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/semaphore/semaphore/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/semaphore/semaphore/index.html b/os/core_os/semaphore/semaphore/index.html index b7185ad..8d92f4a 100644 --- a/os/core_os/semaphore/semaphore/index.html +++ b/os/core_os/semaphore/semaphore/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/task/os_task_count/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/task/os_task_count/index.html b/os/core_os/task/os_task_count/index.html index 043e84e..76c5642 100644 --- a/os/core_os/task/os_task_count/index.html +++ b/os/core_os/task/os_task_count/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/task/os_task_info_get_next/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/task/os_task_info_get_next/index.html b/os/core_os/task/os_task_info_get_next/index.html index 04bf113..11881a3 100644 --- a/os/core_os/task/os_task_info_get_next/index.html +++ b/os/core_os/task/os_task_info_get_next/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/task/os_task_init/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/task/os_task_init/index.html b/os/core_os/task/os_task_init/index.html index 0b0d022..19e114a 100644 --- a/os/core_os/task/os_task_init/index.html +++ b/os/core_os/task/os_task_init/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/task/task/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/task/task/index.html b/os/core_os/task/task/index.html index 64459e0..c72d237 100644 --- a/os/core_os/task/task/index.html +++ b/os/core_os/task/task/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/time/os_gettimeofday/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/time/os_gettimeofday/index.html b/os/core_os/time/os_gettimeofday/index.html index 5e2698a..5aca5a1 100644 --- a/os/core_os/time/os_gettimeofday/index.html +++ b/os/core_os/time/os_gettimeofday/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/time/os_settimeofday/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/time/os_settimeofday/index.html b/os/core_os/time/os_settimeofday/index.html index a9ce6b9..a07ba85 100644 --- a/os/core_os/time/os_settimeofday/index.html +++ b/os/core_os/time/os_settimeofday/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/time/os_time/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/time/os_time/index.html b/os/core_os/time/os_time/index.html index 066d76d..995c183 100644 --- a/os/core_os/time/os_time/index.html +++ b/os/core_os/time/os_time/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/time/os_time_delay/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/time/os_time_delay/index.html b/os/core_os/time/os_time_delay/index.html index fdfb58e..d20c3b2 100644 --- a/os/core_os/time/os_time_delay/index.html +++ b/os/core_os/time/os_time_delay/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/time/os_time_get/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/time/os_time_get/index.html b/os/core_os/time/os_time_get/index.html index 0db0d52..e6bc181 100644 --- a/os/core_os/time/os_time_get/index.html +++ b/os/core_os/time/os_time_get/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/core_os/time/os_time_tick/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/time/os_time_tick/index.html b/os/core_os/time/os_time_tick/index.html index 65a712a..908f53e 100644 --- a/os/core_os/time/os_time_tick/index.html +++ b/os/core_os/time/os_time_tick/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_started/ -">Functions</a> + ../../os_init/ +">System-level Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/modules/bootloader/bootloader/index.html ---------------------------------------------------------------------- diff --git a/os/modules/bootloader/bootloader/index.html b/os/modules/bootloader/bootloader/index.html index f206c97..b82d2a0 100644 --- a/os/modules/bootloader/bootloader/index.html +++ b/os/modules/bootloader/bootloader/index.html @@ -567,9 +567,9 @@ <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../../shell/shell_evq_set/> + <a href=../../shell/shell_nlip_output/> <span class="fa fa-arrow-left"></span> - Previous: shell_evq_set + Previous: shell_nlip_output </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/modules/imgmgr/imgmgr/index.html ---------------------------------------------------------------------- diff --git a/os/modules/imgmgr/imgmgr/index.html b/os/modules/imgmgr/imgmgr/index.html index 5279745..6248320 100644 --- a/os/modules/imgmgr/imgmgr/index.html +++ b/os/modules/imgmgr/imgmgr/index.html @@ -359,7 +359,7 @@ <li><a href=" - ../imgr_ver_parse/ + ../imgmgr_module_init/ ">Functions</a> @@ -543,7 +543,7 @@ </thead> <tbody> <tr> -<td><a href="imgmgr_module_init.md">imgmgr_module_init</a></td> +<td><a href="../imgmgr_module_init/">imgmgr_module_init</a></td> <td>Registers image manager commands with newtmgr.</td> </tr> <tr> @@ -573,8 +573,8 @@ </li> <li class="pull-right"> - <a href=../imgr_ver_parse/> - Next: imgr_ver_parse + <a href=../imgmgr_module_init/> + Next: imgmgr_module_init <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/modules/imgmgr/imgmgr_module_init/index.html ---------------------------------------------------------------------- diff --git a/os/modules/imgmgr/imgmgr_module_init/index.html b/os/modules/imgmgr/imgmgr_module_init/index.html new file mode 100644 index 0000000..d121cbd --- /dev/null +++ b/os/modules/imgmgr/imgmgr_module_init/index.html @@ -0,0 +1,632 @@ +<!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/imgmgr/imgmgr_module_init/";> --> + <link rel="shortcut icon" href="../../../../img/favicon.ico"> + + <title>imgmgr_module_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="imgmgr_module_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/">Shell</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="../../testutil/testutil/">Test Utilities</a> + + + </li> + + + + + + + + <li ><a href="../../devmgmt/newtmgr/">Device Management with Newt Manager</a> + + + </li> + + + + + + + + <li ><a href="../imgmgr/">Image Manager</a> + + + <ul> + + + + + + + + <li><a href=" + ./ +">Functions</a> + + + <ul> + + + + <li class="active"> + <a href="./">imgmgr_module_init</a> + </li> + + + + + + <li > + <a href="../imgr_ver_parse/">imgr_ver_parse</a> + </li> + + + + + + <li > + <a href="../imgr_ver_str/">imgr_ver_str</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </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="../../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="../imgmgr/">Image Manager</a></li> + + + + <li>» Functions</li> + + + + <li>» imgmgr_module_init</li> + + + + </ul> +</div> + </div> + + <h2 id="imgmgr_module_init"><font color="#F2853F" style="font-size:24pt"> imgmgr_module_init </font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> int + imgmgr_module_init(void) +</pre></div> + + +<p>Registers image manager commands with newtmgr. This function should be called while initializing the project, preferably after newtmgr itself has been initialized.</p> +<h4 id="arguments">Arguments</h4> +<p>N/A</p> +<h4 id="returned-values">Returned values</h4> +<p>List any values returned. +Error codes?</p> +<h4 id="notes">Notes</h4> +<h4 id="example">Example</h4> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int main(int argc, char **argv) +{ + ... + + nmgr_task_init(NEWTMGR_TASK_PRIO, newtmgr_stack, NEWTMGR_TASK_STACK_SIZE); + imgmgr_module_init(); + + ... +} +</pre></div> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../imgmgr/> + <span class="fa fa-arrow-left"></span> + Previous: Image Manager + </a> + + </li> + <li class="pull-right"> + + <a href=../imgr_ver_parse/> + Next: imgr_ver_parse + <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/35f2fc76/os/modules/imgmgr/imgr_ver_parse/index.html ---------------------------------------------------------------------- diff --git a/os/modules/imgmgr/imgr_ver_parse/index.html b/os/modules/imgmgr/imgr_ver_parse/index.html index 3f8dd57..cde94e3 100644 --- a/os/modules/imgmgr/imgr_ver_parse/index.html +++ b/os/modules/imgmgr/imgr_ver_parse/index.html @@ -359,7 +359,7 @@ <li><a href=" - ./ + ../imgmgr_module_init/ ">Functions</a> @@ -367,6 +367,14 @@ + <li > + <a href="../imgmgr_module_init/">imgmgr_module_init</a> + </li> + + + + + <li class="active"> <a href="./">imgr_ver_parse</a> </li> @@ -531,7 +539,7 @@ - <li>» Functions</li> + <li>» <a href="../imgmgr_module_init/">Functions</a></li> @@ -597,9 +605,9 @@ <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../imgmgr/> + <a href=../imgmgr_module_init/> <span class="fa fa-arrow-left"></span> - Previous: Image Manager + Previous: imgmgr_module_init </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/modules/imgmgr/imgr_ver_str/index.html ---------------------------------------------------------------------- diff --git a/os/modules/imgmgr/imgr_ver_str/index.html b/os/modules/imgmgr/imgr_ver_str/index.html index 730673f..5593dcc 100644 --- a/os/modules/imgmgr/imgr_ver_str/index.html +++ b/os/modules/imgmgr/imgr_ver_str/index.html @@ -359,7 +359,7 @@ <li><a href=" - ../imgr_ver_parse/ + ../imgmgr_module_init/ ">Functions</a> @@ -368,6 +368,14 @@ <li > + <a href="../imgmgr_module_init/">imgmgr_module_init</a> + </li> + + + + + + <li > <a href="../imgr_ver_parse/">imgr_ver_parse</a> </li> @@ -531,7 +539,7 @@ - <li>» <a href="../imgr_ver_parse/">Functions</a></li> + <li>» <a href="../imgmgr_module_init/">Functions</a></li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/modules/shell/shell/index.html ---------------------------------------------------------------------- diff --git a/os/modules/shell/shell/index.html b/os/modules/shell/shell/index.html index ff8d2b0..0c6bf8a 100644 --- a/os/modules/shell/shell/index.html +++ b/os/modules/shell/shell/index.html @@ -288,7 +288,7 @@ <li><a href=" - ../shell_cmd_register/ + ../shell_task_init/ ">Functions</a> @@ -647,7 +647,7 @@ stat stat </thead> <tbody> <tr> -<td><a href="shell_task_init.md">shell_task_init</a></td> +<td><a href="../shell_task_init/">shell_task_init</a></td> <td>Initializes the shell package. This creates a task for shell, and registers few commands on its own.</td> </tr> <tr> @@ -681,8 +681,8 @@ stat stat </li> <li class="pull-right"> - <a href=../shell_cmd_register/> - Next: shell_cmd_register + <a href=../shell_task_init/> + Next: shell_task_init <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/modules/shell/shell_cmd_register/index.html ---------------------------------------------------------------------- diff --git a/os/modules/shell/shell_cmd_register/index.html b/os/modules/shell/shell_cmd_register/index.html index 7984dd3..8b689b2 100644 --- a/os/modules/shell/shell_cmd_register/index.html +++ b/os/modules/shell/shell_cmd_register/index.html @@ -288,7 +288,7 @@ <li><a href=" - ./ + ../shell_task_init/ ">Functions</a> @@ -296,16 +296,16 @@ - <li class="active"> - <a href="./">shell_cmd_register</a> + <li > + <a href="../shell_task_init/">shell_task_init</a> </li> - <li > - <a href="../shell_nlip_input_register/">shell_nlip_input_register</a> + <li class="active"> + <a href="./">shell_cmd_register</a> </li> @@ -313,7 +313,7 @@ <li > - <a href="../shell_nlip_output/">shell_nlip_output</a> + <a href="../shell_nlip_input_register/">shell_nlip_input_register</a> </li> @@ -321,7 +321,7 @@ <li > - <a href="../shell_evq_set/">shell_evq_set</a> + <a href="../shell_nlip_output/">shell_nlip_output</a> </li> @@ -547,7 +547,7 @@ - <li>» Functions</li> + <li>» <a href="../shell_task_init/">Functions</a></li> @@ -608,9 +608,9 @@ fs_cli_init(void) <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../shell/> + <a href=../shell_task_init/> <span class="fa fa-arrow-left"></span> - Previous: Shell + Previous: shell_task_init </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/modules/shell/shell_evq_set/index.html ---------------------------------------------------------------------- diff --git a/os/modules/shell/shell_evq_set/index.html b/os/modules/shell/shell_evq_set/index.html deleted file mode 100644 index 4410598..0000000 --- a/os/modules/shell/shell_evq_set/index.html +++ /dev/null @@ -1,643 +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_evq_set/";> --> - <link rel="shortcut icon" href="../../../../img/favicon.ico"> - - <title>shell_evq_set - 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_evq_set"> - - - <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=" - ../shell_cmd_register/ -">Functions</a> - - - <ul> - - - - <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> - - - - - - <li class="active"> - <a href="./">shell_evq_set</a> - </li> - - - - </ul> - - </li> - - - - </ul> - - </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="../../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="../../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>» <a href="../shell_cmd_register/">Functions</a></li> - - - - <li>» shell_evq_set</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">void</span> <span style="color: #000000">shell_evq_set</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_eventq</span> <span style="color: #000000">*evq</span>) -</pre></div> - - -<p>Specifies an event queue to use for shell events. You must create the event queue -and the task to process events from the queue before calling this function. </p> -<p>By default, shell uses the OS default event queue and executes in the context -of the main task that Mynewt creates.</p> -<h4 id="arguments">Arguments</h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td><code>evq</code></td> -<td>Pointer to the event queue to use for shell events.</td> -</tr> -</tbody> -</table> -<h4 id="returned-values">Returned values</h4> -<p>None</p> -<h4 id="notes">Notes</h4> - - <div class="row"> - - - - -<ul class="nav nav-pills" style="margin-bottom: 10px"> - <li> - - <a href=../shell_nlip_output/> - <span class="fa fa-arrow-left"></span> - Previous: shell_nlip_output - </a> - - </li> - <li class="pull-right"> - - <a href=../../bootloader/bootloader/> - Next: Bootloader - <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/35f2fc76/os/modules/shell/shell_nlip_input_register/index.html ---------------------------------------------------------------------- diff --git a/os/modules/shell/shell_nlip_input_register/index.html b/os/modules/shell/shell_nlip_input_register/index.html index 7fe8f5d..60e5dfe 100644 --- a/os/modules/shell/shell_nlip_input_register/index.html +++ b/os/modules/shell/shell_nlip_input_register/index.html @@ -288,7 +288,7 @@ <li><a href=" - ../shell_cmd_register/ + ../shell_task_init/ ">Functions</a> @@ -297,23 +297,23 @@ <li > - <a href="../shell_cmd_register/">shell_cmd_register</a> + <a href="../shell_task_init/">shell_task_init</a> </li> - <li class="active"> - <a href="./">shell_nlip_input_register</a> + <li > + <a href="../shell_cmd_register/">shell_cmd_register</a> </li> - <li > - <a href="../shell_nlip_output/">shell_nlip_output</a> + <li class="active"> + <a href="./">shell_nlip_input_register</a> </li> @@ -321,7 +321,7 @@ <li > - <a href="../shell_evq_set/">shell_evq_set</a> + <a href="../shell_nlip_output/">shell_nlip_output</a> </li> @@ -547,7 +547,7 @@ - <li>» <a href="../shell_cmd_register/">Functions</a></li> + <li>» <a href="../shell_task_init/">Functions</a></li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/modules/shell/shell_nlip_output/index.html ---------------------------------------------------------------------- diff --git a/os/modules/shell/shell_nlip_output/index.html b/os/modules/shell/shell_nlip_output/index.html index 1264c4b..d9c5dc4 100644 --- a/os/modules/shell/shell_nlip_output/index.html +++ b/os/modules/shell/shell_nlip_output/index.html @@ -288,7 +288,7 @@ <li><a href=" - ../shell_cmd_register/ + ../shell_task_init/ ">Functions</a> @@ -297,7 +297,7 @@ <li > - <a href="../shell_cmd_register/">shell_cmd_register</a> + <a href="../shell_task_init/">shell_task_init</a> </li> @@ -305,23 +305,23 @@ <li > - <a href="../shell_nlip_input_register/">shell_nlip_input_register</a> + <a href="../shell_cmd_register/">shell_cmd_register</a> </li> - <li class="active"> - <a href="./">shell_nlip_output</a> + <li > + <a href="../shell_nlip_input_register/">shell_nlip_input_register</a> </li> - <li > - <a href="../shell_evq_set/">shell_evq_set</a> + <li class="active"> + <a href="./">shell_nlip_output</a> </li> @@ -547,7 +547,7 @@ - <li>» <a href="../shell_cmd_register/">Functions</a></li> + <li>» <a href="../shell_task_init/">Functions</a></li> @@ -615,8 +615,8 @@ err: </li> <li class="pull-right"> - <a href=../shell_evq_set/> - Next: shell_evq_set + <a href=../../bootloader/bootloader/> + Next: Bootloader <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/35f2fc76/os/modules/shell/shell_task_init/index.html ---------------------------------------------------------------------- diff --git a/os/modules/shell/shell_task_init/index.html b/os/modules/shell/shell_task_init/index.html new file mode 100644 index 0000000..c5a51f4 --- /dev/null +++ b/os/modules/shell/shell_task_init/index.html @@ -0,0 +1,670 @@ +<!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="../../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="../../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="../../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%">int shell_task_init(uint8_t prio, os_stack_t *stack, uint16_t stack_size, + int max_input_length); +</pre></div> + + +<p>Initializes the shell package. This creates a task for shell, and registers few commands on its own (<em>echo</em>, <em>?</em>, 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>prio</td> +<td>Priority of the shell task</td> +</tr> +<tr> +<td>stack</td> +<td>Pointer to shell tasks's stack</td> +</tr> +<tr> +<td>stack_size</td> +<td>Size of the aforementioned stack (in units of os_stack_t)</td> +</tr> +<tr> +<td>max_input_length</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%">#define SHELL_TASK_PRIO (3) +#define SHELL_MAX_INPUT_LEN (256) +#define SHELL_TASK_STACK_SIZE (OS_STACK_ALIGN(384)) +os_stack_t shell_stack[SHELL_TASK_STACK_SIZE]; + +int +main(int argc, char **argv) +{ + .... + shell_task_init(SHELL_TASK_PRIO, shell_stack, SHELL_TASK_STACK_SIZE, + SHELL_MAX_INPUT_LEN); + .... +} +</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
