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/05/20 07:35:51 UTC
[08/51] [partial] incubator-mynewt-site git commit: Changed landing
page, main banner, secondary banner, events, community,
added Quick start nav link, collapsed documentation hierarchy
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/modules/console/console_write/index.html
----------------------------------------------------------------------
diff --git a/os/modules/console/console_write/index.html b/os/modules/console/console_write/index.html
index d83a3ed..44483ab 100644
--- a/os/modules/console/console_write/index.html
+++ b/os/modules/console/console_write/index.html
@@ -16,6 +16,7 @@
<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 rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href="../../../../extra.css" rel="stylesheet">
@@ -43,11 +44,10 @@
<body class="console_write">
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
@@ -64,75 +64,37 @@
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
- <li>
+ <li
+ class=""
+>
<a href="/">Home</a>
</li>
- <li>
- <a href="/about/">About</a>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
</li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../faq/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
</li>
<li>
+ <a href="/os/introduction/">Documentation</a>
+ </li>
+ <li
+ class=""
+>
<a href="/download/">Download</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/community/">Community</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/events/">Events</a>
</li>
</ul>
@@ -142,27 +104,26 @@
</ul>
</div>
- # </div>
-</div>
+ </div>
+</nav>
- <div class="container-fluid">
+ <div class="container">
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div 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 class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
- <ul class="nav bs-sidenav">
+ <ul class="toc-nav">
@@ -180,42 +141,29 @@
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
-
-
- <ul class="current-toc">
-
-
-
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
+ <ul>
+
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
-
- </li>
+
+ </li>
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
@@ -223,10 +171,10 @@
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
-
- </li>
+
+ </li>
@@ -234,10 +182,10 @@
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -245,10 +193,10 @@
- <li ><a href="../../../core_os/mynewt_os/">OS Core</a></li>
+ <li ><a href="../../../core_os/mynewt_os/">OS Core</a>
-
- </li>
+
+ </li>
@@ -256,10 +204,10 @@
- <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a></li>
+ <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a>
-
- </li>
+
+ </li>
@@ -267,10 +215,10 @@
- <li ><a href="../console/">Console</a></li>
+ <li ><a href="../console/">Console</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -282,88 +230,74 @@
../console_blocking_mode/
">Functions</a>
-
- <ul class="current-toc">
+
+ <ul>
-
- <li>
+ <li >
<a href="../console_blocking_mode/">console_blocking_mode</a>
</li>
-
-
- <li>
+ <li >
<a href="../console_echo/">console_echo</a>
</li>
-
-
- <li>
+ <li >
<a href="../console_init/">console_init</a>
</li>
-
-
- <li>
+ <li >
<a href="../console_is_init/">console_is_init</a>
</li>
-
-
- <li>
+ <li >
<a href="../console_printf/">console_printf</a>
</li>
-
-
- <li>
+ <li >
<a href="../console_read/">console_read</a>
</li>
-
-
<li class="active">
- console_write
+ <a href="./">console_write</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -371,10 +305,10 @@
- <li ><a href="../../shell/shell/">Shell</a></li>
+ <li ><a href="../../shell/shell/">Shell</a>
-
- </li>
+
+ </li>
@@ -382,10 +316,10 @@
- <li ><a href="../../bootloader/bootloader/">Bootloader</a></li>
+ <li ><a href="../../bootloader/bootloader/">Bootloader</a>
-
- </li>
+
+ </li>
@@ -400,8 +334,8 @@
">File System</a>
-
- </li>
+
+ </li>
@@ -409,10 +343,10 @@
- <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -420,10 +354,10 @@
- <li ><a href="../../testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -431,20 +365,18 @@
- <li ><a href="../../imgmgr/imgmgr/">Image Manager</a></li>
+ <li ><a href="../../imgmgr/imgmgr/">Image Manager</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../../baselibc/">Baselibc library</a>
</li>
-
@@ -452,10 +384,10 @@
- <li ><a href="../../elua/elua/">Embedded Lua</a></li>
+ <li ><a href="../../elua/elua/">Embedded Lua</a>
-
- </li>
+
+ </li>
@@ -463,10 +395,10 @@
- <li ><a href="../../json/json/">JSON</a></li>
+ <li ><a href="../../json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -474,10 +406,10 @@
- <li ><a href="../../stats/stats/">Stats</a></li>
+ <li ><a href="../../stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -485,16 +417,16 @@
- <li ><a href="../../logs/logs/">Logs</a></li>
+ <li ><a href="../../logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -506,40 +438,36 @@
../../../../network/ble/ble_intro/
">BLE User Guide</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
-
-
-
-
-
+
+
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
-
- </li>
+
+ </li>
-
-
-
+
+
+
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
-
- </li>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
@@ -551,8 +479,8 @@
../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -563,45 +491,11 @@
<button class="show-sidebar">Docs Menu</button>
</div>
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
+ <div class="col-md-9" role="main">
<div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
+ <div class="col-sm-12">
<div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
+ <ul class="wy-breadcrumbs pull-right">
<li><a href="/documentation/">Docs</a></li>
@@ -623,14 +517,14 @@
</div>
</div>
- <h2 id="console_write"><font color="#F2853F" style="font-size:24pt"> console_write </font><a class="headerlink" href="#console_write" title="Permanent link">¶</a></h2>
+ <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)
</pre></div>
<p>Queues characters to console display over serial port.</p>
-<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<h4 id="arguments">Arguments</h4>
<table>
<thead>
<tr>
@@ -649,9 +543,9 @@
</tr>
</tbody>
</table>
-<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<h4 id="returned-values">Returned values</h4>
<p>N/A</p>
-<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<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)
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/modules/elua/elua/index.html
----------------------------------------------------------------------
diff --git a/os/modules/elua/elua/index.html b/os/modules/elua/elua/index.html
index 0b22387..c080835 100644
--- a/os/modules/elua/elua/index.html
+++ b/os/modules/elua/elua/index.html
@@ -16,6 +16,7 @@
<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 rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href="../../../../extra.css" rel="stylesheet">
@@ -43,11 +44,10 @@
<body class="toc">
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
@@ -64,75 +64,37 @@
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
- <li>
+ <li
+ class=""
+>
<a href="/">Home</a>
</li>
- <li>
- <a href="/about/">About</a>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
</li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../faq/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
</li>
<li>
+ <a href="/os/introduction/">Documentation</a>
+ </li>
+ <li
+ class=""
+>
<a href="/download/">Download</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/community/">Community</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/events/">Events</a>
</li>
</ul>
@@ -142,27 +104,26 @@
</ul>
</div>
- # </div>
-</div>
+ </div>
+</nav>
- <div class="container-fluid">
+ <div class="container">
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div 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 class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
- <ul class="nav bs-sidenav">
+ <ul class="toc-nav">
@@ -180,42 +141,29 @@
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
-
-
- <ul class="current-toc">
-
-
-
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
+ <ul>
+
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
-
- </li>
+
+ </li>
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
@@ -223,10 +171,10 @@
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
-
- </li>
+
+ </li>
@@ -234,10 +182,10 @@
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -245,10 +193,10 @@
- <li ><a href="../../../core_os/mynewt_os/">OS Core</a></li>
+ <li ><a href="../../../core_os/mynewt_os/">OS Core</a>
-
- </li>
+
+ </li>
@@ -256,10 +204,10 @@
- <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a></li>
+ <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a>
-
- </li>
+
+ </li>
@@ -267,10 +215,10 @@
- <li ><a href="../../console/console/">Console</a></li>
+ <li ><a href="../../console/console/">Console</a>
-
- </li>
+
+ </li>
@@ -278,10 +226,10 @@
- <li ><a href="../../shell/shell/">Shell</a></li>
+ <li ><a href="../../shell/shell/">Shell</a>
-
- </li>
+
+ </li>
@@ -289,10 +237,10 @@
- <li ><a href="../../bootloader/bootloader/">Bootloader</a></li>
+ <li ><a href="../../bootloader/bootloader/">Bootloader</a>
-
- </li>
+
+ </li>
@@ -307,8 +255,8 @@
">File System</a>
-
- </li>
+
+ </li>
@@ -316,10 +264,10 @@
- <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -327,10 +275,10 @@
- <li ><a href="../../testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -338,20 +286,18 @@
- <li ><a href="../../imgmgr/imgmgr/">Image Manager</a></li>
+ <li ><a href="../../imgmgr/imgmgr/">Image Manager</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../../baselibc/">Baselibc library</a>
</li>
-
@@ -359,10 +305,10 @@
- <li class="active"><a href="./">Embedded Lua</a></li>
+ <li class="active"><a href="./">Embedded Lua</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -374,14 +320,14 @@
../lua_init/
">Functions</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -389,10 +335,10 @@
- <li ><a href="../../json/json/">JSON</a></li>
+ <li ><a href="../../json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -400,10 +346,10 @@
- <li ><a href="../../stats/stats/">Stats</a></li>
+ <li ><a href="../../stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -411,16 +357,16 @@
- <li ><a href="../../logs/logs/">Logs</a></li>
+ <li ><a href="../../logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -432,40 +378,36 @@
../../../../network/ble/ble_intro/
">BLE User Guide</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
-
-
-
-
-
+
+
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
-
- </li>
+
+ </li>
-
-
-
+
+
+
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
-
- </li>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
@@ -477,8 +419,8 @@
../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -489,45 +431,11 @@
<button class="show-sidebar">Docs Menu</button>
</div>
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
+ <div class="col-md-9" role="main">
<div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
+ <div class="col-sm-12">
<div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
+ <ul class="wy-breadcrumbs pull-right">
<li><a href="/documentation/">Docs</a></li>
@@ -547,14 +455,14 @@
</div>
</div>
- <h1 id="elua">elua<a class="headerlink" href="#elua" title="Permanent link">¶</a></h1>
-<h3 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h3>
+ <h1 id="elua">elua</h1>
+<h3 id="description">Description</h3>
<p>This package contains a Lua interpreter. See http://lua.org for documentation of the language.</p>
<p>You can execute lua scripts either from console with shell or start the execution programmatically.</p>
-<h3 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h3>
-<h3 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h3>
+<h3 id="data-structures">Data structures</h3>
+<h3 id="notes">Notes</h3>
<p>Currently we don't have language extension modules which would go together with this one, but those should be added.</p>
-<h3 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h3>
+<h3 id="list-of-functions">List of Functions</h3>
<ul>
<li><a href="../lua_init/">lua_init</a></li>
<li><a href="../lua_main/">lua_main</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/modules/elua/lua_init/index.html
----------------------------------------------------------------------
diff --git a/os/modules/elua/lua_init/index.html b/os/modules/elua/lua_init/index.html
index b32fd78..20cd113 100644
--- a/os/modules/elua/lua_init/index.html
+++ b/os/modules/elua/lua_init/index.html
@@ -16,6 +16,7 @@
<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 rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href="../../../../extra.css" rel="stylesheet">
@@ -43,11 +44,10 @@
<body class="lua_init">
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
@@ -64,75 +64,37 @@
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
- <li>
+ <li
+ class=""
+>
<a href="/">Home</a>
</li>
- <li>
- <a href="/about/">About</a>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
</li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../faq/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
</li>
<li>
+ <a href="/os/introduction/">Documentation</a>
+ </li>
+ <li
+ class=""
+>
<a href="/download/">Download</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/community/">Community</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/events/">Events</a>
</li>
</ul>
@@ -142,27 +104,26 @@
</ul>
</div>
- # </div>
-</div>
+ </div>
+</nav>
- <div class="container-fluid">
+ <div class="container">
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div 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 class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
- <ul class="nav bs-sidenav">
+ <ul class="toc-nav">
@@ -180,42 +141,29 @@
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
-
- <ul class="current-toc">
-
-
-
-
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
+ <ul>
+
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
-
- </li>
+
+ </li>
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
@@ -223,10 +171,10 @@
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
-
- </li>
+
+ </li>
@@ -234,10 +182,10 @@
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -245,10 +193,10 @@
- <li ><a href="../../../core_os/mynewt_os/">OS Core</a></li>
+ <li ><a href="../../../core_os/mynewt_os/">OS Core</a>
-
- </li>
+
+ </li>
@@ -256,10 +204,10 @@
- <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a></li>
+ <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a>
-
- </li>
+
+ </li>
@@ -267,10 +215,10 @@
- <li ><a href="../../console/console/">Console</a></li>
+ <li ><a href="../../console/console/">Console</a>
-
- </li>
+
+ </li>
@@ -278,10 +226,10 @@
- <li ><a href="../../shell/shell/">Shell</a></li>
+ <li ><a href="../../shell/shell/">Shell</a>
-
- </li>
+
+ </li>
@@ -289,10 +237,10 @@
- <li ><a href="../../bootloader/bootloader/">Bootloader</a></li>
+ <li ><a href="../../bootloader/bootloader/">Bootloader</a>
-
- </li>
+
+ </li>
@@ -307,8 +255,8 @@
">File System</a>
-
- </li>
+
+ </li>
@@ -316,10 +264,10 @@
- <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -327,10 +275,10 @@
- <li ><a href="../../testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -338,20 +286,18 @@
- <li ><a href="../../imgmgr/imgmgr/">Image Manager</a></li>
+ <li ><a href="../../imgmgr/imgmgr/">Image Manager</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../../baselibc/">Baselibc library</a>
</li>
-
@@ -359,10 +305,10 @@
- <li ><a href="../elua/">Embedded Lua</a></li>
+ <li ><a href="../elua/">Embedded Lua</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -374,38 +320,34 @@
./
">Functions</a>
-
- <ul class="current-toc">
+
+ <ul>
-
<li class="active">
- lua_init
+ <a href="./">lua_init</a>
</li>
-
-
- <li>
+ <li >
<a href="../lua_main/">lua_main</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -413,10 +355,10 @@
- <li ><a href="../../json/json/">JSON</a></li>
+ <li ><a href="../../json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -424,10 +366,10 @@
- <li ><a href="../../stats/stats/">Stats</a></li>
+ <li ><a href="../../stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -435,16 +377,16 @@
- <li ><a href="../../logs/logs/">Logs</a></li>
+ <li ><a href="../../logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -456,40 +398,36 @@
../../../../network/ble/ble_intro/
">BLE User Guide</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
-
-
-
-
-
+
+
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
-
- </li>
+
+ </li>
-
-
-
+
+
+
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
-
- </li>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
@@ -501,8 +439,8 @@
../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -513,45 +451,11 @@
<button class="show-sidebar">Docs Menu</button>
</div>
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
+ <div class="col-md-9" role="main">
<div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
+ <div class="col-sm-12">
<div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
+ <ul class="wy-breadcrumbs pull-right">
<li><a href="/documentation/">Docs</a></li>
@@ -573,20 +477,20 @@
</div>
</div>
- <h2 id="lua_init"><font color="#F2853F" style="font-size:24pt"> lua_init </font><a class="headerlink" href="#lua_init" title="Permanent link">¶</a></h2>
+ <h2 id="lua_init"><font color="#F2853F" style="font-size:24pt"> lua_init </font></h2>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> int
lua_init(void)
</pre></div>
<p>Registers 'lua' command with shell. This function should be called while initializing the project, preferably after shell itself has been initialized.</p>
-<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<h4 id="arguments">Arguments</h4>
<p>N/A</p>
-<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<h4 id="returned-values">Returned values</h4>
<p>Returns </p>
-<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<h4 id="notes">Notes</h4>
<p>Calling this is meaningful only if you include the shell package in your project.</p>
-<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<h4 id="example">Example</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int main(int argc, char **argv)
{
...
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/modules/elua/lua_main/index.html
----------------------------------------------------------------------
diff --git a/os/modules/elua/lua_main/index.html b/os/modules/elua/lua_main/index.html
index 879bd0f..87f11ab 100644
--- a/os/modules/elua/lua_main/index.html
+++ b/os/modules/elua/lua_main/index.html
@@ -16,6 +16,7 @@
<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 rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href="../../../../extra.css" rel="stylesheet">
@@ -43,11 +44,10 @@
<body class="lua_main">
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
@@ -64,75 +64,37 @@
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
- <li>
+ <li
+ class=""
+>
<a href="/">Home</a>
</li>
- <li>
- <a href="/about/">About</a>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
</li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../faq/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
</li>
<li>
+ <a href="/os/introduction/">Documentation</a>
+ </li>
+ <li
+ class=""
+>
<a href="/download/">Download</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/community/">Community</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/events/">Events</a>
</li>
</ul>
@@ -142,27 +104,26 @@
</ul>
</div>
- # </div>
-</div>
+ </div>
+</nav>
- <div class="container-fluid">
+ <div class="container">
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div 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 class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
- <ul class="nav bs-sidenav">
+ <ul class="toc-nav">
@@ -180,42 +141,29 @@
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
-
- <ul class="current-toc">
-
-
-
-
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
+ <ul>
+
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
-
- </li>
+
+ </li>
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
@@ -223,10 +171,10 @@
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
-
- </li>
+
+ </li>
@@ -234,10 +182,10 @@
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -245,10 +193,10 @@
- <li ><a href="../../../core_os/mynewt_os/">OS Core</a></li>
+ <li ><a href="../../../core_os/mynewt_os/">OS Core</a>
-
- </li>
+
+ </li>
@@ -256,10 +204,10 @@
- <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a></li>
+ <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a>
-
- </li>
+
+ </li>
@@ -267,10 +215,10 @@
- <li ><a href="../../console/console/">Console</a></li>
+ <li ><a href="../../console/console/">Console</a>
-
- </li>
+
+ </li>
@@ -278,10 +226,10 @@
- <li ><a href="../../shell/shell/">Shell</a></li>
+ <li ><a href="../../shell/shell/">Shell</a>
-
- </li>
+
+ </li>
@@ -289,10 +237,10 @@
- <li ><a href="../../bootloader/bootloader/">Bootloader</a></li>
+ <li ><a href="../../bootloader/bootloader/">Bootloader</a>
-
- </li>
+
+ </li>
@@ -307,8 +255,8 @@
">File System</a>
-
- </li>
+
+ </li>
@@ -316,10 +264,10 @@
- <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -327,10 +275,10 @@
- <li ><a href="../../testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -338,20 +286,18 @@
- <li ><a href="../../imgmgr/imgmgr/">Image Manager</a></li>
+ <li ><a href="../../imgmgr/imgmgr/">Image Manager</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../../baselibc/">Baselibc library</a>
</li>
-
@@ -359,10 +305,10 @@
- <li ><a href="../elua/">Embedded Lua</a></li>
+ <li ><a href="../elua/">Embedded Lua</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -374,38 +320,34 @@
../lua_init/
">Functions</a>
-
- <ul class="current-toc">
+
+ <ul>
-
- <li>
+ <li >
<a href="../lua_init/">lua_init</a>
</li>
-
-
<li class="active">
- lua_main
+ <a href="./">lua_main</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -413,10 +355,10 @@
- <li ><a href="../../json/json/">JSON</a></li>
+ <li ><a href="../../json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -424,10 +366,10 @@
- <li ><a href="../../stats/stats/">Stats</a></li>
+ <li ><a href="../../stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -435,16 +377,16 @@
- <li ><a href="../../logs/logs/">Logs</a></li>
+ <li ><a href="../../logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -456,40 +398,36 @@
../../../../network/ble/ble_intro/
">BLE User Guide</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
-
-
-
-
-
+
+
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
-
- </li>
+
+ </li>
-
-
-
+
+
+
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
-
- </li>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
@@ -501,8 +439,8 @@
../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -513,45 +451,11 @@
<button class="show-sidebar">Docs Menu</button>
</div>
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
+ <div class="col-md-9" role="main">
<div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
+ <div class="col-sm-12">
<div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
+ <ul class="wy-breadcrumbs pull-right">
<li><a href="/documentation/">Docs</a></li>
@@ -573,14 +477,14 @@
</div>
</div>
- <h2 id="lua_main"><font color="#F2853F" style="font-size:24pt"> lua_main </font><a class="headerlink" href="#lua_main" title="Permanent link">¶</a></h2>
+ <h2 id="lua_main"><font color="#F2853F" style="font-size:24pt"> lua_main </font></h2>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> int
lua_main(int argc, char **argv)
</pre></div>
<p>Executes lua script in current task's context. Arguments given are passed to lua interpreter.</p>
-<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<h4 id="arguments">Arguments</h4>
<table>
<thead>
<tr>
@@ -599,10 +503,10 @@
</tr>
</tbody>
</table>
-<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<h4 id="returned-values">Returned values</h4>
<p>Returns the return code from the lua interpreter.</p>
-<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
-<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<h4 id="notes">Notes</h4>
+<h4 id="example">Example</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">static int
lua_cmd(int argc, char **argv)
{
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/modules/fs/fs/fs/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/fs/fs/index.html b/os/modules/fs/fs/fs/index.html
index 46af203..e539371 100644
--- a/os/modules/fs/fs/fs/index.html
+++ b/os/modules/fs/fs/fs/index.html
@@ -16,6 +16,7 @@
<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 rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href="../../../../../extra.css" rel="stylesheet">
@@ -43,11 +44,10 @@
<body class="toc">
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
@@ -64,75 +64,37 @@
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
- <li>
+ <li
+ class=""
+>
<a href="/">Home</a>
</li>
- <li>
- <a href="/about/">About</a>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
</li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../../faq/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
</li>
<li>
+ <a href="/os/introduction/">Documentation</a>
+ </li>
+ <li
+ class=""
+>
<a href="/download/">Download</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/community/">Community</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/events/">Events</a>
</li>
</ul>
@@ -142,27 +104,26 @@
</ul>
</div>
- # </div>
-</div>
+ </div>
+</nav>
- <div class="container-fluid">
+ <div class="container">
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div 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 class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
<div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
- <ul class="nav bs-sidenav">
+ <ul class="toc-nav">
@@ -180,42 +141,29 @@
- <li><a href="
- ../../../../get_started/introduction/
-">Mynewt OS Manual</a>
-
-
- <ul class="current-toc">
-
-
-
+ <li ><a href="../../../../introduction/">Mynewt Documentation</a>
- <li>
- <a href="../../../../get_started/introduction/">Introduction</a>
- </li>
-
+ <ul>
+
- <li ><a href="../../../../get_started/get_started/">Quick Start</a></li>
+ <li ><a href="../../../../get_started/get_started/">Basic Setup</a>
-
- </li>
+
+ </li>
-
-
- <li ><a href="../../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
+ <li >
+ <a href="../../../../get_started/vocabulary/">Concepts</a>
+ </li>
@@ -223,10 +171,10 @@
- <li ><a href="../../../../tutorials/tutorials/">Tutorials</a></li>
+ <li ><a href="../../../../tutorials/tutorials/">Tutorials</a>
-
- </li>
+
+ </li>
@@ -234,10 +182,10 @@
- <li ><a href="../../../../os_user_guide/">OS User Guide</a></li>
+ <li ><a href="../../../../os_user_guide/">OS User Guide</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -245,10 +193,10 @@
- <li ><a href="../../../../core_os/mynewt_os/">OS Core</a></li>
+ <li ><a href="../../../../core_os/mynewt_os/">OS Core</a>
-
- </li>
+
+ </li>
@@ -256,10 +204,10 @@
- <li ><a href="../../../../core_os/porting/port_os/">Porting to your Platform</a></li>
+ <li ><a href="../../../../core_os/porting/port_os/">Porting to your Platform</a>
-
- </li>
+
+ </li>
@@ -267,10 +215,10 @@
- <li ><a href="../../../console/console/">Console</a></li>
+ <li ><a href="../../../console/console/">Console</a>
-
- </li>
+
+ </li>
@@ -278,10 +226,10 @@
- <li ><a href="../../../shell/shell/">Shell</a></li>
+ <li ><a href="../../../shell/shell/">Shell</a>
-
- </li>
+
+ </li>
@@ -289,10 +237,10 @@
- <li ><a href="../../../bootloader/bootloader/">Bootloader</a></li>
+ <li ><a href="../../../bootloader/bootloader/">Bootloader</a>
-
- </li>
+
+ </li>
@@ -307,27 +255,25 @@
">File System</a>
-
- <ul class="current-toc">
+
+ <ul>
- <li class="active"><a href="./">File System Abstraction</a></li>
+ <li class="active"><a href="./">File System Abstraction</a>
-
- <ul class="current-toc">
+
+ <ul>
-
- <li>
+ <li >
<a href="../fs_return_codes/">Return Codes</a>
</li>
-
@@ -339,8 +285,8 @@
../fs_ops/
">Data Structures</a>
-
- </li>
+
+ </li>
@@ -352,14 +298,14 @@
../fs_close/
">Functions</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -367,26 +313,24 @@
- <li ><a href="../../nffs/nffs/">Newtron Flash File System</a></li>
+ <li ><a href="../../nffs/nffs/">Newtron Flash File System</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../../otherfs/">Other File Systems</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -394,10 +338,10 @@
- <li ><a href="../../../hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../../hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -405,10 +349,10 @@
- <li ><a href="../../../testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../../testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -416,20 +360,18 @@
- <li ><a href="../../../imgmgr/imgmgr/">Image Manager</a></li>
+ <li ><a href="../../../imgmgr/imgmgr/">Image Manager</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../../../baselibc/">Baselibc library</a>
</li>
-
@@ -437,10 +379,10 @@
- <li ><a href="../../../elua/elua/">Embedded Lua</a></li>
+ <li ><a href="../../../elua/elua/">Embedded Lua</a>
-
- </li>
+
+ </li>
@@ -448,10 +390,10 @@
- <li ><a href="../../../json/json/">JSON</a></li>
+ <li ><a href="../../../json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -459,10 +401,10 @@
- <li ><a href="../../../stats/stats/">Stats</a></li>
+ <li ><a href="../../../stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -470,16 +412,16 @@
- <li ><a href="../../../logs/logs/">Logs</a></li>
+ <li ><a href="../../../logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -491,40 +433,36 @@
../../../../../network/ble/ble_intro/
">BLE User Guide</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
-
-
-
-
-
+
+
- <li><a href="
- ../../../../../newt/newt_intro/
-">Newt Tool Manual</a>
+ <li ><a href="../../../../../newt/newt_intro/">Newt Tool Guide</a>
-
- </li>
+
+ </li>
-
-
-
+
+
+
- <li><a href="
- ../../../../../newtmgr/overview/
-">Newt Manager Manual</a>
+ <li ><a href="../../../../../newtmgr/overview/">Newt Manager Guide</a>
-
- </li>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
@@ -536,8 +474,8 @@
../../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -548,45 +486,11 @@
<button class="show-sidebar">Docs Menu</button>
</div>
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
+ <div class="col-md-9" role="main">
<div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
+ <div class="col-sm-12">
<div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
+ <ul class="wy-breadcrumbs pull-right">
<li><a href="/documentation/">Docs</a></li>
@@ -606,9 +510,9 @@
</div>
</div>
- <h1 id="file-system-abstraction">File System Abstraction<a class="headerlink" href="#file-system-abstraction" title="Permanent link">¶</a></h1>
+ <h1 id="file-system-abstraction">File System Abstraction</h1>
<p>Mynewt provides a file system abstraction layer (<code>fs/fs</code>) to allow client code to be file system agnostic. By accessing the file system via the <code>fs/fs</code> API, client code can perform file system operations without being tied to a particular implementation. When possible, library code should use the <code>fs/fs</code> API rather than accessing the underlying file system directly.</p>
-<h3 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h3>
+<h3 id="description">Description</h3>
<p>Applications should aim to minimize the amount of code which depends on a particular file system implementation. When possible, only depend on the <code>fs/fs</code> package. In the simplest case, the only code which needs to know which file system is in use is the code which initializes the file system. In terms of the Mynewt hierarchy, the <strong>project</strong> package must depend on a specific file system package, while <strong>library</strong> packages should only depend on <code>fs/fs</code>.</p>
<p>The following example illustrates how file system dependencies should be managed. In the slinky application, the project is responsible for initializing the file system, so it depends on a concrete file system package called <code>fs/nffs</code> (Newtron Flash File System). The project explicitly initializes nffs via calls to <code>nffs_init()</code>, <code>nffs_detect()</code> and <code>nffs_format()</code>.</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"># project/slinky/pkg.yml
@@ -660,15 +564,15 @@ pkg.deps:
<p>The <code>libs/imgmgr</code> package uses the <code>fs/fs</code> API for all file system operations.</p>
-<h3 id="thread-safety">Thread Safety<a class="headerlink" href="#thread-safety" title="Permanent link">¶</a></h3>
+<h3 id="thread-safety">Thread Safety</h3>
<p>All <code>fs/fs</code> functions are thread safe.</p>
-<h3 id="header-files">Header Files<a class="headerlink" href="#header-files" title="Permanent link">¶</a></h3>
+<h3 id="header-files">Header Files</h3>
<p>All code which uses the <code>fs/fs</code> package needs to include the following header:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "fs/fs.h"
</pre></div>
-<h3 id="data-structures">Data Structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h3>
+<h3 id="data-structures">Data Structures</h3>
<p>All <code>fs/fs</code> data structures are opaque to client code.</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">struct fs_file;
struct fs_dir;
@@ -676,7 +580,7 @@ struct fs_dirent;
</pre></div>
-<h3 id="api">API<a class="headerlink" href="#api" title="Permanent link">¶</a></h3>
+<h3 id="api">API</h3>
<p>Functions in <code>fs/fs</code> that indicate success or failure do so with the following set of return codes:</p>
<ul>
<li><a href="../fs_return_codes/">Return Codes</a></li>