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/21 01:34:16 UTC
[3/9] incubator-mynewt-site git commit: fixes for mobile phone
responsiveness, nav item colors, and a doc sidebar height,
and some ble doc changes.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/os/modules/fs/fs/fs_rename/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/fs/fs_rename/index.html b/os/modules/fs/fs/fs_rename/index.html
index a2b2fcc..299ca08 100644
--- a/os/modules/fs/fs/fs_rename/index.html
+++ b/os/modules/fs/fs/fs_rename/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -661,7 +668,7 @@
</div>
<h2 id="fs95rename"><font color="#F2853F" style="font-size:24pt">fs_rename</font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int fs_rename(const char *from, const char *to)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">fs_rename</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*from</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*to</span>)
</pre></div>
@@ -670,8 +677,8 @@
<table>
<thead>
<tr>
-<th>Arguments</th>
-<th>Description</th>
+<th><em>Argument</em></th>
+<th><em>Description</em></th>
</tr>
</thead>
<tbody>
@@ -693,40 +700,40 @@
<h4 id="notes">Notes</h4>
<p>The source path can refer to either a file or a directory. All intermediate directories in the destination path must already exist. If the source path refers to a file, the destination path must contain a full filename path, rather than just the new parent directory. If an object already exists at the specified destination path, this function causes it to be unlinked prior to the rename (i.e., the destination gets clobbered).</p>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "fs/fs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "fs/fs.h"</span>
</pre></div>
<h4 id="example">Example</h4>
<p>This example demonstrates how to use fs_rename() to perform a log rotation. In this example, there is one primary log and three archived logs. <code>FS_ENOENT</code> errors returned by <code>fs_rename()</code> are ignored; it is not an error if an archived log was never created.</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int
-rotate_logs(void)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span>
+<span style="color: #000000">rotate_logs</span>(<span style="color: #A90D91">void</span>)
{
- struct fs_file *file;
- int rc;
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">fs_file</span> <span style="color: #000000">*file</span>;
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
- /* Rotate each of the log files. */
- rc = fs_rename("/var/log/messages.2", "/var/log/messages.3")
- if (rc != 0 && rc != FS_ENOENT) return -1;
+ <span style="color: #177500">/* Rotate each of the log files. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_rename</span>(<span style="color: #C41A16">"/var/log/messages.2"</span>, <span style="color: #C41A16">"/var/log/messages.3"</span>)
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">&&</span> <span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #000000">FS_ENOENT</span>) <span style="color: #A90D91">return</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
- rc = fs_rename("/var/log/messages.1", "/var/log/messages.2")
- if (rc != 0 && rc != FS_ENOENT) return -1;
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_rename</span>(<span style="color: #C41A16">"/var/log/messages.1"</span>, <span style="color: #C41A16">"/var/log/messages.2"</span>)
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">&&</span> <span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #000000">FS_ENOENT</span>) <span style="color: #A90D91">return</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
- rc = fs_rename("/var/log/messages.0", "/var/log/messages.1")
- if (rc != 0 && rc != FS_ENOENT) return -1;
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_rename</span>(<span style="color: #C41A16">"/var/log/messages.0"</span>, <span style="color: #C41A16">"/var/log/messages.1"</span>)
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">&&</span> <span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #000000">FS_ENOENT</span>) <span style="color: #A90D91">return</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
- rc = fs_rename("/var/log/messages", "/var/log/messages.0")
- if (rc != 0 && rc != FS_ENOENT) return -1;
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_rename</span>(<span style="color: #C41A16">"/var/log/messages"</span>, <span style="color: #C41A16">"/var/log/messages.0"</span>)
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">&&</span> <span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #000000">FS_ENOENT</span>) <span style="color: #A90D91">return</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
- /* Now create the new log file. */
- rc = fs_open("/var/log/messages", FS_ACCESS_WRITE | FS_ACCESS_TRUNCATE,
- &file);
- if (rc != 0) return -1;
+ <span style="color: #177500">/* Now create the new log file. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_open</span>(<span style="color: #C41A16">"/var/log/messages"</span>, <span style="color: #000000">FS_ACCESS_WRITE</span> <span style="color: #000000">|</span> <span style="color: #000000">FS_ACCESS_TRUNCATE</span>,
+ <span style="color: #000000">&file</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span>) <span style="color: #A90D91">return</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
- rc = fs_write(file, "Creating new log file.\n", 23);
- fs_close(file);
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_write</span>(<span style="color: #000000">file</span>, <span style="color: #C41A16">"Creating new log file.\n"</span>, <span style="color: #1C01CE">23</span>);
+ <span style="color: #000000">fs_close</span>(<span style="color: #000000">file</span>);
- return rc == 0 ? 0 : -1;
+ <span style="color: #A90D91">return</span> <span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">?</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">:</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
}
</pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/os/modules/fs/fs/fs_return_codes/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/fs/fs_return_codes/index.html b/os/modules/fs/fs/fs_return_codes/index.html
index f6b9682..c9d7115 100644
--- a/os/modules/fs/fs/fs_return_codes/index.html
+++ b/os/modules/fs/fs/fs_return_codes/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -581,7 +588,7 @@
</tbody>
</table>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "fs/fs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "fs/fs.h"</span>
</pre></div>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/os/modules/fs/fs/fs_seek/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/fs/fs_seek/index.html b/os/modules/fs/fs/fs_seek/index.html
index d030c00..c10b4e1 100644
--- a/os/modules/fs/fs/fs_seek/index.html
+++ b/os/modules/fs/fs/fs_seek/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -661,7 +668,7 @@
</div>
<h2 id="fs95seek"><font color="#F2853F" style="font-size:24pt">fs_seek</font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int fs_seek(struct fs_file *file, uint32_t offset)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">fs_seek</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">fs_file</span> <span style="color: #000000">*file</span>, <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">offset</span>)
</pre></div>
@@ -670,8 +677,8 @@
<table>
<thead>
<tr>
-<th>Arguments</th>
-<th>Description</th>
+<th><em>Argument</em></th>
+<th><em>Description</em></th>
</tr>
</thead>
<tbody>
@@ -693,38 +700,38 @@
<h4 id="notes">Notes</h4>
<p>If a file is opened in append mode, its write pointer is always positioned at the end of the file. Calling this function on such a file only affects the read pointer.</p>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "fs/fs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "fs/fs.h"</span>
</pre></div>
<h4 id="example">Example</h4>
<p>The following example reads four bytes from a file, starting at an offset of eight.</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int
-read_part1_middle(void)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span>
+<span style="color: #000000">read_part1_middle</span>(<span style="color: #A90D91">void</span>)
{
- struct fs_file *file;
- uint32_t bytes_read;
- uint8_t buf[4];
- int rc;
-
- rc = fs_open("/data/parts/1.bin", FS_ACCESS_READ, &file);
- if (rc == 0) {
- /* Advance to offset 8. */
- rc = fs_seek(file, 8);
- if (rc == 0) {
- /* Read bytes 8, 9, 10, and 11. */
- rc = fs_read(file, 4, buf, &bytes_read);
- if (rc == 0) {
- /* buf now contains up to 4 bytes of file data. */
- console_printf("read %u bytes\n", bytes_read)
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">fs_file</span> <span style="color: #000000">*file</span>;
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">bytes_read</span>;
+ <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">buf</span>[<span style="color: #1C01CE">4</span>];
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
+
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_open</span>(<span style="color: #C41A16">"/data/parts/1.bin"</span>, <span style="color: #000000">FS_ACCESS_READ</span>, <span style="color: #000000">&file</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>) {
+ <span style="color: #177500">/* Advance to offset 8. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_seek</span>(<span style="color: #000000">file</span>, <span style="color: #1C01CE">8</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>) {
+ <span style="color: #177500">/* Read bytes 8, 9, 10, and 11. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_read</span>(<span style="color: #000000">file</span>, <span style="color: #1C01CE">4</span>, <span style="color: #000000">buf</span>, <span style="color: #000000">&bytes_read</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>) {
+ <span style="color: #177500">/* buf now contains up to 4 bytes of file data. */</span>
+ <span style="color: #000000">console_printf</span>(<span style="color: #C41A16">"read %u bytes\n"</span>, <span style="color: #000000">bytes_read</span>)
}
}
- /* Close the file. */
- fs_close(file);
+ <span style="color: #177500">/* Close the file. */</span>
+ <span style="color: #000000">fs_close</span>(<span style="color: #000000">file</span>);
}
- return rc == 0 ? 0 : -1;
+ <span style="color: #A90D91">return</span> <span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">?</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">:</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
}
</pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/os/modules/fs/fs/fs_unlink/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/fs/fs_unlink/index.html b/os/modules/fs/fs/fs_unlink/index.html
index bf02028..2dc0b0d 100644
--- a/os/modules/fs/fs/fs_unlink/index.html
+++ b/os/modules/fs/fs/fs_unlink/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -661,7 +668,7 @@
</div>
<h2 id="fs95unlink"><font color="#F2853F" style="font-size:24pt">fs_unlink</font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int fs_unlink(const char *filename)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">fs_unlink</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*filename</span>)
</pre></div>
@@ -670,8 +677,8 @@
<table>
<thead>
<tr>
-<th>Arguments</th>
-<th>Description</th>
+<th><em>Argument</em></th>
+<th><em>Description</em></th>
</tr>
</thead>
<tbody>
@@ -687,36 +694,36 @@
<li><a href="../fs_return_codes/">FS error code</a> on failure</li>
</ul>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "fs/fs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "fs/fs.h"</span>
</pre></div>
<h4 id="example">Example</h4>
<p>The following example creates a file and then immediately unlinks it. By unlinking the file, this function prevents other OS tasks from accessing it. When the function closes the file, it is deleted from the disk.</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int
-process_data(void)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span>
+<span style="color: #000000">process_data</span>(<span style="color: #A90D91">void</span>)
{
- struct fs_file *file;
- int rc;
-
- /* If the file doesn't exist, create it. If it does exist, truncate it to
- * zero bytes.
- */
- rc = fs_open("/tmp/buffer.bin", FS_ACCESS_WRITE | FS_ACCESS_TRUNCATE, &file);
- if (rc == 0) {
- /* Unlink the file so that other tasks cannot access it. */
- fs_unlink("/tmp/buffer.bin")
-
- /* <use the file as a data buffer> */
-
- /* Close the file. This operation causes the file to be deleted from
- * the disk because it was unlinked earlier (and it has no other open
- * file handles).
- */
- fs_close(file);
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">fs_file</span> <span style="color: #000000">*file</span>;
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
+
+ <span style="color: #177500">/* If the file doesn't exist, create it. If it does exist, truncate it to</span>
+<span style="color: #177500"> * zero bytes.</span>
+<span style="color: #177500"> */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_open</span>(<span style="color: #C41A16">"/tmp/buffer.bin"</span>, <span style="color: #000000">FS_ACCESS_WRITE</span> <span style="color: #000000">|</span> <span style="color: #000000">FS_ACCESS_TRUNCATE</span>, <span style="color: #000000">&file</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>) {
+ <span style="color: #177500">/* Unlink the file so that other tasks cannot access it. */</span>
+ <span style="color: #000000">fs_unlink</span>(<span style="color: #C41A16">"/tmp/buffer.bin"</span>)
+
+ <span style="color: #177500">/* <use the file as a data buffer> */</span>
+
+ <span style="color: #177500">/* Close the file. This operation causes the file to be deleted from</span>
+<span style="color: #177500"> * the disk because it was unlinked earlier (and it has no other open</span>
+<span style="color: #177500"> * file handles).</span>
+<span style="color: #177500"> */</span>
+ <span style="color: #000000">fs_close</span>(<span style="color: #000000">file</span>);
}
- return rc == 0 ? 0 : -1;
+ <span style="color: #A90D91">return</span> <span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">?</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">:</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
}
</pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/os/modules/fs/fs/fs_write/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/fs/fs_write/index.html b/os/modules/fs/fs/fs_write/index.html
index 19a8896..bc11cde 100644
--- a/os/modules/fs/fs/fs_write/index.html
+++ b/os/modules/fs/fs/fs_write/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -661,7 +668,7 @@
</div>
<h2 id="fs95write"><font color="#F2853F" style="font-size:24pt">fs_write</font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int fs_write(struct fs_file *file, const void *data, int len)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">fs_write</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">fs_file</span> <span style="color: #000000">*file</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">void</span> <span style="color: #000000">*data</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">len</span>)
</pre></div>
@@ -670,8 +677,8 @@
<table>
<thead>
<tr>
-<th>Arguments</th>
-<th>Description</th>
+<th><em>Argument</em></th>
+<th><em>Description</em></th>
</tr>
</thead>
<tbody>
@@ -697,35 +704,35 @@
<h4 id="notes">Notes</h4>
<p>For files opened in append mode, the specified data is always written to the end.</p>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "fs/fs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "fs/fs.h"</span>
</pre></div>
<h4 id="example">Example</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int
-write_config(void)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span>
+<span style="color: #000000">write_config</span>(<span style="color: #A90D91">void</span>)
{
- struct fs_file *file;
- int rc;
-
- /* If the file doesn't exist, create it. If it does exist, truncate it to
- * zero bytes.
- */
- rc = fs_open("/settings/config.txt", FS_ACCESS_WRITE | FS_ACCESS_TRUNCATE,
- &file);
- if (rc == 0) {
- /* Write 5 bytes of data to the file. */
- rc = fs_write(file, "hello", 5);
- if (rc == 0) {
- /* The file should now contain exactly five bytes. */
- assert(fs_filelen(file) == 5);
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">fs_file</span> <span style="color: #000000">*file</span>;
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
+
+ <span style="color: #177500">/* If the file doesn't exist, create it. If it does exist, truncate it to</span>
+<span style="color: #177500"> * zero bytes.</span>
+<span style="color: #177500"> */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_open</span>(<span style="color: #C41A16">"/settings/config.txt"</span>, <span style="color: #000000">FS_ACCESS_WRITE</span> <span style="color: #000000">|</span> <span style="color: #000000">FS_ACCESS_TRUNCATE</span>,
+ <span style="color: #000000">&file</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>) {
+ <span style="color: #177500">/* Write 5 bytes of data to the file. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_write</span>(<span style="color: #000000">file</span>, <span style="color: #C41A16">"hello"</span>, <span style="color: #1C01CE">5</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>) {
+ <span style="color: #177500">/* The file should now contain exactly five bytes. */</span>
+ <span style="color: #000000">assert</span>(<span style="color: #000000">fs_filelen</span>(<span style="color: #000000">file</span>) <span style="color: #000000">==</span> <span style="color: #1C01CE">5</span>);
}
- /* Close the file. */
- fs_close(file);
+ <span style="color: #177500">/* Close the file. */</span>
+ <span style="color: #000000">fs_close</span>(<span style="color: #000000">file</span>);
}
- return rc == 0 ? 0 : -1;
+ <span style="color: #A90D91">return</span> <span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">?</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">:</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
}
</pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/os/modules/fs/fs/fsutil_read_file/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/fs/fsutil_read_file/index.html b/os/modules/fs/fs/fsutil_read_file/index.html
index 57fdfe5..98837c5 100644
--- a/os/modules/fs/fs/fsutil_read_file/index.html
+++ b/os/modules/fs/fs/fsutil_read_file/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -661,8 +668,8 @@
</div>
<h2 id="fsutil95read95file"><font color="#F2853F" style="font-size:24pt">fsutil_read_file</font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int fsutil_read_file(const char *path, uint32_t offset, uint32_t len,
- void *dst, uint32_t *out_len)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">fsutil_read_file</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*path</span>, <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">offset</span>, <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">len</span>,
+ <span style="color: #A90D91">void</span> <span style="color: #000000">*dst</span>, <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">*out_len</span>)
</pre></div>
@@ -671,8 +678,8 @@
<table>
<thead>
<tr>
-<th>Arguments</th>
-<th>Description</th>
+<th><em>Argument</em></th>
+<th><em>Description</em></th>
</tr>
</thead>
<tbody>
@@ -706,31 +713,31 @@
<h4 id="notes">Notes</h4>
<p>This is a convenience function. It is useful when the amount of data to be read from the file is small (i.e., all the data read can easily fit in a single buffer).</p>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "fs/fs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "fs/fs.h"</span>
</pre></div>
<h4 id="example">Example</h4>
<p>This example demonstrates reading a small text file in its entirety and printing its contents to the console.</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int
-print_status(void)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span>
+<span style="color: #000000">print_status</span>(<span style="color: #A90D91">void</span>)
{
- uint32_t bytes_read;
- uint8_t buf[16];
- int rc;
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">bytes_read</span>;
+ <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">buf</span>[<span style="color: #1C01CE">16</span>];
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
- /* Read up to 15 bytes from the start of the file. */
- rc = fsutil_read_file("/cfg/status.txt", 0, sizeof buf - 1, buf,
- &bytes_read);
- if (rc != 0) return -1;
+ <span style="color: #177500">/* Read up to 15 bytes from the start of the file. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fsutil_read_file</span>(<span style="color: #C41A16">"/cfg/status.txt"</span>, <span style="color: #1C01CE">0</span>, <span style="color: #A90D91">sizeof</span> <span style="color: #000000">buf</span> <span style="color: #000000">-</span> <span style="color: #1C01CE">1</span>, <span style="color: #000000">buf</span>,
+ <span style="color: #000000">&bytes_read</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span>) <span style="color: #A90D91">return</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
- /* Null-terminate the string just read. */
- buf[bytes_read] = '\0';
+ <span style="color: #177500">/* Null-terminate the string just read. */</span>
+ <span style="color: #000000">buf</span>[<span style="color: #000000">bytes_read</span>] <span style="color: #000000">=</span> <span style="color: #2300CE">'\0'</span>;
- /* Print the file contents to the console. */
- console_printf("%s\n", buf);
+ <span style="color: #177500">/* Print the file contents to the console. */</span>
+ <span style="color: #000000">console_printf</span>(<span style="color: #C41A16">"%s\n"</span>, <span style="color: #000000">buf</span>);
- return 0;
+ <span style="color: #A90D91">return</span> <span style="color: #1C01CE">0</span>;
}
</pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/os/modules/fs/fs/fsutil_write_file/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/fs/fsutil_write_file/index.html b/os/modules/fs/fs/fsutil_write_file/index.html
index f96bda7..e9f24ae 100644
--- a/os/modules/fs/fs/fsutil_write_file/index.html
+++ b/os/modules/fs/fs/fsutil_write_file/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -661,7 +668,7 @@
</div>
<h2 id="fsutil95write95file"><font color="#F2853F" style="font-size:24pt">fsutil_write_file</font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int fsutil_write_file(const char *path, const void *data, uint32_t len)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">fsutil_write_file</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*path</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">void</span> <span style="color: #000000">*data</span>, <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">len</span>)
</pre></div>
@@ -670,8 +677,8 @@
<table>
<thead>
<tr>
-<th>Arguments</th>
-<th>Description</th>
+<th><em>Argument</em></th>
+<th><em>Description</em></th>
</tr>
</thead>
<tbody>
@@ -695,30 +702,30 @@
<li><a href="../fs_return_codes/">FS error code</a> on failure</li>
</ul>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "fs/fs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "fs/fs.h"</span>
</pre></div>
<h4 id="example">Example</h4>
<p>This example creates a 4-byte file.</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int
-write_id(void)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span>
+<span style="color: #000000">write_id</span>(<span style="color: #A90D91">void</span>)
{
- int rc;
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
- /* Create the parent directory. */
- rc = fs_mkdir("/cfg");
- if (rc != 0 && rc != FS_EALREADY) {
- return -1;
+ <span style="color: #177500">/* Create the parent directory. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_mkdir</span>(<span style="color: #C41A16">"/cfg"</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">&&</span> <span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #000000">FS_EALREADY</span>) {
+ <span style="color: #A90D91">return</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
}
- /* Create a file and write four bytes to it. */
- rc = fsutil_write_file("/cfg/id.txt", "1234", 4);
- if (rc != 0) {
- return -1;
+ <span style="color: #177500">/* Create a file and write four bytes to it. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fsutil_write_file</span>(<span style="color: #C41A16">"/cfg/id.txt"</span>, <span style="color: #C41A16">"1234"</span>, <span style="color: #1C01CE">4</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span>) {
+ <span style="color: #A90D91">return</span> <span style="color: #000000">-</span><span style="color: #1C01CE">1</span>;
}
- return 0;
+ <span style="color: #A90D91">return</span> <span style="color: #1C01CE">0</span>;
}
</pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/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 090da4d..351cce8 100644
--- a/os/modules/fs/nffs/nffs/index.html
+++ b/os/modules/fs/nffs/nffs/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -540,48 +547,48 @@
</ol>
<p>Both methods require the user to describe how the flash memory should be divided into nffs areas. This is accomplished with an array of <a href="../nffs_area_desc/">struct nffs_area_desc</a>.</p>
<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. The below example, taken from the slinky project, illustrates the nffs initialization procedure.</p>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">/*** hw/hal/include/hal/flash_map.h */
-
-/*
- * Flash area types
- */
-#define FLASH_AREA_BOOTLOADER 0
-#define FLASH_AREA_IMAGE_0 1
-#define FLASH_AREA_IMAGE_1 2
-#define FLASH_AREA_IMAGE_SCRATCH 3
-#define FLASH_AREA_NFFS 4
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/*** hw/hal/include/hal/flash_map.h */</span>
+
+<span style="color: #177500">/*</span>
+<span style="color: #177500"> * Flash area types</span>
+<span style="color: #177500"> */</span>
+<span style="color: #633820">#define FLASH_AREA_BOOTLOADER 0</span>
+<span style="color: #633820">#define FLASH_AREA_IMAGE_0 1</span>
+<span style="color: #633820">#define FLASH_AREA_IMAGE_1 2</span>
+<span style="color: #633820">#define FLASH_AREA_IMAGE_SCRATCH 3</span>
+<span style="color: #633820">#define FLASH_AREA_NFFS 4</span>
</pre></div>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">/*** project/slinky/src/main.c */
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/*** project/slinky/src/main.c */</span>
-int
-main(int argc, char **argv)
+<span style="color: #A90D91">int</span>
+<span style="color: #000000">main</span>(<span style="color: #A90D91">int</span> <span style="color: #000000">argc</span>, <span style="color: #A90D91">char</span> <span style="color: #000000">**argv</span>)
{
- int rc;
- int cnt;
-
- /* NFFS_AREA_MAX is defined in the BSP-specified bsp.h header file. */
- struct nffs_area_desc descs[NFFS_AREA_MAX];
-
- /* Initialize nffs's internal state. */
- rc = nffs_init();
- assert(rc == 0);
-
- /* Convert the set of flash blocks we intend to use for nffs into an array
- * of nffs area descriptors.
- */
- cnt = NFFS_AREA_MAX;
- rc = flash_area_to_nffs_desc(FLASH_AREA_NFFS, &cnt, descs);
- assert(rc == 0);
-
- /* Attempt to restore an existing nffs file system from flash. */
- if (nffs_detect(descs) == FS_ECORRUPT) {
- /* No valid nffs instance detected; format a new one. */
- rc = nffs_format(descs);
- assert(rc == 0);
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
+ <span style="color: #A90D91">int</span> <span style="color: #000000">cnt</span>;
+
+ <span style="color: #177500">/* NFFS_AREA_MAX is defined in the BSP-specified bsp.h header file. */</span>
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">nffs_area_desc</span> <span style="color: #000000">descs</span>[<span style="color: #000000">NFFS_AREA_MAX</span>];
+
+ <span style="color: #177500">/* Initialize nffs's internal state. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">nffs_init</span>();
+ <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
+
+ <span style="color: #177500">/* Convert the set of flash blocks we intend to use for nffs into an array</span>
+<span style="color: #177500"> * of nffs area descriptors.</span>
+<span style="color: #177500"> */</span>
+ <span style="color: #000000">cnt</span> <span style="color: #000000">=</span> <span style="color: #000000">NFFS_AREA_MAX</span>;
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">flash_area_to_nffs_desc</span>(<span style="color: #000000">FLASH_AREA_NFFS</span>, <span style="color: #000000">&cnt</span>, <span style="color: #000000">descs</span>);
+ <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
+
+ <span style="color: #177500">/* Attempt to restore an existing nffs file system from flash. */</span>
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">nffs_detect</span>(<span style="color: #000000">descs</span>) <span style="color: #000000">==</span> <span style="color: #000000">FS_ECORRUPT</span>) {
+ <span style="color: #177500">/* No valid nffs instance detected; format a new one. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">nffs_format</span>(<span style="color: #000000">descs</span>);
+ <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
}
- /* [ ... ] */
+ <span style="color: #177500">/* [ ... ] */</span>
}
</pre></div>
@@ -590,7 +597,7 @@ main(int argc, char **argv)
<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;
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">extern</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">nffs_config</span> <span style="color: #000000">nffs_config</span>;
</pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/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 cbe0f44..4024ef6 100644
--- a/os/modules/fs/nffs/nffs_area_desc/index.html
+++ b/os/modules/fs/nffs/nffs_area_desc/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -533,10 +540,10 @@
</div>
<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. */
- uint8_t nad_flash_id; /* Logical flash id */
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">struct</span> <span style="color: #000000">nffs_area_desc</span> {
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">nad_offset</span>; <span style="color: #177500">/* Flash offset of start of area. */</span>
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">nad_length</span>; <span style="color: #177500">/* Size of area, in bytes. */</span>
+ <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">nad_flash_id</span>; <span style="color: #177500">/* Logical flash id */</span>
};
</pre></div>
@@ -553,7 +560,7 @@
<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</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "nffs/nffs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "nffs/nffs.h"</span>
</pre></div>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/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 95906f1..101a155 100644
--- a/os/modules/fs/nffs/nffs_config/index.html
+++ b/os/modules/fs/nffs/nffs_config/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -533,21 +540,21 @@
</div>
<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;
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">struct</span> <span style="color: #000000">nffs_config</span> {
+ <span style="color: #177500">/** Maximum number of inodes; default=1024. */</span>
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">nc_num_inodes</span>;
- /** Maximum number of data blocks; default=4096. */
- uint32_t nc_num_blocks;
+ <span style="color: #177500">/** Maximum number of data blocks; default=4096. */</span>
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">nc_num_blocks</span>;
- /** Maximum number of open files; default=4. */
- uint32_t nc_num_files;
+ <span style="color: #177500">/** Maximum number of open files; default=4. */</span>
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">nc_num_files</span>;
- /** Inode cache size; default=4. */
- uint32_t nc_num_cache_inodes;
+ <span style="color: #177500">/** Inode cache size; default=4. */</span>
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">nc_num_cache_inodes</span>;
- /** Data block cache size; default=64. */
- uint32_t nc_num_cache_blocks;
+ <span style="color: #177500">/** Data block cache size; default=64. */</span>
+ <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">nc_num_cache_blocks</span>;
};
</pre></div>
@@ -556,12 +563,12 @@
<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</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;
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">extern</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">nffs_config</span> <span style="color: #000000">nffs_config</span>;
</pre></div>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "nffs/nffs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "nffs/nffs.h"</span>
</pre></div>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/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 2f790b1..3d248cb 100644
--- a/os/modules/fs/nffs/nffs_detect/index.html
+++ b/os/modules/fs/nffs/nffs_detect/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -541,7 +548,7 @@
</div>
<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)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">nffs_detect</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">nffs_area_desc</span> <span style="color: #000000">*area_descs</span>)
</pre></div>
@@ -550,8 +557,8 @@
<table>
<thead>
<tr>
-<th>Arguments</th>
-<th>Description</th>
+<th><em>Argument</em></th>
+<th><em>Description</em></th>
</tr>
</thead>
<tbody>
@@ -568,53 +575,53 @@
<li>Other <a href="../../fs/fs_return_codes/">FS error code</a> on failure</li>
</ul>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "nffs/nffs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "nffs/nffs.h"</span>
</pre></div>
<h4 id="example">Example</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">/*** hw/hal/include/hal/flash_map.h */
-
-/*
- * Flash area types
- */
-#define FLASH_AREA_BOOTLOADER 0
-#define FLASH_AREA_IMAGE_0 1
-#define FLASH_AREA_IMAGE_1 2
-#define FLASH_AREA_IMAGE_SCRATCH 3
-#define FLASH_AREA_NFFS 4
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/*** hw/hal/include/hal/flash_map.h */</span>
+
+<span style="color: #177500">/*</span>
+<span style="color: #177500"> * Flash area types</span>
+<span style="color: #177500"> */</span>
+<span style="color: #633820">#define FLASH_AREA_BOOTLOADER 0</span>
+<span style="color: #633820">#define FLASH_AREA_IMAGE_0 1</span>
+<span style="color: #633820">#define FLASH_AREA_IMAGE_1 2</span>
+<span style="color: #633820">#define FLASH_AREA_IMAGE_SCRATCH 3</span>
+<span style="color: #633820">#define FLASH_AREA_NFFS 4</span>
</pre></div>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">/*** project/slinky/src/main.c */
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/*** project/slinky/src/main.c */</span>
-int
-main(int argc, char **argv)
+<span style="color: #A90D91">int</span>
+<span style="color: #000000">main</span>(<span style="color: #A90D91">int</span> <span style="color: #000000">argc</span>, <span style="color: #A90D91">char</span> <span style="color: #000000">**argv</span>)
{
- int rc;
- int cnt;
-
- /* NFFS_AREA_MAX is defined in the BSP-specified bsp.h header file. */
- struct nffs_area_desc descs[NFFS_AREA_MAX];
-
- /* Initialize nffs's internal state. */
- rc = nffs_init();
- assert(rc == 0);
-
- /* Convert the set of flash blocks we intend to use for nffs into an array
- * of nffs area descriptors.
- */
- cnt = NFFS_AREA_MAX;
- rc = flash_area_to_nffs_desc(FLASH_AREA_NFFS, &cnt, descs);
- assert(rc == 0);
-
- /* Attempt to restore an existing nffs file system from flash. */
- if (nffs_detect(descs) == FS_ECORRUPT) {
- /* No valid nffs instance detected; format a new one. */
- rc = nffs_format(descs);
- assert(rc == 0);
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
+ <span style="color: #A90D91">int</span> <span style="color: #000000">cnt</span>;
+
+ <span style="color: #177500">/* NFFS_AREA_MAX is defined in the BSP-specified bsp.h header file. */</span>
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">nffs_area_desc</span> <span style="color: #000000">descs</span>[<span style="color: #000000">NFFS_AREA_MAX</span>];
+
+ <span style="color: #177500">/* Initialize nffs's internal state. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">nffs_init</span>();
+ <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
+
+ <span style="color: #177500">/* Convert the set of flash blocks we intend to use for nffs into an array</span>
+<span style="color: #177500"> * of nffs area descriptors.</span>
+<span style="color: #177500"> */</span>
+ <span style="color: #000000">cnt</span> <span style="color: #000000">=</span> <span style="color: #000000">NFFS_AREA_MAX</span>;
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">flash_area_to_nffs_desc</span>(<span style="color: #000000">FLASH_AREA_NFFS</span>, <span style="color: #000000">&cnt</span>, <span style="color: #000000">descs</span>);
+ <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
+
+ <span style="color: #177500">/* Attempt to restore an existing nffs file system from flash. */</span>
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">nffs_detect</span>(<span style="color: #000000">descs</span>) <span style="color: #000000">==</span> <span style="color: #000000">FS_ECORRUPT</span>) {
+ <span style="color: #177500">/* No valid nffs instance detected; format a new one. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">nffs_format</span>(<span style="color: #000000">descs</span>);
+ <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
}
- /* [ ... ] */
+ <span style="color: #177500">/* [ ... ] */</span>
}
</pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/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 e568945..5486aa3 100644
--- a/os/modules/fs/nffs/nffs_format/index.html
+++ b/os/modules/fs/nffs/nffs_format/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -541,7 +548,7 @@
</div>
<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)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">nffs_format</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">nffs_area_desc</span> <span style="color: #000000">*area_descs</span>)
</pre></div>
@@ -550,8 +557,8 @@
<table>
<thead>
<tr>
-<th>Arguments</th>
-<th>Description</th>
+<th><em>Argument</em></th>
+<th><em>Description</em></th>
</tr>
</thead>
<tbody>
@@ -567,53 +574,53 @@
<li><a href="../../fs/fs_return_codes/">FS error code</a> on failure.</li>
</ul>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "nffs/nffs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "nffs/nffs.h"</span>
</pre></div>
<h4 id="example">Example</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">/*** hw/hal/include/hal/flash_map.h */
-
-/*
- * Flash area types
- */
-#define FLASH_AREA_BOOTLOADER 0
-#define FLASH_AREA_IMAGE_0 1
-#define FLASH_AREA_IMAGE_1 2
-#define FLASH_AREA_IMAGE_SCRATCH 3
-#define FLASH_AREA_NFFS 4
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/*** hw/hal/include/hal/flash_map.h */</span>
+
+<span style="color: #177500">/*</span>
+<span style="color: #177500"> * Flash area types</span>
+<span style="color: #177500"> */</span>
+<span style="color: #633820">#define FLASH_AREA_BOOTLOADER 0</span>
+<span style="color: #633820">#define FLASH_AREA_IMAGE_0 1</span>
+<span style="color: #633820">#define FLASH_AREA_IMAGE_1 2</span>
+<span style="color: #633820">#define FLASH_AREA_IMAGE_SCRATCH 3</span>
+<span style="color: #633820">#define FLASH_AREA_NFFS 4</span>
</pre></div>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">/*** project/slinky/src/main.c */
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/*** project/slinky/src/main.c */</span>
-int
-main(int argc, char **argv)
+<span style="color: #A90D91">int</span>
+<span style="color: #000000">main</span>(<span style="color: #A90D91">int</span> <span style="color: #000000">argc</span>, <span style="color: #A90D91">char</span> <span style="color: #000000">**argv</span>)
{
- int rc;
- int cnt;
-
- /* NFFS_AREA_MAX is defined in the BSP-specified bsp.h header file. */
- struct nffs_area_desc descs[NFFS_AREA_MAX];
-
- /* Initialize nffs's internal state. */
- rc = nffs_init();
- assert(rc == 0);
-
- /* Convert the set of flash blocks we intend to use for nffs into an array
- * of nffs area descriptors.
- */
- cnt = NFFS_AREA_MAX;
- rc = flash_area_to_nffs_desc(FLASH_AREA_NFFS, &cnt, descs);
- assert(rc == 0);
-
- /* Attempt to restore an existing nffs file system from flash. */
- if (nffs_detect(descs) == FS_ECORRUPT) {
- /* No valid nffs instance detected; format a new one. */
- rc = nffs_format(descs);
- assert(rc == 0);
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
+ <span style="color: #A90D91">int</span> <span style="color: #000000">cnt</span>;
+
+ <span style="color: #177500">/* NFFS_AREA_MAX is defined in the BSP-specified bsp.h header file. */</span>
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">nffs_area_desc</span> <span style="color: #000000">descs</span>[<span style="color: #000000">NFFS_AREA_MAX</span>];
+
+ <span style="color: #177500">/* Initialize nffs's internal state. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">nffs_init</span>();
+ <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
+
+ <span style="color: #177500">/* Convert the set of flash blocks we intend to use for nffs into an array</span>
+<span style="color: #177500"> * of nffs area descriptors.</span>
+<span style="color: #177500"> */</span>
+ <span style="color: #000000">cnt</span> <span style="color: #000000">=</span> <span style="color: #000000">NFFS_AREA_MAX</span>;
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">flash_area_to_nffs_desc</span>(<span style="color: #000000">FLASH_AREA_NFFS</span>, <span style="color: #000000">&cnt</span>, <span style="color: #000000">descs</span>);
+ <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
+
+ <span style="color: #177500">/* Attempt to restore an existing nffs file system from flash. */</span>
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">nffs_detect</span>(<span style="color: #000000">descs</span>) <span style="color: #000000">==</span> <span style="color: #000000">FS_ECORRUPT</span>) {
+ <span style="color: #177500">/* No valid nffs instance detected; format a new one. */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">nffs_format</span>(<span style="color: #000000">descs</span>);
+ <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
}
- /* [ ... ] */
+ <span style="color: #177500">/* [ ... ] */</span>
}
</pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/bdc0c773/os/modules/fs/nffs/nffs_init/index.html
----------------------------------------------------------------------
diff --git a/os/modules/fs/nffs/nffs_init/index.html b/os/modules/fs/nffs/nffs_init/index.html
index e26c209..80e93e2 100644
--- a/os/modules/fs/nffs/nffs_init/index.html
+++ b/os/modules/fs/nffs/nffs_init/index.html
@@ -46,6 +46,11 @@
+
+
+
+
+
<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
@@ -79,7 +84,9 @@
>
<a href="/about/">About</a>
</li>
- <li>
+ <li
+ class="active"
+>
<a href="/os/introduction/">Documentation</a>
</li>
<li
@@ -112,7 +119,7 @@
<div class="container">
<div class="row">
- <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
<div role="search">
@@ -541,7 +548,7 @@
</div>
<h2 id="nffs95init"><font color="F2853F" style="font-size:24pt">nffs_init</font></h2>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">int nffs_init(void)
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">nffs_init</span>(<span style="color: #A90D91">void</span>)
</pre></div>
@@ -552,7 +559,7 @@
<li><a href="../../fs/fs_return_codes/">FS error code</a> on failure</li>
</ul>
<h4 id="header-file">Header file</h4>
-<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">#include "nffs/nffs.h"
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "nffs/nffs.h"</span>
</pre></div>
<div class="row">