You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/11/14 23:59:18 UTC
[24/56] [partial] incubator-mynewt-site git commit: Deploying changes
introduced in landingFormat branch
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/modules/console/console/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/console/console/index.html b/develop/os/modules/console/console/index.html
index 98a6788..082d0d2 100644
--- a/develop/os/modules/console/console/index.html
+++ b/develop/os/modules/console/console/index.html
@@ -10,15 +10,14 @@
<link rel="canonical" href="http://mynewt.apache.org/os/modules/console/console/"> -->
<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,11 +513,13 @@
</ul>
</div>
- </div>
</div>
<h1 id="console">Console</h1>
-<p>The console is an operating system window where users interact with system programs of the operating system or a console application by entering text input (typically from a keyboard) and reading text output (typically on the computer terminal or monitor). The text written on the console brings some information and is a sequence of characters sent by the OS or programs running on the OS. </p>
+<p>The console is an operating system window where users interact with system programs of the operating system
+or a console application by entering text input (typically from a keyboard) and reading text output
+(typically on the computer terminal or monitor). The text written on the console brings some information
+and is a sequence of characters sent by the OS or programs running on the OS. </p>
<p>Support is currently available for console access via the serial port on the hardware board.</p>
<h3 id="description">Description</h3>
<p>In the Mynewt OS, the console library comes in two versions:</p>
@@ -513,8 +527,9 @@
<li>full - containing the full implementation</li>
<li>stub - containing stubs for the API</li>
</ul>
-<p>Both of these have <code>pkg.yml</code> file which states that they provide the <code>console</code> API. If a pkg uses this API, it should list <code>console</code> as a requirement.
-For example, the shell pkg is defined by the following pkg.yml file:</p>
+<p>Both of these have a <code>pkg.yml</code> file which states that they provide the <code>console</code> API. If a pkg uses
+this API, it should list <code>console</code> as a requirement. For example, the shell pkg is defined by the
+following pkg.yml file:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> pkg.name: libs/shell
pkg.vers: 0.1
pkg.deps:
@@ -528,8 +543,14 @@ For example, the shell pkg is defined by the following pkg.yml file:</p>
<p>The project .yml file decides which version of the console pkg should be included.
-If project requires the full console capability it lists dependency <code>libs/console/full</code> in its pkg.yml file. On the other hand, a project may not have a physical console (e.g. a UART port to connect a terminal to) but may have a dependency on a pkg that has console capability. In that case you would use a console stub. </p>
-<p>Another example would be the bootloader project where we want to keep the size of the image small. It includes the <code>libs/os</code> pkg that can print out messages on a console (e.g. if there is a hard fault) and the <code>libs/util</code> pkg that uses full console (but only if SHELL is present to provide a CLI). However, we do not want to use any console I/O capability in this particular bootloader project to keep the size small. We simply use the console stub instead, and the pkg.yml file for the project boot pkg looks like the following:</p>
+If a project requires the full console capability it lists dependency <code>libs/console/full</code> in its pkg.yml
+file. On the other hand, a project may not have a physical console (e.g. a UART port to connect a terminal to)
+but may have a dependency on a pkg that has console capability. In that case you would use a console stub. </p>
+<p>Another example would be the bootloader project where we want to keep the size of the image small. It includes
+the <code>libs/os</code> pkg that can print out messages on a console (e.g. if there is a hard fault) and the <code>libs/util</code>
+pkg that uses the full console (but only if SHELL is present to provide a CLI). However, we do not want to use
+any console I/O capability in this particular bootloader project to keep the size small. We simply use the console
+stub instead, and the pkg.yml file for the project boot pkg looks like the following:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> project.name: boot
project.identities: bootloader
project.pkgs:
@@ -541,9 +562,15 @@ If project requires the full console capability it lists dependency <code>libs/c
</pre></div>
-<p>Console has 2 modes for transmit; <em>blocking mode</em> and <em>non-blocking mode</em>. Usually the <em>non-blocking mode</em> is the active one; the output buffer is drained by getting TX completion interrupts from hardware, and more data is added based on these interrupts.
-<em>Blocking mode</em> is used when we don't want TX completion interrupts. It is used when system crashes, and we still want to output info related to that crash.</p>
-<p>Console, by default, echoes everything it receives back. Terminal programs expect this, and is a way for the user to know that the console is connected and responsive. Whether echoing happens or not can be controlled programmatically.</p>
+<p>Console has 2 modes for transmit; <em>blocking mode</em> and <em>non-blocking mode</em>. Usually the <em>non-blocking mode</em> is the
+active one; the output buffer is drained by getting TX completion interrupts from hardware, and more data is added
+based on these interrupts.</p>
+<p><em>Blocking mode</em> is used when we don't want TX completion interrupts. It is used when system crashes, and we still
+want to output info related to that crash.</p>
+<p>Console, by default, echoes everything it receives back. Terminal programs expect this, and is a way for the user to
+know that the console is connected and responsive. Whether echoing happens or not can be controlled programmatically.</p>
+<p>The Console also has a prompt that is configurable. It is off by default but can be turned on programatically. The
+prompt cahracter can also be changed by the user.</p>
<h3 id="data-structures">Data structures</h3>
<p>N/A</p>
<h3 id="list-of-functions">List of Functions</h3>
@@ -611,34 +638,22 @@ If project requires the full console capability it lists dependency <code>libs/c
</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/console/console_blocking_mode/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/console/console_blocking_mode/index.html b/develop/os/modules/console/console_blocking_mode/index.html
index d434b2c..ad6d7e0 100644
--- a/develop/os/modules/console/console_blocking_mode/index.html
+++ b/develop/os/modules/console/console_blocking_mode/index.html
@@ -10,15 +10,14 @@
<link rel="canonical" href="http://mynewt.apache.org/os/modules/console/console_blocking_mode/"> -->
<link rel="shortcut icon" href="../../../../img/favicon.ico">
- <title>console_blocking_mode - Apache Mynewt</title>
+ <title>console_blocking_mode - 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="console_blocking_mode">
+ <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 @@
+
+
+
+
@@ -536,14 +553,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>
@@ -563,34 +575,34 @@
</ul>
</div>
- </div>
</div>
<h2 id="console_blocking_mode"><font color="#F2853F" style="font-size:24pt"> console_blocking_mode </font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> void
- console_blocking_mode(void)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span> <span style="color: #000000">console_blocking_mode</span>(<span style="color: #A90D91">void</span>)
</pre></div>
-<p>Calls the <code>console_blocking_tx</code> function to flush the buffered console output (transmit) queue. The function <code>OS_ENTER_CRITICAL()</code> is called to disable interrupts and <code>OS_EXIT_CRITICAL()</code> is called to enable interrupts back again once the buffer is flushed.</p>
+<p>Calls the <code>console_blocking_tx</code> function to flush the buffered console output (transmit) queue.
+The function <code>OS_ENTER_CRITICAL()</code> is called to disable interrupts and <code>OS_EXIT_CRITICAL()</code>
+is called to enable interrupts back again once the buffer is flushed.</p>
<h4 id="arguments">Arguments</h4>
<p>None</p>
<h4 id="returned-values">Returned values</h4>
<p>N/A</p>
<h4 id="example">Example</h4>
<p>Here is an example of calling <code>console_blocking_mode</code> and printing crash information from an assert to help debug.</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">void
-_assert_func(const char *file, int line, const char *func, const char *e)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span>
+<span style="color: #000000">_assert_func</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*file</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">line</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*func</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*e</span>)
{
- int sr;
-
- OS_ENTER_CRITICAL(sr);
- (void)sr;
- os_die_line = line;
- os_die_module = file;
- console_blocking_mode();
- console_printf("Assert %s; failed in %s:%d\n", e ? e : "", file, line);
- system_reset();
+ <span style="color: #A90D91">int</span> <span style="color: #000000">sr</span>;
+
+ <span style="color: #000000">OS_ENTER_CRITICAL</span>(<span style="color: #000000">sr</span>);
+ (<span style="color: #A90D91">void</span>)<span style="color: #000000">sr</span>;
+ <span style="color: #000000">os_die_line</span> <span style="color: #000000">=</span> <span style="color: #000000">line</span>;
+ <span style="color: #000000">os_die_module</span> <span style="color: #000000">=</span> <span style="color: #000000">file</span>;
+ <span style="color: #000000">console_blocking_mode</span>();
+ <span style="color: #000000">console_printf</span>(<span style="color: #C41A16">"Assert %s; failed in %s:%d\n"</span>, <span style="color: #000000">e</span> <span style="color: #000000">?</span> <span style="color: #000000">e</span> : <span style="color: #C41A16">""</span>, <span style="color: #000000">file</span>, <span style="color: #000000">line</span>);
+ <span style="color: #000000">system_reset</span>();
}
</pre></div>
@@ -618,34 +630,22 @@ _assert_func(const char *file, int line, const char *func, const char *e)
</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/console/console_echo/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/console/console_echo/index.html b/develop/os/modules/console/console_echo/index.html
index 007a475..27e874e 100644
--- a/develop/os/modules/console/console_echo/index.html
+++ b/develop/os/modules/console/console_echo/index.html
@@ -10,15 +10,14 @@
<link rel="canonical" href="http://mynewt.apache.org/os/modules/console/console_echo/"> -->
<link rel="shortcut icon" href="../../../../img/favicon.ico">
- <title>console_echo - Apache Mynewt</title>
+ <title>console_echo - 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="console_echo">
+ <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 @@
+
+
+
+
@@ -536,14 +553,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>
@@ -563,11 +575,10 @@
</ul>
</div>
- </div>
</div>
<h2 id="console_echo"><font color="#F2853F" style="font-size:24pt"> console_echo </font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> void console_echo(int on)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span> <span style="color: #000000">console_echo</span>(<span style="color: #A90D91">int</span> <span style="color: #000000">on</span>)
</pre></div>
@@ -582,7 +593,7 @@
</thead>
<tbody>
<tr>
-<td>on</td>
+<td><code>on</code></td>
<td>1 turns on echoing, 0 turns it off</td>
</tr>
</tbody>
@@ -590,36 +601,38 @@
<h4 id="returned-values">Returned values</h4>
<p>None</p>
<h4 id="notes">Notes</h4>
+<p>None</p>
<h4 id="example">Example</h4>
-<p>Here is an example where newtmgr protocol handler is controlling whether echoing is on or off. Newtmgr, the tool, turns echoing off when it's transmitting large chunks of data to target board.</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">static int
-nmgr_def_console_echo(struct nmgr_jbuf *njb)
+<p>Here is an example where newtmgr protocol handler is controlling whether echoing is on or off. <a href="../../../../newtmgr/overview/">Newtmgr</a>
+turns echoing off when it is transmitting large chunks of data to a target board.</p>
+<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_def_console_echo</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">nmgr_jbuf</span> <span style="color: #000000">*njb</span>)
{
- int echo_on = 1;
- int rc;
- struct json_attr_t attrs[3] = {
- [0] = {
- .attribute = "echo",
- .type = t_integer,
- .addr.integer = &echo_on,
- .nodefault = 1
+ <span style="color: #A90D91">int</span> <span style="color: #000000">echo_on</span> <span style="color: #000000">=</span> <span style="color: #1C01CE">1</span>;
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
+ <span style="color: #A90D91">struct</span> <span style="color: #A90D91">json_attr_t</span> <span style="color: #000000">attrs</span>[<span style="color: #1C01CE">3</span>] <span style="color: #000000">=</span> {
+ [<span style="color: #1C01CE">0</span>] <span style="color: #000000">=</span> {
+ .<span style="color: #000000">attribute</span> <span style="color: #000000">=</span> <span style="color: #C41A16">"echo"</span>,
+ .<span style="color: #000000">type</span> <span style="color: #000000">=</span> <span style="color: #000000">t_integer</span>,
+ .<span style="color: #000000">addr</span>.<span style="color: #000000">integer</span> <span style="color: #000000">=</span> <span style="color: #000000">&echo_on</span>,
+ .<span style="color: #000000">nodefault</span> <span style="color: #000000">=</span> <span style="color: #1C01CE">1</span>
},
- [1] = {
- .attribute = NULL
+ [<span style="color: #1C01CE">1</span>] <span style="color: #000000">=</span> {
+ .<span style="color: #000000">attribute</span> <span style="color: #000000">=</span> <span style="color: #A90D91">NULL</span>
}
};
- rc = json_read_object(&njb->njb_buf, attrs);
- if (rc) {
- return OS_EINVAL;
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">json_read_object</span>(<span style="color: #000000">&njb->njb_buf</span>, <span style="color: #000000">attrs</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span>) {
+ <span style="color: #A90D91">return</span> <span style="color: #000000">OS_EINVAL</span>;
}
- if (echo_on) {
- console_echo(1);
- } else {
- console_echo(0);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">echo_on</span>) {
+ <span style="color: #000000">console_echo</span>(<span style="color: #1C01CE">1</span>);
+ } <span style="color: #A90D91">else</span> {
+ <span style="color: #000000">console_echo</span>(<span style="color: #1C01CE">0</span>);
}
- return (0);
+ <span style="color: #A90D91">return</span> (<span style="color: #1C01CE">0</span>);
}
</pre></div>
@@ -647,34 +660,22 @@ nmgr_def_console_echo(struct nmgr_jbuf *njb)
</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/console/console_init/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/console/console_init/index.html b/develop/os/modules/console/console_init/index.html
index 54d398c..207e0fd 100644
--- a/develop/os/modules/console/console_init/index.html
+++ b/develop/os/modules/console/console_init/index.html
@@ -10,15 +10,14 @@
<link rel="canonical" href="http://mynewt.apache.org/os/modules/console/console_init/"> -->
<link rel="shortcut icon" href="../../../../img/favicon.ico">
- <title>console_init - Apache Mynewt</title>
+ <title>console_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="console_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 @@
+
+
+
+
@@ -536,14 +553,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>
@@ -563,17 +575,18 @@
</ul>
</div>
- </div>
</div>
<h2 id="console_init"><font color="#F2853F" style="font-size:24pt"> console_init </font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> int
- console_init(console_rx_cb rx_cb)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">console_init</span>(<span style="color: #000000">console_rx_cb</span> <span style="color: #000000">rx_cb</span>)
</pre></div>
-<p>Initializes console receive buffer and calls hal funtions <code>hal_uart_init_cbs</code> and <code>hal_uart_config</code> to initialize serial port connection and configure it (e.g. baud rate, flow control etc.)</p>
-<p>Caller registers a function pointer of <code>type void (*console_rx_cb)(int full_line)</code>. This function will be called when console receives either a) full line of data or b) when RX buffer in console is full. Note that this function is most likely getting called from interrupt context.</p>
+<p>Initializes the console receive buffer and calls hal funtions <code>hal_uart_init_cbs</code> and <code>hal_uart_config</code> to
+initialize the serial port connection and configure it (e.g. baud rate, flow control etc.)</p>
+<p>Caller registers a function pointer of <code>type void (*console_rx_cb)(int full_line)</code>. This function will be
+called when the console receives either a) full line of data or b) when RX buffer in console is full.
+Note that this function is most likely getting called from an interrupt context.</p>
<h4 id="arguments">Arguments</h4>
<table>
<thead>
@@ -584,8 +597,8 @@
</thead>
<tbody>
<tr>
-<td>rx_cb</td>
-<td>Function pointer, which gets called input is received.</td>
+<td><code>rx_cb</code></td>
+<td>Function pointer, which gets called when input is received.</td>
</tr>
</tbody>
</table>
@@ -593,15 +606,15 @@
<p>Returns 0 on success.
Non-zero if HAL UART function calls fail.</p>
<h4 id="example">Example</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int
-main(int argc, char **argv)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><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>)
{
....
- /* Init tasks */
- shell_task_init(SHELL_TASK_PRIO, shell_stack, SHELL_TASK_STACK_SIZE,
- SHELL_MAX_INPUT_LEN);
- console_init(shell_console_rx_cb);
+ <span style="color: #177500">/* Init tasks */</span>
+ <span style="color: #000000">shell_task_init</span>(<span style="color: #000000">SHELL_TASK_PRIO</span>, <span style="color: #000000">shell_stack</span>, <span style="color: #000000">SHELL_TASK_STACK_SIZE</span>,
+ <span style="color: #000000">SHELL_MAX_INPUT_LEN</span>);
+ <span style="color: #000000">console_init</span>(<span style="color: #000000">shell_console_rx_cb</span>);
....
}
@@ -631,34 +644,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>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/modules/console/console_is_init/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/console/console_is_init/index.html b/develop/os/modules/console/console_is_init/index.html
index eddc6b9..e505ff2 100644
--- a/develop/os/modules/console/console_is_init/index.html
+++ b/develop/os/modules/console/console_is_init/index.html
@@ -10,15 +10,14 @@
<link rel="canonical" href="http://mynewt.apache.org/os/modules/console/console_is_init/"> -->
<link rel="shortcut icon" href="../../../../img/favicon.ico">
- <title>console_is_init - Apache Mynewt</title>
+ <title>console_is_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="console_is_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 @@
+
+
+
+
@@ -536,14 +553,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>
@@ -563,11 +575,10 @@
</ul>
</div>
- </div>
</div>
<h2 id="console_is_init"><font color="#F2853F" style="font-size:24pt"> console_is_init </font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> int console_is_init(void)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">console_is_init</span>(<span style="color: #A90D91">void</span>)
</pre></div>
@@ -577,16 +588,16 @@
<h4 id="returned-values">Returned values</h4>
<p>Returns 1 if console has been initialized. 0 if not.</p>
<h4 id="example">Example</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">static int
-log_console_append(struct log *log, void *buf, int len)
+<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">log_console_append</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">log</span> <span style="color: #000000">*log</span>, <span style="color: #A90D91">void</span> <span style="color: #000000">*buf</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">len</span>)
{
....
- if (!console_is_init()) {
- return (0);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">!console_is_init</span>()) {
+ <span style="color: #A90D91">return</span> (<span style="color: #1C01CE">0</span>);
}
- /* print log entry to console */
+ <span style="color: #177500">/* print log entry to console */</span>
....
}
</pre></div>
@@ -615,34 +626,22 @@ log_console_append(struct log *log, void *buf, int 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/console/console_printf/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/console/console_printf/index.html b/develop/os/modules/console/console_printf/index.html
index 9d7ccfd..ce05d23 100644
--- a/develop/os/modules/console/console_printf/index.html
+++ b/develop/os/modules/console/console_printf/index.html
@@ -10,15 +10,14 @@
<link rel="canonical" href="http://mynewt.apache.org/os/modules/console/console_printf/"> -->
<link rel="shortcut icon" href="../../../../img/favicon.ico">
- <title>console_printf - Apache Mynewt</title>
+ <title>console_printf - 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="console_printf">
+ <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 @@
+
+
+
+
@@ -536,14 +553,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>
@@ -563,16 +575,17 @@
</ul>
</div>
- </div>
</div>
<h2 id="console_printf"><font color="F2853F" style="font-size:24pt"> console_printf</font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> void
- console_printf(const char *fmt, ...)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span> <span style="color: #000000">console_printf</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*fmt</span>, ...)
</pre></div>
-<p>Writes a formatted message instead of raw output to the console. It first composes a C string containing text specified as arguments to the function or containing the elements in the variable argument list passed to it using snprintf or vsnprintf, respectively. It then uses function <code>console_write</code> to output the formatted data (messages) on the console.</p>
+<p>Writes a formatted message instead of raw output to the console. It first composes a C string containing
+the text specified as arguments to the function or containing the elements in the variable argument list
+passed to it using <code>snprintf</code> or <code>vsnprintf</code>, respectively. It then uses the function <code>console_write</code> to
+output the formatted data (messages) on the console.</p>
<h4 id="arguments">Arguments</h4>
<table>
<thead>
@@ -583,49 +596,50 @@
</thead>
<tbody>
<tr>
-<td>fmt</td>
+<td><code>fmt</code></td>
<td>Pointer to C string that contains a format string that follows the same specifications as format in printf. The string is printed to console.</td>
</tr>
<tr>
<td>...</td>
-<td>Depending on the format string, the function may expect either a sequence of additional arguments to be used to replace a format specifier in the format string or a variable arguments list. va_list is a special type defined in <cstdarg> in stdarg.h.</td>
+<td>Depending on the format string, the function may expect either a sequence of additional arguments to be used to replace a format specifier in the format string or a variable arguments list. <code>va_list</code> is a special type defined in <cstdarg> in <code>stdarg.h</code>.</td>
</tr>
</tbody>
</table>
<h4 id="returned-values">Returned values</h4>
<p>None</p>
<h4 id="notes">Notes</h4>
-<p>While <code>console_printf</code>, with its well understood formatting options in C, is more convenient and easy on the eyes than the raw output of <code>console_write</code>, the associated code size is considerably larger.</p>
+<p>While <code>console_printf</code>, with its well understood formatting options in C, is more convenient and easy on the
+eyes than the raw output of <code>console_write</code>, the associated code size is considerably larger.</p>
<h4 id="example">Example</h4>
<p>Example #1:</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">char adv_data_buf[32];
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">char</span> <span style="color: #000000">adv_data_buf</span>[<span style="color: #1C01CE">32</span>];
-void
-task()
+<span style="color: #A90D91">void</span>
+<span style="color: #000000">task</span>()
{
- char adv_data_buf[32];
+ <span style="color: #A90D91">char</span> <span style="color: #000000">adv_data_buf</span>[<span style="color: #1C01CE">32</span>];
- console_printf("%s", adv_data_buf);
+ <span style="color: #000000">console_printf</span>(<span style="color: #C41A16">"%s"</span>, <span style="color: #000000">adv_data_buf</span>);
}
</pre></div>
<p>Example #2:</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">struct exception_frame {
- uint32_t r0;
- uint32_t r1;
-
-struct trap_frame {
- struct exception_frame *ef;
- uint32_t r2;
- uint32_t r3;
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">struct</span> <span style="color: #000000">exception_frame</span> {
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">r0</span>;
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">r1</span>;
+
+<span style="color: #A90D91">struct</span> <span style="color: #000000">trap_frame</span> {
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">exception_frame</span> <span style="color: #000000">*ef</span>;
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">r2</span>;
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">r3</span>;
};
-void
-task(struct trap_frame *tf)
+<span style="color: #A90D91">void</span>
+<span style="color: #000000">task</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">trap_frame</span> <span style="color: #000000">*tf</span>)
{
- console_printf(" r0:%8.8x r1:%8.8x", tf->ef->r0, tf->ef->r1);
- console_printf(" r8:%8.8x r9:%8.8x", tf->r2, tf->r3);
+ <span style="color: #000000">console_printf</span>(<span style="color: #C41A16">" r0:%8.8x r1:%8.8x"</span>, <span style="color: #000000">tf->ef->r0</span>, <span style="color: #000000">tf->ef->r1</span>);
+ <span style="color: #000000">console_printf</span>(<span style="color: #C41A16">" r8:%8.8x r9:%8.8x"</span>, <span style="color: #000000">tf->r2</span>, <span style="color: #000000">tf->r3</span>);
}
</pre></div>
@@ -653,34 +667,22 @@ task(struct trap_frame *tf)
</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/console/console_read/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/console/console_read/index.html b/develop/os/modules/console/console_read/index.html
index c68595e..8dcfaed 100644
--- a/develop/os/modules/console/console_read/index.html
+++ b/develop/os/modules/console/console_read/index.html
@@ -10,15 +10,14 @@
<link rel="canonical" href="http://mynewt.apache.org/os/modules/console/console_read/"> -->
<link rel="shortcut icon" href="../../../../img/favicon.ico">
- <title>console_read - Apache Mynewt</title>
+ <title>console_read - 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="console_read">
+ <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 @@
+
+
+
+
@@ -536,14 +553,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>
@@ -563,16 +575,15 @@
</ul>
</div>
- </div>
</div>
<h2 id="console_read"><font color="#F2853F" style="font-size:24pt"> console_read </font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> int
- console_read(char *str, int cnt)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">console_read</span>(<span style="color: #A90D91">char</span> <span style="color: #000000">*str</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">cnt</span>)
</pre></div>
-<p>Copies up to <em>cnt</em> bytes of received data to buffer pointed by <em>str</em>. Function tries to break the input into separate lines; once it encounters a newline character, it replaces that with end-of-string and returns.</p>
+<p>Copies up to <code>cnt</code> bytes of received data to buffer pointed by <code>str</code>. Function tries to break the input into
+separate lines; once it encounters a newline character, it replaces that with end-of-string and returns.</p>
<h4 id="arguments">Arguments</h4>
<table>
<thead>
@@ -583,11 +594,11 @@
</thead>
<tbody>
<tr>
-<td>str</td>
+<td><code>str</code></td>
<td>Buffer where data is copied to.</td>
</tr>
<tr>
-<td>cnt</td>
+<td><code>cnt</code></td>
<td>Maximum number of characters to copy.</td>
</tr>
</tbody>
@@ -596,22 +607,26 @@
<p>Returns the number of characters copied. 0 if there was no data
available, or if the first received character was '\n'.</p>
<h4 id="example">Example</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">void
-task1_loop(void *arg)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span>
+<span style="color: #000000">task1_loop</span>(<span style="color: #A90D91">void</span> <span style="color: #000000">*arg</span>)
{
- struct os_event *ev;
- char rx_msg[128];
- int rx_len;
-
- while (1) {
- ev = os_eventq_get(&task1_evq);
- assert(ev);
- if (ev->ev_type == CONS_EV_TYPE) {
- rx_len = console_read(rx_msg, sizeof(rx_msg));
- if (rx_len) {
- if (!strncmp(rx_msg, "reset", rx_len)) {
- assert(0);
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">os_event</span> <span style="color: #000000">*ev</span>;
+ <span style="color: #A90D91">char</span> <span style="color: #000000">rx_msg</span>[<span style="color: #1C01CE">128</span>];
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rx_len</span>;
+
+ <span style="color: #A90D91">while</span> (<span style="color: #1C01CE">1</span>) {
+ <span style="color: #000000">ev</span> <span style="color: #000000">=</span> <span style="color: #000000">os_eventq_get</span>(<span style="color: #000000">&task1_evq</span>);
+ <span style="color: #000000">assert</span>(<span style="color: #000000">ev</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">ev->ev_type</span> <span style="color: #000000">==</span> <span style="color: #000000">CONS_EV_TYPE</span>) {
+ <span style="color: #000000">rx_len</span> <span style="color: #000000">=</span> <span style="color: #000000">console_read</span>(<span style="color: #000000">rx_msg</span>, <span style="color: #A90D91">sizeof</span>(<span style="color: #000000">rx_msg</span>));
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rx_len</span>) {
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">!strncmp</span>(<span style="color: #000000">rx_msg</span>, <span style="color: #C41A16">"reset"</span>, <span style="color: #000000">rx_len</span>)) {
+ <span style="color: #000000">assert</span>(<span style="color: #1C01CE">0</span>);
}
+ }
+ }
+ }
+}
</pre></div>
<div class="row">
@@ -638,34 +653,22 @@ task1_loop(void *arg)
</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/console/console_write/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/console/console_write/index.html b/develop/os/modules/console/console_write/index.html
index ea8a1c1..1af8de0 100644
--- a/develop/os/modules/console/console_write/index.html
+++ b/develop/os/modules/console/console_write/index.html
@@ -10,15 +10,14 @@
<link rel="canonical" href="http://mynewt.apache.org/os/modules/console/console_write/"> -->
<link rel="shortcut icon" href="../../../../img/favicon.ico">
- <title>console_write - Apache Mynewt</title>
+ <title>console_write - 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="console_write">
+ <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 @@
+
+
+
+
@@ -536,14 +553,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>
@@ -563,12 +575,10 @@
</ul>
</div>
- </div>
</div>
<h2 id="console_write"><font color="#F2853F" style="font-size:24pt"> console_write </font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> void
- console_write(char *str, int cnt)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span> <span style="color: #000000">console_write</span>(<span style="color: #A90D91">char</span> <span style="color: #000000">*str</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">cnt</span>)
</pre></div>
@@ -583,12 +593,12 @@
</thead>
<tbody>
<tr>
-<td>*str</td>
+<td><code>*str</code></td>
<td>pointer to the character or packet to be transmitted</td>
</tr>
<tr>
-<td>cnt</td>
-<td>number of characters in <em>str</em></td>
+<td><code>cnt</code></td>
+<td>number of characters in <code>str</code></td>
</tr>
</tbody>
</table>
@@ -596,18 +606,18 @@
<p>N/A</p>
<h4 id="example">Example</h4>
<p>Here is an example of the function being used in an echo command with a newline at the end.</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">static int
-shell_echo_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">shell_echo_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>)
{
- int i;
+ <span style="color: #A90D91">int</span> <span style="color: #000000">i</span>;
- for (i = 1; i < argc; i++) {
- console_write(argv[i], strlen(argv[i]));
- console_write(" ", sizeof(" ")-1);
+ <span style="color: #A90D91">for</span> (<span style="color: #000000">i</span> <span style="color: #000000">=</span> <span style="color: #1C01CE">1</span>; <span style="color: #000000">i</span> <span style="color: #000000"><</span> <span style="color: #000000">argc</span>; <span style="color: #000000">i++</span>) {
+ <span style="color: #000000">console_write</span>(<span style="color: #000000">argv</span>[<span style="color: #000000">i</span>], <span style="color: #000000">strlen</span>(<span style="color: #000000">argv</span>[<span style="color: #000000">i</span>]));
+ <span style="color: #000000">console_write</span>(<span style="color: #C41A16">" "</span>, <span style="color: #A90D91">sizeof</span>(<span style="color: #C41A16">" "</span>)<span style="color: #000000">-</span><span style="color: #1C01CE">1</span>);
}
- console_write("\n", sizeof("\n")-1);
+ <span style="color: #000000">console_write</span>(<span style="color: #C41A16">"\n"</span>, <span style="color: #A90D91">sizeof</span>(<span style="color: #C41A16">"\n"</span>)<span style="color: #000000">-</span><span style="color: #1C01CE">1</span>);
- return (0);
+ <span style="color: #A90D91">return</span> (<span style="color: #1C01CE">0</span>);
}
</pre></div>
@@ -635,34 +645,22 @@ shell_echo_cmd(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>