new chapter names and references, updated but not complete Windows instructions for blinky project
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/2c998465 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/2c998465 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/2c998465 Branch: refs/heads/asf-site Commit: 2c9984654fb1f02b29e8927e2d8956bc06236917 Parents: d88b960 Author: aditihilbert <[email protected]> Authored: Fri Dec 18 12:24:45 2015 -0800 Committer: aditihilbert <[email protected]> Committed: Fri Dec 18 12:24:45 2015 -0800 ---------------------------------------------------------------------- chapter1/how_to_edit_docs/index.html | 584 ------- chapter1/newt_concepts/index.html | 429 ----- chapter1/pics/bottomview.png | Bin 1995826 -> 0 bytes chapter1/pics/topview.png | Bin 1945584 -> 0 bytes chapter1/project1/index.html | 1377 ---------------- chapter1/try_markdown/index.html | 424 ----- chapter2/pics/STM32f3discovery_connector.png | Bin 612760 -> 0 bytes chapter2/project2/index.html | 755 --------- chapter2/project3/index.html | 386 ----- chapter2/vocabulary/index.html | 537 ------- chapter3/newt_ops/index.html | 419 ----- chapter3/newt_tool_reference/index.html | 918 ----------- chapter4/context_switch/index.html | 529 ------- chapter4/event_queue/index.html | 529 ------- chapter4/heap/index.html | 529 ------- chapter4/mbufs/index.html | 530 ------- chapter4/memory_pool/index.html | 531 ------- chapter4/mutex/index.html | 530 ------- chapter4/mynewt_os/index.html | 550 ------- chapter4/port_os/index.html | 393 ----- chapter4/sanity/index.html | 530 ------- chapter4/semaphore/index.html | 530 ------- chapter4/task/index.html | 530 ------- chapter4/time/index.html | 530 ------- chapter5/bootloader/index.html | 530 ------- chapter5/console/index.html | 910 ----------- chapter5/filesystem/index.html | 530 ------- chapter5/shell/index.html | 529 ------- chapter5/testutil/index.html | 530 ------- chapter6/dist/index.html | 379 ----- .../pics/STM32f3discovery_connector.png | Bin 0 -> 612760 bytes get_acclimated/project2/index.html | 768 +++++++++ get_acclimated/project3/index.html | 393 +++++ get_acclimated/vocabulary/index.html | 544 +++++++ get_started/how_to_edit_docs/index.html | 591 +++++++ get_started/newt_concepts/index.html | 436 +++++ get_started/pics/bottomview.png | Bin 0 -> 1995826 bytes get_started/pics/topview.png | Bin 0 -> 1945584 bytes get_started/project1/index.html | 1498 ++++++++++++++++++ get_started/try_markdown/index.html | 431 +++++ index.html | 95 +- mkdocs/search_index.json | 295 ++-- modules/bootloader/index.html | 537 +++++++ modules/console/index.html | 917 +++++++++++ modules/filesystem/index.html | 537 +++++++ modules/shell/index.html | 536 +++++++ modules/testutil/index.html | 537 +++++++ newt/newt_ops/index.html | 426 +++++ newt/newt_tool_reference/index.html | 925 +++++++++++ os/callout/index.html | 536 +++++++ os/context_switch/index.html | 536 +++++++ os/event_queue/index.html | 536 +++++++ os/heap/index.html | 536 +++++++ os/mbufs/index.html | 537 +++++++ os/memory_pool/index.html | 538 +++++++ os/mutex/index.html | 537 +++++++ os/mynewt_os/index.html | 557 +++++++ os/port_os/index.html | 400 +++++ os/sanity/index.html | 537 +++++++ os/semaphore/index.html | 537 +++++++ os/task/index.html | 537 +++++++ os/time/index.html | 537 +++++++ packaging/dist/index.html | 386 +++++ search.html | 69 +- sitemap.xml | 116 +- 65 files changed, 16639 insertions(+), 15737 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter1/how_to_edit_docs/index.html ---------------------------------------------------------------------- diff --git a/chapter1/how_to_edit_docs/index.html b/chapter1/how_to_edit_docs/index.html deleted file mode 100644 index a23c4b3..0000000 --- a/chapter1/how_to_edit_docs/index.html +++ /dev/null @@ -1,584 +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>How to edit docs - 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 = "How to edit docs"; - </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="../newt_concepts/">Newt Concepts</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../project1/">Blinky, The First Project</a> - - </li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">How to edit docs</a> - - <ul> - - <li class="toctree-l3"><a href="#how-to-edit-docs">How to Edit Docs</a></li> - - <li><a class="toctree-l4" href="#objective">Objective</a></li> - - <li><a class="toctree-l4" href="#markdown-mkdocs-mou">Markdown, MkDocs, Mou</a></li> - - <li><a class="toctree-l4" href="#access-to-the-apache-repo">Access to the Apache repo</a></li> - - <li><a class="toctree-l4" href="#making-a-local-copy">Making a local copy</a></li> - - <li><a class="toctree-l4" href="#file-to-be-edited">File to be edited</a></li> - - <li><a class="toctree-l4" href="#editing-an-existing-page">Editing an existing page</a></li> - - <li><a class="toctree-l4" href="#adding-a-new-page">Adding a new page</a></li> - - <li><a class="toctree-l4" href="#pushing-changes-to-remote-as-a-committer">Pushing changes to remote as a committer</a></li> - - <li><a class="toctree-l4" href="#sharing-changes-as-a-non-committer">Sharing changes as a non-committer</a></li> - - <li><a class="toctree-l4" href="#conversion-to-html">Conversion to HTML</a></li> - - <li><a class="toctree-l4" href="#local-preview-of-html-files">Local preview of HTML files</a></li> - - - </ul> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../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 "> - <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>Chapter1 - Get Started »</li> - - - - <li>How to edit docs</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h2 id="how-to-edit-docs">How to Edit Docs<a class="headerlink" href="#how-to-edit-docs" title="Permanent link">¶</a></h2> -<h3 id="objective">Objective<a class="headerlink" href="#objective" title="Permanent link">¶</a></h3> -<p>We will go through the process of downloading existing doccumentation and adding some content to a test document.</p> -<h3 id="markdown-mkdocs-mou">Markdown, MkDocs, Mou<a class="headerlink" href="#markdown-mkdocs-mou" title="Permanent link">¶</a></h3> -<p>The Mynewt documentation you see on the Apache incubator website is a bunch of HTML files generated using MkDocs which is a simple static site generation tool geared towards building project documentation. You can read about it at <a href="http://www.mkdocs.org";>http://www.mkdocs.org</a>. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats using a tool (which in our case is MkDocs).</p> -<p>You do not need to install MkDocs unless you want to actually render your documentation in HTML in order to preview it before pushing your content to the remote repository. Typically, using a Markdown editor such as <a href="http://25.io/mou/";>Mou</a> is enough to check how it will look after the document has gone through MkDocs. Go ahead and download <a href="http://25.io/mou/";>Mou</a>. If you are on a Windows machine, download the <a href="http://alternativeto.net/software/mou/?platform=windows";>editor of your choice</a>.</p> -<p>Currently someone in the project is designated to use MkDocs to generate the HTML pages periodically after changes have been reviewed and accepted into the master branch.</p> -<h3 id="access-to-the-apache-repo">Access to the Apache repo<a class="headerlink" href="#access-to-the-apache-repo" title="Permanent link">¶</a></h3> -<p>Get an account on Apache. You do not need a committer account to view the website or clone the repository but you need it to push changes to it.</p> -<p>If you are not a committer, you may follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is <a href="https://git-wip-us.apache.org/docs/workflow.html";>https://git-wip-us.apache.org/docs/workflow.html</a>. You will find the steps described in more detail later in this tutorial.</p> -<h3 id="making-a-local-copy">Making a local copy<a class="headerlink" href="#making-a-local-copy" title="Permanent link">¶</a></h3> -<ul> -<li> -<p>Copy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure. Use http instead of https if you are a non-committer.</p> -<pre><code>$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git -Cloning into 'incubator-mynewt-site'... -remote: Counting objects: 330, done. -remote: Compressing objects: 100% (263/263), done. -remote: Total 330 (delta 120), reused 0 (delta 0) -Receiving objects: 100% (330/330), 4.34 MiB | 830.00 KiB/s, done. -Resolving deltas: 100% (120/120), done. -Checking connectivity... done. -$ ls -incubator-mynewt-site -$ ls incubator-mynewt-site/ -docs images mkdocs.yml -</code></pre> -</li> -<li> -<p>Create a new branch to work on your documentation and move to that branch.</p> -<pre><code>$ git checkout -b <your-branch-name> -</code></pre> -</li> -</ul> -<h3 id="file-to-be-edited">File to be edited<a class="headerlink" href="#file-to-be-edited" title="Permanent link">¶</a></h3> -<p>The file you will edit is <a href="../try_markdown/">try_markdown.md</a>.</p> -<h3 id="editing-an-existing-page">Editing an existing page<a class="headerlink" href="#editing-an-existing-page" title="Permanent link">¶</a></h3> -<ul> -<li> -<p>Open the application Mou.</p> -</li> -<li> -<p>Open the file incubator-mynewt-site/docs/chapter1/try_markdown.md in Mou.</p> -</li> -<li> -<p>Edit the last item on the list.</p> -</li> -<li> -<p>Save and quit the application.</p> -</li> -</ul> -<p>You may want to review the documentation organization back in <a href="../..">Home</a> to remind you how to locate files easily. The corresponding directory tree structure is shown below.</p> -<pre><code> . - âââ docs - â  âââ chapter1 - â  â  âââ how_to_edit_docs.md - â  â  âââ newt_concepts.md - â  â  âââ pics - â  â  â  âââ bottomview.png - â  â  â  âââ topview.png - â  â  âââ project1.md - â  â  âââ try_markdown.md - â  âââ chapter2 - â  â  âââ project2.md - â  â  âââ project3.md - â  â  âââ ... (more to be added) - â  â  âââ vocabulary.md - â  âââ chapter3 - â  â  âââ newt_ops.md - â  â  âââ newt_tool_reference.md - â  âââ chapter4 - â  â  âââ context_switch.md - â  â  âââ event_queue.md - â  â  âââ heap.md - â  â  âââ mbufs.md - â  â  âââ memory_pool.md - â  â  âââ mutex.md - â  â  âââ mynewt_os.md - â  â  âââ port_os.md - â  â  âââ sanity.md - â  â  âââ semaphore.md - â  â  âââ task.md - â  â  âââ time.md - â  â  âââ ... (more to be added) - â  âââ chapter5 - â  â  âââ bootloader.md - â  â  âââ console.md - â  â  âââ filesystem.md - â  â  âââ shell.md - â  â  âââ testutil.md - â  â  âââ ... (more to be added) - â  âââ chapter6 - â  â  âââ dist.md - â  â  âââ ... (more to be added) - â  âââ extra.css - â  âââ images - â  â  âââ egg-logo.png - â  âââ index.md - âââ images - â  âââ asf_logo_wide.gif - â  âââ content-bg.png - â  âââ egg-logo.png - âââ mkdocs.yml -</code></pre> -<h3 id="adding-a-new-page">Adding a new page<a class="headerlink" href="#adding-a-new-page" title="Permanent link">¶</a></h3> -<p>If you create a new file somewhere in the <code>docs</code> subdirectory to add a new page, you have to add a line in the <code>mkdocs.yml</code> file at the correct level. For example, if you add a new module named "Ethernet" by creating a new file named <code>ethernet.md</code> in the chapter5 subdirectory, you have to insert the following line under <code>Modules:</code> in the <code>mkdocs.yml</code> file.</p> -<pre><code> - 'Ethernet': 'chapter5/ethernet.md' -</code></pre> -<h3 id="pushing-changes-to-remote-as-a-committer">Pushing changes to remote as a committer<a class="headerlink" href="#pushing-changes-to-remote-as-a-committer" title="Permanent link">¶</a></h3> -<p>If you are not a committer yet, skip this section and proceed to the <a href="#sharing-changes-as-a-non-committer">next section</a>.</p> -<ul> -<li> -<p>Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.</p> -<pre><code>$ git remote -v -origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (fetch) -origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push) -</code></pre> -</li> -<li> -<p>If, however, you do not see your remote repository, then set it up as follows.</p> -<pre><code>$ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git -</code></pre> -</li> -<li> -<p>First check the git status. It will show you that the <code>try_markdown.md</code> document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository. </p> -</li> -</ul> -<p>During staging below using <code>git add</code>, we use the <code>-A</code> option indicating you want to stage all your modifications. Instead, you can choose to specify only the files that you want to. The commit message (specified after <code>-m</code>) should summarize what your changes are about.</p> -<pre><code> $ git status - $ git add -A - $ git commit -m "My first doc change as a trial run" - $ git push -u origin <your-branch-name> -</code></pre> -<ul> -<li> -<p>You can see the changed Markdown file if you traverse the tree on the git repository <a href="https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git";> https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git</a>.</p> -</li> -<li> -<p>A commit notification automatically goes out to the [email protected] mailing list. The "upstream" manager pulls the notified changes, reviews it, and merges it to the master branch if all is well. Otherwise you get an email for further changes.</p> -</li> -</ul> -<h3 id="sharing-changes-as-a-non-committer">Sharing changes as a non-committer<a class="headerlink" href="#sharing-changes-as-a-non-committer" title="Permanent link">¶</a></h3> -<p>We suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is <a href="https://git-wip-us.apache.org/docs/workflow.html";>https://git-wip-us.apache.org/docs/workflow.html</a>. </p> -<ul> -<li> -<p>Assuming you have made changes to the example file, you will first commit your changes.</p> -<pre><code>$ git add -A -$ git commit -m "My first doc change as a trial run" -</code></pre> -</li> -<li> -<p>Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future):</p> -<pre><code>$ git format-patch origin/trunk -</code></pre> -</li> -<li> -<p>Email the patch file to [email protected]. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough. </p> -</li> -</ul> -<p>If there is a JIRA ticket associated with your work you should post your patch files to the ticket.</p> -<h3 id="conversion-to-html">Conversion to HTML<a class="headerlink" href="#conversion-to-html" title="Permanent link">¶</a></h3> -<p>The conversion of the Markdown files to HTML for the website happens manually and statically using MkDocs. You cannot see automatic and immediate rendering in HTML upon making a change in the Markdown file. You can choose to stop here and proceed to changing other Markdown files in your branch.</p> -<h3 id="local-preview-of-html-files">Local preview of HTML files<a class="headerlink" href="#local-preview-of-html-files" title="Permanent link">¶</a></h3> -<p>However, you have the option to download MkDocs and do a local conversion yourself to preview the pages using the built-in devserver that comes with MkDocs. But first you will have to install MkDocs for that. In order to install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have them already (usually you will).</p> -<pre><code> $ python --version - Python 2.7.2 - $ pip --version - pip 1.5.2 - $ pip install mkdocs -</code></pre> -<p>You will then run the built-in webserver from the root of the documentation directory using the command <code>mkdocs serve</code>. The root directory for documentation is <code>incubator-mynewt-site</code> or the directory with the <code>mkdocs.yml</code> file.</p> -<pre><code> $ ls - docs images mkdocs.yml - $ mkdocs serve -</code></pre> -<p>Then go to <a href="http://127.0.0.1:8000";>http://127.0.0.1:8000</a> to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be updated.</p> -<p>For more information on MkDocs go to <a href="http://www.mkdocs.org";>http://www.mkdocs.org</a>. </p> - - </div> - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="../try_markdown/" class="btn btn-neutral float-right" title="Sample doc to edit"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../project1/" class="btn btn-neutral" title="Blinky, The First Project"><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="../project1/" style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../try_markdown/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter1/newt_concepts/index.html ---------------------------------------------------------------------- diff --git a/chapter1/newt_concepts/index.html b/chapter1/newt_concepts/index.html deleted file mode 100644 index 13ecf59..0000000 --- a/chapter1/newt_concepts/index.html +++ /dev/null @@ -1,429 +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>Newt Concepts - 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 = "Newt Concepts"; - </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 current"> - <a class="current" href="./">Newt Concepts</a> - - <ul> - - <li class="toctree-l3"><a href="#newt-concepts">Newt Concepts</a></li> - - <li><a class="toctree-l4" href="#basic-components-in-the-ecosystem">Basic components in the ecosystem</a></li> - - <li><a class="toctree-l4" href="#terminology">Terminology</a></li> - - <li><a class="toctree-l4" href="#a-mynewt-contributor">A Mynewt contributor</a></li> - - <li><a class="toctree-l4" href="#a-mynewt-user">A Mynewt user</a></li> - - - </ul> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../project1/">Blinky, The First Project</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../how_to_edit_docs/">How to edit docs</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../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 "> - <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>Chapter1 - Get Started »</li> - - - - <li>Newt Concepts</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h2 id="newt-concepts">Newt Concepts<a class="headerlink" href="#newt-concepts" title="Permanent link">¶</a></h2> -<p>This page introduces the basic terms you will need to find your way around the Mynewt ecosystem.</p> -<h3 id="basic-components-in-the-ecosystem">Basic components in the ecosystem<a class="headerlink" href="#basic-components-in-the-ecosystem" title="Permanent link">¶</a></h3> -<ul> -<li> -<p>NewtOS is an open-source RTOS (Real Time Operating System) that works on a variety of hardware. The goal is to develop a pre-emptive, multitasking OS that is highly modular, making it possible to mix and match components to enable desired features and capabilities on multiple hardware architectures. Examples of components being worked on are the Core RTOS, a flash file system, utility functions, a variety of board support packages, packages of microcontrollers etc.</p> -</li> -<li> -<p>Network protocol stacks such as Bluetooth Low Energy, and more</p> -</li> -<li> -<p>Newt Tool helps you mix the specific packages for the combination of hardware and low-level embedded architecture features of the user's choice and generate the corresponding run-time image based on the NewtOS. It provides the infrastructure to manage and build for different CPU architectures, memory units, board support packages etc., allowing a user to formulate the contents according to the low-level features needed by his or her project.</p> -</li> -</ul> -<h3 id="terminology">Terminology<a class="headerlink" href="#terminology" title="Permanent link">¶</a></h3> -<p>A Mynewt user starts with a project in mind that defines the application or utility that he or she wants to implement on an embedded device. Making an LED blink on an electronics prototyping board is a common starter project. Enabling a BLE (Bluetooth Low Energy) peripheral mode on a development board is a more complex project. Specifying a project requires naming it, at the very least, and then adding the desired properties or attributes. In order to actualize a project, it needs to be applied to a target which is essentially a combination of some specified hardware and the execution environment. </p> -<p>In the mynewt lifecycle, a project grows in a nest. A nest may house multiple projects. The nest is, therefore, a repository where various component packages for one or more projects reside. Each package is an egg (naturally!). However, in the world of Mynewt an egg may consist of other eggs! For example, the starter project Blinky is an egg consisting of several constituent eggs that enable core features. The egg form is suitable for elemental units of code as it explicitly exposes characteristics such as dependencies, versions, capabilities, requirements etc., thus making assembling appropriate components for a project and building an image for it easy to follow, modular, and robust.</p> -<p>A nest can be given any name. For example, you will see a nest named "tadpole" in Mynewt (<a href="https://git-wip-us.apache.org/repos/asf?p=incubator-mynewt-tadpole.git";>https://git-wip-us.apache.org/repos/asf?p=incubator-mynewt-tadpole.git</a>). It contains all the core libraries of the operating system for the native platform which currently supports compilation on Mac OS X. The core libraries are contained in the form of eggs where an egg is a basic unit of implementation of any aspect of the RTOS. The eggs are distributed in the following directory structure inside the nest:</p> -<ul> -<li>libs: contains the two eggs <code>os</code> and <code>testutil</code></li> -<li>hw: contains three eggs - (i) <code>hal</code> which has the abstraction layer (HAL) API definitions that all BSP and MCU implementations must support, (ii) <code>/mcu/native</code> which in an MCU implementation for the native platform (a simulator, in this case), and (iii) <code>bsp/native</code> which is a BSP implementation for the native platform </li> -<li>compiler: contains the <code>sim</code> egg which bundles the compiler specifications for the native platform.</li> -</ul> -<p>Let's explore this sample nest a bit further. The <code>libs/os</code> egg contains code for scheduler, process/thread/memory management, semaphores etc. It is the core RTOS which ports to all supported chip platforms.The <code>libs/testutil</code> egg contains code for testing packages on hardware or simulated environment. The <code>hw/hal</code> egg contains header files that provide abstraction for physical hardware components such as GPIO (general purpose input/output), network adapters, timers, and UARTs. This <code>hw/hal</code> egg is an MCU peripheral abstraction designed to make it easy to port to different MCUs (microcontrollers). The <code>hw/mcu/native</code> egg contains code for microcontroller operations on the native platform. The <code>hw/bsp/native</code> egg contains the board support package for the native platform. And finally, the sixth egg <code>sim</code> contains the compiler specifications such as path and flags. Currently the compilation is supported on Mac OS X.</p> -<p>You can see another nest in the mynewt ecosystem called the "larva". It was spawned from the skeletal "tadpole" nest using the newt tool. Spawning is easy - <code>$ newt create nest <your_nest_name></code>. "larva" is the developer's test repository containing all sorts of eggs being written and incubated, including ones to enhance the core operating system which should eventually make their way into the "tadpole" nest. There is a <code>hatch_tadpole</code> script to update the "tadpole" nest when the core OS related eggs in "larva" are ready.</p> -<p>There is a third nest named "newt" that contains all the eggs needed to support the build and release process of mynewt software. In the future, there will also be pre-built nests for certain common hardware devices to enable a user to quickly get started with a project.</p> -<h3 id="a-mynewt-contributor">A Mynewt contributor<a class="headerlink" href="#a-mynewt-contributor" title="Permanent link">¶</a></h3> -<p>A contributor can choose to work on any area(s) of the Mynewt endeavor that appeals to him or her. Hence, you can work on one or more eggs or an entire nest. You can create your own nest (master) or create a branch in an existing nest. For now, Runtime contributors will review any new areas of support that you may wish to introduce e.g. a new board support package (BSP) or a new network protocol. </p> -<p>A contributer role necessarily implies he or she is a Mynewt user (see below) of some or all of the products developed.</p> -<h3 id="a-mynewt-user">A Mynewt user<a class="headerlink" href="#a-mynewt-user" title="Permanent link">¶</a></h3> -<p>An application developer is interested only in using software available in this ecosystem to build a top level build artifact. He or she may either:</p> -<ul> -<li>Use a pre-built nest, or</li> -<li>Spawn a new nest using the newt tool for a target where a target is a custom combination of supported hardware components</li> -</ul> -<p>In either case, the user would use the newt tool to create and set the target in the chosen nest. The newt tool would then be used to build out the target profile which would determine which eggs to choose. Finally, the user would use the newt tool to generate a run-time image that can be run on the device.</p> - - </div> - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="../project1/" class="btn btn-neutral float-right" title="Blinky, The First Project"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../.." class="btn btn-neutral" title="Home"><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="../.." style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../project1/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter1/pics/bottomview.png ---------------------------------------------------------------------- diff --git a/chapter1/pics/bottomview.png b/chapter1/pics/bottomview.png deleted file mode 100644 index fb7bf0a..0000000 Binary files a/chapter1/pics/bottomview.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter1/pics/topview.png ---------------------------------------------------------------------- diff --git a/chapter1/pics/topview.png b/chapter1/pics/topview.png deleted file mode 100644 index e57995e..0000000 Binary files a/chapter1/pics/topview.png and /dev/null differ
