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/23 21:20:05 UTC
[13/16] incubator-mynewt-site git commit: Updated function list to
tables for callout, mqueue, msys, and sanity.
Updated function list to tables for callout, mqueue, msys, and sanity.
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/3c863ede
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/3c863ede
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/3c863ede
Branch: refs/heads/master
Commit: 3c863edee981f21ef352cb10cc87cd0d5b1f2c90
Parents: cefe988
Author: = <=>
Authored: Thu Jun 23 10:30:10 2016 -0700
Committer: = <=>
Committed: Thu Jun 23 10:30:10 2016 -0700
----------------------------------------------------------------------
docs/os/core_os/callout/callout.md | 12 +++++++-----
docs/os/core_os/mqueue/mqueue.md | 8 +++++---
docs/os/core_os/msys/msys.md | 10 ++++++----
docs/os/core_os/sanity/sanity.md | 12 +++++++-----
4 files changed, 25 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c863ede/docs/os/core_os/callout/callout.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/callout/callout.md b/docs/os/core_os/callout/callout.md
index e99acd8..042dd7b 100644
--- a/docs/os/core_os/callout/callout.md
+++ b/docs/os/core_os/callout/callout.md
@@ -53,9 +53,11 @@ Callout timer fires out just once. For periodic timer type of operation you need
The functions available in callout are:
-* [os_callout_func_init](os_callout_func_init)
-* [os_callout_init](os_callout_init)
-* [os_callout_queued](os_callout_queued)
-* [os_callout_reset](os_callout_reset)
-* [os_callout_stop](os_callout_stop)
+| **Function** | **Description** |
+|-----------|-------------|
+| [os_callout_func_init](os_callout_func_init) | Initializes the given callout function struct. |
+| [os_callout_init](os_callout_init) | Initializes the given callout struct. |
+| [os_callout_queued](os_callout_queued) | Checks whether the given callout has been armed. |
+| [os_callout_reset](os_callout_reset) | Resets the callout to happen in the given number of OS ticks. |
+| [os_callout_stop](os_callout_stop) | Disarms a timer. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c863ede/docs/os/core_os/mqueue/mqueue.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mqueue/mqueue.md b/docs/os/core_os/mqueue/mqueue.md
index 44ad81b..ac0de39 100644
--- a/docs/os/core_os/mqueue/mqueue.md
+++ b/docs/os/core_os/mqueue/mqueue.md
@@ -90,7 +90,9 @@ struct os_mqueue {
The functions available in Mqueue are:
-* [os_mqueue_init](os_mqueue_init.md)
-* [os_mqueue_get](os_mqueue_get.md)
-* [os_mqueue_put](os_mqueue_put.md)
+| **Function** | **Description** |
+|-----------|-------------|
+| [os_mqueue_init](os_mqueue_init.md) | Initializes an mqueue. |
+| [os_mqueue_get](os_mqueue_get.md) | Retrieves a packet off an Mqueue. |
+| [os_mqueue_put](os_mqueue_put.md) | Adds a packet (i.e. packet header mbuf) to an mqueue. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c863ede/docs/os/core_os/msys/msys.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/msys/msys.md b/docs/os/core_os/msys/msys.md
index 9bca024..6c3b2ca 100644
--- a/docs/os/core_os/msys/msys.md
+++ b/docs/os/core_os/msys/msys.md
@@ -14,7 +14,9 @@ Note that no added descriptions on how to use the msys API are presented here (o
The functions available in msys are:
-* [os_msys_get](os_msys_get.md)
-* [os_msys_get_pkthdr](os_msys_get_pkthdr.md)
-* [os_msys_register](os_msys_register.md)
-* [os_msys_reset](os_msys_reset.md)
+| **Function** | **Description** |
+|-----------|-------------|
+| [os_msys_get](os_msys_get.md) | Retrieve an mbuf from the system mbuf pools with the given number of bytes available in the mbuf. |
+| [os_msys_get_pkthdr](os_msys_get_pkthdr.md) | Retrieve a packet header mbuf from the system mbuf pools with the given number of bytes available for the user header in the mbuf. |
+| [os_msys_register](os_msys_register.md) | Register an mbuf pool for use as a system mbuf pool. |
+| [os_msys_reset](os_msys_reset.md) | Resets msys module. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c863ede/docs/os/core_os/sanity/sanity.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/sanity/sanity.md b/docs/os/core_os/sanity/sanity.md
index d20e4b1..7091a33 100644
--- a/docs/os/core_os/sanity/sanity.md
+++ b/docs/os/core_os/sanity/sanity.md
@@ -187,8 +187,10 @@ struct os_sanity_check {
The functions available in sanity are:
-* [os_sanity_check_init](os_sanity_check_init.md)
-* [os_sanity_check_register](os_sanity_check_register.md)
-* [os_sanity_check_reset](os_sanity_check_reset.md)
-* [os_sanity_task_checkin](os_sanity_task_checkin.md)
-* [os_sanity_task_init](os_sanity_task_init.md)
+| **Function** | **Description** |
+|-----------|-------------|
+| [os_sanity_check_init](os_sanity_check_init.md) | Initialize the given sanity check. |
+| [os_sanity_check_register](os_sanity_check_register.md) | Register the given sanity check with the sanity task. |
+| [os_sanity_check_reset](os_sanity_check_reset.md) | Reset the given sanity check. |
+| [os_sanity_task_checkin](os_sanity_task_checkin.md) | Informs the sanity task that the given task is still alive and working normally. |
+| [os_sanity_task_init](os_sanity_task_init.md) | Initialize the os sanity task. |