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/05/20 07:36:10 UTC
[27/51] [partial] incubator-mynewt-site git commit: Changed landing
page, main banner, secondary banner, events, community,
added Quick start nav link, collapsed documentation hierarchy
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/core_os/memory_pool/memory_pool/index.html
----------------------------------------------------------------------
diff --git a/os/core_os/memory_pool/memory_pool/index.html b/os/core_os/memory_pool/memory_pool/index.html
index 233efa7..4a07c3d 100644
--- a/os/core_os/memory_pool/memory_pool/index.html
+++ b/os/core_os/memory_pool/memory_pool/index.html
@@ -16,6 +16,7 @@
<link rel="stylesheet" href="../../../../css/highlight.css">
<link href="../../../../css/base.css" rel="stylesheet">
<link href="../../../../css/custom.css" rel="stylesheet">
+ <link href="../../../../css/v2.css" rel="stylesheet">
<link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href="../../../../extra.css" rel="stylesheet">
@@ -43,11 +44,10 @@
<body class="toc">
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
@@ -64,75 +64,37 @@
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
- <li>
+ <li
+ class=""
+>
<a href="/">Home</a>
</li>
- <li>
- <a href="/about/">About</a>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
</li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../faq/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
</li>
<li>
+ <a href="/os/introduction/">Documentation</a>
+ </li>
+ <li
+ class=""
+>
<a href="/download/">Download</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/community/">Community</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/events/">Events</a>
</li>
</ul>
@@ -142,27 +104,26 @@
</ul>
</div>
- # </div>
-</div>
+ </div>
+</nav>
- <div class="container-fluid">
+ <div class="container">
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
- <div class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
- <ul class="nav bs-sidenav">
+ <ul class="toc-nav">
@@ -180,42 +141,29 @@
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
-
- <ul class="current-toc">
-
-
-
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
-
+ <ul>
+
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
-
- </li>
+
+ </li>
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
@@ -223,10 +171,10 @@
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
-
- </li>
+
+ </li>
@@ -234,10 +182,10 @@
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -245,10 +193,10 @@
- <li ><a href="../../mynewt_os/">OS Core</a></li>
+ <li ><a href="../../mynewt_os/">OS Core</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -260,8 +208,8 @@
../../os_init/
">System-level Functions</a>
-
- </li>
+
+ </li>
@@ -269,10 +217,10 @@
- <li ><a href="../../context_switch/context_switch/">Scheduler</a></li>
+ <li ><a href="../../context_switch/context_switch/">Scheduler</a>
-
- </li>
+
+ </li>
@@ -280,10 +228,10 @@
- <li ><a href="../../time/os_time/">Time</a></li>
+ <li ><a href="../../time/os_time/">Time</a>
-
- </li>
+
+ </li>
@@ -291,10 +239,10 @@
- <li ><a href="../../task/task/">Tasks</a></li>
+ <li ><a href="../../task/task/">Tasks</a>
-
- </li>
+
+ </li>
@@ -302,10 +250,10 @@
- <li ><a href="../../event_queue/event_queue/">Event Queues</a></li>
+ <li ><a href="../../event_queue/event_queue/">Event Queues</a>
-
- </li>
+
+ </li>
@@ -313,10 +261,10 @@
- <li ><a href="../../semaphore/semaphore/">Semaphores</a></li>
+ <li ><a href="../../semaphore/semaphore/">Semaphores</a>
-
- </li>
+
+ </li>
@@ -324,10 +272,10 @@
- <li ><a href="../../mutex/mutex/">Mutexes</a></li>
+ <li ><a href="../../mutex/mutex/">Mutexes</a>
-
- </li>
+
+ </li>
@@ -335,10 +283,10 @@
- <li class="active"><a href="./">Memory Pools</a></li>
+ <li class="active"><a href="./">Memory Pools</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -350,14 +298,14 @@
../os_memblock_get/
">Functions/Macros</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -365,10 +313,10 @@
- <li ><a href="../../heap/heap/">Heap</a></li>
+ <li ><a href="../../heap/heap/">Heap</a>
-
- </li>
+
+ </li>
@@ -383,8 +331,8 @@
">Memory Buffers</a>
-
- </li>
+
+ </li>
@@ -392,10 +340,10 @@
- <li ><a href="../../sanity/sanity/">Sanity</a></li>
+ <li ><a href="../../sanity/sanity/">Sanity</a>
-
- </li>
+
+ </li>
@@ -403,16 +351,16 @@
- <li ><a href="../../callout/callout/">Callouts</a></li>
+ <li ><a href="../../callout/callout/">Callouts</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -420,10 +368,10 @@
- <li ><a href="../../porting/port_os/">Porting to your Platform</a></li>
+ <li ><a href="../../porting/port_os/">Porting to your Platform</a>
-
- </li>
+
+ </li>
@@ -431,10 +379,10 @@
- <li ><a href="../../../modules/console/console/">Console</a></li>
+ <li ><a href="../../../modules/console/console/">Console</a>
-
- </li>
+
+ </li>
@@ -442,10 +390,10 @@
- <li ><a href="../../../modules/shell/shell/">Shell</a></li>
+ <li ><a href="../../../modules/shell/shell/">Shell</a>
-
- </li>
+
+ </li>
@@ -453,10 +401,10 @@
- <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a></li>
+ <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a>
-
- </li>
+
+ </li>
@@ -471,8 +419,8 @@
">File System</a>
-
- </li>
+
+ </li>
@@ -480,10 +428,10 @@
- <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -491,10 +439,10 @@
- <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -502,20 +450,18 @@
- <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a></li>
+ <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../../../modules/baselibc/">Baselibc library</a>
</li>
-
@@ -523,10 +469,10 @@
- <li ><a href="../../../modules/elua/elua/">Embedded Lua</a></li>
+ <li ><a href="../../../modules/elua/elua/">Embedded Lua</a>
-
- </li>
+
+ </li>
@@ -534,10 +480,10 @@
- <li ><a href="../../../modules/json/json/">JSON</a></li>
+ <li ><a href="../../../modules/json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -545,10 +491,10 @@
- <li ><a href="../../../modules/stats/stats/">Stats</a></li>
+ <li ><a href="../../../modules/stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -556,16 +502,16 @@
- <li ><a href="../../../modules/logs/logs/">Logs</a></li>
+ <li ><a href="../../../modules/logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -577,40 +523,36 @@
../../../../network/ble/ble_intro/
">BLE User Guide</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
-
-
-
-
-
+
+
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
-
- </li>
+
+ </li>
-
-
-
+
+
+
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
-
- </li>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
@@ -622,8 +564,8 @@
../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -634,45 +576,11 @@
<button class="show-sidebar">Docs Menu</button>
</div>
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
+ <div class="col-md-9" role="main">
<div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
+ <div class="col-sm-12">
<div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
+ <ul class="wy-breadcrumbs pull-right">
<li><a href="/documentation/">Docs</a></li>
@@ -692,9 +600,9 @@
</div>
</div>
- <h1 id="memory-pools">Memory Pools<a class="headerlink" href="#memory-pools" title="Permanent link">¶</a></h1>
+ <h1 id="memory-pools">Memory Pools</h1>
<p>A memory pool is a collection of fixed sized elements called memory blocks. Generally, memory pools are used when the developer wants to allocate a certain amount of memory to a given feature. Unlike the heap, where a code module is at the mercy of other code modules to insure there is sufficient memory, memory pools can insure sufficient memory allocation.</p>
-<h3 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h3>
+<h3 id="description">Description</h3>
<p>In order to create a memory pool the developer needs to do a few things. The first task is to define the memory pool itself. This is a data structure which contains information about the pool itself (i.e. number of blocks, size of the blocks, etc).</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">struct</span> <span style="color: #000000">os_mempool</span> <span style="color: #000000">my_pool</span>;
</pre></div>
@@ -722,7 +630,7 @@ Now that the memory pool has been defined as well as the memory required for the
<p><br>
Once the memory pool has been initialized the developer can allocate memory blocks from the pool by calling <code>os_memblock_get</code>. When the memory block is no longer needed the memory can be freed by calling <code>os_memblock_put</code>. </p>
-<h3 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h3>
+<h3 id="data-structures">Data structures</h3>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">struct</span> <span style="color: #000000">os_mempool</span> {
<span style="color: #A90D91">int</span> <span style="color: #000000">mp_block_size</span>;
<span style="color: #A90D91">int</span> <span style="color: #000000">mp_num_blocks</span>;
@@ -774,7 +682,7 @@ Once the memory pool has been initialized the developer can allocate memory bloc
</tr>
</tbody>
</table>
-<h3 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h3>
+<h3 id="list-of-functions">List of Functions</h3>
<p>The functions available in mem_pool are:</p>
<ul>
<li><a href="../os_memblock_get">os_memblock_get</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/core_os/memory_pool/os_memblock_get/index.html
----------------------------------------------------------------------
diff --git a/os/core_os/memory_pool/os_memblock_get/index.html b/os/core_os/memory_pool/os_memblock_get/index.html
index 2ef7825..68c8458 100644
--- a/os/core_os/memory_pool/os_memblock_get/index.html
+++ b/os/core_os/memory_pool/os_memblock_get/index.html
@@ -16,6 +16,7 @@
<link rel="stylesheet" href="../../../../css/highlight.css">
<link href="../../../../css/base.css" rel="stylesheet">
<link href="../../../../css/custom.css" rel="stylesheet">
+ <link href="../../../../css/v2.css" rel="stylesheet">
<link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href="../../../../extra.css" rel="stylesheet">
@@ -43,11 +44,10 @@
<body class="os_memblock_get">
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
@@ -64,75 +64,37 @@
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
- <li>
+ <li
+ class=""
+>
<a href="/">Home</a>
</li>
- <li>
- <a href="/about/">About</a>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
</li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../faq/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
</li>
<li>
+ <a href="/os/introduction/">Documentation</a>
+ </li>
+ <li
+ class=""
+>
<a href="/download/">Download</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/community/">Community</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/events/">Events</a>
</li>
</ul>
@@ -142,27 +104,26 @@
</ul>
</div>
- # </div>
-</div>
+ </div>
+</nav>
- <div class="container-fluid">
+ <div class="container">
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
- <div class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
- <ul class="nav bs-sidenav">
+ <ul class="toc-nav">
@@ -180,42 +141,29 @@
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
-
- <ul class="current-toc">
-
-
-
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
-
+ <ul>
+
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
-
- </li>
+
+ </li>
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
@@ -223,10 +171,10 @@
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
-
- </li>
+
+ </li>
@@ -234,10 +182,10 @@
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -245,10 +193,10 @@
- <li ><a href="../../mynewt_os/">OS Core</a></li>
+ <li ><a href="../../mynewt_os/">OS Core</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -260,8 +208,8 @@
../../os_init/
">System-level Functions</a>
-
- </li>
+
+ </li>
@@ -269,10 +217,10 @@
- <li ><a href="../../context_switch/context_switch/">Scheduler</a></li>
+ <li ><a href="../../context_switch/context_switch/">Scheduler</a>
-
- </li>
+
+ </li>
@@ -280,10 +228,10 @@
- <li ><a href="../../time/os_time/">Time</a></li>
+ <li ><a href="../../time/os_time/">Time</a>
-
- </li>
+
+ </li>
@@ -291,10 +239,10 @@
- <li ><a href="../../task/task/">Tasks</a></li>
+ <li ><a href="../../task/task/">Tasks</a>
-
- </li>
+
+ </li>
@@ -302,10 +250,10 @@
- <li ><a href="../../event_queue/event_queue/">Event Queues</a></li>
+ <li ><a href="../../event_queue/event_queue/">Event Queues</a>
-
- </li>
+
+ </li>
@@ -313,10 +261,10 @@
- <li ><a href="../../semaphore/semaphore/">Semaphores</a></li>
+ <li ><a href="../../semaphore/semaphore/">Semaphores</a>
-
- </li>
+
+ </li>
@@ -324,10 +272,10 @@
- <li ><a href="../../mutex/mutex/">Mutexes</a></li>
+ <li ><a href="../../mutex/mutex/">Mutexes</a>
-
- </li>
+
+ </li>
@@ -335,10 +283,10 @@
- <li ><a href="../memory_pool/">Memory Pools</a></li>
+ <li ><a href="../memory_pool/">Memory Pools</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -350,68 +298,58 @@
./
">Functions/Macros</a>
-
- <ul class="current-toc">
+
+ <ul>
-
<li class="active">
- os_memblock_get
+ <a href="./">os_memblock_get</a>
</li>
-
-
- <li>
+ <li >
<a href="../os_mempool_init/">os_mempool_init</a>
</li>
-
-
- <li>
+ <li >
<a href="../os_memblock_put/">os_memblock_put</a>
</li>
-
-
- <li>
+ <li >
<a href="../OS_MEMPOOL_BYTES/">OS_MEMPOOL_BYTES</a>
</li>
-
-
- <li>
+ <li >
<a href="../OS_MEMPOOL_SIZE/">OS_MEMPOOL_SIZE</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -419,10 +357,10 @@
- <li ><a href="../../heap/heap/">Heap</a></li>
+ <li ><a href="../../heap/heap/">Heap</a>
-
- </li>
+
+ </li>
@@ -437,8 +375,8 @@
">Memory Buffers</a>
-
- </li>
+
+ </li>
@@ -446,10 +384,10 @@
- <li ><a href="../../sanity/sanity/">Sanity</a></li>
+ <li ><a href="../../sanity/sanity/">Sanity</a>
-
- </li>
+
+ </li>
@@ -457,16 +395,16 @@
- <li ><a href="../../callout/callout/">Callouts</a></li>
+ <li ><a href="../../callout/callout/">Callouts</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -474,10 +412,10 @@
- <li ><a href="../../porting/port_os/">Porting to your Platform</a></li>
+ <li ><a href="../../porting/port_os/">Porting to your Platform</a>
-
- </li>
+
+ </li>
@@ -485,10 +423,10 @@
- <li ><a href="../../../modules/console/console/">Console</a></li>
+ <li ><a href="../../../modules/console/console/">Console</a>
-
- </li>
+
+ </li>
@@ -496,10 +434,10 @@
- <li ><a href="../../../modules/shell/shell/">Shell</a></li>
+ <li ><a href="../../../modules/shell/shell/">Shell</a>
-
- </li>
+
+ </li>
@@ -507,10 +445,10 @@
- <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a></li>
+ <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a>
-
- </li>
+
+ </li>
@@ -525,8 +463,8 @@
">File System</a>
-
- </li>
+
+ </li>
@@ -534,10 +472,10 @@
- <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -545,10 +483,10 @@
- <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -556,20 +494,18 @@
- <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a></li>
+ <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../../../modules/baselibc/">Baselibc library</a>
</li>
-
@@ -577,10 +513,10 @@
- <li ><a href="../../../modules/elua/elua/">Embedded Lua</a></li>
+ <li ><a href="../../../modules/elua/elua/">Embedded Lua</a>
-
- </li>
+
+ </li>
@@ -588,10 +524,10 @@
- <li ><a href="../../../modules/json/json/">JSON</a></li>
+ <li ><a href="../../../modules/json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -599,10 +535,10 @@
- <li ><a href="../../../modules/stats/stats/">Stats</a></li>
+ <li ><a href="../../../modules/stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -610,16 +546,16 @@
- <li ><a href="../../../modules/logs/logs/">Logs</a></li>
+ <li ><a href="../../../modules/logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -631,40 +567,36 @@
../../../../network/ble/ble_intro/
">BLE User Guide</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
-
-
-
-
-
+
+
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
-
- </li>
+
+ </li>
-
-
-
+
+
+
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
-
- </li>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
@@ -676,8 +608,8 @@
../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -688,45 +620,11 @@
<button class="show-sidebar">Docs Menu</button>
</div>
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
+ <div class="col-md-9" role="main">
<div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
+ <div class="col-sm-12">
<div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
+ <ul class="wy-breadcrumbs pull-right">
<li><a href="/documentation/">Docs</a></li>
@@ -748,13 +646,13 @@
</div>
</div>
- <h2 id="os_memblock_get"><font color="#F2853F" style="font-size:24pt"> os_memblock_get</font><a class="headerlink" href="#os_memblock_get" title="Permanent link">¶</a></h2>
+ <h2 id="os_memblock_get"><font color="#F2853F" style="font-size:24pt"> os_memblock_get</font></h2>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span> <span style="color: #000000">*os_memblock_get</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mempool</span> <span style="color: #000000">*mp</span>)
</pre></div>
<p>Allocate an element from the memory pool. If succesful, you'll get a pointer to allocated element. If there are no elements available, you'll get NULL as response.</p>
-<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<h4 id="arguments">Arguments</h4>
<table>
<thead>
<tr>
@@ -769,11 +667,11 @@
</tr>
</tbody>
</table>
-<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<h4 id="returned-values">Returned values</h4>
<p>NULL: no elements available.
<pointer>: pointer to allocated element.</p>
-<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
-<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<h4 id="notes">Notes</h4>
+<h4 id="example">Example</h4>
<p><Add text to set up the context for the example here></p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #A90D91">struct</span> <span style="color: #000000">nffs_file</span> <span style="color: #000000">*file</span>;
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/core_os/memory_pool/os_memblock_put/index.html
----------------------------------------------------------------------
diff --git a/os/core_os/memory_pool/os_memblock_put/index.html b/os/core_os/memory_pool/os_memblock_put/index.html
index b097a49..886b79d 100644
--- a/os/core_os/memory_pool/os_memblock_put/index.html
+++ b/os/core_os/memory_pool/os_memblock_put/index.html
@@ -16,6 +16,7 @@
<link rel="stylesheet" href="../../../../css/highlight.css">
<link href="../../../../css/base.css" rel="stylesheet">
<link href="../../../../css/custom.css" rel="stylesheet">
+ <link href="../../../../css/v2.css" rel="stylesheet">
<link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href="../../../../extra.css" rel="stylesheet">
@@ -43,11 +44,10 @@
<body class="os_memblock_put">
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
@@ -64,75 +64,37 @@
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
- <li>
+ <li
+ class=""
+>
<a href="/">Home</a>
</li>
- <li>
- <a href="/about/">About</a>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
</li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../faq/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
</li>
<li>
+ <a href="/os/introduction/">Documentation</a>
+ </li>
+ <li
+ class=""
+>
<a href="/download/">Download</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/community/">Community</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/events/">Events</a>
</li>
</ul>
@@ -142,27 +104,26 @@
</ul>
</div>
- # </div>
-</div>
+ </div>
+</nav>
- <div class="container-fluid">
+ <div class="container">
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
- <div class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
- <ul class="nav bs-sidenav">
+ <ul class="toc-nav">
@@ -180,42 +141,29 @@
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
-
- <ul class="current-toc">
-
-
-
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
-
+ <ul>
+
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
-
- </li>
+
+ </li>
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
@@ -223,10 +171,10 @@
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
-
- </li>
+
+ </li>
@@ -234,10 +182,10 @@
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -245,10 +193,10 @@
- <li ><a href="../../mynewt_os/">OS Core</a></li>
+ <li ><a href="../../mynewt_os/">OS Core</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -260,8 +208,8 @@
../../os_init/
">System-level Functions</a>
-
- </li>
+
+ </li>
@@ -269,10 +217,10 @@
- <li ><a href="../../context_switch/context_switch/">Scheduler</a></li>
+ <li ><a href="../../context_switch/context_switch/">Scheduler</a>
-
- </li>
+
+ </li>
@@ -280,10 +228,10 @@
- <li ><a href="../../time/os_time/">Time</a></li>
+ <li ><a href="../../time/os_time/">Time</a>
-
- </li>
+
+ </li>
@@ -291,10 +239,10 @@
- <li ><a href="../../task/task/">Tasks</a></li>
+ <li ><a href="../../task/task/">Tasks</a>
-
- </li>
+
+ </li>
@@ -302,10 +250,10 @@
- <li ><a href="../../event_queue/event_queue/">Event Queues</a></li>
+ <li ><a href="../../event_queue/event_queue/">Event Queues</a>
-
- </li>
+
+ </li>
@@ -313,10 +261,10 @@
- <li ><a href="../../semaphore/semaphore/">Semaphores</a></li>
+ <li ><a href="../../semaphore/semaphore/">Semaphores</a>
-
- </li>
+
+ </li>
@@ -324,10 +272,10 @@
- <li ><a href="../../mutex/mutex/">Mutexes</a></li>
+ <li ><a href="../../mutex/mutex/">Mutexes</a>
-
- </li>
+
+ </li>
@@ -335,10 +283,10 @@
- <li ><a href="../memory_pool/">Memory Pools</a></li>
+ <li ><a href="../memory_pool/">Memory Pools</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -350,68 +298,58 @@
../os_memblock_get/
">Functions/Macros</a>
-
- <ul class="current-toc">
+
+ <ul>
-
- <li>
+ <li >
<a href="../os_memblock_get/">os_memblock_get</a>
</li>
-
-
- <li>
+ <li >
<a href="../os_mempool_init/">os_mempool_init</a>
</li>
-
-
<li class="active">
- os_memblock_put
+ <a href="./">os_memblock_put</a>
</li>
-
-
- <li>
+ <li >
<a href="../OS_MEMPOOL_BYTES/">OS_MEMPOOL_BYTES</a>
</li>
-
-
- <li>
+ <li >
<a href="../OS_MEMPOOL_SIZE/">OS_MEMPOOL_SIZE</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -419,10 +357,10 @@
- <li ><a href="../../heap/heap/">Heap</a></li>
+ <li ><a href="../../heap/heap/">Heap</a>
-
- </li>
+
+ </li>
@@ -437,8 +375,8 @@
">Memory Buffers</a>
-
- </li>
+
+ </li>
@@ -446,10 +384,10 @@
- <li ><a href="../../sanity/sanity/">Sanity</a></li>
+ <li ><a href="../../sanity/sanity/">Sanity</a>
-
- </li>
+
+ </li>
@@ -457,16 +395,16 @@
- <li ><a href="../../callout/callout/">Callouts</a></li>
+ <li ><a href="../../callout/callout/">Callouts</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -474,10 +412,10 @@
- <li ><a href="../../porting/port_os/">Porting to your Platform</a></li>
+ <li ><a href="../../porting/port_os/">Porting to your Platform</a>
-
- </li>
+
+ </li>
@@ -485,10 +423,10 @@
- <li ><a href="../../../modules/console/console/">Console</a></li>
+ <li ><a href="../../../modules/console/console/">Console</a>
-
- </li>
+
+ </li>
@@ -496,10 +434,10 @@
- <li ><a href="../../../modules/shell/shell/">Shell</a></li>
+ <li ><a href="../../../modules/shell/shell/">Shell</a>
-
- </li>
+
+ </li>
@@ -507,10 +445,10 @@
- <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a></li>
+ <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a>
-
- </li>
+
+ </li>
@@ -525,8 +463,8 @@
">File System</a>
-
- </li>
+
+ </li>
@@ -534,10 +472,10 @@
- <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -545,10 +483,10 @@
- <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -556,20 +494,18 @@
- <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a></li>
+ <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../../../modules/baselibc/">Baselibc library</a>
</li>
-
@@ -577,10 +513,10 @@
- <li ><a href="../../../modules/elua/elua/">Embedded Lua</a></li>
+ <li ><a href="../../../modules/elua/elua/">Embedded Lua</a>
-
- </li>
+
+ </li>
@@ -588,10 +524,10 @@
- <li ><a href="../../../modules/json/json/">JSON</a></li>
+ <li ><a href="../../../modules/json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -599,10 +535,10 @@
- <li ><a href="../../../modules/stats/stats/">Stats</a></li>
+ <li ><a href="../../../modules/stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -610,16 +546,16 @@
- <li ><a href="../../../modules/logs/logs/">Logs</a></li>
+ <li ><a href="../../../modules/logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -631,40 +567,36 @@
../../../../network/ble/ble_intro/
">BLE User Guide</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
-
-
-
-
-
+
+
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
-
- </li>
+
+ </li>
-
-
-
+
+
+
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
-
- </li>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
@@ -676,8 +608,8 @@
../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -688,45 +620,11 @@
<button class="show-sidebar">Docs Menu</button>
</div>
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
+ <div class="col-md-9" role="main">
<div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
+ <div class="col-sm-12">
<div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
+ <ul class="wy-breadcrumbs pull-right">
<li><a href="/documentation/">Docs</a></li>
@@ -748,14 +646,14 @@
</div>
</div>
- <h2 id="os_memblock_put"><font color="#F2853F" style="font-size:24pt">os_memblock_put</font><a class="headerlink" href="#os_memblock_put" title="Permanent link">¶</a></h2>
+ <h2 id="os_memblock_put"><font color="#F2853F" style="font-size:24pt">os_memblock_put</font></h2>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">os_error_t</span> <span style="color: #000000">os_memblock_put</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mempool</span> <span style="color: #000000">*mp</span>, <span style="color: #A90D91">void</span> <span style="color: #000000">*block_addr</span>)
</pre></div>
<p>Releases previously allocated element back to the pool. </p>
<p><br></p>
-<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<h4 id="arguments">Arguments</h4>
<table>
<thead>
<tr>
@@ -775,11 +673,11 @@
</tbody>
</table>
<p><br></p>
-<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<h4 id="returned-values">Returned values</h4>
<p>OS_OK: operation was a success:<br />
OS_INVALID_PARAM: If either mp or block_addr were NULL, or the block being freed was outside the range of the memory buffer or not on a true block size boundary.</p>
<p><br></p>
-<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<h4 id="example">Example</h4>
<p><Add text to set up the context for the example here></p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #A90D91">if</span> (<span style="color: #000000">file</span> <span style="color: #000000">!=</span> <span style="color: #A90D91">NULL</span>) {
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">os_memblock_put</span>(<span style="color: #000000">&nffs_file_pool</span>, <span style="color: #000000">file</span>);
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/eab28af6/os/core_os/memory_pool/os_mempool_init/index.html
----------------------------------------------------------------------
diff --git a/os/core_os/memory_pool/os_mempool_init/index.html b/os/core_os/memory_pool/os_mempool_init/index.html
index e017756..9f9b63b 100644
--- a/os/core_os/memory_pool/os_mempool_init/index.html
+++ b/os/core_os/memory_pool/os_mempool_init/index.html
@@ -16,6 +16,7 @@
<link rel="stylesheet" href="../../../../css/highlight.css">
<link href="../../../../css/base.css" rel="stylesheet">
<link href="../../../../css/custom.css" rel="stylesheet">
+ <link href="../../../../css/v2.css" rel="stylesheet">
<link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href="../../../../extra.css" rel="stylesheet">
@@ -43,11 +44,10 @@
<body class="os_mempool_init">
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
@@ -64,75 +64,37 @@
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
- <li>
+ <li
+ class=""
+>
<a href="/">Home</a>
</li>
- <li>
- <a href="/about/">About</a>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
</li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../faq/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
</li>
<li>
+ <a href="/os/introduction/">Documentation</a>
+ </li>
+ <li
+ class=""
+>
<a href="/download/">Download</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/community/">Community</a>
</li>
- <li>
+ <li
+ class=""
+>
<a href="/events/">Events</a>
</li>
</ul>
@@ -142,27 +104,26 @@
</ul>
</div>
- # </div>
-</div>
+ </div>
+</nav>
- <div class="container-fluid">
+ <div class="container">
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div class="hidden-print" role="complementary">
+ <div class="top">
<img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
- <div class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
- <ul class="nav bs-sidenav">
+ <ul class="toc-nav">
@@ -180,42 +141,29 @@
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
-
- <ul class="current-toc">
-
-
-
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
-
+ <ul>
+
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
-
- </li>
+
+ </li>
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
@@ -223,10 +171,10 @@
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
-
- </li>
+
+ </li>
@@ -234,10 +182,10 @@
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -245,10 +193,10 @@
- <li ><a href="../../mynewt_os/">OS Core</a></li>
+ <li ><a href="../../mynewt_os/">OS Core</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -260,8 +208,8 @@
../../os_init/
">System-level Functions</a>
-
- </li>
+
+ </li>
@@ -269,10 +217,10 @@
- <li ><a href="../../context_switch/context_switch/">Scheduler</a></li>
+ <li ><a href="../../context_switch/context_switch/">Scheduler</a>
-
- </li>
+
+ </li>
@@ -280,10 +228,10 @@
- <li ><a href="../../time/os_time/">Time</a></li>
+ <li ><a href="../../time/os_time/">Time</a>
-
- </li>
+
+ </li>
@@ -291,10 +239,10 @@
- <li ><a href="../../task/task/">Tasks</a></li>
+ <li ><a href="../../task/task/">Tasks</a>
-
- </li>
+
+ </li>
@@ -302,10 +250,10 @@
- <li ><a href="../../event_queue/event_queue/">Event Queues</a></li>
+ <li ><a href="../../event_queue/event_queue/">Event Queues</a>
-
- </li>
+
+ </li>
@@ -313,10 +261,10 @@
- <li ><a href="../../semaphore/semaphore/">Semaphores</a></li>
+ <li ><a href="../../semaphore/semaphore/">Semaphores</a>
-
- </li>
+
+ </li>
@@ -324,10 +272,10 @@
- <li ><a href="../../mutex/mutex/">Mutexes</a></li>
+ <li ><a href="../../mutex/mutex/">Mutexes</a>
-
- </li>
+
+ </li>
@@ -335,10 +283,10 @@
- <li ><a href="../memory_pool/">Memory Pools</a></li>
+ <li ><a href="../memory_pool/">Memory Pools</a>
-
- <ul class="current-toc">
+
+ <ul>
@@ -350,68 +298,58 @@
../os_memblock_get/
">Functions/Macros</a>
-
- <ul class="current-toc">
+
+ <ul>
-
- <li>
+ <li >
<a href="../os_memblock_get/">os_memblock_get</a>
</li>
-
-
<li class="active">
- os_mempool_init
+ <a href="./">os_mempool_init</a>
</li>
-
-
- <li>
+ <li >
<a href="../os_memblock_put/">os_memblock_put</a>
</li>
-
-
- <li>
+ <li >
<a href="../OS_MEMPOOL_BYTES/">OS_MEMPOOL_BYTES</a>
</li>
-
-
- <li>
+ <li >
<a href="../OS_MEMPOOL_SIZE/">OS_MEMPOOL_SIZE</a>
</li>
-
- </ul>
-
- </li>
+ </ul>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -419,10 +357,10 @@
- <li ><a href="../../heap/heap/">Heap</a></li>
+ <li ><a href="../../heap/heap/">Heap</a>
-
- </li>
+
+ </li>
@@ -437,8 +375,8 @@
">Memory Buffers</a>
-
- </li>
+
+ </li>
@@ -446,10 +384,10 @@
- <li ><a href="../../sanity/sanity/">Sanity</a></li>
+ <li ><a href="../../sanity/sanity/">Sanity</a>
-
- </li>
+
+ </li>
@@ -457,16 +395,16 @@
- <li ><a href="../../callout/callout/">Callouts</a></li>
+ <li ><a href="../../callout/callout/">Callouts</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -474,10 +412,10 @@
- <li ><a href="../../porting/port_os/">Porting to your Platform</a></li>
+ <li ><a href="../../porting/port_os/">Porting to your Platform</a>
-
- </li>
+
+ </li>
@@ -485,10 +423,10 @@
- <li ><a href="../../../modules/console/console/">Console</a></li>
+ <li ><a href="../../../modules/console/console/">Console</a>
-
- </li>
+
+ </li>
@@ -496,10 +434,10 @@
- <li ><a href="../../../modules/shell/shell/">Shell</a></li>
+ <li ><a href="../../../modules/shell/shell/">Shell</a>
-
- </li>
+
+ </li>
@@ -507,10 +445,10 @@
- <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a></li>
+ <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a>
-
- </li>
+
+ </li>
@@ -525,8 +463,8 @@
">File System</a>
-
- </li>
+
+ </li>
@@ -534,10 +472,10 @@
- <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a></li>
+ <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a>
-
- </li>
+
+ </li>
@@ -545,10 +483,10 @@
- <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a></li>
+ <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a>
-
- </li>
+
+ </li>
@@ -556,20 +494,18 @@
- <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a></li>
+ <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a>
-
- </li>
+
+ </li>
-
- <li>
+ <li >
<a href="../../../modules/baselibc/">Baselibc library</a>
</li>
-
@@ -577,10 +513,10 @@
- <li ><a href="../../../modules/elua/elua/">Embedded Lua</a></li>
+ <li ><a href="../../../modules/elua/elua/">Embedded Lua</a>
-
- </li>
+
+ </li>
@@ -588,10 +524,10 @@
- <li ><a href="../../../modules/json/json/">JSON</a></li>
+ <li ><a href="../../../modules/json/json/">JSON</a>
-
- </li>
+
+ </li>
@@ -599,10 +535,10 @@
- <li ><a href="../../../modules/stats/stats/">Stats</a></li>
+ <li ><a href="../../../modules/stats/stats/">Stats</a>
-
- </li>
+
+ </li>
@@ -610,16 +546,16 @@
- <li ><a href="../../../modules/logs/logs/">Logs</a></li>
+ <li ><a href="../../../modules/logs/logs/">Logs</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
+ </ul>
+
+ </li>
@@ -631,40 +567,36 @@
../../../../network/ble/ble_intro/
">BLE User Guide</a>
-
- </li>
+
+ </li>
- </ul>
-
- </li>
-
-
-
-
-
+
+
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
-
- </li>
+
+ </li>
-
-
-
+
+
+
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
-
- </li>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
@@ -676,8 +608,8 @@
../../../../faq/how_to_edit_docs/
">Appendix</a>
-
- </li>
+
+ </li>
@@ -688,45 +620,11 @@
<button class="show-sidebar">Docs Menu</button>
</div>
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
+ <div class="col-md-9" role="main">
<div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
+ <div class="col-sm-12">
<div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
+ <ul class="wy-breadcrumbs pull-right">
<li><a href="/documentation/">Docs</a></li>
@@ -748,7 +646,7 @@
</div>
</div>
- <h2 id="os_mempool_init"><font color="F2853F" style="font-size:24pt"> os_mempool_init</font><a class="headerlink" href="#os_mempool_init" title="Permanent link">¶</a></h2>
+ <h2 id="os_mempool_init"><font color="F2853F" style="font-size:24pt"> os_mempool_init</font></h2>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">os_error_t</span> <span style="color: #000000">os_mempool_init</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mempool</span> <span style="color: #000000">*mp</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">blocks</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">block_size</span>, <span style="color: #A90D91">void</span> <span style="color: #000000">*membuf</span>, <span style="color: #A90D91">char</span> <span style="color: #000000">*name</span>)
</pre></div>
@@ -756,7 +654,7 @@
<p>Initializes the memory pool. Memory pointed to by <em>membuf</em> is divided into <em>blocks</em> number of elements of size OS_ALIGN(<em>block_size</em>). The <em>name</em> is optional, and names the memory pool.</p>
<p>It is assumed that the amount of memory pointed by <em>membuf</em> has at least <em>OS_MEMPOOL_BYTES(blocks, block_size)</em> number of bytes.</p>
<p><em>name</em> is not copied, so caller should make sure that the memory does not get reused.</p>
-<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<h4 id="arguments">Arguments</h4>
<table>
<thead>
<tr>
@@ -787,14 +685,14 @@
</tr>
</tbody>
</table>
-<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<h4 id="returned-values">Returned values</h4>
<p>OS_OK: operation was successful.<br />
OS_INVALID_PARAM: invalid parameters. Block count or block size was negative, or membuf or mp was NULL.<br />
OS_MEM_NOT_ALIGNED: membuf was not aligned on correct byte boundary.</p>
-<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4>
+<h4 id="notes">Notes</h4>
<p>Note that os_mempool_init() does not allocate backing storage; <em>membuf</em> has to be allocated by the caller.</p>
<p>It's recommended that you use <em>OS_MEMPOOL_BYTES()</em> or <em>OS_MEMPOOL_SIZE()</em> to figure out how much memory to allocate for the pool.</p>
-<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<h4 id="example">Example</h4>
<p><Add text to set up the context for the example here></p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #A90D91">void</span> <span style="color: #000000">*nffs_file_mem</span>;