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/03 01:12:10 UTC
[2/4] incubator-mynewt-site git commit: Remove os_mbuf_free() from
exposed API. This is an internal API only
Remove os_mbuf_free() from exposed API. This is an internal API only
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/f4662ecb
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/f4662ecb
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/f4662ecb
Branch: refs/heads/master
Commit: f4662ecb12515e4dc1ed5db4880d366d10b10994
Parents: fb6890b
Author: wes3 <wi...@micosa.io>
Authored: Wed Mar 2 09:43:17 2016 -0800
Committer: wes3 <wi...@micosa.io>
Committed: Wed Mar 2 09:43:17 2016 -0800
----------------------------------------------------------------------
docs/os/core_os/mbuf/mbuf.md | 1 -
docs/os/core_os/mbuf/os_mbuf_free.md | 43 -------------------------------
mkdocs.yml | 1 -
3 files changed, 45 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f4662ecb/docs/os/core_os/mbuf/mbuf.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/mbuf.md b/docs/os/core_os/mbuf/mbuf.md
index 8f39f31..140f335 100644
--- a/docs/os/core_os/mbuf/mbuf.md
+++ b/docs/os/core_os/mbuf/mbuf.md
@@ -225,7 +225,6 @@ The functions/macros available in mbuf are:
* [os_mbuf_copyinto](os_mbuf_copyinto.md)
* [os_mbuf_dup](os_mbuf_dup.md)
* [os_mbuf_extend](os_mbuf_extend.md)
-* [os_mbuf_free](os_mbuf_free.md)
* [os_mbuf_free_chain](os_mbuf_free_chain.md)
* [os_mbuf_get](os_mbuf_get.md)
* [os_mbuf_get_pkthdr](os_mbuf_get_pkthdr.md)
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f4662ecb/docs/os/core_os/mbuf/os_mbuf_free.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_free.md b/docs/os/core_os/mbuf/os_mbuf_free.md
deleted file mode 100644
index 33a966e..0000000
--- a/docs/os/core_os/mbuf/os_mbuf_free.md
+++ /dev/null
@@ -1,43 +0,0 @@
-## <font color="#F2853F" style="font-size:24pt"> os_mbuf_free</font>
-
-```no-highlight
-int os_mbuf_free(struct os_mbuf *om);
-```
-
-Free a single mbuf
-
-<br>
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| om | Pointer to single mbuf |
-
-<br>
-
-#### Returned values
-
-0: success
-Any other value indicates error
-
-<br>
-
-#### Notes
-The mbuf is freed to the pool pointed to by *om_omp* in the mbuf. If the pool pointer is NULL, no error is returned and the mbuf is not freed.
-
-Care should be taked when using this function as any mbufs chained to *om* will be lost as this function assumes no mbufs are chained to *om*.
-
-<br>
-
-#### Example
-
-```no-highlight
- int rc;
- struct os_mbuf *om;
-
- rc = os_mbuf_free(om);
- assert(rc == 0);
-```
-
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f4662ecb/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index c79f8c5..e0a2d84 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -103,7 +103,6 @@ pages:
- 'os_mbuf_copyinto': 'os/core_os/mbuf/os_mbuf_copyinto.md'
- 'os_mbuf_dup': 'os/core_os/mbuf/os_mbuf_dup.md'
- 'os_mbuf_extend': 'os/core_os/mbuf/os_mbuf_extend.md'
- - 'os_mbuf_free': 'os/core_os/mbuf/os_mbuf_free.md'
- 'os_mbuf_free_chain': 'os/core_os/mbuf/os_mbuf_free_chain.md'
- 'os_mbuf_get': 'os/core_os/mbuf/os_mbuf_get.md'
- 'os_mbuf_get_pkthdr': 'os/core_os/mbuf/os_mbuf_get_pkthdr.md'