http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/modules/shell/shell/index.html ---------------------------------------------------------------------- diff --git a/develop/os/modules/shell/shell/index.html b/develop/os/modules/shell/shell/index.html index 744183e..ae0a2e0 100644 --- a/develop/os/modules/shell/shell/index.html +++ b/develop/os/modules/shell/shell/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/modules/shell/shell/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>toc - Apache Mynewt</title> + <title>toc - Apache Mynewt</title> <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> - <link href="../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <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"> @@ -45,6 +44,16 @@ <body class="toc"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<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"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> <div class="top"> - <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> <div class="form-group"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -476,14 +493,9 @@ </ul> </div></div> - <div class="show-sidebar-container"> - <button class="show-sidebar">Docs Menu</button> - </div> - <div class="col-md-9" role="main"> - <div class="row doc-header"> - <div class="col-sm-12"> - <div role="navigation" aria-label="breadcrumbs navigation"> + <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> @@ -501,20 +513,29 @@ </ul> </div> - </div> </div> <h1 id="shell">Shell</h1> -<p>The shell is package sitting on top of console, handling 2 jobs: processing console input and implementing newtmgr line protocol over serial line. Shell runs on its own task.</p> +<p>The shell is package sitting on top of console, handling 2 jobs: processing console input and implementing +<a href="../../../../newtmgr/overview/">newtmgr</a> line protocol over serial line. Shell runs in its own task.</p> <h3 id="description">Description</h3> <ul> <li> -<p>Shell's first job is directing incoming commands to other subsystems. It parses the incoming character string, and splits it into tokens. Then it looks for the subsystem to handle this command based on the first token of input.</p> +<p>Shell's first job is directing incoming commands to other subsystems. It parses the incoming character string +and splits it into tokens. Then it looks for the subsystem to handle this command based on the first token of input.</p> +<ul> +<li> <p>Subsystems register their command handlers using <code>shell_cmd_register()</code>. When shell calls the command handler, it passes the other tokens as arguments.</p> -<p>A few commands are currently available in the shell - <code>tasks</code>, <code>log</code>, and <code>stat stat</code>. A $ prompt sign will be coming soon!</p> </li> <li> -<p>Shell's second job is doing framing, encoding and decoding newtmgr protocol when it's carried over the console. Protocol handler (libs/newtmgr) registers itself using <code>shell_nlip_input_register()</code>, and shell calls the registered handler for every frame. Outgoing frames for the protocol are sent using <code>shell_nlip_output()</code>.</p> +<p>A few commands are currently available in the shell - <code>tasks</code>, <code>log</code>, <code>echo</code>, <code>date</code> and <code>prompt</code>.</p> +</li> +</ul> +</li> +<li> +<p>Shell's second job is doing framing, encoding and decoding newtmgr protocol when it's carried over the console. +Protocol handler (libs/newtmgr) registers itself using <code>shell_nlip_input_register()</code>, and shell calls the registered +handler for every frame. Outgoing frames for the protocol are sent using <code>shell_nlip_output()</code>.</p> </li> </ul> <p><br></p> @@ -581,17 +602,21 @@ tasks 217953: os_sanity (prio: 254, nw: 218710, flags: 0x0, ssize: 0, cswcnt: 218, tot_run_time: 0ms) 218010: task2 (prio: 2, nw: 217709, flags: 0x3, ssize: 0, cswcnt: 218, tot_run_time: 0ms) -stat stat -229881:s0: 1 + +prompt +Usage: prompt [set|show] [prompt_char] +prompt set > +Prompt set to: > +229370: > </pre></div> <h3 id="data-structures">Data structures</h3> <p>This data structure is used in holding information about registered command handlers.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">struct shell_cmd { - char *sc_cmd; - shell_cmd_func_t sc_cmd_func; - STAILQ_ENTRY(shell_cmd) sc_next; +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">struct</span> <span style="color: #000000">shell_cmd</span> { + <span style="color: #A90D91">char</span> <span style="color: #000000">*sc_cmd</span>; + <span style="color: #A90D91">shell_cmd_func_t</span> <span style="color: #000000">sc_cmd_func</span>; + <span style="color: #000000">STAILQ_ENTRY</span>(<span style="color: #000000">shell_cmd</span>) <span style="color: #000000">sc_next</span>; }; </pre></div> @@ -605,15 +630,15 @@ stat stat </thead> <tbody> <tr> -<td>sc_cmd</td> +<td><code>sc_cmd</code></td> <td>Character string of the command</td> </tr> <tr> -<td>sc_cmd_func</td> +<td><code>sc_cmd_func</code></td> <td>Pointer to the command handler</td> </tr> <tr> -<td>sc_next</td> +<td><code>sc_next</code></td> <td>Bookkeeping linkage internal for shell</td> </tr> </tbody> @@ -672,34 +697,22 @@ stat stat </li> </ul> </div> - <div class="row"> - <footer> - <div class="row"> - <div class="col-md-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.<br>The Apache Software Foundation Apache Incubator</p> - - </div> - </div> - <div class="copyright-logos"> - <div class="row"> - <div class="col-xs-6 text-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </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="row"> - <div class="col-md-12"> + <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>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/modules/shell/shell_cmd_register/index.html ---------------------------------------------------------------------- diff --git a/develop/os/modules/shell/shell_cmd_register/index.html b/develop/os/modules/shell/shell_cmd_register/index.html index f8850b1..e5ce393 100644 --- a/develop/os/modules/shell/shell_cmd_register/index.html +++ b/develop/os/modules/shell/shell_cmd_register/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/modules/shell/shell_cmd_register/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>shell_cmd_register - Apache Mynewt</title> + <title>shell_cmd_register - Apache Mynewt</title> <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> - <link href="../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <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"> @@ -45,6 +44,16 @@ <body class="shell_cmd_register"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<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"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> <div class="top"> - <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> <div class="form-group"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -512,14 +529,9 @@ </ul> </div></div> - <div class="show-sidebar-container"> - <button class="show-sidebar">Docs Menu</button> - </div> - <div class="col-md-9" role="main"> - <div class="row doc-header"> - <div class="col-sm-12"> - <div role="navigation" aria-label="breadcrumbs navigation"> + <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> @@ -539,16 +551,18 @@ </ul> </div> - </div> </div> <h2 id="shell_cmd_register"><font color="#F2853F" style="font-size:24pt"> shell_cmd_register </font></h2> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int shell_cmd_register(struct shell_cmd *sc) +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">shell_cmd_register</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">shell_cmd</span> <span style="color: #000000">*sc</span>) </pre></div> -<p>Registers a handler for incoming console commands. Within the structure there is the command string and the handler for those commands. Caller must allocate the memory for this structure and keep it around as shell links this to its own internal data structures.</p> -<p>Command handler is of type <code>int(*shell_cmd_func_t)(int argc, char **argv)</code>. Command line arguments are passed to it as an array of character pointers.</p> +<p>Registers a handler for incoming console commands. Within the structure there is the command string +and the handler for those commands. Caller must allocate the memory for this structure and keep it around +as shell links this to its own internal data structures.</p> +<p>Command handler is of type <code>int(*shell_cmd_func_t)(int argc, char **argv)</code>. Command line arguments +are passed to it as an array of character pointers.</p> <h4 id="arguments">Arguments</h4> <table> <thead> @@ -559,7 +573,7 @@ </thead> <tbody> <tr> -<td>sc</td> +<td><code>sc</code></td> <td>Structure containing info about the command.</td> </tr> </tbody> @@ -568,17 +582,17 @@ <p>Returns 0 on success. Non-zero on failure.</p> <h4 id="example">Example</h4> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">static int fs_ls_cmd(int argc, char **argv); +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">static</span> <span style="color: #A90D91">int</span> <span style="color: #000000">fs_ls_cmd</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>); -static struct shell_cmd fs_ls_struct = { - .sc_cmd = "ls", - .sc_cmd_func = fs_ls_cmd +<span style="color: #A90D91">static</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">shell_cmd</span> <span style="color: #000000">fs_ls_struct</span> <span style="color: #000000">=</span> { + .<span style="color: #000000">sc_cmd</span> <span style="color: #000000">=</span> <span style="color: #C41A16">"ls"</span>, + .<span style="color: #000000">sc_cmd_func</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_ls_cmd</span> }; -void -fs_cli_init(void) +<span style="color: #A90D91">void</span> +<span style="color: #000000">fs_cli_init</span>(<span style="color: #A90D91">void</span>) { - shell_cmd_register(&fs_ls_struct); + <span style="color: #000000">shell_cmd_register</span>(<span style="color: #000000">&fs_ls_struct</span>); .... } </pre></div> @@ -607,34 +621,22 @@ fs_cli_init(void) </li> </ul> </div> - <div class="row"> - <footer> - <div class="row"> - <div class="col-md-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.<br>The Apache Software Foundation Apache Incubator</p> - - </div> - </div> - <div class="copyright-logos"> - <div class="row"> - <div class="col-xs-6 text-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </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="row"> - <div class="col-md-12"> + <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> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/modules/shell/shell_nlip_input_register/index.html ---------------------------------------------------------------------- diff --git a/develop/os/modules/shell/shell_nlip_input_register/index.html b/develop/os/modules/shell/shell_nlip_input_register/index.html index a5cc71e..cd3d4c8 100644 --- a/develop/os/modules/shell/shell_nlip_input_register/index.html +++ b/develop/os/modules/shell/shell_nlip_input_register/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/modules/shell/shell_nlip_input_register/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>shell_nlip_input_register - Apache Mynewt</title> + <title>shell_nlip_input_register - Apache Mynewt</title> <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> - <link href="../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <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"> @@ -45,6 +44,16 @@ <body class="shell_nlip_input_register"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<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"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> <div class="top"> - <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> <div class="form-group"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -512,14 +529,9 @@ </ul> </div></div> - <div class="show-sidebar-container"> - <button class="show-sidebar">Docs Menu</button> - </div> - <div class="col-md-9" role="main"> - <div class="row doc-header"> - <div class="col-sm-12"> - <div role="navigation" aria-label="breadcrumbs navigation"> + <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> @@ -539,16 +551,18 @@ </ul> </div> - </div> </div> <h2 id="shell_nlip_input_register"><font color="#F2853F" style="font-size:24pt"> shell_nlip_input_register </font></h2> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int shell_nlip_input_register(shell_nlip_input_func_t nf, void *arg) +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">shell_nlip_input_register</span>(<span style="color: #A90D91">shell_nlip_input_func_t</span> <span style="color: #000000">nf</span>, <span style="color: #A90D91">void</span> <span style="color: #000000">*arg</span>) </pre></div> -<p>Registers a handler for incoming newtmgr messages. Shell receives incoming data stream from UART and when it detects NLIP frame, it decodes it and passes it on by calling the function <code>nf</code>.</p> -<p>Handler function is of type <code>int (*shell_nlip_input_func_t)(struct os_mbuf *m, void *arg)</code>. Shell passes the incoming newtmgr message inside os_mbuf <em>m</em>, and <em>arg</em> is the argument that was passed in during handler registration.</p> +<p>Registers a handler for incoming newtmgr messages. Shell receives incoming data stream from +UART and when it detects NLIP frame, it decodes it and passes it on by calling the function <code>nf</code>.</p> +<p>Handler function is of type <code>int (*shell_nlip_input_func_t)(struct os_mbuf *m, void *arg)</code>. +Shell passes the incoming newtmgr message inside <code>os_mbuf</code> <code>m</code>, and <code>arg</code> is the argument that +was passed in during handler registration.</p> <h4 id="arguments">Arguments</h4> <table> <thead> @@ -559,11 +573,11 @@ </thead> <tbody> <tr> -<td>nf</td> +<td><code>nf</code></td> <td>Handler for incoming newtmgr datagrams.</td> </tr> <tr> -<td>arg</td> +<td><code>arg</code></td> <td>Argument that gets passed to this handler, along with the datagram</td> </tr> </tbody> @@ -571,21 +585,21 @@ <h4 id="returned-values">Returned values</h4> <p>Returns 0 on success.</p> <h4 id="example">Example</h4> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">static int -nmgr_shell_in(struct os_mbuf *m, void *arg) +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">static</span> <span style="color: #A90D91">int</span> +<span style="color: #000000">nmgr_shell_in</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*m</span>, <span style="color: #A90D91">void</span> <span style="color: #000000">*arg</span>) { .... } -int -nmgr_task_init(uint8_t prio, os_stack_t *stack_ptr, uint16_t stack_len) +<span style="color: #A90D91">int</span> +<span style="color: #000000">nmgr_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_ptr</span>, <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">stack_len</span>) { - int rc; + <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>; .... - rc = shell_nlip_input_register(nmgr_shell_in, - (void *) &g_nmgr_shell_transport); - if (rc != 0) { - goto err; + <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">shell_nlip_input_register</span>(<span style="color: #000000">nmgr_shell_in</span>, + (<span style="color: #A90D91">void</span> <span style="color: #000000">*</span>) <span style="color: #000000">&g_nmgr_shell_transport</span>); + <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span>) { + <span style="color: #A90D91">goto</span> <span style="color: #000000">err</span>; } .... } @@ -615,34 +629,22 @@ nmgr_task_init(uint8_t prio, os_stack_t *stack_ptr, uint16_t stack_len) </li> </ul> </div> - <div class="row"> - <footer> - <div class="row"> - <div class="col-md-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.<br>The Apache Software Foundation Apache Incubator</p> - - </div> - </div> - <div class="copyright-logos"> - <div class="row"> - <div class="col-xs-6 text-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </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="row"> - <div class="col-md-12"> + <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> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/modules/shell/shell_nlip_output/index.html ---------------------------------------------------------------------- diff --git a/develop/os/modules/shell/shell_nlip_output/index.html b/develop/os/modules/shell/shell_nlip_output/index.html index 6626f85..a8c5e7a 100644 --- a/develop/os/modules/shell/shell_nlip_output/index.html +++ b/develop/os/modules/shell/shell_nlip_output/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/modules/shell/shell_nlip_output/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>shell_nlip_output - Apache Mynewt</title> + <title>shell_nlip_output - Apache Mynewt</title> <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> - <link href="../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <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"> @@ -45,6 +44,16 @@ <body class="shell_nlip_output"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<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"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> <div class="top"> - <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> <div class="form-group"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -512,14 +529,9 @@ </ul> </div></div> - <div class="show-sidebar-container"> - <button class="show-sidebar">Docs Menu</button> - </div> - <div class="col-md-9" role="main"> - <div class="row doc-header"> - <div class="col-sm-12"> - <div role="navigation" aria-label="breadcrumbs navigation"> + <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> @@ -539,11 +551,10 @@ </ul> </div> - </div> </div> <h2 id="shell_nlip_output"><font color="#F2853F" style="font-size:24pt"> shell_nlip_output </font></h2> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int shell_nlip_output(struct os_mbuf *m) +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">shell_nlip_output</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*m</span>) </pre></div> @@ -558,7 +569,7 @@ </thead> <tbody> <tr> -<td>m</td> +<td><code>m</code></td> <td>os_mbuf containing the message</td> </tr> </tbody> @@ -566,19 +577,19 @@ <h4 id="returned-values">Returned values</h4> <p>Returns 0 on success.</p> <h4 id="example">Example</h4> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">static int -nmgr_shell_out(struct nmgr_transport *nt, struct os_mbuf *m) +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">static</span> <span style="color: #A90D91">int</span> +<span style="color: #000000">nmgr_shell_out</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">nmgr_transport</span> <span style="color: #000000">*nt</span>, <span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*m</span>) { - int rc; + <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>; - rc = shell_nlip_output(m); - if (rc != 0) { - goto err; + <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">shell_nlip_output</span>(<span style="color: #000000">m</span>); + <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span>) { + <span style="color: #A90D91">goto</span> <span style="color: #000000">err</span>; } - return (0); -err: - return (rc); + <span style="color: #A90D91">return</span> (<span style="color: #1C01CE">0</span>); +<span style="color: #000000">err</span>: + <span style="color: #A90D91">return</span> (<span style="color: #000000">rc</span>); } </pre></div> @@ -606,34 +617,22 @@ err: </li> </ul> </div> - <div class="row"> - <footer> - <div class="row"> - <div class="col-md-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.<br>The Apache Software Foundation Apache Incubator</p> - - </div> - </div> - <div class="copyright-logos"> - <div class="row"> - <div class="col-xs-6 text-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </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="row"> - <div class="col-md-12"> + <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> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/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 index d922c83..fac6b9d 100644 --- a/develop/os/modules/shell/shell_task_init/index.html +++ b/develop/os/modules/shell/shell_task_init/index.html @@ -10,15 +10,14 @@ <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> + <title>shell_task_init - Apache Mynewt</title> <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> - <link href="../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <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"> @@ -45,6 +44,16 @@ <body class="shell_task_init"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<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"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> <div class="top"> - <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> <div class="form-group"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -512,14 +529,9 @@ </ul> </div></div> - <div class="show-sidebar-container"> - <button class="show-sidebar">Docs Menu</button> - </div> - <div class="col-md-9" role="main"> - <div class="row doc-header"> - <div class="col-sm-12"> - <div role="navigation" aria-label="breadcrumbs navigation"> + <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> @@ -539,16 +551,15 @@ </ul> </div> - </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); +<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 few commands on its own (<em>echo</em>, <em>?</em>, for example). It also allocates memory for buffering console input.</p> +<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> @@ -559,19 +570,19 @@ </thead> <tbody> <tr> -<td>prio</td> +<td><code>prio</code></td> <td>Priority of the shell task</td> </tr> <tr> -<td>stack</td> +<td><code>stack</code></td> <td>Pointer to shell tasks's stack</td> </tr> <tr> -<td>stack_size</td> +<td><code>stack_size</code></td> <td>Size of the aforementioned stack (in units of os_stack_t)</td> </tr> <tr> -<td>max_input_length</td> +<td><code>max_input_length</code></td> <td>the maximum expected length of line for input</td> </tr> </tbody> @@ -582,17 +593,17 @@ <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]; +<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>]; -int -main(int argc, char **argv) +<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>) { .... - shell_task_init(SHELL_TASK_PRIO, shell_stack, SHELL_TASK_STACK_SIZE, - SHELL_MAX_INPUT_LEN); + <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> @@ -621,34 +632,22 @@ main(int argc, char **argv) </li> </ul> </div> - <div class="row"> - <footer> - <div class="row"> - <div class="col-md-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.<br>The Apache Software Foundation Apache Incubator</p> - - </div> - </div> - <div class="copyright-logos"> - <div class="row"> - <div class="col-xs-6 text-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </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="row"> - <div class="col-md-12"> + <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>
