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:45 UTC
[02/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/fs/nffs/nffs/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/nffs/nffs/index.html b/os/modules/fs/nffs/nffs/index.html
index 58b7629..090da4d 100644
--- a/os/modules/fs/nffs/nffs/index.html
+++ b/os/modules/fs/nffs/nffs/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,17 +255,17 @@
">File System</a>
-
- <ul class="current-toc">
+
+ <ul>
- <li ><a href="../../fs/fs/">File System Abstraction</a></li>
+ <li ><a href="../../fs/fs/">File System Abstraction</a>
-
- </li>
+
+ </li>
@@ -325,10 +273,10 @@
- <li class="active"><a href="./">Newtron Flash File System</a></li>
+ <li class="active"><a href="./">Newtron Flash File System</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -340,8 +288,8 @@
../nffs_area_desc/
">Data Structures</a>
-
- </li>
+
+ </li>
@@ -353,40 +301,36 @@
../nffs_detect/
">Functions</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../nffs_internals/">Internals</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </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,15 +510,15 @@
</div>
</div>
- <h1 id="newtron-flash-filesystem-nffs">Newtron Flash Filesystem (nffs)<a class="headerlink" href="#newtron-flash-filesystem-nffs" title="Permanent link">¶</a></h1>
+ <h1 id="newtron-flash-filesystem-nffs">Newtron Flash Filesystem (nffs)</h1>
<p>Mynewt includes the Newtron Flash File System (nffs). This file system is designed with two priorities that makes it suitable for embedded use: </p>
<ul>
<li>Minimal RAM usage</li>
<li>Reliability</li>
</ul>
<p>Mynewt also provides an abstraction layer API (fs) to allow you to swap out nffs with a different file system of your choice.</p>
-<h3 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h3>
-<h4 id="areas">Areas<a class="headerlink" href="#areas" title="Permanent link">¶</a></h4>
+<h3 id="description">Description</h3>
+<h4 id="areas">Areas</h4>
<p>At the top level, an nffs disk is partitioned into <em>areas</em>. An area is a region of disk with the following properties:</p>
<ol>
<li>An area can be fully erased without affecting any other areas.</li>
@@ -623,7 +527,7 @@
<p><strong>Regarding property 1:</strong> Generally, flash hardware divides its memory space into "blocks." When erasing flash, entire blocks must be erased in a single operation; partial erases are not possible.</p>
<p><strong>Regarding property 2:</strong> Furthermore, some flash hardware imposes a restriction with regards to writes: writes within a block must be strictly sequential. For example, if you wish to write to the first 16 bytes of a block, you must write bytes 1 through 15 before writing byte 16. This restriction only applies at the block level; writes to one block have no effect on what parts of other blocks can be written.</p>
<p>Thus, each area must comprise a discrete number of blocks.</p>
-<h4 id="initialization">Initialization<a class="headerlink" href="#initialization" title="Permanent link">¶</a></h4>
+<h4 id="initialization">Initialization</h4>
<p>Before nffs can be used, it must be initialized. There are two means of initializing an nffs file system:</p>
<ol>
<li>Restore an existing file system via detection.</li>
@@ -683,27 +587,27 @@ main(int argc, char **argv)
<p>After nffs has been initialized, the application can access the file system via the <a href="../../fs/fs/">file system abstraction layer</a>.</p>
-<h3 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">¶</a></h3>
+<h3 id="configuration">Configuration</h3>
<p>The nffs file system is configured by populating fields in a global <a href="../nffs_config/">struct nffs_config</a> instance. Each field in the structure corresponds to a setting. All configuration must be done prior to calling nffs_init().</p>
<p>The global <code>struct nffs_config</code> instance is exposed in <code>nffs/nffs.h</code> as follows:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">extern struct nffs_config nffs_config;
</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>The <code>fs/nffs</code> package exposes the following data structures:</p>
<ul>
<li><a href="../nffs_area_desc/">struct nffs_area_desc</a></li>
<li><a href="../nffs_config/">struct nffs_config</a></li>
</ul>
-<h3 id="api">API<a class="headerlink" href="#api" title="Permanent link">¶</a></h3>
+<h3 id="api">API</h3>
<p>The functions available in this OS feature are:</p>
<ul>
<li><a href="../nffs_detect/">nffs_detect</a></li>
<li><a href="../nffs_format/">nffs_format</a></li>
<li><a href="../nffs_init/">nffs_init</a></li>
</ul>
-<h3 id="miscellaneous-measures">Miscellaneous measures<a class="headerlink" href="#miscellaneous-measures" title="Permanent link">¶</a></h3>
+<h3 id="miscellaneous-measures">Miscellaneous measures</h3>
<ul>
<li>
<p>RAM usage:</p>
@@ -719,12 +623,12 @@ main(int argc, char **argv)
</li>
<li>Disallowed filename characters: '/' and '\0'</li>
</ul>
-<h3 id="internals">Internals<a class="headerlink" href="#internals" title="Permanent link">¶</a></h3>
+<h3 id="internals">Internals</h3>
<p>nffs implementation details can be found here:</p>
<ul>
<li><a href="../nffs_internals/">nffs_internals</a></li>
</ul>
-<h3 id="future-enhancements">Future enhancements<a class="headerlink" href="#future-enhancements" title="Permanent link">¶</a></h3>
+<h3 id="future-enhancements">Future enhancements</h3>
<ul>
<li>Error correction.</li>
<li>Encryption.</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/modules/fs/nffs/nffs_area_desc/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/nffs/nffs_area_desc/index.html b/os/modules/fs/nffs/nffs_area_desc/index.html
index 2062208..cbe0f44 100644
--- a/os/modules/fs/nffs/nffs_area_desc/index.html
+++ b/os/modules/fs/nffs/nffs_area_desc/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="struct nffs_area_desc">
- <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,17 +255,17 @@
">File System</a>
-
- <ul class="current-toc">
+
+ <ul>
- <li ><a href="../../fs/fs/">File System Abstraction</a></li>
+ <li ><a href="../../fs/fs/">File System Abstraction</a>
-
- </li>
+
+ </li>
@@ -325,10 +273,10 @@
- <li ><a href="../nffs/">Newtron Flash File System</a></li>
+ <li ><a href="../nffs/">Newtron Flash File System</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -340,32 +288,28 @@
./
">Data Structures</a>
-
- <ul class="current-toc">
+
+ <ul>
-
<li class="active">
- struct nffs_area_desc
+ <a href="./">struct nffs_area_desc</a>
</li>
-
-
- <li>
+ <li >
<a href="../nffs_config/">struct nffs_config</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -377,40 +321,36 @@
../nffs_detect/
">Functions</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../nffs_internals/">Internals</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
-
- <li>
+ <li >
<a href="../../otherfs/">Other File Systems</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -418,10 +358,10 @@
- <li ><a href="../../../hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../../hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -429,10 +369,10 @@
- <li ><a href="../../../testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../../testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -440,20 +380,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>
-
@@ -461,10 +399,10 @@
- <li ><a href="../../../elua/elua/">Embedded Lua</a></li>
+ <li ><a href="../../../elua/elua/">Embedded Lua</a>
-
- </li>
+
+ </li>
@@ -472,10 +410,10 @@
- <li ><a href="../../../json/json/">JSON</a></li>
+ <li ><a href="../../../json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -483,10 +421,10 @@
- <li ><a href="../../../stats/stats/">Stats</a></li>
+ <li ><a href="../../../stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -494,16 +432,16 @@
- <li ><a href="../../../logs/logs/">Logs</a></li>
+ <li ><a href="../../../logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -515,40 +453,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>
@@ -560,8 +494,8 @@
../../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -572,45 +506,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>
@@ -632,7 +532,7 @@
</div>
</div>
- <h2 id="struct-nffs95area95desc"><font color="F2853F" style="font-size:24pt">struct nffs_area_desc</font><a class="headerlink" href="#struct-nffs95area95desc" title="Permanent link">¶</a></h2>
+ <h2 id="struct-nffs95area95desc"><font color="F2853F" style="font-size:24pt">struct nffs_area_desc</font></h2>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">struct nffs_area_desc {
uint32_t nad_offset; /* Flash offset of start of area. */
uint32_t nad_length; /* Size of area, in bytes. */
@@ -650,9 +550,9 @@
<p><strong>Regarding property 2:</strong> Furthermore, some flash hardware imposes a restriction with regards to writes: writes within a block must be strictly sequential. For example, if you wish to write to the first 16 bytes of a block, you must write bytes 1 through 15 before writing byte 16. This restriction only applies at the block level; writes to one block have no effect on what parts of other blocks can be written.</p>
<p>Thus, each area must comprise a discrete number of blocks.</p>
<p>An array of area descriptors is terminated by an entry with a <em>nad_length</em> value of 0.</p>
-<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<h4 id="notes">Notes</h4>
<p>Typically, a product's flash layout is exposed via its BSP-specific <code>bsp_flash_dev()</code> function. This function retrieves the layout of the specified flash device resident in the BSP. The result of this function can then be converted into the <code>struct nffs_area_desc[]</code> that nffs requires.</p>
-<h4 id="header-file">Header file<a class="headerlink" href="#header-file" title="Permanent link">¶</a></h4>
+<h4 id="header-file">Header file</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "nffs/nffs.h"
</pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/modules/fs/nffs/nffs_config/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/nffs/nffs_config/index.html b/os/modules/fs/nffs/nffs_config/index.html
index 1fe6b67..95906f1 100644
--- a/os/modules/fs/nffs/nffs_config/index.html
+++ b/os/modules/fs/nffs/nffs_config/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="struct nffs_config">
- <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,17 +255,17 @@
">File System</a>
-
- <ul class="current-toc">
+
+ <ul>
- <li ><a href="../../fs/fs/">File System Abstraction</a></li>
+ <li ><a href="../../fs/fs/">File System Abstraction</a>
-
- </li>
+
+ </li>
@@ -325,10 +273,10 @@
- <li ><a href="../nffs/">Newtron Flash File System</a></li>
+ <li ><a href="../nffs/">Newtron Flash File System</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -340,32 +288,28 @@
../nffs_area_desc/
">Data Structures</a>
-
- <ul class="current-toc">
+
+ <ul>
-
- <li>
+ <li >
<a href="../nffs_area_desc/">struct nffs_area_desc</a>
</li>
-
-
<li class="active">
- struct nffs_config
+ <a href="./">struct nffs_config</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -377,40 +321,36 @@
../nffs_detect/
">Functions</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../nffs_internals/">Internals</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
-
- <li>
+ <li >
<a href="../../otherfs/">Other File Systems</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -418,10 +358,10 @@
- <li ><a href="../../../hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../../hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -429,10 +369,10 @@
- <li ><a href="../../../testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../../testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -440,20 +380,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>
-
@@ -461,10 +399,10 @@
- <li ><a href="../../../elua/elua/">Embedded Lua</a></li>
+ <li ><a href="../../../elua/elua/">Embedded Lua</a>
-
- </li>
+
+ </li>
@@ -472,10 +410,10 @@
- <li ><a href="../../../json/json/">JSON</a></li>
+ <li ><a href="../../../json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -483,10 +421,10 @@
- <li ><a href="../../../stats/stats/">Stats</a></li>
+ <li ><a href="../../../stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -494,16 +432,16 @@
- <li ><a href="../../../logs/logs/">Logs</a></li>
+ <li ><a href="../../../logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -515,40 +453,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>
@@ -560,8 +494,8 @@
../../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -572,45 +506,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>
@@ -632,7 +532,7 @@
</div>
</div>
- <h2 id="struct-nffs95config"><font color="F2853F" style="font-size:24pt">struct nffs_config</font><a class="headerlink" href="#struct-nffs95config" title="Permanent link">¶</a></h2>
+ <h2 id="struct-nffs95config"><font color="F2853F" style="font-size:24pt">struct nffs_config</font></h2>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">struct nffs_config {
/** Maximum number of inodes; default=1024. */
uint32_t nc_num_inodes;
@@ -654,13 +554,13 @@
<p>The file system is configured by populating fields in a global <code>struct nffs_config</code> instance. Each field in the structure corresponds to a setting. All configuration must be done prior to calling nffs_init().</p>
<p>Any fields that are set to 0 (or not set at all) inherit the corresponding default value. This means that it is impossible to configure any setting with a value of zero.</p>
-<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<h4 id="notes">Notes</h4>
<p>The global <code>struct nffs_config</code> instance is exposed in <code>nffs/nffs.h</code> as follows:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">extern struct nffs_config nffs_config;
</pre></div>
-<h4 id="header-file">Header file<a class="headerlink" href="#header-file" title="Permanent link">¶</a></h4>
+<h4 id="header-file">Header file</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "nffs/nffs.h"
</pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/modules/fs/nffs/nffs_detect/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/nffs/nffs_detect/index.html b/os/modules/fs/nffs/nffs_detect/index.html
index 920407e..2f790b1 100644
--- a/os/modules/fs/nffs/nffs_detect/index.html
+++ b/os/modules/fs/nffs/nffs_detect/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="nffs_detect">
- <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,17 +255,17 @@
">File System</a>
-
- <ul class="current-toc">
+
+ <ul>
- <li ><a href="../../fs/fs/">File System Abstraction</a></li>
+ <li ><a href="../../fs/fs/">File System Abstraction</a>
-
- </li>
+
+ </li>
@@ -325,10 +273,10 @@
- <li ><a href="../nffs/">Newtron Flash File System</a></li>
+ <li ><a href="../nffs/">Newtron Flash File System</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -340,8 +288,8 @@
../nffs_area_desc/
">Data Structures</a>
-
- </li>
+
+ </li>
@@ -353,74 +301,64 @@
./
">Functions</a>
-
- <ul class="current-toc">
+
+ <ul>
-
<li class="active">
- nffs_detect
+ <a href="./">nffs_detect</a>
</li>
-
-
- <li>
+ <li >
<a href="../nffs_format/">nffs_format</a>
</li>
-
-
- <li>
+ <li >
<a href="../nffs_init/">nffs_init</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
-
- <li>
+ <li >
<a href="../nffs_internals/">Internals</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
-
- <li>
+ <li >
<a href="../../otherfs/">Other File Systems</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -428,10 +366,10 @@
- <li ><a href="../../../hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../../hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -439,10 +377,10 @@
- <li ><a href="../../../testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../../testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -450,20 +388,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>
-
@@ -471,10 +407,10 @@
- <li ><a href="../../../elua/elua/">Embedded Lua</a></li>
+ <li ><a href="../../../elua/elua/">Embedded Lua</a>
-
- </li>
+
+ </li>
@@ -482,10 +418,10 @@
- <li ><a href="../../../json/json/">JSON</a></li>
+ <li ><a href="../../../json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -493,10 +429,10 @@
- <li ><a href="../../../stats/stats/">Stats</a></li>
+ <li ><a href="../../../stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -504,16 +440,16 @@
- <li ><a href="../../../logs/logs/">Logs</a></li>
+ <li ><a href="../../../logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -525,40 +461,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>
@@ -570,8 +502,8 @@
../../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -582,45 +514,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>
@@ -642,13 +540,13 @@
</div>
</div>
- <h2 id="nffs95detect"><font color="F2853F" style="font-size:24pt">nffs_detect</font><a class="headerlink" href="#nffs95detect" title="Permanent link">¶</a></h2>
+ <h2 id="nffs95detect"><font color="F2853F" style="font-size:24pt">nffs_detect</font></h2>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int nffs_detect(const struct nffs_area_desc *area_descs)
</pre></div>
<p>Searches for a valid nffs file system among the specified areas. This function succeeds if a file system is detected among any subset of the supplied areas. If the area set does not contain a valid file system, a new one can be created via a separate call to nffs_format().</p>
-<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<h4 id="arguments">Arguments</h4>
<table>
<thead>
<tr>
@@ -663,18 +561,18 @@
</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>
<ul>
<li>0 on success</li>
<li>FS_ECORRUPT if no valid file system was detected</li>
<li>Other <a href="../../fs/fs_return_codes/">FS error code</a> on failure</li>
</ul>
-<h4 id="header-file">Header file<a class="headerlink" href="#header-file" title="Permanent link">¶</a></h4>
+<h4 id="header-file">Header file</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "nffs/nffs.h"
</pre></div>
-<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%">/*** hw/hal/include/hal/flash_map.h */
/*
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/modules/fs/nffs/nffs_format/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/nffs/nffs_format/index.html b/os/modules/fs/nffs/nffs_format/index.html
index 0151920..e568945 100644
--- a/os/modules/fs/nffs/nffs_format/index.html
+++ b/os/modules/fs/nffs/nffs_format/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="nffs_format">
- <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,17 +255,17 @@
">File System</a>
-
- <ul class="current-toc">
+
+ <ul>
- <li ><a href="../../fs/fs/">File System Abstraction</a></li>
+ <li ><a href="../../fs/fs/">File System Abstraction</a>
-
- </li>
+
+ </li>
@@ -325,10 +273,10 @@
- <li ><a href="../nffs/">Newtron Flash File System</a></li>
+ <li ><a href="../nffs/">Newtron Flash File System</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -340,8 +288,8 @@
../nffs_area_desc/
">Data Structures</a>
-
- </li>
+
+ </li>
@@ -353,74 +301,64 @@
../nffs_detect/
">Functions</a>
-
- <ul class="current-toc">
+
+ <ul>
-
- <li>
+ <li >
<a href="../nffs_detect/">nffs_detect</a>
</li>
-
-
<li class="active">
- nffs_format
+ <a href="./">nffs_format</a>
</li>
-
-
- <li>
+ <li >
<a href="../nffs_init/">nffs_init</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
-
- <li>
+ <li >
<a href="../nffs_internals/">Internals</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
-
- <li>
+ <li >
<a href="../../otherfs/">Other File Systems</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -428,10 +366,10 @@
- <li ><a href="../../../hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../../hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -439,10 +377,10 @@
- <li ><a href="../../../testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../../testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -450,20 +388,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>
-
@@ -471,10 +407,10 @@
- <li ><a href="../../../elua/elua/">Embedded Lua</a></li>
+ <li ><a href="../../../elua/elua/">Embedded Lua</a>
-
- </li>
+
+ </li>
@@ -482,10 +418,10 @@
- <li ><a href="../../../json/json/">JSON</a></li>
+ <li ><a href="../../../json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -493,10 +429,10 @@
- <li ><a href="../../../stats/stats/">Stats</a></li>
+ <li ><a href="../../../stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -504,16 +440,16 @@
- <li ><a href="../../../logs/logs/">Logs</a></li>
+ <li ><a href="../../../logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -525,40 +461,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>
@@ -570,8 +502,8 @@
../../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -582,45 +514,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>
@@ -642,13 +540,13 @@
</div>
</div>
- <h2 id="nffs95format"><font color="F2853F" style="font-size:24pt">nffs_format</font><a class="headerlink" href="#nffs95format" title="Permanent link">¶</a></h2>
+ <h2 id="nffs95format"><font color="F2853F" style="font-size:24pt">nffs_format</font></h2>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int nffs_format(const struct nffs_area_desc *area_descs)
</pre></div>
<p>Erases all the specified areas and initializes them with a clean nffs file system.</p>
-<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<h4 id="arguments">Arguments</h4>
<table>
<thead>
<tr>
@@ -663,17 +561,17 @@
</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>
<ul>
<li>0 on success</li>
<li><a href="../../fs/fs_return_codes/">FS error code</a> on failure.</li>
</ul>
-<h4 id="header-file">Header file<a class="headerlink" href="#header-file" title="Permanent link">¶</a></h4>
+<h4 id="header-file">Header file</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "nffs/nffs.h"
</pre></div>
-<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%">/*** hw/hal/include/hal/flash_map.h */
/*