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/03/04 23:35:50 UTC
[3/3] incubator-mynewt-site git commit: mqueue documentation added.
This closes #30.
mqueue documentation added. This closes #30.
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/a72d044c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/a72d044c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/a72d044c
Branch: refs/heads/master
Commit: a72d044cd34c873e2aa78f4a50e0fc7e973d8eec
Parents: ebb9dcb
Author: aditihilbert <ad...@runtime.io>
Authored: Fri Mar 4 14:35:31 2016 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Fri Mar 4 14:35:31 2016 -0800
----------------------------------------------------------------------
docs/os/core_os/mqueue/mqueue.md | 6 +++---
docs/os/core_os/mqueue/os_mqueue_put.md | 1 +
docs/os/core_os/msys/os_msys_register.md | 4 ----
docs/os/core_os/msys/os_msys_reset.md | 4 ----
4 files changed, 4 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/a72d044c/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 93e3c7b..7344ac4 100644
--- a/docs/os/core_os/mqueue/mqueue.md
+++ b/docs/os/core_os/mqueue/mqueue.md
@@ -1,14 +1,14 @@
# Mqueue
-Mqueue (Mbuf event queue) is a set of API built on top of the mbuf and event queue code. A typical networking stack operation is to put a packet on a queue and post an event to the task handling that queue. Mqueue was designed to provide a common api so that individual packages would not each have to create similar code.
+Mqueue (Mbuf event queue) is a set of API built on top of the mbuf and event queue code. A typical networking stack operation is to put a packet on a queue and post an event to the task handling that queue. Mqueue was designed to provide a common API so that individual packages would not each have to create similar code.
-The mqueue data structure consists of a queue head pointer (a "stailq" queue; a singly linked list with head structure having a pointer to the start and end of the list) and an os event structure. Packets (packet header mbufs) are added to the queue using the *omp_next* pointer in the `os_mbuf_pkthdr` structure of the mbuf. The event is used to post a task an event of type OS_EVENT_T_MQUEUE_DATA.
+The mqueue data structure consists of a queue head pointer (a "stailq" queue; a singly linked list with head structure having a pointer to the start and end of the list) and an os event structure. Packets (packet header mbufs) are added to the queue using the *omp_next* pointer in the `os_mbuf_pkthdr` structure of the mbuf. The event is used to post to the task an event of type OS_EVENT_T_MQUEUE_DATA.
<br>
## Using Mqueue
-The following code sample will demonstrate how to use an mqueue. This is a simple example where packets are put on a ""receive queue"" and a task processes that receive queue by incrementing the total number of packet received and then freeing the packet. Not shown in the code example is a call my_task_rx_data_func. Presumably, some other code will call this API.
+The following code sample will demonstrate how to use an mqueue. This is a simple example where packets are put on a "receive queue" and a task processes that "receive queue" by incrementing the total number of packet received and then freeing the packet. Not shown in the code example is a call my_task_rx_data_func. Presumably, some other code will call this API.
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/a72d044c/docs/os/core_os/mqueue/os_mqueue_put.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mqueue/os_mqueue_put.md b/docs/os/core_os/mqueue/os_mqueue_put.md
index a8b379c..b12aef4 100644
--- a/docs/os/core_os/mqueue/os_mqueue_put.md
+++ b/docs/os/core_os/mqueue/os_mqueue_put.md
@@ -21,6 +21,7 @@ Adds a packet (i.e. packet header mbuf) to an mqueue. Post event to *evq*.
#### Returned values
0: success
+
OS_EINVAL: the mbuf is not a packet header mbuf.
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/a72d044c/docs/os/core_os/msys/os_msys_register.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/msys/os_msys_register.md b/docs/os/core_os/msys/os_msys_register.md
index 8fb4257..c3726a0 100644
--- a/docs/os/core_os/msys/os_msys_register.md
+++ b/docs/os/core_os/msys/os_msys_register.md
@@ -21,10 +21,6 @@ Register an mbuf pool for use as a system mbuf pool. The pool should be initiali
<br>
-#### Notes
-
-<br>
-
#### Example
```no-highlight
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/a72d044c/docs/os/core_os/msys/os_msys_reset.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/msys/os_msys_reset.md b/docs/os/core_os/msys/os_msys_reset.md
index 1ed5875..a01bfd8 100644
--- a/docs/os/core_os/msys/os_msys_reset.md
+++ b/docs/os/core_os/msys/os_msys_reset.md
@@ -20,10 +20,6 @@ None
<br>
-#### Notes
-
-<br>
-
#### Example
```no-highlight