http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter5/console/index.html ---------------------------------------------------------------------- diff --git a/chapter5/console/index.html b/chapter5/console/index.html deleted file mode 100644 index c1efb23..0000000 --- a/chapter5/console/index.html +++ /dev/null @@ -1,910 +0,0 @@ -<!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>Console - 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 = "Console"; - </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>Chapter1 - 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>Chapter2 - 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/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>Chapter3 - 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>Chapter4 - Newt OS</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/mynewt_os/">Overview</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/context_switch/">Scheduler/Context Switching</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/time/">Time</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/task/">Tasks</a> - - </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>Chapter5 - Modules</span></li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">Console</a> - - <ul> - - <li class="toctree-l3"><a href="#console">Console</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="../shell/">Shell</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../bootloader/">Bootloader</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../filesystem/">File System</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../testutil/">Test Utilities</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter6 - 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>Chapter5 - Modules »</li> - - - - <li>Console</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h1 id="console">Console<a class="headerlink" href="#console" title="Permanent link">¶</a></h1> -<p>The console is an operating system window where users interact with system programs of the operating system or a console application by entering text input (typically from a keyboard) and reading text output (typically on the computer terminal). The text written on the console brings some information and is a sequence of characters sent by the OS or programs running on the OS. </p> -<p>Support is currently available for console access via the serial port on the hardware board.</p> -<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2> -<p>In the Mynewt OS, the console library comes in two versions:</p> -<ul> -<li>full - containing the full implementation</li> -<li>stub - containing stubs for the API</li> -</ul> -<p>If an egg or project requires the full console capability it lists that dependency in its egg.yml file. For example, the shell egg is defined by the following egg.yml file:</p> -<pre><code>egg.name: libs/shell -egg.vers: 0.1 -egg.deps: - - libs/console/full - - libs/os -egg.identities: - - SHELL -</code></pre> -<p>On the other hand, a project may not have a physical console (e.g. a UART port to connect a terminal to) but may have a dependency on an egg that has console capability. In that case you would use a console stub. Another example would be the bootloader project where we want to keep the size of the image small. It includes the <code>libs/os</code> egg that can print out messages on a console (e.g. if there is a hard fault) and the <code>libs/util</code> egg that uses full console (but only if SHELL is present to provide a CLI). However, we do not want to use any console I/O capability in this particular bootloader project to keep the size small. We simply use the console stub instead and the egg.yml file for the project boot egg looks like the following:</p> -<pre><code>project.name: boot -project.identities: bootloader -project.eggs: - - libs/os - - libs/bootutil - - libs/nffs - - libs/console/stub - - libs/util -</code></pre> -<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2> -<p>Console interaction is intrinsically composed of two unidirectional systems. The console implementation uses two ring buffers containing input (receive) and output (transmit) characters, respectively. Read and write operations on the console_ring structure are managed by labeling the read location indicator the <code>cr_tail</code> and the write location indicator the <code>cr_head</code>. The console ring length is variable and is specified as the <code>cr_size</code> member of the data structure. <code>cr_buf</code> is the pointer to the actual array of data contained.</p> -<pre><code>struct console_ring { - 32 uint8_t cr_head; - 33 uint8_t cr_tail; - 34 uint8_t cr_size; - 35 uint8_t _pad; - 36 uint8_t *cr_buf; - 37 } -</code></pre> - -<pre><code>struct console_tty { - 40 struct console_ring ct_tx; - 41 uint8_t ct_tx_buf[CONSOLE_TX_BUF_SZ]; /* must be after console_ring */ - 42 struct console_ring ct_rx; - 43 uint8_t ct_rx_buf[CONSOLE_RX_BUF_SZ]; /* must be after console_ring */ - 44 console_rx_cb ct_rx_cb; /* callback that input is ready */ - 45 console_write_char ct_write_char; - 46 } console_tty -</code></pre> - -<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2> -<p>The functions available in console are:</p> -<ul> -<li><a href="#function-console_printf">console_printf</a></li> -<li><a href="#function-console_add_char">console_add_char</a></li> -<li><a href="#function-console_pull_char">console_pull_char</a></li> -<li><a href="#function-console_pull_char_head">console_pull_char_head</a></li> -<li><a href="#function-console_queue_char">console_queue_char</a></li> -<li><a href="#function-console_blocking_tx">console_blocking_tx</a></li> -<li><a href="#function-console_blocking_mode">console_blocking_mode</a></li> -<li><a href="#function-console_write">console_write</a></li> -<li><a href="#function-console_read">console_read</a></li> -<li><a href="#function-console_tx_char">console_tx_char</a></li> -<li><a href="#function-console_rx_char">console_rx_char</a></li> -<li><a href="#function-console_init">console_init</a></li> -</ul> -<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2> -<hr /> -<h3 id="function-console_printf"><font color="2980b9">function console_printf</font><a class="headerlink" href="#function-console_printf" title="Permanent link">¶</a></h3> -<pre><code> void - console_printf(const char *fmt, ...) -</code></pre> - -<p>Writes a formatted message instead of raw output to the console. It first composes a C string containing text specified as arguments to the function or containing the elements in the variable argument list passed to it using snprintf or vsnprintf, respectively. It then uses function <code>console_write</code> to output the formatted data (messages) on the console.</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>fmt</td> -<td>Pointer to C string that contains a format string that follows the same specifications as format in printf. The string is printed to console.</td> -</tr> -<tr> -<td>...</td> -<td>Depending on the format string, the function may expect either a sequence of additional arguments to be used to replace a format specifier in the format string or a variable arguments list. va_list is a special type defined in <cstdarg> in stdarg.h.</td> -</tr> -</tbody> -</table> -<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4> -<p>None</p> -<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4> -<p>While <code>console_printf</code>, with its well understood formatting options in C, is more convenient and easy on the eyes than the raw output of <code>console_write</code>, the associated code size is considerably larger.</p> -<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4> -<p>Example #1:</p> -<pre><code>char adv_data_buf[32]; - -void -task() -{ - char adv_data_buf[32]; - - console_printf("%s", adv_data_buf); -} -</code></pre> - -<p>Example #2:</p> -<pre><code>struct exception_frame { - uint32_t r0; - uint32_t r1; - -struct trap_frame { - struct exception_frame *ef; - uint32_t r2; - uint32_t r3; -}; - -void -task(struct trap_frame *tf) -{ - console_printf(" r0:%8.8x r1:%8.8x", tf->ef->r0, tf->ef->r1); - console_printf(" r8:%8.8x r9:%8.8x", tf->r2, tf->r3); -} -</code></pre> - -<hr /> -<h3 id="function-console_add_char"><font color="#2980b9"> function console_add_char</font><a class="headerlink" href="#function-console_add_char" title="Permanent link">¶</a></h3> -<pre><code> static void - console_add_char(struct console_ring *cr, char ch) -</code></pre> - -<p>Adds a character to the console ring buffer. When you store an item in the buffer you store it at the head location, and the head advances to the next location.</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>*cr</td> -<td>Pointer to a console ring data structure whose <code>cr_head</code>variable is to be set to the second argument in this function call</td> -</tr> -<tr> -<td>ch</td> -<td>Character to be inserted to the ring</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4> -<p>None</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 a new line character to the output (transmit) buffer.</p> -<pre><code>void -task() -{ - struct console_ring *tx = &ct->ct_tx; - - console_add_char(tx, '\n'); -} -</code></pre> - -<hr /> -<h3 id="function-console_pull_char"><font color="#2980b9"> function console_pull_char </font><a class="headerlink" href="#function-console_pull_char" title="Permanent link">¶</a></h3> -<pre><code> static uint8_t - console_pull_char(struct console_ring *cr) -</code></pre> - -<p>Reads (remove) a byte from the console ring buffer. When you read (pull) an item, you read it at the current tail location, and the tail advances to the next position. </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>*cr</td> -<td>Pointer to the console ring buffer from where a character is to be removed</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4> -<p>Returns the character pulled from the ring buffer.</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>Read the characters in the ring buffer into a string.</p> -<pre><code>void -task(struct console_ring *cr, char *str, int cnt) -{ - for (i = 0; i < cnt; i++) { - if (cr->cr_head == cr->cr_tail) { - i = -1; - break; - } - ch = console_pull_char(cr); - *str++ = ch; - } -} -</code></pre> - -<hr /> -<h3 id="function-console_pull_char_head"><font color="#2980b9"> function console_pull_char_head </font><a class="headerlink" href="#function-console_pull_char_head" title="Permanent link">¶</a></h3> -<pre><code> static void - console_pull_char_head(struct console_ring *cr) -</code></pre> - -<p>Removes the last character inserted into the ring buffer by moving back the head location and shrinking the ring size by 1. </p> -<h4 id="arguments_3">Arguments<a class="headerlink" href="#arguments_3" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>cr</td> -<td>Pointer to the console ring buffer from which the last inserted character must be deleted</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_3">Returned values<a class="headerlink" href="#returned-values_3" title="Permanent link">¶</a></h4> -<p>None</p> -<h4 id="notes_3">Notes<a class="headerlink" href="#notes_3" 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_3">Example<a class="headerlink" href="#example_3" title="Permanent link">¶</a></h4> -<p>In order to see a character getting deleted when a user hits backspace while typying a command, the following needs to happen in sequence:</p> -<ul> -<li>output a backspace (move cursor back one character)</li> -<li>output space (erasing whatever character there was before)</li> -<li>output backspace (move cursor back one character)</li> -<li>remove the previous character from incoming RX queue</li> -</ul> -<p>The example below shows console_pull_char_head being used for the last step.</p> -<pre><code>void -task(uint8_t data) -{ - struct console_tty *ct = (struct console_tty *)arg; - struct console_ring *tx = &ct->ct_tx; - struct console_ring *rx = &ct->ct_rx; - - switch (data) { - case '\b': - console_add_char(tx, '\b'); - console_add_char(tx, ' '); - console_add_char(tx, '\b'); - console_pull_char_head(rx); - break; - } -} - -</code></pre> - -<hr /> -<h3 id="function-console_queue_char"><font color="#2980b9"> function console_queue_char </font><a class="headerlink" href="#function-console_queue_char" title="Permanent link">¶</a></h3> -<pre><code> static void - console_queue_char(char ch) -</code></pre> - -<p>Manage the buffer queue before inserting a character into it. If the head of the output (transmit) console ring is right up to its tail, the queue needs to be drained first before any data can be added. Then it uses console_add_char function to add the character.</p> -<h4 id="arguments_4">Arguments<a class="headerlink" href="#arguments_4" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>ch</td> -<td>Character to be inserted to the queue</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_4">Returned values<a class="headerlink" href="#returned-values_4" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_4">Notes<a class="headerlink" href="#notes_4" title="Permanent link">¶</a></h4> -<p>This function makes sure no interrupts are allowed while the transmit buffer is draining and the character is being added.</p> -<h4 id="example_4">Example<a class="headerlink" href="#example_4" title="Permanent link">¶</a></h4> -<pre><code>Insert example -</code></pre> - -<hr /> -<h3 id="function-console_blocking_tx"><font color="#2980b9"> function console_blocking_tx </font><a class="headerlink" href="#function-console_blocking_tx" title="Permanent link">¶</a></h3> -<pre><code> static void - console_blocking_tx(char ch) -</code></pre> - -<p>Calls the hal function hal_uart_blocking_tx to transmit a byte to the console over UART in a blocking mode until the character has been sent. Hence it must be called with interrupts disabled. It is used when printing diagnostic output from system crash. </p> -<h4 id="arguments_5">Arguments<a class="headerlink" href="#arguments_5" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -</tr> -<tr> -<td>yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_5">Returned values<a class="headerlink" href="#returned-values_5" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_5">Notes<a class="headerlink" href="#notes_5" 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_5">Example<a class="headerlink" href="#example_5" title="Permanent link">¶</a></h4> -<p>Give at least one example of usage.</p> -<hr /> -<h3 id="function-console_blocking_mode"><font color="#2980b9"> function console_blocking_mode </font><a class="headerlink" href="#function-console_blocking_mode" title="Permanent link">¶</a></h3> -<pre><code> void - console_blocking_mode(void) -</code></pre> - -<p>Calls the console_blocking_tx function to flush the buffered console output (transmit) queue. The function OS_ENTER_CRITICAL() is called to disable interrupts and OS_EXIT_CRITICAL() is called to enable interrupts back again once the buffer is flushed.</p> -<h4 id="arguments_6">Arguments<a class="headerlink" href="#arguments_6" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -</tr> -<tr> -<td>yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_6">Returned values<a class="headerlink" href="#returned-values_6" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_6">Notes<a class="headerlink" href="#notes_6" 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_6">Example<a class="headerlink" href="#example_6" title="Permanent link">¶</a></h4> -<p>Give at least one example of usage.</p> -<h3 id="function-console_write"><font color="#2980b9">function console_write </font><a class="headerlink" href="#function-console_write" title="Permanent link">¶</a></h3> -<pre><code> void - console_write(char *str, int cnt) -</code></pre> - -<p>Transmit characters to console display over serial port. </p> -<h4 id="arguments_7">Arguments<a class="headerlink" href="#arguments_7" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -</tr> -<tr> -<td>yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_7">Returned values<a class="headerlink" href="#returned-values_7" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_7">Notes<a class="headerlink" href="#notes_7" 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_7">Example<a class="headerlink" href="#example_7" title="Permanent link">¶</a></h4> -<p>Give at least one example of usage.</p> -<h3 id="function-console_read"><font color="#2980b9"> function console_read </font><a class="headerlink" href="#function-console_read" title="Permanent link">¶</a></h3> -<pre><code> int - console_read(char *str, int cnt) -</code></pre> - -<p>Calls hal function hal_uart_start_rx to start receiving input from console terminal over serial port.</p> -<h4 id="arguments_8">Arguments<a class="headerlink" href="#arguments_8" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -</tr> -<tr> -<td>yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_8">Returned values<a class="headerlink" href="#returned-values_8" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_8">Notes<a class="headerlink" href="#notes_8" 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_8">Example<a class="headerlink" href="#example_8" title="Permanent link">¶</a></h4> -<p>Give at least one example of usage.</p> -<h3 id="function-console_tx_char"><font color="#2980b9"> function console_tx_char </font><a class="headerlink" href="#function-console_tx_char" title="Permanent link">¶</a></h3> -<p><code>static int - console_tx_char(void *arg)</code></p> -<h4 id="arguments_9">Arguments<a class="headerlink" href="#arguments_9" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -</tr> -<tr> -<td>yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_9">Returned values<a class="headerlink" href="#returned-values_9" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_9">Notes<a class="headerlink" href="#notes_9" 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_9">Example<a class="headerlink" href="#example_9" title="Permanent link">¶</a></h4> -<p>Give at least one example of usage.</p> -<h3 id="function-console_rx_char"><font color="#2980b9"> function console_rx_char </font><a class="headerlink" href="#function-console_rx_char" title="Permanent link">¶</a></h3> -<pre><code> static int - console_rx_char(void *arg, uint8_t data) -</code></pre> - -<h4 id="arguments_10">Arguments<a class="headerlink" href="#arguments_10" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -</tr> -<tr> -<td>yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_10">Returned values<a class="headerlink" href="#returned-values_10" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_10">Notes<a class="headerlink" href="#notes_10" 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_10">Example<a class="headerlink" href="#example_10" title="Permanent link">¶</a></h4> -<p>Give at least one example of usage.</p> -<h3 id="function-console_init"><font color="#2980b9"> function console_init </font><a class="headerlink" href="#function-console_init" title="Permanent link">¶</a></h3> -<pre><code> int - console_init(console_rx_cb rx_cb) -</code></pre> - -<p>Initializes console receive buffer and calls hal funtions hal_uart_init_cbs and hal_uart_config to initialize serial port connection and configure it (e.g. baud rate, flow control etc.)</p> -<h4 id="arguments_11">Arguments<a class="headerlink" href="#arguments_11" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -</tr> -<tr> -<td>yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_11">Returned values<a class="headerlink" href="#returned-values_11" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_11">Notes<a class="headerlink" href="#notes_11" 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_11">Example<a class="headerlink" href="#example_11" title="Permanent link">¶</a></h4> -<p>Give at least one example of usage.</p> - - </div> - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="../shell/" class="btn btn-neutral float-right" title="Shell"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../../chapter4/port_os/" class="btn btn-neutral" title="Porting to other Platforms"><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="../../chapter4/port_os/" style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../shell/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter5/filesystem/index.html ---------------------------------------------------------------------- diff --git a/chapter5/filesystem/index.html b/chapter5/filesystem/index.html deleted file mode 100644 index 252f3c8..0000000 --- a/chapter5/filesystem/index.html +++ /dev/null @@ -1,530 +0,0 @@ -<!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>File System - 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 = "File System"; - </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>Chapter1 - 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>Chapter2 - 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/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>Chapter3 - 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>Chapter4 - Newt OS</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/mynewt_os/">Overview</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/context_switch/">Scheduler/Context Switching</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/time/">Time</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/task/">Tasks</a> - - </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>Chapter5 - Modules</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../console/">Console</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../shell/">Shell</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../bootloader/">Bootloader</a> - - </li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">File System</a> - - <ul> - - <li class="toctree-l3"><a href="#filesystem">Filesystem</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="../testutil/">Test Utilities</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter6 - 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>Chapter5 - Modules »</li> - - - - <li>File System</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h1 id="filesystem">Filesystem<a class="headerlink" href="#filesystem" 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 module here, special features, how pieces fit together etc.</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-nffs_lock">nffs_lock</a></li> -<li><a href="#function-nffs_unlock">nffs_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-nffs_lock"><font color="2980b9">function nffs_lock </font><a class="headerlink" href="#function-nffs_lock" title="Permanent link">¶</a></h3> -<pre><code> static void - nffs_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-nffs_unlock"><font color="#2980b9"> function nffs_unlock </font><a class="headerlink" href="#function-nffs_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="../testutil/" class="btn btn-neutral float-right" title="Test Utilities"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../bootloader/" class="btn btn-neutral" title="Bootloader"><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="../bootloader/" style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../testutil/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter5/shell/index.html ---------------------------------------------------------------------- diff --git a/chapter5/shell/index.html b/chapter5/shell/index.html deleted file mode 100644 index d569590..0000000 --- a/chapter5/shell/index.html +++ /dev/null @@ -1,529 +0,0 @@ -<!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>Shell - 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 = "Shell"; - </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>Chapter1 - 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>Chapter2 - 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/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>Chapter3 - 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>Chapter4 - Newt OS</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/mynewt_os/">Overview</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/context_switch/">Scheduler/Context Switching</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/time/">Time</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/task/">Tasks</a> - - </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>Chapter5 - Modules</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../console/">Console</a> - - </li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">Shell</a> - - <ul> - - <li class="toctree-l3"><a href="#shell">Shell</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="../bootloader/">Bootloader</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../filesystem/">File System</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../testutil/">Test Utilities</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter6 - 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>Chapter5 - Modules »</li> - - - - <li>Shell</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h1 id="shell">Shell<a class="headerlink" href="#shell" 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 module here, special features, how pieces fit together etc.</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-shell_cmd_list_lock">shell_cmd_list_lock</a></li> -<li><a href="#function-shell_cmd_list_unlock">shell_cmd_list_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-shell_cmd_list_lock"><font color="2980b9">function shell_cmd_list_lock </font><a class="headerlink" href="#function-shell_cmd_list_lock" title="Permanent link">¶</a></h3> -<pre><code> static int - shell_cmd_list_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-shell_cmd_list_unlock"><font color="#2980b9"> function shell_cmd_list_unlock </font><a class="headerlink" href="#function-shell_cmd_list_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="../bootloader/" class="btn btn-neutral float-right" title="Bootloader"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../console/" class="btn btn-neutral" title="Console"><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="../console/" style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../bootloader/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter5/testutil/index.html ---------------------------------------------------------------------- diff --git a/chapter5/testutil/index.html b/chapter5/testutil/index.html deleted file mode 100644 index e6fc72a..0000000 --- a/chapter5/testutil/index.html +++ /dev/null @@ -1,530 +0,0 @@ -<!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>Test Utilities - 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 = "Test Utilities"; - </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>Chapter1 - 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>Chapter2 - 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/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>Chapter3 - 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>Chapter4 - Newt OS</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/mynewt_os/">Overview</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/context_switch/">Scheduler/Context Switching</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/time/">Time</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/task/">Tasks</a> - - </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>Chapter5 - Modules</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../console/">Console</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../shell/">Shell</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../bootloader/">Bootloader</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../filesystem/">File System</a> - - </li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">Test Utilities</a> - - <ul> - - <li class="toctree-l3"><a href="#testutil">testutil</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> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter6 - 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>Chapter5 - Modules »</li> - - - - <li>Test Utilities</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h1 id="testutil">testutil<a class="headerlink" href="#testutil" 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 module here, special features, how pieces fit together etc.</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-tu_init">tu_init</a></li> -<li><a href="#function-tu_restart">tu_restart</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-tu_init"><font color="2980b9">function tu_init </font><a class="headerlink" href="#function-tu_init" title="Permanent link">¶</a></h3> -<pre><code> int - tu_init(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-tu_restart"><font color="#2980b9"> function tu_restart </font><a class="headerlink" href="#function-tu_restart" 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="../../chapter6/dist/" class="btn btn-neutral float-right" title="Creating Packages"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../filesystem/" class="btn btn-neutral" title="File System"><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="../filesystem/" style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../../chapter6/dist/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter6/dist/index.html ---------------------------------------------------------------------- diff --git a/chapter6/dist/index.html b/chapter6/dist/index.html deleted file mode 100644 index 27c5e21..0000000 --- a/chapter6/dist/index.html +++ /dev/null @@ -1,379 +0,0 @@ -<!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>Creating Packages - 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 = "Creating Packages"; - </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>Chapter1 - 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>Chapter2 - 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/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>Chapter3 - 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>Chapter4 - Newt OS</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/mynewt_os/">Overview</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/context_switch/">Scheduler/Context Switching</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/time/">Time</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter4/task/">Tasks</a> - - </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>Chapter5 - 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>Chapter6 - Packaging it</span></li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">Creating Packages</a> - - <ul> - - </ul> - - </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>Chapter6 - Packaging it »</li> - - - - <li>Creating Packages</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - - - </div> - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - - <a href="../../chapter5/testutil/" class="btn btn-neutral" title="Test Utilities"><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="../../chapter5/testutil/" style="color: #fcfcfc;">« Previous</a></span> - - - </span> -</div> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/get_acclimated/pics/STM32f3discovery_connector.png ---------------------------------------------------------------------- diff --git a/get_acclimated/pics/STM32f3discovery_connector.png b/get_acclimated/pics/STM32f3discovery_connector.png new file mode 100644 index 0000000..1f4437a Binary files /dev/null and b/get_acclimated/pics/STM32f3discovery_connector.png differ
