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 2015/11/19 00:16:09 UTC
[14/17] incubator-mynewt-site git commit: update website with stubs
for doc contributors
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4883e672/chapter3/newt_tool_reference/index.html
----------------------------------------------------------------------
diff --git a/chapter3/newt_tool_reference/index.html b/chapter3/newt_tool_reference/index.html
index f1fc87c..d7bff91 100644
--- a/chapter3/newt_tool_reference/index.html
+++ b/chapter3/newt_tool_reference/index.html
@@ -1,236 +1,362 @@
<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Command list - Mynewt</title>
+
+
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "Command list";
+ </script>
+
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
+ <script src="../../js/theme.js"></script>
+
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href="../.." class="icon icon-home"> Mynewt</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+ <li>
+ <li class="toctree-l1 ">
+ <a class="" href="../..">Home</a>
+ </li>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Started</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/newt_concepts/">Newt Concepts</a>
- <link rel="canonical" href="http://mynewt.incubator.apache.org/index.html/chapter3/newt_tool_reference/">
- <link rel="shortcut icon" href="../../img/favicon.ico">
+ </li>
- <title>Command list - Mynewt</title>
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/project1/">Blinky, The First Project</a>
+
+ </li>
- <link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
- <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
- <link href="../../css/base.css" rel="stylesheet">
- <link rel="stylesheet" href="../../css/highlight.css">
- <link href="../../extra.css" rel="stylesheet">
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/how_to_edit_docs/">How to edit docs</a>
+
+ </li>
- <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
- <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
- <![endif]-->
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/try_markdown/">Sample doc to edit</a>
+
+ </li>
- </head>
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Acclimated</span></li>
- <body>
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a>
+
+ </li>
- <div class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="container">
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/mod/">Modules Overview</a>
+
+ </li>
- <!-- Collapsed navigation -->
- <div class="navbar-header">
+
- <!-- Expander button -->
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project2/">Project 2</a>
+
+ </li>
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project3/">Project 3</a>
+
+ </li>
- <!-- Main title -->
- <a class="navbar-brand" href="../..">Mynewt</a>
- </div>
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt Tool</span></li>
- <!-- Expanded navigation -->
- <div class="navbar-collapse collapse">
+
- <!-- Main navigation -->
- <ul class="nav navbar-nav">
-
-
- <li >
- <a href="../..">Home</a>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Started <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter1/newt_concepts/">Newt Concepts</a>
-</li>
-
-
-
-<li >
- <a href="../../chapter1/project1/">Blinky, The First Project</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Acclimated <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter2/vocabulary/">Understanding Newt Terms</a>
-</li>
-
-
-
-<li >
- <a href="../../chapter2/project2/">Project 2</a>
-</li>
-
-
-
-<li >
- <a href="../../chapter2/project3/">Project 3</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown active">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Newt Tool <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../newt_ops/">Command structure</a>
-</li>
-
-
-
-<li class="active">
- <a href="./">Command list</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Newt OS <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter4/newt_os/">Features</a>
-</li>
-
-
- </ul>
- </li>
-
+ <li class="toctree-l1 ">
+ <a class="" href="../newt_ops/">Command structure</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 current">
+ <a class="current" href="./">Command list</a>
+
+ <ul>
+
+ <li class="toctree-l3"><a href="#command-list">Command List</a></li>
+ <li><a class="toctree-l4" href="#available-high-level-commands">Available high-level commands</a></li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Modules <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter5/mods/">Overview</a>
-</li>
-
-
-
-<li >
- <a href="../../chapter5/console/">Console</a>
-</li>
-
-
- </ul>
- </li>
+ <li><a class="toctree-l4" href="#version">version</a></li>
+ <li><a class="toctree-l4" href="#help">help</a></li>
+ <li><a class="toctree-l4" href="#nest">nest</a></li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Packaging it up <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter6/dist/">Creating Packages</a>
-</li>
-
-
- </ul>
- </li>
+ <li><a class="toctree-l4" href="#egg">egg</a></li>
+ <li><a class="toctree-l4" href="#target">target</a></li>
- </ul>
-
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
- <i class="fa fa-search"></i> Search
- </a>
- </li>
-
- <li >
- <a rel="next" href="../newt_ops/">
- <i class="fa fa-arrow-left"></i> Previous
- </a>
- </li>
- <li >
- <a rel="prev" href="../../chapter4/newt_os/">
- Next <i class="fa fa-arrow-right"></i>
- </a>
- </li>
-
-
</ul>
- </div>
- </div>
-</div>
+
+ </li>
- <div class="container">
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt OS</span></li>
+
+
- <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
- <ul class="nav bs-sidenav">
-
- <li class="main active"><a href="#command-list">Command List</a></li>
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/mynewt_os/">Overview</a>
- <li><a href="#available-high-level-commands">Available high-level commands</a></li>
+ </li>
+
- <li><a href="#version">version</a></li>
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/context_switch/">Scheduler/Context Switching</a>
+
+ </li>
+
- <li><a href="#help">help</a></li>
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/time/">Time</a>
- <li><a href="#nest">nest</a></li>
+ </li>
+
- <li><a href="#egg">egg</a></li>
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/task/">Tasks</a>
- <li><a href="#target">target</a></li>
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/event_queue/">Event Queues</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/semaphore/">Semaphores</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/mutex/">Mutexes</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/memory_pool/">Memory Pools</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/heap/">Heap</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/mbufs/">Mbufs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/sanity/">Sanity</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/port_os/">Porting to other Platforms</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Modules</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/console/">Console</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/shell/">Shell</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/bootloader/">Bootloader</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/filesystem/">File System</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/testutil/">Test Utilities</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Packaging it</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter6/dist/">Creating Packages</a>
+
+ </li>
+
-
</ul>
-</div></div>
- <div class="col-md-9" role="main">
+<li>
+
+ </ul>
+ </div>
+
+ </nav>
-<h2 id="command-list">Command List<a class="headerlink" href="#command-list" title="Permanent link">¶</a></h2>
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../..">Mynewt</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Newt Tool »</li>
+
+
+
+ <li>Command list</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h2 id="command-list">Command List<a class="headerlink" href="#command-list" title="Permanent link">¶</a></h2>
<h3 id="available-high-level-commands">Available high-level commands<a class="headerlink" href="#available-high-level-commands" title="Permanent link">¶</a></h3>
<pre><code>version Display the Newt version number
help Help about any command
@@ -750,47 +876,50 @@ arch=sim<br />
compiler_def=debug<br />
compiler=arm-none-eabi-m4<br />
@endtargets</p>
-</blockquote></div>
-
- </div>
-
- <footer class="col-md-12">
- <hr>
-
- <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p>
- </footer>
-
- <script src="../../js/jquery-1.10.2.min.js"></script>
- <script src="../../js/bootstrap-3.0.3.min.js"></script>
- <script src="../../js/highlight.pack.js"></script>
- <script>var base_url = '../..';</script>
- <script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
- <script src="../../js/base.js"></script>
-
- <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
- <div class="modal-dialog">
- <div class="modal-content">
- <div class="modal-header">
- <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
- <h4 class="modal-title" id="exampleModalLabel">Search</h4>
- </div>
- <div class="modal-body">
- <p>
- From here you can search these documents. Enter
- your search terms below.
- </p>
- <form role="form">
- <div class="form-group">
- <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
- </div>
- </form>
- <div id="mkdocs-search-results"></div>
- </div>
- <div class="modal-footer">
- </div>
- </div>
+</blockquote>
+
</div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../../chapter4/mynewt_os/" class="btn btn-neutral float-right" title="Overview"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../newt_ops/" class="btn btn-neutral" title="Command structure"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
</div>
+ </div>
+
+ </section>
+
+ </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+ <span><a href="../newt_ops/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../../chapter4/mynewt_os/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
- </body>
+</body>
</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4883e672/chapter4/context_switch/index.html
----------------------------------------------------------------------
diff --git a/chapter4/context_switch/index.html b/chapter4/context_switch/index.html
new file mode 100644
index 0000000..2b687a6
--- /dev/null
+++ b/chapter4/context_switch/index.html
@@ -0,0 +1,536 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Scheduler/Context Switching - Mynewt</title>
+
+
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "Scheduler/Context Switching";
+ </script>
+
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
+ <script src="../../js/theme.js"></script>
+
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href="../.." class="icon icon-home"> Mynewt</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+ <li>
+ <li class="toctree-l1 ">
+ <a class="" href="../..">Home</a>
+
+ </li>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Started</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/newt_concepts/">Newt Concepts</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/project1/">Blinky, The First Project</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/how_to_edit_docs/">How to edit docs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/try_markdown/">Sample doc to edit</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Acclimated</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/mod/">Modules Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project2/">Project 2</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project3/">Project 3</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt Tool</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_ops/">Command structure</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_tool_reference/">Command list</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt OS</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../mynewt_os/">Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 current">
+ <a class="current" href="./">Scheduler/Context Switching</a>
+
+ <ul>
+
+ <li class="toctree-l3"><a href="#schedulercontext-switching">Scheduler/Context Switching</a></li>
+
+ <li><a class="toctree-l4" href="#description">Description</a></li>
+
+ <li><a class="toctree-l4" href="#data-structures">Data structures</a></li>
+
+ <li><a class="toctree-l4" href="#list-of-functions">List of Functions</a></li>
+
+ <li><a class="toctree-l4" href="#function-reference">Function Reference</a></li>
+
+
+ </ul>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../time/">Time</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../task/">Tasks</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../event_queue/">Event Queues</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../semaphore/">Semaphores</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../mutex/">Mutexes</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../memory_pool/">Memory Pools</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../heap/">Heap</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../mbufs/">Mbufs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../sanity/">Sanity</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../port_os/">Porting to other Platforms</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Modules</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/console/">Console</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/shell/">Shell</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/bootloader/">Bootloader</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/filesystem/">File System</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/testutil/">Test Utilities</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Packaging it</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter6/dist/">Creating Packages</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ </ul>
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../..">Mynewt</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Newt OS »</li>
+
+
+
+ <li>Scheduler/Context Switching</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h1 id="schedulercontext-switching">Scheduler/Context Switching<a class="headerlink" href="#schedulercontext-switching" title="Permanent link">¶</a></h1>
+<p>Insert synopsis here</p>
+<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
+<p>Describe scheduler here</p>
+<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
+<p>Replace this with the list of data structures used, why, any neat features</p>
+<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
+<p><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 words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p>The functions available in the scheduler are:</p>
+<ul>
+<li><a href="#function-os_sched_insert">os_sched_insert</a></li>
+<li><a href="#function-os_sched_walk">os_sched_walk</a></li>
+<li>add the rest</li>
+</ul>
+<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
+<hr />
+<h3 id="function-os_sched_insert"><font color="2980b9">function os_sched_insert</font><a class="headerlink" href="#function-os_sched_insert" title="Permanent link">¶</a></h3>
+<pre><code> os_error_t
+ os_sched_insert(struct os_task *t)
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+<h3 id="function-os_sched_walk"><font color="#2980b9"> function os_sched_walk</font><a class="headerlink" href="#function-os_sched_walk" title="Permanent link">¶</a></h3>
+<pre><code> <Insert function callout here >
+
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
+<pre><code> <Insert function callout here >
+
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../time/" class="btn btn-neutral float-right" title="Time"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../mynewt_os/" class="btn btn-neutral" title="Overview"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+ <span><a href="../mynewt_os/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../time/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4883e672/chapter4/event_queue/index.html
----------------------------------------------------------------------
diff --git a/chapter4/event_queue/index.html b/chapter4/event_queue/index.html
new file mode 100644
index 0000000..7823248
--- /dev/null
+++ b/chapter4/event_queue/index.html
@@ -0,0 +1,536 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Event Queues - Mynewt</title>
+
+
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "Event Queues";
+ </script>
+
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
+ <script src="../../js/theme.js"></script>
+
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href="../.." class="icon icon-home"> Mynewt</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+ <li>
+ <li class="toctree-l1 ">
+ <a class="" href="../..">Home</a>
+
+ </li>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Started</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/newt_concepts/">Newt Concepts</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/project1/">Blinky, The First Project</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/how_to_edit_docs/">How to edit docs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/try_markdown/">Sample doc to edit</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Acclimated</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/mod/">Modules Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project2/">Project 2</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project3/">Project 3</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt Tool</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_ops/">Command structure</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_tool_reference/">Command list</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt OS</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../mynewt_os/">Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../context_switch/">Scheduler/Context Switching</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../time/">Time</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../task/">Tasks</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 current">
+ <a class="current" href="./">Event Queues</a>
+
+ <ul>
+
+ <li class="toctree-l3"><a href="#event-queues">Event Queues</a></li>
+
+ <li><a class="toctree-l4" href="#description">Description</a></li>
+
+ <li><a class="toctree-l4" href="#data-structures">Data structures</a></li>
+
+ <li><a class="toctree-l4" href="#list-of-functions">List of Functions</a></li>
+
+ <li><a class="toctree-l4" href="#function-reference">Function Reference</a></li>
+
+
+ </ul>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../semaphore/">Semaphores</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../mutex/">Mutexes</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../memory_pool/">Memory Pools</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../heap/">Heap</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../mbufs/">Mbufs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../sanity/">Sanity</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../port_os/">Porting to other Platforms</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Modules</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/console/">Console</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/shell/">Shell</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/bootloader/">Bootloader</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/filesystem/">File System</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/testutil/">Test Utilities</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Packaging it</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter6/dist/">Creating Packages</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ </ul>
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../..">Mynewt</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Newt OS »</li>
+
+
+
+ <li>Event Queues</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h1 id="event-queues">Event Queues<a class="headerlink" href="#event-queues" title="Permanent link">¶</a></h1>
+<p>Insert synopsis here</p>
+<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
+<p>Describe scheduler here</p>
+<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
+<p>Replace this with the list of data structures used, why, any neat features</p>
+<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
+<p><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 words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p>The functions available in this OS feature are:</p>
+<ul>
+<li><a href="#function-os_eventq_init">os_eventq_init</a></li>
+<li><a href="#function-os_eventq_put2">os_eventq_put2</a></li>
+<li>add the rest</li>
+</ul>
+<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
+<hr />
+<h3 id="function-os_eventq_init"><font color="2980b9">function os_eventq_init</font><a class="headerlink" href="#function-os_eventq_init" title="Permanent link">¶</a></h3>
+<pre><code> void
+ os_eventq_init(struct os_eventq *evq)
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+<h3 id="function-os_eventq_put2"><font color="#2980b9"> function os_eventq_put2</font><a class="headerlink" href="#function-os_eventq_put2" title="Permanent link">¶</a></h3>
+<pre><code> <Insert function callout here >
+
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
+<pre><code> <Insert function callout here >
+
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../semaphore/" class="btn btn-neutral float-right" title="Semaphores"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../task/" class="btn btn-neutral" title="Tasks"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+ <span><a href="../task/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../semaphore/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4883e672/chapter4/heap/index.html
----------------------------------------------------------------------
diff --git a/chapter4/heap/index.html b/chapter4/heap/index.html
new file mode 100644
index 0000000..d6ba545
--- /dev/null
+++ b/chapter4/heap/index.html
@@ -0,0 +1,536 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Heap - Mynewt</title>
+
+
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "Heap";
+ </script>
+
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
+ <script src="../../js/theme.js"></script>
+
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href="../.." class="icon icon-home"> Mynewt</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+ <li>
+ <li class="toctree-l1 ">
+ <a class="" href="../..">Home</a>
+
+ </li>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Started</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/newt_concepts/">Newt Concepts</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/project1/">Blinky, The First Project</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/how_to_edit_docs/">How to edit docs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/try_markdown/">Sample doc to edit</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Acclimated</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/mod/">Modules Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project2/">Project 2</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project3/">Project 3</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt Tool</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_ops/">Command structure</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_tool_reference/">Command list</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt OS</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../mynewt_os/">Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../context_switch/">Scheduler/Context Switching</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../time/">Time</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../task/">Tasks</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../event_queue/">Event Queues</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../semaphore/">Semaphores</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../mutex/">Mutexes</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../memory_pool/">Memory Pools</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 current">
+ <a class="current" href="./">Heap</a>
+
+ <ul>
+
+ <li class="toctree-l3"><a href="#heap">Heap</a></li>
+
+ <li><a class="toctree-l4" href="#description">Description</a></li>
+
+ <li><a class="toctree-l4" href="#data-structures">Data structures</a></li>
+
+ <li><a class="toctree-l4" href="#list-of-functions">List of Functions</a></li>
+
+ <li><a class="toctree-l4" href="#function-reference">Function Reference</a></li>
+
+
+ </ul>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../mbufs/">Mbufs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../sanity/">Sanity</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../port_os/">Porting to other Platforms</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Modules</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/console/">Console</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/shell/">Shell</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/bootloader/">Bootloader</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/filesystem/">File System</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/testutil/">Test Utilities</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Packaging it</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter6/dist/">Creating Packages</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ </ul>
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../..">Mynewt</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Newt OS »</li>
+
+
+
+ <li>Heap</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h1 id="heap">Heap<a class="headerlink" href="#heap" title="Permanent link">¶</a></h1>
+<p>Insert synopsis here</p>
+<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
+<p>Describe OS feature here </p>
+<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
+<p>Replace this with the list of data structures used, why, any neat features</p>
+<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
+<p><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 words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
+<p>The functions available in this OS feature are:</p>
+<ul>
+<li><a href="#function-os_malloc_lock">os_malloc_lock</a></li>
+<li><a href="#function-os_malloc_unlock">os_malloc_unlock</a></li>
+<li>add the rest</li>
+</ul>
+<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
+<hr />
+<h3 id="function-os_malloc_lock"><font color="2980b9">function os_malloc_lock</font><a class="headerlink" href="#function-os_malloc_lock" title="Permanent link">¶</a></h3>
+<pre><code> static void
+ os_malloc_lock(void)
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+<h3 id="function-os_malloc_unlock"><font color="#2980b9"> function os_malloc_unlock</font><a class="headerlink" href="#function-os_malloc_unlock" title="Permanent link">¶</a></h3>
+<pre><code> <Insert function callout here >
+
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
+<pre><code> <Insert function callout here >
+
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../mbufs/" class="btn btn-neutral float-right" title="Mbufs"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../memory_pool/" class="btn btn-neutral" title="Memory Pools"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+ <span><a href="../memory_pool/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../mbufs/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4883e672/chapter4/mbufs/index.html
----------------------------------------------------------------------
diff --git a/chapter4/mbufs/index.html b/chapter4/mbufs/index.html
new file mode 100644
index 0000000..7e61ad9
--- /dev/null
+++ b/chapter4/mbufs/index.html
@@ -0,0 +1,537 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Mbufs - Mynewt</title>
+
+
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "Mbufs";
+ </script>
+
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
+ <script src="../../js/theme.js"></script>
+
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href="../.." class="icon icon-home"> Mynewt</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+ <li>
+ <li class="toctree-l1 ">
+ <a class="" href="../..">Home</a>
+
+ </li>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Started</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/newt_concepts/">Newt Concepts</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/project1/">Blinky, The First Project</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/how_to_edit_docs/">How to edit docs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter1/try_markdown/">Sample doc to edit</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Acclimated</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/mod/">Modules Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project2/">Project 2</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project3/">Project 3</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt Tool</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_ops/">Command structure</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_tool_reference/">Command list</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt OS</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../mynewt_os/">Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../context_switch/">Scheduler/Context Switching</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../time/">Time</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../task/">Tasks</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../event_queue/">Event Queues</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../semaphore/">Semaphores</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../mutex/">Mutexes</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../memory_pool/">Memory Pools</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../heap/">Heap</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 current">
+ <a class="current" href="./">Mbufs</a>
+
+ <ul>
+
+ <li class="toctree-l3"><a href="#mbufs">Mbufs</a></li>
+
+ <li><a class="toctree-l4" href="#description">Description</a></li>
+
+ <li><a class="toctree-l4" href="#data-structures">Data structures</a></li>
+
+ <li><a class="toctree-l4" href="#list-of-functions">List of Functions</a></li>
+
+ <li><a class="toctree-l4" href="#function-reference">Function Reference</a></li>
+
+
+ </ul>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../sanity/">Sanity</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../port_os/">Porting to other Platforms</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Modules</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/console/">Console</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/shell/">Shell</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/bootloader/">Bootloader</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/filesystem/">File System</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/testutil/">Test Utilities</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Packaging it</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter6/dist/">Creating Packages</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ </ul>
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../..">Mynewt</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Newt OS »</li>
+
+
+
+ <li>Mbufs</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h1 id="mbufs">Mbufs<a class="headerlink" href="#mbufs" title="Permanent link">¶</a></h1>
+<p>Insert synopsis here</p>
+<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
+<p>Describe OS feature here </p>
+<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
+<p>Replace this with the list of data structures used, why, any neat features</p>
+<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
+<p><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 words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least words for the anchor to work - that's how it is.></p>
+<p>The functions available in this OS feature are:</p>
+<ul>
+<li><a href="#function-os_mbuf_pool_init">os_mbuf_pool_init</a></li>
+<li><a href="#function-os_mbuf_get">os_mbuf_get</a></li>
+<li>add the rest</li>
+</ul>
+<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2>
+<hr />
+<h3 id="function-os_mbuf_pool_init"><font color="2980b9">function os_mbuf_pool_init</font><a class="headerlink" href="#function-os_mbuf_pool_init" title="Permanent link">¶</a></h3>
+<pre><code> int
+ os_mbuf_pool_init(struct os_mbuf_pool *omp, struct os_mempool *mp,
+ uint16_t hdr_len, uint16_t buf_len, uint16_t nbufs)
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+<h3 id="function-os_mbuf_get"><font color="#2980b9"> function os_mbuf_get</font><a class="headerlink" href="#function-os_mbuf_get" title="Permanent link">¶</a></h3>
+<pre><code> <Insert function callout here >
+
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3>
+<pre><code> <Insert function callout here >
+
+</code></pre>
+
+<p><Insert short description></p>
+<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>xx</td>
+<td>explain argument xx</td>
+</tr>
+<tr>
+<td>yy</td>
+<td>explain argument yy</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4>
+<p>List any values returned.
+Error codes?</p>
+<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4>
+<p>Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).</p>
+<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4>
+<p><Add text to set up the context for the example here></p>
+<pre><code>
+<Insert the code snippet here>
+
+</code></pre>
+
+<hr />
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../sanity/" class="btn btn-neutral float-right" title="Sanity"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../heap/" class="btn btn-neutral" title="Heap"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+ <span><a href="../heap/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../sanity/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
+
+</body>
+</html>