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:58:10 UTC
[2/6] incubator-mynewt-site git commit: Updated OS Module function
lists to include descriptions
Updated OS Module function lists to include descriptions
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/09a360be
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/09a360be
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/09a360be
Branch: refs/heads/master
Commit: 09a360bee574752f8518bb65d796e610f998b504
Parents: 3c863ed
Author: = <=>
Authored: Tue Jun 28 13:12:30 2016 -0700
Committer: = <=>
Committed: Tue Jun 28 13:12:30 2016 -0700
----------------------------------------------------------------------
docs/os/modules/console/console.md | 16 +++++++------
docs/os/modules/elua/elua.md | 6 +++--
docs/os/modules/fs/fs/fs.md | 39 +++++++++++++++++--------------
docs/os/modules/fs/nffs/nffs.md | 14 +++++++----
docs/os/modules/imgmgr/imgmgr.md | 8 ++++---
docs/os/modules/json/json.md | 14 +++++++----
docs/os/modules/shell/shell.md | 11 +++++----
docs/os/modules/testutil/testutil.md | 16 +++++++------
8 files changed, 74 insertions(+), 50 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/09a360be/docs/os/modules/console/console.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/console/console.md b/docs/os/modules/console/console.md
index d890fb8..53d195b 100644
--- a/docs/os/modules/console/console.md
+++ b/docs/os/modules/console/console.md
@@ -55,13 +55,15 @@ N/A
The functions available in console are:
-* [console_blocking_mode](console_blocking_mode.md)
-* [console_echo](console_echo.md)
-* [console_init](console_init.md)
-* [console_is_init](console_is_init.md)
-* [console_printf](console_printf.md)
-* [console_read](console_read.md)
-* [console_write](console_write.md)
+| Function | Description |
+|---------|-------------|
+| [console_blocking_mode](console_blocking_mode.md) | Calls the `console_blocking_tx` function to flush the buffered console output (transmit) queue. |
+| [console_echo](console_echo.md) | Controls whether echoing is on or off for the console. |
+| [console_init](console_init.md) | Initialize the console. |
+| [console_is_init](console_is_init.md) | Returns whether console has been initialized or not. |
+| [console_printf](console_printf.md) | Writes a formatted message instead of raw output to the console. |
+| [console_read](console_read.md) | Copies up the to given number of bytes to the input string. |
+| [console_write](console_write.md) | Queues characters to console display over serial port. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/09a360be/docs/os/modules/elua/elua.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/elua/elua.md b/docs/os/modules/elua/elua.md
index 1cd3693..a3c0ac2 100644
--- a/docs/os/modules/elua/elua.md
+++ b/docs/os/modules/elua/elua.md
@@ -15,7 +15,9 @@ Currently we don't have language extension modules which would go together with
###List of Functions
-* [lua_init](lua_init.md)
-* [lua_main](lua_main.md)
+| Function | Description |
+|---------|-------------|
+| [lua_init](lua_init.md) | Registers 'lua' command with shell. |
+| [lua_main](lua_main.md) | Executes lua script in current task's context. Arguments given are passed to lua interpreter. |
<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.>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/09a360be/docs/os/modules/fs/fs/fs.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/fs/fs/fs.md b/docs/os/modules/fs/fs/fs.md
index 89f1da5..e36995a 100644
--- a/docs/os/modules/fs/fs/fs.md
+++ b/docs/os/modules/fs/fs/fs.md
@@ -84,23 +84,28 @@ Functions in `fs/fs` that indicate success or failure do so with the following s
The functions available in this OS feature are:
-* [fs\_close](fs_close.md)
-* [fs\_closedir](fs_closedir.md)
-* [fs\_dirent\_is\_dir](fs_dirent_is_dir.md)
-* [fs\_dirent\_name](fs_dirent_name.md)
-* [fs\_filelen](fs_filelen.md)
-* [fs\_getpos](fs_getpos.md)
-* [fs\_mkdir](fs_mkdir.md)
-* [fs\_open](fs_open.md)
-* [fs\_opendir](fs_opendir.md)
-* [fs\_read](fs_read.md)
-* [fs\_readdir](fs_readdir.md)
-* [fs\_rename](fs_rename.md)
-* [fs\_seek](fs_seek.md)
-* [fs\_unlink](fs_unlink.md)
-* [fs\_write](fs_write.md)
+| Function | Description |
+|---------|-------------|
+| [fs\_close](fs_close.md) | Closes the specified file and invalidates the file handle. |
+| [fs\_closedir](fs_closedir.md) | Closes the specified directory handle. |
+| [fs\_dirent\_is\_dir](fs_dirent_is_dir.md) | Tells you whether the specified directory entry is a sub-directory or a regular file. |
+| [fs\_dirent\_name](fs_dirent_name.md) | Retrieves the filename of the specified directory entry. |
+| [fs\_filelen](fs_filelen.md) | Retrieves the current length of the specified open file. |
+| [fs\_getpos](fs_getpos.md) | Retrieves the current read and write position of the specified open file. |
+| [fs\_mkdir](fs_mkdir.md) | Creates the directory represented by the specified path. |
+| [fs\_open](fs_open.md) | Opens a file at the specified path. |
+| [fs\_opendir](fs_opendir.md) | Opens the directory at the specified path. |
+| [fs\_read](fs_read.md) | Reads data from the specified file. |
+| [fs\_readdir](fs_readdir.md) | Reads the next entry in an open directory. |
+| [fs\_register](fs_register.md) | Registers a file system with the abstraction layer. |
+| [fs\_rename](fs_rename.md) | Performs a rename and/or move of the specified source path to the specified destination. |
+| [fs\_seek](fs_seek.md) | Positions a file's read and write pointer at the specified offset. |
+| [fs\_unlink](fs_unlink.md) | Unlinks the file or directory at the specified path. |
+| [fs\_write](fs_write.md) | Writes the supplied data to the current offset of the specified file handle. |
Additional file system utilities that bundle some of the basic functions above are:
-* [fsutil\_read\_file](fsutil_read_file.md)
-* [fsutil\_write\_file](fsutil_write_file.md)
+| Function | Description |
+|---------|-------------|
+| [fsutil\_read\_file](fsutil_read_file.md) | 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. |
+| [fsutil\_write\_file](fsutil_write_file.md) | 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. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/09a360be/docs/os/modules/fs/nffs/nffs.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/fs/nffs/nffs.md b/docs/os/modules/fs/nffs/nffs.md
index 6a84d27..7a79ae7 100644
--- a/docs/os/modules/fs/nffs/nffs.md
+++ b/docs/os/modules/fs/nffs/nffs.md
@@ -101,16 +101,20 @@ extern struct nffs_config nffs_config;
The `fs/nffs` package exposes the following data structures:
-* [struct nffs\_area\_desc](nffs_area_desc.md)
-* [struct nffs\_config](nffs_config.md)
+| Struct | Description |
+|---------|-------------|
+| [struct nffs\_area\_desc](nffs_area_desc.md) | Descriptor for a single nffs area. |
+| [struct nffs\_config](nffs_config.md) | Configuration struct for nffs. |
###API
The functions available in this OS feature are:
-* [nffs\_detect](nffs_detect.md)
-* [nffs\_format](nffs_format.md)
-* [nffs\_init](nffs_init.md)
+| Function | Description |
+|---------|-------------|
+| [nffs\_detect](nffs_detect.md) | Searches for a valid nffs file system among the specified areas. |
+| [nffs\_format](nffs_format.md) | rases all the specified areas and initializes them with a clean nffs file system. |
+| [nffs\_init](nffs_init.md) | Initializes internal nffs memory and data structures. |
###Miscellaneous measures
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/09a360be/docs/os/modules/imgmgr/imgmgr.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/imgmgr/imgmgr.md b/docs/os/modules/imgmgr/imgmgr.md
index 187912c..4c49593 100644
--- a/docs/os/modules/imgmgr/imgmgr.md
+++ b/docs/os/modules/imgmgr/imgmgr.md
@@ -27,6 +27,8 @@ N/A.
The functions available in imgmgr are:
-* [imgmgr_module_init](imgmgr_module_init.md)
-* [imgr_ver_parse](imgr_ver_parse.md)
-* [imgr_ver_str](imgr_ver_str.md)
+| Function | Description |
+|---------|-------------|
+| [imgmgr_module_init](imgmgr_module_init.md) | Registers image manager commands with newtmgr. |
+| [imgr_ver_parse](imgr_ver_parse.md) | Parses character string containing specified image version number and writes that to given image_version struct. |
+| [imgr_ver_str](imgr_ver_str.md) | Takes version string from specified image_version struct and formats it into a printable string. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/09a360be/docs/os/modules/json/json.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json.md b/docs/os/modules/json/json.md
index 0297477..ea59e29 100644
--- a/docs/os/modules/json/json.md
+++ b/docs/os/modules/json/json.md
@@ -108,11 +108,15 @@ This structure tells the decoder about a particular name/value pair. Structure m
Functions for encoding:
-* [json_encode_object_start](json_encode_object_start.md)
-* [json_encode_object_key](json_encode_object_key.md)
-* [json_encode_object_entry](json_encode_object_entry.md)
-* [json_encode_object_finish](json_encode_object_finish.md)
+| Function | Description |
+|---------|-------------|
+| [json_encode_object_start](json_encode_object_start.md) | This function starts the encoded JSON object. |
+| [json_encode_object_key](json_encode_object_key.md) | This function writes out a name for a field, followed by ":" character. |
+| [json_encode_object_entry](json_encode_object_entry.md) | This function writes out a name for a field, followed by ":" character, and the value itself. |
+| [json_encode_object_finish](json_encode_object_finish.md) | This function finalizes the encoded JSON object. |
Functions for decoding:
-* [json_read_object](json_read_object.md)
+| Function | Description |
+|---------|-------------|
+| [json_read_object](json_read_object.md) | This function reads in JSON data stream, while looking for name/value pairs described in given attribites. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/09a360be/docs/os/modules/shell/shell.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/shell/shell.md b/docs/os/modules/shell/shell.md
index eaf9409..d3b50f5 100644
--- a/docs/os/modules/shell/shell.md
+++ b/docs/os/modules/shell/shell.md
@@ -111,7 +111,10 @@ struct shell_cmd {
The functions available in this OS feature are:
-* [shell_task_init](shell_task_init.md)
-* [shell_cmd_register](shell_cmd_register.md)
-* [shell_nlip_input_register](shell_nlip_input_register.md)
-* [shell_nlip_output](shell_nlip_output.md)
+| Function | Description |
+|---------|-------------|
+| [shell_task_init](shell_task_init.md) | Initializes the shell package. This creates a task for shell, and registers few commands on its own. |
+| [shell_cmd_register](shell_cmd_register.md) | Registers a handler for incoming console commands. |
+| [shell_nlip_input_register](shell_nlip_input_register.md) | Registers a handler for incoming newtmgr messages. |
+| [shell_nlip_output](shell_nlip_output.md) | Queue outgoing newtmgr message for transmission. |
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/09a360be/docs/os/modules/testutil/testutil.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/testutil/testutil.md b/docs/os/modules/testutil/testutil.md
index 693568f..37996da 100644
--- a/docs/os/modules/testutil/testutil.md
+++ b/docs/os/modules/testutil/testutil.md
@@ -82,10 +82,12 @@ This should be populated before `tu_init()` is called.
The functions, and macros available in `testutil` are:
-* [tu_init](tu_init.md)
-* [TEST_ASSERT](test_assert.md)
-* [TEST_PASS](test_pass.md)
-* [TEST_SUITE](test_suite.md)
-* [TEST_CASE](test_case.md)
-* [TEST_CASE_DECL](test_decl.md)
-* [tu_restart](tu_restart.md)
+| Function | Description |
+|---------|-------------|
+| [tu_init](tu_init.md) | Initializes the test framework according to the contents of the tu_config struct. |
+| [TEST_ASSERT](test_assert.md) | Asserts that the specified condition is true. |
+| [TEST_PASS](test_pass.md) | Reports a success result for the current test. |
+| [TEST_SUITE](test_suite.md) | Declares a test suite function. |
+| [TEST_CASE](test_case.md) | Defines a test case function. |
+| [TEST_CASE_DECL](test_decl.md) | Declares a test case function. his is only required if the test case function exists in a different file than the test suite. |
+| [tu_restart](tu_restart.md) | This function is used when a system reset is necessary to proceed with testing. |