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/06/28 21:56:20 UTC
[6/7] incubator-mynewt-site git commit: Pushing pull requests #98 by
bgiori and #99 by spoonofpower for function descriptions in docs and Docker
installation instruction changes respectively
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ae75dc7d/develop/os/modules/fs/fs/fs/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/fs/fs/fs/index.html b/develop/os/modules/fs/fs/fs/index.html
index 49acb02..cc1635d 100644
--- a/develop/os/modules/fs/fs/fs/index.html
+++ b/develop/os/modules/fs/fs/fs/index.html
@@ -610,28 +610,99 @@ pkg.deps:
<li><a href="../fs_return_codes/">Return Codes</a></li>
</ul>
<p>The functions available in this OS feature are:</p>
-<ul>
-<li><a href="../fs_close/">fs_close</a></li>
-<li><a href="../fs_closedir/">fs_closedir</a></li>
-<li><a href="../fs_dirent_is_dir/">fs_dirent_is_dir</a></li>
-<li><a href="../fs_dirent_name/">fs_dirent_name</a></li>
-<li><a href="../fs_filelen/">fs_filelen</a></li>
-<li><a href="../fs_getpos/">fs_getpos</a></li>
-<li><a href="../fs_mkdir/">fs_mkdir</a></li>
-<li><a href="../fs_open/">fs_open</a></li>
-<li><a href="../fs_opendir/">fs_opendir</a></li>
-<li><a href="../fs_read/">fs_read</a></li>
-<li><a href="../fs_readdir/">fs_readdir</a></li>
-<li><a href="../fs_rename/">fs_rename</a></li>
-<li><a href="../fs_seek/">fs_seek</a></li>
-<li><a href="../fs_unlink/">fs_unlink</a></li>
-<li><a href="../fs_write/">fs_write</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th>Function</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../fs_close/">fs_close</a></td>
+<td>Closes the specified file and invalidates the file handle.</td>
+</tr>
+<tr>
+<td><a href="../fs_closedir/">fs_closedir</a></td>
+<td>Closes the specified directory handle.</td>
+</tr>
+<tr>
+<td><a href="../fs_dirent_is_dir/">fs_dirent_is_dir</a></td>
+<td>Tells you whether the specified directory entry is a sub-directory or a regular file.</td>
+</tr>
+<tr>
+<td><a href="../fs_dirent_name/">fs_dirent_name</a></td>
+<td>Retrieves the filename of the specified directory entry.</td>
+</tr>
+<tr>
+<td><a href="../fs_filelen/">fs_filelen</a></td>
+<td>Retrieves the current length of the specified open file.</td>
+</tr>
+<tr>
+<td><a href="../fs_getpos/">fs_getpos</a></td>
+<td>Retrieves the current read and write position of the specified open file.</td>
+</tr>
+<tr>
+<td><a href="../fs_mkdir/">fs_mkdir</a></td>
+<td>Creates the directory represented by the specified path.</td>
+</tr>
+<tr>
+<td><a href="../fs_open/">fs_open</a></td>
+<td>Opens a file at the specified path.</td>
+</tr>
+<tr>
+<td><a href="../fs_opendir/">fs_opendir</a></td>
+<td>Opens the directory at the specified path.</td>
+</tr>
+<tr>
+<td><a href="../fs_read/">fs_read</a></td>
+<td>Reads data from the specified file.</td>
+</tr>
+<tr>
+<td><a href="../fs_readdir/">fs_readdir</a></td>
+<td>Reads the next entry in an open directory.</td>
+</tr>
+<tr>
+<td><a href="../fs_register/">fs_register</a></td>
+<td>Registers a file system with the abstraction layer.</td>
+</tr>
+<tr>
+<td><a href="../fs_rename/">fs_rename</a></td>
+<td>Performs a rename and/or move of the specified source path to the specified destination.</td>
+</tr>
+<tr>
+<td><a href="../fs_seek/">fs_seek</a></td>
+<td>Positions a file's read and write pointer at the specified offset.</td>
+</tr>
+<tr>
+<td><a href="../fs_unlink/">fs_unlink</a></td>
+<td>Unlinks the file or directory at the specified path.</td>
+</tr>
+<tr>
+<td><a href="../fs_write/">fs_write</a></td>
+<td>Writes the supplied data to the current offset of the specified file handle.</td>
+</tr>
+</tbody>
+</table>
<p>Additional file system utilities that bundle some of the basic functions above are:</p>
-<ul>
-<li><a href="../fsutil_read_file/">fsutil_read_file</a></li>
-<li><a href="../fsutil_write_file/">fsutil_write_file</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th>Function</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../fsutil_read_file/">fsutil_read_file</a></td>
+<td>Opens a file at the specified path, retrieve data from the file starting from the specified offset, and close the file and invalidate the file handle.</td>
+</tr>
+<tr>
+<td><a href="../fsutil_write_file/">fsutil_write_file</a></td>
+<td>Open a file at the specified path, write the supplied data to the current offset of the specified file handle, and close the file and invalidate the file handle.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ae75dc7d/develop/os/modules/fs/nffs/nffs/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/fs/nffs/nffs/index.html b/develop/os/modules/fs/nffs/nffs/index.html
index acbdd31..29f997f 100644
--- a/develop/os/modules/fs/nffs/nffs/index.html
+++ b/develop/os/modules/fs/nffs/nffs/index.html
@@ -622,17 +622,48 @@
<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>
+<table>
+<thead>
+<tr>
+<th>Struct</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../nffs_area_desc/">struct nffs_area_desc</a></td>
+<td>Descriptor for a single nffs area.</td>
+</tr>
+<tr>
+<td><a href="../nffs_config/">struct nffs_config</a></td>
+<td>Configuration struct for nffs.</td>
+</tr>
+</tbody>
+</table>
<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>
+<table>
+<thead>
+<tr>
+<th>Function</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../nffs_detect/">nffs_detect</a></td>
+<td>Searches for a valid nffs file system among the specified areas.</td>
+</tr>
+<tr>
+<td><a href="../nffs_format/">nffs_format</a></td>
+<td>Erases all the specified areas and initializes them with a clean nffs file system.</td>
+</tr>
+<tr>
+<td><a href="../nffs_init/">nffs_init</a></td>
+<td>Initializes internal nffs memory and data structures.</td>
+</tr>
+</tbody>
+</table>
<h3 id="miscellaneous-measures">Miscellaneous measures</h3>
<ul>
<li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ae75dc7d/develop/os/modules/imgmgr/imgmgr/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/imgmgr/imgmgr/index.html b/develop/os/modules/imgmgr/imgmgr/index.html
index 8c9a844..fad64d9 100644
--- a/develop/os/modules/imgmgr/imgmgr/index.html
+++ b/develop/os/modules/imgmgr/imgmgr/index.html
@@ -494,11 +494,28 @@
<h3 id="list-of-functions">List of Functions</h3>
<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in imgmgr are:</p>
-<ul>
-<li><a href="../imgmgr_module_init/">imgmgr_module_init</a></li>
-<li><a href="../imgr_ver_parse/">imgr_ver_parse</a></li>
-<li><a href="../imgr_ver_str/">imgr_ver_str</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th>Function</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../imgmgr_module_init/">imgmgr_module_init</a></td>
+<td>Registers image manager commands with newtmgr.</td>
+</tr>
+<tr>
+<td><a href="../imgr_ver_parse/">imgr_ver_parse</a></td>
+<td>Parses character string containing specified image version number and writes that to given image_version struct.</td>
+</tr>
+<tr>
+<td><a href="../imgr_ver_str/">imgr_ver_str</a></td>
+<td>Takes version string from specified image_version struct and formats it into a printable string.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ae75dc7d/develop/os/modules/json/json/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/json/json/index.html b/develop/os/modules/json/json/index.html
index 8b0f235..f6f846c 100644
--- a/develop/os/modules/json/json/index.html
+++ b/develop/os/modules/json/json/index.html
@@ -608,16 +608,47 @@ This function should collect all the data encoder function generates. It can col
</table>
<h2 id="list-of-functions">List of Functions</h2>
<p>Functions for encoding:</p>
-<ul>
-<li><a href="../json_encode_object_start/">json_encode_object_start</a></li>
-<li><a href="../json_encode_object_key/">json_encode_object_key</a></li>
-<li><a href="../json_encode_object_entry/">json_encode_object_entry</a></li>
-<li><a href="../json_encode_object_finish/">json_encode_object_finish</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th>Function</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../json_encode_object_start/">json_encode_object_start</a></td>
+<td>This function starts the encoded JSON object.</td>
+</tr>
+<tr>
+<td><a href="../json_encode_object_key/">json_encode_object_key</a></td>
+<td>This function writes out a name for a field, followed by ":" character.</td>
+</tr>
+<tr>
+<td><a href="../json_encode_object_entry/">json_encode_object_entry</a></td>
+<td>This function writes out a name for a field, followed by ":" character, and the value itself.</td>
+</tr>
+<tr>
+<td><a href="../json_encode_object_finish/">json_encode_object_finish</a></td>
+<td>This function finalizes the encoded JSON object.</td>
+</tr>
+</tbody>
+</table>
<p>Functions for decoding:</p>
-<ul>
-<li><a href="../json_read_object/">json_read_object</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th>Function</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../json_read_object/">json_read_object</a></td>
+<td>This function reads in JSON data stream, while looking for name/value pairs described in given attribites.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ae75dc7d/develop/os/modules/shell/shell/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/shell/shell/index.html b/develop/os/modules/shell/shell/index.html
index becb674..1a9d59c 100644
--- a/develop/os/modules/shell/shell/index.html
+++ b/develop/os/modules/shell/shell/index.html
@@ -598,12 +598,32 @@ stat stat
<h3 id="list-of-functions">List of Functions</h3>
<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions available in this OS feature are:</p>
-<ul>
-<li><a href="../shell_task_init/">shell_task_init</a></li>
-<li><a href="../shell_cmd_register/">shell_cmd_register</a></li>
-<li><a href="../shell_nlip_input_register/">shell_nlip_input_register</a></li>
-<li><a href="../shell_nlip_output/">shell_nlip_output</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th>Function</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../shell_task_init/">shell_task_init</a></td>
+<td>Initializes the shell package. This creates a task for shell, and registers few commands on its own.</td>
+</tr>
+<tr>
+<td><a href="../shell_cmd_register/">shell_cmd_register</a></td>
+<td>Registers a handler for incoming console commands.</td>
+</tr>
+<tr>
+<td><a href="../shell_nlip_input_register/">shell_nlip_input_register</a></td>
+<td>Registers a handler for incoming newtmgr messages.</td>
+</tr>
+<tr>
+<td><a href="../shell_nlip_output/">shell_nlip_output</a></td>
+<td>Queue outgoing newtmgr message for transmission.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ae75dc7d/develop/os/modules/testutil/testutil/index.html
----------------------------------------------------------------------
diff --git a/develop/os/modules/testutil/testutil/index.html b/develop/os/modules/testutil/testutil/index.html
index 5698cc5..3886d68 100644
--- a/develop/os/modules/testutil/testutil/index.html
+++ b/develop/os/modules/testutil/testutil/index.html
@@ -549,15 +549,44 @@ This should be populated before <code>tu_init()</code> is called.</p>
<h3 id="list-of-functions">List of Functions</h3>
<p><Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.></p>
<p>The functions, and macros available in <code>testutil</code> are:</p>
-<ul>
-<li><a href="../tu_init/">tu_init</a></li>
-<li><a href="../test_assert/">TEST_ASSERT</a></li>
-<li><a href="../test_pass/">TEST_PASS</a></li>
-<li><a href="../test_suite/">TEST_SUITE</a></li>
-<li><a href="../test_case/">TEST_CASE</a></li>
-<li><a href="../test_decl/">TEST_CASE_DECL</a></li>
-<li><a href="../tu_restart/">tu_restart</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th>Function</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../tu_init/">tu_init</a></td>
+<td>Initializes the test framework according to the contents of the tu_config struct.</td>
+</tr>
+<tr>
+<td><a href="../test_assert/">TEST_ASSERT</a></td>
+<td>Asserts that the specified condition is true.</td>
+</tr>
+<tr>
+<td><a href="../test_pass/">TEST_PASS</a></td>
+<td>Reports a success result for the current test.</td>
+</tr>
+<tr>
+<td><a href="../test_suite/">TEST_SUITE</a></td>
+<td>Declares a test suite function.</td>
+</tr>
+<tr>
+<td><a href="../test_case/">TEST_CASE</a></td>
+<td>Defines a test case function.</td>
+</tr>
+<tr>
+<td><a href="../test_decl/">TEST_CASE_DECL</a></td>
+<td>Declares a test case function. his is only required if the test case function exists in a different file than the test suite.</td>
+</tr>
+<tr>
+<td><a href="../tu_restart/">tu_restart</a></td>
+<td>This function is used when a system reset is necessary to proceed with testing.</td>
+</tr>
+</tbody>
+</table>
<div class="row">